src/Tweeper.php: harmonize error messages

[tweeper.git] / src / Tweeper.php

diff --git a/src/Tweeper.php b/src/Tweeper.php
index 8ac2fe3..7318900 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-2016  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


@@ -36,13 +36,21 @@ date_default_timezone_set('UTC');
  */
 class Tweeper {
 
  */
 class Tweeper {
 

-  private static $userAgent = "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; WOW64; rv:60.0) Gecko/20100101 Firefox/60.0";

 
   /**
 
   /**

-   * Constructor sets up {@link $generate_enclosure}.
+   * Create a new Tweeper object controlling optional settings.
+   *
+   * @param bool $generate_enclosure
+   *   Enables the creation of <enclosure/> elements (disabled by default).
+   * @param bool $show_usernames
+   *   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).

    */
    */

-  public function __construct($generate_enclosure = FALSE) {
+  public function __construct($generate_enclosure = FALSE, $show_usernames = TRUE) {

     $this->generate_enclosure = $generate_enclosure;
     $this->generate_enclosure = $generate_enclosure;

+    $this->show_usernames = $show_usernames;

   }
 
   /**
   }
 
   /**


@@ -94,7 +102,7 @@ class Tweeper {
     ));
     $contents = curl_exec($ch);
     if (FALSE === $contents) {
     ));
     $contents = curl_exec($ch);
     if (FALSE === $contents) {

-      trigger_error(curl_error($ch));
+      trigger_error(curl_error($ch), E_USER_WARNING);

     }
     curl_close($ch);
 
     }
     curl_close($ch);
 


@@ -116,10 +124,17 @@ class Tweeper {
       CURLOPT_SSL_VERIFYPEER => FALSE,
       CURLOPT_USERAGENT => Tweeper::$userAgent,
     ));
       CURLOPT_SSL_VERIFYPEER => FALSE,
       CURLOPT_USERAGENT => Tweeper::$userAgent,
     ));

-    curl_exec($ch);
+
+    $ret = curl_exec($ch);
+    if (FALSE === $ret) {
+      trigger_error(curl_error($ch), E_USER_WARNING);
+      curl_close($ch);
+      return FALSE;
+    }
+

     $url_info = curl_getinfo($ch);
     if (FALSE === $url_info) {
     $url_info = curl_getinfo($ch);
     if (FALSE === $url_info) {

-      trigger_error(curl_error($ch));
+      trigger_error(curl_error($ch), E_USER_WARNING);

     }
     curl_close($ch);
 
     }
     curl_close($ch);
 


@@ -152,10 +167,14 @@ class Tweeper {
     );
 
     $url_info = Tweeper::getUrlInfo($url);
     );
 
     $url_info = Tweeper::getUrlInfo($url);

+    if (FALSE === $url_info) {
+      trigger_error("Failed to retrieve info for URL: " . $url, E_USER_WARNING);
+      return '';
+    }

 
     $supported = in_array($url_info['content_type'], $supported_content_types);
     if (!$supported) {
 
     $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']);
+      trigger_error("Unsupported enclosure content type \"" . $url_info['content_type'] . "\" for URL: " . $url_info['url'], E_USER_WARNING);

       return '';
     }
 
       return '';
     }
 


@@ -203,7 +222,7 @@ class Tweeper {
 
     $output .= " line $error->line";
 
 
     $output .= " line $error->line";
 

-    error_log($output);
+    trigger_error($output, E_USER_WARNING);

   }
 
   /**
   }
 
   /**


@@ -230,7 +249,7 @@ class Tweeper {
 
     $xml_data = $serializer->serialize($data, 'xml', $serializer_options);
     if (!$xml_data) {
 
     $xml_data = $serializer->serialize($data, 'xml', $serializer_options);
     if (!$xml_data) {

-      trigger_error("Cannot serialize data", E_USER_ERROR);
+      trigger_error("Cannot serialize data", E_USER_WARNING);

       return NULL;
     }
 
       return NULL;
     }
 


@@ -245,11 +264,23 @@ class Tweeper {
     $json_match_expr = '/window._sharedData = (.*);/';
     $ret = preg_match($json_match_expr, $html, $matches);
     if ($ret !== 1) {
     $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);
+      trigger_error("Cannot match expression: $json_match_expr\n", E_USER_WARNING);

       return NULL;
     }
 
       return NULL;
     }
 

-    return Tweeper::jsonToXml($matches[1], 'instagram');
+    $data = json_decode($matches[1], $assoc = TRUE);
+
+    // The "qe" object contains elements which will result in invalid XML
+    // element names, so remove it.
+    unset($data["qe"]);
+
+    // The "knobs" object contains elements with undefined namespaces, so
+    // remove it to silence an error message.
+    unset($data["knobs"]);
+
+    $json = json_encode($data);
+
+    return Tweeper::jsonToXml($json, 'instagram');

   }
 
   /**
   }
 
   /**


@@ -295,11 +326,14 @@ class Tweeper {
   private function loadStylesheet($host) {
     $stylesheet = "file://" . __DIR__ . "/rss_converter_" . $host . ".xsl";
     if (FALSE === file_exists($stylesheet)) {
   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);
+      trigger_error("Conversion to RSS not supported for $host ($stylesheet not found)", E_USER_WARNING);

       return NULL;
     }
 
     $stylesheet_contents = Tweeper::getUrlContents($stylesheet);
       return NULL;
     }
 
     $stylesheet_contents = Tweeper::getUrlContents($stylesheet);

+    if (FALSE === $stylesheet_contents) {
+      return NULL;
+    }

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


@@ -307,6 +341,7 @@ class Tweeper {
     $xsltProcessor = new XSLTProcessor();
     $xsltProcessor->registerPHPFunctions();
     $xsltProcessor->setParameter('', 'generate-enclosure', $this->generate_enclosure);
     $xsltProcessor = new XSLTProcessor();
     $xsltProcessor->registerPHPFunctions();
     $xsltProcessor->setParameter('', 'generate-enclosure', $this->generate_enclosure);

+    $xsltProcessor->setParameter('', 'show-usernames', $this->show_usernames);

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


@@ -318,14 +353,14 @@ class Tweeper {
   public function tweep($src_url, $host=NULL, $validate_scheme=TRUE) {
     $url = parse_url($src_url);
     if (FALSE === $url) {
   public function tweep($src_url, $host=NULL, $validate_scheme=TRUE) {
     $url = parse_url($src_url);
     if (FALSE === $url) {

-      trigger_error("Invalid URL: $src_url", E_USER_ERROR);
+      trigger_error("Invalid URL: $src_url", E_USER_WARNING);

       return NULL;
     }
 
     if (TRUE === $validate_scheme) {
       $scheme = $url["scheme"];
       if (!in_array($scheme, array("http", "https"))) {
       return NULL;
     }
 
     if (TRUE === $validate_scheme) {
       $scheme = $url["scheme"];
       if (!in_array($scheme, array("http", "https"))) {

-        trigger_error("unsupported scheme: $scheme", E_USER_ERROR);
+        trigger_error("unsupported scheme: $scheme", E_USER_WARNING);

         return NULL;
       }
     }
         return NULL;
       }
     }


@@ -333,7 +368,7 @@ class Tweeper {
     // if the host is not given derive it from the URL
     if (NULL === $host) {
       if (empty($url["host"])) {
     // if the host is not given derive it from the URL
     if (NULL === $host) {
       if (empty($url["host"])) {

-        trigger_error("Invalid host in URL: $src_url", E_USER_ERROR);
+        trigger_error("Invalid host in URL: $src_url", E_USER_WARNING);

         return NULL;
       }
       // Strip the leading www. to be more forgiving on input URLs.
         return NULL;
       }
       // Strip the leading www. to be more forgiving on input URLs.


@@ -361,11 +396,11 @@ class Tweeper {
     }
 
     $output = $xsltProcessor->transformToXML($xmlDoc);
     }
 
     $output = $xsltProcessor->transformToXML($xmlDoc);

-

     if (FALSE === $output) {
     if (FALSE === $output) {

-      trigger_error('XSL transformation failed.', E_USER_ERROR);
+      trigger_error('XSL transformation failed.', E_USER_WARNING);

       return NULL;
     }
       return NULL;
     }

+

     return $output;
   }
 
     return $output;
   }