projects / tweeper.git / blobdiff
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fix style issues pointed out by PHP_CodeSniffer
[tweeper.git] / src / Tweeper.php
diff --git a/src/Tweeper.php b/src/Tweeper.php
index b75409b..10e07e3 100644 (file)
--- a/src/Tweeper.php
+++ b/src/Tweeper.php
@@ -6,7 +6,7 @@ namespace Tweeper;
  * @file
  * Tweeper - a Twitter to RSS web scraper.
  *
  * @file
  * Tweeper - a Twitter to RSS web scraper.
  *
- * Copyright (C) 2013-2018  Antonio Ospite <ao2@ao2.it>
+ * Copyright (C) 2013-2020  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
@@ -36,7 +36,7 @@ date_default_timezone_set('UTC');
  */
 class Tweeper {
 
  */
 class Tweeper {
 
-  private static $userAgent = "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:60.0) Gecko/20100101 Firefox/60.0";
+  private static $userAgent = "Mozilla/5.0 (Linux; U; Android 4.3; en-us; SM-N900T Build/JSS15J)";
   private static $maxConnectionTimeout = 5;
   private static $maxConnectionRetries = 5;
 
   private static $maxConnectionTimeout = 5;
   private static $maxConnectionRetries = 5;
 
@@ -49,10 +49,18 @@ class Tweeper {
    *   Enables showing the username in front of the content for multi-user
    *   sites (enabled by default). Only some stylesheets supports this
    *   functionality (twitter, instagram, pump.io).
    *   Enables showing the username in front of the content for multi-user
    *   sites (enabled by default). Only some stylesheets supports this
    *   functionality (twitter, instagram, pump.io).
+   * @param bool $show_multimedia
+   *   Enables showing multimedia content (images, videos) directly in the
+   *   item description (enabled by default). Only some stylesheets supports
+   *   this functionality (twitter, instagram, dilbert).
+   * @param bool $verbose_output
+   *   Enables showing non-fatal errors like XML parsing errors.
    */
    */
-  public function __construct($generate_enclosure = FALSE, $show_usernames = TRUE) {
+  public function __construct($generate_enclosure = FALSE, $show_usernames = TRUE, $show_multimedia = TRUE, $verbose_output = TRUE) {
     $this->generate_enclosure = $generate_enclosure;
     $this->show_usernames = $show_usernames;
     $this->generate_enclosure = $generate_enclosure;
     $this->show_usernames = $show_usernames;
+    $this->show_multimedia = $show_multimedia;
+    $this->verbose_output = $verbose_output;
   }
 
   /**
   }
 
   /**
@@ -79,6 +87,46 @@ class Tweeper {
   }
 
   /**
   }
 
   /**
+   * Convert Twitter mobile date to the date format expected in a RSS document.
+   */
+  public static function twitterToRssDate($date) {
+    // Twitter uses relative timestamps in minutes for recent tweets.
+    if (preg_match('/^(\d+)m$/', $date, $matches)) {
+      $timestamp = strtotime("+" . $matches[1] . " min", time());
+      if (FALSE === $timestamp) {
+        $timestamp = 0;
+      }
+    }
+    else {
+      /*
+       * In case the time is specified put it after the date,
+       * to make it recognized by strptime().
+       */
+      if (preg_match('/(.*) - (.*)/', $date, $matches)) {
+        $date = $matches[2] . " " . $matches[1];
+      }
+
+      $timestamp = strtotime($date);
+      if (FALSE === $timestamp) {
+        $timestamp = 0;
+      }
+
+      /*
+       * The twitter mobile UI usually only specifies the month and the day, so
+       * strtotime($date) may interpret the date as being in the future.
+       *
+       * If the date is in the future it is probably in the same day but in the
+       * previous year.
+       */
+      if ($timestamp > time()) {
+        $timestamp = strtotime('-1 years', $timestamp);
+      }
+    }
+
+    return Tweeper::epochToRssDate($timestamp);
+  }
+
+  /**
    * Convert string to UpperCamelCase.
    */
   public static function toUpperCamelCase($str, $delim = ' ') {
    * Convert string to UpperCamelCase.
    */
   public static function toUpperCamelCase($str, $delim = ' ') {
@@ -111,17 +159,16 @@ class Tweeper {
    */
   private static function getUrlContents($url) {
     $ch = curl_init($url);
    */
   private static function getUrlContents($url) {
     $ch = curl_init($url);
-    curl_setopt_array($ch, array(
+    curl_setopt_array($ch, [
       CURLOPT_HEADER => FALSE,
       CURLOPT_CONNECTTIMEOUT => Tweeper::$maxConnectionTimeout,
       // Follow http redirects to get the real URL.
       CURLOPT_FOLLOWLOCATION => TRUE,
       CURLOPT_HEADER => FALSE,
       CURLOPT_CONNECTTIMEOUT => Tweeper::$maxConnectionTimeout,
       // Follow http redirects to get the real URL.
       CURLOPT_FOLLOWLOCATION => TRUE,
+      CURLOPT_COOKIEFILE => "",
       CURLOPT_RETURNTRANSFER => TRUE,
       CURLOPT_RETURNTRANSFER => TRUE,
-      CURLOPT_SSL_VERIFYHOST => FALSE,
-      CURLOPT_SSL_VERIFYPEER => FALSE,
-      CURLOPT_HTTPHEADER => array('Accept-language: en'),
+      CURLOPT_HTTPHEADER => ['Accept-language: en'],
       CURLOPT_USERAGENT => Tweeper::$userAgent,
       CURLOPT_USERAGENT => Tweeper::$userAgent,
-    ));
+    ]);
     $contents = Tweeper::curlExec($ch);
     curl_close($ch);
 
     $contents = Tweeper::curlExec($ch);
     curl_close($ch);
 
@@ -133,17 +180,15 @@ class Tweeper {
    */
   private static function getUrlInfo($url) {
     $ch = curl_init($url);
    */
   private static function getUrlInfo($url) {
     $ch = curl_init($url);
-    curl_setopt_array($ch, array(
+    curl_setopt_array($ch, [
       CURLOPT_HEADER => TRUE,
       CURLOPT_NOBODY => TRUE,
       CURLOPT_CONNECTTIMEOUT => Tweeper::$maxConnectionTimeout,
       // Follow http redirects to get the real URL.
       CURLOPT_FOLLOWLOCATION => TRUE,
       CURLOPT_RETURNTRANSFER => TRUE,
       CURLOPT_HEADER => TRUE,
       CURLOPT_NOBODY => TRUE,
       CURLOPT_CONNECTTIMEOUT => Tweeper::$maxConnectionTimeout,
       // Follow http redirects to get the real URL.
       CURLOPT_FOLLOWLOCATION => TRUE,
       CURLOPT_RETURNTRANSFER => TRUE,
-      CURLOPT_SSL_VERIFYHOST => FALSE,
-      CURLOPT_SSL_VERIFYPEER => FALSE,
       CURLOPT_USERAGENT => Tweeper::$userAgent,
       CURLOPT_USERAGENT => Tweeper::$userAgent,
-    ));
+    ]);
 
     $ret = Tweeper::curlExec($ch);
     if (FALSE === $ret) {
 
     $ret = Tweeper::curlExec($ch);
     if (FALSE === $ret) {
@@ -164,7 +209,7 @@ class Tweeper {
    * Generate an RSS <enclosure/> element.
    */
   public static function generateEnclosure($url) {
    * Generate an RSS <enclosure/> element.
    */
   public static function generateEnclosure($url) {
-    $supported_content_types = array(
+    $supported_content_types = [
       "application/octet-stream",
       "application/ogg",
       "application/pdf",
       "application/octet-stream",
       "application/ogg",
       "application/pdf",
@@ -183,7 +228,7 @@ class Tweeper {
       "video/mp4",
       "video/mpeg",
       "video/ogg",
       "video/mp4",
       "video/mpeg",
       "video/ogg",
-    );
+    ];
 
     $url_info = Tweeper::getUrlInfo($url);
     if (FALSE === $url_info) {
 
     $url_info = Tweeper::getUrlInfo($url);
     if (FALSE === $url_info) {
@@ -201,10 +246,17 @@ class Tweeper {
     // See http://sourceforge.net/p/feedvalidator/bugs/72/
     $http_url = preg_replace("/^https/", "http", $url_info['url']);
 
     // See http://sourceforge.net/p/feedvalidator/bugs/72/
     $http_url = preg_replace("/^https/", "http", $url_info['url']);
 
+    // When the server does not provide a Content-Length header,
+    // curl_getinfo() would return a negative value for
+    // "download_content_length", however RSS recommends to use 0 when the
+    // enclosure's size cannot be determined.
+    // See: https://www.feedvalidator.org/docs/error/UseZeroForUnknown.html
+    $length = max($url_info['download_content_length'], 0);
+
     $dom = new DOMDocument();
     $enc = $dom->createElement('enclosure');
     $enc->setAttribute('url', $http_url);
     $dom = new DOMDocument();
     $enc = $dom->createElement('enclosure');
     $enc->setAttribute('url', $http_url);
-    $enc->setAttribute('length', $url_info['download_content_length']);
+    $enc->setAttribute('length', $length);
     $enc->setAttribute('type', $url_info['content_type']);
 
     return $enc;
     $enc->setAttribute('type', $url_info['content_type']);
 
     return $enc;
@@ -258,13 +310,13 @@ class Tweeper {
 
     $encoder = new XmlEncoder();
     $normalizer = new ObjectNormalizer();
 
     $encoder = new XmlEncoder();
     $normalizer = new ObjectNormalizer();
-    $serializer = new Serializer(array($normalizer), array($encoder));
+    $serializer = new Serializer([$normalizer], [$encoder]);
 
 
-    $serializer_options = array(
+    $serializer_options = [
       'xml_encoding' => "UTF-8",
       'xml_format_output' => TRUE,
       'xml_root_node_name' => $root_node_name,
       'xml_encoding' => "UTF-8",
       'xml_format_output' => TRUE,
       'xml_root_node_name' => $root_node_name,
-    );
+    ];
 
     $xml_data = $serializer->serialize($data, 'xml', $serializer_options);
     if (!$xml_data) {
 
     $xml_data = $serializer->serialize($data, 'xml', $serializer_options);
     if (!$xml_data) {
@@ -323,15 +375,17 @@ class Tweeper {
     // 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)) {
     // 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));
+      $xml_data = call_user_func_array([$this, $get_xml_host_method], [$html]);
       $xmlDoc->loadXML($xml_data);
     }
     else {
       $xmlDoc->loadHTML($html);
     }
 
       $xmlDoc->loadXML($xml_data);
     }
     else {
       $xmlDoc->loadHTML($html);
     }
 
-    foreach (libxml_get_errors() as $xml_error) {
-      Tweeper::logXmlError($xml_error);
+    if ($this->verbose_output) {
+      foreach (libxml_get_errors() as $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);
@@ -362,6 +416,7 @@ class Tweeper {
     $xsltProcessor->registerPHPFunctions();
     $xsltProcessor->setParameter('', 'generate-enclosure', $this->generate_enclosure);
     $xsltProcessor->setParameter('', 'show-usernames', $this->show_usernames);
     $xsltProcessor->registerPHPFunctions();
     $xsltProcessor->setParameter('', 'generate-enclosure', $this->generate_enclosure);
     $xsltProcessor->setParameter('', 'show-usernames', $this->show_usernames);
+    $xsltProcessor->setParameter('', 'show-multimedia', $this->show_multimedia);
     $xsltProcessor->importStylesheet($xslDoc);
 
     return $xsltProcessor;
     $xsltProcessor->importStylesheet($xslDoc);
 
     return $xsltProcessor;
@@ -379,7 +434,7 @@ class Tweeper {
 
     if (TRUE === $validate_scheme) {
       $scheme = $url["scheme"];
 
     if (TRUE === $validate_scheme) {
       $scheme = $url["scheme"];
-      if (!in_array($scheme, array("http", "https"))) {
+      if (!in_array($scheme, ["http", "https"])) {
         trigger_error("unsupported scheme: $scheme", E_USER_WARNING);
         return NULL;
       }
         trigger_error("unsupported scheme: $scheme", E_USER_WARNING);
         return NULL;
       }
@@ -408,7 +463,7 @@ class Tweeper {
 
     $preprocess_html_host_method = 'preprocessHtml' . Tweeper::toUpperCamelCase($host, '.');
     if (method_exists($this, $preprocess_html_host_method)) {
 
     $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));
+      $html = call_user_func_array([$this, $preprocess_html_host_method], [$html]);
     }
 
     $xmlDoc = $this->htmlToXml($html, $host);
     }
 
     $xmlDoc = $this->htmlToXml($html, $host);
A web scraper to convert supported websites, like Twitter.com, to RSS