* @file
* Tweeper - a Twitter to RSS web scraper.
*
- * Copyright (C) 2013-20
18 Antonio Ospite <ao2@ao2.it>
+ * Copyright (C) 2013-20
20 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
*/
class Tweeper {
- private static $userAgent = "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:60.0) Gecko/20100101 Firefox/60.0";
+ private static $userAgent = "APIs-Google (+https://developers.google.com/webmasters/APIs-Google.html)";
private static $maxConnectionTimeout = 5;
private static $maxConnectionRetries = 5;
* 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, $show_multimedia = 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->show_multimedia = $show_multimedia;
+ $this->verbose_output = $verbose_output;
}
/**
}
} while (curl_errno($ch) == CURLE_OPERATION_TIMEDOUT && ++$attempt < Tweeper::$maxConnectionRetries);
+ $response_code = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
+ if (FALSE === $response_code) {
+ trigger_error(curl_error($ch), E_USER_WARNING);
+ return FALSE;
+ }
+
+ if ($response_code >= 400) {
+ trigger_error("HTTP reponse code $response_code", E_USER_WARNING);
+ return FALSE;
+ }
+
return $ret;
}
/**
* Get the contents from a URL.
*/
- private static function getUrlContents($url) {
+ private static function getUrlContents($url, $user_agent = NULL) {
$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_COOKIEFILE => "",
CURLOPT_RETURNTRANSFER => TRUE,
- CURLOPT_SSL_VERIFYHOST => FALSE,
- CURLOPT_SSL_VERIFYPEER => FALSE,
- CURLOPT_HTTPHEADER => array('Accept-language: en'),
- CURLOPT_USERAGENT => Tweeper::$userAgent,
- ));
+ CURLOPT_HTTPHEADER => ['Accept-language: en'],
+ CURLOPT_USERAGENT => isset($user_agent) ? $user_agent : Tweeper::$userAgent,
+ ]);
$contents = Tweeper::curlExec($ch);
curl_close($ch);
/**
* Get the headers from a URL.
*/
- private static function getUrlInfo($url) {
+ private static function getUrlInfo($url, $user_agent = NULL) {
$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_SSL_VERIFYHOST => FALSE,
- CURLOPT_SSL_VERIFYPEER => FALSE,
- CURLOPT_USERAGENT => Tweeper::$userAgent,
- ));
+ CURLOPT_USERAGENT => isset($user_agent) ? $user_agent : Tweeper::$userAgent,
+ ]);
$ret = Tweeper::curlExec($ch);
if (FALSE === $ret) {
* Generate an RSS <enclosure/> element.
*/
public static function generateEnclosure($url) {
- $supported_content_types = array(
+ $supported_content_types = [
"application/octet-stream",
"application/ogg",
"application/pdf",
"video/mp4",
"video/mpeg",
"video/ogg",
- );
+ ];
$url_info = Tweeper::getUrlInfo($url);
if (FALSE === $url_info) {
// 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);
- $enc->setAttribute('length', $url_info['download_content_length']);
+ $enc->setAttribute('length', $length);
$enc->setAttribute('type', $url_info['content_type']);
return $enc;
}
/**
+ * Generate a data URL.
+ */
+ public static function generateDataURL($url) {
+ $supported_content_types = [
+ "image/gif",
+ "image/jpeg",
+ "image/png",
+ ];
+
+ $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) {
+ trigger_error("Unsupported data URL type \"" . $url_info['content_type'] . "\" for URL: " . $url_info['url'], E_USER_WARNING);
+ return '';
+ }
+
+ $base64Data = base64_encode(file_get_contents($url));
+ $dataURL = 'data: ' . $url_info['content_type'] . ';base64,' . $base64Data;
+
+ return $dataURL;
+ }
+
+ /**
* Mimic the message from libxml.c::php_libxml_ctx_error_level()
*/
private static function logXmlError($error) {
$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_data = $serializer->serialize($data, 'xml', $serializer_options);
if (!$xml_data) {
$data = json_decode($matches[1], $assoc = TRUE);
- // The "qe" object contains elements which will result in invalid XML
- // element names, so remove it.
+ // Remove items that may contain elements which can result in invalid XML
+ // element names (for example names starting with a number).
unset($data["qe"]);
-
- // The "knobs" object contains elements with undefined namespaces, so
- // remove it to silence an error message.
- unset($data["knobs"]);
+ unset($data["knobx"]);
+ unset($data["to_cache"]);
+
+ // Stop here in case Instagram redirected to the login page, this can
+ // happen when too many consecutive requests have been made from the same
+ // IP.
+ if (array_key_exists("LoginAndSignupPage", $data["entry_data"])) {
+ trigger_error("Cannot open instagram page: redirected to Login page.\n", E_USER_WARNING);
+ return NULL;
+ }
$json = json_encode($data);
// 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]);
+ if (NULL === $xml_data) {
+ return NULL;
+ }
$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);
return NULL;
}
- $stylesheet_contents = Tweeper::getUrlContents($stylesheet);
+ $stylesheet_contents = file_get_contents($stylesheet);
if (FALSE === $stylesheet_contents) {
trigger_error("Cannot open $stylesheet", E_USER_WARNING);
return NULL;
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;
}
$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);
projects / tweeper.git / blobdiff