Use doctrine event to download images

This commit is contained in:
Jeremy Benoist 2016-10-30 10:48:29 +01:00
parent 45fd7e09d7
commit 7f55941856
No known key found for this signature in database
GPG key ID: BCA73962457ACC3C
6 changed files with 401 additions and 132 deletions

View file

@ -0,0 +1,129 @@
<?php
namespace Wallabag\CoreBundle\Event\Subscriber;
use Doctrine\Common\EventSubscriber;
use Doctrine\ORM\Event\LifecycleEventArgs;
use Psr\Log\LoggerInterface;
use Wallabag\CoreBundle\Helper\DownloadImages;
use Wallabag\CoreBundle\Entity\Entry;
use Doctrine\ORM\EntityManager;
use Craue\ConfigBundle\Util\Config;
class DownloadImagesSubscriber implements EventSubscriber
{
private $configClass;
private $downloadImages;
private $logger;
/**
* We inject the class instead of the service otherwise it generates a circular reference with the EntityManager.
* So we build the service ourself when we got the EntityManager (in downloadImages).
*/
public function __construct(DownloadImages $downloadImages, $configClass, LoggerInterface $logger)
{
$this->downloadImages = $downloadImages;
$this->configClass = $configClass;
$this->logger = $logger;
}
public function getSubscribedEvents()
{
return array(
'prePersist',
'preUpdate',
);
}
/**
* In case of an entry has been updated.
* We won't update the content field if it wasn't updated.
*
* @param LifecycleEventArgs $args
*/
public function preUpdate(LifecycleEventArgs $args)
{
$entity = $args->getEntity();
if (!$entity instanceof Entry) {
return;
}
$em = $args->getEntityManager();
// field content has been updated
if ($args->hasChangedField('content')) {
$html = $this->downloadImages($em, $entity);
if (null !== $html) {
$args->setNewValue('content', $html);
}
}
// field preview picture has been updated
if ($args->hasChangedField('previewPicture')) {
$previewPicture = $this->downloadPreviewImage($em, $entity);
if (null !== $previewPicture) {
$entity->setPreviewPicture($previewPicture);
}
}
}
/**
* When a new entry is saved.
*
* @param LifecycleEventArgs $args
*/
public function prePersist(LifecycleEventArgs $args)
{
$entity = $args->getEntity();
if (!$entity instanceof Entry) {
return;
}
$config = new $this->configClass();
$config->setEntityManager($args->getEntityManager());
// update all images inside the html
$html = $this->downloadImages($config, $entity);
if (null !== $html) {
$entity->setContent($html);
}
// update preview picture
$previewPicture = $this->downloadPreviewImage($config, $entity);
if (null !== $previewPicture) {
$entity->setPreviewPicture($previewPicture);
}
}
public function downloadImages(Config $config, Entry $entry)
{
// if ($config->get('download_images_with_rabbitmq')) {
// } else if ($config->get('download_images_with_redis')) {
// }
return $this->downloadImages->processHtml(
$entry->getContent(),
$entry->getUrl()
);
}
public function downloadPreviewImage(Config $config, Entry $entry)
{
// if ($config->get('download_images_with_rabbitmq')) {
// } else if ($config->get('download_images_with_redis')) {
// }
return $this->downloadImages->processSingleImage(
$entry->getPreviewPicture(),
$entry->getUrl()
);
}
}

View file

