3 * @file src/Protocol/Feed.php
4 * @brief Imports RSS/RDF/Atom feeds
7 namespace Friendica\Protocol;
9 use Friendica\Database\DBM;
10 use Friendica\Core\System;
15 require_once 'include/dba.php';
16 require_once 'include/html2bbcode.php';
17 require_once 'include/items.php';
20 * @brief This class contain functions to import feeds
25 * @brief Read a RSS/RDF/Atom feed and create an item entry for it
27 * @param string $xml The feed data
28 * @param array $importer The user record of the importer
29 * @param array $contact The contact record of the feed
30 * @param string $hub Unused dummy value for compatibility reasons
31 * @param bool $simulate If enabled, no data is imported
33 * @return array In simulation mode it returns the header and the first item
35 public static function import($xml, $importer, &$contact, &$hub, $simulate = false) {
40 logger("Import Atom/RSS feed '".$contact["name"]."' (Contact ".$contact["id"].") for user ".$importer["uid"], LOGGER_DEBUG);
42 logger("Test Atom/RSS feed", LOGGER_DEBUG);
45 logger('XML is empty.', LOGGER_DEBUG);
49 if (!empty($contact['poll'])) {
50 $basepath = $contact['poll'];
51 } elseif (!empty($contact['url'])) {
52 $basepath = $contact['url'];
57 $doc = new DOMDocument();
58 @$doc->loadXML(trim($xml));
59 $xpath = new DOMXPath($doc);
60 $xpath->registerNamespace('atom', NAMESPACE_ATOM1);
61 $xpath->registerNamespace('dc', "http://purl.org/dc/elements/1.1/");
62 $xpath->registerNamespace('content', "http://purl.org/rss/1.0/modules/content/");
63 $xpath->registerNamespace('rdf', "http://www.w3.org/1999/02/22-rdf-syntax-ns#");
64 $xpath->registerNamespace('rss', "http://purl.org/rss/1.0/");
65 $xpath->registerNamespace('media', "http://search.yahoo.com/mrss/");
66 $xpath->registerNamespace('poco', NAMESPACE_POCO);
71 if ($xpath->query('/rdf:RDF/rss:channel')->length > 0) {
72 $author["author-link"] = $xpath->evaluate('/rdf:RDF/rss:channel/rss:link/text()')->item(0)->nodeValue;
73 $author["author-name"] = $xpath->evaluate('/rdf:RDF/rss:channel/rss:title/text()')->item(0)->nodeValue;
75 if ($author["author-name"] == "") {
76 $author["author-name"] = $xpath->evaluate('/rdf:RDF/rss:channel/rss:description/text()')->item(0)->nodeValue;
78 $entries = $xpath->query('/rdf:RDF/rss:item');
82 if ($xpath->query('/atom:feed')->length > 0) {
83 $alternate = $xpath->query("atom:link[@rel='alternate']")->item(0)->attributes;
84 if (is_object($alternate)) {
85 foreach ($alternate AS $attributes) {
86 if ($attributes->name == "href") {
87 $author["author-link"] = $attributes->textContent;
92 if ($author["author-link"] == "") {
93 $author["author-link"] = $author["author-id"];
95 if ($author["author-link"] == "") {
96 $self = $xpath->query("atom:link[@rel='self']")->item(0)->attributes;
97 if (is_object($self)) {
98 foreach ($self AS $attributes) {
99 if ($attributes->name == "href") {
100 $author["author-link"] = $attributes->textContent;
106 if ($author["author-link"] == "") {
107 $author["author-link"] = $xpath->evaluate('/atom:feed/atom:id/text()')->item(0)->nodeValue;
109 $author["author-avatar"] = $xpath->evaluate('/atom:feed/atom:logo/text()')->item(0)->nodeValue;
111 $author["author-name"] = $xpath->evaluate('/atom:feed/atom:title/text()')->item(0)->nodeValue;
113 if ($author["author-name"] == "") {
114 $author["author-name"] = $xpath->evaluate('/atom:feed/atom:subtitle/text()')->item(0)->nodeValue;
116 if ($author["author-name"] == "") {
117 $author["author-name"] = $xpath->evaluate('/atom:feed/atom:author/atom:name/text()')->item(0)->nodeValue;
119 $value = $xpath->evaluate('atom:author/poco:displayName/text()')->item(0)->nodeValue;
121 $author["author-name"] = $value;
124 $author["author-id"] = $xpath->evaluate('/atom:feed/atom:author/atom:uri/text()')->item(0)->nodeValue;
126 $value = $xpath->evaluate('atom:author/poco:preferredUsername/text()')->item(0)->nodeValue;
128 $author["author-nick"] = $value;
130 $value = $xpath->evaluate('atom:author/poco:address/poco:formatted/text()')->item(0)->nodeValue;
132 $author["author-location"] = $value;
134 $value = $xpath->evaluate('atom:author/poco:note/text()')->item(0)->nodeValue;
136 $author["author-about"] = $value;
138 $avatar = $xpath->evaluate("atom:author/atom:link[@rel='avatar']")->item(0)->attributes;
139 if (is_object($avatar)) {
140 foreach ($avatar AS $attributes) {
141 if ($attributes->name == "href") {
142 $author["author-avatar"] = $attributes->textContent;
148 $author["edited"] = $author["created"] = $xpath->query('/atom:feed/atom:updated/text()')->item(0)->nodeValue;
150 $author["app"] = $xpath->evaluate('/atom:feed/atom:generator/text()')->item(0)->nodeValue;
152 $entries = $xpath->query('/atom:feed/atom:entry');
156 if ($xpath->query('/rss/channel')->length > 0) {
157 $author["author-link"] = $xpath->evaluate('/rss/channel/link/text()')->item(0)->nodeValue;
159 $author["author-name"] = $xpath->evaluate('/rss/channel/title/text()')->item(0)->nodeValue;
160 $author["author-avatar"] = $xpath->evaluate('/rss/channel/image/url/text()')->item(0)->nodeValue;
162 if ($author["author-name"] == "") {
163 $author["author-name"] = $xpath->evaluate('/rss/channel/copyright/text()')->item(0)->nodeValue;
165 if ($author["author-name"] == "") {
166 $author["author-name"] = $xpath->evaluate('/rss/channel/description/text()')->item(0)->nodeValue;
168 $author["edited"] = $author["created"] = $xpath->query('/rss/channel/pubDate/text()')->item(0)->nodeValue;
170 $author["app"] = $xpath->evaluate('/rss/channel/generator/text()')->item(0)->nodeValue;
172 $entries = $xpath->query('/rss/channel/item');
176 $author["author-link"] = $contact["url"];
178 if ($author["author-name"] == "") {
179 $author["author-name"] = $contact["name"];
181 $author["author-avatar"] = $contact["thumb"];
183 $author["owner-link"] = $contact["url"];
184 $author["owner-name"] = $contact["name"];
185 $author["owner-avatar"] = $contact["thumb"];
189 $header["uid"] = $importer["uid"];
190 $header["network"] = NETWORK_FEED;
191 $header["type"] = "remote";
193 $header["origin"] = 0;
194 $header["gravity"] = GRAVITY_PARENT;
195 $header["private"] = 2;
196 $header["verb"] = ACTIVITY_POST;
197 $header["object-type"] = ACTIVITY_OBJ_NOTE;
199 $header["contact-id"] = $contact["id"];
201 if (!strlen($contact["notify"])) {
202 // one way feed - no remote comment ability
203 $header["last-child"] = 0;
206 if (!is_object($entries)) {
207 logger("There are no entries in this feed.", LOGGER_DEBUG);
213 $entrylist = array();
215 foreach ($entries AS $entry) {
216 $entrylist[] = $entry;
218 foreach (array_reverse($entrylist) AS $entry) {
219 $item = array_merge($header, $author);
221 $alternate = $xpath->query("atom:link[@rel='alternate']", $entry)->item(0)->attributes;
222 if (!is_object($alternate)) {
223 $alternate = $xpath->query("atom:link", $entry)->item(0)->attributes;
225 if (is_object($alternate)) {
226 foreach ($alternate AS $attributes) {
227 if ($attributes->name == "href") {
228 $item["plink"] = $attributes->textContent;
232 if ($item["plink"] == "") {
233 $item["plink"] = $xpath->evaluate('link/text()', $entry)->item(0)->nodeValue;
235 if ($item["plink"] == "") {
236 $item["plink"] = $xpath->evaluate('rss:link/text()', $entry)->item(0)->nodeValue;
239 $item["uri"] = $xpath->evaluate('atom:id/text()', $entry)->item(0)->nodeValue;
241 if ($item["uri"] == "") {
242 $item["uri"] = $xpath->evaluate('guid/text()', $entry)->item(0)->nodeValue;
244 if ($item["uri"] == "") {
245 $item["uri"] = $item["plink"];
248 $orig_plink = $item["plink"];
250 $item["plink"] = original_url($item["plink"]);
252 $item["parent-uri"] = $item["uri"];
255 $condition = ["`uid` = ? AND `uri` = ? AND `network` IN (?, ?)",
256 $importer["uid"], $item["uri"], NETWORK_FEED, NETWORK_DFRN];
257 $previous = dba::select('item', ['id'], $condition, ['limit' => 1]);
258 if (DBM::is_result($previous)) {
259 logger("Item with uri ".$item["uri"]." for user ".$importer["uid"]." already existed under id ".$previous["id"], LOGGER_DEBUG);
264 $item["title"] = $xpath->evaluate('atom:title/text()', $entry)->item(0)->nodeValue;
266 if ($item["title"] == "") {
267 $item["title"] = $xpath->evaluate('title/text()', $entry)->item(0)->nodeValue;
269 if ($item["title"] == "") {
270 $item["title"] = $xpath->evaluate('rss:title/text()', $entry)->item(0)->nodeValue;
272 $published = $xpath->query('atom:published/text()', $entry)->item(0)->nodeValue;
274 if ($published == "") {
275 $published = $xpath->query('pubDate/text()', $entry)->item(0)->nodeValue;
277 if ($published == "") {
278 $published = $xpath->query('dc:date/text()', $entry)->item(0)->nodeValue;
280 $updated = $xpath->query('atom:updated/text()', $entry)->item(0)->nodeValue;
282 if ($updated == "") {
283 $updated = $published;
285 if ($published != "") {
286 $item["created"] = $published;
288 if ($updated != "") {
289 $item["edited"] = $updated;
291 $creator = $xpath->query('author/text()', $entry)->item(0)->nodeValue;
293 if ($creator == "") {
294 $creator = $xpath->query('atom:author/atom:name/text()', $entry)->item(0)->nodeValue;
296 if ($creator == "") {
297 $creator = $xpath->query('dc:creator/text()', $entry)->item(0)->nodeValue;
299 if ($creator != "") {
300 $item["author-name"] = $creator;
302 $creator = $xpath->query('dc:creator/text()', $entry)->item(0)->nodeValue;
304 if ($creator != "") {
305 $item["author-name"] = $creator;
309 // <category>Ausland</category>
310 // <media:thumbnail width="152" height="76" url="http://www.taz.de/picture/667875/192/14388767.jpg"/>
312 $attachments = array();
314 $enclosures = $xpath->query("enclosure", $entry);
315 foreach ($enclosures AS $enclosure) {
321 foreach ($enclosure->attributes AS $attributes) {
322 if ($attributes->name == "url") {
323 $href = $attributes->textContent;
324 } elseif ($attributes->name == "length") {
325 $length = $attributes->textContent;
326 } elseif ($attributes->name == "type") {
327 $type = $attributes->textContent;
330 if (strlen($item["attach"])) {
331 $item["attach"] .= ',';
334 $attachments[] = array("link" => $href, "type" => $type, "length" => $length);
336 $item["attach"] .= '[attach]href="'.$href.'" length="'.$length.'" type="'.$type.'"[/attach]';
340 $categories = $xpath->query("category", $entry);
341 foreach ($categories AS $category) {
342 $hashtag = $category->nodeValue;
347 $taglink = "#[url=" . System::baseUrl() . "/search?tag=" . rawurlencode($hashtag) . "]" . $hashtag . "[/url]";
351 $body = trim($xpath->evaluate('atom:content/text()', $entry)->item(0)->nodeValue);
354 $body = trim($xpath->evaluate('content:encoded/text()', $entry)->item(0)->nodeValue);
357 $body = trim($xpath->evaluate('description/text()', $entry)->item(0)->nodeValue);
360 $body = trim($xpath->evaluate('atom:summary/text()', $entry)->item(0)->nodeValue);
363 // remove the content of the title if it is identically to the body
364 // This helps with auto generated titles e.g. from tumblr
365 if (title_is_body($item["title"], $body)) {
368 $item["body"] = html2bbcode($body, $basepath);
370 if (($item["body"] == '') && ($item["title"] != '')) {
371 $item["body"] = $item["title"];
375 if (!empty($contact["fetch_further_information"]) && ($contact["fetch_further_information"] < 3)) {
378 // Handle enclosures and treat them as preview picture
379 foreach ($attachments AS $attachment) {
380 if ($attachment["type"] == "image/jpeg") {
381 $preview = $attachment["link"];
385 // Remove a possible link to the item itself
386 $item["body"] = str_replace($item["plink"], '', $item["body"]);
387 $item["body"] = preg_replace('/\[url\=\](\w+.*?)\[\/url\]/i', '', $item["body"]);
389 // Replace the content when the title is longer than the body
390 $replace = (strlen($item["title"]) > strlen($item["body"]));
392 // Replace it, when there is an image in the body
393 if (strstr($item["body"], '[/img]')) {
397 // Replace it, when there is a link in the body
398 if (strstr($item["body"], '[/url]')) {
403 $item["body"] = $item["title"];
405 // We always strip the title since it will be added in the page information
407 $item["body"] = $item["body"].add_page_info($item["plink"], false, $preview, ($contact["fetch_further_information"] == 2), $contact["ffi_keyword_blacklist"]);
408 $item["tag"] = add_page_keywords($item["plink"], false, $preview, ($contact["fetch_further_information"] == 2), $contact["ffi_keyword_blacklist"]);
409 $item["object-type"] = ACTIVITY_OBJ_BOOKMARK;
410 unset($item["attach"]);
412 if ($contact["fetch_further_information"] == 3) {
414 $item["tag"] = $tags;
416 $item["tag"] = add_page_keywords($item["plink"], false, $preview, true, $contact["ffi_keyword_blacklist"]);
418 $item["body"] .= "\n".$item['tag'];
420 if (!strstr($item["body"], '[url') && ($item['plink'] != '')) {
421 $item["body"] .= "[hr][url]".$item['plink']."[/url]";
426 logger("Stored feed: ".print_r($item, true), LOGGER_DEBUG);
428 $notify = item_is_remote_self($contact, $item);
430 // Distributed items should have a well formatted URI.
431 // Additionally we have to avoid conflicts with identical URI between imported feeds and these items.
433 $item['guid'] = uri_to_guid($orig_plink, $a->get_hostname());
435 unset($item['parent-uri']);
438 $id = item_store($item, false, $notify);
440 logger("Feed for contact ".$contact["url"]." stored under id ".$id);
450 return array("header" => $author, "items" => $items);