3 * Shaarli - The personal, minimalist, super-fast, database free, bookmarking service.
5 * Friendly fork by the Shaarli community:
6 * - https://github.com/shaarli/Shaarli
8 * Original project by sebsauvage.net:
9 * - http://sebsauvage.net/wiki/doku.php?id=php:shaarli
10 * - https://github.com/sebsauvage/Shaarli
12 * Licence: http://www.opensource.org/licenses/zlib-license.php
17 // Set 'UTC' as the default timezone if it is not defined in php.ini
18 // See http://php.net/manual/en/datetime.configuration.php#ini.date.timezone
19 if (date_default_timezone_get() == '') {
20 date_default_timezone_set('UTC');
27 // http://server.com/x/shaarli --> /shaarli/
28 define('WEB_PATH', substr($_SERVER['REQUEST_URI'], 0, 1+
strrpos($_SERVER['REQUEST_URI'], '/', 0)));
30 // High execution time in case of problematic imports/exports.
31 ini_set('max_input_time','60');
33 // Try to set max upload file size and read
34 ini_set('memory_limit', '128M');
35 ini_set('post_max_size', '16M');
36 ini_set('upload_max_filesize', '16M');
38 // See all error except warnings
39 error_reporting(E_ALL^E_WARNING
);
40 // See all errors (for debugging only)
41 //error_reporting(-1);
44 // 3rd-party libraries
45 if (! file_exists(__DIR__
. '/vendor/autoload.php')) {
46 header('Content-Type: text/plain; charset=utf-8');
47 echo "Error: missing Composer configuration\n\n"
48 ."If you installed Shaarli through Git or using the development branch,\n"
49 ."please refer to the installation documentation to install PHP"
50 ." dependencies using Composer:\n"
51 ."- https://shaarli.readthedocs.io/en/master/Server-configuration/\n"
52 ."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/";
55 require_once 'inc/rain.tpl.class.php';
56 require_once __DIR__
. '/vendor/autoload.php';
59 require_once 'application/ApplicationUtils.php';
60 require_once 'application/Cache.php';
61 require_once 'application/CachedPage.php';
62 require_once 'application/config/ConfigPlugin.php';
63 require_once 'application/FeedBuilder.php';
64 require_once 'application/FileUtils.php';
65 require_once 'application/History.php';
66 require_once 'application/HttpUtils.php';
67 require_once 'application/LinkDB.php';
68 require_once 'application/LinkFilter.php';
69 require_once 'application/LinkUtils.php';
70 require_once 'application/NetscapeBookmarkUtils.php';
71 require_once 'application/PageBuilder.php';
72 require_once 'application/TimeZone.php';
73 require_once 'application/Url.php';
74 require_once 'application/Utils.php';
75 require_once 'application/PluginManager.php';
76 require_once 'application/Router.php';
77 require_once 'application/Updater.php';
78 use \Shaarli\Config\ConfigManager
;
79 use \Shaarli\Languages
;
80 use \Shaarli\Security\LoginManager
;
81 use \Shaarli\Security\SessionManager
;
82 use \Shaarli\ThemeUtils
;
83 use \Shaarli\Thumbnailer
;
85 // Ensure the PHP version is supported
87 ApplicationUtils
::checkPHPVersion('5.5', PHP_VERSION
);
88 } catch(Exception
$exc) {
89 header('Content-Type: text/plain; charset=utf-8');
90 echo $exc->getMessage();
94 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
96 // Force cookie path (but do not change lifetime)
97 $cookie = session_get_cookie_params();
99 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
100 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
102 // Set default cookie expiration and path.
103 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
104 // Set session parameters on server side.
105 // Use cookies to store session.
106 ini_set('session.use_cookies', 1);
107 // Force cookies for session (phpsessionID forbidden in URL).
108 ini_set('session.use_only_cookies', 1);
109 // Prevent PHP form using sessionID in URL if cookies are disabled.
110 ini_set('session.use_trans_sid', false);
112 session_name('shaarli');
113 // Start session if needed (Some server auto-start sessions).
114 if (session_id() == '') {
118 // Regenerate session ID if invalid or not defined in cookie.
119 if (isset($_COOKIE['shaarli']) && !SessionManager
::checkId($_COOKIE['shaarli'])) {
120 session_regenerate_id(true);
121 $_COOKIE['shaarli'] = session_id();
124 $conf = new ConfigManager();
125 $sessionManager = new SessionManager($_SESSION, $conf);
126 $loginManager = new LoginManager($GLOBALS, $conf, $sessionManager);
127 $loginManager->generateStaySignedInToken($_SERVER['REMOTE_ADDR']);
128 $clientIpId = client_ip_id($_SERVER);
130 // LC_MESSAGES isn't defined without php-intl, in this case use LC_COLLATE locale instead.
131 if (! defined('LC_MESSAGES')) {
132 define('LC_MESSAGES', LC_COLLATE
);
135 // Sniff browser language and set date format accordingly.
136 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
137 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
140 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
142 $conf->setEmpty('general.timezone', date_default_timezone_get());
143 $conf->setEmpty('general.title', t('Shared links on '). escape(index_url($_SERVER)));
144 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
145 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
147 $pluginManager = new PluginManager($conf);
148 $pluginManager->load($conf->get('general.enabled_plugins'));
150 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
152 ob_start(); // Output buffering for the page cache.
154 // Prevent caching on client side or proxy: (yes, it's ugly)
155 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
156 header("Cache-Control: no-store, no-cache, must-revalidate");
157 header("Cache-Control: post-check=0, pre-check=0", false);
158 header("Pragma: no-cache");
160 if (! is_file($conf->getConfigFileExt())) {
161 // Ensure Shaarli has proper access to its resources
162 $errors = ApplicationUtils
::checkResourcePermissions($conf);
164 if ($errors != array()) {
165 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
167 foreach ($errors as $error) {
168 $message .= '<li>'.$error.'</li>';
172 header('Content-Type: text/html; charset=utf-8');
177 // Display the installation form if no existing config is found
178 install($conf, $sessionManager, $loginManager);
181 $loginManager->checkLoginState($_COOKIE, $clientIpId);
184 * Adapter function to ensure compatibility with third-party templates
186 * @see https://github.com/shaarli/Shaarli/pull/1086
188 * @return bool true when the user is logged in, false otherwise
190 function isLoggedIn()
192 global $loginManager;
193 return $loginManager->isLoggedIn();
197 // ------------------------------------------------------------------------------------------
198 // Process login form: Check if login/password is correct.
199 if (isset($_POST['login'])) {
200 if (! $loginManager->canLogin($_SERVER)) {
201 die(t('I said: NO. You are banned for the moment. Go away.'));
203 if (isset($_POST['password'])
204 && $sessionManager->checkToken($_POST['token'])
205 && $loginManager->checkCredentials($_SERVER['REMOTE_ADDR'], $clientIpId, $_POST['login'], $_POST['password'])
207 $loginManager->handleSuccessfulLogin($_SERVER);
210 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
211 // Note: Never forget the trailing slash on the cookie path!
212 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]) . '/';
215 if (!empty($_POST['longlastingsession'])) {
216 // Keep the session cookie even after the browser closes
217 $sessionManager->setStaySignedIn(true);
218 $expirationTime = $sessionManager->extendSession();
221 $loginManager::$STAY_SIGNED_IN_COOKIE,
222 $loginManager->getStaySignedInToken(),
228 // Standard session expiration (=when browser closes)
232 // Send cookie with the new expiration date to the browser
233 session_set_cookie_params($expirationTime, $cookiedir, $_SERVER['SERVER_NAME']);
234 session_regenerate_id(true);
236 // Optional redirect after login:
237 if (isset($_GET['post'])) {
238 $uri = '?post='. urlencode($_GET['post']);
239 foreach (array('description', 'source', 'title', 'tags') as $param) {
240 if (!empty($_GET[$param])) {
241 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
244 header('Location: '. $uri);
248 if (isset($_GET['edit_link'])) {
249 header('Location: ?edit_link='. escape($_GET['edit_link']));
253 if (isset($_POST['returnurl'])) {
254 // Prevent loops over login screen.
255 if (strpos($_POST['returnurl'], 'do=login') === false) {
256 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
260 header('Location: ?'); exit;
262 $loginManager->handleFailedLogin($_SERVER);
263 $redir = '&username='. urlencode($_POST['login']);
264 if (isset($_GET['post'])) {
265 $redir .= '&post=' . urlencode($_GET['post']);
266 foreach (array('description', 'source', 'title', 'tags') as $param) {
267 if (!empty($_GET[$param])) {
268 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
272 // Redirect to login screen.
273 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
278 // ------------------------------------------------------------------------------------------
279 // Token management for XSRF protection
280 // Token should be used in any form which acts on data (create,update,delete,import...).
281 if (!isset($_SESSION['tokens'])) $_SESSION['tokens']=array(); // Token are attached to the session.
284 * Daily RSS feed: 1 RSS entry per day giving all the links on that day.
285 * Gives the last 7 days (which have links).
286 * This RSS feed cannot be filtered.
288 * @param ConfigManager $conf Configuration Manager instance
289 * @param LoginManager $loginManager LoginManager instance
291 function showDailyRSS($conf, $loginManager) {
293 $query = $_SERVER['QUERY_STRING'];
294 $cache = new CachedPage(
295 $conf->get('config.PAGE_CACHE'),
297 startsWith($query,'do=dailyrss') && !$loginManager->isLoggedIn()
299 $cached = $cache->cachedVersion();
300 if (!empty($cached)) {
305 // If cached was not found (or not usable), then read the database and build the response:
306 // Read links from database (and filter private links if used it not logged in).
307 $LINKSDB = new LinkDB(
308 $conf->get('resource.datastore'),
309 $loginManager->isLoggedIn(),
310 $conf->get('privacy.hide_public_links'),
311 $conf->get('redirector.url'),
312 $conf->get('redirector.encode_url')
315 /* Some Shaarlies may have very few links, so we need to look
316 back in time until we have enough days ($nb_of_days).
318 $nb_of_days = 7; // We take 7 days.
319 $today = date('Ymd');
322 foreach ($LINKSDB as $link) {
323 $day = $link['created']->format('Ymd'); // Extract day (without time)
324 if (strcmp($day, $today) < 0) {
325 if (empty($days[$day])) {
326 $days[$day] = array();
328 $days[$day][] = $link;
331 if (count($days) > $nb_of_days) {
332 break; // Have we collected enough days?
336 // Build the RSS feed.
337 header('Content-Type: application/rss+xml; charset=utf-8');
338 $pageaddr = escape(index_url($_SERVER));
339 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
341 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
342 echo '<link>'. $pageaddr .'</link>';
343 echo '<description>Daily shared links</description>';
344 echo '<language>en-en</language>';
345 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
348 foreach ($days as $day => $links) {
349 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
350 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
352 // We pre-format some fields for proper output.
353 foreach ($links as &$link) {
354 $link['formatedDescription'] = format_description(
355 $link['description'],
356 $conf->get('redirector.url'),
357 $conf->get('redirector.encode_url')
359 $link['timestamp'] = $link['created']->getTimestamp();
360 if (startsWith($link['url'], '?')) {
361 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
365 // Then build the HTML for this day:
367 $tpl->assign('title', $conf->get('general.title'));
368 $tpl->assign('daydate', $dayDate->getTimestamp());
369 $tpl->assign('absurl', $absurl);
370 $tpl->assign('links', $links);
371 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
372 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
373 $tpl->assign('index_url', $pageaddr);
374 $html = $tpl->draw('dailyrss', true);
376 echo $html . PHP_EOL
;
378 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
380 $cache->cache(ob_get_contents());
386 * Show the 'Daily' page.
388 * @param PageBuilder $pageBuilder Template engine wrapper.
389 * @param LinkDB $LINKSDB LinkDB instance.
390 * @param ConfigManager $conf Configuration Manager instance.
391 * @param PluginManager $pluginManager Plugin Manager instance.
392 * @param LoginManager $loginManager Login Manager instance
394 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager, $loginManager)
396 $day = date('Ymd', strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
397 if (isset($_GET['day'])) {
401 $days = $LINKSDB->days();
402 $i = array_search($day, $days);
403 if ($i === false && count($days)) {
404 // no links for day, but at least one day with links
405 $i = count($days) - 1;
413 $previousday=$days[$i - 1];
415 if ($i < count($days) - 1) {
416 $nextday = $days[$i +
1];
420 $linksToDisplay = $LINKSDB->filterDay($day);
421 } catch (Exception
$exc) {
423 $linksToDisplay = array();
426 // We pre-format some fields for proper output.
427 foreach($linksToDisplay as $key => $link) {
428 $taglist = explode(' ',$link['tags']);
429 uasort($taglist, 'strcasecmp');
430 $linksToDisplay[$key]['taglist']=$taglist;
431 $linksToDisplay[$key]['formatedDescription'] = format_description(
432 $link['description'],
433 $conf->get('redirector.url'),
434 $conf->get('redirector.encode_url')
436 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
439 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
441 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
442 'linksToDisplay' => $linksToDisplay,
443 'day' => $dayDate->getTimestamp(),
444 'dayDate' => $dayDate,
445 'previousday' => $previousday,
446 'nextday' => $nextday,
449 /* Hook is called before column construction so that plugins don't have
450 to deal with columns. */
451 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
453 /* We need to spread the articles on 3 columns.
454 I did not want to use a JavaScript lib like http://masonry.desandro.com/
455 so I manually spread entries with a simple method: I roughly evaluate the
456 height of a div according to title and description length.
458 $columns = array(array(), array(), array()); // Entries to display, for each column.
459 $fill = array(0, 0, 0); // Rough estimate of columns fill.
460 foreach($data['linksToDisplay'] as $key => $link) {
461 // Roughly estimate length of entry (by counting characters)
462 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
463 // Description: 836 characters gives roughly 342 pixel height.
464 // This is not perfect, but it's usually OK.
465 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
466 if ($link['thumbnail']) {
467 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
469 // Then put in column which is the less filled:
470 $smallest = min($fill); // find smallest value in array.
471 $index = array_search($smallest, $fill); // find index of this smallest value.
472 array_push($columns[$index], $link); // Put entry in this column.
473 $fill[$index] +
= $length;
476 $data['cols'] = $columns;
478 foreach ($data as $key => $value) {
479 $pageBuilder->assign($key, $value);
482 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
483 $pageBuilder->renderPage('daily');
488 * Renders the linklist
490 * @param pageBuilder $PAGE pageBuilder instance.
491 * @param LinkDB $LINKSDB LinkDB instance.
492 * @param ConfigManager $conf Configuration Manager instance.
493 * @param PluginManager $pluginManager Plugin Manager instance.
495 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager) {
496 buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager, $loginManager);
497 $PAGE->renderPage('linklist');
501 * Render HTML page (according to URL parameters and user rights)
503 * @param ConfigManager $conf Configuration Manager instance.
504 * @param PluginManager $pluginManager Plugin Manager instance,
505 * @param LinkDB $LINKSDB
506 * @param History $history instance
507 * @param SessionManager $sessionManager SessionManager instance
508 * @param LoginManager $loginManager LoginManager instance
510 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager, $loginManager)
512 $updater = new Updater(
513 read_updates_file($conf->get('resource.updates')),
516 $loginManager->isLoggedIn(),
520 $newUpdates = $updater->update();
521 if (! empty($newUpdates)) {
523 $conf->get('resource.updates'),
524 $updater->getDoneUpdates()
528 catch(Exception
$e) {
529 die($e->getMessage());
532 $PAGE = new PageBuilder($conf, $_SESSION, $LINKSDB, $sessionManager->generateToken(), $loginManager->isLoggedIn());
533 $PAGE->assign('linkcount', count($LINKSDB));
534 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
535 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
537 // Determine which page will be rendered.
538 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
539 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
542 // if the user isn't logged in
543 !$loginManager->isLoggedIn() &&
544 // and Shaarli doesn't have public content...
545 $conf->get('privacy.hide_public_links') &&
546 // and is configured to enforce the login
547 $conf->get('privacy.force_login') &&
548 // and the current page isn't already the login page
549 $targetPage !== Router
::$PAGE_LOGIN &&
550 // and the user is not requesting a feed (which would lead to a different content-type as expected)
551 $targetPage !== Router
::$PAGE_FEED_ATOM &&
552 $targetPage !== Router
::$PAGE_FEED_RSS
554 // force current page to be the login page
555 $targetPage = Router
::$PAGE_LOGIN;
558 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
559 // Then assign generated data to RainTPL.
560 $common_hooks = array(
566 foreach($common_hooks as $name) {
567 $plugin_data = array();
568 $pluginManager->executeHooks('render_' . $name, $plugin_data,
570 'target' => $targetPage,
571 'loggedin' => $loginManager->isLoggedIn()
574 $PAGE->assign('plugins_' . $name, $plugin_data);
577 // -------- Display login form.
578 if ($targetPage == Router
::$PAGE_LOGIN)
580 if ($conf->get('security.open_shaarli')) { header('Location: ?'); exit; } // No need to login for open Shaarli
581 if (isset($_GET['username'])) {
582 $PAGE->assign('username', escape($_GET['username']));
584 $PAGE->assign('returnurl',(isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
585 // add default state of the 'remember me' checkbox
586 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
587 $PAGE->assign('user_can_login', $loginManager->canLogin($_SERVER));
588 $PAGE->assign('pagetitle', t('Login') .' - '. $conf->get('general.title', 'Shaarli'));
589 $PAGE->renderPage('loginform');
592 // -------- User wants to logout.
593 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout'))
595 invalidateCaches($conf->get('resource.page_cache'));
596 $sessionManager->logout();
597 setcookie(LoginManager
::$STAY_SIGNED_IN_COOKIE, 'false', 0, WEB_PATH
);
598 header('Location: ?');
602 // -------- Picture wall
603 if ($targetPage == Router
::$PAGE_PICWALL)
605 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
606 if (! $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) === Thumbnailer
::MODE_NONE
) {
607 $PAGE->assign('linksToDisplay', []);
608 $PAGE->renderPage('picwall');
612 // Optionally filter the results:
613 $links = $LINKSDB->filterSearch($_GET);
614 $linksToDisplay = array();
616 // Get only links which have a thumbnail.
617 // Note: we do not retrieve thumbnails here, the request is too heavy.
618 foreach($links as $key => $link)
620 if (isset($link['thumbnail']) && $link['thumbnail'] !== false) {
621 $linksToDisplay[] = $link; // Add to array.
626 'linksToDisplay' => $linksToDisplay,
628 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => $loginManager->isLoggedIn()));
630 foreach ($data as $key => $value) {
631 $PAGE->assign($key, $value);
635 $PAGE->renderPage('picwall');
639 // -------- Tag cloud
640 if ($targetPage == Router
::$PAGE_TAGCLOUD)
642 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
643 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
644 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
646 // We sort tags alphabetically, then choose a font size according to count.
647 // First, find max value.
649 foreach ($tags as $value) {
650 $maxcount = max($maxcount, $value);
653 alphabetical_sort($tags, false, true);
656 foreach($tags as $key => $value) {
657 if (in_array($key, $filteringTags)) {
660 // Tag font size scaling:
661 // default 15 and 30 logarithm bases affect scaling,
662 // 22 and 6 are arbitrary font sizes for max and min sizes.
663 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
664 $tagList[$key] = array(
666 'size' => number_format($size, 2, '.', ''),
670 $searchTags = implode(' ', escape($filteringTags));
672 'search_tags' => $searchTags,
675 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
677 foreach ($data as $key => $value) {
678 $PAGE->assign($key, $value);
681 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
682 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
683 $PAGE->renderPage('tag.cloud');
688 if ($targetPage == Router
::$PAGE_TAGLIST)
690 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
691 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
692 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
693 foreach ($filteringTags as $tag) {
694 if (array_key_exists($tag, $tags)) {
699 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
700 alphabetical_sort($tags, false, true);
703 $searchTags = implode(' ', escape($filteringTags));
705 'search_tags' => $searchTags,
708 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
710 foreach ($data as $key => $value) {
711 $PAGE->assign($key, $value);
714 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
715 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
716 $PAGE->renderPage('tag.list');
721 if ($targetPage == Router
::$PAGE_DAILY) {
722 showDaily($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
725 // ATOM and RSS feed.
726 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
727 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
728 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
731 $query = $_SERVER['QUERY_STRING'];
732 $cache = new CachedPage(
733 $conf->get('resource.page_cache'),
735 startsWith($query,'do='. $targetPage) && !$loginManager->isLoggedIn()
737 $cached = $cache->cachedVersion();
738 if (!empty($cached)) {
744 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, $loginManager->isLoggedIn());
745 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
746 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
747 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
748 $data = $feedGenerator->buildData();
750 // Process plugin hook.
751 $pluginManager->executeHooks('render_feed', $data, array(
752 'loggedin' => $loginManager->isLoggedIn(),
753 'target' => $targetPage,
756 // Render the template.
757 $PAGE->assignAll($data);
758 $PAGE->renderPage('feed.'. $feedType);
759 $cache->cache(ob_get_contents());
764 // Display opensearch plugin (XML)
765 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
766 header('Content-Type: application/xml; charset=utf-8');
767 $PAGE->assign('serverurl', index_url($_SERVER));
768 $PAGE->renderPage('opensearch');
772 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
773 if (isset($_GET['addtag']))
775 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
776 if (empty($_SERVER['HTTP_REFERER'])) { header('Location: ?searchtags='.urlencode($_GET
['addtag'])); exit; } // In case browser does not send HTTP_REFERER
777 parse_str(parse_url($_SERVER['HTTP_REFERER'],PHP_URL_QUERY
), $params);
779 // Prevent redirection loop
780 if (isset($params['addtag'])) {
781 unset($params['addtag']);
784 // Check if this tag is already in the search query and ignore it if it is.
785 // Each tag is always separated by a space
786 if (isset($params['searchtags'])) {
787 $current_tags = explode(' ', $params['searchtags']);
789 $current_tags = array();
792 foreach ($current_tags as $value) {
793 if ($value === $_GET['addtag']) {
798 // Append the tag if necessary
799 if (empty($params['searchtags'])) {
800 $params['searchtags'] = trim($_GET['addtag']);
803 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
806 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
807 header('Location: ?'.http_build_query($params));
811 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
812 if (isset($_GET['removetag'])) {
813 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
814 if (empty($_SERVER['HTTP_REFERER'])) {
815 header('Location: ?');
819 // In case browser does not send HTTP_REFERER
820 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
822 // Prevent redirection loop
823 if (isset($params['removetag'])) {
824 unset($params['removetag']);
827 if (isset($params['searchtags'])) {
828 $tags = explode(' ', $params['searchtags']);
829 // Remove value from array $tags.
830 $tags = array_diff($tags, array($_GET['removetag']));
831 $params['searchtags'] = implode(' ',$tags);
833 if (empty($params['searchtags'])) {
834 unset($params['searchtags']);
837 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
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())
902 // User tries to post new link but is not logged in:
903 // Show login screen, then redirect to ?post=...
904 if (isset($_GET['post']))
906 header( // Redirect to login page, then back to post link.
907 'Location: ?do=login&post='.urlencode($_GET['post']).
908 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
909 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
910 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
911 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
916 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
917 if (isset($_GET['edit_link'])) {
918 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
922 exit; // Never remove this one! All operations below are reserved for logged in user.
925 // -------- All other functions are reserved for the registered user:
927 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
928 if ($targetPage == Router
::$PAGE_TOOLS)
931 'pageabsaddr' => index_url($_SERVER),
932 'sslenabled' => is_https($_SERVER),
934 $pluginManager->executeHooks('render_tools', $data);
936 foreach ($data as $key => $value) {
937 $PAGE->assign($key, $value);
940 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
941 $PAGE->renderPage('tools');
945 // -------- User wants to change his/her password.
946 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD)
948 if ($conf->get('security.open_shaarli')) {
949 die(t('You are not supposed to change a password on an Open Shaarli.'));
952 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword']))
954 if (!$sessionManager->checkToken($_POST['token'])) die(t('Wrong token.')); // Go away!
956 // Make sure old password is correct.
957 $oldhash = sha1($_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt'));
958 if ($oldhash!= $conf->get('credentials.hash')) {
959 echo '<script>alert("'. t('The old password is not correct.') .'");document.location=\'?do=changepasswd\';</script>';
963 // Salt renders rainbow-tables attacks useless.
964 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
965 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $conf->get('credentials.login') . $conf->get('credentials.salt')));
967 $conf->write($loginManager->isLoggedIn());
969 catch(Exception
$e) {
971 'ERROR while writing config file after changing password.' . PHP_EOL
.
975 // TODO: do not handle exceptions/errors in JS.
976 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
979 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
982 else // show the change password form.
984 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
985 $PAGE->renderPage('changepassword');
990 // -------- User wants to change configuration
991 if ($targetPage == Router
::$PAGE_CONFIGURE)
993 if (!empty($_POST['title']) )
995 if (!$sessionManager->checkToken($_POST['token'])) {
996 die(t('Wrong token.')); // Go away!
999 if (!empty($_POST['continent']) && !empty($_POST['city'])
1000 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1002 $tz = $_POST['continent'] . '/' . $_POST['city'];
1004 $conf->set('general.timezone', $tz);
1005 $conf->set('general.title', escape($_POST['title']));
1006 $conf->set('general.header_link', escape($_POST['titleLink']));
1007 $conf->set('resource.theme', escape($_POST['theme']));
1008 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1009 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1010 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1011 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1012 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1013 $conf->set('api.enabled', !empty($_POST['enableApi']));
1014 $conf->set('api.secret', escape($_POST['apiSecret']));
1015 $conf->set('translation.language', escape($_POST['language']));
1017 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1018 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1019 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1021 $_SESSION['warnings'][] = t(
1022 'You have enabled or changed thumbnails mode. <a href="?do=thumbs_update">Please synchronize them</a>.'
1025 $conf->set('thumbnails.mode', $thumbnailsMode);
1028 $conf->write($loginManager->isLoggedIn());
1029 $history->updateSettings();
1030 invalidateCaches($conf->get('resource.page_cache'));
1032 catch(Exception
$e) {
1034 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1038 // TODO: do not handle exceptions/errors in JS.
1039 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1042 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1045 else // Show the configuration form.
1047 $PAGE->assign('title', $conf->get('general.title'));
1048 $PAGE->assign('theme', $conf->get('resource.theme'));
1049 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1050 list($continents, $cities) = generateTimeZoneData(
1051 timezone_identifiers_list(),
1052 $conf->get('general.timezone')
1054 $PAGE->assign('continents', $continents);
1055 $PAGE->assign('cities', $cities);
1056 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1057 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1058 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1059 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1060 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1061 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1062 $PAGE->assign('api_secret', $conf->get('api.secret'));
1063 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1064 $PAGE->assign('language', $conf->get('translation.language'));
1065 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1066 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1067 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1068 $PAGE->renderPage('configure');
1073 // -------- User wants to rename a tag or delete it
1074 if ($targetPage == Router
::$PAGE_CHANGETAG)
1076 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1077 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1078 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1079 $PAGE->renderPage('changetag');
1083 if (!$sessionManager->checkToken($_POST['token'])) {
1084 die(t('Wrong token.'));
1087 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1088 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), $toTag);
1089 $LINKSDB->save($conf->get('resource.page_cache'));
1090 foreach ($alteredLinks as $link) {
1091 $history->updateLink($link);
1093 $delete = empty($_POST['totag']);
1094 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1095 $count = count($alteredLinks);
1097 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1098 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1099 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1103 // -------- User wants to add a link without using the bookmarklet: Show form.
1104 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']))
1115 if (! $sessionManager->checkToken($_POST['token'])) {
1116 die(t('Wrong token.'));
1119 // lf_id should only be present if the link exists.
1120 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1121 // Linkdate is kept here to:
1122 // - use the same permalink for notes as they're displayed when creating them
1123 // - let users hack creation date of their posts
1124 // See: https://shaarli.readthedocs.io/en/master/guides/various-hacks/#changing-the-timestamp-for-a-shaare
1125 $linkdate = escape($_POST['lf_linkdate']);
1126 if (isset($LINKSDB[$id])) {
1128 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1129 $updated = new DateTime();
1130 $shortUrl = $LINKSDB[$id]['shorturl'];
1134 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1136 $shortUrl = link_small_hash($created, $id);
1140 // Remove multiple spaces.
1141 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1142 // Remove first '-' char in tags.
1143 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1144 // Remove duplicates.
1145 $tags = implode(' ', array_unique(explode(' ', $tags)));
1147 if (empty(trim($_POST['lf_url
']))) {
1148 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1150 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1154 'title
' => trim($_POST['lf_title
']),
1156 'description
' => $_POST['lf_description
'],
1157 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1158 'created
' => $created,
1159 'updated
' => $updated,
1160 'tags
' => str_replace(',', ' ', $tags),
1161 'shorturl
' => $shortUrl,
1164 // If title is empty, use the URL as title.
1165 if ($link['title
'] == '') {
1166 $link['title
'] = $link['url
'];
1169 if ($conf->get('thumbnails
.mode
', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE) {
1170 $thumbnailer = new Thumbnailer($conf);
1171 $link['thumbnail
'] = $thumbnailer->get($url);
1174 $pluginManager->executeHooks('save_link
', $link);
1176 $LINKSDB[$id] = $link;
1177 $LINKSDB->save($conf->get('resource.page_cache
'));
1179 $history->addLink($link);
1181 $history->updateLink($link);
1184 // If we are called from the bookmarklet, we must close the popup:
1185 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1186 echo '<script
>self
.close();</script
>';
1190 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1191 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1192 // Scroll to the link which has been edited.
1193 $location .= '#' . $link['shorturl'];
1194 // After saving the link, redirect to the page the user was on.
1195 header('Location: '. $location);
1199 // -------- User clicked the "Cancel" button when editing a link.
1200 if (isset($_POST['cancel_edit']))
1202 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1203 if (! isset($LINKSDB[$id])) {
1204 header('Location: ?');
1206 // If we are called from the bookmarklet, we must close the popup:
1207 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1208 $link = $LINKSDB[$id];
1209 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1210 // Scroll to the link which has been edited.
1211 $returnurl .= '#'. $link['shorturl'];
1212 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1213 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1217 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1218 if ($targetPage == Router
::$PAGE_DELETELINK)
1220 if (! $sessionManager->checkToken($_GET['token'])) {
1221 die(t('Wrong token.'));
1224 $ids = trim($_GET['lf_linkdate']);
1225 if (strpos($ids, ' ') !== false) {
1226 // multiple, space-separated ids provided
1227 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1229 // only a single id provided
1232 // assert at least one id is given
1234 die('no id provided');
1236 foreach ($ids as $id) {
1237 $id = (int) escape($id);
1238 $link = $LINKSDB[$id];
1239 $pluginManager->executeHooks('delete_link', $link);
1240 $history->deleteLink($link);
1241 unset($LINKSDB[$id]);
1243 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1245 // If we are called from the bookmarklet, we must close the popup:
1246 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1249 if (isset($_SERVER['HTTP_REFERER'])) {
1250 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1251 $location = generateLocation(
1252 $_SERVER['HTTP_REFERER'],
1253 $_SERVER['HTTP_HOST'],
1254 ['delete_link', 'edit_link', $link['shorturl']]
1258 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1262 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1263 if (isset($_GET['edit_link']))
1265 $id = (int) escape($_GET['edit_link']);
1266 $link = $LINKSDB[$id]; // Read database
1267 if (!$link) { header('Location: ?'); exit; } // Link not found in database.
1268 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1271 'link_is_new' => false,
1272 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1273 'tags' => $LINKSDB->linksCountPerTag(),
1275 $pluginManager->executeHooks('render_editlink', $data);
1277 foreach ($data as $key => $value) {
1278 $PAGE->assign($key, $value);
1281 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1282 $PAGE->renderPage('editlink');
1286 // -------- User want to post a new link: Display link edit form.
1287 if (isset($_GET['post'])) {
1288 $url = cleanup_url($_GET['post']);
1290 $link_is_new = false;
1291 // Check if URL is not already in database (in this case, we will edit the existing link)
1292 $link = $LINKSDB->getLinkFromUrl($url);
1295 $link_is_new = true;
1296 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1297 // Get title if it was provided in URL (by the bookmarklet).
1298 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1299 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1300 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1301 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1302 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1303 // If this is an HTTP(S) link, we try go get the page to extract the title (otherwise we will to straight to the edit form.)
1304 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1305 // Short timeout to keep the application responsive
1306 // The callback will fill $charset and $title with data from the downloaded page.
1309 $conf->get('general.download_timeout', 30),
1310 $conf->get('general.download_max_size', 4194304),
1311 get_curl_download_callback($charset, $title)
1313 if (! empty($title) && strtolower($charset) != 'utf-8') {
1314 $title = mb_convert_encoding($title, 'utf-8', $charset);
1319 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1320 $title = $conf->get('general.default_note_title', t('Note: '));
1322 $url = escape($url);
1323 $title = escape($title);
1326 'linkdate' => $linkdate,
1329 'description' => $description,
1331 'private' => $private,
1334 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1339 'link_is_new' => $link_is_new,
1340 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1341 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1342 'tags' => $LINKSDB->linksCountPerTag(),
1343 'default_private_links' => $conf->get('privacy.default_private_links', false),
1345 $pluginManager->executeHooks('render_editlink', $data);
1347 foreach ($data as $key => $value) {
1348 $PAGE->assign($key, $value);
1351 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1352 $PAGE->renderPage('editlink');
1356 if ($targetPage == Router
::$PAGE_PINLINK) {
1357 if (! isset($_GET['id']) || empty($LINKSDB[$_GET['id']])) {
1358 // FIXME! Use a proper error system.
1359 $msg = t('Invalid link ID provided');
1360 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1363 if (! $sessionManager->checkToken($_GET['token'])) {
1364 die('Wrong token.');
1367 $link = $LINKSDB[$_GET['id']];
1368 $link['sticky'] = ! $link['sticky'];
1369 $LINKSDB[(int) $_GET['id']] = $link;
1370 $LINKSDB->save($conf->get('resource.page_cache'));
1371 header('Location: '.index_url($_SERVER));
1375 if ($targetPage == Router
::$PAGE_EXPORT) {
1376 // Export links as a Netscape Bookmarks file
1378 if (empty($_GET['selection'])) {
1379 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1380 $PAGE->renderPage('export');
1384 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1385 $selection = $_GET['selection'];
1386 if (isset($_GET['prepend_note_url'])) {
1387 $prependNoteUrl = $_GET['prepend_note_url'];
1389 $prependNoteUrl = false;
1395 NetscapeBookmarkUtils
::filterAndFormat(
1402 } catch (Exception
$exc) {
1403 header('Content-Type: text/plain; charset=utf-8');
1404 echo $exc->getMessage();
1407 $now = new DateTime();
1408 header('Content-Type: text/html; charset=utf-8');
1410 'Content-disposition: attachment; filename=bookmarks_'
1411 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1413 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1414 $PAGE->assign('eol', PHP_EOL
);
1415 $PAGE->assign('selection', $selection);
1416 $PAGE->renderPage('export.bookmarks');
1420 if ($targetPage == Router
::$PAGE_IMPORT) {
1421 // Upload a Netscape bookmark dump to import its contents
1423 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1424 // Show import dialog
1427 get_max_upload_size(
1428 ini_get('post_max_size'),
1429 ini_get('upload_max_filesize'),
1435 get_max_upload_size(
1436 ini_get('post_max_size'),
1437 ini_get('upload_max_filesize'),
1441 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1442 $PAGE->renderPage('import');
1446 // Import bookmarks from an uploaded file
1447 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1448 // The file is too big or some form field may be missing.
1451 'The file you are trying to upload is probably bigger than what this webserver can accept'
1452 .' (%s). Please upload in smaller chunks.'
1454 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1456 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1459 if (! $sessionManager->checkToken($_POST['token'])) {
1460 die('Wrong token.');
1462 $status = NetscapeBookmarkUtils
::import(
1469 echo '<script>alert("'.$status.'");document.location=\'?do='
1470 .Router
::$PAGE_IMPORT .'\';</script>';
1474 // Plugin administration page
1475 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1476 $pluginMeta = $pluginManager->getPluginsMeta();
1478 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1479 $enabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] !== false; });
1481 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1484 function($a, $b) { return $a
['order'] - $b
['order']; }
1486 $disabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] === false; });
1488 $PAGE->assign('enabledPlugins', $enabledPlugins);
1489 $PAGE->assign('disabledPlugins', $disabledPlugins);
1490 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1491 $PAGE->renderPage('pluginsadmin');
1495 // Plugin administration form action
1496 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1498 if (isset($_POST['parameters_form'])) {
1499 unset($_POST['parameters_form']);
1500 foreach ($_POST as $param => $value) {
1501 $conf->set('plugins.'. $param, escape($value));
1505 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1507 $conf->write($loginManager->isLoggedIn());
1508 $history->updateSettings();
1510 catch (Exception
$e) {
1512 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1516 // TODO: do not handle exceptions/errors in JS.
1517 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do='. Router
::$PAGE_PLUGINSADMIN .'\';</script>';
1520 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1524 // Get a fresh token
1525 if ($targetPage == Router
::$GET_TOKEN) {
1526 header('Content-Type:text/plain');
1527 echo $sessionManager->generateToken($conf);
1531 // -------- Thumbnails Update
1532 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1534 foreach ($LINKSDB as $link) {
1535 // A note or not HTTP(S)
1536 if ($link['url'][0] === '?' || ! startsWith(strtolower($link['url']), 'http')) {
1539 $ids[] = $link['id'];
1541 $PAGE->assign('ids', $ids);
1542 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1543 $PAGE->renderPage('thumbnails');
1547 // -------- Single Thumbnail Update
1548 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1549 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1550 http_response_code(400);
1553 $id = (int) $_POST['id'];
1554 if (empty($LINKSDB[$id])) {
1555 http_response_code(404);
1558 $thumbnailer = new Thumbnailer($conf);
1559 $link = $LINKSDB[$id];
1560 $link['thumbnail'] = $thumbnailer->get($link['url']);
1561 $LINKSDB[$id] = $link;
1562 $LINKSDB->save($conf->get('resource.page_cache'));
1564 echo json_encode($link);
1568 // -------- Otherwise, simply display search form and links:
1569 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
1574 * Template for the list of links (<div id="linklist">)
1575 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1577 * @param pageBuilder $PAGE pageBuilder instance.
1578 * @param LinkDB $LINKSDB LinkDB instance.
1579 * @param ConfigManager $conf Configuration Manager instance.
1580 * @param PluginManager $pluginManager Plugin Manager instance.
1581 * @param LoginManager $loginManager LoginManager instance
1583 function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
1585 // Used in templates
1586 if (isset($_GET['searchtags'])) {
1587 if (! empty($_GET['searchtags'])) {
1588 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1590 $searchtags = false;
1595 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1598 if (! empty($_SERVER['QUERY_STRING'])
1599 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1601 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1602 } catch (LinkNotFoundException
$e) {
1603 $PAGE->render404($e->getMessage());
1607 // Filter links according search parameters.
1608 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1610 'searchtags' => $searchtags,
1611 'searchterm' => $searchterm,
1613 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1616 // ---- Handle paging.
1618 foreach ($linksToDisplay as $key => $value) {
1622 // Select articles according to paging.
1623 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1624 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1625 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1626 $page = $page < 1 ? 1 : $page;
1627 $page = $page > $pagecount ? $pagecount : $page;
1629 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1630 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1632 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1633 if ($thumbnailsEnabled) {
1634 $thumbnailer = new Thumbnailer($conf);
1637 $linkDisp = array();
1638 while ($i<$end && $i<count($keys))
1640 $link = $linksToDisplay[$keys[$i]];
1641 $link['description'] = format_description(
1642 $link['description'],
1643 $conf->get('redirector.url'),
1644 $conf->get('redirector.encode_url')
1646 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1647 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1648 $link['timestamp'] = $link['created']->getTimestamp();
1649 if (! empty($link['updated'])) {
1650 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1652 $link['updated_timestamp'] = '';
1654 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1655 uasort($taglist, 'strcasecmp');
1656 $link['taglist'] = $taglist;
1658 // Logged in, thumbnails enabled, not a note,
1659 // and (never retrieved yet or no valid cache file)
1660 if ($loginManager->isLoggedIn() && $thumbnailsEnabled && $link['url'][0] != '?'
1661 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
1663 $elem = $LINKSDB[$keys[$i]];
1664 $elem['thumbnail'] = $thumbnailer->get($link['url']);
1665 $LINKSDB[$keys[$i]] = $elem;
1667 $link['thumbnail'] = $elem['thumbnail'];
1670 // Check for both signs of a note: starting with ? and 7 chars long.
1671 if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1672 $link['url'] = index_url($_SERVER) . $link['url'];
1675 $linkDisp[$keys[$i]] = $link;
1679 // If we retrieved new thumbnails, we update the database.
1680 if (!empty($updateDB)) {
1681 $LINKSDB->save($conf->get('resource.page_cache'));
1684 // Compute paging navigation
1685 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1686 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1687 $previous_page_url = '';
1688 if ($i != count($keys)) {
1689 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1693 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1696 // Fill all template fields.
1698 'previous_page_url' => $previous_page_url,
1699 'next_page_url' => $next_page_url,
1700 'page_current' => $page,
1701 'page_max' => $pagecount,
1702 'result_count' => count($linksToDisplay),
1703 'search_term' => $searchterm,
1704 'search_tags' => $searchtags,
1705 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1706 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1707 'links' => $linkDisp,
1710 // If there is only a single link, we change on-the-fly the title of the page.
1711 if (count($linksToDisplay) == 1) {
1712 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1713 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1714 $data['pagetitle'] = t('Search: ');
1715 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1716 $bracketWrap = function ($tag) {
1717 return '['. $tag .']';
1719 $data['pagetitle'] .= ! empty($searchtags)
1720 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1722 $data['pagetitle'] .= '- '. $conf->get('general.title');
1725 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1727 foreach ($data as $key => $value) {
1728 $PAGE->assign($key, $value);
1736 * This function should NEVER be called if the file data/config.php exists.
1738 * @param ConfigManager $conf Configuration Manager instance.
1739 * @param SessionManager $sessionManager SessionManager instance
1740 * @param LoginManager $loginManager LoginManager instance
1742 function install($conf, $sessionManager, $loginManager) {
1743 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1744 if (endsWith($_SERVER['HTTP_HOST'],'.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions',0705);
1747 // This part makes sure sessions works correctly.
1748 // (Because on some hosts, session.save_path may not be set correctly,
1749 // or we may not have write access to it.)
1750 if (isset($_GET['test_session']) && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working'))
1752 // Step 2: Check if data in session is correct.
1754 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1755 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1756 'and that you have write access to it.<br>'.
1757 'It currently points to %s.<br>'.
1758 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1759 'or any custom hostname without a dot causes cookie storage to fail. '.
1760 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1762 $msg = sprintf($msg, session_save_path());
1764 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1767 if (!isset($_SESSION['session_tested']))
1768 { // Step 1 : Try to store data in session and reload page.
1769 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1770 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1772 if (isset($_GET['test_session']))
1773 { // Step 3: Sessions are OK. Remove test parameter from URL.
1774 header('Location: '.index_url($_SERVER));
1778 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
1781 if (!empty($_POST['continent']) && !empty($_POST['city'])
1782 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1784 $tz = $_POST['continent'].'/'.$_POST['city'];
1786 $conf->set('general.timezone', $tz);
1787 $login = $_POST['setlogin'];
1788 $conf->set('credentials.login', $login);
1789 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1790 $conf->set('credentials.salt', $salt);
1791 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1792 if (!empty($_POST['title'])) {
1793 $conf->set('general.title', escape($_POST['title']));
1795 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
1797 $conf->set('translation.language', escape($_POST['language']));
1798 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1799 $conf->set('api.enabled', !empty($_POST['enableApi']));
1802 generate_api_secret(
1803 $conf->get('credentials.login'),
1804 $conf->get('credentials.salt')
1808 // Everything is ok, let's create config file.
1809 $conf->write($loginManager->isLoggedIn());
1811 catch(Exception
$e) {
1813 'ERROR while writing config file after installation.' . PHP_EOL
.
1817 // TODO: do not handle exceptions/errors in JS.
1818 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1821 echo '<script>alert("Shaarli is now configured. Please enter your login/password and start shaaring your links!");document.location=\'?do=login\';</script>';
1825 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1826 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1827 $PAGE->assign('continents', $continents);
1828 $PAGE->assign('cities', $cities);
1829 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1830 $PAGE->renderPage('install');
1834 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1835 showDailyRSS($conf, $loginManager);
1839 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1840 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1844 $history = new History($conf->get('resource.history'));
1845 } catch(Exception
$e) {
1846 die($e->getMessage());
1849 $linkDb = new LinkDB(
1850 $conf->get('resource.datastore'),
1851 $loginManager->isLoggedIn(),
1852 $conf->get('privacy.hide_public_links'),
1853 $conf->get('redirector.url'),
1854 $conf->get('redirector.encode_url')
1857 $container = new \Slim\
Container();
1858 $container['conf'] = $conf;
1859 $container['plugins'] = $pluginManager;
1860 $container['history'] = $history;
1861 $app = new \Slim\
App($container);
1864 $app->group('/api/v1', function() {
1865 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1866 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1867 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1868 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1869 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1870 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1872 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1873 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1874 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1875 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1877 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
1878 })->add('\Shaarli\Api\ApiMiddleware');
1880 $response = $app->run(true);
1882 // Hack to make Slim and Shaarli router work together:
1883 // If a Slim route isn't found and NOT API call, we call renderPage().
1884 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1885 // We use UTF-8 for proper international characters handling.
1886 header('Content-Type: text/html; charset=utf-8');
1887 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1889 $response = $response
1890 ->withHeader('Access-Control-Allow-Origin', '*')
1892 'Access-Control-Allow-Headers',
1893 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1895 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1896 $app->respond($response);