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\LoginManager
;
82 use \Shaarli\SessionManager
;
84 // Ensure the PHP version is supported
86 ApplicationUtils
::checkPHPVersion('5.5', PHP_VERSION
);
87 } catch(Exception
$exc) {
88 header('Content-Type: text/plain; charset=utf-8');
89 echo $exc->getMessage();
93 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
95 // Force cookie path (but do not change lifetime)
96 $cookie = session_get_cookie_params();
98 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
99 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
101 // Set default cookie expiration and path.
102 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
103 // Set session parameters on server side.
104 // Use cookies to store session.
105 ini_set('session.use_cookies', 1);
106 // Force cookies for session (phpsessionID forbidden in URL).
107 ini_set('session.use_only_cookies', 1);
108 // Prevent PHP form using sessionID in URL if cookies are disabled.
109 ini_set('session.use_trans_sid', false);
111 session_name('shaarli');
112 // Start session if needed (Some server auto-start sessions).
113 if (session_id() == '') {
117 // Regenerate session ID if invalid or not defined in cookie.
118 if (isset($_COOKIE['shaarli']) && !SessionManager
::checkId($_COOKIE['shaarli'])) {
119 session_regenerate_id(true);
120 $_COOKIE['shaarli'] = session_id();
123 $conf = new ConfigManager();
124 $sessionManager = new SessionManager($_SESSION, $conf);
125 $loginManager = new LoginManager($GLOBALS, $conf, $sessionManager);
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')));
181 $loginManager->checkLoginState($_SERVER, $_SESSION, $_COOKIE, WEB_PATH
, STAY_SIGNED_IN_TOKEN
);
184 * Adapter function for PageBuilder
186 * TODO: update PageBuilder and tests
188 function isLoggedIn()
190 global $loginManager;
191 return $loginManager->isLoggedIn();
195 // ------------------------------------------------------------------------------------------
196 // Process login form: Check if login/password is correct.
197 if (isset($_POST['login'])) {
198 if (! $loginManager->canLogin($_SERVER)) {
199 die(t('I said: NO. You are banned for the moment. Go away.'));
201 if (isset($_POST['password'])
202 && $sessionManager->checkToken($_POST['token'])
203 && $loginManager->checkCredentials($_SERVER, $_POST['login'], $_POST['password'])
205 // Login/password is OK.
206 $loginManager->handleSuccessfulLogin($_SERVER);
208 // If user wants to keep the session cookie even after the browser closes:
209 if (!empty($_POST['longlastingsession'])) {
210 $_SESSION['longlastingsession'] = 31536000; // (31536000 seconds = 1 year)
211 $expiration = time() +
$_SESSION['longlastingsession']; // calculate relative cookie expiration (1 year from now)
212 setcookie($sessionManager::$LOGGED_IN_COOKIE, STAY_SIGNED_IN_TOKEN
, $expiration, WEB_PATH
);
213 $_SESSION['expires_on'] = $expiration; // Set session expiration on server-side.
216 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
217 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]) . '/';
219 session_set_cookie_params($_SESSION['longlastingsession'],$cookiedir,$_SERVER['SERVER_NAME']); // Set session cookie expiration on client side
220 // Note: Never forget the trailing slash on the cookie path!
221 session_regenerate_id(true); // Send cookie with new expiration date to browser.
223 else // Standard session expiration (=when browser closes)
225 $cookiedir = ''; if(dirname($_SERVER['SCRIPT_NAME'])!='/') $cookiedir=dirname($_SERVER["SCRIPT_NAME"]).'/';
226 session_set_cookie_params(0,$cookiedir,$_SERVER['SERVER_NAME']); // 0 means "When browser closes"
227 session_regenerate_id(true);
230 // Optional redirect after login:
231 if (isset($_GET['post'])) {
232 $uri = '?post='. urlencode($_GET['post']);
233 foreach (array('description', 'source', 'title', 'tags') as $param) {
234 if (!empty($_GET[$param])) {
235 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
238 header('Location: '. $uri);
242 if (isset($_GET['edit_link'])) {
243 header('Location: ?edit_link='. escape($_GET['edit_link']));
247 if (isset($_POST['returnurl'])) {
248 // Prevent loops over login screen.
249 if (strpos($_POST['returnurl'], 'do=login') === false) {
250 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
254 header('Location: ?'); exit;
256 $loginManager->handleFailedLogin($_SERVER);
257 $redir = '&username='. urlencode($_POST['login']);
258 if (isset($_GET['post'])) {
259 $redir .= '&post=' . urlencode($_GET['post']);
260 foreach (array('description', 'source', 'title', 'tags') as $param) {
261 if (!empty($_GET[$param])) {
262 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
266 // Redirect to login screen.
267 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
272 // ------------------------------------------------------------------------------------------
273 // Token management for XSRF protection
274 // Token should be used in any form which acts on data (create,update,delete,import...).
275 if (!isset($_SESSION['tokens'])) $_SESSION['tokens']=array(); // Token are attached to the session.
278 * Daily RSS feed: 1 RSS entry per day giving all the links on that day.
279 * Gives the last 7 days (which have links).
280 * This RSS feed cannot be filtered.
282 * @param ConfigManager $conf Configuration Manager instance
283 * @param LoginManager $loginManager LoginManager instance
285 function showDailyRSS($conf, $loginManager) {
287 $query = $_SERVER['QUERY_STRING'];
288 $cache = new CachedPage(
289 $conf->get('config.PAGE_CACHE'),
291 startsWith($query,'do=dailyrss') && !$loginManager->isLoggedIn()
293 $cached = $cache->cachedVersion();
294 if (!empty($cached)) {
299 // If cached was not found (or not usable), then read the database and build the response:
300 // Read links from database (and filter private links if used it not logged in).
301 $LINKSDB = new LinkDB(
302 $conf->get('resource.datastore'),
303 $loginManager->isLoggedIn(),
304 $conf->get('privacy.hide_public_links'),
305 $conf->get('redirector.url'),
306 $conf->get('redirector.encode_url')
309 /* Some Shaarlies may have very few links, so we need to look
310 back in time until we have enough days ($nb_of_days).
312 $nb_of_days = 7; // We take 7 days.
313 $today = date('Ymd');
316 foreach ($LINKSDB as $link) {
317 $day = $link['created']->format('Ymd'); // Extract day (without time)
318 if (strcmp($day, $today) < 0) {
319 if (empty($days[$day])) {
320 $days[$day] = array();
322 $days[$day][] = $link;
325 if (count($days) > $nb_of_days) {
326 break; // Have we collected enough days?
330 // Build the RSS feed.
331 header('Content-Type: application/rss+xml; charset=utf-8');
332 $pageaddr = escape(index_url($_SERVER));
333 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
335 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
336 echo '<link>'. $pageaddr .'</link>';
337 echo '<description>Daily shared links</description>';
338 echo '<language>en-en</language>';
339 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
342 foreach ($days as $day => $links) {
343 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
344 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
346 // We pre-format some fields for proper output.
347 foreach ($links as &$link) {
348 $link['formatedDescription'] = format_description(
349 $link['description'],
350 $conf->get('redirector.url'),
351 $conf->get('redirector.encode_url')
353 $link['thumbnail'] = thumbnail($conf, $link['url']);
354 $link['timestamp'] = $link['created']->getTimestamp();
355 if (startsWith($link['url'], '?')) {
356 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
360 // Then build the HTML for this day:
362 $tpl->assign('title', $conf->get('general.title'));
363 $tpl->assign('daydate', $dayDate->getTimestamp());
364 $tpl->assign('absurl', $absurl);
365 $tpl->assign('links', $links);
366 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
367 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
368 $html = $tpl->draw('dailyrss', true);
370 echo $html . PHP_EOL
;
372 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
374 $cache->cache(ob_get_contents());
380 * Show the 'Daily' page.
382 * @param PageBuilder $pageBuilder Template engine wrapper.
383 * @param LinkDB $LINKSDB LinkDB instance.
384 * @param ConfigManager $conf Configuration Manager instance.
385 * @param PluginManager $pluginManager Plugin Manager instane.
387 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager)
389 $day = date('Ymd', strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
390 if (isset($_GET['day'])) {
394 $days = $LINKSDB->days();
395 $i = array_search($day, $days);
396 if ($i === false && count($days)) {
397 // no links for day, but at least one day with links
398 $i = count($days) - 1;
406 $previousday=$days[$i - 1];
408 if ($i < count($days) - 1) {
409 $nextday = $days[$i +
1];
413 $linksToDisplay = $LINKSDB->filterDay($day);
414 } catch (Exception
$exc) {
416 $linksToDisplay = array();
419 // We pre-format some fields for proper output.
420 foreach($linksToDisplay as $key => $link) {
421 $taglist = explode(' ',$link['tags']);
422 uasort($taglist, 'strcasecmp');
423 $linksToDisplay[$key]['taglist']=$taglist;
424 $linksToDisplay[$key]['formatedDescription'] = format_description(
425 $link['description'],
426 $conf->get('redirector.url'),
427 $conf->get('redirector.encode_url')
429 $linksToDisplay[$key]['thumbnail'] = thumbnail($conf, $link['url']);
430 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
433 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
435 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
436 'linksToDisplay' => $linksToDisplay,
437 'day' => $dayDate->getTimestamp(),
438 'dayDate' => $dayDate,
439 'previousday' => $previousday,
440 'nextday' => $nextday,
443 /* Hook is called before column construction so that plugins don't have
444 to deal with columns. */
445 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
447 /* We need to spread the articles on 3 columns.
448 I did not want to use a JavaScript lib like http://masonry.desandro.com/
449 so I manually spread entries with a simple method: I roughly evaluate the
450 height of a div according to title and description length.
452 $columns = array(array(), array(), array()); // Entries to display, for each column.
453 $fill = array(0, 0, 0); // Rough estimate of columns fill.
454 foreach($data['linksToDisplay'] as $key => $link) {
455 // Roughly estimate length of entry (by counting characters)
456 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
457 // Description: 836 characters gives roughly 342 pixel height.
458 // This is not perfect, but it's usually OK.
459 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
460 if ($link['thumbnail']) {
461 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
463 // Then put in column which is the less filled:
464 $smallest = min($fill); // find smallest value in array.
465 $index = array_search($smallest, $fill); // find index of this smallest value.
466 array_push($columns[$index], $link); // Put entry in this column.
467 $fill[$index] +
= $length;
470 $data['cols'] = $columns;
472 foreach ($data as $key => $value) {
473 $pageBuilder->assign($key, $value);
476 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
477 $pageBuilder->renderPage('daily');
482 * Renders the linklist
484 * @param pageBuilder $PAGE pageBuilder instance.
485 * @param LinkDB $LINKSDB LinkDB instance.
486 * @param ConfigManager $conf Configuration Manager instance.
487 * @param PluginManager $pluginManager Plugin Manager instance.
489 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager) {
490 buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager, $loginManager);
491 $PAGE->renderPage('linklist');
495 * Render HTML page (according to URL parameters and user rights)
497 * @param ConfigManager $conf Configuration Manager instance.
498 * @param PluginManager $pluginManager Plugin Manager instance,
499 * @param LinkDB $LINKSDB
500 * @param History $history instance
501 * @param SessionManager $sessionManager SessionManager instance
502 * @param LoginManager $loginManager LoginManager instance
504 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager, $loginManager)
506 $updater = new Updater(
507 read_updates_file($conf->get('resource.updates')),
510 $loginManager->isLoggedIn()
513 $newUpdates = $updater->update();
514 if (! empty($newUpdates)) {
516 $conf->get('resource.updates'),
517 $updater->getDoneUpdates()
521 catch(Exception
$e) {
522 die($e->getMessage());
525 $PAGE = new PageBuilder($conf, $LINKSDB, $sessionManager->generateToken());
526 $PAGE->assign('linkcount', count($LINKSDB));
527 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
528 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
530 // Determine which page will be rendered.
531 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
532 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
535 // if the user isn't logged in
536 !$loginManager->isLoggedIn() &&
537 // and Shaarli doesn't have public content...
538 $conf->get('privacy.hide_public_links') &&
539 // and is configured to enforce the login
540 $conf->get('privacy.force_login') &&
541 // and the current page isn't already the login page
542 $targetPage !== Router
::$PAGE_LOGIN &&
543 // and the user is not requesting a feed (which would lead to a different content-type as expected)
544 $targetPage !== Router
::$PAGE_FEED_ATOM &&
545 $targetPage !== Router
::$PAGE_FEED_RSS
547 // force current page to be the login page
548 $targetPage = Router
::$PAGE_LOGIN;
551 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
552 // Then assign generated data to RainTPL.
553 $common_hooks = array(
559 foreach($common_hooks as $name) {
560 $plugin_data = array();
561 $pluginManager->executeHooks('render_' . $name, $plugin_data,
563 'target' => $targetPage,
564 'loggedin' => $loginManager->isLoggedIn()
567 $PAGE->assign('plugins_' . $name, $plugin_data);
570 // -------- Display login form.
571 if ($targetPage == Router
::$PAGE_LOGIN)
573 if ($conf->get('security.open_shaarli')) { header('Location: ?'); exit; } // No need to login for open Shaarli
574 if (isset($_GET['username'])) {
575 $PAGE->assign('username', escape($_GET['username']));
577 $PAGE->assign('returnurl',(isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
578 // add default state of the 'remember me' checkbox
579 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
580 $PAGE->assign('user_can_login', $loginManager->canLogin($_SERVER));
581 $PAGE->assign('pagetitle', t('Login') .' - '. $conf->get('general.title', 'Shaarli'));
582 $PAGE->renderPage('loginform');
585 // -------- User wants to logout.
586 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout'))
588 invalidateCaches($conf->get('resource.page_cache'));
589 $sessionManager->logout(WEB_PATH
);
590 header('Location: ?');
594 // -------- Picture wall
595 if ($targetPage == Router
::$PAGE_PICWALL)
597 // Optionally filter the results:
598 $links = $LINKSDB->filterSearch($_GET);
599 $linksToDisplay = array();
601 // Get only links which have a thumbnail.
602 foreach($links as $link)
604 $permalink='?'.$link['shorturl'];
605 $thumb=lazyThumbnail($conf, $link['url'],$permalink);
606 if ($thumb!='') // Only output links which have a thumbnail.
608 $link['thumbnail']=$thumb; // Thumbnail HTML code.
609 $linksToDisplay[]=$link; // Add to array.
614 'linksToDisplay' => $linksToDisplay,
616 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => $loginManager->isLoggedIn()));
618 foreach ($data as $key => $value) {
619 $PAGE->assign($key, $value);
622 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
623 $PAGE->renderPage('picwall');
627 // -------- Tag cloud
628 if ($targetPage == Router
::$PAGE_TAGCLOUD)
630 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
631 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
632 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
634 // We sort tags alphabetically, then choose a font size according to count.
635 // First, find max value.
637 foreach ($tags as $value) {
638 $maxcount = max($maxcount, $value);
641 alphabetical_sort($tags, false, true);
644 foreach($tags as $key => $value) {
645 if (in_array($key, $filteringTags)) {
648 // Tag font size scaling:
649 // default 15 and 30 logarithm bases affect scaling,
650 // 22 and 6 are arbitrary font sizes for max and min sizes.
651 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
652 $tagList[$key] = array(
654 'size' => number_format($size, 2, '.', ''),
658 $searchTags = implode(' ', escape($filteringTags));
660 'search_tags' => $searchTags,
663 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
665 foreach ($data as $key => $value) {
666 $PAGE->assign($key, $value);
669 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
670 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
671 $PAGE->renderPage('tag.cloud');
676 if ($targetPage == Router
::$PAGE_TAGLIST)
678 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
679 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
680 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
681 foreach ($filteringTags as $tag) {
682 if (array_key_exists($tag, $tags)) {
687 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
688 alphabetical_sort($tags, false, true);
691 $searchTags = implode(' ', escape($filteringTags));
693 'search_tags' => $searchTags,
696 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
698 foreach ($data as $key => $value) {
699 $PAGE->assign($key, $value);
702 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
703 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
704 $PAGE->renderPage('tag.list');
709 if ($targetPage == Router
::$PAGE_DAILY) {
710 showDaily($PAGE, $LINKSDB, $conf, $pluginManager);
713 // ATOM and RSS feed.
714 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
715 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
716 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
719 $query = $_SERVER['QUERY_STRING'];
720 $cache = new CachedPage(
721 $conf->get('resource.page_cache'),
723 startsWith($query,'do='. $targetPage) && !$loginManager->isLoggedIn()
725 $cached = $cache->cachedVersion();
726 if (!empty($cached)) {
732 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, $loginManager->isLoggedIn());
733 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
734 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
735 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
736 $data = $feedGenerator->buildData();
738 // Process plugin hook.
739 $pluginManager->executeHooks('render_feed', $data, array(
740 'loggedin' => $loginManager->isLoggedIn(),
741 'target' => $targetPage,
744 // Render the template.
745 $PAGE->assignAll($data);
746 $PAGE->renderPage('feed.'. $feedType);
747 $cache->cache(ob_get_contents());
752 // Display opensearch plugin (XML)
753 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
754 header('Content-Type: application/xml; charset=utf-8');
755 $PAGE->assign('serverurl', index_url($_SERVER));
756 $PAGE->renderPage('opensearch');
760 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
761 if (isset($_GET['addtag']))
763 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
764 if (empty($_SERVER['HTTP_REFERER'])) { header('Location: ?searchtags='.urlencode($_GET
['addtag'])); exit; } // In case browser does not send HTTP_REFERER
765 parse_str(parse_url($_SERVER['HTTP_REFERER'],PHP_URL_QUERY
), $params);
767 // Prevent redirection loop
768 if (isset($params['addtag'])) {
769 unset($params['addtag']);
772 // Check if this tag is already in the search query and ignore it if it is.
773 // Each tag is always separated by a space
774 if (isset($params['searchtags'])) {
775 $current_tags = explode(' ', $params['searchtags']);
777 $current_tags = array();
780 foreach ($current_tags as $value) {
781 if ($value === $_GET['addtag']) {
786 // Append the tag if necessary
787 if (empty($params['searchtags'])) {
788 $params['searchtags'] = trim($_GET['addtag']);
791 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
794 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
795 header('Location: ?'.http_build_query($params));
799 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
800 if (isset($_GET['removetag'])) {
801 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
802 if (empty($_SERVER['HTTP_REFERER'])) {
803 header('Location: ?');
807 // In case browser does not send HTTP_REFERER
808 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
810 // Prevent redirection loop
811 if (isset($params['removetag'])) {
812 unset($params['removetag']);
815 if (isset($params['searchtags'])) {
816 $tags = explode(' ', $params['searchtags']);
817 // Remove value from array $tags.
818 $tags = array_diff($tags, array($_GET['removetag']));
819 $params['searchtags'] = implode(' ',$tags);
821 if (empty($params['searchtags'])) {
822 unset($params['searchtags']);
825 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
827 header('Location: ?'.http_build_query($params));
831 // -------- User wants to change the number of links per page (linksperpage=...)
832 if (isset($_GET['linksperpage'])) {
833 if (is_numeric($_GET['linksperpage'])) {
834 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
837 if (! empty($_SERVER['HTTP_REFERER'])) {
838 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
842 header('Location: '. $location);
846 // -------- User wants to see only private links (toggle)
847 if (isset($_GET['visibility'])) {
848 if ($_GET['visibility'] === 'private') {
849 // Visibility not set or not already private, set private, otherwise reset it
850 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
851 // See only private links
852 $_SESSION['visibility'] = 'private';
854 unset($_SESSION['visibility']);
856 } elseif ($_GET['visibility'] === 'public') {
857 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
858 // See only public links
859 $_SESSION['visibility'] = 'public';
861 unset($_SESSION['visibility']);
865 if (! empty($_SERVER['HTTP_REFERER'])) {
866 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
870 header('Location: '. $location);
874 // -------- User wants to see only untagged links (toggle)
875 if (isset($_GET['untaggedonly'])) {
876 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
878 if (! empty($_SERVER['HTTP_REFERER'])) {
879 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
883 header('Location: '. $location);
887 // -------- Handle other actions allowed for non-logged in users:
888 if (!$loginManager->isLoggedIn())
890 // User tries to post new link but is not logged in:
891 // Show login screen, then redirect to ?post=...
892 if (isset($_GET['post']))
894 header( // Redirect to login page, then back to post link.
895 'Location: ?do=login&post='.urlencode($_GET['post']).
896 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
897 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
898 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
899 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
904 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
905 if (isset($_GET['edit_link'])) {
906 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
910 exit; // Never remove this one! All operations below are reserved for logged in user.
913 // -------- All other functions are reserved for the registered user:
915 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
916 if ($targetPage == Router
::$PAGE_TOOLS)
919 'pageabsaddr' => index_url($_SERVER),
920 'sslenabled' => is_https($_SERVER),
922 $pluginManager->executeHooks('render_tools', $data);
924 foreach ($data as $key => $value) {
925 $PAGE->assign($key, $value);
928 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
929 $PAGE->renderPage('tools');
933 // -------- User wants to change his/her password.
934 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD)
936 if ($conf->get('security.open_shaarli')) {
937 die(t('You are not supposed to change a password on an Open Shaarli.'));
940 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword']))
942 if (!$sessionManager->checkToken($_POST['token'])) die(t('Wrong token.')); // Go away!
944 // Make sure old password is correct.
945 $oldhash = sha1($_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt'));
946 if ($oldhash!= $conf->get('credentials.hash')) {
947 echo '<script>alert("'. t('The old password is not correct.') .'");document.location=\'?do=changepasswd\';</script>';
951 // Salt renders rainbow-tables attacks useless.
952 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
953 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $conf->get('credentials.login') . $conf->get('credentials.salt')));
955 $conf->write($loginManager->isLoggedIn());
957 catch(Exception
$e) {
959 'ERROR while writing config file after changing password.' . PHP_EOL
.
963 // TODO: do not handle exceptions/errors in JS.
964 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
967 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
970 else // show the change password form.
972 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
973 $PAGE->renderPage('changepassword');
978 // -------- User wants to change configuration
979 if ($targetPage == Router
::$PAGE_CONFIGURE)
981 if (!empty($_POST['title']) )
983 if (!$sessionManager->checkToken($_POST['token'])) {
984 die(t('Wrong token.')); // Go away!
987 if (!empty($_POST['continent']) && !empty($_POST['city'])
988 && isTimeZoneValid($_POST['continent'], $_POST['city'])
990 $tz = $_POST['continent'] . '/' . $_POST['city'];
992 $conf->set('general.timezone', $tz);
993 $conf->set('general.title', escape($_POST['title']));
994 $conf->set('general.header_link', escape($_POST['titleLink']));
995 $conf->set('resource.theme', escape($_POST['theme']));
996 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
997 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
998 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
999 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1000 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1001 $conf->set('api.enabled', !empty($_POST['enableApi']));
1002 $conf->set('api.secret', escape($_POST['apiSecret']));
1003 $conf->set('translation.language', escape($_POST['language']));
1006 $conf->write($loginManager->isLoggedIn());
1007 $history->updateSettings();
1008 invalidateCaches($conf->get('resource.page_cache'));
1010 catch(Exception
$e) {
1012 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1016 // TODO: do not handle exceptions/errors in JS.
1017 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1020 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1023 else // Show the configuration form.
1025 $PAGE->assign('title', $conf->get('general.title'));
1026 $PAGE->assign('theme', $conf->get('resource.theme'));
1027 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1028 list($continents, $cities) = generateTimeZoneData(
1029 timezone_identifiers_list(),
1030 $conf->get('general.timezone')
1032 $PAGE->assign('continents', $continents);
1033 $PAGE->assign('cities', $cities);
1034 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1035 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1036 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1037 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1038 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1039 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1040 $PAGE->assign('api_secret', $conf->get('api.secret'));
1041 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1042 $PAGE->assign('language', $conf->get('translation.language'));
1043 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1044 $PAGE->renderPage('configure');
1049 // -------- User wants to rename a tag or delete it
1050 if ($targetPage == Router
::$PAGE_CHANGETAG)
1052 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1053 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1054 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1055 $PAGE->renderPage('changetag');
1059 if (!$sessionManager->checkToken($_POST['token'])) {
1060 die(t('Wrong token.'));
1063 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), escape($_POST['totag']));
1064 $LINKSDB->save($conf->get('resource.page_cache'));
1065 foreach ($alteredLinks as $link) {
1066 $history->updateLink($link);
1068 $delete = empty($_POST['totag']);
1069 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1070 $count = count($alteredLinks);
1072 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1073 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1074 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1078 // -------- User wants to add a link without using the bookmarklet: Show form.
1079 if ($targetPage == Router
::$PAGE_ADDLINK)
1081 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1082 $PAGE->renderPage('addlink');
1086 // -------- User clicked the "Save" button when editing a link: Save link to database.
1087 if (isset($_POST['save_edit']))
1090 if (! $sessionManager->checkToken($_POST['token'])) {
1091 die(t('Wrong token.'));
1094 // lf_id should only be present if the link exists.
1095 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1096 // Linkdate is kept here to:
1097 // - use the same permalink for notes as they're displayed when creating them
1098 // - let users hack creation date of their posts
1099 // See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare
1100 $linkdate = escape($_POST['lf_linkdate']);
1101 if (isset($LINKSDB[$id])) {
1103 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1104 $updated = new DateTime();
1105 $shortUrl = $LINKSDB[$id]['shorturl'];
1109 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1111 $shortUrl = link_small_hash($created, $id);
1115 // Remove multiple spaces.
1116 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1117 // Remove first '-' char in tags.
1118 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1119 // Remove duplicates.
1120 $tags = implode(' ', array_unique(explode(' ', $tags)));
1122 if (empty(trim($_POST['lf_url
']))) {
1123 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1125 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1129 'title
' => trim($_POST['lf_title
']),
1131 'description
' => $_POST['lf_description
'],
1132 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1133 'created
' => $created,
1134 'updated
' => $updated,
1135 'tags
' => str_replace(',', ' ', $tags),
1136 'shorturl
' => $shortUrl,
1139 // If title is empty, use the URL as title.
1140 if ($link['title
'] == '') {
1141 $link['title
'] = $link['url
'];
1144 $pluginManager->executeHooks('save_link
', $link);
1146 $LINKSDB[$id] = $link;
1147 $LINKSDB->save($conf->get('resource.page_cache
'));
1149 $history->addLink($link);
1151 $history->updateLink($link);
1154 // If we are called from the bookmarklet, we must close the popup:
1155 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1156 echo '<script
>self
.close();</script
>';
1160 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1161 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1162 // Scroll to the link which has been edited.
1163 $location .= '#' . $link['shorturl'];
1164 // After saving the link, redirect to the page the user was on.
1165 header('Location: '. $location);
1169 // -------- User clicked the "Cancel" button when editing a link.
1170 if (isset($_POST['cancel_edit']))
1172 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1173 if (! isset($LINKSDB[$id])) {
1174 header('Location: ?');
1176 // If we are called from the bookmarklet, we must close the popup:
1177 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1178 $link = $LINKSDB[$id];
1179 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1180 // Scroll to the link which has been edited.
1181 $returnurl .= '#'. $link['shorturl'];
1182 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1183 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1187 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1188 if ($targetPage == Router
::$PAGE_DELETELINK)
1190 if (! $sessionManager->checkToken($_GET['token'])) {
1191 die(t('Wrong token.'));
1194 $ids = trim($_GET['lf_linkdate']);
1195 if (strpos($ids, ' ') !== false) {
1196 // multiple, space-separated ids provided
1197 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1199 // only a single id provided
1202 // assert at least one id is given
1204 die('no id provided');
1206 foreach ($ids as $id) {
1207 $id = (int) escape($id);
1208 $link = $LINKSDB[$id];
1209 $pluginManager->executeHooks('delete_link', $link);
1210 unset($LINKSDB[$id]);
1212 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1213 $history->deleteLink($link);
1215 // If we are called from the bookmarklet, we must close the popup:
1216 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }
1219 if (isset($_SERVER['HTTP_REFERER'])) {
1220 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1221 $location = generateLocation(
1222 $_SERVER['HTTP_REFERER'],
1223 $_SERVER['HTTP_HOST'],
1224 ['delete_link', 'edit_link', $link['shorturl']]
1228 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1232 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1233 if (isset($_GET['edit_link']))
1235 $id = (int) escape($_GET['edit_link']);
1236 $link = $LINKSDB[$id]; // Read database
1237 if (!$link) { header('Location: ?'); exit; } // Link not found in database.
1238 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1241 'link_is_new' => false,
1242 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1243 'tags' => $LINKSDB->linksCountPerTag(),
1245 $pluginManager->executeHooks('render_editlink', $data);
1247 foreach ($data as $key => $value) {
1248 $PAGE->assign($key, $value);
1251 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1252 $PAGE->renderPage('editlink');
1256 // -------- User want to post a new link: Display link edit form.
1257 if (isset($_GET['post'])) {
1258 $url = cleanup_url($_GET['post']);
1260 $link_is_new = false;
1261 // Check if URL is not already in database (in this case, we will edit the existing link)
1262 $link = $LINKSDB->getLinkFromUrl($url);
1265 $link_is_new = true;
1266 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1267 // Get title if it was provided in URL (by the bookmarklet).
1268 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1269 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1270 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1271 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1272 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1273 // 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.)
1274 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1275 // Short timeout to keep the application responsive
1276 // The callback will fill $charset and $title with data from the downloaded page.
1279 $conf->get('general.download_timeout', 30),
1280 $conf->get('general.download_max_size', 4194304),
1281 get_curl_download_callback($charset, $title)
1283 if (! empty($title) && strtolower($charset) != 'utf-8') {
1284 $title = mb_convert_encoding($title, 'utf-8', $charset);
1289 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1290 $title = $conf->get('general.default_note_title', t('Note: '));
1292 $url = escape($url);
1293 $title = escape($title);
1296 'linkdate' => $linkdate,
1299 'description' => $description,
1301 'private' => $private,
1304 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1309 'link_is_new' => $link_is_new,
1310 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1311 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1312 'tags' => $LINKSDB->linksCountPerTag(),
1313 'default_private_links' => $conf->get('privacy.default_private_links', false),
1315 $pluginManager->executeHooks('render_editlink', $data);
1317 foreach ($data as $key => $value) {
1318 $PAGE->assign($key, $value);
1321 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1322 $PAGE->renderPage('editlink');
1326 if ($targetPage == Router
::$PAGE_EXPORT) {
1327 // Export links as a Netscape Bookmarks file
1329 if (empty($_GET['selection'])) {
1330 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1331 $PAGE->renderPage('export');
1335 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1336 $selection = $_GET['selection'];
1337 if (isset($_GET['prepend_note_url'])) {
1338 $prependNoteUrl = $_GET['prepend_note_url'];
1340 $prependNoteUrl = false;
1346 NetscapeBookmarkUtils
::filterAndFormat(
1353 } catch (Exception
$exc) {
1354 header('Content-Type: text/plain; charset=utf-8');
1355 echo $exc->getMessage();
1358 $now = new DateTime();
1359 header('Content-Type: text/html; charset=utf-8');
1361 'Content-disposition: attachment; filename=bookmarks_'
1362 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1364 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1365 $PAGE->assign('eol', PHP_EOL
);
1366 $PAGE->assign('selection', $selection);
1367 $PAGE->renderPage('export.bookmarks');
1371 if ($targetPage == Router
::$PAGE_IMPORT) {
1372 // Upload a Netscape bookmark dump to import its contents
1374 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1375 // Show import dialog
1378 get_max_upload_size(
1379 ini_get('post_max_size'),
1380 ini_get('upload_max_filesize'),
1386 get_max_upload_size(
1387 ini_get('post_max_size'),
1388 ini_get('upload_max_filesize'),
1392 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1393 $PAGE->renderPage('import');
1397 // Import bookmarks from an uploaded file
1398 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1399 // The file is too big or some form field may be missing.
1402 'The file you are trying to upload is probably bigger than what this webserver can accept'
1403 .' (%s). Please upload in smaller chunks.'
1405 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1407 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1410 if (! $sessionManager->checkToken($_POST['token'])) {
1411 die('Wrong token.');
1413 $status = NetscapeBookmarkUtils
::import(
1420 echo '<script>alert("'.$status.'");document.location=\'?do='
1421 .Router
::$PAGE_IMPORT .'\';</script>';
1425 // Plugin administration page
1426 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1427 $pluginMeta = $pluginManager->getPluginsMeta();
1429 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1430 $enabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] !== false; });
1432 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1435 function($a, $b) { return $a
['order'] - $b
['order']; }
1437 $disabledPlugins = array_filter($pluginMeta, function($v) { return $v
['order'] === false; });
1439 $PAGE->assign('enabledPlugins', $enabledPlugins);
1440 $PAGE->assign('disabledPlugins', $disabledPlugins);
1441 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1442 $PAGE->renderPage('pluginsadmin');
1446 // Plugin administration form action
1447 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1449 if (isset($_POST['parameters_form'])) {
1450 unset($_POST['parameters_form']);
1451 foreach ($_POST as $param => $value) {
1452 $conf->set('plugins.'. $param, escape($value));
1456 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1458 $conf->write($loginManager->isLoggedIn());
1459 $history->updateSettings();
1461 catch (Exception
$e) {
1463 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1467 // TODO: do not handle exceptions/errors in JS.
1468 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do='. Router
::$PAGE_PLUGINSADMIN .'\';</script>';
1471 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1475 // Get a fresh token
1476 if ($targetPage == Router
::$GET_TOKEN) {
1477 header('Content-Type:text/plain');
1478 echo $sessionManager->generateToken($conf);
1482 // -------- Otherwise, simply display search form and links:
1483 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
1488 * Template for the list of links (<div id="linklist">)
1489 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1491 * @param pageBuilder $PAGE pageBuilder instance.
1492 * @param LinkDB $LINKSDB LinkDB instance.
1493 * @param ConfigManager $conf Configuration Manager instance.
1494 * @param PluginManager $pluginManager Plugin Manager instance.
1495 * @param LoginManager $loginManager LoginManager instance
1497 function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
1499 // Used in templates
1500 if (isset($_GET['searchtags'])) {
1501 if (! empty($_GET['searchtags'])) {
1502 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1504 $searchtags = false;
1509 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1512 if (! empty($_SERVER['QUERY_STRING'])
1513 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1515 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1516 } catch (LinkNotFoundException
$e) {
1517 $PAGE->render404($e->getMessage());
1521 // Filter links according search parameters.
1522 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1524 'searchtags' => $searchtags,
1525 'searchterm' => $searchterm,
1527 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1530 // ---- Handle paging.
1532 foreach ($linksToDisplay as $key => $value) {
1536 // Select articles according to paging.
1537 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1538 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1539 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1540 $page = $page < 1 ? 1 : $page;
1541 $page = $page > $pagecount ? $pagecount : $page;
1543 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1544 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1545 $linkDisp = array();
1546 while ($i<$end && $i<count($keys))
1548 $link = $linksToDisplay[$keys[$i]];
1549 $link['description'] = format_description(
1550 $link['description'],
1551 $conf->get('redirector.url'),
1552 $conf->get('redirector.encode_url')
1554 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1555 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1556 $link['timestamp'] = $link['created']->getTimestamp();
1557 if (! empty($link['updated'])) {
1558 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1560 $link['updated_timestamp'] = '';
1562 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1563 uasort($taglist, 'strcasecmp');
1564 $link['taglist'] = $taglist;
1565 // Check for both signs of a note: starting with ? and 7 chars long.
1566 if ($link['url'][0] === '?' &&
1567 strlen($link['url']) === 7) {
1568 $link['url'] = index_url($_SERVER) . $link['url'];
1571 $linkDisp[$keys[$i]] = $link;
1575 // Compute paging navigation
1576 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1577 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1578 $previous_page_url = '';
1579 if ($i != count($keys)) {
1580 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1584 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1587 // Fill all template fields.
1589 'previous_page_url' => $previous_page_url,
1590 'next_page_url' => $next_page_url,
1591 'page_current' => $page,
1592 'page_max' => $pagecount,
1593 'result_count' => count($linksToDisplay),
1594 'search_term' => $searchterm,
1595 'search_tags' => $searchtags,
1596 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1597 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1598 'links' => $linkDisp,
1601 // If there is only a single link, we change on-the-fly the title of the page.
1602 if (count($linksToDisplay) == 1) {
1603 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1604 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1605 $data['pagetitle'] = t('Search: ');
1606 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1607 $bracketWrap = function ($tag) {
1608 return '['. $tag .']';
1610 $data['pagetitle'] .= ! empty($searchtags)
1611 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1613 $data['pagetitle'] .= '- '. $conf->get('general.title');
1616 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1618 foreach ($data as $key => $value) {
1619 $PAGE->assign($key, $value);
1626 * Compute the thumbnail for a link.
1628 * With a link to the original URL.
1629 * Understands various services (youtube.com...)
1630 * Input: $url = URL for which the thumbnail must be found.
1631 * $href = if provided, this URL will be followed instead of $url
1632 * Returns an associative array with thumbnail attributes (src,href,width,height,style,alt)
1633 * Some of them may be missing.
1634 * Return an empty array if no thumbnail available.
1636 * @param ConfigManager $conf Configuration Manager instance.
1637 * @param string $url
1638 * @param string|bool $href
1642 function computeThumbnail($conf, $url, $href = false)
1644 if (!$conf->get('thumbnail.enable_thumbnails')) return array();
1645 if ($href==false) $href=$url;
1647 // For most hosts, the URL of the thumbnail can be easily deduced from the URL of the link.
1648 // (e.g. http://www.youtube.com/watch?v=spVypYk4kto ---> http://img.youtube.com/vi/spVypYk4kto/default.jpg )
1649 // ^^^^^^^^^^^ ^^^^^^^^^^^
1650 $domain = parse_url($url,PHP_URL_HOST
);
1651 if ($domain=='youtube.com' || $domain=='www.youtube.com')
1653 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract video ID and get thumbnail
1654 if (!empty($params['v'])) return array('src'=>'https://img.youtube.com/vi/'.$params['v'].'/default.jpg',
1655 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1657 if ($domain=='youtu.be') // Youtube short links
1659 $path = parse_url($url,PHP_URL_PATH
);
1660 return array('src'=>'https://img.youtube.com/vi'.$path.'/default.jpg',
1661 'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
1663 if ($domain=='pix.toile-libre.org') // pix.toile-libre.org image hosting
1665 parse_str(parse_url($url,PHP_URL_QUERY
), $params); // Extract image filename.
1666 if (!empty($params) && !empty($params['img'])) return array('src'=>'http://pix.toile-libre.org/upload/thumb/'.urlencode($params['img']),
1667 'href'=>$href,'style'=>'max-width:120px; max-height:150px','alt'=>'pix.toile-libre.org thumbnail');
1670 if ($domain=='imgur.com')
1672 $path = parse_url($url,PHP_URL_PATH
);
1673 if (startsWith($path,'/a/')) return array(); // Thumbnails for albums are not available.
1674 if (startsWith($path,'/r/')) return array('src'=>'https://i.imgur.com/'.basename($path).'s.jpg',
1675 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1676 if (startsWith($path,'/gallery/')) return array('src'=>'https://i.imgur.com'.substr($path,8).'s.jpg',
1677 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1679 if (substr_count($path,'/')==1) return array('src'=>'https://i.imgur.com/'.substr($path,1).'s.jpg',
1680 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1682 if ($domain=='i.imgur.com')
1684 $pi = pathinfo(parse_url($url,PHP_URL_PATH
));
1685 if (!empty($pi['filename'])) return array('src'=>'https://i.imgur.com/'.$pi['filename'].'s.jpg',
1686 'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
1688 if ($domain=='dailymotion.com' || $domain=='www.dailymotion.com')
1690 if (strpos($url,'dailymotion.com/video/')!==false)
1692 $thumburl=str_replace('dailymotion.com/video/','dailymotion.com/thumbnail/video/',$url);
1693 return array('src'=>$thumburl,
1694 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'DailyMotion thumbnail');
1697 if (endsWith($domain,'.imageshack.us'))
1699 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1700 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1702 $thumburl = substr($url,0,strlen($url)-strlen($ext)).'th.'.$ext;
1703 return array('src'=>$thumburl,
1704 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'imageshack.us thumbnail');
1708 // Some other hosts are SLOW AS HELL and usually require an extra HTTP request to get the thumbnail URL.
1709 // So we deport the thumbnail generation in order not to slow down page generation
1710 // (and we also cache the thumbnail)
1712 if (! $conf->get('thumbnail.enable_localcache')) return array(); // If local cache is disabled, no thumbnails for services which require the use a local cache.
1714 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com')
1715 || $domain=='vimeo.com'
1716 || $domain=='ted.com' || endsWith($domain,'.ted.com')
1717 || $domain=='xkcd.com' || endsWith($domain,'.xkcd.com')
1720 if ($domain=='vimeo.com')
1721 { // Make sure this vimeo URL points to a video (/xxx... where xxx is numeric)
1722 $path = parse_url($url,PHP_URL_PATH
);
1723 if (!preg_match('!/\d+.+?!',$path)) return array(); // This is not a single video URL.
1725 if ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
1726 { // Make sure this URL points to a single comic (/xxx... where xxx is numeric)
1727 $path = parse_url($url,PHP_URL_PATH
);
1728 if (!preg_match('!/\d+.+?!',$path)) return array();
1730 if ($domain=='ted.com' || endsWith($domain,'.ted.com'))
1731 { // Make sure this TED URL points to a video (/talks/...)
1732 $path = parse_url($url,PHP_URL_PATH
);
1733 if ("/talks/" !== substr($path,0,7)) return array(); // This is not a single video URL.
1735 $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)
1736 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1737 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1740 // For all other, we try to make a thumbnail of links ending with .jpg/jpeg/png/gif
1741 // Technically speaking, we should download ALL links and check their Content-Type to see if they are images.
1742 // But using the extension will do.
1743 $ext=strtolower(pathinfo($url,PATHINFO_EXTENSION
));
1744 if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
1746 $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)
1747 return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
1748 'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
1750 return array(); // No thumbnail.
1755 // Returns the HTML code to display a thumbnail for a link
1756 // with a link to the original URL.
1757 // Understands various services (youtube.com...)
1758 // Input: $url = URL for which the thumbnail must be found.
1759 // $href = if provided, this URL will be followed instead of $url
1760 // Returns '' if no thumbnail available.
1761 function thumbnail($url,$href=false)
1765 $t = computeThumbnail($conf, $url,$href);
1766 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1768 $html='<a href="'.escape($t['href']).'"><img src="'.escape($t['src']).'"';
1769 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1770 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1771 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1772 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1777 // Returns the HTML code to display a thumbnail for a link
1778 // for the picture wall (using lazy image loading)
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 '' if no thumbnail available.
1783 function lazyThumbnail($conf, $url,$href=false)
1787 $t = computeThumbnail($conf, $url,$href);
1788 if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
1790 $html='<a href="'.escape($t['href']).'">';
1793 $html.='<img class="b-lazy" src="#" data-src="'.escape($t['src']).'"';
1795 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1796 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1797 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1798 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1801 // No-JavaScript fallback.
1802 $html.='<noscript><img src="'.escape($t['src']).'"';
1803 if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
1804 if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
1805 if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
1806 if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
1807 $html.='></noscript></a>';
1815 * This function should NEVER be called if the file data/config.php exists.
1817 * @param ConfigManager $conf Configuration Manager instance.
1818 * @param SessionManager $sessionManager SessionManager instance
1820 function install($conf, $sessionManager) {
1821 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1822 if (endsWith($_SERVER['HTTP_HOST'],'.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions',0705);
1825 // This part makes sure sessions works correctly.
1826 // (Because on some hosts, session.save_path may not be set correctly,
1827 // or we may not have write access to it.)
1828 if (isset($_GET['test_session']) && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working'))
1830 // Step 2: Check if data in session is correct.
1832 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1833 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1834 'and that you have write access to it.<br>'.
1835 'It currently points to %s.<br>'.
1836 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1837 'or any custom hostname without a dot causes cookie storage to fail. '.
1838 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1840 $msg = sprintf($msg, session_save_path());
1842 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1845 if (!isset($_SESSION['session_tested']))
1846 { // Step 1 : Try to store data in session and reload page.
1847 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1848 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1850 if (isset($_GET['test_session']))
1851 { // Step 3: Sessions are OK. Remove test parameter from URL.
1852 header('Location: '.index_url($_SERVER));
1856 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
1859 if (!empty($_POST['continent']) && !empty($_POST['city'])
1860 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1862 $tz = $_POST['continent'].'/'.$_POST['city'];
1864 $conf->set('general.timezone', $tz);
1865 $login = $_POST['setlogin'];
1866 $conf->set('credentials.login', $login);
1867 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1868 $conf->set('credentials.salt', $salt);
1869 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1870 if (!empty($_POST['title'])) {
1871 $conf->set('general.title', escape($_POST['title']));
1873 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
1875 $conf->set('translation.language', escape($_POST['language']));
1876 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1877 $conf->set('api.enabled', !empty($_POST['enableApi']));
1880 generate_api_secret(
1881 $conf->get('credentials.login'),
1882 $conf->get('credentials.salt')
1886 // Everything is ok, let's create config file.
1887 $conf->write($loginManager->isLoggedIn());
1889 catch(Exception
$e) {
1891 'ERROR while writing config file after installation.' . PHP_EOL
.
1895 // TODO: do not handle exceptions/errors in JS.
1896 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1899 echo '<script>alert("Shaarli is now configured. Please enter your login/password and start shaaring your links!");document.location=\'?do=login\';</script>';
1903 $PAGE = new PageBuilder($conf, null, $sessionManager->generateToken());
1904 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1905 $PAGE->assign('continents', $continents);
1906 $PAGE->assign('cities', $cities);
1907 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1908 $PAGE->renderPage('install');
1913 * Because some f*cking services like flickr require an extra HTTP request to get the thumbnail URL,
1914 * I have deported the thumbnail URL code generation here, otherwise this would slow down page generation.
1915 * The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail.
1916 * This function is called by passing the URL:
1917 * http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL]
1918 * [URL] is the URL of the link (e.g. a flickr page)
1919 * [HMAC] is the signature for the [URL] (so that these URL cannot be forged).
1920 * The function below will fetch the image from the webservice and store it in the cache.
1922 * @param ConfigManager $conf Configuration Manager instance,
1924 function genThumbnail($conf)
1926 // Make sure the parameters in the URL were generated by us.
1927 $sign = hash_hmac('sha256', $_GET['url'], $conf->get('credentials.salt'));
1928 if ($sign!=$_GET['hmac']) die('Naughty boy!');
1930 $cacheDir = $conf->get('resource.thumbnails_cache', 'cache');
1931 // Let's see if we don't already have the image for this URL in the cache.
1932 $thumbname=hash('sha1',$_GET['url']).'.jpg';
1933 if (is_file($cacheDir .'/'. $thumbname))
1934 { // We have the thumbnail, just serve it:
1935 header('Content-Type: image/jpeg');
1936 echo file_get_contents($cacheDir .'/'. $thumbname);
1939 // We may also serve a blank image (if service did not respond)
1940 $blankname=hash('sha1',$_GET['url']).'.gif';
1941 if (is_file($cacheDir .'/'. $blankname))
1943 header('Content-Type: image/gif');
1944 echo file_get_contents($cacheDir .'/'. $blankname);
1948 // Otherwise, generate the thumbnail.
1949 $url = $_GET['url'];
1950 $domain = parse_url($url,PHP_URL_HOST
);
1952 if ($domain=='flickr.com' || endsWith($domain,'.flickr.com'))
1954 // Crude replacement to handle new flickr domain policy (They prefer www. now)
1955 $url = str_replace('http://flickr.com/','http://www.flickr.com/',$url);
1957 // Is this a link to an image, or to a flickr page ?
1959 if (endsWith(parse_url($url, PHP_URL_PATH
), '.jpg'))
1960 { // This is a direct link to an image. e.g. http://farm1.staticflickr.com/5/5921913_ac83ed27bd_o.jpg
1961 preg_match('!(http://farm\d+\.staticflickr\.com/\d+/\d+_\w+_)\w.jpg!',$url,$matches);
1962 if (!empty($matches[1])) $imageurl=$matches[1].'m.jpg';
1964 else // This is a flickr page (html)
1966 // Get the flickr html page.
1967 list($headers, $content) = get_http_response($url, 20);
1968 if (strpos($headers[0], '200 OK') !== false)
1970 // flickr now nicely provides the URL of the thumbnail in each flickr page.
1971 preg_match('!<link rel=\"image_src\" href=\"(.+?)\"!', $content, $matches);
1972 if (!empty($matches[1])) $imageurl=$matches[1];
1974 // In albums (and some other pages), the link rel="image_src" is not provided,
1975 // but flickr provides:
1976 // <meta property="og:image" content="http://farm4.staticflickr.com/3398/3239339068_25d13535ff_z.jpg" />
1979 preg_match('!<meta property=\"og:image\" content=\"(.+?)\"!', $content, $matches);
1980 if (!empty($matches[1])) $imageurl=$matches[1];
1986 { // Let's download the image.
1987 // Image is 240x120, so 10 seconds to download should be enough.
1988 list($headers, $content) = get_http_response($imageurl, 10);
1989 if (strpos($headers[0], '200 OK') !== false) {
1990 // Save image to cache.
1991 file_put_contents($cacheDir .'/'. $thumbname, $content);
1992 header('Content-Type: image/jpeg');
1999 elseif ($domain=='vimeo.com' )
2001 // This is more complex: we have to perform a HTTP request, then parse the result.
2002 // Maybe we should deport this to JavaScript ? Example: http://stackoverflow.com/questions/1361149/get-img-thumbnails-from-vimeo/4285098#4285098
2003 $vid = substr(parse_url($url,PHP_URL_PATH
),1);
2004 list($headers, $content) = get_http_response('https://vimeo.com/api/v2/video/'.escape($vid).'.php', 5);
2005 if (strpos($headers[0], '200 OK') !== false) {
2006 $t = unserialize($content);
2007 $imageurl = $t[0]['thumbnail_medium'];
2008 // Then we download the image and serve it to our client.
2009 list($headers, $content) = get_http_response($imageurl, 10);
2010 if (strpos($headers[0], '200 OK') !== false) {
2011 // Save image to cache.
2012 file_put_contents($cacheDir .'/'. $thumbname, $content);
2013 header('Content-Type: image/jpeg');
2020 elseif ($domain=='ted.com' || endsWith($domain,'.ted.com'))
2022 // The thumbnail for TED talks is located in the <link rel="image_src" [...]> tag on that page
2023 // http://www.ted.com/talks/mikko_hypponen_fighting_viruses_defending_the_net.html
2024 // <link rel="image_src" href="http://images.ted.com/images/ted/28bced335898ba54d4441809c5b1112ffaf36781_389x292.jpg" />
2025 list($headers, $content) = get_http_response($url, 5);
2026 if (strpos($headers[0], '200 OK') !== false) {
2027 // Extract the link to the thumbnail
2028 preg_match('!link rel="image_src" href="(http://images.ted.com/images/ted/.+_\d+x\d+\.jpg)"!', $content, $matches);
2029 if (!empty($matches[1]))
2030 { // Let's download the image.
2031 $imageurl=$matches[1];
2032 // No control on image size, so wait long enough
2033 list($headers, $content) = get_http_response($imageurl, 20);
2034 if (strpos($headers[0], '200 OK') !== false) {
2035 $filepath = $cacheDir .'/'. $thumbname;
2036 file_put_contents($filepath, $content); // Save image to cache.
2037 if (resizeImage($filepath))
2039 header('Content-Type: image/jpeg');
2040 echo file_get_contents($filepath);
2048 elseif ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
2050 // There is no thumbnail available for xkcd comics, so download the whole image and resize it.
2051 // http://xkcd.com/327/
2052 // <img src="http://imgs.xkcd.com/comics/exploits_of_a_mom.png" title="<BLABLA>" alt="<BLABLA>" />
2053 list($headers, $content) = get_http_response($url, 5);
2054 if (strpos($headers[0], '200 OK') !== false) {
2055 // Extract the link to the thumbnail
2056 preg_match('!<img src="(http://imgs.xkcd.com/comics/.*)" title="[^s]!', $content, $matches);
2057 if (!empty($matches[1]))
2058 { // Let's download the image.
2059 $imageurl=$matches[1];
2060 // No control on image size, so wait long enough
2061 list($headers, $content) = get_http_response($imageurl, 20);
2062 if (strpos($headers[0], '200 OK') !== false) {
2063 $filepath = $cacheDir.'/'.$thumbname;
2064 // Save image to cache.
2065 file_put_contents($filepath, $content);
2066 if (resizeImage($filepath))
2068 header('Content-Type: image/jpeg');
2069 echo file_get_contents($filepath);
2079 // For all other domains, we try to download the image and make a thumbnail.
2080 // We allow 30 seconds max to download (and downloads are limited to 4 Mb)
2081 list($headers, $content) = get_http_response($url, 30);
2082 if (strpos($headers[0], '200 OK') !== false) {
2083 $filepath = $cacheDir .'/'.$thumbname;
2084 // Save image to cache.
2085 file_put_contents($filepath, $content);
2086 if (resizeImage($filepath))
2088 header('Content-Type: image/jpeg');
2089 echo file_get_contents($filepath);
2096 // Otherwise, return an empty image (8x8 transparent gif)
2097 $blankgif = base64_decode('R0lGODlhCAAIAIAAAP///////yH5BAEKAAEALAAAAAAIAAgAAAIHjI+py+1dAAA7');
2098 // Also put something in cache so that this URL is not requested twice.
2099 file_put_contents($cacheDir .'/'. $blankname, $blankgif);
2100 header('Content-Type: image/gif');
2104 // Make a thumbnail of the image (to width: 120 pixels)
2105 // Returns true if success, false otherwise.
2106 function resizeImage($filepath)
2108 if (!function_exists('imagecreatefromjpeg')) return false; // GD not present: no thumbnail possible.
2110 // Trick: some stupid people rename GIF as JPEG... or else.
2111 // So we really try to open each image type whatever the extension is.
2112 $header=file_get_contents($filepath,false,NULL,0,256); // Read first 256 bytes and try to sniff file type.
2114 $i=strpos($header,'GIF8'); if (($i!==false) && ($i==0)) $im = imagecreatefromgif($filepath); // Well this is crude, but it should be enough.
2115 $i=strpos($header,'PNG'); if (($i!==false) && ($i==1)) $im = imagecreatefrompng($filepath);
2116 $i=strpos($header,'JFIF'); if ($i!==false) $im = imagecreatefromjpeg($filepath);
2117 if (!$im) return false; // Unable to open image (corrupted or not an image)
2120 $ystart = 0; $yheight=$h;
2121 if ($h>$w) { $ystart
= ($h
/2)-($w
/2); $yheight
=$w
/2; }
2122 $nw = 120; // Desired width
2123 $nh = min(floor(($h*$nw)/$w),120); // Compute new width/height, but maximum 120 pixels height.
2125 $im2 = imagecreatetruecolor($nw,$nh);
2126 imagecopyresampled($im2, $im, 0, 0, 0, $ystart, $nw, $nh, $w, $yheight);
2127 imageinterlace($im2,true); // For progressive JPEG.
2128 $tempname=$filepath.'_TEMP.jpg';
2129 imagejpeg($im2, $tempname, 90);
2133 rename($tempname,$filepath); // Overwrite original picture with thumbnail.
2137 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=genthumbnail')) { genThumbnail($conf
); exit; } // Thumbnail generation/cache does not need the link database.
2138 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf
); exit; }
2139 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
2140 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
2144 $history = new History($conf->get('resource.history'));
2145 } catch(Exception
$e) {
2146 die($e->getMessage());
2149 $linkDb = new LinkDB(
2150 $conf->get('resource.datastore'),
2151 $loginManager->isLoggedIn(),
2152 $conf->get('privacy.hide_public_links'),
2153 $conf->get('redirector.url'),
2154 $conf->get('redirector.encode_url')
2157 $container = new \Slim\
Container();
2158 $container['conf'] = $conf;
2159 $container['plugins'] = $pluginManager;
2160 $container['history'] = $history;
2161 $app = new \Slim\
App($container);
2164 $app->group('/api/v1', function() {
2165 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
2166 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
2167 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
2168 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
2169 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
2170 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
2171 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
2172 })->add('\Shaarli\Api\ApiMiddleware');
2174 $response = $app->run(true);
2175 // Hack to make Slim and Shaarli router work together:
2176 // If a Slim route isn't found and NOT API call, we call renderPage().
2177 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
2178 // We use UTF-8 for proper international characters handling.
2179 header('Content-Type: text/html; charset=utf-8');
2180 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
2182 $app->respond($response);