Use more accurate names for the date conversion functions

[tweeper.git] / tweeper.php

diff --git a/tweeper.php b/tweeper.php
index bed6350..3e250b7 100644 (file)
--- a/tweeper.php
+++ b/tweeper.php
@@ -1,6 +1,7 @@
 <?php
 <?php

-/*
- * tweeper - a Twitter to RSS web scraper
+/**
+ * @file
+ * Tweeper - a Twitter to RSS web scraper.

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


@@ -26,44 +27,57 @@ use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 
 date_default_timezone_set('UTC');
 
 
 date_default_timezone_set('UTC');
 

+/**
+ * Scrape supported websites and perform conversion to RSS.
+ */

 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}.
+   */

   public function __construct($generate_enclosure = FALSE) {
     $this->generate_enclosure = $generate_enclosure;
   }
 
   public function __construct($generate_enclosure = FALSE) {
     $this->generate_enclosure = $generate_enclosure;
   }
 

-  public static function epoch_to_gmdate($timestamp)
-  {
+  /**
+   * Convert numeric Epoch to the date format expected in a RSS document.
+   */
+  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);

   }
 
   }
 

-  public static function str_to_gmdate($date)
-  {
+  /**
+   * Convert generic date string to the date format expected in a RSS document.
+   */
+  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);

   }
 
   }
 

