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 // Sniff browser language and set date format accordingly.
128 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
129 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
132 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
134 $conf->setEmpty('general.timezone', date_default_timezone_get());
135 $conf->setEmpty('general.title', t('Shared links on '). escape(index_url($_SERVER)));
136 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
137 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
139 $pluginManager = new PluginManager($conf);
140 $pluginManager->load($conf->get('general.enabled_plugins'));
142 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
144 ob_start(); // Output buffering for the page cache.
146 // Prevent caching on client side or proxy: (yes, it's ugly)
147 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
148 header("Cache-Control: no-store, no-cache, must-revalidate");
149 header("Cache-Control: post-check=0, pre-check=0", false);
150 header("Pragma: no-cache");
152 if (! is_file($conf->getConfigFileExt())) {
153 // Ensure Shaarli has proper access to its resources
154 $errors = ApplicationUtils
::checkResourcePermissions($conf);
156 if ($errors != array()) {
157 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
159 foreach ($errors as $error) {
160 $message .= '<li>'.$error.'</li>';
164 header('Content-Type: text/html; charset=utf-8');
169 // Display the installation form if no existing config is found
170 install($conf, $sessionManager);
173 // a token depending of deployment salt, user password, and the current ip
174 define('STAY_SIGNED_IN_TOKEN', sha1($conf->get('credentials.hash') . $_SERVER['REMOTE_ADDR'] . $conf->get('credentials.salt')));
177 * Checking session state (i.e. is the user still logged in)
179 * @param ConfigManager $conf The configuration manager.
181 * @return bool: true if the user is logged in, false otherwise.
183 function setup_login_state($conf)
185 if ($conf->get('security.open_shaarli')) {
188 $userIsLoggedIn = false; // By default, we do not consider the user as logged in;
189 $loginFailure = false; // If set to true, every attempt to authenticate the user will fail. This indicates that an important condition isn't met.
190 if (! $conf->exists('credentials.login')) {
191 $userIsLoggedIn = false; // Shaarli is not configured yet.
192 $loginFailure = true;
194 if (isset($_COOKIE['shaarli_staySignedIn']) &&
195 $_COOKIE['shaarli_staySignedIn']===STAY_SIGNED_IN_TOKEN
&&
198 fillSessionInfo($conf);
199 $userIsLoggedIn = true;
201 // If session does not exist on server side, or IP address has changed, or session has expired, logout.
202 if (empty($_SESSION['uid'])
203 || ($conf->get('security.session_protection_disabled') === false && $_SESSION['ip'] != allIPs())
204 || time() >= $_SESSION['expires_on'])
207 $userIsLoggedIn = false;
208 $loginFailure = true;
210 if (!empty($_SESSION['longlastingsession'])) {
211 $_SESSION['expires_on']=time()+
$_SESSION['longlastingsession']; // In case of "Stay signed in" checked.
214 $_SESSION['expires_on']=time()+INACTIVITY_TIMEOUT
; // Standard session expiration date.
216 if (!$loginFailure) {
217 $userIsLoggedIn = true;
220 return $userIsLoggedIn;
222 $userIsLoggedIn = setup_login_state($conf);
224 // ------------------------------------------------------------------------------------------
225 // Session management
227 // Returns the IP address of the client (Used to prevent session cookie hijacking.)
230 $ip = $_SERVER['REMOTE_ADDR'];
231 // Then we use more HTTP headers to prevent session hijacking from users behind the same proxy.
232 if (isset($_SERVER['HTTP_X_FORWARDED_FOR'])) { $ip
=$ip
.'_'.$_SERVER
['HTTP_X_FORWARDED_FOR']; }
233 if (isset($_SERVER['HTTP_CLIENT_IP'])) { $ip
=$ip
.'_'.$_SERVER
['HTTP_CLIENT_IP']; }
240 * @param ConfigManager $conf Configuration Manager instance.
242 function fillSessionInfo($conf)
244 $_SESSION['uid'] = sha1(uniqid('',true).'_'.mt_rand()); // Generate unique random number (different than phpsessionid)
245 $_SESSION['ip']=allIPs(); // We store IP address(es) of the client to make sure session is not hijacked.
246 $_SESSION['username']= $conf->get('credentials.login');
247 $_SESSION['expires_on']=time()+INACTIVITY_TIMEOUT
; // Set session expiration.
251 * Check that user/password is correct.
253 * @param string $login Username
254 * @param string $password User password
255 * @param ConfigManager $conf Configuration Manager instance.
257 * @return bool: authentication successful or not.
259 function check_auth($login, $password, $conf)
261 $hash = sha1($password . $login . $conf->get('credentials.salt'));
262 if ($login == $conf->get('credentials.login') && $hash == $conf->get('credentials.hash'))
263 { // Login/password is correct.
264 fillSessionInfo($conf);
265 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Login successful');
268 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Login failed for user '.$login);
272 // Returns true if the user is logged in.
273 function isLoggedIn()
275 global $userIsLoggedIn;
276 return $userIsLoggedIn;
281 if (isset($_SESSION)) {
282 unset($_SESSION['uid']);
283 unset($_SESSION['ip']);
284 unset($_SESSION['username']);
285 unset($_SESSION['privateonly']);
286 unset($_SESSION['untaggedonly']);
288 setcookie('shaarli_staySignedIn', FALSE, 0, WEB_PATH
);
292 // ------------------------------------------------------------------------------------------
293 // Brute force protection system
294 // Several consecutive failed logins will ban the IP address for 30 minutes.
295 if (!is_file($conf->get('resource.ban_file', 'data/ipbans.php'))) {
298 $conf->get('resource.ban_file', 'data/ipbans.php'),
299 "<?php\n\$GLOBALS['IPBANS']=".var_export(array('FAILURES'=>array(),'BANS'=>array()),true).";\n?>"
302 include $conf->get('resource.ban_file', 'data/ipbans.php');
304 * Signal a failed login. Will ban the IP if too many failures:
306 * @param ConfigManager $conf Configuration Manager instance.
308 function ban_loginFailed($conf)
310 $ip = $_SERVER['REMOTE_ADDR'];
311 $trusted = $conf->get('security.trusted_proxies', array());
312 if (in_array($ip, $trusted)) {
313 $ip = getIpAddressFromProxy($_SERVER, $trusted);
318 $gb = $GLOBALS['IPBANS'];
319 if (! isset($gb['FAILURES'][$ip])) {
320 $gb['FAILURES'][$ip]=0;
322 $gb['FAILURES'][$ip]++
;
323 if ($gb['FAILURES'][$ip] > ($conf->get('security.ban_after') - 1))
325 $gb['BANS'][$ip] = time() +
$conf->get('security.ban_after', 1800);
326 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'IP address banned from login');
328 $GLOBALS['IPBANS'] = $gb;
330 $conf->get('resource.ban_file', 'data/ipbans.php'),
331 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
336 * Signals a successful login. Resets failed login counter.
338 * @param ConfigManager $conf Configuration Manager instance.
340 function ban_loginOk($conf)
342 $ip = $_SERVER['REMOTE_ADDR'];
343 $gb = $GLOBALS['IPBANS'];
344 unset($gb['FAILURES'][$ip]); unset($gb['BANS'][$ip]);
345 $GLOBALS['IPBANS'] = $gb;
347 $conf->get('resource.ban_file', 'data/ipbans.php'),
348 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
353 * Checks if the user CAN login. If 'true', the user can try to login.
355 * @param ConfigManager $conf Configuration Manager instance.
357 * @return bool: true if the user is allowed to login.
359 function ban_canLogin($conf)
361 $ip=$_SERVER["REMOTE_ADDR"]; $gb=$GLOBALS['IPBANS'];
362 if (isset($gb['BANS'][$ip]))
364 // User is banned. Check if the ban has expired:
365 if ($gb['BANS'][$ip]<=time())
366 { // Ban expired, user can try to login again.
367 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Ban lifted.');
368 unset($gb['FAILURES'][$ip]); unset($gb['BANS'][$ip]);
370 $conf->get('resource.ban_file', 'data/ipbans.php'),
371 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
373 return true; // Ban has expired, user can login.
375 return false; // User is banned.
377 return true; // User is not banned.
380 // ------------------------------------------------------------------------------------------
381 // Process login form: Check if login/password is correct.
382 if (isset($_POST['login']))
384 if (!ban_canLogin($conf)) die(t('I said: NO. You are banned for the moment. Go away.'));
385 if (isset($_POST['password'])
386 && $sessionManager->checkToken($_POST['token'])
387 && (check_auth($_POST['login'], $_POST['password'], $conf))
388 ) { // Login/password is OK.
390 // If user wants to keep the session cookie even after the browser closes:
391 if (!empty($_POST['longlastingsession']))
393 $_SESSION['longlastingsession'] = 31536000; // (31536000 seconds = 1 year)
394 $expiration = time() +
$_SESSION['longlastingsession']; // calculate relative cookie expiration (1 year from now)
395 setcookie('shaarli_staySignedIn', STAY_SIGNED_IN_TOKEN
, $expiration, WEB_PATH
);
396 $_SESSION['expires_on'] = $expiration; // Set session expiration on server-side.
398 $cookiedir = ''; if(dirname($_SERVER['SCRIPT_NAME'])!='/') $cookiedir=dirname($_SERVER["SCRIPT_NAME"]).'/';
399 session_set_cookie_params($_SESSION['longlastingsession'],$cookiedir,$_SERVER['SERVER_NAME']); // Set session cookie expiration on client side
400 // Note: Never forget the trailing slash on the cookie path!
401 session_regenerate_id(true); // Send cookie with new expiration date to browser.
403 else // Standard session expiration (=when browser closes)
405 $cookiedir = ''; if(dirname($_SERVER['SCRIPT_NAME'])!='/') $cookiedir=dirname($_SERVER["SCRIPT_NAME"]).'/';
406 session_set_cookie_params(0,$cookiedir,$_SERVER['SERVER_NAME']); // 0 means "When browser closes"
407 session_regenerate_id(true);
410 // Optional redirect after login:
411 if (isset($_GET['post'])) {
412 $uri = '?post='. urlencode($_GET['post']);
413 foreach (array('description', 'source', 'title', 'tags') as $param) {
414 if (!empty($_GET[$param])) {
415 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
418 header('Location: '. $uri);
422 if (isset($_GET['edit_link'])) {
423 header('Location: ?edit_link='. escape($_GET['edit_link']));
427 if (isset($_POST['returnurl'])) {
428 // Prevent loops over login screen.
429 if (strpos($_POST['returnurl'], 'do=login') === false) {
430 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
434 header('Location: ?'); exit;
438 ban_loginFailed($conf);
439 $redir = '&username='. $_POST['login'];
440 if (isset($_GET['post'])) {
441 $redir .= '&post=' . urlencode($_GET['post']);
442 foreach (array('description', 'source', 'title', 'tags') as $param) {
443 if (!empty($_GET[$param])) {
444 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
448 // Redirect to login screen.
449 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
454 // ------------------------------------------------------------------------------------------
455 // Token management for XSRF protection
456 // Token should be used in any form which acts on data (create,update,delete,import...).
457 if (!isset($_SESSION['tokens'])) $_SESSION['tokens']=array(); // Token are attached to the session.
460 * Daily RSS feed: 1 RSS entry per day giving all the links on that day.
461 * Gives the last 7 days (which have links).
462 * This RSS feed cannot be filtered.
464 * @param ConfigManager $conf Configuration Manager instance.
466 function showDailyRSS($conf) {
468 $query = $_SERVER['QUERY_STRING'];
469 $cache = new CachedPage(
470 $conf->get('config.PAGE_CACHE'),
472 startsWith($query,'do=dailyrss') && !isLoggedIn()
474 $cached = $cache->cachedVersion();
475 if (!empty($cached)) {
480 // If cached was not found (or not usable), then read the database and build the response:
481 // Read links from database (and filter private links if used it not logged in).
482 $LINKSDB = new LinkDB(
483 $conf->get('resource.datastore'),
485 $conf->get('privacy.hide_public_links'),
486 $conf->get('redirector.url'),
487 $conf->get('redirector.encode_url')
490 /* Some Shaarlies may have very few links, so we need to look
491 back in time until we have enough days ($nb_of_days).
493 $nb_of_days = 7; // We take 7 days.
494 $today = date('Ymd');
497 foreach ($LINKSDB as $link) {
498 $day = $link['created']->format('Ymd'); // Extract day (without time)
499 if (strcmp($day, $today) < 0) {
500 if (empty($days[$day])) {
501 $days[$day] = array();
503 $days[$day][] = $link;
506 if (count($days) > $nb_of_days) {
507 break; // Have we collected enough days?
511 // Build the RSS feed.
512 header('Content-Type: application/rss+xml; charset=utf-8');
513 $pageaddr = escape(index_url($_SERVER));
514 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
516 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
517 echo '<link>'. $pageaddr .'</link>';
518 echo '<description>Daily shared links</description>';
519 echo '<language>en-en</language>';
520 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
523 foreach ($days as $day => $links) {
524 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
525 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
527 // We pre-format some fields for proper output.
528 foreach ($links as &$link) {
529 $link['formatedDescription'] = format_description($link['description'], $conf->get('redirector.url'));
530 $link['thumbnail'] = thumbnail($conf, $link['url']);
531 $link['timestamp'] = $link['created']->getTimestamp();
532 if (startsWith($link['url'], '?')) {
533 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
537 // Then build the HTML for this day:
539 $tpl->assign('title', $conf->get('general.title'));
540 $tpl->assign('daydate', $dayDate->getTimestamp());
541 $tpl->assign('absurl', $absurl);
542 $tpl->assign('links', $links);
543 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
544 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
545 $html = $tpl->draw('dailyrss', true);
547 echo $html . PHP_EOL
;
549 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
551 $cache->cache(ob_get_contents());
557 * Show the 'Daily' page.
559 * @param PageBuilder $pageBuilder Template engine wrapper.
560 * @param LinkDB $LINKSDB LinkDB instance.
561 * @param ConfigManager $conf Configuration Manager instance.
562 * @param PluginManager $pluginManager Plugin Manager instane.
564 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager)
566 $day = date('Ymd', strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
567 if (isset($_GET['day'])) {
571 $days = $LINKSDB->days();
572 $i = array_search($day, $days);
573 if ($i === false && count($days)) {
574 // no links for day, but at least one day with links
575 $i = count($days) - 1;
583 $previousday=$days[$i - 1];
585 if ($i < count($days) - 1) {
586 $nextday = $days[$i +
1];
590 $linksToDisplay = $LINKSDB->filterDay($day);
591 } catch (Exception
$exc) {
593 $linksToDisplay = array();
596 // We pre-format some fields for proper output.
597 foreach($linksToDisplay as $key => $link) {
598 $taglist = explode(' ',$link['tags']);
599 uasort($taglist, 'strcasecmp');
600 $linksToDisplay[$key]['taglist']=$taglist;
601 $linksToDisplay[$key]['formatedDescription'] = format_description($link['description'], $conf->get('redirector.url'));
602 $linksToDisplay[$key]['thumbnail'] = thumbnail($conf, $link['url']);
603 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
606 /* We need to spread the articles on 3 columns.
607 I did not want to use a JavaScript lib like http://masonry.desandro.com/
608 so I manually spread entries with a simple method: I roughly evaluate the
609 height of a div according to title and description length.
611 $columns = array(array(), array(), array()); // Entries to display, for each column.
612 $fill = array(0, 0, 0); // Rough estimate of columns fill.
613 foreach($linksToDisplay as $key => $link) {
614 // Roughly estimate length of entry (by counting characters)
615 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
616 // Description: 836 characters gives roughly 342 pixel height.
617 // This is not perfect, but it's usually OK.
618 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
619 if ($link['thumbnail']) {
620 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
622 // Then put in column which is the less filled:
623 $smallest = min($fill); // find smallest value in array.
624 $index = array_search($smallest, $fill); // find index of this smallest value.
625 array_push($columns[$index], $link); // Put entry in this column.
626 $fill[$index] +
= $length;
629 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
631 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
632 'linksToDisplay' => $linksToDisplay,
634 'day' => $dayDate->getTimestamp(),
635 'dayDate' => $dayDate,
636 'previousday' => $previousday,
637 'nextday' => $nextday,
640 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => isLoggedIn()));
642 foreach ($data as $key => $value) {
643 $pageBuilder->assign($key, $value);
646 $pageBuilder->renderPage('daily');
651 * Renders the linklist
653 * @param pageBuilder $PAGE pageBuilder instance.
654 * @param LinkDB $LINKSDB LinkDB instance.
655 * @param ConfigManager $conf Configuration Manager instance.
656 * @param PluginManager $pluginManager Plugin Manager instance.
658 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager) {
659 buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager); // Compute list of links to display
660 $PAGE->renderPage('linklist');
664 * Render HTML page (according to URL parameters and user rights)
666 * @param ConfigManager $conf Configuration Manager instance.
667 * @param PluginManager $pluginManager Plugin Manager instance,
668 * @param LinkDB $LINKSDB
669 * @param History $history instance
670 * @param SessionManager $sessionManager SessionManager instance
672 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager)
674 $updater = new Updater(
675 read_updates_file($conf->get('resource.updates')),
681 $newUpdates = $updater->update();
682 if (! empty($newUpdates)) {
684 $conf->get('resource.updates'),
685 $updater->getDoneUpdates()
689 catch(Exception
$e) {
690 die($e->getMessage());
693 $PAGE = new PageBuilder($conf, $LINKSDB, $sessionManager->generateToken());
694 $PAGE->assign('linkcount', count($LINKSDB));
695 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
696 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
698 // Determine which page will be rendered.
699 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
700 $targetPage = Router
::findPage($query, $_GET, isLoggedIn());
703 // if the user isn't logged in
705 // and Shaarli doesn't have public content...
706 $conf->get('privacy.hide_public_links') &&
707 // and is configured to enforce the login
708 $conf->get('privacy.force_login') &&
709 // and the current page isn't already the login page
710 $targetPage !== Router
::$PAGE_LOGIN &&
711 // and the user is not requesting a feed (which would lead to a different content-type as expected)
712 $targetPage !== Router
::$PAGE_FEED_ATOM &&
713 $targetPage !== Router
::$PAGE_FEED_RSS
715 // force current page to be the login page
716 $targetPage = Router
::$PAGE_LOGIN;
719 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
720 // Then assign generated data to RainTPL.
721 $common_hooks = array(
727 foreach($common_hooks as $name) {
728 $plugin_data = array();
729 $pluginManager->executeHooks('render_' . $name, $plugin_data,
731 'target' => $targetPage,
732 'loggedin' => isLoggedIn()
735 $PAGE->assign('plugins_' . $name, $plugin_data);
738 // -------- Display login form.
739 if ($targetPage == Router
::$PAGE_LOGIN)
741 if ($conf->get('security.open_shaarli')) { header('Location: ?'); exit; } // No need to login for open Shaarli
742 if (isset($_GET['username'])) {
743 $PAGE->assign('username', escape($_GET['username']));
745 $PAGE->assign('returnurl',(isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
746 // add default state of the 'remember me' checkbox
747 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
748 $PAGE->renderPage('loginform');
751 // -------- User wants to logout.
752 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout'))
754 invalidateCaches($conf->get('resource.page_cache'));
756 header('Location: ?');
760 // -------- Picture wall
761 if ($targetPage == Router
::$PAGE_PICWALL)
763 // Optionally filter the results:
764 $links = $LINKSDB->filterSearch($_GET);
765 $linksToDisplay = array();
767 // Get only links which have a thumbnail.
768 foreach($links as $link)
770 $permalink='?'.$link['shorturl'];
771 $thumb=lazyThumbnail($conf, $link['url'],$permalink);
772 if ($thumb!='') // Only output links which have a thumbnail.
774 $link['thumbnail']=$thumb; // Thumbnail HTML code.
775 $linksToDisplay[]=$link; // Add to array.
780 'linksToDisplay' => $linksToDisplay,
782 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => isLoggedIn()));
784 foreach ($data as $key => $value) {
785 $PAGE->assign($key, $value);
788 $PAGE->renderPage('picwall');
792 // -------- Tag cloud
793 if ($targetPage == Router
::$PAGE_TAGCLOUD)
795 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
796 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
797 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
799 // We sort tags alphabetically, then choose a font size according to count.
800 // First, find max value.
802 foreach ($tags as $value) {
803 $maxcount = max($maxcount, $value);
806 alphabetical_sort($tags, false, true);
809 foreach($tags as $key => $value) {
810 if (in_array($key, $filteringTags)) {
813 // Tag font size scaling:
814 // default 15 and 30 logarithm bases affect scaling,
815 // 22 and 6 are arbitrary font sizes for max and min sizes.
816 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
817 $tagList[$key] = array(
819 'size' => number_format($size, 2, '.', ''),
824 'search_tags' => implode(' ', escape($filteringTags)),
827 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => isLoggedIn()));
829 foreach ($data as $key => $value) {
830 $PAGE->assign($key, $value);
833 $PAGE->renderPage('tag.cloud');
838 if ($targetPage == Router
::$PAGE_TAGLIST)
840 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
841 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
842 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
843 foreach ($filteringTags as $tag) {
844 if (array_key_exists($tag, $tags)) {
849 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
850 alphabetical_sort($tags, false, true);
854 'search_tags' => implode(' ', escape($filteringTags)),
857 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => isLoggedIn()]);
859 foreach ($data as $key => $value) {
860 $PAGE->assign($key, $value);
863 $PAGE->renderPage('tag.list');
868 if ($targetPage == Router
::$PAGE_DAILY) {
869 showDaily($PAGE, $LINKSDB, $conf, $pluginManager);
872 // ATOM and RSS feed.
873 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
874 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
875 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
878 $query = $_SERVER['QUERY_STRING'];
879 $cache = new CachedPage(
880 $conf->get('resource.page_cache'),
882 startsWith($query,'do='. $targetPage) && !isLoggedIn()
884 $cached = $cache->cachedVersion();
885 if (!empty($cached)) {
891 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, isLoggedIn());
892 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
893 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !isLoggedIn());
894 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
895 $data = $feedGenerator->buildData();
897 // Process plugin hook.
898 $pluginManager->executeHooks('render_feed', $data, array(
899 'loggedin' => isLoggedIn(),
900 'target' => $targetPage,
903 // Render the template.
904 $PAGE->assignAll($data);
905 $PAGE->renderPage('feed.'. $feedType);
906 $cache->cache(ob_get_contents());
911 // Display opensearch plugin (XML)
912 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
913 header('Content-Type: application/xml; charset=utf-8');
914 $PAGE->assign('serverurl', index_url($_SERVER));
915 $PAGE->renderPage('opensearch');
919 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
920 if (isset($_GET['addtag']))
922 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
923 if (empty($_SERVER['HTTP_REFERER'])) { header('Location: ?searchtags='.urlencode($_GET
['addtag'])); exit; } // In case browser does not send HTTP_REFERER
924 parse_str(parse_url($_SERVER['HTTP_REFERER'],PHP_URL_QUERY
), $params);
926 // Prevent redirection loop
927 if (isset($params['addtag'])) {
928 unset($params['addtag']);
931 // Check if this tag is already in the search query and ignore it if it is.
932 // Each tag is always separated by a space
933 if (isset($params['searchtags'])) {
934 $current_tags = explode(' ', $params['searchtags']);
936 $current_tags = array();
939 foreach ($current_tags as $value) {
940 if ($value === $_GET['addtag']) {
945 // Append the tag if necessary
946 if (empty($params['searchtags'])) {
947 $params['searchtags'] = trim($_GET['addtag']);
950 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
953 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
954 header('Location: ?'.http_build_query($params));
958 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
959 if (isset($_GET['removetag'])) {
960 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
961 if (empty($_SERVER['HTTP_REFERER'])) {
962 header('Location: ?');
966 // In case browser does not send HTTP_REFERER
967 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
969 // Prevent redirection loop
970 if (isset($params['removetag'])) {
971 unset($params['removetag']);
974 if (isset($params['searchtags'])) {
975 $tags = explode(' ', $params['searchtags']);
976 // Remove value from array $tags.
977 $tags = array_diff($tags, array($_GET['removetag']));
978 $params['searchtags'] = implode(' ',$tags);
980 if (empty($params['searchtags'])) {
981 unset($params['searchtags']);
984 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
986 header('Location: ?'.http_build_query($params));
990 // -------- User wants to change the number of links per page (linksperpage=...)
991 if (isset($_GET['linksperpage'])) {
992 if (is_numeric($_GET['linksperpage'])) {
993 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
996 if (! empty($_SERVER['HTTP_REFERER'])) {
997 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
1001 header('Location: '. $location);
1005 // -------- User wants to see only private links (toggle)
1006 if (isset($_GET['privateonly'])) {
1007 if (empty($_SESSION['privateonly'])) {
1008 $_SESSION['privateonly'] = 1; // See only private links
1010 unset($_SESSION['privateonly']); // See all links
1013 if (! empty($_SERVER['HTTP_REFERER'])) {
1014 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('privateonly'));
1018 header('Location: '. $location);
1022 // -------- User wants to see only untagged links (toggle)
1023 if (isset($_GET['untaggedonly'])) {
1024 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
1026 if (! empty($_SERVER['HTTP_REFERER'])) {
1027 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
1031 header('Location: '. $location);
1035 // -------- Handle other actions allowed for non-logged in users:
1038 // User tries to post new link but is not logged in:
1039 // Show login screen, then redirect to ?post=...
1040 if (isset($_GET['post']))
1042 header( // Redirect to login page, then back to post link.
1043 'Location: ?do=login&post='.urlencode($_GET['post']).
1044 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
1045 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
1046 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
1047 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
1052 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1053 if (isset($_GET['edit_link'])) {
1054 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
1058 exit; // Never remove this one! All operations below are reserved for logged in user.
1061 // -------- All other functions are reserved for the registered user:
1063 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
1064 if ($targetPage == Router
::$PAGE_TOOLS)
1067 'pageabsaddr' => index_url($_SERVER),
1068 'sslenabled' => is_https($_SERVER),
1070 $pluginManager->executeHooks('render_tools', $data);
1072 foreach ($data as $key => $value) {
1073 $PAGE->assign($key, $value);
1076 $PAGE->renderPage('tools');
1080 // -------- User wants to change his/her password.
1081 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD)
1083 if ($conf->get('security.open_shaarli')) {
1084 die(t('You are not supposed to change a password on an Open Shaarli.'));
1087 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword']))
1089 if (!$sessionManager->checkToken($_POST['token'])) die(t('Wrong token.')); // Go away!
1091 // Make sure old password is correct.
1092 $oldhash = sha1($_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt'));
1093 if ($oldhash!= $conf->get('credentials.hash')) {
1094 echo '<script>alert("'. t('The old password is not correct.') .'");document.location=\'?do=changepasswd\';</script>';
1097 // Save new password
1098 // Salt renders rainbow-tables attacks useless.
1099 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
1100 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $conf->get('credentials.login') . $conf->get('credentials.salt')));
1102 $conf->write(isLoggedIn());
1104 catch(Exception
$e) {
1106 'ERROR while writing config file after changing password.' . PHP_EOL
.
1110 // TODO: do not handle exceptions/errors in JS.
1111 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
1114 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
1117 else // show the change password form.
1119 $PAGE->renderPage('changepassword');
1124 // -------- User wants to change configuration
1125 if ($targetPage == Router
::$PAGE_CONFIGURE)
1127 if (!empty($_POST['title']) )
1129 if (!$sessionManager->checkToken($_POST['token'])) {
1130 die(t('Wrong token.')); // Go away!
1133 if (!empty($_POST['continent']) && !empty($_POST['city'])
1134 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1136 $tz = $_POST['continent'] . '/' . $_POST['city'];
1138 $conf->set('general.timezone', $tz);
1139 $conf->set('general.title', escape($_POST['title']));
1140 $conf->set('general.header_link', escape($_POST['titleLink']));
1141 $conf->set('resource.theme', escape($_POST['theme']));
1142 $conf->set('redirector.url', escape($_POST['redirector']));
1143 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1144 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1145 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1146 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1147 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1148 $conf->set('api.enabled', !empty($_POST['enableApi']));
1149 $conf->set('api.secret', escape($_POST['apiSecret']));
1150 $conf->set('translation.language', escape($_POST['language']));
1153 $conf->write(isLoggedIn());
1154 $history->updateSettings();
1155 invalidateCaches($conf->get('resource.page_cache'));
1157 catch(Exception
$e) {
1159 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1163 // TODO: do not handle exceptions/errors in JS.
1164 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1167 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1170 else // Show the configuration form.
1172 $PAGE->assign('title', $conf->get('general.title'));
1173 $PAGE->assign('theme', $conf->get('resource.theme'));
1174 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1175 $PAGE->assign('redirector', $conf->get('redirector.url'));
1176 list($continents, $cities) = generateTimeZoneData(
1177 timezone_identifiers_list(),
1178 $conf->get('general.timezone')
1180 $PAGE->assign('continents', $continents);
1181 $PAGE->assign('cities', $cities);
1182 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1183 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1184 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1185 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1186 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1187 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1188 $PAGE->assign('api_secret', $conf->get('api.secret'));
1189 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1190 $PAGE->assign('language', $conf->get('translation.language'));
1191 $PAGE->renderPage('configure');
1196 // -------- User wants to rename a tag or delete it
1197 if ($targetPage == Router
::$PAGE_CHANGETAG)
1199 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1200 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1201 $PAGE->renderPage('changetag');
1205 if (!$sessionManager->checkToken($_POST['token'])) {
1206 die(t('Wrong token.'));
1209 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), escape($_POST['totag']));
1210 $LINKSDB->save($conf->get('resource.page_cache'));
1211 foreach ($alteredLinks as $link) {
1212 $history->updateLink($link);
1214 $delete = empty($_POST['totag']);
1215 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1216 $count = count($alteredLinks);
1218 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1219 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1220 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1224 // -------- User wants to add a link without using the bookmarklet: Show form.
1225 if ($targetPage == Router
::$PAGE_ADDLINK)
1227 $PAGE->renderPage('addlink');
1231 // -------- User clicked the "Save" button when editing a link: Save link to database.
1232 if (isset($_POST['save_edit']))
1235 if (! $sessionManager->checkToken($_POST['token'])) {
1236 die(t('Wrong token.'));
1239 // lf_id should only be present if the link exists.
1240 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1241 // Linkdate is kept here to:
1242 // - use the same permalink for notes as they're displayed when creating them
1243 // - let users hack creation date of their posts
1244 // See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare
1245 $linkdate = escape($_POST['lf_linkdate']);
1246 if (isset($LINKSDB[$id])) {
1248 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1249 $updated = new DateTime();
1250 $shortUrl = $LINKSDB[$id]['shorturl'];
1254 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1256 $shortUrl = link_small_hash($created, $id);
1260 // Remove multiple spaces.
1261 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1262 // Remove first '-' char in tags.
1263 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1264 // Remove duplicates.
1265 $tags = implode(' ', array_unique(explode(' ', $tags)));
1267 if (empty(trim($_POST['lf_url
']))) {
1268 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1270 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1274 'title
' => trim($_POST['lf_title
']),
1276 'description
' => $_POST['lf_description
'],
1277 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1278 'created
' => $created,
1279 'updated
' => $updated,
1280 'tags
' => str_replace(',', ' ', $tags),
1281 'shorturl
' => $shortUrl,
1284 // If title is empty, use the URL as title.
1285 if ($link['title
'] == '') {
1286 $link['title
'] = $link['url
'];
1289 $pluginManager->executeHooks('save_link
', $link);
1291 $LINKSDB[$id] = $link;
1292 $LINKSDB->save($conf->get('resource.page_cache
'));
1294 $history->addLink($link);
1296 $history->updateLink($link);
1299 // If we are called from the bookmarklet, we must close the popup:
1300 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1301 echo '<script
>self
.close();</script
>';
1305 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1306 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1307 // Scroll to the link which has been edited.
1308 $location .= '#' . $link['shorturl'];
1309 // After saving the link, redirect to the page the user was on.
1310 header('Location: '. $location);
1314 // -------- User clicked the "Cancel" button when editing a link.
1315 if (isset($_POST['cancel_edit']))
1317 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1318 if (! isset($LINKSDB[$id])) {
1319 header('Location: ?');
1321 // If we are called from the bookmarklet, we must close the popup:
1322 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1323 $link = $LINKSDB[$id];
1324 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1325 // Scroll to the link which has been edited.
1326 $returnurl .= '#'. $link['shorturl'];
1327 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1328 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1332 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1333 if ($targetPage == Router
::$PAGE_DELETELINK)
1335 if (! $sessionManager->checkToken($_GET['token'])) {
1336 die(t('Wrong token.'));
1339 $ids = trim($_GET['lf_linkdate']);
1340 if (strpos($ids, ' ') !== false) {
1341 // multiple, space-separated ids provided
1342 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1344 // only a single id provided
1347 // assert at least one id is given
1349 die('no id provided');
1351 foreach ($ids as $id) {
1352 $id = (int) escape($id);
1353 $link = $LINKSDB[$id];
1354 $pluginManager->executeHooks('delete_link', $link);
1355 unset($LINKSDB[$id]);
1357 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1358 $history->deleteLink($link);
1360 // If we are called from the bookmarklet, we must close the popup:
1361 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1364 if (isset($_SERVER['HTTP_REFERER'])) {
1365 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1366 $location = generateLocation(
1367 $_SERVER['HTTP_REFERER'],
1368 $_SERVER['HTTP_HOST'],
1369 ['delete_link', 'edit_link', $link['shorturl']]
1373 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1377 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1378 if (isset($_GET['edit_link']))
1380 $id = (int) escape($_GET['edit_link']);
1381 $link = $LINKSDB[$id]; // Read database
1382 if (!$link) { header('Location: ?'); exit; } // Link not found in database.
1383 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1386 'link_is_new' => false,
1387 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1388 'tags' => $LINKSDB->linksCountPerTag(),
1390 $pluginManager->executeHooks('render_editlink', $data);
1392 foreach ($data as $key => $value) {
1393 $PAGE->assign($key, $value);
1396 $PAGE->renderPage('editlink');
1400 // -------- User want to post a new link: Display link edit form.
1401 if (isset($_GET['post'])) {
1402 $url = cleanup_url($_GET['post']);
1404 $link_is_new = false;
1405 // Check if URL is not already in database (in this case, we will edit the existing link)
1406 $link = $LINKSDB->getLinkFromUrl($url);
1409 $link_is_new = true;
1410 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1411 // Get title if it was provided in URL (by the bookmarklet).
1412 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1413 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1414 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1415 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1416 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1417 // 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.)
1418 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1419 // Short timeout to keep the application responsive
1420 list($headers, $content) = get_http_response($url, 4);
1421 if (strpos($headers[0], '200 OK') !== false) {
1422 // Retrieve charset.
1423 $charset = get_charset($headers, $content);
1425 $title = html_extract_title($content);
1426 // Re-encode title in utf-8 if necessary.
1427 if (! empty($title) && strtolower($charset) != 'utf-8') {
1428 $title = mb_convert_encoding($title, 'utf-8', $charset);
1434 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1435 $title = $conf->get('general.default_note_title', t('Note: '));
1437 $url = escape($url);
1438 $title = escape($title);
1441 'linkdate' => $linkdate,
1444 'description' => $description,
1446 'private' => $private,
1449 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1454 'link_is_new' => $link_is_new,
1455 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1456 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1457 'tags' => $LINKSDB->linksCountPerTag(),
1458 'default_private_links' => $conf->get('privacy.default_private_links', false),
1460 $pluginManager->executeHooks('render_editlink', $data);
1462 foreach ($data as $key => $value) {
1463 $PAGE->assign($key, $value);
1466 $PAGE->renderPage('editlink');
1470 if ($targetPage == Router
::$PAGE_EXPORT) {
1471 // Export links as a Netscape Bookmarks file
1473 if (empty($_GET['selection'])) {
1474 $PAGE->renderPage('export');
1478 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1479 $selection = $_GET['selection'];
1480 if (isset($_GET['prepend_note_url'])) {
1481 $prependNoteUrl = $_GET['prepend_note_url'];
1483 $prependNoteUrl = false;
1489 NetscapeBookmarkUtils
::filterAndFormat(
1496 } catch (Exception
$exc) {
1497 header('Content-Type: text/plain; charset=utf-8');
1498 echo $exc->getMessage();
1501 $now = new DateTime();
1502 header('Content-Type: text/html; charset=utf-8');
1504 'Content-disposition: attachment; filename=bookmarks_'
1505 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1507 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1508 $PAGE->assign('eol', PHP_EOL
);
1509 $PAGE->assign('selection', $selection);
1510 $PAGE->renderPage('export.bookmarks');
1514 if ($targetPage == Router
::$PAGE_IMPORT) {
1515 // Upload a Netscape bookmark dump to import its contents
1517 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1518 // Show import dialog
1521 get_max_upload_size(
1522 ini_get('post_max_size'),
1523 ini_get('upload_max_filesize'),
1529 get_max_upload_size(
1530 ini_get('post_max_size'),
1531 ini_get('upload_max_filesize'),
1535 $PAGE->renderPage('import');
1539 // Import bookmarks from an uploaded file
1540 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1541 // The file is too big or some form field may be missing.
1544 'The file you are trying to upload is probably bigger than what this webserver can accept'
1545 .' (%s). Please upload in smaller chunks.'
1547 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1549 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1552 if (! $sessionManager->checkToken($_POST['token'])) {
1553 die('Wrong token.');
1555 $status = NetscapeBookmarkUtils
::import(
1562 echo '<script>alert("'.$status.'");document.location=\'?do='
1563 .Router
::$PAGE_IMPORT .'\';</script>';
1567 // Plugin administration page
1568 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1569 $pluginMeta = $pluginManager->getPluginsMeta();
1571 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1572 $enabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] !== false; });
1574 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1577 function($a, $b) { return $a
['order'] - $b
['order']; }
1579 $disabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] === false; });
1581 $PAGE->assign('enabledPlugins', $enabledPlugins);
1582 $PAGE->assign('disabledPlugins', $disabledPlugins);
1583 $PAGE->renderPage('pluginsadmin');
1587 // Plugin administration form action
1588 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1590 if (isset($_POST['parameters_form'])) {
1591 unset($_POST['parameters_form']);
1592 foreach ($_POST as $param => $value) {
1593 $conf->set('plugins.'. $param, escape($value));
1597 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1599 $conf->write(isLoggedIn());
1600 $history->updateSettings();
1602 catch (Exception
$e) {
1604 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1608 // TODO: do not handle exceptions/errors in JS.
1609 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do='. Router
::$PAGE_PLUGINSADMIN .'\';</script>';
1612 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1616 // Get a fresh token
1617 if ($targetPage == Router
::$GET_TOKEN) {
1618 header('Content-Type:text/plain');
1619 echo $sessionManager->generateToken($conf);
1623 // -------- Otherwise, simply display search form and links:
1624 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1629 * Template for the list of links (<div id="linklist">)
1630 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1632 * @param pageBuilder $PAGE pageBuilder instance.
1633 * @param LinkDB $LINKSDB LinkDB instance.
1634 * @param ConfigManager $conf Configuration Manager instance.
1635 * @param PluginManager $pluginManager Plugin Manager instance.
1637 function buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager)
1639 // Used in templates
1640 if (isset($_GET['searchtags'])) {
1641 if (! empty($_GET['searchtags'])) {
1642 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1644 $searchtags = false;
1649 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1652 if (! empty($_SERVER['QUERY_STRING'])
1653 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1655 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1656 } catch (LinkNotFoundException
$e) {
1657 $PAGE->render404($e->getMessage());
1661 // Filter links according search parameters.
1662 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
1664 'searchtags' => $searchtags,
1665 'searchterm' => $searchterm,
1667 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1670 // ---- Handle paging.
1672 foreach ($linksToDisplay as $key => $value) {
1678 // Select articles according to paging.
1679 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1680 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1681 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1682 $page = $page < 1 ? 1 : $page;
1683 $page = $page > $pagecount ? $pagecount : $page;
1685 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1686 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1687 $linkDisp = array();
1688 while ($i<$end && $i<count($keys))
1690 $link = $linksToDisplay[$keys[$i]];
1691 $link['description'] = format_description($link['description'], $conf->get('redirector.url'));
1692 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1693 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1694 $link['timestamp'] = $link['created']->getTimestamp();
1695 if (! empty($link['updated'])) {
1696 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1698 $link['updated_timestamp'] = '';
1700 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1701 uasort($taglist, 'strcasecmp');
1702 $link['taglist'] = $taglist;
1703 // Check for both signs of a note: starting with ? and 7 chars long.
1704 if ($link['url'][0] === '?' &&
1705 strlen($link['url']) === 7) {
1706 $link['url'] = index_url($_SERVER) . $link['url'];
1709 $linkDisp[$keys[$i]] = $link;
1713 // Compute paging navigation
1714 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1715 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1716 $previous_page_url = '';
1717 if ($i != count($keys)) {
1718 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1722 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1725 // Fill all template fields.
1727 'previous_page_url' => $previous_page_url,
1728 'next_page_url' => $next_page_url,
1729 'page_current' => $page,
1730 'page_max' => $pagecount,
1731 'result_count' => count($linksToDisplay),
1732 'search_term' => $searchterm,
1733 'search_tags' => $searchtags,
1734 'visibility' => ! empty($_SESSION['privateonly']) ? 'private' : '',
1735 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1736 'links' => $linkDisp,
1739 // If there is only a single link, we change on-the-fly the title of the page.
1740 if (count($linksToDisplay) == 1) {
1741 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1744 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => isLoggedIn()));
1746 foreach ($data as $key => $value) {
1747 $PAGE->assign($key, $value);
1754 * Compute the thumbnail for a link.
1756 * With a link to the original URL.
1757 * Understands various services (youtube.com...)
1758 * Input: $url = URL for which the thumbnail must be found.
1759 * $href = if provided, this URL will be followed instead of $url
1760 * Returns an associative array with thumbnail attributes (src,href,width,height,style,alt)
1761 * Some of them may be missing.
1762 * Return an empty array if no thumbnail available.
1764 * @param ConfigManager $conf Configuration Manager instance.
1765 * @param string $url
1766 * @param string|bool $href
1770 function computeThumbnail($conf, $url, $href = false)
1772 if (!$conf->get('thumbnail.enable_thumbnails')) return array();
1773 if ($href==false) $href=$url;
1775 // For most hosts, the URL of the thumbnail can be easily deduced from the URL of the link.
1776 // (e.g. http://www.youtube.com/watch?v=spVypYk4kto ---> http://img.youtube.com/vi/spVypYk4kto/default.jpg )
1777 // ^^^^^^^^^^^ ^^^^^^^^^^^
1778 $domain = parse_url($url,PHP_URL_HOST
);
1779 if ($domain=='youtube.com' || $domain=='www.youtube.com')
1781 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract video ID and get thumbnail
1782 if (!empty($params['v'])) return array('src'=>'https://img.youtube.com/vi/'.$params['v'].'/default.jpg',
1783 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1785 if ($domain=='youtu.be') // Youtube short links
1787 $path = parse_url($url,PHP_URL_PATH
);
1788 return array('src'=>'https://img.youtube.com/vi'.$path.'/default.jpg',
1789 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1791 if ($domain=='pix.toile-libre.org') // pix.toile-libre.org image hosting
1793 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract image filename.
1794 if (!empty($params) && !empty($params['img'])) return array('src'=>'http://pix.toile-libre.org/upload/thumb/'.urlencode($params['img']),
1795 'href'=>$href,'style'=>'max-width:120px; max-height:150px','alt'=>'pix.toile-libre.org thumbnail');
1798 if ($domain=='imgur.com')
1800 $path = parse_url($url,PHP_URL_PATH
);
1801 if (startsWith($path,'/a/')) return array(); // Thumbnails for albums are not available.
1802 if (startsWith($path,'/r/')) return array('src'=>'https://i.imgur.com/'.basename($path).'s.jpg',
1803 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1804 if (startsWith($path,'/gallery/')) return array('src'=>'https://i.imgur.com'.substr($path,8).'s.jpg',
1805 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1807 if (substr_count($path,'/')==1) return array('src'=>'https://i.imgur.com/'.substr($path,1).'s.jpg',
1808 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1810 if ($domain=='i.imgur.com')
1812 $pi = pathinfo(parse_url($url,PHP_URL_PATH
));
1813 if (!empty($pi['filename'])) return array('src'=>'https://i.imgur.com/'.$pi['filename'].'s.jpg',
1814 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1816 if ($domain=='dailymotion.com' || $domain=='www.dailymotion.com')
1818 if (strpos($url,'dailymotion.com/video/')!==false)
1820 $thumburl=str_replace('dailymotion.com/video/','dailymotion.com/thumbnail/video/',$url);
1821 return array('src'=>$thumburl,
1822 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'DailyMotion thumbnail');
1825 if (endsWith($domain,'.imageshack.us'))
1827 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1828 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1830 $thumburl = substr($url,0,strlen($url)-strlen($ext)).'th.'.$ext;
1831 return array('src'=>$thumburl,
1832 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'imageshack.us thumbnail');
1836 // Some other hosts are SLOW AS HELL and usually require an extra HTTP request to get the thumbnail URL.
1837 // So we deport the thumbnail generation in order not to slow down page generation
1838 // (and we also cache the thumbnail)
1840 if (! $conf->get('thumbnail.enable_localcache')) return array(); // If local cache is disabled, no thumbnails for services which require the use a local cache.
1842 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com')
1843 || $domain=='vimeo.com'
1844 || $domain=='ted.com' || endsWith($domain,'.ted.com')
1845 || $domain=='xkcd.com' || endsWith($domain,'.xkcd.com')
1848 if ($domain=='vimeo.com')
1849 { // Make sure this vimeo URL points to a video (/xxx... where xxx is numeric)
1850 $path = parse_url($url,PHP_URL_PATH
);
1851 if (!preg_match('!/\d+.+?!',$path)) return array(); // This is not a single video URL.
1853 if ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
1854 { // Make sure this URL points to a single comic (/xxx... where xxx is numeric)
1855 $path = parse_url($url,PHP_URL_PATH
);
1856 if (!preg_match('!/\d+.+?!',$path)) return array();
1858 if ($domain=='ted.com' || endsWith($domain,'.ted.com'))
1859 { // Make sure this TED URL points to a video (/talks/...)
1860 $path = parse_url($url,PHP_URL_PATH
);
1861 if ("/talks/" !== substr($path,0,7)) return array(); // This is not a single video URL.
1863 $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)
1864 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1865 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1868 // For all other, we try to make a thumbnail of links ending with .jpg/jpeg/png/gif
1869 // Technically speaking, we should download ALL links and check their Content-Type to see if they are images.
1870 // But using the extension will do.
1871 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1872 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1874 $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)
1875 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1876 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1878 return array(); // No thumbnail.
1883 // Returns the HTML code to display a thumbnail for a link
1884 // with a link to the original URL.
1885 // Understands various services (youtube.com...)
1886 // Input: $url = URL for which the thumbnail must be found.
1887 // $href = if provided, this URL will be followed instead of $url
1888 // Returns '' if no thumbnail available.
1889 function thumbnail($url,$href=false)
1893 $t = computeThumbnail($conf, $url,$href);
1894 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1896 $html='<a href="'.escape($t['href']).'"><img src="'.escape($t['src']).'"';
1897 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1898 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1899 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1900 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1905 // Returns the HTML code to display a thumbnail for a link
1906 // for the picture wall (using lazy image loading)
1907 // Understands various services (youtube.com...)
1908 // Input: $url = URL for which the thumbnail must be found.
1909 // $href = if provided, this URL will be followed instead of $url
1910 // Returns '' if no thumbnail available.
1911 function lazyThumbnail($conf, $url,$href=false)
1915 $t = computeThumbnail($conf, $url,$href);
1916 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1918 $html='<a href="'.escape($t['href']).'">';
1921 $html.='<img class="b-lazy" src="#" data-src="'.escape($t['src']).'"';
1923 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1924 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1925 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1926 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1929 // No-JavaScript fallback.
1930 $html.='<noscript><img src="'.escape($t['src']).'"';
1931 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1932 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1933 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1934 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1935 $html.='></noscript></a>';
1943 * This function should NEVER be called if the file data/config.php exists.
1945 * @param ConfigManager $conf Configuration Manager instance.
1946 * @param SessionManager $sessionManager SessionManager instance
1948 function install($conf, $sessionManager) {
1949 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1950 if (endsWith($_SERVER['HTTP_HOST'],'.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions',0705);
1953 // This part makes sure sessions works correctly.
1954 // (Because on some hosts, session.save_path may not be set correctly,
1955 // or we may not have write access to it.)
1956 if (isset($_GET['test_session']) && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working'))
1958 // Step 2: Check if data in session is correct.
1960 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1961 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1962 'and that you have write access to it.<br>'.
1963 'It currently points to %s.<br>'.
1964 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1965 'or any custom hostname without a dot causes cookie storage to fail. '.
1966 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1968 $msg = sprintf($msg, session_save_path());
1970 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1973 if (!isset($_SESSION['session_tested']))
1974 { // Step 1 : Try to store data in session and reload page.
1975 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1976 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1978 if (isset($_GET['test_session']))
1979 { // Step 3: Sessions are OK. Remove test parameter from URL.
1980 header('Location: '.index_url($_SERVER));
1984 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
1987 if (!empty($_POST['continent']) && !empty($_POST['city'])
1988 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1990 $tz = $_POST['continent'].'/'.$_POST['city'];
1992 $conf->set('general.timezone', $tz);
1993 $login = $_POST['setlogin'];
1994 $conf->set('credentials.login', $login);
1995 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1996 $conf->set('credentials.salt', $salt);
1997 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1998 if (!empty($_POST['title'])) {
1999 $conf->set('general.title', escape($_POST['title']));
2001 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
2003 $conf->set('translation.language', escape($_POST['language']));
2004 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
2005 $conf->set('api.enabled', !empty($_POST['enableApi']));
2008 generate_api_secret(
2009 $conf->get('credentials.login'),
2010 $conf->get('credentials.salt')
2014 // Everything is ok, let's create config file.
2015 $conf->write(isLoggedIn());
2017 catch(Exception
$e) {
2019 'ERROR while writing config file after installation.' . PHP_EOL
.
2023 // TODO: do not handle exceptions/errors in JS.
2024 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
2027 echo '<script>alert("Shaarli is now configured. Please enter your login/password and start shaaring your links!");document.location=\'?do=login\';</script>';
2031 $PAGE = new PageBuilder($conf, null, $sessionManager->generateToken());
2032 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
2033 $PAGE->assign('continents', $continents);
2034 $PAGE->assign('cities', $cities);
2035 $PAGE->assign('languages', Languages
::getAvailableLanguages());
2036 $PAGE->renderPage('install');
2041 * Because some f*cking services like flickr require an extra HTTP request to get the thumbnail URL,
2042 * I have deported the thumbnail URL code generation here, otherwise this would slow down page generation.
2043 * The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail.
2044 * This function is called by passing the URL:
2045 * http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL]
2046 * [URL] is the URL of the link (e.g. a flickr page)
2047 * [HMAC] is the signature for the [URL] (so that these URL cannot be forged).
2048 * The function below will fetch the image from the webservice and store it in the cache.
2050 * @param ConfigManager $conf Configuration Manager instance,
2052 function genThumbnail($conf)
2054 // Make sure the parameters in the URL were generated by us.
2055 $sign = hash_hmac('sha256', $_GET['url'], $conf->get('credentials.salt'));
2056 if ($sign!=$_GET['hmac']) die('Naughty boy!');
2058 $cacheDir = $conf->get('resource.thumbnails_cache', 'cache');
2059 // Let's see if we don't already have the image for this URL in the cache.
2060 $thumbname=hash('sha1',$_GET['url']).'.jpg';
2061 if (is_file($cacheDir .'/'. $thumbname))
2062 { // We have the thumbnail, just serve it:
2063 header('Content-Type: image/jpeg');
2064 echo file_get_contents($cacheDir .'/'. $thumbname);
2067 // We may also serve a blank image (if service did not respond)
2068 $blankname=hash('sha1',$_GET['url']).'.gif';
2069 if (is_file($cacheDir .'/'. $blankname))
2071 header('Content-Type: image/gif');
2072 echo file_get_contents($cacheDir .'/'. $blankname);
2076 // Otherwise, generate the thumbnail.
2077 $url = $_GET['url'];
2078 $domain = parse_url($url,PHP_URL_HOST
);
2080 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com'))
2082 // Crude replacement to handle new flickr domain policy (They prefer www. now)
2083 $url = str_replace('http://flickr.com/','http://www.flickr.com/',$url);
2085 // Is this a link to an image, or to a flickr page ?
2087 if (endsWith(parse_url($url, PHP_URL_PATH
), '.jpg'))
2088 { // This is a direct link to an image. e.g. http://farm1.staticflickr.com/5/5921913_ac83ed27bd_o.jpg
2089 preg_match('!(http://farm\d+\.staticflickr\.com/\d+/\d+_\w+_)\w.jpg!',$url,$matches);
2090 if (!empty($matches[1])) $imageurl=$matches[1].'m.jpg';
2092 else // This is a flickr page (html)
2094 // Get the flickr html page.
2095 list($headers, $content) = get_http_response($url, 20);
2096 if (strpos($headers[0], '200 OK') !== false)
2098 // flickr now nicely provides the URL of the thumbnail in each flickr page.
2099 preg_match('!<link rel=\"image_src\" href=\"(.+?)\"!', $content, $matches);
2100 if (!empty($matches[1])) $imageurl=$matches[1];
2102 // In albums (and some other pages), the link rel="image_src" is not provided,
2103 // but flickr provides:
2104 // <meta property="og:image" content="http://farm4.staticflickr.com/3398/3239339068_25d13535ff_z.jpg" />
2107 preg_match('!<meta property=\"og:image\" content=\"(.+?)\"!', $content, $matches);
2108 if (!empty($matches[1])) $imageurl=$matches[1];
2114 { // Let's download the image.
2115 // Image is 240x120, so 10 seconds to download should be enough.
2116 list($headers, $content) = get_http_response($imageurl, 10);
2117 if (strpos($headers[0], '200 OK') !== false) {
2118 // Save image to cache.
2119 file_put_contents($cacheDir .'/'. $thumbname, $content);
2120 header('Content-Type: image/jpeg');
2127 elseif ($domain=='vimeo.com' )
2129 // This is more complex: we have to perform a HTTP request, then parse the result.
2130 // Maybe we should deport this to JavaScript ? Example: http://stackoverflow.com/questions/1361149/get-img-thumbnails-from-vimeo/4285098#4285098
2131 $vid = substr(parse_url($url,PHP_URL_PATH
),1);
2132 list($headers, $content) = get_http_response('https://vimeo.com/api/v2/video/'.escape($vid).'.php', 5);
2133 if (strpos($headers[0], '200 OK') !== false) {
2134 $t = unserialize($content);
2135 $imageurl = $t[0]['thumbnail_medium'];
2136 // Then we download the image and serve it to our client.
2137 list($headers, $content) = get_http_response($imageurl, 10);
2138 if (strpos($headers[0], '200 OK') !== false) {
2139 // Save image to cache.
2140 file_put_contents($cacheDir .'/'. $thumbname, $content);
2141 header('Content-Type: image/jpeg');
2148 elseif ($domain=='ted.com' || endsWith($domain,'.ted.com'))
2150 // The thumbnail for TED talks is located in the <link rel="image_src" [...]> tag on that page
2151 // http://www.ted.com/talks/mikko_hypponen_fighting_viruses_defending_the_net.html
2152 // <link rel="image_src" href="http://images.ted.com/images/ted/28bced335898ba54d4441809c5b1112ffaf36781_389x292.jpg" />
2153 list($headers, $content) = get_http_response($url, 5);
2154 if (strpos($headers[0], '200 OK') !== false) {
2155 // Extract the link to the thumbnail
2156 preg_match('!link rel="image_src" href="(http://images.ted.com/images/ted/.+_\d+x\d+\.jpg)"!', $content, $matches);
2157 if (!empty($matches[1]))
2158 { // Let's download the image.
2159 $imageurl=$matches[1];
2160 // No control on image size, so wait long enough
2161 list($headers, $content) = get_http_response($imageurl, 20);
2162 if (strpos($headers[0], '200 OK') !== false) {
2163 $filepath = $cacheDir .'/'. $thumbname;
2164 file_put_contents($filepath, $content); // Save image to cache.
2165 if (resizeImage($filepath))
2167 header('Content-Type: image/jpeg');
2168 echo file_get_contents($filepath);
2176 elseif ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
2178 // There is no thumbnail available for xkcd comics, so download the whole image and resize it.
2179 // http://xkcd.com/327/
2180 // <img src="http://imgs.xkcd.com/comics/exploits_of_a_mom.png" title="<BLABLA>" alt="<BLABLA>" />
2181 list($headers, $content) = get_http_response($url, 5);
2182 if (strpos($headers[0], '200 OK') !== false) {
2183 // Extract the link to the thumbnail
2184 preg_match('!<img src="(http://imgs.xkcd.com/comics/.*)" title="[^s]!', $content, $matches);
2185 if (!empty($matches[1]))
2186 { // Let's download the image.
2187 $imageurl=$matches[1];
2188 // No control on image size, so wait long enough
2189 list($headers, $content) = get_http_response($imageurl, 20);
2190 if (strpos($headers[0], '200 OK') !== false) {
2191 $filepath = $cacheDir.'/'.$thumbname;
2192 // Save image to cache.
2193 file_put_contents($filepath, $content);
2194 if (resizeImage($filepath))
2196 header('Content-Type: image/jpeg');
2197 echo file_get_contents($filepath);
2207 // For all other domains, we try to download the image and make a thumbnail.
2208 // We allow 30 seconds max to download (and downloads are limited to 4 Mb)
2209 list($headers, $content) = get_http_response($url, 30);
2210 if (strpos($headers[0], '200 OK') !== false) {
2211 $filepath = $cacheDir .'/'.$thumbname;
2212 // Save image to cache.
2213 file_put_contents($filepath, $content);
2214 if (resizeImage($filepath))
2216 header('Content-Type: image/jpeg');
2217 echo file_get_contents($filepath);
2224 // Otherwise, return an empty image (8x8 transparent gif)
2225 $blankgif = base64_decode('R0lGODlhCAAIAIAAAP///////yH5BAEKAAEALAAAAAAIAAgAAAIHjI+py+1dAAA7');
2226 // Also put something in cache so that this URL is not requested twice.
2227 file_put_contents($cacheDir .'/'. $blankname, $blankgif);
2228 header('Content-Type: image/gif');
2232 // Make a thumbnail of the image (to width: 120 pixels)
2233 // Returns true if success, false otherwise.
2234 function resizeImage($filepath)
2236 if (!function_exists('imagecreatefromjpeg')) return false; // GD not present: no thumbnail possible.
2238 // Trick: some stupid people rename GIF as JPEG... or else.
2239 // So we really try to open each image type whatever the extension is.
2240 $header=file_get_contents($filepath,false,NULL,0,256); // Read first 256 bytes and try to sniff file type.
2242 $i=strpos($header,'GIF8'); if (($i!==false) && ($i==0)) $im = imagecreatefromgif($filepath); // Well this is crude, but it should be enough.
2243 $i=strpos($header,'PNG'); if (($i!==false) && ($i==1)) $im = imagecreatefrompng($filepath);
2244 $i=strpos($header,'JFIF'); if ($i!==false) $im = imagecreatefromjpeg($filepath);
2245 if (!$im) return false; // Unable to open image (corrupted or not an image)
2248 $ystart = 0; $yheight=$h;
2249 if ($h>$w) { $ystart
= ($h
/2)-($w
/2); $yheight
=$w
/2; }
2250 $nw = 120; // Desired width
2251 $nh = min(floor(($h*$nw)/$w),120); // Compute new width/height, but maximum 120 pixels height.
2253 $im2 = imagecreatetruecolor($nw,$nh);
2254 imagecopyresampled($im2, $im, 0, 0, 0, $ystart, $nw, $nh, $w, $yheight);
2255 imageinterlace($im2,true); // For progressive JPEG.
2256 $tempname=$filepath.'_TEMP.jpg';
2257 imagejpeg($im2, $tempname, 90);
2261 rename($tempname,$filepath); // Overwrite original picture with thumbnail.
2265 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=genthumbnail')) { genThumbnail($conf
); exit; } // Thumbnail generation/cache does not need the link database.
2266 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf
); exit; }
2267 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
2268 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
2272 $history = new History($conf->get('resource.history'));
2273 } catch(Exception
$e) {
2274 die($e->getMessage());
2277 $linkDb = new LinkDB(
2278 $conf->get('resource.datastore'),
2280 $conf->get('privacy.hide_public_links'),
2281 $conf->get('redirector.url'),
2282 $conf->get('redirector.encode_url')
2285 $container = new \Slim\
Container();
2286 $container['conf'] = $conf;
2287 $container['plugins'] = $pluginManager;
2288 $container['history'] = $history;
2289 $app = new \Slim\
App($container);
2292 $app->group('/api/v1', function() {
2293 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
2294 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
2295 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
2296 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
2297 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
2298 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
2299 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
2300 })->add('\Shaarli\Api\ApiMiddleware');
2302 $response = $app->run(true);
2303 // Hack to make Slim and Shaarli router work together:
2304 // If a Slim route isn't found and NOT API call, we call renderPage().
2305 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
2306 // We use UTF-8 for proper international characters handling.
2307 header('Content-Type: text/html; charset=utf-8');
2308 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager);
2310 $app->respond($response);