3 * @file src/Protocol/OStatus.php
5 namespace Friendica\Protocol;
7 use Friendica\Content\Text\BBCode;
8 use Friendica\Core\Cache;
9 use Friendica\Core\Config;
10 use Friendica\Core\L10n;
11 use Friendica\Core\System;
12 use Friendica\Database\DBM;
13 use Friendica\Model\Contact;
14 use Friendica\Model\Conversation;
15 use Friendica\Model\GContact;
16 use Friendica\Model\Item;
17 use Friendica\Network\Probe;
18 use Friendica\Object\Image;
19 use Friendica\Util\DateTimeFormat;
20 use Friendica\Util\Lock;
21 use Friendica\Util\Network;
22 use Friendica\Util\XML;
27 require_once 'include/dba.php';
28 require_once 'include/html2bbcode.php';
29 require_once 'include/items.php';
30 require_once 'mod/share.php';
31 require_once 'include/enotify.php';
32 require_once 'include/api.php';
33 require_once 'mod/proxy.php';
36 * @brief This class contain functions for the OStatus protocol
40 private static $itemlist;
41 private static $conv_list = [];
44 * @brief Fetches author data
46 * @param object $xpath The xpath object
47 * @param object $context The xml context of the author details
48 * @param array $importer user record of the importing user
49 * @param array $contact Called by reference, will contain the fetched contact
50 * @param bool $onlyfetch Only fetch the header without updating the contact entries
52 * @return array Array of author related entries for the item
54 private static function fetchAuthor($xpath, $context, $importer, &$contact, $onlyfetch)
57 $author["author-link"] = $xpath->evaluate('atom:author/atom:uri/text()', $context)->item(0)->nodeValue;
58 $author["author-name"] = $xpath->evaluate('atom:author/atom:name/text()', $context)->item(0)->nodeValue;
59 $addr = $xpath->evaluate('atom:author/atom:email/text()', $context)->item(0)->nodeValue;
61 $aliaslink = $author["author-link"];
63 $alternate = $xpath->query("atom:author/atom:link[@rel='alternate']", $context)->item(0)->attributes;
64 if (is_object($alternate)) {
65 foreach ($alternate as $attributes) {
66 if (($attributes->name == "href") && ($attributes->textContent != "")) {
67 $author["author-link"] = $attributes->textContent;
71 $author["contact-id"] = $contact["id"];
74 if ($aliaslink != '') {
75 $condition = ["`uid` = ? AND `alias` = ? AND `network` != ? AND `rel` IN (?, ?)",
76 $importer["uid"], $aliaslink, NETWORK_STATUSNET,
77 CONTACT_IS_SHARING, CONTACT_IS_FRIEND];
78 $contact = dba::selectFirst('contact', [], $condition);
81 if (!DBM::is_result($contact) && $author["author-link"] != '') {
82 if ($aliaslink == "") {
83 $aliaslink = $author["author-link"];
86 $condition = ["`uid` = ? AND `nurl` IN (?, ?) AND `network` != ? AND `rel` IN (?, ?)",
87 $importer["uid"], normalise_link($author["author-link"]), normalise_link($aliaslink),
88 NETWORK_STATUSNET, CONTACT_IS_SHARING, CONTACT_IS_FRIEND];
89 $contact = dba::selectFirst('contact', [], $condition);
92 if (!DBM::is_result($contact) && ($addr != '')) {
93 $condition = ["`uid` = ? AND `addr` = ? AND `network` != ? AND `rel` IN (?, ?)",
94 $importer["uid"], $addr, NETWORK_STATUSNET,
95 CONTACT_IS_SHARING, CONTACT_IS_FRIEND];
96 $contact = dba::selectFirst('contact', [], $condition);
99 if (DBM::is_result($contact)) {
100 if ($contact['blocked']) {
103 $author["contact-id"] = $contact["id"];
107 $avatars = $xpath->query("atom:author/atom:link[@rel='avatar']", $context);
108 foreach ($avatars as $avatar) {
111 foreach ($avatar->attributes as $attributes) {
112 if ($attributes->name == "href") {
113 $href = $attributes->textContent;
115 if ($attributes->name == "width") {
116 $width = $attributes->textContent;
120 $avatarlist[$width] = $href;
123 if (count($avatarlist) > 0) {
125 $author["author-avatar"] = Probe::fixAvatar(current($avatarlist), $author["author-link"]);
128 $displayname = $xpath->evaluate('atom:author/poco:displayName/text()', $context)->item(0)->nodeValue;
129 if ($displayname != "") {
130 $author["author-name"] = $displayname;
133 $author["owner-name"] = $author["author-name"];
134 $author["owner-link"] = $author["author-link"];
135 $author["owner-avatar"] = $author["author-avatar"];
137 // Only update the contacts if it is an OStatus contact
138 if (DBM::is_result($contact) && ($contact['id'] > 0) && !$onlyfetch && ($contact["network"] == NETWORK_OSTATUS)) {
140 // Update contact data
142 unset($current['name-date']);
144 // This query doesn't seem to work
145 // $value = $xpath->query("atom:link[@rel='salmon']", $context)->item(0)->nodeValue;
147 // $contact["notify"] = $value;
149 // This query doesn't seem to work as well - I hate these queries
150 // $value = $xpath->query("atom:link[@rel='self' and @type='application/atom+xml']", $context)->item(0)->nodeValue;
152 // $contact["poll"] = $value;
154 $contact['url'] = $author["author-link"];
155 $contact['nurl'] = normalise_link($contact['url']);
157 $value = $xpath->evaluate('atom:author/atom:uri/text()', $context)->item(0)->nodeValue;
159 $contact["alias"] = $value;
162 $value = $xpath->evaluate('atom:author/poco:displayName/text()', $context)->item(0)->nodeValue;
164 $contact["name"] = $value;
167 $value = $xpath->evaluate('atom:author/poco:preferredUsername/text()', $context)->item(0)->nodeValue;
169 $contact["nick"] = $value;
172 $value = $xpath->evaluate('atom:author/poco:note/text()', $context)->item(0)->nodeValue;
174 $contact["about"] = html2bbcode($value);
177 $value = $xpath->evaluate('atom:author/poco:address/poco:formatted/text()', $context)->item(0)->nodeValue;
179 $contact["location"] = $value;
182 $contact['name-date'] = DateTimeFormat::utcNow();
184 dba::update('contact', $contact, ['id' => $contact["id"]], $current);
186 if (!empty($author["author-avatar"]) && ($author["author-avatar"] != $current['avatar'])) {
187 logger("Update profile picture for contact ".$contact["id"], LOGGER_DEBUG);
188 Contact::updateAvatar($author["author-avatar"], $importer["uid"], $contact["id"]);
191 // Ensure that we are having this contact (with uid=0)
192 $cid = Contact::getIdForURL($aliaslink, 0, true);
195 $fields = ['url', 'nurl', 'name', 'nick', 'alias', 'about', 'location'];
196 $old_contact = dba::selectFirst('contact', $fields, ['id' => $cid]);
198 // Update it with the current values
199 $fields = ['url' => $author["author-link"], 'name' => $contact["name"],
200 'nurl' => normalise_link($author["author-link"]),
201 'nick' => $contact["nick"], 'alias' => $contact["alias"],
202 'about' => $contact["about"], 'location' => $contact["location"],
203 'success_update' => DateTimeFormat::utcNow(), 'last-update' => DateTimeFormat::utcNow()];
205 dba::update('contact', $fields, ['id' => $cid], $old_contact);
208 Contact::updateAvatar($author["author-avatar"], 0, $cid);
211 $contact["generation"] = 2;
212 $contact["hide"] = false; // OStatus contacts are never hidden
213 $contact["photo"] = $author["author-avatar"];
214 $gcid = GContact::update($contact);
216 GContact::link($gcid, $contact["uid"], $contact["id"]);
223 * @brief Fetches author data from a given XML string
225 * @param string $xml The XML
226 * @param array $importer user record of the importing user
228 * @return array Array of author related entries for the item
230 public static function salmonAuthor($xml, $importer)
236 $doc = new DOMDocument();
237 @$doc->loadXML($xml);
239 $xpath = new DOMXPath($doc);
240 $xpath->registerNamespace('atom', NAMESPACE_ATOM1);
241 $xpath->registerNamespace('thr', NAMESPACE_THREAD);
242 $xpath->registerNamespace('georss', NAMESPACE_GEORSS);
243 $xpath->registerNamespace('activity', NAMESPACE_ACTIVITY);
244 $xpath->registerNamespace('media', NAMESPACE_MEDIA);
245 $xpath->registerNamespace('poco', NAMESPACE_POCO);
246 $xpath->registerNamespace('ostatus', NAMESPACE_OSTATUS);
247 $xpath->registerNamespace('statusnet', NAMESPACE_STATUSNET);
249 $contact = ["id" => 0];
251 // Fetch the first author
252 $authordata = $xpath->query('//author')->item(0);
253 $author = self::fetchAuthor($xpath, $authordata, $importer, $contact, true);
258 * @brief Read attributes from element
260 * @param object $element Element object
262 * @return array attributes
264 private static function readAttributes($element)
268 foreach ($element->attributes as $attributes) {
269 $attribute[$attributes->name] = $attributes->textContent;
276 * @brief Imports an XML string containing OStatus elements
278 * @param string $xml The XML
279 * @param array $importer user record of the importing user
280 * @param array $contact contact
281 * @param string $hub Called by reference, returns the fetched hub data
284 public static function import($xml, $importer, &$contact, &$hub)
286 self::process($xml, $importer, $contact, $hub);
290 * @brief Internal feed processing
292 * @param string $xml The XML
293 * @param array $importer user record of the importing user
294 * @param array $contact contact
295 * @param string $hub Called by reference, returns the fetched hub data
296 * @param boolean $stored Is the post fresh imported or from the database?
297 * @param boolean $initialize Is it the leading post so that data has to be initialized?
299 * @return boolean Could the XML be processed?
301 private static function process($xml, $importer, &$contact, &$hub, $stored = false, $initialize = true)
304 self::$itemlist = [];
305 self::$conv_list = [];
308 logger("Import OStatus message", LOGGER_DEBUG);
313 $doc = new DOMDocument();
314 @$doc->loadXML($xml);
316 $xpath = new DOMXPath($doc);
317 $xpath->registerNamespace('atom', NAMESPACE_ATOM1);
318 $xpath->registerNamespace('thr', NAMESPACE_THREAD);
319 $xpath->registerNamespace('georss', NAMESPACE_GEORSS);
320 $xpath->registerNamespace('activity', NAMESPACE_ACTIVITY);
321 $xpath->registerNamespace('media', NAMESPACE_MEDIA);
322 $xpath->registerNamespace('poco', NAMESPACE_POCO);
323 $xpath->registerNamespace('ostatus', NAMESPACE_OSTATUS);
324 $xpath->registerNamespace('statusnet', NAMESPACE_STATUSNET);
327 $hub_attributes = $xpath->query("/atom:feed/atom:link[@rel='hub']")->item(0)->attributes;
328 if (is_object($hub_attributes)) {
329 foreach ($hub_attributes as $hub_attribute) {
330 if ($hub_attribute->name == "href") {
331 $hub = $hub_attribute->textContent;
332 logger("Found hub ".$hub, LOGGER_DEBUG);
338 $header["uid"] = $importer["uid"];
339 $header["network"] = NETWORK_OSTATUS;
340 $header["type"] = "remote";
342 $header["origin"] = 0;
343 $header["gravity"] = GRAVITY_PARENT;
345 $first_child = $doc->firstChild->tagName;
347 if ($first_child == "feed") {
348 $entries = $xpath->query('/atom:feed/atom:entry');
350 $entries = $xpath->query('/atom:entry');
353 if ($entries->length == 1) {
354 // We reformat the XML to make it better readable
355 $doc2 = new DOMDocument();
356 $doc2->loadXML($xml);
357 $doc2->preserveWhiteSpace = false;
358 $doc2->formatOutput = true;
359 $xml2 = $doc2->saveXML();
361 $header["protocol"] = PROTOCOL_OSTATUS_SALMON;
362 $header["source"] = $xml2;
363 } elseif (!$initialize) {
367 // Fetch the first author
368 $authordata = $xpath->query('//author')->item(0);
369 $author = self::fetchAuthor($xpath, $authordata, $importer, $contact, $stored);
371 $entry = $xpath->query('/atom:entry');
373 // Reverse the order of the entries
376 foreach ($entries as $entry) {
377 $entrylist[] = $entry;
380 foreach (array_reverse($entrylist) as $entry) {
382 $authorelement = $xpath->query('/atom:entry/atom:author', $entry);
384 if ($authorelement->length == 0) {
385 $authorelement = $xpath->query('atom:author', $entry);
388 if ($authorelement->length > 0) {
389 $author = self::fetchAuthor($xpath, $entry, $importer, $contact, $stored);
392 $value = $xpath->evaluate('atom:author/poco:preferredUsername/text()', $entry)->item(0)->nodeValue;
396 $nickname = $author["author-name"];
399 $item = array_merge($header, $author);
401 $item["uri"] = $xpath->query('atom:id/text()', $entry)->item(0)->nodeValue;
403 $item["verb"] = $xpath->query('activity:verb/text()', $entry)->item(0)->nodeValue;
406 if (in_array($item["verb"], ['qvitter-delete-notice', ACTIVITY_DELETE, 'delete'])) {
407 self::deleteNotice($item);
411 if (in_array($item["verb"], [NAMESPACE_OSTATUS."/unfavorite", ACTIVITY_UNFAVORITE])) {
412 // Ignore "Unfavorite" message
413 logger("Ignore unfavorite message ".print_r($item, true), LOGGER_DEBUG);
417 // Deletions come with the same uri, so we check for duplicates after processing deletions
418 if (dba::exists('item', ['uid' => $importer["uid"], 'uri' => $item["uri"]])) {
419 logger('Post with URI '.$item["uri"].' already existed for user '.$importer["uid"].'.', LOGGER_DEBUG);
422 logger('Processing post with URI '.$item["uri"].' for user '.$importer["uid"].'.', LOGGER_DEBUG);
425 if ($item["verb"] == ACTIVITY_JOIN) {
426 // ignore "Join" messages
427 logger("Ignore join message ".print_r($item, true), LOGGER_DEBUG);
431 if ($item["verb"] == "http://mastodon.social/schema/1.0/block") {
432 // ignore mastodon "block" messages
433 logger("Ignore block message ".print_r($item, true), LOGGER_DEBUG);
437 if ($item["verb"] == ACTIVITY_FOLLOW) {
438 Contact::addRelationship($importer, $contact, $item, $nickname);
442 if ($item["verb"] == NAMESPACE_OSTATUS."/unfollow") {
443 Contact::removeFollower($importer, $contact, $item, $dummy);
447 if ($item["verb"] == ACTIVITY_FAVORITE) {
448 $orig_uri = $xpath->query("activity:object/atom:id", $entry)->item(0)->nodeValue;
449 logger("Favorite ".$orig_uri." ".print_r($item, true));
451 $item["verb"] = ACTIVITY_LIKE;
452 $item["parent-uri"] = $orig_uri;
453 $item["gravity"] = GRAVITY_LIKE;
456 // http://activitystrea.ms/schema/1.0/rsvp-yes
457 if (!in_array($item["verb"], [ACTIVITY_POST, ACTIVITY_LIKE, ACTIVITY_SHARE])) {
458 logger("Unhandled verb ".$item["verb"]." ".print_r($item, true), LOGGER_DEBUG);
461 self::processPost($xpath, $entry, $item, $importer);
463 if ($initialize && (count(self::$itemlist) > 0)) {
464 if (self::$itemlist[0]['uri'] == self::$itemlist[0]['parent-uri']) {
465 // We will import it everytime, when it is started by our contacts
466 $valid = !empty(self::$itemlist[0]['contact-id']);
468 // If not, then it depends on this setting
469 $valid = !Config::get('system', 'ostatus_full_threads');
471 logger("Item with uri ".self::$itemlist[0]['uri']." will be imported due to the system settings.", LOGGER_DEBUG);
474 logger("Item with uri ".self::$itemlist[0]['uri']." belongs to a contact (".self::$itemlist[0]['contact-id']."). It will be imported.", LOGGER_DEBUG);
477 // Never post a thread when the only interaction by our contact was a like
479 $verbs = [ACTIVITY_POST, ACTIVITY_SHARE];
480 foreach (self::$itemlist as $item) {
481 if (!empty($item['contact-id']) && in_array($item['verb'], $verbs)) {
486 logger("Item with uri ".self::$itemlist[0]['uri']." will be imported since the thread contains posts or shares.", LOGGER_DEBUG);
490 // But we will only import complete threads
491 $valid = dba::exists('item', ['uid' => $importer["uid"], 'uri' => self::$itemlist[0]['parent-uri']]);
493 logger("Item with uri ".self::$itemlist[0]["uri"]." belongs to parent ".self::$itemlist[0]['parent-uri']." of user ".$importer["uid"].". It will be imported.", LOGGER_DEBUG);
498 $default_contact = 0;
499 $key = count(self::$itemlist);
500 for ($key = count(self::$itemlist) - 1; $key >= 0; $key--) {
501 if (empty(self::$itemlist[$key]['contact-id'])) {
502 self::$itemlist[$key]['contact-id'] = $default_contact;
504 $default_contact = $item['contact-id'];
507 foreach (self::$itemlist as $item) {
508 $found = dba::exists('item', ['uid' => $importer["uid"], 'uri' => $item["uri"]]);
510 logger("Item with uri ".$item["uri"]." for user ".$importer["uid"]." already exists.", LOGGER_DEBUG);
511 } elseif ($item['contact-id'] < 0) {
512 logger("Item with uri ".$item["uri"]." is from a blocked contact.", LOGGER_DEBUG);
514 // We are having duplicated entries. Hopefully this solves it.
515 if (Lock::set('ostatus_process_item_insert')) {
516 $ret = Item::insert($item);
517 Lock::remove('ostatus_process_item_insert');
518 logger("Item with uri ".$item["uri"]." for user ".$importer["uid"].' stored. Return value: '.$ret);
520 $ret = Item::insert($item);
521 logger("We couldn't lock - but tried to store the item anyway. Return value is ".$ret);
526 self::$itemlist = [];
528 logger('Processing done for post with URI '.$item["uri"].' for user '.$importer["uid"].'.', LOGGER_DEBUG);
534 * @param object $item item
537 private static function deleteNotice($item)
539 $condition = ['uid' => $item['uid'], 'author-link' => $item['author-link'], 'uri' => $item['uri']];
540 $deleted = dba::selectFirst('item', ['id', 'parent-uri'], $condition);
541 if (!DBM::is_result($deleted)) {
542 logger('Item from '.$item['author-link'].' with uri '.$item['uri'].' for user '.$item['uid']." wasn't found. We don't delete it. ");
546 Item::deleteById($deleted["id"]);
548 logger('Deleted item with uri '.$item['uri'].' for user '.$item['uid']);
552 * @brief Processes the XML for a post
554 * @param object $xpath The xpath object
555 * @param object $entry The xml entry that is processed
556 * @param array $item The item array
557 * @param array $importer user record of the importing user
560 private static function processPost($xpath, $entry, &$item, $importer)
562 $item["body"] = html2bbcode($xpath->query('atom:content/text()', $entry)->item(0)->nodeValue);
563 $item["object-type"] = $xpath->query('activity:object-type/text()', $entry)->item(0)->nodeValue;
564 if (($item["object-type"] == ACTIVITY_OBJ_BOOKMARK) || ($item["object-type"] == ACTIVITY_OBJ_EVENT)) {
565 $item["title"] = $xpath->query('atom:title/text()', $entry)->item(0)->nodeValue;
566 $item["body"] = $xpath->query('atom:summary/text()', $entry)->item(0)->nodeValue;
567 } elseif ($item["object-type"] == ACTIVITY_OBJ_QUESTION) {
568 $item["title"] = $xpath->query('atom:title/text()', $entry)->item(0)->nodeValue;
571 $item["created"] = $xpath->query('atom:published/text()', $entry)->item(0)->nodeValue;
572 $item["edited"] = $xpath->query('atom:updated/text()', $entry)->item(0)->nodeValue;
573 $conversation = $xpath->query('ostatus:conversation/text()', $entry)->item(0)->nodeValue;
574 $item['conversation-uri'] = $conversation;
576 $conv = $xpath->query('ostatus:conversation', $entry);
577 if (is_object($conv->item(0))) {
578 foreach ($conv->item(0)->attributes as $attributes) {
579 if ($attributes->name == "ref") {
580 $item['conversation-uri'] = $attributes->textContent;
582 if ($attributes->name == "href") {
583 $item['conversation-href'] = $attributes->textContent;
590 $inreplyto = $xpath->query('thr:in-reply-to', $entry);
591 if (is_object($inreplyto->item(0))) {
592 foreach ($inreplyto->item(0)->attributes as $attributes) {
593 if ($attributes->name == "ref") {
594 $item["parent-uri"] = $attributes->textContent;
596 if ($attributes->name == "href") {
597 $related = $attributes->textContent;
602 $georsspoint = $xpath->query('georss:point', $entry);
603 if (!empty($georsspoint) && ($georsspoint->length > 0)) {
604 $item["coord"] = $georsspoint->item(0)->nodeValue;
610 $links = $xpath->query('atom:link', $entry);
612 $link_data = self::processLinks($links, $item);
613 $self = $link_data['self'];
614 $add_body = $link_data['add_body'];
619 $notice_info = $xpath->query('statusnet:notice_info', $entry);
620 if ($notice_info && ($notice_info->length > 0)) {
621 foreach ($notice_info->item(0)->attributes as $attributes) {
622 if ($attributes->name == "source") {
623 $item["app"] = strip_tags($attributes->textContent);
625 if ($attributes->name == "repeat_of") {
626 $repeat_of = $attributes->textContent;
630 // Is it a repeated post?
631 if (($repeat_of != "") || ($item["verb"] == ACTIVITY_SHARE)) {
632 $link_data = self::processRepeatedItem($xpath, $entry, $item, $importer);
633 if (!empty($link_data['add_body'])) {
634 $add_body .= $link_data['add_body'];
638 $item["body"] .= $add_body;
640 // Only add additional data when there is no picture in the post
641 if (!strstr($item["body"], '[/img]')) {
642 $item["body"] = add_page_info_to_body($item["body"]);
645 // Mastodon Content Warning
646 $content_warning = false;
647 if (($item["verb"] == ACTIVITY_POST) && $xpath->evaluate('boolean(atom:summary)', $entry)) {
648 $clear_text = $xpath->query('atom:summary/text()', $entry)->item(0)->nodeValue;
649 if (!empty($clear_text)) {
650 $item["body"] = html2bbcode($clear_text) . '[spoiler]' . $item["body"] . '[/spoiler]';
651 $content_warning = true;
655 if (($self != '') && empty($item['protocol'])) {
656 self::fetchSelf($self, $item);
659 if (!empty($item["conversation-href"])) {
660 self::fetchConversation($item['conversation-href'], $item['conversation-uri']);
663 if (isset($item["parent-uri"]) && ($related != '')) {
664 if (!dba::exists('item', ['uid' => $importer["uid"], 'uri' => $item['parent-uri']])) {
665 self::fetchRelated($related, $item["parent-uri"], $importer);
667 logger('Reply with URI '.$item["uri"].' already existed for user '.$importer["uid"].'.', LOGGER_DEBUG);
670 $item["type"] = 'remote-comment';
671 $item["gravity"] = GRAVITY_COMMENT;
673 $item["parent-uri"] = $item["uri"];
676 $categories = $xpath->query('atom:category', $entry);
678 foreach ($categories as $category) {
679 foreach ($category->attributes as $attributes) {
680 if ($attributes->name == "term") {
681 $term = $attributes->textContent;
682 // don't add nsfw with content warning if enabled.
683 // Background: "nsfw" is set automatically by Mastodon
684 if (!Config::get('system', 'remove_nsfw_with_cw', false) ||
685 !$content_warning || ($term != 'nsfw')) {
686 if (strlen($item["tag"])) {
689 $item["tag"] .= "#[url=".System::baseUrl()."/search?tag=".$term."]".$term."[/url]";
696 if (($item['author-link'] != '') && !empty($item['protocol'])) {
697 $item = Conversation::insert($item);
700 self::$itemlist[] = $item;
704 * @brief Fetch the conversation for posts
706 * @param string $conversation The link to the conversation
707 * @param string $conversation_uri The conversation in "uri" format
710 private static function fetchConversation($conversation, $conversation_uri)
712 // Ensure that we only store a conversation once in a process
713 if (isset(self::$conv_list[$conversation])) {
717 self::$conv_list[$conversation] = true;
719 $conversation_data = Network::curl($conversation, false, $redirects, ['accept_content' => 'application/atom+xml, text/html']);
721 if (!$conversation_data['success']) {
727 if (stristr($conversation_data['header'], 'Content-Type: application/atom+xml')) {
728 $xml = $conversation_data['body'];
732 $doc = new DOMDocument();
733 if (!@$doc->loadHTML($conversation_data['body'])) {
736 $xpath = new DOMXPath($doc);
738 $links = $xpath->query('//link');
741 foreach ($links as $link) {
742 $attribute = self::readAttributes($link);
743 if (($attribute['rel'] == 'alternate') && ($attribute['type'] == 'application/atom+xml')) {
744 $file = $attribute['href'];
748 $conversation_atom = Network::curl($attribute['href']);
750 if ($conversation_atom['success']) {
751 $xml = $conversation_atom['body'];
761 self::storeConversation($xml, $conversation, $conversation_uri);
765 * @brief Store a feed in several conversation entries
767 * @param string $xml The feed
768 * @param string $conversation conversation
769 * @param string $conversation_uri conversation uri
772 private static function storeConversation($xml, $conversation = '', $conversation_uri = '')
774 $doc = new DOMDocument();
775 @$doc->loadXML($xml);
777 $xpath = new DOMXPath($doc);
778 $xpath->registerNamespace('atom', NAMESPACE_ATOM1);
779 $xpath->registerNamespace('thr', NAMESPACE_THREAD);
780 $xpath->registerNamespace('ostatus', NAMESPACE_OSTATUS);
782 $entries = $xpath->query('/atom:feed/atom:entry');
784 // Now store the entries
785 foreach ($entries as $entry) {
786 $doc2 = new DOMDocument();
787 $doc2->preserveWhiteSpace = false;
788 $doc2->formatOutput = true;
792 $conv_data['protocol'] = PROTOCOL_SPLITTED_CONV;
793 $conv_data['network'] = NETWORK_OSTATUS;
794 $conv_data['uri'] = $xpath->query('atom:id/text()', $entry)->item(0)->nodeValue;
796 $inreplyto = $xpath->query('thr:in-reply-to', $entry);
797 if (is_object($inreplyto->item(0))) {
798 foreach ($inreplyto->item(0)->attributes as $attributes) {
799 if ($attributes->name == "ref") {
800 $conv_data['reply-to-uri'] = $attributes->textContent;
805 $conv = $xpath->query('ostatus:conversation/text()', $entry)->item(0)->nodeValue;
806 $conv_data['conversation-uri'] = $conv;
808 $conv = $xpath->query('ostatus:conversation', $entry);
809 if (is_object($conv->item(0))) {
810 foreach ($conv->item(0)->attributes as $attributes) {
811 if ($attributes->name == "ref") {
812 $conv_data['conversation-uri'] = $attributes->textContent;
814 if ($attributes->name == "href") {
815 $conv_data['conversation-href'] = $attributes->textContent;
820 if ($conversation != '') {
821 $conv_data['conversation-uri'] = $conversation;
824 if ($conversation_uri != '') {
825 $conv_data['conversation-uri'] = $conversation_uri;
828 $entry = $doc2->importNode($entry, true);
830 $doc2->appendChild($entry);
832 $conv_data['source'] = $doc2->saveXML();
834 $condition = ['item-uri' => $conv_data['uri'],'protocol' => PROTOCOL_OSTATUS_FEED];
835 if (dba::exists('conversation', $condition)) {
836 logger('Delete deprecated entry for URI '.$conv_data['uri'], LOGGER_DEBUG);
837 dba::delete('conversation', ['item-uri' => $conv_data['uri']]);
840 logger('Store conversation data for uri '.$conv_data['uri'], LOGGER_DEBUG);
841 Conversation::insert($conv_data);
846 * @brief Fetch the own post so that it can be stored later
848 * We want to store the original data for later processing.
849 * This function is meant for cases where we process a feed with multiple entries.
850 * In that case we need to fetch the single posts here.
852 * @param string $self The link to the self item
853 * @param array $item The item array
856 private static function fetchSelf($self, &$item)
858 $condition = ['`item-uri` = ? AND `protocol` IN (?, ?)', $self, PROTOCOL_DFRN, PROTOCOL_OSTATUS_SALMON];
859 if (dba::exists('conversation', $condition)) {
860 logger('Conversation '.$item['uri'].' is already stored.', LOGGER_DEBUG);
864 $self_data = Network::curl($self);
866 if (!$self_data['success']) {
870 // We reformat the XML to make it better readable
871 $doc = new DOMDocument();
872 $doc->loadXML($self_data['body']);
873 $doc->preserveWhiteSpace = false;
874 $doc->formatOutput = true;
875 $xml = $doc->saveXML();
877 $item["protocol"] = PROTOCOL_OSTATUS_SALMON;
878 $item["source"] = $xml;
880 logger('Conversation '.$item['uri'].' is now fetched.', LOGGER_DEBUG);
884 * @brief Fetch related posts and processes them
886 * @param string $related The link to the related item
887 * @param string $related_uri The related item in "uri" format
888 * @param array $importer user record of the importing user
891 private static function fetchRelated($related, $related_uri, $importer)
893 $condition = ['`item-uri` = ? AND `protocol` IN (?, ?)', $related_uri, PROTOCOL_DFRN, PROTOCOL_OSTATUS_SALMON];
894 $conversation = dba::selectFirst('conversation', ['source', 'protocol'], $condition);
895 if (DBM::is_result($conversation)) {
897 $xml = $conversation['source'];
898 if (self::process($xml, $importer, $contact, $hub, $stored, false)) {
899 logger('Got valid cached XML for URI '.$related_uri, LOGGER_DEBUG);
902 if ($conversation['protocol'] == PROTOCOL_OSTATUS_SALMON) {
903 logger('Delete invalid cached XML for URI '.$related_uri, LOGGER_DEBUG);
904 dba::delete('conversation', ['item-uri' => $related_uri]);
909 $related_data = Network::curl($related, false, $redirects, ['accept_content' => 'application/atom+xml, text/html']);
911 if (!$related_data['success']) {
917 if (stristr($related_data['header'], 'Content-Type: application/atom+xml')) {
918 logger('Directly fetched XML for URI '.$related_uri, LOGGER_DEBUG);
919 $xml = $related_data['body'];
923 $doc = new DOMDocument();
924 if (!@$doc->loadHTML($related_data['body'])) {
927 $xpath = new DOMXPath($doc);
931 $links = $xpath->query('//link');
933 foreach ($links as $link) {
934 $attribute = self::readAttributes($link);
935 if (($attribute['rel'] == 'alternate') && ($attribute['type'] == 'application/atom+xml')) {
936 $atom_file = $attribute['href'];
939 if ($atom_file != '') {
940 $related_atom = Network::curl($atom_file);
942 if ($related_atom['success']) {
943 logger('Fetched XML for URI '.$related_uri, LOGGER_DEBUG);
944 $xml = $related_atom['body'];
950 // Workaround for older GNU Social servers
951 if (($xml == '') && strstr($related, '/notice/')) {
952 $related_atom = Network::curl(str_replace('/notice/', '/api/statuses/show/', $related).'.atom');
954 if ($related_atom['success']) {
955 logger('GNU Social workaround to fetch XML for URI '.$related_uri, LOGGER_DEBUG);
956 $xml = $related_atom['body'];
960 // Even more worse workaround for GNU Social ;-)
962 $related_guess = OStatus::convertHref($related_uri);
963 $related_atom = Network::curl(str_replace('/notice/', '/api/statuses/show/', $related_guess).'.atom');
965 if ($related_atom['success']) {
966 logger('GNU Social workaround 2 to fetch XML for URI '.$related_uri, LOGGER_DEBUG);
967 $xml = $related_atom['body'];
971 // Finally we take the data that we fetched from "ostatus:conversation"
973 $condition = ['item-uri' => $related_uri, 'protocol' => PROTOCOL_SPLITTED_CONV];
974 $conversation = dba::selectFirst('conversation', ['source'], $condition);
975 if (DBM::is_result($conversation)) {
977 logger('Got cached XML from conversation for URI '.$related_uri, LOGGER_DEBUG);
978 $xml = $conversation['source'];
983 self::process($xml, $importer, $contact, $hub, $stored, false);
985 logger("XML couldn't be fetched for URI: ".$related_uri." - href: ".$related, LOGGER_DEBUG);
991 * @brief Processes the XML for a repeated post
993 * @param object $xpath The xpath object
994 * @param object $entry The xml entry that is processed
995 * @param array $item The item array
996 * @param array $importer user record of the importing user
998 * @return array with data from links
1000 private static function processRepeatedItem($xpath, $entry, &$item, $importer)
1002 $activityobjects = $xpath->query('activity:object', $entry)->item(0);
1004 if (!is_object($activityobjects)) {
1010 $orig_uri = $xpath->query('atom:id/text()', $activityobjects)->item(0)->nodeValue;
1012 $links = $xpath->query("atom:link", $activityobjects);
1014 $link_data = self::processLinks($links, $item);
1017 $orig_body = $xpath->query('atom:content/text()', $activityobjects)->item(0)->nodeValue;
1018 $orig_created = $xpath->query('atom:published/text()', $activityobjects)->item(0)->nodeValue;
1019 $orig_edited = $xpath->query('atom:updated/text()', $activityobjects)->item(0)->nodeValue;
1021 $orig_author = self::fetchAuthor($xpath, $activityobjects, $importer, $dummy, false);
1023 $item["author-name"] = $orig_author["author-name"];
1024 $item["author-link"] = $orig_author["author-link"];
1025 $item["author-avatar"] = $orig_author["author-avatar"];
1027 $item["body"] = html2bbcode($orig_body);
1028 $item["created"] = $orig_created;
1029 $item["edited"] = $orig_edited;
1031 $item["uri"] = $orig_uri;
1033 $item["verb"] = $xpath->query('activity:verb/text()', $activityobjects)->item(0)->nodeValue;
1035 $item["object-type"] = $xpath->query('activity:object-type/text()', $activityobjects)->item(0)->nodeValue;
1037 $inreplyto = $xpath->query('thr:in-reply-to', $activityobjects);
1038 if (is_object($inreplyto->item(0))) {
1039 foreach ($inreplyto->item(0)->attributes as $attributes) {
1040 if ($attributes->name == "ref") {
1041 $item["parent-uri"] = $attributes->textContent;
1050 * @brief Processes links in the XML
1052 * @param object $links The xml data that contain links
1053 * @param array $item The item array
1055 * @return array with data from the links
1057 private static function processLinks($links, &$item)
1059 $link_data = ['add_body' => '', 'self' => ''];
1061 foreach ($links as $link) {
1062 $attribute = self::readAttributes($link);
1064 if (($attribute['rel'] != "") && ($attribute['href'] != "")) {
1065 switch ($attribute['rel']) {
1067 $item["plink"] = $attribute['href'];
1068 if (($item["object-type"] == ACTIVITY_OBJ_QUESTION)
1069 || ($item["object-type"] == ACTIVITY_OBJ_EVENT)
1071 $item["body"] .= add_page_info($attribute['href']);
1074 case "ostatus:conversation":
1075 $link_data['conversation'] = $attribute['href'];
1076 $item['conversation-href'] = $link_data['conversation'];
1077 if (!isset($item['conversation-uri'])) {
1078 $item['conversation-uri'] = $item['conversation-href'];
1082 $filetype = strtolower(substr($attribute['type'], 0, strpos($attribute['type'], '/')));
1083 if ($filetype == 'image') {
1084 $link_data['add_body'] .= "\n[img]".$attribute['href'].'[/img]';
1086 if (strlen($item["attach"])) {
1087 $item["attach"] .= ',';
1089 if (!isset($attribute['length'])) {
1090 $attribute['length'] = "0";
1092 $item["attach"] .= '[attach]href="'.$attribute['href'].'" length="'.$attribute['length'].'" type="'.$attribute['type'].'" title="'.$attribute['title'].'"[/attach]';
1096 if ($item["object-type"] != ACTIVITY_OBJ_BOOKMARK) {
1097 if (!isset($item["parent-uri"])) {
1098 $item["parent-uri"] = $attribute['href'];
1100 $link_data['related'] = $attribute['href'];
1102 $item["body"] .= add_page_info($attribute['href']);
1106 if ($item["plink"] == '') {
1107 $item["plink"] = $attribute['href'];
1109 $link_data['self'] = $attribute['href'];
1118 * @brief Create an url out of an uri
1120 * @param string $href URI in the format "parameter1:parameter1:..."
1122 * @return string URL in the format http(s)://....
1124 public static function convertHref($href)
1126 $elements = explode(":", $href);
1128 if ((count($elements) <= 2) || ($elements[0] != "tag")) {
1132 $server = explode(",", $elements[1]);
1133 $conversation = explode("=", $elements[2]);
1135 if ((count($elements) == 4) && ($elements[2] == "post")) {
1136 return "http://".$server[0]."/notice/".$elements[3];
1139 if ((count($conversation) != 2) || ($conversation[1] =="")) {
1142 if ($elements[3] == "objectType=thread") {
1143 return "http://".$server[0]."/conversation/".$conversation[1];
1145 return "http://".$server[0]."/notice/".$conversation[1];
1151 * @brief Checks if the current post is a reshare
1153 * @param array $item The item array of thw post
1155 * @return string The guid if the post is a reshare
1157 private static function getResharedGuid($item)
1159 $body = trim($item["body"]);
1161 // Skip if it isn't a pure repeated messages
1162 // Does it start with a share?
1163 if (strpos($body, "[share") > 0) {
1167 // Does it end with a share?
1168 if (strlen($body) > (strrpos($body, "[/share]") + 8)) {
1172 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
1173 // Skip if there is no shared message in there
1174 if ($body == $attributes) {
1179 preg_match("/guid='(.*?)'/ism", $attributes, $matches);
1180 if ($matches[1] != "") {
1181 $guid = $matches[1];
1184 preg_match('/guid="(.*?)"/ism', $attributes, $matches);
1185 if ($matches[1] != "") {
1186 $guid = $matches[1];
1193 * @brief Cleans the body of a post if it contains picture links
1195 * @param string $body The body
1197 * @return string The cleaned body
1199 private static function formatPicturePost($body)
1201 $siteinfo = BBCode::getAttachedData($body);
1203 if (($siteinfo["type"] == "photo")) {
1204 if (isset($siteinfo["preview"])) {
1205 $preview = $siteinfo["preview"];
1207 $preview = $siteinfo["image"];
1210 // Is it a remote picture? Then make a smaller preview here
1211 $preview = proxy_url($preview, false, PROXY_SIZE_SMALL);
1213 // Is it a local picture? Then make it smaller here
1214 $preview = str_replace(["-0.jpg", "-0.png"], ["-2.jpg", "-2.png"], $preview);
1215 $preview = str_replace(["-1.jpg", "-1.png"], ["-2.jpg", "-2.png"], $preview);
1217 if (isset($siteinfo["url"])) {
1218 $url = $siteinfo["url"];
1220 $url = $siteinfo["image"];
1223 $body = trim($siteinfo["text"])." [url]".$url."[/url]\n[img]".$preview."[/img]";
1230 * @brief Adds the header elements to the XML document
1232 * @param object $doc XML document
1233 * @param array $owner Contact data of the poster
1234 * @param string $filter The related feed filter (activity, posts or comments)
1236 * @return object header root element
1238 private static function addHeader($doc, $owner, $filter)
1242 $root = $doc->createElementNS(NAMESPACE_ATOM1, 'feed');
1243 $doc->appendChild($root);
1245 $root->setAttribute("xmlns:thr", NAMESPACE_THREAD);
1246 $root->setAttribute("xmlns:georss", NAMESPACE_GEORSS);
1247 $root->setAttribute("xmlns:activity", NAMESPACE_ACTIVITY);
1248 $root->setAttribute("xmlns:media", NAMESPACE_MEDIA);
1249 $root->setAttribute("xmlns:poco", NAMESPACE_POCO);
1250 $root->setAttribute("xmlns:ostatus", NAMESPACE_OSTATUS);
1251 $root->setAttribute("xmlns:statusnet", NAMESPACE_STATUSNET);
1252 $root->setAttribute("xmlns:mastodon", NAMESPACE_MASTODON);
1256 case 'activity': $title = L10n::t('%s\'s timeline', $owner['name']); break;
1257 case 'posts' : $title = L10n::t('%s\'s posts' , $owner['name']); break;
1258 case 'comments': $title = L10n::t('%s\'s comments', $owner['name']); break;
1261 $attributes = ["uri" => "https://friendi.ca", "version" => FRIENDICA_VERSION . "-" . DB_UPDATE_VERSION];
1262 XML::addElement($doc, $root, "generator", FRIENDICA_PLATFORM, $attributes);
1263 XML::addElement($doc, $root, "id", System::baseUrl() . "/profile/" . $owner["nick"]);
1264 XML::addElement($doc, $root, "title", $title);
1265 XML::addElement($doc, $root, "subtitle", sprintf("Updates from %s on %s", $owner["name"], $a->config["sitename"]));
1266 XML::addElement($doc, $root, "logo", $owner["photo"]);
1267 XML::addElement($doc, $root, "updated", DateTimeFormat::utcNow(DateTimeFormat::ATOM));
1269 $author = self::addAuthor($doc, $owner);
1270 $root->appendChild($author);
1272 $attributes = ["href" => $owner["url"], "rel" => "alternate", "type" => "text/html"];
1273 XML::addElement($doc, $root, "link", "", $attributes);
1275 /// @TODO We have to find out what this is
1276 /// $attributes = array("href" => System::baseUrl()."/sup",
1277 /// "rel" => "http://api.friendfeed.com/2008/03#sup",
1278 /// "type" => "application/json");
1279 /// XML::addElement($doc, $root, "link", "", $attributes);
1281 self::hublinks($doc, $root, $owner["nick"]);
1283 $attributes = ["href" => System::baseUrl() . "/salmon/" . $owner["nick"], "rel" => "salmon"];
1284 XML::addElement($doc, $root, "link", "", $attributes);
1286 $attributes = ["href" => System::baseUrl() . "/salmon/" . $owner["nick"], "rel" => "http://salmon-protocol.org/ns/salmon-replies"];
1287 XML::addElement($doc, $root, "link", "", $attributes);
1289 $attributes = ["href" => System::baseUrl() . "/salmon/" . $owner["nick"], "rel" => "http://salmon-protocol.org/ns/salmon-mention"];
1290 XML::addElement($doc, $root, "link", "", $attributes);
1292 $attributes = ["href" => System::baseUrl() . "/api/statuses/user_timeline/" . $owner["nick"] . ".atom",
1293 "rel" => "self", "type" => "application/atom+xml"];
1294 XML::addElement($doc, $root, "link", "", $attributes);
1300 * @brief Add the link to the push hubs to the XML document
1302 * @param object $doc XML document
1303 * @param object $root XML root element where the hub links are added
1304 * @param object $nick nick
1307 public static function hublinks($doc, $root, $nick)
1309 $h = System::baseUrl() . '/pubsubhubbub/'.$nick;
1310 XML::addElement($doc, $root, "link", "", ["href" => $h, "rel" => "hub"]);
1314 * @brief Adds attachement data to the XML document
1316 * @param object $doc XML document
1317 * @param object $root XML root element where the hub links are added
1318 * @param array $item Data of the item that is to be posted
1321 private static function getAttachment($doc, $root, $item)
1324 $siteinfo = BBCode::getAttachedData($item["body"]);
1326 switch ($siteinfo["type"]) {
1328 $imgdata = Image::getInfoFromURL($siteinfo["image"]);
1329 $attributes = ["rel" => "enclosure",
1330 "href" => $siteinfo["image"],
1331 "type" => $imgdata["mime"],
1332 "length" => intval($imgdata["size"])];
1333 XML::addElement($doc, $root, "link", "", $attributes);
1336 $attributes = ["rel" => "enclosure",
1337 "href" => $siteinfo["url"],
1338 "type" => "text/html; charset=UTF-8",
1340 "title" => $siteinfo["title"]];
1341 XML::addElement($doc, $root, "link", "", $attributes);
1347 if (!Config::get('system', 'ostatus_not_attach_preview') && ($siteinfo["type"] != "photo") && isset($siteinfo["image"])) {
1348 $imgdata = Image::getInfoFromURL($siteinfo["image"]);
1349 $attributes = ["rel" => "enclosure",
1350 "href" => $siteinfo["image"],
1351 "type" => $imgdata["mime"],
1352 "length" => intval($imgdata["size"])];
1354 XML::addElement($doc, $root, "link", "", $attributes);
1357 $arr = explode('[/attach],', $item['attach']);
1359 foreach ($arr as $r) {
1361 $cnt = preg_match('|\[attach\]href=\"(.*?)\" length=\"(.*?)\" type=\"(.*?)\" title=\"(.*?)\"|', $r, $matches);
1363 $attributes = ["rel" => "enclosure",
1364 "href" => $matches[1],
1365 "type" => $matches[3]];
1367 if (intval($matches[2])) {
1368 $attributes["length"] = intval($matches[2]);
1370 if (trim($matches[4]) != "") {
1371 $attributes["title"] = trim($matches[4]);
1373 XML::addElement($doc, $root, "link", "", $attributes);
1380 * @brief Adds the author element to the XML document
1382 * @param object $doc XML document
1383 * @param array $owner Contact data of the poster
1385 * @return object author element
1387 private static function addAuthor($doc, $owner)
1389 $profile = dba::selectFirst('profile', ['homepage', 'publish'], ['uid' => $owner['uid'], 'is-default' => true]);
1390 $author = $doc->createElement("author");
1391 XML::addElement($doc, $author, "id", $owner["url"]);
1392 XML::addElement($doc, $author, "activity:object-type", ACTIVITY_OBJ_PERSON);
1393 XML::addElement($doc, $author, "uri", $owner["url"]);
1394 XML::addElement($doc, $author, "name", $owner["nick"]);
1395 XML::addElement($doc, $author, "email", $owner["addr"]);
1396 XML::addElement($doc, $author, "summary", BBCode::convert($owner["about"], false, 7));
1398 $attributes = ["rel" => "alternate", "type" => "text/html", "href" => $owner["url"]];
1399 XML::addElement($doc, $author, "link", "", $attributes);
1403 "type" => "image/jpeg", // To-Do?
1404 "media:width" => 175,
1405 "media:height" => 175,
1406 "href" => $owner["photo"]];
1407 XML::addElement($doc, $author, "link", "", $attributes);
1409 if (isset($owner["thumb"])) {
1412 "type" => "image/jpeg", // To-Do?
1413 "media:width" => 80,
1414 "media:height" => 80,
1415 "href" => $owner["thumb"]];
1416 XML::addElement($doc, $author, "link", "", $attributes);
1419 XML::addElement($doc, $author, "poco:preferredUsername", $owner["nick"]);
1420 XML::addElement($doc, $author, "poco:displayName", $owner["name"]);
1421 XML::addElement($doc, $author, "poco:note", BBCode::convert($owner["about"], false, 7));
1423 if (trim($owner["location"]) != "") {
1424 $element = $doc->createElement("poco:address");
1425 XML::addElement($doc, $element, "poco:formatted", $owner["location"]);
1426 $author->appendChild($element);
1429 if (DBM::is_result($profile)) {
1430 if (trim($profile["homepage"]) != "") {
1431 $urls = $doc->createElement("poco:urls");
1432 XML::addElement($doc, $urls, "poco:type", "homepage");
1433 XML::addElement($doc, $urls, "poco:value", $profile["homepage"]);
1434 XML::addElement($doc, $urls, "poco:primary", "true");
1435 $author->appendChild($urls);
1438 XML::addElement($doc, $author, "followers", "", ["url" => System::baseUrl()."/viewcontacts/".$owner["nick"]]);
1439 XML::addElement($doc, $author, "statusnet:profile_info", "", ["local_id" => $owner["uid"]]);
1442 if ($profile["publish"]) {
1443 XML::addElement($doc, $author, "mastodon:scope", "public");
1449 * @TODO Picture attachments should look like this:
1450 * <a href="https://status.pirati.ca/attachment/572819" title="https://status.pirati.ca/file/heluecht-20151202T222602-rd3u49p.gif"
1451 * class="attachment thumbnail" id="attachment-572819" rel="nofollow external">https://status.pirati.ca/attachment/572819</a>
1455 * @brief Returns the given activity if present - otherwise returns the "post" activity
1457 * @param array $item Data of the item that is to be posted
1459 * @return string activity
1461 private static function constructVerb($item)
1463 if ($item['verb']) {
1464 return $item['verb'];
1467 return ACTIVITY_POST;
1471 * @brief Returns the given object type if present - otherwise returns the "note" object type
1473 * @param array $item Data of the item that is to be posted
1475 * @return string Object type
1477 private static function constructObjecttype($item)
1479 if (in_array($item['object-type'], [ACTIVITY_OBJ_NOTE, ACTIVITY_OBJ_COMMENT]))
1480 return $item['object-type'];
1481 return ACTIVITY_OBJ_NOTE;
1485 * @brief Adds an entry element to the XML document
1487 * @param object $doc XML document
1488 * @param array $item Data of the item that is to be posted
1489 * @param array $owner Contact data of the poster
1490 * @param bool $toplevel optional default false
1492 * @return object Entry element
1494 private static function entry($doc, $item, $owner, $toplevel = false)
1498 $repeated_guid = self::getResharedGuid($item);
1499 if ($repeated_guid != "") {
1500 $xml = self::reshareEntry($doc, $item, $owner, $repeated_guid, $toplevel);
1507 if ($item["verb"] == ACTIVITY_LIKE) {
1508 return self::likeEntry($doc, $item, $owner, $toplevel);
1509 } elseif (in_array($item["verb"], [ACTIVITY_FOLLOW, NAMESPACE_OSTATUS."/unfollow"])) {
1510 return self::followEntry($doc, $item, $owner, $toplevel);
1512 return self::noteEntry($doc, $item, $owner, $toplevel);
1517 * @brief Adds a source entry to the XML document
1519 * @param object $doc XML document
1520 * @param array $contact Array of the contact that is added
1522 * @return object Source element
1524 private static function sourceEntry($doc, $contact)
1526 $source = $doc->createElement("source");
1527 XML::addElement($doc, $source, "id", $contact["poll"]);
1528 XML::addElement($doc, $source, "title", $contact["name"]);
1529 XML::addElement($doc, $source, "link", "", ["rel" => "alternate", "type" => "text/html", "href" => $contact["alias"]]);
1530 XML::addElement($doc, $source, "link", "", ["rel" => "self", "type" => "application/atom+xml", "href" => $contact["poll"]]);
1531 XML::addElement($doc, $source, "icon", $contact["photo"]);
1532 XML::addElement($doc, $source, "updated", DateTimeFormat::utc($contact["success_update"]."+00:00", DateTimeFormat::ATOM));
1538 * @brief Fetches contact data from the contact or the gcontact table
1540 * @param string $url URL of the contact
1541 * @param array $owner Contact data of the poster
1543 * @return array Contact array
1545 private static function contactEntry($url, $owner)
1548 "SELECT * FROM `contact` WHERE `nurl` = '%s' AND `uid` IN (0, %d) ORDER BY `uid` DESC LIMIT 1",
1549 dbesc(normalise_link($url)),
1550 intval($owner["uid"])
1552 if (DBM::is_result($r)) {
1554 $contact["uid"] = -1;
1557 if (!DBM::is_result($r)) {
1559 "SELECT * FROM `gcontact` WHERE `nurl` = '%s' LIMIT 1",
1560 dbesc(normalise_link($url))
1562 if (DBM::is_result($r)) {
1564 $contact["uid"] = -1;
1565 $contact["success_update"] = $contact["updated"];
1569 if (!DBM::is_result($r)) {
1573 if (!isset($contact["poll"])) {
1574 $data = Probe::uri($url);
1575 $contact["poll"] = $data["poll"];
1577 if (!$contact["alias"]) {
1578 $contact["alias"] = $data["alias"];
1582 if (!isset($contact["alias"])) {
1583 $contact["alias"] = $contact["url"];
1590 * @brief Adds an entry element with reshared content
1592 * @param object $doc XML document
1593 * @param array $item Data of the item that is to be posted
1594 * @param array $owner Contact data of the poster
1595 * @param string $repeated_guid guid
1596 * @param bool $toplevel Is it for en entry element (false) or a feed entry (true)?
1598 * @return object Entry element
1600 private static function reshareEntry($doc, $item, $owner, $repeated_guid, $toplevel)
1602 if (($item["id"] != $item["parent"]) && (normalise_link($item["author-link"]) != normalise_link($owner["url"]))) {
1603 logger("OStatus entry is from author ".$owner["url"]." - not from ".$item["author-link"].". Quitting.", LOGGER_DEBUG);
1606 $title = self::entryHeader($doc, $entry, $owner, $toplevel);
1609 "SELECT * FROM `item` WHERE `uid` = %d AND `guid` = '%s' AND NOT `private` AND `network` IN ('%s', '%s', '%s') LIMIT 1",
1610 intval($owner["uid"]),
1611 dbesc($repeated_guid),
1612 dbesc(NETWORK_DFRN),
1613 dbesc(NETWORK_DIASPORA),
1614 dbesc(NETWORK_OSTATUS)
1616 if (DBM::is_result($r)) {
1617 $repeated_item = $r[0];
1621 $contact = self::contactEntry($repeated_item['author-link'], $owner);
1623 $parent_item = (($item['thr-parent']) ? $item['thr-parent'] : $item['parent-uri']);
1625 $title = $owner["nick"]." repeated a notice by ".$contact["nick"];
1627 self::entryContent($doc, $entry, $item, $owner, $title, ACTIVITY_SHARE, false);
1629 $as_object = $doc->createElement("activity:object");
1631 XML::addElement($doc, $as_object, "activity:object-type", NAMESPACE_ACTIVITY_SCHEMA."activity");
1633 self::entryContent($doc, $as_object, $repeated_item, $owner, "", "", false);
1635 $author = self::addAuthor($doc, $contact);
1636 $as_object->appendChild($author);
1638 $as_object2 = $doc->createElement("activity:object");
1640 XML::addElement($doc, $as_object2, "activity:object-type", self::constructObjecttype($repeated_item));
1642 $title = sprintf("New comment by %s", $contact["nick"]);
1644 self::entryContent($doc, $as_object2, $repeated_item, $owner, $title);
1646 $as_object->appendChild($as_object2);
1648 self::entryFooter($doc, $as_object, $item, $owner, false);
1650 $source = self::sourceEntry($doc, $contact);
1652 $as_object->appendChild($source);
1654 $entry->appendChild($as_object);
1656 self::entryFooter($doc, $entry, $item, $owner);
1662 * @brief Adds an entry element with a "like"
1664 * @param object $doc XML document
1665 * @param array $item Data of the item that is to be posted
1666 * @param array $owner Contact data of the poster
1667 * @param bool $toplevel Is it for en entry element (false) or a feed entry (true)?
1669 * @return object Entry element with "like"
1671 private static function likeEntry($doc, $item, $owner, $toplevel)
1673 if (($item["id"] != $item["parent"]) && (normalise_link($item["author-link"]) != normalise_link($owner["url"]))) {
1674 logger("OStatus entry is from author ".$owner["url"]." - not from ".$item["author-link"].". Quitting.", LOGGER_DEBUG);
1677 $title = self::entryHeader($doc, $entry, $owner, $toplevel);
1679 $verb = NAMESPACE_ACTIVITY_SCHEMA."favorite";
1680 self::entryContent($doc, $entry, $item, $owner, "Favorite", $verb, false);
1682 $as_object = $doc->createElement("activity:object");
1685 "SELECT * FROM `item` WHERE `uri` = '%s' AND `uid` = %d",
1686 dbesc($item["thr-parent"]),
1687 intval($item["uid"])
1689 $parent_item = (($item['thr-parent']) ? $item['thr-parent'] : $item['parent-uri']);
1691 XML::addElement($doc, $as_object, "activity:object-type", self::constructObjecttype($parent[0]));
1693 self::entryContent($doc, $as_object, $parent[0], $owner, "New entry");
1695 $entry->appendChild($as_object);
1697 self::entryFooter($doc, $entry, $item, $owner);
1703 * @brief Adds the person object element to the XML document
1705 * @param object $doc XML document
1706 * @param array $owner Contact data of the poster
1707 * @param array $contact Contact data of the target
1709 * @return object author element
1711 private static function addPersonObject($doc, $owner, $contact)
1713 $object = $doc->createElement("activity:object");
1714 XML::addElement($doc, $object, "activity:object-type", ACTIVITY_OBJ_PERSON);
1716 if ($contact['network'] == NETWORK_PHANTOM) {
1717 XML::addElement($doc, $object, "id", $contact['url']);
1721 XML::addElement($doc, $object, "id", $contact["alias"]);
1722 XML::addElement($doc, $object, "title", $contact["nick"]);
1724 $attributes = ["rel" => "alternate", "type" => "text/html", "href" => $contact["url"]];
1725 XML::addElement($doc, $object, "link", "", $attributes);
1729 "type" => "image/jpeg", // To-Do?
1730 "media:width" => 175,
1731 "media:height" => 175,
1732 "href" => $contact["photo"]];
1733 XML::addElement($doc, $object, "link", "", $attributes);
1735 XML::addElement($doc, $object, "poco:preferredUsername", $contact["nick"]);
1736 XML::addElement($doc, $object, "poco:displayName", $contact["name"]);
1738 if (trim($contact["location"]) != "") {
1739 $element = $doc->createElement("poco:address");
1740 XML::addElement($doc, $element, "poco:formatted", $contact["location"]);
1741 $object->appendChild($element);
1748 * @brief Adds a follow/unfollow entry element
1750 * @param object $doc XML document
1751 * @param array $item Data of the follow/unfollow message
1752 * @param array $owner Contact data of the poster
1753 * @param bool $toplevel Is it for en entry element (false) or a feed entry (true)?
1755 * @return object Entry element
1757 private static function followEntry($doc, $item, $owner, $toplevel)
1759 $item["id"] = $item["parent"] = 0;
1760 $item["created"] = $item["edited"] = date("c");
1761 $item["private"] = true;
1763 $contact = Probe::uri($item['follow']);
1765 if ($contact['alias'] == '') {
1766 $contact['alias'] = $contact["url"];
1768 $item['follow'] = $contact['alias'];
1772 "SELECT `id` FROM `contact` WHERE `uid` = %d AND `nurl` = '%s'",
1773 intval($owner['uid']),
1774 dbesc(normalise_link($contact["url"]))
1777 if (DBM::is_result($r)) {
1778 $connect_id = $r[0]['id'];
1783 if ($item['verb'] == ACTIVITY_FOLLOW) {
1784 $message = L10n::t('%s is now following %s.');
1785 $title = L10n::t('following');
1786 $action = "subscription";
1788 $message = L10n::t('%s stopped following %s.');
1789 $title = L10n::t('stopped following');
1790 $action = "unfollow";
1793 $item["uri"] = $item['parent-uri'] = $item['thr-parent']
1794 = 'tag:'.get_app()->get_hostname().
1795 ','.date('Y-m-d').':'.$action.':'.$owner['uid'].
1796 ':person:'.$connect_id.':'.$item['created'];
1798 $item["body"] = sprintf($message, $owner["nick"], $contact["nick"]);
1800 self::entryHeader($doc, $entry, $owner, $toplevel);
1802 self::entryContent($doc, $entry, $item, $owner, $title);
1804 $object = self::addPersonObject($doc, $owner, $contact);
1805 $entry->appendChild($object);
1807 self::entryFooter($doc, $entry, $item, $owner);
1813 * @brief Adds a regular entry element
1815 * @param object $doc XML document
1816 * @param array $item Data of the item that is to be posted
1817 * @param array $owner Contact data of the poster
1818 * @param bool $toplevel Is it for en entry element (false) or a feed entry (true)?
1820 * @return object Entry element
1822 private static function noteEntry($doc, $item, $owner, $toplevel)
1824 if (($item["id"] != $item["parent"]) && (normalise_link($item["author-link"]) != normalise_link($owner["url"]))) {
1825 logger("OStatus entry is from author ".$owner["url"]." - not from ".$item["author-link"].". Quitting.", LOGGER_DEBUG);
1828 $title = self::entryHeader($doc, $entry, $owner, $toplevel);
1830 XML::addElement($doc, $entry, "activity:object-type", ACTIVITY_OBJ_NOTE);
1832 self::entryContent($doc, $entry, $item, $owner, $title);
1834 self::entryFooter($doc, $entry, $item, $owner);
1840 * @brief Adds a header element to the XML document
1842 * @param object $doc XML document
1843 * @param object $entry The entry element where the elements are added
1844 * @param array $owner Contact data of the poster
1845 * @param bool $toplevel Is it for en entry element (false) or a feed entry (true)?
1847 * @return string The title for the element
1849 private static function entryHeader($doc, &$entry, $owner, $toplevel)
1851 /// @todo Check if this title stuff is really needed (I guess not)
1853 $entry = $doc->createElement("entry");
1854 $title = sprintf("New note by %s", $owner["nick"]);
1856 $entry = $doc->createElementNS(NAMESPACE_ATOM1, "entry");
1858 $entry->setAttribute("xmlns:thr", NAMESPACE_THREAD);
1859 $entry->setAttribute("xmlns:georss", NAMESPACE_GEORSS);
1860 $entry->setAttribute("xmlns:activity", NAMESPACE_ACTIVITY);
1861 $entry->setAttribute("xmlns:media", NAMESPACE_MEDIA);
1862 $entry->setAttribute("xmlns:poco", NAMESPACE_POCO);
1863 $entry->setAttribute("xmlns:ostatus", NAMESPACE_OSTATUS);
1864 $entry->setAttribute("xmlns:statusnet", NAMESPACE_STATUSNET);
1865 $entry->setAttribute("xmlns:mastodon", NAMESPACE_MASTODON);
1867 $author = self::addAuthor($doc, $owner);
1868 $entry->appendChild($author);
1870 $title = sprintf("New comment by %s", $owner["nick"]);
1876 * @brief Adds elements to the XML document
1878 * @param object $doc XML document
1879 * @param object $entry Entry element where the content is added
1880 * @param array $item Data of the item that is to be posted
1881 * @param array $owner Contact data of the poster
1882 * @param string $title Title for the post
1883 * @param string $verb The activity verb
1884 * @param bool $complete Add the "status_net" element?
1887 private static function entryContent($doc, $entry, $item, $owner, $title, $verb = "", $complete = true)
1890 $verb = self::constructVerb($item);
1893 XML::addElement($doc, $entry, "id", $item["uri"]);
1894 XML::addElement($doc, $entry, "title", $title);
1896 $body = self::formatPicturePost($item['body']);
1898 if ($item['title'] != "") {
1899 $body = "[b]".$item['title']."[/b]\n\n".$body;
1902 $body = BBCode::convert($body, false, 7);
1904 XML::addElement($doc, $entry, "content", $body, ["type" => "html"]);
1906 XML::addElement($doc, $entry, "link", "", ["rel" => "alternate", "type" => "text/html",
1907 "href" => System::baseUrl()."/display/".$item["guid"]]
1910 if ($complete && ($item["id"] > 0)) {
1911 XML::addElement($doc, $entry, "status_net", "", ["notice_id" => $item["id"]]);
1914 XML::addElement($doc, $entry, "activity:verb", $verb);
1916 XML::addElement($doc, $entry, "published", DateTimeFormat::utc($item["created"]."+00:00", DateTimeFormat::ATOM));
1917 XML::addElement($doc, $entry, "updated", DateTimeFormat::utc($item["edited"]."+00:00", DateTimeFormat::ATOM));
1921 * @brief Adds the elements at the foot of an entry to the XML document
1923 * @param object $doc XML document
1924 * @param object $entry The entry element where the elements are added
1925 * @param array $item Data of the item that is to be posted
1926 * @param array $owner Contact data of the poster
1927 * @param bool $complete default true
1930 private static function entryFooter($doc, $entry, $item, $owner, $complete = true)
1934 if (($item['parent'] != $item['id']) || ($item['parent-uri'] !== $item['uri']) || (($item['thr-parent'] !== '') && ($item['thr-parent'] !== $item['uri']))) {
1935 $parent = q("SELECT `guid`, `author-link`, `owner-link` FROM `item` WHERE `id` = %d", intval($item["parent"]));
1936 $parent_item = (($item['thr-parent']) ? $item['thr-parent'] : $item['parent-uri']);
1939 "SELECT `guid`, `author-link`, `owner-link`, `plink` FROM `item` WHERE `uid` = %d AND `uri` = '%s'",
1940 intval($owner["uid"]),
1944 $mentioned[$thrparent[0]["author-link"]] = $thrparent[0]["author-link"];
1945 $mentioned[$thrparent[0]["owner-link"]] = $thrparent[0]["owner-link"];
1946 $parent_plink = $thrparent[0]["plink"];
1948 $mentioned[$parent[0]["author-link"]] = $parent[0]["author-link"];
1949 $mentioned[$parent[0]["owner-link"]] = $parent[0]["owner-link"];
1950 $parent_plink = System::baseUrl()."/display/".$parent[0]["guid"];
1954 "ref" => $parent_item,
1955 "href" => $parent_plink];
1956 XML::addElement($doc, $entry, "thr:in-reply-to", "", $attributes);
1960 "href" => $parent_plink];
1961 XML::addElement($doc, $entry, "link", "", $attributes);
1964 if (intval($item["parent"]) > 0) {
1965 $conversation_href = System::baseUrl()."/display/".$owner["nick"]."/".$item["parent"];
1966 $conversation_uri = $conversation_href;
1968 if (isset($parent_item)) {
1969 $r = dba::fetch_first("SELECT `conversation-uri`, `conversation-href` FROM `conversation` WHERE `item-uri` = ?", $parent_item);
1970 if (DBM::is_result($r)) {
1971 if ($r['conversation-uri'] != '') {
1972 $conversation_uri = $r['conversation-uri'];
1974 if ($r['conversation-href'] != '') {
1975 $conversation_href = $r['conversation-href'];
1980 XML::addElement($doc, $entry, "link", "", ["rel" => "ostatus:conversation", "href" => $conversation_href]);
1983 "href" => $conversation_href,
1984 "local_id" => $item["parent"],
1985 "ref" => $conversation_uri];
1987 XML::addElement($doc, $entry, "ostatus:conversation", $conversation_uri, $attributes);
1990 $tags = item::getFeedTags($item);
1993 foreach ($tags as $t) {
1995 $mentioned[$t[1]] = $t[1];
2000 // Make sure that mentions are accepted (GNU Social has problems with mixing HTTP and HTTPS)
2002 foreach ($mentioned as $mention) {
2003 $newmentions[str_replace("http://", "https://", $mention)] = str_replace("http://", "https://", $mention);
2004 $newmentions[str_replace("https://", "http://", $mention)] = str_replace("https://", "http://", $mention);
2006 $mentioned = $newmentions;
2008 foreach ($mentioned as $mention) {
2010 "SELECT `forum`, `prv` FROM `contact` WHERE `uid` = %d AND `nurl` = '%s'",
2011 intval($owner["uid"]),
2012 dbesc(normalise_link($mention))
2014 if ($r[0]["forum"] || $r[0]["prv"]) {
2015 XML::addElement($doc, $entry, "link", "",
2017 "rel" => "mentioned",
2018 "ostatus:object-type" => ACTIVITY_OBJ_GROUP,
2022 XML::addElement($doc, $entry, "link", "",
2024 "rel" => "mentioned",
2025 "ostatus:object-type" => ACTIVITY_OBJ_PERSON,
2031 if (!$item["private"]) {
2032 XML::addElement($doc, $entry, "link", "", ["rel" => "ostatus:attention",
2033 "href" => "http://activityschema.org/collection/public"]);
2034 XML::addElement($doc, $entry, "link", "", ["rel" => "mentioned",
2035 "ostatus:object-type" => "http://activitystrea.ms/schema/1.0/collection",
2036 "href" => "http://activityschema.org/collection/public"]);
2037 XML::addElement($doc, $entry, "mastodon:scope", "public");
2041 foreach ($tags as $t) {
2043 XML::addElement($doc, $entry, "category", "", ["term" => $t[2]]);
2048 self::getAttachment($doc, $entry, $item);
2050 if ($complete && ($item["id"] > 0)) {
2051 $app = $item["app"];
2056 $attributes = ["local_id" => $item["id"], "source" => $app];
2058 if (isset($parent["id"])) {
2059 $attributes["repeat_of"] = $parent["id"];
2062 if ($item["coord"] != "") {
2063 XML::addElement($doc, $entry, "georss:point", $item["coord"]);
2066 XML::addElement($doc, $entry, "statusnet:notice_info", "", $attributes);
2071 * Creates the XML feed for a given nickname
2073 * Supported filters:
2074 * - activity (default): all the public posts
2075 * - posts: all the public top-level posts
2076 * - comments: all the public replies
2078 * Updates the provided last_update parameter if the result comes from the
2079 * cache or it is empty
2081 * @brief Creates the XML feed for a given nickname
2083 * @param string $owner_nick Nickname of the feed owner
2084 * @param string $last_update Date of the last update
2085 * @param integer $max_items Number of maximum items to fetch
2086 * @param string $filter Feed items filter (activity, posts or comments)
2087 * @param boolean $nocache Wether to bypass caching
2089 * @return string XML feed
2091 public static function feed($owner_nick, &$last_update, $max_items = 300, $filter = 'activity', $nocache = false)
2093 $stamp = microtime(true);
2095 $cachekey = "ostatus:feed:" . $owner_nick . ":" . $filter . ":" . $last_update;
2097 $previous_created = $last_update;
2099 $result = Cache::get($cachekey);
2100 if (!$nocache && !is_null($result)) {
2101 logger('Feed duration: ' . number_format(microtime(true) - $stamp, 3) . ' - ' . $owner_nick . ' - ' . $filter . ' - ' . $previous_created . ' (cached)', LOGGER_DEBUG);
2102 $last_update = $result['last_update'];
2103 return $result['feed'];
2106 $owner = dba::fetch_first(
2107 "SELECT `contact`.*, `user`.`nickname`, `user`.`timezone`, `user`.`page-flags`, `user`.`account-type`
2108 FROM `contact` INNER JOIN `user` ON `user`.`uid` = `contact`.`uid`
2109 WHERE `contact`.`self` AND `user`.`nickname` = ? LIMIT 1",
2112 if (!DBM::is_result($owner)) {
2116 if (!strlen($last_update)) {
2117 $last_update = 'now -30 days';
2120 $check_date = DateTimeFormat::utc($last_update);
2121 $authorid = Contact::getIdForURL($owner["url"], 0, true);
2124 if ($filter === 'posts') {
2125 $sql_extra .= ' AND `item`.`id` = `item`.`parent` ';
2128 if ($filter === 'comments') {
2129 $sql_extra .= sprintf(" AND `item`.`object-type` = '%s' ", dbesc(ACTIVITY_OBJ_COMMENT));
2132 if ($owner['account-type'] != ACCOUNT_TYPE_COMMUNITY) {
2133 $sql_extra .= sprintf(" AND `item`.`contact-id` = %d AND `item`.`author-id` = %d ", intval($owner["id"]), intval($authorid));
2137 "SELECT `item`.*, `item`.`id` AS `item_id` FROM `item` USE INDEX (`uid_contactid_created`)
2138 STRAIGHT_JOIN `thread` ON `thread`.`iid` = `item`.`parent`
2139 WHERE `item`.`uid` = %d
2140 AND `item`.`created` > '%s'
2141 AND NOT `item`.`deleted`
2142 AND NOT `item`.`private`
2143 AND `item`.`visible`
2145 AND `thread`.`network` IN ('%s', '%s')
2147 ORDER BY `item`.`created` DESC LIMIT %d",
2148 intval($owner["uid"]),
2150 dbesc(NETWORK_OSTATUS),
2151 dbesc(NETWORK_DFRN),
2155 $doc = new DOMDocument('1.0', 'utf-8');
2156 $doc->formatOutput = true;
2158 $root = self::addHeader($doc, $owner, $filter);
2160 foreach ($items as $item) {
2161 if (Config::get('system', 'ostatus_debug')) {
2162 $item['body'] .= '🍼';
2164 $entry = self::entry($doc, $item, $owner);
2165 $root->appendChild($entry);
2167 if ($last_update < $item['created']) {
2168 $last_update = $item['created'];
2172 $feeddata = trim($doc->saveXML());
2174 $msg = ['feed' => $feeddata, 'last_update' => $last_update];
2175 Cache::set($cachekey, $msg, CACHE_QUARTER_HOUR);
2177 logger('Feed duration: ' . number_format(microtime(true) - $stamp, 3) . ' - ' . $owner_nick . ' - ' . $filter . ' - ' . $previous_created, LOGGER_DEBUG);
2183 * @brief Creates the XML for a salmon message
2185 * @param array $item Data of the item that is to be posted
2186 * @param array $owner Contact data of the poster
2188 * @return string XML for the salmon
2190 public static function salmon($item, $owner)
2192 $doc = new DOMDocument('1.0', 'utf-8');
2193 $doc->formatOutput = true;
2195 if (Config::get('system', 'ostatus_debug')) {
2196 $item['body'] .= '🐟';
2199 $entry = self::entry($doc, $item, $owner, true);
2201 $doc->appendChild($entry);
2203 return trim($doc->saveXML());