projects / tweeper.git / blobdiff
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Add option to enable or disable showing verbose output
[tweeper.git] / tweeper.php
diff --git a/tweeper.php b/tweeper.php
index 17fff8b..49ffb92 100644 (file)
--- a/tweeper.php
+++ b/tweeper.php
@@ -1,8 +1,10 @@
 <?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-2018  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
  *
  * 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
@@ -18,255 +20,154 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-date_default_timezone_set('UTC');
-
-class Tweeper {
-
-  private static $USER_AGENT = "Mozilla/5.0 (Windows NT 6.1; rv:22.0) Gecko/20130405 Firefox/22.0";
-
-  public function __construct($generate_enclosure = FALSE) {
-    $this->generate_enclosure = $generate_enclosure;
-  }
-
-  public static function epoch_to_gmdate($timestamp)
-  {
-    return gmdate('D, d M Y H:i:s', $timestamp) . ' GMT';
-  }
-
-  public static function str_to_gmdate($date)
-  {
-    $timestamp = strtotime($date);
-    return Tweeper::epoch_to_gmdate($timestamp);
-  }
-
-  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);
-
-    return $contents;
-  }
-
-  private static function get_info($url)
-  {
-    $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,
-    ));
-    curl_exec($ch);
-    $url_info = curl_getinfo($ch);
-    curl_close($ch);
-
-    return $url_info;
-  }
-
-  public static function generate_enclosure($url)
-  {
-    $supported_content_types = array(
-      "application/ogg",
-      "audio/aac",
-      "audio/mp4",
-      "audio/mpeg",
-      "audio/ogg",
-      "audio/vorbis",
-      "audio/wav",
-      "audio/webm",
-      "audio/x-midi",
-      "image/gif",
-      "image/jpeg",
-      "video/avi",
-      "video/mp4",
-      "video/mpeg",
-      "video/ogg",
-    );
-
-    $url_info = Tweeper::get_info($url);
-
-    $supported = in_array($url_info['content_type'], $supported_content_types);
-    if (!$supported) {
-      error_log("Unsupported enclosure content type \"" . $url_info['content_type'] . "\" for URL: " . $url_info['url']);
-      return '';
-    }
-
-    $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']);
-
-    $dom->appendChild($enc);
-
-    return $dom->saveXML($enc);
-  }
-
-  /* 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;
-    }
+require_once 'autoload.php';
 
 
-    $stylesheet_contents = $this->get_contents($stylesheet);
+use Tweeper\Tweeper;
 
 
-    $xslDoc = new DOMDocument();
-    $xslDoc->loadXML($stylesheet_contents);
+date_default_timezone_set('UTC');
 
 
-    $xsltProcessor = new XSLTProcessor();
-    $xsltProcessor->registerPHPFunctions();
-    $xsltProcessor->setParameter('', 'generateEnclosure', $this->generate_enclosure);
-    $xsltProcessor->importStylesheet($xslDoc);
+/**
+ * Check if the script is being run from the command line.
+ */
+function is_cli() {
+  return (php_sapi_name() === "cli");
+}
 
 
-    return $xsltProcessor;
+/**
+ * Show the script usage.
+ */
+function usage($argv) {
+  if (is_cli()) {
+    $usage = "{$argv[0]} [-e|-m <0|1>|-u <0|1>|-v <0|1>|-h|--help] <src_url>\n";
   }
   }
-
-  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;
-    }
-
-    $xsltProcessor = $this->load_stylesheet($url["host"]);
-    if (NULL === $xsltProcessor) {
-      return NULL;
-    }
-
-    $html = Tweeper::get_contents($src_url);
-
-    $xmlDoc = new DOMDocument();
-
-    // Handle warnings and errors when loading invalid HTML.
-    $xml_errors_value = libxml_use_internal_errors(true);
-    $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);
-
-    $output = $xsltProcessor->transformToXML($xmlDoc);
-
-    if (FALSE === $output) {
-      trigger_error('XSL transformation failed.', E_USER_ERROR);
-      return NULL;
-    }
-    return $output;
+  else {
+    $usage = htmlentities("{$_SERVER['SCRIPT_NAME']}?src_url=<src_url>&generate_enclosure=<0|1>&show_usernames=<0|1>&show_multimedia=<0|1>&verbose_output=<0|1>");
   }
   }
