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
;
82 // Ensure the PHP version is supported
84 ApplicationUtils
::checkPHPVersion('5.5', PHP_VERSION
);
85 } catch(Exception
$exc) {
86 header('Content-Type: text/plain; charset=utf-8');
87 echo $exc->getMessage();
91 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
93 // Force cookie path (but do not change lifetime)
94 $cookie = session_get_cookie_params();
96 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
97 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
99 // Set default cookie expiration and path.
100 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
101 // Set session parameters on server side.
102 // If the user does not access any page within this time, his/her session is considered expired.
103 define('INACTIVITY_TIMEOUT', 3600); // in seconds.
104 // Use cookies to store session.
105 ini_set('session.use_cookies', 1);
106 // Force cookies for session (phpsessionID forbidden in URL).
107 ini_set('session.use_only_cookies', 1);
108 // Prevent PHP form using sessionID in URL if cookies are disabled.
109 ini_set('session.use_trans_sid', false);
111 session_name('shaarli');
112 // Start session if needed (Some server auto-start sessions).
113 if (session_id() == '') {
117 // Regenerate session ID if invalid or not defined in cookie.
118 if (isset($_COOKIE['shaarli']) && !is_session_id_valid($_COOKIE['shaarli'])) {
119 session_regenerate_id(true);
120 $_COOKIE['shaarli'] = session_id();
123 $conf = new ConfigManager();
125 // Sniff browser language and set date format accordingly.
126 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
127 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
130 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
132 $conf->setEmpty('general.timezone', date_default_timezone_get());
133 $conf->setEmpty('general.title', t('Shared links on '). escape(index_url($_SERVER)));
134 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
135 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
137 $pluginManager = new PluginManager($conf);
138 $pluginManager->load($conf->get('general.enabled_plugins'));
140 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
142 ob_start(); // Output buffering for the page cache.
144 // Prevent caching on client side or proxy: (yes, it's ugly)
145 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
146 header("Cache-Control: no-store, no-cache, must-revalidate");
147 header("Cache-Control: post-check=0, pre-check=0", false);
148 header("Pragma: no-cache");
150 if (! is_file($conf->getConfigFileExt())) {
151 // Ensure Shaarli has proper access to its resources
152 $errors = ApplicationUtils
::checkResourcePermissions($conf);
154 if ($errors != array()) {
155 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
157 foreach ($errors as $error) {
158 $message .= '<li>'.$error.'</li>';
162 header('Content-Type: text/html; charset=utf-8');
167 // Display the installation form if no existing config is found
171 // a token depending of deployment salt, user password, and the current ip
172 define('STAY_SIGNED_IN_TOKEN', sha1($conf->get('credentials.hash') . $_SERVER['REMOTE_ADDR'] . $conf->get('credentials.salt')));
175 * Checking session state (i.e. is the user still logged in)
177 * @param ConfigManager $conf The configuration manager.
179 * @return bool: true if the user is logged in, false otherwise.
181 function setup_login_state($conf)
183 if ($conf->get('security.open_shaarli')) {
186 $userIsLoggedIn = false; // By default, we do not consider the user as logged in;
187 $loginFailure = false; // If set to true, every attempt to authenticate the user will fail. This indicates that an important condition isn't met.
188 if (! $conf->exists('credentials.login')) {
189 $userIsLoggedIn = false; // Shaarli is not configured yet.
190 $loginFailure = true;
192 if (isset($_COOKIE['shaarli_staySignedIn']) &&
193 $_COOKIE['shaarli_staySignedIn']===STAY_SIGNED_IN_TOKEN
&&
196 fillSessionInfo($conf);
197 $userIsLoggedIn = true;
199 // If session does not exist on server side, or IP address has changed, or session has expired, logout.
200 if (empty($_SESSION['uid'])
201 || ($conf->get('security.session_protection_disabled') === false && $_SESSION['ip'] != allIPs())
202 || time() >= $_SESSION['expires_on'])
205 $userIsLoggedIn = false;
206 $loginFailure = true;
208 if (!empty($_SESSION['longlastingsession'])) {
209 $_SESSION['expires_on']=time()+
$_SESSION['longlastingsession']; // In case of "Stay signed in" checked.
212 $_SESSION['expires_on']=time()+INACTIVITY_TIMEOUT
; // Standard session expiration date.
214 if (!$loginFailure) {
215 $userIsLoggedIn = true;
218 return $userIsLoggedIn;
220 $userIsLoggedIn = setup_login_state($conf);
222 // ------------------------------------------------------------------------------------------
223 // Session management
225 // Returns the IP address of the client (Used to prevent session cookie hijacking.)
228 $ip = $_SERVER['REMOTE_ADDR'];
229 // Then we use more HTTP headers to prevent session hijacking from users behind the same proxy.
230 if (isset($_SERVER['HTTP_X_FORWARDED_FOR'])) { $ip
=$ip
.'_'.$_SERVER
['HTTP_X_FORWARDED_FOR']; }
231 if (isset($_SERVER['HTTP_CLIENT_IP'])) { $ip
=$ip
.'_'.$_SERVER
['HTTP_CLIENT_IP']; }
238 * @param ConfigManager $conf Configuration Manager instance.
240 function fillSessionInfo($conf)
242 $_SESSION['uid'] = sha1(uniqid('',true).'_'.mt_rand()); // Generate unique random number (different than phpsessionid)
243 $_SESSION['ip']=allIPs(); // We store IP address(es) of the client to make sure session is not hijacked.
244 $_SESSION['username']= $conf->get('credentials.login');
245 $_SESSION['expires_on']=time()+INACTIVITY_TIMEOUT
; // Set session expiration.
249 * Check that user/password is correct.
251 * @param string $login Username
252 * @param string $password User password
253 * @param ConfigManager $conf Configuration Manager instance.
255 * @return bool: authentication successful or not.
257 function check_auth($login, $password, $conf)
259 $hash = sha1($password . $login . $conf->get('credentials.salt'));
260 if ($login == $conf->get('credentials.login') && $hash == $conf->get('credentials.hash'))
261 { // Login/password is correct.
262 fillSessionInfo($conf);
263 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Login successful');
266 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Login failed for user '.$login);
270 // Returns true if the user is logged in.
271 function isLoggedIn()
273 global $userIsLoggedIn;
274 return $userIsLoggedIn;
279 if (isset($_SESSION)) {
280 unset($_SESSION['uid']);
281 unset($_SESSION['ip']);
282 unset($_SESSION['username']);
283 unset($_SESSION['privateonly']);
284 unset($_SESSION['untaggedonly']);
286 setcookie('shaarli_staySignedIn', FALSE, 0, WEB_PATH
);
290 // ------------------------------------------------------------------------------------------
291 // Brute force protection system
292 // Several consecutive failed logins will ban the IP address for 30 minutes.
293 if (!is_file($conf->get('resource.ban_file', 'data/ipbans.php'))) {
296 $conf->get('resource.ban_file', 'data/ipbans.php'),
297 "<?php\n\$GLOBALS['IPBANS']=".var_export(array('FAILURES'=>array(),'BANS'=>array()),true).";\n?>"
300 include $conf->get('resource.ban_file', 'data/ipbans.php');
302 * Signal a failed login. Will ban the IP if too many failures:
304 * @param ConfigManager $conf Configuration Manager instance.
306 function ban_loginFailed($conf)
308 $ip = $_SERVER['REMOTE_ADDR'];
309 $trusted = $conf->get('security.trusted_proxies', array());
310 if (in_array($ip, $trusted)) {
311 $ip = getIpAddressFromProxy($_SERVER, $trusted);
316 $gb = $GLOBALS['IPBANS'];
317 if (! isset($gb['FAILURES'][$ip])) {
318 $gb['FAILURES'][$ip]=0;
320 $gb['FAILURES'][$ip]++
;
321 if ($gb['FAILURES'][$ip] > ($conf->get('security.ban_after') - 1))
323 $gb['BANS'][$ip] = time() +
$conf->get('security.ban_after', 1800);
324 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'IP address banned from login');
326 $GLOBALS['IPBANS'] = $gb;
328 $conf->get('resource.ban_file', 'data/ipbans.php'),
329 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
334 * Signals a successful login. Resets failed login counter.
336 * @param ConfigManager $conf Configuration Manager instance.
338 function ban_loginOk($conf)
340 $ip = $_SERVER['REMOTE_ADDR'];
341 $gb = $GLOBALS['IPBANS'];
342 unset($gb['FAILURES'][$ip]); unset($gb['BANS'][$ip]);
343 $GLOBALS['IPBANS'] = $gb;
345 $conf->get('resource.ban_file', 'data/ipbans.php'),
346 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
351 * Checks if the user CAN login. If 'true', the user can try to login.
353 * @param ConfigManager $conf Configuration Manager instance.
355 * @return bool: true if the user is allowed to login.
357 function ban_canLogin($conf)
359 $ip=$_SERVER["REMOTE_ADDR"]; $gb=$GLOBALS['IPBANS'];
360 if (isset($gb['BANS'][$ip]))
362 // User is banned. Check if the ban has expired:
363 if ($gb['BANS'][$ip]<=time())
364 { // Ban expired, user can try to login again.
365 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Ban lifted.');
366 unset($gb['FAILURES'][$ip]); unset($gb['BANS'][$ip]);
368 $conf->get('resource.ban_file', 'data/ipbans.php'),
369 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
371 return true; // Ban has expired, user can login.
373 return false; // User is banned.
375 return true; // User is not banned.
378 // ------------------------------------------------------------------------------------------
379 // Process login form: Check if login/password is correct.
380 if (isset($_POST['login']))
382 if (!ban_canLogin($conf)) die(t('I said: NO. You are banned for the moment. Go away.'));
383 if (isset($_POST['password'])
384 && tokenOk($_POST['token'])
385 && (check_auth($_POST['login'], $_POST['password'], $conf))
386 ) { // Login/password is OK.
388 // If user wants to keep the session cookie even after the browser closes:
389 if (!empty($_POST['longlastingsession']))
391 $_SESSION['longlastingsession'] = 31536000; // (31536000 seconds = 1 year)
392 $expiration = time() +
$_SESSION['longlastingsession']; // calculate relative cookie expiration (1 year from now)
393 setcookie('shaarli_staySignedIn', STAY_SIGNED_IN_TOKEN
, $expiration, WEB_PATH
);
394 $_SESSION['expires_on'] = $expiration; // Set session expiration on server-side.
396 $cookiedir = ''; if(dirname($_SERVER['SCRIPT_NAME'])!='/') $cookiedir=dirname($_SERVER["SCRIPT_NAME"]).'/';
397 session_set_cookie_params($_SESSION['longlastingsession'],$cookiedir,$_SERVER['SERVER_NAME']); // Set session cookie expiration on client side
398 // Note: Never forget the trailing slash on the cookie path!
399 session_regenerate_id(true); // Send cookie with new expiration date to browser.
401 else // Standard session expiration (=when browser closes)
403 $cookiedir = ''; if(dirname($_SERVER['SCRIPT_NAME'])!='/') $cookiedir=dirname($_SERVER["SCRIPT_NAME"]).'/';
404 session_set_cookie_params(0,$cookiedir,$_SERVER['SERVER_NAME']); // 0 means "When browser closes"
405 session_regenerate_id(true);
408 // Optional redirect after login:
409 if (isset($_GET['post'])) {
410 $uri = '?post='. urlencode($_GET['post']);
411 foreach (array('description', 'source', 'title', 'tags') as $param) {
412 if (!empty($_GET[$param])) {
413 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
416 header('Location: '. $uri);
420 if (isset($_GET['edit_link'])) {
421 header('Location: ?edit_link='. escape($_GET['edit_link']));
425 if (isset($_POST['returnurl'])) {
426 // Prevent loops over login screen.
427 if (strpos($_POST['returnurl'], 'do=login') === false) {
428 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
432 header('Location: ?'); exit;
436 ban_loginFailed($conf);
437 $redir = '&username='. $_POST['login'];
438 if (isset($_GET['post'])) {
439 $redir .= '&post=' . urlencode($_GET['post']);
440 foreach (array('description', 'source', 'title', 'tags') as $param) {
441 if (!empty($_GET[$param])) {
442 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
446 // Redirect to login screen.
447 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
452 // ------------------------------------------------------------------------------------------
453 // Token management for XSRF protection
454 // Token should be used in any form which acts on data (create,update,delete,import...).
455 if (!isset($_SESSION['tokens'])) $_SESSION['tokens']=array(); // Token are attached to the session.
460 * @param ConfigManager $conf Configuration Manager instance.
462 * @return string token.
464 function getToken($conf)
466 $rnd = sha1(uniqid('', true) .'_'. mt_rand() . $conf->get('credentials.salt')); // We generate a random string.
467 $_SESSION['tokens'][$rnd]=1; // Store it on the server side.
471 // Tells if a token is OK. Using this function will destroy the token.
473 function tokenOk($token)
475 if (isset($_SESSION['tokens'][$token]))
477 unset($_SESSION['tokens'][$token]); // Token is used: destroy it.
478 return true; // Token is OK.
480 return false; // Wrong token, or already used.
484 * Daily RSS feed: 1 RSS entry per day giving all the links on that day.
485 * Gives the last 7 days (which have links).
486 * This RSS feed cannot be filtered.
488 * @param ConfigManager $conf Configuration Manager instance.
490 function showDailyRSS($conf) {
492 $query = $_SERVER['QUERY_STRING'];
493 $cache = new CachedPage(
494 $conf->get('config.PAGE_CACHE'),
496 startsWith($query,'do=dailyrss') && !isLoggedIn()
498 $cached = $cache->cachedVersion();
499 if (!empty($cached)) {
504 // If cached was not found (or not usable), then read the database and build the response:
505 // Read links from database (and filter private links if used it not logged in).
506 $LINKSDB = new LinkDB(
507 $conf->get('resource.datastore'),
509 $conf->get('privacy.hide_public_links'),
510 $conf->get('redirector.url'),
511 $conf->get('redirector.encode_url')
514 /* Some Shaarlies may have very few links, so we need to look
515 back in time until we have enough days ($nb_of_days).
517 $nb_of_days = 7; // We take 7 days.
518 $today = date('Ymd');
521 foreach ($LINKSDB as $link) {
522 $day = $link['created']->format('Ymd'); // Extract day (without time)
523 if (strcmp($day, $today) < 0) {
524 if (empty($days[$day])) {
525 $days[$day] = array();
527 $days[$day][] = $link;
530 if (count($days) > $nb_of_days) {
531 break; // Have we collected enough days?
535 // Build the RSS feed.
536 header('Content-Type: application/rss+xml; charset=utf-8');
537 $pageaddr = escape(index_url($_SERVER));
538 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
540 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
541 echo '<link>'. $pageaddr .'</link>';
542 echo '<description>Daily shared links</description>';
543 echo '<language>en-en</language>';
544 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
547 foreach ($days as $day => $links) {
548 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
549 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
551 // We pre-format some fields for proper output.
552 foreach ($links as &$link) {
553 $link['formatedDescription'] = format_description($link['description'], $conf->get('redirector.url'));
554 $link['thumbnail'] = thumbnail($conf, $link['url']);
555 $link['timestamp'] = $link['created']->getTimestamp();
556 if (startsWith($link['url'], '?')) {
557 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
561 // Then build the HTML for this day:
563 $tpl->assign('title', $conf->get('general.title'));
564 $tpl->assign('daydate', $dayDate->getTimestamp());
565 $tpl->assign('absurl', $absurl);
566 $tpl->assign('links', $links);
567 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
568 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
569 $html = $tpl->draw('dailyrss', true);
571 echo $html . PHP_EOL
;
573 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
575 $cache->cache(ob_get_contents());
581 * Show the 'Daily' page.
583 * @param PageBuilder $pageBuilder Template engine wrapper.
584 * @param LinkDB $LINKSDB LinkDB instance.
585 * @param ConfigManager $conf Configuration Manager instance.
586 * @param PluginManager $pluginManager Plugin Manager instane.
588 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager)
590 $day = date('Ymd', strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
591 if (isset($_GET['day'])) {
595 $days = $LINKSDB->days();
596 $i = array_search($day, $days);
597 if ($i === false && count($days)) {
598 // no links for day, but at least one day with links
599 $i = count($days) - 1;
607 $previousday=$days[$i - 1];
609 if ($i < count($days) - 1) {
610 $nextday = $days[$i +
1];
614 $linksToDisplay = $LINKSDB->filterDay($day);
615 } catch (Exception
$exc) {
617 $linksToDisplay = array();
620 // We pre-format some fields for proper output.
621 foreach($linksToDisplay as $key => $link) {
622 $taglist = explode(' ',$link['tags']);
623 uasort($taglist, 'strcasecmp');
624 $linksToDisplay[$key]['taglist']=$taglist;
625 $linksToDisplay[$key]['formatedDescription'] = format_description($link['description'], $conf->get('redirector.url'));
626 $linksToDisplay[$key]['thumbnail'] = thumbnail($conf, $link['url']);
627 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
630 /* We need to spread the articles on 3 columns.
631 I did not want to use a JavaScript lib like http://masonry.desandro.com/
632 so I manually spread entries with a simple method: I roughly evaluate the
633 height of a div according to title and description length.
635 $columns = array(array(), array(), array()); // Entries to display, for each column.
636 $fill = array(0, 0, 0); // Rough estimate of columns fill.
637 foreach($linksToDisplay as $key => $link) {
638 // Roughly estimate length of entry (by counting characters)
639 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
640 // Description: 836 characters gives roughly 342 pixel height.
641 // This is not perfect, but it's usually OK.
642 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
643 if ($link['thumbnail']) {
644 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
646 // Then put in column which is the less filled:
647 $smallest = min($fill); // find smallest value in array.
648 $index = array_search($smallest, $fill); // find index of this smallest value.
649 array_push($columns[$index], $link); // Put entry in this column.
650 $fill[$index] +
= $length;
653 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
655 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
656 'linksToDisplay' => $linksToDisplay,
658 'day' => $dayDate->getTimestamp(),
659 'dayDate' => $dayDate,
660 'previousday' => $previousday,
661 'nextday' => $nextday,
664 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => isLoggedIn()));
666 foreach ($data as $key => $value) {
667 $pageBuilder->assign($key, $value);
670 $pageBuilder->renderPage('daily');
675 * Renders the linklist
677 * @param pageBuilder $PAGE pageBuilder instance.
678 * @param LinkDB $LINKSDB LinkDB instance.
679 * @param ConfigManager $conf Configuration Manager instance.
680 * @param PluginManager $pluginManager Plugin Manager instance.
682 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager) {
683 buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager); // Compute list of links to display
684 $PAGE->renderPage('linklist');
688 * Render HTML page (according to URL parameters and user rights)
690 * @param ConfigManager $conf Configuration Manager instance.
691 * @param PluginManager $pluginManager Plugin Manager instance,
692 * @param LinkDB $LINKSDB
693 * @param History $history instance
695 function renderPage($conf, $pluginManager, $LINKSDB, $history)
697 $updater = new Updater(
698 read_updates_file($conf->get('resource.updates')),
704 $newUpdates = $updater->update();
705 if (! empty($newUpdates)) {
707 $conf->get('resource.updates'),
708 $updater->getDoneUpdates()
712 catch(Exception
$e) {
713 die($e->getMessage());
716 $PAGE = new PageBuilder($conf, $LINKSDB);
717 $PAGE->assign('linkcount', count($LINKSDB));
718 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
719 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
721 // Determine which page will be rendered.
722 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
723 $targetPage = Router
::findPage($query, $_GET, isLoggedIn());
726 // if the user isn't logged in
728 // and Shaarli doesn't have public content...
729 $conf->get('privacy.hide_public_links') &&
730 // and is configured to enforce the login
731 $conf->get('privacy.force_login') &&
732 // and the current page isn't already the login page
733 $targetPage !== Router
::$PAGE_LOGIN &&
734 // and the user is not requesting a feed (which would lead to a different content-type as expected)
735 $targetPage !== Router
::$PAGE_FEED_ATOM &&
736 $targetPage !== Router
::$PAGE_FEED_RSS
738 // force current page to be the login page
739 $targetPage = Router
::$PAGE_LOGIN;
742 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
743 // Then assign generated data to RainTPL.
744 $common_hooks = array(
750 foreach($common_hooks as $name) {
751 $plugin_data = array();
752 $pluginManager->executeHooks('render_' . $name, $plugin_data,
754 'target' => $targetPage,
755 'loggedin' => isLoggedIn()
758 $PAGE->assign('plugins_' . $name, $plugin_data);
761 // -------- Display login form.
762 if ($targetPage == Router
::$PAGE_LOGIN)
764 if ($conf->get('security.open_shaarli')) { header('Location: ?'); exit; } // No need to login for open Shaarli
765 if (isset($_GET['username'])) {
766 $PAGE->assign('username', escape($_GET['username']));
768 $PAGE->assign('returnurl',(isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
769 // add default state of the 'remember me' checkbox
770 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
771 $PAGE->renderPage('loginform');
774 // -------- User wants to logout.
775 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout'))
777 invalidateCaches($conf->get('resource.page_cache'));
779 header('Location: ?');
783 // -------- Picture wall
784 if ($targetPage == Router
::$PAGE_PICWALL)
786 // Optionally filter the results:
787 $links = $LINKSDB->filterSearch($_GET);
788 $linksToDisplay = array();
790 // Get only links which have a thumbnail.
791 foreach($links as $link)
793 $permalink='?'.$link['shorturl'];
794 $thumb=lazyThumbnail($conf, $link['url'],$permalink);
795 if ($thumb!='') // Only output links which have a thumbnail.
797 $link['thumbnail']=$thumb; // Thumbnail HTML code.
798 $linksToDisplay[]=$link; // Add to array.
803 'linksToDisplay' => $linksToDisplay,
805 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => isLoggedIn()));
807 foreach ($data as $key => $value) {
808 $PAGE->assign($key, $value);
811 $PAGE->renderPage('picwall');
815 // -------- Tag cloud
816 if ($targetPage == Router
::$PAGE_TAGCLOUD)
818 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
819 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
820 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
822 // We sort tags alphabetically, then choose a font size according to count.
823 // First, find max value.
825 foreach ($tags as $value) {
826 $maxcount = max($maxcount, $value);
829 alphabetical_sort($tags, false, true);
832 foreach($tags as $key => $value) {
833 if (in_array($key, $filteringTags)) {
836 // Tag font size scaling:
837 // default 15 and 30 logarithm bases affect scaling,
838 // 22 and 6 are arbitrary font sizes for max and min sizes.
839 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
840 $tagList[$key] = array(
842 'size' => number_format($size, 2, '.', ''),
847 'search_tags' => implode(' ', escape($filteringTags)),
850 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => isLoggedIn()));
852 foreach ($data as $key => $value) {
853 $PAGE->assign($key, $value);
856 $PAGE->renderPage('tag.cloud');
861 if ($targetPage == Router
::$PAGE_TAGLIST)
863 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
864 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
865 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
866 foreach ($filteringTags as $tag) {
867 if (array_key_exists($tag, $tags)) {
872 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
873 alphabetical_sort($tags, false, true);
877 'search_tags' => implode(' ', escape($filteringTags)),
880 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => isLoggedIn()]);
882 foreach ($data as $key => $value) {
883 $PAGE->assign($key, $value);
886 $PAGE->renderPage('tag.list');
891 if ($targetPage == Router
::$PAGE_DAILY) {
892 showDaily($PAGE, $LINKSDB, $conf, $pluginManager);
895 // ATOM and RSS feed.
896 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
897 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
898 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
901 $query = $_SERVER['QUERY_STRING'];
902 $cache = new CachedPage(
903 $conf->get('resource.page_cache'),
905 startsWith($query,'do='. $targetPage) && !isLoggedIn()
907 $cached = $cache->cachedVersion();
908 if (!empty($cached)) {
914 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, isLoggedIn());
915 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
916 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !isLoggedIn());
917 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
918 $data = $feedGenerator->buildData();
920 // Process plugin hook.
921 $pluginManager->executeHooks('render_feed', $data, array(
922 'loggedin' => isLoggedIn(),
923 'target' => $targetPage,
926 // Render the template.
927 $PAGE->assignAll($data);
928 $PAGE->renderPage('feed.'. $feedType);
929 $cache->cache(ob_get_contents());
934 // Display opensearch plugin (XML)
935 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
936 header('Content-Type: application/xml; charset=utf-8');
937 $PAGE->assign('serverurl', index_url($_SERVER));
938 $PAGE->renderPage('opensearch');
942 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
943 if (isset($_GET['addtag']))
945 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
946 if (empty($_SERVER['HTTP_REFERER'])) { header('Location: ?searchtags='.urlencode($_GET
['addtag'])); exit; } // In case browser does not send HTTP_REFERER
947 parse_str(parse_url($_SERVER['HTTP_REFERER'],PHP_URL_QUERY
), $params);
949 // Prevent redirection loop
950 if (isset($params['addtag'])) {
951 unset($params['addtag']);
954 // Check if this tag is already in the search query and ignore it if it is.
955 // Each tag is always separated by a space
956 if (isset($params['searchtags'])) {
957 $current_tags = explode(' ', $params['searchtags']);
959 $current_tags = array();
962 foreach ($current_tags as $value) {
963 if ($value === $_GET['addtag']) {
968 // Append the tag if necessary
969 if (empty($params['searchtags'])) {
970 $params['searchtags'] = trim($_GET['addtag']);
973 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
976 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
977 header('Location: ?'.http_build_query($params));
981 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
982 if (isset($_GET['removetag'])) {
983 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
984 if (empty($_SERVER['HTTP_REFERER'])) {
985 header('Location: ?');
989 // In case browser does not send HTTP_REFERER
990 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
992 // Prevent redirection loop
993 if (isset($params['removetag'])) {
994 unset($params['removetag']);
997 if (isset($params['searchtags'])) {
998 $tags = explode(' ', $params['searchtags']);
999 // Remove value from array $tags.
1000 $tags = array_diff($tags, array($_GET['removetag']));
1001 $params['searchtags'] = implode(' ',$tags);
1003 if (empty($params['searchtags'])) {
1004 unset($params['searchtags']);
1007 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
1009 header('Location: ?'.http_build_query($params));
1013 // -------- User wants to change the number of links per page (linksperpage=...)
1014 if (isset($_GET['linksperpage'])) {
1015 if (is_numeric($_GET['linksperpage'])) {
1016 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
1019 if (! empty($_SERVER['HTTP_REFERER'])) {
1020 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
1024 header('Location: '. $location);
1028 // -------- User wants to see only private links (toggle)
1029 if (isset($_GET['privateonly'])) {
1030 if (empty($_SESSION['privateonly'])) {
1031 $_SESSION['privateonly'] = 1; // See only private links
1033 unset($_SESSION['privateonly']); // See all links
1036 if (! empty($_SERVER['HTTP_REFERER'])) {
1037 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('privateonly'));
1041 header('Location: '. $location);
1045 // -------- User wants to see only untagged links (toggle)
1046 if (isset($_GET['untaggedonly'])) {
1047 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
1049 if (! empty($_SERVER['HTTP_REFERER'])) {
1050 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
1054 header('Location: '. $location);
1058 // -------- Handle other actions allowed for non-logged in users:
1061 // User tries to post new link but is not logged in:
1062 // Show login screen, then redirect to ?post=...
1063 if (isset($_GET['post']))
1065 header( // Redirect to login page, then back to post link.
1066 'Location: ?do=login&post='.urlencode($_GET['post']).
1067 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
1068 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
1069 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
1070 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
1075 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1076 if (isset($_GET['edit_link'])) {
1077 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
1081 exit; // Never remove this one! All operations below are reserved for logged in user.
1084 // -------- All other functions are reserved for the registered user:
1086 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
1087 if ($targetPage == Router
::$PAGE_TOOLS)
1090 'pageabsaddr' => index_url($_SERVER),
1091 'sslenabled' => is_https($_SERVER),
1093 $pluginManager->executeHooks('render_tools', $data);
1095 foreach ($data as $key => $value) {
1096 $PAGE->assign($key, $value);
1099 $PAGE->renderPage('tools');
1103 // -------- User wants to change his/her password.
1104 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD)
1106 if ($conf->get('security.open_shaarli')) {
1107 die(t('You are not supposed to change a password on an Open Shaarli.'));
1110 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword']))
1112 if (!tokenOk($_POST['token'])) die(t('Wrong token.')); // Go away!
1114 // Make sure old password is correct.
1115 $oldhash = sha1($_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt'));
1116 if ($oldhash!= $conf->get('credentials.hash')) {
1117 echo '<script>alert("'. t('The old password is not correct.') .'");document.location=\'?do=changepasswd\';</script>';
1120 // Save new password
1121 // Salt renders rainbow-tables attacks useless.
1122 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
1123 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $conf->get('credentials.login') . $conf->get('credentials.salt')));
1125 $conf->write(isLoggedIn());
1127 catch(Exception
$e) {
1129 'ERROR while writing config file after changing password.' . PHP_EOL
.
1133 // TODO: do not handle exceptions/errors in JS.
1134 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
1137 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
1140 else // show the change password form.
1142 $PAGE->renderPage('changepassword');
1147 // -------- User wants to change configuration
1148 if ($targetPage == Router
::$PAGE_CONFIGURE)
1150 if (!empty($_POST['title']) )
1152 if (!tokenOk($_POST['token'])) {
1153 die(t('Wrong token.')); // Go away!
1156 if (!empty($_POST['continent']) && !empty($_POST['city'])
1157 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1159 $tz = $_POST['continent'] . '/' . $_POST['city'];
1161 $conf->set('general.timezone', $tz);
1162 $conf->set('general.title', escape($_POST['title']));
1163 $conf->set('general.header_link', escape($_POST['titleLink']));
1164 $conf->set('resource.theme', escape($_POST['theme']));
1165 $conf->set('redirector.url', escape($_POST['redirector']));
1166 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1167 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1168 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1169 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1170 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1171 $conf->set('api.enabled', !empty($_POST['enableApi']));
1172 $conf->set('api.secret', escape($_POST['apiSecret']));
1174 $conf->write(isLoggedIn());
1175 $history->updateSettings();
1176 invalidateCaches($conf->get('resource.page_cache'));
1178 catch(Exception
$e) {
1180 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1184 // TODO: do not handle exceptions/errors in JS.
1185 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1188 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1191 else // Show the configuration form.
1193 $PAGE->assign('title', $conf->get('general.title'));
1194 $PAGE->assign('theme', $conf->get('resource.theme'));
1195 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1196 $PAGE->assign('redirector', $conf->get('redirector.url'));
1197 list($continents, $cities) = generateTimeZoneData(
1198 timezone_identifiers_list(),
1199 $conf->get('general.timezone')
1201 $PAGE->assign('continents', $continents);
1202 $PAGE->assign('cities', $cities);
1203 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1204 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1205 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1206 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1207 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1208 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1209 $PAGE->assign('api_secret', $conf->get('api.secret'));
1210 $PAGE->renderPage('configure');
1215 // -------- User wants to rename a tag or delete it
1216 if ($targetPage == Router
::$PAGE_CHANGETAG)
1218 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1219 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1220 $PAGE->renderPage('changetag');
1224 if (!tokenOk($_POST['token'])) {
1225 die(t('Wrong token.'));
1228 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), escape($_POST['totag']));
1229 $LINKSDB->save($conf->get('resource.page_cache'));
1230 foreach ($alteredLinks as $link) {
1231 $history->updateLink($link);
1233 $delete = empty($_POST['totag']);
1234 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1236 ? sprintf(t('The tag was removed from %d links.'), count($alteredLinks))
1237 : sprintf(t('The tag was renamed in %d links.'), count($alteredLinks));
1238 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1242 // -------- User wants to add a link without using the bookmarklet: Show form.
1243 if ($targetPage == Router
::$PAGE_ADDLINK)
1245 $PAGE->renderPage('addlink');
1249 // -------- User clicked the "Save" button when editing a link: Save link to database.
1250 if (isset($_POST['save_edit']))
1253 if (! tokenOk($_POST['token'])) {
1254 die(t('Wrong token.'));
1257 // lf_id should only be present if the link exists.
1258 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1259 // Linkdate is kept here to:
1260 // - use the same permalink for notes as they're displayed when creating them
1261 // - let users hack creation date of their posts
1262 // See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare
1263 $linkdate = escape($_POST['lf_linkdate']);
1264 if (isset($LINKSDB[$id])) {
1266 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1267 $updated = new DateTime();
1268 $shortUrl = $LINKSDB[$id]['shorturl'];
1272 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1274 $shortUrl = link_small_hash($created, $id);
1278 // Remove multiple spaces.
1279 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1280 // Remove first '-' char in tags.
1281 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1282 // Remove duplicates.
1283 $tags = implode(' ', array_unique(explode(' ', $tags)));
1285 if (empty(trim($_POST['lf_url
']))) {
1286 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1288 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1292 'title
' => trim($_POST['lf_title
']),
1294 'description
' => $_POST['lf_description
'],
1295 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1296 'created
' => $created,
1297 'updated
' => $updated,
1298 'tags
' => str_replace(',', ' ', $tags),
1299 'shorturl
' => $shortUrl,
1302 // If title is empty, use the URL as title.
1303 if ($link['title
'] == '') {
1304 $link['title
'] = $link['url
'];
1307 $pluginManager->executeHooks('save_link
', $link);
1309 $LINKSDB[$id] = $link;
1310 $LINKSDB->save($conf->get('resource.page_cache
'));
1312 $history->addLink($link);
1314 $history->updateLink($link);
1317 // If we are called from the bookmarklet, we must close the popup:
1318 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1319 echo '<script
>self
.close();</script
>';
1323 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1324 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1325 // Scroll to the link which has been edited.
1326 $location .= '#' . $link['shorturl'];
1327 // After saving the link, redirect to the page the user was on.
1328 header('Location: '. $location);
1332 // -------- User clicked the "Cancel" button when editing a link.
1333 if (isset($_POST['cancel_edit']))
1335 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1336 if (! isset($LINKSDB[$id])) {
1337 header('Location: ?');
1339 // If we are called from the bookmarklet, we must close the popup:
1340 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1341 $link = $LINKSDB[$id];
1342 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1343 // Scroll to the link which has been edited.
1344 $returnurl .= '#'. $link['shorturl'];
1345 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1346 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1350 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1351 if ($targetPage == Router
::$PAGE_DELETELINK)
1353 if (! tokenOk($_GET['token'])) {
1354 die(t('Wrong token.'));
1357 $ids = trim($_GET['lf_linkdate']);
1358 if (strpos($ids, ' ') !== false) {
1359 // multiple, space-separated ids provided
1360 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1362 // only a single id provided
1365 // assert at least one id is given
1367 die('no id provided');
1369 foreach ($ids as $id) {
1370 $id = (int) escape($id);
1371 $link = $LINKSDB[$id];
1372 $pluginManager->executeHooks('delete_link', $link);
1373 unset($LINKSDB[$id]);
1375 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1376 $history->deleteLink($link);
1378 // If we are called from the bookmarklet, we must close the popup:
1379 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1382 if (isset($_SERVER['HTTP_REFERER'])) {
1383 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1384 $location = generateLocation(
1385 $_SERVER['HTTP_REFERER'],
1386 $_SERVER['HTTP_HOST'],
1387 ['delete_link', 'edit_link', $link['shorturl']]
1391 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1395 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1396 if (isset($_GET['edit_link']))
1398 $id = (int) escape($_GET['edit_link']);
1399 $link = $LINKSDB[$id]; // Read database
1400 if (!$link) { header('Location: ?'); exit; } // Link not found in database.
1401 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1404 'link_is_new' => false,
1405 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1406 'tags' => $LINKSDB->linksCountPerTag(),
1408 $pluginManager->executeHooks('render_editlink', $data);
1410 foreach ($data as $key => $value) {
1411 $PAGE->assign($key, $value);
1414 $PAGE->renderPage('editlink');
1418 // -------- User want to post a new link: Display link edit form.
1419 if (isset($_GET['post'])) {
1420 $url = cleanup_url($_GET['post']);
1422 $link_is_new = false;
1423 // Check if URL is not already in database (in this case, we will edit the existing link)
1424 $link = $LINKSDB->getLinkFromUrl($url);
1427 $link_is_new = true;
1428 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1429 // Get title if it was provided in URL (by the bookmarklet).
1430 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1431 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1432 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1433 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1434 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1435 // 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.)
1436 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1437 // Short timeout to keep the application responsive
1438 list($headers, $content) = get_http_response($url, 4);
1439 if (strpos($headers[0], '200 OK') !== false) {
1440 // Retrieve charset.
1441 $charset = get_charset($headers, $content);
1443 $title = html_extract_title($content);
1444 // Re-encode title in utf-8 if necessary.
1445 if (! empty($title) && strtolower($charset) != 'utf-8') {
1446 $title = mb_convert_encoding($title, 'utf-8', $charset);
1452 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1453 $title = $conf->get('general.default_note_title', 'Note: ');
1455 $url = escape($url);
1456 $title = escape($title);
1459 'linkdate' => $linkdate,
1462 'description' => $description,
1464 'private' => $private,
1467 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1472 'link_is_new' => $link_is_new,
1473 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1474 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1475 'tags' => $LINKSDB->linksCountPerTag(),
1476 'default_private_links' => $conf->get('privacy.default_private_links', false),
1478 $pluginManager->executeHooks('render_editlink', $data);
1480 foreach ($data as $key => $value) {
1481 $PAGE->assign($key, $value);
1484 $PAGE->renderPage('editlink');
1488 if ($targetPage == Router
::$PAGE_EXPORT) {
1489 // Export links as a Netscape Bookmarks file
1491 if (empty($_GET['selection'])) {
1492 $PAGE->renderPage('export');
1496 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1497 $selection = $_GET['selection'];
1498 if (isset($_GET['prepend_note_url'])) {
1499 $prependNoteUrl = $_GET['prepend_note_url'];
1501 $prependNoteUrl = false;
1507 NetscapeBookmarkUtils
::filterAndFormat(
1514 } catch (Exception
$exc) {
1515 header('Content-Type: text/plain; charset=utf-8');
1516 echo $exc->getMessage();
1519 $now = new DateTime();
1520 header('Content-Type: text/html; charset=utf-8');
1522 'Content-disposition: attachment; filename=bookmarks_'
1523 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1525 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1526 $PAGE->assign('eol', PHP_EOL
);
1527 $PAGE->assign('selection', $selection);
1528 $PAGE->renderPage('export.bookmarks');
1532 if ($targetPage == Router
::$PAGE_IMPORT) {
1533 // Upload a Netscape bookmark dump to import its contents
1535 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1536 // Show import dialog
1539 get_max_upload_size(
1540 ini_get('post_max_size'),
1541 ini_get('upload_max_filesize'),
1547 get_max_upload_size(
1548 ini_get('post_max_size'),
1549 ini_get('upload_max_filesize'),
1553 $PAGE->renderPage('import');
1557 // Import bookmarks from an uploaded file
1558 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1559 // The file is too big or some form field may be missing.
1562 'The file you are trying to upload is probably bigger than what this webserver can accept'
1563 .' (%s). Please upload in smaller chunks.'
1565 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1567 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1570 if (! tokenOk($_POST['token'])) {
1571 die('Wrong token.');
1573 $status = NetscapeBookmarkUtils
::import(
1580 echo '<script>alert("'.$status.'");document.location=\'?do='
1581 .Router
::$PAGE_IMPORT .'\';</script>';
1585 // Plugin administration page
1586 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1587 $pluginMeta = $pluginManager->getPluginsMeta();
1589 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1590 $enabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] !== false; });
1592 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1595 function($a, $b) { return $a
['order'] - $b
['order']; }
1597 $disabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] === false; });
1599 $PAGE->assign('enabledPlugins', $enabledPlugins);
1600 $PAGE->assign('disabledPlugins', $disabledPlugins);
1601 $PAGE->renderPage('pluginsadmin');
1605 // Plugin administration form action
1606 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1608 if (isset($_POST['parameters_form'])) {
1609 unset($_POST['parameters_form']);
1610 foreach ($_POST as $param => $value) {
1611 $conf->set('plugins.'. $param, escape($value));
1615 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1617 $conf->write(isLoggedIn());
1618 $history->updateSettings();
1620 catch (Exception
$e) {
1622 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1626 // TODO: do not handle exceptions/errors in JS.
1627 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do='. Router
::$PAGE_PLUGINSADMIN .'\';</script>';
1630 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1634 // Get a fresh token
1635 if ($targetPage == Router
::$GET_TOKEN) {
1636 header('Content-Type:text/plain');
1637 echo getToken($conf);
1641 // -------- Otherwise, simply display search form and links:
1642 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1647 * Template for the list of links (<div id="linklist">)
1648 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1650 * @param pageBuilder $PAGE pageBuilder instance.
1651 * @param LinkDB $LINKSDB LinkDB instance.
1652 * @param ConfigManager $conf Configuration Manager instance.
1653 * @param PluginManager $pluginManager Plugin Manager instance.
1655 function buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager)
1657 // Used in templates
1658 if (isset($_GET['searchtags'])) {
1659 if (! empty($_GET['searchtags'])) {
1660 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1662 $searchtags = false;
1667 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1670 if (! empty($_SERVER['QUERY_STRING'])
1671 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1673 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1674 } catch (LinkNotFoundException
$e) {
1675 $PAGE->render404($e->getMessage());
1679 // Filter links according search parameters.
1680 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
1682 'searchtags' => $searchtags,
1683 'searchterm' => $searchterm,
1685 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1688 // ---- Handle paging.
1690 foreach ($linksToDisplay as $key => $value) {
1696 // Select articles according to paging.
1697 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1698 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1699 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1700 $page = $page < 1 ? 1 : $page;
1701 $page = $page > $pagecount ? $pagecount : $page;
1703 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1704 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1705 $linkDisp = array();
1706 while ($i<$end && $i<count($keys))
1708 $link = $linksToDisplay[$keys[$i]];
1709 $link['description'] = format_description($link['description'], $conf->get('redirector.url'));
1710 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1711 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1712 $link['timestamp'] = $link['created']->getTimestamp();
1713 if (! empty($link['updated'])) {
1714 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1716 $link['updated_timestamp'] = '';
1718 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1719 uasort($taglist, 'strcasecmp');
1720 $link['taglist'] = $taglist;
1721 // Check for both signs of a note: starting with ? and 7 chars long.
1722 if ($link['url'][0] === '?' &&
1723 strlen($link['url']) === 7) {
1724 $link['url'] = index_url($_SERVER) . $link['url'];
1727 $linkDisp[$keys[$i]] = $link;
1731 // Compute paging navigation
1732 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1733 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1734 $previous_page_url = '';
1735 if ($i != count($keys)) {
1736 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1740 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1743 // Fill all template fields.
1745 'previous_page_url' => $previous_page_url,
1746 'next_page_url' => $next_page_url,
1747 'page_current' => $page,
1748 'page_max' => $pagecount,
1749 'result_count' => count($linksToDisplay),
1750 'search_term' => $searchterm,
1751 'search_tags' => $searchtags,
1752 'visibility' => ! empty($_SESSION['privateonly']) ? 'private' : '',
1753 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1754 'links' => $linkDisp,
1757 // If there is only a single link, we change on-the-fly the title of the page.
1758 if (count($linksToDisplay) == 1) {
1759 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1762 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => isLoggedIn()));
1764 foreach ($data as $key => $value) {
1765 $PAGE->assign($key, $value);
1772 * Compute the thumbnail for a link.
1774 * With a link to the original URL.
1775 * Understands various services (youtube.com...)
1776 * Input: $url = URL for which the thumbnail must be found.
1777 * $href = if provided, this URL will be followed instead of $url
1778 * Returns an associative array with thumbnail attributes (src,href,width,height,style,alt)
1779 * Some of them may be missing.
1780 * Return an empty array if no thumbnail available.
1782 * @param ConfigManager $conf Configuration Manager instance.
1783 * @param string $url
1784 * @param string|bool $href
1788 function computeThumbnail($conf, $url, $href = false)
1790 if (!$conf->get('thumbnail.enable_thumbnails')) return array();
1791 if ($href==false) $href=$url;
1793 // For most hosts, the URL of the thumbnail can be easily deduced from the URL of the link.
1794 // (e.g. http://www.youtube.com/watch?v=spVypYk4kto ---> http://img.youtube.com/vi/spVypYk4kto/default.jpg )
1795 // ^^^^^^^^^^^ ^^^^^^^^^^^
1796 $domain = parse_url($url,PHP_URL_HOST
);
1797 if ($domain=='youtube.com' || $domain=='www.youtube.com')
1799 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract video ID and get thumbnail
1800 if (!empty($params['v'])) return array('src'=>'https://img.youtube.com/vi/'.$params['v'].'/default.jpg',
1801 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1803 if ($domain=='youtu.be') // Youtube short links
1805 $path = parse_url($url,PHP_URL_PATH
);
1806 return array('src'=>'https://img.youtube.com/vi'.$path.'/default.jpg',
1807 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1809 if ($domain=='pix.toile-libre.org') // pix.toile-libre.org image hosting
1811 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract image filename.
1812 if (!empty($params) && !empty($params['img'])) return array('src'=>'http://pix.toile-libre.org/upload/thumb/'.urlencode($params['img']),
1813 'href'=>$href,'style'=>'max-width:120px; max-height:150px','alt'=>'pix.toile-libre.org thumbnail');
1816 if ($domain=='imgur.com')
1818 $path = parse_url($url,PHP_URL_PATH
);
1819 if (startsWith($path,'/a/')) return array(); // Thumbnails for albums are not available.
1820 if (startsWith($path,'/r/')) return array('src'=>'https://i.imgur.com/'.basename($path).'s.jpg',
1821 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1822 if (startsWith($path,'/gallery/')) return array('src'=>'https://i.imgur.com'.substr($path,8).'s.jpg',
1823 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1825 if (substr_count($path,'/')==1) return array('src'=>'https://i.imgur.com/'.substr($path,1).'s.jpg',
1826 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1828 if ($domain=='i.imgur.com')
1830 $pi = pathinfo(parse_url($url,PHP_URL_PATH
));
1831 if (!empty($pi['filename'])) return array('src'=>'https://i.imgur.com/'.$pi['filename'].'s.jpg',
1832 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1834 if ($domain=='dailymotion.com' || $domain=='www.dailymotion.com')
1836 if (strpos($url,'dailymotion.com/video/')!==false)
1838 $thumburl=str_replace('dailymotion.com/video/','dailymotion.com/thumbnail/video/',$url);
1839 return array('src'=>$thumburl,
1840 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'DailyMotion thumbnail');
1843 if (endsWith($domain,'.imageshack.us'))
1845 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1846 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1848 $thumburl = substr($url,0,strlen($url)-strlen($ext)).'th.'.$ext;
1849 return array('src'=>$thumburl,
1850 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'imageshack.us thumbnail');
1854 // Some other hosts are SLOW AS HELL and usually require an extra HTTP request to get the thumbnail URL.
1855 // So we deport the thumbnail generation in order not to slow down page generation
1856 // (and we also cache the thumbnail)
1858 if (! $conf->get('thumbnail.enable_localcache')) return array(); // If local cache is disabled, no thumbnails for services which require the use a local cache.
1860 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com')
1861 || $domain=='vimeo.com'
1862 || $domain=='ted.com' || endsWith($domain,'.ted.com')
1863 || $domain=='xkcd.com' || endsWith($domain,'.xkcd.com')
1866 if ($domain=='vimeo.com')
1867 { // Make sure this vimeo URL points to a video (/xxx... where xxx is numeric)
1868 $path = parse_url($url,PHP_URL_PATH
);
1869 if (!preg_match('!/\d+.+?!',$path)) return array(); // This is not a single video URL.
1871 if ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
1872 { // Make sure this URL points to a single comic (/xxx... where xxx is numeric)
1873 $path = parse_url($url,PHP_URL_PATH
);
1874 if (!preg_match('!/\d+.+?!',$path)) return array();
1876 if ($domain=='ted.com' || endsWith($domain,'.ted.com'))
1877 { // Make sure this TED URL points to a video (/talks/...)
1878 $path = parse_url($url,PHP_URL_PATH
);
1879 if ("/talks/" !== substr($path,0,7)) return array(); // This is not a single video URL.
1881 $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)
1882 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1883 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1886 // For all other, we try to make a thumbnail of links ending with .jpg/jpeg/png/gif
1887 // Technically speaking, we should download ALL links and check their Content-Type to see if they are images.
1888 // But using the extension will do.
1889 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1890 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1892 $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)
1893 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1894 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1896 return array(); // No thumbnail.
1901 // Returns the HTML code to display a thumbnail for a link
1902 // with a link to the original URL.
1903 // Understands various services (youtube.com...)
1904 // Input: $url = URL for which the thumbnail must be found.
1905 // $href = if provided, this URL will be followed instead of $url
1906 // Returns '' if no thumbnail available.
1907 function thumbnail($url,$href=false)
1911 $t = computeThumbnail($conf, $url,$href);
1912 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1914 $html='<a href="'.escape($t['href']).'"><img src="'.escape($t['src']).'"';
1915 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1916 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1917 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1918 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1923 // Returns the HTML code to display a thumbnail for a link
1924 // for the picture wall (using lazy image loading)
1925 // Understands various services (youtube.com...)
1926 // Input: $url = URL for which the thumbnail must be found.
1927 // $href = if provided, this URL will be followed instead of $url
1928 // Returns '' if no thumbnail available.
1929 function lazyThumbnail($conf, $url,$href=false)
1933 $t = computeThumbnail($conf, $url,$href);
1934 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1936 $html='<a href="'.escape($t['href']).'">';
1939 $html.='<img class="b-lazy" src="#" data-src="'.escape($t['src']).'"';
1941 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1942 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1943 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1944 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1947 // No-JavaScript fallback.
1948 $html.='<noscript><img src="'.escape($t['src']).'"';
1949 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1950 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1951 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1952 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1953 $html.='></noscript></a>';
1961 * This function should NEVER be called if the file data/config.php exists.
1963 * @param ConfigManager $conf Configuration Manager instance.
1965 function install($conf)
1967 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1968 if (endsWith($_SERVER['HTTP_HOST'],'.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions',0705);
1971 // This part makes sure sessions works correctly.
1972 // (Because on some hosts, session.save_path may not be set correctly,
1973 // or we may not have write access to it.)
1974 if (isset($_GET['test_session']) && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working'))
1976 // Step 2: Check if data in session is correct.
1978 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1979 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1980 'and that you have write access to it.<br>'.
1981 'It currently points to %s.<br>'.
1982 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1983 'or any custom hostname without a dot causes cookie storage to fail. '.
1984 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1986 $msg = sprintf($msg, session_save_path());
1988 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1991 if (!isset($_SESSION['session_tested']))
1992 { // Step 1 : Try to store data in session and reload page.
1993 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1994 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1996 if (isset($_GET['test_session']))
1997 { // Step 3: Sessions are OK. Remove test parameter from URL.
1998 header('Location: '.index_url($_SERVER));
2002 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
2005 if (!empty($_POST['continent']) && !empty($_POST['city'])
2006 && isTimeZoneValid($_POST['continent'], $_POST['city'])
2008 $tz = $_POST['continent'].'/'.$_POST['city'];
2010 $conf->set('general.timezone', $tz);
2011 $login = $_POST['setlogin'];
2012 $conf->set('credentials.login', $login);
2013 $salt = sha1(uniqid('', true) .'_'. mt_rand());
2014 $conf->set('credentials.salt', $salt);
2015 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
2016 if (!empty($_POST['title'])) {
2017 $conf->set('general.title', escape($_POST['title']));
2019 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
2021 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
2022 $conf->set('api.enabled', !empty($_POST['enableApi']));
2025 generate_api_secret(
2026 $conf->get('credentials.login'),
2027 $conf->get('credentials.salt')
2031 // Everything is ok, let's create config file.
2032 $conf->write(isLoggedIn());
2034 catch(Exception
$e) {
2036 'ERROR while writing config file after installation.' . PHP_EOL
.
2040 // TODO: do not handle exceptions/errors in JS.
2041 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
2044 echo '<script>alert("Shaarli is now configured. Please enter your login/password and start shaaring your links!");document.location=\'?do=login\';</script>';
2048 $PAGE = new PageBuilder($conf);
2049 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
2050 $PAGE->assign('continents', $continents);
2051 $PAGE->assign('cities', $cities);
2052 $PAGE->renderPage('install');
2057 * Because some f*cking services like flickr require an extra HTTP request to get the thumbnail URL,
2058 * I have deported the thumbnail URL code generation here, otherwise this would slow down page generation.
2059 * The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail.
2060 * This function is called by passing the URL:
2061 * http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL]
2062 * [URL] is the URL of the link (e.g. a flickr page)
2063 * [HMAC] is the signature for the [URL] (so that these URL cannot be forged).
2064 * The function below will fetch the image from the webservice and store it in the cache.
2066 * @param ConfigManager $conf Configuration Manager instance,
2068 function genThumbnail($conf)
2070 // Make sure the parameters in the URL were generated by us.
2071 $sign = hash_hmac('sha256', $_GET['url'], $conf->get('credentials.salt'));
2072 if ($sign!=$_GET['hmac']) die('Naughty boy!');
2074 $cacheDir = $conf->get('resource.thumbnails_cache', 'cache');
2075 // Let's see if we don't already have the image for this URL in the cache.
2076 $thumbname=hash('sha1',$_GET['url']).'.jpg';
2077 if (is_file($cacheDir .'/'. $thumbname))
2078 { // We have the thumbnail, just serve it:
2079 header('Content-Type: image/jpeg');
2080 echo file_get_contents($cacheDir .'/'. $thumbname);
2083 // We may also serve a blank image (if service did not respond)
2084 $blankname=hash('sha1',$_GET['url']).'.gif';
2085 if (is_file($cacheDir .'/'. $blankname))
2087 header('Content-Type: image/gif');
2088 echo file_get_contents($cacheDir .'/'. $blankname);
2092 // Otherwise, generate the thumbnail.
2093 $url = $_GET['url'];
2094 $domain = parse_url($url,PHP_URL_HOST
);
2096 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com'))
2098 // Crude replacement to handle new flickr domain policy (They prefer www. now)
2099 $url = str_replace('http://flickr.com/','http://www.flickr.com/',$url);
2101 // Is this a link to an image, or to a flickr page ?
2103 if (endsWith(parse_url($url, PHP_URL_PATH
), '.jpg'))
2104 { // This is a direct link to an image. e.g. http://farm1.staticflickr.com/5/5921913_ac83ed27bd_o.jpg
2105 preg_match('!(http://farm\d+\.staticflickr\.com/\d+/\d+_\w+_)\w.jpg!',$url,$matches);
2106 if (!empty($matches[1])) $imageurl=$matches[1].'m.jpg';
2108 else // This is a flickr page (html)
2110 // Get the flickr html page.
2111 list($headers, $content) = get_http_response($url, 20);
2112 if (strpos($headers[0], '200 OK') !== false)
2114 // flickr now nicely provides the URL of the thumbnail in each flickr page.
2115 preg_match('!<link rel=\"image_src\" href=\"(.+?)\"!', $content, $matches);
2116 if (!empty($matches[1])) $imageurl=$matches[1];
2118 // In albums (and some other pages), the link rel="image_src" is not provided,
2119 // but flickr provides:
2120 // <meta property="og:image" content="http://farm4.staticflickr.com/3398/3239339068_25d13535ff_z.jpg" />
2123 preg_match('!<meta property=\"og:image\" content=\"(.+?)\"!', $content, $matches);
2124 if (!empty($matches[1])) $imageurl=$matches[1];
2130 { // Let's download the image.
2131 // Image is 240x120, so 10 seconds to download should be enough.
2132 list($headers, $content) = get_http_response($imageurl, 10);
2133 if (strpos($headers[0], '200 OK') !== false) {
2134 // Save image to cache.
2135 file_put_contents($cacheDir .'/'. $thumbname, $content);
2136 header('Content-Type: image/jpeg');
2143 elseif ($domain=='vimeo.com' )
2145 // This is more complex: we have to perform a HTTP request, then parse the result.
2146 // Maybe we should deport this to JavaScript ? Example: http://stackoverflow.com/questions/1361149/get-img-thumbnails-from-vimeo/4285098#4285098
2147 $vid = substr(parse_url($url,PHP_URL_PATH
),1);
2148 list($headers, $content) = get_http_response('https://vimeo.com/api/v2/video/'.escape($vid).'.php', 5);
2149 if (strpos($headers[0], '200 OK') !== false) {
2150 $t = unserialize($content);
2151 $imageurl = $t[0]['thumbnail_medium'];
2152 // Then we download the image and serve it to our client.
2153 list($headers, $content) = get_http_response($imageurl, 10);
2154 if (strpos($headers[0], '200 OK') !== false) {
2155 // Save image to cache.
2156 file_put_contents($cacheDir .'/'. $thumbname, $content);
2157 header('Content-Type: image/jpeg');
2164 elseif ($domain=='ted.com' || endsWith($domain,'.ted.com'))
2166 // The thumbnail for TED talks is located in the <link rel="image_src" [...]> tag on that page
2167 // http://www.ted.com/talks/mikko_hypponen_fighting_viruses_defending_the_net.html
2168 // <link rel="image_src" href="http://images.ted.com/images/ted/28bced335898ba54d4441809c5b1112ffaf36781_389x292.jpg" />
2169 list($headers, $content) = get_http_response($url, 5);
2170 if (strpos($headers[0], '200 OK') !== false) {
2171 // Extract the link to the thumbnail
2172 preg_match('!link rel="image_src" href="(http://images.ted.com/images/ted/.+_\d+x\d+\.jpg)"!', $content, $matches);
2173 if (!empty($matches[1]))
2174 { // Let's download the image.
2175 $imageurl=$matches[1];
2176 // No control on image size, so wait long enough
2177 list($headers, $content) = get_http_response($imageurl, 20);
2178 if (strpos($headers[0], '200 OK') !== false) {
2179 $filepath = $cacheDir .'/'. $thumbname;
2180 file_put_contents($filepath, $content); // Save image to cache.
2181 if (resizeImage($filepath))
2183 header('Content-Type: image/jpeg');
2184 echo file_get_contents($filepath);
2192 elseif ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
2194 // There is no thumbnail available for xkcd comics, so download the whole image and resize it.
2195 // http://xkcd.com/327/
2196 // <img src="http://imgs.xkcd.com/comics/exploits_of_a_mom.png" title="<BLABLA>" alt="<BLABLA>" />
2197 list($headers, $content) = get_http_response($url, 5);
2198 if (strpos($headers[0], '200 OK') !== false) {
2199 // Extract the link to the thumbnail
2200 preg_match('!<img src="(http://imgs.xkcd.com/comics/.*)" title="[^s]!', $content, $matches);
2201 if (!empty($matches[1]))
2202 { // Let's download the image.
2203 $imageurl=$matches[1];
2204 // No control on image size, so wait long enough
2205 list($headers, $content) = get_http_response($imageurl, 20);
2206 if (strpos($headers[0], '200 OK') !== false) {
2207 $filepath = $cacheDir.'/'.$thumbname;
2208 // Save image to cache.
2209 file_put_contents($filepath, $content);
2210 if (resizeImage($filepath))
2212 header('Content-Type: image/jpeg');
2213 echo file_get_contents($filepath);
2223 // For all other domains, we try to download the image and make a thumbnail.
2224 // We allow 30 seconds max to download (and downloads are limited to 4 Mb)
2225 list($headers, $content) = get_http_response($url, 30);
2226 if (strpos($headers[0], '200 OK') !== false) {
2227 $filepath = $cacheDir .'/'.$thumbname;
2228 // Save image to cache.
2229 file_put_contents($filepath, $content);
2230 if (resizeImage($filepath))
2232 header('Content-Type: image/jpeg');
2233 echo file_get_contents($filepath);
2240 // Otherwise, return an empty image (8x8 transparent gif)
2241 $blankgif = base64_decode('R0lGODlhCAAIAIAAAP///////yH5BAEKAAEALAAAAAAIAAgAAAIHjI+py+1dAAA7');
2242 // Also put something in cache so that this URL is not requested twice.
2243 file_put_contents($cacheDir .'/'. $blankname, $blankgif);
2244 header('Content-Type: image/gif');
2248 // Make a thumbnail of the image (to width: 120 pixels)
2249 // Returns true if success, false otherwise.
2250 function resizeImage($filepath)
2252 if (!function_exists('imagecreatefromjpeg')) return false; // GD not present: no thumbnail possible.
2254 // Trick: some stupid people rename GIF as JPEG... or else.
2255 // So we really try to open each image type whatever the extension is.
2256 $header=file_get_contents($filepath,false,NULL,0,256); // Read first 256 bytes and try to sniff file type.
2258 $i=strpos($header,'GIF8'); if (($i!==false) && ($i==0)) $im = imagecreatefromgif($filepath); // Well this is crude, but it should be enough.
2259 $i=strpos($header,'PNG'); if (($i!==false) && ($i==1)) $im = imagecreatefrompng($filepath);
2260 $i=strpos($header,'JFIF'); if ($i!==false) $im = imagecreatefromjpeg($filepath);
2261 if (!$im) return false; // Unable to open image (corrupted or not an image)
2264 $ystart = 0; $yheight=$h;
2265 if ($h>$w) { $ystart
= ($h
/2)-($w
/2); $yheight
=$w
/2; }
2266 $nw = 120; // Desired width
2267 $nh = min(floor(($h*$nw)/$w),120); // Compute new width/height, but maximum 120 pixels height.
2269 $im2 = imagecreatetruecolor($nw,$nh);
2270 imagecopyresampled($im2, $im, 0, 0, 0, $ystart, $nw, $nh, $w, $yheight);
2271 imageinterlace($im2,true); // For progressive JPEG.
2272 $tempname=$filepath.'_TEMP.jpg';
2273 imagejpeg($im2, $tempname, 90);
2277 rename($tempname,$filepath); // Overwrite original picture with thumbnail.
2281 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=genthumbnail')) { genThumbnail($conf
); exit; } // Thumbnail generation/cache does not need the link database.
2282 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf
); exit; }
2283 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
2284 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
2288 $history = new History($conf->get('resource.history'));
2289 } catch(Exception
$e) {
2290 die($e->getMessage());
2293 $linkDb = new LinkDB(
2294 $conf->get('resource.datastore'),
2296 $conf->get('privacy.hide_public_links'),
2297 $conf->get('redirector.url'),
2298 $conf->get('redirector.encode_url')
2301 $container = new \Slim\
Container();
2302 $container['conf'] = $conf;
2303 $container['plugins'] = $pluginManager;
2304 $container['history'] = $history;
2305 $app = new \Slim\
App($container);
2308 $app->group('/api/v1', function() {
2309 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
2310 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
2311 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
2312 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
2313 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
2314 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
2315 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
2316 })->add('\Shaarli\Api\ApiMiddleware');
2318 $response = $app->run(true);
2319 // Hack to make Slim and Shaarli router work together:
2320 // If a Slim route isn't found and NOT API call, we call renderPage().
2321 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
2322 // We use UTF-8 for proper international characters handling.
2323 header('Content-Type: text/html; charset=utf-8');
2324 renderPage($conf, $pluginManager, $linkDb, $history);
2326 $app->respond($response);