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(
530 $link['description'],
531 $conf->get('redirector.url'),
532 $conf->get('redirector.encode_url')
534 $link['thumbnail'] = thumbnail($conf, $link['url']);
535 $link['timestamp'] = $link['created']->getTimestamp();
536 if (startsWith($link['url'], '?')) {
537 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
541 // Then build the HTML for this day:
543 $tpl->assign('title', $conf->get('general.title'));
544 $tpl->assign('daydate', $dayDate->getTimestamp());
545 $tpl->assign('absurl', $absurl);
546 $tpl->assign('links', $links);
547 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
548 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
549 $html = $tpl->draw('dailyrss', true);
551 echo $html . PHP_EOL
;
553 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
555 $cache->cache(ob_get_contents());
561 * Show the 'Daily' page.
563 * @param PageBuilder $pageBuilder Template engine wrapper.
564 * @param LinkDB $LINKSDB LinkDB instance.
565 * @param ConfigManager $conf Configuration Manager instance.
566 * @param PluginManager $pluginManager Plugin Manager instane.
568 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager)
570 $day = date('Ymd', strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
571 if (isset($_GET['day'])) {
575 $days = $LINKSDB->days();
576 $i = array_search($day, $days);
577 if ($i === false && count($days)) {
578 // no links for day, but at least one day with links
579 $i = count($days) - 1;
587 $previousday=$days[$i - 1];
589 if ($i < count($days) - 1) {
590 $nextday = $days[$i +
1];
594 $linksToDisplay = $LINKSDB->filterDay($day);
595 } catch (Exception
$exc) {
597 $linksToDisplay = array();
600 // We pre-format some fields for proper output.
601 foreach($linksToDisplay as $key => $link) {
602 $taglist = explode(' ',$link['tags']);
603 uasort($taglist, 'strcasecmp');
604 $linksToDisplay[$key]['taglist']=$taglist;
605 $linksToDisplay[$key]['formatedDescription'] = format_description(
606 $link['description'],
607 $conf->get('redirector.url'),
608 $conf->get('redirector.encode_url')
610 $linksToDisplay[$key]['thumbnail'] = thumbnail($conf, $link['url']);
611 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
614 /* We need to spread the articles on 3 columns.
615 I did not want to use a JavaScript lib like http://masonry.desandro.com/
616 so I manually spread entries with a simple method: I roughly evaluate the
617 height of a div according to title and description length.
619 $columns = array(array(), array(), array()); // Entries to display, for each column.
620 $fill = array(0, 0, 0); // Rough estimate of columns fill.
621 foreach($linksToDisplay as $key => $link) {
622 // Roughly estimate length of entry (by counting characters)
623 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
624 // Description: 836 characters gives roughly 342 pixel height.
625 // This is not perfect, but it's usually OK.
626 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
627 if ($link['thumbnail']) {
628 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
630 // Then put in column which is the less filled:
631 $smallest = min($fill); // find smallest value in array.
632 $index = array_search($smallest, $fill); // find index of this smallest value.
633 array_push($columns[$index], $link); // Put entry in this column.
634 $fill[$index] +
= $length;
637 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
639 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
640 'linksToDisplay' => $linksToDisplay,
642 'day' => $dayDate->getTimestamp(),
643 'dayDate' => $dayDate,
644 'previousday' => $previousday,
645 'nextday' => $nextday,
648 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => isLoggedIn()));
650 foreach ($data as $key => $value) {
651 $pageBuilder->assign($key, $value);
654 $pageBuilder->renderPage('daily');
659 * Renders the linklist
661 * @param pageBuilder $PAGE pageBuilder instance.
662 * @param LinkDB $LINKSDB LinkDB instance.
663 * @param ConfigManager $conf Configuration Manager instance.
664 * @param PluginManager $pluginManager Plugin Manager instance.
666 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager) {
667 buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager); // Compute list of links to display
668 $PAGE->renderPage('linklist');
672 * Render HTML page (according to URL parameters and user rights)
674 * @param ConfigManager $conf Configuration Manager instance.
675 * @param PluginManager $pluginManager Plugin Manager instance,
676 * @param LinkDB $LINKSDB
677 * @param History $history instance
678 * @param SessionManager $sessionManager SessionManager instance
680 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager)
682 $updater = new Updater(
683 read_updates_file($conf->get('resource.updates')),
689 $newUpdates = $updater->update();
690 if (! empty($newUpdates)) {
692 $conf->get('resource.updates'),
693 $updater->getDoneUpdates()
697 catch(Exception
$e) {
698 die($e->getMessage());
701 $PAGE = new PageBuilder($conf, $LINKSDB, $sessionManager->generateToken());
702 $PAGE->assign('linkcount', count($LINKSDB));
703 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
704 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
706 // Determine which page will be rendered.
707 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
708 $targetPage = Router
::findPage($query, $_GET, isLoggedIn());
711 // if the user isn't logged in
713 // and Shaarli doesn't have public content...
714 $conf->get('privacy.hide_public_links') &&
715 // and is configured to enforce the login
716 $conf->get('privacy.force_login') &&
717 // and the current page isn't already the login page
718 $targetPage !== Router
::$PAGE_LOGIN &&
719 // and the user is not requesting a feed (which would lead to a different content-type as expected)
720 $targetPage !== Router
::$PAGE_FEED_ATOM &&
721 $targetPage !== Router
::$PAGE_FEED_RSS
723 // force current page to be the login page
724 $targetPage = Router
::$PAGE_LOGIN;
727 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
728 // Then assign generated data to RainTPL.
729 $common_hooks = array(
735 foreach($common_hooks as $name) {
736 $plugin_data = array();
737 $pluginManager->executeHooks('render_' . $name, $plugin_data,
739 'target' => $targetPage,
740 'loggedin' => isLoggedIn()
743 $PAGE->assign('plugins_' . $name, $plugin_data);
746 // -------- Display login form.
747 if ($targetPage == Router
::$PAGE_LOGIN)
749 if ($conf->get('security.open_shaarli')) { header('Location: ?'); exit; } // No need to login for open Shaarli
750 if (isset($_GET['username'])) {
751 $PAGE->assign('username', escape($_GET['username']));
753 $PAGE->assign('returnurl',(isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
754 // add default state of the 'remember me' checkbox
755 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
756 $PAGE->renderPage('loginform');
759 // -------- User wants to logout.
760 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout'))
762 invalidateCaches($conf->get('resource.page_cache'));
764 header('Location: ?');
768 // -------- Picture wall
769 if ($targetPage == Router
::$PAGE_PICWALL)
771 // Optionally filter the results:
772 $links = $LINKSDB->filterSearch($_GET);
773 $linksToDisplay = array();
775 // Get only links which have a thumbnail.
776 foreach($links as $link)
778 $permalink='?'.$link['shorturl'];
779 $thumb=lazyThumbnail($conf, $link['url'],$permalink);
780 if ($thumb!='') // Only output links which have a thumbnail.
782 $link['thumbnail']=$thumb; // Thumbnail HTML code.
783 $linksToDisplay[]=$link; // Add to array.
788 'linksToDisplay' => $linksToDisplay,
790 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => isLoggedIn()));
792 foreach ($data as $key => $value) {
793 $PAGE->assign($key, $value);
796 $PAGE->renderPage('picwall');
800 // -------- Tag cloud
801 if ($targetPage == Router
::$PAGE_TAGCLOUD)
803 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
804 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
805 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
807 // We sort tags alphabetically, then choose a font size according to count.
808 // First, find max value.
810 foreach ($tags as $value) {
811 $maxcount = max($maxcount, $value);
814 alphabetical_sort($tags, false, true);
817 foreach($tags as $key => $value) {
818 if (in_array($key, $filteringTags)) {
821 // Tag font size scaling:
822 // default 15 and 30 logarithm bases affect scaling,
823 // 22 and 6 are arbitrary font sizes for max and min sizes.
824 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
825 $tagList[$key] = array(
827 'size' => number_format($size, 2, '.', ''),
832 'search_tags' => implode(' ', escape($filteringTags)),
835 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => isLoggedIn()));
837 foreach ($data as $key => $value) {
838 $PAGE->assign($key, $value);
841 $PAGE->renderPage('tag.cloud');
846 if ($targetPage == Router
::$PAGE_TAGLIST)
848 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
849 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
850 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
851 foreach ($filteringTags as $tag) {
852 if (array_key_exists($tag, $tags)) {
857 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
858 alphabetical_sort($tags, false, true);
862 'search_tags' => implode(' ', escape($filteringTags)),
865 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => isLoggedIn()]);
867 foreach ($data as $key => $value) {
868 $PAGE->assign($key, $value);
871 $PAGE->renderPage('tag.list');
876 if ($targetPage == Router
::$PAGE_DAILY) {
877 showDaily($PAGE, $LINKSDB, $conf, $pluginManager);
880 // ATOM and RSS feed.
881 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
882 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
883 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
886 $query = $_SERVER['QUERY_STRING'];
887 $cache = new CachedPage(
888 $conf->get('resource.page_cache'),
890 startsWith($query,'do='. $targetPage) && !isLoggedIn()
892 $cached = $cache->cachedVersion();
893 if (!empty($cached)) {
899 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, isLoggedIn());
900 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
901 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !isLoggedIn());
902 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
903 $data = $feedGenerator->buildData();
905 // Process plugin hook.
906 $pluginManager->executeHooks('render_feed', $data, array(
907 'loggedin' => isLoggedIn(),
908 'target' => $targetPage,
911 // Render the template.
912 $PAGE->assignAll($data);
913 $PAGE->renderPage('feed.'. $feedType);
914 $cache->cache(ob_get_contents());
919 // Display opensearch plugin (XML)
920 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
921 header('Content-Type: application/xml; charset=utf-8');
922 $PAGE->assign('serverurl', index_url($_SERVER));
923 $PAGE->renderPage('opensearch');
927 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
928 if (isset($_GET['addtag']))
930 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
931 if (empty($_SERVER['HTTP_REFERER'])) { header('Location: ?searchtags='.urlencode($_GET
['addtag'])); exit; } // In case browser does not send HTTP_REFERER
932 parse_str(parse_url($_SERVER['HTTP_REFERER'],PHP_URL_QUERY
), $params);
934 // Prevent redirection loop
935 if (isset($params['addtag'])) {
936 unset($params['addtag']);
939 // Check if this tag is already in the search query and ignore it if it is.
940 // Each tag is always separated by a space
941 if (isset($params['searchtags'])) {
942 $current_tags = explode(' ', $params['searchtags']);
944 $current_tags = array();
947 foreach ($current_tags as $value) {
948 if ($value === $_GET['addtag']) {
953 // Append the tag if necessary
954 if (empty($params['searchtags'])) {
955 $params['searchtags'] = trim($_GET['addtag']);
958 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
961 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
962 header('Location: ?'.http_build_query($params));
966 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
967 if (isset($_GET['removetag'])) {
968 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
969 if (empty($_SERVER['HTTP_REFERER'])) {
970 header('Location: ?');
974 // In case browser does not send HTTP_REFERER
975 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
977 // Prevent redirection loop
978 if (isset($params['removetag'])) {
979 unset($params['removetag']);
982 if (isset($params['searchtags'])) {
983 $tags = explode(' ', $params['searchtags']);
984 // Remove value from array $tags.
985 $tags = array_diff($tags, array($_GET['removetag']));
986 $params['searchtags'] = implode(' ',$tags);
988 if (empty($params['searchtags'])) {
989 unset($params['searchtags']);
992 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
994 header('Location: ?'.http_build_query($params));
998 // -------- User wants to change the number of links per page (linksperpage=...)
999 if (isset($_GET['linksperpage'])) {
1000 if (is_numeric($_GET['linksperpage'])) {
1001 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
1004 if (! empty($_SERVER['HTTP_REFERER'])) {
1005 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
1009 header('Location: '. $location);
1013 // -------- User wants to see only private links (toggle)
1014 if (isset($_GET['privateonly'])) {
1015 if (empty($_SESSION['privateonly'])) {
1016 $_SESSION['privateonly'] = 1; // See only private links
1018 unset($_SESSION['privateonly']); // See all links
1021 if (! empty($_SERVER['HTTP_REFERER'])) {
1022 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('privateonly'));
1026 header('Location: '. $location);
1030 // -------- User wants to see only untagged links (toggle)
1031 if (isset($_GET['untaggedonly'])) {
1032 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
1034 if (! empty($_SERVER['HTTP_REFERER'])) {
1035 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
1039 header('Location: '. $location);
1043 // -------- Handle other actions allowed for non-logged in users:
1046 // User tries to post new link but is not logged in:
1047 // Show login screen, then redirect to ?post=...
1048 if (isset($_GET['post']))
1050 header( // Redirect to login page, then back to post link.
1051 'Location: ?do=login&post='.urlencode($_GET['post']).
1052 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
1053 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
1054 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
1055 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
1060 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1061 if (isset($_GET['edit_link'])) {
1062 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
1066 exit; // Never remove this one! All operations below are reserved for logged in user.
1069 // -------- All other functions are reserved for the registered user:
1071 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
1072 if ($targetPage == Router
::$PAGE_TOOLS)
1075 'pageabsaddr' => index_url($_SERVER),
1076 'sslenabled' => is_https($_SERVER),
1078 $pluginManager->executeHooks('render_tools', $data);
1080 foreach ($data as $key => $value) {
1081 $PAGE->assign($key, $value);
1084 $PAGE->renderPage('tools');
1088 // -------- User wants to change his/her password.
1089 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD)
1091 if ($conf->get('security.open_shaarli')) {
1092 die(t('You are not supposed to change a password on an Open Shaarli.'));
1095 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword']))
1097 if (!$sessionManager->checkToken($_POST['token'])) die(t('Wrong token.')); // Go away!
1099 // Make sure old password is correct.
1100 $oldhash = sha1($_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt'));
1101 if ($oldhash!= $conf->get('credentials.hash')) {
1102 echo '<script>alert("'. t('The old password is not correct.') .'");document.location=\'?do=changepasswd\';</script>';
1105 // Save new password
1106 // Salt renders rainbow-tables attacks useless.
1107 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
1108 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $conf->get('credentials.login') . $conf->get('credentials.salt')));
1110 $conf->write(isLoggedIn());
1112 catch(Exception
$e) {
1114 'ERROR while writing config file after changing password.' . PHP_EOL
.
1118 // TODO: do not handle exceptions/errors in JS.
1119 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
1122 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
1125 else // show the change password form.
1127 $PAGE->renderPage('changepassword');
1132 // -------- User wants to change configuration
1133 if ($targetPage == Router
::$PAGE_CONFIGURE)
1135 if (!empty($_POST['title']) )
1137 if (!$sessionManager->checkToken($_POST['token'])) {
1138 die(t('Wrong token.')); // Go away!
1141 if (!empty($_POST['continent']) && !empty($_POST['city'])
1142 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1144 $tz = $_POST['continent'] . '/' . $_POST['city'];
1146 $conf->set('general.timezone', $tz);
1147 $conf->set('general.title', escape($_POST['title']));
1148 $conf->set('general.header_link', escape($_POST['titleLink']));
1149 $conf->set('resource.theme', escape($_POST['theme']));
1150 $conf->set('redirector.url', escape($_POST['redirector']));
1151 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1152 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1153 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1154 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1155 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1156 $conf->set('api.enabled', !empty($_POST['enableApi']));
1157 $conf->set('api.secret', escape($_POST['apiSecret']));
1158 $conf->set('translation.language', escape($_POST['language']));
1161 $conf->write(isLoggedIn());
1162 $history->updateSettings();
1163 invalidateCaches($conf->get('resource.page_cache'));
1165 catch(Exception
$e) {
1167 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1171 // TODO: do not handle exceptions/errors in JS.
1172 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1175 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1178 else // Show the configuration form.
1180 $PAGE->assign('title', $conf->get('general.title'));
1181 $PAGE->assign('theme', $conf->get('resource.theme'));
1182 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1183 $PAGE->assign('redirector', $conf->get('redirector.url'));
1184 list($continents, $cities) = generateTimeZoneData(
1185 timezone_identifiers_list(),
1186 $conf->get('general.timezone')
1188 $PAGE->assign('continents', $continents);
1189 $PAGE->assign('cities', $cities);
1190 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1191 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1192 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1193 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1194 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1195 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1196 $PAGE->assign('api_secret', $conf->get('api.secret'));
1197 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1198 $PAGE->assign('language', $conf->get('translation.language'));
1199 $PAGE->renderPage('configure');
1204 // -------- User wants to rename a tag or delete it
1205 if ($targetPage == Router
::$PAGE_CHANGETAG)
1207 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1208 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1209 $PAGE->renderPage('changetag');
1213 if (!$sessionManager->checkToken($_POST['token'])) {
1214 die(t('Wrong token.'));
1217 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), escape($_POST['totag']));
1218 $LINKSDB->save($conf->get('resource.page_cache'));
1219 foreach ($alteredLinks as $link) {
1220 $history->updateLink($link);
1222 $delete = empty($_POST['totag']);
1223 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1224 $count = count($alteredLinks);
1226 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1227 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1228 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1232 // -------- User wants to add a link without using the bookmarklet: Show form.
1233 if ($targetPage == Router
::$PAGE_ADDLINK)
1235 $PAGE->renderPage('addlink');
1239 // -------- User clicked the "Save" button when editing a link: Save link to database.
1240 if (isset($_POST['save_edit']))
1243 if (! $sessionManager->checkToken($_POST['token'])) {
1244 die(t('Wrong token.'));
1247 // lf_id should only be present if the link exists.
1248 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1249 // Linkdate is kept here to:
1250 // - use the same permalink for notes as they're displayed when creating them
1251 // - let users hack creation date of their posts
1252 // See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare
1253 $linkdate = escape($_POST['lf_linkdate']);
1254 if (isset($LINKSDB[$id])) {
1256 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1257 $updated = new DateTime();
1258 $shortUrl = $LINKSDB[$id]['shorturl'];
1262 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1264 $shortUrl = link_small_hash($created, $id);
1268 // Remove multiple spaces.
1269 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1270 // Remove first '-' char in tags.
1271 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1272 // Remove duplicates.
1273 $tags = implode(' ', array_unique(explode(' ', $tags)));
1275 if (empty(trim($_POST['lf_url
']))) {
1276 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1278 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1282 'title
' => trim($_POST['lf_title
']),
1284 'description
' => $_POST['lf_description
'],
1285 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1286 'created
' => $created,
1287 'updated
' => $updated,
1288 'tags
' => str_replace(',', ' ', $tags),
1289 'shorturl
' => $shortUrl,
1292 // If title is empty, use the URL as title.
1293 if ($link['title
'] == '') {
1294 $link['title
'] = $link['url
'];
1297 $pluginManager->executeHooks('save_link
', $link);
1299 $LINKSDB[$id] = $link;
1300 $LINKSDB->save($conf->get('resource.page_cache
'));
1302 $history->addLink($link);
1304 $history->updateLink($link);
1307 // If we are called from the bookmarklet, we must close the popup:
1308 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1309 echo '<script
>self
.close();</script
>';
1313 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1314 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1315 // Scroll to the link which has been edited.
1316 $location .= '#' . $link['shorturl'];
1317 // After saving the link, redirect to the page the user was on.
1318 header('Location: '. $location);
1322 // -------- User clicked the "Cancel" button when editing a link.
1323 if (isset($_POST['cancel_edit']))
1325 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1326 if (! isset($LINKSDB[$id])) {
1327 header('Location: ?');
1329 // If we are called from the bookmarklet, we must close the popup:
1330 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1331 $link = $LINKSDB[$id];
1332 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1333 // Scroll to the link which has been edited.
1334 $returnurl .= '#'. $link['shorturl'];
1335 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1336 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1340 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1341 if ($targetPage == Router
::$PAGE_DELETELINK)
1343 if (! $sessionManager->checkToken($_GET['token'])) {
1344 die(t('Wrong token.'));
1347 $ids = trim($_GET['lf_linkdate']);
1348 if (strpos($ids, ' ') !== false) {
1349 // multiple, space-separated ids provided
1350 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1352 // only a single id provided
1355 // assert at least one id is given
1357 die('no id provided');
1359 foreach ($ids as $id) {
1360 $id = (int) escape($id);
1361 $link = $LINKSDB[$id];
1362 $pluginManager->executeHooks('delete_link', $link);
1363 unset($LINKSDB[$id]);
1365 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1366 $history->deleteLink($link);
1368 // If we are called from the bookmarklet, we must close the popup:
1369 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1372 if (isset($_SERVER['HTTP_REFERER'])) {
1373 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1374 $location = generateLocation(
1375 $_SERVER['HTTP_REFERER'],
1376 $_SERVER['HTTP_HOST'],
1377 ['delete_link', 'edit_link', $link['shorturl']]
1381 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1385 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1386 if (isset($_GET['edit_link']))
1388 $id = (int) escape($_GET['edit_link']);
1389 $link = $LINKSDB[$id]; // Read database
1390 if (!$link) { header('Location: ?'); exit; } // Link not found in database.
1391 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1394 'link_is_new' => false,
1395 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1396 'tags' => $LINKSDB->linksCountPerTag(),
1398 $pluginManager->executeHooks('render_editlink', $data);
1400 foreach ($data as $key => $value) {
1401 $PAGE->assign($key, $value);
1404 $PAGE->renderPage('editlink');
1408 // -------- User want to post a new link: Display link edit form.
1409 if (isset($_GET['post'])) {
1410 $url = cleanup_url($_GET['post']);
1412 $link_is_new = false;
1413 // Check if URL is not already in database (in this case, we will edit the existing link)
1414 $link = $LINKSDB->getLinkFromUrl($url);
1417 $link_is_new = true;
1418 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1419 // Get title if it was provided in URL (by the bookmarklet).
1420 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1421 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1422 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1423 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1424 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1425 // 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.)
1426 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1427 // Short timeout to keep the application responsive
1428 list($headers, $content) = get_http_response($url, 4);
1429 if (strpos($headers[0], '200 OK') !== false) {
1430 // Retrieve charset.
1431 $charset = get_charset($headers, $content);
1433 $title = html_extract_title($content);
1434 // Re-encode title in utf-8 if necessary.
1435 if (! empty($title) && strtolower($charset) != 'utf-8') {
1436 $title = mb_convert_encoding($title, 'utf-8', $charset);
1442 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1443 $title = $conf->get('general.default_note_title', t('Note: '));
1445 $url = escape($url);
1446 $title = escape($title);
1449 'linkdate' => $linkdate,
1452 'description' => $description,
1454 'private' => $private,
1457 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1462 'link_is_new' => $link_is_new,
1463 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1464 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1465 'tags' => $LINKSDB->linksCountPerTag(),
1466 'default_private_links' => $conf->get('privacy.default_private_links', false),
1468 $pluginManager->executeHooks('render_editlink', $data);
1470 foreach ($data as $key => $value) {
1471 $PAGE->assign($key, $value);
1474 $PAGE->renderPage('editlink');
1478 if ($targetPage == Router
::$PAGE_EXPORT) {
1479 // Export links as a Netscape Bookmarks file
1481 if (empty($_GET['selection'])) {
1482 $PAGE->renderPage('export');
1486 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1487 $selection = $_GET['selection'];
1488 if (isset($_GET['prepend_note_url'])) {
1489 $prependNoteUrl = $_GET['prepend_note_url'];
1491 $prependNoteUrl = false;
1497 NetscapeBookmarkUtils
::filterAndFormat(
1504 } catch (Exception
$exc) {
1505 header('Content-Type: text/plain; charset=utf-8');
1506 echo $exc->getMessage();
1509 $now = new DateTime();
1510 header('Content-Type: text/html; charset=utf-8');
1512 'Content-disposition: attachment; filename=bookmarks_'
1513 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1515 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1516 $PAGE->assign('eol', PHP_EOL
);
1517 $PAGE->assign('selection', $selection);
1518 $PAGE->renderPage('export.bookmarks');
1522 if ($targetPage == Router
::$PAGE_IMPORT) {
1523 // Upload a Netscape bookmark dump to import its contents
1525 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1526 // Show import dialog
1529 get_max_upload_size(
1530 ini_get('post_max_size'),
1531 ini_get('upload_max_filesize'),
1537 get_max_upload_size(
1538 ini_get('post_max_size'),
1539 ini_get('upload_max_filesize'),
1543 $PAGE->renderPage('import');
1547 // Import bookmarks from an uploaded file
1548 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1549 // The file is too big or some form field may be missing.
1552 'The file you are trying to upload is probably bigger than what this webserver can accept'
1553 .' (%s). Please upload in smaller chunks.'
1555 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1557 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1560 if (! $sessionManager->checkToken($_POST['token'])) {
1561 die('Wrong token.');
1563 $status = NetscapeBookmarkUtils
::import(
1570 echo '<script>alert("'.$status.'");document.location=\'?do='
1571 .Router
::$PAGE_IMPORT .'\';</script>';
1575 // Plugin administration page
1576 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1577 $pluginMeta = $pluginManager->getPluginsMeta();
1579 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1580 $enabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] !== false; });
1582 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1585 function($a, $b) { return $a
['order'] - $b
['order']; }
1587 $disabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] === false; });
1589 $PAGE->assign('enabledPlugins', $enabledPlugins);
1590 $PAGE->assign('disabledPlugins', $disabledPlugins);
1591 $PAGE->renderPage('pluginsadmin');
1595 // Plugin administration form action
1596 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1598 if (isset($_POST['parameters_form'])) {
1599 unset($_POST['parameters_form']);
1600 foreach ($_POST as $param => $value) {
1601 $conf->set('plugins.'. $param, escape($value));
1605 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1607 $conf->write(isLoggedIn());
1608 $history->updateSettings();
1610 catch (Exception
$e) {
1612 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1616 // TODO: do not handle exceptions/errors in JS.
1617 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do='. Router
::$PAGE_PLUGINSADMIN .'\';</script>';
1620 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1624 // Get a fresh token
1625 if ($targetPage == Router
::$GET_TOKEN) {
1626 header('Content-Type:text/plain');
1627 echo $sessionManager->generateToken($conf);
1631 // -------- Otherwise, simply display search form and links:
1632 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1637 * Template for the list of links (<div id="linklist">)
1638 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1640 * @param pageBuilder $PAGE pageBuilder instance.
1641 * @param LinkDB $LINKSDB LinkDB instance.
1642 * @param ConfigManager $conf Configuration Manager instance.
1643 * @param PluginManager $pluginManager Plugin Manager instance.
1645 function buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager)
1647 // Used in templates
1648 if (isset($_GET['searchtags'])) {
1649 if (! empty($_GET['searchtags'])) {
1650 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1652 $searchtags = false;
1657 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1660 if (! empty($_SERVER['QUERY_STRING'])
1661 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1663 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1664 } catch (LinkNotFoundException
$e) {
1665 $PAGE->render404($e->getMessage());
1669 // Filter links according search parameters.
1670 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
1672 'searchtags' => $searchtags,
1673 'searchterm' => $searchterm,
1675 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1678 // ---- Handle paging.
1680 foreach ($linksToDisplay as $key => $value) {
1686 // Select articles according to paging.
1687 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1688 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1689 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1690 $page = $page < 1 ? 1 : $page;
1691 $page = $page > $pagecount ? $pagecount : $page;
1693 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1694 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1695 $linkDisp = array();
1696 while ($i<$end && $i<count($keys))
1698 $link = $linksToDisplay[$keys[$i]];
1699 $link['description'] = format_description(
1700 $link['description'],
1701 $conf->get('redirector.url'),
1702 $conf->get('redirector.encode_url')
1704 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1705 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1706 $link['timestamp'] = $link['created']->getTimestamp();
1707 if (! empty($link['updated'])) {
1708 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1710 $link['updated_timestamp'] = '';
1712 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1713 uasort($taglist, 'strcasecmp');
1714 $link['taglist'] = $taglist;
1715 // Check for both signs of a note: starting with ? and 7 chars long.
1716 if ($link['url'][0] === '?' &&
1717 strlen($link['url']) === 7) {
1718 $link['url'] = index_url($_SERVER) . $link['url'];
1721 $linkDisp[$keys[$i]] = $link;
1725 // Compute paging navigation
1726 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1727 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1728 $previous_page_url = '';
1729 if ($i != count($keys)) {
1730 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1734 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1737 // Fill all template fields.
1739 'previous_page_url' => $previous_page_url,
1740 'next_page_url' => $next_page_url,
1741 'page_current' => $page,
1742 'page_max' => $pagecount,
1743 'result_count' => count($linksToDisplay),
1744 'search_term' => $searchterm,
1745 'search_tags' => $searchtags,
1746 'visibility' => ! empty($_SESSION['privateonly']) ? 'private' : '',
1747 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1748 'links' => $linkDisp,
1751 // If there is only a single link, we change on-the-fly the title of the page.
1752 if (count($linksToDisplay) == 1) {
1753 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1756 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => isLoggedIn()));
1758 foreach ($data as $key => $value) {
1759 $PAGE->assign($key, $value);
1766 * Compute the thumbnail for a link.
1768 * With a link to the original URL.
1769 * Understands various services (youtube.com...)
1770 * Input: $url = URL for which the thumbnail must be found.
1771 * $href = if provided, this URL will be followed instead of $url
1772 * Returns an associative array with thumbnail attributes (src,href,width,height,style,alt)
1773 * Some of them may be missing.
1774 * Return an empty array if no thumbnail available.
1776 * @param ConfigManager $conf Configuration Manager instance.
1777 * @param string $url
1778 * @param string|bool $href
1782 function computeThumbnail($conf, $url, $href = false)
1784 if (!$conf->get('thumbnail.enable_thumbnails')) return array();
1785 if ($href==false) $href=$url;
1787 // For most hosts, the URL of the thumbnail can be easily deduced from the URL of the link.
1788 // (e.g. http://www.youtube.com/watch?v=spVypYk4kto ---> http://img.youtube.com/vi/spVypYk4kto/default.jpg )
1789 // ^^^^^^^^^^^ ^^^^^^^^^^^
1790 $domain = parse_url($url,PHP_URL_HOST
);
1791 if ($domain=='youtube.com' || $domain=='www.youtube.com')
1793 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract video ID and get thumbnail
1794 if (!empty($params['v'])) return array('src'=>'https://img.youtube.com/vi/'.$params['v'].'/default.jpg',
1795 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1797 if ($domain=='youtu.be') // Youtube short links
1799 $path = parse_url($url,PHP_URL_PATH
);
1800 return array('src'=>'https://img.youtube.com/vi'.$path.'/default.jpg',
1801 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1803 if ($domain=='pix.toile-libre.org') // pix.toile-libre.org image hosting
1805 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract image filename.
1806 if (!empty($params) && !empty($params['img'])) return array('src'=>'http://pix.toile-libre.org/upload/thumb/'.urlencode($params['img']),
1807 'href'=>$href,'style'=>'max-width:120px; max-height:150px','alt'=>'pix.toile-libre.org thumbnail');
1810 if ($domain=='imgur.com')
1812 $path = parse_url($url,PHP_URL_PATH
);
1813 if (startsWith($path,'/a/')) return array(); // Thumbnails for albums are not available.
1814 if (startsWith($path,'/r/')) return array('src'=>'https://i.imgur.com/'.basename($path).'s.jpg',
1815 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1816 if (startsWith($path,'/gallery/')) return array('src'=>'https://i.imgur.com'.substr($path,8).'s.jpg',
1817 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1819 if (substr_count($path,'/')==1) return array('src'=>'https://i.imgur.com/'.substr($path,1).'s.jpg',
1820 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1822 if ($domain=='i.imgur.com')
1824 $pi = pathinfo(parse_url($url,PHP_URL_PATH
));
1825 if (!empty($pi['filename'])) return array('src'=>'https://i.imgur.com/'.$pi['filename'].'s.jpg',
1826 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1828 if ($domain=='dailymotion.com' || $domain=='www.dailymotion.com')
1830 if (strpos($url,'dailymotion.com/video/')!==false)
1832 $thumburl=str_replace('dailymotion.com/video/','dailymotion.com/thumbnail/video/',$url);
1833 return array('src'=>$thumburl,
1834 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'DailyMotion thumbnail');
1837 if (endsWith($domain,'.imageshack.us'))
1839 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1840 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1842 $thumburl = substr($url,0,strlen($url)-strlen($ext)).'th.'.$ext;
1843 return array('src'=>$thumburl,
1844 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'imageshack.us thumbnail');
1848 // Some other hosts are SLOW AS HELL and usually require an extra HTTP request to get the thumbnail URL.
1849 // So we deport the thumbnail generation in order not to slow down page generation
1850 // (and we also cache the thumbnail)
1852 if (! $conf->get('thumbnail.enable_localcache')) return array(); // If local cache is disabled, no thumbnails for services which require the use a local cache.
1854 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com')
1855 || $domain=='vimeo.com'
1856 || $domain=='ted.com' || endsWith($domain,'.ted.com')
1857 || $domain=='xkcd.com' || endsWith($domain,'.xkcd.com')
1860 if ($domain=='vimeo.com')
1861 { // Make sure this vimeo URL points to a video (/xxx... where xxx is numeric)
1862 $path = parse_url($url,PHP_URL_PATH
);
1863 if (!preg_match('!/\d+.+?!',$path)) return array(); // This is not a single video URL.
1865 if ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
1866 { // Make sure this URL points to a single comic (/xxx... where xxx is numeric)
1867 $path = parse_url($url,PHP_URL_PATH
);
1868 if (!preg_match('!/\d+.+?!',$path)) return array();
1870 if ($domain=='ted.com' || endsWith($domain,'.ted.com'))
1871 { // Make sure this TED URL points to a video (/talks/...)
1872 $path = parse_url($url,PHP_URL_PATH
);
1873 if ("/talks/" !== substr($path,0,7)) return array(); // This is not a single video URL.
1875 $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)
1876 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1877 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1880 // For all other, we try to make a thumbnail of links ending with .jpg/jpeg/png/gif
1881 // Technically speaking, we should download ALL links and check their Content-Type to see if they are images.
1882 // But using the extension will do.
1883 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1884 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1886 $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)
1887 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1888 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1890 return array(); // No thumbnail.
1895 // Returns the HTML code to display a thumbnail for a link
1896 // with a link to the original URL.
1897 // Understands various services (youtube.com...)
1898 // Input: $url = URL for which the thumbnail must be found.
1899 // $href = if provided, this URL will be followed instead of $url
1900 // Returns '' if no thumbnail available.
1901 function thumbnail($url,$href=false)
1905 $t = computeThumbnail($conf, $url,$href);
1906 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1908 $html='<a href="'.escape($t['href']).'"><img src="'.escape($t['src']).'"';
1909 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1910 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1911 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1912 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1917 // Returns the HTML code to display a thumbnail for a link
1918 // for the picture wall (using lazy image loading)
1919 // Understands various services (youtube.com...)
1920 // Input: $url = URL for which the thumbnail must be found.
1921 // $href = if provided, this URL will be followed instead of $url
1922 // Returns '' if no thumbnail available.
1923 function lazyThumbnail($conf, $url,$href=false)
1927 $t = computeThumbnail($conf, $url,$href);
1928 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1930 $html='<a href="'.escape($t['href']).'">';
1933 $html.='<img class="b-lazy" src="#" data-src="'.escape($t['src']).'"';
1935 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1936 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1937 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1938 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1941 // No-JavaScript fallback.
1942 $html.='<noscript><img src="'.escape($t['src']).'"';
1943 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1944 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1945 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1946 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1947 $html.='></noscript></a>';
1955 * This function should NEVER be called if the file data/config.php exists.
1957 * @param ConfigManager $conf Configuration Manager instance.
1958 * @param SessionManager $sessionManager SessionManager instance
1960 function install($conf, $sessionManager) {
1961 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1962 if (endsWith($_SERVER['HTTP_HOST'],'.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions',0705);
1965 // This part makes sure sessions works correctly.
1966 // (Because on some hosts, session.save_path may not be set correctly,
1967 // or we may not have write access to it.)
1968 if (isset($_GET['test_session']) && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working'))
1970 // Step 2: Check if data in session is correct.
1972 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1973 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1974 'and that you have write access to it.<br>'.
1975 'It currently points to %s.<br>'.
1976 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1977 'or any custom hostname without a dot causes cookie storage to fail. '.
1978 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1980 $msg = sprintf($msg, session_save_path());
1982 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1985 if (!isset($_SESSION['session_tested']))
1986 { // Step 1 : Try to store data in session and reload page.
1987 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1988 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1990 if (isset($_GET['test_session']))
1991 { // Step 3: Sessions are OK. Remove test parameter from URL.
1992 header('Location: '.index_url($_SERVER));
1996 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
1999 if (!empty($_POST['continent']) && !empty($_POST['city'])
2000 && isTimeZoneValid($_POST['continent'], $_POST['city'])
2002 $tz = $_POST['continent'].'/'.$_POST['city'];
2004 $conf->set('general.timezone', $tz);
2005 $login = $_POST['setlogin'];
2006 $conf->set('credentials.login', $login);
2007 $salt = sha1(uniqid('', true) .'_'. mt_rand());
2008 $conf->set('credentials.salt', $salt);
2009 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
2010 if (!empty($_POST['title'])) {
2011 $conf->set('general.title', escape($_POST['title']));
2013 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
2015 $conf->set('translation.language', escape($_POST['language']));
2016 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
2017 $conf->set('api.enabled', !empty($_POST['enableApi']));
2020 generate_api_secret(
2021 $conf->get('credentials.login'),
2022 $conf->get('credentials.salt')
2026 // Everything is ok, let's create config file.
2027 $conf->write(isLoggedIn());
2029 catch(Exception
$e) {
2031 'ERROR while writing config file after installation.' . PHP_EOL
.
2035 // TODO: do not handle exceptions/errors in JS.
2036 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
2039 echo '<script>alert("Shaarli is now configured. Please enter your login/password and start shaaring your links!");document.location=\'?do=login\';</script>';
2043 $PAGE = new PageBuilder($conf, null, $sessionManager->generateToken());
2044 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
2045 $PAGE->assign('continents', $continents);
2046 $PAGE->assign('cities', $cities);
2047 $PAGE->assign('languages', Languages
::getAvailableLanguages());
2048 $PAGE->renderPage('install');
2053 * Because some f*cking services like flickr require an extra HTTP request to get the thumbnail URL,
2054 * I have deported the thumbnail URL code generation here, otherwise this would slow down page generation.
2055 * The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail.
2056 * This function is called by passing the URL:
2057 * http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL]
2058 * [URL] is the URL of the link (e.g. a flickr page)
2059 * [HMAC] is the signature for the [URL] (so that these URL cannot be forged).
2060 * The function below will fetch the image from the webservice and store it in the cache.
2062 * @param ConfigManager $conf Configuration Manager instance,
2064 function genThumbnail($conf)
2066 // Make sure the parameters in the URL were generated by us.
2067 $sign = hash_hmac('sha256', $_GET['url'], $conf->get('credentials.salt'));
2068 if ($sign!=$_GET['hmac']) die('Naughty boy!');
2070 $cacheDir = $conf->get('resource.thumbnails_cache', 'cache');
2071 // Let's see if we don't already have the image for this URL in the cache.
2072 $thumbname=hash('sha1',$_GET['url']).'.jpg';
2073 if (is_file($cacheDir .'/'. $thumbname))
2074 { // We have the thumbnail, just serve it:
2075 header('Content-Type: image/jpeg');
2076 echo file_get_contents($cacheDir .'/'. $thumbname);
2079 // We may also serve a blank image (if service did not respond)
2080 $blankname=hash('sha1',$_GET['url']).'.gif';
2081 if (is_file($cacheDir .'/'. $blankname))
2083 header('Content-Type: image/gif');
2084 echo file_get_contents($cacheDir .'/'. $blankname);
2088 // Otherwise, generate the thumbnail.
2089 $url = $_GET['url'];
2090 $domain = parse_url($url,PHP_URL_HOST
);
2092 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com'))
2094 // Crude replacement to handle new flickr domain policy (They prefer www. now)
2095 $url = str_replace('http://flickr.com/','http://www.flickr.com/',$url);
2097 // Is this a link to an image, or to a flickr page ?
2099 if (endsWith(parse_url($url, PHP_URL_PATH
), '.jpg'))
2100 { // This is a direct link to an image. e.g. http://farm1.staticflickr.com/5/5921913_ac83ed27bd_o.jpg
2101 preg_match('!(http://farm\d+\.staticflickr\.com/\d+/\d+_\w+_)\w.jpg!',$url,$matches);
2102 if (!empty($matches[1])) $imageurl=$matches[1].'m.jpg';
2104 else // This is a flickr page (html)
2106 // Get the flickr html page.
2107 list($headers, $content) = get_http_response($url, 20);
2108 if (strpos($headers[0], '200 OK') !== false)
2110 // flickr now nicely provides the URL of the thumbnail in each flickr page.
2111 preg_match('!<link rel=\"image_src\" href=\"(.+?)\"!', $content, $matches);
2112 if (!empty($matches[1])) $imageurl=$matches[1];
2114 // In albums (and some other pages), the link rel="image_src" is not provided,
2115 // but flickr provides:
2116 // <meta property="og:image" content="http://farm4.staticflickr.com/3398/3239339068_25d13535ff_z.jpg" />
2119 preg_match('!<meta property=\"og:image\" content=\"(.+?)\"!', $content, $matches);
2120 if (!empty($matches[1])) $imageurl=$matches[1];
2126 { // Let's download the image.
2127 // Image is 240x120, so 10 seconds to download should be enough.
2128 list($headers, $content) = get_http_response($imageurl, 10);
2129 if (strpos($headers[0], '200 OK') !== false) {
2130 // Save image to cache.
2131 file_put_contents($cacheDir .'/'. $thumbname, $content);
2132 header('Content-Type: image/jpeg');
2139 elseif ($domain=='vimeo.com' )
2141 // This is more complex: we have to perform a HTTP request, then parse the result.
2142 // Maybe we should deport this to JavaScript ? Example: http://stackoverflow.com/questions/1361149/get-img-thumbnails-from-vimeo/4285098#4285098
2143 $vid = substr(parse_url($url,PHP_URL_PATH
),1);
2144 list($headers, $content) = get_http_response('https://vimeo.com/api/v2/video/'.escape($vid).'.php', 5);
2145 if (strpos($headers[0], '200 OK') !== false) {
2146 $t = unserialize($content);
2147 $imageurl = $t[0]['thumbnail_medium'];
2148 // Then we download the image and serve it to our client.
2149 list($headers, $content) = get_http_response($imageurl, 10);
2150 if (strpos($headers[0], '200 OK') !== false) {
2151 // Save image to cache.
2152 file_put_contents($cacheDir .'/'. $thumbname, $content);
2153 header('Content-Type: image/jpeg');
2160 elseif ($domain=='ted.com' || endsWith($domain,'.ted.com'))
2162 // The thumbnail for TED talks is located in the <link rel="image_src" [...]> tag on that page
2163 // http://www.ted.com/talks/mikko_hypponen_fighting_viruses_defending_the_net.html
2164 // <link rel="image_src" href="http://images.ted.com/images/ted/28bced335898ba54d4441809c5b1112ffaf36781_389x292.jpg" />
2165 list($headers, $content) = get_http_response($url, 5);
2166 if (strpos($headers[0], '200 OK') !== false) {
2167 // Extract the link to the thumbnail
2168 preg_match('!link rel="image_src" href="(http://images.ted.com/images/ted/.+_\d+x\d+\.jpg)"!', $content, $matches);
2169 if (!empty($matches[1]))
2170 { // Let's download the image.
2171 $imageurl=$matches[1];
2172 // No control on image size, so wait long enough
2173 list($headers, $content) = get_http_response($imageurl, 20);
2174 if (strpos($headers[0], '200 OK') !== false) {
2175 $filepath = $cacheDir .'/'. $thumbname;
2176 file_put_contents($filepath, $content); // Save image to cache.
2177 if (resizeImage($filepath))
2179 header('Content-Type: image/jpeg');
2180 echo file_get_contents($filepath);
2188 elseif ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
2190 // There is no thumbnail available for xkcd comics, so download the whole image and resize it.
2191 // http://xkcd.com/327/
2192 // <img src="http://imgs.xkcd.com/comics/exploits_of_a_mom.png" title="<BLABLA>" alt="<BLABLA>" />
2193 list($headers, $content) = get_http_response($url, 5);
2194 if (strpos($headers[0], '200 OK') !== false) {
2195 // Extract the link to the thumbnail
2196 preg_match('!<img src="(http://imgs.xkcd.com/comics/.*)" title="[^s]!', $content, $matches);
2197 if (!empty($matches[1]))
2198 { // Let's download the image.
2199 $imageurl=$matches[1];
2200 // No control on image size, so wait long enough
2201 list($headers, $content) = get_http_response($imageurl, 20);
2202 if (strpos($headers[0], '200 OK') !== false) {
2203 $filepath = $cacheDir.'/'.$thumbname;
2204 // Save image to cache.
2205 file_put_contents($filepath, $content);
2206 if (resizeImage($filepath))
2208 header('Content-Type: image/jpeg');
2209 echo file_get_contents($filepath);
2219 // For all other domains, we try to download the image and make a thumbnail.
2220 // We allow 30 seconds max to download (and downloads are limited to 4 Mb)
2221 list($headers, $content) = get_http_response($url, 30);
2222 if (strpos($headers[0], '200 OK') !== false) {
2223 $filepath = $cacheDir .'/'.$thumbname;
2224 // Save image to cache.
2225 file_put_contents($filepath, $content);
2226 if (resizeImage($filepath))
2228 header('Content-Type: image/jpeg');
2229 echo file_get_contents($filepath);
2236 // Otherwise, return an empty image (8x8 transparent gif)
2237 $blankgif = base64_decode('R0lGODlhCAAIAIAAAP///////yH5BAEKAAEALAAAAAAIAAgAAAIHjI+py+1dAAA7');
2238 // Also put something in cache so that this URL is not requested twice.
2239 file_put_contents($cacheDir .'/'. $blankname, $blankgif);
2240 header('Content-Type: image/gif');
2244 // Make a thumbnail of the image (to width: 120 pixels)
2245 // Returns true if success, false otherwise.
2246 function resizeImage($filepath)
2248 if (!function_exists('imagecreatefromjpeg')) return false; // GD not present: no thumbnail possible.
2250 // Trick: some stupid people rename GIF as JPEG... or else.
2251 // So we really try to open each image type whatever the extension is.
2252 $header=file_get_contents($filepath,false,NULL,0,256); // Read first 256 bytes and try to sniff file type.
2254 $i=strpos($header,'GIF8'); if (($i!==false) && ($i==0)) $im = imagecreatefromgif($filepath); // Well this is crude, but it should be enough.
2255 $i=strpos($header,'PNG'); if (($i!==false) && ($i==1)) $im = imagecreatefrompng($filepath);
2256 $i=strpos($header,'JFIF'); if ($i!==false) $im = imagecreatefromjpeg($filepath);
2257 if (!$im) return false; // Unable to open image (corrupted or not an image)
2260 $ystart = 0; $yheight=$h;
2261 if ($h>$w) { $ystart
= ($h
/2)-($w
/2); $yheight
=$w
/2; }
2262 $nw = 120; // Desired width
2263 $nh = min(floor(($h*$nw)/$w),120); // Compute new width/height, but maximum 120 pixels height.
2265 $im2 = imagecreatetruecolor($nw,$nh);
2266 imagecopyresampled($im2, $im, 0, 0, 0, $ystart, $nw, $nh, $w, $yheight);
2267 imageinterlace($im2,true); // For progressive JPEG.
2268 $tempname=$filepath.'_TEMP.jpg';
2269 imagejpeg($im2, $tempname, 90);
2273 rename($tempname,$filepath); // Overwrite original picture with thumbnail.
2277 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=genthumbnail')) { genThumbnail($conf
); exit; } // Thumbnail generation/cache does not need the link database.
2278 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf
); exit; }
2279 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
2280 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
2284 $history = new History($conf->get('resource.history'));
2285 } catch(Exception
$e) {
2286 die($e->getMessage());
2289 $linkDb = new LinkDB(
2290 $conf->get('resource.datastore'),
2292 $conf->get('privacy.hide_public_links'),
2293 $conf->get('redirector.url'),
2294 $conf->get('redirector.encode_url')
2297 $container = new \Slim\
Container();
2298 $container['conf'] = $conf;
2299 $container['plugins'] = $pluginManager;
2300 $container['history'] = $history;
2301 $app = new \Slim\
App($container);
2304 $app->group('/api/v1', function() {
2305 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
2306 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
2307 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
2308 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
2309 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
2310 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
2311 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
2312 })->add('\Shaarli\Api\ApiMiddleware');
2314 $response = $app->run(true);
2315 // Hack to make Slim and Shaarli router work together:
2316 // If a Slim route isn't found and NOT API call, we call renderPage().
2317 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
2318 // We use UTF-8 for proper international characters handling.
2319 header('Content-Type: text/html; charset=utf-8');
2320 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager);
2322 $app->respond($response);