3 * Shaarli - The personal, minimalist, super-fast, database free, bookmarking service.
5 * Friendly fork by the Shaarli community:
6 * - https://github.com/shaarli/Shaarli
8 * Original project by sebsauvage.net:
9 * - http://sebsauvage.net/wiki/doku.php?id=php:shaarli
10 * - https://github.com/sebsauvage/Shaarli
12 * Licence: http://www.opensource.org/licenses/zlib-license.php
17 // Set 'UTC' as the default timezone if it is not defined in php.ini
18 // See http://php.net/manual/en/datetime.configuration.php#ini.date.timezone
19 if (date_default_timezone_get() == '') {
20 date_default_timezone_set('UTC');
27 // http://server.com/x/shaarli --> /shaarli/
28 define('WEB_PATH', substr($_SERVER['REQUEST_URI'], 0, 1+
strrpos($_SERVER['REQUEST_URI'], '/', 0)));
30 // High execution time in case of problematic imports/exports.
31 ini_set('max_input_time', '60');
33 // Try to set max upload file size and read
34 ini_set('memory_limit', '128M');
35 ini_set('post_max_size', '16M');
36 ini_set('upload_max_filesize', '16M');
38 // See all error except warnings
39 error_reporting(E_ALL^E_WARNING
);
40 // See all errors (for debugging only)
41 //error_reporting(-1);
44 // 3rd-party libraries
45 if (! file_exists(__DIR__
. '/vendor/autoload.php')) {
46 header('Content-Type: text/plain; charset=utf-8');
47 echo "Error: missing Composer configuration\n\n"
48 ."If you installed Shaarli through Git or using the development branch,\n"
49 ."please refer to the installation documentation to install PHP"
50 ." dependencies using Composer:\n"
51 ."- https://shaarli.readthedocs.io/en/master/Server-configuration/\n"
52 ."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/";
55 require_once 'inc/rain.tpl.class.php';
56 require_once __DIR__
. '/vendor/autoload.php';
59 require_once 'application/bookmark/LinkUtils.php';
60 require_once 'application/config/ConfigPlugin.php';
61 require_once 'application/feed/Cache.php';
62 require_once 'application/http/HttpUtils.php';
63 require_once 'application/http/UrlUtils.php';
64 require_once 'application/updater/UpdaterUtils.php';
65 require_once 'application/FileUtils.php';
66 require_once 'application/TimeZone.php';
67 require_once 'application/Utils.php';
69 use \Shaarli\ApplicationUtils
;
70 use \Shaarli\Bookmark\Exception\LinkNotFoundException
;
71 use \Shaarli\Bookmark\LinkDB
;
72 use \Shaarli\Config\ConfigManager
;
73 use \Shaarli\Feed\CachedPage
;
74 use \Shaarli\Feed\FeedBuilder
;
76 use \Shaarli\Languages
;
77 use \Shaarli\Netscape\NetscapeBookmarkUtils
;
78 use \Shaarli\Plugin\PluginManager
;
79 use \Shaarli\Render\PageBuilder
;
80 use \Shaarli\Render\ThemeUtils
;
82 use \Shaarli\Security\LoginManager
;
83 use \Shaarli\Security\SessionManager
;
84 use \Shaarli\Thumbnailer
;
85 use \Shaarli\Updater\Updater
;
87 // Ensure the PHP version is supported
89 ApplicationUtils
::checkPHPVersion('5.5', PHP_VERSION
);
90 } catch (Exception
$exc) {
91 header('Content-Type: text/plain; charset=utf-8');
92 echo $exc->getMessage();
96 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
98 // Force cookie path (but do not change lifetime)
99 $cookie = session_get_cookie_params();
101 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
102 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
104 // Set default cookie expiration and path.
105 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
106 // Set session parameters on server side.
107 // Use cookies to store session.
108 ini_set('session.use_cookies', 1);
109 // Force cookies for session (phpsessionID forbidden in URL).
110 ini_set('session.use_only_cookies', 1);
111 // Prevent PHP form using sessionID in URL if cookies are disabled.
112 ini_set('session.use_trans_sid', false);
114 session_name('shaarli');
115 // Start session if needed (Some server auto-start sessions).
116 if (session_status() == PHP_SESSION_NONE
) {
120 // Regenerate session ID if invalid or not defined in cookie.
121 if (isset($_COOKIE['shaarli']) && !SessionManager
::checkId($_COOKIE['shaarli'])) {
122 session_regenerate_id(true);
123 $_COOKIE['shaarli'] = session_id();
126 $conf = new ConfigManager();
127 $sessionManager = new SessionManager($_SESSION, $conf);
128 $loginManager = new LoginManager($GLOBALS, $conf, $sessionManager);
129 $loginManager->generateStaySignedInToken($_SERVER['REMOTE_ADDR']);
130 $clientIpId = client_ip_id($_SERVER);
132 // LC_MESSAGES isn't defined without php-intl, in this case use LC_COLLATE locale instead.
133 if (! defined('LC_MESSAGES')) {
134 define('LC_MESSAGES', LC_COLLATE
);
137 // Sniff browser language and set date format accordingly.
138 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
139 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
142 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
144 $conf->setEmpty('general.timezone', date_default_timezone_get());
145 $conf->setEmpty('general.title', t('Shared links on '). escape(index_url($_SERVER)));
146 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
147 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
149 $pluginManager = new PluginManager($conf);
150 $pluginManager->load($conf->get('general.enabled_plugins'));
152 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
154 ob_start(); // Output buffering for the page cache.
156 // Prevent caching on client side or proxy: (yes, it's ugly)
157 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
158 header("Cache-Control: no-store, no-cache, must-revalidate");
159 header("Cache-Control: post-check=0, pre-check=0", false);
160 header("Pragma: no-cache");
162 if (! is_file($conf->getConfigFileExt())) {
163 // Ensure Shaarli has proper access to its resources
164 $errors = ApplicationUtils
::checkResourcePermissions($conf);
166 if ($errors != array()) {
167 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
169 foreach ($errors as $error) {
170 $message .= '<li>'.$error.'</li>';
174 header('Content-Type: text/html; charset=utf-8');
179 // Display the installation form if no existing config is found
180 install($conf, $sessionManager, $loginManager);
183 $loginManager->checkLoginState($_COOKIE, $clientIpId);
186 * Adapter function to ensure compatibility with third-party templates
188 * @see https://github.com/shaarli/Shaarli/pull/1086
190 * @return bool true when the user is logged in, false otherwise
192 function isLoggedIn()
194 global $loginManager;
195 return $loginManager->isLoggedIn();
199 // ------------------------------------------------------------------------------------------
200 // Process login form: Check if login/password is correct.
201 if (isset($_POST['login'])) {
202 if (! $loginManager->canLogin($_SERVER)) {
203 die(t('I said: NO. You are banned for the moment. Go away.'));
205 if (isset($_POST['password'])
206 && $sessionManager->checkToken($_POST['token'])
207 && $loginManager->checkCredentials($_SERVER['REMOTE_ADDR'], $clientIpId, $_POST['login'], $_POST['password'])
209 $loginManager->handleSuccessfulLogin($_SERVER);
212 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
213 // Note: Never forget the trailing slash on the cookie path!
214 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]) . '/';
217 if (!empty($_POST['longlastingsession'])) {
218 // Keep the session cookie even after the browser closes
219 $sessionManager->setStaySignedIn(true);
220 $expirationTime = $sessionManager->extendSession();
223 $loginManager::$STAY_SIGNED_IN_COOKIE,
224 $loginManager->getStaySignedInToken(),
229 // Standard session expiration (=when browser closes)
233 // Send cookie with the new expiration date to the browser
234 session_set_cookie_params($expirationTime, $cookiedir, $_SERVER['SERVER_NAME']);
235 session_regenerate_id(true);
237 // Optional redirect after login:
238 if (isset($_GET['post'])) {
239 $uri = '?post='. urlencode($_GET['post']);
240 foreach (array('description', 'source', 'title', 'tags') as $param) {
241 if (!empty($_GET[$param])) {
242 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
245 header('Location: '. $uri);
249 if (isset($_GET['edit_link'])) {
250 header('Location: ?edit_link='. escape($_GET['edit_link']));
254 if (isset($_POST['returnurl'])) {
255 // Prevent loops over login screen.
256 if (strpos($_POST['returnurl'], 'do=login') === false) {
257 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
261 header('Location: ?');
264 $loginManager->handleFailedLogin($_SERVER);
265 $redir = '&username='. urlencode($_POST['login']);
266 if (isset($_GET['post'])) {
267 $redir .= '&post=' . urlencode($_GET['post']);
268 foreach (array('description', 'source', 'title', 'tags') as $param) {
269 if (!empty($_GET[$param])) {
270 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
274 // Redirect to login screen.
275 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
280 // ------------------------------------------------------------------------------------------
281 // Token management for XSRF protection
282 // Token should be used in any form which acts on data (create,update,delete,import...).
283 if (!isset($_SESSION['tokens'])) {
284 $_SESSION['tokens']=array(); // Token are attached to the session.
288 * Daily RSS feed: 1 RSS entry per day giving all the links on that day.
289 * Gives the last 7 days (which have links).
290 * This RSS feed cannot be filtered.
292 * @param ConfigManager $conf Configuration Manager instance
293 * @param LoginManager $loginManager LoginManager instance
295 function showDailyRSS($conf, $loginManager)
298 $query = $_SERVER['QUERY_STRING'];
299 $cache = new CachedPage(
300 $conf->get('config.PAGE_CACHE'),
302 startsWith($query, 'do=dailyrss') && !$loginManager->isLoggedIn()
304 $cached = $cache->cachedVersion();
305 if (!empty($cached)) {
310 // If cached was not found (or not usable), then read the database and build the response:
311 // Read links from database (and filter private links if used it not logged in).
312 $LINKSDB = new LinkDB(
313 $conf->get('resource.datastore'),
314 $loginManager->isLoggedIn(),
315 $conf->get('privacy.hide_public_links')
318 /* Some Shaarlies may have very few links, so we need to look
319 back in time until we have enough days ($nb_of_days).
321 $nb_of_days = 7; // We take 7 days.
322 $today = date('Ymd');
325 foreach ($LINKSDB as $link) {
326 $day = $link['created']->format('Ymd'); // Extract day (without time)
327 if (strcmp($day, $today) < 0) {
328 if (empty($days[$day])) {
329 $days[$day] = array();
331 $days[$day][] = $link;
334 if (count($days) > $nb_of_days) {
335 break; // Have we collected enough days?
339 // Build the RSS feed.
340 header('Content-Type: application/rss+xml; charset=utf-8');
341 $pageaddr = escape(index_url($_SERVER));
342 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
344 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
345 echo '<link>'. $pageaddr .'</link>';
346 echo '<description>Daily shared links</description>';
347 echo '<language>en-en</language>';
348 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
351 foreach ($days as $day => $links) {
352 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
353 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
355 // We pre-format some fields for proper output.
356 foreach ($links as &$link) {
357 $link['formatedDescription'] = format_description($link['description']);
358 $link['timestamp'] = $link['created']->getTimestamp();
359 if (is_note($link['url'])) {
360 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
364 // Then build the HTML for this day:
366 $tpl->assign('title', $conf->get('general.title'));
367 $tpl->assign('daydate', $dayDate->getTimestamp());
368 $tpl->assign('absurl', $absurl);
369 $tpl->assign('links', $links);
370 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
371 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
372 $tpl->assign('index_url', $pageaddr);
373 $html = $tpl->draw('dailyrss', true);
375 echo $html . PHP_EOL
;
377 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
379 $cache->cache(ob_get_contents());
385 * Show the 'Daily' page.
387 * @param PageBuilder $pageBuilder Template engine wrapper.
388 * @param LinkDB $LINKSDB LinkDB instance.
389 * @param ConfigManager $conf Configuration Manager instance.
390 * @param PluginManager $pluginManager Plugin Manager instance.
391 * @param LoginManager $loginManager Login Manager instance
393 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager, $loginManager)
395 $day = date('Ymd', strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
396 if (isset($_GET['day'])) {
400 $days = $LINKSDB->days();
401 $i = array_search($day, $days);
402 if ($i === false && count($days)) {
403 // no links for day, but at least one day with links
404 $i = count($days) - 1;
412 $previousday=$days[$i - 1];
414 if ($i < count($days) - 1) {
415 $nextday = $days[$i +
1];
419 $linksToDisplay = $LINKSDB->filterDay($day);
420 } catch (Exception
$exc) {
422 $linksToDisplay = array();
425 // We pre-format some fields for proper output.
426 foreach ($linksToDisplay as $key => $link) {
427 $taglist = explode(' ', $link['tags']);
428 uasort($taglist, 'strcasecmp');
429 $linksToDisplay[$key]['taglist']=$taglist;
430 $linksToDisplay[$key]['formatedDescription'] = format_description($link['description']);
431 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
434 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
436 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
437 'linksToDisplay' => $linksToDisplay,
438 'day' => $dayDate->getTimestamp(),
439 'dayDate' => $dayDate,
440 'previousday' => $previousday,
441 'nextday' => $nextday,
444 /* Hook is called before column construction so that plugins don't have
445 to deal with columns. */
446 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
448 /* We need to spread the articles on 3 columns.
449 I did not want to use a JavaScript lib like http://masonry.desandro.com/
450 so I manually spread entries with a simple method: I roughly evaluate the
451 height of a div according to title and description length.
453 $columns = array(array(), array(), array()); // Entries to display, for each column.
454 $fill = array(0, 0, 0); // Rough estimate of columns fill.
455 foreach ($data['linksToDisplay'] as $key => $link) {
456 // Roughly estimate length of entry (by counting characters)
457 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
458 // Description: 836 characters gives roughly 342 pixel height.
459 // This is not perfect, but it's usually OK.
460 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
461 if ($link['thumbnail']) {
462 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
464 // Then put in column which is the less filled:
465 $smallest = min($fill); // find smallest value in array.
466 $index = array_search($smallest, $fill); // find index of this smallest value.
467 array_push($columns[$index], $link); // Put entry in this column.
468 $fill[$index] +
= $length;
471 $data['cols'] = $columns;
473 foreach ($data as $key => $value) {
474 $pageBuilder->assign($key, $value);
477 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
478 $pageBuilder->renderPage('daily');
483 * Renders the linklist
485 * @param pageBuilder $PAGE pageBuilder instance.
486 * @param LinkDB $LINKSDB LinkDB instance.
487 * @param ConfigManager $conf Configuration Manager instance.
488 * @param PluginManager $pluginManager Plugin Manager instance.
490 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
492 buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
493 $PAGE->renderPage('linklist');
497 * Render HTML page (according to URL parameters and user rights)
499 * @param ConfigManager $conf Configuration Manager instance.
500 * @param PluginManager $pluginManager Plugin Manager instance,
501 * @param LinkDB $LINKSDB
502 * @param History $history instance
503 * @param SessionManager $sessionManager SessionManager instance
504 * @param LoginManager $loginManager LoginManager instance
506 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager, $loginManager)
508 $updater = new Updater(
509 read_updates_file($conf->get('resource.updates')),
512 $loginManager->isLoggedIn(),
516 $newUpdates = $updater->update();
517 if (! empty($newUpdates)) {
519 $conf->get('resource.updates'),
520 $updater->getDoneUpdates()
523 } catch (Exception
$e) {
524 die($e->getMessage());
527 $PAGE = new PageBuilder($conf, $_SESSION, $LINKSDB, $sessionManager->generateToken(), $loginManager->isLoggedIn());
528 $PAGE->assign('linkcount', count($LINKSDB));
529 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
530 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
532 // Determine which page will be rendered.
533 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
534 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
536 if (// if the user isn't logged in
537 !$loginManager->isLoggedIn() &&
538 // and Shaarli doesn't have public content...
539 $conf->get('privacy.hide_public_links') &&
540 // and is configured to enforce the login
541 $conf->get('privacy.force_login') &&
542 // and the current page isn't already the login page
543 $targetPage !== Router
::$PAGE_LOGIN &&
544 // and the user is not requesting a feed (which would lead to a different content-type as expected)
545 $targetPage !== Router
::$PAGE_FEED_ATOM &&
546 $targetPage !== Router
::$PAGE_FEED_RSS
548 // force current page to be the login page
549 $targetPage = Router
::$PAGE_LOGIN;
552 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
553 // Then assign generated data to RainTPL.
554 $common_hooks = array(
560 foreach ($common_hooks as $name) {
561 $plugin_data = array();
562 $pluginManager->executeHooks(
566 'target' => $targetPage,
567 'loggedin' => $loginManager->isLoggedIn()
570 $PAGE->assign('plugins_' . $name, $plugin_data);
573 // -------- Display login form.
574 if ($targetPage == Router
::$PAGE_LOGIN) {
575 if ($conf->get('security.open_shaarli')) {
576 header('Location: ?');
578 } // No need to login for open Shaarli
579 if (isset($_GET['username'])) {
580 $PAGE->assign('username', escape($_GET['username']));
582 $PAGE->assign('returnurl', (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
583 // add default state of the 'remember me' checkbox
584 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
585 $PAGE->assign('user_can_login', $loginManager->canLogin($_SERVER));
586 $PAGE->assign('pagetitle', t('Login') .' - '. $conf->get('general.title', 'Shaarli'));
587 $PAGE->renderPage('loginform');
590 // -------- User wants to logout.
591 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
592 invalidateCaches($conf->get('resource.page_cache'));
593 $sessionManager->logout();
594 setcookie(LoginManager
::$STAY_SIGNED_IN_COOKIE, 'false', 0, WEB_PATH
);
595 header('Location: ?');
599 // -------- Picture wall
600 if ($targetPage == Router
::$PAGE_PICWALL) {
601 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
602 if (! $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) === Thumbnailer
::MODE_NONE
) {
603 $PAGE->assign('linksToDisplay', []);
604 $PAGE->renderPage('picwall');
608 // Optionally filter the results:
609 $links = $LINKSDB->filterSearch($_GET);
610 $linksToDisplay = array();
612 // Get only links which have a thumbnail.
613 // Note: we do not retrieve thumbnails here, the request is too heavy.
614 foreach ($links as $key => $link) {
615 if (isset($link['thumbnail']) && $link['thumbnail'] !== false) {
616 $linksToDisplay[] = $link; // Add to array.
621 'linksToDisplay' => $linksToDisplay,
623 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => $loginManager->isLoggedIn()));
625 foreach ($data as $key => $value) {
626 $PAGE->assign($key, $value);
630 $PAGE->renderPage('picwall');
634 // -------- Tag cloud
635 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
636 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
637 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
638 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
640 // We sort tags alphabetically, then choose a font size according to count.
641 // First, find max value.
643 foreach ($tags as $value) {
644 $maxcount = max($maxcount, $value);
647 alphabetical_sort($tags, false, true);
650 foreach ($tags as $key => $value) {
651 if (in_array($key, $filteringTags)) {
654 // Tag font size scaling:
655 // default 15 and 30 logarithm bases affect scaling,
656 // 22 and 6 are arbitrary font sizes for max and min sizes.
657 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
658 $tagList[$key] = array(
660 'size' => number_format($size, 2, '.', ''),
664 $searchTags = implode(' ', escape($filteringTags));
666 'search_tags' => $searchTags,
669 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
671 foreach ($data as $key => $value) {
672 $PAGE->assign($key, $value);
675 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
676 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
677 $PAGE->renderPage('tag.cloud');
682 if ($targetPage == Router
::$PAGE_TAGLIST) {
683 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
684 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
685 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
686 foreach ($filteringTags as $tag) {
687 if (array_key_exists($tag, $tags)) {
692 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
693 alphabetical_sort($tags, false, true);
696 $searchTags = implode(' ', escape($filteringTags));
698 'search_tags' => $searchTags,
701 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
703 foreach ($data as $key => $value) {
704 $PAGE->assign($key, $value);
707 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
708 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
709 $PAGE->renderPage('tag.list');
714 if ($targetPage == Router
::$PAGE_DAILY) {
715 showDaily($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
718 // ATOM and RSS feed.
719 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
720 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
721 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
724 $query = $_SERVER['QUERY_STRING'];
725 $cache = new CachedPage(
726 $conf->get('resource.page_cache'),
728 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
730 $cached = $cache->cachedVersion();
731 if (!empty($cached)) {
737 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, $loginManager->isLoggedIn());
738 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
739 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
740 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
741 $data = $feedGenerator->buildData();
743 // Process plugin hook.
744 $pluginManager->executeHooks('render_feed', $data, array(
745 'loggedin' => $loginManager->isLoggedIn(),
746 'target' => $targetPage,
749 // Render the template.
750 $PAGE->assignAll($data);
751 $PAGE->renderPage('feed.'. $feedType);
752 $cache->cache(ob_get_contents());
757 // Display opensearch plugin (XML)
758 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
759 header('Content-Type: application/xml; charset=utf-8');
760 $PAGE->assign('serverurl', index_url($_SERVER));
761 $PAGE->renderPage('opensearch');
765 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
766 if (isset($_GET['addtag'])) {
767 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
768 if (empty($_SERVER['HTTP_REFERER'])) {
769 // In case browser does not send HTTP_REFERER
770 header('Location: ?searchtags='.urlencode($_GET['addtag']));
773 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
775 // Prevent redirection loop
776 if (isset($params['addtag'])) {
777 unset($params['addtag']);
780 // Check if this tag is already in the search query and ignore it if it is.
781 // Each tag is always separated by a space
782 if (isset($params['searchtags'])) {
783 $current_tags = explode(' ', $params['searchtags']);
785 $current_tags = array();
788 foreach ($current_tags as $value) {
789 if ($value === $_GET['addtag']) {
794 // Append the tag if necessary
795 if (empty($params['searchtags'])) {
796 $params['searchtags'] = trim($_GET['addtag']);
798 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
801 // We also remove page (keeping the same page has no sense, since the
802 // results are different)
803 unset($params['page']);
805 header('Location: ?'.http_build_query($params));
809 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
810 if (isset($_GET['removetag'])) {
811 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
812 if (empty($_SERVER['HTTP_REFERER'])) {
813 header('Location: ?');
817 // In case browser does not send HTTP_REFERER
818 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
820 // Prevent redirection loop
821 if (isset($params['removetag'])) {
822 unset($params['removetag']);
825 if (isset($params['searchtags'])) {
826 $tags = explode(' ', $params['searchtags']);
827 // Remove value from array $tags.
828 $tags = array_diff($tags, array($_GET['removetag']));
829 $params['searchtags'] = implode(' ', $tags);
831 if (empty($params['searchtags'])) {
832 unset($params['searchtags']);
835 // We also remove page (keeping the same page has no sense, since
836 // the results are different)
837 unset($params['page']);
839 header('Location: ?'.http_build_query($params));
843 // -------- User wants to change the number of links per page (linksperpage=...)
844 if (isset($_GET['linksperpage'])) {
845 if (is_numeric($_GET['linksperpage'])) {
846 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
849 if (! empty($_SERVER['HTTP_REFERER'])) {
850 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
854 header('Location: '. $location);
858 // -------- User wants to see only private links (toggle)
859 if (isset($_GET['visibility'])) {
860 if ($_GET['visibility'] === 'private') {
861 // Visibility not set or not already private, set private, otherwise reset it
862 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
863 // See only private links
864 $_SESSION['visibility'] = 'private';
866 unset($_SESSION['visibility']);
868 } elseif ($_GET['visibility'] === 'public') {
869 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
870 // See only public links
871 $_SESSION['visibility'] = 'public';
873 unset($_SESSION['visibility']);
877 if (! empty($_SERVER['HTTP_REFERER'])) {
878 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
882 header('Location: '. $location);
886 // -------- User wants to see only untagged links (toggle)
887 if (isset($_GET['untaggedonly'])) {
888 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
890 if (! empty($_SERVER['HTTP_REFERER'])) {
891 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
895 header('Location: '. $location);
899 // -------- Handle other actions allowed for non-logged in users:
900 if (!$loginManager->isLoggedIn()) {
901 // User tries to post new link but is not logged in:
902 // Show login screen, then redirect to ?post=...
903 if (isset($_GET['post'])) {
904 header( // Redirect to login page, then back to post link.
905 'Location: ?do=login&post='.urlencode($_GET['post']).
906 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
907 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
908 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
909 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
914 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
915 if (isset($_GET['edit_link'])) {
916 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
920 exit; // Never remove this one! All operations below are reserved for logged in user.
923 // -------- All other functions are reserved for the registered user:
925 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
926 if ($targetPage == Router
::$PAGE_TOOLS) {
928 'pageabsaddr' => index_url($_SERVER),
929 'sslenabled' => is_https($_SERVER),
931 $pluginManager->executeHooks('render_tools', $data);
933 foreach ($data as $key => $value) {
934 $PAGE->assign($key, $value);
937 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
938 $PAGE->renderPage('tools');
942 // -------- User wants to change his/her password.
943 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
944 if ($conf->get('security.open_shaarli')) {
945 die(t('You are not supposed to change a password on an Open Shaarli.'));
948 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
949 if (!$sessionManager->checkToken($_POST['token'])) {
950 die(t('Wrong token.')); // Go away!
953 // Make sure old password is correct.
955 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
957 if ($oldhash != $conf->get('credentials.hash')) {
958 echo '<script>alert("'
959 . t('The old password is not correct.')
960 .'");document.location=\'?do=changepasswd\';</script>';
964 // Salt renders rainbow-tables attacks useless.
965 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
969 $_POST['setpassword']
970 . $conf->get('credentials.login')
971 . $conf->get('credentials.salt')
975 $conf->write($loginManager->isLoggedIn());
976 } catch (Exception
$e) {
978 'ERROR while writing config file after changing password.' . PHP_EOL
.
982 // TODO: do not handle exceptions/errors in JS.
983 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
986 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
989 // show the change password form.
990 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
991 $PAGE->renderPage('changepassword');
996 // -------- User wants to change configuration
997 if ($targetPage == Router
::$PAGE_CONFIGURE) {
998 if (!empty($_POST['title'])) {
999 if (!$sessionManager->checkToken($_POST['token'])) {
1000 die(t('Wrong token.')); // Go away!
1003 if (!empty($_POST['continent']) && !empty($_POST['city'])
1004 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1006 $tz = $_POST['continent'] . '/' . $_POST['city'];
1008 $conf->set('general.timezone', $tz);
1009 $conf->set('general.title', escape($_POST['title']));
1010 $conf->set('general.header_link', escape($_POST['titleLink']));
1011 $conf->set('resource.theme', escape($_POST['theme']));
1012 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1013 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1014 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1015 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1016 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1017 $conf->set('api.enabled', !empty($_POST['enableApi']));
1018 $conf->set('api.secret', escape($_POST['apiSecret']));
1019 $conf->set('translation.language', escape($_POST['language']));
1021 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1022 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1023 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1025 $_SESSION['warnings'][] = t(
1026 'You have enabled or changed thumbnails mode. '
1027 .'<a href="?do=thumbs_update">Please synchronize them</a>.'
1030 $conf->set('thumbnails.mode', $thumbnailsMode);
1033 $conf->write($loginManager->isLoggedIn());
1034 $history->updateSettings();
1035 invalidateCaches($conf->get('resource.page_cache'));
1036 } catch (Exception
$e) {
1038 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1042 // TODO: do not handle exceptions/errors in JS.
1043 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1046 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1049 // Show the configuration form.
1050 $PAGE->assign('title', $conf->get('general.title'));
1051 $PAGE->assign('theme', $conf->get('resource.theme'));
1052 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1053 list($continents, $cities) = generateTimeZoneData(
1054 timezone_identifiers_list(),
1055 $conf->get('general.timezone')
1057 $PAGE->assign('continents', $continents);
1058 $PAGE->assign('cities', $cities);
1059 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1060 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1061 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1062 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1063 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1064 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1065 $PAGE->assign('api_secret', $conf->get('api.secret'));
1066 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1067 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1068 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1069 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1070 $PAGE->renderPage('configure');
1075 // -------- User wants to rename a tag or delete it
1076 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1077 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1078 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1079 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1080 $PAGE->renderPage('changetag');
1084 if (!$sessionManager->checkToken($_POST['token'])) {
1085 die(t('Wrong token.'));
1088 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1089 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), $toTag);
1090 $LINKSDB->save($conf->get('resource.page_cache'));
1091 foreach ($alteredLinks as $link) {
1092 $history->updateLink($link);
1094 $delete = empty($_POST['totag']);
1095 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1096 $count = count($alteredLinks);
1098 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1099 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1100 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1104 // -------- User wants to add a link without using the bookmarklet: Show form.
1105 if ($targetPage == Router
::$PAGE_ADDLINK) {
1106 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1107 $PAGE->renderPage('addlink');
1111 // -------- User clicked the "Save" button when editing a link: Save link to database.
1112 if (isset($_POST['save_edit'])) {
1114 if (! $sessionManager->checkToken($_POST['token'])) {
1115 die(t('Wrong token.'));
1118 // lf_id should only be present if the link exists.
1119 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1120 // Linkdate is kept here to:
1121 // - use the same permalink for notes as they're displayed when creating them
1122 // - let users hack creation date of their posts
1123 // See: https://shaarli.readthedocs.io/en/master/guides/various-hacks/#changing-the-timestamp-for-a-shaare
1124 $linkdate = escape($_POST['lf_linkdate']);
1125 if (isset($LINKSDB[$id])) {
1127 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1128 $updated = new DateTime();
1129 $shortUrl = $LINKSDB[$id]['shorturl'];
1133 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1135 $shortUrl = link_small_hash($created, $id);
1139 // Remove multiple spaces.
1140 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1141 // Remove first '-' char in tags.
1142 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1143 // Remove duplicates.
1144 $tags = implode(' ', array_unique(explode(' ', $tags)));
1146 if (empty(trim($_POST['lf_url
']))) {
1147 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1149 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1153 'title
' => trim($_POST['lf_title
']),
1155 'description
' => $_POST['lf_description
'],
1156 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1157 'created
' => $created,
1158 'updated
' => $updated,
1159 'tags
' => str_replace(',', ' ', $tags),
1160 'shorturl
' => $shortUrl,
1163 // If title is empty, use the URL as title.
1164 if ($link['title
'] == '') {
1165 $link['title
'] = $link['url
'];
1168 if ($conf->get('thumbnails
.mode
', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE
1169 && ! is_note($link['url
'])
1171 $thumbnailer = new Thumbnailer($conf);
1172 $link['thumbnail
'] = $thumbnailer->get($url);
1175 $link['sticky
'] = isset($link['sticky
']) ? $link['sticky
'] : false;
1177 $pluginManager->executeHooks('save_link
', $link);
1179 $LINKSDB[$id] = $link;
1180 $LINKSDB->save($conf->get('resource.page_cache
'));
1182 $history->addLink($link);
1184 $history->updateLink($link);
1187 // If we are called from the bookmarklet, we must close the popup:
1188 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1189 echo '<script
>self
.close();</script
>';
1193 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1194 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1195 // Scroll to the link which has been edited.
1196 $location .= '#' . $link['shorturl'];
1197 // After saving the link, redirect to the page the user was on.
1198 header('Location: '. $location);
1202 // -------- User clicked the "Cancel" button when editing a link.
1203 if (isset($_POST['cancel_edit'])) {
1204 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1205 if (! isset($LINKSDB[$id])) {
1206 header('Location: ?');
1208 // If we are called from the bookmarklet, we must close the popup:
1209 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1210 echo '<script>self.close();</script>';
1213 $link = $LINKSDB[$id];
1214 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1215 // Scroll to the link which has been edited.
1216 $returnurl .= '#'. $link['shorturl'];
1217 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1218 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1222 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1223 if ($targetPage == Router
::$PAGE_DELETELINK) {
1224 if (! $sessionManager->checkToken($_GET['token'])) {
1225 die(t('Wrong token.'));
1228 $ids = trim($_GET['lf_linkdate']);
1229 if (strpos($ids, ' ') !== false) {
1230 // multiple, space-separated ids provided
1231 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1233 // only a single id provided
1236 // assert at least one id is given
1238 die('no id provided');
1240 foreach ($ids as $id) {
1241 $id = (int) escape($id);
1242 $link = $LINKSDB[$id];
1243 $pluginManager->executeHooks('delete_link', $link);
1244 $history->deleteLink($link);
1245 unset($LINKSDB[$id]);
1247 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1249 // If we are called from the bookmarklet, we must close the popup:
1250 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1251 echo '<script>self.close();</script>';
1256 if (isset($_SERVER['HTTP_REFERER'])) {
1257 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1258 $location = generateLocation(
1259 $_SERVER['HTTP_REFERER'],
1260 $_SERVER['HTTP_HOST'],
1261 ['delete_link', 'edit_link', $link['shorturl']]
1265 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1269 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1270 if (isset($_GET['edit_link'])) {
1271 $id = (int) escape($_GET['edit_link']);
1272 $link = $LINKSDB[$id]; // Read database
1274 header('Location: ?');
1276 } // Link not found in database.
1277 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1280 'link_is_new' => false,
1281 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1282 'tags' => $LINKSDB->linksCountPerTag(),
1284 $pluginManager->executeHooks('render_editlink', $data);
1286 foreach ($data as $key => $value) {
1287 $PAGE->assign($key, $value);
1290 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1291 $PAGE->renderPage('editlink');
1295 // -------- User want to post a new link: Display link edit form.
1296 if (isset($_GET['post'])) {
1297 $url = cleanup_url($_GET['post']);
1299 $link_is_new = false;
1300 // Check if URL is not already in database (in this case, we will edit the existing link)
1301 $link = $LINKSDB->getLinkFromUrl($url);
1303 $link_is_new = true;
1304 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1305 // Get title if it was provided in URL (by the bookmarklet).
1306 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1307 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1308 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1309 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1310 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1312 // If this is an HTTP(S) link, we try go get the page to extract
1313 // the title (otherwise we will to straight to the edit form.)
1314 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1315 // Short timeout to keep the application responsive
1316 // The callback will fill $charset and $title with data from the downloaded page.
1319 $conf->get('general.download_timeout', 30),
1320 $conf->get('general.download_max_size', 4194304),
1321 get_curl_download_callback($charset, $title)
1323 if (! empty($title) && strtolower($charset) != 'utf-8') {
1324 $title = mb_convert_encoding($title, 'utf-8', $charset);
1329 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1330 $title = $conf->get('general.default_note_title', t('Note: '));
1332 $url = escape($url);
1333 $title = escape($title);
1336 'linkdate' => $linkdate,
1339 'description' => $description,
1341 'private' => $private,
1344 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1349 'link_is_new' => $link_is_new,
1350 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1351 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1352 'tags' => $LINKSDB->linksCountPerTag(),
1353 'default_private_links' => $conf->get('privacy.default_private_links', false),
1355 $pluginManager->executeHooks('render_editlink', $data);
1357 foreach ($data as $key => $value) {
1358 $PAGE->assign($key, $value);
1361 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1362 $PAGE->renderPage('editlink');
1366 if ($targetPage == Router
::$PAGE_PINLINK) {
1367 if (! isset($_GET['id']) || empty($LINKSDB[$_GET['id']])) {
1368 // FIXME! Use a proper error system.
1369 $msg = t('Invalid link ID provided');
1370 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1373 if (! $sessionManager->checkToken($_GET['token'])) {
1374 die('Wrong token.');
1377 $link = $LINKSDB[$_GET['id']];
1378 $link['sticky'] = ! $link['sticky'];
1379 $LINKSDB[(int) $_GET['id']] = $link;
1380 $LINKSDB->save($conf->get('resource.page_cache'));
1381 header('Location: '.index_url($_SERVER));
1385 if ($targetPage == Router
::$PAGE_EXPORT) {
1386 // Export links as a Netscape Bookmarks file
1388 if (empty($_GET['selection'])) {
1389 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1390 $PAGE->renderPage('export');
1394 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1395 $selection = $_GET['selection'];
1396 if (isset($_GET['prepend_note_url'])) {
1397 $prependNoteUrl = $_GET['prepend_note_url'];
1399 $prependNoteUrl = false;
1405 NetscapeBookmarkUtils
::filterAndFormat(
1412 } catch (Exception
$exc) {
1413 header('Content-Type: text/plain; charset=utf-8');
1414 echo $exc->getMessage();
1417 $now = new DateTime();
1418 header('Content-Type: text/html; charset=utf-8');
1420 'Content-disposition: attachment; filename=bookmarks_'
1421 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1423 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1424 $PAGE->assign('eol', PHP_EOL
);
1425 $PAGE->assign('selection', $selection);
1426 $PAGE->renderPage('export.bookmarks');
1430 if ($targetPage == Router
::$PAGE_IMPORT) {
1431 // Upload a Netscape bookmark dump to import its contents
1433 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1434 // Show import dialog
1437 get_max_upload_size(
1438 ini_get('post_max_size'),
1439 ini_get('upload_max_filesize'),
1445 get_max_upload_size(
1446 ini_get('post_max_size'),
1447 ini_get('upload_max_filesize'),
1451 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1452 $PAGE->renderPage('import');
1456 // Import bookmarks from an uploaded file
1457 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1458 // The file is too big or some form field may be missing.
1461 'The file you are trying to upload is probably bigger than what this webserver can accept'
1462 .' (%s). Please upload in smaller chunks.'
1464 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1466 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1469 if (! $sessionManager->checkToken($_POST['token'])) {
1470 die('Wrong token.');
1472 $status = NetscapeBookmarkUtils
::import(
1479 echo '<script>alert("'.$status.'");document.location=\'?do='
1480 .Router
::$PAGE_IMPORT .'\';</script>';
1484 // Plugin administration page
1485 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1486 $pluginMeta = $pluginManager->getPluginsMeta();
1488 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1489 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1490 return $v['order'] !== false;
1493 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1497 return $a['order'] - $b['order'];
1500 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1501 return $v['order'] === false;
1504 $PAGE->assign('enabledPlugins', $enabledPlugins);
1505 $PAGE->assign('disabledPlugins', $disabledPlugins);
1506 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1507 $PAGE->renderPage('pluginsadmin');
1511 // Plugin administration form action
1512 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1514 if (isset($_POST['parameters_form'])) {
1515 unset($_POST['parameters_form']);
1516 foreach ($_POST as $param => $value) {
1517 $conf->set('plugins.'. $param, escape($value));
1520 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1522 $conf->write($loginManager->isLoggedIn());
1523 $history->updateSettings();
1524 } catch (Exception
$e) {
1526 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1530 // TODO: do not handle exceptions/errors in JS.
1531 echo '<script>alert("'
1533 .'");document.location=\'?do='
1534 . Router
::$PAGE_PLUGINSADMIN
1538 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1542 // Get a fresh token
1543 if ($targetPage == Router
::$GET_TOKEN) {
1544 header('Content-Type:text/plain');
1545 echo $sessionManager->generateToken($conf);
1549 // -------- Thumbnails Update
1550 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1552 foreach ($LINKSDB as $link) {
1553 // A note or not HTTP(S)
1554 if (is_note($link['url']) || ! startsWith(strtolower($link['url']), 'http')) {
1557 $ids[] = $link['id'];
1559 $PAGE->assign('ids', $ids);
1560 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1561 $PAGE->renderPage('thumbnails');
1565 // -------- Single Thumbnail Update
1566 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1567 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1568 http_response_code(400);
1571 $id = (int) $_POST['id'];
1572 if (empty($LINKSDB[$id])) {
1573 http_response_code(404);
1576 $thumbnailer = new Thumbnailer($conf);
1577 $link = $LINKSDB[$id];
1578 $link['thumbnail'] = $thumbnailer->get($link['url']);
1579 $LINKSDB[$id] = $link;
1580 $LINKSDB->save($conf->get('resource.page_cache'));
1582 echo json_encode($link);
1586 // -------- Otherwise, simply display search form and links:
1587 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
1592 * Template for the list of links (<div id="linklist">)
1593 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1595 * @param pageBuilder $PAGE pageBuilder instance.
1596 * @param LinkDB $LINKSDB LinkDB instance.
1597 * @param ConfigManager $conf Configuration Manager instance.
1598 * @param PluginManager $pluginManager Plugin Manager instance.
1599 * @param LoginManager $loginManager LoginManager instance
1601 function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
1603 // Used in templates
1604 if (isset($_GET['searchtags'])) {
1605 if (! empty($_GET['searchtags'])) {
1606 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1608 $searchtags = false;
1613 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1616 if (! empty($_SERVER['QUERY_STRING'])
1617 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1619 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1620 } catch (LinkNotFoundException
$e) {
1621 $PAGE->render404($e->getMessage());
1625 // Filter links according search parameters.
1626 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1628 'searchtags' => $searchtags,
1629 'searchterm' => $searchterm,
1631 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1634 // ---- Handle paging.
1636 foreach ($linksToDisplay as $key => $value) {
1640 // Select articles according to paging.
1641 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1642 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1643 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1644 $page = $page < 1 ? 1 : $page;
1645 $page = $page > $pagecount ? $pagecount : $page;
1647 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1648 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1650 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1651 if ($thumbnailsEnabled) {
1652 $thumbnailer = new Thumbnailer($conf);
1655 $linkDisp = array();
1656 while ($i<$end && $i<count($keys)) {
1657 $link = $linksToDisplay[$keys[$i]];
1658 $link['description'] = format_description($link['description']);
1659 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1660 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1661 $link['timestamp'] = $link['created']->getTimestamp();
1662 if (! empty($link['updated'])) {
1663 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1665 $link['updated_timestamp'] = '';
1667 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1668 uasort($taglist, 'strcasecmp');
1669 $link['taglist'] = $taglist;
1671 // Logged in, thumbnails enabled, not a note,
1672 // and (never retrieved yet or no valid cache file)
1673 if ($loginManager->isLoggedIn() && $thumbnailsEnabled && $link['url'][0] != '?'
1674 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
1676 $elem = $LINKSDB[$keys[$i]];
1677 $elem['thumbnail'] = $thumbnailer->get($link['url']);
1678 $LINKSDB[$keys[$i]] = $elem;
1680 $link['thumbnail'] = $elem['thumbnail'];
1683 // Check for both signs of a note: starting with ? and 7 chars long.
1684 if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1685 $link['url'] = index_url($_SERVER) . $link['url'];
1688 $linkDisp[$keys[$i]] = $link;
1692 // If we retrieved new thumbnails, we update the database.
1693 if (!empty($updateDB)) {
1694 $LINKSDB->save($conf->get('resource.page_cache'));
1697 // Compute paging navigation
1698 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1699 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1700 $previous_page_url = '';
1701 if ($i != count($keys)) {
1702 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1706 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1709 // Fill all template fields.
1711 'previous_page_url' => $previous_page_url,
1712 'next_page_url' => $next_page_url,
1713 'page_current' => $page,
1714 'page_max' => $pagecount,
1715 'result_count' => count($linksToDisplay),
1716 'search_term' => $searchterm,
1717 'search_tags' => $searchtags,
1718 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1719 'links' => $linkDisp,
1722 // If there is only a single link, we change on-the-fly the title of the page.
1723 if (count($linksToDisplay) == 1) {
1724 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1725 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1726 $data['pagetitle'] = t('Search: ');
1727 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1728 $bracketWrap = function ($tag) {
1729 return '['. $tag .']';
1731 $data['pagetitle'] .= ! empty($searchtags)
1732 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1734 $data['pagetitle'] .= '- '. $conf->get('general.title');
1737 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1739 foreach ($data as $key => $value) {
1740 $PAGE->assign($key, $value);
1748 * This function should NEVER be called if the file data/config.php exists.
1750 * @param ConfigManager $conf Configuration Manager instance.
1751 * @param SessionManager $sessionManager SessionManager instance
1752 * @param LoginManager $loginManager LoginManager instance
1754 function install($conf, $sessionManager, $loginManager)
1756 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1757 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1758 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1762 // This part makes sure sessions works correctly.
1763 // (Because on some hosts, session.save_path may not be set correctly,
1764 // or we may not have write access to it.)
1765 if (isset($_GET['test_session'])
1766 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1767 // Step 2: Check if data in session is correct.
1769 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1770 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1771 'and that you have write access to it.<br>'.
1772 'It currently points to %s.<br>'.
1773 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1774 'or any custom hostname without a dot causes cookie storage to fail. '.
1775 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1777 $msg = sprintf($msg, session_save_path());
1779 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1782 if (!isset($_SESSION['session_tested'])) {
1783 // Step 1 : Try to store data in session and reload page.
1784 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1785 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1787 if (isset($_GET['test_session'])) {
1788 // Step 3: Sessions are OK. Remove test parameter from URL.
1789 header('Location: '.index_url($_SERVER));
1793 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1795 if (!empty($_POST['continent']) && !empty($_POST['city'])
1796 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1798 $tz = $_POST['continent'].'/'.$_POST['city'];
1800 $conf->set('general.timezone', $tz);
1801 $login = $_POST['setlogin'];
1802 $conf->set('credentials.login', $login);
1803 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1804 $conf->set('credentials.salt', $salt);
1805 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1806 if (!empty($_POST['title'])) {
1807 $conf->set('general.title', escape($_POST['title']));
1809 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
1811 $conf->set('translation.language', escape($_POST['language']));
1812 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1813 $conf->set('api.enabled', !empty($_POST['enableApi']));
1816 generate_api_secret(
1817 $conf->get('credentials.login'),
1818 $conf->get('credentials.salt')
1822 // Everything is ok, let's create config file.
1823 $conf->write($loginManager->isLoggedIn());
1824 } catch (Exception
$e) {
1826 'ERROR while writing config file after installation.' . PHP_EOL
.
1830 // TODO: do not handle exceptions/errors in JS.
1831 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1834 echo '<script>alert('
1835 .'"Shaarli is now configured. '
1836 .'Please enter your login/password and start shaaring your links!"'
1837 .');document.location=\'?do=login\';</script>';
1841 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1842 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1843 $PAGE->assign('continents', $continents);
1844 $PAGE->assign('cities', $cities);
1845 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1846 $PAGE->renderPage('install');
1850 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1851 showDailyRSS($conf, $loginManager);
1855 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1856 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1860 $history = new History($conf->get('resource.history'));
1861 } catch (Exception
$e) {
1862 die($e->getMessage());
1865 $linkDb = new LinkDB(
1866 $conf->get('resource.datastore'),
1867 $loginManager->isLoggedIn(),
1868 $conf->get('privacy.hide_public_links')
1871 $container = new \Slim\
Container();
1872 $container['conf'] = $conf;
1873 $container['plugins'] = $pluginManager;
1874 $container['history'] = $history;
1875 $app = new \Slim\
App($container);
1878 $app->group('/api/v1', function () {
1879 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1880 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1881 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1882 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1883 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1884 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1886 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1887 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1888 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1889 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1891 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
1892 })->add('\Shaarli\Api\ApiMiddleware');
1894 $response = $app->run(true);
1896 // Hack to make Slim and Shaarli router work together:
1897 // If a Slim route isn't found and NOT API call, we call renderPage().
1898 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1899 // We use UTF-8 for proper international characters handling.
1900 header('Content-Type: text/html; charset=utf-8');
1901 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1903 $response = $response
1904 ->withHeader('Access-Control-Allow-Origin', '*')
1906 'Access-Control-Allow-Headers',
1907 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1909 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1910 $app->respond($response);