Changelog, NEWS: prepare for the v0.2 release
[tweeper.git] / tweeper.php
1 <?php
2 /*
3  * tweeper - a Twitter to RSS web scraper
4  * 
5  * Copyright (C) 2013  Antonio Ospite <ospite@studenti.unina.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/vorbis",
95       "audio/wav",
96       "audio/webm",
97       "audio/x-midi",
98       "image/gif",
99       "image/jpeg",
100       "video/avi",
101       "video/mp4",
102       "video/mpeg",
103       "video/ogg",
104     );
105
106     $url_info = Tweeper::get_info($url);
107
108     $supported = in_array($url_info['content_type'], $supported_content_types);
109     if (!$supported) {
110       error_log("Unsupported enclosure content type \"" . $url_info['content_type'] . "\" for URL: " . $url_info['url']);
111       return '';
112     }
113
114     $dom = new DomDocument();
115     $enc = $dom->createElement('enclosure');
116     $enc->setAttribute('url', $url_info['url']);
117     $enc->setAttribute('length', $url_info['download_content_length']);
118     $enc->setAttribute('type', $url_info['content_type']);
119
120     $dom->appendChild($enc);
121
122     return $dom->saveXML($enc);
123   }
124
125   /* Mimic the message from libxml.c::php_libxml_ctx_error_level() */
126   private function log_xml_error($error) {
127     $output = "";
128
129     switch ($error->level) {
130     case LIBXML_ERR_WARNING:
131       $output .= "Warning $error->code: ";
132       break;
133     case LIBXML_ERR_ERROR:
134       $output .= "Error $error->code: ";
135       break;
136     case LIBXML_ERR_FATAL:
137       $output .= "Fatal Error $error->code: ";
138       break;
139     }
140
141     $output .= trim($error->message);
142
143     if ($error->file) {
144       $output .= " in $error->file";
145     } else {
146       $output .= " in Entity,";
147     }
148
149     $output .=" line $error->line";
150
151     error_log($output);
152   }
153
154   public function tweep($uri) {
155     $html = Tweeper::get_contents($uri);
156
157     $xmlDoc = new DOMDocument();
158
159     // Handle warnings and errors when loading invalid HTML.
160     $xml_errors_value = libxml_use_internal_errors(true);
161     $xmlDoc->loadHTML($html);
162     foreach (libxml_get_errors() as $xml_error) {
163       $this->log_xml_error($xml_error);
164     }
165     libxml_clear_errors();
166     libxml_use_internal_errors($xml_errors_value);
167
168     $output = $this->xsltProcessor->transformToXML($xmlDoc);
169
170     if (FALSE === $output) {
171       trigger_error('XSL transformation failed.', E_USER_ERROR);
172       return NULL;
173     }
174     return $output;
175   }
176 }
177
178 function usage($argv)
179 {
180   if (php_sapi_name() != 'cli')
181     $usage = htmlentities("{$_SERVER['SCRIPT_NAME']}?src_url=<src_url>&generate_enclosure=<0|1>");
182   else
183     $usage = "{$argv[0]} [-e|-h|--help] <src_url>\n";
184
185   return "usage: $usage";
186 }
187
188 function parse_options_cli($argv, $argc)
189 {
190   $options = array(
191     'generate_enclosure' => FALSE
192   );
193
194   if ($argc < 2)
195     return $options;
196
197   $cli_options = getopt("eh", array("help"));
198   foreach ($cli_options as $opt => $val) {
199     switch ($opt) {
200     case 'e':
201       $options['generate_enclosure'] = TRUE;
202       break;
203     case 'h':
204     case 'help':
205       echo usage($argv);
206       exit(0);
207     default:
208       fwrite(STDERR, usage($argv));
209       exit(1);
210     }
211   }
212
213   $options['src_url'] = $argv[count($cli_options) + 1];
214
215   return $options;
216 }
217
218 function parse_options_query_string()
219 {
220   $options = array(
221     'generate_enclosure' => FALSE
222   );
223
224   if (isset($_GET['src_url']))
225     $options['src_url'] = $_GET['src_url'];
226
227   if (isset($_GET['generate_enclosure']))
228     $options['generate_enclosure'] = $_GET['generate_enclosure'] == 1;
229
230   return $options;
231 }
232
233
234 if (php_sapi_name() != 'cli') {
235   $options = parse_options_query_string();
236   $ERROR_STREAM = fopen('php://output', 'w');
237 } else {
238   $options = parse_options_cli($argv, $argc);
239   $ERROR_STREAM = fopen('php://stderr', 'w');
240 }
241
242 if (!isset($options['src_url'])) {
243   fwrite($ERROR_STREAM, usage($argv));
244   exit(1);
245 }
246
247 $url = parse_url($options['src_url']);
248 if (FALSE === $url || empty($url["host"])) {
249   fwrite($ERROR_STREAM, "Invalid url: ${options['src_url']}\n");
250   exit(1);
251 }
252
253 $stylesheet = "file://" . __DIR__ . "/rss_converter_" . $url["host"] . ".xsl";
254 if (FALSE === file_exists($stylesheet)) {
255   fwrite($ERROR_STREAM, "Conversion to RSS not supported: {$url["host"]}\n");
256   exit(1);
257 }
258
259 $tweeper = new Tweeper($stylesheet, $options['generate_enclosure']);
260 echo $tweeper->tweep($options['src_url']);