]>
Commit | Line | Data |
---|---|---|
1 | <?php | |
2 | ||
3 | namespace Wallabag\CoreBundle\Helper; | |
4 | ||
5 | use Graby\Graby; | |
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; | |
13 | ||
14 | /** | |
15 | * This kind of proxy class take care of getting the content from an url | |
16 | * and update the entry with what it found. | |
17 | */ | |
18 | class ContentProxy | |
19 | { | |
20 | protected $graby; | |
21 | protected $tagger; | |
22 | protected $validator; | |
23 | protected $logger; | |
24 | protected $mimeGuesser; | |
25 | protected $fetchingErrorMessage; | |
26 | protected $eventDispatcher; | |
27 | protected $storeArticleHeaders; | |
28 | ||
29 | public function __construct(Graby $graby, RuleBasedTagger $tagger, ValidatorInterface $validator, LoggerInterface $logger, $fetchingErrorMessage, $storeArticleHeaders = false) | |
30 | { | |
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; | |
38 | } | |
39 | ||
40 | /** | |
41 | * Update entry using either fetched or provided content. | |
42 | * | |
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 | |
47 | */ | |
48 | public function updateEntry(Entry $entry, $url, array $content = [], $disableContentUpdate = false) | |
49 | { | |
50 | if (!empty($content['html'])) { | |
51 | $content['html'] = $this->graby->cleanupHtml($content['html'], $url); | |
52 | } | |
53 | ||
54 | if ((empty($content) || false === $this->validateContent($content)) && false === $disableContentUpdate) { | |
55 | $fetchedContent = $this->graby->fetchContent($url); | |
56 | $fetchedContent['title'] = $this->sanitizeContentTitle($fetchedContent['title'], $fetchedContent['content_type']); | |
57 | ||
58 | // when content is imported, we have information in $content | |
59 | // in case fetching content goes bad, we'll keep the imported information instead of overriding them | |
60 | if (empty($content) || $fetchedContent['html'] !== $this->fetchingErrorMessage) { | |
61 | $content = $fetchedContent; | |
62 | } | |
63 | } | |
64 | ||
65 | // be sure to keep the url in case of error | |
66 | // so we'll be able to refetch it in the future | |
67 | $content['url'] = !empty($content['url']) ? $content['url'] : $url; | |
68 | ||
69 | // In one case (at least in tests), url is empty here | |
70 | // so we set it using $url provided in the updateEntry call. | |
71 | // Not sure what are the other possible cases where this property is empty | |
72 | if (empty($entry->getUrl()) && !empty($url)) { | |
73 | $entry->setUrl($url); | |
74 | } | |
75 | ||
76 | $this->stockEntry($entry, $content); | |
77 | } | |
78 | ||
79 | /** | |
80 | * Use a Symfony validator to ensure the language is well formatted. | |
81 | * | |
82 | * @param Entry $entry | |
83 | * @param string $value Language to validate and save | |
84 | */ | |
85 | public function updateLanguage(Entry $entry, $value) | |
86 | { | |
87 | // some lang are defined as fr-FR, es-ES. | |
88 | // replacing - by _ might increase language support | |
89 | $value = str_replace('-', '_', $value); | |
90 | ||
91 | $errors = $this->validator->validate( | |
92 | $value, | |
93 | (new LocaleConstraint()) | |
94 | ); | |
95 | ||
96 | if (0 === \count($errors)) { | |
97 | $entry->setLanguage($value); | |
98 | ||
99 | return; | |
100 | } | |
101 | ||
102 | $this->logger->warning('Language validation failed. ' . (string) $errors); | |
103 | } | |
104 | ||
105 | /** | |
106 | * Use a Symfony validator to ensure the preview picture is a real url. | |
107 | * | |
108 | * @param Entry $entry | |
109 | * @param string $value URL to validate and save | |
110 | */ | |
111 | public function updatePreviewPicture(Entry $entry, $value) | |
112 | { | |
113 | $errors = $this->validator->validate( | |
114 | $value, | |
115 | (new UrlConstraint()) | |
116 | ); | |
117 | ||
118 | if (0 === \count($errors)) { | |
119 | $entry->setPreviewPicture($value); | |
120 | ||
121 | return; | |
122 | } | |
123 | ||
124 | $this->logger->warning('PreviewPicture validation failed. ' . (string) $errors); | |
125 | } | |
126 | ||
127 | /** | |
128 | * Update date. | |
129 | * | |
130 | * @param Entry $entry | |
131 | * @param string $value Date to validate and save | |
132 | */ | |
133 | public function updatePublishedAt(Entry $entry, $value) | |
134 | { | |
135 | $date = $value; | |
136 | ||
137 | // is it a timestamp? | |
138 | if (false !== filter_var($date, FILTER_VALIDATE_INT)) { | |
139 | $date = '@' . $date; | |
140 | } | |
141 | ||
142 | try { | |
143 | // is it already a DateTime? | |
144 | // (it's inside the try/catch in case of fail to be parse time string) | |
145 | if (!$date instanceof \DateTime) { | |
146 | $date = new \DateTime($date); | |
147 | } | |
148 | ||
149 | $entry->setPublishedAt($date); | |
150 | } catch (\Exception $e) { | |
151 | $this->logger->warning('Error while defining date', ['e' => $e, 'url' => $entry->getUrl(), 'date' => $value]); | |
152 | } | |
153 | } | |
154 | ||
155 | /** | |
156 | * Helper to extract and save host from entry url. | |
157 | * | |
158 | * @param Entry $entry | |
159 | */ | |
160 | public function setEntryDomainName(Entry $entry) | |
161 | { | |
162 | $domainName = parse_url($entry->getUrl(), PHP_URL_HOST); | |
163 | if (false !== $domainName) { | |
164 | $entry->setDomainName($domainName); | |
165 | } | |
166 | } | |
167 | ||
168 | /** | |
169 | * Helper to set a default title using: | |
170 | * - url basename, if applicable | |
171 | * - hostname. | |
172 | * | |
173 | * @param Entry $entry | |
174 | */ | |
175 | public function setDefaultEntryTitle(Entry $entry) | |
176 | { | |
177 | $url = parse_url($entry->getUrl()); | |
178 | $path = pathinfo($url['path'], PATHINFO_BASENAME); | |
179 | ||
180 | if (empty($path)) { | |
181 | $path = $url['host']; | |
182 | } | |
183 | ||
184 | $entry->setTitle($path); | |
185 | } | |
186 | ||
187 | /** | |
188 | * Try to sanitize the title of the fetched content from wrong character encodings and invalid UTF-8 character. | |
189 | * | |
190 | * @param $title | |
191 | * @param $contentType | |
192 | * | |
193 | * @return string | |
194 | */ | |
195 | private function sanitizeContentTitle($title, $contentType) | |
196 | { | |
197 | if ('application/pdf' === $contentType) { | |
198 | $title = $this->convertPdfEncodingToUTF8($title); | |
199 | } | |
200 | ||
201 | return $this->sanitizeUTF8Text($title); | |
202 | } | |
203 | ||
204 | /** | |
205 | * If the title from the fetched content comes from a PDF, then its very possible that the character encoding is not | |
206 | * UTF-8. This methods tries to identify the character encoding and translate the title to UTF-8. | |
207 | * | |
208 | * @param $title | |
209 | * | |
210 | * @return string (maybe contains invalid UTF-8 character) | |
211 | */ | |
212 | private function convertPdfEncodingToUTF8($title) | |
213 | { | |
214 | // first try UTF-8 because its easier to detect its present/absence | |
215 | foreach (['UTF-8', 'UTF-16BE', 'WINDOWS-1252'] as $encoding) { | |
216 | if (mb_check_encoding($title, $encoding)) { | |
217 | return mb_convert_encoding($title, 'UTF-8', $encoding); | |
218 | } | |
219 | } | |
220 | ||
221 | return $title; | |
222 | } | |
223 | ||
224 | /** | |
225 | * Remove invalid UTF-8 characters from the given string. | |
226 | * | |
227 | * @param string $rawText | |
228 | * | |
229 | * @return string | |
230 | */ | |
231 | private function sanitizeUTF8Text($rawText) | |
232 | { | |
233 | if (mb_check_encoding($rawText, 'UTF-8')) { | |
234 | return $rawText; | |
235 | } | |
236 | ||
237 | return iconv('UTF-8', 'UTF-8//IGNORE', $rawText); | |
238 | } | |
239 | ||
240 | /** | |
241 | * Stock entry with fetched or imported content. | |
242 | * Will fall back to OpenGraph data if available. | |
243 | * | |
244 | * @param Entry $entry Entry to stock | |
245 | * @param array $content Array with at least title, url & html | |
246 | */ | |
247 | private function stockEntry(Entry $entry, array $content) | |
248 | { | |
249 | $this->updateOriginUrl($entry, $content['url']); | |
250 | ||
251 | $this->setEntryDomainName($entry); | |
252 | ||
253 | if (!empty($content['title'])) { | |
254 | $entry->setTitle($content['title']); | |
255 | } elseif (!empty($content['open_graph']['og_title'])) { | |
256 | $entry->setTitle($content['open_graph']['og_title']); | |
257 | } | |
258 | ||
259 | $html = $content['html']; | |
260 | if (false === $html) { | |
261 | $html = $this->fetchingErrorMessage; | |
262 | ||
263 | if (!empty($content['open_graph']['og_description'])) { | |
264 | $html .= '<p><i>But we found a short description: </i></p>'; | |
265 | $html .= $content['open_graph']['og_description']; | |
266 | } | |
267 | } | |
268 | ||
269 | $entry->setContent($html); | |
270 | $entry->setReadingTime(Utils::getReadingTime($html)); | |
271 | ||
272 | if (!empty($content['status'])) { | |
273 | $entry->setHttpStatus($content['status']); | |
274 | } | |
275 | ||
276 | if (!empty($content['authors']) && \is_array($content['authors'])) { | |
277 | $entry->setPublishedBy($content['authors']); | |
278 | } | |
279 | ||
280 | if (!empty($content['all_headers']) && $this->storeArticleHeaders) { | |
281 | $entry->setHeaders($content['all_headers']); | |
282 | } | |
283 | ||
284 | if (!empty($content['date'])) { | |
285 | $this->updatePublishedAt($entry, $content['date']); | |
286 | } | |
287 | ||
288 | if (!empty($content['language'])) { | |
289 | $this->updateLanguage($entry, $content['language']); | |
290 | } | |
291 | ||
292 | if (!empty($content['open_graph']['og_image'])) { | |
293 | $this->updatePreviewPicture($entry, $content['open_graph']['og_image']); | |
294 | } | |
295 | ||
296 | // if content is an image, define it as a preview too | |
297 | if (!empty($content['content_type']) && \in_array($this->mimeGuesser->guess($content['content_type']), ['jpeg', 'jpg', 'gif', 'png'], true)) { | |
298 | $this->updatePreviewPicture($entry, $content['url']); | |
299 | } | |
300 | ||
301 | if (!empty($content['content_type'])) { | |
302 | $entry->setMimetype($content['content_type']); | |
303 | } | |
304 | ||
305 | try { | |
306 | $this->tagger->tag($entry); | |
307 | } catch (\Exception $e) { | |
308 | $this->logger->error('Error while trying to automatically tag an entry.', [ | |
309 | 'entry_url' => $content['url'], | |
310 | 'error_msg' => $e->getMessage(), | |
311 | ]); | |
312 | } | |
313 | } | |
314 | ||
315 | /** | |
316 | * Update the origin_url field when a redirection occurs | |
317 | * This field is set if it is empty and new url does not match ignore list. | |
318 | * | |
319 | * @param Entry $entry | |
320 | * @param string $url | |
321 | */ | |
322 | private function updateOriginUrl(Entry $entry, $url) | |
323 | { | |
324 | if (empty($url) || $entry->getUrl() === $url) { | |
325 | return false; | |
326 | } | |
327 | ||
328 | $parsed_entry_url = parse_url($entry->getUrl()); | |
329 | $parsed_content_url = parse_url($url); | |
330 | ||
331 | /** | |
332 | * The following part computes the list of part changes between two | |
333 | * parse_url arrays. | |
334 | * | |
335 | * As array_diff_assoc only computes changes to go from the left array | |
336 | * to the right one, we make two differents arrays to have both | |
337 | * directions. We merge these two arrays and sort keys before passing | |
338 | * the result to the switch. | |
339 | * | |
340 | * The resulting array gives us all changing parts between the two | |
341 | * urls: scheme, host, path, query and/or fragment. | |
342 | */ | |
343 | $diff_ec = array_diff_assoc($parsed_entry_url, $parsed_content_url); | |
344 | $diff_ce = array_diff_assoc($parsed_content_url, $parsed_entry_url); | |
345 | ||
346 | $diff = array_merge($diff_ec, $diff_ce); | |
347 | $diff_keys = array_keys($diff); | |
348 | sort($diff_keys); | |
349 | ||
350 | if ($this->ignoreUrl($entry->getUrl())) { | |
351 | $entry->setUrl($url); | |
352 | ||
353 | return false; | |
354 | } | |
355 | ||
356 | /** | |
357 | * This switch case lets us apply different behaviors according to | |
358 | * changing parts of urls. | |
359 | * | |
360 | * As $diff_keys is an array, we provide arrays as cases. ['path'] means | |
361 | * 'only the path is different between the two urls' whereas | |
362 | * ['fragment', 'query'] means 'only fragment and query string parts are | |
363 | * different between the two urls'. | |
364 | * | |
365 | * Note that values in $diff_keys are sorted. | |
366 | */ | |
367 | switch ($diff_keys) { | |
368 | case ['path']: | |
369 | if (($parsed_entry_url['path'] . '/' === $parsed_content_url['path']) // diff is trailing slash, we only replace the url of the entry | |
370 | || ($url === urldecode($entry->getUrl()))) { // we update entry url if new url is a decoded version of it, see EntryRepository#findByUrlAndUserId | |
371 | $entry->setUrl($url); | |
372 | } | |
373 | break; | |
374 | case ['scheme']: | |
375 | $entry->setUrl($url); | |
376 | break; | |
377 | case ['fragment']: | |
378 | // noop | |
379 | break; | |
380 | default: | |
381 | if (empty($entry->getOriginUrl())) { | |
382 | $entry->setOriginUrl($entry->getUrl()); | |
383 | } | |
384 | $entry->setUrl($url); | |
385 | break; | |
386 | } | |
387 | } | |
388 | ||
389 | /** | |
390 | * Check entry url against an ignore list to replace with content url. | |
391 | * | |
392 | * XXX: move the ignore list in the database to let users handle it | |
393 | * | |
394 | * @param string $url url to test | |
395 | * | |
396 | * @return bool true if url matches ignore list otherwise false | |
397 | */ | |
398 | private function ignoreUrl($url) | |
399 | { | |
400 | $ignored_hosts = ['feedproxy.google.com', 'feeds.reuters.com']; | |
401 | $ignored_patterns = ['https?://www\.lemonde\.fr/tiny.*']; | |
402 | ||
403 | $parsed_url = parse_url($url); | |
404 | ||
405 | $filtered = array_filter($ignored_hosts, function ($var) use ($parsed_url) { | |
406 | return $var === $parsed_url['host']; | |
407 | }); | |
408 | ||
409 | if ([] !== $filtered) { | |
410 | return true; | |
411 | } | |
412 | ||
413 | $filtered = array_filter($ignored_patterns, function ($var) use ($url) { | |
414 | return preg_match("`$var`i", $url); | |
415 | }); | |
416 | ||
417 | if ([] !== $filtered) { | |
418 | return true; | |
419 | } | |
420 | ||
421 | return false; | |
422 | } | |
423 | ||
424 | /** | |
425 | * Validate that the given content has at least a title, an html and a url. | |
426 | * | |
427 | * @param array $content | |
428 | * | |
429 | * @return bool true if valid otherwise false | |
430 | */ | |
431 | private function validateContent(array $content) | |
432 | { | |
433 | return !empty($content['title']) && !empty($content['html']) && !empty($content['url']); | |
434 | } | |
435 | } |