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