3 * @file src/Protocol/diaspora.php
4 * @brief The implementation of the diaspora protocol
6 * The new protocol is described here: http://diaspora.github.io/diaspora_federation/index.html
7 * This implementation here interprets the old and the new protocol and sends the new one.
8 * In the future we will remove most stuff from "validPosting" and interpret only the new protocol.
11 namespace Friendica\Protocol;
13 use Friendica\Content\Text\BBCode;
14 use Friendica\Content\Text\Markdown;
15 use Friendica\Core\Cache;
16 use Friendica\Core\Config;
17 use Friendica\Core\L10n;
18 use Friendica\Core\PConfig;
19 use Friendica\Core\System;
20 use Friendica\Core\Worker;
21 use Friendica\Database\DBM;
22 use Friendica\Model\Contact;
23 use Friendica\Model\GContact;
24 use Friendica\Model\Group;
25 use Friendica\Model\Item;
26 use Friendica\Model\Profile;
27 use Friendica\Model\Queue;
28 use Friendica\Model\User;
29 use Friendica\Network\Probe;
30 use Friendica\Util\Crypto;
31 use Friendica\Util\DateTimeFormat;
32 use Friendica\Util\Network;
33 use Friendica\Util\XML;
34 use Friendica\Util\Map;
38 require_once 'include/dba.php';
39 require_once 'include/items.php';
42 * @brief This class contain functions to create and send Diaspora XML files
48 * @brief Return a list of relay servers
50 * The list contains not only the official relays but also servers that we serve directly
52 * @param integer $item_id The id of the item that is sent
53 * @param array $contacts The previously fetched contacts
55 * @return array of relay servers
57 public static function relayList($item_id, $contacts = [])
61 // Fetching relay servers
62 $serverdata = Config::get("system", "relay_server");
63 if ($serverdata != "") {
64 $servers = explode(",", $serverdata);
65 foreach ($servers as $server) {
66 $serverlist[$server] = trim($server);
70 if (Config::get("system", "relay_directly", false)) {
71 // We distribute our stuff based on the parent to ensure that the thread will be complete
72 $parent = Item::selectFirst(['parent'], ['id' => $item_id]);
73 if (!DBM::is_result($parent)) {
77 // Servers that want to get all content
78 $servers = dba::select('gserver', ['url'], ['relay-subscribe' => true, 'relay-scope' => 'all']);
79 while ($server = dba::fetch($servers)) {
80 $serverlist[$server['url']] = $server['url'];
83 // All tags of the current post
84 $condition = ['otype' => TERM_OBJ_POST, 'type' => TERM_HASHTAG, 'oid' => $parent['parent']];
85 $tags = dba::select('term', ['term'], $condition);
87 while ($tag = dba::fetch($tags)) {
88 $taglist[] = $tag['term'];
91 // All servers who wants content with this tag
93 if (!empty($taglist)) {
94 $tagserver = dba::select('gserver-tag', ['gserver-id'], ['tag' => $taglist]);
95 while ($server = dba::fetch($tagserver)) {
96 $tagserverlist[] = $server['gserver-id'];
100 // All adresses with the given id
101 if (!empty($tagserverlist)) {
102 $servers = dba::select('gserver', ['url'], ['relay-subscribe' => true, 'relay-scope' => 'tags', 'id' => $tagserverlist]);
103 while ($server = dba::fetch($servers)) {
104 $serverlist[$server['url']] = $server['url'];
109 // Now we are collecting all relay contacts
110 foreach ($serverlist as $server_url) {
111 // We don't send messages to ourselves
112 if (link_compare($server_url, System::baseUrl())) {
115 $contact = self::getRelayContact($server_url);
116 if (is_bool($contact)) {
121 foreach ($contacts as $entry) {
122 if ($entry['batch'] == $contact['batch']) {
128 $contacts[] = $contact;
136 * @brief Return a contact for a given server address or creates a dummy entry
138 * @param string $server_url The url of the server
139 * @return array with the contact
141 private static function getRelayContact($server_url)
143 $fields = ['batch', 'id', 'name', 'network', 'archive', 'blocked'];
145 // Fetch the relay contact
146 $condition = ['uid' => 0, 'nurl' => normalise_link($server_url),
147 'contact-type' => ACCOUNT_TYPE_RELAY];
148 $contact = dba::selectFirst('contact', $fields, $condition);
150 if (DBM::is_result($contact)) {
151 if ($contact['archive'] || $contact['blocked']) {
156 self::setRelayContact($server_url);
158 $contact = dba::selectFirst('contact', $fields, $condition);
159 if (DBM::is_result($contact)) {
164 // It should never happen that we arrive here
169 * @brief Update or insert a relay contact
171 * @param string $server_url The url of the server
172 * @param array $network_fields Optional network specific fields
174 public static function setRelayContact($server_url, $network_fields = [])
176 $fields = ['created' => DateTimeFormat::utcNow(),
177 'name' => 'relay', 'nick' => 'relay',
178 'url' => $server_url, 'network' => NETWORK_DIASPORA,
179 'batch' => $server_url . '/receive/public',
180 'rel' => CONTACT_IS_FOLLOWER, 'blocked' => false,
181 'pending' => false, 'writable' => true];
183 $fields = array_merge($fields, $network_fields);
185 $condition = ['uid' => 0, 'nurl' => normalise_link($server_url),
186 'contact-type' => ACCOUNT_TYPE_RELAY];
188 if (dba::exists('contact', $condition)) {
189 unset($fields['created']);
192 dba::update('contact', $fields, $condition, true);
196 * @brief Return a list of participating contacts for a thread
198 * This is used for the participation feature.
199 * One of the parameters is a contact array.
200 * This is done to avoid duplicates.
202 * @param integer $thread The id of the thread
203 * @param array $contacts The previously fetched contacts
205 * @return array of relay servers
207 public static function participantsForThread($thread, $contacts)
209 $r = dba::p("SELECT `contact`.`batch`, `contact`.`id`, `contact`.`name`, `contact`.`network`,
210 `fcontact`.`batch` AS `fbatch`, `fcontact`.`network` AS `fnetwork` FROM `participation`
211 INNER JOIN `contact` ON `contact`.`id` = `participation`.`cid`
212 INNER JOIN `fcontact` ON `fcontact`.`id` = `participation`.`fid`
213 WHERE `participation`.`iid` = ?", $thread);
215 while ($contact = dba::fetch($r)) {
216 if (!empty($contact['fnetwork'])) {
217 $contact['network'] = $contact['fnetwork'];
219 unset($contact['fnetwork']);
221 if (empty($contact['batch']) && !empty($contact['fbatch'])) {
222 $contact['batch'] = $contact['fbatch'];
224 unset($contact['fbatch']);
227 foreach ($contacts as $entry) {
228 if ($entry['batch'] == $contact['batch']) {
234 $contacts[] = $contact;
243 * @brief repairs a signature that was double encoded
245 * The function is unused at the moment. It was copied from the old implementation.
247 * @param string $signature The signature
248 * @param string $handle The handle of the signature owner
249 * @param integer $level This value is only set inside this function to avoid endless loops
251 * @return string the repaired signature
253 private static function repairSignature($signature, $handle = "", $level = 1)
255 if ($signature == "") {
259 if (base64_encode(base64_decode(base64_decode($signature))) == base64_decode($signature)) {
260 $signature = base64_decode($signature);
261 logger("Repaired double encoded signature from Diaspora/Hubzilla handle ".$handle." - level ".$level, LOGGER_DEBUG);
263 // Do a recursive call to be able to fix even multiple levels
265 $signature = self::repairSignature($signature, $handle, ++$level);
273 * @brief verify the envelope and return the verified data
275 * @param string $envelope The magic envelope
277 * @return string verified data
279 private static function verifyMagicEnvelope($envelope)
281 $basedom = XML::parseString($envelope);
283 if (!is_object($basedom)) {
284 logger("Envelope is no XML file");
288 $children = $basedom->children('http://salmon-protocol.org/ns/magic-env');
290 if (sizeof($children) == 0) {
291 logger("XML has no children");
297 $data = base64url_decode($children->data);
298 $type = $children->data->attributes()->type[0];
300 $encoding = $children->encoding;
302 $alg = $children->alg;
304 $sig = base64url_decode($children->sig);
305 $key_id = $children->sig->attributes()->key_id[0];
307 $handle = base64url_decode($key_id);
310 $b64url_data = base64url_encode($data);
311 $msg = str_replace(["\n", "\r", " ", "\t"], ["", "", "", ""], $b64url_data);
313 $signable_data = $msg.".".base64url_encode($type).".".base64url_encode($encoding).".".base64url_encode($alg);
316 logger('No author could be decoded. Discarding. Message: ' . $envelope);
320 $key = self::key($handle);
322 logger("Couldn't get a key for handle " . $handle . ". Discarding.");
326 $verify = Crypto::rsaVerify($signable_data, $sig, $key);
328 logger('Message from ' . $handle . ' did not verify. Discarding.');
336 * @brief encrypts data via AES
338 * @param string $key The AES key
339 * @param string $iv The IV (is used for CBC encoding)
340 * @param string $data The data that is to be encrypted
342 * @return string encrypted data
344 private static function aesEncrypt($key, $iv, $data)
346 return openssl_encrypt($data, 'aes-256-cbc', str_pad($key, 32, "\0"), OPENSSL_RAW_DATA, str_pad($iv, 16, "\0"));
350 * @brief decrypts data via AES
352 * @param string $key The AES key
353 * @param string $iv The IV (is used for CBC encoding)
354 * @param string $encrypted The encrypted data
356 * @return string decrypted data
358 private static function aesDecrypt($key, $iv, $encrypted)
360 return openssl_decrypt($encrypted, 'aes-256-cbc', str_pad($key, 32, "\0"), OPENSSL_RAW_DATA, str_pad($iv, 16, "\0"));
364 * @brief: Decodes incoming Diaspora message in the new format
366 * @param array $importer Array of the importer user
367 * @param string $raw raw post message
370 * 'message' -> decoded Diaspora XML message
371 * 'author' -> author diaspora handle
372 * 'key' -> author public key (converted to pkcs#8)
374 public static function decodeRaw($importer, $raw)
376 $data = json_decode($raw);
378 // Is it a private post? Then decrypt the outer Salmon
379 if (is_object($data)) {
380 $encrypted_aes_key_bundle = base64_decode($data->aes_key);
381 $ciphertext = base64_decode($data->encrypted_magic_envelope);
383 $outer_key_bundle = '';
384 @openssl_private_decrypt($encrypted_aes_key_bundle, $outer_key_bundle, $importer['prvkey']);
385 $j_outer_key_bundle = json_decode($outer_key_bundle);
387 if (!is_object($j_outer_key_bundle)) {
388 logger('Outer Salmon did not verify. Discarding.');
389 System::httpExit(400);
392 $outer_iv = base64_decode($j_outer_key_bundle->iv);
393 $outer_key = base64_decode($j_outer_key_bundle->key);
395 $xml = self::aesDecrypt($outer_key, $outer_iv, $ciphertext);
400 $basedom = XML::parseString($xml);
402 if (!is_object($basedom)) {
403 logger('Received data does not seem to be an XML. Discarding. '.$xml);
404 System::httpExit(400);
407 $base = $basedom->children(NAMESPACE_SALMON_ME);
409 // Not sure if this cleaning is needed
410 $data = str_replace([" ", "\t", "\r", "\n"], ["", "", "", ""], $base->data);
412 // Build the signed data
413 $type = $base->data[0]->attributes()->type[0];
414 $encoding = $base->encoding;
416 $signed_data = $data.'.'.base64url_encode($type).'.'.base64url_encode($encoding).'.'.base64url_encode($alg);
418 // This is the signature
419 $signature = base64url_decode($base->sig);
421 // Get the senders' public key
422 $key_id = $base->sig[0]->attributes()->key_id[0];
423 $author_addr = base64_decode($key_id);
424 if ($author_addr == '') {
425 logger('No author could be decoded. Discarding. Message: ' . $xml);
426 System::httpExit(400);
429 $key = self::key($author_addr);
431 logger("Couldn't get a key for handle " . $author_addr . ". Discarding.");
432 System::httpExit(400);
435 $verify = Crypto::rsaVerify($signed_data, $signature, $key);
437 logger('Message did not verify. Discarding.');
438 System::httpExit(400);
441 return ['message' => (string)base64url_decode($base->data),
442 'author' => unxmlify($author_addr),
443 'key' => (string)$key];
447 * @brief: Decodes incoming Diaspora message in the deprecated format
449 * @param array $importer Array of the importer user
450 * @param string $xml urldecoded Diaspora salmon
453 * 'message' -> decoded Diaspora XML message
454 * 'author' -> author diaspora handle
455 * 'key' -> author public key (converted to pkcs#8)
457 public static function decode($importer, $xml)
460 $basedom = XML::parseString($xml);
462 if (!is_object($basedom)) {
463 logger("XML is not parseable.");
466 $children = $basedom->children('https://joindiaspora.com/protocol');
468 $inner_aes_key = null;
471 if ($children->header) {
473 $author_link = str_replace('acct:', '', $children->header->author_id);
475 // This happens with posts from a relais
477 logger("This is no private post in the old format", LOGGER_DEBUG);
481 $encrypted_header = json_decode(base64_decode($children->encrypted_header));
483 $encrypted_aes_key_bundle = base64_decode($encrypted_header->aes_key);
484 $ciphertext = base64_decode($encrypted_header->ciphertext);
486 $outer_key_bundle = '';
487 openssl_private_decrypt($encrypted_aes_key_bundle, $outer_key_bundle, $importer['prvkey']);
489 $j_outer_key_bundle = json_decode($outer_key_bundle);
491 $outer_iv = base64_decode($j_outer_key_bundle->iv);
492 $outer_key = base64_decode($j_outer_key_bundle->key);
494 $decrypted = self::aesDecrypt($outer_key, $outer_iv, $ciphertext);
496 logger('decrypted: '.$decrypted, LOGGER_DEBUG);
497 $idom = XML::parseString($decrypted);
499 $inner_iv = base64_decode($idom->iv);
500 $inner_aes_key = base64_decode($idom->aes_key);
502 $author_link = str_replace('acct:', '', $idom->author_id);
505 $dom = $basedom->children(NAMESPACE_SALMON_ME);
507 // figure out where in the DOM tree our data is hiding
510 if ($dom->provenance->data) {
511 $base = $dom->provenance;
512 } elseif ($dom->env->data) {
514 } elseif ($dom->data) {
519 logger('unable to locate salmon data in xml');
520 System::httpExit(400);
524 // Stash the signature away for now. We have to find their key or it won't be good for anything.
525 $signature = base64url_decode($base->sig);
529 // strip whitespace so our data element will return to one big base64 blob
530 $data = str_replace([" ", "\t", "\r", "\n"], ["", "", "", ""], $base->data);
533 // stash away some other stuff for later
535 $type = $base->data[0]->attributes()->type[0];
536 $keyhash = $base->sig[0]->attributes()->keyhash[0];
537 $encoding = $base->encoding;
541 $signed_data = $data.'.'.base64url_encode($type).'.'.base64url_encode($encoding).'.'.base64url_encode($alg);
545 $data = base64url_decode($data);
549 $inner_decrypted = $data;
551 // Decode the encrypted blob
552 $inner_encrypted = base64_decode($data);
553 $inner_decrypted = self::aesDecrypt($inner_aes_key, $inner_iv, $inner_encrypted);
557 logger('Could not retrieve author URI.');
558 System::httpExit(400);
560 // Once we have the author URI, go to the web and try to find their public key
561 // (first this will look it up locally if it is in the fcontact cache)
562 // This will also convert diaspora public key from pkcs#1 to pkcs#8
564 logger('Fetching key for '.$author_link);
565 $key = self::key($author_link);
568 logger('Could not retrieve author key.');
569 System::httpExit(400);
572 $verify = Crypto::rsaVerify($signed_data, $signature, $key);
575 logger('Message did not verify. Discarding.');
576 System::httpExit(400);
579 logger('Message verified.');
581 return ['message' => (string)$inner_decrypted,
582 'author' => unxmlify($author_link),
583 'key' => (string)$key];
588 * @brief Dispatches public messages and find the fitting receivers
590 * @param array $msg The post that will be dispatched
592 * @return int The message id of the generated message, "true" or "false" if there was an error
594 public static function dispatchPublic($msg)
596 $enabled = intval(Config::get("system", "diaspora_enabled"));
598 logger("diaspora is disabled");
602 if (!($fields = self::validPosting($msg))) {
603 logger("Invalid posting");
607 $importer = ["uid" => 0, "page-flags" => PAGE_FREELOVE];
608 $success = self::dispatch($importer, $msg, $fields);
614 * @brief Dispatches the different message types to the different functions
616 * @param array $importer Array of the importer user
617 * @param array $msg The post that will be dispatched
618 * @param object $fields SimpleXML object that contains the message
620 * @return int The message id of the generated message, "true" or "false" if there was an error
622 public static function dispatch($importer, $msg, $fields = null)
624 // The sender is the handle of the contact that sent the message.
625 // This will often be different with relayed messages (for example "like" and "comment")
626 $sender = $msg["author"];
628 // This is only needed for private postings since this is already done for public ones before
629 if (is_null($fields)) {
631 if (!($fields = self::validPosting($msg))) {
632 logger("Invalid posting");
639 $type = $fields->getName();
641 logger("Received message type ".$type." from ".$sender." for user ".$importer["uid"], LOGGER_DEBUG);
644 case "account_migration":
646 logger('Message with type ' . $type . ' is not private, quitting.');
649 return self::receiveAccountMigration($importer, $fields);
651 case "account_deletion":
652 return self::receiveAccountDeletion($fields);
655 return self::receiveComment($importer, $sender, $fields, $msg["message"]);
659 logger('Message with type ' . $type . ' is not private, quitting.');
662 return self::receiveContactRequest($importer, $fields);
666 logger('Message with type ' . $type . ' is not private, quitting.');
669 return self::receiveConversation($importer, $msg, $fields);
672 return self::receiveLike($importer, $sender, $fields);
676 logger('Message with type ' . $type . ' is not private, quitting.');
679 return self::receiveMessage($importer, $fields);
681 case "participation":
683 logger('Message with type ' . $type . ' is not private, quitting.');
686 return self::receiveParticipation($importer, $fields);
688 case "photo": // Not implemented
689 return self::receivePhoto($importer, $fields);
691 case "poll_participation": // Not implemented
692 return self::receivePollParticipation($importer, $fields);
696 logger('Message with type ' . $type . ' is not private, quitting.');
699 return self::receiveProfile($importer, $fields);
702 return self::receiveReshare($importer, $fields, $msg["message"]);
705 return self::receiveRetraction($importer, $sender, $fields);
707 case "status_message":
708 return self::receiveStatusMessage($importer, $fields, $msg["message"]);
711 logger("Unknown message type ".$type);
719 * @brief Checks if a posting is valid and fetches the data fields.
721 * This function does not only check the signature.
722 * It also does the conversion between the old and the new diaspora format.
724 * @param array $msg Array with the XML, the sender handle and the sender signature
726 * @return bool|array If the posting is valid then an array with an SimpleXML object is returned
728 private static function validPosting($msg)
730 $data = XML::parseString($msg["message"]);
732 if (!is_object($data)) {
733 logger("No valid XML ".$msg["message"], LOGGER_DEBUG);
737 // Is this the new or the old version?
738 if ($data->getName() == "XML") {
740 foreach ($data->post->children() as $child) {
748 $type = $element->getName();
751 logger("Got message type ".$type.": ".$msg["message"], LOGGER_DATA);
753 // All retractions are handled identically from now on.
754 // In the new version there will only be "retraction".
755 if (in_array($type, ["signed_retraction", "relayable_retraction"]))
756 $type = "retraction";
758 if ($type == "request") {
762 $fields = new SimpleXMLElement("<".$type."/>");
765 $author_signature = null;
766 $parent_author_signature = null;
768 foreach ($element->children() as $fieldname => $entry) {
770 // Translation for the old XML structure
771 if ($fieldname == "diaspora_handle") {
772 $fieldname = "author";
774 if ($fieldname == "participant_handles") {
775 $fieldname = "participants";
777 if (in_array($type, ["like", "participation"])) {
778 if ($fieldname == "target_type") {
779 $fieldname = "parent_type";
782 if ($fieldname == "sender_handle") {
783 $fieldname = "author";
785 if ($fieldname == "recipient_handle") {
786 $fieldname = "recipient";
788 if ($fieldname == "root_diaspora_id") {
789 $fieldname = "root_author";
791 if ($type == "status_message") {
792 if ($fieldname == "raw_message") {
796 if ($type == "retraction") {
797 if ($fieldname == "post_guid") {
798 $fieldname = "target_guid";
800 if ($fieldname == "type") {
801 $fieldname = "target_type";
806 if (($fieldname == "author_signature") && ($entry != "")) {
807 $author_signature = base64_decode($entry);
808 } elseif (($fieldname == "parent_author_signature") && ($entry != "")) {
809 $parent_author_signature = base64_decode($entry);
810 } elseif (!in_array($fieldname, ["author_signature", "parent_author_signature", "target_author_signature"])) {
811 if ($signed_data != "") {
815 $signed_data .= $entry;
817 if (!in_array($fieldname, ["parent_author_signature", "target_author_signature"])
818 || ($orig_type == "relayable_retraction")
820 XML::copy($entry, $fields, $fieldname);
824 // This is something that shouldn't happen at all.
825 if (in_array($type, ["status_message", "reshare", "profile"])) {
826 if ($msg["author"] != $fields->author) {
827 logger("Message handle is not the same as envelope sender. Quitting this message.");
832 // Only some message types have signatures. So we quit here for the other types.
833 if (!in_array($type, ["comment", "like"])) {
836 // No author_signature? This is a must, so we quit.
837 if (!isset($author_signature)) {
838 logger("No author signature for type ".$type." - Message: ".$msg["message"], LOGGER_DEBUG);
842 if (isset($parent_author_signature)) {
843 $key = self::key($msg["author"]);
845 logger("No key found for parent author ".$msg["author"], LOGGER_DEBUG);
849 if (!Crypto::rsaVerify($signed_data, $parent_author_signature, $key, "sha256")) {
850 logger("No valid parent author signature for parent author ".$msg["author"]. " in type ".$type." - signed data: ".$signed_data." - Message: ".$msg["message"]." - Signature ".$parent_author_signature, LOGGER_DEBUG);
855 $key = self::key($fields->author);
857 logger("No key found for author ".$fields->author, LOGGER_DEBUG);
861 if (!Crypto::rsaVerify($signed_data, $author_signature, $key, "sha256")) {
862 logger("No valid author signature for author ".$fields->author. " in type ".$type." - signed data: ".$signed_data." - Message: ".$msg["message"]." - Signature ".$author_signature, LOGGER_DEBUG);
870 * @brief Fetches the public key for a given handle
872 * @param string $handle The handle
874 * @return string The public key
876 private static function key($handle)
878 $handle = strval($handle);
880 logger("Fetching diaspora key for: ".$handle);
882 $r = self::personByHandle($handle);
891 * @brief Fetches data for a given handle
893 * @param string $handle The handle
895 * @return array the queried data
897 public static function personByHandle($handle)
901 $person = dba::selectFirst('fcontact', [], ['network' => NETWORK_DIASPORA, 'addr' => $handle]);
902 if (DBM::is_result($person)) {
903 logger("In cache " . print_r($person, true), LOGGER_DEBUG);
905 // update record occasionally so it doesn't get stale
906 $d = strtotime($person["updated"]." +00:00");
907 if ($d < strtotime("now - 14 days")) {
911 if ($person["guid"] == "") {
916 if (!DBM::is_result($person) || $update) {
917 logger("create or refresh", LOGGER_DEBUG);
918 $r = Probe::uri($handle, NETWORK_DIASPORA);
920 // Note that Friendica contacts will return a "Diaspora person"
921 // if Diaspora connectivity is enabled on their server
922 if ($r && ($r["network"] === NETWORK_DIASPORA)) {
923 self::updateFContact($r);
925 // Fetch the updated or added contact
926 $person = dba::selectFirst('fcontact', [], ['network' => NETWORK_DIASPORA, 'addr' => $handle]);
927 if (!DBM::is_result($person)) {
937 * @brief Updates the fcontact table
939 * @param array $arr The fcontact data
941 private static function updateFContact($arr)
943 $fields = ['name' => $arr["name"], 'photo' => $arr["photo"],
944 'request' => $arr["request"], 'nick' => $arr["nick"],
945 'addr' => strtolower($arr["addr"]), 'guid' => $arr["guid"],
946 'batch' => $arr["batch"], 'notify' => $arr["notify"],
947 'poll' => $arr["poll"], 'confirm' => $arr["confirm"],
948 'alias' => $arr["alias"], 'pubkey' => $arr["pubkey"],
949 'updated' => DateTimeFormat::utcNow()];
951 $condition = ['url' => $arr["url"], 'network' => $arr["network"]];
953 dba::update('fcontact', $fields, $condition, true);
957 * @brief get a handle (user@domain.tld) from a given contact id
959 * @param int $contact_id The id in the contact table
960 * @param int $pcontact_id The id in the contact table (Used for the public contact)
962 * @return string the handle
964 private static function handleFromContact($contact_id, $pcontact_id = 0)
968 logger("contact id is ".$contact_id." - pcontact id is ".$pcontact_id, LOGGER_DEBUG);
970 if ($pcontact_id != 0) {
972 "SELECT `addr` FROM `contact` WHERE `id` = %d AND `addr` != ''",
976 if (DBM::is_result($r)) {
977 return strtolower($r[0]["addr"]);
982 "SELECT `network`, `addr`, `self`, `url`, `nick` FROM `contact` WHERE `id` = %d",
986 if (DBM::is_result($r)) {
989 logger("contact 'self' = ".$contact['self']." 'url' = ".$contact['url'], LOGGER_DEBUG);
991 if ($contact['addr'] != "") {
992 $handle = $contact['addr'];
994 $baseurl_start = strpos($contact['url'], '://') + 3;
995 // allows installations in a subdirectory--not sure how Diaspora will handle
996 $baseurl_length = strpos($contact['url'], '/profile') - $baseurl_start;
997 $baseurl = substr($contact['url'], $baseurl_start, $baseurl_length);
998 $handle = $contact['nick'].'@'.$baseurl;
1002 return strtolower($handle);
1006 * @brief get a url (scheme://domain.tld/u/user) from a given Diaspora*
1009 * @param mixed $fcontact_guid Hexadecimal string guid
1011 * @return string the contact url or null
1013 public static function urlFromContactGuid($fcontact_guid)
1015 logger("fcontact guid is ".$fcontact_guid, LOGGER_DEBUG);
1018 "SELECT `url` FROM `fcontact` WHERE `url` != '' AND `network` = '%s' AND `guid` = '%s'",
1019 dbesc(NETWORK_DIASPORA),
1020 dbesc($fcontact_guid)
1023 if (DBM::is_result($r)) {
1024 return $r[0]['url'];
1031 * @brief Get a contact id for a given handle
1033 * @todo Move to Friendica\Model\Contact
1035 * @param int $uid The user id
1036 * @param string $handle The handle in the format user@domain.tld
1038 * @return int Contact id
1040 private static function contactByHandle($uid, $handle)
1042 // First do a direct search on the contact table
1044 "SELECT * FROM `contact` WHERE `uid` = %d AND `addr` = '%s' LIMIT 1",
1049 if (DBM::is_result($r)) {
1053 * We haven't found it?
1054 * We use another function for it that will possibly create a contact entry.
1056 $cid = Contact::getIdForURL($handle, $uid);
1059 /// @TODO Contact retrieval should be encapsulated into an "entity" class like `Contact`
1060 $r = q("SELECT * FROM `contact` WHERE `id` = %d LIMIT 1", intval($cid));
1062 if (DBM::is_result($r)) {
1068 $handle_parts = explode("@", $handle);
1069 $nurl_sql = "%%://".$handle_parts[1]."%%/profile/".$handle_parts[0];
1071 "SELECT * FROM `contact` WHERE `network` = '%s' AND `uid` = %d AND `nurl` LIKE '%s' LIMIT 1",
1072 dbesc(NETWORK_DFRN),
1076 if (DBM::is_result($r)) {
1080 logger("Haven't found contact for user ".$uid." and handle ".$handle, LOGGER_DEBUG);
1085 * @brief Check if posting is allowed for this contact
1087 * @param array $importer Array of the importer user
1088 * @param array $contact The contact that is checked
1089 * @param bool $is_comment Is the check for a comment?
1091 * @return bool is the contact allowed to post?
1093 private static function postAllow($importer, $contact, $is_comment = false)
1096 * Perhaps we were already sharing with this person. Now they're sharing with us.
1097 * That makes us friends.
1098 * Normally this should have handled by getting a request - but this could get lost
1100 // It is deactivated by now, due to side effects. See issue https://github.com/friendica/friendica/pull/4033
1101 // It is not removed by now. Possibly the code is needed?
1102 //if (!$is_comment && $contact["rel"] == CONTACT_IS_FOLLOWER && in_array($importer["page-flags"], array(PAGE_FREELOVE))) {
1105 // array('rel' => CONTACT_IS_FRIEND, 'writable' => true),
1106 // array('id' => $contact["id"], 'uid' => $contact["uid"])
1109 // $contact["rel"] = CONTACT_IS_FRIEND;
1110 // logger("defining user ".$contact["nick"]." as friend");
1113 // We don't seem to like that person
1114 if ($contact["blocked"]) {
1115 // Maybe blocked, don't accept.
1117 // We are following this person?
1118 } elseif (($contact["rel"] == CONTACT_IS_SHARING) || ($contact["rel"] == CONTACT_IS_FRIEND)) {
1119 // Yes, then it is fine.
1121 // Is it a post to a community?
1122 } elseif (($contact["rel"] == CONTACT_IS_FOLLOWER) && in_array($importer["page-flags"], [PAGE_COMMUNITY, PAGE_PRVGROUP])) {
1125 // Is the message a global user or a comment?
1126 } elseif (($importer["uid"] == 0) || $is_comment) {
1127 // Messages for the global users and comments are always accepted
1135 * @brief Fetches the contact id for a handle and checks if posting is allowed
1137 * @param array $importer Array of the importer user
1138 * @param string $handle The checked handle in the format user@domain.tld
1139 * @param bool $is_comment Is the check for a comment?
1141 * @return array The contact data
1143 private static function allowedContactByHandle($importer, $handle, $is_comment = false)
1145 $contact = self::contactByHandle($importer["uid"], $handle);
1147 logger("A Contact for handle ".$handle." and user ".$importer["uid"]." was not found");
1148 // If a contact isn't found, we accept it anyway if it is a comment
1156 if (!self::postAllow($importer, $contact, $is_comment)) {
1157 logger("The handle: ".$handle." is not allowed to post to user ".$importer["uid"]);
1164 * @brief Does the message already exists on the system?
1166 * @param int $uid The user id
1167 * @param string $guid The guid of the message
1169 * @return int|bool message id if the message already was stored into the system - or false.
1171 private static function messageExists($uid, $guid)
1173 $item = Item::selectFirst(['id'], ['uid' => $uid, 'guid' => $guid]);
1174 if (DBM::is_result($item)) {
1175 logger("message ".$guid." already exists for user ".$uid);
1183 * @brief Checks for links to posts in a message
1185 * @param array $item The item array
1188 private static function fetchGuid($item)
1190 $expression = "=diaspora://.*?/post/([0-9A-Za-z\-_@.:]{15,254}[0-9A-Za-z])=ism";
1191 preg_replace_callback(
1193 function ($match) use ($item) {
1194 self::fetchGuidSub($match, $item);
1199 preg_replace_callback(
1200 "&\[url=/posts/([^\[\]]*)\](.*)\[\/url\]&Usi",
1201 function ($match) use ($item) {
1202 self::fetchGuidSub($match, $item);
1209 * @brief Checks for relative /people/* links in an item body to match local
1210 * contacts or prepends the remote host taken from the author link.
1212 * @param string $body The item body to replace links from
1213 * @param string $author_link The author link for missing local contact fallback
1215 * @return string the replaced string
1217 public static function replacePeopleGuid($body, $author_link)
1219 $return = preg_replace_callback(
1220 "&\[url=/people/([^\[\]]*)\](.*)\[\/url\]&Usi",
1221 function ($match) use ($author_link) {
1223 // 0 => '[url=/people/0123456789abcdef]Foo Bar[/url]'
1224 // 1 => '0123456789abcdef'
1226 $handle = self::urlFromContactGuid($match[1]);
1229 $return = '@[url='.$handle.']'.$match[2].'[/url]';
1231 // No local match, restoring absolute remote URL from author scheme and host
1232 $author_url = parse_url($author_link);
1233 $return = '[url='.$author_url['scheme'].'://'.$author_url['host'].'/people/'.$match[1].']'.$match[2].'[/url]';
1245 * @brief sub function of "fetchGuid" which checks for links in messages
1247 * @param array $match array containing a link that has to be checked for a message link
1248 * @param array $item The item array
1251 private static function fetchGuidSub($match, $item)
1253 if (!self::storeByGuid($match[1], $item["author-link"])) {
1254 self::storeByGuid($match[1], $item["owner-link"]);
1259 * @brief Fetches an item with a given guid from a given server
1261 * @param string $guid the message guid
1262 * @param string $server The server address
1263 * @param int $uid The user id of the user
1265 * @return int the message id of the stored message or false
1267 private static function storeByGuid($guid, $server, $uid = 0)
1269 $serverparts = parse_url($server);
1270 $server = $serverparts["scheme"]."://".$serverparts["host"];
1272 logger("Trying to fetch item ".$guid." from ".$server, LOGGER_DEBUG);
1274 $msg = self::message($guid, $server);
1280 logger("Successfully fetched item ".$guid." from ".$server, LOGGER_DEBUG);
1282 // Now call the dispatcher
1283 return self::dispatchPublic($msg);
1287 * @brief Fetches a message from a server
1289 * @param string $guid message guid
1290 * @param string $server The url of the server
1291 * @param int $level Endless loop prevention
1294 * 'message' => The message XML
1295 * 'author' => The author handle
1296 * 'key' => The public key of the author
1298 private static function message($guid, $server, $level = 0)
1304 // This will work for new Diaspora servers and Friendica servers from 3.5
1305 $source_url = $server."/fetch/post/".urlencode($guid);
1307 logger("Fetch post from ".$source_url, LOGGER_DEBUG);
1309 $envelope = Network::fetchUrl($source_url);
1311 logger("Envelope was fetched.", LOGGER_DEBUG);
1312 $x = self::verifyMagicEnvelope($envelope);
1314 logger("Envelope could not be verified.", LOGGER_DEBUG);
1316 logger("Envelope was verified.", LOGGER_DEBUG);
1322 // This will work for older Diaspora and Friendica servers
1324 $source_url = $server."/p/".urlencode($guid).".xml";
1325 logger("Fetch post from ".$source_url, LOGGER_DEBUG);
1327 $x = Network::fetchUrl($source_url);
1333 $source_xml = XML::parseString($x);
1335 if (!is_object($source_xml)) {
1339 if ($source_xml->post->reshare) {
1340 // Reshare of a reshare - old Diaspora version
1341 logger("Message is a reshare", LOGGER_DEBUG);
1342 return self::message($source_xml->post->reshare->root_guid, $server, ++$level);
1343 } elseif ($source_xml->getName() == "reshare") {
1344 // Reshare of a reshare - new Diaspora version
1345 logger("Message is a new reshare", LOGGER_DEBUG);
1346 return self::message($source_xml->root_guid, $server, ++$level);
1351 // Fetch the author - for the old and the new Diaspora version
1352 if ($source_xml->post->status_message && $source_xml->post->status_message->diaspora_handle) {
1353 $author = (string)$source_xml->post->status_message->diaspora_handle;
1354 } elseif ($source_xml->author && ($source_xml->getName() == "status_message")) {
1355 $author = (string)$source_xml->author;
1358 // If this isn't a "status_message" then quit
1360 logger("Message doesn't seem to be a status message", LOGGER_DEBUG);
1364 $msg = ["message" => $x, "author" => $author];
1366 $msg["key"] = self::key($msg["author"]);
1372 * @brief Fetches the item record of a given guid
1374 * @param int $uid The user id
1375 * @param string $guid message guid
1376 * @param string $author The handle of the item
1377 * @param array $contact The contact of the item owner
1379 * @return array the item record
1381 private static function parentItem($uid, $guid, $author, $contact)
1383 $fields = ['id', 'parent', 'body', 'wall', 'uri', 'guid', 'private', 'origin',
1384 'author-name', 'author-link', 'author-avatar',
1385 'owner-name', 'owner-link', 'owner-avatar'];
1386 $condition = ['uid' => $uid, 'guid' => $guid];
1387 $item = Item::selectFirst($fields, $condition);
1389 if (!DBM::is_result($item)) {
1390 $result = self::storeByGuid($guid, $contact["url"], $uid);
1393 $person = self::personByHandle($author);
1394 $result = self::storeByGuid($guid, $person["url"], $uid);
1398 logger("Fetched missing item ".$guid." - result: ".$result, LOGGER_DEBUG);
1400 $item = Item::selectFirst($fields, $condition);
1404 if (!DBM::is_result($item)) {
1405 logger("parent item not found: parent: ".$guid." - user: ".$uid);
1408 logger("parent item found: parent: ".$guid." - user: ".$uid);
1414 * @brief returns contact details
1416 * @param array $def_contact The default contact if the person isn't found
1417 * @param array $person The record of the person
1418 * @param int $uid The user id
1421 * 'cid' => contact id
1422 * 'network' => network type
1424 private static function authorContactByUrl($def_contact, $person, $uid)
1426 $condition = ['nurl' => normalise_link($person["url"]), 'uid' => $uid];
1427 $contact = dba::selectFirst('contact', ['id', 'network'], $condition);
1428 if (DBM::is_result($contact)) {
1429 $cid = $contact["id"];
1430 $network = $contact["network"];
1432 $cid = $def_contact["id"];
1433 $network = NETWORK_DIASPORA;
1436 return ["cid" => $cid, "network" => $network];
1440 * @brief Is the profile a hubzilla profile?
1442 * @param string $url The profile link
1444 * @return bool is it a hubzilla server?
1446 public static function isRedmatrix($url)
1448 return(strstr($url, "/channel/"));
1452 * @brief Generate a post link with a given handle and message guid
1454 * @param string $addr The user handle
1455 * @param string $guid message guid
1456 * @param string $parent_guid optional parent guid
1458 * @return string the post link
1460 private static function plink($addr, $guid, $parent_guid = '')
1462 $contact = Contact::getDetailsByAddr($addr);
1466 if ($parent_guid != '') {
1467 return "https://" . substr($addr, strpos($addr, "@") + 1) . "/posts/" . $parent_guid . "#" . $guid;
1469 return "https://" . substr($addr, strpos($addr, "@") + 1) . "/posts/" . $guid;
1473 if ($contact["network"] == NETWORK_DFRN) {
1474 return str_replace("/profile/" . $contact["nick"] . "/", "/display/" . $guid, $contact["url"] . "/");
1477 if (self::isRedmatrix($contact["url"])) {
1478 return $contact["url"] . "/?f=&mid=" . $guid;
1481 if ($parent_guid != '') {
1482 return "https://" . substr($addr, strpos($addr, "@") + 1) . "/posts/" . $parent_guid . "#" . $guid;
1484 return "https://" . substr($addr, strpos($addr, "@") + 1) . "/posts/" . $guid;
1489 * @brief Receives account migration
1491 * @param array $importer Array of the importer user
1492 * @param object $data The message object
1494 * @return bool Success
1496 private static function receiveAccountMigration($importer, $data)
1498 $old_handle = notags(unxmlify($data->author));
1499 $new_handle = notags(unxmlify($data->profile->author));
1500 $signature = notags(unxmlify($data->signature));
1502 $contact = self::contactByHandle($importer["uid"], $old_handle);
1504 logger("cannot find contact for sender: ".$old_handle." and user ".$importer["uid"]);
1508 logger("Got migration for ".$old_handle.", to ".$new_handle." with user ".$importer["uid"]);
1511 $signed_text = 'AccountMigration:'.$old_handle.':'.$new_handle;
1512 $key = self::key($old_handle);
1513 if (!Crypto::rsaVerify($signed_text, $signature, $key, "sha256")) {
1514 logger('No valid signature for migration.');
1518 // Update the profile
1519 self::receiveProfile($importer, $data->profile);
1521 // change the technical stuff in contact and gcontact
1522 $data = Probe::uri($new_handle);
1523 if ($data['network'] == NETWORK_PHANTOM) {
1524 logger('Account for '.$new_handle." couldn't be probed.");
1528 $fields = ['url' => $data['url'], 'nurl' => normalise_link($data['url']),
1529 'name' => $data['name'], 'nick' => $data['nick'],
1530 'addr' => $data['addr'], 'batch' => $data['batch'],
1531 'notify' => $data['notify'], 'poll' => $data['poll'],
1532 'network' => $data['network']];
1534 dba::update('contact', $fields, ['addr' => $old_handle]);
1536 $fields = ['url' => $data['url'], 'nurl' => normalise_link($data['url']),
1537 'name' => $data['name'], 'nick' => $data['nick'],
1538 'addr' => $data['addr'], 'connect' => $data['addr'],
1539 'notify' => $data['notify'], 'photo' => $data['photo'],
1540 'server_url' => $data['baseurl'], 'network' => $data['network']];
1542 dba::update('gcontact', $fields, ['addr' => $old_handle]);
1544 logger('Contacts are updated.');
1550 * @brief Processes an account deletion
1552 * @param object $data The message object
1554 * @return bool Success
1556 private static function receiveAccountDeletion($data)
1558 $author = notags(unxmlify($data->author));
1560 $contacts = dba::select('contact', ['id'], ['addr' => $author]);
1561 while ($contact = dba::fetch($contacts)) {
1562 Contact::remove($contact["id"]);
1565 dba::delete('gcontact', ['addr' => $author]);
1567 logger('Removed contacts for ' . $author);
1573 * @brief Fetch the uri from our database if we already have this item (maybe from ourselves)
1575 * @param string $author Author handle
1576 * @param string $guid Message guid
1577 * @param boolean $onlyfound Only return uri when found in the database
1579 * @return string The constructed uri or the one from our database
1581 private static function getUriFromGuid($author, $guid, $onlyfound = false)
1583 $item = Item::selectFirst(['uri'], ['guid' => $guid]);
1584 if (DBM::is_result($item)) {
1585 return $item["uri"];
1586 } elseif (!$onlyfound) {
1587 $contact = Contact::getDetailsByAddr($author, 0);
1588 if (!empty($contact['network'])) {
1589 $prefix = 'urn:X-' . $contact['network'] . ':';
1591 // This fallback should happen most unlikely
1592 $prefix = 'urn:X-dspr:';
1595 $author_parts = explode('@', $author);
1597 return $prefix . $author_parts[1] . ':' . $author_parts[0] . ':'. $guid;
1604 * @brief Fetch the guid from our database with a given uri
1606 * @param string $uri Message uri
1607 * @param string $uid Author handle
1609 * @return string The post guid
1611 private static function getGuidFromUri($uri, $uid)
1613 $item = Item::selectFirst(['guid'], ['uri' => $uri, 'uid' => $uid]);
1614 if (DBM::is_result($item)) {
1615 return $item["guid"];
1622 * @brief Find the best importer for a comment, like, ...
1624 * @param string $guid The guid of the item
1626 * @return array|boolean the origin owner of that post - or false
1628 private static function importerForGuid($guid)
1630 $item = Item::selectFirst(['uid'], ['origin' => true, 'guid' => $guid]);
1631 if (DBM::is_result($item)) {
1632 logger("Found user ".$item['uid']." as owner of item ".$guid, LOGGER_DEBUG);
1633 $contact = dba::selectFirst('contact', [], ['self' => true, 'uid' => $item['uid']]);
1634 if (DBM::is_result($contact)) {
1642 * @brief Processes an incoming comment
1644 * @param array $importer Array of the importer user
1645 * @param string $sender The sender of the message
1646 * @param object $data The message object
1647 * @param string $xml The original XML of the message
1649 * @return int The message id of the generated comment or "false" if there was an error
1651 private static function receiveComment($importer, $sender, $data, $xml)
1653 $author = notags(unxmlify($data->author));
1654 $guid = notags(unxmlify($data->guid));
1655 $parent_guid = notags(unxmlify($data->parent_guid));
1656 $text = unxmlify($data->text);
1658 if (isset($data->created_at)) {
1659 $created_at = DateTimeFormat::utc(notags(unxmlify($data->created_at)));
1661 $created_at = DateTimeFormat::utcNow();
1664 if (isset($data->thread_parent_guid)) {
1665 $thread_parent_guid = notags(unxmlify($data->thread_parent_guid));
1666 $thr_uri = self::getUriFromGuid("", $thread_parent_guid, true);
1671 $contact = self::allowedContactByHandle($importer, $sender, true);
1676 $message_id = self::messageExists($importer["uid"], $guid);
1681 $parent_item = self::parentItem($importer["uid"], $parent_guid, $author, $contact);
1682 if (!$parent_item) {
1686 $person = self::personByHandle($author);
1687 if (!is_array($person)) {
1688 logger("unable to find author details");
1692 // Fetch the contact id - if we know this contact
1693 $author_contact = self::authorContactByUrl($contact, $person, $importer["uid"]);
1697 $datarray["uid"] = $importer["uid"];
1698 $datarray["contact-id"] = $author_contact["cid"];
1699 $datarray["network"] = $author_contact["network"];
1701 $datarray["author-link"] = $person["url"];
1702 $datarray["author-id"] = Contact::getIdForURL($person["url"], 0);
1704 $datarray["owner-link"] = $contact["url"];
1705 $datarray["owner-id"] = Contact::getIdForURL($contact["url"], 0);
1707 $datarray["guid"] = $guid;
1708 $datarray["uri"] = self::getUriFromGuid($author, $guid);
1710 $datarray["type"] = "remote-comment";
1711 $datarray["verb"] = ACTIVITY_POST;
1712 $datarray["gravity"] = GRAVITY_COMMENT;
1714 if ($thr_uri != "") {
1715 $datarray["parent-uri"] = $thr_uri;
1717 $datarray["parent-uri"] = $parent_item["uri"];
1720 $datarray["object-type"] = ACTIVITY_OBJ_COMMENT;
1722 $datarray["protocol"] = PROTOCOL_DIASPORA;
1723 $datarray["source"] = $xml;
1725 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
1727 $datarray["plink"] = self::plink($author, $guid, $parent_item['guid']);
1729 $body = Markdown::toBBCode($text);
1731 $datarray["body"] = self::replacePeopleGuid($body, $person["url"]);
1733 self::fetchGuid($datarray);
1735 // If we are the origin of the parent we store the original data.
1736 // We notify our followers during the item storage.
1737 if ($parent_item["origin"]) {
1738 $datarray['diaspora_signed_text'] = json_encode($data);
1741 $message_id = Item::insert($datarray);
1743 if ($message_id <= 0) {
1748 logger("Stored comment ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
1749 if ($datarray['uid'] == 0) {
1750 Item::distribute($message_id, json_encode($data));
1758 * @brief processes and stores private messages
1760 * @param array $importer Array of the importer user
1761 * @param array $contact The contact of the message
1762 * @param object $data The message object
1763 * @param array $msg Array of the processed message, author handle and key
1764 * @param object $mesg The private message
1765 * @param array $conversation The conversation record to which this message belongs
1767 * @return bool "true" if it was successful
1769 private static function receiveConversationMessage($importer, $contact, $data, $msg, $mesg, $conversation)
1771 $author = notags(unxmlify($data->author));
1772 $guid = notags(unxmlify($data->guid));
1773 $subject = notags(unxmlify($data->subject));
1775 // "diaspora_handle" is the element name from the old version
1776 // "author" is the element name from the new version
1777 if ($mesg->author) {
1778 $msg_author = notags(unxmlify($mesg->author));
1779 } elseif ($mesg->diaspora_handle) {
1780 $msg_author = notags(unxmlify($mesg->diaspora_handle));
1785 $msg_guid = notags(unxmlify($mesg->guid));
1786 $msg_conversation_guid = notags(unxmlify($mesg->conversation_guid));
1787 $msg_text = unxmlify($mesg->text);
1788 $msg_created_at = DateTimeFormat::utc(notags(unxmlify($mesg->created_at)));
1790 if ($msg_conversation_guid != $guid) {
1791 logger("message conversation guid does not belong to the current conversation.");
1795 $body = Markdown::toBBCode($msg_text);
1796 $message_uri = $msg_author.":".$msg_guid;
1798 $person = self::personByHandle($msg_author);
1803 "SELECT `id` FROM `mail` WHERE `guid` = '%s' AND `uid` = %d LIMIT 1",
1805 intval($importer["uid"])
1807 if (DBM::is_result($r)) {
1808 logger("duplicate message already delivered.", LOGGER_DEBUG);
1813 "INSERT INTO `mail` (`uid`, `guid`, `convid`, `from-name`,`from-photo`,`from-url`,`contact-id`,`title`,`body`,`seen`,`reply`,`uri`,`parent-uri`,`created`)
1814 VALUES (%d, '%s', %d, '%s', '%s', '%s', %d, '%s', '%s', %d, %d, '%s','%s','%s')",
1815 intval($importer["uid"]),
1817 intval($conversation["id"]),
1818 dbesc($person["name"]),
1819 dbesc($person["photo"]),
1820 dbesc($person["url"]),
1821 intval($contact["id"]),
1826 dbesc($message_uri),
1827 dbesc($author.":".$guid),
1828 dbesc($msg_created_at)
1833 dba::update('conv', ['updated' => DateTimeFormat::utcNow()], ['id' => $conversation["id"]]);
1837 "type" => NOTIFY_MAIL,
1838 "notify_flags" => $importer["notify-flags"],
1839 "language" => $importer["language"],
1840 "to_name" => $importer["username"],
1841 "to_email" => $importer["email"],
1842 "uid" =>$importer["uid"],
1843 "item" => ["subject" => $subject, "body" => $body],
1844 "source_name" => $person["name"],
1845 "source_link" => $person["url"],
1846 "source_photo" => $person["thumb"],
1847 "verb" => ACTIVITY_POST,
1854 * @brief Processes new private messages (answers to private messages are processed elsewhere)
1856 * @param array $importer Array of the importer user
1857 * @param array $msg Array of the processed message, author handle and key
1858 * @param object $data The message object
1860 * @return bool Success
1862 private static function receiveConversation($importer, $msg, $data)
1864 $author = notags(unxmlify($data->author));
1865 $guid = notags(unxmlify($data->guid));
1866 $subject = notags(unxmlify($data->subject));
1867 $created_at = DateTimeFormat::utc(notags(unxmlify($data->created_at)));
1868 $participants = notags(unxmlify($data->participants));
1870 $messages = $data->message;
1872 if (!count($messages)) {
1873 logger("empty conversation");
1877 $contact = self::allowedContactByHandle($importer, $msg["author"], true);
1882 $conversation = null;
1885 "SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1886 intval($importer["uid"]),
1890 $conversation = $c[0];
1893 "INSERT INTO `conv` (`uid`, `guid`, `creator`, `created`, `updated`, `subject`, `recips`)
1894 VALUES (%d, '%s', '%s', '%s', '%s', '%s', '%s')",
1895 intval($importer["uid"]),
1899 dbesc(DateTimeFormat::utcNow()),
1901 dbesc($participants)
1905 "SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1906 intval($importer["uid"]),
1912 $conversation = $c[0];
1915 if (!$conversation) {
1916 logger("unable to create conversation.");
1920 foreach ($messages as $mesg) {
1921 self::receiveConversationMessage($importer, $contact, $data, $msg, $mesg, $conversation);
1928 * @brief Processes "like" messages
1930 * @param array $importer Array of the importer user
1931 * @param string $sender The sender of the message
1932 * @param object $data The message object
1934 * @return int The message id of the generated like or "false" if there was an error
1936 private static function receiveLike($importer, $sender, $data)
1938 $author = notags(unxmlify($data->author));
1939 $guid = notags(unxmlify($data->guid));
1940 $parent_guid = notags(unxmlify($data->parent_guid));
1941 $parent_type = notags(unxmlify($data->parent_type));
1942 $positive = notags(unxmlify($data->positive));
1944 // likes on comments aren't supported by Diaspora - only on posts
1945 // But maybe this will be supported in the future, so we will accept it.
1946 if (!in_array($parent_type, ["Post", "Comment"])) {
1950 $contact = self::allowedContactByHandle($importer, $sender, true);
1955 $message_id = self::messageExists($importer["uid"], $guid);
1960 $parent_item = self::parentItem($importer["uid"], $parent_guid, $author, $contact);
1961 if (!$parent_item) {
1965 $person = self::personByHandle($author);
1966 if (!is_array($person)) {
1967 logger("unable to find author details");
1971 // Fetch the contact id - if we know this contact
1972 $author_contact = self::authorContactByUrl($contact, $person, $importer["uid"]);
1974 // "positive" = "false" would be a Dislike - wich isn't currently supported by Diaspora
1975 // We would accept this anyhow.
1976 if ($positive == "true") {
1977 $verb = ACTIVITY_LIKE;
1979 $verb = ACTIVITY_DISLIKE;
1984 $datarray["protocol"] = PROTOCOL_DIASPORA;
1986 $datarray["uid"] = $importer["uid"];
1987 $datarray["contact-id"] = $author_contact["cid"];
1988 $datarray["network"] = $author_contact["network"];
1990 $datarray["author-link"] = $person["url"];
1991 $datarray["author-id"] = Contact::getIdForURL($person["url"], 0);
1993 $datarray["owner-link"] = $contact["url"];
1994 $datarray["owner-id"] = Contact::getIdForURL($contact["url"], 0);
1996 $datarray["guid"] = $guid;
1997 $datarray["uri"] = self::getUriFromGuid($author, $guid);
1999 $datarray["type"] = "activity";
2000 $datarray["verb"] = $verb;
2001 $datarray["gravity"] = GRAVITY_ACTIVITY;
2002 $datarray["parent-uri"] = $parent_item["uri"];
2004 $datarray["object-type"] = ACTIVITY_OBJ_NOTE;
2006 $datarray["body"] = $verb;
2008 // like on comments have the comment as parent. So we need to fetch the toplevel parent
2009 if ($parent_item["id"] != $parent_item["parent"]) {
2010 $toplevel = Item::selectFirst(['origin'], ['id' => $parent_item["parent"]]);
2011 $origin = $toplevel["origin"];
2013 $origin = $parent_item["origin"];
2016 // If we are the origin of the parent we store the original data.
2017 // We notify our followers during the item storage.
2019 $datarray['diaspora_signed_text'] = json_encode($data);
2022 $message_id = Item::insert($datarray);
2024 if ($message_id <= 0) {
2029 logger("Stored like ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
2030 if ($datarray['uid'] == 0) {
2031 Item::distribute($message_id, json_encode($data));
2039 * @brief Processes private messages
2041 * @param array $importer Array of the importer user
2042 * @param object $data The message object
2044 * @return bool Success?
2046 private static function receiveMessage($importer, $data)
2048 $author = notags(unxmlify($data->author));
2049 $guid = notags(unxmlify($data->guid));
2050 $conversation_guid = notags(unxmlify($data->conversation_guid));
2051 $text = unxmlify($data->text);
2052 $created_at = DateTimeFormat::utc(notags(unxmlify($data->created_at)));
2054 $contact = self::allowedContactByHandle($importer, $author, true);
2059 $conversation = null;
2062 "SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
2063 intval($importer["uid"]),
2064 dbesc($conversation_guid)
2067 $conversation = $c[0];
2069 logger("conversation not available.");
2073 $message_uri = $author.":".$guid;
2075 $person = self::personByHandle($author);
2077 logger("unable to find author details");
2081 $body = Markdown::toBBCode($text);
2083 $body = self::replacePeopleGuid($body, $person["url"]);
2088 "SELECT `id` FROM `mail` WHERE `guid` = '%s' AND `uid` = %d LIMIT 1",
2090 intval($importer["uid"])
2092 if (DBM::is_result($r)) {
2093 logger("duplicate message already delivered.", LOGGER_DEBUG);
2098 "INSERT INTO `mail` (`uid`, `guid`, `convid`, `from-name`,`from-photo`,`from-url`,`contact-id`,`title`,`body`,`seen`,`reply`,`uri`,`parent-uri`,`created`)
2099 VALUES ( %d, '%s', %d, '%s', '%s', '%s', %d, '%s', '%s', %d, %d, '%s','%s','%s')",
2100 intval($importer["uid"]),
2102 intval($conversation["id"]),
2103 dbesc($person["name"]),
2104 dbesc($person["photo"]),
2105 dbesc($person["url"]),
2106 intval($contact["id"]),
2107 dbesc($conversation["subject"]),
2111 dbesc($message_uri),
2112 dbesc($author.":".$conversation["guid"]),
2118 dba::update('conv', ['updated' => DateTimeFormat::utcNow()], ['id' => $conversation["id"]]);
2123 * @brief Processes participations - unsupported by now
2125 * @param array $importer Array of the importer user
2126 * @param object $data The message object
2128 * @return bool always true
2130 private static function receiveParticipation($importer, $data)
2132 $author = strtolower(notags(unxmlify($data->author)));
2133 $parent_guid = notags(unxmlify($data->parent_guid));
2135 $contact_id = Contact::getIdForURL($author);
2137 logger('Contact not found: '.$author);
2141 $person = self::personByHandle($author);
2142 if (!is_array($person)) {
2143 logger("Person not found: ".$author);
2147 $item = Item::selectFirst(['id'], ['guid' => $parent_guid, 'origin' => true, 'private' => false]);
2148 if (!DBM::is_result($item)) {
2149 logger('Item not found, no origin or private: '.$parent_guid);
2153 $author_parts = explode('@', $author);
2154 if (isset($author_parts[1])) {
2155 $server = $author_parts[1];
2157 // Should never happen
2161 logger('Received participation for ID: '.$item['id'].' - Contact: '.$contact_id.' - Server: '.$server, LOGGER_DEBUG);
2163 if (!dba::exists('participation', ['iid' => $item['id'], 'server' => $server])) {
2164 dba::insert('participation', ['iid' => $item['id'], 'cid' => $contact_id, 'fid' => $person['id'], 'server' => $server]);
2167 // Send all existing comments and likes to the requesting server
2168 $comments = Item::select(['id', 'parent', 'verb', 'self'], ['parent' => $item['id']]);
2169 while ($comment = Item::fetch($comments)) {
2170 if ($comment['id'] == $comment['parent']) {
2173 if ($comment['verb'] == ACTIVITY_POST) {
2174 $cmd = $comment['self'] ? 'comment-new' : 'comment-import';
2176 $cmd = $comment['self'] ? 'like' : 'comment-import';
2178 logger("Send ".$cmd." for item ".$comment['id']." to contact ".$contact_id, LOGGER_DEBUG);
2179 Worker::add(PRIORITY_HIGH, 'Delivery', $cmd, $comment['id'], $contact_id);
2181 dba::close($comments);
2187 * @brief Processes photos - unneeded
2189 * @param array $importer Array of the importer user
2190 * @param object $data The message object
2192 * @return bool always true
2194 private static function receivePhoto($importer, $data)
2196 // There doesn't seem to be a reason for this function,
2197 // since the photo data is transmitted in the status message as well
2202 * @brief Processes poll participations - unssupported
2204 * @param array $importer Array of the importer user
2205 * @param object $data The message object
2207 * @return bool always true
2209 private static function receivePollParticipation($importer, $data)
2211 // We don't support polls by now
2216 * @brief Processes incoming profile updates
2218 * @param array $importer Array of the importer user
2219 * @param object $data The message object
2221 * @return bool Success
2223 private static function receiveProfile($importer, $data)
2225 $author = strtolower(notags(unxmlify($data->author)));
2227 $contact = self::contactByHandle($importer["uid"], $author);
2232 $name = unxmlify($data->first_name).((strlen($data->last_name)) ? " ".unxmlify($data->last_name) : "");
2233 $image_url = unxmlify($data->image_url);
2234 $birthday = unxmlify($data->birthday);
2235 $gender = unxmlify($data->gender);
2236 $about = Markdown::toBBCode(unxmlify($data->bio));
2237 $location = Markdown::toBBCode(unxmlify($data->location));
2238 $searchable = (unxmlify($data->searchable) == "true");
2239 $nsfw = (unxmlify($data->nsfw) == "true");
2240 $tags = unxmlify($data->tag_string);
2242 $tags = explode("#", $tags);
2245 foreach ($tags as $tag) {
2246 $tag = trim(strtolower($tag));
2252 $keywords = implode(", ", $keywords);
2254 $handle_parts = explode("@", $author);
2255 $nick = $handle_parts[0];
2258 $name = $handle_parts[0];
2261 if (preg_match("|^https?://|", $image_url) === 0) {
2262 $image_url = "http://".$handle_parts[1].$image_url;
2265 Contact::updateAvatar($image_url, $importer["uid"], $contact["id"]);
2267 // Generic birthday. We don't know the timezone. The year is irrelevant.
2269 $birthday = str_replace("1000", "1901", $birthday);
2271 if ($birthday != "") {
2272 $birthday = DateTimeFormat::utc($birthday, "Y-m-d");
2275 // this is to prevent multiple birthday notifications in a single year
2276 // if we already have a stored birthday and the 'm-d' part hasn't changed, preserve the entry, which will preserve the notify year
2278 if (substr($birthday, 5) === substr($contact["bd"], 5)) {
2279 $birthday = $contact["bd"];
2282 $fields = ['name' => $name, 'location' => $location,
2283 'name-date' => DateTimeFormat::utcNow(),
2284 'about' => $about, 'gender' => $gender,
2285 'addr' => $author, 'nick' => $nick,
2286 'keywords' => $keywords];
2288 if (!empty($birthday)) {
2289 $fields['bd'] = $birthday;
2292 dba::update('contact', $fields, ['id' => $contact['id']]);
2294 $gcontact = ["url" => $contact["url"], "network" => NETWORK_DIASPORA, "generation" => 2,
2295 "photo" => $image_url, "name" => $name, "location" => $location,
2296 "about" => $about, "birthday" => $birthday, "gender" => $gender,
2297 "addr" => $author, "nick" => $nick, "keywords" => $keywords,
2298 "hide" => !$searchable, "nsfw" => $nsfw];
2300 $gcid = GContact::update($gcontact);
2302 GContact::link($gcid, $importer["uid"], $contact["id"]);
2304 logger("Profile of contact ".$contact["id"]." stored for user ".$importer["uid"], LOGGER_DEBUG);
2310 * @brief Processes incoming friend requests
2312 * @param array $importer Array of the importer user
2313 * @param array $contact The contact that send the request
2316 private static function receiveRequestMakeFriend($importer, $contact)
2320 if ($contact["rel"] == CONTACT_IS_SHARING) {
2323 ['rel' => CONTACT_IS_FRIEND, 'writable' => true],
2324 ['id' => $contact["id"], 'uid' => $importer["uid"]]
2330 * @brief Processes incoming sharing notification
2332 * @param array $importer Array of the importer user
2333 * @param object $data The message object
2335 * @return bool Success
2337 private static function receiveContactRequest($importer, $data)
2339 $author = unxmlify($data->author);
2340 $recipient = unxmlify($data->recipient);
2342 if (!$author || !$recipient) {
2346 // the current protocol version doesn't know these fields
2347 // That means that we will assume their existance
2348 if (isset($data->following)) {
2349 $following = (unxmlify($data->following) == "true");
2354 if (isset($data->sharing)) {
2355 $sharing = (unxmlify($data->sharing) == "true");
2360 $contact = self::contactByHandle($importer["uid"], $author);
2362 // perhaps we were already sharing with this person. Now they're sharing with us.
2363 // That makes us friends.
2366 logger("Author ".$author." (Contact ".$contact["id"].") wants to follow us.", LOGGER_DEBUG);
2367 self::receiveRequestMakeFriend($importer, $contact);
2369 // refetch the contact array
2370 $contact = self::contactByHandle($importer["uid"], $author);
2372 // If we are now friends, we are sending a share message.
2373 // Normally we needn't to do so, but the first message could have been vanished.
2374 if (in_array($contact["rel"], [CONTACT_IS_FRIEND])) {
2375 $u = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval($importer["uid"]));
2377 logger("Sending share message to author ".$author." - Contact: ".$contact["id"]." - User: ".$importer["uid"], LOGGER_DEBUG);
2378 $ret = self::sendShare($u[0], $contact);
2383 logger("Author ".$author." doesn't want to follow us anymore.", LOGGER_DEBUG);
2384 Contact::removeFollower($importer, $contact);
2389 if (!$following && $sharing && in_array($importer["page-flags"], [PAGE_SOAPBOX, PAGE_NORMAL])) {
2390 logger("Author ".$author." wants to share with us - but doesn't want to listen. Request is ignored.", LOGGER_DEBUG);
2392 } elseif (!$following && !$sharing) {
2393 logger("Author ".$author." doesn't want anything - and we don't know the author. Request is ignored.", LOGGER_DEBUG);
2395 } elseif (!$following && $sharing) {
2396 logger("Author ".$author." wants to share with us.", LOGGER_DEBUG);
2397 } elseif ($following && $sharing) {
2398 logger("Author ".$author." wants to have a bidirectional conection.", LOGGER_DEBUG);
2399 } elseif ($following && !$sharing) {
2400 logger("Author ".$author." wants to listen to us.", LOGGER_DEBUG);
2403 $ret = self::personByHandle($author);
2405 if (!$ret || ($ret["network"] != NETWORK_DIASPORA)) {
2406 logger("Cannot resolve diaspora handle ".$author." for ".$recipient);
2410 $batch = (($ret["batch"]) ? $ret["batch"] : implode("/", array_slice(explode("/", $ret["url"]), 0, 3))."/receive/public");
2413 "INSERT INTO `contact` (`uid`, `network`,`addr`,`created`,`url`,`nurl`,`batch`,`name`,`nick`,`photo`,`pubkey`,`notify`,`poll`,`blocked`,`priority`)
2414 VALUES (%d, '%s', '%s', '%s', '%s','%s','%s','%s','%s','%s','%s','%s','%s',%d,%d)",
2415 intval($importer["uid"]),
2416 dbesc($ret["network"]),
2417 dbesc($ret["addr"]),
2418 DateTimeFormat::utcNow(),
2420 dbesc(normalise_link($ret["url"])),
2422 dbesc($ret["name"]),
2423 dbesc($ret["nick"]),
2424 dbesc($ret["photo"]),
2425 dbesc($ret["pubkey"]),
2426 dbesc($ret["notify"]),
2427 dbesc($ret["poll"]),
2432 // find the contact record we just created
2434 $contact_record = self::contactByHandle($importer["uid"], $author);
2436 if (!$contact_record) {
2437 logger("unable to locate newly created contact record.");
2441 logger("Author ".$author." was added as contact number ".$contact_record["id"].".", LOGGER_DEBUG);
2443 Group::addMember(User::getDefaultGroup($importer['uid'], $ret["network"]), $contact_record['id']);
2445 Contact::updateAvatar($ret["photo"], $importer['uid'], $contact_record["id"], true);
2447 if (in_array($importer["page-flags"], [PAGE_NORMAL, PAGE_PRVGROUP])) {
2448 logger("Sending intra message for author ".$author.".", LOGGER_DEBUG);
2450 $hash = random_string().(string)time(); // Generate a confirm_key
2453 "INSERT INTO `intro` (`uid`, `contact-id`, `blocked`, `knowyou`, `note`, `hash`, `datetime`)
2454 VALUES (%d, %d, %d, %d, '%s', '%s', '%s')",
2455 intval($importer["uid"]),
2456 intval($contact_record["id"]),
2459 dbesc(L10n::t("Sharing notification from Diaspora network")),
2461 dbesc(DateTimeFormat::utcNow())
2464 // automatic friend approval
2466 logger("Does an automatic friend approval for author ".$author.".", LOGGER_DEBUG);
2468 Contact::updateAvatar($contact_record["photo"], $importer["uid"], $contact_record["id"]);
2470 // technically they are sharing with us (CONTACT_IS_SHARING),
2471 // but if our page-type is PAGE_COMMUNITY or PAGE_SOAPBOX
2472 // we are going to change the relationship and make them a follower.
2474 if (($importer["page-flags"] == PAGE_FREELOVE) && $sharing && $following) {
2475 $new_relation = CONTACT_IS_FRIEND;
2476 } elseif (($importer["page-flags"] == PAGE_FREELOVE) && $sharing) {
2477 $new_relation = CONTACT_IS_SHARING;
2479 $new_relation = CONTACT_IS_FOLLOWER;
2483 "UPDATE `contact` SET `rel` = %d,
2491 intval($new_relation),
2492 dbesc(DateTimeFormat::utcNow()),
2493 dbesc(DateTimeFormat::utcNow()),
2494 intval($contact_record["id"])
2497 $u = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval($importer["uid"]));
2499 logger("Sending share message (Relation: ".$new_relation.") to author ".$author." - Contact: ".$contact_record["id"]." - User: ".$importer["uid"], LOGGER_DEBUG);
2500 $ret = self::sendShare($u[0], $contact_record);
2502 // Send the profile data, maybe it weren't transmitted before
2503 self::sendProfile($importer["uid"], [$contact_record]);
2511 * @brief Fetches a message with a given guid
2513 * @param string $guid message guid
2514 * @param string $orig_author handle of the original post
2515 * @param string $author handle of the sharer
2517 * @return array The fetched item
2519 public static function originalItem($guid, $orig_author)
2522 logger('Empty guid. Quitting.');
2526 // Do we already have this item?
2527 $fields = ['body', 'tag', 'app', 'created', 'object-type', 'uri', 'guid',
2528 'author-name', 'author-link', 'author-avatar'];
2529 $condition = ['guid' => $guid, 'visible' => true, 'deleted' => false, 'private' => false];
2530 $item = Item::selectFirst($fields, $condition);
2532 if (DBM::is_result($item)) {
2533 logger("reshared message ".$guid." already exists on system.");
2535 // Maybe it is already a reshared item?
2536 // Then refetch the content, if it is a reshare from a reshare.
2537 // If it is a reshared post from another network then reformat to avoid display problems with two share elements
2538 if (self::isReshare($item["body"], true)) {
2540 } elseif (self::isReshare($item["body"], false) || strstr($item["body"], "[share")) {
2541 $item["body"] = Markdown::toBBCode(BBCode::toMarkdown($item["body"]));
2543 $item["body"] = self::replacePeopleGuid($item["body"], $item["author-link"]);
2545 // Add OEmbed and other information to the body
2546 $item["body"] = add_page_info_to_body($item["body"], false, true);
2554 if (!DBM::is_result($item)) {
2555 if (empty($orig_author)) {
2556 logger('Empty author for guid ' . $guid . '. Quitting.');
2560 $server = "https://".substr($orig_author, strpos($orig_author, "@") + 1);
2561 logger("1st try: reshared message ".$guid." will be fetched via SSL from the server ".$server);
2562 $stored = self::storeByGuid($guid, $server);
2565 $server = "http://".substr($orig_author, strpos($orig_author, "@") + 1);
2566 logger("2nd try: reshared message ".$guid." will be fetched without SSL from the server ".$server);
2567 $stored = self::storeByGuid($guid, $server);
2571 $fields = ['body', 'tag', 'app', 'created', 'object-type', 'uri', 'guid',
2572 'author-name', 'author-link', 'author-avatar'];
2573 $condition = ['guid' => $guid, 'visible' => true, 'deleted' => false, 'private' => false];
2574 $item = Item::selectFirst($fields, $condition);
2576 if (DBM::is_result($item)) {
2577 // If it is a reshared post from another network then reformat to avoid display problems with two share elements
2578 if (self::isReshare($item["body"], false)) {
2579 $item["body"] = Markdown::toBBCode(BBCode::toMarkdown($item["body"]));
2580 $item["body"] = self::replacePeopleGuid($item["body"], $item["author-link"]);
2591 * @brief Processes a reshare message
2593 * @param array $importer Array of the importer user
2594 * @param object $data The message object
2595 * @param string $xml The original XML of the message
2597 * @return int the message id
2599 private static function receiveReshare($importer, $data, $xml)
2601 $author = notags(unxmlify($data->author));
2602 $guid = notags(unxmlify($data->guid));
2603 $created_at = DateTimeFormat::utc(notags(unxmlify($data->created_at)));
2604 $root_author = notags(unxmlify($data->root_author));
2605 $root_guid = notags(unxmlify($data->root_guid));
2606 /// @todo handle unprocessed property "provider_display_name"
2607 $public = notags(unxmlify($data->public));
2609 $contact = self::allowedContactByHandle($importer, $author, false);
2614 $message_id = self::messageExists($importer["uid"], $guid);
2619 $original_item = self::originalItem($root_guid, $root_author);
2620 if (!$original_item) {
2624 $orig_url = System::baseUrl()."/display/".$original_item["guid"];
2628 $datarray["uid"] = $importer["uid"];
2629 $datarray["contact-id"] = $contact["id"];
2630 $datarray["network"] = NETWORK_DIASPORA;
2632 $datarray["author-link"] = $contact["url"];
2633 $datarray["author-id"] = Contact::getIdForURL($contact["url"], 0);
2635 $datarray["owner-link"] = $datarray["author-link"];
2636 $datarray["owner-id"] = $datarray["author-id"];
2638 $datarray["guid"] = $guid;
2639 $datarray["uri"] = $datarray["parent-uri"] = self::getUriFromGuid($author, $guid);
2641 $datarray["verb"] = ACTIVITY_POST;
2642 $datarray["gravity"] = GRAVITY_PARENT;
2644 $datarray["protocol"] = PROTOCOL_DIASPORA;
2645 $datarray["source"] = $xml;
2647 $prefix = share_header(
2648 $original_item["author-name"],
2649 $original_item["author-link"],
2650 $original_item["author-avatar"],
2651 $original_item["guid"],
2652 $original_item["created"],
2655 $datarray["body"] = $prefix.$original_item["body"]."[/share]";
2657 $datarray["tag"] = $original_item["tag"];
2658 $datarray["app"] = $original_item["app"];
2660 $datarray["plink"] = self::plink($author, $guid);
2661 $datarray["private"] = (($public == "false") ? 1 : 0);
2662 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
2664 $datarray["object-type"] = $original_item["object-type"];
2666 self::fetchGuid($datarray);
2667 $message_id = Item::insert($datarray);
2669 self::sendParticipation($contact, $datarray);
2672 logger("Stored reshare ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
2673 if ($datarray['uid'] == 0) {
2674 Item::distribute($message_id);
2683 * @brief Processes retractions
2685 * @param array $importer Array of the importer user
2686 * @param array $contact The contact of the item owner
2687 * @param object $data The message object
2689 * @return bool success
2691 private static function itemRetraction($importer, $contact, $data)
2693 $author = notags(unxmlify($data->author));
2694 $target_guid = notags(unxmlify($data->target_guid));
2695 $target_type = notags(unxmlify($data->target_type));
2697 $person = self::personByHandle($author);
2698 if (!is_array($person)) {
2699 logger("unable to find author detail for ".$author);
2703 if (empty($contact["url"])) {
2704 $contact["url"] = $person["url"];
2707 // Fetch items that are about to be deleted
2708 $fields = ['uid', 'id', 'parent', 'parent-uri', 'author-link', 'file'];
2710 // When we receive a public retraction, we delete every item that we find.
2711 if ($importer['uid'] == 0) {
2712 $condition = ['guid' => $target_guid, 'deleted' => false];
2714 $condition = ['guid' => $target_guid, 'deleted' => false, 'uid' => $importer['uid']];
2717 $r = Item::select($fields, $condition);
2718 if (!DBM::is_result($r)) {
2719 logger("Target guid ".$target_guid." was not found on this system for user ".$importer['uid'].".");
2723 while ($item = Item::fetch($r)) {
2724 if (strstr($item['file'], '[')) {
2725 logger("Target guid " . $target_guid . " for user " . $item['uid'] . " is filed. So it won't be deleted.", LOGGER_DEBUG);
2729 // Fetch the parent item
2730 $parent = Item::selectFirst(['author-link'], ['id' => $item["parent"]]);
2732 // Only delete it if the parent author really fits
2733 if (!link_compare($parent["author-link"], $contact["url"]) && !link_compare($item["author-link"], $contact["url"])) {
2734 logger("Thread author ".$parent["author-link"]." and item author ".$item["author-link"]." don't fit to expected contact ".$contact["url"], LOGGER_DEBUG);
2738 Item::delete(['id' => $item['id']]);
2740 logger("Deleted target ".$target_guid." (".$item["id"].") from user ".$item["uid"]." parent: ".$item["parent"], LOGGER_DEBUG);
2747 * @brief Receives retraction messages
2749 * @param array $importer Array of the importer user
2750 * @param string $sender The sender of the message
2751 * @param object $data The message object
2753 * @return bool Success
2755 private static function receiveRetraction($importer, $sender, $data)
2757 $target_type = notags(unxmlify($data->target_type));
2759 $contact = self::contactByHandle($importer["uid"], $sender);
2760 if (!$contact && (in_array($target_type, ["Contact", "Person"]))) {
2761 logger("cannot find contact for sender: ".$sender." and user ".$importer["uid"]);
2765 logger("Got retraction for ".$target_type.", sender ".$sender." and user ".$importer["uid"], LOGGER_DEBUG);
2767 switch ($target_type) {
2772 case "StatusMessage":
2773 return self::itemRetraction($importer, $contact, $data);
2775 case "PollParticipation":
2777 // Currently unsupported
2781 logger("Unknown target type ".$target_type);
2788 * @brief Receives status messages
2790 * @param array $importer Array of the importer user
2791 * @param object $data The message object
2792 * @param string $xml The original XML of the message
2794 * @return int The message id of the newly created item
2796 private static function receiveStatusMessage($importer, $data, $xml)
2798 $author = notags(unxmlify($data->author));
2799 $guid = notags(unxmlify($data->guid));
2800 $created_at = DateTimeFormat::utc(notags(unxmlify($data->created_at)));
2801 $public = notags(unxmlify($data->public));
2802 $text = unxmlify($data->text);
2803 $provider_display_name = notags(unxmlify($data->provider_display_name));
2805 $contact = self::allowedContactByHandle($importer, $author, false);
2810 $message_id = self::messageExists($importer["uid"], $guid);
2816 if ($data->location) {
2817 foreach ($data->location->children() as $fieldname => $data) {
2818 $address[$fieldname] = notags(unxmlify($data));
2822 $body = Markdown::toBBCode($text);
2826 // Attach embedded pictures to the body
2828 foreach ($data->photo as $photo) {
2829 $body = "[img]".unxmlify($photo->remote_photo_path).
2830 unxmlify($photo->remote_photo_name)."[/img]\n".$body;
2833 $datarray["object-type"] = ACTIVITY_OBJ_IMAGE;
2835 $datarray["object-type"] = ACTIVITY_OBJ_NOTE;
2837 // Add OEmbed and other information to the body
2838 if (!self::isRedmatrix($contact["url"])) {
2839 $body = add_page_info_to_body($body, false, true);
2843 /// @todo enable support for polls
2844 //if ($data->poll) {
2845 // foreach ($data->poll AS $poll)
2850 /// @todo enable support for events
2852 $datarray["uid"] = $importer["uid"];
2853 $datarray["contact-id"] = $contact["id"];
2854 $datarray["network"] = NETWORK_DIASPORA;
2856 $datarray["author-link"] = $contact["url"];
2857 $datarray["author-id"] = Contact::getIdForURL($contact["url"], 0);
2859 $datarray["owner-link"] = $datarray["author-link"];
2860 $datarray["owner-id"] = $datarray["author-id"];
2862 $datarray["guid"] = $guid;
2863 $datarray["uri"] = $datarray["parent-uri"] = self::getUriFromGuid($author, $guid);
2865 $datarray["verb"] = ACTIVITY_POST;
2866 $datarray["gravity"] = GRAVITY_PARENT;
2868 $datarray["protocol"] = PROTOCOL_DIASPORA;
2869 $datarray["source"] = $xml;
2871 $datarray["body"] = self::replacePeopleGuid($body, $contact["url"]);
2873 if ($provider_display_name != "") {
2874 $datarray["app"] = $provider_display_name;
2877 $datarray["plink"] = self::plink($author, $guid);
2878 $datarray["private"] = (($public == "false") ? 1 : 0);
2879 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
2881 if (isset($address["address"])) {
2882 $datarray["location"] = $address["address"];
2885 if (isset($address["lat"]) && isset($address["lng"])) {
2886 $datarray["coord"] = $address["lat"]." ".$address["lng"];
2889 self::fetchGuid($datarray);
2890 $message_id = Item::insert($datarray);
2892 self::sendParticipation($contact, $datarray);
2895 logger("Stored item ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
2896 if ($datarray['uid'] == 0) {
2897 Item::distribute($message_id);
2905 /* ************************************************************************************** *
2906 * Here are all the functions that are needed to transmit data with the Diaspora protocol *
2907 * ************************************************************************************** */
2910 * @brief returnes the handle of a contact
2912 * @param array $contact contact array
2914 * @return string the handle in the format user@domain.tld
2916 private static function myHandle($contact)
2918 if ($contact["addr"] != "") {
2919 return $contact["addr"];
2922 // Normally we should have a filled "addr" field - but in the past this wasn't the case
2923 // So - just in case - we build the the address here.
2924 if ($contact["nickname"] != "") {
2925 $nick = $contact["nickname"];
2927 $nick = $contact["nick"];
2930 return $nick."@".substr(System::baseUrl(), strpos(System::baseUrl(), "://") + 3);
2935 * @brief Creates the data for a private message in the new format
2937 * @param string $msg The message that is to be transmitted
2938 * @param array $user The record of the sender
2939 * @param array $contact Target of the communication
2940 * @param string $prvkey The private key of the sender
2941 * @param string $pubkey The public key of the receiver
2943 * @return string The encrypted data
2945 public static function encodePrivateData($msg, $user, $contact, $prvkey, $pubkey)
2947 logger("Message: ".$msg, LOGGER_DATA);
2949 // without a public key nothing will work
2951 logger("pubkey missing: contact id: ".$contact["id"]);
2955 $aes_key = openssl_random_pseudo_bytes(32);
2956 $b_aes_key = base64_encode($aes_key);
2957 $iv = openssl_random_pseudo_bytes(16);
2958 $b_iv = base64_encode($iv);
2960 $ciphertext = self::aesEncrypt($aes_key, $iv, $msg);
2962 $json = json_encode(["iv" => $b_iv, "key" => $b_aes_key]);
2964 $encrypted_key_bundle = "";
2965 openssl_public_encrypt($json, $encrypted_key_bundle, $pubkey);
2967 $json_object = json_encode(
2968 ["aes_key" => base64_encode($encrypted_key_bundle),
2969 "encrypted_magic_envelope" => base64_encode($ciphertext)]
2972 return $json_object;
2976 * @brief Creates the envelope for the "fetch" endpoint and for the new format
2978 * @param string $msg The message that is to be transmitted
2979 * @param array $user The record of the sender
2981 * @return string The envelope
2983 public static function buildMagicEnvelope($msg, $user)
2985 $b64url_data = base64url_encode($msg);
2986 $data = str_replace(["\n", "\r", " ", "\t"], ["", "", "", ""], $b64url_data);
2988 $key_id = base64url_encode(self::myHandle($user));
2989 $type = "application/xml";
2990 $encoding = "base64url";
2991 $alg = "RSA-SHA256";
2992 $signable_data = $data.".".base64url_encode($type).".".base64url_encode($encoding).".".base64url_encode($alg);
2994 // Fallback if the private key wasn't transmitted in the expected field
2995 if ($user['uprvkey'] == "") {
2996 $user['uprvkey'] = $user['prvkey'];
2999 $signature = Crypto::rsaSign($signable_data, $user["uprvkey"]);
3000 $sig = base64url_encode($signature);
3002 $xmldata = ["me:env" => ["me:data" => $data,
3003 "@attributes" => ["type" => $type],
3004 "me:encoding" => $encoding,
3007 "@attributes2" => ["key_id" => $key_id]]];
3009 $namespaces = ["me" => "http://salmon-protocol.org/ns/magic-env"];
3011 return XML::fromArray($xmldata, $xml, false, $namespaces);
3015 * @brief Create the envelope for a message
3017 * @param string $msg The message that is to be transmitted
3018 * @param array $user The record of the sender
3019 * @param array $contact Target of the communication
3020 * @param string $prvkey The private key of the sender
3021 * @param string $pubkey The public key of the receiver
3022 * @param bool $public Is the message public?
3024 * @return string The message that will be transmitted to other servers
3026 public static function buildMessage($msg, $user, $contact, $prvkey, $pubkey, $public = false)
3028 // The message is put into an envelope with the sender's signature
3029 $envelope = self::buildMagicEnvelope($msg, $user);
3031 // Private messages are put into a second envelope, encrypted with the receivers public key
3033 $envelope = self::encodePrivateData($envelope, $user, $contact, $prvkey, $pubkey);
3040 * @brief Creates a signature for a message
3042 * @param array $owner the array of the owner of the message
3043 * @param array $message The message that is to be signed
3045 * @return string The signature
3047 private static function signature($owner, $message)
3050 unset($sigmsg["author_signature"]);
3051 unset($sigmsg["parent_author_signature"]);
3053 $signed_text = implode(";", $sigmsg);
3055 return base64_encode(Crypto::rsaSign($signed_text, $owner["uprvkey"], "sha256"));
3059 * @brief Transmit a message to a target server
3061 * @param array $owner the array of the item owner
3062 * @param array $contact Target of the communication
3063 * @param string $envelope The message that is to be transmitted
3064 * @param bool $public_batch Is it a public post?
3065 * @param bool $queue_run Is the transmission called from the queue?
3066 * @param string $guid message guid
3068 * @return int Result of the transmission
3070 public static function transmit($owner, $contact, $envelope, $public_batch, $queue_run = false, $guid = "", $no_queue = false)
3074 $enabled = intval(Config::get("system", "diaspora_enabled"));
3079 $logid = random_string(4);
3081 $dest_url = ($public_batch ? $contact["batch"] : $contact["notify"]);
3083 // We always try to use the data from the fcontact table.
3084 // This is important for transmitting data to Friendica servers.
3085 if (!empty($contact['addr'])) {
3086 $fcontact = self::personByHandle($contact['addr']);
3087 if (!empty($fcontact)) {
3088 $dest_url = ($public_batch ? $fcontact["batch"] : $fcontact["notify"]);
3093 logger("no url for contact: ".$contact["id"]." batch mode =".$public_batch);
3097 logger("transmit: ".$logid."-".$guid." ".$dest_url);
3099 if (!$queue_run && Queue::wasDelayed($contact["id"])) {
3102 if (!intval(Config::get("system", "diaspora_test"))) {
3103 $content_type = (($public_batch) ? "application/magic-envelope+xml" : "application/json");
3105 Network::post($dest_url."/", $envelope, ["Content-Type: ".$content_type]);
3106 $return_code = $a->get_curl_code();
3108 logger("test_mode");
3113 logger("transmit: ".$logid."-".$guid." to ".$dest_url." returns: ".$return_code);
3115 if (!$return_code || (($return_code == 503) && (stristr($a->get_curl_headers(), "retry-after")))) {
3116 if (!$no_queue && ($contact['contact-type'] != ACCOUNT_TYPE_RELAY)) {
3117 logger("queue message");
3118 // queue message for redelivery
3119 Queue::add($contact["id"], NETWORK_DIASPORA, $envelope, $public_batch, $guid);
3122 // The message could not be delivered. We mark the contact as "dead"
3123 Contact::markForArchival($contact);
3124 } elseif (($return_code >= 200) && ($return_code <= 299)) {
3125 // We successfully delivered a message, the contact is alive
3126 Contact::unmarkForArchival($contact);
3129 return $return_code ? $return_code : -1;
3134 * @brief Build the post xml
3136 * @param string $type The message type
3137 * @param array $message The message data
3139 * @return string The post XML
3141 public static function buildPostXml($type, $message)
3143 $data = [$type => $message];
3145 return XML::fromArray($data, $xml);
3149 * @brief Builds and transmit messages
3151 * @param array $owner the array of the item owner
3152 * @param array $contact Target of the communication
3153 * @param string $type The message type
3154 * @param array $message The message data
3155 * @param bool $public_batch Is it a public post?
3156 * @param string $guid message guid
3157 * @param bool $spool Should the transmission be spooled or transmitted?
3159 * @return int Result of the transmission
3161 private static function buildAndTransmit($owner, $contact, $type, $message, $public_batch = false, $guid = "", $spool = false)
3163 $msg = self::buildPostXml($type, $message);
3165 logger('message: '.$msg, LOGGER_DATA);
3166 logger('send guid '.$guid, LOGGER_DEBUG);
3168 // Fallback if the private key wasn't transmitted in the expected field
3169 if ($owner['uprvkey'] == "") {
3170 $owner['uprvkey'] = $owner['prvkey'];
3173 $envelope = self::buildMessage($msg, $owner, $contact, $owner['uprvkey'], $contact['pubkey'], $public_batch);
3176 Queue::add($contact['id'], NETWORK_DIASPORA, $envelope, $public_batch, $guid);
3179 $return_code = self::transmit($owner, $contact, $envelope, $public_batch, false, $guid);
3182 logger("guid: ".$guid." result ".$return_code, LOGGER_DEBUG);
3184 return $return_code;
3188 * @brief sends a participation (Used to get all further updates)
3190 * @param array $contact Target of the communication
3191 * @param array $item Item array
3193 * @return int The result of the transmission
3195 private static function sendParticipation($contact, $item)
3197 // Don't send notifications for private postings
3198 if ($item['private']) {
3202 $cachekey = "diaspora:sendParticipation:".$item['guid'];
3204 $result = Cache::get($cachekey);
3205 if (!is_null($result)) {
3209 // Fetch some user id to have a valid handle to transmit the participation.
3210 // In fact it doesn't matter which user sends this - but it is needed by the protocol.
3211 // If the item belongs to a user, we take this user id.
3212 if ($item['uid'] == 0) {
3213 $condition = ['verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false];
3214 $first_user = dba::selectFirst('user', ['uid'], $condition);
3215 $owner = User::getOwnerDataById($first_user['uid']);
3217 $owner = User::getOwnerDataById($item['uid']);
3220 $author = self::myHandle($owner);
3222 $message = ["author" => $author,
3223 "guid" => System::createGUID(32),
3224 "parent_type" => "Post",
3225 "parent_guid" => $item["guid"]];
3227 logger("Send participation for ".$item["guid"]." by ".$author, LOGGER_DEBUG);
3229 // It doesn't matter what we store, we only want to avoid sending repeated notifications for the same item
3230 Cache::set($cachekey, $item["guid"], CACHE_QUARTER_HOUR);
3232 return self::buildAndTransmit($owner, $contact, "participation", $message);
3236 * @brief sends an account migration
3238 * @param array $owner the array of the item owner
3239 * @param array $contact Target of the communication
3240 * @param int $uid User ID
3242 * @return int The result of the transmission
3244 public static function sendAccountMigration($owner, $contact, $uid)
3246 $old_handle = PConfig::get($uid, 'system', 'previous_addr');
3247 $profile = self::createProfileData($uid);
3249 $signed_text = 'AccountMigration:'.$old_handle.':'.$profile['author'];
3250 $signature = base64_encode(Crypto::rsaSign($signed_text, $owner["uprvkey"], "sha256"));
3252 $message = ["author" => $old_handle,
3253 "profile" => $profile,
3254 "signature" => $signature];
3256 logger("Send account migration ".print_r($message, true), LOGGER_DEBUG);
3258 return self::buildAndTransmit($owner, $contact, "account_migration", $message);
3262 * @brief Sends a "share" message
3264 * @param array $owner the array of the item owner
3265 * @param array $contact Target of the communication
3267 * @return int The result of the transmission
3269 public static function sendShare($owner, $contact)
3272 * @todo support the different possible combinations of "following" and "sharing"
3273 * Currently, Diaspora only interprets the "sharing" field
3275 * Before switching this code productive, we have to check all "sendShare" calls if "rel" is set correctly
3279 switch ($contact["rel"]) {
3280 case CONTACT_IS_FRIEND:
3283 case CONTACT_IS_SHARING:
3286 case CONTACT_IS_FOLLOWER:
3292 $message = ["author" => self::myHandle($owner),
3293 "recipient" => $contact["addr"],
3294 "following" => "true",
3295 "sharing" => "true"];
3297 logger("Send share ".print_r($message, true), LOGGER_DEBUG);
3299 return self::buildAndTransmit($owner, $contact, "contact", $message);
3303 * @brief sends an "unshare"
3305 * @param array $owner the array of the item owner
3306 * @param array $contact Target of the communication
3308 * @return int The result of the transmission
3310 public static function sendUnshare($owner, $contact)
3312 $message = ["author" => self::myHandle($owner),
3313 "recipient" => $contact["addr"],
3314 "following" => "false",
3315 "sharing" => "false"];
3317 logger("Send unshare ".print_r($message, true), LOGGER_DEBUG);
3319 return self::buildAndTransmit($owner, $contact, "contact", $message);
3323 * @brief Checks a message body if it is a reshare
3325 * @param string $body The message body that is to be check
3326 * @param bool $complete Should it be a complete check or a simple check?
3328 * @return array|bool Reshare details or "false" if no reshare
3330 public static function isReshare($body, $complete = true)
3332 $body = trim($body);
3334 // Skip if it isn't a pure repeated messages
3335 // Does it start with a share?
3336 if ((strpos($body, "[share") > 0) && $complete) {
3340 // Does it end with a share?
3341 if (strlen($body) > (strrpos($body, "[/share]") + 8)) {
3345 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
3346 // Skip if there is no shared message in there
3347 if ($body == $attributes) {
3351 // If we don't do the complete check we quit here
3354 preg_match("/guid='(.*?)'/ism", $attributes, $matches);
3355 if (!empty($matches[1])) {
3356 $guid = $matches[1];
3359 preg_match('/guid="(.*?)"/ism', $attributes, $matches);
3360 if (!empty($matches[1])) {
3361 $guid = $matches[1];
3364 if (($guid != "") && $complete) {
3365 $condition = ['guid' => $guid, 'network' => [NETWORK_DFRN, NETWORK_DIASPORA]];
3366 $item = Item::selectFirst(['contact-id'], $condition);
3367 if (DBM::is_result($item)) {
3369 $ret["root_handle"] = self::handleFromContact($item["contact-id"]);
3370 $ret["root_guid"] = $guid;
3372 } elseif ($complete) {
3373 // We are resharing something that isn't a DFRN or Diaspora post.
3374 // So we have to return "false" on "$complete" to not trigger a reshare.
3377 } elseif (($guid == "") && $complete) {
3381 $ret["root_guid"] = $guid;
3384 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
3385 if (!empty($matches[1])) {
3386 $profile = $matches[1];
3389 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
3390 if (!empty($matches[1])) {
3391 $profile = $matches[1];
3396 if ($profile != "") {
3397 if (Contact::getIdForURL($profile)) {
3398 $author = Contact::getDetailsByURL($profile);
3399 $ret["root_handle"] = $author['addr'];
3403 if (empty($ret) && !$complete) {
3411 * @brief Create an event array
3413 * @param integer $event_id The id of the event
3415 * @return array with event data
3417 private static function buildEvent($event_id)
3419 $r = q("SELECT `guid`, `uid`, `start`, `finish`, `nofinish`, `summary`, `desc`, `location`, `adjust` FROM `event` WHERE `id` = %d", intval($event_id));
3420 if (!DBM::is_result($r)) {
3428 $r = q("SELECT `timezone` FROM `user` WHERE `uid` = %d", intval($event['uid']));
3429 if (!DBM::is_result($r)) {
3435 $r = q("SELECT `addr`, `nick` FROM `contact` WHERE `uid` = %d AND `self`", intval($event['uid']));
3436 if (!DBM::is_result($r)) {
3442 $eventdata['author'] = self::myHandle($owner);
3444 if ($event['guid']) {
3445 $eventdata['guid'] = $event['guid'];
3448 $mask = DateTimeFormat::ATOM;
3450 /// @todo - establish "all day" events in Friendica
3451 $eventdata["all_day"] = "false";
3453 if (!$event['adjust']) {
3454 $eventdata['timezone'] = $user['timezone'];
3456 if ($eventdata['timezone'] == "") {
3457 $eventdata['timezone'] = 'UTC';
3461 if ($event['start']) {
3462 $eventdata['start'] = DateTimeFormat::convert($event['start'], "UTC", $eventdata['timezone'], $mask);
3464 if ($event['finish'] && !$event['nofinish']) {
3465 $eventdata['end'] = DateTimeFormat::convert($event['finish'], "UTC", $eventdata['timezone'], $mask);
3467 if ($event['summary']) {
3468 $eventdata['summary'] = html_entity_decode(BBCode::toMarkdown($event['summary']));
3470 if ($event['desc']) {
3471 $eventdata['description'] = html_entity_decode(BBCode::toMarkdown($event['desc']));
3473 if ($event['location']) {
3474 $event['location'] = preg_replace("/\[map\](.*?)\[\/map\]/ism", '$1', $event['location']);
3475 $coord = Map::getCoordinates($event['location']);
3478 $location["address"] = html_entity_decode(BBCode::toMarkdown($event['location']));
3479 if (!empty($coord['lat']) && !empty($coord['lon'])) {
3480 $location["lat"] = $coord['lat'];
3481 $location["lng"] = $coord['lon'];
3483 $location["lat"] = 0;
3484 $location["lng"] = 0;
3486 $eventdata['location'] = $location;
3493 * @brief Create a post (status message or reshare)
3495 * @param array $item The item that will be exported
3496 * @param array $owner the array of the item owner
3499 * 'type' -> Message type ("status_message" or "reshare")
3500 * 'message' -> Array of XML elements of the status
3502 public static function buildStatus($item, $owner)
3504 $cachekey = "diaspora:buildStatus:".$item['guid'];
3506 $result = Cache::get($cachekey);
3507 if (!is_null($result)) {
3511 $myaddr = self::myHandle($owner);
3513 $public = (($item["private"]) ? "false" : "true");
3515 $created = DateTimeFormat::utc($item["created"], DateTimeFormat::ATOM);
3517 // Detect a share element and do a reshare
3518 if (!$item['private'] && ($ret = self::isReshare($item["body"]))) {
3519 $message = ["author" => $myaddr,
3520 "guid" => $item["guid"],
3521 "created_at" => $created,
3522 "root_author" => $ret["root_handle"],
3523 "root_guid" => $ret["root_guid"],
3524 "provider_display_name" => $item["app"],
3525 "public" => $public];
3529 $title = $item["title"];
3530 $body = $item["body"];
3532 if ($item['author-link'] != $item['owner-link']) {
3533 require_once 'mod/share.php';
3534 $body = share_header($item['author-name'], $item['author-link'], $item['author-avatar'],
3535 "", $item['created'], $item['plink']) . $body . '[/share]';
3538 // convert to markdown
3539 $body = html_entity_decode(BBCode::toMarkdown($body));
3542 if (strlen($title)) {
3543 $body = "## ".html_entity_decode($title)."\n\n".$body;
3546 if ($item["attach"]) {
3547 $cnt = preg_match_all('/href=\"(.*?)\"(.*?)title=\"(.*?)\"/ism', $item["attach"], $matches, PREG_SET_ORDER);
3549 $body .= "\n".L10n::t("Attachments:")."\n";
3550 foreach ($matches as $mtch) {
3551 $body .= "[".$mtch[3]."](".$mtch[1].")\n";
3558 if ($item["location"] != "")
3559 $location["address"] = $item["location"];
3561 if ($item["coord"] != "") {
3562 $coord = explode(" ", $item["coord"]);
3563 $location["lat"] = $coord[0];
3564 $location["lng"] = $coord[1];
3567 $message = ["author" => $myaddr,
3568 "guid" => $item["guid"],
3569 "created_at" => $created,
3570 "public" => $public,
3572 "provider_display_name" => $item["app"],
3573 "location" => $location];
3575 // Diaspora rejects messages when they contain a location without "lat" or "lng"
3576 if (!isset($location["lat"]) || !isset($location["lng"])) {
3577 unset($message["location"]);
3580 if ($item['event-id'] > 0) {
3581 $event = self::buildEvent($item['event-id']);
3582 if (count($event)) {
3583 $message['event'] = $event;
3585 if (!empty($event['location']['address']) &&
3586 !empty($event['location']['lat']) &&
3587 !empty($event['location']['lng'])) {
3588 $message['location'] = $event['location'];
3591 /// @todo Once Diaspora supports it, we will remove the body and the location hack above
3592 // $message['text'] = '';
3596 $type = "status_message";
3599 $msg = ["type" => $type, "message" => $message];
3601 Cache::set($cachekey, $msg, CACHE_QUARTER_HOUR);
3607 * @brief Sends a post
3609 * @param array $item The item that will be exported
3610 * @param array $owner the array of the item owner
3611 * @param array $contact Target of the communication
3612 * @param bool $public_batch Is it a public post?
3614 * @return int The result of the transmission
3616 public static function sendStatus($item, $owner, $contact, $public_batch = false)
3618 $status = self::buildStatus($item, $owner);
3620 return self::buildAndTransmit($owner, $contact, $status["type"], $status["message"], $public_batch, $item["guid"]);
3624 * @brief Creates a "like" object
3626 * @param array $item The item that will be exported
3627 * @param array $owner the array of the item owner
3629 * @return array The data for a "like"
3631 private static function constructLike($item, $owner)
3633 $parent = Item::selectFirst(['guid', 'uri', 'parent-uri'], ['uri' => $item["thr-parent"]]);
3634 if (!DBM::is_result($parent)) {
3638 $target_type = ($parent["uri"] === $parent["parent-uri"] ? "Post" : "Comment");
3640 if ($item['verb'] === ACTIVITY_LIKE) {
3642 } elseif ($item['verb'] === ACTIVITY_DISLIKE) {
3643 $positive = "false";
3646 return(["author" => self::myHandle($owner),
3647 "guid" => $item["guid"],
3648 "parent_guid" => $parent["guid"],
3649 "parent_type" => $target_type,
3650 "positive" => $positive,
3651 "author_signature" => ""]);
3655 * @brief Creates an "EventParticipation" object
3657 * @param array $item The item that will be exported
3658 * @param array $owner the array of the item owner
3660 * @return array The data for an "EventParticipation"
3662 private static function constructAttend($item, $owner)
3664 $parent = Item::selectFirst(['guid', 'uri', 'parent-uri'], ['uri' => $item["thr-parent"]]);
3665 if (!DBM::is_result($parent)) {
3669 switch ($item['verb']) {
3670 case ACTIVITY_ATTEND:
3671 $attend_answer = 'accepted';
3673 case ACTIVITY_ATTENDNO:
3674 $attend_answer = 'declined';
3676 case ACTIVITY_ATTENDMAYBE:
3677 $attend_answer = 'tentative';
3680 logger('Unknown verb '.$item['verb'].' in item '.$item['guid']);
3684 return(["author" => self::myHandle($owner),
3685 "guid" => $item["guid"],
3686 "parent_guid" => $parent["guid"],
3687 "status" => $attend_answer,
3688 "author_signature" => ""]);
3692 * @brief Creates the object for a comment
3694 * @param array $item The item that will be exported
3695 * @param array $owner the array of the item owner
3697 * @return array The data for a comment
3699 private static function constructComment($item, $owner)
3701 $cachekey = "diaspora:constructComment:".$item['guid'];
3703 $result = Cache::get($cachekey);
3704 if (!is_null($result)) {
3708 $parent = Item::selectFirst(['guid'], ['id' => $item["parent"], 'parent' => $item["parent"]]);
3709 if (!DBM::is_result($parent)) {
3713 $text = html_entity_decode(BBCode::toMarkdown($item["body"]));
3714 $created = DateTimeFormat::utc($item["created"], DateTimeFormat::ATOM);
3716 $comment = ["author" => self::myHandle($owner),
3717 "guid" => $item["guid"],
3718 "created_at" => $created,
3719 "parent_guid" => $parent["guid"],
3721 "author_signature" => ""];
3723 // Send the thread parent guid only if it is a threaded comment
3724 if ($item['thr-parent'] != $item['parent-uri']) {
3725 $comment['thread_parent_guid'] = self::getGuidFromUri($item['thr-parent'], $item['uid']);
3728 Cache::set($cachekey, $comment, CACHE_QUARTER_HOUR);
3734 * @brief Send a like or a comment
3736 * @param array $item The item that will be exported
3737 * @param array $owner the array of the item owner
3738 * @param array $contact Target of the communication
3739 * @param bool $public_batch Is it a public post?
3741 * @return int The result of the transmission
3743 public static function sendFollowup($item, $owner, $contact, $public_batch = false)
3745 if (in_array($item['verb'], [ACTIVITY_ATTEND, ACTIVITY_ATTENDNO, ACTIVITY_ATTENDMAYBE])) {
3746 $message = self::constructAttend($item, $owner);
3747 $type = "event_participation";
3748 } elseif (in_array($item["verb"], [ACTIVITY_LIKE, ACTIVITY_DISLIKE])) {
3749 $message = self::constructLike($item, $owner);
3752 $message = self::constructComment($item, $owner);
3760 $message["author_signature"] = self::signature($owner, $message);
3762 return self::buildAndTransmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
3766 * @brief Creates a message from a signature record entry
3768 * @param array $item The item that will be exported
3769 * @param array $signature The entry of the "sign" record
3771 * @return string The message
3773 private static function messageFromSignature($item, $signature)
3775 // Split the signed text
3776 $signed_parts = explode(";", $signature['signed_text']);
3778 if ($item["deleted"]) {
3779 $message = ["author" => $signature['signer'],
3780 "target_guid" => $signed_parts[0],
3781 "target_type" => $signed_parts[1]];
3782 } elseif (in_array($item["verb"], [ACTIVITY_LIKE, ACTIVITY_DISLIKE])) {
3783 $message = ["author" => $signed_parts[4],
3784 "guid" => $signed_parts[1],
3785 "parent_guid" => $signed_parts[3],
3786 "parent_type" => $signed_parts[2],
3787 "positive" => $signed_parts[0],
3788 "author_signature" => $signature['signature'],
3789 "parent_author_signature" => ""];
3791 // Remove the comment guid
3792 $guid = array_shift($signed_parts);
3794 // Remove the parent guid
3795 $parent_guid = array_shift($signed_parts);
3797 // Remove the handle
3798 $handle = array_pop($signed_parts);
3800 // Glue the parts together
3801 $text = implode(";", $signed_parts);
3803 $message = ["author" => $handle,
3805 "parent_guid" => $parent_guid,
3806 "text" => implode(";", $signed_parts),
3807 "author_signature" => $signature['signature'],
3808 "parent_author_signature" => ""];
3814 * @brief Relays messages (like, comment, retraction) to other servers if we are the thread owner
3816 * @param array $item The item that will be exported
3817 * @param array $owner the array of the item owner
3818 * @param array $contact Target of the communication
3819 * @param bool $public_batch Is it a public post?
3821 * @return int The result of the transmission
3823 public static function sendRelay($item, $owner, $contact, $public_batch = false)
3825 if ($item["deleted"]) {
3826 return self::sendRetraction($item, $owner, $contact, $public_batch, true);
3827 } elseif (in_array($item["verb"], [ACTIVITY_LIKE, ACTIVITY_DISLIKE])) {
3833 logger("Got relayable data ".$type." for item ".$item["guid"]." (".$item["id"].")", LOGGER_DEBUG);
3835 // fetch the original signature
3838 "SELECT `signed_text`, `signature`, `signer` FROM `sign` WHERE `iid` = %d LIMIT 1",
3843 logger("Couldn't fetch signatur for item ".$item["guid"]." (".$item["id"].")", LOGGER_DEBUG);
3849 // Old way - is used by the internal Friendica functions
3850 /// @todo Change all signatur storing functions to the new format
3851 if ($signature['signed_text'] && $signature['signature'] && $signature['signer']) {
3852 $message = self::messageFromSignature($item, $signature);
3854 $msg = json_decode($signature['signed_text'], true);
3857 if (is_array($msg)) {
3858 foreach ($msg as $field => $data) {
3859 if (!$item["deleted"]) {
3860 if ($field == "diaspora_handle") {
3863 if ($field == "target_type") {
3864 $field = "parent_type";
3868 $message[$field] = $data;
3871 logger("Signature text for item ".$item["guid"]." (".$item["id"].") couldn't be extracted: ".$signature['signed_text'], LOGGER_DEBUG);
3875 $message["parent_author_signature"] = self::signature($owner, $message);
3877 logger("Relayed data ".print_r($message, true), LOGGER_DEBUG);
3879 return self::buildAndTransmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
3883 * @brief Sends a retraction (deletion) of a message, like or comment
3885 * @param array $item The item that will be exported
3886 * @param array $owner the array of the item owner
3887 * @param array $contact Target of the communication
3888 * @param bool $public_batch Is it a public post?
3889 * @param bool $relay Is the retraction transmitted from a relay?
3891 * @return int The result of the transmission
3893 public static function sendRetraction($item, $owner, $contact, $public_batch = false, $relay = false)
3895 $itemaddr = self::handleFromContact($item["contact-id"], $item["author-id"]);
3897 $msg_type = "retraction";
3899 if ($item['id'] == $item['parent']) {
3900 $target_type = "Post";
3901 } elseif (in_array($item["verb"], [ACTIVITY_LIKE, ACTIVITY_DISLIKE])) {
3902 $target_type = "Like";
3904 $target_type = "Comment";
3907 $message = ["author" => $itemaddr,
3908 "target_guid" => $item['guid'],
3909 "target_type" => $target_type];
3911 logger("Got message ".print_r($message, true), LOGGER_DEBUG);
3913 return self::buildAndTransmit($owner, $contact, $msg_type, $message, $public_batch, $item["guid"]);
3917 * @brief Sends a mail
3919 * @param array $item The item that will be exported
3920 * @param array $owner The owner
3921 * @param array $contact Target of the communication
3923 * @return int The result of the transmission
3925 public static function sendMail($item, $owner, $contact)
3927 $myaddr = self::myHandle($owner);
3930 "SELECT * FROM `conv` WHERE `id` = %d AND `uid` = %d LIMIT 1",
3931 intval($item["convid"]),
3932 intval($item["uid"])
3935 if (!DBM::is_result($r)) {
3936 logger("conversation not found.");
3942 "author" => $cnv["creator"],
3943 "guid" => $cnv["guid"],
3944 "subject" => $cnv["subject"],
3945 "created_at" => DateTimeFormat::utc($cnv['created'], DateTimeFormat::ATOM),
3946 "participants" => $cnv["recips"]
3949 $body = BBCode::toMarkdown($item["body"]);
3950 $created = DateTimeFormat::utc($item["created"], DateTimeFormat::ATOM);
3953 "author" => $myaddr,
3954 "guid" => $item["guid"],
3955 "conversation_guid" => $cnv["guid"],
3957 "created_at" => $created,
3960 if ($item["reply"]) {
3965 "author" => $cnv["creator"],
3966 "guid" => $cnv["guid"],
3967 "subject" => $cnv["subject"],
3968 "created_at" => DateTimeFormat::utc($cnv['created'], DateTimeFormat::ATOM),
3969 "participants" => $cnv["recips"],
3972 $type = "conversation";
3975 return self::buildAndTransmit($owner, $contact, $type, $message, false, $item["guid"]);
3979 * @brief Split a name into first name and last name
3981 * @param string $name The name
3983 * @return array The array with "first" and "last"
3985 public static function splitName($name) {
3986 $name = trim($name);
3988 // Is the name longer than 64 characters? Then cut the rest of it.
3989 if (strlen($name) > 64) {
3990 if ((strpos($name, ' ') <= 64) && (strpos($name, ' ') !== false)) {
3991 $name = trim(substr($name, 0, strrpos(substr($name, 0, 65), ' ')));
3993 $name = substr($name, 0, 64);
3997 // Take the first word as first name
3998 $first = ((strpos($name, ' ') ? trim(substr($name, 0, strpos($name, ' '))) : $name));
3999 $last = (($first === $name) ? '' : trim(substr($name, strlen($first))));
4000 if ((strlen($first) < 32) && (strlen($last) < 32)) {
4001 return ['first' => $first, 'last' => $last];
4004 // Take the last word as last name
4005 $first = ((strrpos($name, ' ') ? trim(substr($name, 0, strrpos($name, ' '))) : $name));
4006 $last = (($first === $name) ? '' : trim(substr($name, strlen($first))));
4008 if ((strlen($first) < 32) && (strlen($last) < 32)) {
4009 return ['first' => $first, 'last' => $last];
4012 // Take the first 32 characters if there is no space in the first 32 characters
4013 if ((strpos($name, ' ') > 32) || (strpos($name, ' ') === false)) {
4014 $first = substr($name, 0, 32);
4015 $last = substr($name, 32);
4016 return ['first' => $first, 'last' => $last];
4019 $first = trim(substr($name, 0, strrpos(substr($name, 0, 33), ' ')));
4020 $last = (($first === $name) ? '' : trim(substr($name, strlen($first))));
4022 // Check if the last name is longer than 32 characters
4023 if (strlen($last) > 32) {
4024 if (strpos($last, ' ') <= 32) {
4025 $last = trim(substr($last, 0, strrpos(substr($last, 0, 33), ' ')));
4027 $last = substr($last, 0, 32);
4031 return ['first' => $first, 'last' => $last];
4035 * @brief Create profile data
4037 * @param int $uid The user id
4039 * @return array The profile data
4041 private static function createProfileData($uid)
4044 "SELECT `profile`.`uid` AS `profile_uid`, `profile`.* , `user`.*, `user`.`prvkey` AS `uprvkey`, `contact`.`addr`
4046 INNER JOIN `user` ON `profile`.`uid` = `user`.`uid`
4047 INNER JOIN `contact` ON `profile`.`uid` = `contact`.`uid`
4048 WHERE `user`.`uid` = %d AND `profile`.`is-default` AND `contact`.`self` LIMIT 1",
4057 $handle = $profile["addr"];
4059 $split_name = self::splitName($profile['name']);
4060 $first = $split_name['first'];
4061 $last = $split_name['last'];
4063 $large = System::baseUrl().'/photo/custom/300/'.$profile['uid'].'.jpg';
4064 $medium = System::baseUrl().'/photo/custom/100/'.$profile['uid'].'.jpg';
4065 $small = System::baseUrl().'/photo/custom/50/' .$profile['uid'].'.jpg';
4066 $searchable = (($profile['publish'] && $profile['net-publish']) ? 'true' : 'false');
4072 if ($searchable === 'true') {
4075 if ($profile['dob'] && ($profile['dob'] > '0000-00-00')) {
4076 list($year, $month, $day) = sscanf($profile['dob'], '%4d-%2d-%2d');
4080 $dob = DateTimeFormat::utc($year . '-' . $month . '-'. $day, 'Y-m-d');
4083 $about = $profile['about'];
4084 $about = strip_tags(BBCode::convert($about));
4086 $location = Profile::formatLocation($profile);
4088 if ($profile['pub_keywords']) {
4089 $kw = str_replace(',', ' ', $profile['pub_keywords']);
4090 $kw = str_replace(' ', ' ', $kw);
4091 $arr = explode(' ', $profile['pub_keywords']);
4093 for ($x = 0; $x < 5; $x ++) {
4094 if (trim($arr[$x])) {
4095 $tags .= '#'. trim($arr[$x]) .' ';
4100 $tags = trim($tags);
4103 return ["author" => $handle,
4104 "first_name" => $first,
4105 "last_name" => $last,
4106 "image_url" => $large,
4107 "image_url_medium" => $medium,
4108 "image_url_small" => $small,
4110 "gender" => $profile['gender'],
4112 "location" => $location,
4113 "searchable" => $searchable,
4115 "tag_string" => $tags];
4119 * @brief Sends profile data
4121 * @param int $uid The user id
4122 * @param bool $recips optional, default false
4125 public static function sendProfile($uid, $recips = false)
4131 $owner = User::getOwnerDataById($uid);
4138 "SELECT `id`,`name`,`network`,`pubkey`,`notify` FROM `contact` WHERE `network` = '%s'
4139 AND `uid` = %d AND `rel` != %d",
4140 dbesc(NETWORK_DIASPORA),
4142 intval(CONTACT_IS_SHARING)
4150 $message = self::createProfileData($uid);
4152 foreach ($recips as $recip) {
4153 logger("Send updated profile data for user ".$uid." to contact ".$recip["id"], LOGGER_DEBUG);
4154 self::buildAndTransmit($owner, $recip, "profile", $message, false, "", false);
4159 * @brief Stores the signature for likes that are created on our system
4161 * @param array $contact The contact array of the "like"
4162 * @param int $post_id The post id of the "like"
4164 * @return bool Success
4166 public static function storeLikeSignature($contact, $post_id)
4168 // Is the contact the owner? Then fetch the private key
4169 if (!$contact['self'] || ($contact['uid'] == 0)) {
4170 logger("No owner post, so not storing signature", LOGGER_DEBUG);
4174 $r = q("SELECT `prvkey` FROM `user` WHERE `uid` = %d LIMIT 1", intval($contact['uid']));
4175 if (!DBM::is_result($r)) {
4179 $contact["uprvkey"] = $r[0]['prvkey'];
4181 $item = Item::selectFirst([], ['id' => $post_id]);
4182 if (!DBM::is_result($item)) {
4186 if (!in_array($item["verb"], [ACTIVITY_LIKE, ACTIVITY_DISLIKE])) {
4190 $message = self::constructLike($item, $contact);
4191 if ($message === false) {
4195 $message["author_signature"] = self::signature($contact, $message);
4198 * Now store the signature more flexible to dynamically support new fields.
4199 * This will break Diaspora compatibility with Friendica versions prior to 3.5.
4201 dba::insert('sign', ['iid' => $post_id, 'signed_text' => json_encode($message)]);
4203 logger('Stored diaspora like signature');
4208 * @brief Stores the signature for comments that are created on our system
4210 * @param array $item The item array of the comment
4211 * @param array $contact The contact array of the item owner
4212 * @param string $uprvkey The private key of the sender
4213 * @param int $message_id The message id of the comment
4215 * @return bool Success
4217 public static function storeCommentSignature($item, $contact, $uprvkey, $message_id)
4219 if ($uprvkey == "") {
4220 logger('No private key, so not storing comment signature', LOGGER_DEBUG);
4224 $contact["uprvkey"] = $uprvkey;
4226 $message = self::constructComment($item, $contact);
4227 if ($message === false) {
4231 $message["author_signature"] = self::signature($contact, $message);
4234 * Now store the signature more flexible to dynamically support new fields.
4235 * This will break Diaspora compatibility with Friendica versions prior to 3.5.
4237 dba::insert('sign', ['iid' => $message_id, 'signed_text' => json_encode($message)]);
4239 logger('Stored diaspora comment signature');