]>
Commit | Line | Data |
---|---|---|
558d9aab JB |
1 | <?php |
2 | ||
3 | namespace Wallabag\CoreBundle\Helper; | |
4 | ||
5 | use Graby\Graby; | |
45fd7e09 | 6 | use Psr\Log\LoggerInterface; |
8d7b4f0e | 7 | use Symfony\Component\HttpFoundation\File\MimeType\MimeTypeExtensionGuesser; |
42f3bb2c | 8 | use Symfony\Component\Validator\Constraints\Locale as LocaleConstraint; |
0d349ea6 JB |
9 | use Symfony\Component\Validator\Constraints\Url as UrlConstraint; |
10 | use Symfony\Component\Validator\Validator\ValidatorInterface; | |
f808b016 JB |
11 | use Wallabag\CoreBundle\Entity\Entry; |
12 | use Wallabag\CoreBundle\Tools\Utils; | |
558d9aab JB |
13 | |
14 | /** | |
15 | * This kind of proxy class take care of getting the content from an url | |
f1e29e69 | 16 | * and update the entry with what it found. |
558d9aab JB |
17 | */ |
18 | class ContentProxy | |
19 | { | |
20 | protected $graby; | |
c3510620 | 21 | protected $tagger; |
be54dfe4 | 22 | protected $validator; |
1c9cd2a7 | 23 | protected $logger; |
8d7b4f0e | 24 | protected $mimeGuesser; |
29dca432 | 25 | protected $fetchingErrorMessage; |
6bc6fb1f | 26 | protected $eventDispatcher; |
8a219854 | 27 | protected $storeArticleHeaders; |
558d9aab | 28 | |
709e21a3 | 29 | public function __construct(Graby $graby, RuleBasedTagger $tagger, ValidatorInterface $validator, LoggerInterface $logger, $fetchingErrorMessage, $storeArticleHeaders = false) |
558d9aab | 30 | { |
347fa6be | 31 | $this->graby = $graby; |
c3510620 | 32 | $this->tagger = $tagger; |
0d349ea6 | 33 | $this->validator = $validator; |
1c9cd2a7 | 34 | $this->logger = $logger; |
8d7b4f0e | 35 | $this->mimeGuesser = new MimeTypeExtensionGuesser(); |
29dca432 | 36 | $this->fetchingErrorMessage = $fetchingErrorMessage; |
8a219854 | 37 | $this->storeArticleHeaders = $storeArticleHeaders; |
558d9aab JB |
38 | } |
39 | ||
40 | /** | |
6acadf8e | 41 | * Update entry using either fetched or provided content. |
4d0ec0e7 | 42 | * |
6acadf8e JB |
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 | |
558d9aab | 47 | */ |
6acadf8e | 48 | public function updateEntry(Entry $entry, $url, array $content = [], $disableContentUpdate = false) |
558d9aab | 49 | { |
6acadf8e JB |
50 | if (!empty($content['html'])) { |
51 | $content['html'] = $this->graby->cleanupHtml($content['html'], $url); | |
d5c2cc54 | 52 | } |
e668a812 | 53 | |
6acadf8e | 54 | if ((empty($content) || false === $this->validateContent($content)) && false === $disableContentUpdate) { |
ec970721 | 55 | $fetchedContent = $this->graby->fetchContent($url); |
f80f16df | 56 | $fetchedContent['title'] = $this->sanitizeContentTitle($fetchedContent['title'], $fetchedContent['content_type']); |
106bdbcd JB |
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 | |
6acadf8e | 60 | if (empty($content) || $fetchedContent['html'] !== $this->fetchingErrorMessage) { |
29dca432 JC |
61 | $content = $fetchedContent; |
62 | } | |
4d0ec0e7 | 63 | } |
558d9aab | 64 | |
6acadf8e JB |
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 | ||
4a81360e KD |
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 | { | |
74 | $entry->setUrl($url); | |
75 | } | |
76 | ||
d0e9b3d6 JC |
77 | $this->stockEntry($entry, $content); |
78 | } | |
79 | ||
c18a2476 JB |
80 | /** |
81 | * Use a Symfony validator to ensure the language is well formatted. | |
82 | * | |
83 | * @param Entry $entry | |
84 | * @param string $value Language to validate and save | |
85 | */ | |
86 | public function updateLanguage(Entry $entry, $value) | |
87 | { | |
88 | // some lang are defined as fr-FR, es-ES. | |
89 | // replacing - by _ might increase language support | |
90 | $value = str_replace('-', '_', $value); | |
91 | ||
92 | $errors = $this->validator->validate( | |
93 | $value, | |
94 | (new LocaleConstraint()) | |
95 | ); | |
96 | ||
2a1ceb67 | 97 | if (0 === \count($errors)) { |
c18a2476 JB |
98 | $entry->setLanguage($value); |
99 | ||
100 | return; | |
101 | } | |
102 | ||
103 | $this->logger->warning('Language validation failed. ' . (string) $errors); | |
104 | } | |
105 | ||
106 | /** | |
107 | * Use a Symfony validator to ensure the preview picture is a real url. | |
108 | * | |
109 | * @param Entry $entry | |
110 | * @param string $value URL to validate and save | |
111 | */ | |
112 | public function updatePreviewPicture(Entry $entry, $value) | |
113 | { | |
114 | $errors = $this->validator->validate( | |
115 | $value, | |
116 | (new UrlConstraint()) | |
117 | ); | |
118 | ||
2a1ceb67 | 119 | if (0 === \count($errors)) { |
c18a2476 JB |
120 | $entry->setPreviewPicture($value); |
121 | ||
122 | return; | |
123 | } | |
124 | ||
125 | $this->logger->warning('PreviewPicture validation failed. ' . (string) $errors); | |
126 | } | |
127 | ||
128 | /** | |
129 | * Update date. | |
130 | * | |
131 | * @param Entry $entry | |
132 | * @param string $value Date to validate and save | |
133 | */ | |
134 | public function updatePublishedAt(Entry $entry, $value) | |
135 | { | |
ff9f89fd | 136 | $date = $value; |
c18a2476 JB |
137 | |
138 | // is it a timestamp? | |
3ef055ce | 139 | if (false !== filter_var($date, FILTER_VALIDATE_INT)) { |
ff9f89fd | 140 | $date = '@' . $date; |
c18a2476 JB |
141 | } |
142 | ||
143 | try { | |
ff9f89fd JB |
144 | // is it already a DateTime? |
145 | // (it's inside the try/catch in case of fail to be parse time string) | |
146 | if (!$date instanceof \DateTime) { | |
147 | $date = new \DateTime($date); | |
148 | } | |
149 | ||
150 | $entry->setPublishedAt($date); | |
c18a2476 JB |
151 | } catch (\Exception $e) { |
152 | $this->logger->warning('Error while defining date', ['e' => $e, 'url' => $entry->getUrl(), 'date' => $value]); | |
153 | } | |
154 | } | |
155 | ||
af29e1bf KD |
156 | /** |
157 | * Helper to extract and save host from entry url. | |
158 | * | |
159 | * @param Entry $entry | |
160 | */ | |
161 | public function setEntryDomainName(Entry $entry) | |
162 | { | |
163 | $domainName = parse_url($entry->getUrl(), PHP_URL_HOST); | |
164 | if (false !== $domainName) { | |
165 | $entry->setDomainName($domainName); | |
166 | } | |
167 | } | |
168 | ||
169 | /** | |
170 | * Helper to set a default title using: | |
171 | * - url basename, if applicable | |
172 | * - hostname. | |
173 | * | |
174 | * @param Entry $entry | |
175 | */ | |
176 | public function setDefaultEntryTitle(Entry $entry) | |
177 | { | |
178 | $url = parse_url($entry->getUrl()); | |
179 | $path = pathinfo($url['path'], PATHINFO_BASENAME); | |
180 | ||
181 | if (empty($path)) { | |
182 | $path = $url['host']; | |
183 | } | |
184 | ||
185 | $entry->setTitle($path); | |
186 | } | |
187 | ||
83f1c327 T |
188 | /** |
189 | * Try to sanitize the title of the fetched content from wrong character encodings and invalid UTF-8 character. | |
190 | * | |
191 | * @param $title | |
192 | * @param $contentType | |
193 | * | |
194 | * @return string | |
195 | */ | |
196 | private function sanitizeContentTitle($title, $contentType) | |
197 | { | |
198 | if ('application/pdf' === $contentType) { | |
199 | $title = $this->convertPdfEncodingToUTF8($title); | |
200 | } | |
201 | ||
202 | return $this->sanitizeUTF8Text($title); | |
203 | } | |
204 | ||
205 | /** | |
206 | * If the title from the fetched content comes from a PDF, then its very possible that the character encoding is not | |
207 | * UTF-8. This methods tries to identify the character encoding and translate the title to UTF-8. | |
208 | * | |
209 | * @param $title | |
210 | * | |
211 | * @return string (maybe contains invalid UTF-8 character) | |
212 | */ | |
213 | private function convertPdfEncodingToUTF8($title) | |
214 | { | |
215 | // first try UTF-8 because its easier to detect its present/absence | |
216 | foreach (['UTF-8', 'UTF-16BE', 'WINDOWS-1252'] as $encoding) { | |
217 | if (mb_check_encoding($title, $encoding)) { | |
218 | return mb_convert_encoding($title, 'UTF-8', $encoding); | |
219 | } | |
220 | } | |
221 | ||
222 | return $title; | |
223 | } | |
224 | ||
225 | /** | |
226 | * Remove invalid UTF-8 characters from the given string. | |
227 | * | |
228 | * @param string $rawText | |
229 | * | |
230 | * @return string | |
231 | */ | |
232 | private function sanitizeUTF8Text($rawText) | |
233 | { | |
234 | if (mb_check_encoding($rawText, 'UTF-8')) { | |
235 | return $rawText; | |
236 | } | |
237 | ||
238 | return iconv('UTF-8', 'UTF-8//IGNORE', $rawText); | |
239 | } | |
240 | ||
d0e9b3d6 JC |
241 | /** |
242 | * Stock entry with fetched or imported content. | |
243 | * Will fall back to OpenGraph data if available. | |
244 | * | |
d5c2cc54 | 245 | * @param Entry $entry Entry to stock |
ec970721 | 246 | * @param array $content Array with at least title, url & html |
d0e9b3d6 JC |
247 | */ |
248 | private function stockEntry(Entry $entry, array $content) | |
249 | { | |
a05b6115 JB |
250 | $entry->setUrl($content['url']); |
251 | ||
af29e1bf | 252 | $this->setEntryDomainName($entry); |
a05b6115 JB |
253 | |
254 | if (!empty($content['title'])) { | |
255 | $entry->setTitle($content['title']); | |
256 | } elseif (!empty($content['open_graph']['og_title'])) { | |
257 | $entry->setTitle($content['open_graph']['og_title']); | |
558d9aab JB |
258 | } |
259 | ||
260 | $html = $content['html']; | |
261 | if (false === $html) { | |
36e6ef52 | 262 | $html = $this->fetchingErrorMessage; |
558d9aab | 263 | |
e668a812 | 264 | if (!empty($content['open_graph']['og_description'])) { |
558d9aab JB |
265 | $html .= '<p><i>But we found a short description: </i></p>'; |
266 | $html .= $content['open_graph']['og_description']; | |
267 | } | |
268 | } | |
269 | ||
48656e0e | 270 | $entry->setContent($html); |
a05b6115 | 271 | $entry->setReadingTime(Utils::getReadingTime($html)); |
f0378b4d | 272 | |
a05b6115 JB |
273 | if (!empty($content['status'])) { |
274 | $entry->setHttpStatus($content['status']); | |
5e9009ce NL |
275 | } |
276 | ||
2a1ceb67 | 277 | if (!empty($content['authors']) && \is_array($content['authors'])) { |
7b0b3622 NL |
278 | $entry->setPublishedBy($content['authors']); |
279 | } | |
280 | ||
8a219854 | 281 | if (!empty($content['all_headers']) && $this->storeArticleHeaders) { |
dda6a6ad NL |
282 | $entry->setHeaders($content['all_headers']); |
283 | } | |
284 | ||
a05b6115 JB |
285 | if (!empty($content['date'])) { |
286 | $this->updatePublishedAt($entry, $content['date']); | |
287 | } | |
0d349ea6 | 288 | |
a05b6115 JB |
289 | if (!empty($content['language'])) { |
290 | $this->updateLanguage($entry, $content['language']); | |
291 | } | |
292 | ||
293 | if (!empty($content['open_graph']['og_image'])) { | |
294 | $this->updatePreviewPicture($entry, $content['open_graph']['og_image']); | |
295 | } | |
0d349ea6 | 296 | |
be54dfe4 | 297 | // if content is an image, define it as a preview too |
2a1ceb67 | 298 | if (!empty($content['content_type']) && \in_array($this->mimeGuesser->guess($content['content_type']), ['jpeg', 'jpg', 'gif', 'png'], true)) { |
d0ec2ddd | 299 | $this->updatePreviewPicture($entry, $content['url']); |
0d349ea6 JB |
300 | } |
301 | ||
a05b6115 JB |
302 | if (!empty($content['content_type'])) { |
303 | $entry->setMimetype($content['content_type']); | |
4d0ec0e7 | 304 | } |
558d9aab | 305 | |
1c9cd2a7 KG |
306 | try { |
307 | $this->tagger->tag($entry); | |
308 | } catch (\Exception $e) { | |
4094ea47 | 309 | $this->logger->error('Error while trying to automatically tag an entry.', [ |
d0e9b3d6 | 310 | 'entry_url' => $content['url'], |
1c9cd2a7 | 311 | 'error_msg' => $e->getMessage(), |
4094ea47 | 312 | ]); |
1c9cd2a7 | 313 | } |
558d9aab | 314 | } |
c2656f96 | 315 | |
4d0ec0e7 | 316 | /** |
d0e9b3d6 | 317 | * Validate that the given content has at least a title, an html and a url. |
4d0ec0e7 JB |
318 | * |
319 | * @param array $content | |
6acadf8e JB |
320 | * |
321 | * @return bool true if valid otherwise false | |
4d0ec0e7 JB |
322 | */ |
323 | private function validateContent(array $content) | |
324 | { | |
6acadf8e | 325 | return !empty($content['title']) && !empty($content['html']) && !empty($content['url']); |
4d0ec0e7 | 326 | } |
558d9aab | 327 | } |