tweeper.php: factor out an html_to_xml() function from the tweep() method
[tweeper.git] / tweeper.php
1 <?php
2 /*
3  * tweeper - a Twitter to RSS web scraper
4  *
5  * Copyright (C) 2013-2015  Antonio Ospite <ao2@ao2.it>
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19  */
20
21 date_default_timezone_set('UTC');
22
23 class Tweeper {
24
25   private static $USER_AGENT = "Mozilla/5.0 (Windows NT 6.1; rv:22.0) Gecko/20130405 Firefox/22.0";
26
27   public function __construct($generate_enclosure = FALSE) {
28     $this->generate_enclosure = $generate_enclosure;
29   }
30
31   public static function epoch_to_gmdate($timestamp)
32   {
33     return gmdate('D, d M Y H:i:s', $timestamp) . ' GMT';
34   }
35
36   public static function str_to_gmdate($date)
37   {
38     $timestamp = strtotime($date);
39     return Tweeper::epoch_to_gmdate($timestamp);
40   }
41
42   private static function get_contents($url)
43   {
44     $ch = curl_init($url);
45     curl_setopt_array($ch, array(
46       CURLOPT_HEADER => FALSE,
47       CURLOPT_FOLLOWLOCATION => TRUE,  // follow http redirects to get the real URL
48       CURLOPT_RETURNTRANSFER => TRUE,
49       CURLOPT_SSL_VERIFYHOST => FALSE,
50       CURLOPT_SSL_VERIFYPEER => FALSE,
51       CURLOPT_HTTPHEADER => array('Accept-language: en'),
52       CURLOPT_USERAGENT => Tweeper::$USER_AGENT,
53     ));
54     $contents = curl_exec($ch);
55     curl_close($ch);
56
57     return $contents;
58   }
59
60   private static function get_info($url)
61   {
62     $ch = curl_init($url);
63     curl_setopt_array($ch, array(
64       CURLOPT_HEADER => TRUE,
65       CURLOPT_NOBODY => TRUE,
66       CURLOPT_FOLLOWLOCATION => TRUE,  // follow http redirects to get the real URL
67       CURLOPT_RETURNTRANSFER => TRUE,
68       CURLOPT_SSL_VERIFYHOST => FALSE,
69       CURLOPT_SSL_VERIFYPEER => FALSE,
70       CURLOPT_USERAGENT => Tweeper::$USER_AGENT,
71     ));
72     curl_exec($ch);
73     $url_info = curl_getinfo($ch);
74     curl_close($ch);
75
76     return $url_info;
77   }
78
79   public static function generate_enclosure($url)
80   {
81     $supported_content_types = array(
82       "application/ogg",
83       "audio/aac",
84       "audio/mp4",
85       "audio/mpeg",
86       "audio/ogg",
87       "audio/vorbis",
88       "audio/wav",
89       "audio/webm",
90       "audio/x-midi",
91       "image/gif",
92       "image/jpeg",
93       "video/avi",
94       "video/mp4",
95       "video/mpeg",
96       "video/ogg",
97     );
98
99     $url_info = Tweeper::get_info($url);
100
101     $supported = in_array($url_info['content_type'], $supported_content_types);
102     if (!$supported) {
103       error_log("Unsupported enclosure content type \"" . $url_info['content_type'] . "\" for URL: " . $url_info['url']);
104       return '';
105     }
106
107     $dom = new DomDocument();
108     $enc = $dom->createElement('enclosure');
109     $enc->setAttribute('url', $url_info['url']);
110     $enc->setAttribute('length', $url_info['download_content_length']);
111     $enc->setAttribute('type', $url_info['content_type']);
112
113     $dom->appendChild($enc);
114
115     return $dom->saveXML($enc);
116   }
117
118   /* Mimic the message from libxml.c::php_libxml_ctx_error_level() */
119   private function log_xml_error($error) {
120     $output = "";
121
122     switch ($error->level) {
123     case LIBXML_ERR_WARNING:
124       $output .= "Warning $error->code: ";
125       break;
126     case LIBXML_ERR_ERROR:
127       $output .= "Error $error->code: ";
128       break;
129     case LIBXML_ERR_FATAL:
130       $output .= "Fatal Error $error->code: ";
131       break;
132     }
133
134     $output .= trim($error->message);
135
136     if ($error->file) {
137       $output .= " in $error->file";
138     } else {
139       $output .= " in Entity,";
140     }
141
142     $output .=" line $error->line";
143
144     error_log($output);
145   }
146
147   private function load_stylesheet($host) {
148     $stylesheet = "file://" . __DIR__ . "/rss_converter_" . $host . ".xsl";
149     if (FALSE === file_exists($stylesheet)) {
150       trigger_error("Conversion to RSS not supported: $host", E_USER_ERROR);
151       return NULL;
152     }
153
154     $stylesheet_contents = $this->get_contents($stylesheet);
155
156     $xslDoc = new DOMDocument();
157     $xslDoc->loadXML($stylesheet_contents);
158
159     $xsltProcessor = new XSLTProcessor();
160     $xsltProcessor->registerPHPFunctions();
161     $xsltProcessor->setParameter('', 'generateEnclosure', $this->generate_enclosure);
162     $xsltProcessor->importStylesheet($xslDoc);
163
164     return $xsltProcessor;
165   }
166
167   private function html_to_xml($html) {
168     $xmlDoc = new DOMDocument();
169
170     // Handle warnings and errors when loading invalid HTML.
171     $xml_errors_value = libxml_use_internal_errors(true);
172     $xmlDoc->loadHTML($html);
173     foreach (libxml_get_errors() as $xml_error) {
174       $this->log_xml_error($xml_error);
175     }
176     libxml_clear_errors();
177     libxml_use_internal_errors($xml_errors_value);
178
179     return $xmlDoc;
180   }
181
182   public function tweep($src_url) {
183     $url = parse_url($src_url);
184     if (FALSE === $url || empty($url["host"])) {
185       trigger_error("Invalid url: $src_url", E_USER_ERROR);
186       return NULL;
187     }
188
189     $xsltProcessor = $this->load_stylesheet($url["host"]);
190     if (NULL === $xsltProcessor) {
191       return NULL;
192     }
193
194     $html = $this->get_contents($src_url);
195     if (FALSE === $html) {
196       return NULL;
197     }
198
199     $xmlDoc = $this->html_to_xml($html);
200     if (NULL === $xmlDoc) {
201       return NULL;
202     }
203
204     $output = $xsltProcessor->transformToXML($xmlDoc);
205
206     if (FALSE === $output) {
207       trigger_error('XSL transformation failed.', E_USER_ERROR);
208       return NULL;
209     }
210     return $output;
211   }
212 }
213
214 function usage($argv)
215 {
216   if (php_sapi_name() != 'cli')
217     $usage = htmlentities("{$_SERVER['SCRIPT_NAME']}?src_url=<src_url>&generate_enclosure=<0|1>");
218   else
219     $usage = "{$argv[0]} [-e|-h|--help] <src_url>\n";
220
221   return "usage: $usage";
222 }
223
224 function parse_options_cli($argv, $argc)
225 {
226   $options = array(
227     'generate_enclosure' => FALSE
228   );
229
230   if ($argc < 2)
231     return $options;
232
233   $cli_options = getopt("eh", array("help"));
234   foreach ($cli_options as $opt => $val) {
235     switch ($opt) {
236     case 'e':
237       $options['generate_enclosure'] = TRUE;
238       break;
239     case 'h':
240     case 'help':
241       echo usage($argv);
242       exit(0);
243     default:
244       fwrite(STDERR, usage($argv));
245       exit(1);
246     }
247   }
248
249   $options['src_url'] = $argv[count($cli_options) + 1];
250
251   return $options;
252 }
253
254 function parse_options_query_string()
255 {
256   $options = array(
257     'generate_enclosure' => FALSE
258   );
259
260   if (isset($_GET['src_url']))
261     $options['src_url'] = $_GET['src_url'];
262
263   if (isset($_GET['generate_enclosure']))
264     $options['generate_enclosure'] = $_GET['generate_enclosure'] == 1;
265
266   return $options;
267 }
268
269
270 if (php_sapi_name() != 'cli') {
271   $options = parse_options_query_string();
272   $ERROR_STREAM = fopen('php://output', 'w');
273 } else {
274   $options = parse_options_cli($argv, $argc);
275   $ERROR_STREAM = fopen('php://stderr', 'w');
276 }
277
278 if (!isset($options['src_url'])) {
279   fwrite($ERROR_STREAM, usage($argv));
280   exit(1);
281 }
282
283 $tweeper = new Tweeper($options['generate_enclosure']);
284 echo $tweeper->tweep($options['src_url']);