protected $mimeGuesser;
protected $fetchingErrorMessage;
protected $eventDispatcher;
+ protected $storeArticleHeaders;
- public function __construct(Graby $graby, RuleBasedTagger $tagger, ValidatorInterface $validator, LoggerInterface $logger, $fetchingErrorMessage)
+ public function __construct(Graby $graby, RuleBasedTagger $tagger, ValidatorInterface $validator, LoggerInterface $logger, $fetchingErrorMessage, $storeArticleHeaders = false)
{
$this->graby = $graby;
$this->tagger = $tagger;
$this->logger = $logger;
$this->mimeGuesser = new MimeTypeExtensionGuesser();
$this->fetchingErrorMessage = $fetchingErrorMessage;
+ $this->storeArticleHeaders = $storeArticleHeaders;
}
/**
if ((empty($content) || false === $this->validateContent($content)) && false === $disableContentUpdate) {
$fetchedContent = $this->graby->fetchContent($url);
+ $fetchedContent['title'] = $this->sanitizeContentTitle($fetchedContent['title'], $fetchedContent['content_type']);
// when content is imported, we have information in $content
// in case fetching content goes bad, we'll keep the imported information instead of overriding them
// so we'll be able to refetch it in the future
$content['url'] = !empty($content['url']) ? $content['url'] : $url;
+ // In one case (at least in tests), url is empty here
+ // so we set it using $url provided in the updateEntry call.
+ // Not sure what are the other possible cases where this property is empty
+ if (empty($entry->getUrl()) && !empty($url)) {
+ $entry->setUrl($url);
+ }
+
$this->stockEntry($entry, $content);
}
+ /**
+ * Use a Symfony validator to ensure the language is well formatted.
+ *
+ * @param Entry $entry
+ * @param string $value Language to validate and save
+ */
+ public function updateLanguage(Entry $entry, $value)
+ {
+ // some lang are defined as fr-FR, es-ES.
+ // replacing - by _ might increase language support
+ $value = str_replace('-', '_', $value);
+
+ $errors = $this->validator->validate(
+ $value,
+ (new LocaleConstraint())
+ );
+
+ if (0 === \count($errors)) {
+ $entry->setLanguage($value);
+
+ return;
+ }
+
+ $this->logger->warning('Language validation failed. ' . (string) $errors);
+ }
+
+ /**
+ * Use a Symfony validator to ensure the preview picture is a real url.
+ *
+ * @param Entry $entry
+ * @param string $value URL to validate and save
+ */
+ public function updatePreviewPicture(Entry $entry, $value)
+ {
+ $errors = $this->validator->validate(
+ $value,
+ (new UrlConstraint())
+ );
+
+ if (0 === \count($errors)) {
+ $entry->setPreviewPicture($value);
+
+ return;
+ }
+
+ $this->logger->warning('PreviewPicture validation failed. ' . (string) $errors);
+ }
+
+ /**
+ * Update date.
+ *
+ * @param Entry $entry
+ * @param string $value Date to validate and save
+ */
+ public function updatePublishedAt(Entry $entry, $value)
+ {
+ $date = $value;
+
+ // is it a timestamp?
+ if (false !== filter_var($date, FILTER_VALIDATE_INT)) {
+ $date = '@' . $date;
+ }
+
+ try {
+ // is it already a DateTime?
+ // (it's inside the try/catch in case of fail to be parse time string)
+ if (!$date instanceof \DateTime) {
+ $date = new \DateTime($date);
+ }
+
+ $entry->setPublishedAt($date);
+ } catch (\Exception $e) {
+ $this->logger->warning('Error while defining date', ['e' => $e, 'url' => $entry->getUrl(), 'date' => $value]);
+ }
+ }
+
+ /**
+ * Helper to extract and save host from entry url.
+ *
+ * @param Entry $entry
+ */
+ public function setEntryDomainName(Entry $entry)
+ {
+ $domainName = parse_url($entry->getUrl(), PHP_URL_HOST);
+ if (false !== $domainName) {
+ $entry->setDomainName($domainName);
+ }
+ }
+
+ /**
+ * Helper to set a default title using:
+ * - url basename, if applicable
+ * - hostname.
+ *
+ * @param Entry $entry
+ */
+ public function setDefaultEntryTitle(Entry $entry)
+ {
+ $url = parse_url($entry->getUrl());
+ $path = pathinfo($url['path'], PATHINFO_BASENAME);
+
+ if (empty($path)) {
+ $path = $url['host'];
+ }
+
+ $entry->setTitle($path);
+ }
+
+ /**
+ * Try to sanitize the title of the fetched content from wrong character encodings and invalid UTF-8 character.
+ *
+ * @param $title
+ * @param $contentType
+ *
+ * @return string
+ */
+ private function sanitizeContentTitle($title, $contentType)
+ {
+ if ('application/pdf' === $contentType) {
+ $title = $this->convertPdfEncodingToUTF8($title);
+ }
+
+ return $this->sanitizeUTF8Text($title);
+ }
+
+ /**
+ * If the title from the fetched content comes from a PDF, then its very possible that the character encoding is not
+ * UTF-8. This methods tries to identify the character encoding and translate the title to UTF-8.
+ *
+ * @param $title
+ *
+ * @return string (maybe contains invalid UTF-8 character)
+ */
+ private function convertPdfEncodingToUTF8($title)
+ {
+ // first try UTF-8 because its easier to detect its present/absence
+ foreach (['UTF-8', 'UTF-16BE', 'WINDOWS-1252'] as $encoding) {
+ if (mb_check_encoding($title, $encoding)) {
+ return mb_convert_encoding($title, 'UTF-8', $encoding);
+ }
+ }
+
+ return $title;
+ }
+
+ /**
+ * Remove invalid UTF-8 characters from the given string.
+ *
+ * @param string $rawText
+ *
+ * @return string
+ */
+ private function sanitizeUTF8Text($rawText)
+ {
+ if (mb_check_encoding($rawText, 'UTF-8')) {
+ return $rawText;
+ }
+
+ return iconv('UTF-8', 'UTF-8//IGNORE', $rawText);
+ }
+
/**
* Stock entry with fetched or imported content.
* Will fall back to OpenGraph data if available.
*/
private function stockEntry(Entry $entry, array $content)
{
- $title = $content['title'];
- if (!$title && !empty($content['open_graph']['og_title'])) {
- $title = $content['open_graph']['og_title'];
+ $this->updateOriginUrl($entry, $content['url']);
+
+ $this->setEntryDomainName($entry);
+
+ if (!empty($content['title'])) {
+ $entry->setTitle($content['title']);
+ } elseif (!empty($content['open_graph']['og_title'])) {
+ $entry->setTitle($content['open_graph']['og_title']);
}
$html = $content['html'];
}
}
- $entry->setUrl($content['url']);
- $entry->setTitle($title);
$entry->setContent($html);
- $entry->setHttpStatus(isset($content['status']) ? $content['status'] : '');
-
- if (!empty($content['date'])) {
- $date = $content['date'];
-
- // is it a timestamp?
- if (filter_var($date, FILTER_VALIDATE_INT) !== false) {
- $date = '@' . $content['date'];
- }
+ $entry->setReadingTime(Utils::getReadingTime($html));
- try {
- $entry->setPublishedAt(new \DateTime($date));
- } catch (\Exception $e) {
- $this->logger->warning('Error while defining date', ['e' => $e, 'url' => $content['url'], 'date' => $content['date']]);
- }
+ if (!empty($content['status'])) {
+ $entry->setHttpStatus($content['status']);
}
- if (!empty($content['authors']) && is_array($content['authors'])) {
+ if (!empty($content['authors']) && \is_array($content['authors'])) {
$entry->setPublishedBy($content['authors']);
}
- if (!empty($content['all_headers'])) {
+ if (!empty($content['all_headers']) && $this->storeArticleHeaders) {
$entry->setHeaders($content['all_headers']);
}
- $this->validateAndSetLanguage(
- $entry,
- isset($content['language']) ? $content['language'] : null
- );
+ if (!empty($content['date'])) {
+ $this->updatePublishedAt($entry, $content['date']);
+ }
- $this->validateAndSetPreviewPicture(
- $entry,
- isset($content['open_graph']['og_image']) ? $content['open_graph']['og_image'] : null
- );
+ if (!empty($content['language'])) {
+ $this->updateLanguage($entry, $content['language']);
+ }
- // if content is an image, define it as a preview too
- if (!empty($content['content_type']) && in_array($this->mimeGuesser->guess($content['content_type']), ['jpeg', 'jpg', 'gif', 'png'], true)) {
- $this->validateAndSetPreviewPicture(
- $entry,
- $content['url']
- );
+ if (!empty($content['open_graph']['og_image'])) {
+ $this->updatePreviewPicture($entry, $content['open_graph']['og_image']);
}
- $entry->setMimetype(isset($content['content_type']) ? $content['content_type'] : '');
- $entry->setReadingTime(Utils::getReadingTime($html));
+ // if content is an image, define it as a preview too
+ if (!empty($content['content_type']) && \in_array($this->mimeGuesser->guess($content['content_type']), ['jpeg', 'jpg', 'gif', 'png'], true)) {
+ $this->updatePreviewPicture($entry, $content['url']);
+ }
- $domainName = parse_url($entry->getUrl(), PHP_URL_HOST);
- if (false !== $domainName) {
- $entry->setDomainName($domainName);
+ if (!empty($content['content_type'])) {
+ $entry->setMimetype($content['content_type']);
}
try {
}
/**
- * Validate that the given content has at least a title, an html and a url.
- *
- * @param array $content
+ * Update the origin_url field when a redirection occurs
+ * This field is set if it is empty and new url does not match ignore list.
*
- * @return bool true if valid otherwise false
+ * @param Entry $entry
+ * @param string $url
*/
- private function validateContent(array $content)
+ private function updateOriginUrl(Entry $entry, $url)
{
- return !empty($content['title']) && !empty($content['html']) && !empty($content['url']);
+ if (empty($url) || $entry->getUrl() === $url) {
+ return false;
+ }
+
+ $parsed_entry_url = parse_url($entry->getUrl());
+ $parsed_content_url = parse_url($url);
+
+ /**
+ * The following part computes the list of part changes between two
+ * parse_url arrays.
+ *
+ * As array_diff_assoc only computes changes to go from the left array
+ * to the right one, we make two differents arrays to have both
+ * directions. We merge these two arrays and sort keys before passing
+ * the result to the switch.
+ *
+ * The resulting array gives us all changing parts between the two
+ * urls: scheme, host, path, query and/or fragment.
+ */
+ $diff_ec = array_diff_assoc($parsed_entry_url, $parsed_content_url);
+ $diff_ce = array_diff_assoc($parsed_content_url, $parsed_entry_url);
+
+ $diff = array_merge($diff_ec, $diff_ce);
+ $diff_keys = array_keys($diff);
+ sort($diff_keys);
+
+ if ($this->ignoreUrl($entry->getUrl())) {
+ $entry->setUrl($url);
+
+ return false;
+ }
+
+ /**
+ * This switch case lets us apply different behaviors according to
+ * changing parts of urls.
+ *
+ * As $diff_keys is an array, we provide arrays as cases. ['path'] means
+ * 'only the path is different between the two urls' whereas
+ * ['fragment', 'query'] means 'only fragment and query string parts are
+ * different between the two urls'.
+ *
+ * Note that values in $diff_keys are sorted.
+ */
+ switch ($diff_keys) {
+ case ['path']:
+ if (($parsed_entry_url['path'] . '/' === $parsed_content_url['path']) // diff is trailing slash, we only replace the url of the entry
+ || ($url === urldecode($entry->getUrl()))) { // we update entry url if new url is a decoded version of it, see EntryRepository#findByUrlAndUserId
+ $entry->setUrl($url);
+ }
+ break;
+ case ['scheme']:
+ $entry->setUrl($url);
+ break;
+ case ['fragment']:
+ // noop
+ break;
+ default:
+ if (empty($entry->getOriginUrl())) {
+ $entry->setOriginUrl($entry->getUrl());
+ }
+ $entry->setUrl($url);
+ break;
+ }
}
/**
- * Use a Symfony validator to ensure the language is well formatted.
+ * Check entry url against an ignore list to replace with content url.
*
- * @param Entry $entry
- * @param string $value Language to validate
+ * XXX: move the ignore list in the database to let users handle it
+ *
+ * @param string $url url to test
+ *
+ * @return bool true if url matches ignore list otherwise false
*/
- private function validateAndSetLanguage($entry, $value)
+ private function ignoreUrl($url)
{
- // some lang are defined as fr-FR, es-ES.
- // replacing - by _ might increase language support
- $value = str_replace('-', '_', $value);
+ $ignored_hosts = ['feedproxy.google.com', 'feeds.reuters.com'];
+ $ignored_patterns = ['https?://www\.lemonde\.fr/tiny.*'];
- $errors = $this->validator->validate(
- $value,
- (new LocaleConstraint())
- );
+ $parsed_url = parse_url($url);
- if (0 === count($errors)) {
- $entry->setLanguage($value);
+ $filtered = array_filter($ignored_hosts, function ($var) use ($parsed_url) {
+ return $var === $parsed_url['host'];
+ });
- return;
+ if ([] !== $filtered) {
+ return true;
}
- $this->logger->warning('Language validation failed. ' . (string) $errors);
+ $filtered = array_filter($ignored_patterns, function ($var) use ($url) {
+ return preg_match("`$var`i", $url);
+ });
+
+ if ([] !== $filtered) {
+ return true;
+ }
+
+ return false;
}
/**
- * Use a Symfony validator to ensure the preview picture is a real url.
+ * Validate that the given content has at least a title, an html and a url.
*
- * @param Entry $entry
- * @param string $value URL to validate
+ * @param array $content
+ *
+ * @return bool true if valid otherwise false
*/
- private function validateAndSetPreviewPicture($entry, $value)
+ private function validateContent(array $content)
{
- $errors = $this->validator->validate(
- $value,
- (new UrlConstraint())
- );
-
- if (0 === count($errors)) {
- $entry->setPreviewPicture($value);
-
- return;
- }
-
- $this->logger->warning('PreviewPicture validation failed. ' . (string) $errors);
+ return !empty($content['title']) && !empty($content['html']) && !empty($content['url']);
}
}
projects / github / wallabag / wallabag.git / blobdiff