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'),
316 $conf->get('redirector.url'),
317 $conf->get('redirector.encode_url')
320 /* Some Shaarlies may have very few links, so we need to look
321 back in time until we have enough days ($nb_of_days).
323 $nb_of_days = 7; // We take 7 days.
324 $today = date('Ymd');
327 foreach ($LINKSDB as $link) {
328 $day = $link['created']->format('Ymd'); // Extract day (without time)
329 if (strcmp($day, $today) < 0) {
330 if (empty($days[$day])) {
331 $days[$day] = array();
333 $days[$day][] = $link;
336 if (count($days) > $nb_of_days) {
337 break; // Have we collected enough days?
341 // Build the RSS feed.
342 header('Content-Type: application/rss+xml; charset=utf-8');
343 $pageaddr = escape(index_url($_SERVER));
344 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
346 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
347 echo '<link>'. $pageaddr .'</link>';
348 echo '<description>Daily shared links</description>';
349 echo '<language>en-en</language>';
350 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
353 foreach ($days as $day => $links) {
354 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
355 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
357 // We pre-format some fields for proper output.
358 foreach ($links as &$link) {
359 $link['formatedDescription'] = format_description(
360 $link['description'],
361 $conf->get('redirector.url'),
362 $conf->get('redirector.encode_url')
364 $link['timestamp'] = $link['created']->getTimestamp();
365 if (startsWith($link['url'], '?')) {
366 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
370 // Then build the HTML for this day:
372 $tpl->assign('title', $conf->get('general.title'));
373 $tpl->assign('daydate', $dayDate->getTimestamp());
374 $tpl->assign('absurl', $absurl);
375 $tpl->assign('links', $links);
376 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
377 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
378 $tpl->assign('index_url', $pageaddr);
379 $html = $tpl->draw('dailyrss', true);
381 echo $html . PHP_EOL
;
383 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
385 $cache->cache(ob_get_contents());
391 * Show the 'Daily' page.
393 * @param PageBuilder $pageBuilder Template engine wrapper.
394 * @param LinkDB $LINKSDB LinkDB instance.
395 * @param ConfigManager $conf Configuration Manager instance.
396 * @param PluginManager $pluginManager Plugin Manager instance.
397 * @param LoginManager $loginManager Login Manager instance
399 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager, $loginManager)
401 $day = date('Ymd', strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
402 if (isset($_GET['day'])) {
406 $days = $LINKSDB->days();
407 $i = array_search($day, $days);
408 if ($i === false && count($days)) {
409 // no links for day, but at least one day with links
410 $i = count($days) - 1;
418 $previousday=$days[$i - 1];
420 if ($i < count($days) - 1) {
421 $nextday = $days[$i +
1];
425 $linksToDisplay = $LINKSDB->filterDay($day);
426 } catch (Exception
$exc) {
428 $linksToDisplay = array();
431 // We pre-format some fields for proper output.
432 foreach ($linksToDisplay as $key => $link) {
433 $taglist = explode(' ', $link['tags']);
434 uasort($taglist, 'strcasecmp');
435 $linksToDisplay[$key]['taglist']=$taglist;
436 $linksToDisplay[$key]['formatedDescription'] = format_description(
437 $link['description'],
438 $conf->get('redirector.url'),
439 $conf->get('redirector.encode_url')
441 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
444 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
446 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
447 'linksToDisplay' => $linksToDisplay,
448 'day' => $dayDate->getTimestamp(),
449 'dayDate' => $dayDate,
450 'previousday' => $previousday,
451 'nextday' => $nextday,
454 /* Hook is called before column construction so that plugins don't have
455 to deal with columns. */
456 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
458 /* We need to spread the articles on 3 columns.
459 I did not want to use a JavaScript lib like http://masonry.desandro.com/
460 so I manually spread entries with a simple method: I roughly evaluate the
461 height of a div according to title and description length.
463 $columns = array(array(), array(), array()); // Entries to display, for each column.
464 $fill = array(0, 0, 0); // Rough estimate of columns fill.
465 foreach ($data['linksToDisplay'] as $key => $link) {
466 // Roughly estimate length of entry (by counting characters)
467 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
468 // Description: 836 characters gives roughly 342 pixel height.
469 // This is not perfect, but it's usually OK.
470 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
471 if ($link['thumbnail']) {
472 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
474 // Then put in column which is the less filled:
475 $smallest = min($fill); // find smallest value in array.
476 $index = array_search($smallest, $fill); // find index of this smallest value.
477 array_push($columns[$index], $link); // Put entry in this column.
478 $fill[$index] +
= $length;
481 $data['cols'] = $columns;
483 foreach ($data as $key => $value) {
484 $pageBuilder->assign($key, $value);
487 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
488 $pageBuilder->renderPage('daily');
493 * Renders the linklist
495 * @param pageBuilder $PAGE pageBuilder instance.
496 * @param LinkDB $LINKSDB LinkDB instance.
497 * @param ConfigManager $conf Configuration Manager instance.
498 * @param PluginManager $pluginManager Plugin Manager instance.
500 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
502 buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
503 $PAGE->renderPage('linklist');
507 * Render HTML page (according to URL parameters and user rights)
509 * @param ConfigManager $conf Configuration Manager instance.
510 * @param PluginManager $pluginManager Plugin Manager instance,
511 * @param LinkDB $LINKSDB
512 * @param History $history instance
513 * @param SessionManager $sessionManager SessionManager instance
514 * @param LoginManager $loginManager LoginManager instance
516 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager, $loginManager)
518 $updater = new Updater(
519 read_updates_file($conf->get('resource.updates')),
522 $loginManager->isLoggedIn(),
526 $newUpdates = $updater->update();
527 if (! empty($newUpdates)) {
529 $conf->get('resource.updates'),
530 $updater->getDoneUpdates()
533 } catch (Exception
$e) {
534 die($e->getMessage());
537 $PAGE = new PageBuilder($conf, $_SESSION, $LINKSDB, $sessionManager->generateToken(), $loginManager->isLoggedIn());
538 $PAGE->assign('linkcount', count($LINKSDB));
539 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
540 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
542 // Determine which page will be rendered.
543 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
544 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
546 if (// if the user isn't logged in
547 !$loginManager->isLoggedIn() &&
548 // and Shaarli doesn't have public content...
549 $conf->get('privacy.hide_public_links') &&
550 // and is configured to enforce the login
551 $conf->get('privacy.force_login') &&
552 // and the current page isn't already the login page
553 $targetPage !== Router
::$PAGE_LOGIN &&
554 // and the user is not requesting a feed (which would lead to a different content-type as expected)
555 $targetPage !== Router
::$PAGE_FEED_ATOM &&
556 $targetPage !== Router
::$PAGE_FEED_RSS
558 // force current page to be the login page
559 $targetPage = Router
::$PAGE_LOGIN;
562 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
563 // Then assign generated data to RainTPL.
564 $common_hooks = array(
570 foreach ($common_hooks as $name) {
571 $plugin_data = array();
572 $pluginManager->executeHooks(
576 'target' => $targetPage,
577 'loggedin' => $loginManager->isLoggedIn()
580 $PAGE->assign('plugins_' . $name, $plugin_data);
583 // -------- Display login form.
584 if ($targetPage == Router
::$PAGE_LOGIN) {
585 if ($conf->get('security.open_shaarli')) {
586 header('Location: ?');
588 } // No need to login for open Shaarli
589 if (isset($_GET['username'])) {
590 $PAGE->assign('username', escape($_GET['username']));
592 $PAGE->assign('returnurl', (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
593 // add default state of the 'remember me' checkbox
594 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
595 $PAGE->assign('user_can_login', $loginManager->canLogin($_SERVER));
596 $PAGE->assign('pagetitle', t('Login') .' - '. $conf->get('general.title', 'Shaarli'));
597 $PAGE->renderPage('loginform');
600 // -------- User wants to logout.
601 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
602 invalidateCaches($conf->get('resource.page_cache'));
603 $sessionManager->logout();
604 setcookie(LoginManager
::$STAY_SIGNED_IN_COOKIE, 'false', 0, WEB_PATH
);
605 header('Location: ?');
609 // -------- Picture wall
610 if ($targetPage == Router
::$PAGE_PICWALL) {
611 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
612 if (! $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) === Thumbnailer
::MODE_NONE
) {
613 $PAGE->assign('linksToDisplay', []);
614 $PAGE->renderPage('picwall');
618 // Optionally filter the results:
619 $links = $LINKSDB->filterSearch($_GET);
620 $linksToDisplay = array();
622 // Get only links which have a thumbnail.
623 // Note: we do not retrieve thumbnails here, the request is too heavy.
624 foreach ($links as $key => $link) {
625 if (isset($link['thumbnail']) && $link['thumbnail'] !== false) {
626 $linksToDisplay[] = $link; // Add to array.
631 'linksToDisplay' => $linksToDisplay,
633 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => $loginManager->isLoggedIn()));
635 foreach ($data as $key => $value) {
636 $PAGE->assign($key, $value);
640 $PAGE->renderPage('picwall');
644 // -------- Tag cloud
645 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
646 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
647 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
648 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
650 // We sort tags alphabetically, then choose a font size according to count.
651 // First, find max value.
653 foreach ($tags as $value) {
654 $maxcount = max($maxcount, $value);
657 alphabetical_sort($tags, false, true);
660 foreach ($tags as $key => $value) {
661 if (in_array($key, $filteringTags)) {
664 // Tag font size scaling:
665 // default 15 and 30 logarithm bases affect scaling,
666 // 22 and 6 are arbitrary font sizes for max and min sizes.
667 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
668 $tagList[$key] = array(
670 'size' => number_format($size, 2, '.', ''),
674 $searchTags = implode(' ', escape($filteringTags));
676 'search_tags' => $searchTags,
679 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
681 foreach ($data as $key => $value) {
682 $PAGE->assign($key, $value);
685 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
686 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
687 $PAGE->renderPage('tag.cloud');
692 if ($targetPage == Router
::$PAGE_TAGLIST) {
693 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
694 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
695 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
696 foreach ($filteringTags as $tag) {
697 if (array_key_exists($tag, $tags)) {
702 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
703 alphabetical_sort($tags, false, true);
706 $searchTags = implode(' ', escape($filteringTags));
708 'search_tags' => $searchTags,
711 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
713 foreach ($data as $key => $value) {
714 $PAGE->assign($key, $value);
717 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
718 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
719 $PAGE->renderPage('tag.list');
724 if ($targetPage == Router
::$PAGE_DAILY) {
725 showDaily($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
728 // ATOM and RSS feed.
729 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
730 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
731 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
734 $query = $_SERVER['QUERY_STRING'];
735 $cache = new CachedPage(
736 $conf->get('resource.page_cache'),
738 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
740 $cached = $cache->cachedVersion();
741 if (!empty($cached)) {
747 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, $loginManager->isLoggedIn());
748 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
749 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
750 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
751 $data = $feedGenerator->buildData();
753 // Process plugin hook.
754 $pluginManager->executeHooks('render_feed', $data, array(
755 'loggedin' => $loginManager->isLoggedIn(),
756 'target' => $targetPage,
759 // Render the template.
760 $PAGE->assignAll($data);
761 $PAGE->renderPage('feed.'. $feedType);
762 $cache->cache(ob_get_contents());
767 // Display opensearch plugin (XML)
768 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
769 header('Content-Type: application/xml; charset=utf-8');
770 $PAGE->assign('serverurl', index_url($_SERVER));
771 $PAGE->renderPage('opensearch');
775 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
776 if (isset($_GET['addtag'])) {
777 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
778 if (empty($_SERVER['HTTP_REFERER'])) {
779 // In case browser does not send HTTP_REFERER
780 header('Location: ?searchtags='.urlencode($_GET['addtag']));
783 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
785 // Prevent redirection loop
786 if (isset($params['addtag'])) {
787 unset($params['addtag']);
790 // Check if this tag is already in the search query and ignore it if it is.
791 // Each tag is always separated by a space
792 if (isset($params['searchtags'])) {
793 $current_tags = explode(' ', $params['searchtags']);
795 $current_tags = array();
798 foreach ($current_tags as $value) {
799 if ($value === $_GET['addtag']) {
804 // Append the tag if necessary
805 if (empty($params['searchtags'])) {
806 $params['searchtags'] = trim($_GET['addtag']);
808 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
811 // We also remove page (keeping the same page has no sense, since the
812 // results are different)
813 unset($params['page']);
815 header('Location: ?'.http_build_query($params));
819 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
820 if (isset($_GET['removetag'])) {
821 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
822 if (empty($_SERVER['HTTP_REFERER'])) {
823 header('Location: ?');
827 // In case browser does not send HTTP_REFERER
828 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
830 // Prevent redirection loop
831 if (isset($params['removetag'])) {
832 unset($params['removetag']);
835 if (isset($params['searchtags'])) {
836 $tags = explode(' ', $params['searchtags']);
837 // Remove value from array $tags.
838 $tags = array_diff($tags, array($_GET['removetag']));
839 $params['searchtags'] = implode(' ', $tags);
841 if (empty($params['searchtags'])) {
842 unset($params['searchtags']);
845 // We also remove page (keeping the same page has no sense, since
846 // the results are different)
847 unset($params['page']);
849 header('Location: ?'.http_build_query($params));
853 // -------- User wants to change the number of links per page (linksperpage=...)
854 if (isset($_GET['linksperpage'])) {
855 if (is_numeric($_GET['linksperpage'])) {
856 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
859 if (! empty($_SERVER['HTTP_REFERER'])) {
860 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
864 header('Location: '. $location);
868 // -------- User wants to see only private links (toggle)
869 if (isset($_GET['visibility'])) {
870 if ($_GET['visibility'] === 'private') {
871 // Visibility not set or not already private, set private, otherwise reset it
872 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
873 // See only private links
874 $_SESSION['visibility'] = 'private';
876 unset($_SESSION['visibility']);
878 } elseif ($_GET['visibility'] === 'public') {
879 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
880 // See only public links
881 $_SESSION['visibility'] = 'public';
883 unset($_SESSION['visibility']);
887 if (! empty($_SERVER['HTTP_REFERER'])) {
888 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
892 header('Location: '. $location);
896 // -------- User wants to see only untagged links (toggle)
897 if (isset($_GET['untaggedonly'])) {
898 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
900 if (! empty($_SERVER['HTTP_REFERER'])) {
901 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
905 header('Location: '. $location);
909 // -------- Handle other actions allowed for non-logged in users:
910 if (!$loginManager->isLoggedIn()) {
911 // User tries to post new link but is not logged in:
912 // Show login screen, then redirect to ?post=...
913 if (isset($_GET['post'])) {
914 header( // Redirect to login page, then back to post link.
915 'Location: ?do=login&post='.urlencode($_GET['post']).
916 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
917 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
918 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
919 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
924 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
925 if (isset($_GET['edit_link'])) {
926 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
930 exit; // Never remove this one! All operations below are reserved for logged in user.
933 // -------- All other functions are reserved for the registered user:
935 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
936 if ($targetPage == Router
::$PAGE_TOOLS) {
938 'pageabsaddr' => index_url($_SERVER),
939 'sslenabled' => is_https($_SERVER),
941 $pluginManager->executeHooks('render_tools', $data);
943 foreach ($data as $key => $value) {
944 $PAGE->assign($key, $value);
947 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
948 $PAGE->renderPage('tools');
952 // -------- User wants to change his/her password.
953 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
954 if ($conf->get('security.open_shaarli')) {
955 die(t('You are not supposed to change a password on an Open Shaarli.'));
958 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
959 if (!$sessionManager->checkToken($_POST['token'])) {
960 die(t('Wrong token.')); // Go away!
963 // Make sure old password is correct.
965 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
967 if ($oldhash != $conf->get('credentials.hash')) {
968 echo '<script>alert("'
969 . t('The old password is not correct.')
970 .'");document.location=\'?do=changepasswd\';</script>';
974 // Salt renders rainbow-tables attacks useless.
975 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
979 $_POST['setpassword']
980 . $conf->get('credentials.login')
981 . $conf->get('credentials.salt')
985 $conf->write($loginManager->isLoggedIn());
986 } catch (Exception
$e) {
988 'ERROR while writing config file after changing password.' . PHP_EOL
.
992 // TODO: do not handle exceptions/errors in JS.
993 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
996 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
999 // show the change password form.
1000 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
1001 $PAGE->renderPage('changepassword');
1006 // -------- User wants to change configuration
1007 if ($targetPage == Router
::$PAGE_CONFIGURE) {
1008 if (!empty($_POST['title'])) {
1009 if (!$sessionManager->checkToken($_POST['token'])) {
1010 die(t('Wrong token.')); // Go away!
1013 if (!empty($_POST['continent']) && !empty($_POST['city'])
1014 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1016 $tz = $_POST['continent'] . '/' . $_POST['city'];
1018 $conf->set('general.timezone', $tz);
1019 $conf->set('general.title', escape($_POST['title']));
1020 $conf->set('general.header_link', escape($_POST['titleLink']));
1021 $conf->set('resource.theme', escape($_POST['theme']));
1022 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1023 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1024 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1025 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1026 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1027 $conf->set('api.enabled', !empty($_POST['enableApi']));
1028 $conf->set('api.secret', escape($_POST['apiSecret']));
1029 $conf->set('translation.language', escape($_POST['language']));
1031 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1032 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1033 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1035 $_SESSION['warnings'][] = t(
1036 'You have enabled or changed thumbnails mode. '
1037 .'<a href="?do=thumbs_update">Please synchronize them</a>.'
1040 $conf->set('thumbnails.mode', $thumbnailsMode);
1043 $conf->write($loginManager->isLoggedIn());
1044 $history->updateSettings();
1045 invalidateCaches($conf->get('resource.page_cache'));
1046 } catch (Exception
$e) {
1048 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1052 // TODO: do not handle exceptions/errors in JS.
1053 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1056 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1059 // Show the configuration form.
1060 $PAGE->assign('title', $conf->get('general.title'));
1061 $PAGE->assign('theme', $conf->get('resource.theme'));
1062 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1063 list($continents, $cities) = generateTimeZoneData(
1064 timezone_identifiers_list(),
1065 $conf->get('general.timezone')
1067 $PAGE->assign('continents', $continents);
1068 $PAGE->assign('cities', $cities);
1069 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1070 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1071 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1072 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1073 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1074 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1075 $PAGE->assign('api_secret', $conf->get('api.secret'));
1076 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1077 $PAGE->assign('language', $conf->get('translation.language'));
1078 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1079 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1080 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1081 $PAGE->renderPage('configure');
1086 // -------- User wants to rename a tag or delete it
1087 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1088 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1089 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1090 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1091 $PAGE->renderPage('changetag');
1095 if (!$sessionManager->checkToken($_POST['token'])) {
1096 die(t('Wrong token.'));
1099 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1100 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), $toTag);
1101 $LINKSDB->save($conf->get('resource.page_cache'));
1102 foreach ($alteredLinks as $link) {
1103 $history->updateLink($link);
1105 $delete = empty($_POST['totag']);
1106 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1107 $count = count($alteredLinks);
1109 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1110 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1111 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1115 // -------- User wants to add a link without using the bookmarklet: Show form.
1116 if ($targetPage == Router
::$PAGE_ADDLINK) {
1117 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1118 $PAGE->renderPage('addlink');
1122 // -------- User clicked the "Save" button when editing a link: Save link to database.
1123 if (isset($_POST['save_edit'])) {
1125 if (! $sessionManager->checkToken($_POST['token'])) {
1126 die(t('Wrong token.'));
1129 // lf_id should only be present if the link exists.
1130 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1131 // Linkdate is kept here to:
1132 // - use the same permalink for notes as they're displayed when creating them
1133 // - let users hack creation date of their posts
1134 // See: https://shaarli.readthedocs.io/en/master/guides/various-hacks/#changing-the-timestamp-for-a-shaare
1135 $linkdate = escape($_POST['lf_linkdate']);
1136 if (isset($LINKSDB[$id])) {
1138 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1139 $updated = new DateTime();
1140 $shortUrl = $LINKSDB[$id]['shorturl'];
1144 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1146 $shortUrl = link_small_hash($created, $id);
1150 // Remove multiple spaces.
1151 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1152 // Remove first '-' char in tags.
1153 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1154 // Remove duplicates.
1155 $tags = implode(' ', array_unique(explode(' ', $tags)));
1157 if (empty(trim($_POST['lf_url
']))) {
1158 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1160 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1164 'title
' => trim($_POST['lf_title
']),
1166 'description
' => $_POST['lf_description
'],
1167 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1168 'created
' => $created,
1169 'updated
' => $updated,
1170 'tags
' => str_replace(',', ' ', $tags),
1171 'shorturl
' => $shortUrl,
1174 // If title is empty, use the URL as title.
1175 if ($link['title
'] == '') {
1176 $link['title
'] = $link['url
'];
1179 if ($conf->get('thumbnails
.mode
', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE) {
1180 $thumbnailer = new Thumbnailer($conf);
1181 $link['thumbnail
'] = $thumbnailer->get($url);
1184 $pluginManager->executeHooks('save_link
', $link);
1186 $LINKSDB[$id] = $link;
1187 $LINKSDB->save($conf->get('resource.page_cache
'));
1189 $history->addLink($link);
1191 $history->updateLink($link);
1194 // If we are called from the bookmarklet, we must close the popup:
1195 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1196 echo '<script
>self
.close();</script
>';
1200 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1201 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1202 // Scroll to the link which has been edited.
1203 $location .= '#' . $link['shorturl'];
1204 // After saving the link, redirect to the page the user was on.
1205 header('Location: '. $location);
1209 // -------- User clicked the "Cancel" button when editing a link.
1210 if (isset($_POST['cancel_edit'])) {
1211 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1212 if (! isset($LINKSDB[$id])) {
1213 header('Location: ?');
1215 // If we are called from the bookmarklet, we must close the popup:
1216 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1217 echo '<script>self.close();</script>';
1220 $link = $LINKSDB[$id];
1221 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1222 // Scroll to the link which has been edited.
1223 $returnurl .= '#'. $link['shorturl'];
1224 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1225 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1229 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1230 if ($targetPage == Router
::$PAGE_DELETELINK) {
1231 if (! $sessionManager->checkToken($_GET['token'])) {
1232 die(t('Wrong token.'));
1235 $ids = trim($_GET['lf_linkdate']);
1236 if (strpos($ids, ' ') !== false) {
1237 // multiple, space-separated ids provided
1238 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1240 // only a single id provided
1243 // assert at least one id is given
1245 die('no id provided');
1247 foreach ($ids as $id) {
1248 $id = (int) escape($id);
1249 $link = $LINKSDB[$id];
1250 $pluginManager->executeHooks('delete_link', $link);
1251 $history->deleteLink($link);
1252 unset($LINKSDB[$id]);
1254 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1256 // If we are called from the bookmarklet, we must close the popup:
1257 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1258 echo '<script>self.close();</script>';
1263 if (isset($_SERVER['HTTP_REFERER'])) {
1264 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1265 $location = generateLocation(
1266 $_SERVER['HTTP_REFERER'],
1267 $_SERVER['HTTP_HOST'],
1268 ['delete_link', 'edit_link', $link['shorturl']]
1272 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1276 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1277 if (isset($_GET['edit_link'])) {
1278 $id = (int) escape($_GET['edit_link']);
1279 $link = $LINKSDB[$id]; // Read database
1281 header('Location: ?');
1283 } // Link not found in database.
1284 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1287 'link_is_new' => false,
1288 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1289 'tags' => $LINKSDB->linksCountPerTag(),
1291 $pluginManager->executeHooks('render_editlink', $data);
1293 foreach ($data as $key => $value) {
1294 $PAGE->assign($key, $value);
1297 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1298 $PAGE->renderPage('editlink');
1302 // -------- User want to post a new link: Display link edit form.
1303 if (isset($_GET['post'])) {
1304 $url = cleanup_url($_GET['post']);
1306 $link_is_new = false;
1307 // Check if URL is not already in database (in this case, we will edit the existing link)
1308 $link = $LINKSDB->getLinkFromUrl($url);
1310 $link_is_new = true;
1311 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1312 // Get title if it was provided in URL (by the bookmarklet).
1313 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1314 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1315 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1316 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1317 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1319 // If this is an HTTP(S) link, we try go get the page to extract
1320 // the title (otherwise we will to straight to the edit form.)
1321 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1322 // Short timeout to keep the application responsive
1323 // The callback will fill $charset and $title with data from the downloaded page.
1326 $conf->get('general.download_timeout', 30),
1327 $conf->get('general.download_max_size', 4194304),
1328 get_curl_download_callback($charset, $title)
1330 if (! empty($title) && strtolower($charset) != 'utf-8') {
1331 $title = mb_convert_encoding($title, 'utf-8', $charset);
1336 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1337 $title = $conf->get('general.default_note_title', t('Note: '));
1339 $url = escape($url);
1340 $title = escape($title);
1343 'linkdate' => $linkdate,
1346 'description' => $description,
1348 'private' => $private,
1351 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1356 'link_is_new' => $link_is_new,
1357 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1358 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1359 'tags' => $LINKSDB->linksCountPerTag(),
1360 'default_private_links' => $conf->get('privacy.default_private_links', false),
1362 $pluginManager->executeHooks('render_editlink', $data);
1364 foreach ($data as $key => $value) {
1365 $PAGE->assign($key, $value);
1368 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1369 $PAGE->renderPage('editlink');
1373 if ($targetPage == Router
::$PAGE_PINLINK) {
1374 if (! isset($_GET['id']) || empty($LINKSDB[$_GET['id']])) {
1375 // FIXME! Use a proper error system.
1376 $msg = t('Invalid link ID provided');
1377 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1380 if (! $sessionManager->checkToken($_GET['token'])) {
1381 die('Wrong token.');
1384 $link = $LINKSDB[$_GET['id']];
1385 $link['sticky'] = ! $link['sticky'];
1386 $LINKSDB[(int) $_GET['id']] = $link;
1387 $LINKSDB->save($conf->get('resource.page_cache'));
1388 header('Location: '.index_url($_SERVER));
1392 if ($targetPage == Router
::$PAGE_EXPORT) {
1393 // Export links as a Netscape Bookmarks file
1395 if (empty($_GET['selection'])) {
1396 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1397 $PAGE->renderPage('export');
1401 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1402 $selection = $_GET['selection'];
1403 if (isset($_GET['prepend_note_url'])) {
1404 $prependNoteUrl = $_GET['prepend_note_url'];
1406 $prependNoteUrl = false;
1412 NetscapeBookmarkUtils
::filterAndFormat(
1419 } catch (Exception
$exc) {
1420 header('Content-Type: text/plain; charset=utf-8');
1421 echo $exc->getMessage();
1424 $now = new DateTime();
1425 header('Content-Type: text/html; charset=utf-8');
1427 'Content-disposition: attachment; filename=bookmarks_'
1428 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1430 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1431 $PAGE->assign('eol', PHP_EOL
);
1432 $PAGE->assign('selection', $selection);
1433 $PAGE->renderPage('export.bookmarks');
1437 if ($targetPage == Router
::$PAGE_IMPORT) {
1438 // Upload a Netscape bookmark dump to import its contents
1440 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1441 // Show import dialog
1444 get_max_upload_size(
1445 ini_get('post_max_size'),
1446 ini_get('upload_max_filesize'),
1452 get_max_upload_size(
1453 ini_get('post_max_size'),
1454 ini_get('upload_max_filesize'),
1458 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1459 $PAGE->renderPage('import');
1463 // Import bookmarks from an uploaded file
1464 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1465 // The file is too big or some form field may be missing.
1468 'The file you are trying to upload is probably bigger than what this webserver can accept'
1469 .' (%s). Please upload in smaller chunks.'
1471 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1473 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1476 if (! $sessionManager->checkToken($_POST['token'])) {
1477 die('Wrong token.');
1479 $status = NetscapeBookmarkUtils
::import(
1486 echo '<script>alert("'.$status.'");document.location=\'?do='
1487 .Router
::$PAGE_IMPORT .'\';</script>';
1491 // Plugin administration page
1492 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1493 $pluginMeta = $pluginManager->getPluginsMeta();
1495 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1496 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1497 return $v['order'] !== false;
1500 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1504 return $a['order'] - $b['order'];
1507 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1508 return $v['order'] === false;
1511 $PAGE->assign('enabledPlugins', $enabledPlugins);
1512 $PAGE->assign('disabledPlugins', $disabledPlugins);
1513 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1514 $PAGE->renderPage('pluginsadmin');
1518 // Plugin administration form action
1519 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1521 if (isset($_POST['parameters_form'])) {
1522 unset($_POST['parameters_form']);
1523 foreach ($_POST as $param => $value) {
1524 $conf->set('plugins.'. $param, escape($value));
1527 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1529 $conf->write($loginManager->isLoggedIn());
1530 $history->updateSettings();
1531 } catch (Exception
$e) {
1533 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1537 // TODO: do not handle exceptions/errors in JS.
1538 echo '<script>alert("'
1540 .'");document.location=\'?do='
1541 . Router
::$PAGE_PLUGINSADMIN
1545 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1549 // Get a fresh token
1550 if ($targetPage == Router
::$GET_TOKEN) {
1551 header('Content-Type:text/plain');
1552 echo $sessionManager->generateToken($conf);
1556 // -------- Thumbnails Update
1557 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1559 foreach ($LINKSDB as $link) {
1560 // A note or not HTTP(S)
1561 if ($link['url'][0] === '?' || ! startsWith(strtolower($link['url']), 'http')) {
1564 $ids[] = $link['id'];
1566 $PAGE->assign('ids', $ids);
1567 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1568 $PAGE->renderPage('thumbnails');
1572 // -------- Single Thumbnail Update
1573 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1574 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1575 http_response_code(400);
1578 $id = (int) $_POST['id'];
1579 if (empty($LINKSDB[$id])) {
1580 http_response_code(404);
1583 $thumbnailer = new Thumbnailer($conf);
1584 $link = $LINKSDB[$id];
1585 $link['thumbnail'] = $thumbnailer->get($link['url']);
1586 $LINKSDB[$id] = $link;
1587 $LINKSDB->save($conf->get('resource.page_cache'));
1589 echo json_encode($link);
1593 // -------- Otherwise, simply display search form and links:
1594 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
1599 * Template for the list of links (<div id="linklist">)
1600 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1602 * @param pageBuilder $PAGE pageBuilder instance.
1603 * @param LinkDB $LINKSDB LinkDB instance.
1604 * @param ConfigManager $conf Configuration Manager instance.
1605 * @param PluginManager $pluginManager Plugin Manager instance.
1606 * @param LoginManager $loginManager LoginManager instance
1608 function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
1610 // Used in templates
1611 if (isset($_GET['searchtags'])) {
1612 if (! empty($_GET['searchtags'])) {
1613 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1615 $searchtags = false;
1620 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1623 if (! empty($_SERVER['QUERY_STRING'])
1624 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1626 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1627 } catch (LinkNotFoundException
$e) {
1628 $PAGE->render404($e->getMessage());
1632 // Filter links according search parameters.
1633 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1635 'searchtags' => $searchtags,
1636 'searchterm' => $searchterm,
1638 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1641 // ---- Handle paging.
1643 foreach ($linksToDisplay as $key => $value) {
1647 // Select articles according to paging.
1648 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1649 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1650 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1651 $page = $page < 1 ? 1 : $page;
1652 $page = $page > $pagecount ? $pagecount : $page;
1654 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1655 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1657 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1658 if ($thumbnailsEnabled) {
1659 $thumbnailer = new Thumbnailer($conf);
1662 $linkDisp = array();
1663 while ($i<$end && $i<count($keys)) {
1664 $link = $linksToDisplay[$keys[$i]];
1665 $link['description'] = format_description(
1666 $link['description'],
1667 $conf->get('redirector.url'),
1668 $conf->get('redirector.encode_url')
1670 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1671 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1672 $link['timestamp'] = $link['created']->getTimestamp();
1673 if (! empty($link['updated'])) {
1674 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1676 $link['updated_timestamp'] = '';
1678 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1679 uasort($taglist, 'strcasecmp');
1680 $link['taglist'] = $taglist;
1682 // Logged in, thumbnails enabled, not a note,
1683 // and (never retrieved yet or no valid cache file)
1684 if ($loginManager->isLoggedIn() && $thumbnailsEnabled && $link['url'][0] != '?'
1685 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
1687 $elem = $LINKSDB[$keys[$i]];
1688 $elem['thumbnail'] = $thumbnailer->get($link['url']);
1689 $LINKSDB[$keys[$i]] = $elem;
1691 $link['thumbnail'] = $elem['thumbnail'];
1694 // Check for both signs of a note: starting with ? and 7 chars long.
1695 if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1696 $link['url'] = index_url($_SERVER) . $link['url'];
1699 $linkDisp[$keys[$i]] = $link;
1703 // If we retrieved new thumbnails, we update the database.
1704 if (!empty($updateDB)) {
1705 $LINKSDB->save($conf->get('resource.page_cache'));
1708 // Compute paging navigation
1709 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1710 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1711 $previous_page_url = '';
1712 if ($i != count($keys)) {
1713 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1717 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1720 // Fill all template fields.
1722 'previous_page_url' => $previous_page_url,
1723 'next_page_url' => $next_page_url,
1724 'page_current' => $page,
1725 'page_max' => $pagecount,
1726 'result_count' => count($linksToDisplay),
1727 'search_term' => $searchterm,
1728 'search_tags' => $searchtags,
1729 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1730 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1731 'links' => $linkDisp,
1734 // If there is only a single link, we change on-the-fly the title of the page.
1735 if (count($linksToDisplay) == 1) {
1736 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1737 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1738 $data['pagetitle'] = t('Search: ');
1739 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1740 $bracketWrap = function ($tag) {
1741 return '['. $tag .']';
1743 $data['pagetitle'] .= ! empty($searchtags)
1744 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1746 $data['pagetitle'] .= '- '. $conf->get('general.title');
1749 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1751 foreach ($data as $key => $value) {
1752 $PAGE->assign($key, $value);
1760 * This function should NEVER be called if the file data/config.php exists.
1762 * @param ConfigManager $conf Configuration Manager instance.
1763 * @param SessionManager $sessionManager SessionManager instance
1764 * @param LoginManager $loginManager LoginManager instance
1766 function install($conf, $sessionManager, $loginManager)
1768 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1769 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1770 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1774 // This part makes sure sessions works correctly.
1775 // (Because on some hosts, session.save_path may not be set correctly,
1776 // or we may not have write access to it.)
1777 if (isset($_GET['test_session'])
1778 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1779 // Step 2: Check if data in session is correct.
1781 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1782 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1783 'and that you have write access to it.<br>'.
1784 'It currently points to %s.<br>'.
1785 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1786 'or any custom hostname without a dot causes cookie storage to fail. '.
1787 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1789 $msg = sprintf($msg, session_save_path());
1791 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1794 if (!isset($_SESSION['session_tested'])) {
1795 // Step 1 : Try to store data in session and reload page.
1796 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1797 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1799 if (isset($_GET['test_session'])) {
1800 // Step 3: Sessions are OK. Remove test parameter from URL.
1801 header('Location: '.index_url($_SERVER));
1805 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1807 if (!empty($_POST['continent']) && !empty($_POST['city'])
1808 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1810 $tz = $_POST['continent'].'/'.$_POST['city'];
1812 $conf->set('general.timezone', $tz);
1813 $login = $_POST['setlogin'];
1814 $conf->set('credentials.login', $login);
1815 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1816 $conf->set('credentials.salt', $salt);
1817 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1818 if (!empty($_POST['title'])) {
1819 $conf->set('general.title', escape($_POST['title']));
1821 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
1823 $conf->set('translation.language', escape($_POST['language']));
1824 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1825 $conf->set('api.enabled', !empty($_POST['enableApi']));
1828 generate_api_secret(
1829 $conf->get('credentials.login'),
1830 $conf->get('credentials.salt')
1834 // Everything is ok, let's create config file.
1835 $conf->write($loginManager->isLoggedIn());
1836 } catch (Exception
$e) {
1838 'ERROR while writing config file after installation.' . PHP_EOL
.
1842 // TODO: do not handle exceptions/errors in JS.
1843 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1846 echo '<script>alert('
1847 .'"Shaarli is now configured. '
1848 .'Please enter your login/password and start shaaring your links!"'
1849 .');document.location=\'?do=login\';</script>';
1853 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1854 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1855 $PAGE->assign('continents', $continents);
1856 $PAGE->assign('cities', $cities);
1857 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1858 $PAGE->renderPage('install');
1862 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1863 showDailyRSS($conf, $loginManager);
1867 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1868 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1872 $history = new History($conf->get('resource.history'));
1873 } catch (Exception
$e) {
1874 die($e->getMessage());
1877 $linkDb = new LinkDB(
1878 $conf->get('resource.datastore'),
1879 $loginManager->isLoggedIn(),
1880 $conf->get('privacy.hide_public_links'),
1881 $conf->get('redirector.url'),
1882 $conf->get('redirector.encode_url')
1885 $container = new \Slim\
Container();
1886 $container['conf'] = $conf;
1887 $container['plugins'] = $pluginManager;
1888 $container['history'] = $history;
1889 $app = new \Slim\
App($container);
1892 $app->group('/api/v1', function () {
1893 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1894 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1895 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1896 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1897 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1898 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1900 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1901 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1902 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1903 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1905 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
1906 })->add('\Shaarli\Api\ApiMiddleware');
1908 $response = $app->run(true);
1910 // Hack to make Slim and Shaarli router work together:
1911 // If a Slim route isn't found and NOT API call, we call renderPage().
1912 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1913 // We use UTF-8 for proper international characters handling.
1914 header('Content-Type: text/html; charset=utf-8');
1915 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1917 $response = $response
1918 ->withHeader('Access-Control-Allow-Origin', '*')
1920 'Access-Control-Allow-Headers',
1921 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1923 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1924 $app->respond($response);