rss_converter_twitter.com.xsl: add a mode attribute to the enclosure template

[tweeper.git] / tweeper.php

diff --git a/tweeper.php b/tweeper.php
index 736b5b3..f7e0a88 100644 (file)
--- a/tweeper.php
+++ b/tweeper.php
@@ -32,7 +32,7 @@ date_default_timezone_set('UTC');
  */
 class Tweeper {
 
  */
 class Tweeper {
 

-  private static $USER_AGENT = "Mozilla/5.0 (Windows NT 6.1; rv:22.0) Gecko/20130405 Firefox/22.0";
+  private static $userAgent = "Mozilla/5.0 (Windows NT 6.1; rv:22.0) Gecko/20130405 Firefox/22.0";

 
   /**
    * Constructor sets up {@link $generate_enclosure}.
 
   /**
    * Constructor sets up {@link $generate_enclosure}.


@@ -44,30 +44,39 @@ class Tweeper {
   /**
    * Convert numeric Epoch to the date format expected in a RSS document.
    */
   /**
    * Convert numeric Epoch to the date format expected in a RSS document.
    */

-  public static function epoch_to_gmdate($timestamp) {
+  public static function epochToRssDate($timestamp) {

     if (!is_numeric($timestamp) || is_nan($timestamp)) {
       $timestamp = 0;
     }
 
     if (!is_numeric($timestamp) || is_nan($timestamp)) {
       $timestamp = 0;
     }
 

-    return gmdate('D, d M Y H:i:s', $timestamp) . ' GMT';
+    return gmdate(DATE_RSS, $timestamp);

   }
 
   /**
    * Convert generic date string to the date format expected in a RSS document.
    */
   }
 
   /**
    * Convert generic date string to the date format expected in a RSS document.
    */

-  public static function str_to_gmdate($date) {
+  public static function strToRssDate($date) {

     $timestamp = strtotime($date);
     if (FALSE === $timestamp) {
       $timestamp = 0;
     }
 
     $timestamp = strtotime($date);
     if (FALSE === $timestamp) {
       $timestamp = 0;
     }
 

-    return Tweeper::epoch_to_gmdate($timestamp);
+    return Tweeper::epochToRssDate($timestamp);
+  }
+
+  /**
+   * Convert string to UpperCamelCase.
+   */
+  public static function toUpperCamelCase($str, $delim = ' ') {
+    $str_upper = ucwords($str, $delim);
+    $str_camel_case = str_replace($delim, '', $str_upper);
+    return $str_camel_case;

   }
 
   /**
    * Get the contents from a URL.
    */
   }
 
   /**
    * Get the contents from a URL.
    */

-  private static function get_contents($url) {
+  private static function getUrlContents($url) {

     $ch = curl_init($url);
     curl_setopt_array($ch, array(
       CURLOPT_HEADER => FALSE,
     $ch = curl_init($url);
     curl_setopt_array($ch, array(
       CURLOPT_HEADER => FALSE,


@@ -77,7 +86,7 @@ class Tweeper {
       CURLOPT_SSL_VERIFYHOST => FALSE,
       CURLOPT_SSL_VERIFYPEER => FALSE,
       CURLOPT_HTTPHEADER => array('Accept-language: en'),
       CURLOPT_SSL_VERIFYHOST => FALSE,
       CURLOPT_SSL_VERIFYPEER => FALSE,
       CURLOPT_HTTPHEADER => array('Accept-language: en'),

-      CURLOPT_USERAGENT => Tweeper::$USER_AGENT,
+      CURLOPT_USERAGENT => Tweeper::$userAgent,

     ));
     $contents = curl_exec($ch);
     curl_close($ch);
     ));
     $contents = curl_exec($ch);
     curl_close($ch);


@@ -88,7 +97,7 @@ class Tweeper {
   /**
    * Get the headers from a URL.
    */
   /**
    * Get the headers from a URL.
    */

-  private static function get_info($url) {
+  private static function getUrlInfo($url) {

     $ch = curl_init($url);
     curl_setopt_array($ch, array(
       CURLOPT_HEADER => TRUE,
     $ch = curl_init($url);
     curl_setopt_array($ch, array(
       CURLOPT_HEADER => TRUE,


@@ -98,7 +107,7 @@ class Tweeper {
       CURLOPT_RETURNTRANSFER => TRUE,
       CURLOPT_SSL_VERIFYHOST => FALSE,
       CURLOPT_SSL_VERIFYPEER => FALSE,
       CURLOPT_RETURNTRANSFER => TRUE,
       CURLOPT_SSL_VERIFYHOST => FALSE,
       CURLOPT_SSL_VERIFYPEER => FALSE,

-      CURLOPT_USERAGENT => Tweeper::$USER_AGENT,
+      CURLOPT_USERAGENT => Tweeper::$userAgent,

     ));
     curl_exec($ch);
     $url_info = curl_getinfo($ch);
     ));
     curl_exec($ch);
     $url_info = curl_getinfo($ch);


@@ -110,7 +119,7 @@ class Tweeper {
   /**
    * Generate an RSS <enclosure/> element.
    */
   /**
    * Generate an RSS <enclosure/> element.
    */

-  public static function generate_enclosure($url) {
+  public static function generateEnclosure($url) {

     $supported_content_types = array(
       "application/ogg",
       "audio/aac",
     $supported_content_types = array(
       "application/ogg",
       "audio/aac",


@@ -123,6 +132,7 @@ class Tweeper {
       "audio/x-midi",
       "image/gif",
       "image/jpeg",
       "audio/x-midi",
       "image/gif",
       "image/jpeg",

+      "image/png",

       "video/avi",
       "video/mp4",
       "video/mpeg",
       "video/avi",
       "video/mp4",
       "video/mpeg",


@@ -133,7 +143,7 @@ class Tweeper {
     // See http://sourceforge.net/p/feedvalidator/bugs/72/
     $http_url = preg_replace("/^https/", "http", $url);
 
     // See http://sourceforge.net/p/feedvalidator/bugs/72/
     $http_url = preg_replace("/^https/", "http", $url);
 

-    $url_info = Tweeper::get_info($http_url);
+    $url_info = Tweeper::getUrlInfo($http_url);

 
     $supported = in_array($url_info['content_type'], $supported_content_types);
     if (!$supported) {
 
     $supported = in_array($url_info['content_type'], $supported_content_types);
     if (!$supported) {


@@ -141,21 +151,19 @@ class Tweeper {
       return '';
     }
 
       return '';
     }
 

-    $dom = new DomDocument();
+    $dom = new DOMDocument();

     $enc = $dom->createElement('enclosure');
     $enc->setAttribute('url', $url_info['url']);
     $enc->setAttribute('length', $url_info['download_content_length']);
     $enc->setAttribute('type', $url_info['content_type']);
 
     $enc = $dom->createElement('enclosure');
     $enc->setAttribute('url', $url_info['url']);
     $enc->setAttribute('length', $url_info['download_content_length']);
     $enc->setAttribute('type', $url_info['content_type']);
 

-    $dom->appendChild($enc);
-
-    return $dom->saveXML($enc);
+    return $enc;

   }
 
   /**
    * Mimic the message from libxml.c::php_libxml_ctx_error_level()
    */
   }
 
   /**
    * Mimic the message from libxml.c::php_libxml_ctx_error_level()
    */

-  private function log_xml_error($error) {
+  private static function logXmlError($error) {

     $output = "";
 
     switch ($error->level) {
     $output = "";
 
     switch ($error->level) {


@@ -187,32 +195,9 @@ class Tweeper {
   }
 
   /**
   }
 
   /**

-   * Load a stylesheet if the web site is supported.
+   * Convert json to XML.

    */
    */

-  private function load_stylesheet($host) {
-    $stylesheet = "file://" . __DIR__ . "/rss_converter_" . $host . ".xsl";
-    if (FALSE === file_exists($stylesheet)) {
-      trigger_error("Conversion to RSS not supported for $host ($stylesheet not found)", 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;
-  }
-
-  /**
-   * Convert json to xml.
-   */
-  private function json_to_xml($json, $root_node_name) {
+  private static function jsonToXml($json, $root_node_name) {

     // Apparently the ObjectNormalizer used afterwards is not able to handle
     // the stdClass object created by json_decode() with the default setting
     // $assoc = false; so use $assoc = true.
     // Apparently the ObjectNormalizer used afterwards is not able to handle
     // the stdClass object created by json_decode() with the default setting
     // $assoc = false; so use $assoc = true.


@@ -243,7 +228,7 @@ class Tweeper {
   /**
    * Convert the Instagram content to XML.
    */
   /**
    * Convert the Instagram content to XML.
    */

-  private function get_xml_instagram_com($html) {
+  private function getXmlInstagramCom($html) {

     // Extract the json data from the html code.
     $json_match_expr = '/window._sharedData = (.*);/';
     $ret = preg_match($json_match_expr, $html, $matches);
     // Extract the json data from the html code.
     $json_match_expr = '/window._sharedData = (.*);/';
     $ret = preg_match($json_match_expr, $html, $matches);


@@ -252,13 +237,13 @@ class Tweeper {
       return NULL;
     }
 
       return NULL;
     }
 

-    return $this->json_to_xml($matches[1], 'instagram');
+    return Tweeper::jsonToXml($matches[1], 'instagram');

   }
 
   /**
    * Make the Facebook HTML processable.
    */
   }
 
   /**
    * Make the Facebook HTML processable.
    */

-  private function preprocess_html_facebook_com($html) {
+  private function preprocessHtmlFacebookCom($html) {

     $html = str_replace('<!--', '', $html);
     $html = str_replace('-->', '', $html);
     return $html;
     $html = str_replace('<!--', '', $html);
     $html = str_replace('-->', '', $html);
     return $html;


@@ -267,14 +252,14 @@ class Tweeper {
   /**
    * Convert the HTML retrieved from the site to XML.
    */
   /**
    * Convert the HTML retrieved from the site to XML.
    */

-  private function html_to_xml($html, $host) {
+  private function htmlToXml($html, $host) {

     $xmlDoc = new DOMDocument();
 
     // Handle warnings and errors when loading invalid HTML.
     $xml_errors_value = libxml_use_internal_errors(TRUE);
 
     $xmlDoc = new DOMDocument();
 
     // Handle warnings and errors when loading invalid HTML.
     $xml_errors_value = libxml_use_internal_errors(TRUE);
 

-    // If there is a host-specific method to get the xml data, use it!
-    $get_xml_host_method = 'get_xml_' . str_replace(".", "_", $host);
+    // If there is a host-specific method to get the XML data, use it!
+    $get_xml_host_method = 'getXml' . Tweeper::toUpperCamelCase($host, '.');

     if (method_exists($this, $get_xml_host_method)) {
       $xml_data = call_user_func_array(array($this, $get_xml_host_method), array($html));
       $xmlDoc->loadXML($xml_data);
     if (method_exists($this, $get_xml_host_method)) {
       $xml_data = call_user_func_array(array($this, $get_xml_host_method), array($html));
       $xmlDoc->loadXML($xml_data);


@@ -284,7 +269,7 @@ class Tweeper {
     }
 
     foreach (libxml_get_errors() as $xml_error) {
     }
 
     foreach (libxml_get_errors() as $xml_error) {

-      $this->log_xml_error($xml_error);
+      Tweeper::logXmlError($xml_error);

     }
     libxml_clear_errors();
     libxml_use_internal_errors($xml_errors_value);
     }
     libxml_clear_errors();
     libxml_use_internal_errors($xml_errors_value);


@@ -293,6 +278,29 @@ class Tweeper {
   }
 
   /**
   }
 
   /**

+   * Load a stylesheet if the web site is supported.
+   */
+  private function loadStylesheet($host) {
+    $stylesheet = "file://" . __DIR__ . "/rss_converter_" . $host . ".xsl";
+    if (FALSE === file_exists($stylesheet)) {
+      trigger_error("Conversion to RSS not supported for $host ($stylesheet not found)", E_USER_ERROR);
+      return NULL;
+    }
+
+    $stylesheet_contents = Tweeper::getUrlContents($stylesheet);
+
+    $xslDoc = new DOMDocument();
+    $xslDoc->loadXML($stylesheet_contents);
+
+    $xsltProcessor = new XSLTProcessor();
+    $xsltProcessor->registerPHPFunctions();
+    $xsltProcessor->setParameter('', 'generate-enclosure', $this->generate_enclosure);
+    $xsltProcessor->importStylesheet($xslDoc);
+
+    return $xsltProcessor;
+  }
+
+  /**

    * Convert the site content to RSS.
    */
   public function tweep($src_url) {
    * Convert the site content to RSS.
    */
   public function tweep($src_url) {


@@ -305,22 +313,22 @@ class Tweeper {
     // Strip the leading www. to be more forgiving on input URLs.
     $host = preg_replace('/^www\./', '', $url["host"]);
 
     // Strip the leading www. to be more forgiving on input URLs.
     $host = preg_replace('/^www\./', '', $url["host"]);
 

-    $xsltProcessor = $this->load_stylesheet($host);
+    $xsltProcessor = $this->loadStylesheet($host);

     if (NULL === $xsltProcessor) {
       return NULL;
     }
 
     if (NULL === $xsltProcessor) {
       return NULL;
     }
 

-    $html = $this->get_contents($src_url);
+    $html = Tweeper::getUrlContents($src_url);

     if (FALSE === $html) {
       return NULL;
     }
 
     if (FALSE === $html) {
       return NULL;
     }
 

-    $preprocess_html_host_method = 'preprocess_html_' . str_replace(".", "_", $host);
+    $preprocess_html_host_method = 'preprocessHtml' . Tweeper::toUpperCamelCase($host, '.');

     if (method_exists($this, $preprocess_html_host_method)) {
       $html = call_user_func_array(array($this, $preprocess_html_host_method), array($html));
     }
 
     if (method_exists($this, $preprocess_html_host_method)) {
       $html = call_user_func_array(array($this, $preprocess_html_host_method), array($html));
     }
 

-    $xmlDoc = $this->html_to_xml($html, $host);
+    $xmlDoc = $this->htmlToXml($html, $host);

     if (NULL === $xmlDoc) {
       return NULL;
     }
     if (NULL === $xmlDoc) {
       return NULL;
     }


@@ -413,15 +421,15 @@ function parse_options_query_string() {
 
 if (is_cli()) {
   $options = parse_options_cli($argv, $argc);
 
 if (is_cli()) {
   $options = parse_options_cli($argv, $argc);

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

 }
 else {
   $options = parse_options_query_string();
 }
 else {
   $options = parse_options_query_string();

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

 }
 
 if (!isset($options['src_url'])) {
 }
 
 if (!isset($options['src_url'])) {

-  fwrite($ERROR_STREAM, usage(is_cli() ? $argv : NULL));
+  fwrite($error_stream, usage(is_cli() ? $argv : NULL));

   exit(1);
 }
 
   exit(1);
 }