src/Protocol/Feed.php

   1 <?php
   2 /**
   3  * @file src/Protocol/Feed.php
   4  * @brief Imports RSS/RDF/Atom feeds
   5  *
   6  */
   7 namespace Friendica\Protocol;
   8
   9 use Friendica\Database\DBM;
  10 use Friendica\Core\System;
  11 use Friendica\Model\Item;
  12 use Friendica\Util\Network;
  13 use dba;
  14 use DOMDocument;
  15 use DOMXPath;
  16
  17 require_once 'include/dba.php';
  18 require_once 'include/html2bbcode.php';
  19 require_once 'include/items.php';
  20
  21 /**
  22  * @brief This class contain functions to import feeds
  23  *
  24  */
  25 class Feed {
  26         /**
  27          * @brief Read a RSS/RDF/Atom feed and create an item entry for it
  28          *
  29          * @param string $xml The feed data
  30          * @param array $importer The user record of the importer
  31          * @param array $contact The contact record of the feed
  32          * @param string $hub Unused dummy value for compatibility reasons
  33          * @param bool $simulate If enabled, no data is imported
  34          *
  35          * @return array In simulation mode it returns the header and the first item
  36          */
  37         public static function import($xml, $importer, &$contact, &$hub, $simulate = false) {
  38
  39                 $a = get_app();
  40
  41                 if (!$simulate) {
  42                         logger("Import Atom/RSS feed '".$contact["name"]."' (Contact ".$contact["id"].") for user ".$importer["uid"], LOGGER_DEBUG);
  43                 } else {
  44                         logger("Test Atom/RSS feed", LOGGER_DEBUG);
  45                 }
  46                 if ($xml == "") {
  47                         logger('XML is empty.', LOGGER_DEBUG);
  48                         return;
  49                 }
  50
  51                 if (!empty($contact['poll'])) {
  52                         $basepath = $contact['poll'];
  53                 } elseif (!empty($contact['url'])) {
  54                         $basepath = $contact['url'];
  55                 } else {
  56                         $basepath = '';
  57                 }
  58
  59                 $doc = new DOMDocument();
  60                 @$doc->loadXML(trim($xml));
  61                 $xpath = new DOMXPath($doc);
  62                 $xpath->registerNamespace('atom', NAMESPACE_ATOM1);
  63                 $xpath->registerNamespace('dc', "http://purl.org/dc/elements/1.1/");
  64                 $xpath->registerNamespace('content', "http://purl.org/rss/1.0/modules/content/");
  65                 $xpath->registerNamespace('rdf', "http://www.w3.org/1999/02/22-rdf-syntax-ns#");
  66                 $xpath->registerNamespace('rss', "http://purl.org/rss/1.0/");
  67                 $xpath->registerNamespace('media', "http://search.yahoo.com/mrss/");
  68                 $xpath->registerNamespace('poco', NAMESPACE_POCO);
  69
  70                 $author = [];
  71                 $entries = null;
  72
  73                 // Is it RDF?
  74                 if ($xpath->query('/rdf:RDF/rss:channel')->length > 0) {
  75                         $author["author-link"] = $xpath->evaluate('/rdf:RDF/rss:channel/rss:link/text()')->item(0)->nodeValue;
  76                         $author["author-name"] = $xpath->evaluate('/rdf:RDF/rss:channel/rss:title/text()')->item(0)->nodeValue;
  77
  78                         if ($author["author-name"] == "") {
  79                                 $author["author-name"] = $xpath->evaluate('/rdf:RDF/rss:channel/rss:description/text()')->item(0)->nodeValue;
  80                         }
  81                         $entries = $xpath->query('/rdf:RDF/rss:item');
  82                 }
  83
  84                 // Is it Atom?
  85                 if ($xpath->query('/atom:feed')->length > 0) {
  86                         $alternate = $xpath->query("atom:link[@rel='alternate']")->item(0)->attributes;
  87                         if (is_object($alternate)) {
  88                                 foreach ($alternate AS $attribute) {
  89                                         if ($attribute->name == "href") {
  90                                                 $author["author-link"] = $attribute->textContent;
  91                                         }
  92                                 }
  93                         }
  94
  95                         if ($author["author-link"] == "") {
  96                                 $author["author-link"] = $author["author-id"];
  97                         }
  98                         if ($author["author-link"] == "") {
  99                                 $self = $xpath->query("atom:link[@rel='self']")->item(0)->attributes;
 100                                 if (is_object($self)) {
 101                                         foreach ($self AS $attribute) {
 102                                                 if ($attribute->name == "href") {
 103                                                         $author["author-link"] = $attribute->textContent;
 104                                                 }
 105                                         }
 106                                 }
 107                         }
 108
 109                         if ($author["author-link"] == "") {
 110                                 $author["author-link"] = $xpath->evaluate('/atom:feed/atom:id/text()')->item(0)->nodeValue;
 111                         }
 112                         $author["author-avatar"] = $xpath->evaluate('/atom:feed/atom:logo/text()')->item(0)->nodeValue;
 113
 114                         $author["author-name"] = $xpath->evaluate('/atom:feed/atom:title/text()')->item(0)->nodeValue;
 115
 116                         if ($author["author-name"] == "") {
 117                                 $author["author-name"] = $xpath->evaluate('/atom:feed/atom:subtitle/text()')->item(0)->nodeValue;
 118                         }
 119                         if ($author["author-name"] == "") {
 120                                 $author["author-name"] = $xpath->evaluate('/atom:feed/atom:author/atom:name/text()')->item(0)->nodeValue;
 121                         }
 122                         $value = $xpath->evaluate('atom:author/poco:displayName/text()')->item(0)->nodeValue;
 123                         if ($value != "") {
 124                                 $author["author-name"] = $value;
 125                         }
 126                         if ($simulate) {
 127                                 $author["author-id"] = $xpath->evaluate('/atom:feed/atom:author/atom:uri/text()')->item(0)->nodeValue;
 128
 129                                 $value = $xpath->evaluate('atom:author/poco:preferredUsername/text()')->item(0)->nodeValue;
 130                                 if ($value != "") {
 131                                         $author["author-nick"] = $value;
 132                                 }
 133                                 $value = $xpath->evaluate('atom:author/poco:address/poco:formatted/text()')->item(0)->nodeValue;
 134                                 if ($value != "") {
 135                                         $author["author-location"] = $value;
 136                                 }
 137                                 $value = $xpath->evaluate('atom:author/poco:note/text()')->item(0)->nodeValue;
 138                                 if ($value != "") {
 139                                         $author["author-about"] = $value;
 140                                 }
 141                                 $avatar = $xpath->evaluate("atom:author/atom:link[@rel='avatar']")->item(0)->attributes;
 142                                 if (is_object($avatar)) {
 143                                         foreach ($avatar AS $attribute) {
 144                                                 if ($attribute->name == "href") {
 145                                                         $author["author-avatar"] = $attribute->textContent;
 146                                                 }
 147                                         }
 148                                 }
 149                         }
 150
 151                         $author["edited"] = $author["created"] = $xpath->query('/atom:feed/atom:updated/text()')->item(0)->nodeValue;
 152
 153                         $author["app"] = $xpath->evaluate('/atom:feed/atom:generator/text()')->item(0)->nodeValue;
 154
 155                         $entries = $xpath->query('/atom:feed/atom:entry');
 156                 }
 157
 158                 // Is it RSS?
 159                 if ($xpath->query('/rss/channel')->length > 0) {
 160                         $author["author-link"] = $xpath->evaluate('/rss/channel/link/text()')->item(0)->nodeValue;
 161
 162                         $author["author-name"] = $xpath->evaluate('/rss/channel/title/text()')->item(0)->nodeValue;
 163                         $author["author-avatar"] = $xpath->evaluate('/rss/channel/image/url/text()')->item(0)->nodeValue;
 164
 165                         if ($author["author-name"] == "") {
 166                                 $author["author-name"] = $xpath->evaluate('/rss/channel/copyright/text()')->item(0)->nodeValue;
 167                         }
 168                         if ($author["author-name"] == "") {
 169                                 $author["author-name"] = $xpath->evaluate('/rss/channel/description/text()')->item(0)->nodeValue;
 170                         }
 171                         $author["edited"] = $author["created"] = $xpath->query('/rss/channel/pubDate/text()')->item(0)->nodeValue;
 172
 173                         $author["app"] = $xpath->evaluate('/rss/channel/generator/text()')->item(0)->nodeValue;
 174
 175                         $entries = $xpath->query('/rss/channel/item');
 176                 }
 177
 178                 if (!$simulate) {
 179                         $author["author-link"] = $contact["url"];
 180
 181                         if ($author["author-name"] == "") {
 182                                 $author["author-name"] = $contact["name"];
 183                         }
 184                         $author["author-avatar"] = $contact["thumb"];
 185
 186                         $author["owner-link"] = $contact["url"];
 187                         $author["owner-name"] = $contact["name"];
 188                         $author["owner-avatar"] = $contact["thumb"];
 189                 }
 190
 191                 $header = [];
 192                 $header["uid"] = $importer["uid"];
 193                 $header["network"] = NETWORK_FEED;
 194                 $header["type"] = "remote";
 195                 $header["wall"] = 0;
 196                 $header["origin"] = 0;
 197                 $header["gravity"] = GRAVITY_PARENT;
 198                 $header["private"] = 2;
 199                 $header["verb"] = ACTIVITY_POST;
 200                 $header["object-type"] = ACTIVITY_OBJ_NOTE;
 201
 202                 $header["contact-id"] = $contact["id"];
 203
 204                 if (!is_object($entries)) {
 205                         logger("There are no entries in this feed.", LOGGER_DEBUG);
 206                         return;
 207                 }
 208
 209                 $items = [];
 210                 // Importing older entries first
 211                 for($i = $entries->length - 1; $i >= 0;--$i) {
 212                         $entry = $entries->item($i);
 213
 214                         $item = array_merge($header, $author);
 215
 216                         $alternate = $xpath->query("atom:link[@rel='alternate']", $entry)->item(0)->attributes;
 217                         if (!is_object($alternate)) {
 218                                 $alternate = $xpath->query("atom:link", $entry)->item(0)->attributes;
 219                         }
 220                         if (is_object($alternate)) {
 221                                 foreach ($alternate AS $attribute) {
 222                                         if ($attribute->name == "href") {
 223                                                 $item["plink"] = $attribute->textContent;
 224                                         }
 225                                 }
 226                         }
 227                         if ($item["plink"] == "") {
 228                                 $item["plink"] = $xpath->evaluate('link/text()', $entry)->item(0)->nodeValue;
 229                         }
 230                         if ($item["plink"] == "") {
 231                                 $item["plink"] = $xpath->evaluate('rss:link/text()', $entry)->item(0)->nodeValue;
 232                         }
 233
 234                         $item["uri"] = $xpath->evaluate('atom:id/text()', $entry)->item(0)->nodeValue;
 235
 236                         if ($item["uri"] == "") {
 237                                 $item["uri"] = $xpath->evaluate('guid/text()', $entry)->item(0)->nodeValue;
 238                         }
 239                         if ($item["uri"] == "") {
 240                                 $item["uri"] = $item["plink"];
 241                         }
 242
 243                         $orig_plink = $item["plink"];
 244
 245                         $item["plink"] = Network::finalUrl($item["plink"]);
 246
 247                         $item["parent-uri"] = $item["uri"];
 248
 249                         if (!$simulate) {
 250                                 $condition = ["`uid` = ? AND `uri` = ? AND `network` IN (?, ?)",
 251                                         $importer["uid"], $item["uri"], NETWORK_FEED, NETWORK_DFRN];
 252                                 $previous = dba::selectFirst('item', ['id'], $condition);
 253                                 if (DBM::is_result($previous)) {
 254                                         logger("Item with uri ".$item["uri"]." for user ".$importer["uid"]." already existed under id ".$previous["id"], LOGGER_DEBUG);
 255                                         continue;
 256                                 }
 257                         }
 258
 259                         $item["title"] = $xpath->evaluate('atom:title/text()', $entry)->item(0)->nodeValue;
 260
 261                         if ($item["title"] == "") {
 262                                 $item["title"] = $xpath->evaluate('title/text()', $entry)->item(0)->nodeValue;
 263                         }
 264                         if ($item["title"] == "") {
 265                                 $item["title"] = $xpath->evaluate('rss:title/text()', $entry)->item(0)->nodeValue;
 266                         }
 267                         $published = $xpath->query('atom:published/text()', $entry)->item(0)->nodeValue;
 268
 269                         if ($published == "") {
 270                                 $published = $xpath->query('pubDate/text()', $entry)->item(0)->nodeValue;
 271                         }
 272                         if ($published == "") {
 273                                 $published = $xpath->query('dc:date/text()', $entry)->item(0)->nodeValue;
 274                         }
 275                         $updated = $xpath->query('atom:updated/text()', $entry)->item(0)->nodeValue;
 276
 277                         if ($updated == "") {
 278                                 $updated = $published;
 279                         }
 280                         if ($published != "") {
 281                                 $item["created"] = $published;
 282                         }
 283                         if ($updated != "") {
 284                                 $item["edited"] = $updated;
 285                         }
 286                         $creator = $xpath->query('author/text()', $entry)->item(0)->nodeValue;
 287
 288                         if ($creator == "") {
 289                                 $creator = $xpath->query('atom:author/atom:name/text()', $entry)->item(0)->nodeValue;
 290                         }
 291                         if ($creator == "") {
 292                                 $creator = $xpath->query('dc:creator/text()', $entry)->item(0)->nodeValue;
 293                         }
 294                         if ($creator != "") {
 295                                 $item["author-name"] = $creator;
 296                         }
 297                         $creator = $xpath->query('dc:creator/text()', $entry)->item(0)->nodeValue;
 298
 299                         if ($creator != "") {
 300                                 $item["author-name"] = $creator;
 301                         }
 302
 303                         /// @TODO ?
 304                         // <category>Ausland</category>
 305                         // <media:thumbnail width="152" height="76" url="http://www.taz.de/picture/667875/192/14388767.jpg"/>
 306
 307                         $attachments = [];
 308
 309                         $enclosures = $xpath->query("enclosure|atom:link[@rel='enclosure']", $entry);
 310                         foreach ($enclosures AS $enclosure) {
 311                                 $href = "";
 312                                 $length = "";
 313                                 $type = "";
 314                                 $title = "";
 315
 316                                 foreach ($enclosure->attributes AS $attribute) {
 317                                         if (in_array($attribute->name, ["url", "href"])) {
 318                                                 $href = $attribute->textContent;
 319                                         } elseif ($attribute->name == "length") {
 320                                                 $length = $attribute->textContent;
 321                                         } elseif ($attribute->name == "type") {
 322                                                 $type = $attribute->textContent;
 323                                         }
 324                                 }
 325                                 if (strlen($item["attach"])) {
 326                                         $item["attach"] .= ',';
 327                                 }
 328
 329                                 $attachments[] = ["link" => $href, "type" => $type, "length" => $length];
 330
 331                                 $item["attach"] .= '[attach]href="'.$href.'" length="'.$length.'" type="'.$type.'"[/attach]';
 332                         }
 333
 334                         $tags = '';
 335                         $categories = $xpath->query("category", $entry);
 336                         foreach ($categories AS $category) {
 337                                 $hashtag = $category->nodeValue;
 338                                 if ($tags != '') {
 339                                         $tags .= ', ';
 340                                 }
 341
 342                                 $taglink = "#[url=" . System::baseUrl() . "/search?tag=" . rawurlencode($hashtag) . "]" . $hashtag . "[/url]";
 343                                 $tags .= $taglink;
 344                         }
 345
 346                         $body = trim($xpath->evaluate('atom:content/text()', $entry)->item(0)->nodeValue);
 347
 348                         if ($body == "") {
 349                                 $body = trim($xpath->evaluate('content:encoded/text()', $entry)->item(0)->nodeValue);
 350                         }
 351                         if ($body == "") {
 352                                 $body = trim($xpath->evaluate('description/text()', $entry)->item(0)->nodeValue);
 353                         }
 354                         if ($body == "") {
 355                                 $body = trim($xpath->evaluate('atom:summary/text()', $entry)->item(0)->nodeValue);
 356                         }
 357
 358                         // remove the content of the title if it is identically to the body
 359                         // This helps with auto generated titles e.g. from tumblr
 360                         if (self::titleIsBody($item["title"], $body)) {
 361                                 $item["title"] = "";
 362                         }
 363                         $item["body"] = html2bbcode($body, $basepath);
 364
 365                         if (($item["body"] == '') && ($item["title"] != '')) {
 366                                 $item["body"] = $item["title"];
 367                                 $item["title"] = '';
 368                         }
 369
 370                         $preview = '';
 371                         if (!empty($contact["fetch_further_information"]) && ($contact["fetch_further_information"] < 3)) {
 372                                 // Handle enclosures and treat them as preview picture
 373                                 foreach ($attachments AS $attachment) {
 374                                         if ($attachment["type"] == "image/jpeg") {
 375                                                 $preview = $attachment["link"];
 376                                         }
 377                                 }
 378
 379                                 // Remove a possible link to the item itself
 380                                 $item["body"] = str_replace($item["plink"], '', $item["body"]);
 381                                 $item["body"] = preg_replace('/\[url\=\](\w+.*?)\[\/url\]/i', '', $item["body"]);
 382
 383                                 // Replace the content when the title is longer than the body
 384                                 $replace = (strlen($item["title"]) > strlen($item["body"]));
 385
 386                                 // Replace it, when there is an image in the body
 387                                 if (strstr($item["body"], '[/img]')) {
 388                                         $replace = true;
 389                                 }
 390
 391                                 // Replace it, when there is a link in the body
 392                                 if (strstr($item["body"], '[/url]')) {
 393                                         $replace = true;
 394                                 }
 395
 396                                 if ($replace) {
 397                                         $item["body"] = $item["title"];
 398                                 }
 399                                 // We always strip the title since it will be added in the page information
 400                                 $item["title"] = "";
 401                                 $item["body"] = $item["body"].add_page_info($item["plink"], false, $preview, ($contact["fetch_further_information"] == 2), $contact["ffi_keyword_blacklist"]);
 402                                 $item["tag"] = add_page_keywords($item["plink"], $preview, ($contact["fetch_further_information"] == 2), $contact["ffi_keyword_blacklist"]);
 403                                 $item["object-type"] = ACTIVITY_OBJ_BOOKMARK;
 404                                 unset($item["attach"]);
 405                         } else {
 406                                 if ($contact["fetch_further_information"] == 3) {
 407                                         if (!empty($tags)) {
 408                                                 $item["tag"] = $tags;
 409                                         } else {
 410                                                 // @todo $preview is never set in this case, is it intended? - @MrPetovan 2018-02-13
 411                                                 $item["tag"] = add_page_keywords($item["plink"], $preview, true, $contact["ffi_keyword_blacklist"]);
 412                                         }
 413                                         $item["body"] .= "\n".$item['tag'];
 414                                 }
 415                                 // Add the link to the original feed entry if not present in feed
 416                                 if (($item['plink'] != '') && !strstr($item["body"], $item['plink'])) {
 417                                         $item["body"] .= "[hr][url]".$item['plink']."[/url]";
 418                                 }
 419                         }
 420
 421                         if (!$simulate) {
 422                                 logger("Stored feed: ".print_r($item, true), LOGGER_DEBUG);
 423
 424                                 $notify = Item::isRemoteSelf($contact, $item);
 425
 426                                 // Distributed items should have a well formatted URI.
 427                                 // Additionally we have to avoid conflicts with identical URI between imported feeds and these items.
 428                                 if ($notify) {
 429                                         $item['guid'] = Item::guidFromUri($orig_plink, $a->get_hostname());
 430                                         unset($item['uri']);
 431                                         unset($item['parent-uri']);
 432                                 }
 433
 434                                 $id = Item::insert($item, false, $notify);
 435
 436                                 logger("Feed for contact ".$contact["url"]." stored under id ".$id);
 437                         } else {
 438                                 $items[] = $item;
 439                         }
 440                         if ($simulate) {
 441                                 break;
 442                         }
 443                 }
 444
 445                 if ($simulate) {
 446                         return ["header" => $author, "items" => $items];
 447                 }
 448         }
 449
 450         private static function titleIsBody($title, $body)
 451         {
 452                 $title = strip_tags($title);
 453                 $title = trim($title);
 454                 $title = html_entity_decode($title, ENT_QUOTES, 'UTF-8');
 455                 $title = str_replace(["\n", "\r", "\t", " "], ["", "", "", ""], $title);
 456
 457                 $body = strip_tags($body);
 458                 $body = trim($body);
 459                 $body = html_entity_decode($body, ENT_QUOTES, 'UTF-8');
 460                 $body = str_replace(["\n", "\r", "\t", " "], ["", "", "", ""], $body);
 461
 462                 if (strlen($title) < strlen($body)) {
 463                         $body = substr($body, 0, strlen($title));
 464                 }
 465
 466                 if (($title != $body) && (substr($title, -3) == "...")) {
 467                         $pos = strrpos($title, "...");
 468                         if ($pos > 0) {
 469                                 $title = substr($title, 0, $pos);
 470                                 $body = substr($body, 0, $pos);
 471                         }
 472                 }
 473                 return ($title == $body);
 474         }
 475 }