3 * @file include/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 "valid_posting" and interpret only the new protocol.
12 use Friendica\Core\System;
13 use Friendica\Core\Config;
14 use Friendica\Core\PConfig;
15 use Friendica\Network\Probe;
17 require_once 'include/items.php';
18 require_once 'include/bb2diaspora.php';
19 require_once 'include/probe.php';
20 require_once 'include/Contact.php';
21 require_once 'include/Photo.php';
22 require_once 'include/socgraph.php';
23 require_once 'include/group.php';
24 require_once 'include/xml.php';
25 require_once 'include/datetime.php';
26 require_once 'include/queue_fn.php';
27 require_once 'include/cache.php';
30 * @brief This class contain functions to create and send Diaspora XML files
36 * @brief Return a list of relay servers
38 * This is an experimental Diaspora feature.
40 * @return array of relay servers
42 public static function relay_list() {
44 $serverdata = get_config("system", "relay_server");
45 if ($serverdata == "")
50 $servers = explode(",", $serverdata);
52 foreach ($servers AS $server) {
53 $server = trim($server);
54 $addr = "relay@".str_replace("http://", "", normalise_link($server));
55 $batch = $server."/receive/public";
57 $relais = q("SELECT `batch`, `id`, `name`,`network` FROM `contact` WHERE `uid` = 0 AND `batch` = '%s' AND `addr` = '%s' AND `nurl` = '%s' LIMIT 1",
58 dbesc($batch), dbesc($addr), dbesc(normalise_link($server)));
61 $r = q("INSERT INTO `contact` (`uid`, `created`, `name`, `nick`, `addr`, `url`, `nurl`, `batch`, `network`, `rel`, `blocked`, `pending`, `writable`, `name-date`, `uri-date`, `avatar-date`)
62 VALUES (0, '%s', '%s', 'relay', '%s', '%s', '%s', '%s', '%s', %d, 0, 0, 1, '%s', '%s', '%s')",
67 dbesc(normalise_link($server)),
69 dbesc(NETWORK_DIASPORA),
70 intval(CONTACT_IS_FOLLOWER),
71 dbesc(datetime_convert()),
72 dbesc(datetime_convert()),
73 dbesc(datetime_convert())
76 $relais = q("SELECT `batch`, `id`, `name`,`network` FROM `contact` WHERE `uid` = 0 AND `batch` = '%s' LIMIT 1", dbesc($batch));
78 $relay[] = $relais[0];
80 $relay[] = $relais[0];
87 * @brief repairs a signature that was double encoded
89 * The function is unused at the moment. It was copied from the old implementation.
91 * @param string $signature The signature
92 * @param string $handle The handle of the signature owner
93 * @param integer $level This value is only set inside this function to avoid endless loops
95 * @return string the repaired signature
97 private static function repair_signature($signature, $handle = "", $level = 1) {
102 if (base64_encode(base64_decode(base64_decode($signature))) == base64_decode($signature)) {
103 $signature = base64_decode($signature);
104 logger("Repaired double encoded signature from Diaspora/Hubzilla handle ".$handle." - level ".$level, LOGGER_DEBUG);
106 // Do a recursive call to be able to fix even multiple levels
108 $signature = self::repair_signature($signature, $handle, ++$level);
115 * @brief verify the envelope and return the verified data
117 * @param string $envelope The magic envelope
119 * @return string verified data
121 private static function verify_magic_envelope($envelope) {
123 $basedom = parse_xml_string($envelope);
125 if (!is_object($basedom)) {
126 logger("Envelope is no XML file");
130 $children = $basedom->children('http://salmon-protocol.org/ns/magic-env');
132 if (sizeof($children) == 0) {
133 logger("XML has no children");
139 $data = base64url_decode($children->data);
140 $type = $children->data->attributes()->type[0];
142 $encoding = $children->encoding;
144 $alg = $children->alg;
146 $sig = base64url_decode($children->sig);
147 $key_id = $children->sig->attributes()->key_id[0];
149 $handle = base64url_decode($key_id);
151 $b64url_data = base64url_encode($data);
152 $msg = str_replace(array("\n", "\r", " ", "\t"), array("", "", "", ""), $b64url_data);
154 $signable_data = $msg.".".base64url_encode($type).".".base64url_encode($encoding).".".base64url_encode($alg);
156 $key = self::key($handle);
158 $verify = rsa_verify($signable_data, $sig, $key);
160 logger('Message did not verify. Discarding.');
168 * @brief encrypts data via AES
170 * @param string $key The AES key
171 * @param string $iv The IV (is used for CBC encoding)
172 * @param string $data The data that is to be encrypted
174 * @return string encrypted data
176 private static function aes_encrypt($key, $iv, $data) {
177 return openssl_encrypt($data, 'aes-256-cbc', str_pad($key, 32, "\0"), OPENSSL_RAW_DATA, str_pad($iv, 16, "\0"));
181 * @brief decrypts data via AES
183 * @param string $key The AES key
184 * @param string $iv The IV (is used for CBC encoding)
185 * @param string $encrypted The encrypted data
187 * @return string decrypted data
189 private static function aes_decrypt($key, $iv, $encrypted) {
190 return openssl_decrypt($encrypted,'aes-256-cbc', str_pad($key, 32, "\0"), OPENSSL_RAW_DATA,str_pad($iv, 16, "\0"));
194 * @brief: Decodes incoming Diaspora message in the new format
196 * @param array $importer Array of the importer user
197 * @param string $raw raw post message
200 * 'message' -> decoded Diaspora XML message
201 * 'author' -> author diaspora handle
202 * 'key' -> author public key (converted to pkcs#8)
204 public static function decode_raw($importer, $raw) {
205 $data = json_decode($raw);
207 // Is it a private post? Then decrypt the outer Salmon
208 if (is_object($data)) {
209 $encrypted_aes_key_bundle = base64_decode($data->aes_key);
210 $ciphertext = base64_decode($data->encrypted_magic_envelope);
212 $outer_key_bundle = '';
213 @openssl_private_decrypt($encrypted_aes_key_bundle, $outer_key_bundle, $importer['prvkey']);
214 $j_outer_key_bundle = json_decode($outer_key_bundle);
216 if (!is_object($j_outer_key_bundle)) {
217 logger('Outer Salmon did not verify. Discarding.');
218 http_status_exit(400);
221 $outer_iv = base64_decode($j_outer_key_bundle->iv);
222 $outer_key = base64_decode($j_outer_key_bundle->key);
224 $xml = diaspora::aes_decrypt($outer_key, $outer_iv, $ciphertext);
229 $basedom = parse_xml_string($xml);
231 if (!is_object($basedom)) {
232 logger('Received data does not seem to be an XML. Discarding. '.$xml);
233 http_status_exit(400);
236 $base = $basedom->children(NAMESPACE_SALMON_ME);
238 // Not sure if this cleaning is needed
239 $data = str_replace(array(" ", "\t", "\r", "\n"), array("", "", "", ""), $base->data);
241 // Build the signed data
242 $type = $base->data[0]->attributes()->type[0];
243 $encoding = $base->encoding;
245 $signed_data = $data.'.'.base64url_encode($type).'.'.base64url_encode($encoding).'.'.base64url_encode($alg);
247 // This is the signature
248 $signature = base64url_decode($base->sig);
250 // Get the senders' public key
251 $key_id = $base->sig[0]->attributes()->key_id[0];
252 $author_addr = base64_decode($key_id);
253 $key = diaspora::key($author_addr);
255 $verify = rsa_verify($signed_data, $signature, $key);
257 logger('Message did not verify. Discarding.');
258 http_status_exit(400);
261 return array('message' => (string)base64url_decode($base->data),
262 'author' => unxmlify($author_addr),
263 'key' => (string)$key);
267 * @brief: Decodes incoming Diaspora message in the deprecated format
269 * @param array $importer Array of the importer user
270 * @param string $xml urldecoded Diaspora salmon
273 * 'message' -> decoded Diaspora XML message
274 * 'author' -> author diaspora handle
275 * 'key' -> author public key (converted to pkcs#8)
277 public static function decode($importer, $xml) {
280 $basedom = parse_xml_string($xml);
282 if (!is_object($basedom)) {
283 logger("XML is not parseable.");
286 $children = $basedom->children('https://joindiaspora.com/protocol');
288 if ($children->header) {
290 $author_link = str_replace('acct:','',$children->header->author_id);
292 // This happens with posts from a relais
294 logger("This is no private post in the old format", LOGGER_DEBUG);
298 $encrypted_header = json_decode(base64_decode($children->encrypted_header));
300 $encrypted_aes_key_bundle = base64_decode($encrypted_header->aes_key);
301 $ciphertext = base64_decode($encrypted_header->ciphertext);
303 $outer_key_bundle = '';
304 openssl_private_decrypt($encrypted_aes_key_bundle,$outer_key_bundle,$importer['prvkey']);
306 $j_outer_key_bundle = json_decode($outer_key_bundle);
308 $outer_iv = base64_decode($j_outer_key_bundle->iv);
309 $outer_key = base64_decode($j_outer_key_bundle->key);
311 $decrypted = self::aes_decrypt($outer_key, $outer_iv, $ciphertext);
313 logger('decrypted: '.$decrypted, LOGGER_DEBUG);
314 $idom = parse_xml_string($decrypted);
316 $inner_iv = base64_decode($idom->iv);
317 $inner_aes_key = base64_decode($idom->aes_key);
319 $author_link = str_replace('acct:','',$idom->author_id);
322 $dom = $basedom->children(NAMESPACE_SALMON_ME);
324 // figure out where in the DOM tree our data is hiding
326 if ($dom->provenance->data)
327 $base = $dom->provenance;
328 elseif ($dom->env->data)
334 logger('unable to locate salmon data in xml');
335 http_status_exit(400);
339 // Stash the signature away for now. We have to find their key or it won't be good for anything.
340 $signature = base64url_decode($base->sig);
344 // strip whitespace so our data element will return to one big base64 blob
345 $data = str_replace(array(" ","\t","\r","\n"),array("","","",""),$base->data);
348 // stash away some other stuff for later
350 $type = $base->data[0]->attributes()->type[0];
351 $keyhash = $base->sig[0]->attributes()->keyhash[0];
352 $encoding = $base->encoding;
356 $signed_data = $data.'.'.base64url_encode($type).'.'.base64url_encode($encoding).'.'.base64url_encode($alg);
360 $data = base64url_decode($data);
364 $inner_decrypted = $data;
367 // Decode the encrypted blob
369 $inner_encrypted = base64_decode($data);
370 $inner_decrypted = self::aes_decrypt($inner_aes_key, $inner_iv, $inner_encrypted);
374 logger('Could not retrieve author URI.');
375 http_status_exit(400);
377 // Once we have the author URI, go to the web and try to find their public key
378 // (first this will look it up locally if it is in the fcontact cache)
379 // This will also convert diaspora public key from pkcs#1 to pkcs#8
381 logger('Fetching key for '.$author_link);
382 $key = self::key($author_link);
385 logger('Could not retrieve author key.');
386 http_status_exit(400);
389 $verify = rsa_verify($signed_data,$signature,$key);
392 logger('Message did not verify. Discarding.');
393 http_status_exit(400);
396 logger('Message verified.');
398 return array('message' => (string)$inner_decrypted,
399 'author' => unxmlify($author_link),
400 'key' => (string)$key);
405 * @brief Dispatches public messages and find the fitting receivers
407 * @param array $msg The post that will be dispatched
409 * @return int The message id of the generated message, "true" or "false" if there was an error
411 public static function dispatch_public($msg) {
413 $enabled = intval(get_config("system", "diaspora_enabled"));
415 logger("diaspora is disabled");
419 if (!($postdata = self::valid_posting($msg))) {
420 logger("Invalid posting");
424 $fields = $postdata['fields'];
426 // Is it a an action (comment, like, ...) for our own post?
427 if (isset($fields->parent_guid) && !$postdata["relayed"]) {
428 $guid = notags(unxmlify($fields->parent_guid));
429 $importer = self::importer_for_guid($guid);
430 if (is_array($importer)) {
431 logger("delivering to origin: ".$importer["name"]);
432 $message_id = self::dispatch($importer, $msg, $fields);
437 // Process item retractions. This has to be done separated from the other stuff,
438 // since retractions for comments could come even from non followers.
439 if (!empty($fields) && in_array($fields->getName(), array('retraction'))) {
440 $target = notags(unxmlify($fields->target_type));
441 if (in_array($target, array("Comment", "Like", "Post", "Reshare", "StatusMessage"))) {
442 logger('processing retraction for '.$target, LOGGER_DEBUG);
443 $importer = array("uid" => 0, "page-flags" => PAGE_FREELOVE);
444 $message_id = self::dispatch($importer, $msg, $fields);
449 // Now distribute it to the followers
450 $r = q("SELECT `user`.* FROM `user` WHERE `user`.`uid` IN
451 (SELECT `contact`.`uid` FROM `contact` WHERE `contact`.`network` = '%s' AND `contact`.`addr` = '%s')
452 AND NOT `account_expired` AND NOT `account_removed`",
453 dbesc(NETWORK_DIASPORA),
454 dbesc($msg["author"])
457 if (dbm::is_result($r)) {
458 foreach ($r as $rr) {
459 logger("delivering to: ".$rr["username"]);
460 self::dispatch($rr, $msg, $fields);
462 } elseif (!Config::get('system', 'relay_subscribe', false)) {
463 logger("Unwanted message from ".$msg["author"]." send by ".$_SERVER["REMOTE_ADDR"]." with ".$_SERVER["HTTP_USER_AGENT"].": ".print_r($msg, true), LOGGER_DEBUG);
465 // Use a dummy importer to import the data for the public copy
466 $importer = array("uid" => 0, "page-flags" => PAGE_FREELOVE);
467 $message_id = self::dispatch($importer, $msg, $fields);
474 * @brief Dispatches the different message types to the different functions
476 * @param array $importer Array of the importer user
477 * @param array $msg The post that will be dispatched
478 * @param object $fields SimpleXML object that contains the message
480 * @return int The message id of the generated message, "true" or "false" if there was an error
482 public static function dispatch($importer, $msg, $fields = null) {
484 // The sender is the handle of the contact that sent the message.
485 // This will often be different with relayed messages (for example "like" and "comment")
486 $sender = $msg["author"];
488 // This is only needed for private postings since this is already done for public ones before
489 if (is_null($fields)) {
490 if (!($postdata = self::valid_posting($msg))) {
491 logger("Invalid posting");
494 $fields = $postdata['fields'];
497 $type = $fields->getName();
499 logger("Received message type ".$type." from ".$sender." for user ".$importer["uid"], LOGGER_DEBUG);
502 case "account_migration":
503 return self::receiveAccountMigration($importer, $fields);
505 case "account_deletion":
506 return self::receive_account_deletion($importer, $fields);
509 return self::receive_comment($importer, $sender, $fields, $msg["message"]);
512 return self::receive_contact_request($importer, $fields);
515 return self::receive_conversation($importer, $msg, $fields);
518 return self::receive_like($importer, $sender, $fields);
521 return self::receive_message($importer, $fields);
523 case "participation": // Not implemented
524 return self::receive_participation($importer, $fields);
526 case "photo": // Not implemented
527 return self::receive_photo($importer, $fields);
529 case "poll_participation": // Not implemented
530 return self::receive_poll_participation($importer, $fields);
533 return self::receive_profile($importer, $fields);
536 return self::receive_reshare($importer, $fields, $msg["message"]);
539 return self::receive_retraction($importer, $sender, $fields);
541 case "status_message":
542 return self::receive_status_message($importer, $fields, $msg["message"]);
545 logger("Unknown message type ".$type);
553 * @brief Checks if a posting is valid and fetches the data fields.
555 * This function does not only check the signature.
556 * It also does the conversion between the old and the new diaspora format.
558 * @param array $msg Array with the XML, the sender handle and the sender signature
560 * @return bool|array If the posting is valid then an array with an SimpleXML object is returned
562 private static function valid_posting($msg) {
564 $data = parse_xml_string($msg["message"]);
566 if (!is_object($data)) {
567 logger("No valid XML ".$msg["message"], LOGGER_DEBUG);
571 $first_child = $data->getName();
573 // Is this the new or the old version?
574 if ($data->getName() == "XML") {
576 foreach ($data->post->children() as $child)
583 $type = $element->getName();
586 logger("Got message type ".$type.": ".$msg["message"], LOGGER_DATA);
588 // All retractions are handled identically from now on.
589 // In the new version there will only be "retraction".
590 if (in_array($type, array("signed_retraction", "relayable_retraction")))
591 $type = "retraction";
593 if ($type == "request")
596 $fields = new SimpleXMLElement("<".$type."/>");
600 foreach ($element->children() AS $fieldname => $entry) {
602 // Translation for the old XML structure
603 if ($fieldname == "diaspora_handle") {
604 $fieldname = "author";
606 if ($fieldname == "participant_handles") {
607 $fieldname = "participants";
609 if (in_array($type, array("like", "participation"))) {
610 if ($fieldname == "target_type") {
611 $fieldname = "parent_type";
614 if ($fieldname == "sender_handle") {
615 $fieldname = "author";
617 if ($fieldname == "recipient_handle") {
618 $fieldname = "recipient";
620 if ($fieldname == "root_diaspora_id") {
621 $fieldname = "root_author";
623 if ($type == "status_message") {
624 if ($fieldname == "raw_message") {
628 if ($type == "retraction") {
629 if ($fieldname == "post_guid") {
630 $fieldname = "target_guid";
632 if ($fieldname == "type") {
633 $fieldname = "target_type";
638 if (($fieldname == "author_signature") && ($entry != ""))
639 $author_signature = base64_decode($entry);
640 elseif (($fieldname == "parent_author_signature") && ($entry != ""))
641 $parent_author_signature = base64_decode($entry);
642 elseif (!in_array($fieldname, array("author_signature", "parent_author_signature", "target_author_signature"))) {
643 if ($signed_data != "") {
645 $signed_data_parent .= ";";
648 $signed_data .= $entry;
650 if (!in_array($fieldname, array("parent_author_signature", "target_author_signature")) ||
651 ($orig_type == "relayable_retraction"))
652 xml::copy($entry, $fields, $fieldname);
655 // This is something that shouldn't happen at all.
656 if (in_array($type, array("status_message", "reshare", "profile")))
657 if ($msg["author"] != $fields->author) {
658 logger("Message handle is not the same as envelope sender. Quitting this message.");
662 // Only some message types have signatures. So we quit here for the other types.
663 if (!in_array($type, array("comment", "like"))) {
664 return array("fields" => $fields, "relayed" => false);
666 // No author_signature? This is a must, so we quit.
667 if (!isset($author_signature)) {
668 logger("No author signature for type ".$type." - Message: ".$msg["message"], LOGGER_DEBUG);
672 if (isset($parent_author_signature)) {
675 $key = self::key($msg["author"]);
677 if (!rsa_verify($signed_data, $parent_author_signature, $key, "sha256")) {
678 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);
685 $key = self::key($fields->author);
687 if (!rsa_verify($signed_data, $author_signature, $key, "sha256")) {
688 logger("No valid author signature for author ".$fields->author. " in type ".$type." - signed data: ".$signed_data." - Message: ".$msg["message"]." - Signature ".$author_signature, LOGGER_DEBUG);
691 return array("fields" => $fields, "relayed" => $relayed);
696 * @brief Fetches the public key for a given handle
698 * @param string $handle The handle
700 * @return string The public key
702 private static function key($handle) {
703 $handle = strval($handle);
705 logger("Fetching diaspora key for: ".$handle);
707 $r = self::person_by_handle($handle);
715 * @brief Fetches data for a given handle
717 * @param string $handle The handle
719 * @return array the queried data
721 public static function person_by_handle($handle) {
723 $r = q("SELECT * FROM `fcontact` WHERE `network` = '%s' AND `addr` = '%s' LIMIT 1",
724 dbesc(NETWORK_DIASPORA),
729 logger("In cache ".print_r($r,true), LOGGER_DEBUG);
731 // update record occasionally so it doesn't get stale
732 $d = strtotime($person["updated"]." +00:00");
733 if ($d < strtotime("now - 14 days"))
736 if ($person["guid"] == "")
740 if (!$person || $update) {
741 logger("create or refresh", LOGGER_DEBUG);
742 $r = probe_url($handle, PROBE_DIASPORA);
744 // Note that Friendica contacts will return a "Diaspora person"
745 // if Diaspora connectivity is enabled on their server
746 if ($r && ($r["network"] === NETWORK_DIASPORA)) {
747 self::add_fcontact($r, $update);
755 * @brief Updates the fcontact table
757 * @param array $arr The fcontact data
758 * @param bool $update Update or insert?
760 * @return string The id of the fcontact entry
762 private static function add_fcontact($arr, $update = false) {
765 $r = q("UPDATE `fcontact` SET
779 WHERE `url` = '%s' AND `network` = '%s'",
781 dbesc($arr["photo"]),
782 dbesc($arr["request"]),
784 dbesc(strtolower($arr["addr"])),
786 dbesc($arr["batch"]),
787 dbesc($arr["notify"]),
789 dbesc($arr["confirm"]),
790 dbesc($arr["alias"]),
791 dbesc($arr["pubkey"]),
792 dbesc(datetime_convert()),
794 dbesc($arr["network"])
797 $r = q("INSERT INTO `fcontact` (`url`,`name`,`photo`,`request`,`nick`,`addr`, `guid`,
798 `batch`, `notify`,`poll`,`confirm`,`network`,`alias`,`pubkey`,`updated`)
799 VALUES ('%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s')",
802 dbesc($arr["photo"]),
803 dbesc($arr["request"]),
807 dbesc($arr["batch"]),
808 dbesc($arr["notify"]),
810 dbesc($arr["confirm"]),
811 dbesc($arr["network"]),
812 dbesc($arr["alias"]),
813 dbesc($arr["pubkey"]),
814 dbesc(datetime_convert())
822 * @brief get a handle (user@domain.tld) from a given contact id or gcontact id
824 * @param int $contact_id The id in the contact table
825 * @param int $gcontact_id The id in the gcontact table
827 * @return string the handle
829 public static function handle_from_contact($contact_id, $gcontact_id = 0) {
832 logger("contact id is ".$contact_id." - gcontact id is ".$gcontact_id, LOGGER_DEBUG);
834 if ($gcontact_id != 0) {
835 $r = q("SELECT `addr` FROM `gcontact` WHERE `id` = %d AND `addr` != ''",
836 intval($gcontact_id));
838 if (dbm::is_result($r)) {
839 return strtolower($r[0]["addr"]);
843 $r = q("SELECT `network`, `addr`, `self`, `url`, `nick` FROM `contact` WHERE `id` = %d",
844 intval($contact_id));
846 if (dbm::is_result($r)) {
849 logger("contact 'self' = ".$contact['self']." 'url' = ".$contact['url'], LOGGER_DEBUG);
851 if ($contact['addr'] != "") {
852 $handle = $contact['addr'];
854 $baseurl_start = strpos($contact['url'],'://') + 3;
855 $baseurl_length = strpos($contact['url'],'/profile') - $baseurl_start; // allows installations in a subdirectory--not sure how Diaspora will handle
856 $baseurl = substr($contact['url'], $baseurl_start, $baseurl_length);
857 $handle = $contact['nick'].'@'.$baseurl;
861 return strtolower($handle);
865 * @brief get a url (scheme://domain.tld/u/user) from a given Diaspora*
868 * @param mixed $fcontact_guid Hexadecimal string guid
870 * @return string the contact url or null
872 public static function url_from_contact_guid($fcontact_guid) {
873 logger("fcontact guid is ".$fcontact_guid, LOGGER_DEBUG);
875 $r = q("SELECT `url` FROM `fcontact` WHERE `url` != '' AND `network` = '%s' AND `guid` = '%s'",
876 dbesc(NETWORK_DIASPORA),
877 dbesc($fcontact_guid)
880 if (dbm::is_result($r)) {
888 * @brief Get a contact id for a given handle
890 * @param int $uid The user id
891 * @param string $handle The handle in the format user@domain.tld
893 * @return The contact id
895 private static function contact_by_handle($uid, $handle) {
897 // First do a direct search on the contact table
898 $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `addr` = '%s' LIMIT 1",
903 if (dbm::is_result($r)) {
907 * We haven't found it?
908 * We use another function for it that will possibly create a contact entry.
910 $cid = get_contact($handle, $uid);
913 /// @TODO Contact retrieval should be encapsulated into an "entity" class like `Contact`
914 $r = q("SELECT * FROM `contact` WHERE `id` = %d LIMIT 1", intval($cid));
916 if (dbm::is_result($r)) {
922 $handle_parts = explode("@", $handle);
923 $nurl_sql = "%%://".$handle_parts[1]."%%/profile/".$handle_parts[0];
924 $r = q("SELECT * FROM `contact` WHERE `network` = '%s' AND `uid` = %d AND `nurl` LIKE '%s' LIMIT 1",
929 if (dbm::is_result($r)) {
933 logger("Haven't found contact for user ".$uid." and handle ".$handle, LOGGER_DEBUG);
938 * @brief Check if posting is allowed for this contact
940 * @param array $importer Array of the importer user
941 * @param array $contact The contact that is checked
942 * @param bool $is_comment Is the check for a comment?
944 * @return bool is the contact allowed to post?
946 private static function post_allow($importer, $contact, $is_comment = false) {
949 * Perhaps we were already sharing with this person. Now they're sharing with us.
950 * That makes us friends.
951 * Normally this should have handled by getting a request - but this could get lost
953 if ($contact["rel"] == CONTACT_IS_FOLLOWER && in_array($importer["page-flags"], array(PAGE_FREELOVE))) {
954 dba::update('contact', array('rel' => CONTACT_IS_FRIEND, 'writable' => true),
955 array('id' => $contact["id"], 'uid' => $contact["uid"]));
957 $contact["rel"] = CONTACT_IS_FRIEND;
958 logger("defining user ".$contact["nick"]." as friend");
961 // We don't seem to like that person
962 if ($contact["blocked"] || $contact["readonly"] || $contact["archive"]) {
963 // Maybe blocked, don't accept.
965 // We are following this person?
966 } elseif (($contact["rel"] == CONTACT_IS_SHARING) || ($contact["rel"] == CONTACT_IS_FRIEND)) {
967 // Yes, then it is fine.
969 // Is it a post to a community?
970 } elseif (($contact["rel"] == CONTACT_IS_FOLLOWER) && ($importer["page-flags"] == PAGE_COMMUNITY)) {
973 // Is the message a global user or a comment?
974 } elseif (($importer["uid"] == 0) || $is_comment) {
975 // Messages for the global users and comments are always accepted
983 * @brief Fetches the contact id for a handle and checks if posting is allowed
985 * @param array $importer Array of the importer user
986 * @param string $handle The checked handle in the format user@domain.tld
987 * @param bool $is_comment Is the check for a comment?
989 * @return array The contact data
991 private static function allowed_contact_by_handle($importer, $handle, $is_comment = false) {
992 $contact = self::contact_by_handle($importer["uid"], $handle);
994 logger("A Contact for handle ".$handle." and user ".$importer["uid"]." was not found");
995 // If a contact isn't found, we accept it anyway if it is a comment
1003 if (!self::post_allow($importer, $contact, $is_comment)) {
1004 logger("The handle: ".$handle." is not allowed to post to user ".$importer["uid"]);
1011 * @brief Does the message already exists on the system?
1013 * @param int $uid The user id
1014 * @param string $guid The guid of the message
1016 * @return int|bool message id if the message already was stored into the system - or false.
1018 private static function message_exists($uid, $guid) {
1019 $r = q("SELECT `id` FROM `item` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1024 if (dbm::is_result($r)) {
1025 logger("message ".$guid." already exists for user ".$uid);
1033 * @brief Checks for links to posts in a message
1035 * @param array $item The item array
1037 private static function fetch_guid($item) {
1038 $expression = "=diaspora://.*?/post/([0-9A-Za-z\-_@.:]{15,254}[0-9A-Za-z])=ism";
1039 preg_replace_callback($expression,
1040 function ($match) use ($item) {
1041 return self::fetch_guid_sub($match, $item);
1044 preg_replace_callback("&\[url=/posts/([^\[\]]*)\](.*)\[\/url\]&Usi",
1045 function ($match) use ($item) {
1046 return self::fetch_guid_sub($match, $item);
1051 * @brief Checks for relative /people/* links in an item body to match local
1052 * contacts or prepends the remote host taken from the author link.
1054 * @param string $body The item body to replace links from
1055 * @param string $author_link The author link for missing local contact fallback
1057 * @return the replaced string
1059 public static function replace_people_guid($body, $author_link) {
1060 $return = preg_replace_callback("&\[url=/people/([^\[\]]*)\](.*)\[\/url\]&Usi",
1061 function ($match) use ($author_link) {
1063 // 0 => '[url=/people/0123456789abcdef]Foo Bar[/url]'
1064 // 1 => '0123456789abcdef'
1066 $handle = self::url_from_contact_guid($match[1]);
1069 $return = '@[url='.$handle.']'.$match[2].'[/url]';
1071 // No local match, restoring absolute remote URL from author scheme and host
1072 $author_url = parse_url($author_link);
1073 $return = '[url='.$author_url['scheme'].'://'.$author_url['host'].'/people/'.$match[1].']'.$match[2].'[/url]';
1083 * @brief sub function of "fetch_guid" which checks for links in messages
1085 * @param array $match array containing a link that has to be checked for a message link
1086 * @param array $item The item array
1088 private static function fetch_guid_sub($match, $item) {
1089 if (!self::store_by_guid($match[1], $item["author-link"]))
1090 self::store_by_guid($match[1], $item["owner-link"]);
1094 * @brief Fetches an item with a given guid from a given server
1096 * @param string $guid the message guid
1097 * @param string $server The server address
1098 * @param int $uid The user id of the user
1100 * @return int the message id of the stored message or false
1102 private static function store_by_guid($guid, $server, $uid = 0) {
1103 $serverparts = parse_url($server);
1104 $server = $serverparts["scheme"]."://".$serverparts["host"];
1106 logger("Trying to fetch item ".$guid." from ".$server, LOGGER_DEBUG);
1108 $msg = self::message($guid, $server);
1113 logger("Successfully fetched item ".$guid." from ".$server, LOGGER_DEBUG);
1115 // Now call the dispatcher
1116 return self::dispatch_public($msg);
1120 * @brief Fetches a message from a server
1122 * @param string $guid message guid
1123 * @param string $server The url of the server
1124 * @param int $level Endless loop prevention
1127 * 'message' => The message XML
1128 * 'author' => The author handle
1129 * 'key' => The public key of the author
1131 private static function message($guid, $server, $level = 0) {
1136 // This will work for new Diaspora servers and Friendica servers from 3.5
1137 $source_url = $server."/fetch/post/".urlencode($guid);
1139 logger("Fetch post from ".$source_url, LOGGER_DEBUG);
1141 $envelope = fetch_url($source_url);
1143 logger("Envelope was fetched.", LOGGER_DEBUG);
1144 $x = self::verify_magic_envelope($envelope);
1146 logger("Envelope could not be verified.", LOGGER_DEBUG);
1148 logger("Envelope was verified.", LOGGER_DEBUG);
1152 // This will work for older Diaspora and Friendica servers
1154 $source_url = $server."/p/".urlencode($guid).".xml";
1155 logger("Fetch post from ".$source_url, LOGGER_DEBUG);
1157 $x = fetch_url($source_url);
1162 $source_xml = parse_xml_string($x);
1164 if (!is_object($source_xml))
1167 if ($source_xml->post->reshare) {
1168 // Reshare of a reshare - old Diaspora version
1169 logger("Message is a reshare", LOGGER_DEBUG);
1170 return self::message($source_xml->post->reshare->root_guid, $server, ++$level);
1171 } elseif ($source_xml->getName() == "reshare") {
1172 // Reshare of a reshare - new Diaspora version
1173 logger("Message is a new reshare", LOGGER_DEBUG);
1174 return self::message($source_xml->root_guid, $server, ++$level);
1179 // Fetch the author - for the old and the new Diaspora version
1180 if ($source_xml->post->status_message->diaspora_handle)
1181 $author = (string)$source_xml->post->status_message->diaspora_handle;
1182 elseif ($source_xml->author && ($source_xml->getName() == "status_message"))
1183 $author = (string)$source_xml->author;
1185 // If this isn't a "status_message" then quit
1187 logger("Message doesn't seem to be a status message", LOGGER_DEBUG);
1191 $msg = array("message" => $x, "author" => $author);
1193 $msg["key"] = self::key($msg["author"]);
1199 * @brief Fetches the item record of a given guid
1201 * @param int $uid The user id
1202 * @param string $guid message guid
1203 * @param string $author The handle of the item
1204 * @param array $contact The contact of the item owner
1206 * @return array the item record
1208 private static function parent_item($uid, $guid, $author, $contact) {
1209 $r = q("SELECT `id`, `parent`, `body`, `wall`, `uri`, `guid`, `private`, `origin`,
1210 `author-name`, `author-link`, `author-avatar`,
1211 `owner-name`, `owner-link`, `owner-avatar`
1212 FROM `item` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1213 intval($uid), dbesc($guid));
1216 $result = self::store_by_guid($guid, $contact["url"], $uid);
1219 $person = self::person_by_handle($author);
1220 $result = self::store_by_guid($guid, $person["url"], $uid);
1224 logger("Fetched missing item ".$guid." - result: ".$result, LOGGER_DEBUG);
1226 $r = q("SELECT `id`, `body`, `wall`, `uri`, `private`, `origin`,
1227 `author-name`, `author-link`, `author-avatar`,
1228 `owner-name`, `owner-link`, `owner-avatar`
1229 FROM `item` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1230 intval($uid), dbesc($guid));
1235 logger("parent item not found: parent: ".$guid." - user: ".$uid);
1238 logger("parent item found: parent: ".$guid." - user: ".$uid);
1244 * @brief returns contact details
1246 * @param array $contact The default contact if the person isn't found
1247 * @param array $person The record of the person
1248 * @param int $uid The user id
1251 * 'cid' => contact id
1252 * 'network' => network type
1254 private static function author_contact_by_url($contact, $person, $uid) {
1256 $r = q("SELECT `id`, `network`, `url` FROM `contact` WHERE `nurl` = '%s' AND `uid` = %d LIMIT 1",
1257 dbesc(normalise_link($person["url"])), intval($uid));
1260 $network = $r[0]["network"];
1262 // We are receiving content from a user that possibly is about to be terminated
1263 // This means the user is vital, so we remove a possible termination date.
1264 unmark_for_death($r[0]);
1266 $cid = $contact["id"];
1267 $network = NETWORK_DIASPORA;
1270 return array("cid" => $cid, "network" => $network);
1274 * @brief Is the profile a hubzilla profile?
1276 * @param string $url The profile link
1278 * @return bool is it a hubzilla server?
1280 public static function is_redmatrix($url) {
1281 return(strstr($url, "/channel/"));
1285 * @brief Generate a post link with a given handle and message guid
1287 * @param string $addr The user handle
1288 * @param string $guid message guid
1290 * @return string the post link
1292 private static function plink($addr, $guid, $parent_guid = '') {
1293 $r = q("SELECT `url`, `nick`, `network` FROM `fcontact` WHERE `addr`='%s' LIMIT 1", dbesc($addr));
1296 if (!dbm::is_result($r)) {
1297 if ($parent_guid != '') {
1298 return "https://".substr($addr,strpos($addr,"@") + 1)."/posts/".$parent_guid."#".$guid;
1300 return "https://".substr($addr,strpos($addr,"@") + 1)."/posts/".$guid;
1304 // Friendica contacts are often detected as Diaspora contacts in the "fcontact" table
1305 // So we try another way as well.
1306 $s = q("SELECT `network` FROM `gcontact` WHERE `nurl`='%s' LIMIT 1", dbesc(normalise_link($r[0]["url"])));
1307 if (dbm::is_result($s)) {
1308 $r[0]["network"] = $s[0]["network"];
1311 if ($r[0]["network"] == NETWORK_DFRN) {
1312 return str_replace("/profile/".$r[0]["nick"]."/", "/display/".$guid, $r[0]["url"]."/");
1315 if (self::is_redmatrix($r[0]["url"])) {
1316 return $r[0]["url"]."/?f=&mid=".$guid;
1319 if ($parent_guid != '') {
1320 return "https://".substr($addr,strpos($addr,"@")+1)."/posts/".$parent_guid."#".$guid;
1322 return "https://".substr($addr,strpos($addr,"@")+1)."/posts/".$guid;
1327 * @brief Receives account migration
1329 * @param array $importer Array of the importer user
1330 * @param object $data The message object
1332 * @return bool Success
1334 private static function receiveAccountMigration($importer, $data) {
1335 $old_handle = notags(unxmlify($data->author));
1336 $new_handle = notags(unxmlify($data->profile->author));
1337 $signature = notags(unxmlify($data->signature));
1339 $contact = self::contact_by_handle($importer["uid"], $old_handle);
1341 logger("cannot find contact for sender: ".$old_handle." and user ".$importer["uid"]);
1345 logger("Got migration for ".$old_handle.", to ".$new_handle." with user ".$importer["uid"]);
1348 $signed_text = 'AccountMigration:'.$old_handle.':'.$new_handle;
1349 $key = self::key($old_handle);
1350 if (!rsa_verify($signed_text, $signature, $key, "sha256")) {
1351 logger('No valid signature for migration.');
1355 // Update the profile
1356 self::receive_profile($importer, $data->profile);
1358 // change the technical stuff in contact and gcontact
1359 $data = Probe::uri($new_handle);
1360 if ($data['network'] == NETWORK_PHANTOM) {
1361 logger('Account for '.$new_handle." couldn't be probed.");
1365 $fields = array('url' => $data['url'], 'nurl' => normalise_link($data['url']),
1366 'name' => $data['name'], 'nick' => $data['nick'],
1367 'addr' => $data['addr'], 'batch' => $data['batch'],
1368 'notify' => $data['notify'], 'poll' => $data['poll'],
1369 'network' => $data['network']);
1371 dba::update('contact', $fields, array('addr' => $old_handle));
1373 $fields = array('url' => $data['url'], 'nurl' => normalise_link($data['url']),
1374 'name' => $data['name'], 'nick' => $data['nick'],
1375 'addr' => $data['addr'], 'connect' => $data['addr'],
1376 'notify' => $data['notify'], 'photo' => $data['photo'],
1377 'server_url' => $data['baseurl'], 'network' => $data['network']);
1379 dba::update('gcontact', $fields, array('addr' => $old_handle));
1381 logger('Contacts are updated.');
1384 /// @todo This is an extreme performance killer
1386 'owner-link' => array($contact["url"], $data["url"]),
1387 'author-link' => array($contact["url"], $data["url"]),
1389 foreach ($fields as $n=>$f) {
1390 $r = q("SELECT `id` FROM `item` WHERE `%s` = '%s' AND `uid` = %d LIMIT 1",
1392 intval($importer["uid"]));
1394 if (dbm::is_result($r)) {
1395 $x = q("UPDATE `item` SET `%s` = '%s' WHERE `%s` = '%s' AND `uid` = %d",
1398 intval($importer["uid"]));
1406 logger('Items are updated.');
1412 * @brief Processes an account deletion
1414 * @param array $importer Array of the importer user
1415 * @param object $data The message object
1417 * @return bool Success
1419 private static function receive_account_deletion($importer, $data) {
1421 /// @todo Account deletion should remove the contact from the global contacts as well
1423 $author = notags(unxmlify($data->author));
1425 $contact = self::contact_by_handle($importer["uid"], $author);
1427 logger("cannot find contact for author: ".$author);
1431 // We now remove the contact
1432 contact_remove($contact["id"]);
1437 * @brief Fetch the uri from our database if we already have this item (maybe from ourselves)
1439 * @param string $author Author handle
1440 * @param string $guid Message guid
1441 * @param boolean $onlyfound Only return uri when found in the database
1443 * @return string The constructed uri or the one from our database
1445 private static function get_uri_from_guid($author, $guid, $onlyfound = false) {
1447 $r = q("SELECT `uri` FROM `item` WHERE `guid` = '%s' LIMIT 1", dbesc($guid));
1448 if (dbm::is_result($r)) {
1449 return $r[0]["uri"];
1450 } elseif (!$onlyfound) {
1451 return $author.":".$guid;
1458 * @brief Fetch the guid from our database with a given uri
1460 * @param string $author Author handle
1461 * @param string $uri Message uri
1463 * @return string The post guid
1465 private static function get_guid_from_uri($uri, $uid) {
1467 $r = q("SELECT `guid` FROM `item` WHERE `uri` = '%s' AND `uid` = %d LIMIT 1", dbesc($uri), intval($uid));
1468 if (dbm::is_result($r)) {
1469 return $r[0]["guid"];
1476 * @brief Find the best importer for a comment, like, ...
1478 * @param string $guid The guid of the item
1480 * @return array|boolean the origin owner of that post - or false
1482 private static function importer_for_guid($guid) {
1483 $item = dba::fetch_first("SELECT `uid` FROM `item` WHERE `origin` AND `guid` = ? LIMIT 1", $guid);
1485 if (dbm::is_result($item)) {
1486 logger("Found user ".$item['uid']." as owner of item ".$guid, LOGGER_DEBUG);
1487 $contact = dba::fetch_first("SELECT * FROM `contact` WHERE `self` AND `uid` = ?", $item['uid']);
1488 if (dbm::is_result($contact)) {
1496 * @brief Processes an incoming comment
1498 * @param array $importer Array of the importer user
1499 * @param string $sender The sender of the message
1500 * @param object $data The message object
1501 * @param string $xml The original XML of the message
1503 * @return int The message id of the generated comment or "false" if there was an error
1505 private static function receive_comment($importer, $sender, $data, $xml) {
1506 $author = notags(unxmlify($data->author));
1507 $guid = notags(unxmlify($data->guid));
1508 $parent_guid = notags(unxmlify($data->parent_guid));
1509 $text = unxmlify($data->text);
1511 if (isset($data->created_at)) {
1512 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
1514 $created_at = datetime_convert();
1517 if (isset($data->thread_parent_guid)) {
1518 $thread_parent_guid = notags(unxmlify($data->thread_parent_guid));
1519 $thr_uri = self::get_uri_from_guid("", $thread_parent_guid, true);
1524 $contact = self::allowed_contact_by_handle($importer, $sender, true);
1529 $message_id = self::message_exists($importer["uid"], $guid);
1534 $parent_item = self::parent_item($importer["uid"], $parent_guid, $author, $contact);
1535 if (!$parent_item) {
1539 $person = self::person_by_handle($author);
1540 if (!is_array($person)) {
1541 logger("unable to find author details");
1545 // Fetch the contact id - if we know this contact
1546 $author_contact = self::author_contact_by_url($contact, $person, $importer["uid"]);
1548 $datarray = array();
1550 $datarray["uid"] = $importer["uid"];
1551 $datarray["contact-id"] = $author_contact["cid"];
1552 $datarray["network"] = $author_contact["network"];
1554 $datarray["author-name"] = $person["name"];
1555 $datarray["author-link"] = $person["url"];
1556 $datarray["author-avatar"] = ((x($person,"thumb")) ? $person["thumb"] : $person["photo"]);
1558 $datarray["owner-name"] = $contact["name"];
1559 $datarray["owner-link"] = $contact["url"];
1560 $datarray["owner-avatar"] = ((x($contact,"thumb")) ? $contact["thumb"] : $contact["photo"]);
1562 $datarray["guid"] = $guid;
1563 $datarray["uri"] = self::get_uri_from_guid($author, $guid);
1565 $datarray["type"] = "remote-comment";
1566 $datarray["verb"] = ACTIVITY_POST;
1567 $datarray["gravity"] = GRAVITY_COMMENT;
1569 if ($thr_uri != "") {
1570 $datarray["parent-uri"] = $thr_uri;
1572 $datarray["parent-uri"] = $parent_item["uri"];
1575 $datarray["object-type"] = ACTIVITY_OBJ_COMMENT;
1577 $datarray["protocol"] = PROTOCOL_DIASPORA;
1578 $datarray["source"] = $xml;
1580 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
1582 $datarray["plink"] = self::plink($author, $guid, $parent_item['guid']);
1584 $body = diaspora2bb($text);
1586 $datarray["body"] = self::replace_people_guid($body, $person["url"]);
1588 self::fetch_guid($datarray);
1590 $message_id = item_store($datarray);
1592 if ($message_id <= 0) {
1597 logger("Stored comment ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
1600 // If we are the origin of the parent we store the original data and notify our followers
1601 if ($message_id && $parent_item["origin"]) {
1603 // Formerly we stored the signed text, the signature and the author in different fields.
1604 // We now store the raw data so that we are more flexible.
1605 dba::insert('sign', array('iid' => $message_id, 'signed_text' => json_encode($data)));
1608 proc_run(PRIORITY_HIGH, "include/notifier.php", "comment-import", $message_id);
1615 * @brief processes and stores private messages
1617 * @param array $importer Array of the importer user
1618 * @param array $contact The contact of the message
1619 * @param object $data The message object
1620 * @param array $msg Array of the processed message, author handle and key
1621 * @param object $mesg The private message
1622 * @param array $conversation The conversation record to which this message belongs
1624 * @return bool "true" if it was successful
1626 private static function receive_conversation_message($importer, $contact, $data, $msg, $mesg, $conversation) {
1627 $author = notags(unxmlify($data->author));
1628 $guid = notags(unxmlify($data->guid));
1629 $subject = notags(unxmlify($data->subject));
1631 // "diaspora_handle" is the element name from the old version
1632 // "author" is the element name from the new version
1633 if ($mesg->author) {
1634 $msg_author = notags(unxmlify($mesg->author));
1635 } elseif ($mesg->diaspora_handle) {
1636 $msg_author = notags(unxmlify($mesg->diaspora_handle));
1641 $msg_guid = notags(unxmlify($mesg->guid));
1642 $msg_conversation_guid = notags(unxmlify($mesg->conversation_guid));
1643 $msg_text = unxmlify($mesg->text);
1644 $msg_created_at = datetime_convert("UTC", "UTC", notags(unxmlify($mesg->created_at)));
1646 if ($msg_conversation_guid != $guid) {
1647 logger("message conversation guid does not belong to the current conversation.");
1651 $body = diaspora2bb($msg_text);
1652 $message_uri = $msg_author.":".$msg_guid;
1654 $person = self::person_by_handle($msg_author);
1658 $r = q("SELECT `id` FROM `mail` WHERE `guid` = '%s' AND `uid` = %d LIMIT 1",
1660 intval($importer["uid"])
1662 if (dbm::is_result($r)) {
1663 logger("duplicate message already delivered.", LOGGER_DEBUG);
1667 q("INSERT INTO `mail` (`uid`, `guid`, `convid`, `from-name`,`from-photo`,`from-url`,`contact-id`,`title`,`body`,`seen`,`reply`,`uri`,`parent-uri`,`created`)
1668 VALUES (%d, '%s', %d, '%s', '%s', '%s', %d, '%s', '%s', %d, %d, '%s','%s','%s')",
1669 intval($importer["uid"]),
1671 intval($conversation["id"]),
1672 dbesc($person["name"]),
1673 dbesc($person["photo"]),
1674 dbesc($person["url"]),
1675 intval($contact["id"]),
1680 dbesc($message_uri),
1681 dbesc($author.":".$guid),
1682 dbesc($msg_created_at)
1687 dba::update('conv', array('updated' => datetime_convert()), array('id' => $conversation["id"]));
1690 "type" => NOTIFY_MAIL,
1691 "notify_flags" => $importer["notify-flags"],
1692 "language" => $importer["language"],
1693 "to_name" => $importer["username"],
1694 "to_email" => $importer["email"],
1695 "uid" =>$importer["uid"],
1696 "item" => array("subject" => $subject, "body" => $body),
1697 "source_name" => $person["name"],
1698 "source_link" => $person["url"],
1699 "source_photo" => $person["thumb"],
1700 "verb" => ACTIVITY_POST,
1707 * @brief Processes new private messages (answers to private messages are processed elsewhere)
1709 * @param array $importer Array of the importer user
1710 * @param array $msg Array of the processed message, author handle and key
1711 * @param object $data The message object
1713 * @return bool Success
1715 private static function receive_conversation($importer, $msg, $data) {
1716 $author = notags(unxmlify($data->author));
1717 $guid = notags(unxmlify($data->guid));
1718 $subject = notags(unxmlify($data->subject));
1719 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
1720 $participants = notags(unxmlify($data->participants));
1722 $messages = $data->message;
1724 if (!count($messages)) {
1725 logger("empty conversation");
1729 $contact = self::allowed_contact_by_handle($importer, $msg["author"], true);
1733 $conversation = null;
1735 $c = q("SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1736 intval($importer["uid"]),
1740 $conversation = $c[0];
1742 $r = q("INSERT INTO `conv` (`uid`, `guid`, `creator`, `created`, `updated`, `subject`, `recips`)
1743 VALUES (%d, '%s', '%s', '%s', '%s', '%s', '%s')",
1744 intval($importer["uid"]),
1748 dbesc(datetime_convert()),
1750 dbesc($participants)
1753 $c = q("SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1754 intval($importer["uid"]),
1759 $conversation = $c[0];
1761 if (!$conversation) {
1762 logger("unable to create conversation.");
1766 foreach ($messages as $mesg)
1767 self::receive_conversation_message($importer, $contact, $data, $msg, $mesg, $conversation);
1773 * @brief Creates the body for a "like" message
1775 * @param array $contact The contact that send us the "like"
1776 * @param array $parent_item The item array of the parent item
1777 * @param string $guid message guid
1779 * @return string the body
1781 private static function construct_like_body($contact, $parent_item, $guid) {
1782 $bodyverb = t('%1$s likes %2$s\'s %3$s');
1784 $ulink = "[url=".$contact["url"]."]".$contact["name"]."[/url]";
1785 $alink = "[url=".$parent_item["author-link"]."]".$parent_item["author-name"]."[/url]";
1786 $plink = "[url=".System::baseUrl()."/display/".urlencode($guid)."]".t("status")."[/url]";
1788 return sprintf($bodyverb, $ulink, $alink, $plink);
1792 * @brief Creates a XML object for a "like"
1794 * @param array $importer Array of the importer user
1795 * @param array $parent_item The item array of the parent item
1797 * @return string The XML
1799 private static function construct_like_object($importer, $parent_item) {
1800 $objtype = ACTIVITY_OBJ_NOTE;
1801 $link = '<link rel="alternate" type="text/html" href="'.System::baseUrl()."/display/".$importer["nickname"]."/".$parent_item["id"].'" />';
1802 $parent_body = $parent_item["body"];
1804 $xmldata = array("object" => array("type" => $objtype,
1806 "id" => $parent_item["uri"],
1809 "content" => $parent_body));
1811 return xml::from_array($xmldata, $xml, true);
1815 * @brief Processes "like" messages
1817 * @param array $importer Array of the importer user
1818 * @param string $sender The sender of the message
1819 * @param object $data The message object
1821 * @return int The message id of the generated like or "false" if there was an error
1823 private static function receive_like($importer, $sender, $data) {
1824 $author = notags(unxmlify($data->author));
1825 $guid = notags(unxmlify($data->guid));
1826 $parent_guid = notags(unxmlify($data->parent_guid));
1827 $parent_type = notags(unxmlify($data->parent_type));
1828 $positive = notags(unxmlify($data->positive));
1830 // likes on comments aren't supported by Diaspora - only on posts
1831 // But maybe this will be supported in the future, so we will accept it.
1832 if (!in_array($parent_type, array("Post", "Comment")))
1835 $contact = self::allowed_contact_by_handle($importer, $sender, true);
1839 $message_id = self::message_exists($importer["uid"], $guid);
1843 $parent_item = self::parent_item($importer["uid"], $parent_guid, $author, $contact);
1847 $person = self::person_by_handle($author);
1848 if (!is_array($person)) {
1849 logger("unable to find author details");
1853 // Fetch the contact id - if we know this contact
1854 $author_contact = self::author_contact_by_url($contact, $person, $importer["uid"]);
1856 // "positive" = "false" would be a Dislike - wich isn't currently supported by Diaspora
1857 // We would accept this anyhow.
1858 if ($positive == "true")
1859 $verb = ACTIVITY_LIKE;
1861 $verb = ACTIVITY_DISLIKE;
1863 $datarray = array();
1865 $datarray["protocol"] = PROTOCOL_DIASPORA;
1867 $datarray["uid"] = $importer["uid"];
1868 $datarray["contact-id"] = $author_contact["cid"];
1869 $datarray["network"] = $author_contact["network"];
1871 $datarray["author-name"] = $person["name"];
1872 $datarray["author-link"] = $person["url"];
1873 $datarray["author-avatar"] = ((x($person,"thumb")) ? $person["thumb"] : $person["photo"]);
1875 $datarray["owner-name"] = $contact["name"];
1876 $datarray["owner-link"] = $contact["url"];
1877 $datarray["owner-avatar"] = ((x($contact,"thumb")) ? $contact["thumb"] : $contact["photo"]);
1879 $datarray["guid"] = $guid;
1880 $datarray["uri"] = self::get_uri_from_guid($author, $guid);
1882 $datarray["type"] = "activity";
1883 $datarray["verb"] = $verb;
1884 $datarray["gravity"] = GRAVITY_LIKE;
1885 $datarray["parent-uri"] = $parent_item["uri"];
1887 $datarray["object-type"] = ACTIVITY_OBJ_NOTE;
1888 $datarray["object"] = self::construct_like_object($importer, $parent_item);
1890 $datarray["body"] = self::construct_like_body($contact, $parent_item, $guid);
1892 $message_id = item_store($datarray);
1894 if ($message_id <= 0) {
1899 logger("Stored like ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
1902 // like on comments have the comment as parent. So we need to fetch the toplevel parent
1903 if ($parent_item["id"] != $parent_item["parent"]) {
1904 $toplevel = dba::select('item', array('origin'), array('id' => $parent_item["parent"]), array('limit' => 1));
1905 $origin = $toplevel["origin"];
1907 $origin = $parent_item["origin"];
1910 // If we are the origin of the parent we store the original data and notify our followers
1911 if ($message_id && $origin) {
1913 // Formerly we stored the signed text, the signature and the author in different fields.
1914 // We now store the raw data so that we are more flexible.
1915 dba::insert('sign', array('iid' => $message_id, 'signed_text' => json_encode($data)));
1918 proc_run(PRIORITY_HIGH, "include/notifier.php", "comment-import", $message_id);
1925 * @brief Processes private messages
1927 * @param array $importer Array of the importer user
1928 * @param object $data The message object
1930 * @return bool Success?
1932 private static function receive_message($importer, $data) {
1933 $author = notags(unxmlify($data->author));
1934 $guid = notags(unxmlify($data->guid));
1935 $conversation_guid = notags(unxmlify($data->conversation_guid));
1936 $text = unxmlify($data->text);
1937 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
1939 $contact = self::allowed_contact_by_handle($importer, $author, true);
1944 $conversation = null;
1946 $c = q("SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1947 intval($importer["uid"]),
1948 dbesc($conversation_guid)
1951 $conversation = $c[0];
1953 logger("conversation not available.");
1957 $message_uri = $author.":".$guid;
1959 $person = self::person_by_handle($author);
1961 logger("unable to find author details");
1965 $body = diaspora2bb($text);
1967 $body = self::replace_people_guid($body, $person["url"]);
1971 $r = q("SELECT `id` FROM `mail` WHERE `guid` = '%s' AND `uid` = %d LIMIT 1",
1973 intval($importer["uid"])
1975 if (dbm::is_result($r)) {
1976 logger("duplicate message already delivered.", LOGGER_DEBUG);
1980 q("INSERT INTO `mail` (`uid`, `guid`, `convid`, `from-name`,`from-photo`,`from-url`,`contact-id`,`title`,`body`,`seen`,`reply`,`uri`,`parent-uri`,`created`)
1981 VALUES ( %d, '%s', %d, '%s', '%s', '%s', %d, '%s', '%s', %d, %d, '%s','%s','%s')",
1982 intval($importer["uid"]),
1984 intval($conversation["id"]),
1985 dbesc($person["name"]),
1986 dbesc($person["photo"]),
1987 dbesc($person["url"]),
1988 intval($contact["id"]),
1989 dbesc($conversation["subject"]),
1993 dbesc($message_uri),
1994 dbesc($author.":".$conversation["guid"]),
2000 dba::update('conv', array('updated' => datetime_convert()), array('id' => $conversation["id"]));
2005 * @brief Processes participations - unsupported by now
2007 * @param array $importer Array of the importer user
2008 * @param object $data The message object
2010 * @return bool always true
2012 private static function receive_participation($importer, $data) {
2013 // I'm not sure if we can fully support this message type
2018 * @brief Processes photos - unneeded
2020 * @param array $importer Array of the importer user
2021 * @param object $data The message object
2023 * @return bool always true
2025 private static function receive_photo($importer, $data) {
2026 // There doesn't seem to be a reason for this function, since the photo data is transmitted in the status message as well
2031 * @brief Processes poll participations - unssupported
2033 * @param array $importer Array of the importer user
2034 * @param object $data The message object
2036 * @return bool always true
2038 private static function receive_poll_participation($importer, $data) {
2039 // We don't support polls by now
2044 * @brief Processes incoming profile updates
2046 * @param array $importer Array of the importer user
2047 * @param object $data The message object
2049 * @return bool Success
2051 private static function receive_profile($importer, $data) {
2052 $author = strtolower(notags(unxmlify($data->author)));
2054 $contact = self::contact_by_handle($importer["uid"], $author);
2058 $name = unxmlify($data->first_name).((strlen($data->last_name)) ? " ".unxmlify($data->last_name) : "");
2059 $image_url = unxmlify($data->image_url);
2060 $birthday = unxmlify($data->birthday);
2061 $gender = unxmlify($data->gender);
2062 $about = diaspora2bb(unxmlify($data->bio));
2063 $location = diaspora2bb(unxmlify($data->location));
2064 $searchable = (unxmlify($data->searchable) == "true");
2065 $nsfw = (unxmlify($data->nsfw) == "true");
2066 $tags = unxmlify($data->tag_string);
2068 $tags = explode("#", $tags);
2070 $keywords = array();
2071 foreach ($tags as $tag) {
2072 $tag = trim(strtolower($tag));
2077 $keywords = implode(", ", $keywords);
2079 $handle_parts = explode("@", $author);
2080 $nick = $handle_parts[0];
2083 $name = $handle_parts[0];
2085 if ( preg_match("|^https?://|", $image_url) === 0)
2086 $image_url = "http://".$handle_parts[1].$image_url;
2088 update_contact_avatar($image_url, $importer["uid"], $contact["id"]);
2090 // Generic birthday. We don't know the timezone. The year is irrelevant.
2092 $birthday = str_replace("1000", "1901", $birthday);
2094 if ($birthday != "")
2095 $birthday = datetime_convert("UTC", "UTC", $birthday, "Y-m-d");
2097 // this is to prevent multiple birthday notifications in a single year
2098 // if we already have a stored birthday and the 'm-d' part hasn't changed, preserve the entry, which will preserve the notify year
2100 if (substr($birthday,5) === substr($contact["bd"],5))
2101 $birthday = $contact["bd"];
2103 $r = q("UPDATE `contact` SET `name` = '%s', `nick` = '%s', `addr` = '%s', `name-date` = '%s', `bd` = '%s',
2104 `location` = '%s', `about` = '%s', `keywords` = '%s', `gender` = '%s' WHERE `id` = %d AND `uid` = %d",
2108 dbesc(datetime_convert()),
2114 intval($contact["id"]),
2115 intval($importer["uid"])
2118 $gcontact = array("url" => $contact["url"], "network" => NETWORK_DIASPORA, "generation" => 2,
2119 "photo" => $image_url, "name" => $name, "location" => $location,
2120 "about" => $about, "birthday" => $birthday, "gender" => $gender,
2121 "addr" => $author, "nick" => $nick, "keywords" => $keywords,
2122 "hide" => !$searchable, "nsfw" => $nsfw);
2124 $gcid = update_gcontact($gcontact);
2126 link_gcontact($gcid, $importer["uid"], $contact["id"]);
2128 logger("Profile of contact ".$contact["id"]." stored for user ".$importer["uid"], LOGGER_DEBUG);
2134 * @brief Processes incoming friend requests
2136 * @param array $importer Array of the importer user
2137 * @param array $contact The contact that send the request
2139 private static function receive_request_make_friend($importer, $contact) {
2143 if ($contact["rel"] == CONTACT_IS_SHARING) {
2144 dba::update('contact', array('rel' => CONTACT_IS_FRIEND, 'writable' => true),
2145 array('id' => $contact["id"], 'uid' => $importer["uid"]));
2147 // send notification
2149 $r = q("SELECT `hide-friends` FROM `profile` WHERE `uid` = %d AND `is-default` = 1 LIMIT 1",
2150 intval($importer["uid"])
2153 if ($r && !$r[0]["hide-friends"] && !$contact["hidden"] && intval(get_pconfig($importer["uid"], "system", "post_newfriend"))) {
2155 $self = q("SELECT * FROM `contact` WHERE `self` AND `uid` = %d LIMIT 1",
2156 intval($importer["uid"])
2159 // they are not CONTACT_IS_FOLLOWER anymore but that's what we have in the array
2161 if ($self && $contact["rel"] == CONTACT_IS_FOLLOWER) {
2164 $arr["protocol"] = PROTOCOL_DIASPORA;
2165 $arr["uri"] = $arr["parent-uri"] = item_new_uri($a->get_hostname(), $importer["uid"]);
2166 $arr["uid"] = $importer["uid"];
2167 $arr["contact-id"] = $self[0]["id"];
2169 $arr["type"] = 'wall';
2170 $arr["gravity"] = 0;
2172 $arr["author-name"] = $arr["owner-name"] = $self[0]["name"];
2173 $arr["author-link"] = $arr["owner-link"] = $self[0]["url"];
2174 $arr["author-avatar"] = $arr["owner-avatar"] = $self[0]["thumb"];
2175 $arr["verb"] = ACTIVITY_FRIEND;
2176 $arr["object-type"] = ACTIVITY_OBJ_PERSON;
2178 $A = "[url=".$self[0]["url"]."]".$self[0]["name"]."[/url]";
2179 $B = "[url=".$contact["url"]."]".$contact["name"]."[/url]";
2180 $BPhoto = "[url=".$contact["url"]."][img]".$contact["thumb"]."[/img][/url]";
2181 $arr["body"] = sprintf(t("%1$s is now friends with %2$s"), $A, $B)."\n\n\n".$Bphoto;
2183 $arr["object"] = self::construct_new_friend_object($contact);
2185 $arr["last-child"] = 1;
2187 $arr["allow_cid"] = $user[0]["allow_cid"];
2188 $arr["allow_gid"] = $user[0]["allow_gid"];
2189 $arr["deny_cid"] = $user[0]["deny_cid"];
2190 $arr["deny_gid"] = $user[0]["deny_gid"];
2192 $i = item_store($arr);
2194 proc_run(PRIORITY_HIGH, "include/notifier.php", "activity", $i);
2200 * @brief Creates a XML object for a "new friend" message
2202 * @param array $contact Array of the contact
2204 * @return string The XML
2206 private static function construct_new_friend_object($contact) {
2207 $objtype = ACTIVITY_OBJ_PERSON;
2208 $link = '<link rel="alternate" type="text/html" href="'.$contact["url"].'" />'."\n".
2209 '<link rel="photo" type="image/jpeg" href="'.$contact["thumb"].'" />'."\n";
2211 $xmldata = array("object" => array("type" => $objtype,
2212 "title" => $contact["name"],
2213 "id" => $contact["url"]."/".$contact["name"],
2216 return xml::from_array($xmldata, $xml, true);
2220 * @brief Processes incoming sharing notification
2222 * @param array $importer Array of the importer user
2223 * @param object $data The message object
2225 * @return bool Success
2227 private static function receive_contact_request($importer, $data) {
2228 $author = unxmlify($data->author);
2229 $recipient = unxmlify($data->recipient);
2231 if (!$author || !$recipient) {
2235 // the current protocol version doesn't know these fields
2236 // That means that we will assume their existance
2237 if (isset($data->following)) {
2238 $following = (unxmlify($data->following) == "true");
2243 if (isset($data->sharing)) {
2244 $sharing = (unxmlify($data->sharing) == "true");
2249 $contact = self::contact_by_handle($importer["uid"],$author);
2251 // perhaps we were already sharing with this person. Now they're sharing with us.
2252 // That makes us friends.
2255 logger("Author ".$author." (Contact ".$contact["id"].") wants to follow us.", LOGGER_DEBUG);
2256 self::receive_request_make_friend($importer, $contact);
2258 // refetch the contact array
2259 $contact = self::contact_by_handle($importer["uid"],$author);
2261 // If we are now friends, we are sending a share message.
2262 // Normally we needn't to do so, but the first message could have been vanished.
2263 if (in_array($contact["rel"], array(CONTACT_IS_FRIEND))) {
2264 $u = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval($importer["uid"]));
2266 logger("Sending share message to author ".$author." - Contact: ".$contact["id"]." - User: ".$importer["uid"], LOGGER_DEBUG);
2267 $ret = self::send_share($u[0], $contact);
2272 logger("Author ".$author." doesn't want to follow us anymore.", LOGGER_DEBUG);
2273 lose_follower($importer, $contact);
2278 if (!$following && $sharing && in_array($importer["page-flags"], array(PAGE_SOAPBOX, PAGE_NORMAL))) {
2279 logger("Author ".$author." wants to share with us - but doesn't want to listen. Request is ignored.", LOGGER_DEBUG);
2281 } elseif (!$following && !$sharing) {
2282 logger("Author ".$author." doesn't want anything - and we don't know the author. Request is ignored.", LOGGER_DEBUG);
2284 } elseif (!$following && $sharing) {
2285 logger("Author ".$author." wants to share with us.", LOGGER_DEBUG);
2286 } elseif ($following && $sharing) {
2287 logger("Author ".$author." wants to have a bidirectional conection.", LOGGER_DEBUG);
2288 } elseif ($following && !$sharing) {
2289 logger("Author ".$author." wants to listen to us.", LOGGER_DEBUG);
2292 $ret = self::person_by_handle($author);
2294 if (!$ret || ($ret["network"] != NETWORK_DIASPORA)) {
2295 logger("Cannot resolve diaspora handle ".$author." for ".$recipient);
2299 $batch = (($ret["batch"]) ? $ret["batch"] : implode("/", array_slice(explode("/", $ret["url"]), 0, 3))."/receive/public");
2301 $r = q("INSERT INTO `contact` (`uid`, `network`,`addr`,`created`,`url`,`nurl`,`batch`,`name`,`nick`,`photo`,`pubkey`,`notify`,`poll`,`blocked`,`priority`)
2302 VALUES (%d, '%s', '%s', '%s', '%s','%s','%s','%s','%s','%s','%s','%s','%s',%d,%d)",
2303 intval($importer["uid"]),
2304 dbesc($ret["network"]),
2305 dbesc($ret["addr"]),
2308 dbesc(normalise_link($ret["url"])),
2310 dbesc($ret["name"]),
2311 dbesc($ret["nick"]),
2312 dbesc($ret["photo"]),
2313 dbesc($ret["pubkey"]),
2314 dbesc($ret["notify"]),
2315 dbesc($ret["poll"]),
2320 // find the contact record we just created
2322 $contact_record = self::contact_by_handle($importer["uid"],$author);
2324 if (!$contact_record) {
2325 logger("unable to locate newly created contact record.");
2329 logger("Author ".$author." was added as contact number ".$contact_record["id"].".", LOGGER_DEBUG);
2331 $def_gid = get_default_group($importer['uid'], $ret["network"]);
2333 if (intval($def_gid))
2334 group_add_member($importer["uid"], "", $contact_record["id"], $def_gid);
2336 update_contact_avatar($ret["photo"], $importer['uid'], $contact_record["id"], true);
2338 if ($importer["page-flags"] == PAGE_NORMAL) {
2340 logger("Sending intra message for author ".$author.".", LOGGER_DEBUG);
2342 $hash = random_string().(string)time(); // Generate a confirm_key
2344 $ret = q("INSERT INTO `intro` (`uid`, `contact-id`, `blocked`, `knowyou`, `note`, `hash`, `datetime`)
2345 VALUES (%d, %d, %d, %d, '%s', '%s', '%s')",
2346 intval($importer["uid"]),
2347 intval($contact_record["id"]),
2350 dbesc(t("Sharing notification from Diaspora network")),
2352 dbesc(datetime_convert())
2356 // automatic friend approval
2358 logger("Does an automatic friend approval for author ".$author.".", LOGGER_DEBUG);
2360 update_contact_avatar($contact_record["photo"],$importer["uid"],$contact_record["id"]);
2362 // technically they are sharing with us (CONTACT_IS_SHARING),
2363 // but if our page-type is PAGE_COMMUNITY or PAGE_SOAPBOX
2364 // we are going to change the relationship and make them a follower.
2366 if (($importer["page-flags"] == PAGE_FREELOVE) && $sharing && $following)
2367 $new_relation = CONTACT_IS_FRIEND;
2368 elseif (($importer["page-flags"] == PAGE_FREELOVE) && $sharing)
2369 $new_relation = CONTACT_IS_SHARING;
2371 $new_relation = CONTACT_IS_FOLLOWER;
2373 $r = q("UPDATE `contact` SET `rel` = %d,
2381 intval($new_relation),
2382 dbesc(datetime_convert()),
2383 dbesc(datetime_convert()),
2384 intval($contact_record["id"])
2387 $u = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval($importer["uid"]));
2389 logger("Sending share message (Relation: ".$new_relation.") to author ".$author." - Contact: ".$contact_record["id"]." - User: ".$importer["uid"], LOGGER_DEBUG);
2390 $ret = self::send_share($u[0], $contact_record);
2392 // Send the profile data, maybe it weren't transmitted before
2393 self::send_profile($importer["uid"], array($contact_record));
2401 * @brief Fetches a message with a given guid
2403 * @param string $guid message guid
2404 * @param string $orig_author handle of the original post
2405 * @param string $author handle of the sharer
2407 * @return array The fetched item
2409 private static function original_item($guid, $orig_author, $author) {
2411 // Do we already have this item?
2412 $r = q("SELECT `body`, `tag`, `app`, `created`, `object-type`, `uri`, `guid`,
2413 `author-name`, `author-link`, `author-avatar`
2414 FROM `item` WHERE `guid` = '%s' AND `visible` AND NOT `deleted` AND `body` != '' LIMIT 1",
2417 if (dbm::is_result($r)) {
2418 logger("reshared message ".$guid." already exists on system.");
2420 // Maybe it is already a reshared item?
2421 // Then refetch the content, if it is a reshare from a reshare.
2422 // If it is a reshared post from another network then reformat to avoid display problems with two share elements
2423 if (self::is_reshare($r[0]["body"], true)) {
2425 } elseif (self::is_reshare($r[0]["body"], false) || strstr($r[0]["body"], "[share")) {
2426 $r[0]["body"] = diaspora2bb(bb2diaspora($r[0]["body"]));
2428 $r[0]["body"] = self::replace_people_guid($r[0]["body"], $r[0]["author-link"]);
2430 // Add OEmbed and other information to the body
2431 $r[0]["body"] = add_page_info_to_body($r[0]["body"], false, true);
2439 if (!dbm::is_result($r)) {
2440 $server = "https://".substr($orig_author, strpos($orig_author, "@") + 1);
2441 logger("1st try: reshared message ".$guid." will be fetched via SSL from the server ".$server);
2442 $item_id = self::store_by_guid($guid, $server);
2445 $server = "http://".substr($orig_author, strpos($orig_author, "@") + 1);
2446 logger("2nd try: reshared message ".$guid." will be fetched without SLL from the server ".$server);
2447 $item_id = self::store_by_guid($guid, $server);
2451 $r = q("SELECT `body`, `tag`, `app`, `created`, `object-type`, `uri`, `guid`,
2452 `author-name`, `author-link`, `author-avatar`
2453 FROM `item` WHERE `id` = %d AND `visible` AND NOT `deleted` AND `body` != '' LIMIT 1",
2456 if (dbm::is_result($r)) {
2457 // If it is a reshared post from another network then reformat to avoid display problems with two share elements
2458 if (self::is_reshare($r[0]["body"], false)) {
2459 $r[0]["body"] = diaspora2bb(bb2diaspora($r[0]["body"]));
2460 $r[0]["body"] = self::replace_people_guid($r[0]["body"], $r[0]["author-link"]);
2472 * @brief Processes a reshare message
2474 * @param array $importer Array of the importer user
2475 * @param object $data The message object
2476 * @param string $xml The original XML of the message
2478 * @return int the message id
2480 private static function receive_reshare($importer, $data, $xml) {
2481 $author = notags(unxmlify($data->author));
2482 $guid = notags(unxmlify($data->guid));
2483 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
2484 $root_author = notags(unxmlify($data->root_author));
2485 $root_guid = notags(unxmlify($data->root_guid));
2486 /// @todo handle unprocessed property "provider_display_name"
2487 $public = notags(unxmlify($data->public));
2489 $contact = self::allowed_contact_by_handle($importer, $author, false);
2494 $message_id = self::message_exists($importer["uid"], $guid);
2499 $original_item = self::original_item($root_guid, $root_author, $author);
2500 if (!$original_item) {
2504 $orig_url = System::baseUrl()."/display/".$original_item["guid"];
2506 $datarray = array();
2508 $datarray["uid"] = $importer["uid"];
2509 $datarray["contact-id"] = $contact["id"];
2510 $datarray["network"] = NETWORK_DIASPORA;
2512 $datarray["author-name"] = $contact["name"];
2513 $datarray["author-link"] = $contact["url"];
2514 $datarray["author-avatar"] = ((x($contact,"thumb")) ? $contact["thumb"] : $contact["photo"]);
2516 $datarray["owner-name"] = $datarray["author-name"];
2517 $datarray["owner-link"] = $datarray["author-link"];
2518 $datarray["owner-avatar"] = $datarray["author-avatar"];
2520 $datarray["guid"] = $guid;
2521 $datarray["uri"] = $datarray["parent-uri"] = self::get_uri_from_guid($author, $guid);
2523 $datarray["verb"] = ACTIVITY_POST;
2524 $datarray["gravity"] = GRAVITY_PARENT;
2526 $datarray["protocol"] = PROTOCOL_DIASPORA;
2527 $datarray["source"] = $xml;
2529 $prefix = share_header($original_item["author-name"], $original_item["author-link"], $original_item["author-avatar"],
2530 $original_item["guid"], $original_item["created"], $orig_url);
2531 $datarray["body"] = $prefix.$original_item["body"]."[/share]";
2533 $datarray["tag"] = $original_item["tag"];
2534 $datarray["app"] = $original_item["app"];
2536 $datarray["plink"] = self::plink($author, $guid);
2537 $datarray["private"] = (($public == "false") ? 1 : 0);
2538 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
2540 $datarray["object-type"] = $original_item["object-type"];
2542 self::fetch_guid($datarray);
2543 $message_id = item_store($datarray);
2546 logger("Stored reshare ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
2554 * @brief Processes retractions
2556 * @param array $importer Array of the importer user
2557 * @param array $contact The contact of the item owner
2558 * @param object $data The message object
2560 * @return bool success
2562 private static function item_retraction($importer, $contact, $data) {
2563 $author = notags(unxmlify($data->author));
2564 $target_guid = notags(unxmlify($data->target_guid));
2565 $target_type = notags(unxmlify($data->target_type));
2567 $person = self::person_by_handle($author);
2568 if (!is_array($person)) {
2569 logger("unable to find author detail for ".$author);
2573 if (empty($contact["url"])) {
2574 $contact["url"] = $person["url"];
2577 // Fetch items that are about to be deleted
2578 $fields = array('uid', 'id', 'parent', 'parent-uri', 'author-link');
2580 // When we receive a public retraction, we delete every item that we find.
2581 if ($importer['uid'] == 0) {
2582 $condition = array("`guid` = ? AND NOT `file` LIKE '%%[%%' AND NOT `deleted`", $target_guid);
2584 $condition = array("`guid` = ? AND `uid` = ? AND NOT `file` LIKE '%%[%%' AND NOT `deleted`", $target_guid, $importer['uid']);
2586 $r = dba::select('item', $fields, $condition);
2587 if (!dbm::is_result($r)) {
2588 logger("Target guid ".$target_guid." was not found on this system for user ".$importer['uid'].".");
2592 while ($item = dba::fetch($r)) {
2593 // Fetch the parent item
2594 $parent = dba::select('item', array('author-link', 'origin'), array('id' => $item["parent"]), array('limit' => 1));
2596 // Only delete it if the parent author really fits
2597 if (!link_compare($parent["author-link"], $contact["url"]) && !link_compare($item["author-link"], $contact["url"])) {
2598 logger("Thread author ".$parent["author-link"]." and item author ".$item["author-link"]." don't fit to expected contact ".$contact["url"], LOGGER_DEBUG);
2602 // Currently we don't have a central deletion function that we could use in this case. The function "item_drop" doesn't work for that case
2603 dba::update('item', array('deleted' => true, 'title' => '', 'body' => '',
2604 'edited' => datetime_convert(), 'changed' => datetime_convert()),
2605 array('id' => $item["id"]));
2607 // Delete the thread - if it is a starting post and not a comment
2608 if ($target_type != 'Comment') {
2609 delete_thread($item["id"], $item["parent-uri"]);
2612 logger("Deleted target ".$target_guid." (".$item["id"].") from user ".$item["uid"]." parent: ".$item["parent"], LOGGER_DEBUG);
2614 // Now check if the retraction needs to be relayed by us
2615 if ($parent["origin"]) {
2617 proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $item["id"]);
2625 * @brief Receives retraction messages
2627 * @param array $importer Array of the importer user
2628 * @param string $sender The sender of the message
2629 * @param object $data The message object
2631 * @return bool Success
2633 private static function receive_retraction($importer, $sender, $data) {
2634 $target_type = notags(unxmlify($data->target_type));
2636 $contact = self::contact_by_handle($importer["uid"], $sender);
2637 if (!$contact && (in_array($target_type, array("Contact", "Person")))) {
2638 logger("cannot find contact for sender: ".$sender." and user ".$importer["uid"]);
2642 logger("Got retraction for ".$target_type.", sender ".$sender." and user ".$importer["uid"], LOGGER_DEBUG);
2644 switch ($target_type) {
2649 case "StatusMessage":
2650 return self::item_retraction($importer, $contact, $data);
2654 /// @todo What should we do with an "unshare"?
2655 // Removing the contact isn't correct since we still can read the public items
2656 contact_remove($contact["id"]);
2660 logger("Unknown target type ".$target_type);
2667 * @brief Receives status messages
2669 * @param array $importer Array of the importer user
2670 * @param object $data The message object
2671 * @param string $xml The original XML of the message
2673 * @return int The message id of the newly created item
2675 private static function receive_status_message($importer, $data, $xml) {
2676 $author = notags(unxmlify($data->author));
2677 $guid = notags(unxmlify($data->guid));
2678 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
2679 $public = notags(unxmlify($data->public));
2680 $text = unxmlify($data->text);
2681 $provider_display_name = notags(unxmlify($data->provider_display_name));
2683 $contact = self::allowed_contact_by_handle($importer, $author, false);
2688 $message_id = self::message_exists($importer["uid"], $guid);
2694 if ($data->location) {
2695 foreach ($data->location->children() AS $fieldname => $data) {
2696 $address[$fieldname] = notags(unxmlify($data));
2700 $body = diaspora2bb($text);
2702 $datarray = array();
2704 // Attach embedded pictures to the body
2706 foreach ($data->photo AS $photo) {
2707 $body = "[img]".unxmlify($photo->remote_photo_path).
2708 unxmlify($photo->remote_photo_name)."[/img]\n".$body;
2711 $datarray["object-type"] = ACTIVITY_OBJ_IMAGE;
2713 $datarray["object-type"] = ACTIVITY_OBJ_NOTE;
2715 // Add OEmbed and other information to the body
2716 if (!self::is_redmatrix($contact["url"])) {
2717 $body = add_page_info_to_body($body, false, true);
2721 /// @todo enable support for polls
2722 //if ($data->poll) {
2723 // foreach ($data->poll AS $poll)
2728 /// @todo enable support for events
2730 $datarray["uid"] = $importer["uid"];
2731 $datarray["contact-id"] = $contact["id"];
2732 $datarray["network"] = NETWORK_DIASPORA;
2734 $datarray["author-name"] = $contact["name"];
2735 $datarray["author-link"] = $contact["url"];
2736 $datarray["author-avatar"] = ((x($contact,"thumb")) ? $contact["thumb"] : $contact["photo"]);
2738 $datarray["owner-name"] = $datarray["author-name"];
2739 $datarray["owner-link"] = $datarray["author-link"];
2740 $datarray["owner-avatar"] = $datarray["author-avatar"];
2742 $datarray["guid"] = $guid;
2743 $datarray["uri"] = $datarray["parent-uri"] = self::get_uri_from_guid($author, $guid);
2745 $datarray["verb"] = ACTIVITY_POST;
2746 $datarray["gravity"] = GRAVITY_PARENT;
2748 $datarray["protocol"] = PROTOCOL_DIASPORA;
2749 $datarray["source"] = $xml;
2751 $datarray["body"] = self::replace_people_guid($body, $contact["url"]);
2753 if ($provider_display_name != "") {
2754 $datarray["app"] = $provider_display_name;
2757 $datarray["plink"] = self::plink($author, $guid);
2758 $datarray["private"] = (($public == "false") ? 1 : 0);
2759 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
2761 if (isset($address["address"])) {
2762 $datarray["location"] = $address["address"];
2765 if (isset($address["lat"]) && isset($address["lng"])) {
2766 $datarray["coord"] = $address["lat"]." ".$address["lng"];
2769 self::fetch_guid($datarray);
2770 $message_id = item_store($datarray);
2773 logger("Stored item ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
2780 /* ************************************************************************************** *
2781 * Here are all the functions that are needed to transmit data with the Diaspora protocol *
2782 * ************************************************************************************** */
2785 * @brief returnes the handle of a contact
2787 * @param array $me contact array
2789 * @return string the handle in the format user@domain.tld
2791 private static function my_handle($contact) {
2792 if ($contact["addr"] != "") {
2793 return $contact["addr"];
2796 // Normally we should have a filled "addr" field - but in the past this wasn't the case
2797 // So - just in case - we build the the address here.
2798 if ($contact["nickname"] != "") {
2799 $nick = $contact["nickname"];
2801 $nick = $contact["nick"];
2804 return $nick."@".substr(System::baseUrl(), strpos(System::baseUrl(),"://") + 3);
2809 * @brief Creates the data for a private message in the new format
2811 * @param string $msg The message that is to be transmitted
2812 * @param array $user The record of the sender
2813 * @param array $contact Target of the communication
2814 * @param string $prvkey The private key of the sender
2815 * @param string $pubkey The public key of the receiver
2817 * @return string The encrypted data
2819 public static function encode_private_data($msg, $user, $contact, $prvkey, $pubkey) {
2821 logger("Message: ".$msg, LOGGER_DATA);
2823 // without a public key nothing will work
2825 logger("pubkey missing: contact id: ".$contact["id"]);
2829 $aes_key = openssl_random_pseudo_bytes(32);
2830 $b_aes_key = base64_encode($aes_key);
2831 $iv = openssl_random_pseudo_bytes(16);
2832 $b_iv = base64_encode($iv);
2834 $ciphertext = self::aes_encrypt($aes_key, $iv, $msg);
2836 $json = json_encode(array("iv" => $b_iv, "key" => $b_aes_key));
2838 $encrypted_key_bundle = "";
2839 openssl_public_encrypt($json, $encrypted_key_bundle, $pubkey);
2841 $json_object = json_encode(array("aes_key" => base64_encode($encrypted_key_bundle),
2842 "encrypted_magic_envelope" => base64_encode($ciphertext)));
2844 return $json_object;
2848 * @brief Creates the envelope for the "fetch" endpoint and for the new format
2850 * @param string $msg The message that is to be transmitted
2851 * @param array $user The record of the sender
2853 * @return string The envelope
2855 public static function build_magic_envelope($msg, $user) {
2857 $b64url_data = base64url_encode($msg);
2858 $data = str_replace(array("\n", "\r", " ", "\t"), array("", "", "", ""), $b64url_data);
2860 $key_id = base64url_encode(self::my_handle($user));
2861 $type = "application/xml";
2862 $encoding = "base64url";
2863 $alg = "RSA-SHA256";
2864 $signable_data = $data.".".base64url_encode($type).".".base64url_encode($encoding).".".base64url_encode($alg);
2866 // Fallback if the private key wasn't transmitted in the expected field
2867 if ($user['uprvkey'] == "")
2868 $user['uprvkey'] = $user['prvkey'];
2870 $signature = rsa_sign($signable_data, $user["uprvkey"]);
2871 $sig = base64url_encode($signature);
2873 $xmldata = array("me:env" => array("me:data" => $data,
2874 "@attributes" => array("type" => $type),
2875 "me:encoding" => $encoding,
2878 "@attributes2" => array("key_id" => $key_id)));
2880 $namespaces = array("me" => "http://salmon-protocol.org/ns/magic-env");
2882 return xml::from_array($xmldata, $xml, false, $namespaces);
2886 * @brief Create the envelope for a message
2888 * @param string $msg The message that is to be transmitted
2889 * @param array $user The record of the sender
2890 * @param array $contact Target of the communication
2891 * @param string $prvkey The private key of the sender
2892 * @param string $pubkey The public key of the receiver
2893 * @param bool $public Is the message public?
2895 * @return string The message that will be transmitted to other servers
2897 private static function build_message($msg, $user, $contact, $prvkey, $pubkey, $public = false) {
2899 // The message is put into an envelope with the sender's signature
2900 $envelope = self::build_magic_envelope($msg, $user);
2902 // Private messages are put into a second envelope, encrypted with the receivers public key
2904 $envelope = self::encode_private_data($envelope, $user, $contact, $prvkey, $pubkey);
2911 * @brief Creates a signature for a message
2913 * @param array $owner the array of the owner of the message
2914 * @param array $message The message that is to be signed
2916 * @return string The signature
2918 private static function signature($owner, $message) {
2920 unset($sigmsg["author_signature"]);
2921 unset($sigmsg["parent_author_signature"]);
2923 $signed_text = implode(";", $sigmsg);
2925 return base64_encode(rsa_sign($signed_text, $owner["uprvkey"], "sha256"));
2929 * @brief Transmit a message to a target server
2931 * @param array $owner the array of the item owner
2932 * @param array $contact Target of the communication
2933 * @param string $envelope The message that is to be transmitted
2934 * @param bool $public_batch Is it a public post?
2935 * @param bool $queue_run Is the transmission called from the queue?
2936 * @param string $guid message guid
2938 * @return int Result of the transmission
2940 public static function transmit($owner, $contact, $envelope, $public_batch, $queue_run=false, $guid = "") {
2944 $enabled = intval(get_config("system", "diaspora_enabled"));
2948 $logid = random_string(4);
2949 $dest_url = (($public_batch) ? $contact["batch"] : $contact["notify"]);
2951 logger("no url for contact: ".$contact["id"]." batch mode =".$public_batch);
2955 logger("transmit: ".$logid."-".$guid." ".$dest_url);
2957 if (!$queue_run && was_recently_delayed($contact["id"])) {
2960 if (!intval(get_config("system", "diaspora_test"))) {
2961 $content_type = (($public_batch) ? "application/magic-envelope+xml" : "application/json");
2963 post_url($dest_url."/", $envelope, array("Content-Type: ".$content_type));
2964 $return_code = $a->get_curl_code();
2966 logger("test_mode");
2971 logger("transmit: ".$logid."-".$guid." returns: ".$return_code);
2973 if (!$return_code || (($return_code == 503) && (stristr($a->get_curl_headers(), "retry-after")))) {
2974 logger("queue message");
2976 $r = q("SELECT `id` FROM `queue` WHERE `cid` = %d AND `network` = '%s' AND `content` = '%s' AND `batch` = %d LIMIT 1",
2977 intval($contact["id"]),
2978 dbesc(NETWORK_DIASPORA),
2980 intval($public_batch)
2983 logger("add_to_queue ignored - identical item already in queue");
2985 // queue message for redelivery
2986 add_to_queue($contact["id"], NETWORK_DIASPORA, $envelope, $public_batch);
2988 // The message could not be delivered. We mark the contact as "dead"
2989 mark_for_death($contact);
2991 } elseif (($return_code >= 200) && ($return_code <= 299)) {
2992 // We successfully delivered a message, the contact is alive
2993 unmark_for_death($contact);
2996 return(($return_code) ? $return_code : (-1));
3001 * @brief Build the post xml
3003 * @param string $type The message type
3004 * @param array $message The message data
3006 * @return string The post XML
3008 public static function build_post_xml($type, $message) {
3010 $data = array($type => $message);
3012 return xml::from_array($data, $xml);
3016 * @brief Builds and transmit messages
3018 * @param array $owner the array of the item owner
3019 * @param array $contact Target of the communication
3020 * @param string $type The message type
3021 * @param array $message The message data
3022 * @param bool $public_batch Is it a public post?
3023 * @param string $guid message guid
3024 * @param bool $spool Should the transmission be spooled or transmitted?
3026 * @return int Result of the transmission
3028 private static function build_and_transmit($owner, $contact, $type, $message, $public_batch = false, $guid = "", $spool = false) {
3030 $msg = self::build_post_xml($type, $message);
3032 logger('message: '.$msg, LOGGER_DATA);
3033 logger('send guid '.$guid, LOGGER_DEBUG);
3035 // Fallback if the private key wasn't transmitted in the expected field
3036 if ($owner['uprvkey'] == "")
3037 $owner['uprvkey'] = $owner['prvkey'];
3039 $envelope = self::build_message($msg, $owner, $contact, $owner['uprvkey'], $contact['pubkey'], $public_batch);
3042 add_to_queue($contact['id'], NETWORK_DIASPORA, $envelope, $public_batch);
3045 $return_code = self::transmit($owner, $contact, $envelope, $public_batch, false, $guid);
3047 logger("guid: ".$item["guid"]." result ".$return_code, LOGGER_DEBUG);
3049 return $return_code;
3053 * @brief sends an account migration
3055 * @param array $owner the array of the item owner
3056 * @param array $contact Target of the communication
3057 * @param int $uid User ID
3059 * @return int The result of the transmission
3061 public static function sendAccountMigration($owner, $contact, $uid) {
3063 $old_handle = PConfig::get($uid, 'system', 'previous_addr');
3064 $profile = self::createProfileData($uid);
3066 $signed_text = 'AccountMigration:'.$old_handle.':'.$profile['author'];
3067 $signature = base64_encode(rsa_sign($signed_text, $owner["uprvkey"], "sha256"));
3069 $message = array("author" => $old_handle,
3070 "profile" => $profile,
3071 "signature" => $signature);
3073 logger("Send account migration ".print_r($message, true), LOGGER_DEBUG);
3075 return self::build_and_transmit($owner, $contact, "account_migration", $message);
3079 * @brief Sends a "share" message
3081 * @param array $owner the array of the item owner
3082 * @param array $contact Target of the communication
3084 * @return int The result of the transmission
3086 public static function send_share($owner, $contact) {
3089 * @todo support the different possible combinations of "following" and "sharing"
3090 * Currently, Diaspora only interprets the "sharing" field
3092 * Before switching this code productive, we have to check all "send_share" calls if "rel" is set correctly
3096 switch ($contact["rel"]) {
3097 case CONTACT_IS_FRIEND:
3100 case CONTACT_IS_SHARING:
3103 case CONTACT_IS_FOLLOWER:
3109 $message = array("author" => self::my_handle($owner),
3110 "recipient" => $contact["addr"],
3111 "following" => "true",
3112 "sharing" => "true");
3114 logger("Send share ".print_r($message, true), LOGGER_DEBUG);
3116 return self::build_and_transmit($owner, $contact, "contact", $message);
3120 * @brief sends an "unshare"
3122 * @param array $owner the array of the item owner
3123 * @param array $contact Target of the communication
3125 * @return int The result of the transmission
3127 public static function send_unshare($owner, $contact) {
3129 $message = array("author" => self::my_handle($owner),
3130 "recipient" => $contact["addr"],
3131 "following" => "false",
3132 "sharing" => "false");
3134 logger("Send unshare ".print_r($message, true), LOGGER_DEBUG);
3136 return self::build_and_transmit($owner, $contact, "contact", $message);
3140 * @brief Checks a message body if it is a reshare
3142 * @param string $body The message body that is to be check
3143 * @param bool $complete Should it be a complete check or a simple check?
3145 * @return array|bool Reshare details or "false" if no reshare
3147 public static function is_reshare($body, $complete = true) {
3148 $body = trim($body);
3150 // Skip if it isn't a pure repeated messages
3151 // Does it start with a share?
3152 if ((strpos($body, "[share") > 0) && $complete)
3155 // Does it end with a share?
3156 if (strlen($body) > (strrpos($body, "[/share]") + 8))
3159 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism","$1",$body);
3160 // Skip if there is no shared message in there
3161 if ($body == $attributes)
3164 // If we don't do the complete check we quit here
3169 preg_match("/guid='(.*?)'/ism", $attributes, $matches);
3170 if ($matches[1] != "")
3171 $guid = $matches[1];
3173 preg_match('/guid="(.*?)"/ism', $attributes, $matches);
3174 if ($matches[1] != "")
3175 $guid = $matches[1];
3178 $r = q("SELECT `contact-id` FROM `item` WHERE `guid` = '%s' AND `network` IN ('%s', '%s') LIMIT 1",
3179 dbesc($guid), NETWORK_DFRN, NETWORK_DIASPORA);
3182 $ret["root_handle"] = self::handle_from_contact($r[0]["contact-id"]);
3183 $ret["root_guid"] = $guid;
3189 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
3190 if ($matches[1] != "")
3191 $profile = $matches[1];
3193 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
3194 if ($matches[1] != "")
3195 $profile = $matches[1];
3199 $ret["root_handle"] = preg_replace("=https?://(.*)/u/(.*)=ism", "$2@$1", $profile);
3200 if (($ret["root_handle"] == $profile) || ($ret["root_handle"] == ""))
3204 preg_match("/link='(.*?)'/ism", $attributes, $matches);
3205 if ($matches[1] != "")
3206 $link = $matches[1];
3208 preg_match('/link="(.*?)"/ism', $attributes, $matches);
3209 if ($matches[1] != "")
3210 $link = $matches[1];
3212 $ret["root_guid"] = preg_replace("=https?://(.*)/posts/(.*)=ism", "$2", $link);
3213 if (($ret["root_guid"] == $link) || (trim($ret["root_guid"]) == ""))
3220 * @brief Create an event array
3222 * @param integer $event_id The id of the event
3224 * @return array with event data
3226 private static function build_event($event_id) {
3228 $r = q("SELECT `guid`, `uid`, `start`, `finish`, `nofinish`, `summary`, `desc`, `location`, `adjust` FROM `event` WHERE `id` = %d", intval($event_id));
3229 if (!dbm::is_result($r)) {
3235 $eventdata = array();
3237 $r = q("SELECT `timezone` FROM `user` WHERE `uid` = %d", intval($event['uid']));
3238 if (!dbm::is_result($r)) {
3244 $r = q("SELECT `addr`, `nick` FROM `contact` WHERE `uid` = %d AND `self`", intval($event['uid']));
3245 if (!dbm::is_result($r)) {
3251 $eventdata['author'] = self::my_handle($owner);
3253 if ($event['guid']) {
3254 $eventdata['guid'] = $event['guid'];
3257 $mask = 'Y-m-d\TH:i:s\Z';
3259 /// @todo - establish "all day" events in Friendica
3260 $eventdata["all_day"] = "false";
3262 if (!$event['adjust']) {
3263 $eventdata['timezone'] = $user['timezone'];
3265 if ($eventdata['timezone'] == "") {
3266 $eventdata['timezone'] = 'UTC';
3270 if ($event['start']) {
3271 $eventdata['start'] = datetime_convert($eventdata['timezone'], "UTC", $event['start'], $mask);
3273 if ($event['finish'] && !$event['nofinish']) {
3274 $eventdata['end'] = datetime_convert($eventdata['timezone'], "UTC", $event['finish'], $mask);
3276 if ($event['summary']) {
3277 $eventdata['summary'] = html_entity_decode(bb2diaspora($event['summary']));
3279 if ($event['desc']) {
3280 $eventdata['description'] = html_entity_decode(bb2diaspora($event['desc']));
3282 if ($event['location']) {
3283 $location = array();
3284 $location["address"] = html_entity_decode(bb2diaspora($event['location']));
3285 $location["lat"] = 0;
3286 $location["lng"] = 0;
3287 $eventdata['location'] = $location;
3294 * @brief Create a post (status message or reshare)
3296 * @param array $item The item that will be exported
3297 * @param array $owner the array of the item owner
3300 * 'type' -> Message type ("status_message" or "reshare")
3301 * 'message' -> Array of XML elements of the status
3303 public static function build_status($item, $owner) {
3305 $cachekey = "diaspora:build_status:".$item['guid'];
3307 $result = Cache::get($cachekey);
3308 if (!is_null($result)) {
3312 $myaddr = self::my_handle($owner);
3314 $public = (($item["private"]) ? "false" : "true");
3316 $created = datetime_convert("UTC", "UTC", $item["created"], 'Y-m-d\TH:i:s\Z');
3318 // Detect a share element and do a reshare
3319 if (!$item['private'] && ($ret = self::is_reshare($item["body"]))) {
3320 $message = array("author" => $myaddr,
3321 "guid" => $item["guid"],
3322 "created_at" => $created,
3323 "root_author" => $ret["root_handle"],
3324 "root_guid" => $ret["root_guid"],
3325 "provider_display_name" => $item["app"],
3326 "public" => $public);
3330 $title = $item["title"];
3331 $body = $item["body"];
3333 // convert to markdown
3334 $body = html_entity_decode(bb2diaspora($body));
3338 $body = "## ".html_entity_decode($title)."\n\n".$body;
3340 if ($item["attach"]) {
3341 $cnt = preg_match_all('/href=\"(.*?)\"(.*?)title=\"(.*?)\"/ism', $item["attach"], $matches, PREG_SET_ORDER);
3343 $body .= "\n".t("Attachments:")."\n";
3344 foreach ($matches as $mtch)
3345 $body .= "[".$mtch[3]."](".$mtch[1].")\n";
3349 $location = array();
3351 if ($item["location"] != "")
3352 $location["address"] = $item["location"];
3354 if ($item["coord"] != "") {
3355 $coord = explode(" ", $item["coord"]);
3356 $location["lat"] = $coord[0];
3357 $location["lng"] = $coord[1];
3360 $message = array("author" => $myaddr,
3361 "guid" => $item["guid"],
3362 "created_at" => $created,
3363 "public" => $public,
3365 "provider_display_name" => $item["app"],
3366 "location" => $location);
3368 // Diaspora rejects messages when they contain a location without "lat" or "lng"
3369 if (!isset($location["lat"]) || !isset($location["lng"])) {
3370 unset($message["location"]);
3373 if ($item['event-id'] > 0) {
3374 $event = self::build_event($item['event-id']);
3375 if (count($event)) {
3376 $message['event'] = $event;
3378 /// @todo Once Diaspora supports it, we will remove the body
3379 // $message['text'] = '';
3383 $type = "status_message";
3386 $msg = array("type" => $type, "message" => $message);
3388 Cache::set($cachekey, $msg, CACHE_QUARTER_HOUR);
3394 * @brief Sends a post
3396 * @param array $item The item that will be exported
3397 * @param array $owner the array of the item owner
3398 * @param array $contact Target of the communication
3399 * @param bool $public_batch Is it a public post?
3401 * @return int The result of the transmission
3403 public static function send_status($item, $owner, $contact, $public_batch = false) {
3405 $status = self::build_status($item, $owner);
3407 return self::build_and_transmit($owner, $contact, $status["type"], $status["message"], $public_batch, $item["guid"]);
3411 * @brief Creates a "like" object
3413 * @param array $item The item that will be exported
3414 * @param array $owner the array of the item owner
3416 * @return array The data for a "like"
3418 private static function construct_like($item, $owner) {
3420 $p = q("SELECT `guid`, `uri`, `parent-uri` FROM `item` WHERE `uri` = '%s' LIMIT 1",
3421 dbesc($item["thr-parent"]));
3422 if (!dbm::is_result($p))
3427 $target_type = ($parent["uri"] === $parent["parent-uri"] ? "Post" : "Comment");
3428 if ($item['verb'] === ACTIVITY_LIKE) {
3430 } elseif ($item['verb'] === ACTIVITY_DISLIKE) {
3431 $positive = "false";
3434 return(array("author" => self::my_handle($owner),
3435 "guid" => $item["guid"],
3436 "parent_guid" => $parent["guid"],
3437 "parent_type" => $target_type,
3438 "positive" => $positive,
3439 "author_signature" => ""));
3443 * @brief Creates an "EventParticipation" object
3445 * @param array $item The item that will be exported
3446 * @param array $owner the array of the item owner
3448 * @return array The data for an "EventParticipation"
3450 private static function construct_attend($item, $owner) {
3452 $p = q("SELECT `guid`, `uri`, `parent-uri` FROM `item` WHERE `uri` = '%s' LIMIT 1",
3453 dbesc($item["thr-parent"]));
3454 if (!dbm::is_result($p))
3459 switch ($item['verb']) {
3460 case ACTIVITY_ATTEND:
3461 $attend_answer = 'accepted';
3463 case ACTIVITY_ATTENDNO:
3464 $attend_answer = 'declined';
3466 case ACTIVITY_ATTENDMAYBE:
3467 $attend_answer = 'tentative';
3470 logger('Unknown verb '.$item['verb'].' in item '.$item['guid']);
3474 return(array("author" => self::my_handle($owner),
3475 "guid" => $item["guid"],
3476 "parent_guid" => $parent["guid"],
3477 "status" => $attend_answer,
3478 "author_signature" => ""));
3482 * @brief Creates the object for a comment
3484 * @param array $item The item that will be exported
3485 * @param array $owner the array of the item owner
3487 * @return array The data for a comment
3489 private static function construct_comment($item, $owner) {
3491 $cachekey = "diaspora:construct_comment:".$item['guid'];
3493 $result = Cache::get($cachekey);
3494 if (!is_null($result)) {
3498 $p = q("SELECT `guid` FROM `item` WHERE `parent` = %d AND `id` = %d LIMIT 1",
3499 intval($item["parent"]),
3500 intval($item["parent"])
3503 if (!dbm::is_result($p))
3508 $text = html_entity_decode(bb2diaspora($item["body"]));
3509 $created = datetime_convert("UTC", "UTC", $item["created"], 'Y-m-d\TH:i:s\Z');
3511 $comment = array("author" => self::my_handle($owner),
3512 "guid" => $item["guid"],
3513 "created_at" => $created,
3514 "parent_guid" => $parent["guid"],
3516 "author_signature" => "");
3518 // Send the thread parent guid only if it is a threaded comment
3519 if ($item['thr-parent'] != $item['parent-uri']) {
3520 $comment['thread_parent_guid'] = self::get_guid_from_uri($item['thr-parent'], $item['uid']);
3523 Cache::set($cachekey, $comment, CACHE_QUARTER_HOUR);
3529 * @brief Send a like or a comment
3531 * @param array $item The item that will be exported
3532 * @param array $owner the array of the item owner
3533 * @param array $contact Target of the communication
3534 * @param bool $public_batch Is it a public post?
3536 * @return int The result of the transmission
3538 public static function send_followup($item,$owner,$contact,$public_batch = false) {
3540 if (in_array($item['verb'], array(ACTIVITY_ATTEND, ACTIVITY_ATTENDNO, ACTIVITY_ATTENDMAYBE))) {
3541 $message = self::construct_attend($item, $owner);
3542 $type = "event_participation";
3543 } elseif (in_array($item["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
3544 $message = self::construct_like($item, $owner);
3547 $message = self::construct_comment($item, $owner);
3554 $message["author_signature"] = self::signature($owner, $message);
3556 return self::build_and_transmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
3560 * @brief Creates a message from a signature record entry
3562 * @param array $item The item that will be exported
3563 * @param array $signature The entry of the "sign" record
3565 * @return string The message
3567 private static function message_from_signature($item, $signature) {
3569 // Split the signed text
3570 $signed_parts = explode(";", $signature['signed_text']);
3572 if ($item["deleted"])
3573 $message = array("author" => $signature['signer'],
3574 "target_guid" => $signed_parts[0],
3575 "target_type" => $signed_parts[1]);
3576 elseif ($item['verb'] === ACTIVITY_LIKE)
3577 $message = array("author" => $signed_parts[4],
3578 "guid" => $signed_parts[1],
3579 "parent_guid" => $signed_parts[3],
3580 "parent_type" => $signed_parts[2],
3581 "positive" => $signed_parts[0],
3582 "author_signature" => $signature['signature'],
3583 "parent_author_signature" => "");
3585 // Remove the comment guid
3586 $guid = array_shift($signed_parts);
3588 // Remove the parent guid
3589 $parent_guid = array_shift($signed_parts);
3591 // Remove the handle
3592 $handle = array_pop($signed_parts);
3594 // Glue the parts together
3595 $text = implode(";", $signed_parts);
3597 $message = array("author" => $handle,
3599 "parent_guid" => $parent_guid,
3600 "text" => implode(";", $signed_parts),
3601 "author_signature" => $signature['signature'],
3602 "parent_author_signature" => "");
3608 * @brief Relays messages (like, comment, retraction) to other servers if we are the thread owner
3610 * @param array $item The item that will be exported
3611 * @param array $owner the array of the item owner
3612 * @param array $contact Target of the communication
3613 * @param bool $public_batch Is it a public post?
3615 * @return int The result of the transmission
3617 public static function send_relay($item, $owner, $contact, $public_batch = false) {
3619 if ($item["deleted"])
3620 return self::send_retraction($item, $owner, $contact, $public_batch, true);
3621 elseif ($item['verb'] === ACTIVITY_LIKE)
3626 logger("Got relayable data ".$type." for item ".$item["guid"]." (".$item["id"].")", LOGGER_DEBUG);
3628 // fetch the original signature
3630 $r = q("SELECT `signed_text`, `signature`, `signer` FROM `sign` WHERE `iid` = %d LIMIT 1",
3631 intval($item["id"]));
3634 logger("Couldn't fetch signatur for item ".$item["guid"]." (".$item["id"].")", LOGGER_DEBUG);
3640 // Old way - is used by the internal Friendica functions
3641 /// @todo Change all signatur storing functions to the new format
3642 if ($signature['signed_text'] && $signature['signature'] && $signature['signer'])
3643 $message = self::message_from_signature($item, $signature);
3645 $msg = json_decode($signature['signed_text'], true);
3648 if (is_array($msg)) {
3649 foreach ($msg AS $field => $data) {
3650 if (!$item["deleted"]) {
3651 if ($field == "diaspora_handle") {
3654 if ($field == "target_type") {
3655 $field = "parent_type";
3659 $message[$field] = $data;
3662 logger("Signature text for item ".$item["guid"]." (".$item["id"].") couldn't be extracted: ".$signature['signed_text'], LOGGER_DEBUG);
3665 $message["parent_author_signature"] = self::signature($owner, $message);
3667 logger("Relayed data ".print_r($message, true), LOGGER_DEBUG);
3669 return self::build_and_transmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
3673 * @brief Sends a retraction (deletion) of a message, like or comment
3675 * @param array $item The item that will be exported
3676 * @param array $owner the array of the item owner
3677 * @param array $contact Target of the communication
3678 * @param bool $public_batch Is it a public post?
3679 * @param bool $relay Is the retraction transmitted from a relay?
3681 * @return int The result of the transmission
3683 public static function send_retraction($item, $owner, $contact, $public_batch = false, $relay = false) {
3685 $itemaddr = self::handle_from_contact($item["contact-id"], $item["gcontact-id"]);
3687 $msg_type = "retraction";
3689 if ($item['id'] == $item['parent']) {
3690 $target_type = "Post";
3691 } elseif ($item["verb"] == ACTIVITY_LIKE) {
3692 $target_type = "Like";
3694 $target_type = "Comment";
3697 $message = array("author" => $itemaddr,
3698 "target_guid" => $item['guid'],
3699 "target_type" => $target_type);
3701 logger("Got message ".print_r($message, true), LOGGER_DEBUG);
3703 return self::build_and_transmit($owner, $contact, $msg_type, $message, $public_batch, $item["guid"]);
3707 * @brief Sends a mail
3709 * @param array $item The item that will be exported
3710 * @param array $owner The owner
3711 * @param array $contact Target of the communication
3713 * @return int The result of the transmission
3715 public static function send_mail($item, $owner, $contact) {
3717 $myaddr = self::my_handle($owner);
3719 $r = q("SELECT * FROM `conv` WHERE `id` = %d AND `uid` = %d LIMIT 1",
3720 intval($item["convid"]),
3721 intval($item["uid"])
3724 if (!dbm::is_result($r)) {
3725 logger("conversation not found.");
3731 "author" => $cnv["creator"],
3732 "guid" => $cnv["guid"],
3733 "subject" => $cnv["subject"],
3734 "created_at" => datetime_convert("UTC", "UTC", $cnv['created'], 'Y-m-d\TH:i:s\Z'),
3735 "participants" => $cnv["recips"]
3738 $body = bb2diaspora($item["body"]);
3739 $created = datetime_convert("UTC", "UTC", $item["created"], 'Y-m-d\TH:i:s\Z');
3742 "author" => $myaddr,
3743 "guid" => $item["guid"],
3744 "conversation_guid" => $cnv["guid"],
3746 "created_at" => $created,
3749 if ($item["reply"]) {
3754 "author" => $cnv["creator"],
3755 "guid" => $cnv["guid"],
3756 "subject" => $cnv["subject"],
3757 "created_at" => datetime_convert("UTC", "UTC", $cnv['created'], 'Y-m-d\TH:i:s\Z'),
3758 "participants" => $cnv["recips"],
3761 $type = "conversation";
3764 return self::build_and_transmit($owner, $contact, $type, $message, false, $item["guid"]);
3768 * @brief Create profile data
3770 * @param int $uid The user id
3772 * @return array The profile data
3774 private static function createProfileData($uid) {
3775 $r = q("SELECT `profile`.`uid` AS `profile_uid`, `profile`.* , `user`.*, `user`.`prvkey` AS `uprvkey`, `contact`.`addr`
3777 INNER JOIN `user` ON `profile`.`uid` = `user`.`uid`
3778 INNER JOIN `contact` ON `profile`.`uid` = `contact`.`uid`
3779 WHERE `user`.`uid` = %d AND `profile`.`is-default` AND `contact`.`self` LIMIT 1",
3789 $handle = $profile["addr"];
3790 $first = ((strpos($profile['name'],' ')
3791 ? trim(substr($profile['name'],0,strpos($profile['name'],' '))) : $profile['name']));
3792 $last = (($first === $profile['name']) ? '' : trim(substr($profile['name'], strlen($first))));
3793 $large = System::baseUrl().'/photo/custom/300/'.$profile['uid'].'.jpg';
3794 $medium = System::baseUrl().'/photo/custom/100/'.$profile['uid'].'.jpg';
3795 $small = System::baseUrl().'/photo/custom/50/' .$profile['uid'].'.jpg';
3796 $searchable = (($profile['publish'] && $profile['net-publish']) ? 'true' : 'false');
3798 if ($searchable === 'true') {
3799 $dob = '1000-00-00';
3801 if (($profile['dob']) && ($profile['dob'] > '0001-01-01'))
3802 $dob = ((intval($profile['dob'])) ? intval($profile['dob']) : '1000') .'-'. datetime_convert('UTC','UTC',$profile['dob'],'m-d');
3804 $about = $profile['about'];
3805 $about = strip_tags(bbcode($about));
3807 $location = formatted_location($profile);
3809 if ($profile['pub_keywords']) {
3810 $kw = str_replace(',',' ',$profile['pub_keywords']);
3811 $kw = str_replace(' ',' ',$kw);
3812 $arr = explode(' ',$profile['pub_keywords']);
3814 for ($x = 0; $x < 5; $x ++) {
3816 $tags .= '#'. trim($arr[$x]) .' ';
3820 $tags = trim($tags);
3823 return array("author" => $handle,
3824 "first_name" => $first,
3825 "last_name" => $last,
3826 "image_url" => $large,
3827 "image_url_medium" => $medium,
3828 "image_url_small" => $small,
3830 "gender" => $profile['gender'],
3832 "location" => $location,
3833 "searchable" => $searchable,
3835 "tag_string" => $tags);
3839 * @brief Sends profile data
3841 * @param int $uid The user id
3843 public static function send_profile($uid, $recips = false) {
3849 $recips = q("SELECT `id`,`name`,`network`,`pubkey`,`notify` FROM `contact` WHERE `network` = '%s'
3850 AND `uid` = %d AND `rel` != %d",
3851 dbesc(NETWORK_DIASPORA),
3853 intval(CONTACT_IS_SHARING)
3858 $message = self::createProfileData($uid);
3860 foreach ($recips as $recip) {
3861 logger("Send updated profile data for user ".$uid." to contact ".$recip["id"], LOGGER_DEBUG);
3862 self::build_and_transmit($profile, $recip, "profile", $message, false, "", true);
3867 * @brief Stores the signature for likes that are created on our system
3869 * @param array $contact The contact array of the "like"
3870 * @param int $post_id The post id of the "like"
3872 * @return bool Success
3874 public static function store_like_signature($contact, $post_id) {
3876 // Is the contact the owner? Then fetch the private key
3877 if (!$contact['self'] || ($contact['uid'] == 0)) {
3878 logger("No owner post, so not storing signature", LOGGER_DEBUG);
3882 $r = q("SELECT `prvkey` FROM `user` WHERE `uid` = %d LIMIT 1", intval($contact['uid']));
3883 if (!dbm::is_result($r)) {
3887 $contact["uprvkey"] = $r[0]['prvkey'];
3889 $r = q("SELECT * FROM `item` WHERE `id` = %d LIMIT 1", intval($post_id));
3890 if (!dbm::is_result($r)) {
3894 if (!in_array($r[0]["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
3898 $message = self::construct_like($r[0], $contact);
3899 $message["author_signature"] = self::signature($contact, $message);
3902 * Now store the signature more flexible to dynamically support new fields.
3903 * This will break Diaspora compatibility with Friendica versions prior to 3.5.
3905 dba::insert('sign', array('iid' => $post_id, 'signed_text' => json_encode($message)));
3907 logger('Stored diaspora like signature');
3912 * @brief Stores the signature for comments that are created on our system
3914 * @param array $item The item array of the comment
3915 * @param array $contact The contact array of the item owner
3916 * @param string $uprvkey The private key of the sender
3917 * @param int $message_id The message id of the comment
3919 * @return bool Success
3921 public static function store_comment_signature($item, $contact, $uprvkey, $message_id) {
3923 if ($uprvkey == "") {
3924 logger('No private key, so not storing comment signature', LOGGER_DEBUG);
3928 $contact["uprvkey"] = $uprvkey;
3930 $message = self::construct_comment($item, $contact);
3931 $message["author_signature"] = self::signature($contact, $message);
3934 * Now store the signature more flexible to dynamically support new fields.
3935 * This will break Diaspora compatibility with Friendica versions prior to 3.5.
3937 dba::insert('sign', array('iid' => $message_id, 'signed_text' => json_encode($message)));
3939 logger('Stored diaspora comment signature');