cfa38125b3a75f9ad0892724031930aa0b9f2cc2
[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     curl_exec($ch);
128     $url_info = curl_getinfo($ch);
129     if (FALSE === $url_info) {
130       trigger_error(curl_error($ch));
131     }
132     curl_close($ch);
133
134     return $url_info;
135   }
136
137   /**
138    * Generate an RSS <enclosure/> element.
139    */
140   public static function generateEnclosure($url) {
141     $supported_content_types = array(
142       "application/octet-stream",
143       "application/ogg",
144       "application/pdf",
145       "audio/aac",
146       "audio/mp4",
147       "audio/mpeg",
148       "audio/ogg",
149       "audio/vorbis",
150       "audio/wav",
151       "audio/webm",
152       "audio/x-midi",
153       "image/gif",
154       "image/jpeg",
155       "image/png",
156       "video/avi",
157       "video/mp4",
158       "video/mpeg",
159       "video/ogg",
160     );
161
162     $url_info = Tweeper::getUrlInfo($url);
163
164     $supported = in_array($url_info['content_type'], $supported_content_types);
165     if (!$supported) {
166       error_log("Unsupported enclosure content type \"" . $url_info['content_type'] . "\" for URL: " . $url_info['url']);
167       return '';
168     }
169
170     // The RSS specification says that the enclosure element URL must be http.
171     // See http://sourceforge.net/p/feedvalidator/bugs/72/
172     $http_url = preg_replace("/^https/", "http", $url_info['url']);
173
174     $dom = new DOMDocument();
175     $enc = $dom->createElement('enclosure');
176     $enc->setAttribute('url', $http_url);
177     $enc->setAttribute('length', $url_info['download_content_length']);
178     $enc->setAttribute('type', $url_info['content_type']);
179
180     return $enc;
181   }
182
183   /**
184    * Mimic the message from libxml.c::php_libxml_ctx_error_level()
185    */
186   private static function logXmlError($error) {
187     $output = "";
188
189     switch ($error->level) {
190       case LIBXML_ERR_WARNING:
191         $output .= "Warning $error->code: ";
192         break;
193
194       case LIBXML_ERR_ERROR:
195         $output .= "Error $error->code: ";
196         break;
197
198       case LIBXML_ERR_FATAL:
199         $output .= "Fatal Error $error->code: ";
200         break;
201     }
202
203     $output .= trim($error->message);
204
205     if ($error->file) {
206       $output .= " in $error->file";
207     }
208     else {
209       $output .= " in Entity,";
210     }
211
212     $output .= " line $error->line";
213
214     error_log($output);
215   }
216
217   /**
218    * Convert json to XML.
219    */
220   private static function jsonToXml($json, $root_node_name) {
221     // Apparently the ObjectNormalizer used afterwards is not able to handle
222     // the stdClass object created by json_decode() with the default setting
223     // $assoc = false; so use $assoc = true.
224     $data = json_decode($json, $assoc = TRUE);
225     if (!$data) {
226       return NULL;
227     }
228
229     $encoder = new XmlEncoder();
230     $normalizer = new ObjectNormalizer();
231     $serializer = new Serializer(array($normalizer), array($encoder));
232
233     $serializer_options = array(
234       'xml_encoding' => "UTF-8",
235       'xml_format_output' => TRUE,
236       'xml_root_node_name' => $root_node_name,
237     );
238
239     $xml_data = $serializer->serialize($data, 'xml', $serializer_options);
240     if (!$xml_data) {
241       trigger_error("Cannot serialize data", E_USER_ERROR);
242       return NULL;
243     }
244
245     return $xml_data;
246   }
247
248   /**
249    * Convert the Instagram content to XML.
250    */
251   private function getXmlInstagramCom($html) {
252     // Extract the json data from the html code.
253     $json_match_expr = '/window._sharedData = (.*);/';
254     $ret = preg_match($json_match_expr, $html, $matches);
255     if ($ret !== 1) {
256       trigger_error("Cannot match expression: $json_match_expr\n", E_USER_ERROR);
257       return NULL;
258     }
259
260     $data = json_decode($matches[1], $assoc = TRUE);
261
262     // The "qe" object contains elements which will result in invalid XML
263     // element names, so remove it.
264     unset($data["qe"]);
265
266     // The "knobs" object contains elements with undefined namespaces, so
267     // remove it to silence an error message.
268     unset($data["knobs"]);
269
270     $json = json_encode($data);
271
272     return Tweeper::jsonToXml($json, 'instagram');
273   }
274
275   /**
276    * Make the Facebook HTML processable.
277    */
278   private function preprocessHtmlFacebookCom($html) {
279     $html = str_replace('<!--', '', $html);
280     $html = str_replace('-->', '', $html);
281     return $html;
282   }
283
284   /**
285    * Convert the HTML retrieved from the site to XML.
286    */
287   private function htmlToXml($html, $host) {
288     $xmlDoc = new DOMDocument();
289
290     // Handle warnings and errors when loading invalid HTML.
291     $xml_errors_value = libxml_use_internal_errors(TRUE);
292
293     // If there is a host-specific method to get the XML data, use it!
294     $get_xml_host_method = 'getXml' . Tweeper::toUpperCamelCase($host, '.');
295     if (method_exists($this, $get_xml_host_method)) {
296       $xml_data = call_user_func_array(array($this, $get_xml_host_method), array($html));
297       $xmlDoc->loadXML($xml_data);
298     }
299     else {
300       $xmlDoc->loadHTML($html);
301     }
302
303     foreach (libxml_get_errors() as $xml_error) {
304       Tweeper::logXmlError($xml_error);
305     }
306     libxml_clear_errors();
307     libxml_use_internal_errors($xml_errors_value);
308
309     return $xmlDoc;
310   }
311
312   /**
313    * Load a stylesheet if the web site is supported.
314    */
315   private function loadStylesheet($host) {
316     $stylesheet = "file://" . __DIR__ . "/rss_converter_" . $host . ".xsl";
317     if (FALSE === file_exists($stylesheet)) {
318       trigger_error("Conversion to RSS not supported for $host ($stylesheet not found)", E_USER_ERROR);
319       return NULL;
320     }
321
322     $stylesheet_contents = Tweeper::getUrlContents($stylesheet);
323
324     $xslDoc = new DOMDocument();
325     $xslDoc->loadXML($stylesheet_contents);
326
327     $xsltProcessor = new XSLTProcessor();
328     $xsltProcessor->registerPHPFunctions();
329     $xsltProcessor->setParameter('', 'generate-enclosure', $this->generate_enclosure);
330     $xsltProcessor->setParameter('', 'show-usernames', $this->show_usernames);
331     $xsltProcessor->importStylesheet($xslDoc);
332
333     return $xsltProcessor;
334   }
335
336   /**
337    * Convert the site content to RSS.
338    */
339   public function tweep($src_url, $host=NULL, $validate_scheme=TRUE) {
340     $url = parse_url($src_url);
341     if (FALSE === $url) {
342       trigger_error("Invalid URL: $src_url", E_USER_ERROR);
343       return NULL;
344     }
345
346     if (TRUE === $validate_scheme) {
347       $scheme = $url["scheme"];
348       if (!in_array($scheme, array("http", "https"))) {
349         trigger_error("unsupported scheme: $scheme", E_USER_ERROR);
350         return NULL;
351       }
352     }
353
354     // if the host is not given derive it from the URL
355     if (NULL === $host) {
356       if (empty($url["host"])) {
357         trigger_error("Invalid host in URL: $src_url", E_USER_ERROR);
358         return NULL;
359       }
360       // Strip the leading www. to be more forgiving on input URLs.
361       $host = preg_replace('/^www\./', '', $url["host"]);
362     }
363
364     $xsltProcessor = $this->loadStylesheet($host);
365     if (NULL === $xsltProcessor) {
366       return NULL;
367     }
368
369     $html = Tweeper::getUrlContents($src_url);
370     if (FALSE === $html) {
371       return NULL;
372     }
373
374     $preprocess_html_host_method = 'preprocessHtml' . Tweeper::toUpperCamelCase($host, '.');
375     if (method_exists($this, $preprocess_html_host_method)) {
376       $html = call_user_func_array(array($this, $preprocess_html_host_method), array($html));
377     }
378
379     $xmlDoc = $this->htmlToXml($html, $host);
380     if (NULL === $xmlDoc) {
381       return NULL;
382     }
383
384     $output = $xsltProcessor->transformToXML($xmlDoc);
385     if (FALSE === $output) {
386       trigger_error('XSL transformation failed.', E_USER_ERROR);
387       return NULL;
388     }
389
390     return $output;
391   }
392
393 }