Use web-thumbnailer to retrieve thumbnails
* requires PHP 5.6 * use blazy on linklist since a lot more thumbs are retrieved * thumbnails can be disabled * thumbs size is now 120x120 * thumbs are now cropped to fit the expected size Fixes #345 #425 #487 #543 #588 #590
This commit is contained in:
parent
edb4a4d9c9
commit
1b93137e16
12 changed files with 222 additions and 427 deletions
|
@ -105,6 +105,11 @@ private function initialize()
|
|||
if ($this->linkDB !== null) {
|
||||
$this->tpl->assign('tags', $this->linkDB->linksCountPerTag());
|
||||
}
|
||||
|
||||
$this->tpl->assign('thumbnails_enabled', $this->conf->get('thumbnails.enabled'));
|
||||
$this->tpl->assign('thumbnails_width', $this->conf->get('thumbnails.width'));
|
||||
$this->tpl->assign('thumbnails_height', $this->conf->get('thumbnails.height'));
|
||||
|
||||
// To be removed with a proper theme configuration.
|
||||
$this->tpl->assign('conf', $this->conf);
|
||||
}
|
||||
|
|
49
application/Thumbnailer.php
Normal file
49
application/Thumbnailer.php
Normal file
|
@ -0,0 +1,49 @@
|
|||
<?php
|
||||
|
||||
use WebThumbnailer\WebThumbnailer;
|
||||
|
||||
/**
|
||||
* Class Thumbnailer
|
||||
*
|
||||
* Utility class used to retrieve thumbnails using web-thumbnailer dependency.
|
||||
*/
|
||||
class Thumbnailer
|
||||
{
|
||||
/**
|
||||
* @var WebThumbnailer instance.
|
||||
*/
|
||||
protected $wt;
|
||||
|
||||
/**
|
||||
* @var ConfigManager instance.
|
||||
*/
|
||||
protected $conf;
|
||||
|
||||
/**
|
||||
* Thumbnailer constructor.
|
||||
*
|
||||
* @param ConfigManager $conf instance.
|
||||
*/
|
||||
public function __construct($conf)
|
||||
{
|
||||
$this->conf = $conf;
|
||||
$this->wt = new WebThumbnailer();
|
||||
\WebThumbnailer\Application\ConfigManager::addFile('inc/web-thumbnailer.json');
|
||||
$this->wt->maxWidth($this->conf->get('thumbnails.width'))
|
||||
->maxHeight($this->conf->get('thumbnails.height'))
|
||||
->crop(true)
|
||||
->debug($this->conf->get('dev.debug', false));
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve a thumbnail for given URL
|
||||
*
|
||||
* @param string $url where to look for a thumbnail.
|
||||
*
|
||||
* @return bool|string The thumbnail relative cache file path, or false if none has been found.
|
||||
*/
|
||||
public function get($url)
|
||||
{
|
||||
return $this->wt->thumbnail($url);
|
||||
}
|
||||
}
|
|
@ -319,6 +319,10 @@ protected function setDefaultValues()
|
|||
$this->setEmpty('general.enabled_plugins', self::$DEFAULT_PLUGINS);
|
||||
$this->setEmpty('general.default_note_title', 'Note: ');
|
||||
|
||||
$this->setEmpty('thumbnails.enabled', true);
|
||||
$this->setEmpty('thumbnails.width', 120);
|
||||
$this->setEmpty('thumbnails.height', 120);
|
||||
|
||||
$this->setEmpty('updates.check_updates', false);
|
||||
$this->setEmpty('updates.check_updates_branch', 'stable');
|
||||
$this->setEmpty('updates.check_updates_interval', 86400);
|
||||
|
|
|
@ -701,8 +701,8 @@ a.bigbutton, #pageheader a.bigbutton {
|
|||
position: relative;
|
||||
display: table-cell;
|
||||
vertical-align: middle;
|
||||
width: 90px;
|
||||
height: 90px;
|
||||
width: 120px;
|
||||
height: 120px;
|
||||
overflow: hidden;
|
||||
text-align: center;
|
||||
float: left;
|
||||
|
@ -739,9 +739,9 @@ a.bigbutton, #pageheader a.bigbutton {
|
|||
position: absolute;
|
||||
top: 0;
|
||||
left: 0;
|
||||
width: 90px;
|
||||
width: 120px;
|
||||
font-weight: bold;
|
||||
font-size: 8pt;
|
||||
font-size: 9pt;
|
||||
color: #fff;
|
||||
text-align: left;
|
||||
background-color: transparent;
|
||||
|
|
|
@ -19,6 +19,7 @@
|
|||
"shaarli/netscape-bookmark-parser": "^2.0",
|
||||
"erusev/parsedown": "^1.6",
|
||||
"slim/slim": "^3.0",
|
||||
"arthurhoaro/web-thumbnailer": "dev-master",
|
||||
"pubsubhubbub/publisher": "dev-master",
|
||||
"gettext/gettext": "^4.4"
|
||||
},
|
||||
|
|
9
inc/web-thumbnailer.json
Normal file
9
inc/web-thumbnailer.json
Normal file
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"settings": {
|
||||
"default": {
|
||||
"_comment": "infinite cache",
|
||||
"cache_duration": -1,
|
||||
"timeout": 60
|
||||
}
|
||||
}
|
||||
}
|
490
index.php
490
index.php
|
@ -74,6 +74,7 @@
|
|||
require_once 'application/Utils.php';
|
||||
require_once 'application/PluginManager.php';
|
||||
require_once 'application/Router.php';
|
||||
require_once 'application/Thumbnailer.php';
|
||||
require_once 'application/Updater.php';
|
||||
use \Shaarli\Languages;
|
||||
use \Shaarli\ThemeUtils;
|
||||
|
@ -601,20 +602,52 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager,
|
|||
// -------- Picture wall
|
||||
if ($targetPage == Router::$PAGE_PICWALL)
|
||||
{
|
||||
if (! $conf->get('thumbnails.enabled')) {
|
||||
header('Location: ?');
|
||||
exit;
|
||||
}
|
||||
|
||||
// Optionally filter the results:
|
||||
$links = $LINKSDB->filterSearch($_GET);
|
||||
$linksToDisplay = array();
|
||||
|
||||
$thumbnailer = new Thumbnailer($conf);
|
||||
|
||||
|
||||
$cpt = 0;
|
||||
// Get only links which have a thumbnail.
|
||||
foreach($links as $link)
|
||||
{
|
||||
$permalink='?'.$link['shorturl'];
|
||||
$thumb=lazyThumbnail($conf, $link['url'],$permalink);
|
||||
if ($thumb!='') // Only output links which have a thumbnail.
|
||||
{
|
||||
$link['thumbnail']=$thumb; // Thumbnail HTML code.
|
||||
$linksToDisplay[]=$link; // Add to array.
|
||||
// Not a note,
|
||||
// and (never retrieved yet or no valid cache file)
|
||||
if ($link['url'][0] != '?'
|
||||
&& (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
|
||||
) {
|
||||
$link['thumbnail'] = $thumbnailer->get($link['url']);
|
||||
// FIXME! we really need to get rid of ArrayAccess...
|
||||
$item = $LINKSDB[$link['linkdate']];
|
||||
$item['thumbnail'] = $link['thumbnail'];
|
||||
$LINKSDB[$link['linkdate']] = $item;
|
||||
$updateDB = true;
|
||||
$cpt++;
|
||||
}
|
||||
|
||||
if (isset($link['thumbnail']) && $link['thumbnail'] !== false) {
|
||||
$linksToDisplay[] = $link; // Add to array.
|
||||
}
|
||||
|
||||
// If we retrieved new thumbnails, we update the database every 20 links.
|
||||
// Downloading everything the first time may take a very long time
|
||||
if (!empty($updateDB) && $cpt == 20) {
|
||||
$LINKSDB->save($conf->get('resource.page_cache'));
|
||||
$updateDB = false;
|
||||
$cpt = 0;
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($updateDB)) {
|
||||
$LINKSDB->save($conf->get('resource.page_cache'));
|
||||
}
|
||||
|
||||
$data = array(
|
||||
|
@ -1008,6 +1041,7 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager,
|
|||
$conf->set('api.enabled', !empty($_POST['enableApi']));
|
||||
$conf->set('api.secret', escape($_POST['apiSecret']));
|
||||
$conf->set('translation.language', escape($_POST['language']));
|
||||
$conf->set('thumbnails.enabled', !empty($_POST['enableThumbnails']));
|
||||
|
||||
try {
|
||||
$conf->write($loginManager->isLoggedIn());
|
||||
|
@ -1148,6 +1182,11 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager,
|
|||
$link['title'] = $link['url'];
|
||||
}
|
||||
|
||||
if ($conf->get('thumbnails.enabled')) {
|
||||
$thumbnailer = new Thumbnailer($conf);
|
||||
$link['thumbnail'] = $thumbnailer->get($url);
|
||||
}
|
||||
|
||||
$pluginManager->executeHooks('save_link', $link);
|
||||
|
||||
$LINKSDB[$id] = $link;
|
||||
|
@ -1549,6 +1588,11 @@ function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
|
|||
// Start index.
|
||||
$i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
|
||||
$end = $i + $_SESSION['LINKS_PER_PAGE'];
|
||||
|
||||
if ($conf->get('thumbnails.enabled')) {
|
||||
$thumbnailer = new Thumbnailer($conf);
|
||||
}
|
||||
|
||||
$linkDisp = array();
|
||||
while ($i<$end && $i<count($keys))
|
||||
{
|
||||
|
@ -1569,9 +1613,22 @@ function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
|
|||
$taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY);
|
||||
uasort($taglist, 'strcasecmp');
|
||||
$link['taglist'] = $taglist;
|
||||
|
||||
// Thumbnails enabled, not a note,
|
||||
// and (never retrieved yet or no valid cache file)
|
||||
if ($conf->get('thumbnails.enabled') && $link['url'][0] != '?'
|
||||
&& (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
|
||||
) {
|
||||
$link['thumbnail'] = $thumbnailer->get($link['url']);
|
||||
// FIXME! we really need to get rid of ArrayAccess...
|
||||
$item = $LINKSDB[$keys[$i]];
|
||||
$item['thumbnail'] = $link['thumbnail'];
|
||||
$LINKSDB[$keys[$i]] = $item;
|
||||
$updateDB = true;
|
||||
}
|
||||
|
||||
// Check for both signs of a note: starting with ? and 7 chars long.
|
||||
if ($link['url'][0] === '?' &&
|
||||
strlen($link['url']) === 7) {
|
||||
if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
|
||||
$link['url'] = index_url($_SERVER) . $link['url'];
|
||||
}
|
||||
|
||||
|
@ -1579,6 +1636,11 @@ function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
|
|||
$i++;
|
||||
}
|
||||
|
||||
// If we retrieved new thumbnails, we update the database.
|
||||
if (!empty($updateDB)) {
|
||||
$LINKSDB->save($conf->get('resource.page_cache'));
|
||||
}
|
||||
|
||||
// Compute paging navigation
|
||||
$searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
|
||||
$searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
|
||||
|
@ -1629,194 +1691,6 @@ function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
|
|||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute the thumbnail for a link.
|
||||
*
|
||||
* With a link to the original URL.
|
||||
* Understands various services (youtube.com...)
|
||||
* Input: $url = URL for which the thumbnail must be found.
|
||||
* $href = if provided, this URL will be followed instead of $url
|
||||
* Returns an associative array with thumbnail attributes (src,href,width,height,style,alt)
|
||||
* Some of them may be missing.
|
||||
* Return an empty array if no thumbnail available.
|
||||
*
|
||||
* @param ConfigManager $conf Configuration Manager instance.
|
||||
* @param string $url
|
||||
* @param string|bool $href
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
function computeThumbnail($conf, $url, $href = false)
|
||||
{
|
||||
if (!$conf->get('thumbnail.enable_thumbnails')) return array();
|
||||
if ($href==false) $href=$url;
|
||||
|
||||
// For most hosts, the URL of the thumbnail can be easily deduced from the URL of the link.
|
||||
// (e.g. http://www.youtube.com/watch?v=spVypYk4kto ---> http://img.youtube.com/vi/spVypYk4kto/default.jpg )
|
||||
// ^^^^^^^^^^^ ^^^^^^^^^^^
|
||||
$domain = parse_url($url,PHP_URL_HOST);
|
||||
if ($domain=='youtube.com' || $domain=='www.youtube.com')
|
||||
{
|
||||
parse_str(parse_url($url,PHP_URL_QUERY), $params); // Extract video ID and get thumbnail
|
||||
if (!empty($params['v'])) return array('src'=>'https://img.youtube.com/vi/'.$params['v'].'/default.jpg',
|
||||
'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
|
||||
}
|
||||
if ($domain=='youtu.be') // Youtube short links
|
||||
{
|
||||
$path = parse_url($url,PHP_URL_PATH);
|
||||
return array('src'=>'https://img.youtube.com/vi'.$path.'/default.jpg',
|
||||
'href'=>$href,'width'=>'120','height'=>'90','alt'=>'YouTube thumbnail');
|
||||
}
|
||||
if ($domain=='pix.toile-libre.org') // pix.toile-libre.org image hosting
|
||||
{
|
||||
parse_str(parse_url($url,PHP_URL_QUERY), $params); // Extract image filename.
|
||||
if (!empty($params) && !empty($params['img'])) return array('src'=>'http://pix.toile-libre.org/upload/thumb/'.urlencode($params['img']),
|
||||
'href'=>$href,'style'=>'max-width:120px; max-height:150px','alt'=>'pix.toile-libre.org thumbnail');
|
||||
}
|
||||
|
||||
if ($domain=='imgur.com')
|
||||
{
|
||||
$path = parse_url($url,PHP_URL_PATH);
|
||||
if (startsWith($path,'/a/')) return array(); // Thumbnails for albums are not available.
|
||||
if (startsWith($path,'/r/')) return array('src'=>'https://i.imgur.com/'.basename($path).'s.jpg',
|
||||
'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
|
||||
if (startsWith($path,'/gallery/')) return array('src'=>'https://i.imgur.com'.substr($path,8).'s.jpg',
|
||||
'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
|
||||
|
||||
if (substr_count($path,'/')==1) return array('src'=>'https://i.imgur.com/'.substr($path,1).'s.jpg',
|
||||
'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
|
||||
}
|
||||
if ($domain=='i.imgur.com')
|
||||
{
|
||||
$pi = pathinfo(parse_url($url,PHP_URL_PATH));
|
||||
if (!empty($pi['filename'])) return array('src'=>'https://i.imgur.com/'.$pi['filename'].'s.jpg',
|
||||
'href'=>$href,'width'=>'90','height'=>'90','alt'=>'imgur.com thumbnail');
|
||||
}
|
||||
if ($domain=='dailymotion.com' || $domain=='www.dailymotion.com')
|
||||
{
|
||||
if (strpos($url,'dailymotion.com/video/')!==false)
|
||||
{
|
||||
$thumburl=str_replace('dailymotion.com/video/','dailymotion.com/thumbnail/video/',$url);
|
||||
return array('src'=>$thumburl,
|
||||
'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'DailyMotion thumbnail');
|
||||
}
|
||||
}
|
||||
if (endsWith($domain,'.imageshack.us'))
|
||||
{
|
||||
$ext=strtolower(pathinfo($url,PATHINFO_EXTENSION));
|
||||
if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
|
||||
{
|
||||
$thumburl = substr($url,0,strlen($url)-strlen($ext)).'th.'.$ext;
|
||||
return array('src'=>$thumburl,
|
||||
'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'imageshack.us thumbnail');
|
||||
}
|
||||
}
|
||||
|
||||
// Some other hosts are SLOW AS HELL and usually require an extra HTTP request to get the thumbnail URL.
|
||||
// So we deport the thumbnail generation in order not to slow down page generation
|
||||
// (and we also cache the thumbnail)
|
||||
|
||||
if (! $conf->get('thumbnail.enable_localcache')) return array(); // If local cache is disabled, no thumbnails for services which require the use a local cache.
|
||||
|
||||
if ($domain=='flickr.com' || endsWith($domain,'.flickr.com')
|
||||
|| $domain=='vimeo.com'
|
||||
|| $domain=='ted.com' || endsWith($domain,'.ted.com')
|
||||
|| $domain=='xkcd.com' || endsWith($domain,'.xkcd.com')
|
||||
)
|
||||
{
|
||||
if ($domain=='vimeo.com')
|
||||
{ // Make sure this vimeo URL points to a video (/xxx... where xxx is numeric)
|
||||
$path = parse_url($url,PHP_URL_PATH);
|
||||
if (!preg_match('!/\d+.+?!',$path)) return array(); // This is not a single video URL.
|
||||
}
|
||||
if ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
|
||||
{ // Make sure this URL points to a single comic (/xxx... where xxx is numeric)
|
||||
$path = parse_url($url,PHP_URL_PATH);
|
||||
if (!preg_match('!/\d+.+?!',$path)) return array();
|
||||
}
|
||||
if ($domain=='ted.com' || endsWith($domain,'.ted.com'))
|
||||
{ // Make sure this TED URL points to a video (/talks/...)
|
||||
$path = parse_url($url,PHP_URL_PATH);
|
||||
if ("/talks/" !== substr($path,0,7)) return array(); // This is not a single video URL.
|
||||
}
|
||||
$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)
|
||||
return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
|
||||
'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
|
||||
}
|
||||
|
||||
// For all other, we try to make a thumbnail of links ending with .jpg/jpeg/png/gif
|
||||
// Technically speaking, we should download ALL links and check their Content-Type to see if they are images.
|
||||
// But using the extension will do.
|
||||
$ext=strtolower(pathinfo($url,PATHINFO_EXTENSION));
|
||||
if ($ext=='jpg' || $ext=='jpeg' || $ext=='png' || $ext=='gif')
|
||||
{
|
||||
$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)
|
||||
return array('src'=>index_url($_SERVER).'?do=genthumbnail&hmac='.$sign.'&url='.urlencode($url),
|
||||
'href'=>$href,'width'=>'120','style'=>'height:auto;','alt'=>'thumbnail');
|
||||
}
|
||||
return array(); // No thumbnail.
|
||||
|
||||
}
|
||||
|
||||
|
||||
// Returns the HTML code to display a thumbnail for a link
|
||||
// with a link to the original URL.
|
||||
// Understands various services (youtube.com...)
|
||||
// Input: $url = URL for which the thumbnail must be found.
|
||||
// $href = if provided, this URL will be followed instead of $url
|
||||
// Returns '' if no thumbnail available.
|
||||
function thumbnail($url,$href=false)
|
||||
{
|
||||
// FIXME!
|
||||
global $conf;
|
||||
$t = computeThumbnail($conf, $url,$href);
|
||||
if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
|
||||
|
||||
$html='<a href="'.escape($t['href']).'"><img src="'.escape($t['src']).'"';
|
||||
if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
|
||||
if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
|
||||
if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
|
||||
if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
|
||||
$html.='></a>';
|
||||
return $html;
|
||||
}
|
||||
|
||||
// Returns the HTML code to display a thumbnail for a link
|
||||
// for the picture wall (using lazy image loading)
|
||||
// Understands various services (youtube.com...)
|
||||
// Input: $url = URL for which the thumbnail must be found.
|
||||
// $href = if provided, this URL will be followed instead of $url
|
||||
// Returns '' if no thumbnail available.
|
||||
function lazyThumbnail($conf, $url,$href=false)
|
||||
{
|
||||
// FIXME!
|
||||
global $conf;
|
||||
$t = computeThumbnail($conf, $url,$href);
|
||||
if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
|
||||
|
||||
$html='<a href="'.escape($t['href']).'">';
|
||||
|
||||
// Lazy image
|
||||
$html.='<img class="b-lazy" src="#" data-src="'.escape($t['src']).'"';
|
||||
|
||||
if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
|
||||
if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
|
||||
if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
|
||||
if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
|
||||
$html.='>';
|
||||
|
||||
// No-JavaScript fallback.
|
||||
$html.='<noscript><img src="'.escape($t['src']).'"';
|
||||
if (!empty($t['width'])) $html.=' width="'.escape($t['width']).'"';
|
||||
if (!empty($t['height'])) $html.=' height="'.escape($t['height']).'"';
|
||||
if (!empty($t['style'])) $html.=' style="'.escape($t['style']).'"';
|
||||
if (!empty($t['alt'])) $html.=' alt="'.escape($t['alt']).'"';
|
||||
$html.='></noscript></a>';
|
||||
|
||||
return $html;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Installation
|
||||
* This function should NEVER be called if the file data/config.php exists.
|
||||
|
@ -1917,232 +1791,6 @@ function install($conf, $sessionManager, $loginManager) {
|
|||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Because some f*cking services like flickr require an extra HTTP request to get the thumbnail URL,
|
||||
* I have deported the thumbnail URL code generation here, otherwise this would slow down page generation.
|
||||
* The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail.
|
||||
* This function is called by passing the URL:
|
||||
* http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL]
|
||||
* [URL] is the URL of the link (e.g. a flickr page)
|
||||
* [HMAC] is the signature for the [URL] (so that these URL cannot be forged).
|
||||
* The function below will fetch the image from the webservice and store it in the cache.
|
||||
*
|
||||
* @param ConfigManager $conf Configuration Manager instance,
|
||||
*/
|
||||
function genThumbnail($conf)
|
||||
{
|
||||
// Make sure the parameters in the URL were generated by us.
|
||||
$sign = hash_hmac('sha256', $_GET['url'], $conf->get('credentials.salt'));
|
||||
if ($sign!=$_GET['hmac']) die('Naughty boy!');
|
||||
|
||||
$cacheDir = $conf->get('resource.thumbnails_cache', 'cache');
|
||||
// Let's see if we don't already have the image for this URL in the cache.
|
||||
$thumbname=hash('sha1',$_GET['url']).'.jpg';
|
||||
if (is_file($cacheDir .'/'. $thumbname))
|
||||
{ // We have the thumbnail, just serve it:
|
||||
header('Content-Type: image/jpeg');
|
||||
echo file_get_contents($cacheDir .'/'. $thumbname);
|
||||
return;
|
||||
}
|
||||
// We may also serve a blank image (if service did not respond)
|
||||
$blankname=hash('sha1',$_GET['url']).'.gif';
|
||||
if (is_file($cacheDir .'/'. $blankname))
|
||||
{
|
||||
header('Content-Type: image/gif');
|
||||
echo file_get_contents($cacheDir .'/'. $blankname);
|
||||
return;
|
||||
}
|
||||
|
||||
// Otherwise, generate the thumbnail.
|
||||
$url = $_GET['url'];
|
||||
$domain = parse_url($url,PHP_URL_HOST);
|
||||
|
||||
if ($domain=='flickr.com' || endsWith($domain,'.flickr.com'))
|
||||
{
|
||||
// Crude replacement to handle new flickr domain policy (They prefer www. now)
|
||||
$url = str_replace('http://flickr.com/','http://www.flickr.com/',$url);
|
||||
|
||||
// Is this a link to an image, or to a flickr page ?
|
||||
$imageurl='';
|
||||
if (endsWith(parse_url($url, PHP_URL_PATH), '.jpg'))
|
||||
{ // This is a direct link to an image. e.g. http://farm1.staticflickr.com/5/5921913_ac83ed27bd_o.jpg
|
||||
preg_match('!(http://farm\d+\.staticflickr\.com/\d+/\d+_\w+_)\w.jpg!',$url,$matches);
|
||||
if (!empty($matches[1])) $imageurl=$matches[1].'m.jpg';
|
||||
}
|
||||
else // This is a flickr page (html)
|
||||
{
|
||||
// Get the flickr html page.
|
||||
list($headers, $content) = get_http_response($url, 20);
|
||||
if (strpos($headers[0], '200 OK') !== false)
|
||||
{
|
||||
// flickr now nicely provides the URL of the thumbnail in each flickr page.
|
||||
preg_match('!<link rel=\"image_src\" href=\"(.+?)\"!', $content, $matches);
|
||||
if (!empty($matches[1])) $imageurl=$matches[1];
|
||||
|
||||
// In albums (and some other pages), the link rel="image_src" is not provided,
|
||||
// but flickr provides:
|
||||
// <meta property="og:image" content="http://farm4.staticflickr.com/3398/3239339068_25d13535ff_z.jpg" />
|
||||
if ($imageurl=='')
|
||||
{
|
||||
preg_match('!<meta property=\"og:image\" content=\"(.+?)\"!', $content, $matches);
|
||||
if (!empty($matches[1])) $imageurl=$matches[1];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ($imageurl!='')
|
||||
{ // Let's download the image.
|
||||
// Image is 240x120, so 10 seconds to download should be enough.
|
||||
list($headers, $content) = get_http_response($imageurl, 10);
|
||||
if (strpos($headers[0], '200 OK') !== false) {
|
||||
// Save image to cache.
|
||||
file_put_contents($cacheDir .'/'. $thumbname, $content);
|
||||
header('Content-Type: image/jpeg');
|
||||
echo $content;
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
elseif ($domain=='vimeo.com' )
|
||||
{
|
||||
// This is more complex: we have to perform a HTTP request, then parse the result.
|
||||
// Maybe we should deport this to JavaScript ? Example: http://stackoverflow.com/questions/1361149/get-img-thumbnails-from-vimeo/4285098#4285098
|
||||
$vid = substr(parse_url($url,PHP_URL_PATH),1);
|
||||
list($headers, $content) = get_http_response('https://vimeo.com/api/v2/video/'.escape($vid).'.php', 5);
|
||||
if (strpos($headers[0], '200 OK') !== false) {
|
||||
$t = unserialize($content);
|
||||
$imageurl = $t[0]['thumbnail_medium'];
|
||||
// Then we download the image and serve it to our client.
|
||||
list($headers, $content) = get_http_response($imageurl, 10);
|
||||
if (strpos($headers[0], '200 OK') !== false) {
|
||||
// Save image to cache.
|
||||
file_put_contents($cacheDir .'/'. $thumbname, $content);
|
||||
header('Content-Type: image/jpeg');
|
||||
echo $content;
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
elseif ($domain=='ted.com' || endsWith($domain,'.ted.com'))
|
||||
{
|
||||
// The thumbnail for TED talks is located in the <link rel="image_src" [...]> tag on that page
|
||||
// http://www.ted.com/talks/mikko_hypponen_fighting_viruses_defending_the_net.html
|
||||
// <link rel="image_src" href="http://images.ted.com/images/ted/28bced335898ba54d4441809c5b1112ffaf36781_389x292.jpg" />
|
||||
list($headers, $content) = get_http_response($url, 5);
|
||||
if (strpos($headers[0], '200 OK') !== false) {
|
||||
// Extract the link to the thumbnail
|
||||
preg_match('!link rel="image_src" href="(http://images.ted.com/images/ted/.+_\d+x\d+\.jpg)"!', $content, $matches);
|
||||
if (!empty($matches[1]))
|
||||
{ // Let's download the image.
|
||||
$imageurl=$matches[1];
|
||||
// No control on image size, so wait long enough
|
||||
list($headers, $content) = get_http_response($imageurl, 20);
|
||||
if (strpos($headers[0], '200 OK') !== false) {
|
||||
$filepath = $cacheDir .'/'. $thumbname;
|
||||
file_put_contents($filepath, $content); // Save image to cache.
|
||||
if (resizeImage($filepath))
|
||||
{
|
||||
header('Content-Type: image/jpeg');
|
||||
echo file_get_contents($filepath);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
elseif ($domain=='xkcd.com' || endsWith($domain,'.xkcd.com'))
|
||||
{
|
||||
// There is no thumbnail available for xkcd comics, so download the whole image and resize it.
|
||||
// http://xkcd.com/327/
|
||||
// <img src="http://imgs.xkcd.com/comics/exploits_of_a_mom.png" title="<BLABLA>" alt="<BLABLA>" />
|
||||
list($headers, $content) = get_http_response($url, 5);
|
||||
if (strpos($headers[0], '200 OK') !== false) {
|
||||
// Extract the link to the thumbnail
|
||||
preg_match('!<img src="(http://imgs.xkcd.com/comics/.*)" title="[^s]!', $content, $matches);
|
||||
if (!empty($matches[1]))
|
||||
{ // Let's download the image.
|
||||
$imageurl=$matches[1];
|
||||
// No control on image size, so wait long enough
|
||||
list($headers, $content) = get_http_response($imageurl, 20);
|
||||
if (strpos($headers[0], '200 OK') !== false) {
|
||||
$filepath = $cacheDir.'/'.$thumbname;
|
||||
// Save image to cache.
|
||||
file_put_contents($filepath, $content);
|
||||
if (resizeImage($filepath))
|
||||
{
|
||||
header('Content-Type: image/jpeg');
|
||||
echo file_get_contents($filepath);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
else
|
||||
{
|
||||
// For all other domains, we try to download the image and make a thumbnail.
|
||||
// We allow 30 seconds max to download (and downloads are limited to 4 Mb)
|
||||
list($headers, $content) = get_http_response($url, 30);
|
||||
if (strpos($headers[0], '200 OK') !== false) {
|
||||
$filepath = $cacheDir .'/'.$thumbname;
|
||||
// Save image to cache.
|
||||
file_put_contents($filepath, $content);
|
||||
if (resizeImage($filepath))
|
||||
{
|
||||
header('Content-Type: image/jpeg');
|
||||
echo file_get_contents($filepath);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Otherwise, return an empty image (8x8 transparent gif)
|
||||
$blankgif = base64_decode('R0lGODlhCAAIAIAAAP///////yH5BAEKAAEALAAAAAAIAAgAAAIHjI+py+1dAAA7');
|
||||
// Also put something in cache so that this URL is not requested twice.
|
||||
file_put_contents($cacheDir .'/'. $blankname, $blankgif);
|
||||
header('Content-Type: image/gif');
|
||||
echo $blankgif;
|
||||
}
|
||||
|
||||
// Make a thumbnail of the image (to width: 120 pixels)
|
||||
// Returns true if success, false otherwise.
|
||||
function resizeImage($filepath)
|
||||
{
|
||||
if (!function_exists('imagecreatefromjpeg')) return false; // GD not present: no thumbnail possible.
|
||||
|
||||
// Trick: some stupid people rename GIF as JPEG... or else.
|
||||
// So we really try to open each image type whatever the extension is.
|
||||
$header=file_get_contents($filepath,false,NULL,0,256); // Read first 256 bytes and try to sniff file type.
|
||||
$im=false;
|
||||
$i=strpos($header,'GIF8'); if (($i!==false) && ($i==0)) $im = imagecreatefromgif($filepath); // Well this is crude, but it should be enough.
|
||||
$i=strpos($header,'PNG'); if (($i!==false) && ($i==1)) $im = imagecreatefrompng($filepath);
|
||||
$i=strpos($header,'JFIF'); if ($i!==false) $im = imagecreatefromjpeg($filepath);
|
||||
if (!$im) return false; // Unable to open image (corrupted or not an image)
|
||||
$w = imagesx($im);
|
||||
$h = imagesy($im);
|
||||
$ystart = 0; $yheight=$h;
|
||||
if ($h>$w) { $ystart= ($h/2)-($w/2); $yheight=$w/2; }
|
||||
$nw = 120; // Desired width
|
||||
$nh = min(floor(($h*$nw)/$w),120); // Compute new width/height, but maximum 120 pixels height.
|
||||
// Resize image:
|
||||
$im2 = imagecreatetruecolor($nw,$nh);
|
||||
imagecopyresampled($im2, $im, 0, 0, 0, $ystart, $nw, $nh, $w, $yheight);
|
||||
imageinterlace($im2,true); // For progressive JPEG.
|
||||
$tempname=$filepath.'_TEMP.jpg';
|
||||
imagejpeg($im2, $tempname, 90);
|
||||
imagedestroy($im);
|
||||
imagedestroy($im2);
|
||||
unlink($filepath);
|
||||
rename($tempname,$filepath); // Overwrite original picture with thumbnail.
|
||||
return true;
|
||||
}
|
||||
|
||||
if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=genthumbnail')) { genThumbnail($conf); exit; } // Thumbnail generation/cache does not need the link database.
|
||||
if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf); exit; }
|
||||
if (!isset($_SESSION['LINKS_PER_PAGE'])) {
|
||||
$_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
|
||||
|
|
51
tests/ThumbnailerTest.php
Normal file
51
tests/ThumbnailerTest.php
Normal file
|
@ -0,0 +1,51 @@
|
|||
<?php
|
||||
|
||||
require_once 'application/Thumbnailer.php';
|
||||
require_once 'application/config/ConfigManager.php';
|
||||
|
||||
/**
|
||||
* Class ThumbnailerTest
|
||||
*
|
||||
* We only make 1 thumb test because:
|
||||
*
|
||||
* 1. the thumbnailer library is itself tested
|
||||
* 2. we don't want to make too many external requests during the tests
|
||||
*/
|
||||
class ThumbnailerTest extends PHPUnit_Framework_TestCase
|
||||
{
|
||||
/**
|
||||
* Test a thumbnail with a custom size.
|
||||
*/
|
||||
public function testThumbnailValid()
|
||||
{
|
||||
$conf = new ConfigManager('tests/utils/config/configJson');
|
||||
$width = 200;
|
||||
$height = 200;
|
||||
$conf->set('thumbnails.width', $width);
|
||||
$conf->set('thumbnails.height', $height);
|
||||
|
||||
$thumbnailer = new Thumbnailer($conf);
|
||||
$thumb = $thumbnailer->get('https://github.com/shaarli/Shaarli/');
|
||||
$this->assertNotFalse($thumb);
|
||||
$image = imagecreatefromstring(file_get_contents($thumb));
|
||||
$this->assertEquals($width, imagesx($image));
|
||||
$this->assertEquals($height, imagesy($image));
|
||||
}
|
||||
|
||||
/**
|
||||
* Test a thumbnail that can't be retrieved.
|
||||
*
|
||||
* @expectedException WebThumbnailer\Exception\ThumbnailNotFoundException
|
||||
*/
|
||||
public function testThumbnailNotValid()
|
||||
{
|
||||
$oldlog = ini_get('error_log');
|
||||
ini_set('error_log', '/dev/null');
|
||||
|
||||
$thumbnailer = new Thumbnailer(new ConfigManager());
|
||||
$thumb = $thumbnailer->get('nope');
|
||||
$this->assertFalse($thumb);
|
||||
|
||||
ini_set('error_log', $oldlog);
|
||||
}
|
||||
}
|
|
@ -29,6 +29,9 @@
|
|||
},
|
||||
"plugins": {
|
||||
"WALLABAG_VERSION": 1
|
||||
},
|
||||
"dev": {
|
||||
"debug": true
|
||||
}
|
||||
}
|
||||
*/ ?>
|
||||
|
|
|
@ -128,6 +128,18 @@
|
|||
<input type="text" name="apiSecret" id="apiSecret" size="50" value="{$api_secret}" />
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><b>Enable thumbnails</b></td>
|
||||
<td>
|
||||
<input type="checkbox" name="enableThumbnails" id="enableThumbnails"
|
||||
{if="$thumbnails_enabled"}checked{/if}/>
|
||||
<label for="enableThumbnails">
|
||||
<strong>Warning:</strong>
|
||||
If you have a large database, the first retrieval may take a few minutes.
|
||||
It's recommended to visit the picture wall after enabling this feature
|
||||
</label>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td></td>
|
||||
|
|
|
@ -80,7 +80,16 @@
|
|||
{loop="$links"}
|
||||
<li{if="$value.class"} class="{$value.class}"{/if}>
|
||||
<a id="{$value.shorturl}"></a>
|
||||
<div class="thumbnail">{$value.url|thumbnail}</div>
|
||||
{if="$thumbnails_enabled && !empty($value.thumbnail)"}
|
||||
<div class="thumbnail">
|
||||
<a href="{$value.real_url}">
|
||||
{ignore}RainTPL hack: put the 2 src on two different line to avoid path replace bug{/ignore}
|
||||
<img data-src="{$value.thumbnail}#" class="b-lazy"
|
||||
src="#"
|
||||
alt="thumbnail" width="{$thumbnails_width}" height="{$thumbnails_height}" />
|
||||
</a>
|
||||
</div>
|
||||
{/if}
|
||||
<div class="linkcontainer">
|
||||
{if="$is_logged_in"}
|
||||
<div class="linkeditbuttons">
|
||||
|
|
|
@ -15,7 +15,11 @@
|
|||
<div id="picwall_container">
|
||||
{loop="$linksToDisplay"}
|
||||
<div class="picwall_pictureframe">
|
||||
{$value.thumbnail}<a href="{$value.real_url}"><span class="info">{$value.title}</span></a>
|
||||
{ignore}RainTPL hack: put the 2 src on two different line to avoid path replace bug{/ignore}
|
||||
<img data-src="{$value.thumbnail}#" class="b-lazy"
|
||||
src="#"
|
||||
alt="thumbnail" width="{$thumbnails_width}" height="{$thumbnails_height}" />
|
||||
<a href="{$value.real_url}"><span class="info">{$value.title}</span></a>
|
||||
{loop="$value.picwall_plugin"}
|
||||
{$value}
|
||||
{/loop}
|
||||
|
|
Loading…
Reference in a new issue