3 * Shaarli - The personal, minimalist, super-fast, database free, bookmarking service.
5 * Friendly fork by the Shaarli community:
6 * - https://github.com/shaarli/Shaarli
8 * Original project by sebsauvage.net:
9 * - http://sebsauvage.net/wiki/doku.php?id=php:shaarli
10 * - https://github.com/sebsauvage/Shaarli
12 * Licence: http://www.opensource.org/licenses/zlib-license.php
17 // Set 'UTC' as the default timezone if it is not defined in php.ini
18 // See http://php.net/manual/en/datetime.configuration.php#ini.date.timezone
19 if (date_default_timezone_get() == '') {
20 date_default_timezone_set('UTC');
27 // http://server.com/x/shaarli --> /shaarli/
28 define('WEB_PATH', substr($_SERVER['REQUEST_URI'], 0, 1+
strrpos($_SERVER['REQUEST_URI'], '/', 0)));
30 // High execution time in case of problematic imports/exports.
31 ini_set('max_input_time','60');
33 // Try to set max upload file size and read
34 ini_set('memory_limit', '128M');
35 ini_set('post_max_size', '16M');
36 ini_set('upload_max_filesize', '16M');
38 // See all error except warnings
39 error_reporting(E_ALL^E_WARNING
);
40 // See all errors (for debugging only)
41 //error_reporting(-1);
44 // 3rd-party libraries
45 if (! file_exists(__DIR__
. '/vendor/autoload.php')) {
46 header('Content-Type: text/plain; charset=utf-8');
47 echo "Error: missing Composer configuration\n\n"
48 ."If you installed Shaarli through Git or using the development branch,\n"
49 ."please refer to the installation documentation to install PHP"
50 ." dependencies using Composer:\n"
51 ."- https://shaarli.readthedocs.io/en/master/Server-requirements/\n"
52 ."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/";
55 require_once 'inc/rain.tpl.class.php';
56 require_once __DIR__
. '/vendor/autoload.php';
59 require_once 'application/ApplicationUtils.php';
60 require_once 'application/Cache.php';
61 require_once 'application/CachedPage.php';
62 require_once 'application/config/ConfigPlugin.php';
63 require_once 'application/FeedBuilder.php';
64 require_once 'application/FileUtils.php';
65 require_once 'application/History.php';
66 require_once 'application/HttpUtils.php';
67 require_once 'application/LinkDB.php';
68 require_once 'application/LinkFilter.php';
69 require_once 'application/LinkUtils.php';
70 require_once 'application/NetscapeBookmarkUtils.php';
71 require_once 'application/PageBuilder.php';
72 require_once 'application/TimeZone.php';
73 require_once 'application/Url.php';
74 require_once 'application/Utils.php';
75 require_once 'application/PluginManager.php';
76 require_once 'application/Router.php';
77 require_once 'application/Updater.php';
78 use \Shaarli\Languages
;
79 use \Shaarli\ThemeUtils
;
80 use \Shaarli\Config\ConfigManager
;
81 use \Shaarli\SessionManager
;
83 // Ensure the PHP version is supported
85 ApplicationUtils
::checkPHPVersion('5.5', PHP_VERSION
);
86 } catch(Exception
$exc) {
87 header('Content-Type: text/plain; charset=utf-8');
88 echo $exc->getMessage();
92 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
94 // Force cookie path (but do not change lifetime)
95 $cookie = session_get_cookie_params();
97 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
98 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
100 // Set default cookie expiration and path.
101 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
102 // Set session parameters on server side.
103 // If the user does not access any page within this time, his/her session is considered expired.
104 define('INACTIVITY_TIMEOUT', 3600); // in seconds.
105 // Use cookies to store session.
106 ini_set('session.use_cookies', 1);
107 // Force cookies for session (phpsessionID forbidden in URL).
108 ini_set('session.use_only_cookies', 1);
109 // Prevent PHP form using sessionID in URL if cookies are disabled.
110 ini_set('session.use_trans_sid', false);
112 session_name('shaarli');
113 // Start session if needed (Some server auto-start sessions).
114 if (session_id() == '') {
118 // Regenerate session ID if invalid or not defined in cookie.
119 if (isset($_COOKIE['shaarli']) && !SessionManager
::checkId($_COOKIE['shaarli'])) {
120 session_regenerate_id(true);
121 $_COOKIE['shaarli'] = session_id();
124 $conf = new ConfigManager();
125 $sessionManager = new SessionManager($_SESSION, $conf);
127 // LC_MESSAGES isn't defined without php-intl, in this case use LC_COLLATE locale instead.
128 if (! defined('LC_MESSAGES')) {
129 define('LC_MESSAGES', LC_COLLATE
);
132 // Sniff browser language and set date format accordingly.
133 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
134 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
137 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
139 $conf->setEmpty('general.timezone', date_default_timezone_get());
140 $conf->setEmpty('general.title', t('Shared links on '). escape(index_url($_SERVER)));
141 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
142 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
144 $pluginManager = new PluginManager($conf);
145 $pluginManager->load($conf->get('general.enabled_plugins'));
147 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
149 ob_start(); // Output buffering for the page cache.
151 // Prevent caching on client side or proxy: (yes, it's ugly)
152 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
153 header("Cache-Control: no-store, no-cache, must-revalidate");
154 header("Cache-Control: post-check=0, pre-check=0", false);
155 header("Pragma: no-cache");
157 if (! is_file($conf->getConfigFileExt())) {
158 // Ensure Shaarli has proper access to its resources
159 $errors = ApplicationUtils
::checkResourcePermissions($conf);
161 if ($errors != array()) {
162 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
164 foreach ($errors as $error) {
165 $message .= '<li>'.$error.'</li>';
169 header('Content-Type: text/html; charset=utf-8');
174 // Display the installation form if no existing config is found
175 install($conf, $sessionManager);
178 // a token depending of deployment salt, user password, and the current ip
179 define('STAY_SIGNED_IN_TOKEN', sha1($conf->get('credentials.hash') . $_SERVER['REMOTE_ADDR'] . $conf->get('credentials.salt')));
182 * Checking session state (i.e. is the user still logged in)
184 * @param ConfigManager $conf The configuration manager.
186 * @return bool: true if the user is logged in, false otherwise.
188 function setup_login_state($conf)
190 if ($conf->get('security.open_shaarli')) {
193 $userIsLoggedIn = false; // By default, we do not consider the user as logged in;
194 $loginFailure = false; // If set to true, every attempt to authenticate the user will fail. This indicates that an important condition isn't met.
195 if (! $conf->exists('credentials.login')) {
196 $userIsLoggedIn = false; // Shaarli is not configured yet.
197 $loginFailure = true;
199 if (isset($_COOKIE['shaarli_staySignedIn']) &&
200 $_COOKIE['shaarli_staySignedIn']===STAY_SIGNED_IN_TOKEN
&&
203 fillSessionInfo($conf);
204 $userIsLoggedIn = true;
206 // If session does not exist on server side, or IP address has changed, or session has expired, logout.
207 if (empty($_SESSION['uid'])
208 || ($conf->get('security.session_protection_disabled') === false && $_SESSION['ip'] != allIPs())
209 || time() >= $_SESSION['expires_on'])
212 $userIsLoggedIn = false;
213 $loginFailure = true;
215 if (!empty($_SESSION['longlastingsession'])) {
216 $_SESSION['expires_on']=time()+
$_SESSION['longlastingsession']; // In case of "Stay signed in" checked.
219 $_SESSION['expires_on']=time()+INACTIVITY_TIMEOUT
; // Standard session expiration date.
221 if (!$loginFailure) {
222 $userIsLoggedIn = true;
225 return $userIsLoggedIn;
227 $userIsLoggedIn = setup_login_state($conf);
229 // ------------------------------------------------------------------------------------------
230 // Session management
232 // Returns the IP address of the client (Used to prevent session cookie hijacking.)
235 $ip = $_SERVER['REMOTE_ADDR'];
236 // Then we use more HTTP headers to prevent session hijacking from users behind the same proxy.
237 if (isset($_SERVER['HTTP_X_FORWARDED_FOR'])) { $ip
=$ip
.'_'.$_SERVER
['HTTP_X_FORWARDED_FOR']; }
238 if (isset($_SERVER['HTTP_CLIENT_IP'])) { $ip
=$ip
.'_'.$_SERVER
['HTTP_CLIENT_IP']; }
245 * @param ConfigManager $conf Configuration Manager instance.
247 function fillSessionInfo($conf)
249 $_SESSION['uid'] = sha1(uniqid('',true).'_'.mt_rand()); // Generate unique random number (different than phpsessionid)
250 $_SESSION['ip']=allIPs(); // We store IP address(es) of the client to make sure session is not hijacked.
251 $_SESSION['username']= $conf->get('credentials.login');
252 $_SESSION['expires_on']=time()+INACTIVITY_TIMEOUT
; // Set session expiration.
256 * Check that user/password is correct.
258 * @param string $login Username
259 * @param string $password User password
260 * @param ConfigManager $conf Configuration Manager instance.
262 * @return bool: authentication successful or not.
264 function check_auth($login, $password, $conf)
266 $hash = sha1($password . $login . $conf->get('credentials.salt'));
267 if ($login == $conf->get('credentials.login') && $hash == $conf->get('credentials.hash'))
268 { // Login/password is correct.
269 fillSessionInfo($conf);
270 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Login successful');
273 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Login failed for user '.$login);
277 // Returns true if the user is logged in.
278 function isLoggedIn()
280 global $userIsLoggedIn;
281 return $userIsLoggedIn;
286 if (isset($_SESSION)) {
287 unset($_SESSION['uid']);
288 unset($_SESSION['ip']);
289 unset($_SESSION['username']);
290 unset($_SESSION['visibility']);
291 unset($_SESSION['untaggedonly']);
293 setcookie('shaarli_staySignedIn', FALSE, 0, WEB_PATH
);
297 // ------------------------------------------------------------------------------------------
298 // Brute force protection system
299 // Several consecutive failed logins will ban the IP address for 30 minutes.
300 if (!is_file($conf->get('resource.ban_file', 'data/ipbans.php'))) {
303 $conf->get('resource.ban_file', 'data/ipbans.php'),
304 "<?php\n\$GLOBALS['IPBANS']=".var_export(array('FAILURES'=>array(),'BANS'=>array()),true).";\n?>"
307 include $conf->get('resource.ban_file', 'data/ipbans.php');
309 * Signal a failed login. Will ban the IP if too many failures:
311 * @param ConfigManager $conf Configuration Manager instance.
313 function ban_loginFailed($conf)
315 $ip = $_SERVER['REMOTE_ADDR'];
316 $trusted = $conf->get('security.trusted_proxies', array());
317 if (in_array($ip, $trusted)) {
318 $ip = getIpAddressFromProxy($_SERVER, $trusted);
323 $gb = $GLOBALS['IPBANS'];
324 if (! isset($gb['FAILURES'][$ip])) {
325 $gb['FAILURES'][$ip]=0;
327 $gb['FAILURES'][$ip]++
;
328 if ($gb['FAILURES'][$ip] > ($conf->get('security.ban_after') - 1))
330 $gb['BANS'][$ip] = time() +
$conf->get('security.ban_after', 1800);
331 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'IP address banned from login');
333 $GLOBALS['IPBANS'] = $gb;
335 $conf->get('resource.ban_file', 'data/ipbans.php'),
336 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
341 * Signals a successful login. Resets failed login counter.
343 * @param ConfigManager $conf Configuration Manager instance.
345 function ban_loginOk($conf)
347 $ip = $_SERVER['REMOTE_ADDR'];
348 $gb = $GLOBALS['IPBANS'];
349 unset($gb['FAILURES'][$ip]); unset($gb['BANS'][$ip]);
350 $GLOBALS['IPBANS'] = $gb;
352 $conf->get('resource.ban_file', 'data/ipbans.php'),
353 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
358 * Checks if the user CAN login. If 'true', the user can try to login.
360 * @param ConfigManager $conf Configuration Manager instance.
362 * @return bool: true if the user is allowed to login.
364 function ban_canLogin($conf)
366 $ip=$_SERVER["REMOTE_ADDR"]; $gb=$GLOBALS['IPBANS'];
367 if (isset($gb['BANS'][$ip]))
369 // User is banned. Check if the ban has expired:
370 if ($gb['BANS'][$ip]<=time())
371 { // Ban expired, user can try to login again.
372 logm($conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], 'Ban lifted.');
373 unset($gb['FAILURES'][$ip]); unset($gb['BANS'][$ip]);
375 $conf->get('resource.ban_file', 'data/ipbans.php'),
376 "<?php\n\$GLOBALS['IPBANS']=".var_export($gb,true).";\n?>"
378 return true; // Ban has expired, user can login.
380 return false; // User is banned.
382 return true; // User is not banned.
385 // ------------------------------------------------------------------------------------------
386 // Process login form: Check if login/password is correct.
387 if (isset($_POST['login']))
389 if (!ban_canLogin($conf)) die(t('I said: NO. You are banned for the moment. Go away.'));
390 if (isset($_POST['password'])
391 && $sessionManager->checkToken($_POST['token'])
392 && (check_auth($_POST['login'], $_POST['password'], $conf))
393 ) { // Login/password is OK.
395 // If user wants to keep the session cookie even after the browser closes:
396 if (!empty($_POST['longlastingsession']))
398 $_SESSION['longlastingsession'] = 31536000; // (31536000 seconds = 1 year)
399 $expiration = time() +
$_SESSION['longlastingsession']; // calculate relative cookie expiration (1 year from now)
400 setcookie('shaarli_staySignedIn', STAY_SIGNED_IN_TOKEN
, $expiration, WEB_PATH
);
401 $_SESSION['expires_on'] = $expiration; // Set session expiration on server-side.
403 $cookiedir = ''; if(dirname($_SERVER['SCRIPT_NAME'])!='/') $cookiedir=dirname($_SERVER["SCRIPT_NAME"]).'/';
404 session_set_cookie_params($_SESSION['longlastingsession'],$cookiedir,$_SERVER['SERVER_NAME']); // Set session cookie expiration on client side
405 // Note: Never forget the trailing slash on the cookie path!
406 session_regenerate_id(true); // Send cookie with new expiration date to browser.
408 else // Standard session expiration (=when browser closes)
410 $cookiedir = ''; if(dirname($_SERVER['SCRIPT_NAME'])!='/') $cookiedir=dirname($_SERVER["SCRIPT_NAME"]).'/';
411 session_set_cookie_params(0,$cookiedir,$_SERVER['SERVER_NAME']); // 0 means "When browser closes"
412 session_regenerate_id(true);
415 // Optional redirect after login:
416 if (isset($_GET['post'])) {
417 $uri = '?post='. urlencode($_GET['post']);
418 foreach (array('description', 'source', 'title', 'tags') as $param) {
419 if (!empty($_GET[$param])) {
420 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
423 header('Location: '. $uri);
427 if (isset($_GET['edit_link'])) {
428 header('Location: ?edit_link='. escape($_GET['edit_link']));
432 if (isset($_POST['returnurl'])) {
433 // Prevent loops over login screen.
434 if (strpos($_POST['returnurl'], 'do=login') === false) {
435 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
439 header('Location: ?'); exit;
443 ban_loginFailed($conf);
444 $redir = '&username='. urlencode($_POST['login']);
445 if (isset($_GET['post'])) {
446 $redir .= '&post=' . urlencode($_GET['post']);
447 foreach (array('description', 'source', 'title', 'tags') as $param) {
448 if (!empty($_GET[$param])) {
449 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
453 // Redirect to login screen.
454 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
459 // ------------------------------------------------------------------------------------------
460 // Token management for XSRF protection
461 // Token should be used in any form which acts on data (create,update,delete,import...).
462 if (!isset($_SESSION['tokens'])) $_SESSION['tokens']=array(); // Token are attached to the session.
465 * Daily RSS feed: 1 RSS entry per day giving all the links on that day.
466 * Gives the last 7 days (which have links).
467 * This RSS feed cannot be filtered.
469 * @param ConfigManager $conf Configuration Manager instance.
471 function showDailyRSS($conf) {
473 $query = $_SERVER['QUERY_STRING'];
474 $cache = new CachedPage(
475 $conf->get('config.PAGE_CACHE'),
477 startsWith($query,'do=dailyrss') && !isLoggedIn()
479 $cached = $cache->cachedVersion();
480 if (!empty($cached)) {
485 // If cached was not found (or not usable), then read the database and build the response:
486 // Read links from database (and filter private links if used it not logged in).
487 $LINKSDB = new LinkDB(
488 $conf->get('resource.datastore'),
490 $conf->get('privacy.hide_public_links'),
491 $conf->get('redirector.url'),
492 $conf->get('redirector.encode_url')
495 /* Some Shaarlies may have very few links, so we need to look
496 back in time until we have enough days ($nb_of_days).
498 $nb_of_days = 7; // We take 7 days.
499 $today = date('Ymd');
502 foreach ($LINKSDB as $link) {
503 $day = $link['created']->format('Ymd'); // Extract day (without time)
504 if (strcmp($day, $today) < 0) {
505 if (empty($days[$day])) {
506 $days[$day] = array();
508 $days[$day][] = $link;
511 if (count($days) > $nb_of_days) {
512 break; // Have we collected enough days?
516 // Build the RSS feed.
517 header('Content-Type: application/rss+xml; charset=utf-8');
518 $pageaddr = escape(index_url($_SERVER));
519 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
521 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
522 echo '<link>'. $pageaddr .'</link>';
523 echo '<description>Daily shared links</description>';
524 echo '<language>en-en</language>';
525 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
528 foreach ($days as $day => $links) {
529 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
530 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
532 // We pre-format some fields for proper output.
533 foreach ($links as &$link) {
534 $link['formatedDescription'] = format_description(
535 $link['description'],
536 $conf->get('redirector.url'),
537 $conf->get('redirector.encode_url')
539 $link['thumbnail'] = thumbnail($conf, $link['url']);
540 $link['timestamp'] = $link['created']->getTimestamp();
541 if (startsWith($link['url'], '?')) {
542 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
546 // Then build the HTML for this day:
548 $tpl->assign('title', $conf->get('general.title'));
549 $tpl->assign('daydate', $dayDate->getTimestamp());
550 $tpl->assign('absurl', $absurl);
551 $tpl->assign('links', $links);
552 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
553 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
554 $html = $tpl->draw('dailyrss', true);
556 echo $html . PHP_EOL
;
558 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
560 $cache->cache(ob_get_contents());
566 * Show the 'Daily' page.
568 * @param PageBuilder $pageBuilder Template engine wrapper.
569 * @param LinkDB $LINKSDB LinkDB instance.
570 * @param ConfigManager $conf Configuration Manager instance.
571 * @param PluginManager $pluginManager Plugin Manager instane.
573 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager)
575 $day = date('Ymd', strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
576 if (isset($_GET['day'])) {
580 $days = $LINKSDB->days();
581 $i = array_search($day, $days);
582 if ($i === false && count($days)) {
583 // no links for day, but at least one day with links
584 $i = count($days) - 1;
592 $previousday=$days[$i - 1];
594 if ($i < count($days) - 1) {
595 $nextday = $days[$i +
1];
599 $linksToDisplay = $LINKSDB->filterDay($day);
600 } catch (Exception
$exc) {
602 $linksToDisplay = array();
605 // We pre-format some fields for proper output.
606 foreach($linksToDisplay as $key => $link) {
607 $taglist = explode(' ',$link['tags']);
608 uasort($taglist, 'strcasecmp');
609 $linksToDisplay[$key]['taglist']=$taglist;
610 $linksToDisplay[$key]['formatedDescription'] = format_description(
611 $link['description'],
612 $conf->get('redirector.url'),
613 $conf->get('redirector.encode_url')
615 $linksToDisplay[$key]['thumbnail'] = thumbnail($conf, $link['url']);
616 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
619 /* We need to spread the articles on 3 columns.
620 I did not want to use a JavaScript lib like http://masonry.desandro.com/
621 so I manually spread entries with a simple method: I roughly evaluate the
622 height of a div according to title and description length.
624 $columns = array(array(), array(), array()); // Entries to display, for each column.
625 $fill = array(0, 0, 0); // Rough estimate of columns fill.
626 foreach($linksToDisplay as $key => $link) {
627 // Roughly estimate length of entry (by counting characters)
628 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
629 // Description: 836 characters gives roughly 342 pixel height.
630 // This is not perfect, but it's usually OK.
631 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
632 if ($link['thumbnail']) {
633 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
635 // Then put in column which is the less filled:
636 $smallest = min($fill); // find smallest value in array.
637 $index = array_search($smallest, $fill); // find index of this smallest value.
638 array_push($columns[$index], $link); // Put entry in this column.
639 $fill[$index] +
= $length;
642 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
644 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
645 'linksToDisplay' => $linksToDisplay,
647 'day' => $dayDate->getTimestamp(),
648 'dayDate' => $dayDate,
649 'previousday' => $previousday,
650 'nextday' => $nextday,
653 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => isLoggedIn()));
655 foreach ($data as $key => $value) {
656 $pageBuilder->assign($key, $value);
659 $pageBuilder->renderPage('daily');
664 * Renders the linklist
666 * @param pageBuilder $PAGE pageBuilder instance.
667 * @param LinkDB $LINKSDB LinkDB instance.
668 * @param ConfigManager $conf Configuration Manager instance.
669 * @param PluginManager $pluginManager Plugin Manager instance.
671 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager) {
672 buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager); // Compute list of links to display
673 $PAGE->renderPage('linklist');
677 * Render HTML page (according to URL parameters and user rights)
679 * @param ConfigManager $conf Configuration Manager instance.
680 * @param PluginManager $pluginManager Plugin Manager instance,
681 * @param LinkDB $LINKSDB
682 * @param History $history instance
683 * @param SessionManager $sessionManager SessionManager instance
685 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager)
687 $updater = new Updater(
688 read_updates_file($conf->get('resource.updates')),
694 $newUpdates = $updater->update();
695 if (! empty($newUpdates)) {
697 $conf->get('resource.updates'),
698 $updater->getDoneUpdates()
702 catch(Exception
$e) {
703 die($e->getMessage());
706 $PAGE = new PageBuilder($conf, $LINKSDB, $sessionManager->generateToken());
707 $PAGE->assign('linkcount', count($LINKSDB));
708 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
709 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
711 // Determine which page will be rendered.
712 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
713 $targetPage = Router
::findPage($query, $_GET, isLoggedIn());
716 // if the user isn't logged in
718 // and Shaarli doesn't have public content...
719 $conf->get('privacy.hide_public_links') &&
720 // and is configured to enforce the login
721 $conf->get('privacy.force_login') &&
722 // and the current page isn't already the login page
723 $targetPage !== Router
::$PAGE_LOGIN &&
724 // and the user is not requesting a feed (which would lead to a different content-type as expected)
725 $targetPage !== Router
::$PAGE_FEED_ATOM &&
726 $targetPage !== Router
::$PAGE_FEED_RSS
728 // force current page to be the login page
729 $targetPage = Router
::$PAGE_LOGIN;
732 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
733 // Then assign generated data to RainTPL.
734 $common_hooks = array(
740 foreach($common_hooks as $name) {
741 $plugin_data = array();
742 $pluginManager->executeHooks('render_' . $name, $plugin_data,
744 'target' => $targetPage,
745 'loggedin' => isLoggedIn()
748 $PAGE->assign('plugins_' . $name, $plugin_data);
751 // -------- Display login form.
752 if ($targetPage == Router
::$PAGE_LOGIN)
754 if ($conf->get('security.open_shaarli')) { header('Location: ?'); exit; } // No need to login for open Shaarli
755 if (isset($_GET['username'])) {
756 $PAGE->assign('username', escape($_GET['username']));
758 $PAGE->assign('returnurl',(isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
759 // add default state of the 'remember me' checkbox
760 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
761 $PAGE->renderPage('loginform');
764 // -------- User wants to logout.
765 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout'))
767 invalidateCaches($conf->get('resource.page_cache'));
769 header('Location: ?');
773 // -------- Picture wall
774 if ($targetPage == Router
::$PAGE_PICWALL)
776 // Optionally filter the results:
777 $links = $LINKSDB->filterSearch($_GET);
778 $linksToDisplay = array();
780 // Get only links which have a thumbnail.
781 foreach($links as $link)
783 $permalink='?'.$link['shorturl'];
784 $thumb=lazyThumbnail($conf, $link['url'],$permalink);
785 if ($thumb!='') // Only output links which have a thumbnail.
787 $link['thumbnail']=$thumb; // Thumbnail HTML code.
788 $linksToDisplay[]=$link; // Add to array.
793 'linksToDisplay' => $linksToDisplay,
795 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => isLoggedIn()));
797 foreach ($data as $key => $value) {
798 $PAGE->assign($key, $value);
801 $PAGE->renderPage('picwall');
805 // -------- Tag cloud
806 if ($targetPage == Router
::$PAGE_TAGCLOUD)
808 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
809 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
810 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
812 // We sort tags alphabetically, then choose a font size according to count.
813 // First, find max value.
815 foreach ($tags as $value) {
816 $maxcount = max($maxcount, $value);
819 alphabetical_sort($tags, false, true);
822 foreach($tags as $key => $value) {
823 if (in_array($key, $filteringTags)) {
826 // Tag font size scaling:
827 // default 15 and 30 logarithm bases affect scaling,
828 // 22 and 6 are arbitrary font sizes for max and min sizes.
829 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
830 $tagList[$key] = array(
832 'size' => number_format($size, 2, '.', ''),
837 'search_tags' => implode(' ', escape($filteringTags)),
840 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => isLoggedIn()));
842 foreach ($data as $key => $value) {
843 $PAGE->assign($key, $value);
846 $PAGE->renderPage('tag.cloud');
851 if ($targetPage == Router
::$PAGE_TAGLIST)
853 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
854 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
855 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
856 foreach ($filteringTags as $tag) {
857 if (array_key_exists($tag, $tags)) {
862 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
863 alphabetical_sort($tags, false, true);
867 'search_tags' => implode(' ', escape($filteringTags)),
870 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => isLoggedIn()]);
872 foreach ($data as $key => $value) {
873 $PAGE->assign($key, $value);
876 $PAGE->renderPage('tag.list');
881 if ($targetPage == Router
::$PAGE_DAILY) {
882 showDaily($PAGE, $LINKSDB, $conf, $pluginManager);
885 // ATOM and RSS feed.
886 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
887 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
888 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
891 $query = $_SERVER['QUERY_STRING'];
892 $cache = new CachedPage(
893 $conf->get('resource.page_cache'),
895 startsWith($query,'do='. $targetPage) && !isLoggedIn()
897 $cached = $cache->cachedVersion();
898 if (!empty($cached)) {
904 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, isLoggedIn());
905 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
906 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !isLoggedIn());
907 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
908 $data = $feedGenerator->buildData();
910 // Process plugin hook.
911 $pluginManager->executeHooks('render_feed', $data, array(
912 'loggedin' => isLoggedIn(),
913 'target' => $targetPage,
916 // Render the template.
917 $PAGE->assignAll($data);
918 $PAGE->renderPage('feed.'. $feedType);
919 $cache->cache(ob_get_contents());
924 // Display opensearch plugin (XML)
925 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
926 header('Content-Type: application/xml; charset=utf-8');
927 $PAGE->assign('serverurl', index_url($_SERVER));
928 $PAGE->renderPage('opensearch');
932 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
933 if (isset($_GET['addtag']))
935 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
936 if (empty($_SERVER['HTTP_REFERER'])) { header('Location: ?searchtags='.urlencode($_GET
['addtag'])); exit; } // In case browser does not send HTTP_REFERER
937 parse_str(parse_url($_SERVER['HTTP_REFERER'],PHP_URL_QUERY
), $params);
939 // Prevent redirection loop
940 if (isset($params['addtag'])) {
941 unset($params['addtag']);
944 // Check if this tag is already in the search query and ignore it if it is.
945 // Each tag is always separated by a space
946 if (isset($params['searchtags'])) {
947 $current_tags = explode(' ', $params['searchtags']);
949 $current_tags = array();
952 foreach ($current_tags as $value) {
953 if ($value === $_GET['addtag']) {
958 // Append the tag if necessary
959 if (empty($params['searchtags'])) {
960 $params['searchtags'] = trim($_GET['addtag']);
963 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
966 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
967 header('Location: ?'.http_build_query($params));
971 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
972 if (isset($_GET['removetag'])) {
973 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
974 if (empty($_SERVER['HTTP_REFERER'])) {
975 header('Location: ?');
979 // In case browser does not send HTTP_REFERER
980 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
982 // Prevent redirection loop
983 if (isset($params['removetag'])) {
984 unset($params['removetag']);
987 if (isset($params['searchtags'])) {
988 $tags = explode(' ', $params['searchtags']);
989 // Remove value from array $tags.
990 $tags = array_diff($tags, array($_GET['removetag']));
991 $params['searchtags'] = implode(' ',$tags);
993 if (empty($params['searchtags'])) {
994 unset($params['searchtags']);
997 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
999 header('Location: ?'.http_build_query($params));
1003 // -------- User wants to change the number of links per page (linksperpage=...)
1004 if (isset($_GET['linksperpage'])) {
1005 if (is_numeric($_GET['linksperpage'])) {
1006 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
1009 if (! empty($_SERVER['HTTP_REFERER'])) {
1010 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
1014 header('Location: '. $location);
1018 // -------- User wants to see only private links (toggle)
1019 if (isset($_GET['visibility'])) {
1020 if ($_GET['visibility'] === 'private') {
1021 // Visibility not set or not already private, set private, otherwise reset it
1022 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
1023 // See only private links
1024 $_SESSION['visibility'] = 'private';
1026 unset($_SESSION['visibility']);
1028 } else if ($_GET['visibility'] === 'public') {
1029 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
1030 // See only public links
1031 $_SESSION['visibility'] = 'public';
1033 unset($_SESSION['visibility']);
1037 if (! empty($_SERVER['HTTP_REFERER'])) {
1038 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
1042 header('Location: '. $location);
1046 // -------- User wants to see only untagged links (toggle)
1047 if (isset($_GET['untaggedonly'])) {
1048 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
1050 if (! empty($_SERVER['HTTP_REFERER'])) {
1051 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
1055 header('Location: '. $location);
1059 // -------- Handle other actions allowed for non-logged in users:
1062 // User tries to post new link but is not logged in:
1063 // Show login screen, then redirect to ?post=...
1064 if (isset($_GET['post']))
1066 header( // Redirect to login page, then back to post link.
1067 'Location: ?do=login&post='.urlencode($_GET['post']).
1068 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
1069 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
1070 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
1071 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
1076 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1077 if (isset($_GET['edit_link'])) {
1078 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
1082 exit; // Never remove this one! All operations below are reserved for logged in user.
1085 // -------- All other functions are reserved for the registered user:
1087 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
1088 if ($targetPage == Router
::$PAGE_TOOLS)
1091 'pageabsaddr' => index_url($_SERVER),
1092 'sslenabled' => is_https($_SERVER),
1094 $pluginManager->executeHooks('render_tools', $data);
1096 foreach ($data as $key => $value) {
1097 $PAGE->assign($key, $value);
1100 $PAGE->renderPage('tools');
1104 // -------- User wants to change his/her password.
1105 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD)
1107 if ($conf->get('security.open_shaarli')) {
1108 die(t('You are not supposed to change a password on an Open Shaarli.'));
1111 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword']))
1113 if (!$sessionManager->checkToken($_POST['token'])) die(t('Wrong token.')); // Go away!
1115 // Make sure old password is correct.
1116 $oldhash = sha1($_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt'));
1117 if ($oldhash!= $conf->get('credentials.hash')) {
1118 echo '<script>alert("'. t('The old password is not correct.') .'");document.location=\'?do=changepasswd\';</script>';
1121 // Save new password
1122 // Salt renders rainbow-tables attacks useless.
1123 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
1124 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $conf->get('credentials.login') . $conf->get('credentials.salt')));
1126 $conf->write(isLoggedIn());
1128 catch(Exception
$e) {
1130 'ERROR while writing config file after changing password.' . PHP_EOL
.
1134 // TODO: do not handle exceptions/errors in JS.
1135 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
1138 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
1141 else // show the change password form.
1143 $PAGE->renderPage('changepassword');
1148 // -------- User wants to change configuration
1149 if ($targetPage == Router
::$PAGE_CONFIGURE)
1151 if (!empty($_POST['title']) )
1153 if (!$sessionManager->checkToken($_POST['token'])) {
1154 die(t('Wrong token.')); // Go away!
1157 if (!empty($_POST['continent']) && !empty($_POST['city'])
1158 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1160 $tz = $_POST['continent'] . '/' . $_POST['city'];
1162 $conf->set('general.timezone', $tz);
1163 $conf->set('general.title', escape($_POST['title']));
1164 $conf->set('general.header_link', escape($_POST['titleLink']));
1165 $conf->set('resource.theme', escape($_POST['theme']));
1166 $conf->set('redirector.url', escape($_POST['redirector']));
1167 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1168 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1169 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1170 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1171 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1172 $conf->set('api.enabled', !empty($_POST['enableApi']));
1173 $conf->set('api.secret', escape($_POST['apiSecret']));
1174 $conf->set('translation.language', escape($_POST['language']));
1177 $conf->write(isLoggedIn());
1178 $history->updateSettings();
1179 invalidateCaches($conf->get('resource.page_cache'));
1181 catch(Exception
$e) {
1183 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1187 // TODO: do not handle exceptions/errors in JS.
1188 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1191 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1194 else // Show the configuration form.
1196 $PAGE->assign('title', $conf->get('general.title'));
1197 $PAGE->assign('theme', $conf->get('resource.theme'));
1198 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1199 $PAGE->assign('redirector', $conf->get('redirector.url'));
1200 list($continents, $cities) = generateTimeZoneData(
1201 timezone_identifiers_list(),
1202 $conf->get('general.timezone')
1204 $PAGE->assign('continents', $continents);
1205 $PAGE->assign('cities', $cities);
1206 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1207 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1208 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1209 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1210 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1211 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1212 $PAGE->assign('api_secret', $conf->get('api.secret'));
1213 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1214 $PAGE->assign('language', $conf->get('translation.language'));
1215 $PAGE->renderPage('configure');
1220 // -------- User wants to rename a tag or delete it
1221 if ($targetPage == Router
::$PAGE_CHANGETAG)
1223 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1224 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1225 $PAGE->renderPage('changetag');
1229 if (!$sessionManager->checkToken($_POST['token'])) {
1230 die(t('Wrong token.'));
1233 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), escape($_POST['totag']));
1234 $LINKSDB->save($conf->get('resource.page_cache'));
1235 foreach ($alteredLinks as $link) {
1236 $history->updateLink($link);
1238 $delete = empty($_POST['totag']);
1239 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1240 $count = count($alteredLinks);
1242 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1243 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1244 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1248 // -------- User wants to add a link without using the bookmarklet: Show form.
1249 if ($targetPage == Router
::$PAGE_ADDLINK)
1251 $PAGE->renderPage('addlink');
1255 // -------- User clicked the "Save" button when editing a link: Save link to database.
1256 if (isset($_POST['save_edit']))
1259 if (! $sessionManager->checkToken($_POST['token'])) {
1260 die(t('Wrong token.'));
1263 // lf_id should only be present if the link exists.
1264 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1265 // Linkdate is kept here to:
1266 // - use the same permalink for notes as they're displayed when creating them
1267 // - let users hack creation date of their posts
1268 // See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare
1269 $linkdate = escape($_POST['lf_linkdate']);
1270 if (isset($LINKSDB[$id])) {
1272 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1273 $updated = new DateTime();
1274 $shortUrl = $LINKSDB[$id]['shorturl'];
1278 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1280 $shortUrl = link_small_hash($created, $id);
1284 // Remove multiple spaces.
1285 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1286 // Remove first '-' char in tags.
1287 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1288 // Remove duplicates.
1289 $tags = implode(' ', array_unique(explode(' ', $tags)));
1291 if (empty(trim($_POST['lf_url
']))) {
1292 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1294 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1298 'title
' => trim($_POST['lf_title
']),
1300 'description
' => $_POST['lf_description
'],
1301 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1302 'created
' => $created,
1303 'updated
' => $updated,
1304 'tags
' => str_replace(',', ' ', $tags),
1305 'shorturl
' => $shortUrl,
1308 // If title is empty, use the URL as title.
1309 if ($link['title
'] == '') {
1310 $link['title
'] = $link['url
'];
1313 $pluginManager->executeHooks('save_link
', $link);
1315 $LINKSDB[$id] = $link;
1316 $LINKSDB->save($conf->get('resource.page_cache
'));
1318 $history->addLink($link);
1320 $history->updateLink($link);
1323 // If we are called from the bookmarklet, we must close the popup:
1324 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1325 echo '<script
>self
.close();</script
>';
1329 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1330 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1331 // Scroll to the link which has been edited.
1332 $location .= '#' . $link['shorturl'];
1333 // After saving the link, redirect to the page the user was on.
1334 header('Location: '. $location);
1338 // -------- User clicked the "Cancel" button when editing a link.
1339 if (isset($_POST['cancel_edit']))
1341 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1342 if (! isset($LINKSDB[$id])) {
1343 header('Location: ?');
1345 // If we are called from the bookmarklet, we must close the popup:
1346 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1347 $link = $LINKSDB[$id];
1348 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1349 // Scroll to the link which has been edited.
1350 $returnurl .= '#'. $link['shorturl'];
1351 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1352 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1356 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1357 if ($targetPage == Router
::$PAGE_DELETELINK)
1359 if (! $sessionManager->checkToken($_GET['token'])) {
1360 die(t('Wrong token.'));
1363 $ids = trim($_GET['lf_linkdate']);
1364 if (strpos($ids, ' ') !== false) {
1365 // multiple, space-separated ids provided
1366 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1368 // only a single id provided
1371 // assert at least one id is given
1373 die('no id provided');
1375 foreach ($ids as $id) {
1376 $id = (int) escape($id);
1377 $link = $LINKSDB[$id];
1378 $pluginManager->executeHooks('delete_link', $link);
1379 unset($LINKSDB[$id]);
1381 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1382 $history->deleteLink($link);
1384 // If we are called from the bookmarklet, we must close the popup:
1385 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1388 if (isset($_SERVER['HTTP_REFERER'])) {
1389 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1390 $location = generateLocation(
1391 $_SERVER['HTTP_REFERER'],
1392 $_SERVER['HTTP_HOST'],
1393 ['delete_link', 'edit_link', $link['shorturl']]
1397 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1401 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1402 if (isset($_GET['edit_link']))
1404 $id = (int) escape($_GET['edit_link']);
1405 $link = $LINKSDB[$id]; // Read database
1406 if (!$link) { header('Location: ?'); exit; } // Link not found in database.
1407 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1410 'link_is_new' => false,
1411 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1412 'tags' => $LINKSDB->linksCountPerTag(),
1414 $pluginManager->executeHooks('render_editlink', $data);
1416 foreach ($data as $key => $value) {
1417 $PAGE->assign($key, $value);
1420 $PAGE->renderPage('editlink');
1424 // -------- User want to post a new link: Display link edit form.
1425 if (isset($_GET['post'])) {
1426 $url = cleanup_url($_GET['post']);
1428 $link_is_new = false;
1429 // Check if URL is not already in database (in this case, we will edit the existing link)
1430 $link = $LINKSDB->getLinkFromUrl($url);
1433 $link_is_new = true;
1434 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1435 // Get title if it was provided in URL (by the bookmarklet).
1436 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1437 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1438 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1439 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1440 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1441 // 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.)
1442 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1443 // Short timeout to keep the application responsive
1444 // The callback will fill $charset and $title with data from the downloaded page.
1445 get_http_response($url, 25, 4194304, get_curl_download_callback($charset, $title));
1446 if (! empty($title) && strtolower($charset) != 'utf-8') {
1447 $title = mb_convert_encoding($title, 'utf-8', $charset);
1452 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1453 $title = $conf->get('general.default_note_title', t('Note: '));
1455 $url = escape($url);
1456 $title = escape($title);
1459 'linkdate' => $linkdate,
1462 'description' => $description,
1464 'private' => $private,
1467 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1472 'link_is_new' => $link_is_new,
1473 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1474 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1475 'tags' => $LINKSDB->linksCountPerTag(),
1476 'default_private_links' => $conf->get('privacy.default_private_links', false),
1478 $pluginManager->executeHooks('render_editlink', $data);
1480 foreach ($data as $key => $value) {
1481 $PAGE->assign($key, $value);
1484 $PAGE->renderPage('editlink');
1488 if ($targetPage == Router
::$PAGE_EXPORT) {
1489 // Export links as a Netscape Bookmarks file
1491 if (empty($_GET['selection'])) {
1492 $PAGE->renderPage('export');
1496 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1497 $selection = $_GET['selection'];
1498 if (isset($_GET['prepend_note_url'])) {
1499 $prependNoteUrl = $_GET['prepend_note_url'];
1501 $prependNoteUrl = false;
1507 NetscapeBookmarkUtils
::filterAndFormat(
1514 } catch (Exception
$exc) {
1515 header('Content-Type: text/plain; charset=utf-8');
1516 echo $exc->getMessage();
1519 $now = new DateTime();
1520 header('Content-Type: text/html; charset=utf-8');
1522 'Content-disposition: attachment; filename=bookmarks_'
1523 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1525 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1526 $PAGE->assign('eol', PHP_EOL
);
1527 $PAGE->assign('selection', $selection);
1528 $PAGE->renderPage('export.bookmarks');
1532 if ($targetPage == Router
::$PAGE_IMPORT) {
1533 // Upload a Netscape bookmark dump to import its contents
1535 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1536 // Show import dialog
1539 get_max_upload_size(
1540 ini_get('post_max_size'),
1541 ini_get('upload_max_filesize'),
1547 get_max_upload_size(
1548 ini_get('post_max_size'),
1549 ini_get('upload_max_filesize'),
1553 $PAGE->renderPage('import');
1557 // Import bookmarks from an uploaded file
1558 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1559 // The file is too big or some form field may be missing.
1562 'The file you are trying to upload is probably bigger than what this webserver can accept'
1563 .' (%s). Please upload in smaller chunks.'
1565 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1567 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1570 if (! $sessionManager->checkToken($_POST['token'])) {
1571 die('Wrong token.');
1573 $status = NetscapeBookmarkUtils
::import(
1580 echo '<script>alert("'.$status.'");document.location=\'?do='
1581 .Router
::$PAGE_IMPORT .'\';</script>';
1585 // Plugin administration page
1586 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1587 $pluginMeta = $pluginManager->getPluginsMeta();
1589 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1590 $enabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] !== false; });
1592 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1595 function($a, $b) { return $a
['order'] - $b
['order']; }
1597 $disabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] === false; });
1599 $PAGE->assign('enabledPlugins', $enabledPlugins);
1600 $PAGE->assign('disabledPlugins', $disabledPlugins);
1601 $PAGE->renderPage('pluginsadmin');
1605 // Plugin administration form action
1606 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1608 if (isset($_POST['parameters_form'])) {
1609 unset($_POST['parameters_form']);
1610 foreach ($_POST as $param => $value) {
1611 $conf->set('plugins.'. $param, escape($value));
1615 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1617 $conf->write(isLoggedIn());
1618 $history->updateSettings();
1620 catch (Exception
$e) {
1622 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1626 // TODO: do not handle exceptions/errors in JS.
1627 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do='. Router
::$PAGE_PLUGINSADMIN .'\';</script>';
1630 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1634 // Get a fresh token
1635 if ($targetPage == Router
::$GET_TOKEN) {
1636 header('Content-Type:text/plain');
1637 echo $sessionManager->generateToken($conf);
1641 // -------- Otherwise, simply display search form and links:
1642 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1647 * Template for the list of links (<div id="linklist">)
1648 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1650 * @param pageBuilder $PAGE pageBuilder instance.
1651 * @param LinkDB $LINKSDB LinkDB instance.
1652 * @param ConfigManager $conf Configuration Manager instance.
1653 * @param PluginManager $pluginManager Plugin Manager instance.
1655 function buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager)
1657 // Used in templates
1658 if (isset($_GET['searchtags'])) {
1659 if (! empty($_GET['searchtags'])) {
1660 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1662 $searchtags = false;
1667 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1670 if (! empty($_SERVER['QUERY_STRING'])
1671 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1673 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1674 } catch (LinkNotFoundException
$e) {
1675 $PAGE->render404($e->getMessage());
1679 // Filter links according search parameters.
1680 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1682 'searchtags' => $searchtags,
1683 'searchterm' => $searchterm,
1685 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1688 // ---- Handle paging.
1690 foreach ($linksToDisplay as $key => $value) {
1696 // Select articles according to paging.
1697 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1698 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1699 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1700 $page = $page < 1 ? 1 : $page;
1701 $page = $page > $pagecount ? $pagecount : $page;
1703 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1704 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1705 $linkDisp = array();
1706 while ($i<$end && $i<count($keys))
1708 $link = $linksToDisplay[$keys[$i]];
1709 $link['description'] = format_description(
1710 $link['description'],
1711 $conf->get('redirector.url'),
1712 $conf->get('redirector.encode_url')
1714 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1715 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1716 $link['timestamp'] = $link['created']->getTimestamp();
1717 if (! empty($link['updated'])) {
1718 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1720 $link['updated_timestamp'] = '';
1722 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1723 uasort($taglist, 'strcasecmp');
1724 $link['taglist'] = $taglist;
1725 // Check for both signs of a note: starting with ? and 7 chars long.
1726 if ($link['url'][0] === '?' &&
1727 strlen($link['url']) === 7) {
1728 $link['url'] = index_url($_SERVER) . $link['url'];
1731 $linkDisp[$keys[$i]] = $link;
1735 // Compute paging navigation
1736 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1737 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1738 $previous_page_url = '';
1739 if ($i != count($keys)) {
1740 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1744 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1747 // Fill all template fields.
1749 'previous_page_url' => $previous_page_url,
1750 'next_page_url' => $next_page_url,
1751 'page_current' => $page,
1752 'page_max' => $pagecount,
1753 'result_count' => count($linksToDisplay),
1754 'search_term' => $searchterm,
1755 'search_tags' => $searchtags,
1756 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1757 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1758 'links' => $linkDisp,
1761 // If there is only a single link, we change on-the-fly the title of the page.
1762 if (count($linksToDisplay) == 1) {
1763 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1766 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => isLoggedIn()));
1768 foreach ($data as $key => $value) {
1769 $PAGE->assign($key, $value);
1776 * Compute the thumbnail for a link.
1778 * With a link to the original URL.
1779 * Understands various services (youtube.com...)
1780 * Input: $url = URL for which the thumbnail must be found.
1781 * $href = if provided, this URL will be followed instead of $url
1782 * Returns an associative array with thumbnail attributes (src,href,width,height,style,alt)
1783 * Some of them may be missing.
1784 * Return an empty array if no thumbnail available.
1786 * @param ConfigManager $conf Configuration Manager instance.
1787 * @param string $url
1788 * @param string|bool $href
1792 function computeThumbnail($conf, $url, $href = false)
1794 if (!$conf->get('thumbnail.enable_thumbnails')) return array();
1795 if ($href==false) $href=$url;
1797 // For most hosts, the URL of the thumbnail can be easily deduced from the URL of the link.
1798 // (e.g. http://www.youtube.com/watch?v=spVypYk4kto ---> http://img.youtube.com/vi/spVypYk4kto/default.jpg )
1799 // ^^^^^^^^^^^ ^^^^^^^^^^^
1800 $domain = parse_url($url,PHP_URL_HOST
);
1801 if ($domain=='youtube.com' || $domain=='www.youtube.com')
1803 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract video ID and get thumbnail
1804 if (!empty($params['v'])) return array('src'=>'https://img.youtube.com/vi/'.$params['v'].'/default.jpg',
1805 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1807 if ($domain=='youtu.be') // Youtube short links
1809 $path = parse_url($url,PHP_URL_PATH
);
1810 return array('src'=>'https://img.youtube.com/vi'.$path.'/default.jpg',
1811 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1813 if ($domain=='pix.toile-libre.org') // pix.toile-libre.org image hosting
1815 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract image filename.
1816 if (!empty($params) && !empty($params['img'])) return array('src'=>'http://pix.toile-libre.org/upload/thumb/'.urlencode($params['img']),
1817 'href'=>$href,'style'=>'max-width:120px; max-height:150px','alt'=>'pix.toile-libre.org thumbnail');
1820 if ($domain=='imgur.com')
1822 $path = parse_url($url,PHP_URL_PATH
);
1823 if (startsWith($path,'/a/')) return array(); // Thumbnails for albums are not available.
1824 if (startsWith($path,'/r/')) return array('src'=>'https://i.imgur.com/'.basename($path).'s.jpg',
1825 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1826 if (startsWith($path,'/gallery/')) return array('src'=>'https://i.imgur.com'.substr($path,8).'s.jpg',
1827 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1829 if (substr_count($path,'/')==1) return array('src'=>'https://i.imgur.com/'.substr($path,1).'s.jpg',
1830 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1832 if ($domain=='i.imgur.com')
1834 $pi = pathinfo(parse_url($url,PHP_URL_PATH
));
1835 if (!empty($pi['filename'])) return array('src'=>'https://i.imgur.com/'.$pi['filename'].'s.jpg',
1836 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1838 if ($domain=='dailymotion.com' || $domain=='www.dailymotion.com')
1840 if (strpos($url,'dailymotion.com/video/')!==false)
1842 $thumburl=str_replace('dailymotion.com/video/','dailymotion.com/thumbnail/video/',$url);
1843 return array('src'=>$thumburl,
1844 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'DailyMotion thumbnail');
1847 if (endsWith($domain,'.imageshack.us'))
1849 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1850 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1852 $thumburl = substr($url,0,strlen($url)-strlen($ext)).'th.'.$ext;
1853 return array('src'=>$thumburl,
1854 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'imageshack.us thumbnail');
1858 // Some other hosts are SLOW AS HELL and usually require an extra HTTP request to get the thumbnail URL.
1859 // So we deport the thumbnail generation in order not to slow down page generation
1860 // (and we also cache the thumbnail)
1862 if (! $conf->get('thumbnail.enable_localcache')) return array(); // If local cache is disabled, no thumbnails for services which require the use a local cache.
1864 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com')
1865 || $domain=='vimeo.com'
1866 || $domain=='ted.com' || endsWith($domain,'.ted.com')
1867 || $domain=='xkcd.com' || endsWith($domain,'.xkcd.com')
1870 if ($domain=='vimeo.com')
1871 { // Make sure this vimeo URL points to a video (/xxx... where xxx is numeric)
1872 $path = parse_url($url,PHP_URL_PATH
);
1873 if (!preg_match('!/\d+.+?!',$path)) return array(); // This is not a single video URL.
1875 if ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
1876 { // Make sure this URL points to a single comic (/xxx... where xxx is numeric)
1877 $path = parse_url($url,PHP_URL_PATH
);
1878 if (!preg_match('!/\d+.+?!',$path)) return array();
1880 if ($domain=='ted.com' || endsWith($domain,'.ted.com'))
1881 { // Make sure this TED URL points to a video (/talks/...)
1882 $path = parse_url($url,PHP_URL_PATH
);
1883 if ("/talks/" !== substr($path,0,7)) return array(); // This is not a single video URL.
1885 $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)
1886 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1887 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1890 // For all other, we try to make a thumbnail of links ending with .jpg/jpeg/png/gif
1891 // Technically speaking, we should download ALL links and check their Content-Type to see if they are images.
1892 // But using the extension will do.
1893 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1894 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1896 $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)
1897 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1898 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1900 return array(); // No thumbnail.
1905 // Returns the HTML code to display a thumbnail for a link
1906 // with a link to the original URL.
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 thumbnail($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']).'"><img src="'.escape($t['src']).'"';
1919 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1920 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1921 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1922 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1927 // Returns the HTML code to display a thumbnail for a link
1928 // for the picture wall (using lazy image loading)
1929 // Understands various services (youtube.com...)
1930 // Input: $url = URL for which the thumbnail must be found.
1931 // $href = if provided, this URL will be followed instead of $url
1932 // Returns '' if no thumbnail available.
1933 function lazyThumbnail($conf, $url,$href=false)
1937 $t = computeThumbnail($conf, $url,$href);
1938 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1940 $html='<a href="'.escape($t['href']).'">';
1943 $html.='<img class="b-lazy" src="#" data-src="'.escape($t['src']).'"';
1945 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1946 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1947 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1948 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1951 // No-JavaScript fallback.
1952 $html.='<noscript><img src="'.escape($t['src']).'"';
1953 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1954 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1955 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1956 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1957 $html.='></noscript></a>';
1965 * This function should NEVER be called if the file data/config.php exists.
1967 * @param ConfigManager $conf Configuration Manager instance.
1968 * @param SessionManager $sessionManager SessionManager instance
1970 function install($conf, $sessionManager) {
1971 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1972 if (endsWith($_SERVER['HTTP_HOST'],'.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions',0705);
1975 // This part makes sure sessions works correctly.
1976 // (Because on some hosts, session.save_path may not be set correctly,
1977 // or we may not have write access to it.)
1978 if (isset($_GET['test_session']) && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working'))
1980 // Step 2: Check if data in session is correct.
1982 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1983 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1984 'and that you have write access to it.<br>'.
1985 'It currently points to %s.<br>'.
1986 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1987 'or any custom hostname without a dot causes cookie storage to fail. '.
1988 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1990 $msg = sprintf($msg, session_save_path());
1992 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1995 if (!isset($_SESSION['session_tested']))
1996 { // Step 1 : Try to store data in session and reload page.
1997 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1998 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
2000 if (isset($_GET['test_session']))
2001 { // Step 3: Sessions are OK. Remove test parameter from URL.
2002 header('Location: '.index_url($_SERVER));
2006 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
2009 if (!empty($_POST['continent']) && !empty($_POST['city'])
2010 && isTimeZoneValid($_POST['continent'], $_POST['city'])
2012 $tz = $_POST['continent'].'/'.$_POST['city'];
2014 $conf->set('general.timezone', $tz);
2015 $login = $_POST['setlogin'];
2016 $conf->set('credentials.login', $login);
2017 $salt = sha1(uniqid('', true) .'_'. mt_rand());
2018 $conf->set('credentials.salt', $salt);
2019 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
2020 if (!empty($_POST['title'])) {
2021 $conf->set('general.title', escape($_POST['title']));
2023 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
2025 $conf->set('translation.language', escape($_POST['language']));
2026 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
2027 $conf->set('api.enabled', !empty($_POST['enableApi']));
2030 generate_api_secret(
2031 $conf->get('credentials.login'),
2032 $conf->get('credentials.salt')
2036 // Everything is ok, let's create config file.
2037 $conf->write(isLoggedIn());
2039 catch(Exception
$e) {
2041 'ERROR while writing config file after installation.' . PHP_EOL
.
2045 // TODO: do not handle exceptions/errors in JS.
2046 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
2049 echo '<script>alert("Shaarli is now configured. Please enter your login/password and start shaaring your links!");document.location=\'?do=login\';</script>';
2053 $PAGE = new PageBuilder($conf, null, $sessionManager->generateToken());
2054 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
2055 $PAGE->assign('continents', $continents);
2056 $PAGE->assign('cities', $cities);
2057 $PAGE->assign('languages', Languages
::getAvailableLanguages());
2058 $PAGE->renderPage('install');
2063 * Because some f*cking services like flickr require an extra HTTP request to get the thumbnail URL,
2064 * I have deported the thumbnail URL code generation here, otherwise this would slow down page generation.
2065 * The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail.
2066 * This function is called by passing the URL:
2067 * http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL]
2068 * [URL] is the URL of the link (e.g. a flickr page)
2069 * [HMAC] is the signature for the [URL] (so that these URL cannot be forged).
2070 * The function below will fetch the image from the webservice and store it in the cache.
2072 * @param ConfigManager $conf Configuration Manager instance,
2074 function genThumbnail($conf)
2076 // Make sure the parameters in the URL were generated by us.
2077 $sign = hash_hmac('sha256', $_GET['url'], $conf->get('credentials.salt'));
2078 if ($sign!=$_GET['hmac']) die('Naughty boy!');
2080 $cacheDir = $conf->get('resource.thumbnails_cache', 'cache');
2081 // Let's see if we don't already have the image for this URL in the cache.
2082 $thumbname=hash('sha1',$_GET['url']).'.jpg';
2083 if (is_file($cacheDir .'/'. $thumbname))
2084 { // We have the thumbnail, just serve it:
2085 header('Content-Type: image/jpeg');
2086 echo file_get_contents($cacheDir .'/'. $thumbname);
2089 // We may also serve a blank image (if service did not respond)
2090 $blankname=hash('sha1',$_GET['url']).'.gif';
2091 if (is_file($cacheDir .'/'. $blankname))
2093 header('Content-Type: image/gif');
2094 echo file_get_contents($cacheDir .'/'. $blankname);
2098 // Otherwise, generate the thumbnail.
2099 $url = $_GET['url'];
2100 $domain = parse_url($url,PHP_URL_HOST
);
2102 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com'))
2104 // Crude replacement to handle new flickr domain policy (They prefer www. now)
2105 $url = str_replace('http://flickr.com/','http://www.flickr.com/',$url);
2107 // Is this a link to an image, or to a flickr page ?
2109 if (endsWith(parse_url($url, PHP_URL_PATH
), '.jpg'))
2110 { // This is a direct link to an image. e.g. http://farm1.staticflickr.com/5/5921913_ac83ed27bd_o.jpg
2111 preg_match('!(http://farm\d+\.staticflickr\.com/\d+/\d+_\w+_)\w.jpg!',$url,$matches);
2112 if (!empty($matches[1])) $imageurl=$matches[1].'m.jpg';
2114 else // This is a flickr page (html)
2116 // Get the flickr html page.
2117 list($headers, $content) = get_http_response($url, 20);
2118 if (strpos($headers[0], '200 OK') !== false)
2120 // flickr now nicely provides the URL of the thumbnail in each flickr page.
2121 preg_match('!<link rel=\"image_src\" href=\"(.+?)\"!', $content, $matches);
2122 if (!empty($matches[1])) $imageurl=$matches[1];
2124 // In albums (and some other pages), the link rel="image_src" is not provided,
2125 // but flickr provides:
2126 // <meta property="og:image" content="http://farm4.staticflickr.com/3398/3239339068_25d13535ff_z.jpg" />
2129 preg_match('!<meta property=\"og:image\" content=\"(.+?)\"!', $content, $matches);
2130 if (!empty($matches[1])) $imageurl=$matches[1];
2136 { // Let's download the image.
2137 // Image is 240x120, so 10 seconds to download should be enough.
2138 list($headers, $content) = get_http_response($imageurl, 10);
2139 if (strpos($headers[0], '200 OK') !== false) {
2140 // Save image to cache.
2141 file_put_contents($cacheDir .'/'. $thumbname, $content);
2142 header('Content-Type: image/jpeg');
2149 elseif ($domain=='vimeo.com' )
2151 // This is more complex: we have to perform a HTTP request, then parse the result.
2152 // Maybe we should deport this to JavaScript ? Example: http://stackoverflow.com/questions/1361149/get-img-thumbnails-from-vimeo/4285098#4285098
2153 $vid = substr(parse_url($url,PHP_URL_PATH
),1);
2154 list($headers, $content) = get_http_response('https://vimeo.com/api/v2/video/'.escape($vid).'.php', 5);
2155 if (strpos($headers[0], '200 OK') !== false) {
2156 $t = unserialize($content);
2157 $imageurl = $t[0]['thumbnail_medium'];
2158 // Then we download the image and serve it to our client.
2159 list($headers, $content) = get_http_response($imageurl, 10);
2160 if (strpos($headers[0], '200 OK') !== false) {
2161 // Save image to cache.
2162 file_put_contents($cacheDir .'/'. $thumbname, $content);
2163 header('Content-Type: image/jpeg');
2170 elseif ($domain=='ted.com' || endsWith($domain,'.ted.com'))
2172 // The thumbnail for TED talks is located in the <link rel="image_src" [...]> tag on that page
2173 // http://www.ted.com/talks/mikko_hypponen_fighting_viruses_defending_the_net.html
2174 // <link rel="image_src" href="http://images.ted.com/images/ted/28bced335898ba54d4441809c5b1112ffaf36781_389x292.jpg" />
2175 list($headers, $content) = get_http_response($url, 5);
2176 if (strpos($headers[0], '200 OK') !== false) {
2177 // Extract the link to the thumbnail
2178 preg_match('!link rel="image_src" href="(http://images.ted.com/images/ted/.+_\d+x\d+\.jpg)"!', $content, $matches);
2179 if (!empty($matches[1]))
2180 { // Let's download the image.
2181 $imageurl=$matches[1];
2182 // No control on image size, so wait long enough
2183 list($headers, $content) = get_http_response($imageurl, 20);
2184 if (strpos($headers[0], '200 OK') !== false) {
2185 $filepath = $cacheDir .'/'. $thumbname;
2186 file_put_contents($filepath, $content); // Save image to cache.
2187 if (resizeImage($filepath))
2189 header('Content-Type: image/jpeg');
2190 echo file_get_contents($filepath);
2198 elseif ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
2200 // There is no thumbnail available for xkcd comics, so download the whole image and resize it.
2201 // http://xkcd.com/327/
2202 // <img src="http://imgs.xkcd.com/comics/exploits_of_a_mom.png" title="<BLABLA>" alt="<BLABLA>" />
2203 list($headers, $content) = get_http_response($url, 5);
2204 if (strpos($headers[0], '200 OK') !== false) {
2205 // Extract the link to the thumbnail
2206 preg_match('!<img src="(http://imgs.xkcd.com/comics/.*)" title="[^s]!', $content, $matches);
2207 if (!empty($matches[1]))
2208 { // Let's download the image.
2209 $imageurl=$matches[1];
2210 // No control on image size, so wait long enough
2211 list($headers, $content) = get_http_response($imageurl, 20);
2212 if (strpos($headers[0], '200 OK') !== false) {
2213 $filepath = $cacheDir.'/'.$thumbname;
2214 // Save image to cache.
2215 file_put_contents($filepath, $content);
2216 if (resizeImage($filepath))
2218 header('Content-Type: image/jpeg');
2219 echo file_get_contents($filepath);
2229 // For all other domains, we try to download the image and make a thumbnail.
2230 // We allow 30 seconds max to download (and downloads are limited to 4 Mb)
2231 list($headers, $content) = get_http_response($url, 30);
2232 if (strpos($headers[0], '200 OK') !== false) {
2233 $filepath = $cacheDir .'/'.$thumbname;
2234 // Save image to cache.
2235 file_put_contents($filepath, $content);
2236 if (resizeImage($filepath))
2238 header('Content-Type: image/jpeg');
2239 echo file_get_contents($filepath);
2246 // Otherwise, return an empty image (8x8 transparent gif)
2247 $blankgif = base64_decode('R0lGODlhCAAIAIAAAP///////yH5BAEKAAEALAAAAAAIAAgAAAIHjI+py+1dAAA7');
2248 // Also put something in cache so that this URL is not requested twice.
2249 file_put_contents($cacheDir .'/'. $blankname, $blankgif);
2250 header('Content-Type: image/gif');
2254 // Make a thumbnail of the image (to width: 120 pixels)
2255 // Returns true if success, false otherwise.
2256 function resizeImage($filepath)
2258 if (!function_exists('imagecreatefromjpeg')) return false; // GD not present: no thumbnail possible.
2260 // Trick: some stupid people rename GIF as JPEG... or else.
2261 // So we really try to open each image type whatever the extension is.
2262 $header=file_get_contents($filepath,false,NULL,0,256); // Read first 256 bytes and try to sniff file type.
2264 $i=strpos($header,'GIF8'); if (($i!==false) && ($i==0)) $im = imagecreatefromgif($filepath); // Well this is crude, but it should be enough.
2265 $i=strpos($header,'PNG'); if (($i!==false) && ($i==1)) $im = imagecreatefrompng($filepath);
2266 $i=strpos($header,'JFIF'); if ($i!==false) $im = imagecreatefromjpeg($filepath);
2267 if (!$im) return false; // Unable to open image (corrupted or not an image)
2270 $ystart = 0; $yheight=$h;
2271 if ($h>$w) { $ystart
= ($h
/2)-($w
/2); $yheight
=$w
/2; }
2272 $nw = 120; // Desired width
2273 $nh = min(floor(($h*$nw)/$w),120); // Compute new width/height, but maximum 120 pixels height.
2275 $im2 = imagecreatetruecolor($nw,$nh);
2276 imagecopyresampled($im2, $im, 0, 0, 0, $ystart, $nw, $nh, $w, $yheight);
2277 imageinterlace($im2,true); // For progressive JPEG.
2278 $tempname=$filepath.'_TEMP.jpg';
2279 imagejpeg($im2, $tempname, 90);
2283 rename($tempname,$filepath); // Overwrite original picture with thumbnail.
2287 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=genthumbnail')) { genThumbnail($conf
); exit; } // Thumbnail generation/cache does not need the link database.
2288 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf
); exit; }
2289 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
2290 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
2294 $history = new History($conf->get('resource.history'));
2295 } catch(Exception
$e) {
2296 die($e->getMessage());
2299 $linkDb = new LinkDB(
2300 $conf->get('resource.datastore'),
2302 $conf->get('privacy.hide_public_links'),
2303 $conf->get('redirector.url'),
2304 $conf->get('redirector.encode_url')
2307 $container = new \Slim\
Container();
2308 $container['conf'] = $conf;
2309 $container['plugins'] = $pluginManager;
2310 $container['history'] = $history;
2311 $app = new \Slim\
App($container);
2314 $app->group('/api/v1', function() {
2315 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
2316 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
2317 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
2318 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
2319 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
2320 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
2321 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
2322 })->add('\Shaarli\Api\ApiMiddleware');
2324 $response = $app->run(true);
2325 // Hack to make Slim and Shaarli router work together:
2326 // If a Slim route isn't found and NOT API call, we call renderPage().
2327 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
2328 // We use UTF-8 for proper international characters handling.
2329 header('Content-Type: text/html; charset=utf-8');
2330 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager);
2332 $app->respond($response);