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-requirements/\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\Languages
;
79 use \Shaarli\ThemeUtils
;
80 use \Shaarli\Config\ConfigManager
;
81 use \Shaarli\SessionManager
;
83 // Ensure the PHP version is supported
85 ApplicationUtils
::checkPHPVersion('5.5', PHP_VERSION
);
86 } catch(Exception
$exc) {
87 header('Content-Type: text/plain; charset=utf-8');
88 echo $exc->getMessage();
92 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
94 // Force cookie path (but do not change lifetime)
95 $cookie = session_get_cookie_params();
97 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
98 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
100 // Set default cookie expiration and path.
101 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
102 // Set session parameters on server side.
103 // If the user does not access any page within this time, his/her session is considered expired.
104 define('INACTIVITY_TIMEOUT', 3600); // in seconds.
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);
127 // LC_MESSAGES isn't defined without php-intl, in this case use LC_COLLATE locale instead.
128 if (! defined('LC_MESSAGES')) {
129 define('LC_MESSAGES', LC_COLLATE
);
132 // Sniff browser language and set date format accordingly.
133 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
134 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
137 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
139 $conf->setEmpty('general.timezone', date_default_timezone_get());
140 $conf->setEmpty('general.title', t('Shared links on '). escape(index_url($_SERVER)));
141 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
142 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
144 $pluginManager = new PluginManager($conf);
145 $pluginManager->load($conf->get('general.enabled_plugins'));
147 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
149 ob_start(); // Output buffering for the page cache.
151 // Prevent caching on client side or proxy: (yes, it's ugly)
152 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
153 header("Cache-Control: no-store, no-cache, must-revalidate");
154 header("Cache-Control: post-check=0, pre-check=0", false);
155 header("Pragma: no-cache");
157 if (! is_file($conf->getConfigFileExt())) {
158 // Ensure Shaarli has proper access to its resources
159 $errors = ApplicationUtils
::checkResourcePermissions($conf);
161 if ($errors != array()) {
162 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
164 foreach ($errors as $error) {
165 $message .= '<li>'.$error.'</li>';
169 header('Content-Type: text/html; charset=utf-8');
174 // Display the installation form if no existing config is found
175 install($conf, $sessionManager);
178 // a token depending of deployment salt, user password, and the current ip
179 define('STAY_SIGNED_IN_TOKEN', sha1($conf->get('credentials.hash') . $_SERVER['REMOTE_ADDR'] . $conf->get('credentials.salt')));
182 * Checking session state (i.e. is the user still logged in)
184 * @param ConfigManager $conf The configuration manager.
186 * @return bool: true if the user is logged in, false otherwise.
188 function setup_login_state($conf)
190 if ($conf->get('security.open_shaarli')) {
193 $userIsLoggedIn = false; // By default, we do not consider the user as logged in;
194 $loginFailure = false; // If set to true, every attempt to authenticate the user will fail. This indicates that an important condition isn't met.
195 if (! $conf->exists('credentials.login')) {
196 $userIsLoggedIn = false; // Shaarli is not configured yet.
197 $loginFailure = true;
199 if (isset($_COOKIE['shaarli_staySignedIn']) &&
200 $_COOKIE['shaarli_staySignedIn']===STAY_SIGNED_IN_TOKEN
&&
203 fillSessionInfo($conf);
204 $userIsLoggedIn = true;
206 // If session does not exist on server side, or IP address has changed, or session has expired, logout.
207 if (empty($_SESSION['uid'])
208 || ($conf->get('security.session_protection_disabled') === false && $_SESSION['ip'] != allIPs())
209 || time() >= $_SESSION['expires_on'])
212 $userIsLoggedIn = false;
213 $loginFailure = true;
215 if (!empty($_SESSION['longlastingsession'])) {
216 $_SESSION['expires_on']=time()+
$_SESSION['longlastingsession']; // In case of "Stay signed in" checked.
219 $_SESSION['expires_on']=time()+INACTIVITY_TIMEOUT
; // Standard session expiration date.
221 if (!$loginFailure) {
222 $userIsLoggedIn = true;
225 return $userIsLoggedIn;
227 $userIsLoggedIn = setup_login_state($conf);
229 // ------------------------------------------------------------------------------------------
230 // Session management
232 // Returns the IP address of the client (Used to prevent session cookie hijacking.)
235 $ip = $_SERVER['REMOTE_ADDR'];
236 // Then we use more HTTP headers to prevent session hijacking from users behind the same proxy.
237 if (isset($_SERVER['HTTP_X_FORWARDED_FOR'])) { $ip
=$ip
.'_'.$_SERVER
['HTTP_X_FORWARDED_FOR']; }
238 if (isset($_SERVER['HTTP_CLIENT_IP'])) { $ip
=$ip
.'_'.$_SERVER
['HTTP_CLIENT_IP']; }
245 * @param ConfigManager $conf Configuration Manager instance.
247 function fillSessionInfo($conf)
249 $_SESSION['uid'] = sha1(uniqid('',true).'_'.mt_rand()); // Generate unique random number (different than phpsessionid)
250 $_SESSION['ip']=allIPs(); // We store IP address(es) of the client to make sure session is not hijacked.
251 $_SESSION['username']= $conf->get('credentials.login');
252 $_SESSION['expires_on']=time()+INACTIVITY_TIMEOUT
; // Set session expiration.
256 * Check that user/password is correct.
258 * @param string $login Username
259 * @param string $password User password
260 * @param ConfigManager $conf Configuration Manager instance.
262 * @return bool: authentication successful or not.
264 function check_auth($login, $password, $conf)
266 $hash = sha1($password . $login . $conf->get('credentials.salt'));
267 if ($login == $conf->get('credentials.login') && $hash == $conf->get('credentials.hash'))
268 { // Login/password is correct.
269 fillSessionInfo($conf);
270 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Login successful');
273 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Login failed for user '.$login);
277 // Returns true if the user is logged in.
278 function isLoggedIn()
280 global $userIsLoggedIn;
281 return $userIsLoggedIn;
286 if (isset($_SESSION)) {
287 unset($_SESSION['uid']);
288 unset($_SESSION['ip']);
289 unset($_SESSION['username']);
290 unset($_SESSION['visibility']);
291 unset($_SESSION['untaggedonly']);
293 setcookie('shaarli_staySignedIn', FALSE, 0, WEB_PATH
);
297 // ------------------------------------------------------------------------------------------
298 // Brute force protection system
299 // Several consecutive failed logins will ban the IP address for 30 minutes.
300 if (!is_file($conf->get('resource.ban_file', 'data/ipbans.php'))) {
303 $conf->get('resource.ban_file', 'data/ipbans.php'),
304 "<?php\n\$GLOBALS['IPBANS']=".var_export(array('FAILURES'=>array(),'BANS'=>array()),true).";\n?>"
307 include $conf->get('resource.ban_file', 'data/ipbans.php');
309 * Signal a failed login. Will ban the IP if too many failures:
311 * @param ConfigManager $conf Configuration Manager instance.
313 function ban_loginFailed($conf)
315 $ip = $_SERVER['REMOTE_ADDR'];
316 $trusted = $conf->get('security.trusted_proxies', array());
317 if (in_array($ip, $trusted)) {
318 $ip = getIpAddressFromProxy($_SERVER, $trusted);
323 $gb = $GLOBALS['IPBANS'];
324 if (! isset($gb['FAILURES'][$ip])) {
325 $gb['FAILURES'][$ip]=0;
327 $gb['FAILURES'][$ip]++
;
328 if ($gb['FAILURES'][$ip] > ($conf->get('security.ban_after') - 1))
330 $gb['BANS'][$ip] = time() +
$conf->get('security.ban_after', 1800);
331 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'IP address banned from login');
333 $GLOBALS['IPBANS'] = $gb;
335 $conf->get('resource.ban_file', 'data/ipbans.php'),
336 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
341 * Signals a successful login. Resets failed login counter.
343 * @param ConfigManager $conf Configuration Manager instance.
345 function ban_loginOk($conf)
347 $ip = $_SERVER['REMOTE_ADDR'];
348 $gb = $GLOBALS['IPBANS'];
349 unset($gb['FAILURES'][$ip]); unset($gb['BANS'][$ip]);
350 $GLOBALS['IPBANS'] = $gb;
352 $conf->get('resource.ban_file', 'data/ipbans.php'),
353 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
358 * Checks if the user CAN login. If 'true', the user can try to login.
360 * @param ConfigManager $conf Configuration Manager instance.
362 * @return bool: true if the user is allowed to login.
364 function ban_canLogin($conf)
366 $ip=$_SERVER["REMOTE_ADDR"]; $gb=$GLOBALS['IPBANS'];
367 if (isset($gb['BANS'][$ip]))
369 // User is banned. Check if the ban has expired:
370 if ($gb['BANS'][$ip]<=time())
371 { // Ban expired, user can try to login again.
372 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Ban lifted.');
373 unset($gb['FAILURES'][$ip]); unset($gb['BANS'][$ip]);
375 $conf->get('resource.ban_file', 'data/ipbans.php'),
376 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
378 return true; // Ban has expired, user can login.
380 return false; // User is banned.
382 return true; // User is not banned.
385 // ------------------------------------------------------------------------------------------
386 // Process login form: Check if login/password is correct.
387 if (isset($_POST['login']))
389 if (!ban_canLogin($conf)) die(t('I said: NO. You are banned for the moment. Go away.'));
390 if (isset($_POST['password'])
391 && $sessionManager->checkToken($_POST['token'])
392 && (check_auth($_POST['login'], $_POST['password'], $conf))
393 ) { // Login/password is OK.
395 // If user wants to keep the session cookie even after the browser closes:
396 if (!empty($_POST['longlastingsession']))
398 $_SESSION['longlastingsession'] = 31536000; // (31536000 seconds = 1 year)
399 $expiration = time() +
$_SESSION['longlastingsession']; // calculate relative cookie expiration (1 year from now)
400 setcookie('shaarli_staySignedIn', STAY_SIGNED_IN_TOKEN
, $expiration, WEB_PATH
);
401 $_SESSION['expires_on'] = $expiration; // Set session expiration on server-side.
403 $cookiedir = ''; if(dirname($_SERVER['SCRIPT_NAME'])!='/') $cookiedir=dirname($_SERVER["SCRIPT_NAME"]).'/';
404 session_set_cookie_params($_SESSION['longlastingsession'],$cookiedir,$_SERVER['SERVER_NAME']); // Set session cookie expiration on client side
405 // Note: Never forget the trailing slash on the cookie path!
406 session_regenerate_id(true); // Send cookie with new expiration date to browser.
408 else // Standard session expiration (=when browser closes)
410 $cookiedir = ''; if(dirname($_SERVER['SCRIPT_NAME'])!='/') $cookiedir=dirname($_SERVER["SCRIPT_NAME"]).'/';
411 session_set_cookie_params(0,$cookiedir,$_SERVER['SERVER_NAME']); // 0 means "When browser closes"
412 session_regenerate_id(true);
415 // Optional redirect after login:
416 if (isset($_GET['post'])) {
417 $uri = '?post='. urlencode($_GET['post']);
418 foreach (array('description', 'source', 'title', 'tags') as $param) {
419 if (!empty($_GET[$param])) {
420 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
423 header('Location: '. $uri);
427 if (isset($_GET['edit_link'])) {
428 header('Location: ?edit_link='. escape($_GET['edit_link']));
432 if (isset($_POST['returnurl'])) {
433 // Prevent loops over login screen.
434 if (strpos($_POST['returnurl'], 'do=login') === false) {
435 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
439 header('Location: ?'); exit;
443 ban_loginFailed($conf);
444 $redir = '&username='. urlencode($_POST['login']);
445 if (isset($_GET['post'])) {
446 $redir .= '&post=' . urlencode($_GET['post']);
447 foreach (array('description', 'source', 'title', 'tags') as $param) {
448 if (!empty($_GET[$param])) {
449 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
453 // Redirect to login screen.
454 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
459 // ------------------------------------------------------------------------------------------
460 // Token management for XSRF protection
461 // Token should be used in any form which acts on data (create,update,delete,import...).
462 if (!isset($_SESSION['tokens'])) $_SESSION['tokens']=array(); // Token are attached to the session.
465 * Daily RSS feed: 1 RSS entry per day giving all the links on that day.
466 * Gives the last 7 days (which have links).
467 * This RSS feed cannot be filtered.
469 * @param ConfigManager $conf Configuration Manager instance.
471 function showDailyRSS($conf) {
473 $query = $_SERVER['QUERY_STRING'];
474 $cache = new CachedPage(
475 $conf->get('config.PAGE_CACHE'),
477 startsWith($query,'do=dailyrss') && !isLoggedIn()
479 $cached = $cache->cachedVersion();
480 if (!empty($cached)) {
485 // If cached was not found (or not usable), then read the database and build the response:
486 // Read links from database (and filter private links if used it not logged in).
487 $LINKSDB = new LinkDB(
488 $conf->get('resource.datastore'),
490 $conf->get('privacy.hide_public_links'),
491 $conf->get('redirector.url'),
492 $conf->get('redirector.encode_url')
495 /* Some Shaarlies may have very few links, so we need to look
496 back in time until we have enough days ($nb_of_days).
498 $nb_of_days = 7; // We take 7 days.
499 $today = date('Ymd');
502 foreach ($LINKSDB as $link) {
503 $day = $link['created']->format('Ymd'); // Extract day (without time)
504 if (strcmp($day, $today) < 0) {
505 if (empty($days[$day])) {
506 $days[$day] = array();
508 $days[$day][] = $link;
511 if (count($days) > $nb_of_days) {
512 break; // Have we collected enough days?
516 // Build the RSS feed.
517 header('Content-Type: application/rss+xml; charset=utf-8');
518 $pageaddr = escape(index_url($_SERVER));
519 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
521 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
522 echo '<link>'. $pageaddr .'</link>';
523 echo '<description>Daily shared links</description>';
524 echo '<language>en-en</language>';
525 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
528 foreach ($days as $day => $links) {
529 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
530 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
532 // We pre-format some fields for proper output.
533 foreach ($links as &$link) {
534 $link['formatedDescription'] = format_description(
535 $link['description'],
536 $conf->get('redirector.url'),
537 $conf->get('redirector.encode_url')
539 $link['thumbnail'] = thumbnail($conf, $link['url']);
540 $link['timestamp'] = $link['created']->getTimestamp();
541 if (startsWith($link['url'], '?')) {
542 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
546 // Then build the HTML for this day:
548 $tpl->assign('title', $conf->get('general.title'));
549 $tpl->assign('daydate', $dayDate->getTimestamp());
550 $tpl->assign('absurl', $absurl);
551 $tpl->assign('links', $links);
552 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
553 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
554 $html = $tpl->draw('dailyrss', true);
556 echo $html . PHP_EOL
;
558 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
560 $cache->cache(ob_get_contents());
566 * Show the 'Daily' page.
568 * @param PageBuilder $pageBuilder Template engine wrapper.
569 * @param LinkDB $LINKSDB LinkDB instance.
570 * @param ConfigManager $conf Configuration Manager instance.
571 * @param PluginManager $pluginManager Plugin Manager instane.
573 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager)
575 $day = date('Ymd', strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
576 if (isset($_GET['day'])) {
580 $days = $LINKSDB->days();
581 $i = array_search($day, $days);
582 if ($i === false && count($days)) {
583 // no links for day, but at least one day with links
584 $i = count($days) - 1;
592 $previousday=$days[$i - 1];
594 if ($i < count($days) - 1) {
595 $nextday = $days[$i +
1];
599 $linksToDisplay = $LINKSDB->filterDay($day);
600 } catch (Exception
$exc) {
602 $linksToDisplay = array();
605 // We pre-format some fields for proper output.
606 foreach($linksToDisplay as $key => $link) {
607 $taglist = explode(' ',$link['tags']);
608 uasort($taglist, 'strcasecmp');
609 $linksToDisplay[$key]['taglist']=$taglist;
610 $linksToDisplay[$key]['formatedDescription'] = format_description(
611 $link['description'],
612 $conf->get('redirector.url'),
613 $conf->get('redirector.encode_url')
615 $linksToDisplay[$key]['thumbnail'] = thumbnail($conf, $link['url']);
616 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
619 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
621 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
622 'linksToDisplay' => $linksToDisplay,
623 'day' => $dayDate->getTimestamp(),
624 'dayDate' => $dayDate,
625 'previousday' => $previousday,
626 'nextday' => $nextday,
629 /* Hook is called before column construction so that plugins don't have
630 to deal with columns. */
631 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => isLoggedIn()));
633 /* We need to spread the articles on 3 columns.
634 I did not want to use a JavaScript lib like http://masonry.desandro.com/
635 so I manually spread entries with a simple method: I roughly evaluate the
636 height of a div according to title and description length.
638 $columns = array(array(), array(), array()); // Entries to display, for each column.
639 $fill = array(0, 0, 0); // Rough estimate of columns fill.
640 foreach($data['linksToDisplay'] as $key => $link) {
641 // Roughly estimate length of entry (by counting characters)
642 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
643 // Description: 836 characters gives roughly 342 pixel height.
644 // This is not perfect, but it's usually OK.
645 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
646 if ($link['thumbnail']) {
647 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
649 // Then put in column which is the less filled:
650 $smallest = min($fill); // find smallest value in array.
651 $index = array_search($smallest, $fill); // find index of this smallest value.
652 array_push($columns[$index], $link); // Put entry in this column.
653 $fill[$index] +
= $length;
656 $data['cols'] = $columns;
658 foreach ($data as $key => $value) {
659 $pageBuilder->assign($key, $value);
662 $pageBuilder->renderPage('daily');
667 * Renders the linklist
669 * @param pageBuilder $PAGE pageBuilder instance.
670 * @param LinkDB $LINKSDB LinkDB instance.
671 * @param ConfigManager $conf Configuration Manager instance.
672 * @param PluginManager $pluginManager Plugin Manager instance.
674 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager) {
675 buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager); // Compute list of links to display
676 $PAGE->renderPage('linklist');
680 * Render HTML page (according to URL parameters and user rights)
682 * @param ConfigManager $conf Configuration Manager instance.
683 * @param PluginManager $pluginManager Plugin Manager instance,
684 * @param LinkDB $LINKSDB
685 * @param History $history instance
686 * @param SessionManager $sessionManager SessionManager instance
688 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager)
690 $updater = new Updater(
691 read_updates_file($conf->get('resource.updates')),
697 $newUpdates = $updater->update();
698 if (! empty($newUpdates)) {
700 $conf->get('resource.updates'),
701 $updater->getDoneUpdates()
705 catch(Exception
$e) {
706 die($e->getMessage());
709 $PAGE = new PageBuilder($conf, $LINKSDB, $sessionManager->generateToken());
710 $PAGE->assign('linkcount', count($LINKSDB));
711 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
712 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
714 // Determine which page will be rendered.
715 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
716 $targetPage = Router
::findPage($query, $_GET, isLoggedIn());
719 // if the user isn't logged in
721 // and Shaarli doesn't have public content...
722 $conf->get('privacy.hide_public_links') &&
723 // and is configured to enforce the login
724 $conf->get('privacy.force_login') &&
725 // and the current page isn't already the login page
726 $targetPage !== Router
::$PAGE_LOGIN &&
727 // and the user is not requesting a feed (which would lead to a different content-type as expected)
728 $targetPage !== Router
::$PAGE_FEED_ATOM &&
729 $targetPage !== Router
::$PAGE_FEED_RSS
731 // force current page to be the login page
732 $targetPage = Router
::$PAGE_LOGIN;
735 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
736 // Then assign generated data to RainTPL.
737 $common_hooks = array(
743 foreach($common_hooks as $name) {
744 $plugin_data = array();
745 $pluginManager->executeHooks('render_' . $name, $plugin_data,
747 'target' => $targetPage,
748 'loggedin' => isLoggedIn()
751 $PAGE->assign('plugins_' . $name, $plugin_data);
754 // -------- Display login form.
755 if ($targetPage == Router
::$PAGE_LOGIN)
757 if ($conf->get('security.open_shaarli')) { header('Location: ?'); exit; } // No need to login for open Shaarli
758 if (isset($_GET['username'])) {
759 $PAGE->assign('username', escape($_GET['username']));
761 $PAGE->assign('returnurl',(isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
762 // add default state of the 'remember me' checkbox
763 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
764 $PAGE->renderPage('loginform');
767 // -------- User wants to logout.
768 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout'))
770 invalidateCaches($conf->get('resource.page_cache'));
772 header('Location: ?');
776 // -------- Picture wall
777 if ($targetPage == Router
::$PAGE_PICWALL)
779 // Optionally filter the results:
780 $links = $LINKSDB->filterSearch($_GET);
781 $linksToDisplay = array();
783 // Get only links which have a thumbnail.
784 foreach($links as $link)
786 $permalink='?'.$link['shorturl'];
787 $thumb=lazyThumbnail($conf, $link['url'],$permalink);
788 if ($thumb!='') // Only output links which have a thumbnail.
790 $link['thumbnail']=$thumb; // Thumbnail HTML code.
791 $linksToDisplay[]=$link; // Add to array.
796 'linksToDisplay' => $linksToDisplay,
798 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => isLoggedIn()));
800 foreach ($data as $key => $value) {
801 $PAGE->assign($key, $value);
804 $PAGE->renderPage('picwall');
808 // -------- Tag cloud
809 if ($targetPage == Router
::$PAGE_TAGCLOUD)
811 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
812 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
813 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
815 // We sort tags alphabetically, then choose a font size according to count.
816 // First, find max value.
818 foreach ($tags as $value) {
819 $maxcount = max($maxcount, $value);
822 alphabetical_sort($tags, false, true);
825 foreach($tags as $key => $value) {
826 if (in_array($key, $filteringTags)) {
829 // Tag font size scaling:
830 // default 15 and 30 logarithm bases affect scaling,
831 // 22 and 6 are arbitrary font sizes for max and min sizes.
832 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
833 $tagList[$key] = array(
835 'size' => number_format($size, 2, '.', ''),
840 'search_tags' => implode(' ', escape($filteringTags)),
843 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => isLoggedIn()));
845 foreach ($data as $key => $value) {
846 $PAGE->assign($key, $value);
849 $PAGE->renderPage('tag.cloud');
854 if ($targetPage == Router
::$PAGE_TAGLIST)
856 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
857 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
858 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
859 foreach ($filteringTags as $tag) {
860 if (array_key_exists($tag, $tags)) {
865 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
866 alphabetical_sort($tags, false, true);
870 'search_tags' => implode(' ', escape($filteringTags)),
873 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => isLoggedIn()]);
875 foreach ($data as $key => $value) {
876 $PAGE->assign($key, $value);
879 $PAGE->renderPage('tag.list');
884 if ($targetPage == Router
::$PAGE_DAILY) {
885 showDaily($PAGE, $LINKSDB, $conf, $pluginManager);
888 // ATOM and RSS feed.
889 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
890 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
891 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
894 $query = $_SERVER['QUERY_STRING'];
895 $cache = new CachedPage(
896 $conf->get('resource.page_cache'),
898 startsWith($query,'do='. $targetPage) && !isLoggedIn()
900 $cached = $cache->cachedVersion();
901 if (!empty($cached)) {
907 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, isLoggedIn());
908 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
909 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !isLoggedIn());
910 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
911 $data = $feedGenerator->buildData();
913 // Process plugin hook.
914 $pluginManager->executeHooks('render_feed', $data, array(
915 'loggedin' => isLoggedIn(),
916 'target' => $targetPage,
919 // Render the template.
920 $PAGE->assignAll($data);
921 $PAGE->renderPage('feed.'. $feedType);
922 $cache->cache(ob_get_contents());
927 // Display opensearch plugin (XML)
928 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
929 header('Content-Type: application/xml; charset=utf-8');
930 $PAGE->assign('serverurl', index_url($_SERVER));
931 $PAGE->renderPage('opensearch');
935 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
936 if (isset($_GET['addtag']))
938 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
939 if (empty($_SERVER['HTTP_REFERER'])) { header('Location: ?searchtags='.urlencode($_GET
['addtag'])); exit; } // In case browser does not send HTTP_REFERER
940 parse_str(parse_url($_SERVER['HTTP_REFERER'],PHP_URL_QUERY
), $params);
942 // Prevent redirection loop
943 if (isset($params['addtag'])) {
944 unset($params['addtag']);
947 // Check if this tag is already in the search query and ignore it if it is.
948 // Each tag is always separated by a space
949 if (isset($params['searchtags'])) {
950 $current_tags = explode(' ', $params['searchtags']);
952 $current_tags = array();
955 foreach ($current_tags as $value) {
956 if ($value === $_GET['addtag']) {
961 // Append the tag if necessary
962 if (empty($params['searchtags'])) {
963 $params['searchtags'] = trim($_GET['addtag']);
966 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
969 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
970 header('Location: ?'.http_build_query($params));
974 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
975 if (isset($_GET['removetag'])) {
976 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
977 if (empty($_SERVER['HTTP_REFERER'])) {
978 header('Location: ?');
982 // In case browser does not send HTTP_REFERER
983 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
985 // Prevent redirection loop
986 if (isset($params['removetag'])) {
987 unset($params['removetag']);
990 if (isset($params['searchtags'])) {
991 $tags = explode(' ', $params['searchtags']);
992 // Remove value from array $tags.
993 $tags = array_diff($tags, array($_GET['removetag']));
994 $params['searchtags'] = implode(' ',$tags);
996 if (empty($params['searchtags'])) {
997 unset($params['searchtags']);
1000 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
1002 header('Location: ?'.http_build_query($params));
1006 // -------- User wants to change the number of links per page (linksperpage=...)
1007 if (isset($_GET['linksperpage'])) {
1008 if (is_numeric($_GET['linksperpage'])) {
1009 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
1012 if (! empty($_SERVER['HTTP_REFERER'])) {
1013 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
1017 header('Location: '. $location);
1021 // -------- User wants to see only private links (toggle)
1022 if (isset($_GET['visibility'])) {
1023 if ($_GET['visibility'] === 'private') {
1024 // Visibility not set or not already private, set private, otherwise reset it
1025 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
1026 // See only private links
1027 $_SESSION['visibility'] = 'private';
1029 unset($_SESSION['visibility']);
1031 } else if ($_GET['visibility'] === 'public') {
1032 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
1033 // See only public links
1034 $_SESSION['visibility'] = 'public';
1036 unset($_SESSION['visibility']);
1040 if (! empty($_SERVER['HTTP_REFERER'])) {
1041 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
1045 header('Location: '. $location);
1049 // -------- User wants to see only untagged links (toggle)
1050 if (isset($_GET['untaggedonly'])) {
1051 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
1053 if (! empty($_SERVER['HTTP_REFERER'])) {
1054 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
1058 header('Location: '. $location);
1062 // -------- Handle other actions allowed for non-logged in users:
1065 // User tries to post new link but is not logged in:
1066 // Show login screen, then redirect to ?post=...
1067 if (isset($_GET['post']))
1069 header( // Redirect to login page, then back to post link.
1070 'Location: ?do=login&post='.urlencode($_GET['post']).
1071 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
1072 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
1073 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
1074 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
1079 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1080 if (isset($_GET['edit_link'])) {
1081 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
1085 exit; // Never remove this one! All operations below are reserved for logged in user.
1088 // -------- All other functions are reserved for the registered user:
1090 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
1091 if ($targetPage == Router
::$PAGE_TOOLS)
1094 'pageabsaddr' => index_url($_SERVER),
1095 'sslenabled' => is_https($_SERVER),
1097 $pluginManager->executeHooks('render_tools', $data);
1099 foreach ($data as $key => $value) {
1100 $PAGE->assign($key, $value);
1103 $PAGE->renderPage('tools');
1107 // -------- User wants to change his/her password.
1108 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD)
1110 if ($conf->get('security.open_shaarli')) {
1111 die(t('You are not supposed to change a password on an Open Shaarli.'));
1114 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword']))
1116 if (!$sessionManager->checkToken($_POST['token'])) die(t('Wrong token.')); // Go away!
1118 // Make sure old password is correct.
1119 $oldhash = sha1($_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt'));
1120 if ($oldhash!= $conf->get('credentials.hash')) {
1121 echo '<script>alert("'. t('The old password is not correct.') .'");document.location=\'?do=changepasswd\';</script>';
1124 // Save new password
1125 // Salt renders rainbow-tables attacks useless.
1126 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
1127 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $conf->get('credentials.login') . $conf->get('credentials.salt')));
1129 $conf->write(isLoggedIn());
1131 catch(Exception
$e) {
1133 'ERROR while writing config file after changing password.' . PHP_EOL
.
1137 // TODO: do not handle exceptions/errors in JS.
1138 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
1141 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
1144 else // show the change password form.
1146 $PAGE->renderPage('changepassword');
1151 // -------- User wants to change configuration
1152 if ($targetPage == Router
::$PAGE_CONFIGURE)
1154 if (!empty($_POST['title']) )
1156 if (!$sessionManager->checkToken($_POST['token'])) {
1157 die(t('Wrong token.')); // Go away!
1160 if (!empty($_POST['continent']) && !empty($_POST['city'])
1161 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1163 $tz = $_POST['continent'] . '/' . $_POST['city'];
1165 $conf->set('general.timezone', $tz);
1166 $conf->set('general.title', escape($_POST['title']));
1167 $conf->set('general.header_link', escape($_POST['titleLink']));
1168 $conf->set('resource.theme', escape($_POST['theme']));
1169 $conf->set('redirector.url', escape($_POST['redirector']));
1170 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1171 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1172 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1173 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1174 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1175 $conf->set('api.enabled', !empty($_POST['enableApi']));
1176 $conf->set('api.secret', escape($_POST['apiSecret']));
1177 $conf->set('translation.language', escape($_POST['language']));
1180 $conf->write(isLoggedIn());
1181 $history->updateSettings();
1182 invalidateCaches($conf->get('resource.page_cache'));
1184 catch(Exception
$e) {
1186 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1190 // TODO: do not handle exceptions/errors in JS.
1191 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1194 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1197 else // Show the configuration form.
1199 $PAGE->assign('title', $conf->get('general.title'));
1200 $PAGE->assign('theme', $conf->get('resource.theme'));
1201 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1202 $PAGE->assign('redirector', $conf->get('redirector.url'));
1203 list($continents, $cities) = generateTimeZoneData(
1204 timezone_identifiers_list(),
1205 $conf->get('general.timezone')
1207 $PAGE->assign('continents', $continents);
1208 $PAGE->assign('cities', $cities);
1209 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1210 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1211 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1212 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1213 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1214 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1215 $PAGE->assign('api_secret', $conf->get('api.secret'));
1216 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1217 $PAGE->assign('language', $conf->get('translation.language'));
1218 $PAGE->renderPage('configure');
1223 // -------- User wants to rename a tag or delete it
1224 if ($targetPage == Router
::$PAGE_CHANGETAG)
1226 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1227 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1228 $PAGE->renderPage('changetag');
1232 if (!$sessionManager->checkToken($_POST['token'])) {
1233 die(t('Wrong token.'));
1236 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), escape($_POST['totag']));
1237 $LINKSDB->save($conf->get('resource.page_cache'));
1238 foreach ($alteredLinks as $link) {
1239 $history->updateLink($link);
1241 $delete = empty($_POST['totag']);
1242 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1243 $count = count($alteredLinks);
1245 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1246 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1247 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1251 // -------- User wants to add a link without using the bookmarklet: Show form.
1252 if ($targetPage == Router
::$PAGE_ADDLINK)
1254 $PAGE->renderPage('addlink');
1258 // -------- User clicked the "Save" button when editing a link: Save link to database.
1259 if (isset($_POST['save_edit']))
1262 if (! $sessionManager->checkToken($_POST['token'])) {
1263 die(t('Wrong token.'));
1266 // lf_id should only be present if the link exists.
1267 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1268 // Linkdate is kept here to:
1269 // - use the same permalink for notes as they're displayed when creating them
1270 // - let users hack creation date of their posts
1271 // See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare
1272 $linkdate = escape($_POST['lf_linkdate']);
1273 if (isset($LINKSDB[$id])) {
1275 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1276 $updated = new DateTime();
1277 $shortUrl = $LINKSDB[$id]['shorturl'];
1281 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1283 $shortUrl = link_small_hash($created, $id);
1287 // Remove multiple spaces.
1288 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1289 // Remove first '-' char in tags.
1290 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1291 // Remove duplicates.
1292 $tags = implode(' ', array_unique(explode(' ', $tags)));
1294 if (empty(trim($_POST['lf_url
']))) {
1295 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1297 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1301 'title
' => trim($_POST['lf_title
']),
1303 'description
' => $_POST['lf_description
'],
1304 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1305 'created
' => $created,
1306 'updated
' => $updated,
1307 'tags
' => str_replace(',', ' ', $tags),
1308 'shorturl
' => $shortUrl,
1311 // If title is empty, use the URL as title.
1312 if ($link['title
'] == '') {
1313 $link['title
'] = $link['url
'];
1316 $pluginManager->executeHooks('save_link
', $link);
1318 $LINKSDB[$id] = $link;
1319 $LINKSDB->save($conf->get('resource.page_cache
'));
1321 $history->addLink($link);
1323 $history->updateLink($link);
1326 // If we are called from the bookmarklet, we must close the popup:
1327 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1328 echo '<script
>self
.close();</script
>';
1332 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1333 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1334 // Scroll to the link which has been edited.
1335 $location .= '#' . $link['shorturl'];
1336 // After saving the link, redirect to the page the user was on.
1337 header('Location: '. $location);
1341 // -------- User clicked the "Cancel" button when editing a link.
1342 if (isset($_POST['cancel_edit']))
1344 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1345 if (! isset($LINKSDB[$id])) {
1346 header('Location: ?');
1348 // If we are called from the bookmarklet, we must close the popup:
1349 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1350 $link = $LINKSDB[$id];
1351 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1352 // Scroll to the link which has been edited.
1353 $returnurl .= '#'. $link['shorturl'];
1354 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1355 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1359 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1360 if ($targetPage == Router
::$PAGE_DELETELINK)
1362 if (! $sessionManager->checkToken($_GET['token'])) {
1363 die(t('Wrong token.'));
1366 $ids = trim($_GET['lf_linkdate']);
1367 if (strpos($ids, ' ') !== false) {
1368 // multiple, space-separated ids provided
1369 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1371 // only a single id provided
1374 // assert at least one id is given
1376 die('no id provided');
1378 foreach ($ids as $id) {
1379 $id = (int) escape($id);
1380 $link = $LINKSDB[$id];
1381 $pluginManager->executeHooks('delete_link', $link);
1382 unset($LINKSDB[$id]);
1384 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1385 $history->deleteLink($link);
1387 // If we are called from the bookmarklet, we must close the popup:
1388 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1391 if (isset($_SERVER['HTTP_REFERER'])) {
1392 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1393 $location = generateLocation(
1394 $_SERVER['HTTP_REFERER'],
1395 $_SERVER['HTTP_HOST'],
1396 ['delete_link', 'edit_link', $link['shorturl']]
1400 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1404 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1405 if (isset($_GET['edit_link']))
1407 $id = (int) escape($_GET['edit_link']);
1408 $link = $LINKSDB[$id]; // Read database
1409 if (!$link) { header('Location: ?'); exit; } // Link not found in database.
1410 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1413 'link_is_new' => false,
1414 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1415 'tags' => $LINKSDB->linksCountPerTag(),
1417 $pluginManager->executeHooks('render_editlink', $data);
1419 foreach ($data as $key => $value) {
1420 $PAGE->assign($key, $value);
1423 $PAGE->renderPage('editlink');
1427 // -------- User want to post a new link: Display link edit form.
1428 if (isset($_GET['post'])) {
1429 $url = cleanup_url($_GET['post']);
1431 $link_is_new = false;
1432 // Check if URL is not already in database (in this case, we will edit the existing link)
1433 $link = $LINKSDB->getLinkFromUrl($url);
1436 $link_is_new = true;
1437 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1438 // Get title if it was provided in URL (by the bookmarklet).
1439 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1440 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1441 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1442 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1443 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1444 // 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.)
1445 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1446 // Short timeout to keep the application responsive
1447 // The callback will fill $charset and $title with data from the downloaded page.
1448 get_http_response($url, 25, 4194304, get_curl_download_callback($charset, $title));
1449 if (! empty($title) && strtolower($charset) != 'utf-8') {
1450 $title = mb_convert_encoding($title, 'utf-8', $charset);
1455 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1456 $title = $conf->get('general.default_note_title', t('Note: '));
1458 $url = escape($url);
1459 $title = escape($title);
1462 'linkdate' => $linkdate,
1465 'description' => $description,
1467 'private' => $private,
1470 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1475 'link_is_new' => $link_is_new,
1476 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1477 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1478 'tags' => $LINKSDB->linksCountPerTag(),
1479 'default_private_links' => $conf->get('privacy.default_private_links', false),
1481 $pluginManager->executeHooks('render_editlink', $data);
1483 foreach ($data as $key => $value) {
1484 $PAGE->assign($key, $value);
1487 $PAGE->renderPage('editlink');
1491 if ($targetPage == Router
::$PAGE_EXPORT) {
1492 // Export links as a Netscape Bookmarks file
1494 if (empty($_GET['selection'])) {
1495 $PAGE->renderPage('export');
1499 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1500 $selection = $_GET['selection'];
1501 if (isset($_GET['prepend_note_url'])) {
1502 $prependNoteUrl = $_GET['prepend_note_url'];
1504 $prependNoteUrl = false;
1510 NetscapeBookmarkUtils
::filterAndFormat(
1517 } catch (Exception
$exc) {
1518 header('Content-Type: text/plain; charset=utf-8');
1519 echo $exc->getMessage();
1522 $now = new DateTime();
1523 header('Content-Type: text/html; charset=utf-8');
1525 'Content-disposition: attachment; filename=bookmarks_'
1526 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1528 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1529 $PAGE->assign('eol', PHP_EOL
);
1530 $PAGE->assign('selection', $selection);
1531 $PAGE->renderPage('export.bookmarks');
1535 if ($targetPage == Router
::$PAGE_IMPORT) {
1536 // Upload a Netscape bookmark dump to import its contents
1538 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1539 // Show import dialog
1542 get_max_upload_size(
1543 ini_get('post_max_size'),
1544 ini_get('upload_max_filesize'),
1550 get_max_upload_size(
1551 ini_get('post_max_size'),
1552 ini_get('upload_max_filesize'),
1556 $PAGE->renderPage('import');
1560 // Import bookmarks from an uploaded file
1561 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1562 // The file is too big or some form field may be missing.
1565 'The file you are trying to upload is probably bigger than what this webserver can accept'
1566 .' (%s). Please upload in smaller chunks.'
1568 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1570 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1573 if (! $sessionManager->checkToken($_POST['token'])) {
1574 die('Wrong token.');
1576 $status = NetscapeBookmarkUtils
::import(
1583 echo '<script>alert("'.$status.'");document.location=\'?do='
1584 .Router
::$PAGE_IMPORT .'\';</script>';
1588 // Plugin administration page
1589 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1590 $pluginMeta = $pluginManager->getPluginsMeta();
1592 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1593 $enabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] !== false; });
1595 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1598 function($a, $b) { return $a
['order'] - $b
['order']; }
1600 $disabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] === false; });
1602 $PAGE->assign('enabledPlugins', $enabledPlugins);
1603 $PAGE->assign('disabledPlugins', $disabledPlugins);
1604 $PAGE->renderPage('pluginsadmin');
1608 // Plugin administration form action
1609 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1611 if (isset($_POST['parameters_form'])) {
1612 unset($_POST['parameters_form']);
1613 foreach ($_POST as $param => $value) {
1614 $conf->set('plugins.'. $param, escape($value));
1618 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1620 $conf->write(isLoggedIn());
1621 $history->updateSettings();
1623 catch (Exception
$e) {
1625 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1629 // TODO: do not handle exceptions/errors in JS.
1630 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do='. Router
::$PAGE_PLUGINSADMIN .'\';</script>';
1633 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1637 // Get a fresh token
1638 if ($targetPage == Router
::$GET_TOKEN) {
1639 header('Content-Type:text/plain');
1640 echo $sessionManager->generateToken($conf);
1644 // -------- Otherwise, simply display search form and links:
1645 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1650 * Template for the list of links (<div id="linklist">)
1651 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1653 * @param pageBuilder $PAGE pageBuilder instance.
1654 * @param LinkDB $LINKSDB LinkDB instance.
1655 * @param ConfigManager $conf Configuration Manager instance.
1656 * @param PluginManager $pluginManager Plugin Manager instance.
1658 function buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager)
1660 // Used in templates
1661 if (isset($_GET['searchtags'])) {
1662 if (! empty($_GET['searchtags'])) {
1663 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1665 $searchtags = false;
1670 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1673 if (! empty($_SERVER['QUERY_STRING'])
1674 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1676 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1677 } catch (LinkNotFoundException
$e) {
1678 $PAGE->render404($e->getMessage());
1682 // Filter links according search parameters.
1683 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1685 'searchtags' => $searchtags,
1686 'searchterm' => $searchterm,
1688 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1691 // ---- Handle paging.
1693 foreach ($linksToDisplay as $key => $value) {
1699 // Select articles according to paging.
1700 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1701 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1702 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1703 $page = $page < 1 ? 1 : $page;
1704 $page = $page > $pagecount ? $pagecount : $page;
1706 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1707 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1708 $linkDisp = array();
1709 while ($i<$end && $i<count($keys))
1711 $link = $linksToDisplay[$keys[$i]];
1712 $link['description'] = format_description(
1713 $link['description'],
1714 $conf->get('redirector.url'),
1715 $conf->get('redirector.encode_url')
1717 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1718 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1719 $link['timestamp'] = $link['created']->getTimestamp();
1720 if (! empty($link['updated'])) {
1721 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1723 $link['updated_timestamp'] = '';
1725 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1726 uasort($taglist, 'strcasecmp');
1727 $link['taglist'] = $taglist;
1728 // Check for both signs of a note: starting with ? and 7 chars long.
1729 if ($link['url'][0] === '?' &&
1730 strlen($link['url']) === 7) {
1731 $link['url'] = index_url($_SERVER) . $link['url'];
1734 $linkDisp[$keys[$i]] = $link;
1738 // Compute paging navigation
1739 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1740 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1741 $previous_page_url = '';
1742 if ($i != count($keys)) {
1743 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1747 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1750 // Fill all template fields.
1752 'previous_page_url' => $previous_page_url,
1753 'next_page_url' => $next_page_url,
1754 'page_current' => $page,
1755 'page_max' => $pagecount,
1756 'result_count' => count($linksToDisplay),
1757 'search_term' => $searchterm,
1758 'search_tags' => $searchtags,
1759 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1760 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1761 'links' => $linkDisp,
1764 // If there is only a single link, we change on-the-fly the title of the page.
1765 if (count($linksToDisplay) == 1) {
1766 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1769 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => isLoggedIn()));
1771 foreach ($data as $key => $value) {
1772 $PAGE->assign($key, $value);
1779 * Compute the thumbnail for a link.
1781 * With a link to the original URL.
1782 * Understands various services (youtube.com...)
1783 * Input: $url = URL for which the thumbnail must be found.
1784 * $href = if provided, this URL will be followed instead of $url
1785 * Returns an associative array with thumbnail attributes (src,href,width,height,style,alt)
1786 * Some of them may be missing.
1787 * Return an empty array if no thumbnail available.
1789 * @param ConfigManager $conf Configuration Manager instance.
1790 * @param string $url
1791 * @param string|bool $href
1795 function computeThumbnail($conf, $url, $href = false)
1797 if (!$conf->get('thumbnail.enable_thumbnails')) return array();
1798 if ($href==false) $href=$url;
1800 // For most hosts, the URL of the thumbnail can be easily deduced from the URL of the link.
1801 // (e.g. http://www.youtube.com/watch?v=spVypYk4kto ---> http://img.youtube.com/vi/spVypYk4kto/default.jpg )
1802 // ^^^^^^^^^^^ ^^^^^^^^^^^
1803 $domain = parse_url($url,PHP_URL_HOST
);
1804 if ($domain=='youtube.com' || $domain=='www.youtube.com')
1806 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract video ID and get thumbnail
1807 if (!empty($params['v'])) return array('src'=>'https://img.youtube.com/vi/'.$params['v'].'/default.jpg',
1808 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1810 if ($domain=='youtu.be') // Youtube short links
1812 $path = parse_url($url,PHP_URL_PATH
);
1813 return array('src'=>'https://img.youtube.com/vi'.$path.'/default.jpg',
1814 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1816 if ($domain=='pix.toile-libre.org') // pix.toile-libre.org image hosting
1818 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract image filename.
1819 if (!empty($params) && !empty($params['img'])) return array('src'=>'http://pix.toile-libre.org/upload/thumb/'.urlencode($params['img']),
1820 'href'=>$href,'style'=>'max-width:120px; max-height:150px','alt'=>'pix.toile-libre.org thumbnail');
1823 if ($domain=='imgur.com')
1825 $path = parse_url($url,PHP_URL_PATH
);
1826 if (startsWith($path,'/a/')) return array(); // Thumbnails for albums are not available.
1827 if (startsWith($path,'/r/')) return array('src'=>'https://i.imgur.com/'.basename($path).'s.jpg',
1828 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1829 if (startsWith($path,'/gallery/')) return array('src'=>'https://i.imgur.com'.substr($path,8).'s.jpg',
1830 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1832 if (substr_count($path,'/')==1) return array('src'=>'https://i.imgur.com/'.substr($path,1).'s.jpg',
1833 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1835 if ($domain=='i.imgur.com')
1837 $pi = pathinfo(parse_url($url,PHP_URL_PATH
));
1838 if (!empty($pi['filename'])) return array('src'=>'https://i.imgur.com/'.$pi['filename'].'s.jpg',
1839 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1841 if ($domain=='dailymotion.com' || $domain=='www.dailymotion.com')
1843 if (strpos($url,'dailymotion.com/video/')!==false)
1845 $thumburl=str_replace('dailymotion.com/video/','dailymotion.com/thumbnail/video/',$url);
1846 return array('src'=>$thumburl,
1847 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'DailyMotion thumbnail');
1850 if (endsWith($domain,'.imageshack.us'))
1852 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1853 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1855 $thumburl = substr($url,0,strlen($url)-strlen($ext)).'th.'.$ext;
1856 return array('src'=>$thumburl,
1857 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'imageshack.us thumbnail');
1861 // Some other hosts are SLOW AS HELL and usually require an extra HTTP request to get the thumbnail URL.
1862 // So we deport the thumbnail generation in order not to slow down page generation
1863 // (and we also cache the thumbnail)
1865 if (! $conf->get('thumbnail.enable_localcache')) return array(); // If local cache is disabled, no thumbnails for services which require the use a local cache.
1867 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com')
1868 || $domain=='vimeo.com'
1869 || $domain=='ted.com' || endsWith($domain,'.ted.com')
1870 || $domain=='xkcd.com' || endsWith($domain,'.xkcd.com')
1873 if ($domain=='vimeo.com')
1874 { // Make sure this vimeo URL points to a video (/xxx... where xxx is numeric)
1875 $path = parse_url($url,PHP_URL_PATH
);
1876 if (!preg_match('!/\d+.+?!',$path)) return array(); // This is not a single video URL.
1878 if ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
1879 { // Make sure this URL points to a single comic (/xxx... where xxx is numeric)
1880 $path = parse_url($url,PHP_URL_PATH
);
1881 if (!preg_match('!/\d+.+?!',$path)) return array();
1883 if ($domain=='ted.com' || endsWith($domain,'.ted.com'))
1884 { // Make sure this TED URL points to a video (/talks/...)
1885 $path = parse_url($url,PHP_URL_PATH
);
1886 if ("/talks/" !== substr($path,0,7)) return array(); // This is not a single video URL.
1888 $sign = hash_hmac('sha256', $url, $conf->get('credentials.salt')); // We use the salt to sign data (it's random, secret, and specific to each installation)
1889 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1890 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1893 // For all other, we try to make a thumbnail of links ending with .jpg/jpeg/png/gif
1894 // Technically speaking, we should download ALL links and check their Content-Type to see if they are images.
1895 // But using the extension will do.
1896 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1897 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1899 $sign = hash_hmac('sha256', $url, $conf->get('credentials.salt')); // We use the salt to sign data (it's random, secret, and specific to each installation)
1900 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1901 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1903 return array(); // No thumbnail.
1908 // Returns the HTML code to display a thumbnail for a link
1909 // with a link to the original URL.
1910 // Understands various services (youtube.com...)
1911 // Input: $url = URL for which the thumbnail must be found.
1912 // $href = if provided, this URL will be followed instead of $url
1913 // Returns '' if no thumbnail available.
1914 function thumbnail($url,$href=false)
1918 $t = computeThumbnail($conf, $url,$href);
1919 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1921 $html='<a href="'.escape($t['href']).'"><img src="'.escape($t['src']).'"';
1922 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1923 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1924 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1925 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1930 // Returns the HTML code to display a thumbnail for a link
1931 // for the picture wall (using lazy image loading)
1932 // Understands various services (youtube.com...)
1933 // Input: $url = URL for which the thumbnail must be found.
1934 // $href = if provided, this URL will be followed instead of $url
1935 // Returns '' if no thumbnail available.
1936 function lazyThumbnail($conf, $url,$href=false)
1940 $t = computeThumbnail($conf, $url,$href);
1941 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1943 $html='<a href="'.escape($t['href']).'">';
1946 $html.='<img class="b-lazy" src="#" data-src="'.escape($t['src']).'"';
1948 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1949 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1950 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1951 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1954 // No-JavaScript fallback.
1955 $html.='<noscript><img src="'.escape($t['src']).'"';
1956 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1957 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1958 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1959 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1960 $html.='></noscript></a>';
1968 * This function should NEVER be called if the file data/config.php exists.
1970 * @param ConfigManager $conf Configuration Manager instance.
1971 * @param SessionManager $sessionManager SessionManager instance
1973 function install($conf, $sessionManager) {
1974 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1975 if (endsWith($_SERVER['HTTP_HOST'],'.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions',0705);
1978 // This part makes sure sessions works correctly.
1979 // (Because on some hosts, session.save_path may not be set correctly,
1980 // or we may not have write access to it.)
1981 if (isset($_GET['test_session']) && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working'))
1983 // Step 2: Check if data in session is correct.
1985 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1986 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1987 'and that you have write access to it.<br>'.
1988 'It currently points to %s.<br>'.
1989 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1990 'or any custom hostname without a dot causes cookie storage to fail. '.
1991 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1993 $msg = sprintf($msg, session_save_path());
1995 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1998 if (!isset($_SESSION['session_tested']))
1999 { // Step 1 : Try to store data in session and reload page.
2000 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
2001 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
2003 if (isset($_GET['test_session']))
2004 { // Step 3: Sessions are OK. Remove test parameter from URL.
2005 header('Location: '.index_url($_SERVER));
2009 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
2012 if (!empty($_POST['continent']) && !empty($_POST['city'])
2013 && isTimeZoneValid($_POST['continent'], $_POST['city'])
2015 $tz = $_POST['continent'].'/'.$_POST['city'];
2017 $conf->set('general.timezone', $tz);
2018 $login = $_POST['setlogin'];
2019 $conf->set('credentials.login', $login);
2020 $salt = sha1(uniqid('', true) .'_'. mt_rand());
2021 $conf->set('credentials.salt', $salt);
2022 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
2023 if (!empty($_POST['title'])) {
2024 $conf->set('general.title', escape($_POST['title']));
2026 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
2028 $conf->set('translation.language', escape($_POST['language']));
2029 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
2030 $conf->set('api.enabled', !empty($_POST['enableApi']));
2033 generate_api_secret(
2034 $conf->get('credentials.login'),
2035 $conf->get('credentials.salt')
2039 // Everything is ok, let's create config file.
2040 $conf->write(isLoggedIn());
2042 catch(Exception
$e) {
2044 'ERROR while writing config file after installation.' . PHP_EOL
.
2048 // TODO: do not handle exceptions/errors in JS.
2049 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
2052 echo '<script>alert("Shaarli is now configured. Please enter your login/password and start shaaring your links!");document.location=\'?do=login\';</script>';
2056 $PAGE = new PageBuilder($conf, null, $sessionManager->generateToken());
2057 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
2058 $PAGE->assign('continents', $continents);
2059 $PAGE->assign('cities', $cities);
2060 $PAGE->assign('languages', Languages
::getAvailableLanguages());
2061 $PAGE->renderPage('install');
2066 * Because some f*cking services like flickr require an extra HTTP request to get the thumbnail URL,
2067 * I have deported the thumbnail URL code generation here, otherwise this would slow down page generation.
2068 * The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail.
2069 * This function is called by passing the URL:
2070 * http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL]
2071 * [URL] is the URL of the link (e.g. a flickr page)
2072 * [HMAC] is the signature for the [URL] (so that these URL cannot be forged).
2073 * The function below will fetch the image from the webservice and store it in the cache.
2075 * @param ConfigManager $conf Configuration Manager instance,
2077 function genThumbnail($conf)
2079 // Make sure the parameters in the URL were generated by us.
2080 $sign = hash_hmac('sha256', $_GET['url'], $conf->get('credentials.salt'));
2081 if ($sign!=$_GET['hmac']) die('Naughty boy!');
2083 $cacheDir = $conf->get('resource.thumbnails_cache', 'cache');
2084 // Let's see if we don't already have the image for this URL in the cache.
2085 $thumbname=hash('sha1',$_GET['url']).'.jpg';
2086 if (is_file($cacheDir .'/'. $thumbname))
2087 { // We have the thumbnail, just serve it:
2088 header('Content-Type: image/jpeg');
2089 echo file_get_contents($cacheDir .'/'. $thumbname);
2092 // We may also serve a blank image (if service did not respond)
2093 $blankname=hash('sha1',$_GET['url']).'.gif';
2094 if (is_file($cacheDir .'/'. $blankname))
2096 header('Content-Type: image/gif');
2097 echo file_get_contents($cacheDir .'/'. $blankname);
2101 // Otherwise, generate the thumbnail.
2102 $url = $_GET['url'];
2103 $domain = parse_url($url,PHP_URL_HOST
);
2105 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com'))
2107 // Crude replacement to handle new flickr domain policy (They prefer www. now)
2108 $url = str_replace('http://flickr.com/','http://www.flickr.com/',$url);
2110 // Is this a link to an image, or to a flickr page ?
2112 if (endsWith(parse_url($url, PHP_URL_PATH
), '.jpg'))
2113 { // This is a direct link to an image. e.g. http://farm1.staticflickr.com/5/5921913_ac83ed27bd_o.jpg
2114 preg_match('!(http://farm\d+\.staticflickr\.com/\d+/\d+_\w+_)\w.jpg!',$url,$matches);
2115 if (!empty($matches[1])) $imageurl=$matches[1].'m.jpg';
2117 else // This is a flickr page (html)
2119 // Get the flickr html page.
2120 list($headers, $content) = get_http_response($url, 20);
2121 if (strpos($headers[0], '200 OK') !== false)
2123 // flickr now nicely provides the URL of the thumbnail in each flickr page.
2124 preg_match('!<link rel=\"image_src\" href=\"(.+?)\"!', $content, $matches);
2125 if (!empty($matches[1])) $imageurl=$matches[1];
2127 // In albums (and some other pages), the link rel="image_src" is not provided,
2128 // but flickr provides:
2129 // <meta property="og:image" content="http://farm4.staticflickr.com/3398/3239339068_25d13535ff_z.jpg" />
2132 preg_match('!<meta property=\"og:image\" content=\"(.+?)\"!', $content, $matches);
2133 if (!empty($matches[1])) $imageurl=$matches[1];
2139 { // Let's download the image.
2140 // Image is 240x120, so 10 seconds to download should be enough.
2141 list($headers, $content) = get_http_response($imageurl, 10);
2142 if (strpos($headers[0], '200 OK') !== false) {
2143 // Save image to cache.
2144 file_put_contents($cacheDir .'/'. $thumbname, $content);
2145 header('Content-Type: image/jpeg');
2152 elseif ($domain=='vimeo.com' )
2154 // This is more complex: we have to perform a HTTP request, then parse the result.
2155 // Maybe we should deport this to JavaScript ? Example: http://stackoverflow.com/questions/1361149/get-img-thumbnails-from-vimeo/4285098#4285098
2156 $vid = substr(parse_url($url,PHP_URL_PATH
),1);
2157 list($headers, $content) = get_http_response('https://vimeo.com/api/v2/video/'.escape($vid).'.php', 5);
2158 if (strpos($headers[0], '200 OK') !== false) {
2159 $t = unserialize($content);
2160 $imageurl = $t[0]['thumbnail_medium'];
2161 // Then we download the image and serve it to our client.
2162 list($headers, $content) = get_http_response($imageurl, 10);
2163 if (strpos($headers[0], '200 OK') !== false) {
2164 // Save image to cache.
2165 file_put_contents($cacheDir .'/'. $thumbname, $content);
2166 header('Content-Type: image/jpeg');
2173 elseif ($domain=='ted.com' || endsWith($domain,'.ted.com'))
2175 // The thumbnail for TED talks is located in the <link rel="image_src" [...]> tag on that page
2176 // http://www.ted.com/talks/mikko_hypponen_fighting_viruses_defending_the_net.html
2177 // <link rel="image_src" href="http://images.ted.com/images/ted/28bced335898ba54d4441809c5b1112ffaf36781_389x292.jpg" />
2178 list($headers, $content) = get_http_response($url, 5);
2179 if (strpos($headers[0], '200 OK') !== false) {
2180 // Extract the link to the thumbnail
2181 preg_match('!link rel="image_src" href="(http://images.ted.com/images/ted/.+_\d+x\d+\.jpg)"!', $content, $matches);
2182 if (!empty($matches[1]))
2183 { // Let's download the image.
2184 $imageurl=$matches[1];
2185 // No control on image size, so wait long enough
2186 list($headers, $content) = get_http_response($imageurl, 20);
2187 if (strpos($headers[0], '200 OK') !== false) {
2188 $filepath = $cacheDir .'/'. $thumbname;
2189 file_put_contents($filepath, $content); // Save image to cache.
2190 if (resizeImage($filepath))
2192 header('Content-Type: image/jpeg');
2193 echo file_get_contents($filepath);
2201 elseif ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
2203 // There is no thumbnail available for xkcd comics, so download the whole image and resize it.
2204 // http://xkcd.com/327/
2205 // <img src="http://imgs.xkcd.com/comics/exploits_of_a_mom.png" title="<BLABLA>" alt="<BLABLA>" />
2206 list($headers, $content) = get_http_response($url, 5);
2207 if (strpos($headers[0], '200 OK') !== false) {
2208 // Extract the link to the thumbnail
2209 preg_match('!<img src="(http://imgs.xkcd.com/comics/.*)" title="[^s]!', $content, $matches);
2210 if (!empty($matches[1]))
2211 { // Let's download the image.
2212 $imageurl=$matches[1];
2213 // No control on image size, so wait long enough
2214 list($headers, $content) = get_http_response($imageurl, 20);
2215 if (strpos($headers[0], '200 OK') !== false) {
2216 $filepath = $cacheDir.'/'.$thumbname;
2217 // Save image to cache.
2218 file_put_contents($filepath, $content);
2219 if (resizeImage($filepath))
2221 header('Content-Type: image/jpeg');
2222 echo file_get_contents($filepath);
2232 // For all other domains, we try to download the image and make a thumbnail.
2233 // We allow 30 seconds max to download (and downloads are limited to 4 Mb)
2234 list($headers, $content) = get_http_response($url, 30);
2235 if (strpos($headers[0], '200 OK') !== false) {
2236 $filepath = $cacheDir .'/'.$thumbname;
2237 // Save image to cache.
2238 file_put_contents($filepath, $content);
2239 if (resizeImage($filepath))
2241 header('Content-Type: image/jpeg');
2242 echo file_get_contents($filepath);
2249 // Otherwise, return an empty image (8x8 transparent gif)
2250 $blankgif = base64_decode('R0lGODlhCAAIAIAAAP///////yH5BAEKAAEALAAAAAAIAAgAAAIHjI+py+1dAAA7');
2251 // Also put something in cache so that this URL is not requested twice.
2252 file_put_contents($cacheDir .'/'. $blankname, $blankgif);
2253 header('Content-Type: image/gif');
2257 // Make a thumbnail of the image (to width: 120 pixels)
2258 // Returns true if success, false otherwise.
2259 function resizeImage($filepath)
2261 if (!function_exists('imagecreatefromjpeg')) return false; // GD not present: no thumbnail possible.
2263 // Trick: some stupid people rename GIF as JPEG... or else.
2264 // So we really try to open each image type whatever the extension is.
2265 $header=file_get_contents($filepath,false,NULL,0,256); // Read first 256 bytes and try to sniff file type.
2267 $i=strpos($header,'GIF8'); if (($i!==false) && ($i==0)) $im = imagecreatefromgif($filepath); // Well this is crude, but it should be enough.
2268 $i=strpos($header,'PNG'); if (($i!==false) && ($i==1)) $im = imagecreatefrompng($filepath);
2269 $i=strpos($header,'JFIF'); if ($i!==false) $im = imagecreatefromjpeg($filepath);
2270 if (!$im) return false; // Unable to open image (corrupted or not an image)
2273 $ystart = 0; $yheight=$h;
2274 if ($h>$w) { $ystart
= ($h
/2)-($w
/2); $yheight
=$w
/2; }
2275 $nw = 120; // Desired width
2276 $nh = min(floor(($h*$nw)/$w),120); // Compute new width/height, but maximum 120 pixels height.
2278 $im2 = imagecreatetruecolor($nw,$nh);
2279 imagecopyresampled($im2, $im, 0, 0, 0, $ystart, $nw, $nh, $w, $yheight);
2280 imageinterlace($im2,true); // For progressive JPEG.
2281 $tempname=$filepath.'_TEMP.jpg';
2282 imagejpeg($im2, $tempname, 90);
2286 rename($tempname,$filepath); // Overwrite original picture with thumbnail.
2290 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=genthumbnail')) { genThumbnail($conf
); exit; } // Thumbnail generation/cache does not need the link database.
2291 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf
); exit; }
2292 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
2293 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
2297 $history = new History($conf->get('resource.history'));
2298 } catch(Exception
$e) {
2299 die($e->getMessage());
2302 $linkDb = new LinkDB(
2303 $conf->get('resource.datastore'),
2305 $conf->get('privacy.hide_public_links'),
2306 $conf->get('redirector.url'),
2307 $conf->get('redirector.encode_url')
2310 $container = new \Slim\
Container();
2311 $container['conf'] = $conf;
2312 $container['plugins'] = $pluginManager;
2313 $container['history'] = $history;
2314 $app = new \Slim\
App($container);
2317 $app->group('/api/v1', function() {
2318 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
2319 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
2320 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
2321 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
2322 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
2323 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
2324 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
2325 })->add('\Shaarli\Api\ApiMiddleware');
2327 $response = $app->run(true);
2328 // Hack to make Slim and Shaarli router work together:
2329 // If a Slim route isn't found and NOT API call, we call renderPage().
2330 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
2331 // We use UTF-8 for proper international characters handling.
2332 header('Content-Type: text/html; charset=utf-8');
2333 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager);
2335 $app->respond($response);