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['thumbnail'] = thumbnail($conf, $link['url']);
360 $link['timestamp'] = $link['created']->getTimestamp();
361 if (startsWith($link['url'], '?')) {
362 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
366 // Then build the HTML for this day:
368 $tpl->assign('title', $conf->get('general.title'));
369 $tpl->assign('daydate', $dayDate->getTimestamp());
370 $tpl->assign('absurl', $absurl);
371 $tpl->assign('links', $links);
372 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
373 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
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]['thumbnail'] = thumbnail($conf, $link['url']);
437 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
440 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
442 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
443 'linksToDisplay' => $linksToDisplay,
444 'day' => $dayDate->getTimestamp(),
445 'dayDate' => $dayDate,
446 'previousday' => $previousday,
447 'nextday' => $nextday,
450 /* Hook is called before column construction so that plugins don't have
451 to deal with columns. */
452 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
454 /* We need to spread the articles on 3 columns.
455 I did not want to use a JavaScript lib like http://masonry.desandro.com/
456 so I manually spread entries with a simple method: I roughly evaluate the
457 height of a div according to title and description length.
459 $columns = array(array(), array(), array()); // Entries to display, for each column.
460 $fill = array(0, 0, 0); // Rough estimate of columns fill.
461 foreach($data['linksToDisplay'] as $key => $link) {
462 // Roughly estimate length of entry (by counting characters)
463 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
464 // Description: 836 characters gives roughly 342 pixel height.
465 // This is not perfect, but it's usually OK.
466 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
467 if ($link['thumbnail']) {
468 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
470 // Then put in column which is the less filled:
471 $smallest = min($fill); // find smallest value in array.
472 $index = array_search($smallest, $fill); // find index of this smallest value.
473 array_push($columns[$index], $link); // Put entry in this column.
474 $fill[$index] +
= $length;
477 $data['cols'] = $columns;
479 foreach ($data as $key => $value) {
480 $pageBuilder->assign($key, $value);
483 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
484 $pageBuilder->renderPage('daily');
489 * Renders the linklist
491 * @param pageBuilder $PAGE pageBuilder instance.
492 * @param LinkDB $LINKSDB LinkDB instance.
493 * @param ConfigManager $conf Configuration Manager instance.
494 * @param PluginManager $pluginManager Plugin Manager instance.
496 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager) {
497 buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager, $loginManager);
498 $PAGE->renderPage('linklist');
502 * Render HTML page (according to URL parameters and user rights)
504 * @param ConfigManager $conf Configuration Manager instance.
505 * @param PluginManager $pluginManager Plugin Manager instance,
506 * @param LinkDB $LINKSDB
507 * @param History $history instance
508 * @param SessionManager $sessionManager SessionManager instance
509 * @param LoginManager $loginManager LoginManager instance
511 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager, $loginManager)
513 $updater = new Updater(
514 read_updates_file($conf->get('resource.updates')),
517 $loginManager->isLoggedIn()
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, $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 if (! $conf->get('thumbnails.enabled')) {
606 $PAGE->renderPage('picwall');
610 // Optionally filter the results:
611 $links = $LINKSDB->filterSearch($_GET);
612 $linksToDisplay = array();
614 $thumbnailer = new Thumbnailer($conf);
617 $newThumbnailsCpt = 0;
618 // Get only links which have a thumbnail.
619 foreach($links as $key => $link)
622 // and (never retrieved yet or no valid cache file)
623 if ($link['url'][0] != '?'
624 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
626 $item = $LINKSDB[$key];
627 $item['thumbnail'] = $thumbnailer->get($link['url']);
628 $LINKSDB[$key] = $item;
632 if (isset($link['thumbnail']) && $link['thumbnail'] !== false) {
633 $linksToDisplay[] = $link; // Add to array.
636 // If we retrieved new thumbnails, we update the database every 20 links.
637 // Downloading everything the first time may take a very long time
638 if ($newThumbnailsCpt == 20) {
639 $LINKSDB->save($conf->get('resource.page_cache'));
640 $newThumbnailsCpt = 0;
644 if ($newThumbnailsCpt > 0) {
645 $LINKSDB->save($conf->get('resource.page_cache'));
649 'linksToDisplay' => $linksToDisplay,
651 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => $loginManager->isLoggedIn()));
653 foreach ($data as $key => $value) {
654 $PAGE->assign($key, $value);
657 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
658 $PAGE->renderPage('picwall');
662 // -------- Tag cloud
663 if ($targetPage == Router
::$PAGE_TAGCLOUD)
665 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
666 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
667 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
669 // We sort tags alphabetically, then choose a font size according to count.
670 // First, find max value.
672 foreach ($tags as $value) {
673 $maxcount = max($maxcount, $value);
676 alphabetical_sort($tags, false, true);
679 foreach($tags as $key => $value) {
680 if (in_array($key, $filteringTags)) {
683 // Tag font size scaling:
684 // default 15 and 30 logarithm bases affect scaling,
685 // 22 and 6 are arbitrary font sizes for max and min sizes.
686 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
687 $tagList[$key] = array(
689 'size' => number_format($size, 2, '.', ''),
693 $searchTags = implode(' ', escape($filteringTags));
695 'search_tags' => $searchTags,
698 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
700 foreach ($data as $key => $value) {
701 $PAGE->assign($key, $value);
704 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
705 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
706 $PAGE->renderPage('tag.cloud');
711 if ($targetPage == Router
::$PAGE_TAGLIST)
713 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
714 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
715 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
716 foreach ($filteringTags as $tag) {
717 if (array_key_exists($tag, $tags)) {
722 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
723 alphabetical_sort($tags, false, true);
726 $searchTags = implode(' ', escape($filteringTags));
728 'search_tags' => $searchTags,
731 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
733 foreach ($data as $key => $value) {
734 $PAGE->assign($key, $value);
737 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
738 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
739 $PAGE->renderPage('tag.list');
744 if ($targetPage == Router
::$PAGE_DAILY) {
745 showDaily($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
748 // ATOM and RSS feed.
749 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
750 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
751 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
754 $query = $_SERVER['QUERY_STRING'];
755 $cache = new CachedPage(
756 $conf->get('resource.page_cache'),
758 startsWith($query,'do='. $targetPage) && !$loginManager->isLoggedIn()
760 $cached = $cache->cachedVersion();
761 if (!empty($cached)) {
767 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, $loginManager->isLoggedIn());
768 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
769 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
770 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
771 $data = $feedGenerator->buildData();
773 // Process plugin hook.
774 $pluginManager->executeHooks('render_feed', $data, array(
775 'loggedin' => $loginManager->isLoggedIn(),
776 'target' => $targetPage,
779 // Render the template.
780 $PAGE->assignAll($data);
781 $PAGE->renderPage('feed.'. $feedType);
782 $cache->cache(ob_get_contents());
787 // Display opensearch plugin (XML)
788 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
789 header('Content-Type: application/xml; charset=utf-8');
790 $PAGE->assign('serverurl', index_url($_SERVER));
791 $PAGE->renderPage('opensearch');
795 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
796 if (isset($_GET['addtag']))
798 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
799 if (empty($_SERVER['HTTP_REFERER'])) { header('Location: ?searchtags='.urlencode($_GET
['addtag'])); exit; } // In case browser does not send HTTP_REFERER
800 parse_str(parse_url($_SERVER['HTTP_REFERER'],PHP_URL_QUERY
), $params);
802 // Prevent redirection loop
803 if (isset($params['addtag'])) {
804 unset($params['addtag']);
807 // Check if this tag is already in the search query and ignore it if it is.
808 // Each tag is always separated by a space
809 if (isset($params['searchtags'])) {
810 $current_tags = explode(' ', $params['searchtags']);
812 $current_tags = array();
815 foreach ($current_tags as $value) {
816 if ($value === $_GET['addtag']) {
821 // Append the tag if necessary
822 if (empty($params['searchtags'])) {
823 $params['searchtags'] = trim($_GET['addtag']);
826 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
829 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
830 header('Location: ?'.http_build_query($params));
834 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
835 if (isset($_GET['removetag'])) {
836 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
837 if (empty($_SERVER['HTTP_REFERER'])) {
838 header('Location: ?');
842 // In case browser does not send HTTP_REFERER
843 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
845 // Prevent redirection loop
846 if (isset($params['removetag'])) {
847 unset($params['removetag']);
850 if (isset($params['searchtags'])) {
851 $tags = explode(' ', $params['searchtags']);
852 // Remove value from array $tags.
853 $tags = array_diff($tags, array($_GET['removetag']));
854 $params['searchtags'] = implode(' ',$tags);
856 if (empty($params['searchtags'])) {
857 unset($params['searchtags']);
860 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
862 header('Location: ?'.http_build_query($params));
866 // -------- User wants to change the number of links per page (linksperpage=...)
867 if (isset($_GET['linksperpage'])) {
868 if (is_numeric($_GET['linksperpage'])) {
869 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
872 if (! empty($_SERVER['HTTP_REFERER'])) {
873 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
877 header('Location: '. $location);
881 // -------- User wants to see only private links (toggle)
882 if (isset($_GET['visibility'])) {
883 if ($_GET['visibility'] === 'private') {
884 // Visibility not set or not already private, set private, otherwise reset it
885 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
886 // See only private links
887 $_SESSION['visibility'] = 'private';
889 unset($_SESSION['visibility']);
891 } elseif ($_GET['visibility'] === 'public') {
892 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
893 // See only public links
894 $_SESSION['visibility'] = 'public';
896 unset($_SESSION['visibility']);
900 if (! empty($_SERVER['HTTP_REFERER'])) {
901 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
905 header('Location: '. $location);
909 // -------- User wants to see only untagged links (toggle)
910 if (isset($_GET['untaggedonly'])) {
911 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
913 if (! empty($_SERVER['HTTP_REFERER'])) {
914 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
918 header('Location: '. $location);
922 // -------- Handle other actions allowed for non-logged in users:
923 if (!$loginManager->isLoggedIn())
925 // User tries to post new link but is not logged in:
926 // Show login screen, then redirect to ?post=...
927 if (isset($_GET['post']))
929 header( // Redirect to login page, then back to post link.
930 'Location: ?do=login&post='.urlencode($_GET['post']).
931 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
932 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
933 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
934 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
939 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
940 if (isset($_GET['edit_link'])) {
941 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
945 exit; // Never remove this one! All operations below are reserved for logged in user.
948 // -------- All other functions are reserved for the registered user:
950 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
951 if ($targetPage == Router
::$PAGE_TOOLS)
954 'pageabsaddr' => index_url($_SERVER),
955 'sslenabled' => is_https($_SERVER),
957 $pluginManager->executeHooks('render_tools', $data);
959 foreach ($data as $key => $value) {
960 $PAGE->assign($key, $value);
963 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
964 $PAGE->renderPage('tools');
968 // -------- User wants to change his/her password.
969 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD)
971 if ($conf->get('security.open_shaarli')) {
972 die(t('You are not supposed to change a password on an Open Shaarli.'));
975 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword']))
977 if (!$sessionManager->checkToken($_POST['token'])) die(t('Wrong token.')); // Go away!
979 // Make sure old password is correct.
980 $oldhash = sha1($_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt'));
981 if ($oldhash!= $conf->get('credentials.hash')) {
982 echo '<script>alert("'. t('The old password is not correct.') .'");document.location=\'?do=changepasswd\';</script>';
986 // Salt renders rainbow-tables attacks useless.
987 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
988 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $conf->get('credentials.login') . $conf->get('credentials.salt')));
990 $conf->write($loginManager->isLoggedIn());
992 catch(Exception
$e) {
994 'ERROR while writing config file after changing password.' . PHP_EOL
.
998 // TODO: do not handle exceptions/errors in JS.
999 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
1002 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
1005 else // show the change password form.
1007 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
1008 $PAGE->renderPage('changepassword');
1013 // -------- User wants to change configuration
1014 if ($targetPage == Router
::$PAGE_CONFIGURE)
1016 if (!empty($_POST['title']) )
1018 if (!$sessionManager->checkToken($_POST['token'])) {
1019 die(t('Wrong token.')); // Go away!
1022 if (!empty($_POST['continent']) && !empty($_POST['city'])
1023 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1025 $tz = $_POST['continent'] . '/' . $_POST['city'];
1027 $conf->set('general.timezone', $tz);
1028 $conf->set('general.title', escape($_POST['title']));
1029 $conf->set('general.header_link', escape($_POST['titleLink']));
1030 $conf->set('resource.theme', escape($_POST['theme']));
1031 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1032 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1033 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1034 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1035 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1036 $conf->set('api.enabled', !empty($_POST['enableApi']));
1037 $conf->set('api.secret', escape($_POST['apiSecret']));
1038 $conf->set('translation.language', escape($_POST['language']));
1039 $conf->set('thumbnails.enabled', !empty($_POST['enableThumbnails']));
1042 $conf->write($loginManager->isLoggedIn());
1043 $history->updateSettings();
1044 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 else // Show the configuration form.
1061 $PAGE->assign('title', $conf->get('general.title'));
1062 $PAGE->assign('theme', $conf->get('resource.theme'));
1063 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1064 list($continents, $cities) = generateTimeZoneData(
1065 timezone_identifiers_list(),
1066 $conf->get('general.timezone')
1068 $PAGE->assign('continents', $continents);
1069 $PAGE->assign('cities', $cities);
1070 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1071 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1072 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1073 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1074 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1075 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1076 $PAGE->assign('api_secret', $conf->get('api.secret'));
1077 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1078 $PAGE->assign('language', $conf->get('translation.language'));
1079 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1080 $PAGE->renderPage('configure');
1085 // -------- User wants to rename a tag or delete it
1086 if ($targetPage == Router
::$PAGE_CHANGETAG)
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 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), escape($_POST['totag']));
1100 $LINKSDB->save($conf->get('resource.page_cache'));
1101 foreach ($alteredLinks as $link) {
1102 $history->updateLink($link);
1104 $delete = empty($_POST['totag']);
1105 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1106 $count = count($alteredLinks);
1108 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1109 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1110 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1114 // -------- User wants to add a link without using the bookmarklet: Show form.
1115 if ($targetPage == Router
::$PAGE_ADDLINK)
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']))
1126 if (! $sessionManager->checkToken($_POST['token'])) {
1127 die(t('Wrong token.'));
1130 // lf_id should only be present if the link exists.
1131 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1132 // Linkdate is kept here to:
1133 // - use the same permalink for notes as they're displayed when creating them
1134 // - let users hack creation date of their posts
1135 // See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare
1136 $linkdate = escape($_POST['lf_linkdate']);
1137 if (isset($LINKSDB[$id])) {
1139 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1140 $updated = new DateTime();
1141 $shortUrl = $LINKSDB[$id]['shorturl'];
1145 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1147 $shortUrl = link_small_hash($created, $id);
1151 // Remove multiple spaces.
1152 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1153 // Remove first '-' char in tags.
1154 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1155 // Remove duplicates.
1156 $tags = implode(' ', array_unique(explode(' ', $tags)));
1158 if (empty(trim($_POST['lf_url
']))) {
1159 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1161 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1165 'title
' => trim($_POST['lf_title
']),
1167 'description
' => $_POST['lf_description
'],
1168 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1169 'created
' => $created,
1170 'updated
' => $updated,
1171 'tags
' => str_replace(',', ' ', $tags),
1172 'shorturl
' => $shortUrl,
1175 // If title is empty, use the URL as title.
1176 if ($link['title
'] == '') {
1177 $link['title
'] = $link['url
'];
1180 if ($conf->get('thumbnails
.enabled
')) {
1181 $thumbnailer = new Thumbnailer($conf);
1182 $link['thumbnail
'] = $thumbnailer->get($url);
1185 $pluginManager->executeHooks('save_link
', $link);
1187 $LINKSDB[$id] = $link;
1188 $LINKSDB->save($conf->get('resource.page_cache
'));
1190 $history->addLink($link);
1192 $history->updateLink($link);
1195 // If we are called from the bookmarklet, we must close the popup:
1196 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1197 echo '<script
>self
.close();</script
>';
1201 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1202 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1203 // Scroll to the link which has been edited.
1204 $location .= '#' . $link['shorturl'];
1205 // After saving the link, redirect to the page the user was on.
1206 header('Location: '. $location);
1210 // -------- User clicked the "Cancel" button when editing a link.
1211 if (isset($_POST['cancel_edit']))
1213 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1214 if (! isset($LINKSDB[$id])) {
1215 header('Location: ?');
1217 // If we are called from the bookmarklet, we must close the popup:
1218 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1219 $link = $LINKSDB[$id];
1220 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1221 // Scroll to the link which has been edited.
1222 $returnurl .= '#'. $link['shorturl'];
1223 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1224 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1228 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1229 if ($targetPage == Router
::$PAGE_DELETELINK)
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 unset($LINKSDB[$id]);
1253 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1254 $history->deleteLink($link);
1256 // If we are called from the bookmarklet, we must close the popup:
1257 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1260 if (isset($_SERVER['HTTP_REFERER'])) {
1261 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1262 $location = generateLocation(
1263 $_SERVER['HTTP_REFERER'],
1264 $_SERVER['HTTP_HOST'],
1265 ['delete_link', 'edit_link', $link['shorturl']]
1269 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1273 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1274 if (isset($_GET['edit_link']))
1276 $id = (int) escape($_GET['edit_link']);
1277 $link = $LINKSDB[$id]; // Read database
1278 if (!$link) { header('Location: ?'); exit; } // Link not found in database.
1279 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1282 'link_is_new' => false,
1283 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1284 'tags' => $LINKSDB->linksCountPerTag(),
1286 $pluginManager->executeHooks('render_editlink', $data);
1288 foreach ($data as $key => $value) {
1289 $PAGE->assign($key, $value);
1292 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1293 $PAGE->renderPage('editlink');
1297 // -------- User want to post a new link: Display link edit form.
1298 if (isset($_GET['post'])) {
1299 $url = cleanup_url($_GET['post']);
1301 $link_is_new = false;
1302 // Check if URL is not already in database (in this case, we will edit the existing link)
1303 $link = $LINKSDB->getLinkFromUrl($url);
1306 $link_is_new = true;
1307 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1308 // Get title if it was provided in URL (by the bookmarklet).
1309 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1310 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1311 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1312 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1313 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1314 // 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.)
1315 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1316 // Short timeout to keep the application responsive
1317 // The callback will fill $charset and $title with data from the downloaded page.
1320 $conf->get('general.download_timeout', 30),
1321 $conf->get('general.download_max_size', 4194304),
1322 get_curl_download_callback($charset, $title)
1324 if (! empty($title) && strtolower($charset) != 'utf-8') {
1325 $title = mb_convert_encoding($title, 'utf-8', $charset);
1330 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1331 $title = $conf->get('general.default_note_title', t('Note: '));
1333 $url = escape($url);
1334 $title = escape($title);
1337 'linkdate' => $linkdate,
1340 'description' => $description,
1342 'private' => $private,
1345 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1350 'link_is_new' => $link_is_new,
1351 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1352 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1353 'tags' => $LINKSDB->linksCountPerTag(),
1354 'default_private_links' => $conf->get('privacy.default_private_links', false),
1356 $pluginManager->executeHooks('render_editlink', $data);
1358 foreach ($data as $key => $value) {
1359 $PAGE->assign($key, $value);
1362 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1363 $PAGE->renderPage('editlink');
1367 if ($targetPage == Router
::$PAGE_EXPORT) {
1368 // Export links as a Netscape Bookmarks file
1370 if (empty($_GET['selection'])) {
1371 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1372 $PAGE->renderPage('export');
1376 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1377 $selection = $_GET['selection'];
1378 if (isset($_GET['prepend_note_url'])) {
1379 $prependNoteUrl = $_GET['prepend_note_url'];
1381 $prependNoteUrl = false;
1387 NetscapeBookmarkUtils
::filterAndFormat(
1394 } catch (Exception
$exc) {
1395 header('Content-Type: text/plain; charset=utf-8');
1396 echo $exc->getMessage();
1399 $now = new DateTime();
1400 header('Content-Type: text/html; charset=utf-8');
1402 'Content-disposition: attachment; filename=bookmarks_'
1403 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1405 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1406 $PAGE->assign('eol', PHP_EOL
);
1407 $PAGE->assign('selection', $selection);
1408 $PAGE->renderPage('export.bookmarks');
1412 if ($targetPage == Router
::$PAGE_IMPORT) {
1413 // Upload a Netscape bookmark dump to import its contents
1415 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1416 // Show import dialog
1419 get_max_upload_size(
1420 ini_get('post_max_size'),
1421 ini_get('upload_max_filesize'),
1427 get_max_upload_size(
1428 ini_get('post_max_size'),
1429 ini_get('upload_max_filesize'),
1433 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1434 $PAGE->renderPage('import');
1438 // Import bookmarks from an uploaded file
1439 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1440 // The file is too big or some form field may be missing.
1443 'The file you are trying to upload is probably bigger than what this webserver can accept'
1444 .' (%s). Please upload in smaller chunks.'
1446 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1448 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1451 if (! $sessionManager->checkToken($_POST['token'])) {
1452 die('Wrong token.');
1454 $status = NetscapeBookmarkUtils
::import(
1461 echo '<script>alert("'.$status.'");document.location=\'?do='
1462 .Router
::$PAGE_IMPORT .'\';</script>';
1466 // Plugin administration page
1467 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1468 $pluginMeta = $pluginManager->getPluginsMeta();
1470 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1471 $enabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] !== false; });
1473 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1476 function($a, $b) { return $a
['order'] - $b
['order']; }
1478 $disabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] === false; });
1480 $PAGE->assign('enabledPlugins', $enabledPlugins);
1481 $PAGE->assign('disabledPlugins', $disabledPlugins);
1482 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1483 $PAGE->renderPage('pluginsadmin');
1487 // Plugin administration form action
1488 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1490 if (isset($_POST['parameters_form'])) {
1491 unset($_POST['parameters_form']);
1492 foreach ($_POST as $param => $value) {
1493 $conf->set('plugins.'. $param, escape($value));
1497 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1499 $conf->write($loginManager->isLoggedIn());
1500 $history->updateSettings();
1502 catch (Exception
$e) {
1504 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1508 // TODO: do not handle exceptions/errors in JS.
1509 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do='. Router
::$PAGE_PLUGINSADMIN .'\';</script>';
1512 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1516 // Get a fresh token
1517 if ($targetPage == Router
::$GET_TOKEN) {
1518 header('Content-Type:text/plain');
1519 echo $sessionManager->generateToken($conf);
1523 // -------- Otherwise, simply display search form and links:
1524 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
1529 * Template for the list of links (<div id="linklist">)
1530 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1532 * @param pageBuilder $PAGE pageBuilder instance.
1533 * @param LinkDB $LINKSDB LinkDB instance.
1534 * @param ConfigManager $conf Configuration Manager instance.
1535 * @param PluginManager $pluginManager Plugin Manager instance.
1536 * @param LoginManager $loginManager LoginManager instance
1538 function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
1540 // Used in templates
1541 if (isset($_GET['searchtags'])) {
1542 if (! empty($_GET['searchtags'])) {
1543 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1545 $searchtags = false;
1550 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1553 if (! empty($_SERVER['QUERY_STRING'])
1554 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1556 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1557 } catch (LinkNotFoundException
$e) {
1558 $PAGE->render404($e->getMessage());
1562 // Filter links according search parameters.
1563 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1565 'searchtags' => $searchtags,
1566 'searchterm' => $searchterm,
1568 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1571 // ---- Handle paging.
1573 foreach ($linksToDisplay as $key => $value) {
1577 // Select articles according to paging.
1578 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1579 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1580 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1581 $page = $page < 1 ? 1 : $page;
1582 $page = $page > $pagecount ? $pagecount : $page;
1584 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1585 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1587 if ($conf->get('thumbnails.enabled')) {
1588 $thumbnailer = new Thumbnailer($conf);
1591 $linkDisp = array();
1592 while ($i<$end && $i<count($keys))
1594 $link = $linksToDisplay[$keys[$i]];
1595 $link['description'] = format_description(
1596 $link['description'],
1597 $conf->get('redirector.url'),
1598 $conf->get('redirector.encode_url')
1600 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1601 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1602 $link['timestamp'] = $link['created']->getTimestamp();
1603 if (! empty($link['updated'])) {
1604 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1606 $link['updated_timestamp'] = '';
1608 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1609 uasort($taglist, 'strcasecmp');
1610 $link['taglist'] = $taglist;
1612 // Thumbnails enabled, not a note,
1613 // and (never retrieved yet or no valid cache file)
1614 if ($conf->get('thumbnails.enabled') && $link['url'][0] != '?'
1615 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
1617 $elem = $LINKSDB[$keys[$i]];
1618 $elem['thumbnail'] = $thumbnailer->get($link['url']);
1619 $LINKSDB[$keys[$i]] = $elem;
1623 // Check for both signs of a note: starting with ? and 7 chars long.
1624 if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1625 $link['url'] = index_url($_SERVER) . $link['url'];
1628 $linkDisp[$keys[$i]] = $link;
1632 // If we retrieved new thumbnails, we update the database.
1633 if (!empty($updateDB)) {
1634 $LINKSDB->save($conf->get('resource.page_cache'));
1637 // Compute paging navigation
1638 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1639 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1640 $previous_page_url = '';
1641 if ($i != count($keys)) {
1642 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1646 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1649 // Fill all template fields.
1651 'previous_page_url' => $previous_page_url,
1652 'next_page_url' => $next_page_url,
1653 'page_current' => $page,
1654 'page_max' => $pagecount,
1655 'result_count' => count($linksToDisplay),
1656 'search_term' => $searchterm,
1657 'search_tags' => $searchtags,
1658 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1659 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1660 'links' => $linkDisp,
1663 // If there is only a single link, we change on-the-fly the title of the page.
1664 if (count($linksToDisplay) == 1) {
1665 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1666 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1667 $data['pagetitle'] = t('Search: ');
1668 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1669 $bracketWrap = function ($tag) {
1670 return '['. $tag .']';
1672 $data['pagetitle'] .= ! empty($searchtags)
1673 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1675 $data['pagetitle'] .= '- '. $conf->get('general.title');
1678 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1680 foreach ($data as $key => $value) {
1681 $PAGE->assign($key, $value);
1689 * This function should NEVER be called if the file data/config.php exists.
1691 * @param ConfigManager $conf Configuration Manager instance.
1692 * @param SessionManager $sessionManager SessionManager instance
1693 * @param LoginManager $loginManager LoginManager instance
1695 function install($conf, $sessionManager, $loginManager) {
1696 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1697 if (endsWith($_SERVER['HTTP_HOST'],'.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions',0705);
1700 // This part makes sure sessions works correctly.
1701 // (Because on some hosts, session.save_path may not be set correctly,
1702 // or we may not have write access to it.)
1703 if (isset($_GET['test_session']) && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working'))
1705 // Step 2: Check if data in session is correct.
1707 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1708 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1709 'and that you have write access to it.<br>'.
1710 'It currently points to %s.<br>'.
1711 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1712 'or any custom hostname without a dot causes cookie storage to fail. '.
1713 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1715 $msg = sprintf($msg, session_save_path());
1717 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1720 if (!isset($_SESSION['session_tested']))
1721 { // Step 1 : Try to store data in session and reload page.
1722 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1723 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1725 if (isset($_GET['test_session']))
1726 { // Step 3: Sessions are OK. Remove test parameter from URL.
1727 header('Location: '.index_url($_SERVER));
1731 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
1734 if (!empty($_POST['continent']) && !empty($_POST['city'])
1735 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1737 $tz = $_POST['continent'].'/'.$_POST['city'];
1739 $conf->set('general.timezone', $tz);
1740 $login = $_POST['setlogin'];
1741 $conf->set('credentials.login', $login);
1742 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1743 $conf->set('credentials.salt', $salt);
1744 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1745 if (!empty($_POST['title'])) {
1746 $conf->set('general.title', escape($_POST['title']));
1748 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
1750 $conf->set('translation.language', escape($_POST['language']));
1751 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1752 $conf->set('api.enabled', !empty($_POST['enableApi']));
1755 generate_api_secret(
1756 $conf->get('credentials.login'),
1757 $conf->get('credentials.salt')
1761 // Everything is ok, let's create config file.
1762 $conf->write($loginManager->isLoggedIn());
1764 catch(Exception
$e) {
1766 'ERROR while writing config file after installation.' . PHP_EOL
.
1770 // TODO: do not handle exceptions/errors in JS.
1771 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1774 echo '<script>alert("Shaarli is now configured. Please enter your login/password and start shaaring your links!");document.location=\'?do=login\';</script>';
1778 $PAGE = new PageBuilder($conf, null, $sessionManager->generateToken());
1779 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1780 $PAGE->assign('continents', $continents);
1781 $PAGE->assign('cities', $cities);
1782 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1783 $PAGE->renderPage('install');
1787 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf
); exit; }
1788 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1789 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1793 $history = new History($conf->get('resource.history'));
1794 } catch(Exception
$e) {
1795 die($e->getMessage());
1798 $linkDb = new LinkDB(
1799 $conf->get('resource.datastore'),
1800 $loginManager->isLoggedIn(),
1801 $conf->get('privacy.hide_public_links'),
1802 $conf->get('redirector.url'),
1803 $conf->get('redirector.encode_url')
1806 $container = new \Slim\
Container();
1807 $container['conf'] = $conf;
1808 $container['plugins'] = $pluginManager;
1809 $container['history'] = $history;
1810 $app = new \Slim\
App($container);
1813 $app->group('/api/v1', function() {
1814 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1815 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1816 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1817 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1818 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1819 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1820 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
1821 })->add('\Shaarli\Api\ApiMiddleware');
1823 $response = $app->run(true);
1824 // Hack to make Slim and Shaarli router work together:
1825 // If a Slim route isn't found and NOT API call, we call renderPage().
1826 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1827 // We use UTF-8 for proper international characters handling.
1828 header('Content-Type: text/html; charset=utf-8');
1829 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1831 $app->respond($response);