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='. urlencode($_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 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
616 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
617 'linksToDisplay' => $linksToDisplay,
618 'day' => $dayDate->getTimestamp(),
619 'dayDate' => $dayDate,
620 'previousday' => $previousday,
621 'nextday' => $nextday,
624 /* Hook is called before column construction so that plugins don't have
625 to deal with columns. */
626 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => isLoggedIn()));
628 /* We need to spread the articles on 3 columns.
629 I did not want to use a JavaScript lib like http://masonry.desandro.com/
630 so I manually spread entries with a simple method: I roughly evaluate the
631 height of a div according to title and description length.
633 $columns = array(array(), array(), array()); // Entries to display, for each column.
634 $fill = array(0, 0, 0); // Rough estimate of columns fill.
635 foreach($data['linksToDisplay'] as $key => $link) {
636 // Roughly estimate length of entry (by counting characters)
637 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
638 // Description: 836 characters gives roughly 342 pixel height.
639 // This is not perfect, but it's usually OK.
640 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
641 if ($link['thumbnail']) {
642 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
644 // Then put in column which is the less filled:
645 $smallest = min($fill); // find smallest value in array.
646 $index = array_search($smallest, $fill); // find index of this smallest value.
647 array_push($columns[$index], $link); // Put entry in this column.
648 $fill[$index] +
= $length;
651 $data['cols'] = $columns;
653 foreach ($data as $key => $value) {
654 $pageBuilder->assign($key, $value);
657 $pageBuilder->renderPage('daily');
662 * Renders the linklist
664 * @param pageBuilder $PAGE pageBuilder instance.
665 * @param LinkDB $LINKSDB LinkDB instance.
666 * @param ConfigManager $conf Configuration Manager instance.
667 * @param PluginManager $pluginManager Plugin Manager instance.
669 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager) {
670 buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager); // Compute list of links to display
671 $PAGE->renderPage('linklist');
675 * Render HTML page (according to URL parameters and user rights)
677 * @param ConfigManager $conf Configuration Manager instance.
678 * @param PluginManager $pluginManager Plugin Manager instance,
679 * @param LinkDB $LINKSDB
680 * @param History $history instance
681 * @param SessionManager $sessionManager SessionManager instance
683 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager)
685 $updater = new Updater(
686 read_updates_file($conf->get('resource.updates')),
692 $newUpdates = $updater->update();
693 if (! empty($newUpdates)) {
695 $conf->get('resource.updates'),
696 $updater->getDoneUpdates()
700 catch(Exception
$e) {
701 die($e->getMessage());
704 $PAGE = new PageBuilder($conf, $LINKSDB, $sessionManager->generateToken());
705 $PAGE->assign('linkcount', count($LINKSDB));
706 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
707 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
709 // Determine which page will be rendered.
710 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
711 $targetPage = Router
::findPage($query, $_GET, isLoggedIn());
714 // if the user isn't logged in
716 // and Shaarli doesn't have public content...
717 $conf->get('privacy.hide_public_links') &&
718 // and is configured to enforce the login
719 $conf->get('privacy.force_login') &&
720 // and the current page isn't already the login page
721 $targetPage !== Router
::$PAGE_LOGIN &&
722 // and the user is not requesting a feed (which would lead to a different content-type as expected)
723 $targetPage !== Router
::$PAGE_FEED_ATOM &&
724 $targetPage !== Router
::$PAGE_FEED_RSS
726 // force current page to be the login page
727 $targetPage = Router
::$PAGE_LOGIN;
730 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
731 // Then assign generated data to RainTPL.
732 $common_hooks = array(
738 foreach($common_hooks as $name) {
739 $plugin_data = array();
740 $pluginManager->executeHooks('render_' . $name, $plugin_data,
742 'target' => $targetPage,
743 'loggedin' => isLoggedIn()
746 $PAGE->assign('plugins_' . $name, $plugin_data);
749 // -------- Display login form.
750 if ($targetPage == Router
::$PAGE_LOGIN)
752 if ($conf->get('security.open_shaarli')) { header('Location: ?'); exit; } // No need to login for open Shaarli
753 if (isset($_GET['username'])) {
754 $PAGE->assign('username', escape($_GET['username']));
756 $PAGE->assign('returnurl',(isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
757 // add default state of the 'remember me' checkbox
758 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
759 $PAGE->renderPage('loginform');
762 // -------- User wants to logout.
763 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout'))
765 invalidateCaches($conf->get('resource.page_cache'));
767 header('Location: ?');
771 // -------- Picture wall
772 if ($targetPage == Router
::$PAGE_PICWALL)
774 // Optionally filter the results:
775 $links = $LINKSDB->filterSearch($_GET);
776 $linksToDisplay = array();
778 // Get only links which have a thumbnail.
779 foreach($links as $link)
781 $permalink='?'.$link['shorturl'];
782 $thumb=lazyThumbnail($conf, $link['url'],$permalink);
783 if ($thumb!='') // Only output links which have a thumbnail.
785 $link['thumbnail']=$thumb; // Thumbnail HTML code.
786 $linksToDisplay[]=$link; // Add to array.
791 'linksToDisplay' => $linksToDisplay,
793 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => isLoggedIn()));
795 foreach ($data as $key => $value) {
796 $PAGE->assign($key, $value);
799 $PAGE->renderPage('picwall');
803 // -------- Tag cloud
804 if ($targetPage == Router
::$PAGE_TAGCLOUD)
806 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
807 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
808 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
810 // We sort tags alphabetically, then choose a font size according to count.
811 // First, find max value.
813 foreach ($tags as $value) {
814 $maxcount = max($maxcount, $value);
817 alphabetical_sort($tags, false, true);
820 foreach($tags as $key => $value) {
821 if (in_array($key, $filteringTags)) {
824 // Tag font size scaling:
825 // default 15 and 30 logarithm bases affect scaling,
826 // 22 and 6 are arbitrary font sizes for max and min sizes.
827 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
828 $tagList[$key] = array(
830 'size' => number_format($size, 2, '.', ''),
835 'search_tags' => implode(' ', escape($filteringTags)),
838 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => isLoggedIn()));
840 foreach ($data as $key => $value) {
841 $PAGE->assign($key, $value);
844 $PAGE->renderPage('tag.cloud');
849 if ($targetPage == Router
::$PAGE_TAGLIST)
851 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
852 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
853 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
854 foreach ($filteringTags as $tag) {
855 if (array_key_exists($tag, $tags)) {
860 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
861 alphabetical_sort($tags, false, true);
865 'search_tags' => implode(' ', escape($filteringTags)),
868 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => isLoggedIn()]);
870 foreach ($data as $key => $value) {
871 $PAGE->assign($key, $value);
874 $PAGE->renderPage('tag.list');
879 if ($targetPage == Router
::$PAGE_DAILY) {
880 showDaily($PAGE, $LINKSDB, $conf, $pluginManager);
883 // ATOM and RSS feed.
884 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
885 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
886 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
889 $query = $_SERVER['QUERY_STRING'];
890 $cache = new CachedPage(
891 $conf->get('resource.page_cache'),
893 startsWith($query,'do='. $targetPage) && !isLoggedIn()
895 $cached = $cache->cachedVersion();
896 if (!empty($cached)) {
902 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, isLoggedIn());
903 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
904 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !isLoggedIn());
905 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
906 $data = $feedGenerator->buildData();
908 // Process plugin hook.
909 $pluginManager->executeHooks('render_feed', $data, array(
910 'loggedin' => isLoggedIn(),
911 'target' => $targetPage,
914 // Render the template.
915 $PAGE->assignAll($data);
916 $PAGE->renderPage('feed.'. $feedType);
917 $cache->cache(ob_get_contents());
922 // Display opensearch plugin (XML)
923 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
924 header('Content-Type: application/xml; charset=utf-8');
925 $PAGE->assign('serverurl', index_url($_SERVER));
926 $PAGE->renderPage('opensearch');
930 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
931 if (isset($_GET['addtag']))
933 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
934 if (empty($_SERVER['HTTP_REFERER'])) { header('Location: ?searchtags='.urlencode($_GET
['addtag'])); exit; } // In case browser does not send HTTP_REFERER
935 parse_str(parse_url($_SERVER['HTTP_REFERER'],PHP_URL_QUERY
), $params);
937 // Prevent redirection loop
938 if (isset($params['addtag'])) {
939 unset($params['addtag']);
942 // Check if this tag is already in the search query and ignore it if it is.
943 // Each tag is always separated by a space
944 if (isset($params['searchtags'])) {
945 $current_tags = explode(' ', $params['searchtags']);
947 $current_tags = array();
950 foreach ($current_tags as $value) {
951 if ($value === $_GET['addtag']) {
956 // Append the tag if necessary
957 if (empty($params['searchtags'])) {
958 $params['searchtags'] = trim($_GET['addtag']);
961 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
964 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
965 header('Location: ?'.http_build_query($params));
969 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
970 if (isset($_GET['removetag'])) {
971 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
972 if (empty($_SERVER['HTTP_REFERER'])) {
973 header('Location: ?');
977 // In case browser does not send HTTP_REFERER
978 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
980 // Prevent redirection loop
981 if (isset($params['removetag'])) {
982 unset($params['removetag']);
985 if (isset($params['searchtags'])) {
986 $tags = explode(' ', $params['searchtags']);
987 // Remove value from array $tags.
988 $tags = array_diff($tags, array($_GET['removetag']));
989 $params['searchtags'] = implode(' ',$tags);
991 if (empty($params['searchtags'])) {
992 unset($params['searchtags']);
995 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
997 header('Location: ?'.http_build_query($params));
1001 // -------- User wants to change the number of links per page (linksperpage=...)
1002 if (isset($_GET['linksperpage'])) {
1003 if (is_numeric($_GET['linksperpage'])) {
1004 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
1007 if (! empty($_SERVER['HTTP_REFERER'])) {
1008 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
1012 header('Location: '. $location);
1016 // -------- User wants to see only private links (toggle)
1017 if (isset($_GET['privateonly'])) {
1018 if (empty($_SESSION['privateonly'])) {
1019 $_SESSION['privateonly'] = 1; // See only private links
1021 unset($_SESSION['privateonly']); // See all links
1024 if (! empty($_SERVER['HTTP_REFERER'])) {
1025 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('privateonly'));
1029 header('Location: '. $location);
1033 // -------- User wants to see only untagged links (toggle)
1034 if (isset($_GET['untaggedonly'])) {
1035 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
1037 if (! empty($_SERVER['HTTP_REFERER'])) {
1038 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
1042 header('Location: '. $location);
1046 // -------- Handle other actions allowed for non-logged in users:
1049 // User tries to post new link but is not logged in:
1050 // Show login screen, then redirect to ?post=...
1051 if (isset($_GET['post']))
1053 header( // Redirect to login page, then back to post link.
1054 'Location: ?do=login&post='.urlencode($_GET['post']).
1055 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
1056 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
1057 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
1058 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
1063 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1064 if (isset($_GET['edit_link'])) {
1065 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
1069 exit; // Never remove this one! All operations below are reserved for logged in user.
1072 // -------- All other functions are reserved for the registered user:
1074 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
1075 if ($targetPage == Router
::$PAGE_TOOLS)
1078 'pageabsaddr' => index_url($_SERVER),
1079 'sslenabled' => is_https($_SERVER),
1081 $pluginManager->executeHooks('render_tools', $data);
1083 foreach ($data as $key => $value) {
1084 $PAGE->assign($key, $value);
1087 $PAGE->renderPage('tools');
1091 // -------- User wants to change his/her password.
1092 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD)
1094 if ($conf->get('security.open_shaarli')) {
1095 die(t('You are not supposed to change a password on an Open Shaarli.'));
1098 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword']))
1100 if (!$sessionManager->checkToken($_POST['token'])) die(t('Wrong token.')); // Go away!
1102 // Make sure old password is correct.
1103 $oldhash = sha1($_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt'));
1104 if ($oldhash!= $conf->get('credentials.hash')) {
1105 echo '<script>alert("'. t('The old password is not correct.') .'");document.location=\'?do=changepasswd\';</script>';
1108 // Save new password
1109 // Salt renders rainbow-tables attacks useless.
1110 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
1111 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $conf->get('credentials.login') . $conf->get('credentials.salt')));
1113 $conf->write(isLoggedIn());
1115 catch(Exception
$e) {
1117 'ERROR while writing config file after changing password.' . PHP_EOL
.
1121 // TODO: do not handle exceptions/errors in JS.
1122 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
1125 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
1128 else // show the change password form.
1130 $PAGE->renderPage('changepassword');
1135 // -------- User wants to change configuration
1136 if ($targetPage == Router
::$PAGE_CONFIGURE)
1138 if (!empty($_POST['title']) )
1140 if (!$sessionManager->checkToken($_POST['token'])) {
1141 die(t('Wrong token.')); // Go away!
1144 if (!empty($_POST['continent']) && !empty($_POST['city'])
1145 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1147 $tz = $_POST['continent'] . '/' . $_POST['city'];
1149 $conf->set('general.timezone', $tz);
1150 $conf->set('general.title', escape($_POST['title']));
1151 $conf->set('general.header_link', escape($_POST['titleLink']));
1152 $conf->set('resource.theme', escape($_POST['theme']));
1153 $conf->set('redirector.url', escape($_POST['redirector']));
1154 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1155 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1156 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1157 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1158 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1159 $conf->set('api.enabled', !empty($_POST['enableApi']));
1160 $conf->set('api.secret', escape($_POST['apiSecret']));
1161 $conf->set('translation.language', escape($_POST['language']));
1164 $conf->write(isLoggedIn());
1165 $history->updateSettings();
1166 invalidateCaches($conf->get('resource.page_cache'));
1168 catch(Exception
$e) {
1170 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1174 // TODO: do not handle exceptions/errors in JS.
1175 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1178 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1181 else // Show the configuration form.
1183 $PAGE->assign('title', $conf->get('general.title'));
1184 $PAGE->assign('theme', $conf->get('resource.theme'));
1185 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1186 $PAGE->assign('redirector', $conf->get('redirector.url'));
1187 list($continents, $cities) = generateTimeZoneData(
1188 timezone_identifiers_list(),
1189 $conf->get('general.timezone')
1191 $PAGE->assign('continents', $continents);
1192 $PAGE->assign('cities', $cities);
1193 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1194 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1195 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1196 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1197 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1198 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1199 $PAGE->assign('api_secret', $conf->get('api.secret'));
1200 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1201 $PAGE->assign('language', $conf->get('translation.language'));
1202 $PAGE->renderPage('configure');
1207 // -------- User wants to rename a tag or delete it
1208 if ($targetPage == Router
::$PAGE_CHANGETAG)
1210 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1211 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1212 $PAGE->renderPage('changetag');
1216 if (!$sessionManager->checkToken($_POST['token'])) {
1217 die(t('Wrong token.'));
1220 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), escape($_POST['totag']));
1221 $LINKSDB->save($conf->get('resource.page_cache'));
1222 foreach ($alteredLinks as $link) {
1223 $history->updateLink($link);
1225 $delete = empty($_POST['totag']);
1226 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1227 $count = count($alteredLinks);
1229 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1230 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1231 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1235 // -------- User wants to add a link without using the bookmarklet: Show form.
1236 if ($targetPage == Router
::$PAGE_ADDLINK)
1238 $PAGE->renderPage('addlink');
1242 // -------- User clicked the "Save" button when editing a link: Save link to database.
1243 if (isset($_POST['save_edit']))
1246 if (! $sessionManager->checkToken($_POST['token'])) {
1247 die(t('Wrong token.'));
1250 // lf_id should only be present if the link exists.
1251 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1252 // Linkdate is kept here to:
1253 // - use the same permalink for notes as they're displayed when creating them
1254 // - let users hack creation date of their posts
1255 // See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare
1256 $linkdate = escape($_POST['lf_linkdate']);
1257 if (isset($LINKSDB[$id])) {
1259 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1260 $updated = new DateTime();
1261 $shortUrl = $LINKSDB[$id]['shorturl'];
1265 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1267 $shortUrl = link_small_hash($created, $id);
1271 // Remove multiple spaces.
1272 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1273 // Remove first '-' char in tags.
1274 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1275 // Remove duplicates.
1276 $tags = implode(' ', array_unique(explode(' ', $tags)));
1278 if (empty(trim($_POST['lf_url
']))) {
1279 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1281 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1285 'title
' => trim($_POST['lf_title
']),
1287 'description
' => $_POST['lf_description
'],
1288 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1289 'created
' => $created,
1290 'updated
' => $updated,
1291 'tags
' => str_replace(',', ' ', $tags),
1292 'shorturl
' => $shortUrl,
1295 // If title is empty, use the URL as title.
1296 if ($link['title
'] == '') {
1297 $link['title
'] = $link['url
'];
1300 $pluginManager->executeHooks('save_link
', $link);
1302 $LINKSDB[$id] = $link;
1303 $LINKSDB->save($conf->get('resource.page_cache
'));
1305 $history->addLink($link);
1307 $history->updateLink($link);
1310 // If we are called from the bookmarklet, we must close the popup:
1311 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1312 echo '<script
>self
.close();</script
>';
1316 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1317 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1318 // Scroll to the link which has been edited.
1319 $location .= '#' . $link['shorturl'];
1320 // After saving the link, redirect to the page the user was on.
1321 header('Location: '. $location);
1325 // -------- User clicked the "Cancel" button when editing a link.
1326 if (isset($_POST['cancel_edit']))
1328 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1329 if (! isset($LINKSDB[$id])) {
1330 header('Location: ?');
1332 // If we are called from the bookmarklet, we must close the popup:
1333 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1334 $link = $LINKSDB[$id];
1335 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1336 // Scroll to the link which has been edited.
1337 $returnurl .= '#'. $link['shorturl'];
1338 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1339 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1343 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1344 if ($targetPage == Router
::$PAGE_DELETELINK)
1346 if (! $sessionManager->checkToken($_GET['token'])) {
1347 die(t('Wrong token.'));
1350 $ids = trim($_GET['lf_linkdate']);
1351 if (strpos($ids, ' ') !== false) {
1352 // multiple, space-separated ids provided
1353 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1355 // only a single id provided
1358 // assert at least one id is given
1360 die('no id provided');
1362 foreach ($ids as $id) {
1363 $id = (int) escape($id);
1364 $link = $LINKSDB[$id];
1365 $pluginManager->executeHooks('delete_link', $link);
1366 unset($LINKSDB[$id]);
1368 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1369 $history->deleteLink($link);
1371 // If we are called from the bookmarklet, we must close the popup:
1372 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1375 if (isset($_SERVER['HTTP_REFERER'])) {
1376 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1377 $location = generateLocation(
1378 $_SERVER['HTTP_REFERER'],
1379 $_SERVER['HTTP_HOST'],
1380 ['delete_link', 'edit_link', $link['shorturl']]
1384 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1388 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1389 if (isset($_GET['edit_link']))
1391 $id = (int) escape($_GET['edit_link']);
1392 $link = $LINKSDB[$id]; // Read database
1393 if (!$link) { header('Location: ?'); exit; } // Link not found in database.
1394 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1397 'link_is_new' => false,
1398 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1399 'tags' => $LINKSDB->linksCountPerTag(),
1401 $pluginManager->executeHooks('render_editlink', $data);
1403 foreach ($data as $key => $value) {
1404 $PAGE->assign($key, $value);
1407 $PAGE->renderPage('editlink');
1411 // -------- User want to post a new link: Display link edit form.
1412 if (isset($_GET['post'])) {
1413 $url = cleanup_url($_GET['post']);
1415 $link_is_new = false;
1416 // Check if URL is not already in database (in this case, we will edit the existing link)
1417 $link = $LINKSDB->getLinkFromUrl($url);
1420 $link_is_new = true;
1421 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1422 // Get title if it was provided in URL (by the bookmarklet).
1423 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1424 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1425 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1426 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1427 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1428 // 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.)
1429 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1430 // Short timeout to keep the application responsive
1431 // The callback will fill $charset and $title with data from the downloaded page.
1432 get_http_response($url, 25, 4194304, get_curl_download_callback($charset, $title));
1433 if (! empty($title) && strtolower($charset) != 'utf-8') {
1434 $title = mb_convert_encoding($title, 'utf-8', $charset);
1439 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1440 $title = $conf->get('general.default_note_title', t('Note: '));
1442 $url = escape($url);
1443 $title = escape($title);
1446 'linkdate' => $linkdate,
1449 'description' => $description,
1451 'private' => $private,
1454 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1459 'link_is_new' => $link_is_new,
1460 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1461 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1462 'tags' => $LINKSDB->linksCountPerTag(),
1463 'default_private_links' => $conf->get('privacy.default_private_links', false),
1465 $pluginManager->executeHooks('render_editlink', $data);
1467 foreach ($data as $key => $value) {
1468 $PAGE->assign($key, $value);
1471 $PAGE->renderPage('editlink');
1475 if ($targetPage == Router
::$PAGE_EXPORT) {
1476 // Export links as a Netscape Bookmarks file
1478 if (empty($_GET['selection'])) {
1479 $PAGE->renderPage('export');
1483 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1484 $selection = $_GET['selection'];
1485 if (isset($_GET['prepend_note_url'])) {
1486 $prependNoteUrl = $_GET['prepend_note_url'];
1488 $prependNoteUrl = false;
1494 NetscapeBookmarkUtils
::filterAndFormat(
1501 } catch (Exception
$exc) {
1502 header('Content-Type: text/plain; charset=utf-8');
1503 echo $exc->getMessage();
1506 $now = new DateTime();
1507 header('Content-Type: text/html; charset=utf-8');
1509 'Content-disposition: attachment; filename=bookmarks_'
1510 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1512 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1513 $PAGE->assign('eol', PHP_EOL
);
1514 $PAGE->assign('selection', $selection);
1515 $PAGE->renderPage('export.bookmarks');
1519 if ($targetPage == Router
::$PAGE_IMPORT) {
1520 // Upload a Netscape bookmark dump to import its contents
1522 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1523 // Show import dialog
1526 get_max_upload_size(
1527 ini_get('post_max_size'),
1528 ini_get('upload_max_filesize'),
1534 get_max_upload_size(
1535 ini_get('post_max_size'),
1536 ini_get('upload_max_filesize'),
1540 $PAGE->renderPage('import');
1544 // Import bookmarks from an uploaded file
1545 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1546 // The file is too big or some form field may be missing.
1549 'The file you are trying to upload is probably bigger than what this webserver can accept'
1550 .' (%s). Please upload in smaller chunks.'
1552 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1554 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1557 if (! $sessionManager->checkToken($_POST['token'])) {
1558 die('Wrong token.');
1560 $status = NetscapeBookmarkUtils
::import(
1567 echo '<script>alert("'.$status.'");document.location=\'?do='
1568 .Router
::$PAGE_IMPORT .'\';</script>';
1572 // Plugin administration page
1573 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1574 $pluginMeta = $pluginManager->getPluginsMeta();
1576 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1577 $enabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] !== false; });
1579 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1582 function($a, $b) { return $a
['order'] - $b
['order']; }
1584 $disabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] === false; });
1586 $PAGE->assign('enabledPlugins', $enabledPlugins);
1587 $PAGE->assign('disabledPlugins', $disabledPlugins);
1588 $PAGE->renderPage('pluginsadmin');
1592 // Plugin administration form action
1593 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1595 if (isset($_POST['parameters_form'])) {
1596 unset($_POST['parameters_form']);
1597 foreach ($_POST as $param => $value) {
1598 $conf->set('plugins.'. $param, escape($value));
1602 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1604 $conf->write(isLoggedIn());
1605 $history->updateSettings();
1607 catch (Exception
$e) {
1609 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1613 // TODO: do not handle exceptions/errors in JS.
1614 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do='. Router
::$PAGE_PLUGINSADMIN .'\';</script>';
1617 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1621 // Get a fresh token
1622 if ($targetPage == Router
::$GET_TOKEN) {
1623 header('Content-Type:text/plain');
1624 echo $sessionManager->generateToken($conf);
1628 // -------- Otherwise, simply display search form and links:
1629 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
1634 * Template for the list of links (<div id="linklist">)
1635 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1637 * @param pageBuilder $PAGE pageBuilder instance.
1638 * @param LinkDB $LINKSDB LinkDB instance.
1639 * @param ConfigManager $conf Configuration Manager instance.
1640 * @param PluginManager $pluginManager Plugin Manager instance.
1642 function buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager)
1644 // Used in templates
1645 if (isset($_GET['searchtags'])) {
1646 if (! empty($_GET['searchtags'])) {
1647 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1649 $searchtags = false;
1654 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1657 if (! empty($_SERVER['QUERY_STRING'])
1658 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1660 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1661 } catch (LinkNotFoundException
$e) {
1662 $PAGE->render404($e->getMessage());
1666 // Filter links according search parameters.
1667 $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all';
1669 'searchtags' => $searchtags,
1670 'searchterm' => $searchterm,
1672 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1675 // ---- Handle paging.
1677 foreach ($linksToDisplay as $key => $value) {
1683 // Select articles according to paging.
1684 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1685 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1686 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1687 $page = $page < 1 ? 1 : $page;
1688 $page = $page > $pagecount ? $pagecount : $page;
1690 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1691 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1692 $linkDisp = array();
1693 while ($i<$end && $i<count($keys))
1695 $link = $linksToDisplay[$keys[$i]];
1696 $link['description'] = format_description(
1697 $link['description'],
1698 $conf->get('redirector.url'),
1699 $conf->get('redirector.encode_url')
1701 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1702 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1703 $link['timestamp'] = $link['created']->getTimestamp();
1704 if (! empty($link['updated'])) {
1705 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1707 $link['updated_timestamp'] = '';
1709 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1710 uasort($taglist, 'strcasecmp');
1711 $link['taglist'] = $taglist;
1712 // Check for both signs of a note: starting with ? and 7 chars long.
1713 if ($link['url'][0] === '?' &&
1714 strlen($link['url']) === 7) {
1715 $link['url'] = index_url($_SERVER) . $link['url'];
1718 $linkDisp[$keys[$i]] = $link;
1722 // Compute paging navigation
1723 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1724 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1725 $previous_page_url = '';
1726 if ($i != count($keys)) {
1727 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1731 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1734 // Fill all template fields.
1736 'previous_page_url' => $previous_page_url,
1737 'next_page_url' => $next_page_url,
1738 'page_current' => $page,
1739 'page_max' => $pagecount,
1740 'result_count' => count($linksToDisplay),
1741 'search_term' => $searchterm,
1742 'search_tags' => $searchtags,
1743 'visibility' => ! empty($_SESSION['privateonly']) ? 'private' : '',
1744 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1745 'links' => $linkDisp,
1748 // If there is only a single link, we change on-the-fly the title of the page.
1749 if (count($linksToDisplay) == 1) {
1750 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1753 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => isLoggedIn()));
1755 foreach ($data as $key => $value) {
1756 $PAGE->assign($key, $value);
1763 * Compute the thumbnail for a link.
1765 * With a link to the original URL.
1766 * Understands various services (youtube.com...)
1767 * Input: $url = URL for which the thumbnail must be found.
1768 * $href = if provided, this URL will be followed instead of $url
1769 * Returns an associative array with thumbnail attributes (src,href,width,height,style,alt)
1770 * Some of them may be missing.
1771 * Return an empty array if no thumbnail available.
1773 * @param ConfigManager $conf Configuration Manager instance.
1774 * @param string $url
1775 * @param string|bool $href
1779 function computeThumbnail($conf, $url, $href = false)
1781 if (!$conf->get('thumbnail.enable_thumbnails')) return array();
1782 if ($href==false) $href=$url;
1784 // For most hosts, the URL of the thumbnail can be easily deduced from the URL of the link.
1785 // (e.g. http://www.youtube.com/watch?v=spVypYk4kto ---> http://img.youtube.com/vi/spVypYk4kto/default.jpg )
1786 // ^^^^^^^^^^^ ^^^^^^^^^^^
1787 $domain = parse_url($url,PHP_URL_HOST
);
1788 if ($domain=='youtube.com' || $domain=='www.youtube.com')
1790 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract video ID and get thumbnail
1791 if (!empty($params['v'])) return array('src'=>'https://img.youtube.com/vi/'.$params['v'].'/default.jpg',
1792 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1794 if ($domain=='youtu.be') // Youtube short links
1796 $path = parse_url($url,PHP_URL_PATH
);
1797 return array('src'=>'https://img.youtube.com/vi'.$path.'/default.jpg',
1798 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1800 if ($domain=='pix.toile-libre.org') // pix.toile-libre.org image hosting
1802 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract image filename.
1803 if (!empty($params) && !empty($params['img'])) return array('src'=>'http://pix.toile-libre.org/upload/thumb/'.urlencode($params['img']),
1804 'href'=>$href,'style'=>'max-width:120px; max-height:150px','alt'=>'pix.toile-libre.org thumbnail');
1807 if ($domain=='imgur.com')
1809 $path = parse_url($url,PHP_URL_PATH
);
1810 if (startsWith($path,'/a/')) return array(); // Thumbnails for albums are not available.
1811 if (startsWith($path,'/r/')) return array('src'=>'https://i.imgur.com/'.basename($path).'s.jpg',
1812 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1813 if (startsWith($path,'/gallery/')) return array('src'=>'https://i.imgur.com'.substr($path,8).'s.jpg',
1814 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1816 if (substr_count($path,'/')==1) return array('src'=>'https://i.imgur.com/'.substr($path,1).'s.jpg',
1817 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1819 if ($domain=='i.imgur.com')
1821 $pi = pathinfo(parse_url($url,PHP_URL_PATH
));
1822 if (!empty($pi['filename'])) return array('src'=>'https://i.imgur.com/'.$pi['filename'].'s.jpg',
1823 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1825 if ($domain=='dailymotion.com' || $domain=='www.dailymotion.com')
1827 if (strpos($url,'dailymotion.com/video/')!==false)
1829 $thumburl=str_replace('dailymotion.com/video/','dailymotion.com/thumbnail/video/',$url);
1830 return array('src'=>$thumburl,
1831 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'DailyMotion thumbnail');
1834 if (endsWith($domain,'.imageshack.us'))
1836 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1837 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1839 $thumburl = substr($url,0,strlen($url)-strlen($ext)).'th.'.$ext;
1840 return array('src'=>$thumburl,
1841 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'imageshack.us thumbnail');
1845 // Some other hosts are SLOW AS HELL and usually require an extra HTTP request to get the thumbnail URL.
1846 // So we deport the thumbnail generation in order not to slow down page generation
1847 // (and we also cache the thumbnail)
1849 if (! $conf->get('thumbnail.enable_localcache')) return array(); // If local cache is disabled, no thumbnails for services which require the use a local cache.
1851 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com')
1852 || $domain=='vimeo.com'
1853 || $domain=='ted.com' || endsWith($domain,'.ted.com')
1854 || $domain=='xkcd.com' || endsWith($domain,'.xkcd.com')
1857 if ($domain=='vimeo.com')
1858 { // Make sure this vimeo URL points to a video (/xxx... where xxx is numeric)
1859 $path = parse_url($url,PHP_URL_PATH
);
1860 if (!preg_match('!/\d+.+?!',$path)) return array(); // This is not a single video URL.
1862 if ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
1863 { // Make sure this URL points to a single comic (/xxx... where xxx is numeric)
1864 $path = parse_url($url,PHP_URL_PATH
);
1865 if (!preg_match('!/\d+.+?!',$path)) return array();
1867 if ($domain=='ted.com' || endsWith($domain,'.ted.com'))
1868 { // Make sure this TED URL points to a video (/talks/...)
1869 $path = parse_url($url,PHP_URL_PATH
);
1870 if ("/talks/" !== substr($path,0,7)) return array(); // This is not a single video URL.
1872 $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)
1873 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1874 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1877 // For all other, we try to make a thumbnail of links ending with .jpg/jpeg/png/gif
1878 // Technically speaking, we should download ALL links and check their Content-Type to see if they are images.
1879 // But using the extension will do.
1880 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1881 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1883 $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)
1884 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1885 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1887 return array(); // No thumbnail.
1892 // Returns the HTML code to display a thumbnail for a link
1893 // with a link to the original URL.
1894 // Understands various services (youtube.com...)
1895 // Input: $url = URL for which the thumbnail must be found.
1896 // $href = if provided, this URL will be followed instead of $url
1897 // Returns '' if no thumbnail available.
1898 function thumbnail($url,$href=false)
1902 $t = computeThumbnail($conf, $url,$href);
1903 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1905 $html='<a href="'.escape($t['href']).'"><img src="'.escape($t['src']).'"';
1906 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1907 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1908 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1909 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1914 // Returns the HTML code to display a thumbnail for a link
1915 // for the picture wall (using lazy image loading)
1916 // Understands various services (youtube.com...)
1917 // Input: $url = URL for which the thumbnail must be found.
1918 // $href = if provided, this URL will be followed instead of $url
1919 // Returns '' if no thumbnail available.
1920 function lazyThumbnail($conf, $url,$href=false)
1924 $t = computeThumbnail($conf, $url,$href);
1925 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1927 $html='<a href="'.escape($t['href']).'">';
1930 $html.='<img class="b-lazy" src="#" data-src="'.escape($t['src']).'"';
1932 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1933 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1934 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1935 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1938 // No-JavaScript fallback.
1939 $html.='<noscript><img src="'.escape($t['src']).'"';
1940 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1941 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1942 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1943 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1944 $html.='></noscript></a>';
1952 * This function should NEVER be called if the file data/config.php exists.
1954 * @param ConfigManager $conf Configuration Manager instance.
1955 * @param SessionManager $sessionManager SessionManager instance
1957 function install($conf, $sessionManager) {
1958 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1959 if (endsWith($_SERVER['HTTP_HOST'],'.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions',0705);
1962 // This part makes sure sessions works correctly.
1963 // (Because on some hosts, session.save_path may not be set correctly,
1964 // or we may not have write access to it.)
1965 if (isset($_GET['test_session']) && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working'))
1967 // Step 2: Check if data in session is correct.
1969 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1970 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1971 'and that you have write access to it.<br>'.
1972 'It currently points to %s.<br>'.
1973 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1974 'or any custom hostname without a dot causes cookie storage to fail. '.
1975 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1977 $msg = sprintf($msg, session_save_path());
1979 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1982 if (!isset($_SESSION['session_tested']))
1983 { // Step 1 : Try to store data in session and reload page.
1984 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1985 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1987 if (isset($_GET['test_session']))
1988 { // Step 3: Sessions are OK. Remove test parameter from URL.
1989 header('Location: '.index_url($_SERVER));
1993 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
1996 if (!empty($_POST['continent']) && !empty($_POST['city'])
1997 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1999 $tz = $_POST['continent'].'/'.$_POST['city'];
2001 $conf->set('general.timezone', $tz);
2002 $login = $_POST['setlogin'];
2003 $conf->set('credentials.login', $login);
2004 $salt = sha1(uniqid('', true) .'_'. mt_rand());
2005 $conf->set('credentials.salt', $salt);
2006 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
2007 if (!empty($_POST['title'])) {
2008 $conf->set('general.title', escape($_POST['title']));
2010 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
2012 $conf->set('translation.language', escape($_POST['language']));
2013 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
2014 $conf->set('api.enabled', !empty($_POST['enableApi']));
2017 generate_api_secret(
2018 $conf->get('credentials.login'),
2019 $conf->get('credentials.salt')
2023 // Everything is ok, let's create config file.
2024 $conf->write(isLoggedIn());
2026 catch(Exception
$e) {
2028 'ERROR while writing config file after installation.' . PHP_EOL
.
2032 // TODO: do not handle exceptions/errors in JS.
2033 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
2036 echo '<script>alert("Shaarli is now configured. Please enter your login/password and start shaaring your links!");document.location=\'?do=login\';</script>';
2040 $PAGE = new PageBuilder($conf, null, $sessionManager->generateToken());
2041 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
2042 $PAGE->assign('continents', $continents);
2043 $PAGE->assign('cities', $cities);
2044 $PAGE->assign('languages', Languages
::getAvailableLanguages());
2045 $PAGE->renderPage('install');
2050 * Because some f*cking services like flickr require an extra HTTP request to get the thumbnail URL,
2051 * I have deported the thumbnail URL code generation here, otherwise this would slow down page generation.
2052 * The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail.
2053 * This function is called by passing the URL:
2054 * http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL]
2055 * [URL] is the URL of the link (e.g. a flickr page)
2056 * [HMAC] is the signature for the [URL] (so that these URL cannot be forged).
2057 * The function below will fetch the image from the webservice and store it in the cache.
2059 * @param ConfigManager $conf Configuration Manager instance,
2061 function genThumbnail($conf)
2063 // Make sure the parameters in the URL were generated by us.
2064 $sign = hash_hmac('sha256', $_GET['url'], $conf->get('credentials.salt'));
2065 if ($sign!=$_GET['hmac']) die('Naughty boy!');
2067 $cacheDir = $conf->get('resource.thumbnails_cache', 'cache');
2068 // Let's see if we don't already have the image for this URL in the cache.
2069 $thumbname=hash('sha1',$_GET['url']).'.jpg';
2070 if (is_file($cacheDir .'/'. $thumbname))
2071 { // We have the thumbnail, just serve it:
2072 header('Content-Type: image/jpeg');
2073 echo file_get_contents($cacheDir .'/'. $thumbname);
2076 // We may also serve a blank image (if service did not respond)
2077 $blankname=hash('sha1',$_GET['url']).'.gif';
2078 if (is_file($cacheDir .'/'. $blankname))
2080 header('Content-Type: image/gif');
2081 echo file_get_contents($cacheDir .'/'. $blankname);
2085 // Otherwise, generate the thumbnail.
2086 $url = $_GET['url'];
2087 $domain = parse_url($url,PHP_URL_HOST
);
2089 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com'))
2091 // Crude replacement to handle new flickr domain policy (They prefer www. now)
2092 $url = str_replace('http://flickr.com/','http://www.flickr.com/',$url);
2094 // Is this a link to an image, or to a flickr page ?
2096 if (endsWith(parse_url($url, PHP_URL_PATH
), '.jpg'))
2097 { // This is a direct link to an image. e.g. http://farm1.staticflickr.com/5/5921913_ac83ed27bd_o.jpg
2098 preg_match('!(http://farm\d+\.staticflickr\.com/\d+/\d+_\w+_)\w.jpg!',$url,$matches);
2099 if (!empty($matches[1])) $imageurl=$matches[1].'m.jpg';
2101 else // This is a flickr page (html)
2103 // Get the flickr html page.
2104 list($headers, $content) = get_http_response($url, 20);
2105 if (strpos($headers[0], '200 OK') !== false)
2107 // flickr now nicely provides the URL of the thumbnail in each flickr page.
2108 preg_match('!<link rel=\"image_src\" href=\"(.+?)\"!', $content, $matches);
2109 if (!empty($matches[1])) $imageurl=$matches[1];
2111 // In albums (and some other pages), the link rel="image_src" is not provided,
2112 // but flickr provides:
2113 // <meta property="og:image" content="http://farm4.staticflickr.com/3398/3239339068_25d13535ff_z.jpg" />
2116 preg_match('!<meta property=\"og:image\" content=\"(.+?)\"!', $content, $matches);
2117 if (!empty($matches[1])) $imageurl=$matches[1];
2123 { // Let's download the image.
2124 // Image is 240x120, so 10 seconds to download should be enough.
2125 list($headers, $content) = get_http_response($imageurl, 10);
2126 if (strpos($headers[0], '200 OK') !== false) {
2127 // Save image to cache.
2128 file_put_contents($cacheDir .'/'. $thumbname, $content);
2129 header('Content-Type: image/jpeg');
2136 elseif ($domain=='vimeo.com' )
2138 // This is more complex: we have to perform a HTTP request, then parse the result.
2139 // Maybe we should deport this to JavaScript ? Example: http://stackoverflow.com/questions/1361149/get-img-thumbnails-from-vimeo/4285098#4285098
2140 $vid = substr(parse_url($url,PHP_URL_PATH
),1);
2141 list($headers, $content) = get_http_response('https://vimeo.com/api/v2/video/'.escape($vid).'.php', 5);
2142 if (strpos($headers[0], '200 OK') !== false) {
2143 $t = unserialize($content);
2144 $imageurl = $t[0]['thumbnail_medium'];
2145 // Then we download the image and serve it to our client.
2146 list($headers, $content) = get_http_response($imageurl, 10);
2147 if (strpos($headers[0], '200 OK') !== false) {
2148 // Save image to cache.
2149 file_put_contents($cacheDir .'/'. $thumbname, $content);
2150 header('Content-Type: image/jpeg');
2157 elseif ($domain=='ted.com' || endsWith($domain,'.ted.com'))
2159 // The thumbnail for TED talks is located in the <link rel="image_src" [...]> tag on that page
2160 // http://www.ted.com/talks/mikko_hypponen_fighting_viruses_defending_the_net.html
2161 // <link rel="image_src" href="http://images.ted.com/images/ted/28bced335898ba54d4441809c5b1112ffaf36781_389x292.jpg" />
2162 list($headers, $content) = get_http_response($url, 5);
2163 if (strpos($headers[0], '200 OK') !== false) {
2164 // Extract the link to the thumbnail
2165 preg_match('!link rel="image_src" href="(http://images.ted.com/images/ted/.+_\d+x\d+\.jpg)"!', $content, $matches);
2166 if (!empty($matches[1]))
2167 { // Let's download the image.
2168 $imageurl=$matches[1];
2169 // No control on image size, so wait long enough
2170 list($headers, $content) = get_http_response($imageurl, 20);
2171 if (strpos($headers[0], '200 OK') !== false) {
2172 $filepath = $cacheDir .'/'. $thumbname;
2173 file_put_contents($filepath, $content); // Save image to cache.
2174 if (resizeImage($filepath))
2176 header('Content-Type: image/jpeg');
2177 echo file_get_contents($filepath);
2185 elseif ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
2187 // There is no thumbnail available for xkcd comics, so download the whole image and resize it.
2188 // http://xkcd.com/327/
2189 // <img src="http://imgs.xkcd.com/comics/exploits_of_a_mom.png" title="<BLABLA>" alt="<BLABLA>" />
2190 list($headers, $content) = get_http_response($url, 5);
2191 if (strpos($headers[0], '200 OK') !== false) {
2192 // Extract the link to the thumbnail
2193 preg_match('!<img src="(http://imgs.xkcd.com/comics/.*)" title="[^s]!', $content, $matches);
2194 if (!empty($matches[1]))
2195 { // Let's download the image.
2196 $imageurl=$matches[1];
2197 // No control on image size, so wait long enough
2198 list($headers, $content) = get_http_response($imageurl, 20);
2199 if (strpos($headers[0], '200 OK') !== false) {
2200 $filepath = $cacheDir.'/'.$thumbname;
2201 // Save image to cache.
2202 file_put_contents($filepath, $content);
2203 if (resizeImage($filepath))
2205 header('Content-Type: image/jpeg');
2206 echo file_get_contents($filepath);
2216 // For all other domains, we try to download the image and make a thumbnail.
2217 // We allow 30 seconds max to download (and downloads are limited to 4 Mb)
2218 list($headers, $content) = get_http_response($url, 30);
2219 if (strpos($headers[0], '200 OK') !== false) {
2220 $filepath = $cacheDir .'/'.$thumbname;
2221 // Save image to cache.
2222 file_put_contents($filepath, $content);
2223 if (resizeImage($filepath))
2225 header('Content-Type: image/jpeg');
2226 echo file_get_contents($filepath);
2233 // Otherwise, return an empty image (8x8 transparent gif)
2234 $blankgif = base64_decode('R0lGODlhCAAIAIAAAP///////yH5BAEKAAEALAAAAAAIAAgAAAIHjI+py+1dAAA7');
2235 // Also put something in cache so that this URL is not requested twice.
2236 file_put_contents($cacheDir .'/'. $blankname, $blankgif);
2237 header('Content-Type: image/gif');
2241 // Make a thumbnail of the image (to width: 120 pixels)
2242 // Returns true if success, false otherwise.
2243 function resizeImage($filepath)
2245 if (!function_exists('imagecreatefromjpeg')) return false; // GD not present: no thumbnail possible.
2247 // Trick: some stupid people rename GIF as JPEG... or else.
2248 // So we really try to open each image type whatever the extension is.
2249 $header=file_get_contents($filepath,false,NULL,0,256); // Read first 256 bytes and try to sniff file type.
2251 $i=strpos($header,'GIF8'); if (($i!==false) && ($i==0)) $im = imagecreatefromgif($filepath); // Well this is crude, but it should be enough.
2252 $i=strpos($header,'PNG'); if (($i!==false) && ($i==1)) $im = imagecreatefrompng($filepath);
2253 $i=strpos($header,'JFIF'); if ($i!==false) $im = imagecreatefromjpeg($filepath);
2254 if (!$im) return false; // Unable to open image (corrupted or not an image)
2257 $ystart = 0; $yheight=$h;
2258 if ($h>$w) { $ystart
= ($h
/2)-($w
/2); $yheight
=$w
/2; }
2259 $nw = 120; // Desired width
2260 $nh = min(floor(($h*$nw)/$w),120); // Compute new width/height, but maximum 120 pixels height.
2262 $im2 = imagecreatetruecolor($nw,$nh);
2263 imagecopyresampled($im2, $im, 0, 0, 0, $ystart, $nw, $nh, $w, $yheight);
2264 imageinterlace($im2,true); // For progressive JPEG.
2265 $tempname=$filepath.'_TEMP.jpg';
2266 imagejpeg($im2, $tempname, 90);
2270 rename($tempname,$filepath); // Overwrite original picture with thumbnail.
2274 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=genthumbnail')) { genThumbnail($conf
); exit; } // Thumbnail generation/cache does not need the link database.
2275 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf
); exit; }
2276 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
2277 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
2281 $history = new History($conf->get('resource.history'));
2282 } catch(Exception
$e) {
2283 die($e->getMessage());
2286 $linkDb = new LinkDB(
2287 $conf->get('resource.datastore'),
2289 $conf->get('privacy.hide_public_links'),
2290 $conf->get('redirector.url'),
2291 $conf->get('redirector.encode_url')
2294 $container = new \Slim\
Container();
2295 $container['conf'] = $conf;
2296 $container['plugins'] = $pluginManager;
2297 $container['history'] = $history;
2298 $app = new \Slim\
App($container);
2301 $app->group('/api/v1', function() {
2302 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
2303 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
2304 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
2305 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
2306 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
2307 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
2308 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
2309 })->add('\Shaarli\Api\ApiMiddleware');
2311 $response = $app->run(true);
2312 // Hack to make Slim and Shaarli router work together:
2313 // If a Slim route isn't found and NOT API call, we call renderPage().
2314 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
2315 // We use UTF-8 for proper international characters handling.
2316 header('Content-Type: text/html; charset=utf-8');
2317 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager);
2319 $app->respond($response);