-  private static function get_contents($url)
-  {
+  /**
+   * Get the contents from a 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,

-      CURLOPT_FOLLOWLOCATION => TRUE,  // follow http redirects to get the real URL
+      // Follow http redirects to get the real URL.
+      CURLOPT_FOLLOWLOCATION => TRUE,

       CURLOPT_RETURNTRANSFER => TRUE,
       CURLOPT_SSL_VERIFYHOST => FALSE,
       CURLOPT_SSL_VERIFYPEER => FALSE,
       CURLOPT_HTTPHEADER => array('Accept-language: en'),
       CURLOPT_RETURNTRANSFER => TRUE,
       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);


@@ -71,17 +85,20 @@ class Tweeper {
     return $contents;
   }
 
     return $contents;
   }
 

-  private static function get_info($url)
-  {
+  /**
+   * Get the headers from a URL.
+   */
+  private static function getUrlInfo($url) {

     $ch = curl_init($url);
     curl_setopt_array($ch, array(
       CURLOPT_HEADER => TRUE,
       CURLOPT_NOBODY => TRUE,
     $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
+      // Follow http redirects to get the real URL.
+      CURLOPT_FOLLOWLOCATION => TRUE,

       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);


@@ -90,8 +107,10 @@ class Tweeper {
     return $url_info;
   }
 
     return $url_info;
   }
 

-  public static function generate_enclosure($url)
-  {
+  /**
+   * Generate an RSS <enclosure/> element.
+   */
+  public static function generateEnclosure($url) {

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


@@ -110,11 +129,11 @@ class Tweeper {
       "video/ogg",
     );
 
       "video/ogg",
     );
 

-    // The RSS specification says that the enclosure element url must be http.
+    // The RSS specification says that the enclosure element URL must be http.

     // 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) {


@@ -133,67 +152,71 @@ class Tweeper {
     return $dom->saveXML($enc);
   }
 
     return $dom->saveXML($enc);
   }
 

-  /* Mimic the message from libxml.c::php_libxml_ctx_error_level() */
-  private function log_xml_error($error) {
+  /**
+   * Mimic the message from libxml.c::php_libxml_ctx_error_level()
+   */
+  private function logXmlError($error) {

     $output = "";
 
     switch ($error->level) {
     $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;
+      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";
     }
 
     $output .= trim($error->message);
 
     if ($error->file) {
       $output .= " in $error->file";

-    } else {
+    }
+    else {

       $output .= " in Entity,";
     }
 
       $output .= " in Entity,";
     }
 

-    $output .=" line $error->line";
+    $output .= " line $error->line";

 
     error_log($output);
   }
 
 
     error_log($output);
   }
 

-  private function load_stylesheet($host) {
+  /**
+   * 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 = "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);
+    $stylesheet_contents = $this->getUrlContents($stylesheet);

 
     $xslDoc = new DOMDocument();
     $xslDoc->loadXML($stylesheet_contents);
 
     $xsltProcessor = new XSLTProcessor();
     $xsltProcessor->registerPHPFunctions();
 
     $xslDoc = new DOMDocument();
     $xslDoc->loadXML($stylesheet_contents);
 
     $xsltProcessor = new XSLTProcessor();
     $xsltProcessor->registerPHPFunctions();

-    $xsltProcessor->setParameter('', 'generateEnclosure', $this->generate_enclosure);
+    $xsltProcessor->setParameter('', 'generate-enclosure', $this->generate_enclosure);

     $xsltProcessor->importStylesheet($xslDoc);
 
     return $xsltProcessor;
   }
 
     $xsltProcessor->importStylesheet($xslDoc);
 
     return $xsltProcessor;
   }
 

-  private function json_to_xml($html, $json_match_expr, $rootName) {
-    // pre-process, convert json to XML
-    $ret = preg_match($json_match_expr, $html, $matches);
-    if ($ret !== 1) {
-      trigger_error("Cannot match expression: $json_match_expr\n", E_USER_ERROR);
-      return NULL;
-    }
-
-    // Apparenty the ObjectNormalizer used afterwards is not able to handle
+  /**
+   * Convert json to xml.
+   */
+  private 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
     // the stdClass object created by json_decode() with the default setting

-    // $assoc = false; so use $assoc = true 
-    $data = json_decode($matches[1], $assoc = true);
+    // $assoc = false; so use $assoc = true.
+    $data = json_decode($json, $assoc = TRUE);

     if (!$data) {
       return NULL;
     }
     if (!$data) {
       return NULL;
     }


@@ -202,10 +225,10 @@ class Tweeper {
     $normalizer = new ObjectNormalizer();
     $serializer = new Serializer(array($normalizer), array($encoder));
 
     $normalizer = new ObjectNormalizer();
     $serializer = new Serializer(array($normalizer), array($encoder));
 

-    $serializer_options = array (
+    $serializer_options = array(

       'xml_encoding' => "UTF-8",
       'xml_format_output' => TRUE,
       'xml_encoding' => "UTF-8",
       'xml_format_output' => TRUE,

-      'xml_root_node_name' => $rootName,
+      'xml_root_node_name' => $root_node_name,

     );
 
     $xml_data = $serializer->serialize($data, 'xml', $serializer_options);
     );
 
     $xml_data = $serializer->serialize($data, 'xml', $serializer_options);


@@ -217,33 +240,51 @@ class Tweeper {
     return $xml_data;
   }
 
     return $xml_data;
   }
 

+  /**
+   * Convert the Instagram content to XML.
+   */

   private function get_xml_instagram_com($html) {
   private function get_xml_instagram_com($html) {

-    return $this->json_to_xml($html, '/window._sharedData = (.*);/', 'instagram');
+    // Extract the json data from the html code.
+    $json_match_expr = '/window._sharedData = (.*);/';
+    $ret = preg_match($json_match_expr, $html, $matches);
+    if ($ret !== 1) {
+      trigger_error("Cannot match expression: $json_match_expr\n", E_USER_ERROR);
+      return NULL;
+    }
+
+    return $this->jsonToXml($matches[1], 'instagram');

   }
 
   }
 

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

   private function preprocess_html_facebook_com($html) {
     $html = str_replace('<!--', '', $html);
     $html = str_replace('-->', '', $html);
     return $html;
   }
 
   private function preprocess_html_facebook_com($html) {
     $html = str_replace('<!--', '', $html);
     $html = str_replace('-->', '', $html);
     return $html;
   }
 

-  private function html_to_xml($html, $host) {
+  /**
+   * Convert the HTML retrieved from the site to XML.
+   */
+  private function htmlToXml($html, $host) {

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

-    $xml_errors_value = libxml_use_internal_errors(true);
+    $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 (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 there is a host-specific method to get the xml data, use it!
     $get_xml_host_method = 'get_xml_' . str_replace(".", "_", $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);

-    } else {
+    }
+    else {

       $xmlDoc->loadHTML($html);
     }
 
     foreach (libxml_get_errors() as $xml_error) {
       $xmlDoc->loadHTML($html);
     }
 
     foreach (libxml_get_errors() as $xml_error) {

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

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


@@ -251,22 +292,25 @@ class Tweeper {
     return $xmlDoc;
   }
 
     return $xmlDoc;
   }
 

+  /**
+   * Convert the site content to RSS.
+   */

   public function tweep($src_url) {
     $url = parse_url($src_url);
     if (FALSE === $url || empty($url["host"])) {
   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);
+      trigger_error("Invalid URL: $src_url", E_USER_ERROR);

       return NULL;
     }
 
       return NULL;
     }
 

-    // Strip the leading www. to be more forgiving on input URLs
+    // Strip the leading www. to be more forgiving on input URLs.

     $host = preg_replace('/^www\./', '', $url["host"]);
 
     $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 = $this->getUrlContents($src_url);

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


@@ -276,7 +320,7 @@ class Tweeper {
       $html = call_user_func_array(array($this, $preprocess_html_host_method), array($html));
     }
 
       $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;
     }


@@ -289,46 +333,57 @@ class Tweeper {
     }
     return $output;
   }
     }
     return $output;
   }

