Add option to enable or disable showing usernames in RSS items

[tweeper.git] / src / Tweeper.php

diff --git a/src/Tweeper.php b/src/Tweeper.php
index 944b37c..cfa3812 100644 (file)
--- a/src/Tweeper.php
+++ b/src/Tweeper.php
@@ -6,7 +6,7 @@ namespace Tweeper;
  * @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
@@ -36,13 +36,21 @@ date_default_timezone_set('UTC');
  */
 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->show_usernames = $show_usernames;
   }
 
   /**
@@ -249,7 +257,19 @@ class Tweeper {
       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');
   }
 
   /**
@@ -307,6 +327,7 @@ class Tweeper {
     $xsltProcessor = new XSLTProcessor();
     $xsltProcessor->registerPHPFunctions();
     $xsltProcessor->setParameter('', 'generate-enclosure', $this->generate_enclosure);
+    $xsltProcessor->setParameter('', 'show-usernames', $this->show_usernames);
     $xsltProcessor->importStylesheet($xslDoc);
 
     return $xsltProcessor;
@@ -315,21 +336,30 @@ class Tweeper {
   /**
    * Convert the site content to RSS.
    */
-  public function tweep($src_url) {
+  public function tweep($src_url, $host=NULL, $validate_scheme=TRUE) {
     $url = parse_url($src_url);
-    if (FALSE === $url || empty($url["host"])) {
+    if (FALSE === $url) {
       trigger_error("Invalid URL: $src_url", E_USER_ERROR);
       return NULL;
     }
 
-    $scheme = $url["scheme"];
-    if (!in_array($scheme, array("http", "https"))) {
-      trigger_error("unsupported scheme: $scheme", E_USER_ERROR);
-      return NULL;
+    if (TRUE === $validate_scheme) {
+      $scheme = $url["scheme"];
+      if (!in_array($scheme, array("http", "https"))) {
+        trigger_error("unsupported scheme: $scheme", E_USER_ERROR);
+        return NULL;
+      }
     }
 
-    // Strip the leading www. to be more forgiving on input URLs.
-    $host = preg_replace('/^www\./', '', $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);
+        return NULL;
+      }
+      // Strip the leading www. to be more forgiving on input URLs.
+      $host = preg_replace('/^www\./', '', $url["host"]);
+    }
 
     $xsltProcessor = $this->loadStylesheet($host);
     if (NULL === $xsltProcessor) {
@@ -352,11 +382,11 @@ class Tweeper {
     }
 
     $output = $xsltProcessor->transformToXML($xmlDoc);
-
     if (FALSE === $output) {
       trigger_error('XSL transformation failed.', E_USER_ERROR);
       return NULL;
     }
+
     return $output;
   }