tweeper.php: factor out an html_to_xml() function from the tweep() method

[tweeper.git] / tweeper.php

diff --git a/tweeper.php b/tweeper.php
index ef55022..524928a 100644 (file)
--- a/tweeper.php
+++ b/tweeper.php
@@ -1,19 +1,19 @@
 <?php
 /*
  * tweeper - a Twitter to RSS web scraper
 <?php
 /*
  * tweeper - a Twitter to RSS web scraper

- * 
- * Copyright (C) 2013  Antonio Ospite <ospite@studenti.unina.it>
- * 
+ *
+ * Copyright (C) 2013-2015  Antonio Ospite <ao2@ao2.it>
+ *

  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.

- * 
+ *

  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.

- * 
+ *

  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */


@@ -24,16 +24,8 @@ class Tweeper {
 
   private static $USER_AGENT = "Mozilla/5.0 (Windows NT 6.1; rv:22.0) Gecko/20130405 Firefox/22.0";
 
 
   private static $USER_AGENT = "Mozilla/5.0 (Windows NT 6.1; rv:22.0) Gecko/20130405 Firefox/22.0";
 

-  public function __construct($stylesheet, $generate_enclosure = FALSE) {
-    $stylesheet_contents = $this->get_contents($stylesheet);
-
-    $xslDoc = new DOMDocument();
-    $xslDoc->loadXML($stylesheet_contents);
-
-    $this->xsltProcessor = new XSLTProcessor();
-    $this->xsltProcessor->registerPHPFunctions();
-    $this->xsltProcessor->setParameter('', 'generateEnclosure', $generate_enclosure);
-    $this->xsltProcessor->importStylesheet($xslDoc);
+  public function __construct($generate_enclosure = FALSE) {
+    $this->generate_enclosure = $generate_enclosure;

   }
 
   public static function epoch_to_gmdate($timestamp)
   }
 
   public static function epoch_to_gmdate($timestamp)


@@ -47,20 +39,21 @@ class Tweeper {
     return Tweeper::epoch_to_gmdate($timestamp);
   }
 
     return Tweeper::epoch_to_gmdate($timestamp);
   }
 

-  private static function get_contents($uri) {
-    # https://www.wjsams.com/c/docs/Wiki/Php-HowToSetUserAgentOnFileGetContents
-    $opts = array(
-      'http' => array(
-        'method' => "GET",
-        'header' => join(array(
-          "Accept-language: en\r\n",
-          "User-Agent: {" + Tweeper::$USER_AGENT + "}\r\n"
-        ))
-      )
-    );
+  private static function get_contents($url)
+  {
+    $ch = curl_init($url);
+    curl_setopt_array($ch, array(
+      CURLOPT_HEADER => FALSE,
+      CURLOPT_FOLLOWLOCATION => TRUE,  // follow http redirects to get the real URL
+      CURLOPT_RETURNTRANSFER => TRUE,
+      CURLOPT_SSL_VERIFYHOST => FALSE,
+      CURLOPT_SSL_VERIFYPEER => FALSE,
+      CURLOPT_HTTPHEADER => array('Accept-language: en'),
+      CURLOPT_USERAGENT => Tweeper::$USER_AGENT,
+    ));
+    $contents = curl_exec($ch);
+    curl_close($ch);

 
 

-    $context = stream_context_create($opts);
-    $contents = file_get_contents($uri, false, $context);

     return $contents;
   }
 
     return $contents;
   }
 