@ -75,12 +75,6 @@ class ContentProxy
$entry->setDomainName($domainName);
}
if (true) {
$this->logger->log('debug', 'Starting to download images');
$downloadImages = new DownloadImages($html, $url, $this->logger);
$html = $downloadImages->process();
}
$entry->setContent($html);
if (isset($content['open_graph']['og_image'])) {

View file

@ -2,193 +2,197 @@
namespace Wallabag\CoreBundle\Helper;
use Psr\Log\LoggerInterface as Logger;
use Psr\Log\LoggerInterface;
use Symfony\Component\DomCrawler\Crawler;
define('REGENERATE_PICTURES_QUALITY', 75);
define('HTTP_PORT', 80);
define('SSL_PORT', 443);
define('BASE_URL', '');
use GuzzleHttp\Client;
use Symfony\Component\HttpFoundation\File\MimeType\MimeTypeExtensionGuesser;
class DownloadImages
{
private $folder;
private $url;
private $html;
private $fileName;
private $logger;
const REGENERATE_PICTURES_QUALITY = 80;
public function __construct($html, $url, Logger $logger)
private $client;
private $baseFolder;
private $logger;
private $mimeGuesser;
public function __construct(Client $client, $baseFolder, LoggerInterface $logger)
{
$this->html = $html;
$this->url = $url;
$this->setFolder();
$this->client = $client;
$this->baseFolder = $baseFolder;
$this->logger = $logger;
$this->mimeGuesser = new MimeTypeExtensionGuesser();
$this->setFolder();
}
public function setFolder($folder = 'assets/images')
/**
* Setup base folder where all images are going to be saved.
*/
private function setFolder()
{
// if folder doesn't exist, attempt to create one and store the folder name in property $folder
if (!file_exists($folder)) {
mkdir($folder);
if (!file_exists($this->baseFolder)) {
mkdir($this->baseFolder, 0777, true);
}
$this->folder = $folder;
}
public function process()
/**
* Process the html and extract image from it, save them to local and return the updated html.
*
* @param string $html
* @param string $url Used as a base path for relative image and folder
*
* @return string
*/
public function processHtml($html, $url)
{
//instantiate the symfony DomCrawler Component
$crawler = new Crawler($this->html);
// create an array of all scrapped image links
$this->logger->log('debug', 'Finding images inside document');
$crawler = new Crawler($html);
$result = $crawler
->filterXpath('//img')
->extract(array('src'));
$relativePath = $this->getRelativePath($url);
// download and save the image to the folder
foreach ($result as $image) {
$file = file_get_contents($image);
$imagePath = $this->processSingleImage($image, $url, $relativePath);
// Checks
$absolute_path = self::getAbsoluteLink($image, $this->url);
$filename = basename(parse_url($absolute_path, PHP_URL_PATH));
$fullpath = $this->folder.'/'.$filename;
self::checks($file, $fullpath, $absolute_path);
$this->html = str_replace($image, self::getPocheUrl().'/'.$fullpath, $this->html);
if (false === $imagePath) {
continue;
}
$html = str_replace($image, $imagePath, $html);
}
return $this->html;
return $html;
}
private function checks($rawdata, $fullpath, $absolute_path)
/**
* Process a single image:
* - retrieve it
* - re-saved it (for security reason)
* - return the new local path.
*
* @param string $imagePath Path to the image to retrieve
* @param string $url Url from where the image were found
* @param string $relativePath Relative local path to saved the image
*
* @return string Relative url to access the image from the web
*/
public function processSingleImage($imagePath, $url, $relativePath = null)
{
$fullpath = urldecode($fullpath);
if (file_exists($fullpath)) {
unlink($fullpath);
if (null == $relativePath) {
$relativePath = $this->getRelativePath($url);
}
// check extension
$this->logger->log('debug', 'Checking extension');
$folderPath = $this->baseFolder.'/'.$relativePath;
$file_ext = strrchr($fullpath, '.');
$whitelist = array('.jpg', '.jpeg', '.gif', '.png');
if (!(in_array($file_ext, $whitelist))) {
$this->logger->log('debug', 'processed image with not allowed extension. Skipping '.$fullpath);
// build image path
$absolutePath = $this->getAbsoluteLink($url, $imagePath);
if (false === $absolutePath) {
$this->logger->log('debug', 'Can not determine the absolute path for that image, skipping.');
return false;
}
// check headers
$this->logger->log('debug', 'Checking headers');
$imageinfo = getimagesize($absolute_path);
if ($imageinfo['mime'] != 'image/gif' && $imageinfo['mime'] != 'image/jpeg' && $imageinfo['mime'] != 'image/jpg' && $imageinfo['mime'] != 'image/png') {
$this->logger->log('debug', 'processed image with bad header. Skipping '.$fullpath);
$res = $this->client->get(
$absolutePath,
['exceptions' => false]
);
$ext = $this->mimeGuesser->guess($res->getHeader('content-type'));
$this->logger->log('debug', 'Checking extension', ['ext' => $ext, 'header' => $res->getHeader('content-type')]);
if (!in_array($ext, ['jpeg', 'jpg', 'gif', 'png'])) {
$this->logger->log('debug', 'Processed image with not allowed extension. Skipping '.$imagePath);
return false;
}
$hashImage = hash('crc32', $absolutePath);
$localPath = $folderPath.'/'.$hashImage.'.'.$ext;
try {
$im = imagecreatefromstring($res->getBody());
} catch (\Exception $e) {
$im = false;
}
// regenerate image
$this->logger->log('debug', 'regenerating image');
$im = imagecreatefromstring($rawdata);
if ($im === false) {
$this->logger->log('error', 'error while regenerating image '.$fullpath);
$this->logger->log('error', 'Error while regenerating image', ['path' => $localPath]);
return false;
}
switch ($imageinfo['mime']) {
case 'image/gif':
$result = imagegif($im, $fullpath);
switch ($ext) {
case 'gif':
$result = imagegif($im, $localPath);
$this->logger->log('debug', 'Re-creating gif');
break;
case 'image/jpeg':
case 'image/jpg':
$result = imagejpeg($im, $fullpath, REGENERATE_PICTURES_QUALITY);
case 'jpeg':
case 'jpg':
$result = imagejpeg($im, $localPath, self::REGENERATE_PICTURES_QUALITY);
$this->logger->log('debug', 'Re-creating jpg');
break;
case 'image/png':
case 'png':
$result = imagepng($im, $localPath, ceil(self::REGENERATE_PICTURES_QUALITY / 100 * 9));
$this->logger->log('debug', 'Re-creating png');
$result = imagepng($im, $fullpath, ceil(REGENERATE_PICTURES_QUALITY / 100 * 9));
break;
}
imagedestroy($im);
return $result;
return '/assets/images/'.$relativePath.'/'.$hashImage.'.'.$ext;
}
private static function getAbsoluteLink($relativeLink, $url)
/**
* Generate the folder where we are going to save images based on the entry url.
*
* @param string $url
*
* @return string
*/
private function getRelativePath($url)
{
/* return if already absolute URL */
if (parse_url($relativeLink, PHP_URL_SCHEME) != '') {
return $relativeLink;
$hashUrl = hash('crc32', $url);
$relativePath = $hashUrl[0].'/'.$hashUrl[1].'/'.$hashUrl;
$folderPath = $this->baseFolder.'/'.$relativePath;
if (!file_exists($folderPath)) {
mkdir($folderPath, 0777, true);
}
/* queries and anchors */
if ($relativeLink[0] == '#' || $relativeLink[0] == '?') {
return $url.$relativeLink;
}
$this->logger->log('debug', 'Folder used for that url', ['folder' => $folderPath, 'url' => $url]);
/* parse base URL and convert to local variables:
$scheme, $host, $path */
extract(parse_url($url));
/* remove non-directory element from path */
$path = preg_replace('#/[^/]*$#', '', $path);
/* destroy path if relative url points to root */
if ($relativeLink[0] == '/') {
$path = '';
}
/* dirty absolute URL */
$abs = $host.$path.'/'.$relativeLink;
/* replace '//' or '/./' or '/foo/../' with '/' */
$re = array('#(/\.?/)#', '#/(?!\.\.)[^/]+/\.\./#');
for ($n = 1; $n > 0; $abs = preg_replace($re, '/', $abs, -1, $n)) {
}
/* absolute URL is ready! */
return $scheme.'://'.$abs;
return $relativePath;
}
public static function getPocheUrl()
/**
* Make an $url absolute based on the $base.
*
* @see Graby->makeAbsoluteStr
*
* @param string $base Base url
* @param string $url Url to make it absolute
*
* @return false|string
*/
private function getAbsoluteLink($base, $url)
{
$baseUrl = '';
$https = (!empty($_SERVER['HTTPS'])
&& (strtolower($_SERVER['HTTPS']) == 'on'))
|| (isset($_SERVER['SERVER_PORT'])
&& $_SERVER['SERVER_PORT'] == '443') // HTTPS detection.
|| (isset($_SERVER['SERVER_PORT']) //Custom HTTPS port detection
&& $_SERVER['SERVER_PORT'] == SSL_PORT)
|| (isset($_SERVER['HTTP_X_FORWARDED_PROTO'])
&& $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https');
$serverport = (!isset($_SERVER['SERVER_PORT'])
|| $_SERVER['SERVER_PORT'] == '80'
|| $_SERVER['SERVER_PORT'] == HTTP_PORT
|| ($https && $_SERVER['SERVER_PORT'] == '443')
|| ($https && $_SERVER['SERVER_PORT'] == SSL_PORT) //Custom HTTPS port detection
? '' : ':'.$_SERVER['SERVER_PORT']);
if (isset($_SERVER['HTTP_X_FORWARDED_PORT'])) {
$serverport = ':'.$_SERVER['HTTP_X_FORWARDED_PORT'];
}
// $scriptname = str_replace('/index.php', '/', $_SERVER["SCRIPT_NAME"]);
// if (!isset($_SERVER["HTTP_HOST"])) {
// return $scriptname;
// }
$host = (isset($_SERVER['HTTP_X_FORWARDED_HOST']) ? $_SERVER['HTTP_X_FORWARDED_HOST'] : (isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_SERVER['SERVER_NAME']));
if (strpos($host, ':') !== false) {
$serverport = '';
}
// check if BASE_URL is configured
if (BASE_URL) {
$baseUrl = BASE_URL;
} else {
$baseUrl = 'http'.($https ? 's' : '').'://'.$host.$serverport;
if (preg_match('!^https?://!i', $url)) {
// already absolute
return $url;
}
return $baseUrl;
$base = new \SimplePie_IRI($base);
// remove '//' in URL path (causes URLs not to resolve properly)
if (isset($base->ipath)) {
$base->ipath = preg_replace('!//+!', '/', $base->ipath);
}
if ($absolute = \SimplePie_IRI::absolutize($base, $url)) {
return $absolute->get_uri();
}
return false;
}
}

View file

@ -136,3 +136,22 @@ services:
- "@doctrine"
tags:
- { name: doctrine.event_subscriber }
wallabag_core.subscriber.download_images:
class: Wallabag\CoreBundle\Event\Subscriber\DownloadImagesSubscriber
arguments:
- "@wallabag_core.entry.download_images"
- "%craue_config.config.class%"
- "@logger"
tags:
- { name: doctrine.event_subscriber }
wallabag_core.entry.download_images:
class: Wallabag\CoreBundle\Helper\DownloadImages
arguments:
- "@wallabag_core.entry.download_images.client"
- "%kernel.root_dir%/../web/assets/images"
- "@logger"
wallabag_core.entry.download_images.client:
class: GuzzleHttp\Client

View file

@ -0,0 +1,123 @@
<?php
namespace Tests\Wallabag\CoreBundle\Helper;
use Wallabag\CoreBundle\Helper\DownloadImages;
use Psr\Log\NullLogger;
use Monolog\Logger;
use Monolog\Handler\TestHandler;
use GuzzleHttp\Client;
use GuzzleHttp\Subscriber\Mock;
use GuzzleHttp\Message\Response;
use GuzzleHttp\Stream\Stream;
class DownloadImagesTest extends \PHPUnit_Framework_TestCase
{
public function testProcessHtml()
{
$client = new Client();
$mock = new Mock([
new Response(200, ['content-type' => 'image/png'], Stream::factory(file_get_contents(__DIR__.'/../fixtures/unnamed.png'))),
]);
$client->getEmitter()->attach($mock);
$logHandler = new TestHandler();
$logger = new Logger('test', array($logHandler));
$download = new DownloadImages($client, sys_get_temp_dir().'/wallabag_test', $logger);
$res = $download->processHtml('<div><img src="http://i.imgur.com/T9qgcHc.jpg" /></div>', 'http://imgur.com/gallery/WxtWY');
$this->assertContains('/assets/images/4/2/4258f71e/c638b4c2.png', $res);
}
public function testProcessHtmlWithBadImage()
{
$client = new Client();
$mock = new Mock([
new Response(200, ['content-type' => 'application/json'], Stream::factory('')),
]);
$client->getEmitter()->attach($mock);
$logHandler = new TestHandler();
$logger = new Logger('test', array($logHandler));
$download = new DownloadImages($client, sys_get_temp_dir().'/wallabag_test', $logger);
$res = $download->processHtml('<div><img src="http://i.imgur.com/T9qgcHc.jpg" /></div>', 'http://imgur.com/gallery/WxtWY');
$this->assertContains('http://i.imgur.com/T9qgcHc.jpg', $res, 'Image were not replace because of content-type');
}
public function singleImage()
{
return [
['image/pjpeg', 'jpeg'],
['image/jpeg', 'jpeg'],
['image/png', 'png'],
['image/gif', 'gif'],
];
}
/**
* @dataProvider singleImage
*/
public function testProcessSingleImage($header, $extension)
{
$client = new Client();
$mock = new Mock([
new Response(200, ['content-type' => $header], Stream::factory(file_get_contents(__DIR__.'/../fixtures/unnamed.png'))),
]);
$client->getEmitter()->attach($mock);
$logHandler = new TestHandler();
$logger = new Logger('test', array($logHandler));
$download = new DownloadImages($client, sys_get_temp_dir().'/wallabag_test', $logger);
$res = $download->processSingleImage('T9qgcHc.jpg', 'http://imgur.com/gallery/WxtWY');
$this->assertContains('/assets/images/4/2/4258f71e/ebe60399.'.$extension, $res);
}
public function testProcessSingleImageWithBadImage()
{
$client = new Client();
$mock = new Mock([
new Response(200, ['content-type' => 'image/png'], Stream::factory('')),
]);
$client->getEmitter()->attach($mock);
$logHandler = new TestHandler();
$logger = new Logger('test', array($logHandler));
$download = new DownloadImages($client, sys_get_temp_dir().'/wallabag_test', $logger);
$res = $download->processSingleImage('http://i.imgur.com/T9qgcHc.jpg', 'http://imgur.com/gallery/WxtWY');
$this->assertFalse($res, 'Image can not be loaded, so it will not be replaced');
}
public function testProcessSingleImageFailAbsolute()
{
$client = new Client();
$mock = new Mock([
new Response(200, ['content-type' => 'image/png'], Stream::factory(file_get_contents(__DIR__.'/../fixtures/unnamed.png'))),
]);
$client->getEmitter()->attach($mock);
$logHandler = new TestHandler();
$logger = new Logger('test', array($logHandler));
$download = new DownloadImages($client, sys_get_temp_dir().'/wallabag_test', $logger);
$res = $download->processSingleImage('/i.imgur.com/T9qgcHc.jpg', 'imgur.com/gallery/WxtWY');
$this->assertFalse($res, 'Absolute image can not be determined, so it will not be replaced');
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 KiB