+

 }
 
 }
 

-function is_cli()
-{
+/**
+ * Check if the script is being run from the command line.
+ */
+function is_cli() {

   return (php_sapi_name() === "cli");
 }
 
   return (php_sapi_name() === "cli");
 }
 

-function usage($argv)
-{
+/**
+ * Show the script usage.
+ */
+function usage($argv) {

   if (is_cli()) {
     $usage = "{$argv[0]} [-e|-h|--help] <src_url>\n";
   if (is_cli()) {
     $usage = "{$argv[0]} [-e|-h|--help] <src_url>\n";

-  } else {
+  }
+  else {

     $usage = htmlentities("{$_SERVER['SCRIPT_NAME']}?src_url=<src_url>&generate_enclosure=<0|1>");
   }
 
   return "usage: $usage";
 }
 
     $usage = htmlentities("{$_SERVER['SCRIPT_NAME']}?src_url=<src_url>&generate_enclosure=<0|1>");
   }
 
   return "usage: $usage";
 }
 

-function parse_options_cli($argv, $argc)
-{
+/**
+ * Parse command line options.
+ */
+function parse_options_cli($argv, $argc) {

   $options = array(
   $options = array(

-    'generate_enclosure' => FALSE
+    'generate_enclosure' => FALSE,

   );
 
   );
 

-  if ($argc < 2)
+  if ($argc < 2) {

     return $options;
     return $options;

+  }

 
   $cli_options = getopt("eh", array("help"));
   foreach ($cli_options as $opt => $val) {
     switch ($opt) {
 
   $cli_options = getopt("eh", array("help"));
   foreach ($cli_options as $opt => $val) {
     switch ($opt) {

-    case 'e':
-      $options['generate_enclosure'] = TRUE;
-      break;
-    case 'h':
-    case 'help':
-      echo usage($argv);
-      exit(0);
-    default:
-      fwrite(STDERR, usage($argv));
-      exit(1);
+      case 'e':
+        $options['generate_enclosure'] = TRUE;
+        break;
+
+      case 'h':
+      case 'help':
+        echo usage($argv);
+        exit(0);
+
+      default:
+        fwrite(STDERR, usage($argv));
+        exit(1);

     }
   }
 
     }
   }
 


@@ -337,26 +392,30 @@ function parse_options_cli($argv, $argc)
   return $options;
 }
 
   return $options;
 }
 

-function parse_options_query_string()
-{
+/**
+ * Parse options passed from a query string.
+ */
+function parse_options_query_string() {

   $options = array(
   $options = array(

-    'generate_enclosure' => FALSE
+    'generate_enclosure' => FALSE,

   );
 
   );
 

-  if (isset($_GET['src_url']))
+  if (isset($_GET['src_url'])) {

     $options['src_url'] = $_GET['src_url'];
     $options['src_url'] = $_GET['src_url'];

+  }

 
 

-  if (isset($_GET['generate_enclosure']))
+  if (isset($_GET['generate_enclosure'])) {

     $options['generate_enclosure'] = $_GET['generate_enclosure'] == 1;
     $options['generate_enclosure'] = $_GET['generate_enclosure'] == 1;

+  }

 
   return $options;
 }
 
 
   return $options;
 }
 

-

 if (is_cli()) {
   $options = parse_options_cli($argv, $argc);
   $ERROR_STREAM = fopen('php://stderr', 'w');
 if (is_cli()) {
   $options = parse_options_cli($argv, $argc);
   $ERROR_STREAM = fopen('php://stderr', 'w');

-} else {
+}
+else {

   $options = parse_options_query_string();
   $ERROR_STREAM = fopen('php://output', 'w');
 }
   $options = parse_options_query_string();
   $ERROR_STREAM = fopen('php://output', 'w');
 }