3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Protocol;
26 use Friendica\Content\PageInfo;
27 use Friendica\Content\Text\BBCode;
28 use Friendica\Content\Text\HTML;
29 use Friendica\Core\Cache\Duration;
30 use Friendica\Core\Logger;
31 use Friendica\Core\Protocol;
32 use Friendica\Database\DBA;
34 use Friendica\Model\Contact;
35 use Friendica\Model\Item;
36 use Friendica\Model\Post;
37 use Friendica\Model\Tag;
38 use Friendica\Model\User;
39 use Friendica\Util\DateTimeFormat;
40 use Friendica\Util\Network;
41 use Friendica\Util\ParseUrl;
42 use Friendica\Util\Proxy;
43 use Friendica\Util\Strings;
44 use Friendica\Util\XML;
47 * This class contain functions to import feeds (RSS/RDF/Atom)
52 * Read a RSS/RDF/Atom feed and create an item entry for it
54 * @param string $xml The feed data
55 * @param array $importer The user record of the importer
56 * @param array $contact The contact record of the feed
58 * @return array Returns the header and the first item in dry run mode
59 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
61 public static function import($xml, array $importer = [], array $contact = [])
63 $dryRun = empty($importer) && empty($contact);
66 Logger::info("Test Atom/RSS feed");
68 Logger::info("Import Atom/RSS feed '" . $contact["name"] . "' (Contact " . $contact["id"] . ") for user " . $importer["uid"]);
72 Logger::info('XML is empty.');
76 if (!empty($contact['poll'])) {
77 $basepath = $contact['poll'];
78 } elseif (!empty($contact['url'])) {
79 $basepath = $contact['url'];
84 $doc = new DOMDocument();
85 @$doc->loadXML(trim($xml));
86 $xpath = new DOMXPath($doc);
87 $xpath->registerNamespace('atom', ActivityNamespace::ATOM1);
88 $xpath->registerNamespace('dc', "http://purl.org/dc/elements/1.1/");
89 $xpath->registerNamespace('content', "http://purl.org/rss/1.0/modules/content/");
90 $xpath->registerNamespace('rdf', "http://www.w3.org/1999/02/22-rdf-syntax-ns#");
91 $xpath->registerNamespace('rss', "http://purl.org/rss/1.0/");
92 $xpath->registerNamespace('media', "http://search.yahoo.com/mrss/");
93 $xpath->registerNamespace('poco', ActivityNamespace::POCO);
99 if ($xpath->query('/rdf:RDF/rss:channel')->length > 0) {
100 $author["author-link"] = XML::getFirstNodeValue($xpath, '/rdf:RDF/rss:channel/rss:link/text()');
101 $author["author-name"] = XML::getFirstNodeValue($xpath, '/rdf:RDF/rss:channel/rss:title/text()');
103 if (empty($author["author-name"])) {
104 $author["author-name"] = XML::getFirstNodeValue($xpath, '/rdf:RDF/rss:channel/rss:description/text()');
106 $entries = $xpath->query('/rdf:RDF/rss:item');
110 if ($xpath->query('/atom:feed')->length > 0) {
111 $alternate = XML::getFirstAttributes($xpath, "atom:link[@rel='alternate']");
112 if (is_object($alternate)) {
113 foreach ($alternate AS $attribute) {
114 if ($attribute->name == "href") {
115 $author["author-link"] = $attribute->textContent;
120 if (empty($author["author-link"])) {
121 $self = XML::getFirstAttributes($xpath, "atom:link[@rel='self']");
122 if (is_object($self)) {
123 foreach ($self AS $attribute) {
124 if ($attribute->name == "href") {
125 $author["author-link"] = $attribute->textContent;
131 if (empty($author["author-link"])) {
132 $author["author-link"] = XML::getFirstNodeValue($xpath, '/atom:feed/atom:id/text()');
134 $author["author-avatar"] = XML::getFirstNodeValue($xpath, '/atom:feed/atom:logo/text()');
136 $author["author-name"] = XML::getFirstNodeValue($xpath, '/atom:feed/atom:title/text()');
138 if (empty($author["author-name"])) {
139 $author["author-name"] = XML::getFirstNodeValue($xpath, '/atom:feed/atom:subtitle/text()');
142 if (empty($author["author-name"])) {
143 $author["author-name"] = XML::getFirstNodeValue($xpath, '/atom:feed/atom:author/atom:name/text()');
146 $value = XML::getFirstNodeValue($xpath, 'atom:author/poco:displayName/text()');
148 $author["author-name"] = $value;
152 $author["author-id"] = XML::getFirstNodeValue($xpath, '/atom:feed/atom:author/atom:id/text()');
154 // See https://tools.ietf.org/html/rfc4287#section-3.2.2
155 $value = XML::getFirstNodeValue($xpath, 'atom:author/atom:uri/text()');
157 $author["author-link"] = $value;
160 $value = XML::getFirstNodeValue($xpath, 'atom:author/poco:preferredUsername/text()');
162 $author["author-nick"] = $value;
165 $value = XML::getFirstNodeValue($xpath, 'atom:author/poco:address/poco:formatted/text()');
167 $author["author-location"] = $value;
170 $value = XML::getFirstNodeValue($xpath, 'atom:author/poco:note/text()');
172 $author["author-about"] = $value;
175 $avatar = XML::getFirstAttributes($xpath, "atom:author/atom:link[@rel='avatar']");
176 if (is_object($avatar)) {
177 foreach ($avatar AS $attribute) {
178 if ($attribute->name == "href") {
179 $author["author-avatar"] = $attribute->textContent;
185 $author["edited"] = $author["created"] = XML::getFirstNodeValue($xpath, '/atom:feed/atom:updated/text()');
187 $author["app"] = XML::getFirstNodeValue($xpath, '/atom:feed/atom:generator/text()');
189 $entries = $xpath->query('/atom:feed/atom:entry');
193 if ($xpath->query('/rss/channel')->length > 0) {
194 $author["author-link"] = XML::getFirstNodeValue($xpath, '/rss/channel/link/text()');
196 $author["author-name"] = XML::getFirstNodeValue($xpath, '/rss/channel/title/text()');
197 $author["author-avatar"] = XML::getFirstNodeValue($xpath, '/rss/channel/image/url/text()');
199 if (empty($author["author-name"])) {
200 $author["author-name"] = XML::getFirstNodeValue($xpath, '/rss/channel/copyright/text()');
203 if (empty($author["author-name"])) {
204 $author["author-name"] = XML::getFirstNodeValue($xpath, '/rss/channel/description/text()');
207 $author["edited"] = $author["created"] = XML::getFirstNodeValue($xpath, '/rss/channel/pubDate/text()');
209 $author["app"] = XML::getFirstNodeValue($xpath, '/rss/channel/generator/text()');
211 $entries = $xpath->query('/rss/channel/item');
215 $author["author-link"] = $contact["url"];
217 if (empty($author["author-name"])) {
218 $author["author-name"] = $contact["name"];
221 $author["author-avatar"] = $contact["thumb"];
223 $author["owner-link"] = $contact["url"];
224 $author["owner-name"] = $contact["name"];
225 $author["owner-avatar"] = $contact["thumb"];
229 $header["uid"] = $importer["uid"] ?? 0;
230 $header["network"] = Protocol::FEED;
232 $header["origin"] = 0;
233 $header["gravity"] = GRAVITY_PARENT;
234 $header["private"] = Item::PUBLIC;
235 $header["verb"] = Activity::POST;
236 $header["object-type"] = Activity\ObjectType::NOTE;
237 $header["post-type"] = Item::PT_ARTICLE;
239 $header["contact-id"] = $contact["id"] ?? 0;
241 if (!is_object($entries)) {
242 Logger::info("There are no entries in this feed.");
247 $creation_dates = [];
249 // Limit the number of items that are about to be fetched
250 $total_items = ($entries->length - 1);
251 $max_items = DI::config()->get('system', 'max_feed_items');
252 if (($max_items > 0) && ($total_items > $max_items)) {
253 $total_items = $max_items;
258 // Importing older entries first
259 for ($i = $total_items; $i >= 0; --$i) {
260 $entry = $entries->item($i);
262 $item = array_merge($header, $author);
264 $alternate = XML::getFirstAttributes($xpath, "atom:link[@rel='alternate']", $entry);
265 if (!is_object($alternate)) {
266 $alternate = XML::getFirstAttributes($xpath, "atom:link", $entry);
268 if (is_object($alternate)) {
269 foreach ($alternate AS $attribute) {
270 if ($attribute->name == "href") {
271 $item["plink"] = $attribute->textContent;
276 if (empty($item["plink"])) {
277 $item["plink"] = XML::getFirstNodeValue($xpath, 'link/text()', $entry);
280 if (empty($item["plink"])) {
281 $item["plink"] = XML::getFirstNodeValue($xpath, 'rss:link/text()', $entry);
284 $item["uri"] = XML::getFirstNodeValue($xpath, 'atom:id/text()', $entry);
286 if (empty($item["uri"])) {
287 $item["uri"] = XML::getFirstNodeValue($xpath, 'guid/text()', $entry);
290 if (empty($item["uri"])) {
291 $item["uri"] = $item["plink"];
294 // Add the base path if missing
295 $item["uri"] = Network::addBasePath($item["uri"], $basepath);
296 $item["plink"] = Network::addBasePath($item["plink"], $basepath);
298 $orig_plink = $item["plink"];
300 $item["plink"] = DI::httpRequest()->finalUrl($item["plink"]);
302 $item["title"] = XML::getFirstNodeValue($xpath, 'atom:title/text()', $entry);
304 if (empty($item["title"])) {
305 $item["title"] = XML::getFirstNodeValue($xpath, 'title/text()', $entry);
307 if (empty($item["title"])) {
308 $item["title"] = XML::getFirstNodeValue($xpath, 'rss:title/text()', $entry);
311 $item["title"] = html_entity_decode($item["title"], ENT_QUOTES, 'UTF-8');
313 $published = XML::getFirstNodeValue($xpath, 'atom:published/text()', $entry);
315 if (empty($published)) {
316 $published = XML::getFirstNodeValue($xpath, 'pubDate/text()', $entry);
319 if (empty($published)) {
320 $published = XML::getFirstNodeValue($xpath, 'dc:date/text()', $entry);
323 $updated = XML::getFirstNodeValue($xpath, 'atom:updated/text()', $entry);
325 if (empty($updated) && !empty($published)) {
326 $updated = $published;
329 if (empty($published) && !empty($updated)) {
330 $published = $updated;
333 if ($published != "") {
334 $item["created"] = $published;
337 if ($updated != "") {
338 $item["edited"] = $updated;
342 $condition = ["`uid` = ? AND `uri` = ? AND `network` IN (?, ?)",
343 $importer["uid"], $item["uri"], Protocol::FEED, Protocol::DFRN];
344 $previous = Post::selectFirst(['id', 'created'], $condition);
345 if (DBA::isResult($previous)) {
346 // Use the creation date when the post had been stored. It can happen this date changes in the feed.
347 $creation_dates[] = $previous['created'];
348 Logger::info("Item with uri " . $item["uri"] . " for user " . $importer["uid"] . " already existed under id " . $previous["id"]);
351 $creation_dates[] = DateTimeFormat::utc($item['created']);
354 $creator = XML::getFirstNodeValue($xpath, 'author/text()', $entry);
356 if (empty($creator)) {
357 $creator = XML::getFirstNodeValue($xpath, 'atom:author/atom:name/text()', $entry);
360 if (empty($creator)) {
361 $creator = XML::getFirstNodeValue($xpath, 'dc:creator/text()', $entry);
364 if ($creator != "") {
365 $item["author-name"] = $creator;
368 $creator = XML::getFirstNodeValue($xpath, 'dc:creator/text()', $entry);
370 if ($creator != "") {
371 $item["author-name"] = $creator;
375 // <category>Ausland</category>
376 // <media:thumbnail width="152" height="76" url="http://www.taz.de/picture/667875/192/14388767.jpg"/>
380 $enclosures = $xpath->query("enclosure|atom:link[@rel='enclosure']", $entry);
381 foreach ($enclosures AS $enclosure) {
386 foreach ($enclosure->attributes AS $attribute) {
387 if (in_array($attribute->name, ["url", "href"])) {
388 $href = $attribute->textContent;
389 } elseif ($attribute->name == "length") {
390 $length = (int)$attribute->textContent;
391 } elseif ($attribute->name == "type") {
392 $type = $attribute->textContent;
397 $attachments[] = ['type' => Post\Media::DOCUMENT, 'url' => $href, 'mimetype' => $type, 'size' => $length];
402 $categories = $xpath->query("category", $entry);
403 foreach ($categories AS $category) {
404 $taglist[] = $category->nodeValue;
407 $body = trim(XML::getFirstNodeValue($xpath, 'atom:content/text()', $entry));
410 $body = trim(XML::getFirstNodeValue($xpath, 'content:encoded/text()', $entry));
413 $summary = trim(XML::getFirstNodeValue($xpath, 'atom:summary/text()', $entry));
415 if (empty($summary)) {
416 $summary = trim(XML::getFirstNodeValue($xpath, 'description/text()', $entry));
424 if ($body == $summary) {
428 // remove the content of the title if it is identically to the body
429 // This helps with auto generated titles e.g. from tumblr
430 if (self::titleIsBody($item["title"], $body)) {
433 $item["body"] = HTML::toBBCode($body, $basepath);
435 // Remove tracking pixels
436 $item["body"] = preg_replace("/\[img=1x1\]([^\[\]]*)\[\/img\]/Usi", '', $item["body"]);
438 if (($item["body"] == '') && ($item["title"] != '')) {
439 $item["body"] = $item["title"];
446 } elseif (!Item::isValid($item)) {
447 Logger::info('Feed item is invalid', ['created' => $item['created'], 'uid' => $item['uid'], 'uri' => $item['uri']]);
449 } elseif (Item::isTooOld($item)) {
450 Logger::info('Feed is too old', ['created' => $item['created'], 'uid' => $item['uid'], 'uri' => $item['uri']]);
455 if (!empty($contact["fetch_further_information"]) && ($contact["fetch_further_information"] < 3)) {
456 // Handle enclosures and treat them as preview picture
457 foreach ($attachments AS $attachment) {
458 if ($attachment["mimetype"] == "image/jpeg") {
459 $preview = $attachment["url"];
463 // Remove a possible link to the item itself
464 $item["body"] = str_replace($item["plink"], '', $item["body"]);
465 $item["body"] = trim(preg_replace('/\[url\=\](\w+.*?)\[\/url\]/i', '', $item["body"]));
467 // Replace the content when the title is longer than the body
468 $replace = (strlen($item["title"]) > strlen($item["body"]));
470 // Replace it, when there is an image in the body
471 if (strstr($item["body"], '[/img]')) {
475 // Replace it, when there is a link in the body
476 if (strstr($item["body"], '[/url]')) {
480 $saved_body = $item["body"];
481 $saved_title = $item["title"];
484 $item["body"] = trim($item["title"]);
487 $data = ParseUrl::getSiteinfoCached($item['plink']);
488 if (!empty($data['text']) && !empty($data['title']) && (mb_strlen($item['body']) < mb_strlen($data['text']))) {
489 // When the fetched page info text is longer than the body, we do try to enhance the body
490 if (!empty($item['body']) && (strpos($data['title'], $item['body']) === false) && (strpos($data['text'], $item['body']) === false)) {
491 // The body is not part of the fetched page info title or page info text. So we add the text to the body
492 $item['body'] .= "\n\n" . $data['text'];
494 // Else we replace the body with the page info text
495 $item['body'] = $data['text'];
499 $data = PageInfo::queryUrl($item["plink"], false, $preview, ($contact["fetch_further_information"] == 2), $contact["ffi_keyword_denylist"] ?? '');
502 // Take the data that was provided by the feed if the query is empty
503 if (($data['type'] == 'link') && empty($data['title']) && empty($data['text'])) {
504 $data['title'] = $saved_title;
505 $item["body"] = $saved_body;
508 $data_text = strip_tags(trim($data['text'] ?? ''));
509 $item_body = strip_tags(trim($item['body'] ?? ''));
511 if (!empty($data_text) && (($data_text == $item_body) || strstr($item_body, $data_text))) {
515 // We always strip the title since it will be added in the page information
517 $item["body"] = $item["body"] . "\n" . PageInfo::getFooterFromData($data, false);
518 $taglist = $contact["fetch_further_information"] == 2 ? PageInfo::getTagsFromUrl($item["plink"], $preview, $contact["ffi_keyword_denylist"] ?? '') : [];
519 $item["object-type"] = Activity\ObjectType::BOOKMARK;
523 if (!empty($summary)) {
524 $item["body"] = '[abstract]' . HTML::toBBCode($summary, $basepath) . "[/abstract]\n" . $item["body"];
527 if (!empty($contact["fetch_further_information"]) && ($contact["fetch_further_information"] == 3)) {
528 if (empty($taglist)) {
529 $taglist = PageInfo::getTagsFromUrl($item["plink"], $preview, $contact["ffi_keyword_denylist"] ?? '');
531 $item["body"] .= "\n" . self::tagToString($taglist);
536 // Add the link to the original feed entry if not present in feed
537 if (($item['plink'] != '') && !strstr($item["body"], $item['plink'])) {
538 $item["body"] .= "[hr][url]" . $item['plink'] . "[/url]";
542 if (empty($item['title'])) {
543 $item['post-type'] = Item::PT_NOTE;
546 Logger::info('Stored feed', ['item' => $item]);
548 $notify = Item::isRemoteSelf($contact, $item);
550 // Distributed items should have a well formatted URI.
551 // Additionally we have to avoid conflicts with identical URI between imported feeds and these items.
553 $item['guid'] = Item::guidFromUri($orig_plink, DI::baseUrl()->getHostname());
554 $item['uri'] = Item::newURI($item['uid'], $item['guid']);
555 unset($item['thr-parent']);
556 unset($item['parent-uri']);
558 // Set the delivery priority for "remote self" to "medium"
559 $notify = PRIORITY_MEDIUM;
562 $condition = ['uid' => $item['uid'], 'uri' => $item['uri']];
563 if (!Post::exists($condition) && !Post\Delayed::exists($item["uri"], $item['uid'])) {
565 Post\Delayed::publish($item, $notify, $taglist, $attachments);
567 $postings[] = ['item' => $item, 'notify' => $notify,
568 'taglist' => $taglist, 'attachments' => $attachments];
571 Logger::info('Post already created or exists in the delayed posts queue', ['uid' => $item['uid'], 'uri' => $item["uri"]]);
575 if (!empty($postings)) {
576 $min_posting = DI::config()->get('system', 'minimum_posting_interval', 0);
577 $total = count($postings);
579 // Posts shouldn't be delayed more than a day
580 $interval = min(1440, self::getPollInterval($contact));
581 $delay = max(round(($interval * 60) / $total), 60 * $min_posting);
582 Logger::info('Got posting delay', ['delay' => $delay, 'interval' => $interval, 'items' => $total, 'cid' => $contact['id'], 'url' => $contact['url']]);
589 foreach ($postings as $posting) {
591 $publish_time = time() + $post_delay;
592 $post_delay += $delay;
594 $publish_time = time();
597 $last_publish = DI::pConfig()->get($posting['item']['uid'], 'system', 'last_publish', 0, true);
598 $next_publish = max($last_publish + (60 * $min_posting), time());
599 if ($publish_time < $next_publish) {
600 $publish_time = $next_publish;
602 $publish_at = date(DateTimeFormat::MYSQL, $publish_time);
604 Post\Delayed::add($posting['item']['uri'], $posting['item'], $posting['notify'], false, $publish_at, $posting['taglist'], $posting['attachments']);
608 if (!$dryRun && DI::config()->get('system', 'adjust_poll_frequency')) {
609 self::adjustPollFrequency($contact, $creation_dates);
612 return ["header" => $author, "items" => $items];
616 * Automatically adjust the poll frequency according to the post frequency
618 * @param array $contact
619 * @param array $creation_dates
622 private static function adjustPollFrequency(array $contact, array $creation_dates)
624 if ($contact['network'] != Protocol::FEED) {
625 Logger::info('Contact is no feed, skip.', ['id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $contact['url'], 'network' => $contact['network']]);
629 if (!empty($creation_dates)) {
630 // Count the post frequency and the earliest and latest post date
634 $oldest_date = $newest_date = '';
636 foreach ($creation_dates as $date) {
637 $timestamp = strtotime($date);
638 $day = intdiv($timestamp, 86400);
639 $hour = $timestamp % 86400;
641 // Only have a look at values from the last seven days
642 if (((time() / 86400) - $day) < 7) {
643 if (empty($frequency[$day])) {
644 $frequency[$day] = ['count' => 1, 'low' => $hour, 'high' => $hour];
646 ++$frequency[$day]['count'];
647 if ($frequency[$day]['low'] > $hour) {
648 $frequency[$day]['low'] = $hour;
650 if ($frequency[$day]['high'] < $hour) {
651 $frequency[$day]['high'] = $hour;
655 if ($oldest > $day) {
657 $oldest_date = $date;
660 if ($newest < $day) {
662 $newest_date = $date;
666 if (count($creation_dates) == 1) {
667 Logger::info('Feed had posted a single time, switching to daily polling', ['newest' => $newest_date, 'id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $contact['url']]);
668 $priority = 8; // Poll once a day
671 if (empty($priority) && (((time() / 86400) - $newest) > 730)) {
672 Logger::info('Feed had not posted for two years, switching to monthly polling', ['newest' => $newest_date, 'id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $contact['url']]);
673 $priority = 10; // Poll every month
676 if (empty($priority) && (((time() / 86400) - $newest) > 365)) {
677 Logger::info('Feed had not posted for a year, switching to weekly polling', ['newest' => $newest_date, 'id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $contact['url']]);
678 $priority = 9; // Poll every week
681 if (empty($priority) && empty($frequency)) {
682 Logger::info('Feed had not posted for at least a week, switching to daily polling', ['newest' => $newest_date, 'id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $contact['url']]);
683 $priority = 8; // Poll once a day
686 if (empty($priority)) {
687 // Calculate the highest "posts per day" value
689 foreach ($frequency as $entry) {
690 if (($entry['count'] == 1) || ($entry['high'] == $entry['low'])) {
694 // We take the earliest and latest post day and interpolate the number of post per day
695 // that would had been created with this post frequency
697 // Assume at least four hours between oldest and newest post per day - should be okay for news outlets
698 $duration = max($entry['high'] - $entry['low'], 14400);
699 $ppd = (86400 / $duration) * $entry['count'];
705 $priority = 1; // Poll every quarter hour
706 } elseif ($max > 24) {
707 $priority = 2; // Poll half an hour
708 } elseif ($max > 12) {
709 $priority = 3; // Poll hourly
710 } elseif ($max > 8) {
711 $priority = 4; // Poll every two hours
712 } elseif ($max > 4) {
713 $priority = 5; // Poll every three hours
714 } elseif ($max > 2) {
715 $priority = 6; // Poll every six hours
717 $priority = 7; // Poll twice a day
719 Logger::info('Calculated priority by the posts per day', ['priority' => $priority, 'max' => round($max, 2), 'id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $contact['url']]);
722 Logger::info('No posts, switching to daily polling', ['id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $contact['url']]);
723 $priority = 8; // Poll once a day
726 if ($contact['rating'] != $priority) {
727 Logger::notice('Adjusting priority', ['old' => $contact['rating'], 'new' => $priority, 'id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $contact['url']]);
728 DBA::update('contact', ['rating' => $priority], ['id' => $contact['id']]);
733 * Get the poll interval for the given contact array
735 * @param array $contact
736 * @return int Poll interval in minutes
738 public static function getPollInterval(array $contact)
740 if (in_array($contact['network'], [Protocol::MAIL, Protocol::FEED])) {
741 $ratings = [0, 3, 7, 8, 9, 10];
742 if (DI::config()->get('system', 'adjust_poll_frequency') && ($contact['network'] == Protocol::FEED)) {
743 $rating = $contact['rating'];
744 } elseif (array_key_exists($contact['priority'], $ratings)) {
745 $rating = $ratings[$contact['priority']];
750 // Check once a week per default for all other networks
754 // Friendica and OStatus are checked once a day
755 if (in_array($contact['network'], [Protocol::DFRN, Protocol::OSTATUS])) {
759 // Check archived contacts or contacts with unsupported protocols once a month
760 if ($contact['archive'] || in_array($contact['network'], [Protocol::ZOT, Protocol::PHANTOM])) {
768 * Based on $contact['priority'], should we poll this site now? Or later?
771 $min_poll_interval = max(1, DI::config()->get('system', 'min_poll_interval'));
773 $poll_intervals = [$min_poll_interval, 15, 30, 60, 120, 180, 360, 720 ,1440, 10080, 43200];
775 //$poll_intervals = [$min_poll_interval . ' minute', '15 minute', '30 minute',
776 // '1 hour', '2 hour', '3 hour', '6 hour', '12 hour' ,'1 day', '1 week', '1 month'];
778 return $poll_intervals[$rating];
782 * Convert a tag array to a tag string
785 * @return string tag string
787 private static function tagToString(array $tags)
791 foreach ($tags as $tag) {
796 $tagstr .= "#[url=" . DI::baseUrl() . "/search?tag=" . urlencode($tag) . "]" . $tag . "[/url]";
802 private static function titleIsBody($title, $body)
804 $title = strip_tags($title);
805 $title = trim($title);
806 $title = html_entity_decode($title, ENT_QUOTES, 'UTF-8');
807 $title = str_replace(["\n", "\r", "\t", " "], ["", "", "", ""], $title);
809 $body = strip_tags($body);
811 $body = html_entity_decode($body, ENT_QUOTES, 'UTF-8');
812 $body = str_replace(["\n", "\r", "\t", " "], ["", "", "", ""], $body);
814 if (strlen($title) < strlen($body)) {
815 $body = substr($body, 0, strlen($title));
818 if (($title != $body) && (substr($title, -3) == "...")) {
819 $pos = strrpos($title, "...");
821 $title = substr($title, 0, $pos);
822 $body = substr($body, 0, $pos);
825 return ($title == $body);
829 * Creates the Atom feed for a given nickname
832 * - activity (default): all the public posts
833 * - posts: all the public top-level posts
834 * - comments: all the public replies
836 * Updates the provided last_update parameter if the result comes from the
837 * cache or it is empty
839 * @param string $owner_nick Nickname of the feed owner
840 * @param string $last_update Date of the last update
841 * @param integer $max_items Number of maximum items to fetch
842 * @param string $filter Feed items filter (activity, posts or comments)
843 * @param boolean $nocache Wether to bypass caching
845 * @return string Atom feed
846 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
847 * @throws \ImagickException
849 public static function atom($owner_nick, $last_update, $max_items = 300, $filter = 'activity', $nocache = false)
851 $stamp = microtime(true);
853 $owner = User::getOwnerDataByNick($owner_nick);
858 $cachekey = "feed:feed:" . $owner_nick . ":" . $filter . ":" . $last_update;
860 $previous_created = $last_update;
862 // Don't cache when the last item was posted less then 15 minutes ago (Cache duration)
863 if ((time() - strtotime($owner['last-item'])) < 15*60) {
864 $result = DI::cache()->get($cachekey);
865 if (!$nocache && !is_null($result)) {
866 Logger::info('Cached feed duration', ['seconds' => number_format(microtime(true) - $stamp, 3), 'nick' => $owner_nick, 'filter' => $filter, 'created' => $previous_created]);
867 return $result['feed'];
871 $check_date = empty($last_update) ? '' : DateTimeFormat::utc($last_update);
872 $authorid = Contact::getIdForURL($owner["url"]);
874 $condition = ["`uid` = ? AND `received` > ? AND NOT `deleted` AND `gravity` IN (?, ?)
875 AND `private` != ? AND `visible` AND `wall` AND `parent-network` IN (?, ?, ?, ?)",
876 $owner["uid"], $check_date, GRAVITY_PARENT, GRAVITY_COMMENT,
877 Item::PRIVATE, Protocol::ACTIVITYPUB,
878 Protocol::OSTATUS, Protocol::DFRN, Protocol::DIASPORA];
880 if ($filter === 'comments') {
881 $condition[0] .= " AND `object-type` = ? ";
882 $condition[] = Activity\ObjectType::COMMENT;
885 if ($owner['account-type'] != User::ACCOUNT_TYPE_COMMUNITY) {
886 $condition[0] .= " AND `contact-id` = ? AND `author-id` = ?";
887 $condition[] = $owner["id"];
888 $condition[] = $authorid;
891 $params = ['order' => ['received' => true], 'limit' => $max_items];
893 if ($filter === 'posts') {
894 $ret = Post::selectThread(Item::DELIVER_FIELDLIST, $condition, $params);
896 $ret = Post::select(Item::DELIVER_FIELDLIST, $condition, $params);
899 $items = Post::toArray($ret);
901 $doc = new DOMDocument('1.0', 'utf-8');
902 $doc->formatOutput = true;
904 $root = self::addHeader($doc, $owner, $filter);
906 foreach ($items as $item) {
907 $entry = self::entry($doc, $item, $owner);
908 $root->appendChild($entry);
910 if ($last_update < $item['created']) {
911 $last_update = $item['created'];
915 $feeddata = trim($doc->saveXML());
917 $msg = ['feed' => $feeddata, 'last_update' => $last_update];
918 DI::cache()->set($cachekey, $msg, Duration::QUARTER_HOUR);
920 Logger::info('Feed duration', ['seconds' => number_format(microtime(true) - $stamp, 3), 'nick' => $owner_nick, 'filter' => $filter, 'created' => $previous_created]);
926 * Adds the header elements to the XML document
928 * @param DOMDocument $doc XML document
929 * @param array $owner Contact data of the poster
930 * @param string $filter The related feed filter (activity, posts or comments)
932 * @return object header root element
933 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
935 private static function addHeader(DOMDocument $doc, array $owner, $filter)
937 $root = $doc->createElementNS(ActivityNamespace::ATOM1, 'feed');
938 $doc->appendChild($root);
941 $selfUri = '/feed/' . $owner["nick"] . '/';
944 $title = DI::l10n()->t('%s\'s timeline', $owner['name']);
948 $title = DI::l10n()->t('%s\'s posts', $owner['name']);
951 $title = DI::l10n()->t('%s\'s comments', $owner['name']);
956 $attributes = ["uri" => "https://friendi.ca", "version" => FRIENDICA_VERSION . "-" . DB_UPDATE_VERSION];
957 XML::addElement($doc, $root, "generator", FRIENDICA_PLATFORM, $attributes);
958 XML::addElement($doc, $root, "id", DI::baseUrl() . "/profile/" . $owner["nick"]);
959 XML::addElement($doc, $root, "title", $title);
960 XML::addElement($doc, $root, "subtitle", sprintf("Updates from %s on %s", $owner["name"], DI::config()->get('config', 'sitename')));
961 XML::addElement($doc, $root, "logo", Contact::getAvatarUrlForId($owner['id'], Proxy::SIZE_SMALL, $owner['updated']));
962 XML::addElement($doc, $root, "updated", DateTimeFormat::utcNow(DateTimeFormat::ATOM));
964 $author = self::addAuthor($doc, $owner);
965 $root->appendChild($author);
967 $attributes = ["href" => $owner["url"], "rel" => "alternate", "type" => "text/html"];
968 XML::addElement($doc, $root, "link", "", $attributes);
970 OStatus::hublinks($doc, $root, $owner["nick"]);
972 $attributes = ["href" => DI::baseUrl() . $selfUri, "rel" => "self", "type" => "application/atom+xml"];
973 XML::addElement($doc, $root, "link", "", $attributes);
979 * Adds the author element to the XML document
981 * @param DOMDocument $doc XML document
982 * @param array $owner Contact data of the poster
984 * @return \DOMElement author element
985 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
987 private static function addAuthor(DOMDocument $doc, array $owner)
989 $author = $doc->createElement("author");
990 XML::addElement($doc, $author, "uri", $owner["url"]);
991 XML::addElement($doc, $author, "name", $owner["nick"]);
992 XML::addElement($doc, $author, "email", $owner["addr"]);
998 * Adds an entry element to the XML document
1000 * @param DOMDocument $doc XML document
1001 * @param array $item Data of the item that is to be posted
1002 * @param array $owner Contact data of the poster
1003 * @param bool $toplevel optional default false
1005 * @return \DOMElement Entry element
1006 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1007 * @throws \ImagickException
1009 private static function entry(DOMDocument $doc, array $item, array $owner)
1013 $repeated_guid = OStatus::getResharedGuid($item);
1014 if ($repeated_guid != "") {
1015 $xml = self::reshareEntry($doc, $item, $owner, $repeated_guid);
1022 return self::noteEntry($doc, $item, $owner);
1026 * Adds an entry element with reshared content
1028 * @param DOMDocument $doc XML document
1029 * @param array $item Data of the item that is to be posted
1030 * @param array $owner Contact data of the poster
1031 * @param string $repeated_guid guid
1032 * @param bool $toplevel Is it for en entry element (false) or a feed entry (true)?
1034 * @return bool Entry element
1035 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1036 * @throws \ImagickException
1038 private static function reshareEntry(DOMDocument $doc, array $item, array $owner, $repeated_guid)
1040 if (($item['gravity'] != GRAVITY_PARENT) && (Strings::normaliseLink($item["author-link"]) != Strings::normaliseLink($owner["url"]))) {
1041 Logger::info('Feed entry author does not match feed owner', ['owner' => $owner["url"], 'author' => $item["author-link"]]);
1044 $entry = OStatus::entryHeader($doc, $owner, $item, false);
1046 $condition = ['uid' => $owner["uid"], 'guid' => $repeated_guid, 'private' => [Item::PUBLIC, Item::UNLISTED],
1047 'network' => Protocol::FEDERATED];
1048 $repeated_item = Post::selectFirst(Item::DELIVER_FIELDLIST, $condition);
1049 if (!DBA::isResult($repeated_item)) {
1053 self::entryContent($doc, $entry, $item, self::getTitle($repeated_item), Activity::SHARE, false);
1055 self::entryFooter($doc, $entry, $item, $owner);
1061 * Adds a regular entry element
1063 * @param DOMDocument $doc XML document
1064 * @param array $item Data of the item that is to be posted
1065 * @param array $owner Contact data of the poster
1066 * @param bool $toplevel Is it for en entry element (false) or a feed entry (true)?
1068 * @return \DOMElement Entry element
1069 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1070 * @throws \ImagickException
1072 private static function noteEntry(DOMDocument $doc, array $item, array $owner)
1074 if (($item['gravity'] != GRAVITY_PARENT) && (Strings::normaliseLink($item["author-link"]) != Strings::normaliseLink($owner["url"]))) {
1075 Logger::info('Feed entry author does not match feed owner', ['owner' => $owner["url"], 'author' => $item["author-link"]]);
1078 $entry = OStatus::entryHeader($doc, $owner, $item, false);
1080 self::entryContent($doc, $entry, $item, self::getTitle($item), '', true);
1082 self::entryFooter($doc, $entry, $item, $owner);
1088 * Adds elements to the XML document
1090 * @param DOMDocument $doc XML document
1091 * @param \DOMElement $entry Entry element where the content is added
1092 * @param array $item Data of the item that is to be posted
1093 * @param array $owner Contact data of the poster
1094 * @param string $title Title for the post
1095 * @param string $verb The activity verb
1096 * @param bool $complete Add the "status_net" element?
1097 * @param bool $feed_mode Behave like a regular feed for users if true
1099 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1101 private static function entryContent(DOMDocument $doc, \DOMElement $entry, array $item, $title, $verb = "", $complete = true)
1104 $verb = OStatus::constructVerb($item);
1107 XML::addElement($doc, $entry, "id", $item["uri"]);
1108 XML::addElement($doc, $entry, "title", html_entity_decode($title, ENT_QUOTES, 'UTF-8'));
1110 $body = OStatus::formatPicturePost($item['body'], $item['uri-id']);
1112 $body = BBCode::convert($body, false, BBCode::OSTATUS);
1114 XML::addElement($doc, $entry, "content", $body, ["type" => "html"]);
1116 XML::addElement($doc, $entry, "link", "", ["rel" => "alternate", "type" => "text/html",
1117 "href" => DI::baseUrl()."/display/".$item["guid"]]
1120 XML::addElement($doc, $entry, "published", DateTimeFormat::utc($item["created"]."+00:00", DateTimeFormat::ATOM));
1121 XML::addElement($doc, $entry, "updated", DateTimeFormat::utc($item["edited"]."+00:00", DateTimeFormat::ATOM));
1125 * Adds the elements at the foot of an entry to the XML document
1127 * @param DOMDocument $doc XML document
1128 * @param object $entry The entry element where the elements are added
1129 * @param array $item Data of the item that is to be posted
1130 * @param array $owner Contact data of the poster
1131 * @param bool $complete default true
1133 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1135 private static function entryFooter(DOMDocument $doc, $entry, array $item, array $owner)
1139 if ($item['gravity'] != GRAVITY_PARENT) {
1140 $parent = Post::selectFirst(['guid', 'author-link', 'owner-link'], ['id' => $item['parent']]);
1142 $thrparent = Post::selectFirst(['guid', 'author-link', 'owner-link', 'plink'], ['uid' => $owner["uid"], 'uri' => $item['thr-parent']]);
1144 if (DBA::isResult($thrparent)) {
1145 $mentioned[$thrparent["author-link"]] = $thrparent["author-link"];
1146 $mentioned[$thrparent["owner-link"]] = $thrparent["owner-link"];
1147 $parent_plink = $thrparent["plink"];
1149 $mentioned[$parent["author-link"]] = $parent["author-link"];
1150 $mentioned[$parent["owner-link"]] = $parent["owner-link"];
1151 $parent_plink = DI::baseUrl()."/display/".$parent["guid"];
1155 "ref" => $item['thr-parent'],
1156 "href" => $parent_plink];
1157 XML::addElement($doc, $entry, "thr:in-reply-to", "", $attributes);
1161 "href" => $parent_plink];
1162 XML::addElement($doc, $entry, "link", "", $attributes);
1165 // uri-id isn't present for follow entry pseudo-items
1166 $tags = Tag::getByURIId($item['uri-id'] ?? 0);
1167 foreach ($tags as $tag) {
1168 $mentioned[$tag['url']] = $tag['url'];
1171 foreach ($tags as $tag) {
1172 if ($tag['type'] == Tag::HASHTAG) {
1173 XML::addElement($doc, $entry, "category", "", ["term" => $tag['name']]);
1177 OStatus::getAttachment($doc, $entry, $item);
1181 * Fetch or create title for feed entry
1183 * @param array $item
1184 * @return string title
1186 private static function getTitle(array $item)
1188 if ($item['title'] != '') {
1189 return BBCode::convert($item['title'], false, BBCode::OSTATUS);
1192 // Fetch information about the post
1193 $siteinfo = BBCode::getAttachedData($item["body"]);
1194 if (isset($siteinfo["title"])) {
1195 return $siteinfo["title"];
1198 // If no bookmark is found then take the first line
1199 // Remove the share element before fetching the first line
1200 $title = trim(preg_replace("/\[share.*?\](.*?)\[\/share\]/ism","\n$1\n",$item['body']));
1202 $title = BBCode::toPlaintext($title)."\n";
1203 $pos = strpos($title, "\n");
1205 if (($pos == 0) || ($pos > 100)) {
1210 return substr($title, 0, $pos) . $trailer;