3 namespace Wallabag\CoreBundle\Helper
;
6 use Psr\Log\LoggerInterface
;
7 use Symfony\Component\HttpFoundation\File\MimeType\MimeTypeExtensionGuesser
;
8 use Symfony\Component\Validator\Constraints\Locale
as LocaleConstraint
;
9 use Symfony\Component\Validator\Constraints\Url
as UrlConstraint
;
10 use Symfony\Component\Validator\Validator\ValidatorInterface
;
11 use Wallabag\CoreBundle\Entity\Entry
;
12 use Wallabag\CoreBundle\Tools\Utils
;
15 * This kind of proxy class takes care of getting the content from an url
16 * and updates the entry with what it found.
24 protected $mimeGuesser;
25 protected $fetchingErrorMessage;
26 protected $eventDispatcher;
27 protected $storeArticleHeaders;
29 public function __construct(Graby
$graby, RuleBasedTagger
$tagger, ValidatorInterface
$validator, LoggerInterface
$logger, $fetchingErrorMessage, $storeArticleHeaders = false)
31 $this->graby
= $graby;
32 $this->tagger
= $tagger;
33 $this->validator
= $validator;
34 $this->logger
= $logger;
35 $this->mimeGuesser
= new MimeTypeExtensionGuesser();
36 $this->fetchingErrorMessage
= $fetchingErrorMessage;
37 $this->storeArticleHeaders
= $storeArticleHeaders;
41 * Update entry using either fetched or provided content.
43 * @param Entry $entry Entry to update
44 * @param string $url Url of the content
45 * @param array $content Array with content provided for import with AT LEAST keys title, html, url to skip the fetchContent from the url
46 * @param bool $disableContentUpdate Whether to skip trying to fetch content using Graby
48 public function updateEntry(Entry
$entry, $url, array $content = [], $disableContentUpdate = false)
50 $this->graby
->toggleImgNoReferrer(true);
51 if (!empty($content['html'])) {
52 $content['html'] = $this->graby
->cleanupHtml($content['html'], $url);
55 if ((empty($content) || false === $this->validateContent($content)) && false === $disableContentUpdate) {
56 $fetchedContent = $this->graby
->fetchContent($url);
58 $fetchedContent['title'] = $this->sanitizeContentTitle(
59 $fetchedContent['title'],
60 isset($fetchedContent['headers']['content-type']) ? $fetchedContent['headers']['content-type'] : ''
63 // when content is imported, we have information in $content
64 // in case fetching content goes bad, we'll keep the imported information instead of overriding them
65 if (empty($content) || $fetchedContent['html'] !== $this->fetchingErrorMessage
) {
66 $content = $fetchedContent;
70 // be sure to keep the url in case of error
71 // so we'll be able to refetch it in the future
72 $content['url'] = !empty($content['url']) ? $content['url'] : $url;
74 // In one case (at least in tests), url is empty here
75 // so we set it using $url provided in the updateEntry call.
76 // Not sure what are the other possible cases where this property is empty
77 if (empty($entry->getUrl()) && !empty($url)) {
81 $this->stockEntry($entry, $content);
85 * Use a Symfony validator to ensure the language is well formatted.
88 * @param string $value Language to validate and save
90 public function updateLanguage(Entry
$entry, $value)
92 // some lang are defined as fr-FR, es-ES.
93 // replacing - by _ might increase language support
94 $value = str_replace('-', '_', $value);
96 $errors = $this->validator
->validate(
98 (new LocaleConstraint())
101 if (0 === \
count($errors)) {
102 $entry->setLanguage($value);
107 $this->logger
->warning('Language validation failed. ' . (string) $errors);
111 * Use a Symfony validator to ensure the preview picture is a real url.
113 * @param Entry $entry
114 * @param string $value URL to validate and save
116 public function updatePreviewPicture(Entry
$entry, $value)
118 $errors = $this->validator
->validate(
120 (new UrlConstraint())
123 if (0 === \
count($errors)) {
124 $entry->setPreviewPicture($value);
129 $this->logger
->warning('PreviewPicture validation failed. ' . (string) $errors);
135 * @param Entry $entry
136 * @param string $value Date to validate and save
138 public function updatePublishedAt(Entry
$entry, $value)
142 // is it a timestamp?
143 if (false !== filter_var($date, FILTER_VALIDATE_INT
)) {
148 // is it already a DateTime?
149 // (it's inside the try/catch in case of fail to be parse time string)
150 if (!$date instanceof \DateTime
) {
151 $date = new \
DateTime($date);
154 $entry->setPublishedAt($date);
155 } catch (\Exception
$e) {
156 $this->logger
->warning('Error while defining date', ['e' => $e, 'url' => $entry->getUrl(), 'date' => $value]);
161 * Helper to extract and save host from entry url.
163 * @param Entry $entry
165 public function setEntryDomainName(Entry
$entry)
167 $domainName = parse_url($entry->getUrl(), PHP_URL_HOST
);
168 if (false !== $domainName) {
169 $entry->setDomainName($domainName);
174 * Helper to set a default title using:
175 * - url basename, if applicable
178 * @param Entry $entry
180 public function setDefaultEntryTitle(Entry
$entry)
182 $url = parse_url($entry->getUrl());
183 $path = pathinfo($url['path'], PATHINFO_BASENAME
);
186 $path = $url['host'];
189 $entry->setTitle($path);
193 * Try to sanitize the title of the fetched content from wrong character encodings and invalid UTF-8 character.
195 * @param string $title
196 * @param string $contentType
200 private function sanitizeContentTitle($title, $contentType)
202 if ('application/pdf' === $contentType) {
203 $title = $this->convertPdfEncodingToUTF8($title);
206 return $this->sanitizeUTF8Text($title);
210 * If the title from the fetched content comes from a PDF, then its very possible that the character encoding is not
211 * UTF-8. This methods tries to identify the character encoding and translate the title to UTF-8.
215 * @return string (maybe contains invalid UTF-8 character)
217 private function convertPdfEncodingToUTF8($title)
219 // first try UTF-8 because its easier to detect its present/absence
220 foreach (['UTF-8', 'UTF-16BE', 'WINDOWS-1252'] as $encoding) {
221 if (mb_check_encoding($title, $encoding)) {
222 return mb_convert_encoding($title, 'UTF-8', $encoding);
230 * Remove invalid UTF-8 characters from the given string.
232 * @param string $rawText
236 private function sanitizeUTF8Text($rawText)
238 if (mb_check_encoding($rawText, 'UTF-8')) {
242 return iconv('UTF-8', 'UTF-8//IGNORE', $rawText);
246 * Stock entry with fetched or imported content.
247 * Will fall back to OpenGraph data if available.
249 * @param Entry $entry Entry to stock
250 * @param array $content Array with at least title, url & html
252 private function stockEntry(Entry
$entry, array $content)
254 $this->updateOriginUrl($entry, $content['url']);
256 $this->setEntryDomainName($entry);
258 if (!empty($content['title'])) {
259 $entry->setTitle($content['title']);
262 if (empty($content['html'])) {
263 $content['html'] = $this->fetchingErrorMessage
;
265 if (!empty($content['description'])) {
266 $content['html'] .= '<p><i>But we found a short description: </i></p>';
267 $content['html'] .= $content['description'];
271 $entry->setContent($content['html']);
272 $entry->setReadingTime(Utils
::getReadingTime($content['html']));
274 if (!empty($content['status'])) {
275 $entry->setHttpStatus($content['status']);
278 if (!empty($content['authors']) && \
is_array($content['authors'])) {
279 $entry->setPublishedBy($content['authors']);
282 if (!empty($content['headers'])) {
283 $entry->setHeaders($content['headers']);
286 if (!empty($content['date'])) {
287 $this->updatePublishedAt($entry, $content['date']);
290 if (!empty($content['language'])) {
291 $this->updateLanguage($entry, $content['language']);
294 $previewPictureUrl = '';
295 if (!empty($content['image'])) {
296 $previewPictureUrl = $content['image'];
299 // if content is an image, define it as a preview too
300 if (!empty($content['headers']['content-type']) && \
in_array($this->mimeGuesser
->guess($content['headers']['content-type']), ['jpeg', 'jpg', 'gif', 'png'], true)) {
301 $previewPictureUrl = $content['url'];
302 } elseif (empty($previewPictureUrl)) {
303 $this->logger
->debug('Extracting images from content to provide a default preview picture');
304 $imagesUrls = DownloadImages
::extractImagesUrlsFromHtml($content['html']);
305 $this->logger
->debug(\
count($imagesUrls) . ' pictures found');
307 if (!empty($imagesUrls)) {
308 $previewPictureUrl = $imagesUrls[0];
312 if (!empty($content['headers']['content-type'])) {
313 $entry->setMimetype($content['headers']['content-type']);
316 if (!empty($previewPictureUrl)) {
317 $this->updatePreviewPicture($entry, $previewPictureUrl);
321 $this->tagger
->tag($entry);
322 } catch (\Exception
$e) {
323 $this->logger
->error('Error while trying to automatically tag an entry.', [
324 'entry_url' => $content['url'],
325 'error_msg' => $e->getMessage(),
331 * Update the origin_url field when a redirection occurs
332 * This field is set if it is empty and new url does not match ignore list.
334 * @param Entry $entry
337 private function updateOriginUrl(Entry
$entry, $url)
339 if (empty($url) || $entry->getUrl() === $url) {
343 $parsed_entry_url = parse_url($entry->getUrl());
344 $parsed_content_url = parse_url($url);
347 * The following part computes the list of part changes between two
350 * As array_diff_assoc only computes changes to go from the left array
351 * to the right one, we make two differents arrays to have both
352 * directions. We merge these two arrays and sort keys before passing
353 * the result to the switch.
355 * The resulting array gives us all changing parts between the two
356 * urls: scheme, host, path, query and/or fragment.
358 $diff_ec = array_diff_assoc($parsed_entry_url, $parsed_content_url);
359 $diff_ce = array_diff_assoc($parsed_content_url, $parsed_entry_url);
361 $diff = array_merge($diff_ec, $diff_ce);
362 $diff_keys = array_keys($diff);
365 if ($this->ignoreUrl($entry->getUrl())) {
366 $entry->setUrl($url);
372 * This switch case lets us apply different behaviors according to
373 * changing parts of urls.
375 * As $diff_keys is an array, we provide arrays as cases. ['path'] means
376 * 'only the path is different between the two urls' whereas
377 * ['fragment', 'query'] means 'only fragment and query string parts are
378 * different between the two urls'.
380 * Note that values in $diff_keys are sorted.
382 switch ($diff_keys) {
384 if (($parsed_entry_url['path'] . '/' === $parsed_content_url['path']) // diff is trailing slash, we only replace the url of the entry
385 || ($url === urldecode($entry->getUrl()))) { // we update entry url if new url is a decoded version of it, see EntryRepository#findByUrlAndUserId
386 $entry->setUrl($url);
390 $entry->setUrl($url);
396 if (empty($entry->getOriginUrl())) {
397 $entry->setOriginUrl($entry->getUrl());
399 $entry->setUrl($url);
405 * Check entry url against an ignore list to replace with content url.
407 * XXX: move the ignore list in the database to let users handle it
409 * @param string $url url to test
411 * @return bool true if url matches ignore list otherwise false
413 private function ignoreUrl($url)
415 $ignored_hosts = ['feedproxy.google.com', 'feeds.reuters.com'];
416 $ignored_patterns = ['https?://www\.lemonde\.fr/tiny.*'];
418 $parsed_url = parse_url($url);
420 $filtered = array_filter($ignored_hosts, function ($var) use ($parsed_url) {
421 return $var === $parsed_url['host'];
424 if ([] !== $filtered) {
428 $filtered = array_filter($ignored_patterns, function ($var) use ($url) {
429 return preg_match("`$var`i", $url);
432 if ([] !== $filtered) {
440 * Validate that the given content has at least a title, an html and a url.
442 * @param array $content
444 * @return bool true if valid otherwise false
446 private function validateContent(array $content)
448 return !empty($content['title']) && !empty($content['html']) && !empty($content['url']);