3 * @copyright Copyright (C) 2010-2022, 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;
24 use Friendica\Content\Feature;
25 use Friendica\Content\Text\BBCode;
26 use Friendica\Content\Text\Markdown;
27 use Friendica\Core\Cache\Enum\Duration;
28 use Friendica\Core\Logger;
29 use Friendica\Core\Protocol;
30 use Friendica\Core\System;
31 use Friendica\Core\Worker;
32 use Friendica\Database\DBA;
34 use Friendica\Model\Contact;
35 use Friendica\Model\Conversation;
36 use Friendica\Model\FContact;
37 use Friendica\Model\GServer;
38 use Friendica\Model\Item;
39 use Friendica\Model\ItemURI;
40 use Friendica\Model\Mail;
41 use Friendica\Model\Post;
42 use Friendica\Model\Tag;
43 use Friendica\Model\User;
44 use Friendica\Network\Probe;
45 use Friendica\Util\Crypto;
46 use Friendica\Util\DateTimeFormat;
47 use Friendica\Util\Map;
48 use Friendica\Util\Network;
49 use Friendica\Util\Strings;
50 use Friendica\Util\XML;
51 use Friendica\Worker\Delivery;
55 * This class contain functions to create and send Diaspora XML files
60 * Return a list of participating contacts for a thread
62 * This is used for the participation feature.
63 * One of the parameters is a contact array.
64 * This is done to avoid duplicates.
66 * @param array $item Item that is about to be delivered
67 * @param array $contacts The previously fetched contacts
69 * @return array of relay servers
72 public static function participantsForThread(array $item, array $contacts)
74 if (!in_array($item['private'], [Item::PUBLIC, Item::UNLISTED]) || in_array($item["verb"], [Activity::FOLLOW, Activity::TAG])) {
75 Logger::info('Item is private or a participation request. It will not be relayed', ['guid' => $item['guid'], 'private' => $item['private'], 'verb' => $item['verb']]);
79 $items = Post::select(['author-id', 'author-link', 'parent-author-link', 'parent-guid', 'guid'],
80 ['parent' => $item['parent'], 'gravity' => [GRAVITY_COMMENT, GRAVITY_ACTIVITY]]);
81 while ($item = Post::fetch($items)) {
82 $contact = DBA::selectFirst('contact', ['id', 'url', 'name', 'protocol', 'batch', 'network'],
83 ['id' => $item['author-id']]);
84 if (!DBA::isResult($contact) || empty($contact['batch']) ||
85 ($contact['network'] != Protocol::DIASPORA) ||
86 Strings::compareLink($item['parent-author-link'], $item['author-link'])) {
91 foreach ($contacts as $entry) {
92 if ($entry['batch'] == $contact['batch']) {
98 Logger::info('Add participant to receiver list', ['parent' => $item['parent-guid'], 'item' => $item['guid'], 'participant' => $contact['url']]);
99 $contacts[] = $contact;
108 * verify the envelope and return the verified data
110 * @param string $envelope The magic envelope
112 * @return string verified data
113 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
114 * @throws \ImagickException
116 private static function verifyMagicEnvelope($envelope)
118 $basedom = XML::parseString($envelope, true);
120 if (!is_object($basedom)) {
121 Logger::notice("Envelope is no XML file");
125 $children = $basedom->children('http://salmon-protocol.org/ns/magic-env');
127 if (sizeof($children) == 0) {
128 Logger::notice("XML has no children");
134 $data = Strings::base64UrlDecode($children->data);
135 $type = $children->data->attributes()->type[0];
137 $encoding = $children->encoding;
139 $alg = $children->alg;
141 $sig = Strings::base64UrlDecode($children->sig);
142 $key_id = $children->sig->attributes()->key_id[0];
144 $handle = Strings::base64UrlDecode($key_id);
147 $b64url_data = Strings::base64UrlEncode($data);
148 $msg = str_replace(["\n", "\r", " ", "\t"], ["", "", "", ""], $b64url_data);
150 $signable_data = $msg.".".Strings::base64UrlEncode($type).".".Strings::base64UrlEncode($encoding).".".Strings::base64UrlEncode($alg);
153 Logger::notice('No author could be decoded. Discarding. Message: ' . $envelope);
157 $key = self::key($handle);
159 Logger::notice("Couldn't get a key for handle " . $handle . ". Discarding.");
163 $verify = Crypto::rsaVerify($signable_data, $sig, $key);
165 Logger::notice('Message from ' . $handle . ' did not verify. Discarding.');
173 * encrypts data via AES
175 * @param string $key The AES key
176 * @param string $iv The IV (is used for CBC encoding)
177 * @param string $data The data that is to be encrypted
179 * @return string encrypted data
181 private static function aesEncrypt($key, $iv, $data)
183 return openssl_encrypt($data, 'aes-256-cbc', str_pad($key, 32, "\0"), OPENSSL_RAW_DATA, str_pad($iv, 16, "\0"));
187 * decrypts data via AES
189 * @param string $key The AES key
190 * @param string $iv The IV (is used for CBC encoding)
191 * @param string $encrypted The encrypted data
193 * @return string decrypted data
195 private static function aesDecrypt($key, $iv, $encrypted)
197 return openssl_decrypt($encrypted, 'aes-256-cbc', str_pad($key, 32, "\0"), OPENSSL_RAW_DATA, str_pad($iv, 16, "\0"));
201 * Decodes incoming Diaspora message in the new format
203 * @param string $raw raw post message
204 * @param string $privKey The private key of the importer
205 * @param boolean $no_exit Don't do an http exit on error
208 * 'message' -> decoded Diaspora XML message
209 * 'author' -> author diaspora handle
210 * 'key' -> author public key (converted to pkcs#8)
211 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
212 * @throws \ImagickException
214 public static function decodeRaw(string $raw, string $privKey = '', bool $no_exit = false)
216 $data = json_decode($raw);
218 // Is it a private post? Then decrypt the outer Salmon
219 if (is_object($data)) {
220 $encrypted_aes_key_bundle = base64_decode($data->aes_key);
221 $ciphertext = base64_decode($data->encrypted_magic_envelope);
223 $outer_key_bundle = '';
224 @openssl_private_decrypt($encrypted_aes_key_bundle, $outer_key_bundle, $privKey);
225 $j_outer_key_bundle = json_decode($outer_key_bundle);
227 if (!is_object($j_outer_key_bundle)) {
228 Logger::notice('Outer Salmon did not verify. Discarding.');
232 throw new \Friendica\Network\HTTPException\BadRequestException();
236 $outer_iv = base64_decode($j_outer_key_bundle->iv);
237 $outer_key = base64_decode($j_outer_key_bundle->key);
239 $xml = self::aesDecrypt($outer_key, $outer_iv, $ciphertext);
244 $basedom = XML::parseString($xml, true);
246 if (!is_object($basedom)) {
247 Logger::notice('Received data does not seem to be an XML. Discarding. '.$xml);
251 throw new \Friendica\Network\HTTPException\BadRequestException();
255 $base = $basedom->children(ActivityNamespace::SALMON_ME);
257 // Not sure if this cleaning is needed
258 $data = str_replace([" ", "\t", "\r", "\n"], ["", "", "", ""], $base->data);
260 // Build the signed data
261 $type = $base->data[0]->attributes()->type[0];
262 $encoding = $base->encoding;
264 $signed_data = $data.'.'.Strings::base64UrlEncode($type).'.'.Strings::base64UrlEncode($encoding).'.'.Strings::base64UrlEncode($alg);
266 // This is the signature
267 $signature = Strings::base64UrlDecode($base->sig);
269 // Get the senders' public key
270 $key_id = $base->sig[0]->attributes()->key_id[0];
271 $author_addr = base64_decode($key_id);
272 if ($author_addr == '') {
273 Logger::notice('No author could be decoded. Discarding. Message: ' . $xml);
277 throw new \Friendica\Network\HTTPException\BadRequestException();
281 $key = self::key($author_addr);
283 Logger::notice("Couldn't get a key for handle " . $author_addr . ". Discarding.");
287 throw new \Friendica\Network\HTTPException\BadRequestException();
291 $verify = Crypto::rsaVerify($signed_data, $signature, $key);
293 Logger::notice('Message did not verify. Discarding.');
297 throw new \Friendica\Network\HTTPException\BadRequestException();
301 return ['message' => (string)Strings::base64UrlDecode($base->data),
302 'author' => XML::unescape($author_addr),
303 'key' => (string)$key];
307 * Decodes incoming Diaspora message in the deprecated format
309 * @param string $xml urldecoded Diaspora salmon
310 * @param string $privKey The private key of the importer
313 * 'message' -> decoded Diaspora XML message
314 * 'author' -> author diaspora handle
315 * 'key' -> author public key (converted to pkcs#8)
316 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
317 * @throws \ImagickException
319 public static function decode(string $xml, string $privKey = '')
322 $basedom = XML::parseString($xml);
324 if (!is_object($basedom)) {
325 Logger::notice('XML is not parseable.');
328 $children = $basedom->children('https://joindiaspora.com/protocol');
330 $inner_aes_key = null;
333 if ($children->header) {
335 $author_link = str_replace('acct:', '', $children->header->author_id);
337 // This happens with posts from a relais
338 if (empty($privKey)) {
339 Logger::info('This is no private post in the old format');
343 $encrypted_header = json_decode(base64_decode($children->encrypted_header));
345 $encrypted_aes_key_bundle = base64_decode($encrypted_header->aes_key);
346 $ciphertext = base64_decode($encrypted_header->ciphertext);
348 $outer_key_bundle = '';
349 openssl_private_decrypt($encrypted_aes_key_bundle, $outer_key_bundle, $privKey);
351 $j_outer_key_bundle = json_decode($outer_key_bundle);
353 $outer_iv = base64_decode($j_outer_key_bundle->iv);
354 $outer_key = base64_decode($j_outer_key_bundle->key);
356 $decrypted = self::aesDecrypt($outer_key, $outer_iv, $ciphertext);
358 Logger::info('decrypted', ['data' => $decrypted]);
359 $idom = XML::parseString($decrypted);
361 $inner_iv = base64_decode($idom->iv);
362 $inner_aes_key = base64_decode($idom->aes_key);
364 $author_link = str_replace('acct:', '', $idom->author_id);
367 $dom = $basedom->children(ActivityNamespace::SALMON_ME);
369 // figure out where in the DOM tree our data is hiding
372 if ($dom->provenance->data) {
373 $base = $dom->provenance;
374 } elseif ($dom->env->data) {
376 } elseif ($dom->data) {
381 Logger::notice('unable to locate salmon data in xml');
382 throw new \Friendica\Network\HTTPException\BadRequestException();
386 // Stash the signature away for now. We have to find their key or it won't be good for anything.
387 $signature = Strings::base64UrlDecode($base->sig);
391 // strip whitespace so our data element will return to one big base64 blob
392 $data = str_replace([" ", "\t", "\r", "\n"], ["", "", "", ""], $base->data);
395 // stash away some other stuff for later
397 $type = $base->data[0]->attributes()->type[0];
398 $keyhash = $base->sig[0]->attributes()->keyhash[0];
399 $encoding = $base->encoding;
403 $signed_data = $data.'.'.Strings::base64UrlEncode($type).'.'.Strings::base64UrlEncode($encoding).'.'.Strings::base64UrlEncode($alg);
407 $data = Strings::base64UrlDecode($data);
411 $inner_decrypted = $data;
413 // Decode the encrypted blob
414 $inner_encrypted = base64_decode($data);
415 $inner_decrypted = self::aesDecrypt($inner_aes_key, $inner_iv, $inner_encrypted);
419 Logger::notice('Could not retrieve author URI.');
420 throw new \Friendica\Network\HTTPException\BadRequestException();
422 // Once we have the author URI, go to the web and try to find their public key
423 // (first this will look it up locally if it is in the fcontact cache)
424 // This will also convert diaspora public key from pkcs#1 to pkcs#8
426 Logger::notice('Fetching key for '.$author_link);
427 $key = self::key($author_link);
430 Logger::notice('Could not retrieve author key.');
431 throw new \Friendica\Network\HTTPException\BadRequestException();
434 $verify = Crypto::rsaVerify($signed_data, $signature, $key);
437 Logger::notice('Message did not verify. Discarding.');
438 throw new \Friendica\Network\HTTPException\BadRequestException();
441 Logger::notice('Message verified.');
443 return ['message' => (string)$inner_decrypted,
444 'author' => XML::unescape($author_link),
445 'key' => (string)$key];
450 * Dispatches public messages and find the fitting receivers
452 * @param array $msg The post that will be dispatched
453 * @param bool $fetched The message had been fetched (default "false")
455 * @return int The message id of the generated message, "true" or "false" if there was an error
456 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
457 * @throws \ImagickException
459 public static function dispatchPublic($msg, bool $fetched = false)
461 $enabled = intval(DI::config()->get("system", "diaspora_enabled"));
463 Logger::notice("diaspora is disabled");
467 if (!($fields = self::validPosting($msg))) {
468 Logger::notice("Invalid posting");
472 $importer = ["uid" => 0, "page-flags" => User::PAGE_FLAGS_FREELOVE];
473 $success = self::dispatch($importer, $msg, $fields, $fetched);
479 * Dispatches the different message types to the different functions
481 * @param array $importer Array of the importer user
482 * @param array $msg The post that will be dispatched
483 * @param SimpleXMLElement $fields SimpleXML object that contains the message
484 * @param bool $fetched The message had been fetched (default "false")
486 * @return int The message id of the generated message, "true" or "false" if there was an error
487 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
488 * @throws \ImagickException
490 public static function dispatch(array $importer, $msg, SimpleXMLElement $fields = null, bool $fetched = false)
492 // The sender is the handle of the contact that sent the message.
493 // This will often be different with relayed messages (for example "like" and "comment")
494 $sender = $msg["author"];
496 // This is only needed for private postings since this is already done for public ones before
497 if (is_null($fields)) {
499 if (!($fields = self::validPosting($msg))) {
500 Logger::notice("Invalid posting");
507 $type = $fields->getName();
509 Logger::info('Received message', ['type' => $type, 'sender' => $sender, 'user' => $importer["uid"]]);
512 case "account_migration":
514 Logger::notice('Message with type ' . $type . ' is not private, quitting.');
517 return self::receiveAccountMigration($importer, $fields);
519 case "account_deletion":
520 return self::receiveAccountDeletion($fields);
523 return self::receiveComment($importer, $sender, $fields, $msg["message"], $fetched);
527 Logger::notice('Message with type ' . $type . ' is not private, quitting.');
530 return self::receiveContactRequest($importer, $fields);
534 Logger::notice('Message with type ' . $type . ' is not private, quitting.');
537 return self::receiveConversation($importer, $msg, $fields);
540 return self::receiveLike($importer, $sender, $fields, $fetched);
544 Logger::notice('Message with type ' . $type . ' is not private, quitting.');
547 return self::receiveMessage($importer, $fields);
549 case "participation":
551 Logger::notice('Message with type ' . $type . ' is not private, quitting.');
554 return self::receiveParticipation($importer, $fields, $fetched);
556 case "photo": // Not implemented
557 return self::receivePhoto($importer, $fields);
559 case "poll_participation": // Not implemented
560 return self::receivePollParticipation($importer, $fields);
564 Logger::notice('Message with type ' . $type . ' is not private, quitting.');
567 return self::receiveProfile($importer, $fields);
570 return self::receiveReshare($importer, $fields, $msg["message"], $fetched);
573 return self::receiveRetraction($importer, $sender, $fields);
575 case "status_message":
576 return self::receiveStatusMessage($importer, $fields, $msg["message"], $fetched);
579 Logger::notice("Unknown message type ".$type);
585 * Checks if a posting is valid and fetches the data fields.
587 * This function does not only check the signature.
588 * It also does the conversion between the old and the new diaspora format.
590 * @param array $msg Array with the XML, the sender handle and the sender signature
592 * @return bool|SimpleXMLElement If the posting is valid then an array with an SimpleXML object is returned
593 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
594 * @throws \ImagickException
596 private static function validPosting($msg)
598 $data = XML::parseString($msg["message"]);
600 if (!is_object($data)) {
601 Logger::info('No valid XML', ['message' => $msg['message']]);
605 // Is this the new or the old version?
606 if ($data->getName() == "XML") {
608 foreach ($data->post->children() as $child) {
616 $type = $element->getName();
619 Logger::debug("Got message type ".$type.": ".$msg["message"]);
621 // All retractions are handled identically from now on.
622 // In the new version there will only be "retraction".
623 if (in_array($type, ["signed_retraction", "relayable_retraction"]))
624 $type = "retraction";
626 if ($type == "request") {
630 $fields = new SimpleXMLElement("<".$type."/>");
633 $author_signature = null;
634 $parent_author_signature = null;
636 foreach ($element->children() as $fieldname => $entry) {
638 // Translation for the old XML structure
639 if ($fieldname == "diaspora_handle") {
640 $fieldname = "author";
642 if ($fieldname == "participant_handles") {
643 $fieldname = "participants";
645 if (in_array($type, ["like", "participation"])) {
646 if ($fieldname == "target_type") {
647 $fieldname = "parent_type";
650 if ($fieldname == "sender_handle") {
651 $fieldname = "author";
653 if ($fieldname == "recipient_handle") {
654 $fieldname = "recipient";
656 if ($fieldname == "root_diaspora_id") {
657 $fieldname = "root_author";
659 if ($type == "status_message") {
660 if ($fieldname == "raw_message") {
664 if ($type == "retraction") {
665 if ($fieldname == "post_guid") {
666 $fieldname = "target_guid";
668 if ($fieldname == "type") {
669 $fieldname = "target_type";
674 if (($fieldname == "author_signature") && ($entry != "")) {
675 $author_signature = base64_decode($entry);
676 } elseif (($fieldname == "parent_author_signature") && ($entry != "")) {
677 $parent_author_signature = base64_decode($entry);
678 } elseif (!in_array($fieldname, ["author_signature", "parent_author_signature", "target_author_signature"])) {
679 if ($signed_data != "") {
683 $signed_data .= $entry;
685 if (!in_array($fieldname, ["parent_author_signature", "target_author_signature"])
686 || ($orig_type == "relayable_retraction")
688 XML::copy($entry, $fields, $fieldname);
692 // This is something that shouldn't happen at all.
693 if (in_array($type, ["status_message", "reshare", "profile"])) {
694 if ($msg["author"] != $fields->author) {
695 Logger::notice("Message handle is not the same as envelope sender. Quitting this message.");
700 // Only some message types have signatures. So we quit here for the other types.
701 if (!in_array($type, ["comment", "like"])) {
704 // No author_signature? This is a must, so we quit.
705 if (!isset($author_signature)) {
706 Logger::info("No author signature for type ".$type." - Message: ".$msg["message"]);
710 if (isset($parent_author_signature)) {
711 $key = self::key($msg["author"]);
713 Logger::info('No key found for parent', ['author' => $msg["author"]]);
717 if (!Crypto::rsaVerify($signed_data, $parent_author_signature, $key, "sha256")) {
718 Logger::info("No valid parent author signature for parent author ".$msg["author"]. " in type ".$type." - signed data: ".$signed_data." - Message: ".$msg["message"]." - Signature ".$parent_author_signature);
723 $key = self::key($fields->author);
725 Logger::info('No key found', ['author' => $fields->author]);
729 if (!Crypto::rsaVerify($signed_data, $author_signature, $key, "sha256")) {
730 Logger::info("No valid author signature for author ".$fields->author. " in type ".$type." - signed data: ".$signed_data." - Message: ".$msg["message"]." - Signature ".$author_signature);
738 * Fetches the public key for a given handle
740 * @param string $handle The handle
742 * @return string The public key
743 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
744 * @throws \ImagickException
746 private static function key($handle)
748 $handle = strval($handle);
750 Logger::notice("Fetching diaspora key for: ".$handle);
752 $r = FContact::getByURL($handle);
761 * get a handle (user@domain.tld) from a given contact id
763 * @param int $contact_id The id in the contact table
764 * @param int $pcontact_id The id in the contact table (Used for the public contact)
766 * @return string the handle
769 private static function handleFromContact($contact_id, $pcontact_id = 0)
773 if ($pcontact_id != 0) {
774 $contact = Contact::getById($pcontact_id, ['addr']);
775 if (DBA::isResult($contact)) {
776 $handle = $contact['addr'];
780 if (empty($handle)) {
781 $contact = Contact::getById($contact_id, ['addr']);
782 if (DBA::isResult($contact)) {
783 $handle = $contact['addr'];
787 return strtolower($handle);
791 * Get a contact id for a given handle
793 * @todo Move to Friendica\Model\Contact
795 * @param int $uid The user id
796 * @param string $handle The handle in the format user@domain.tld
798 * @return array Contact data
799 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
800 * @throws \ImagickException
802 private static function contactByHandle($uid, $handle)
804 return Contact::getByURL($handle, null, [], $uid);
808 * Checks if the given contact url does support ActivityPub
810 * @param string $url profile url
811 * @param boolean $update true = always update, false = never update, null = update when not found or outdated
813 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
814 * @throws \ImagickException
816 public static function isSupportedByContactUrl($url, $update = null)
818 return !empty(FContact::getByURL($url, $update));
822 * Check if posting is allowed for this contact
824 * @param array $importer Array of the importer user
825 * @param array $contact The contact that is checked
826 * @param bool $is_comment Is the check for a comment?
828 * @return bool is the contact allowed to post?
830 private static function postAllow(array $importer, array $contact, $is_comment = false)
833 * Perhaps we were already sharing with this person. Now they're sharing with us.
834 * That makes us friends.
835 * Normally this should have handled by getting a request - but this could get lost
837 // It is deactivated by now, due to side effects. See issue https://github.com/friendica/friendica/pull/4033
838 // It is not removed by now. Possibly the code is needed?
839 //if (!$is_comment && $contact["rel"] == Contact::FOLLOWER && in_array($importer["page-flags"], array(User::PAGE_FLAGS_FREELOVE))) {
841 // array('rel' => Contact::FRIEND, 'writable' => true),
842 // array('id' => $contact["id"], 'uid' => $contact["uid"])
845 // $contact["rel"] = Contact::FRIEND;
846 // Logger::notice("defining user ".$contact["nick"]." as friend");
849 // Contact server is blocked
850 if (Network::isUrlBlocked($contact['url'])) {
852 // We don't seem to like that person
853 } elseif ($contact["blocked"]) {
854 // Maybe blocked, don't accept.
856 // We are following this person?
857 } elseif (($contact["rel"] == Contact::SHARING) || ($contact["rel"] == Contact::FRIEND)) {
858 // Yes, then it is fine.
860 // Is the message a global user or a comment?
861 } elseif (($importer["uid"] == 0) || $is_comment) {
862 // Messages for the global users and comments are always accepted
870 * Fetches the contact id for a handle and checks if posting is allowed
872 * @param array $importer Array of the importer user
873 * @param string $handle The checked handle in the format user@domain.tld
874 * @param bool $is_comment Is the check for a comment?
876 * @return array The contact data
879 private static function allowedContactByHandle(array $importer, $handle, $is_comment = false)
881 $contact = self::contactByHandle($importer["uid"], $handle);
883 Logger::notice("A Contact for handle ".$handle." and user ".$importer["uid"]." was not found");
884 // If a contact isn't found, we accept it anyway if it is a comment
885 if ($is_comment && ($importer["uid"] != 0)) {
886 return self::contactByHandle(0, $handle);
887 } elseif ($is_comment) {
894 if (!self::postAllow($importer, $contact, $is_comment)) {
895 Logger::notice("The handle: ".$handle." is not allowed to post to user ".$importer["uid"]);
902 * Does the message already exists on the system?
904 * @param int $uid The user id
905 * @param string $guid The guid of the message
907 * @return int|bool message id if the message already was stored into the system - or false.
910 private static function messageExists($uid, $guid)
912 $item = Post::selectFirst(['id'], ['uid' => $uid, 'guid' => $guid]);
913 if (DBA::isResult($item)) {
914 Logger::notice("message ".$guid." already exists for user ".$uid);
922 * Checks for links to posts in a message
924 * @param array $item The item array
927 private static function fetchGuid(array $item)
929 $expression = "=diaspora://.*?/post/([0-9A-Za-z\-_@.:]{15,254}[0-9A-Za-z])=ism";
930 preg_replace_callback(
932 function ($match) use ($item) {
933 self::fetchGuidSub($match, $item);
938 preg_replace_callback(
939 "&\[url=/?posts/([^\[\]]*)\](.*)\[\/url\]&Usi",
940 function ($match) use ($item) {
941 self::fetchGuidSub($match, $item);
948 * Checks for relative /people/* links in an item body to match local
949 * contacts or prepends the remote host taken from the author link.
951 * @param string $body The item body to replace links from
952 * @param string $author_link The author link for missing local contact fallback
954 * @return string the replaced string
956 public static function replacePeopleGuid($body, $author_link)
958 $return = preg_replace_callback(
959 "&\[url=/people/([^\[\]]*)\](.*)\[\/url\]&Usi",
960 function ($match) use ($author_link) {
962 // 0 => '[url=/people/0123456789abcdef]Foo Bar[/url]'
963 // 1 => '0123456789abcdef'
965 $handle = FContact::getUrlByGuid($match[1]);
968 $return = '@[url='.$handle.']'.$match[2].'[/url]';
970 // No local match, restoring absolute remote URL from author scheme and host
971 $author_url = parse_url($author_link);
972 $return = '[url='.$author_url['scheme'].'://'.$author_url['host'].'/people/'.$match[1].']'.$match[2].'[/url]';
984 * sub function of "fetchGuid" which checks for links in messages
986 * @param array $match array containing a link that has to be checked for a message link
987 * @param array $item The item array
989 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
990 * @throws \ImagickException
992 private static function fetchGuidSub($match, $item)
994 if (!self::storeByGuid($match[1], $item["author-link"])) {
995 self::storeByGuid($match[1], $item["owner-link"]);
1000 * Fetches an item with a given guid from a given server
1002 * @param string $guid the message guid
1003 * @param string $server The server address
1004 * @param int $uid The user id of the user
1006 * @return int the message id of the stored message or false
1007 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1008 * @throws \ImagickException
1010 private static function storeByGuid($guid, $server, $uid = 0)
1012 $serverparts = parse_url($server);
1014 if (empty($serverparts["host"]) || empty($serverparts["scheme"])) {
1018 $server = $serverparts["scheme"]."://".$serverparts["host"];
1020 Logger::info("Trying to fetch item ".$guid." from ".$server);
1022 $msg = self::message($guid, $server);
1028 Logger::info("Successfully fetched item ".$guid." from ".$server);
1030 // Now call the dispatcher
1031 return self::dispatchPublic($msg, true);
1035 * Fetches a message from a server
1037 * @param string $guid message guid
1038 * @param string $server The url of the server
1039 * @param int $level Endless loop prevention
1042 * 'message' => The message XML
1043 * 'author' => The author handle
1044 * 'key' => The public key of the author
1045 * @throws \Exception
1047 public static function message($guid, $server, $level = 0)
1053 // This will work for new Diaspora servers and Friendica servers from 3.5
1054 $source_url = $server."/fetch/post/".urlencode($guid);
1056 Logger::info("Fetch post from ".$source_url);
1058 $envelope = DI::httpClient()->fetch($source_url);
1060 Logger::info("Envelope was fetched.");
1061 $x = self::verifyMagicEnvelope($envelope);
1063 Logger::info("Envelope could not be verified.");
1065 Logger::info("Envelope was verified.");
1075 $source_xml = XML::parseString($x);
1077 if (!is_object($source_xml)) {
1081 if ($source_xml->post->reshare) {
1082 // Reshare of a reshare - old Diaspora version
1083 Logger::info("Message is a reshare");
1084 return self::message($source_xml->post->reshare->root_guid, $server, ++$level);
1085 } elseif ($source_xml->getName() == "reshare") {
1086 // Reshare of a reshare - new Diaspora version
1087 Logger::info("Message is a new reshare");
1088 return self::message($source_xml->root_guid, $server, ++$level);
1093 // Fetch the author - for the old and the new Diaspora version
1094 if ($source_xml->post->status_message && $source_xml->post->status_message->diaspora_handle) {
1095 $author = (string)$source_xml->post->status_message->diaspora_handle;
1096 } elseif ($source_xml->author && ($source_xml->getName() == "status_message")) {
1097 $author = (string)$source_xml->author;
1100 // If this isn't a "status_message" then quit
1102 Logger::info("Message doesn't seem to be a status message");
1106 $msg = ["message" => $x, "author" => $author];
1108 $msg["key"] = self::key($msg["author"]);
1114 * Fetches an item with a given URL
1116 * @param string $url the message url
1118 * @return int the message id of the stored message or false
1119 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1120 * @throws \ImagickException
1122 public static function fetchByURL($url, $uid = 0)
1124 // Check for Diaspora (and Friendica) typical paths
1125 if (!preg_match("=(https?://.+)/(?:posts|display|objects)/([a-zA-Z0-9-_@.:%]+[a-zA-Z0-9])=i", $url, $matches)) {
1126 Logger::info('Invalid url', ['url' => $url]);
1130 $guid = urldecode($matches[2]);
1132 $item = Post::selectFirst(['id'], ['guid' => $guid, 'uid' => $uid]);
1133 if (DBA::isResult($item)) {
1134 Logger::info('Found', ['id' => $item['id']]);
1138 Logger::info('Fetch GUID from origin', ['guid' => $guid, 'server' => $matches[1]]);
1139 $ret = self::storeByGuid($guid, $matches[1], $uid);
1140 Logger::info('Result', ['ret' => $ret]);
1142 $item = Post::selectFirst(['id'], ['guid' => $guid, 'uid' => $uid]);
1143 if (DBA::isResult($item)) {
1144 Logger::info('Found', ['id' => $item['id']]);
1147 Logger::info('Not found', ['guid' => $guid, 'uid' => $uid]);
1153 * Fetches the item record of a given guid
1155 * @param int $uid The user id
1156 * @param string $guid message guid
1157 * @param string $author The handle of the item
1158 * @param array $contact The contact of the item owner
1160 * @return array the item record
1161 * @throws \Exception
1163 private static function parentItem($uid, $guid, $author, array $contact)
1165 $fields = ['id', 'parent', 'body', 'wall', 'uri', 'guid', 'private', 'origin',
1166 'author-name', 'author-link', 'author-avatar', 'gravity',
1167 'owner-name', 'owner-link', 'owner-avatar'];
1168 $condition = ['uid' => $uid, 'guid' => $guid];
1169 $item = Post::selectFirst($fields, $condition);
1171 if (!DBA::isResult($item)) {
1172 $person = FContact::getByURL($author);
1173 $result = self::storeByGuid($guid, $person["url"], $uid);
1175 // We don't have an url for items that arrived at the public dispatcher
1176 if (!$result && !empty($contact["url"])) {
1177 $result = self::storeByGuid($guid, $contact["url"], $uid);
1181 Logger::info("Fetched missing item ".$guid." - result: ".$result);
1183 $item = Post::selectFirst($fields, $condition);
1187 if (!DBA::isResult($item)) {
1188 Logger::notice("parent item not found: parent: ".$guid." - user: ".$uid);
1191 Logger::notice("parent item found: parent: ".$guid." - user: ".$uid);
1197 * returns contact details
1199 * @param array $def_contact The default contact if the person isn't found
1200 * @param array $person The record of the person
1201 * @param int $uid The user id
1204 * 'cid' => contact id
1205 * 'network' => network type
1206 * @throws \Exception
1208 private static function authorContactByUrl($def_contact, $person, $uid)
1210 $condition = ['nurl' => Strings::normaliseLink($person["url"]), 'uid' => $uid];
1211 $contact = DBA::selectFirst('contact', ['id', 'network'], $condition);
1212 if (DBA::isResult($contact)) {
1213 $cid = $contact["id"];
1214 $network = $contact["network"];
1216 $cid = $def_contact["id"];
1217 $network = Protocol::DIASPORA;
1220 return ["cid" => $cid, "network" => $network];
1224 * Is the profile a hubzilla profile?
1226 * @param string $url The profile link
1228 * @return bool is it a hubzilla server?
1230 private static function isHubzilla($url)
1232 return(strstr($url, '/channel/'));
1236 * Generate a post link with a given handle and message guid
1238 * @param string $addr The user handle
1239 * @param string $guid message guid
1240 * @param string $parent_guid optional parent guid
1242 * @return string the post link
1243 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1244 * @throws \ImagickException
1246 private static function plink(string $addr, string $guid, string $parent_guid = '')
1248 $contact = Contact::getByURL($addr);
1249 if (empty($contact)) {
1250 Logger::info('No contact data for address', ['addr' => $addr]);
1254 if (empty($contact['baseurl'])) {
1255 $contact['baseurl'] = 'https://' . substr($addr, strpos($addr, '@') + 1);
1256 Logger::info('Create baseurl from address', ['baseurl' => $contact['baseurl'], 'url' => $contact['url']]);
1260 $gserver = DBA::selectFirst('gserver', ['platform'], ['nurl' => Strings::normaliseLink($contact['baseurl'])]);
1261 if (!empty($gserver['platform'])) {
1262 $platform = strtolower($gserver['platform']);
1263 Logger::info('Detected platform', ['platform' => $platform, 'url' => $contact['url']]);
1266 if (!in_array($platform, ['diaspora', 'friendica', 'hubzilla', 'socialhome'])) {
1267 if (self::isHubzilla($contact['url'])) {
1268 Logger::info('Detected unknown platform as Hubzilla', ['platform' => $platform, 'url' => $contact['url']]);
1269 $platform = 'hubzilla';
1270 } elseif ($contact['network'] == Protocol::DFRN) {
1271 Logger::info('Detected unknown platform as Friendica', ['platform' => $platform, 'url' => $contact['url']]);
1272 $platform = 'friendica';
1276 if ($platform == 'friendica') {
1277 return str_replace('/profile/' . $contact['nick'] . '/', '/display/' . $guid, $contact['url'] . '/');
1280 if ($platform == 'hubzilla') {
1281 return $contact['baseurl'] . '/item/' . $guid;
1284 if ($platform == 'socialhome') {
1285 return $contact['baseurl'] . '/content/' . $guid;
1288 if ($platform != 'diaspora') {
1289 Logger::info('Unknown platform', ['platform' => $platform, 'url' => $contact['url']]);
1293 if ($parent_guid != '') {
1294 return $contact['baseurl'] . '/posts/' . $parent_guid . '#' . $guid;
1296 return $contact['baseurl'] . '/posts/' . $guid;
1301 * Receives account migration
1303 * @param array $importer Array of the importer user
1304 * @param object $data The message object
1306 * @return bool Success
1307 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1308 * @throws \ImagickException
1310 private static function receiveAccountMigration(array $importer, $data)
1312 $old_handle = XML::unescape($data->author);
1313 $new_handle = XML::unescape($data->profile->author);
1314 $signature = XML::unescape($data->signature);
1316 $contact = self::contactByHandle($importer["uid"], $old_handle);
1318 Logger::notice("cannot find contact for sender: ".$old_handle." and user ".$importer["uid"]);
1322 Logger::notice("Got migration for ".$old_handle.", to ".$new_handle." with user ".$importer["uid"]);
1325 $signed_text = 'AccountMigration:'.$old_handle.':'.$new_handle;
1326 $key = self::key($old_handle);
1327 if (!Crypto::rsaVerify($signed_text, $signature, $key, "sha256")) {
1328 Logger::notice('No valid signature for migration.');
1332 // Update the profile
1333 self::receiveProfile($importer, $data->profile);
1335 // change the technical stuff in contact
1336 $data = Probe::uri($new_handle);
1337 if ($data['network'] == Protocol::PHANTOM) {
1338 Logger::notice('Account for '.$new_handle." couldn't be probed.");
1342 $fields = ['url' => $data['url'], 'nurl' => Strings::normaliseLink($data['url']),
1343 'name' => $data['name'], 'nick' => $data['nick'],
1344 'addr' => $data['addr'], 'batch' => $data['batch'],
1345 'notify' => $data['notify'], 'poll' => $data['poll'],
1346 'network' => $data['network']];
1348 Contact::update($fields, ['addr' => $old_handle]);
1350 Logger::notice('Contacts are updated.');
1356 * Processes an account deletion
1358 * @param object $data The message object
1360 * @return bool Success
1361 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1363 private static function receiveAccountDeletion($data)
1365 $author = XML::unescape($data->author);
1367 $contacts = DBA::select('contact', ['id'], ['addr' => $author]);
1368 while ($contact = DBA::fetch($contacts)) {
1369 Contact::remove($contact["id"]);
1371 DBA::close($contacts);
1373 Logger::notice('Removed contacts for ' . $author);
1379 * Fetch the uri from our database if we already have this item (maybe from ourselves)
1381 * @param string $author Author handle
1382 * @param string $guid Message guid
1383 * @param boolean $onlyfound Only return uri when found in the database
1385 * @return string The constructed uri or the one from our database
1386 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1387 * @throws \ImagickException
1389 private static function getUriFromGuid($author, $guid, $onlyfound = false)
1391 $item = Post::selectFirst(['uri'], ['guid' => $guid]);
1392 if (DBA::isResult($item)) {
1393 return $item["uri"];
1394 } elseif (!$onlyfound) {
1395 $person = FContact::getByURL($author);
1397 $parts = parse_url($person['url']);
1398 unset($parts['path']);
1399 $host_url = Network::unparseURL($parts);
1401 return $host_url . '/objects/' . $guid;
1408 * Store the mentions in the tag table
1410 * @param integer $uriid
1411 * @param string $text
1413 private static function storeMentions(int $uriid, string $text)
1415 preg_match_all('/([@!]){(?:([^}]+?); ?)?([^} ]+)}/', $text, $matches, PREG_SET_ORDER);
1416 if (empty($matches)) {
1421 * Matching values for the preg match
1422 * [1] = mention type (@ or !)
1423 * [2] = name (optional)
1427 foreach ($matches as $match) {
1428 if (empty($match)) {
1432 $person = FContact::getByURL($match[3]);
1433 if (empty($person)) {
1437 Tag::storeByHash($uriid, $match[1], $person['name'] ?: $person['nick'], $person['url']);
1442 * Processes an incoming comment
1444 * @param array $importer Array of the importer user
1445 * @param string $sender The sender of the message
1446 * @param object $data The message object
1447 * @param string $xml The original XML of the message
1448 * @param bool $fetched The message had been fetched and not pushed
1450 * @return int The message id of the generated comment or "false" if there was an error
1451 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1452 * @throws \ImagickException
1454 private static function receiveComment(array $importer, $sender, $data, $xml, bool $fetched)
1456 $author = XML::unescape($data->author);
1457 $guid = XML::unescape($data->guid);
1458 $parent_guid = XML::unescape($data->parent_guid);
1459 $text = XML::unescape($data->text);
1461 if (isset($data->created_at)) {
1462 $created_at = DateTimeFormat::utc(XML::unescape($data->created_at));
1464 $created_at = DateTimeFormat::utcNow();
1467 if (isset($data->thread_parent_guid)) {
1468 $thread_parent_guid = XML::unescape($data->thread_parent_guid);
1469 $thr_parent = self::getUriFromGuid("", $thread_parent_guid, true);
1474 $contact = self::allowedContactByHandle($importer, $sender, true);
1479 if (!empty($contact['gsid'])) {
1480 GServer::setProtocol($contact['gsid'], Post\DeliveryData::DIASPORA);
1483 $message_id = self::messageExists($importer["uid"], $guid);
1488 $toplevel_parent_item = self::parentItem($importer["uid"], $parent_guid, $author, $contact);
1489 if (!$toplevel_parent_item) {
1493 $person = FContact::getByURL($author);
1494 if (!is_array($person)) {
1495 Logger::notice("unable to find author details");
1499 // Fetch the contact id - if we know this contact
1500 $author_contact = self::authorContactByUrl($contact, $person, $importer["uid"]);
1504 $datarray["uid"] = $importer["uid"];
1505 $datarray["contact-id"] = $author_contact["cid"];
1506 $datarray["network"] = $author_contact["network"];
1508 $datarray["author-link"] = $person["url"];
1509 $datarray["author-id"] = Contact::getIdForURL($person["url"], 0);
1511 $datarray["owner-link"] = $contact["url"];
1512 $datarray["owner-id"] = Contact::getIdForURL($contact["url"], 0);
1514 // Will be overwritten for sharing accounts in Item::insert
1516 $datarray["post-reason"] = Item::PR_FETCHED;
1517 } elseif ($datarray["uid"] == 0) {
1518 $datarray["post-reason"] = Item::PR_GLOBAL;
1520 $datarray["post-reason"] = Item::PR_COMMENT;
1523 $datarray["guid"] = $guid;
1524 $datarray["uri"] = self::getUriFromGuid($author, $guid);
1525 $datarray['uri-id'] = ItemURI::insert(['uri' => $datarray['uri'], 'guid' => $datarray['guid']]);
1527 $datarray["verb"] = Activity::POST;
1528 $datarray["gravity"] = GRAVITY_COMMENT;
1530 $datarray['thr-parent'] = $thr_parent ?: $toplevel_parent_item['uri'];
1532 $datarray["object-type"] = Activity\ObjectType::COMMENT;
1533 $datarray["post-type"] = Item::PT_NOTE;
1535 $datarray["protocol"] = Conversation::PARCEL_DIASPORA;
1536 $datarray["source"] = $xml;
1537 $datarray["direction"] = $fetched ? Conversation::PULL : Conversation::PUSH;
1539 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
1541 $datarray["plink"] = self::plink($author, $guid, $toplevel_parent_item['guid']);
1542 $body = Markdown::toBBCode($text);
1544 $datarray["body"] = self::replacePeopleGuid($body, $person["url"]);
1546 self::storeMentions($datarray['uri-id'], $text);
1547 Tag::storeRawTagsFromBody($datarray['uri-id'], $datarray["body"]);
1549 self::fetchGuid($datarray);
1551 // If we are the origin of the parent we store the original data.
1552 // We notify our followers during the item storage.
1553 if ($toplevel_parent_item["origin"]) {
1554 $datarray['diaspora_signed_text'] = json_encode($data);
1557 if (Item::isTooOld($datarray)) {
1558 Logger::info('Comment is too old', ['created' => $datarray['created'], 'uid' => $datarray['uid'], 'guid' => $datarray['guid']]);
1562 $message_id = Item::insert($datarray);
1564 if ($message_id <= 0) {
1569 Logger::info("Stored comment ".$datarray["guid"]." with message id ".$message_id);
1570 if ($datarray['uid'] == 0) {
1571 Item::distribute($message_id, json_encode($data));
1579 * processes and stores private messages
1581 * @param array $importer Array of the importer user
1582 * @param array $contact The contact of the message
1583 * @param object $data The message object
1584 * @param array $msg Array of the processed message, author handle and key
1585 * @param object $mesg The private message
1586 * @param array $conversation The conversation record to which this message belongs
1588 * @return bool "true" if it was successful
1589 * @throws \Exception
1591 private static function receiveConversationMessage(array $importer, array $contact, $data, $msg, $mesg, $conversation)
1593 $author = XML::unescape($data->author);
1594 $guid = XML::unescape($data->guid);
1595 $subject = XML::unescape($data->subject);
1597 // "diaspora_handle" is the element name from the old version
1598 // "author" is the element name from the new version
1599 if ($mesg->author) {
1600 $msg_author = XML::unescape($mesg->author);
1601 } elseif ($mesg->diaspora_handle) {
1602 $msg_author = XML::unescape($mesg->diaspora_handle);
1607 $msg_guid = XML::unescape($mesg->guid);
1608 $msg_conversation_guid = XML::unescape($mesg->conversation_guid);
1609 $msg_text = XML::unescape($mesg->text);
1610 $msg_created_at = DateTimeFormat::utc(XML::unescape($mesg->created_at));
1612 if ($msg_conversation_guid != $guid) {
1613 Logger::notice("message conversation guid does not belong to the current conversation.");
1617 $body = Markdown::toBBCode($msg_text);
1618 $message_uri = $msg_author.":".$msg_guid;
1620 $person = FContact::getByURL($msg_author);
1622 return Mail::insert([
1623 'uid' => $importer['uid'],
1624 'guid' => $msg_guid,
1625 'convid' => $conversation['id'],
1626 'from-name' => $person['name'],
1627 'from-photo' => $person['photo'],
1628 'from-url' => $person['url'],
1629 'contact-id' => $contact['id'],
1630 'title' => $subject,
1632 'uri' => $message_uri,
1633 'parent-uri' => $author . ':' . $guid,
1634 'created' => $msg_created_at
1639 * Processes new private messages (answers to private messages are processed elsewhere)
1641 * @param array $importer Array of the importer user
1642 * @param array $msg Array of the processed message, author handle and key
1643 * @param object $data The message object
1645 * @return bool Success
1646 * @throws \Exception
1648 private static function receiveConversation(array $importer, $msg, $data)
1650 $author = XML::unescape($data->author);
1651 $guid = XML::unescape($data->guid);
1652 $subject = XML::unescape($data->subject);
1653 $created_at = DateTimeFormat::utc(XML::unescape($data->created_at));
1654 $participants = XML::unescape($data->participants);
1656 $messages = $data->message;
1658 if (!count($messages)) {
1659 Logger::notice("empty conversation");
1663 $contact = self::allowedContactByHandle($importer, $msg["author"], true);
1668 if (!empty($contact['gsid'])) {
1669 GServer::setProtocol($contact['gsid'], Post\DeliveryData::DIASPORA);
1672 $conversation = DBA::selectFirst('conv', [], ['uid' => $importer["uid"], 'guid' => $guid]);
1673 if (!DBA::isResult($conversation)) {
1674 $r = DBA::insert('conv', [
1675 'uid' => $importer['uid'],
1677 'creator' => $author,
1678 'created' => $created_at,
1679 'updated' => DateTimeFormat::utcNow(),
1680 'subject' => $subject,
1681 'recips' => $participants]);
1683 $conversation = DBA::selectFirst('conv', [], ['uid' => $importer["uid"], 'guid' => $guid]);
1686 if (!$conversation) {
1687 Logger::notice("unable to create conversation.");
1691 foreach ($messages as $mesg) {
1692 self::receiveConversationMessage($importer, $contact, $data, $msg, $mesg, $conversation);
1699 * Processes "like" messages
1701 * @param array $importer Array of the importer user
1702 * @param string $sender The sender of the message
1703 * @param object $data The message object
1705 * @return int The message id of the generated like or "false" if there was an error
1706 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1707 * @throws \ImagickException
1709 private static function receiveLike(array $importer, $sender, $data, bool $fetched)
1711 $author = XML::unescape($data->author);
1712 $guid = XML::unescape($data->guid);
1713 $parent_guid = XML::unescape($data->parent_guid);
1714 $parent_type = XML::unescape($data->parent_type);
1715 $positive = XML::unescape($data->positive);
1717 // likes on comments aren't supported by Diaspora - only on posts
1718 // But maybe this will be supported in the future, so we will accept it.
1719 if (!in_array($parent_type, ["Post", "Comment"])) {
1723 $contact = self::allowedContactByHandle($importer, $sender, true);
1728 if (!empty($contact['gsid'])) {
1729 GServer::setProtocol($contact['gsid'], Post\DeliveryData::DIASPORA);
1732 $message_id = self::messageExists($importer["uid"], $guid);
1737 $toplevel_parent_item = self::parentItem($importer["uid"], $parent_guid, $author, $contact);
1738 if (!$toplevel_parent_item) {
1742 $person = FContact::getByURL($author);
1743 if (!is_array($person)) {
1744 Logger::notice("unable to find author details");
1748 // Fetch the contact id - if we know this contact
1749 $author_contact = self::authorContactByUrl($contact, $person, $importer["uid"]);
1751 // "positive" = "false" would be a Dislike - wich isn't currently supported by Diaspora
1752 // We would accept this anyhow.
1753 if ($positive == "true") {
1754 $verb = Activity::LIKE;
1756 $verb = Activity::DISLIKE;
1761 $datarray["protocol"] = Conversation::PARCEL_DIASPORA;
1762 $datarray["direction"] = $fetched ? Conversation::PULL : Conversation::PUSH;
1764 $datarray["uid"] = $importer["uid"];
1765 $datarray["contact-id"] = $author_contact["cid"];
1766 $datarray["network"] = $author_contact["network"];
1768 $datarray["owner-link"] = $datarray["author-link"] = $person["url"];
1769 $datarray["owner-id"] = $datarray["author-id"] = Contact::getIdForURL($person["url"], 0);
1771 $datarray["guid"] = $guid;
1772 $datarray["uri"] = self::getUriFromGuid($author, $guid);
1774 $datarray["verb"] = $verb;
1775 $datarray["gravity"] = GRAVITY_ACTIVITY;
1776 $datarray['thr-parent'] = $toplevel_parent_item['uri'];
1778 $datarray["object-type"] = Activity\ObjectType::NOTE;
1780 $datarray["body"] = $verb;
1782 // Diaspora doesn't provide a date for likes
1783 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = DateTimeFormat::utcNow();
1785 // like on comments have the comment as parent. So we need to fetch the toplevel parent
1786 if ($toplevel_parent_item['gravity'] != GRAVITY_PARENT) {
1787 $toplevel = Post::selectFirst(['origin'], ['id' => $toplevel_parent_item['parent']]);
1788 $origin = $toplevel["origin"];
1790 $origin = $toplevel_parent_item["origin"];
1793 // If we are the origin of the parent we store the original data.
1794 // We notify our followers during the item storage.
1796 $datarray['diaspora_signed_text'] = json_encode($data);
1799 if (Item::isTooOld($datarray)) {
1800 Logger::info('Like is too old', ['created' => $datarray['created'], 'uid' => $datarray['uid'], 'guid' => $datarray['guid']]);
1804 $message_id = Item::insert($datarray);
1806 if ($message_id <= 0) {
1811 Logger::info("Stored like ".$datarray["guid"]." with message id ".$message_id);
1812 if ($datarray['uid'] == 0) {
1813 Item::distribute($message_id, json_encode($data));
1821 * Processes private messages
1823 * @param array $importer Array of the importer user
1824 * @param object $data The message object
1826 * @return bool Success?
1827 * @throws \Exception
1829 private static function receiveMessage(array $importer, $data)
1831 $author = XML::unescape($data->author);
1832 $guid = XML::unescape($data->guid);
1833 $conversation_guid = XML::unescape($data->conversation_guid);
1834 $text = XML::unescape($data->text);
1835 $created_at = DateTimeFormat::utc(XML::unescape($data->created_at));
1837 $contact = self::allowedContactByHandle($importer, $author, true);
1842 if (!empty($contact['gsid'])) {
1843 GServer::setProtocol($contact['gsid'], Post\DeliveryData::DIASPORA);
1846 $conversation = null;
1848 $condition = ['uid' => $importer["uid"], 'guid' => $conversation_guid];
1849 $conversation = DBA::selectFirst('conv', [], $condition);
1851 if (!DBA::isResult($conversation)) {
1852 Logger::notice("conversation not available.");
1856 $message_uri = $author.":".$guid;
1858 $person = FContact::getByURL($author);
1860 Logger::notice("unable to find author details");
1864 $body = Markdown::toBBCode($text);
1866 $body = self::replacePeopleGuid($body, $person["url"]);
1868 return Mail::insert([
1869 'uid' => $importer['uid'],
1871 'convid' => $conversation['id'],
1872 'from-name' => $person['name'],
1873 'from-photo' => $person['photo'],
1874 'from-url' => $person['url'],
1875 'contact-id' => $contact['id'],
1876 'title' => $conversation['subject'],
1879 'uri' => $message_uri,
1880 'parent-uri' => $author.":".$conversation['guid'],
1881 'created' => $created_at
1886 * Processes participations - unsupported by now
1888 * @param array $importer Array of the importer user
1889 * @param object $data The message object
1891 * @return bool success
1892 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1893 * @throws \ImagickException
1895 private static function receiveParticipation(array $importer, $data, bool $fetched)
1897 $author = strtolower(XML::unescape($data->author));
1898 $guid = XML::unescape($data->guid);
1899 $parent_guid = XML::unescape($data->parent_guid);
1901 $contact = self::allowedContactByHandle($importer, $author, true);
1906 if (!empty($contact['gsid'])) {
1907 GServer::setProtocol($contact['gsid'], Post\DeliveryData::DIASPORA);
1910 if (self::messageExists($importer["uid"], $guid)) {
1914 $toplevel_parent_item = self::parentItem($importer["uid"], $parent_guid, $author, $contact);
1915 if (!$toplevel_parent_item) {
1919 if (!$toplevel_parent_item['origin']) {
1920 Logger::info('Not our origin. Participation is ignored', ['parent_guid' => $parent_guid, 'guid' => $guid, 'author' => $author]);
1923 if (!in_array($toplevel_parent_item['private'], [Item::PUBLIC, Item::UNLISTED])) {
1924 Logger::info('Item is not public, participation is ignored', ['parent_guid' => $parent_guid, 'guid' => $guid, 'author' => $author]);
1928 $person = FContact::getByURL($author);
1929 if (!is_array($person)) {
1930 Logger::notice("Person not found: ".$author);
1934 $author_contact = self::authorContactByUrl($contact, $person, $importer["uid"]);
1936 // Store participation
1939 $datarray["protocol"] = Conversation::PARCEL_DIASPORA;
1940 $datarray["direction"] = $fetched ? Conversation::PULL : Conversation::PUSH;
1942 $datarray["uid"] = $importer["uid"];
1943 $datarray["contact-id"] = $author_contact["cid"];
1944 $datarray["network"] = $author_contact["network"];
1946 $datarray["owner-link"] = $datarray["author-link"] = $person["url"];
1947 $datarray["owner-id"] = $datarray["author-id"] = Contact::getIdForURL($person["url"], 0);
1949 $datarray["guid"] = $guid;
1950 $datarray["uri"] = self::getUriFromGuid($author, $guid);
1952 $datarray["verb"] = Activity::FOLLOW;
1953 $datarray["gravity"] = GRAVITY_ACTIVITY;
1954 $datarray['thr-parent'] = $toplevel_parent_item['uri'];
1956 $datarray["object-type"] = Activity\ObjectType::NOTE;
1958 $datarray["body"] = Activity::FOLLOW;
1960 // Diaspora doesn't provide a date for a participation
1961 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = DateTimeFormat::utcNow();
1963 if (Item::isTooOld($datarray)) {
1964 Logger::info('Participation is too old', ['created' => $datarray['created'], 'uid' => $datarray['uid'], 'guid' => $datarray['guid']]);
1968 $message_id = Item::insert($datarray);
1970 Logger::info('Participation stored', ['id' => $message_id, 'guid' => $guid, 'parent_guid' => $parent_guid, 'author' => $author]);
1972 // Send all existing comments and likes to the requesting server
1973 $comments = Post::select(['id', 'uri-id', 'parent-author-network', 'author-network', 'verb'],
1974 ['parent' => $toplevel_parent_item['id'], 'gravity' => [GRAVITY_COMMENT, GRAVITY_ACTIVITY]]);
1975 while ($comment = Post::fetch($comments)) {
1976 if (in_array($comment['verb'], [Activity::FOLLOW, Activity::TAG])) {
1977 Logger::info('participation messages are not relayed', ['item' => $comment['id']]);
1981 if ($comment['author-network'] == Protocol::ACTIVITYPUB) {
1982 Logger::info('Comments from ActivityPub authors are not relayed', ['item' => $comment['id']]);
1986 if ($comment['parent-author-network'] == Protocol::ACTIVITYPUB) {
1987 Logger::info('Comments to comments from ActivityPub authors are not relayed', ['item' => $comment['id']]);
1991 Logger::info('Deliver participation', ['item' => $comment['id'], 'contact' => $author_contact["cid"]]);
1992 if (Worker::add(PRIORITY_HIGH, 'Delivery', Delivery::POST, $comment['id'], $author_contact["cid"])) {
1993 Post\DeliveryData::incrementQueueCount($comment['uri-id'], 1);
1996 DBA::close($comments);
2002 * Processes photos - unneeded
2004 * @param array $importer Array of the importer user
2005 * @param object $data The message object
2007 * @return bool always true
2009 private static function receivePhoto(array $importer, $data)
2011 // There doesn't seem to be a reason for this function,
2012 // since the photo data is transmitted in the status message as well
2017 * Processes poll participations - unssupported
2019 * @param array $importer Array of the importer user
2020 * @param object $data The message object
2022 * @return bool always true
2024 private static function receivePollParticipation(array $importer, $data)
2026 // We don't support polls by now
2031 * Processes incoming profile updates
2033 * @param array $importer Array of the importer user
2034 * @param object $data The message object
2036 * @return bool Success
2037 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2038 * @throws \ImagickException
2040 private static function receiveProfile(array $importer, $data)
2042 $author = strtolower(XML::unescape($data->author));
2044 $contact = self::contactByHandle($importer["uid"], $author);
2049 $name = XML::unescape($data->first_name).((strlen($data->last_name)) ? " ".XML::unescape($data->last_name) : "");
2050 $image_url = XML::unescape($data->image_url);
2051 $birthday = XML::unescape($data->birthday);
2052 $about = Markdown::toBBCode(XML::unescape($data->bio));
2053 $location = Markdown::toBBCode(XML::unescape($data->location));
2054 $searchable = (XML::unescape($data->searchable) == "true");
2055 $nsfw = (XML::unescape($data->nsfw) == "true");
2056 $tags = XML::unescape($data->tag_string);
2058 $tags = explode("#", $tags);
2061 foreach ($tags as $tag) {
2062 $tag = trim(strtolower($tag));
2068 $keywords = implode(", ", $keywords);
2070 $handle_parts = explode("@", $author);
2071 $nick = $handle_parts[0];
2074 $name = $handle_parts[0];
2077 if (preg_match("|^https?://|", $image_url) === 0) {
2078 $image_url = "http://".$handle_parts[1].$image_url;
2081 Contact::updateAvatar($contact["id"], $image_url);
2083 // Generic birthday. We don't know the timezone. The year is irrelevant.
2085 $birthday = str_replace("1000", "1901", $birthday);
2087 if ($birthday != "") {
2088 $birthday = DateTimeFormat::utc($birthday, "Y-m-d");
2091 // this is to prevent multiple birthday notifications in a single year
2092 // if we already have a stored birthday and the 'm-d' part hasn't changed, preserve the entry, which will preserve the notify year
2094 if (substr($birthday, 5) === substr($contact["bd"], 5)) {
2095 $birthday = $contact["bd"];
2098 $fields = ['name' => $name, 'location' => $location,
2099 'name-date' => DateTimeFormat::utcNow(), 'about' => $about,
2100 'addr' => $author, 'nick' => $nick, 'keywords' => $keywords,
2101 'unsearchable' => !$searchable, 'sensitive' => $nsfw];
2103 if (!empty($birthday)) {
2104 $fields['bd'] = $birthday;
2107 Contact::update($fields, ['id' => $contact['id']]);
2109 Logger::info("Profile of contact ".$contact["id"]." stored for user ".$importer["uid"]);
2115 * Processes incoming friend requests
2117 * @param array $importer Array of the importer user
2118 * @param array $contact The contact that send the request
2120 * @throws \Exception
2122 private static function receiveRequestMakeFriend(array $importer, array $contact)
2124 if ($contact["rel"] == Contact::SHARING) {
2126 ['rel' => Contact::FRIEND, 'writable' => true],
2127 ['id' => $contact["id"], 'uid' => $importer["uid"]]
2133 * Processes incoming sharing notification
2135 * @param array $importer Array of the importer user
2136 * @param object $data The message object
2138 * @return bool Success
2139 * @throws \Exception
2141 private static function receiveContactRequest(array $importer, $data)
2143 $author = XML::unescape($data->author);
2144 $recipient = XML::unescape($data->recipient);
2146 if (!$author || !$recipient) {
2150 // the current protocol version doesn't know these fields
2151 // That means that we will assume their existance
2152 if (isset($data->following)) {
2153 $following = (XML::unescape($data->following) == "true");
2158 if (isset($data->sharing)) {
2159 $sharing = (XML::unescape($data->sharing) == "true");
2164 $contact = self::contactByHandle($importer["uid"], $author);
2166 // perhaps we were already sharing with this person. Now they're sharing with us.
2167 // That makes us friends.
2170 Logger::info("Author ".$author." (Contact ".$contact["id"].") wants to follow us.");
2171 self::receiveRequestMakeFriend($importer, $contact);
2173 // refetch the contact array
2174 $contact = self::contactByHandle($importer["uid"], $author);
2176 // If we are now friends, we are sending a share message.
2177 // Normally we needn't to do so, but the first message could have been vanished.
2178 if (in_array($contact["rel"], [Contact::FRIEND])) {
2179 $user = DBA::selectFirst('user', [], ['uid' => $importer["uid"]]);
2180 if (DBA::isResult($user)) {
2181 Logger::info("Sending share message to author ".$author." - Contact: ".$contact["id"]." - User: ".$importer["uid"]);
2182 self::sendShare($user, $contact);
2187 Logger::info("Author ".$author." doesn't want to follow us anymore.");
2188 Contact::removeFollower($contact);
2193 if (!$following && $sharing && in_array($importer["page-flags"], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_NORMAL])) {
2194 Logger::info("Author ".$author." wants to share with us - but doesn't want to listen. Request is ignored.");
2196 } elseif (!$following && !$sharing) {
2197 Logger::info("Author ".$author." doesn't want anything - and we don't know the author. Request is ignored.");
2199 } elseif (!$following && $sharing) {
2200 Logger::info("Author ".$author." wants to share with us.");
2201 } elseif ($following && $sharing) {
2202 Logger::info("Author ".$author." wants to have a bidirectional conection.");
2203 } elseif ($following && !$sharing) {
2204 Logger::info("Author ".$author." wants to listen to us.");
2207 $ret = FContact::getByURL($author);
2209 if (!$ret || ($ret["network"] != Protocol::DIASPORA)) {
2210 Logger::notice("Cannot resolve diaspora handle ".$author." for ".$recipient);
2214 $cid = Contact::getIdForURL($ret['url'], $importer['uid']);
2216 $contact = DBA::selectFirst('contact', [], ['id' => $cid, 'network' => Protocol::NATIVE_SUPPORT]);
2221 $item = ['author-id' => Contact::getIdForURL($ret['url']),
2222 'author-link' => $ret['url']];
2224 $result = Contact::addRelationship($importer, $contact, $item, false);
2225 if ($result === true) {
2226 $contact_record = self::contactByHandle($importer['uid'], $author);
2227 if (!$contact_record) {
2228 Logger::info('unable to locate newly created contact record.');
2232 $user = DBA::selectFirst('user', [], ['uid' => $importer['uid']]);
2233 if (DBA::isResult($user)) {
2234 self::sendShare($user, $contact_record);
2236 // Send the profile data, maybe it weren't transmitted before
2237 self::sendProfile($importer['uid'], [$contact_record]);
2245 * Fetches a message with a given guid
2247 * @param string $guid message guid
2248 * @param string $orig_author handle of the original post
2249 * @return array The fetched item
2250 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2251 * @throws \ImagickException
2253 public static function originalItem($guid, $orig_author)
2256 Logger::notice('Empty guid. Quitting.');
2260 // Do we already have this item?
2261 $fields = ['body', 'title', 'app', 'created', 'object-type', 'uri', 'guid',
2262 'author-name', 'author-link', 'author-avatar', 'plink', 'uri-id'];
2263 $condition = ['guid' => $guid, 'visible' => true, 'deleted' => false, 'private' => [Item::PUBLIC, Item::UNLISTED]];
2264 $item = Post::selectFirst($fields, $condition);
2266 if (DBA::isResult($item)) {
2267 Logger::notice("reshared message ".$guid." already exists on system.");
2269 // Maybe it is already a reshared item?
2270 // Then refetch the content, if it is a reshare from a reshare.
2271 // If it is a reshared post from another network then reformat to avoid display problems with two share elements
2272 if (self::isReshare($item["body"], true)) {
2274 } elseif (self::isReshare($item["body"], false) || strstr($item["body"], "[share")) {
2275 $item["body"] = Markdown::toBBCode(BBCode::toMarkdown($item["body"]));
2277 $item["body"] = self::replacePeopleGuid($item["body"], $item["author-link"]);
2285 if (!DBA::isResult($item)) {
2286 if (empty($orig_author)) {
2287 Logger::notice('Empty author for guid ' . $guid . '. Quitting.');
2291 $server = "https://".substr($orig_author, strpos($orig_author, "@") + 1);
2292 Logger::notice("1st try: reshared message ".$guid." will be fetched via SSL from the server ".$server);
2293 $stored = self::storeByGuid($guid, $server);
2296 $server = "http://".substr($orig_author, strpos($orig_author, "@") + 1);
2297 Logger::notice("2nd try: reshared message ".$guid." will be fetched without SSL from the server ".$server);
2298 $stored = self::storeByGuid($guid, $server);
2302 $fields = ['body', 'title', 'app', 'created', 'object-type', 'uri', 'guid',
2303 'author-name', 'author-link', 'author-avatar', 'plink', 'uri-id'];
2304 $condition = ['guid' => $guid, 'visible' => true, 'deleted' => false, 'private' => [Item::PUBLIC, Item::UNLISTED]];
2305 $item = Post::selectFirst($fields, $condition);
2307 if (DBA::isResult($item)) {
2308 // If it is a reshared post from another network then reformat to avoid display problems with two share elements
2309 if (self::isReshare($item["body"], false)) {
2310 $item["body"] = Markdown::toBBCode(BBCode::toMarkdown($item["body"]));
2311 $item["body"] = self::replacePeopleGuid($item["body"], $item["author-link"]);
2322 * Stores a reshare activity
2324 * @param array $item Array of reshare post
2325 * @param integer $parent_message_id Id of the parent post
2326 * @param string $guid GUID string of reshare action
2327 * @param string $author Author handle
2329 private static function addReshareActivity($item, $parent_message_id, $guid, $author)
2331 $parent = Post::selectFirst(['uri', 'guid'], ['id' => $parent_message_id]);
2335 $datarray['uid'] = $item['uid'];
2336 $datarray['contact-id'] = $item['contact-id'];
2337 $datarray['network'] = $item['network'];
2339 $datarray['author-link'] = $item['author-link'];
2340 $datarray['author-id'] = $item['author-id'];
2342 $datarray['owner-link'] = $datarray['author-link'];
2343 $datarray['owner-id'] = $datarray['author-id'];
2345 $datarray['guid'] = $parent['guid'] . '-' . $guid;
2346 $datarray['uri'] = self::getUriFromGuid($author, $datarray['guid']);
2347 $datarray['thr-parent'] = $parent['uri'];
2349 $datarray['verb'] = $datarray['body'] = Activity::ANNOUNCE;
2350 $datarray['gravity'] = GRAVITY_ACTIVITY;
2351 $datarray['object-type'] = Activity\ObjectType::NOTE;
2353 $datarray['protocol'] = $item['protocol'];
2354 $datarray['source'] = $item['source'];
2355 $datarray['direction'] = $item['direction'];
2357 $datarray['plink'] = self::plink($author, $datarray['guid']);
2358 $datarray['private'] = $item['private'];
2359 $datarray['changed'] = $datarray['created'] = $datarray['edited'] = $item['created'];
2361 if (Item::isTooOld($datarray)) {
2362 Logger::info('Reshare activity is too old', ['created' => $datarray['created'], 'uid' => $datarray['uid'], 'guid' => $datarray['guid']]);
2366 $message_id = Item::insert($datarray);
2369 Logger::info('Stored reshare activity.', ['guid' => $guid, 'id' => $message_id]);
2370 if ($datarray['uid'] == 0) {
2371 Item::distribute($message_id);
2377 * Processes a reshare message
2379 * @param array $importer Array of the importer user
2380 * @param object $data The message object
2381 * @param string $xml The original XML of the message
2383 * @return int the message id
2384 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2385 * @throws \ImagickException
2387 private static function receiveReshare(array $importer, $data, $xml, bool $fetched)
2389 $author = XML::unescape($data->author);
2390 $guid = XML::unescape($data->guid);
2391 $created_at = DateTimeFormat::utc(XML::unescape($data->created_at));
2392 $root_author = XML::unescape($data->root_author);
2393 $root_guid = XML::unescape($data->root_guid);
2394 /// @todo handle unprocessed property "provider_display_name"
2395 $public = XML::unescape($data->public);
2397 $contact = self::allowedContactByHandle($importer, $author, false);
2402 if (!empty($contact['gsid'])) {
2403 GServer::setProtocol($contact['gsid'], Post\DeliveryData::DIASPORA);
2406 $message_id = self::messageExists($importer["uid"], $guid);
2411 $original_item = self::originalItem($root_guid, $root_author);
2412 if (!$original_item) {
2416 if (empty($original_item['plink'])) {
2417 $original_item['plink'] = self::plink($root_author, $root_guid);
2422 $datarray["uid"] = $importer["uid"];
2423 $datarray["contact-id"] = $contact["id"];
2424 $datarray["network"] = Protocol::DIASPORA;
2426 $datarray["author-link"] = $contact["url"];
2427 $datarray["author-id"] = Contact::getIdForURL($contact["url"], 0);
2429 $datarray["owner-link"] = $datarray["author-link"];
2430 $datarray["owner-id"] = $datarray["author-id"];
2432 $datarray["guid"] = $guid;
2433 $datarray["uri"] = $datarray["thr-parent"] = self::getUriFromGuid($author, $guid);
2434 $datarray['uri-id'] = ItemURI::insert(['uri' => $datarray['uri'], 'guid' => $datarray['guid']]);
2436 $datarray["verb"] = Activity::POST;
2437 $datarray["gravity"] = GRAVITY_PARENT;
2439 $datarray["protocol"] = Conversation::PARCEL_DIASPORA;
2440 $datarray["source"] = $xml;
2441 $datarray["direction"] = $fetched ? Conversation::PULL : Conversation::PUSH;
2443 /// @todo Copy tag data from original post
2445 $prefix = BBCode::getShareOpeningTag(
2446 $original_item["author-name"],
2447 $original_item["author-link"],
2448 $original_item["author-avatar"],
2449 $original_item["plink"],
2450 $original_item["created"],
2451 $original_item["guid"]
2454 if (!empty($original_item['title'])) {
2455 $prefix .= '[h3]' . $original_item['title'] . "[/h3]\n";
2458 $datarray["body"] = $prefix.$original_item["body"]."[/share]";
2460 Tag::storeFromBody($datarray['uri-id'], $datarray["body"]);
2462 $datarray["app"] = $original_item["app"];
2464 $datarray["plink"] = self::plink($author, $guid);
2465 $datarray["private"] = (($public == "false") ? Item::PRIVATE : Item::PUBLIC);
2466 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
2468 $datarray["object-type"] = $original_item["object-type"];
2470 self::fetchGuid($datarray);
2472 if (Item::isTooOld($datarray)) {
2473 Logger::info('Reshare is too old', ['created' => $datarray['created'], 'uid' => $datarray['uid'], 'guid' => $datarray['guid']]);
2477 $message_id = Item::insert($datarray);
2479 self::sendParticipation($contact, $datarray);
2481 $root_message_id = self::messageExists($importer["uid"], $root_guid);
2482 if ($root_message_id) {
2483 self::addReshareActivity($datarray, $root_message_id, $guid, $author);
2487 Logger::info("Stored reshare ".$datarray["guid"]." with message id ".$message_id);
2488 if ($datarray['uid'] == 0) {
2489 Item::distribute($message_id);
2498 * Processes retractions
2500 * @param array $importer Array of the importer user
2501 * @param array $contact The contact of the item owner
2502 * @param object $data The message object
2504 * @return bool success
2505 * @throws \Exception
2507 private static function itemRetraction(array $importer, array $contact, $data)
2509 $author = XML::unescape($data->author);
2510 $target_guid = XML::unescape($data->target_guid);
2511 $target_type = XML::unescape($data->target_type);
2513 $person = FContact::getByURL($author);
2514 if (!is_array($person)) {
2515 Logger::notice("unable to find author detail for ".$author);
2519 if (empty($contact["url"])) {
2520 $contact["url"] = $person["url"];
2523 // Fetch items that are about to be deleted
2524 $fields = ['uid', 'id', 'parent', 'author-link', 'uri-id'];
2526 // When we receive a public retraction, we delete every item that we find.
2527 if ($importer['uid'] == 0) {
2528 $condition = ['guid' => $target_guid, 'deleted' => false];
2530 $condition = ['guid' => $target_guid, 'deleted' => false, 'uid' => $importer['uid']];
2533 $r = Post::select($fields, $condition);
2534 if (!DBA::isResult($r)) {
2535 Logger::notice("Target guid ".$target_guid." was not found on this system for user ".$importer['uid'].".");
2539 while ($item = Post::fetch($r)) {
2540 if (DBA::exists('post-category', ['uri-id' => $item['uri-id'], 'uid' => $item['uid'], 'type' => Post\Category::FILE])) {
2541 Logger::info("Target guid " . $target_guid . " for user " . $item['uid'] . " is filed. So it won't be deleted.");
2545 // Fetch the parent item
2546 $parent = Post::selectFirst(['author-link'], ['id' => $item['parent']]);
2548 // Only delete it if the parent author really fits
2549 if (!Strings::compareLink($parent["author-link"], $contact["url"]) && !Strings::compareLink($item["author-link"], $contact["url"])) {
2550 Logger::info("Thread author ".$parent["author-link"]." and item author ".$item["author-link"]." don't fit to expected contact ".$contact["url"]);
2554 Item::markForDeletion(['id' => $item['id']]);
2556 Logger::info("Deleted target ".$target_guid." (".$item["id"].") from user ".$item["uid"]." parent: ".$item['parent']);
2564 * Receives retraction messages
2566 * @param array $importer Array of the importer user
2567 * @param string $sender The sender of the message
2568 * @param object $data The message object
2570 * @return bool Success
2571 * @throws \Exception
2573 private static function receiveRetraction(array $importer, $sender, $data)
2575 $target_type = XML::unescape($data->target_type);
2577 $contact = self::contactByHandle($importer["uid"], $sender);
2578 if (!$contact && (in_array($target_type, ["Contact", "Person"]))) {
2579 Logger::notice("cannot find contact for sender: ".$sender." and user ".$importer["uid"]);
2587 Logger::info("Got retraction for ".$target_type.", sender ".$sender." and user ".$importer["uid"]);
2589 switch ($target_type) {
2594 case "StatusMessage":
2595 return self::itemRetraction($importer, $contact, $data);
2597 case "PollParticipation":
2599 // Currently unsupported
2603 Logger::notice("Unknown target type ".$target_type);
2610 * Checks if an incoming message is wanted
2612 * @param string $url
2613 * @param integer $uriid
2614 * @param string $author
2615 * @param string $body
2616 * @return boolean Is the message wanted?
2618 private static function isSolicitedMessage(string $url, int $uriid, string $author, string $body)
2620 $contact = Contact::getByURL($author);
2621 if (DBA::exists('contact', ["`nurl` = ? AND `uid` != ? AND `rel` IN (?, ?)",
2622 $contact['nurl'], 0, Contact::FRIEND, Contact::SHARING])) {
2623 Logger::debug('Author has got followers - accepted', ['url' => $url, 'author' => $author]);
2627 $tags = array_column(Tag::getByURIId($uriid, [Tag::HASHTAG]), 'name');
2628 return Relay::isSolicitedPost($tags, $body, $contact['id'], $url, Protocol::DIASPORA);
2632 * Store an attached photo in the post-media table
2635 * @param object $photo
2638 private static function storePhotoAsMedia(int $uriid, $photo)
2641 $data['uri-id'] = $uriid;
2642 $data['type'] = Post\Media::IMAGE;
2643 $data['url'] = XML::unescape($photo->remote_photo_path) . XML::unescape($photo->remote_photo_name);
2644 $data['height'] = (int)XML::unescape($photo->height ?? 0);
2645 $data['width'] = (int)XML::unescape($photo->width ?? 0);
2646 $data['description'] = XML::unescape($photo->text ?? '');
2648 Post\Media::insert($data);
2652 * Receives status messages
2654 * @param array $importer Array of the importer user
2655 * @param SimpleXMLElement $data The message object
2656 * @param string $xml The original XML of the message
2657 * @param bool $fetched The message had been fetched and not pushed
2658 * @return int The message id of the newly created item
2659 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2660 * @throws \ImagickException
2662 private static function receiveStatusMessage(array $importer, SimpleXMLElement $data, $xml, bool $fetched)
2664 $author = XML::unescape($data->author);
2665 $guid = XML::unescape($data->guid);
2666 $created_at = DateTimeFormat::utc(XML::unescape($data->created_at));
2667 $public = XML::unescape($data->public);
2668 $text = XML::unescape($data->text);
2669 $provider_display_name = XML::unescape($data->provider_display_name);
2671 $contact = self::allowedContactByHandle($importer, $author, false);
2676 if (!empty($contact['gsid'])) {
2677 GServer::setProtocol($contact['gsid'], Post\DeliveryData::DIASPORA);
2680 $message_id = self::messageExists($importer["uid"], $guid);
2686 if ($data->location) {
2687 foreach ($data->location->children() as $fieldname => $data) {
2688 $address[$fieldname] = XML::unescape($data);
2692 $raw_body = $body = Markdown::toBBCode($text);
2696 $datarray["guid"] = $guid;
2697 $datarray["uri"] = $datarray["thr-parent"] = self::getUriFromGuid($author, $guid);
2698 $datarray['uri-id'] = ItemURI::insert(['uri' => $datarray['uri'], 'guid' => $datarray['guid']]);
2700 // Attach embedded pictures to the body
2702 foreach ($data->photo as $photo) {
2703 self::storePhotoAsMedia($datarray['uri-id'], $photo);
2706 $datarray["object-type"] = Activity\ObjectType::IMAGE;
2707 $datarray["post-type"] = Item::PT_IMAGE;
2708 } elseif ($data->poll) {
2709 $datarray["object-type"] = Activity\ObjectType::NOTE;
2710 $datarray["post-type"] = Item::PT_POLL;
2712 $datarray["object-type"] = Activity\ObjectType::NOTE;
2713 $datarray["post-type"] = Item::PT_NOTE;
2716 /// @todo enable support for polls
2717 //if ($data->poll) {
2718 // foreach ($data->poll as $poll)
2723 /// @todo enable support for events
2725 $datarray["uid"] = $importer["uid"];
2726 $datarray["contact-id"] = $contact["id"];
2727 $datarray["network"] = Protocol::DIASPORA;
2729 $datarray["author-link"] = $contact["url"];
2730 $datarray["author-id"] = Contact::getIdForURL($contact["url"], 0);
2732 $datarray["owner-link"] = $datarray["author-link"];
2733 $datarray["owner-id"] = $datarray["author-id"];
2735 $datarray["verb"] = Activity::POST;
2736 $datarray["gravity"] = GRAVITY_PARENT;
2738 $datarray["protocol"] = Conversation::PARCEL_DIASPORA;
2739 $datarray["source"] = $xml;
2740 $datarray["direction"] = $fetched ? Conversation::PULL : Conversation::PUSH;
2743 $datarray["post-reason"] = Item::PR_FETCHED;
2744 } elseif ($datarray["uid"] == 0) {
2745 $datarray["post-reason"] = Item::PR_GLOBAL;
2748 $datarray["body"] = self::replacePeopleGuid($body, $contact["url"]);
2749 $datarray["raw-body"] = self::replacePeopleGuid($raw_body, $contact["url"]);
2751 self::storeMentions($datarray['uri-id'], $text);
2752 Tag::storeRawTagsFromBody($datarray['uri-id'], $datarray["body"]);
2754 if (!$fetched && !self::isSolicitedMessage($datarray["uri"], $datarray['uri-id'], $author, $body)) {
2755 DBA::delete('item-uri', ['uri' => $datarray['uri']]);
2759 if ($provider_display_name != "") {
2760 $datarray["app"] = $provider_display_name;
2763 $datarray["plink"] = self::plink($author, $guid);
2764 $datarray["private"] = (($public == "false") ? Item::PRIVATE : Item::PUBLIC);
2765 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
2767 if (isset($address["address"])) {
2768 $datarray["location"] = $address["address"];
2771 if (isset($address["lat"]) && isset($address["lng"])) {
2772 $datarray["coord"] = $address["lat"]." ".$address["lng"];
2775 self::fetchGuid($datarray);
2777 if (Item::isTooOld($datarray)) {
2778 Logger::info('Status is too old', ['created' => $datarray['created'], 'uid' => $datarray['uid'], 'guid' => $datarray['guid']]);
2782 $message_id = Item::insert($datarray);
2784 self::sendParticipation($contact, $datarray);
2787 Logger::info("Stored item ".$datarray["guid"]." with message id ".$message_id);
2788 if ($datarray['uid'] == 0) {
2789 Item::distribute($message_id);
2797 /* ************************************************************************************** *
2798 * Here are all the functions that are needed to transmit data with the Diaspora protocol *
2799 * ************************************************************************************** */
2802 * returnes the handle of a contact
2804 * @param array $contact contact array
2806 * @return string the handle in the format user@domain.tld
2807 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2809 private static function myHandle(array $contact)
2811 if (!empty($contact["addr"])) {
2812 return $contact["addr"];
2815 // Normally we should have a filled "addr" field - but in the past this wasn't the case
2816 // So - just in case - we build the the address here.
2817 if ($contact["nickname"] != "") {
2818 $nick = $contact["nickname"];
2820 $nick = $contact["nick"];
2823 return $nick . "@" . substr(DI::baseUrl(), strpos(DI::baseUrl(), "://") + 3);
2828 * Creates the data for a private message in the new format
2830 * @param string $msg The message that is to be transmitted
2831 * @param array $user The record of the sender
2832 * @param array $contact Target of the communication
2833 * @param string $prvkey The private key of the sender
2834 * @param string $pubkey The public key of the receiver
2836 * @return string The encrypted data
2837 * @throws \Exception
2839 public static function encodePrivateData($msg, array $user, array $contact, $prvkey, $pubkey)
2841 Logger::debug("Message: ".$msg);
2843 // without a public key nothing will work
2845 Logger::notice("pubkey missing: contact id: ".$contact["id"]);
2849 $aes_key = random_bytes(32);
2850 $b_aes_key = base64_encode($aes_key);
2851 $iv = random_bytes(16);
2852 $b_iv = base64_encode($iv);
2854 $ciphertext = self::aesEncrypt($aes_key, $iv, $msg);
2856 $json = json_encode(["iv" => $b_iv, "key" => $b_aes_key]);
2858 $encrypted_key_bundle = "";
2859 if (!@openssl_public_encrypt($json, $encrypted_key_bundle, $pubkey)) {
2863 $json_object = json_encode(
2864 ["aes_key" => base64_encode($encrypted_key_bundle),
2865 "encrypted_magic_envelope" => base64_encode($ciphertext)]
2868 return $json_object;
2872 * Creates the envelope for the "fetch" endpoint and for the new format
2874 * @param string $msg The message that is to be transmitted
2875 * @param array $user The record of the sender
2877 * @return string The envelope
2878 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2880 public static function buildMagicEnvelope($msg, array $user)
2882 $b64url_data = Strings::base64UrlEncode($msg);
2883 $data = str_replace(["\n", "\r", " ", "\t"], ["", "", "", ""], $b64url_data);
2885 $key_id = Strings::base64UrlEncode(self::myHandle($user));
2886 $type = "application/xml";
2887 $encoding = "base64url";
2888 $alg = "RSA-SHA256";
2889 $signable_data = $data.".".Strings::base64UrlEncode($type).".".Strings::base64UrlEncode($encoding).".".Strings::base64UrlEncode($alg);
2891 // Fallback if the private key wasn't transmitted in the expected field
2892 if ($user['uprvkey'] == "") {
2893 $user['uprvkey'] = $user['prvkey'];
2896 $signature = Crypto::rsaSign($signable_data, $user["uprvkey"]);
2897 $sig = Strings::base64UrlEncode($signature);
2899 $xmldata = ["me:env" => ["me:data" => $data,
2900 "@attributes" => ["type" => $type],
2901 "me:encoding" => $encoding,
2904 "@attributes2" => ["key_id" => $key_id]]];
2906 $namespaces = ["me" => "http://salmon-protocol.org/ns/magic-env"];
2908 return XML::fromArray($xmldata, $xml, false, $namespaces);
2912 * Create the envelope for a message
2914 * @param string $msg The message that is to be transmitted
2915 * @param array $user The record of the sender
2916 * @param array $contact Target of the communication
2917 * @param string $prvkey The private key of the sender
2918 * @param string $pubkey The public key of the receiver
2919 * @param bool $public Is the message public?
2921 * @return string The message that will be transmitted to other servers
2922 * @throws \Exception
2924 public static function buildMessage($msg, array $user, array $contact, $prvkey, $pubkey, $public = false)
2926 // The message is put into an envelope with the sender's signature
2927 $envelope = self::buildMagicEnvelope($msg, $user);
2929 // Private messages are put into a second envelope, encrypted with the receivers public key
2931 $envelope = self::encodePrivateData($envelope, $user, $contact, $prvkey, $pubkey);
2938 * Creates a signature for a message
2940 * @param array $owner the array of the owner of the message
2941 * @param array $message The message that is to be signed
2943 * @return string The signature
2945 private static function signature($owner, $message)
2948 unset($sigmsg["author_signature"]);
2949 unset($sigmsg["parent_author_signature"]);
2951 $signed_text = implode(";", $sigmsg);
2953 return base64_encode(Crypto::rsaSign($signed_text, $owner["uprvkey"], "sha256"));
2957 * Transmit a message to a target server
2959 * @param array $owner the array of the item owner
2960 * @param array $contact Target of the communication
2961 * @param string $envelope The message that is to be transmitted
2962 * @param bool $public_batch Is it a public post?
2963 * @param string $guid message guid
2965 * @return int Result of the transmission
2966 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2967 * @throws \ImagickException
2969 private static function transmit(array $owner, array $contact, $envelope, $public_batch, $guid = "")
2971 $enabled = intval(DI::config()->get("system", "diaspora_enabled"));
2976 $logid = Strings::getRandomHex(4);
2978 // We always try to use the data from the fcontact table.
2979 // This is important for transmitting data to Friendica servers.
2980 if (!empty($contact['addr'])) {
2981 $fcontact = FContact::getByURL($contact['addr']);
2982 if (!empty($fcontact)) {
2983 $dest_url = ($public_batch ? $fcontact["batch"] : $fcontact["notify"]);
2987 if (empty($dest_url)) {
2988 $dest_url = ($public_batch ? $contact["batch"] : $contact["notify"]);
2992 Logger::notice("no url for contact: ".$contact["id"]." batch mode =".$public_batch);
2996 Logger::notice("transmit: ".$logid."-".$guid." ".$dest_url);
2998 if (!intval(DI::config()->get("system", "diaspora_test"))) {
2999 $content_type = (($public_batch) ? "application/magic-envelope+xml" : "application/json");
3001 $postResult = DI::httpClient()->post($dest_url . "/", $envelope, ['Content-Type' => $content_type]);
3002 $return_code = $postResult->getReturnCode();
3004 Logger::notice("test_mode");
3008 Logger::notice("transmit: ".$logid."-".$guid." to ".$dest_url." returns: ".$return_code);
3010 return $return_code ? $return_code : -1;
3015 * Build the post xml
3017 * @param string $type The message type
3018 * @param array $message The message data
3020 * @return string The post XML
3022 public static function buildPostXml($type, $message)
3024 $data = [$type => $message];
3026 return XML::fromArray($data, $xml);
3030 * Builds and transmit messages
3032 * @param array $owner the array of the item owner
3033 * @param array $contact Target of the communication
3034 * @param string $type The message type
3035 * @param array $message The message data
3036 * @param bool $public_batch Is it a public post?
3037 * @param string $guid message guid
3039 * @return int Result of the transmission
3040 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3041 * @throws \ImagickException
3043 private static function buildAndTransmit(array $owner, array $contact, $type, $message, $public_batch = false, $guid = "")
3045 $msg = self::buildPostXml($type, $message);
3047 // Fallback if the private key wasn't transmitted in the expected field
3048 if (empty($owner['uprvkey'])) {
3049 $owner['uprvkey'] = $owner['prvkey'];
3052 // When sending content to Friendica contacts using the Diaspora protocol
3053 // we have to fetch the public key from the fcontact.
3054 // This is due to the fact that legacy DFRN had unique keys for every contact.
3055 $pubkey = $contact['pubkey'];
3056 if (!empty($contact['addr'])) {
3057 $fcontact = FContact::getByURL($contact['addr']);
3058 if (!empty($fcontact)) {
3059 $pubkey = $fcontact['pubkey'];
3062 // The "addr" field should always be filled.
3063 // If this isn't the case, it will raise a notice some lines later.
3064 // And in the log we will see where it came from and we can handle it there.
3065 Logger::notice('Empty addr', ['contact' => $contact ?? [], 'callstack' => System::callstack(20)]);
3068 $envelope = self::buildMessage($msg, $owner, $contact, $owner['uprvkey'], $pubkey, $public_batch);
3070 $return_code = self::transmit($owner, $contact, $envelope, $public_batch, $guid);
3072 Logger::info('Transmitted message', ['owner' => $owner['uid'], 'target' => $contact['addr'], 'type' => $type, 'guid' => $guid, 'result' => $return_code]);
3074 return $return_code;
3078 * sends a participation (Used to get all further updates)
3080 * @param array $contact Target of the communication
3081 * @param array $item Item array
3083 * @return int The result of the transmission
3084 * @throws \Exception
3086 private static function sendParticipation(array $contact, array $item)
3088 // Don't send notifications for private postings
3089 if ($item['private'] == Item::PRIVATE) {
3093 $cachekey = "diaspora:sendParticipation:".$item['guid'];
3095 $result = DI::cache()->get($cachekey);
3096 if (!is_null($result)) {
3100 // Fetch some user id to have a valid handle to transmit the participation.
3101 // In fact it doesn't matter which user sends this - but it is needed by the protocol.
3102 // If the item belongs to a user, we take this user id.
3103 if ($item['uid'] == 0) {
3104 // @todo Possibly use an administrator account?
3105 $condition = ['verified' => true, 'blocked' => false,
3106 'account_removed' => false, 'account_expired' => false, 'account-type' => User::ACCOUNT_TYPE_PERSON];
3107 $first_user = DBA::selectFirst('user', ['uid'], $condition, ['order' => ['uid']]);
3108 $owner = User::getOwnerDataById($first_user['uid']);
3110 $owner = User::getOwnerDataById($item['uid']);
3113 $author = self::myHandle($owner);
3115 $message = ["author" => $author,
3116 "guid" => System::createUUID(),
3117 "parent_type" => "Post",
3118 "parent_guid" => $item["guid"]];
3120 Logger::info("Send participation for ".$item["guid"]." by ".$author);
3122 // It doesn't matter what we store, we only want to avoid sending repeated notifications for the same item
3123 DI::cache()->set($cachekey, $item["guid"], Duration::QUARTER_HOUR);
3125 return self::buildAndTransmit($owner, $contact, "participation", $message);
3129 * sends an account migration
3131 * @param array $owner the array of the item owner
3132 * @param array $contact Target of the communication
3133 * @param int $uid User ID
3135 * @return int The result of the transmission
3136 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3137 * @throws \ImagickException
3139 public static function sendAccountMigration(array $owner, array $contact, $uid)
3141 $old_handle = DI::pConfig()->get($uid, 'system', 'previous_addr');
3142 $profile = self::createProfileData($uid);
3144 $signed_text = 'AccountMigration:'.$old_handle.':'.$profile['author'];
3145 $signature = base64_encode(Crypto::rsaSign($signed_text, $owner["uprvkey"], "sha256"));
3147 $message = ["author" => $old_handle,
3148 "profile" => $profile,
3149 "signature" => $signature];
3151 Logger::info('Send account migration', ['msg' => $message]);
3153 return self::buildAndTransmit($owner, $contact, "account_migration", $message);
3157 * Sends a "share" message
3159 * @param array $owner the array of the item owner
3160 * @param array $contact Target of the communication
3162 * @return int The result of the transmission
3163 * @throws \Exception
3165 public static function sendShare(array $owner, array $contact)
3168 * @todo support the different possible combinations of "following" and "sharing"
3169 * Currently, Diaspora only interprets the "sharing" field
3171 * Before switching this code productive, we have to check all "sendShare" calls if "rel" is set correctly
3175 switch ($contact["rel"]) {
3176 case Contact::FRIEND:
3180 case Contact::SHARING:
3184 case Contact::FOLLOWER:
3190 $message = ["author" => self::myHandle($owner),
3191 "recipient" => $contact["addr"],
3192 "following" => "true",
3193 "sharing" => "true"];
3195 Logger::info('Send share', ['msg' => $message]);
3197 return self::buildAndTransmit($owner, $contact, "contact", $message);
3201 * sends an "unshare"
3203 * @param array $owner the array of the item owner
3204 * @param array $contact Target of the communication
3206 * @return int The result of the transmission
3207 * @throws \Exception
3209 public static function sendUnshare(array $owner, array $contact)
3211 $message = ["author" => self::myHandle($owner),
3212 "recipient" => $contact["addr"],
3213 "following" => "false",
3214 "sharing" => "false"];
3216 Logger::info('Send unshare', ['msg' => $message]);
3218 return self::buildAndTransmit($owner, $contact, "contact", $message);
3222 * Checks a message body if it is a reshare
3224 * @param string $body The message body that is to be check
3225 * @param bool $complete Should it be a complete check or a simple check?
3227 * @return array|bool Reshare details or "false" if no reshare
3228 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3229 * @throws \ImagickException
3231 public static function isReshare($body, $complete = true)
3233 $body = trim($body);
3235 $reshared = Item::getShareArray(['body' => $body]);
3236 if (empty($reshared)) {
3240 // Skip if it isn't a pure repeated messages
3241 // Does it start with a share?
3242 if (!empty($reshared['comment']) && $complete) {
3246 if (!empty($reshared['guid']) && $complete) {
3247 $condition = ['guid' => $reshared['guid'], 'network' => [Protocol::DFRN, Protocol::DIASPORA]];
3248 $item = Post::selectFirst(['contact-id'], $condition);
3249 if (DBA::isResult($item)) {
3251 $ret["root_handle"] = self::handleFromContact($item["contact-id"]);
3252 $ret["root_guid"] = $reshared['guid'];
3254 } elseif ($complete) {
3255 // We are resharing something that isn't a DFRN or Diaspora post.
3256 // So we have to return "false" on "$complete" to not trigger a reshare.
3259 } elseif (empty($reshared['guid']) && $complete) {
3265 if (!empty($reshared['profile']) && ($cid = Contact::getIdForURL($reshared['profile']))) {
3266 $contact = DBA::selectFirst('contact', ['addr'], ['id' => $cid]);
3267 if (!empty($contact['addr'])) {
3268 $ret['root_handle'] = $contact['addr'];
3272 if (empty($ret) && !$complete) {
3280 * Create an event array
3282 * @param integer $event_id The id of the event
3284 * @return array with event data
3285 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3287 private static function buildEvent($event_id)
3289 $event = DBA::selectFirst('event', [], ['id' => $event_id]);
3290 if (!DBA::isResult($event)) {
3296 $owner = User::getOwnerDataById($event['uid']);
3301 $eventdata['author'] = self::myHandle($owner);
3303 if ($event['guid']) {
3304 $eventdata['guid'] = $event['guid'];
3307 $mask = DateTimeFormat::ATOM;
3309 /// @todo - establish "all day" events in Friendica
3310 $eventdata["all_day"] = "false";
3312 $eventdata['timezone'] = 'UTC';
3314 if ($event['start']) {
3315 $eventdata['start'] = DateTimeFormat::utc($event['start'], $mask);
3317 if ($event['finish'] && !$event['nofinish']) {
3318 $eventdata['end'] = DateTimeFormat::utc($event['finish'], $mask);
3320 if ($event['summary']) {
3321 $eventdata['summary'] = html_entity_decode(BBCode::toMarkdown($event['summary']));
3323 if ($event['desc']) {
3324 $eventdata['description'] = html_entity_decode(BBCode::toMarkdown($event['desc']));
3326 if ($event['location']) {
3327 $event['location'] = preg_replace("/\[map\](.*?)\[\/map\]/ism", '$1', $event['location']);
3328 $coord = Map::getCoordinates($event['location']);
3331 $location["address"] = html_entity_decode(BBCode::toMarkdown($event['location']));
3332 if (!empty($coord['lat']) && !empty($coord['lon'])) {
3333 $location["lat"] = $coord['lat'];
3334 $location["lng"] = $coord['lon'];
3336 $location["lat"] = 0;
3337 $location["lng"] = 0;
3339 $eventdata['location'] = $location;
3346 * Create a post (status message or reshare)
3348 * @param array $item The item that will be exported
3349 * @param array $owner the array of the item owner
3352 * 'type' -> Message type ("status_message" or "reshare")
3353 * 'message' -> Array of XML elements of the status
3354 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3355 * @throws \ImagickException
3357 public static function buildStatus(array $item, array $owner)
3359 $cachekey = "diaspora:buildStatus:".$item['guid'];
3361 $result = DI::cache()->get($cachekey);
3362 if (!is_null($result)) {
3366 $myaddr = self::myHandle($owner);
3368 $public = ($item["private"] == Item::PRIVATE ? "false" : "true");
3369 $created = DateTimeFormat::utc($item['received'], DateTimeFormat::ATOM);
3370 $edited = DateTimeFormat::utc($item["edited"] ?? $item["created"], DateTimeFormat::ATOM);
3372 // Detect a share element and do a reshare
3373 if (($item['private'] != Item::PRIVATE) && ($ret = self::isReshare($item["body"]))) {
3374 $message = ["author" => $myaddr,
3375 "guid" => $item["guid"],
3376 "created_at" => $created,
3377 "root_author" => $ret["root_handle"],
3378 "root_guid" => $ret["root_guid"],
3379 "provider_display_name" => $item["app"],
3380 "public" => $public];
3384 $title = $item["title"];
3385 $body = Post\Media::addAttachmentsToBody($item['uri-id'], $item['body']);
3387 // Fetch the title from an attached link - if there is one
3388 if (empty($item["title"]) && DI::pConfig()->get($owner['uid'], 'system', 'attach_link_title')) {
3389 $page_data = BBCode::getAttachmentData($item['body']);
3390 if (!empty($page_data['type']) && !empty($page_data['title']) && ($page_data['type'] == 'link')) {
3391 $title = $page_data['title'];
3395 if ($item['author-link'] != $item['owner-link']) {
3396 $body = BBCode::getShareOpeningTag($item['author-name'], $item['author-link'], $item['author-avatar'],
3397 $item['plink'], $item['created']) . $body . '[/share]';
3400 // convert to markdown
3401 $body = html_entity_decode(BBCode::toMarkdown($body));
3404 if (strlen($title)) {
3405 $body = "### ".html_entity_decode($title)."\n\n".$body;
3408 $attachments = Post\Media::getByURIId($item['uri-id'], [Post\Media::DOCUMENT, Post\Media::TORRENT, Post\Media::UNKNOWN]);
3409 if (!empty($attachments)) {
3410 $body .= "\n[hr]\n";
3411 foreach ($attachments as $attachment) {
3412 $body .= "[" . $attachment['description'] . "](" . $attachment['url'] . ")\n";
3418 if ($item["location"] != "")
3419 $location["address"] = $item["location"];
3421 if ($item["coord"] != "") {
3422 $coord = explode(" ", $item["coord"]);
3423 $location["lat"] = $coord[0];
3424 $location["lng"] = $coord[1];
3427 $message = ["author" => $myaddr,
3428 "guid" => $item["guid"],
3429 "created_at" => $created,
3430 "edited_at" => $edited,
3431 "public" => $public,
3433 "provider_display_name" => $item["app"],
3434 "location" => $location];
3436 // Diaspora rejects messages when they contain a location without "lat" or "lng"
3437 if (!isset($location["lat"]) || !isset($location["lng"])) {
3438 unset($message["location"]);
3441 if ($item['event-id'] > 0) {
3442 $event = self::buildEvent($item['event-id']);
3443 if (count($event)) {
3444 $message['event'] = $event;
3446 if (!empty($event['location']['address']) &&
3447 !empty($event['location']['lat']) &&
3448 !empty($event['location']['lng'])) {
3449 $message['location'] = $event['location'];
3452 /// @todo Once Diaspora supports it, we will remove the body and the location hack above
3453 // $message['text'] = '';
3457 $type = "status_message";
3460 $msg = ["type" => $type, "message" => $message];
3462 DI::cache()->set($cachekey, $msg, Duration::QUARTER_HOUR);
3467 private static function prependParentAuthorMention($body, $profile_url)
3469 $profile = Contact::getByURL($profile_url, false, ['addr', 'name']);
3470 if (!empty($profile['addr'])
3471 && !strstr($body, $profile['addr'])
3472 && !strstr($body, $profile_url)
3474 $body = '@[url=' . $profile_url . ']' . $profile['name'] . '[/url] ' . $body;
3483 * @param array $item The item that will be exported
3484 * @param array $owner the array of the item owner
3485 * @param array $contact Target of the communication
3486 * @param bool $public_batch Is it a public post?
3488 * @return int The result of the transmission
3489 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3490 * @throws \ImagickException
3492 public static function sendStatus(array $item, array $owner, array $contact, $public_batch = false)
3494 $status = self::buildStatus($item, $owner);
3496 return self::buildAndTransmit($owner, $contact, $status["type"], $status["message"], $public_batch, $item["guid"]);
3500 * Creates a "like" object
3502 * @param array $item The item that will be exported
3503 * @param array $owner the array of the item owner
3505 * @return array The data for a "like"
3506 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3508 private static function constructLike(array $item, array $owner)
3510 $parent = Post::selectFirst(['guid', 'uri', 'thr-parent'], ['uri' => $item["thr-parent"]]);
3511 if (!DBA::isResult($parent)) {
3515 $target_type = ($parent["uri"] === $parent["thr-parent"] ? "Post" : "Comment");
3517 if ($item['verb'] === Activity::LIKE) {
3519 } elseif ($item['verb'] === Activity::DISLIKE) {
3520 $positive = "false";
3523 return(["author" => self::myHandle($owner),
3524 "guid" => $item["guid"],
3525 "parent_guid" => $parent["guid"],
3526 "parent_type" => $target_type,
3527 "positive" => $positive,
3528 "author_signature" => ""]);
3532 * Creates an "EventParticipation" object
3534 * @param array $item The item that will be exported
3535 * @param array $owner the array of the item owner
3537 * @return array The data for an "EventParticipation"
3538 * @throws \Exception
3540 private static function constructAttend(array $item, array $owner)
3542 $parent = Post::selectFirst(['guid'], ['uri' => $item['thr-parent']]);
3543 if (!DBA::isResult($parent)) {
3547 switch ($item['verb']) {
3548 case Activity::ATTEND:
3549 $attend_answer = 'accepted';
3551 case Activity::ATTENDNO:
3552 $attend_answer = 'declined';
3554 case Activity::ATTENDMAYBE:
3555 $attend_answer = 'tentative';
3558 Logger::notice('Unknown verb '.$item['verb'].' in item '.$item['guid']);
3562 return(["author" => self::myHandle($owner),
3563 "guid" => $item["guid"],
3564 "parent_guid" => $parent["guid"],
3565 "status" => $attend_answer,
3566 "author_signature" => ""]);
3570 * Creates the object for a comment
3572 * @param array $item The item that will be exported
3573 * @param array $owner the array of the item owner
3575 * @return array|false The data for a comment
3576 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3578 private static function constructComment(array $item, array $owner)
3580 $cachekey = "diaspora:constructComment:".$item['guid'];
3582 $result = DI::cache()->get($cachekey);
3583 if (!is_null($result)) {
3587 $toplevel_item = Post::selectFirst(['guid', 'author-id', 'author-link', 'gravity'], ['id' => $item['parent'], 'parent' => $item['parent']]);
3588 if (!DBA::isResult($toplevel_item)) {
3589 Logger::error('Missing parent conversation item', ['parent' => $item['parent']]);
3593 $thread_parent_item = $toplevel_item;
3594 if ($item['thr-parent'] != $item['parent-uri']) {
3595 $thread_parent_item = Post::selectFirst(['guid', 'author-id', 'author-link', 'gravity'], ['uri' => $item['thr-parent'], 'uid' => $item['uid']]);
3598 $body = Post\Media::addAttachmentsToBody($item['uri-id'], $item['body']);
3600 // The replied to autor mention is prepended for clarity if:
3601 // - Item replied isn't yours
3602 // - Item is public or explicit mentions are disabled
3603 // - Implicit mentions are enabled
3605 $item['author-id'] != $thread_parent_item['author-id']
3606 && ($thread_parent_item['gravity'] != GRAVITY_PARENT)
3607 && (empty($item['uid']) || !Feature::isEnabled($item['uid'], 'explicit_mentions'))
3608 && !DI::config()->get('system', 'disable_implicit_mentions')
3610 $body = self::prependParentAuthorMention($body, $thread_parent_item['author-link']);
3613 $text = html_entity_decode(BBCode::toMarkdown($body));
3614 $created = DateTimeFormat::utc($item["created"], DateTimeFormat::ATOM);
3615 $edited = DateTimeFormat::utc($item["edited"], DateTimeFormat::ATOM);
3618 "author" => self::myHandle($owner),
3619 "guid" => $item["guid"],
3620 "created_at" => $created,
3621 "edited_at" => $edited,
3622 "parent_guid" => $toplevel_item["guid"],
3624 "author_signature" => ""
3627 // Send the thread parent guid only if it is a threaded comment
3628 if ($item['thr-parent'] != $item['parent-uri']) {
3629 $comment['thread_parent_guid'] = $thread_parent_item['guid'];
3632 DI::cache()->set($cachekey, $comment, Duration::QUARTER_HOUR);
3638 * Send a like or a comment
3640 * @param array $item The item that will be exported
3641 * @param array $owner the array of the item owner
3642 * @param array $contact Target of the communication
3643 * @param bool $public_batch Is it a public post?
3645 * @return int The result of the transmission
3646 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3647 * @throws \ImagickException
3649 public static function sendFollowup(array $item, array $owner, array $contact, $public_batch = false)
3651 if (in_array($item['verb'], [Activity::ATTEND, Activity::ATTENDNO, Activity::ATTENDMAYBE])) {
3652 $message = self::constructAttend($item, $owner);
3653 $type = "event_participation";
3654 } elseif (in_array($item["verb"], [Activity::LIKE, Activity::DISLIKE])) {
3655 $message = self::constructLike($item, $owner);
3657 } elseif (!in_array($item["verb"], [Activity::FOLLOW, Activity::TAG])) {
3658 $message = self::constructComment($item, $owner);
3662 if (empty($message)) {
3666 $message["author_signature"] = self::signature($owner, $message);
3668 return self::buildAndTransmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
3672 * Relays messages (like, comment, retraction) to other servers if we are the thread owner
3674 * @param array $item The item that will be exported
3675 * @param array $owner the array of the item owner
3676 * @param array $contact Target of the communication
3677 * @param bool $public_batch Is it a public post?
3679 * @return int The result of the transmission
3680 * @throws \Exception
3682 public static function sendRelay(array $item, array $owner, array $contact, $public_batch = false)
3684 if ($item["deleted"]) {
3685 return self::sendRetraction($item, $owner, $contact, $public_batch, true);
3686 } elseif (in_array($item["verb"], [Activity::LIKE, Activity::DISLIKE])) {
3692 Logger::info("Got relayable data ".$type." for item ".$item["guid"]." (".$item["id"].")");
3694 $msg = json_decode($item['signed_text'], true);
3697 if (is_array($msg)) {
3698 foreach ($msg as $field => $data) {
3699 if (!$item["deleted"]) {
3700 if ($field == "diaspora_handle") {
3703 if ($field == "target_type") {
3704 $field = "parent_type";
3708 $message[$field] = $data;
3711 Logger::info("Signature text for item ".$item["guid"]." (".$item["id"].") couldn't be extracted: ".$item['signed_text']);
3714 $message["parent_author_signature"] = self::signature($owner, $message);
3716 Logger::info('Relayed data', ['msg' => $message]);
3718 return self::buildAndTransmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
3722 * Sends a retraction (deletion) of a message, like or comment
3724 * @param array $item The item that will be exported
3725 * @param array $owner the array of the item owner
3726 * @param array $contact Target of the communication
3727 * @param bool $public_batch Is it a public post?
3728 * @param bool $relay Is the retraction transmitted from a relay?
3730 * @return int The result of the transmission
3731 * @throws \Exception
3733 public static function sendRetraction(array $item, array $owner, array $contact, $public_batch = false, $relay = false)
3735 $itemaddr = self::handleFromContact($item["contact-id"], $item["author-id"]);
3737 $msg_type = "retraction";
3739 if ($item['gravity'] == GRAVITY_PARENT) {
3740 $target_type = "Post";
3741 } elseif (in_array($item["verb"], [Activity::LIKE, Activity::DISLIKE])) {
3742 $target_type = "Like";
3744 $target_type = "Comment";
3747 $message = ["author" => $itemaddr,
3748 "target_guid" => $item['guid'],
3749 "target_type" => $target_type];
3751 Logger::info('Got message', ['msg' => $message]);
3753 return self::buildAndTransmit($owner, $contact, $msg_type, $message, $public_batch, $item["guid"]);
3759 * @param array $item The item that will be exported
3760 * @param array $owner The owner
3761 * @param array $contact Target of the communication
3763 * @return int The result of the transmission
3764 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3765 * @throws \ImagickException
3767 public static function sendMail(array $item, array $owner, array $contact)
3769 $myaddr = self::myHandle($owner);
3771 $cnv = DBA::selectFirst('conv', [], ['id' => $item["convid"], 'uid' => $item["uid"]]);
3772 if (!DBA::isResult($cnv)) {
3773 Logger::notice("conversation not found.");
3777 $body = BBCode::toMarkdown($item["body"]);
3778 $created = DateTimeFormat::utc($item["created"], DateTimeFormat::ATOM);
3781 "author" => $myaddr,
3782 "guid" => $item["guid"],
3783 "conversation_guid" => $cnv["guid"],
3785 "created_at" => $created,
3788 if ($item["reply"]) {
3793 "author" => $cnv["creator"],
3794 "guid" => $cnv["guid"],
3795 "subject" => $cnv["subject"],
3796 "created_at" => DateTimeFormat::utc($cnv['created'], DateTimeFormat::ATOM),
3797 "participants" => $cnv["recips"],
3801 $type = "conversation";
3804 return self::buildAndTransmit($owner, $contact, $type, $message, false, $item["guid"]);
3808 * Split a name into first name and last name
3810 * @param string $name The name
3812 * @return array The array with "first" and "last"
3814 public static function splitName($name) {
3815 $name = trim($name);
3817 // Is the name longer than 64 characters? Then cut the rest of it.
3818 if (strlen($name) > 64) {
3819 if ((strpos($name, ' ') <= 64) && (strpos($name, ' ') !== false)) {
3820 $name = trim(substr($name, 0, strrpos(substr($name, 0, 65), ' ')));
3822 $name = substr($name, 0, 64);
3826 // Take the first word as first name
3827 $first = ((strpos($name, ' ') ? trim(substr($name, 0, strpos($name, ' '))) : $name));
3828 $last = (($first === $name) ? '' : trim(substr($name, strlen($first))));
3829 if ((strlen($first) < 32) && (strlen($last) < 32)) {
3830 return ['first' => $first, 'last' => $last];
3833 // Take the last word as last name
3834 $first = ((strrpos($name, ' ') ? trim(substr($name, 0, strrpos($name, ' '))) : $name));
3835 $last = (($first === $name) ? '' : trim(substr($name, strlen($first))));
3837 if ((strlen($first) < 32) && (strlen($last) < 32)) {
3838 return ['first' => $first, 'last' => $last];
3841 // Take the first 32 characters if there is no space in the first 32 characters
3842 if ((strpos($name, ' ') > 32) || (strpos($name, ' ') === false)) {
3843 $first = substr($name, 0, 32);
3844 $last = substr($name, 32);
3845 return ['first' => $first, 'last' => $last];
3848 $first = trim(substr($name, 0, strrpos(substr($name, 0, 33), ' ')));
3849 $last = (($first === $name) ? '' : trim(substr($name, strlen($first))));
3851 // Check if the last name is longer than 32 characters
3852 if (strlen($last) > 32) {
3853 if (strpos($last, ' ') <= 32) {
3854 $last = trim(substr($last, 0, strrpos(substr($last, 0, 33), ' ')));
3856 $last = substr($last, 0, 32);
3860 return ['first' => $first, 'last' => $last];
3864 * Create profile data
3866 * @param int $uid The user id
3868 * @return array The profile data
3869 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3871 private static function createProfileData($uid)
3873 $profile = DBA::selectFirst('owner-view', ['uid', 'addr', 'name', 'location', 'net-publish', 'dob', 'about', 'pub_keywords'], ['uid' => $uid]);
3874 if (!DBA::isResult($profile)) {
3878 $handle = $profile["addr"];
3880 $split_name = self::splitName($profile['name']);
3881 $first = $split_name['first'];
3882 $last = $split_name['last'];
3884 $large = DI::baseUrl().'/photo/custom/300/'.$profile['uid'].'.jpg';
3885 $medium = DI::baseUrl().'/photo/custom/100/'.$profile['uid'].'.jpg';
3886 $small = DI::baseUrl().'/photo/custom/50/' .$profile['uid'].'.jpg';
3887 $searchable = ($profile['net-publish'] ? 'true' : 'false');
3893 if ($searchable === 'true') {
3896 if ($profile['dob'] && ($profile['dob'] > '0000-00-00')) {
3897 [$year, $month, $day] = sscanf($profile['dob'], '%4d-%2d-%2d');
3901 $dob = DateTimeFormat::utc($year . '-' . $month . '-'. $day, 'Y-m-d');
3904 $about = BBCode::toMarkdown($profile['about']);
3906 $location = $profile['location'];
3908 if ($profile['pub_keywords']) {
3909 $kw = str_replace(',', ' ', $profile['pub_keywords']);
3910 $kw = str_replace(' ', ' ', $kw);
3911 $arr = explode(' ', $kw);
3913 for ($x = 0; $x < 5; $x ++) {
3914 if (!empty($arr[$x])) {
3915 $tags .= '#'. trim($arr[$x]) .' ';
3920 $tags = trim($tags);
3923 return ["author" => $handle,
3924 "first_name" => $first,
3925 "last_name" => $last,
3926 "image_url" => $large,
3927 "image_url_medium" => $medium,
3928 "image_url_small" => $small,
3931 "location" => $location,
3932 "searchable" => $searchable,
3934 "tag_string" => $tags];
3938 * Sends profile data
3940 * @param int $uid The user id
3941 * @param bool $recips optional, default false
3943 * @throws \Exception
3945 public static function sendProfile($uid, $recips = false)
3951 $owner = User::getOwnerDataById($uid);
3957 $recips = DBA::selectToArray('contact', [], ['network' => Protocol::DIASPORA, 'uid' => $uid, 'rel' => [Contact::FOLLOWER, Contact::FRIEND]]);
3964 $message = self::createProfileData($uid);
3966 // @ToDo Split this into single worker jobs
3967 foreach ($recips as $recip) {
3968 Logger::info("Send updated profile data for user ".$uid." to contact ".$recip["id"]);
3969 self::buildAndTransmit($owner, $recip, "profile", $message);
3974 * Creates the signature for likes that are created on our system
3976 * @param integer $uid The user of that comment
3977 * @param array $item Item array
3979 * @return array Signed content
3980 * @throws \Exception
3982 public static function createLikeSignature($uid, array $item)
3984 $owner = User::getOwnerDataById($uid);
3985 if (empty($owner)) {
3986 Logger::info('No owner post, so not storing signature');
3990 if (!in_array($item["verb"], [Activity::LIKE, Activity::DISLIKE])) {
3994 $message = self::constructLike($item, $owner);
3995 if ($message === false) {
3999 $message["author_signature"] = self::signature($owner, $message);
4005 * Creates the signature for Comments that are created on our system
4007 * @param array $item Item array
4009 * @return array Signed content
4010 * @throws \Exception
4012 public static function createCommentSignature(array $item)
4014 if (!empty($item['author-link'])) {
4015 $url = $item['author-link'];
4017 $contact = Contact::getById($item['author-id'], ['url']);
4018 if (empty($contact['url'])) {
4019 Logger::warning('Author Contact not found', ['author-id' => $item['author-id']]);
4022 $url = $contact['url'];
4025 $uid = User::getIdForURL($url);
4027 Logger::info('No owner post, so not storing signature', ['url' => $contact['url']]);
4031 $owner = User::getOwnerDataById($uid);
4032 if (empty($owner)) {
4033 Logger::info('No owner post, so not storing signature');
4037 // This is only needed for the automated tests
4038 if (empty($owner['uprvkey'])) {
4042 $message = self::constructComment($item, $owner);
4043 if ($message === false) {
4047 $message["author_signature"] = self::signature($owner, $message);
4052 public static function performReshare(int $UriId, int $uid)
4054 $fields = ['uri-id', 'body', 'title', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink'];
4055 $item = Post::selectFirst($fields, ['uri-id' => $UriId, 'uid' => [$uid, 0], 'private' => [Item::PUBLIC, Item::UNLISTED]]);
4056 if (!DBA::isResult($item)) {
4060 if (strpos($item['body'], '[/share]') !== false) {
4061 $pos = strpos($item['body'], '[share');
4062 $post = substr($item['body'], $pos);
4064 $post = BBCode::getShareOpeningTag($item['author-name'], $item['author-link'], $item['author-avatar'], $item['plink'], $item['created'], $item['guid']);
4066 if (!empty($item['title'])) {
4067 $post .= '[h3]' . $item['title'] . "[/h3]\n";
4070 $post .= $item['body'];
4071 $post .= '[/share]';
4074 $owner = User::getOwnerDataById($uid);
4075 $author = Contact::getPublicIdByUserId($uid);
4079 'verb' => Activity::POST,
4080 'contact-id' => $owner['id'],
4081 'author-id' => $author,
4082 'owner-id' => $author,
4084 'allow_cid' => $owner['allow_cid'],
4085 'allow_gid' => $owner['allow_gid'],
4086 'deny_cid' => $owner['deny_cid'],
4087 'deny_gid' => $owner['deny_gid'],
4090 if (!empty($item['allow_cid'] . $item['allow_gid'] . $item['deny_cid'] . $item['deny_gid'])) {
4091 $item['private'] = Item::PRIVATE;
4092 } elseif (DI::pConfig()->get($uid, 'system', 'unlisted')) {
4093 $item['private'] = Item::UNLISTED;
4095 $item['private'] = Item::PUBLIC;
4098 // Don't trigger the addons
4099 $item['api_source'] = false;
4101 return Item::insert($item, true);