NEWS: add release notes for the v0.3 release
[tweeper.git] / tweeper.php
1 <?php
2 /*
3  * tweeper - a Twitter to RSS web scraper
4  * 
5  * Copyright (C) 2013-2014  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($stylesheet, $generate_enclosure = FALSE) {
28     $stylesheet_contents = $this->get_contents($stylesheet);
29
30     $xslDoc = new DOMDocument();
31     $xslDoc->loadXML($stylesheet_contents);
32
33     $this->xsltProcessor = new XSLTProcessor();
34     $this->xsltProcessor->registerPHPFunctions();
35     $this->xsltProcessor->setParameter('', 'generateEnclosure', $generate_enclosure);
36     $this->xsltProcessor->importStylesheet($xslDoc);
37   }
38
39   public static function epoch_to_gmdate($timestamp)
40   {
41     return gmdate('D, d M Y H:i:s', $timestamp) . ' GMT';
42   }
43
44   public static function str_to_gmdate($date)
45   {
46     $timestamp = strtotime($date);
47     return Tweeper::epoch_to_gmdate($timestamp);
48   }
49
50   private static function get_contents($url)
51   {
52     $ch = curl_init($url);
53     curl_setopt_array($ch, array(
54       CURLOPT_HEADER => FALSE,
55       CURLOPT_FOLLOWLOCATION => TRUE,  // follow http redirects to get the real URL
56       CURLOPT_RETURNTRANSFER => TRUE,
57       CURLOPT_SSL_VERIFYHOST => FALSE,
58       CURLOPT_SSL_VERIFYPEER => FALSE,
59       CURLOPT_HTTPHEADER => array('Accept-language: en'),
60       CURLOPT_USERAGENT => Tweeper::$USER_AGENT,
61     ));
62     $contents = curl_exec($ch);
63     curl_close($ch);
64
65     return $contents;
66   }
67
68   private static function get_info($url)
69   {
70     $ch = curl_init($url);
71     curl_setopt_array($ch, array(
72       CURLOPT_HEADER => TRUE,
73       CURLOPT_NOBODY => TRUE,
74       CURLOPT_FOLLOWLOCATION => TRUE,  // follow http redirects to get the real URL
75       CURLOPT_RETURNTRANSFER => TRUE,
76       CURLOPT_SSL_VERIFYHOST => FALSE,
77       CURLOPT_SSL_VERIFYPEER => FALSE,
78       CURLOPT_USERAGENT => Tweeper::$USER_AGENT,
79     ));
80     curl_exec($ch);
81     $url_info = curl_getinfo($ch);
82     curl_close($ch);
83
84     return $url_info;
85   }
86
87   public static function generate_enclosure($url)
88   {
89     $supported_content_types = array(
90       "application/ogg",
91       "audio/aac",
92       "audio/mp4",
93       "audio/mpeg",
94       "audio/ogg",
95       "audio/vorbis",
96       "audio/wav",
97       "audio/webm",
98       "audio/x-midi",
99       "image/gif",
100       "image/jpeg",
101       "video/avi",
102       "video/mp4",
103       "video/mpeg",
104       "video/ogg",
105     );
106
107     $url_info = Tweeper::get_info($url);
108
109     $supported = in_array($url_info['content_type'], $supported_content_types);
110     if (!$supported) {
111       error_log("Unsupported enclosure content type \"" . $url_info['content_type'] . "\" for URL: " . $url_info['url']);
112       return '';
113     }
114
115     $dom = new DomDocument();
116     $enc = $dom->createElement('enclosure');
117     $enc->setAttribute('url', $url_info['url']);
118     $enc->setAttribute('length', $url_info['download_content_length']);
119     $enc->setAttribute('type', $url_info['content_type']);
120
121     $dom->appendChild($enc);
122
123     return $dom->saveXML($enc);
124   }
125
126   /* Mimic the message from libxml.c::php_libxml_ctx_error_level() */
127   private function log_xml_error($error) {
128     $output = "";
129
130     switch ($error->level) {
131     case LIBXML_ERR_WARNING:
132       $output .= "Warning $error->code: ";
133       break;
134     case LIBXML_ERR_ERROR:
135       $output .= "Error $error->code: ";
136       break;
137     case LIBXML_ERR_FATAL:
138       $output .= "Fatal Error $error->code: ";
139       break;
140     }
141
142     $output .= trim($error->message);
143
144     if ($error->file) {
145       $output .= " in $error->file";
146     } else {
147       $output .= " in Entity,";
148     }
149
150     $output .=" line $error->line";
151
152     error_log($output);
153   }
154
155   public function tweep($uri) {
156     $html = Tweeper::get_contents($uri);
157
158     $xmlDoc = new DOMDocument();
159
160     // Handle warnings and errors when loading invalid HTML.
161     $xml_errors_value = libxml_use_internal_errors(true);
162     $xmlDoc->loadHTML($html);
163     foreach (libxml_get_errors() as $xml_error) {
164       $this->log_xml_error($xml_error);
165     }
166     libxml_clear_errors();
167     libxml_use_internal_errors($xml_errors_value);
168
169     $output = $this->xsltProcessor->transformToXML($xmlDoc);
170
171     if (FALSE === $output) {
172       trigger_error('XSL transformation failed.', E_USER_ERROR);
173       return NULL;
174     }
175     return $output;
176   }
177 }
178
179 function usage($argv)
180 {
181   if (php_sapi_name() != 'cli')
182     $usage = htmlentities("{$_SERVER['SCRIPT_NAME']}?src_url=<src_url>&generate_enclosure=<0|1>");
183   else
184     $usage = "{$argv[0]} [-e|-h|--help] <src_url>\n";
185
186   return "usage: $usage";
187 }
188
189 function parse_options_cli($argv, $argc)
190 {
191   $options = array(
192     'generate_enclosure' => FALSE
193   );
194
195   if ($argc < 2)
196     return $options;
197
198   $cli_options = getopt("eh", array("help"));
199   foreach ($cli_options as $opt => $val) {
200     switch ($opt) {
201     case 'e':
202       $options['generate_enclosure'] = TRUE;
203       break;
204     case 'h':
205     case 'help':
206       echo usage($argv);
207       exit(0);
208     default:
209       fwrite(STDERR, usage($argv));
210       exit(1);
211     }
212   }
213
214   $options['src_url'] = $argv[count($cli_options) + 1];
215
216   return $options;
217 }
218
219 function parse_options_query_string()
220 {
221   $options = array(
222     'generate_enclosure' => FALSE
223   );
224
225   if (isset($_GET['src_url']))
226     $options['src_url'] = $_GET['src_url'];
227
228   if (isset($_GET['generate_enclosure']))
229     $options['generate_enclosure'] = $_GET['generate_enclosure'] == 1;
230
231   return $options;
232 }
233
234
235 if (php_sapi_name() != 'cli') {
236   $options = parse_options_query_string();
237   $ERROR_STREAM = fopen('php://output', 'w');
238 } else {
239   $options = parse_options_cli($argv, $argc);
240   $ERROR_STREAM = fopen('php://stderr', 'w');
241 }
242
243 if (!isset($options['src_url'])) {
244   fwrite($ERROR_STREAM, usage($argv));
245   exit(1);
246 }
247
248 $url = parse_url($options['src_url']);
249 if (FALSE === $url || empty($url["host"])) {
250   fwrite($ERROR_STREAM, "Invalid url: ${options['src_url']}\n");
251   exit(1);
252 }
253
254 $stylesheet = "file://" . __DIR__ . "/rss_converter_" . $url["host"] . ".xsl";
255 if (FALSE === file_exists($stylesheet)) {
256   fwrite($ERROR_STREAM, "Conversion to RSS not supported: {$url["host"]}\n");
257   exit(1);
258 }
259
260 $tweeper = new Tweeper($stylesheet, $options['generate_enclosure']);
261 echo $tweeper->tweep($options['src_url']);