@@ -68,16 +61,16 @@ class Tweeper {
   {
     $ch = curl_init($url);
     curl_setopt_array($ch, array(
   {
     $ch = curl_init($url);
     curl_setopt_array($ch, array(

-        CURLOPT_HEADER => TRUE,
-        CURLOPT_NOBODY => TRUE,
-        CURLOPT_FOLLOWLOCATION => TRUE,  // follow http redirects to get the real URL
-        CURLOPT_RETURNTRANSFER => TRUE,
-        CURLOPT_SSL_VERIFYHOST => FALSE,
-        CURLOPT_SSL_VERIFYPEER => FALSE,
-        CURLOPT_USERAGENT => Tweeper::$USER_AGENT,
+      CURLOPT_HEADER => TRUE,
+      CURLOPT_NOBODY => TRUE,
+      CURLOPT_FOLLOWLOCATION => TRUE,  // follow http redirects to get the real URL
+      CURLOPT_RETURNTRANSFER => TRUE,
+      CURLOPT_SSL_VERIFYHOST => FALSE,
+      CURLOPT_SSL_VERIFYPEER => FALSE,
+      CURLOPT_USERAGENT => Tweeper::$USER_AGENT,

     ));
     curl_exec($ch);
     ));
     curl_exec($ch);

-    $url_info = curl_getinfo($ch);;
+    $url_info = curl_getinfo($ch);

     curl_close($ch);
 
     return $url_info;
     curl_close($ch);
 
     return $url_info;


@@ -90,6 +83,7 @@ class Tweeper {
       "audio/aac",
       "audio/mp4",
       "audio/mpeg",
       "audio/aac",
       "audio/mp4",
       "audio/mpeg",

+      "audio/ogg",

       "audio/vorbis",
       "audio/wav",
       "audio/webm",
       "audio/vorbis",
       "audio/wav",
       "audio/webm",


@@ -121,13 +115,93 @@ class Tweeper {
     return $dom->saveXML($enc);
   }
 
     return $dom->saveXML($enc);
   }
 

-  public function tweep($uri) {
-    $html = Tweeper::get_contents($uri);
+  /* Mimic the message from libxml.c::php_libxml_ctx_error_level() */
+  private function log_xml_error($error) {
+    $output = "";
+
+    switch ($error->level) {
+    case LIBXML_ERR_WARNING:
+      $output .= "Warning $error->code: ";
+      break;
+    case LIBXML_ERR_ERROR:
+      $output .= "Error $error->code: ";
+      break;
+    case LIBXML_ERR_FATAL:
+      $output .= "Fatal Error $error->code: ";
+      break;
+    }
+
+    $output .= trim($error->message);
+
+    if ($error->file) {
+      $output .= " in $error->file";
+    } else {
+      $output .= " in Entity,";
+    }
+
+    $output .=" line $error->line";
+
+    error_log($output);
+  }
+
+  private function load_stylesheet($host) {
+    $stylesheet = "file://" . __DIR__ . "/rss_converter_" . $host . ".xsl";
+    if (FALSE === file_exists($stylesheet)) {
+      trigger_error("Conversion to RSS not supported: $host", E_USER_ERROR);
+      return NULL;
+    }
+
+    $stylesheet_contents = $this->get_contents($stylesheet);

 
 

+    $xslDoc = new DOMDocument();
+    $xslDoc->loadXML($stylesheet_contents);
+
+    $xsltProcessor = new XSLTProcessor();
+    $xsltProcessor->registerPHPFunctions();
+    $xsltProcessor->setParameter('', 'generateEnclosure', $this->generate_enclosure);
+    $xsltProcessor->importStylesheet($xslDoc);
+
+    return $xsltProcessor;
+  }
+
+  private function html_to_xml($html) {

     $xmlDoc = new DOMDocument();
     $xmlDoc = new DOMDocument();

+
+    // Handle warnings and errors when loading invalid HTML.
+    $xml_errors_value = libxml_use_internal_errors(true);

     $xmlDoc->loadHTML($html);
     $xmlDoc->loadHTML($html);

+    foreach (libxml_get_errors() as $xml_error) {
+      $this->log_xml_error($xml_error);
+    }
+    libxml_clear_errors();
+    libxml_use_internal_errors($xml_errors_value);
+
+    return $xmlDoc;
+  }
+
+  public function tweep($src_url) {
+    $url = parse_url($src_url);
+    if (FALSE === $url || empty($url["host"])) {
+      trigger_error("Invalid url: $src_url", E_USER_ERROR);
+      return NULL;
+    }

 
 

-    $output = $this->xsltProcessor->transformToXML($xmlDoc);
+    $xsltProcessor = $this->load_stylesheet($url["host"]);
+    if (NULL === $xsltProcessor) {
+      return NULL;
+    }
+
+    $html = $this->get_contents($src_url);
+    if (FALSE === $html) {
+      return NULL;
+    }
+
+    $xmlDoc = $this->html_to_xml($html);
+    if (NULL === $xmlDoc) {
+      return NULL;
+    }
+
+    $output = $xsltProcessor->transformToXML($xmlDoc);

 
     if (FALSE === $output) {
       trigger_error('XSL transformation failed.', E_USER_ERROR);
 
     if (FALSE === $output) {
       trigger_error('XSL transformation failed.', E_USER_ERROR);


@@ -167,7 +241,8 @@ function parse_options_cli($argv, $argc)
       echo usage($argv);
       exit(0);
     default:
       echo usage($argv);
       exit(0);
     default:

-      die(usage($argv));
+      fwrite(STDERR, usage($argv));
+      exit(1);

     }
   }
 
     }
   }
 


@@ -192,21 +267,18 @@ function parse_options_query_string()
 }
 
 
 }
 
 

-if (php_sapi_name() != 'cli')
+if (php_sapi_name() != 'cli') {

   $options = parse_options_query_string();
   $options = parse_options_query_string();

-else
+  $ERROR_STREAM = fopen('php://output', 'w');
+} else {

   $options = parse_options_cli($argv, $argc);
   $options = parse_options_cli($argv, $argc);

+  $ERROR_STREAM = fopen('php://stderr', 'w');
+}

 
 

-if (!isset($options['src_url']))
-  die(usage($argv));
-
-$url = parse_url($options['src_url']);
-if (FALSE === $url || empty($url["host"]))
-  die("Invalid url: ${options['src_url']}\n");
-
-$stylesheet = __DIR__ . "/rss_converter_" . $url["host"] . ".xsl";
-if (FALSE === file_exists($stylesheet))
-  die("Conversion to RSS not supported: {$url["host"]}\n");
+if (!isset($options['src_url'])) {
+  fwrite($ERROR_STREAM, usage($argv));
+  exit(1);
+}

 
 

-$tweeper = new Tweeper($stylesheet, $options['generate_enclosure']);
+$tweeper = new Tweeper($options['generate_enclosure']);

 echo $tweeper->tweep($options['src_url']);
 echo $tweeper->tweep($options['src_url']);