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       "image/png",
 136       "video/avi",
 137       "video/mp4",
 138       "video/mpeg",
 139       "video/ogg",
 140     );
 141
 142     // The RSS specification says that the enclosure element URL must be http.
 143     // See http://sourceforge.net/p/feedvalidator/bugs/72/
 144     $http_url = preg_replace("/^https/", "http", $url);
 145
 146     $url_info = Tweeper::getUrlInfo($http_url);
 147
 148     $supported = in_array($url_info['content_type'], $supported_content_types);
 149     if (!$supported) {
 150       error_log("Unsupported enclosure content type \"" . $url_info['content_type'] . "\" for URL: " . $url_info['url']);
 151       return '';
 152     }
 153
 154     $dom = new DOMDocument();
 155     $enc = $dom->createElement('enclosure');
 156     $enc->setAttribute('url', $url_info['url']);
 157     $enc->setAttribute('length', $url_info['download_content_length']);
 158     $enc->setAttribute('type', $url_info['content_type']);
 159
 160     return $enc;
 161   }
 162
 163   /**
 164    * Mimic the message from libxml.c::php_libxml_ctx_error_level()
 165    */
 166   private static function logXmlError($error) {
 167     $output = "";
 168
 169     switch ($error->level) {
 170       case LIBXML_ERR_WARNING:
 171         $output .= "Warning $error->code: ";
 172         break;
 173
 174       case LIBXML_ERR_ERROR:
 175         $output .= "Error $error->code: ";
 176         break;
 177
 178       case LIBXML_ERR_FATAL:
 179         $output .= "Fatal Error $error->code: ";
 180         break;
 181     }
 182
 183     $output .= trim($error->message);
 184
 185     if ($error->file) {
 186       $output .= " in $error->file";
 187     }
 188     else {
 189       $output .= " in Entity,";
 190     }
 191
 192     $output .= " line $error->line";
 193
 194     error_log($output);
 195   }
 196
 197   /**
 198    * Convert json to XML.
 199    */
 200   private static function jsonToXml($json, $root_node_name) {
 201     // Apparently the ObjectNormalizer used afterwards is not able to handle
 202     // the stdClass object created by json_decode() with the default setting
 203     // $assoc = false; so use $assoc = true.
 204     $data = json_decode($json, $assoc = TRUE);
 205     if (!$data) {
 206       return NULL;
 207     }
 208
 209     $encoder = new XmlEncoder();
 210     $normalizer = new ObjectNormalizer();
 211     $serializer = new Serializer(array($normalizer), array($encoder));
 212
 213     $serializer_options = array(
 214       'xml_encoding' => "UTF-8",
 215       'xml_format_output' => TRUE,
 216       'xml_root_node_name' => $root_node_name,
 217     );
 218
 219     $xml_data = $serializer->serialize($data, 'xml', $serializer_options);
 220     if (!$xml_data) {
 221       trigger_error("Cannot serialize data", E_USER_ERROR);
 222       return NULL;
 223     }
 224
 225     return $xml_data;
 226   }
 227
 228   /**
 229    * Convert the Instagram content to XML.
 230    */
 231   private function getXmlInstagramCom($html) {
 232     // Extract the json data from the html code.
 233     $json_match_expr = '/window._sharedData = (.*);/';
 234     $ret = preg_match($json_match_expr, $html, $matches);
 235     if ($ret !== 1) {
 236       trigger_error("Cannot match expression: $json_match_expr\n", E_USER_ERROR);
 237       return NULL;
 238     }
 239
 240     return Tweeper::jsonToXml($matches[1], 'instagram');
 241   }
 242
 243   /**
 244    * Make the Facebook HTML processable.
 245    */
 246   private function preprocessHtmlFacebookCom($html) {
 247     $html = str_replace('<!--', '', $html);
 248     $html = str_replace('-->', '', $html);
 249     return $html;
 250   }
 251
 252   /**
 253    * Convert the HTML retrieved from the site to XML.
 254    */
 255   private function htmlToXml($html, $host) {
 256     $xmlDoc = new DOMDocument();
 257
 258     // Handle warnings and errors when loading invalid HTML.
 259     $xml_errors_value = libxml_use_internal_errors(TRUE);
 260
 261     // If there is a host-specific method to get the XML data, use it!
 262     $get_xml_host_method = 'getXml' . Tweeper::toUpperCamelCase($host, '.');
 263     if (method_exists($this, $get_xml_host_method)) {
 264       $xml_data = call_user_func_array(array($this, $get_xml_host_method), array($html));
 265       $xmlDoc->loadXML($xml_data);
 266     }
 267     else {
 268       $xmlDoc->loadHTML($html);
 269     }
 270
 271     foreach (libxml_get_errors() as $xml_error) {
 272       Tweeper::logXmlError($xml_error);
 273     }
 274     libxml_clear_errors();
 275     libxml_use_internal_errors($xml_errors_value);
 276
 277     return $xmlDoc;
 278   }
 279
 280   /**
 281    * Load a stylesheet if the web site is supported.
 282    */
 283   private function loadStylesheet($host) {
 284     $stylesheet = "file://" . __DIR__ . "/rss_converter_" . $host . ".xsl";
 285     if (FALSE === file_exists($stylesheet)) {
 286       trigger_error("Conversion to RSS not supported for $host ($stylesheet not found)", E_USER_ERROR);
 287       return NULL;
 288     }
 289
 290     $stylesheet_contents = Tweeper::getUrlContents($stylesheet);
 291
 292     $xslDoc = new DOMDocument();
 293     $xslDoc->loadXML($stylesheet_contents);
 294
 295     $xsltProcessor = new XSLTProcessor();
 296     $xsltProcessor->registerPHPFunctions();
 297     $xsltProcessor->setParameter('', 'generate-enclosure', $this->generate_enclosure);
 298     $xsltProcessor->importStylesheet($xslDoc);
 299
 300     return $xsltProcessor;
 301   }
 302
 303   /**
 304    * Convert the site content to RSS.
 305    */
 306   public function tweep($src_url) {
 307     $url = parse_url($src_url);
 308     if (FALSE === $url || empty($url["host"])) {
 309       trigger_error("Invalid URL: $src_url", E_USER_ERROR);
 310       return NULL;
 311     }
 312
 313     // Strip the leading www. to be more forgiving on input URLs.
 314     $host = preg_replace('/^www\./', '', $url["host"]);
 315
 316     $xsltProcessor = $this->loadStylesheet($host);
 317     if (NULL === $xsltProcessor) {
 318       return NULL;
 319     }
 320
 321     $html = Tweeper::getUrlContents($src_url);
 322     if (FALSE === $html) {
 323       return NULL;
 324     }
 325
 326     $preprocess_html_host_method = 'preprocessHtml' . Tweeper::toUpperCamelCase($host, '.');
 327     if (method_exists($this, $preprocess_html_host_method)) {
 328       $html = call_user_func_array(array($this, $preprocess_html_host_method), array($html));
 329     }
 330
 331     $xmlDoc = $this->htmlToXml($html, $host);
 332     if (NULL === $xmlDoc) {
 333       return NULL;
 334     }
 335
 336     $output = $xsltProcessor->transformToXML($xmlDoc);
 337
 338     if (FALSE === $output) {
 339       trigger_error('XSL transformation failed.', E_USER_ERROR);
 340       return NULL;
 341     }
 342     return $output;
 343   }
 344
 345 }
 346
 347 /**
 348  * Check if the script is being run from the command line.
 349  */
 350 function is_cli() {
 351   return (php_sapi_name() === "cli");
 352 }
 353
 354 /**
 355  * Show the script usage.
 356  */
 357 function usage($argv) {
 358   if (is_cli()) {
 359     $usage = "{$argv[0]} [-e|-h|--help] <src_url>\n";
 360   }
 361   else {
 362     $usage = htmlentities("{$_SERVER['SCRIPT_NAME']}?src_url=<src_url>&generate_enclosure=<0|1>");
 363   }
 364
 365   return "usage: $usage";
 366 }
 367
 368 /**
 369  * Parse command line options.
 370  */
 371 function parse_options_cli($argv, $argc) {
 372   $options = array(
 373     'generate_enclosure' => FALSE,
 374   );
 375
 376   if ($argc < 2) {
 377     return $options;
 378   }
 379
 380   $cli_options = getopt("eh", array("help"));
 381   foreach ($cli_options as $opt => $val) {
 382     switch ($opt) {
 383       case 'e':
 384         $options['generate_enclosure'] = TRUE;
 385         break;
 386
 387       case 'h':
 388       case 'help':
 389         echo usage($argv);
 390         exit(0);
 391
 392       default:
 393         fwrite(STDERR, usage($argv));
 394         exit(1);
 395     }
 396   }
 397
 398   $options['src_url'] = $argv[count($cli_options) + 1];
 399
 400   return $options;
 401 }
 402
 403 /**
 404  * Parse options passed from a query string.
 405  */
 406 function parse_options_query_string() {
 407   $options = array(
 408     'generate_enclosure' => FALSE,
 409   );
 410
 411   if (isset($_GET['src_url'])) {
 412     $options['src_url'] = $_GET['src_url'];
 413   }
 414
 415   if (isset($_GET['generate_enclosure'])) {
 416     $options['generate_enclosure'] = $_GET['generate_enclosure'] == 1;
 417   }
 418
 419   return $options;
 420 }
 421
 422 if (is_cli()) {
 423   $options = parse_options_cli($argv, $argc);
 424   $error_stream = fopen('php://stderr', 'w');
 425 }
 426 else {
 427   $options = parse_options_query_string();
 428   $error_stream = fopen('php://output', 'w');
 429 }
 430
 431 if (!isset($options['src_url'])) {
 432   fwrite($error_stream, usage(is_cli() ? $argv : NULL));
 433   exit(1);
 434 }
 435
 436 $tweeper = new Tweeper($options['generate_enclosure']);
 437 echo $tweeper->tweep($options['src_url']);