src/Tweeper.php: make code more robust by properly check return values
[tweeper.git] / src / Tweeper.php
1 <?php
2
3 namespace Tweeper;
4
5 /**
6  * @file
7  * Tweeper - a Twitter to RSS web scraper.
8  *
9  * Copyright (C) 2013-2018  Antonio Ospite <ao2@ao2.it>
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  */
24
25 use DOMDocument;
26 use XSLTProcessor;
27
28 use Symfony\Component\Serializer\Serializer;
29 use Symfony\Component\Serializer\Encoder\XmlEncoder;
30 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
31
32 date_default_timezone_set('UTC');
33
34 /**
35  * Scrape supported websites and perform conversion to RSS.
36  */
37 class Tweeper {
38
39   private static $userAgent = "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:60.0) Gecko/20100101 Firefox/60.0";
40
41   /**
42    * Create a new Tweeper object controlling optional settings.
43    *
44    * @param bool $generate_enclosure
45    *   Enables the creation of <enclosure/> elements (disabled by default).
46    * @param bool $show_usernames
47    *   Enables showing the username in front of the content for multi-user
48    *   sites (enabled by default). Only some stylesheets supports this
49    *   functionality (twitter, instagram, pump.io).
50    */
51   public function __construct($generate_enclosure = FALSE, $show_usernames = TRUE) {
52     $this->generate_enclosure = $generate_enclosure;
53     $this->show_usernames = $show_usernames;
54   }
55
56   /**
57    * Convert numeric Epoch to the date format expected in a RSS document.
58    */
59   public static function epochToRssDate($timestamp) {
60     if (!is_numeric($timestamp) || is_nan($timestamp)) {
61       $timestamp = 0;
62     }
63
64     return gmdate(DATE_RSS, $timestamp);
65   }
66
67   /**
68    * Convert generic date string to the date format expected in a RSS document.
69    */
70   public static function strToRssDate($date) {
71     $timestamp = strtotime($date);
72     if (FALSE === $timestamp) {
73       $timestamp = 0;
74     }
75
76     return Tweeper::epochToRssDate($timestamp);
77   }
78
79   /**
80    * Convert string to UpperCamelCase.
81    */
82   public static function toUpperCamelCase($str, $delim = ' ') {
83     $str_upper = ucwords($str, $delim);
84     $str_camel_case = str_replace($delim, '', $str_upper);
85     return $str_camel_case;
86   }
87
88   /**
89    * Get the contents from a URL.
90    */
91   private static function getUrlContents($url) {
92     $ch = curl_init($url);
93     curl_setopt_array($ch, array(
94       CURLOPT_HEADER => FALSE,
95       // Follow http redirects to get the real URL.
96       CURLOPT_FOLLOWLOCATION => TRUE,
97       CURLOPT_RETURNTRANSFER => TRUE,
98       CURLOPT_SSL_VERIFYHOST => FALSE,
99       CURLOPT_SSL_VERIFYPEER => FALSE,
100       CURLOPT_HTTPHEADER => array('Accept-language: en'),
101       CURLOPT_USERAGENT => Tweeper::$userAgent,
102     ));
103     $contents = curl_exec($ch);
104     if (FALSE === $contents) {
105       trigger_error(curl_error($ch));
106     }
107     curl_close($ch);
108
109     return $contents;
110   }
111
112   /**
113    * Get the headers from a URL.
114    */
115   private static function getUrlInfo($url) {
116     $ch = curl_init($url);
117     curl_setopt_array($ch, array(
118       CURLOPT_HEADER => TRUE,
119       CURLOPT_NOBODY => TRUE,
120       // Follow http redirects to get the real URL.
121       CURLOPT_FOLLOWLOCATION => TRUE,
122       CURLOPT_RETURNTRANSFER => TRUE,
123       CURLOPT_SSL_VERIFYHOST => FALSE,
124       CURLOPT_SSL_VERIFYPEER => FALSE,
125       CURLOPT_USERAGENT => Tweeper::$userAgent,
126     ));
127
128     $ret = curl_exec($ch);
129     if (FALSE === $ret) {
130       trigger_error(curl_error($ch));
131       curl_close($ch);
132       return FALSE;
133     }
134
135     $url_info = curl_getinfo($ch);
136     if (FALSE === $url_info) {
137       trigger_error(curl_error($ch));
138     }
139     curl_close($ch);
140
141     return $url_info;
142   }
143
144   /**
145    * Generate an RSS <enclosure/> element.
146    */
147   public static function generateEnclosure($url) {
148     $supported_content_types = array(
149       "application/octet-stream",
150       "application/ogg",
151       "application/pdf",
152       "audio/aac",
153       "audio/mp4",
154       "audio/mpeg",
155       "audio/ogg",
156       "audio/vorbis",
157       "audio/wav",
158       "audio/webm",
159       "audio/x-midi",
160       "image/gif",
161       "image/jpeg",
162       "image/png",
163       "video/avi",
164       "video/mp4",
165       "video/mpeg",
166       "video/ogg",
167     );
168
169     $url_info = Tweeper::getUrlInfo($url);
170     if (FALSE === $url_info) {
171       error_log("Failed to retrieve info for URL: " . $url);
172       return '';
173     }
174
175     $supported = in_array($url_info['content_type'], $supported_content_types);
176     if (!$supported) {
177       error_log("Unsupported enclosure content type \"" . $url_info['content_type'] . "\" for URL: " . $url_info['url']);
178       return '';
179     }
180
181     // The RSS specification says that the enclosure element URL must be http.
182     // See http://sourceforge.net/p/feedvalidator/bugs/72/
183     $http_url = preg_replace("/^https/", "http", $url_info['url']);
184
185     $dom = new DOMDocument();
186     $enc = $dom->createElement('enclosure');
187     $enc->setAttribute('url', $http_url);
188     $enc->setAttribute('length', $url_info['download_content_length']);
189     $enc->setAttribute('type', $url_info['content_type']);
190
191     return $enc;
192   }
193
194   /**
195    * Mimic the message from libxml.c::php_libxml_ctx_error_level()
196    */
197   private static function logXmlError($error) {
198     $output = "";
199
200     switch ($error->level) {
201       case LIBXML_ERR_WARNING:
202         $output .= "Warning $error->code: ";
203         break;
204
205       case LIBXML_ERR_ERROR:
206         $output .= "Error $error->code: ";
207         break;
208
209       case LIBXML_ERR_FATAL:
210         $output .= "Fatal Error $error->code: ";
211         break;
212     }
213
214     $output .= trim($error->message);
215
216     if ($error->file) {
217       $output .= " in $error->file";
218     }
219     else {
220       $output .= " in Entity,";
221     }
222
223     $output .= " line $error->line";
224
225     error_log($output);
226   }
227
228   /**
229    * Convert json to XML.
230    */
231   private static function jsonToXml($json, $root_node_name) {
232     // Apparently the ObjectNormalizer used afterwards is not able to handle
233     // the stdClass object created by json_decode() with the default setting
234     // $assoc = false; so use $assoc = true.
235     $data = json_decode($json, $assoc = TRUE);
236     if (!$data) {
237       return NULL;
238     }
239
240     $encoder = new XmlEncoder();
241     $normalizer = new ObjectNormalizer();
242     $serializer = new Serializer(array($normalizer), array($encoder));
243
244     $serializer_options = array(
245       'xml_encoding' => "UTF-8",
246       'xml_format_output' => TRUE,
247       'xml_root_node_name' => $root_node_name,
248     );
249
250     $xml_data = $serializer->serialize($data, 'xml', $serializer_options);
251     if (!$xml_data) {
252       trigger_error("Cannot serialize data", E_USER_ERROR);
253       return NULL;
254     }
255
256     return $xml_data;
257   }
258
259   /**
260    * Convert the Instagram content to XML.
261    */
262   private function getXmlInstagramCom($html) {
263     // Extract the json data from the html code.
264     $json_match_expr = '/window._sharedData = (.*);/';
265     $ret = preg_match($json_match_expr, $html, $matches);
266     if ($ret !== 1) {
267       trigger_error("Cannot match expression: $json_match_expr\n", E_USER_ERROR);
268       return NULL;
269     }
270
271     $data = json_decode($matches[1], $assoc = TRUE);
272
273     // The "qe" object contains elements which will result in invalid XML
274     // element names, so remove it.
275     unset($data["qe"]);
276
277     // The "knobs" object contains elements with undefined namespaces, so
278     // remove it to silence an error message.
279     unset($data["knobs"]);
280
281     $json = json_encode($data);
282
283     return Tweeper::jsonToXml($json, 'instagram');
284   }
285
286   /**
287    * Make the Facebook HTML processable.
288    */
289   private function preprocessHtmlFacebookCom($html) {
290     $html = str_replace('<!--', '', $html);
291     $html = str_replace('-->', '', $html);
292     return $html;
293   }
294
295   /**
296    * Convert the HTML retrieved from the site to XML.
297    */
298   private function htmlToXml($html, $host) {
299     $xmlDoc = new DOMDocument();
300
301     // Handle warnings and errors when loading invalid HTML.
302     $xml_errors_value = libxml_use_internal_errors(TRUE);
303
304     // If there is a host-specific method to get the XML data, use it!
305     $get_xml_host_method = 'getXml' . Tweeper::toUpperCamelCase($host, '.');
306     if (method_exists($this, $get_xml_host_method)) {
307       $xml_data = call_user_func_array(array($this, $get_xml_host_method), array($html));
308       $xmlDoc->loadXML($xml_data);
309     }
310     else {
311       $xmlDoc->loadHTML($html);
312     }
313
314     foreach (libxml_get_errors() as $xml_error) {
315       Tweeper::logXmlError($xml_error);
316     }
317     libxml_clear_errors();
318     libxml_use_internal_errors($xml_errors_value);
319
320     return $xmlDoc;
321   }
322
323   /**
324    * Load a stylesheet if the web site is supported.
325    */
326   private function loadStylesheet($host) {
327     $stylesheet = "file://" . __DIR__ . "/rss_converter_" . $host . ".xsl";
328     if (FALSE === file_exists($stylesheet)) {
329       trigger_error("Conversion to RSS not supported for $host ($stylesheet not found)", E_USER_ERROR);
330       return NULL;
331     }
332
333     $stylesheet_contents = Tweeper::getUrlContents($stylesheet);
334     if (FALSE === $stylesheet_contents) {
335       return NULL;
336     }
337
338     $xslDoc = new DOMDocument();
339     $xslDoc->loadXML($stylesheet_contents);
340
341     $xsltProcessor = new XSLTProcessor();
342     $xsltProcessor->registerPHPFunctions();
343     $xsltProcessor->setParameter('', 'generate-enclosure', $this->generate_enclosure);
344     $xsltProcessor->setParameter('', 'show-usernames', $this->show_usernames);
345     $xsltProcessor->importStylesheet($xslDoc);
346
347     return $xsltProcessor;
348   }
349
350   /**
351    * Convert the site content to RSS.
352    */
353   public function tweep($src_url, $host=NULL, $validate_scheme=TRUE) {
354     $url = parse_url($src_url);
355     if (FALSE === $url) {
356       trigger_error("Invalid URL: $src_url", E_USER_ERROR);
357       return NULL;
358     }
359
360     if (TRUE === $validate_scheme) {
361       $scheme = $url["scheme"];
362       if (!in_array($scheme, array("http", "https"))) {
363         trigger_error("unsupported scheme: $scheme", E_USER_ERROR);
364         return NULL;
365       }
366     }
367
368     // if the host is not given derive it from the URL
369     if (NULL === $host) {
370       if (empty($url["host"])) {
371         trigger_error("Invalid host in URL: $src_url", E_USER_ERROR);
372         return NULL;
373       }
374       // Strip the leading www. to be more forgiving on input URLs.
375       $host = preg_replace('/^www\./', '', $url["host"]);
376     }
377
378     $xsltProcessor = $this->loadStylesheet($host);
379     if (NULL === $xsltProcessor) {
380       return NULL;
381     }
382
383     $html = Tweeper::getUrlContents($src_url);
384     if (FALSE === $html) {
385       return NULL;
386     }
387
388     $preprocess_html_host_method = 'preprocessHtml' . Tweeper::toUpperCamelCase($host, '.');
389     if (method_exists($this, $preprocess_html_host_method)) {
390       $html = call_user_func_array(array($this, $preprocess_html_host_method), array($html));
391     }
392
393     $xmlDoc = $this->htmlToXml($html, $host);
394     if (NULL === $xmlDoc) {
395       return NULL;
396     }
397
398     $output = $xsltProcessor->transformToXML($xmlDoc);
399     if (FALSE === $output) {
400       trigger_error('XSL transformation failed.', E_USER_ERROR);
401       return NULL;
402     }
403
404     return $output;
405   }
406
407 }