-}
-
-function usage($argv)
-{
-  if (php_sapi_name() != 'cli')
-    $usage = htmlentities("{$_SERVER['SCRIPT_NAME']}?src_url=<src_url>&generate_enclosure=<0|1>");
-  else
-    $usage = "{$argv[0]} [-e|-h|--help] <src_url>\n";
 
   return "usage: $usage";
 }
 
 
   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,
+    'show_usernames' => TRUE,
+    'show_multimedia' => TRUE,
+    'verbose_output' => TRUE,
   );
 
   );
 
-  if ($argc < 2)
+  if ($argc < 2) {
     return $options;
     return $options;
+  }
 
 
-  $cli_options = getopt("eh", array("help"));
+  $cli_options = getopt("em:u:v:h", array("help"));
   foreach ($cli_options as $opt => $val) {
     switch ($opt) {
   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 'm':
+        $ret = filter_var($val, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
+        if (NULL === $ret) {
+          fwrite(STDERR, "Invalid argument for the -m option.\n");
+          fwrite(STDERR, usage($argv));
+          exit(1);
+        }
+        $options['show_multimedia'] = $val;
+        break;
+
+      case 'u':
+        $ret = filter_var($val, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
+        if (NULL === $ret) {
+          fwrite(STDERR, "Invalid argument for the -u option.\n");
+          fwrite(STDERR, usage($argv));
+          exit(1);
+        }
+        $options['show_usernames'] = $val;
+        break;
+
+      case 'v':
+        $ret = filter_var($val, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
+        if (NULL === $ret) {
+          fwrite(STDERR, "Invalid argument for the -v option.\n");
+          fwrite(STDERR, usage($argv));
+          exit(1);
+        }
+        $options['verbose_output'] = $val;
+        break;
+
+      case 'h':
+      case 'help':
+        echo usage($argv);
+        exit(0);
+
+      default:
+        fwrite(STDERR, usage($argv));
+        exit(1);
     }
   }
 
     }
   }
 
-  $options['src_url'] = $argv[count($cli_options) + 1];
+  // For now assume that the URL is the lest argument, in the future we could
+  // switch to PHP >= 7.1 and use the $optind argument of getopt().
+  $options['src_url'] = array_pop($argv);
 
   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,
+    'show_usernames' => TRUE,
+    'show_multimedia' => TRUE,
+    'verbose_output' => TRUE,
   );
 
   );
 
-  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;
+  }
+
+  if (isset($_GET['show_multimedia'])) {
+    $options['show_multimedia'] = $_GET['show_multimedia'] != 0;
+  }
+
+  if (isset($_GET['show_usernames'])) {
+    $options['show_usernames'] = $_GET['show_usernames'] != 0;
+  }
+
+  if (isset($_GET['verbose_output'])) {
+    $options['verbose_output'] = $_GET['verbose_output'] != 0;
+  }
 
   return $options;
 }
 
 
   return $options;
 }
 
-
-if (php_sapi_name() != 'cli') {
-  $options = parse_options_query_string();
-  $ERROR_STREAM = fopen('php://output', 'w');
-} else {
+if (is_cli()) {
   $options = parse_options_cli($argv, $argc);
   $options = parse_options_cli($argv, $argc);
-  $ERROR_STREAM = fopen('php://stderr', 'w');
+  $error_stream = fopen('php://stderr', 'w');
+}
+else {
+  $options = parse_options_query_string();
+  $error_stream = fopen('php://output', 'w');
 }
 
 if (!isset($options['src_url'])) {
 }
 
 if (!isset($options['src_url'])) {
-  fwrite($ERROR_STREAM, usage($argv));
+  fwrite($error_stream, usage(is_cli() ? $argv : NULL));
   exit(1);
 }
 
   exit(1);
 }
 
-$tweeper = new Tweeper($options['generate_enclosure']);
-echo $tweeper->tweep($options['src_url']);
+$tweeper = new Tweeper($options['generate_enclosure'], $options['show_usernames'], $options['show_multimedia'], $options['verbose_output']);
+$output = $tweeper->tweep($options['src_url']);
+if (is_null($output)) {
+  exit(1);
+}
+echo $output;
A web scraper to convert supported websites, like Twitter.com, to RSS