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 require_once 'Symfony/Component/Serializer/autoload.php';
  22
  23 use Symfony\Component\Serializer\Serializer;
  24 use Symfony\Component\Serializer\Encoder\XmlEncoder;
  25 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
  26
  27 date_default_timezone_set('UTC');
  28
  29 class Tweeper {
  30
  31   private static $USER_AGENT = "Mozilla/5.0 (Windows NT 6.1; rv:22.0) Gecko/20130405 Firefox/22.0";
  32
  33   public function __construct($generate_enclosure = FALSE) {
  34     $this->generate_enclosure = $generate_enclosure;
  35   }
  36
  37   public static function epoch_to_gmdate($timestamp) {
  38     if (!is_numeric($timestamp) || is_nan($timestamp)) {
  39       $timestamp = 0;
  40     }
  41
  42     return gmdate('D, d M Y H:i:s', $timestamp) . ' GMT';
  43   }
  44
  45   public static function str_to_gmdate($date) {
  46     $timestamp = strtotime($date);
  47     if (FALSE === $timestamp) {
  48       $timestamp = 0;
  49     }
  50
  51     return Tweeper::epoch_to_gmdate($timestamp);
  52   }
  53
  54   private static function get_contents($url) {
  55     $ch = curl_init($url);
  56     curl_setopt_array($ch, array(
  57       CURLOPT_HEADER => FALSE,
  58       CURLOPT_FOLLOWLOCATION => TRUE,  // follow http redirects to get the real URL
  59       CURLOPT_RETURNTRANSFER => TRUE,
  60       CURLOPT_SSL_VERIFYHOST => FALSE,
  61       CURLOPT_SSL_VERIFYPEER => FALSE,
  62       CURLOPT_HTTPHEADER => array('Accept-language: en'),
  63       CURLOPT_USERAGENT => Tweeper::$USER_AGENT,
  64     ));
  65     $contents = curl_exec($ch);
  66     curl_close($ch);
  67
  68     return $contents;
  69   }
  70
  71   private static function get_info($url) {
  72     $ch = curl_init($url);
  73     curl_setopt_array($ch, array(
  74       CURLOPT_HEADER => TRUE,
  75       CURLOPT_NOBODY => TRUE,
  76       CURLOPT_FOLLOWLOCATION => TRUE,  // follow http redirects to get the real URL
  77       CURLOPT_RETURNTRANSFER => TRUE,
  78       CURLOPT_SSL_VERIFYHOST => FALSE,
  79       CURLOPT_SSL_VERIFYPEER => FALSE,
  80       CURLOPT_USERAGENT => Tweeper::$USER_AGENT,
  81     ));
  82     curl_exec($ch);
  83     $url_info = curl_getinfo($ch);
  84     curl_close($ch);
  85
  86     return $url_info;
  87   }
  88
  89   public static function generate_enclosure($url) {
  90     $supported_content_types = array(
  91       "application/ogg",
  92       "audio/aac",
  93       "audio/mp4",
  94       "audio/mpeg",
  95       "audio/ogg",
  96       "audio/vorbis",
  97       "audio/wav",
  98       "audio/webm",
  99       "audio/x-midi",
 100       "image/gif",
 101       "image/jpeg",
 102       "video/avi",
 103       "video/mp4",
 104       "video/mpeg",
 105       "video/ogg",
 106     );
 107
 108     // The RSS specification says that the enclosure element url must be http.
 109     // See http://sourceforge.net/p/feedvalidator/bugs/72/
 110     $http_url = preg_replace("/^https/", "http", $url);
 111
 112     $url_info = Tweeper::get_info($http_url);
 113
 114     $supported = in_array($url_info['content_type'], $supported_content_types);
 115     if (!$supported) {
 116       error_log("Unsupported enclosure content type \"" . $url_info['content_type'] . "\" for URL: " . $url_info['url']);
 117       return '';
 118     }
 119
 120     $dom = new DomDocument();
 121     $enc = $dom->createElement('enclosure');
 122     $enc->setAttribute('url', $url_info['url']);
 123     $enc->setAttribute('length', $url_info['download_content_length']);
 124     $enc->setAttribute('type', $url_info['content_type']);
 125
 126     $dom->appendChild($enc);
 127
 128     return $dom->saveXML($enc);
 129   }
 130
 131   /* Mimic the message from libxml.c::php_libxml_ctx_error_level() */
 132   private function log_xml_error($error) {
 133     $output = "";
 134
 135     switch ($error->level) {
 136     case LIBXML_ERR_WARNING:
 137       $output .= "Warning $error->code: ";
 138       break;
 139     case LIBXML_ERR_ERROR:
 140       $output .= "Error $error->code: ";
 141       break;
 142     case LIBXML_ERR_FATAL:
 143       $output .= "Fatal Error $error->code: ";
 144       break;
 145     }
 146
 147     $output .= trim($error->message);
 148
 149     if ($error->file) {
 150       $output .= " in $error->file";
 151     } else {
 152       $output .= " in Entity,";
 153     }
 154
 155     $output .=" line $error->line";
 156
 157     error_log($output);
 158   }
 159
 160   private function load_stylesheet($host) {
 161     $stylesheet = "file://" . __DIR__ . "/rss_converter_" . $host . ".xsl";
 162     if (FALSE === file_exists($stylesheet)) {
 163       trigger_error("Conversion to RSS not supported for $host ($stylesheet not found)", E_USER_ERROR);
 164       return NULL;
 165     }
 166
 167     $stylesheet_contents = $this->get_contents($stylesheet);
 168
 169     $xslDoc = new DOMDocument();
 170     $xslDoc->loadXML($stylesheet_contents);
 171
 172     $xsltProcessor = new XSLTProcessor();
 173     $xsltProcessor->registerPHPFunctions();
 174     $xsltProcessor->setParameter('', 'generateEnclosure', $this->generate_enclosure);
 175     $xsltProcessor->importStylesheet($xslDoc);
 176
 177     return $xsltProcessor;
 178   }
 179
 180   private function json_to_xml($json, $root_node_name) {
 181     // Apparenty the ObjectNormalizer used afterwards is not able to handle
 182     // the stdClass object created by json_decode() with the default setting
 183     // $assoc = false; so use $assoc = true
 184     $data = json_decode($json, $assoc = true);
 185     if (!$data) {
 186       return NULL;
 187     }
 188
 189     $encoder = new XmlEncoder();
 190     $normalizer = new ObjectNormalizer();
 191     $serializer = new Serializer(array($normalizer), array($encoder));
 192
 193     $serializer_options = array (
 194       'xml_encoding' => "UTF-8",
 195       'xml_format_output' => TRUE,
 196       'xml_root_node_name' => $root_node_name,
 197     );
 198
 199     $xml_data = $serializer->serialize($data, 'xml', $serializer_options);
 200     if (!$xml_data) {
 201       trigger_error("Cannot serialize data", E_USER_ERROR);
 202       return NULL;
 203     }
 204
 205     return $xml_data;
 206   }
 207
 208   private function get_xml_instagram_com($html) {
 209     // extract the json data from the html code
 210     $json_match_expr = '/window._sharedData = (.*);/';
 211     $ret = preg_match($json_match_expr, $html, $matches);
 212     if ($ret !== 1) {
 213       trigger_error("Cannot match expression: $json_match_expr\n", E_USER_ERROR);
 214       return NULL;
 215     }
 216
 217     return $this->json_to_xml($matches[1], 'instagram');
 218   }
 219
 220   private function preprocess_html_facebook_com($html) {
 221     $html = str_replace('<!--', '', $html);
 222     $html = str_replace('-->', '', $html);
 223     return $html;
 224   }
 225
 226   private function html_to_xml($html, $host) {
 227     $xmlDoc = new DOMDocument();
 228
 229     // Handle warnings and errors when loading invalid HTML.
 230     $xml_errors_value = libxml_use_internal_errors(true);
 231
 232     // If there is a host-specific method to get the xml data, use it!
 233     $get_xml_host_method = 'get_xml_' . str_replace(".", "_", $host);
 234     if (method_exists($this, $get_xml_host_method)) {
 235       $xml_data = call_user_func_array(array($this, $get_xml_host_method), array($html));
 236       $xmlDoc->loadXML($xml_data);
 237     } else {
 238       $xmlDoc->loadHTML($html);
 239     }
 240
 241     foreach (libxml_get_errors() as $xml_error) {
 242       $this->log_xml_error($xml_error);
 243     }
 244     libxml_clear_errors();
 245     libxml_use_internal_errors($xml_errors_value);
 246
 247     return $xmlDoc;
 248   }
 249
 250   public function tweep($src_url) {
 251     $url = parse_url($src_url);
 252     if (FALSE === $url || empty($url["host"])) {
 253       trigger_error("Invalid url: $src_url", E_USER_ERROR);
 254       return NULL;
 255     }
 256
 257     // Strip the leading www. to be more forgiving on input URLs
 258     $host = preg_replace('/^www\./', '', $url["host"]);
 259
 260     $xsltProcessor = $this->load_stylesheet($host);
 261     if (NULL === $xsltProcessor) {
 262       return NULL;
 263     }
 264
 265     $html = $this->get_contents($src_url);
 266     if (FALSE === $html) {
 267       return NULL;
 268     }
 269
 270     $preprocess_html_host_method = 'preprocess_html_' . str_replace(".", "_", $host);
 271     if (method_exists($this, $preprocess_html_host_method)) {
 272       $html = call_user_func_array(array($this, $preprocess_html_host_method), array($html));
 273     }
 274
 275     $xmlDoc = $this->html_to_xml($html, $host);
 276     if (NULL === $xmlDoc) {
 277       return NULL;
 278     }
 279
 280     $output = $xsltProcessor->transformToXML($xmlDoc);
 281
 282     if (FALSE === $output) {
 283       trigger_error('XSL transformation failed.', E_USER_ERROR);
 284       return NULL;
 285     }
 286     return $output;
 287   }
 288 }
 289
 290 function is_cli() {
 291   return (php_sapi_name() === "cli");
 292 }
 293
 294 function usage($argv) {
 295   if (is_cli()) {
 296     $usage = "{$argv[0]} [-e|-h|--help] <src_url>\n";
 297   } else {
 298     $usage = htmlentities("{$_SERVER['SCRIPT_NAME']}?src_url=<src_url>&generate_enclosure=<0|1>");
 299   }
 300
 301   return "usage: $usage";
 302 }
 303
 304 function parse_options_cli($argv, $argc) {
 305   $options = array(
 306     'generate_enclosure' => FALSE
 307   );
 308
 309   if ($argc < 2)
 310     return $options;
 311
 312   $cli_options = getopt("eh", array("help"));
 313   foreach ($cli_options as $opt => $val) {
 314     switch ($opt) {
 315     case 'e':
 316       $options['generate_enclosure'] = TRUE;
 317       break;
 318     case 'h':
 319     case 'help':
 320       echo usage($argv);
 321       exit(0);
 322     default:
 323       fwrite(STDERR, usage($argv));
 324       exit(1);
 325     }
 326   }
 327
 328   $options['src_url'] = $argv[count($cli_options) + 1];
 329
 330   return $options;
 331 }
 332
 333 function parse_options_query_string() {
 334   $options = array(
 335     'generate_enclosure' => FALSE
 336   );
 337
 338   if (isset($_GET['src_url']))
 339     $options['src_url'] = $_GET['src_url'];
 340
 341   if (isset($_GET['generate_enclosure']))
 342     $options['generate_enclosure'] = $_GET['generate_enclosure'] == 1;
 343
 344   return $options;
 345 }
 346
 347
 348 if (is_cli()) {
 349   $options = parse_options_cli($argv, $argc);
 350   $ERROR_STREAM = fopen('php://stderr', 'w');
 351 } else {
 352   $options = parse_options_query_string();
 353   $ERROR_STREAM = fopen('php://output', 'w');
 354 }
 355
 356 if (!isset($options['src_url'])) {
 357   fwrite($ERROR_STREAM, usage(is_cli() ? $argv : NULL));
 358   exit(1);
 359 }
 360
 361 $tweeper = new Tweeper($options['generate_enclosure']);
 362 echo $tweeper->tweep($options['src_url']);