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/Thumbnailer.php';
78 require_once 'application/Updater.php';
79 use \Shaarli\Languages
;
80 use \Shaarli\ThemeUtils
;
81 use \Shaarli\Config\ConfigManager
;
82 use \Shaarli\Security\LoginManager
;
83 use \Shaarli\Security\SessionManager
;
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 header('Location: ?');
610 // Optionally filter the results:
611 $links = $LINKSDB->filterSearch($_GET);
612 $linksToDisplay = array();
614 $thumbnailer = new Thumbnailer($conf);
618 // Get only links which have a thumbnail.
619 foreach($links as $link)
621 $permalink='?'.$link['shorturl'];
623 // and (never retrieved yet or no valid cache file)
624 if ($link['url'][0] != '?'
625 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
627 $link['thumbnail'] = $thumbnailer->get($link['url']);
628 // FIXME! we really need to get rid of ArrayAccess...
629 $item = $LINKSDB[$link['linkdate']];
630 $item['thumbnail'] = $link['thumbnail'];
631 $LINKSDB[$link['linkdate']] = $item;
636 if (isset($link['thumbnail']) && $link['thumbnail'] !== false) {
637 $linksToDisplay[] = $link; // Add to array.
640 // If we retrieved new thumbnails, we update the database every 20 links.
641 // Downloading everything the first time may take a very long time
642 if (!empty($updateDB) && $cpt == 20) {
643 $LINKSDB->save($conf->get('resource.page_cache'));
649 if (!empty($updateDB)) {
650 $LINKSDB->save($conf->get('resource.page_cache'));
654 'linksToDisplay' => $linksToDisplay,
656 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => $loginManager->isLoggedIn()));
658 foreach ($data as $key => $value) {
659 $PAGE->assign($key, $value);
662 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
663 $PAGE->renderPage('picwall');
667 // -------- Tag cloud
668 if ($targetPage == Router
::$PAGE_TAGCLOUD)
670 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
671 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
672 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
674 // We sort tags alphabetically, then choose a font size according to count.
675 // First, find max value.
677 foreach ($tags as $value) {
678 $maxcount = max($maxcount, $value);
681 alphabetical_sort($tags, false, true);
684 foreach($tags as $key => $value) {
685 if (in_array($key, $filteringTags)) {
688 // Tag font size scaling:
689 // default 15 and 30 logarithm bases affect scaling,
690 // 22 and 6 are arbitrary font sizes for max and min sizes.
691 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
692 $tagList[$key] = array(
694 'size' => number_format($size, 2, '.', ''),
698 $searchTags = implode(' ', escape($filteringTags));
700 'search_tags' => $searchTags,
703 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
705 foreach ($data as $key => $value) {
706 $PAGE->assign($key, $value);
709 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
710 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
711 $PAGE->renderPage('tag.cloud');
716 if ($targetPage == Router
::$PAGE_TAGLIST)
718 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
719 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
720 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
721 foreach ($filteringTags as $tag) {
722 if (array_key_exists($tag, $tags)) {
727 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
728 alphabetical_sort($tags, false, true);
731 $searchTags = implode(' ', escape($filteringTags));
733 'search_tags' => $searchTags,
736 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
738 foreach ($data as $key => $value) {
739 $PAGE->assign($key, $value);
742 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
743 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
744 $PAGE->renderPage('tag.list');
749 if ($targetPage == Router
::$PAGE_DAILY) {
750 showDaily($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
753 // ATOM and RSS feed.
754 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
755 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
756 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
759 $query = $_SERVER['QUERY_STRING'];
760 $cache = new CachedPage(
761 $conf->get('resource.page_cache'),
763 startsWith($query,'do='. $targetPage) && !$loginManager->isLoggedIn()
765 $cached = $cache->cachedVersion();
766 if (!empty($cached)) {
772 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, $loginManager->isLoggedIn());
773 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
774 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
775 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
776 $data = $feedGenerator->buildData();
778 // Process plugin hook.
779 $pluginManager->executeHooks('render_feed', $data, array(
780 'loggedin' => $loginManager->isLoggedIn(),
781 'target' => $targetPage,
784 // Render the template.
785 $PAGE->assignAll($data);
786 $PAGE->renderPage('feed.'. $feedType);
787 $cache->cache(ob_get_contents());
792 // Display opensearch plugin (XML)
793 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
794 header('Content-Type: application/xml; charset=utf-8');
795 $PAGE->assign('serverurl', index_url($_SERVER));
796 $PAGE->renderPage('opensearch');
800 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
801 if (isset($_GET['addtag']))
803 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
804 if (empty($_SERVER['HTTP_REFERER'])) { header('Location: ?searchtags='.urlencode($_GET
['addtag'])); exit; } // In case browser does not send HTTP_REFERER
805 parse_str(parse_url($_SERVER['HTTP_REFERER'],PHP_URL_QUERY
), $params);
807 // Prevent redirection loop
808 if (isset($params['addtag'])) {
809 unset($params['addtag']);
812 // Check if this tag is already in the search query and ignore it if it is.
813 // Each tag is always separated by a space
814 if (isset($params['searchtags'])) {
815 $current_tags = explode(' ', $params['searchtags']);
817 $current_tags = array();
820 foreach ($current_tags as $value) {
821 if ($value === $_GET['addtag']) {
826 // Append the tag if necessary
827 if (empty($params['searchtags'])) {
828 $params['searchtags'] = trim($_GET['addtag']);
831 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
834 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
835 header('Location: ?'.http_build_query($params));
839 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
840 if (isset($_GET['removetag'])) {
841 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
842 if (empty($_SERVER['HTTP_REFERER'])) {
843 header('Location: ?');
847 // In case browser does not send HTTP_REFERER
848 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
850 // Prevent redirection loop
851 if (isset($params['removetag'])) {
852 unset($params['removetag']);
855 if (isset($params['searchtags'])) {
856 $tags = explode(' ', $params['searchtags']);
857 // Remove value from array $tags.
858 $tags = array_diff($tags, array($_GET['removetag']));
859 $params['searchtags'] = implode(' ',$tags);
861 if (empty($params['searchtags'])) {
862 unset($params['searchtags']);
865 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
867 header('Location: ?'.http_build_query($params));
871 // -------- User wants to change the number of links per page (linksperpage=...)
872 if (isset($_GET['linksperpage'])) {
873 if (is_numeric($_GET['linksperpage'])) {
874 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
877 if (! empty($_SERVER['HTTP_REFERER'])) {
878 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
882 header('Location: '. $location);
886 // -------- User wants to see only private links (toggle)
887 if (isset($_GET['visibility'])) {
888 if ($_GET['visibility'] === 'private') {
889 // Visibility not set or not already private, set private, otherwise reset it
890 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
891 // See only private links
892 $_SESSION['visibility'] = 'private';
894 unset($_SESSION['visibility']);
896 } elseif ($_GET['visibility'] === 'public') {
897 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
898 // See only public links
899 $_SESSION['visibility'] = 'public';
901 unset($_SESSION['visibility']);
905 if (! empty($_SERVER['HTTP_REFERER'])) {
906 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
910 header('Location: '. $location);
914 // -------- User wants to see only untagged links (toggle)
915 if (isset($_GET['untaggedonly'])) {
916 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
918 if (! empty($_SERVER['HTTP_REFERER'])) {
919 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
923 header('Location: '. $location);
927 // -------- Handle other actions allowed for non-logged in users:
928 if (!$loginManager->isLoggedIn())
930 // User tries to post new link but is not logged in:
931 // Show login screen, then redirect to ?post=...
932 if (isset($_GET['post']))
934 header( // Redirect to login page, then back to post link.
935 'Location: ?do=login&post='.urlencode($_GET['post']).
936 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
937 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
938 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
939 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
944 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
945 if (isset($_GET['edit_link'])) {
946 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
950 exit; // Never remove this one! All operations below are reserved for logged in user.
953 // -------- All other functions are reserved for the registered user:
955 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
956 if ($targetPage == Router
::$PAGE_TOOLS)
959 'pageabsaddr' => index_url($_SERVER),
960 'sslenabled' => is_https($_SERVER),
962 $pluginManager->executeHooks('render_tools', $data);
964 foreach ($data as $key => $value) {
965 $PAGE->assign($key, $value);
968 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
969 $PAGE->renderPage('tools');
973 // -------- User wants to change his/her password.
974 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD)
976 if ($conf->get('security.open_shaarli')) {
977 die(t('You are not supposed to change a password on an Open Shaarli.'));
980 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword']))
982 if (!$sessionManager->checkToken($_POST['token'])) die(t('Wrong token.')); // Go away!
984 // Make sure old password is correct.
985 $oldhash = sha1($_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt'));
986 if ($oldhash!= $conf->get('credentials.hash')) {
987 echo '<script>alert("'. t('The old password is not correct.') .'");document.location=\'?do=changepasswd\';</script>';
991 // Salt renders rainbow-tables attacks useless.
992 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
993 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $conf->get('credentials.login') . $conf->get('credentials.salt')));
995 $conf->write($loginManager->isLoggedIn());
997 catch(Exception
$e) {
999 'ERROR while writing config file after changing password.' . PHP_EOL
.
1003 // TODO: do not handle exceptions/errors in JS.
1004 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
1007 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
1010 else // show the change password form.
1012 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
1013 $PAGE->renderPage('changepassword');
1018 // -------- User wants to change configuration
1019 if ($targetPage == Router
::$PAGE_CONFIGURE)
1021 if (!empty($_POST['title']) )
1023 if (!$sessionManager->checkToken($_POST['token'])) {
1024 die(t('Wrong token.')); // Go away!
1027 if (!empty($_POST['continent']) && !empty($_POST['city'])
1028 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1030 $tz = $_POST['continent'] . '/' . $_POST['city'];
1032 $conf->set('general.timezone', $tz);
1033 $conf->set('general.title', escape($_POST['title']));
1034 $conf->set('general.header_link', escape($_POST['titleLink']));
1035 $conf->set('resource.theme', escape($_POST['theme']));
1036 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1037 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1038 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1039 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1040 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1041 $conf->set('api.enabled', !empty($_POST['enableApi']));
1042 $conf->set('api.secret', escape($_POST['apiSecret']));
1043 $conf->set('translation.language', escape($_POST['language']));
1044 $conf->set('thumbnails.enabled', !empty($_POST['enableThumbnails']));
1047 $conf->write($loginManager->isLoggedIn());
1048 $history->updateSettings();
1049 invalidateCaches($conf->get('resource.page_cache'));
1051 catch(Exception
$e) {
1053 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1057 // TODO: do not handle exceptions/errors in JS.
1058 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1061 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1064 else // Show the configuration form.
1066 $PAGE->assign('title', $conf->get('general.title'));
1067 $PAGE->assign('theme', $conf->get('resource.theme'));
1068 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1069 list($continents, $cities) = generateTimeZoneData(
1070 timezone_identifiers_list(),
1071 $conf->get('general.timezone')
1073 $PAGE->assign('continents', $continents);
1074 $PAGE->assign('cities', $cities);
1075 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1076 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1077 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1078 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1079 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1080 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1081 $PAGE->assign('api_secret', $conf->get('api.secret'));
1082 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1083 $PAGE->assign('language', $conf->get('translation.language'));
1084 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1085 $PAGE->renderPage('configure');
1090 // -------- User wants to rename a tag or delete it
1091 if ($targetPage == Router
::$PAGE_CHANGETAG)
1093 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1094 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1095 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1096 $PAGE->renderPage('changetag');
1100 if (!$sessionManager->checkToken($_POST['token'])) {
1101 die(t('Wrong token.'));
1104 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), escape($_POST['totag']));
1105 $LINKSDB->save($conf->get('resource.page_cache'));
1106 foreach ($alteredLinks as $link) {
1107 $history->updateLink($link);
1109 $delete = empty($_POST['totag']);
1110 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1111 $count = count($alteredLinks);
1113 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1114 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1115 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1119 // -------- User wants to add a link without using the bookmarklet: Show form.
1120 if ($targetPage == Router
::$PAGE_ADDLINK)
1122 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1123 $PAGE->renderPage('addlink');
1127 // -------- User clicked the "Save" button when editing a link: Save link to database.
1128 if (isset($_POST['save_edit']))
1131 if (! $sessionManager->checkToken($_POST['token'])) {
1132 die(t('Wrong token.'));
1135 // lf_id should only be present if the link exists.
1136 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1137 // Linkdate is kept here to:
1138 // - use the same permalink for notes as they're displayed when creating them
1139 // - let users hack creation date of their posts
1140 // See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare
1141 $linkdate = escape($_POST['lf_linkdate']);
1142 if (isset($LINKSDB[$id])) {
1144 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1145 $updated = new DateTime();
1146 $shortUrl = $LINKSDB[$id]['shorturl'];
1150 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1152 $shortUrl = link_small_hash($created, $id);
1156 // Remove multiple spaces.
1157 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1158 // Remove first '-' char in tags.
1159 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1160 // Remove duplicates.
1161 $tags = implode(' ', array_unique(explode(' ', $tags)));
1163 if (empty(trim($_POST['lf_url
']))) {
1164 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1166 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1170 'title
' => trim($_POST['lf_title
']),
1172 'description
' => $_POST['lf_description
'],
1173 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1174 'created
' => $created,
1175 'updated
' => $updated,
1176 'tags
' => str_replace(',', ' ', $tags),
1177 'shorturl
' => $shortUrl,
1180 // If title is empty, use the URL as title.
1181 if ($link['title
'] == '') {
1182 $link['title
'] = $link['url
'];
1185 if ($conf->get('thumbnails
.enabled
')) {
1186 $thumbnailer = new Thumbnailer($conf);
1187 $link['thumbnail
'] = $thumbnailer->get($url);
1190 $pluginManager->executeHooks('save_link
', $link);
1192 $LINKSDB[$id] = $link;
1193 $LINKSDB->save($conf->get('resource.page_cache
'));
1195 $history->addLink($link);
1197 $history->updateLink($link);
1200 // If we are called from the bookmarklet, we must close the popup:
1201 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1202 echo '<script
>self
.close();</script
>';
1206 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1207 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1208 // Scroll to the link which has been edited.
1209 $location .= '#' . $link['shorturl'];
1210 // After saving the link, redirect to the page the user was on.
1211 header('Location: '. $location);
1215 // -------- User clicked the "Cancel" button when editing a link.
1216 if (isset($_POST['cancel_edit']))
1218 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1219 if (! isset($LINKSDB[$id])) {
1220 header('Location: ?');
1222 // If we are called from the bookmarklet, we must close the popup:
1223 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1224 $link = $LINKSDB[$id];
1225 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1226 // Scroll to the link which has been edited.
1227 $returnurl .= '#'. $link['shorturl'];
1228 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1229 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1233 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1234 if ($targetPage == Router
::$PAGE_DELETELINK)
1236 if (! $sessionManager->checkToken($_GET['token'])) {
1237 die(t('Wrong token.'));
1240 $ids = trim($_GET['lf_linkdate']);
1241 if (strpos($ids, ' ') !== false) {
1242 // multiple, space-separated ids provided
1243 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1245 // only a single id provided
1248 // assert at least one id is given
1250 die('no id provided');
1252 foreach ($ids as $id) {
1253 $id = (int) escape($id);
1254 $link = $LINKSDB[$id];
1255 $pluginManager->executeHooks('delete_link', $link);
1256 unset($LINKSDB[$id]);
1258 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1259 $history->deleteLink($link);
1261 // If we are called from the bookmarklet, we must close the popup:
1262 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1265 if (isset($_SERVER['HTTP_REFERER'])) {
1266 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1267 $location = generateLocation(
1268 $_SERVER['HTTP_REFERER'],
1269 $_SERVER['HTTP_HOST'],
1270 ['delete_link', 'edit_link', $link['shorturl']]
1274 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1278 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1279 if (isset($_GET['edit_link']))
1281 $id = (int) escape($_GET['edit_link']);
1282 $link = $LINKSDB[$id]; // Read database
1283 if (!$link) { header('Location: ?'); exit; } // Link not found in database.
1284 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1287 'link_is_new' => false,
1288 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1289 'tags' => $LINKSDB->linksCountPerTag(),
1291 $pluginManager->executeHooks('render_editlink', $data);
1293 foreach ($data as $key => $value) {
1294 $PAGE->assign($key, $value);
1297 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1298 $PAGE->renderPage('editlink');
1302 // -------- User want to post a new link: Display link edit form.
1303 if (isset($_GET['post'])) {
1304 $url = cleanup_url($_GET['post']);
1306 $link_is_new = false;
1307 // Check if URL is not already in database (in this case, we will edit the existing link)
1308 $link = $LINKSDB->getLinkFromUrl($url);
1311 $link_is_new = true;
1312 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1313 // Get title if it was provided in URL (by the bookmarklet).
1314 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1315 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1316 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1317 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1318 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1319 // If this is an HTTP(S) link, we try go get the page to extract the title (otherwise we will to straight to the edit form.)
1320 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1321 // Short timeout to keep the application responsive
1322 // The callback will fill $charset and $title with data from the downloaded page.
1325 $conf->get('general.download_timeout', 30),
1326 $conf->get('general.download_max_size', 4194304),
1327 get_curl_download_callback($charset, $title)
1329 if (! empty($title) && strtolower($charset) != 'utf-8') {
1330 $title = mb_convert_encoding($title, 'utf-8', $charset);
1335 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1336 $title = $conf->get('general.default_note_title', t('Note: '));
1338 $url = escape($url);
1339 $title = escape($title);
1342 'linkdate' => $linkdate,
1345 'description' => $description,
1347 'private' => $private,
1350 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1355 'link_is_new' => $link_is_new,
1356 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1357 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1358 'tags' => $LINKSDB->linksCountPerTag(),
1359 'default_private_links' => $conf->get('privacy.default_private_links', false),
1361 $pluginManager->executeHooks('render_editlink', $data);
1363 foreach ($data as $key => $value) {
1364 $PAGE->assign($key, $value);
1367 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1368 $PAGE->renderPage('editlink');
1372 if ($targetPage == Router
::$PAGE_EXPORT) {
1373 // Export links as a Netscape Bookmarks file
1375 if (empty($_GET['selection'])) {
1376 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1377 $PAGE->renderPage('export');
1381 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1382 $selection = $_GET['selection'];
1383 if (isset($_GET['prepend_note_url'])) {
1384 $prependNoteUrl = $_GET['prepend_note_url'];
1386 $prependNoteUrl = false;
1392 NetscapeBookmarkUtils
::filterAndFormat(
1399 } catch (Exception
$exc) {
1400 header('Content-Type: text/plain; charset=utf-8');
1401 echo $exc->getMessage();
1404 $now = new DateTime();
1405 header('Content-Type: text/html; charset=utf-8');
1407 'Content-disposition: attachment; filename=bookmarks_'
1408 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1410 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1411 $PAGE->assign('eol', PHP_EOL
);
1412 $PAGE->assign('selection', $selection);
1413 $PAGE->renderPage('export.bookmarks');
1417 if ($targetPage == Router
::$PAGE_IMPORT) {
1418 // Upload a Netscape bookmark dump to import its contents
1420 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1421 // Show import dialog
1424 get_max_upload_size(
1425 ini_get('post_max_size'),
1426 ini_get('upload_max_filesize'),
1432 get_max_upload_size(
1433 ini_get('post_max_size'),
1434 ini_get('upload_max_filesize'),
1438 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1439 $PAGE->renderPage('import');
1443 // Import bookmarks from an uploaded file
1444 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1445 // The file is too big or some form field may be missing.
1448 'The file you are trying to upload is probably bigger than what this webserver can accept'
1449 .' (%s). Please upload in smaller chunks.'
1451 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1453 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1456 if (! $sessionManager->checkToken($_POST['token'])) {
1457 die('Wrong token.');
1459 $status = NetscapeBookmarkUtils
::import(
1466 echo '<script>alert("'.$status.'");document.location=\'?do='
1467 .Router
::$PAGE_IMPORT .'\';</script>';
1471 // Plugin administration page
1472 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1473 $pluginMeta = $pluginManager->getPluginsMeta();
1475 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1476 $enabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] !== false; });
1478 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1481 function($a, $b) { return $a
['order'] - $b
['order']; }
1483 $disabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] === false; });
1485 $PAGE->assign('enabledPlugins', $enabledPlugins);
1486 $PAGE->assign('disabledPlugins', $disabledPlugins);
1487 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1488 $PAGE->renderPage('pluginsadmin');
1492 // Plugin administration form action
1493 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1495 if (isset($_POST['parameters_form'])) {
1496 unset($_POST['parameters_form']);
1497 foreach ($_POST as $param => $value) {
1498 $conf->set('plugins.'. $param, escape($value));
1502 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1504 $conf->write($loginManager->isLoggedIn());
1505 $history->updateSettings();
1507 catch (Exception
$e) {
1509 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1513 // TODO: do not handle exceptions/errors in JS.
1514 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do='. Router
::$PAGE_PLUGINSADMIN .'\';</script>';
1517 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1521 // Get a fresh token
1522 if ($targetPage == Router
::$GET_TOKEN) {
1523 header('Content-Type:text/plain');
1524 echo $sessionManager->generateToken($conf);
1528 // -------- Otherwise, simply display search form and links:
1529 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
1534 * Template for the list of links (<div id="linklist">)
1535 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1537 * @param pageBuilder $PAGE pageBuilder instance.
1538 * @param LinkDB $LINKSDB LinkDB instance.
1539 * @param ConfigManager $conf Configuration Manager instance.
1540 * @param PluginManager $pluginManager Plugin Manager instance.
1541 * @param LoginManager $loginManager LoginManager instance
1543 function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
1545 // Used in templates
1546 if (isset($_GET['searchtags'])) {
1547 if (! empty($_GET['searchtags'])) {
1548 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1550 $searchtags = false;
1555 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1558 if (! empty($_SERVER['QUERY_STRING'])
1559 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1561 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1562 } catch (LinkNotFoundException
$e) {
1563 $PAGE->render404($e->getMessage());
1567 // Filter links according search parameters.
1568 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1570 'searchtags' => $searchtags,
1571 'searchterm' => $searchterm,
1573 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1576 // ---- Handle paging.
1578 foreach ($linksToDisplay as $key => $value) {
1582 // Select articles according to paging.
1583 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1584 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1585 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1586 $page = $page < 1 ? 1 : $page;
1587 $page = $page > $pagecount ? $pagecount : $page;
1589 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1590 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1592 if ($conf->get('thumbnails.enabled')) {
1593 $thumbnailer = new Thumbnailer($conf);
1596 $linkDisp = array();
1597 while ($i<$end && $i<count($keys))
1599 $link = $linksToDisplay[$keys[$i]];
1600 $link['description'] = format_description(
1601 $link['description'],
1602 $conf->get('redirector.url'),
1603 $conf->get('redirector.encode_url')
1605 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1606 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1607 $link['timestamp'] = $link['created']->getTimestamp();
1608 if (! empty($link['updated'])) {
1609 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1611 $link['updated_timestamp'] = '';
1613 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1614 uasort($taglist, 'strcasecmp');
1615 $link['taglist'] = $taglist;
1617 // Thumbnails enabled, not a note,
1618 // and (never retrieved yet or no valid cache file)
1619 if ($conf->get('thumbnails.enabled') && $link['url'][0] != '?'
1620 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
1622 $link['thumbnail'] = $thumbnailer->get($link['url']);
1623 // FIXME! we really need to get rid of ArrayAccess...
1624 $item = $LINKSDB[$keys[$i]];
1625 $item['thumbnail'] = $link['thumbnail'];
1626 $LINKSDB[$keys[$i]] = $item;
1630 // Check for both signs of a note: starting with ? and 7 chars long.
1631 if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1632 $link['url'] = index_url($_SERVER) . $link['url'];
1635 $linkDisp[$keys[$i]] = $link;
1639 // If we retrieved new thumbnails, we update the database.
1640 if (!empty($updateDB)) {
1641 $LINKSDB->save($conf->get('resource.page_cache'));
1644 // Compute paging navigation
1645 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1646 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1647 $previous_page_url = '';
1648 if ($i != count($keys)) {
1649 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1653 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1656 // Fill all template fields.
1658 'previous_page_url' => $previous_page_url,
1659 'next_page_url' => $next_page_url,
1660 'page_current' => $page,
1661 'page_max' => $pagecount,
1662 'result_count' => count($linksToDisplay),
1663 'search_term' => $searchterm,
1664 'search_tags' => $searchtags,
1665 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1666 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1667 'links' => $linkDisp,
1670 // If there is only a single link, we change on-the-fly the title of the page.
1671 if (count($linksToDisplay) == 1) {
1672 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1673 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1674 $data['pagetitle'] = t('Search: ');
1675 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1676 $bracketWrap = function ($tag) {
1677 return '['. $tag .']';
1679 $data['pagetitle'] .= ! empty($searchtags)
1680 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1682 $data['pagetitle'] .= '- '. $conf->get('general.title');
1685 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1687 foreach ($data as $key => $value) {
1688 $PAGE->assign($key, $value);
1696 * This function should NEVER be called if the file data/config.php exists.
1698 * @param ConfigManager $conf Configuration Manager instance.
1699 * @param SessionManager $sessionManager SessionManager instance
1700 * @param LoginManager $loginManager LoginManager instance
1702 function install($conf, $sessionManager, $loginManager) {
1703 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1704 if (endsWith($_SERVER['HTTP_HOST'],'.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions',0705);
1707 // This part makes sure sessions works correctly.
1708 // (Because on some hosts, session.save_path may not be set correctly,
1709 // or we may not have write access to it.)
1710 if (isset($_GET['test_session']) && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working'))
1712 // Step 2: Check if data in session is correct.
1714 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1715 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1716 'and that you have write access to it.<br>'.
1717 'It currently points to %s.<br>'.
1718 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1719 'or any custom hostname without a dot causes cookie storage to fail. '.
1720 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1722 $msg = sprintf($msg, session_save_path());
1724 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1727 if (!isset($_SESSION['session_tested']))
1728 { // Step 1 : Try to store data in session and reload page.
1729 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1730 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1732 if (isset($_GET['test_session']))
1733 { // Step 3: Sessions are OK. Remove test parameter from URL.
1734 header('Location: '.index_url($_SERVER));
1738 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
1741 if (!empty($_POST['continent']) && !empty($_POST['city'])
1742 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1744 $tz = $_POST['continent'].'/'.$_POST['city'];
1746 $conf->set('general.timezone', $tz);
1747 $login = $_POST['setlogin'];
1748 $conf->set('credentials.login', $login);
1749 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1750 $conf->set('credentials.salt', $salt);
1751 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1752 if (!empty($_POST['title'])) {
1753 $conf->set('general.title', escape($_POST['title']));
1755 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
1757 $conf->set('translation.language', escape($_POST['language']));
1758 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1759 $conf->set('api.enabled', !empty($_POST['enableApi']));
1762 generate_api_secret(
1763 $conf->get('credentials.login'),
1764 $conf->get('credentials.salt')
1768 // Everything is ok, let's create config file.
1769 $conf->write($loginManager->isLoggedIn());
1771 catch(Exception
$e) {
1773 'ERROR while writing config file after installation.' . PHP_EOL
.
1777 // TODO: do not handle exceptions/errors in JS.
1778 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1781 echo '<script>alert("Shaarli is now configured. Please enter your login/password and start shaaring your links!");document.location=\'?do=login\';</script>';
1785 $PAGE = new PageBuilder($conf, null, $sessionManager->generateToken());
1786 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1787 $PAGE->assign('continents', $continents);
1788 $PAGE->assign('cities', $cities);
1789 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1790 $PAGE->renderPage('install');
1794 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf
); exit; }
1795 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1796 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1800 $history = new History($conf->get('resource.history'));
1801 } catch(Exception
$e) {
1802 die($e->getMessage());
1805 $linkDb = new LinkDB(
1806 $conf->get('resource.datastore'),
1807 $loginManager->isLoggedIn(),
1808 $conf->get('privacy.hide_public_links'),
1809 $conf->get('redirector.url'),
1810 $conf->get('redirector.encode_url')
1813 $container = new \Slim\
Container();
1814 $container['conf'] = $conf;
1815 $container['plugins'] = $pluginManager;
1816 $container['history'] = $history;
1817 $app = new \Slim\
App($container);
1820 $app->group('/api/v1', function() {
1821 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1822 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1823 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1824 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1825 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1826 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1827 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
1828 })->add('\Shaarli\Api\ApiMiddleware');
1830 $response = $app->run(true);
1831 // Hack to make Slim and Shaarli router work together:
1832 // If a Slim route isn't found and NOT API call, we call renderPage().
1833 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1834 // We use UTF-8 for proper international characters handling.
1835 header('Content-Type: text/html; charset=utf-8');
1836 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1838 $app->respond($response);