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.
10 namespace Friendica\Protocol;
13 use Friendica\Core\System;
14 use Friendica\Core\Config;
15 use Friendica\Core\PConfig;
16 use Friendica\Core\Worker;
17 use Friendica\Database\DBM;
18 use Friendica\Network\Probe;
25 require_once 'include/items.php';
26 require_once 'include/bb2diaspora.php';
27 require_once 'include/Contact.php';
28 require_once 'include/Photo.php';
29 require_once 'include/socgraph.php';
30 require_once 'include/group.php';
31 require_once 'include/datetime.php';
32 require_once 'include/queue_fn.php';
35 * @brief This class contain functions to create and send Diaspora XML files
42 * @brief Return a list of relay servers
44 * This is an experimental Diaspora feature.
46 * @return array of relay servers
48 public static function relay_list()
50 $serverdata = Config::get("system", "relay_server");
51 if ($serverdata == "") {
57 $servers = explode(",", $serverdata);
59 foreach ($servers as $server) {
60 $server = trim($server);
61 $addr = "relay@".str_replace("http://", "", normalise_link($server));
62 $batch = $server."/receive/public";
65 "SELECT `batch`, `id`, `name`,`network` FROM `contact` WHERE `uid` = 0 AND `batch` = '%s' AND `addr` = '%s' AND `nurl` = '%s' LIMIT 1",
68 dbesc(normalise_link($server))
73 "INSERT INTO `contact` (`uid`, `created`, `name`, `nick`, `addr`, `url`, `nurl`, `batch`, `network`, `rel`, `blocked`, `pending`, `writable`, `name-date`, `uri-date`, `avatar-date`)
74 VALUES (0, '%s', '%s', 'relay', '%s', '%s', '%s', '%s', '%s', %d, 0, 0, 1, '%s', '%s', '%s')",
79 dbesc(normalise_link($server)),
81 dbesc(NETWORK_DIASPORA),
82 intval(CONTACT_IS_FOLLOWER),
83 dbesc(datetime_convert()),
84 dbesc(datetime_convert()),
85 dbesc(datetime_convert())
88 $relais = q("SELECT `batch`, `id`, `name`,`network` FROM `contact` WHERE `uid` = 0 AND `batch` = '%s' LIMIT 1", dbesc($batch));
90 $relay[] = $relais[0];
93 $relay[] = $relais[0];
101 * @brief repairs a signature that was double encoded
103 * The function is unused at the moment. It was copied from the old implementation.
105 * @param string $signature The signature
106 * @param string $handle The handle of the signature owner
107 * @param integer $level This value is only set inside this function to avoid endless loops
109 * @return string the repaired signature
111 private static function repair_signature($signature, $handle = "", $level = 1)
113 if ($signature == "") {
117 if (base64_encode(base64_decode(base64_decode($signature))) == base64_decode($signature)) {
118 $signature = base64_decode($signature);
119 logger("Repaired double encoded signature from Diaspora/Hubzilla handle ".$handle." - level ".$level, LOGGER_DEBUG);
121 // Do a recursive call to be able to fix even multiple levels
123 $signature = self::repair_signature($signature, $handle, ++$level);
131 * @brief verify the envelope and return the verified data
133 * @param string $envelope The magic envelope
135 * @return string verified data
137 private static function verify_magic_envelope($envelope)
139 $basedom = parse_xml_string($envelope);
141 if (!is_object($basedom)) {
142 logger("Envelope is no XML file");
146 $children = $basedom->children('http://salmon-protocol.org/ns/magic-env');
148 if (sizeof($children) == 0) {
149 logger("XML has no children");
155 $data = base64url_decode($children->data);
156 $type = $children->data->attributes()->type[0];
158 $encoding = $children->encoding;
160 $alg = $children->alg;
162 $sig = base64url_decode($children->sig);
163 $key_id = $children->sig->attributes()->key_id[0];
165 $handle = base64url_decode($key_id);
168 $b64url_data = base64url_encode($data);
169 $msg = str_replace(array("\n", "\r", " ", "\t"), array("", "", "", ""), $b64url_data);
171 $signable_data = $msg.".".base64url_encode($type).".".base64url_encode($encoding).".".base64url_encode($alg);
173 $key = self::key($handle);
175 $verify = rsa_verify($signable_data, $sig, $key);
177 logger('Message did not verify. Discarding.');
185 * @brief encrypts data via AES
187 * @param string $key The AES key
188 * @param string $iv The IV (is used for CBC encoding)
189 * @param string $data The data that is to be encrypted
191 * @return string encrypted data
193 private static function aes_encrypt($key, $iv, $data)
195 return openssl_encrypt($data, 'aes-256-cbc', str_pad($key, 32, "\0"), OPENSSL_RAW_DATA, str_pad($iv, 16, "\0"));
199 * @brief decrypts data via AES
201 * @param string $key The AES key
202 * @param string $iv The IV (is used for CBC encoding)
203 * @param string $encrypted The encrypted data
205 * @return string decrypted data
207 private static function aes_decrypt($key, $iv, $encrypted)
209 return openssl_decrypt($encrypted, 'aes-256-cbc', str_pad($key, 32, "\0"), OPENSSL_RAW_DATA, str_pad($iv, 16, "\0"));
213 * @brief: Decodes incoming Diaspora message in the new format
215 * @param array $importer Array of the importer user
216 * @param string $raw raw post message
219 * 'message' -> decoded Diaspora XML message
220 * 'author' -> author diaspora handle
221 * 'key' -> author public key (converted to pkcs#8)
223 public static function decode_raw($importer, $raw)
225 $data = json_decode($raw);
227 // Is it a private post? Then decrypt the outer Salmon
228 if (is_object($data)) {
229 $encrypted_aes_key_bundle = base64_decode($data->aes_key);
230 $ciphertext = base64_decode($data->encrypted_magic_envelope);
232 $outer_key_bundle = '';
233 @openssl_private_decrypt($encrypted_aes_key_bundle, $outer_key_bundle, $importer['prvkey']);
234 $j_outer_key_bundle = json_decode($outer_key_bundle);
236 if (!is_object($j_outer_key_bundle)) {
237 logger('Outer Salmon did not verify. Discarding.');
238 http_status_exit(400);
241 $outer_iv = base64_decode($j_outer_key_bundle->iv);
242 $outer_key = base64_decode($j_outer_key_bundle->key);
244 $xml = self::aes_decrypt($outer_key, $outer_iv, $ciphertext);
249 $basedom = parse_xml_string($xml);
251 if (!is_object($basedom)) {
252 logger('Received data does not seem to be an XML. Discarding. '.$xml);
253 http_status_exit(400);
256 $base = $basedom->children(NAMESPACE_SALMON_ME);
258 // Not sure if this cleaning is needed
259 $data = str_replace(array(" ", "\t", "\r", "\n"), array("", "", "", ""), $base->data);
261 // Build the signed data
262 $type = $base->data[0]->attributes()->type[0];
263 $encoding = $base->encoding;
265 $signed_data = $data.'.'.base64url_encode($type).'.'.base64url_encode($encoding).'.'.base64url_encode($alg);
267 // This is the signature
268 $signature = base64url_decode($base->sig);
270 // Get the senders' public key
271 $key_id = $base->sig[0]->attributes()->key_id[0];
272 $author_addr = base64_decode($key_id);
273 $key = self::key($author_addr);
275 $verify = rsa_verify($signed_data, $signature, $key);
277 logger('Message did not verify. Discarding.');
278 http_status_exit(400);
281 return array('message' => (string)base64url_decode($base->data),
282 'author' => unxmlify($author_addr),
283 'key' => (string)$key);
287 * @brief: Decodes incoming Diaspora message in the deprecated format
289 * @param array $importer Array of the importer user
290 * @param string $xml urldecoded Diaspora salmon
293 * 'message' -> decoded Diaspora XML message
294 * 'author' -> author diaspora handle
295 * 'key' -> author public key (converted to pkcs#8)
297 public static function decode($importer, $xml)
300 $basedom = parse_xml_string($xml);
302 if (!is_object($basedom)) {
303 logger("XML is not parseable.");
306 $children = $basedom->children('https://joindiaspora.com/protocol');
308 if ($children->header) {
310 $author_link = str_replace('acct:', '', $children->header->author_id);
312 // This happens with posts from a relais
314 logger("This is no private post in the old format", LOGGER_DEBUG);
318 $encrypted_header = json_decode(base64_decode($children->encrypted_header));
320 $encrypted_aes_key_bundle = base64_decode($encrypted_header->aes_key);
321 $ciphertext = base64_decode($encrypted_header->ciphertext);
323 $outer_key_bundle = '';
324 openssl_private_decrypt($encrypted_aes_key_bundle, $outer_key_bundle, $importer['prvkey']);
326 $j_outer_key_bundle = json_decode($outer_key_bundle);
328 $outer_iv = base64_decode($j_outer_key_bundle->iv);
329 $outer_key = base64_decode($j_outer_key_bundle->key);
331 $decrypted = self::aes_decrypt($outer_key, $outer_iv, $ciphertext);
333 logger('decrypted: '.$decrypted, LOGGER_DEBUG);
334 $idom = parse_xml_string($decrypted);
336 $inner_iv = base64_decode($idom->iv);
337 $inner_aes_key = base64_decode($idom->aes_key);
339 $author_link = str_replace('acct:', '', $idom->author_id);
342 $dom = $basedom->children(NAMESPACE_SALMON_ME);
344 // figure out where in the DOM tree our data is hiding
346 if ($dom->provenance->data) {
347 $base = $dom->provenance;
348 } elseif ($dom->env->data) {
350 } elseif ($dom->data) {
355 logger('unable to locate salmon data in xml');
356 http_status_exit(400);
360 // Stash the signature away for now. We have to find their key or it won't be good for anything.
361 $signature = base64url_decode($base->sig);
365 // strip whitespace so our data element will return to one big base64 blob
366 $data = str_replace(array(" ", "\t", "\r", "\n"), array("", "", "", ""), $base->data);
369 // stash away some other stuff for later
371 $type = $base->data[0]->attributes()->type[0];
372 $keyhash = $base->sig[0]->attributes()->keyhash[0];
373 $encoding = $base->encoding;
377 $signed_data = $data.'.'.base64url_encode($type).'.'.base64url_encode($encoding).'.'.base64url_encode($alg);
381 $data = base64url_decode($data);
385 $inner_decrypted = $data;
387 // Decode the encrypted blob
388 $inner_encrypted = base64_decode($data);
389 $inner_decrypted = self::aes_decrypt($inner_aes_key, $inner_iv, $inner_encrypted);
393 logger('Could not retrieve author URI.');
394 http_status_exit(400);
396 // Once we have the author URI, go to the web and try to find their public key
397 // (first this will look it up locally if it is in the fcontact cache)
398 // This will also convert diaspora public key from pkcs#1 to pkcs#8
400 logger('Fetching key for '.$author_link);
401 $key = self::key($author_link);
404 logger('Could not retrieve author key.');
405 http_status_exit(400);
408 $verify = rsa_verify($signed_data, $signature, $key);
411 logger('Message did not verify. Discarding.');
412 http_status_exit(400);
415 logger('Message verified.');
417 return array('message' => (string)$inner_decrypted,
418 'author' => unxmlify($author_link),
419 'key' => (string)$key);
424 * @brief Dispatches public messages and find the fitting receivers
426 * @param array $msg The post that will be dispatched
428 * @return int The message id of the generated message, "true" or "false" if there was an error
430 public static function dispatch_public($msg)
432 $enabled = intval(Config::get("system", "diaspora_enabled"));
434 logger("diaspora is disabled");
438 if (!($postdata = self::valid_posting($msg))) {
439 logger("Invalid posting");
443 $fields = $postdata['fields'];
445 // Is it a an action (comment, like, ...) for our own post?
446 if (isset($fields->parent_guid) && !$postdata["relayed"]) {
447 $guid = notags(unxmlify($fields->parent_guid));
448 $importer = self::importer_for_guid($guid);
449 if (is_array($importer)) {
450 logger("delivering to origin: ".$importer["name"]);
451 $message_id = self::dispatch($importer, $msg, $fields);
456 // Process item retractions. This has to be done separated from the other stuff,
457 // since retractions for comments could come even from non followers.
458 if (!empty($fields) && in_array($fields->getName(), array('retraction'))) {
459 $target = notags(unxmlify($fields->target_type));
460 if (in_array($target, array("Comment", "Like", "Post", "Reshare", "StatusMessage"))) {
461 logger('processing retraction for '.$target, LOGGER_DEBUG);
462 $importer = array("uid" => 0, "page-flags" => PAGE_FREELOVE);
463 $message_id = self::dispatch($importer, $msg, $fields);
468 // Now distribute it to the followers
470 "SELECT `user`.* FROM `user` WHERE `user`.`uid` IN
471 (SELECT `contact`.`uid` FROM `contact` WHERE `contact`.`network` = '%s' AND `contact`.`addr` = '%s')
472 AND NOT `account_expired` AND NOT `account_removed`",
473 dbesc(NETWORK_DIASPORA),
474 dbesc($msg["author"])
477 if (DBM::is_result($r)) {
478 foreach ($r as $rr) {
479 logger("delivering to: ".$rr["username"]);
480 self::dispatch($rr, $msg, $fields);
482 } elseif (!Config::get('system', 'relay_subscribe', false)) {
483 logger("Unwanted message from ".$msg["author"]." send by ".$_SERVER["REMOTE_ADDR"]." with ".$_SERVER["HTTP_USER_AGENT"].": ".print_r($msg, true), LOGGER_DEBUG);
485 // Use a dummy importer to import the data for the public copy
486 $importer = array("uid" => 0, "page-flags" => PAGE_FREELOVE);
487 $message_id = self::dispatch($importer, $msg, $fields);
494 * @brief Dispatches the different message types to the different functions
496 * @param array $importer Array of the importer user
497 * @param array $msg The post that will be dispatched
498 * @param object $fields SimpleXML object that contains the message
500 * @return int The message id of the generated message, "true" or "false" if there was an error
502 public static function dispatch($importer, $msg, $fields = null)
504 // The sender is the handle of the contact that sent the message.
505 // This will often be different with relayed messages (for example "like" and "comment")
506 $sender = $msg["author"];
508 // This is only needed for private postings since this is already done for public ones before
509 if (is_null($fields)) {
510 if (!($postdata = self::valid_posting($msg))) {
511 logger("Invalid posting");
514 $fields = $postdata['fields'];
517 $type = $fields->getName();
519 logger("Received message type ".$type." from ".$sender." for user ".$importer["uid"], LOGGER_DEBUG);
522 case "account_migration":
523 return self::receiveAccountMigration($importer, $fields);
525 case "account_deletion":
526 return self::receive_account_deletion($importer, $fields);
529 return self::receive_comment($importer, $sender, $fields, $msg["message"]);
532 return self::receive_contact_request($importer, $fields);
535 return self::receive_conversation($importer, $msg, $fields);
538 return self::receive_like($importer, $sender, $fields);
541 return self::receive_message($importer, $fields);
543 case "participation": // Not implemented
544 return self::receive_participation($importer, $fields);
546 case "photo": // Not implemented
547 return self::receive_photo($importer, $fields);
549 case "poll_participation": // Not implemented
550 return self::receive_poll_participation($importer, $fields);
553 return self::receive_profile($importer, $fields);
556 return self::receive_reshare($importer, $fields, $msg["message"]);
559 return self::receive_retraction($importer, $sender, $fields);
561 case "status_message":
562 return self::receive_status_message($importer, $fields, $msg["message"]);
565 logger("Unknown message type ".$type);
573 * @brief Checks if a posting is valid and fetches the data fields.
575 * This function does not only check the signature.
576 * It also does the conversion between the old and the new diaspora format.
578 * @param array $msg Array with the XML, the sender handle and the sender signature
580 * @return bool|array If the posting is valid then an array with an SimpleXML object is returned
582 private static function valid_posting($msg)
584 $data = parse_xml_string($msg["message"]);
586 if (!is_object($data)) {
587 logger("No valid XML ".$msg["message"], LOGGER_DEBUG);
591 $first_child = $data->getName();
593 // Is this the new or the old version?
594 if ($data->getName() == "XML") {
596 foreach ($data->post->children() as $child) {
604 $type = $element->getName();
607 logger("Got message type ".$type.": ".$msg["message"], LOGGER_DATA);
609 // All retractions are handled identically from now on.
610 // In the new version there will only be "retraction".
611 if (in_array($type, array("signed_retraction", "relayable_retraction")))
612 $type = "retraction";
614 if ($type == "request") {
618 $fields = new SimpleXMLElement("<".$type."/>");
622 foreach ($element->children() as $fieldname => $entry) {
624 // Translation for the old XML structure
625 if ($fieldname == "diaspora_handle") {
626 $fieldname = "author";
628 if ($fieldname == "participant_handles") {
629 $fieldname = "participants";
631 if (in_array($type, array("like", "participation"))) {
632 if ($fieldname == "target_type") {
633 $fieldname = "parent_type";
636 if ($fieldname == "sender_handle") {
637 $fieldname = "author";
639 if ($fieldname == "recipient_handle") {
640 $fieldname = "recipient";
642 if ($fieldname == "root_diaspora_id") {
643 $fieldname = "root_author";
645 if ($type == "status_message") {
646 if ($fieldname == "raw_message") {
650 if ($type == "retraction") {
651 if ($fieldname == "post_guid") {
652 $fieldname = "target_guid";
654 if ($fieldname == "type") {
655 $fieldname = "target_type";
660 if (($fieldname == "author_signature") && ($entry != "")) {
661 $author_signature = base64_decode($entry);
662 } elseif (($fieldname == "parent_author_signature") && ($entry != "")) {
663 $parent_author_signature = base64_decode($entry);
664 } elseif (!in_array($fieldname, array("author_signature", "parent_author_signature", "target_author_signature"))) {
665 if ($signed_data != "") {
667 $signed_data_parent .= ";";
670 $signed_data .= $entry;
672 if (!in_array($fieldname, array("parent_author_signature", "target_author_signature"))
673 || ($orig_type == "relayable_retraction")
675 xml::copy($entry, $fields, $fieldname);
679 // This is something that shouldn't happen at all.
680 if (in_array($type, array("status_message", "reshare", "profile"))) {
681 if ($msg["author"] != $fields->author) {
682 logger("Message handle is not the same as envelope sender. Quitting this message.");
687 // Only some message types have signatures. So we quit here for the other types.
688 if (!in_array($type, array("comment", "like"))) {
689 return array("fields" => $fields, "relayed" => false);
691 // No author_signature? This is a must, so we quit.
692 if (!isset($author_signature)) {
693 logger("No author signature for type ".$type." - Message: ".$msg["message"], LOGGER_DEBUG);
697 if (isset($parent_author_signature)) {
700 $key = self::key($msg["author"]);
702 if (!rsa_verify($signed_data, $parent_author_signature, $key, "sha256")) {
703 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);
710 $key = self::key($fields->author);
712 if (!rsa_verify($signed_data, $author_signature, $key, "sha256")) {
713 logger("No valid author signature for author ".$fields->author. " in type ".$type." - signed data: ".$signed_data." - Message: ".$msg["message"]." - Signature ".$author_signature, LOGGER_DEBUG);
716 return array("fields" => $fields, "relayed" => $relayed);
721 * @brief Fetches the public key for a given handle
723 * @param string $handle The handle
725 * @return string The public key
727 private static function key($handle)
729 $handle = strval($handle);
731 logger("Fetching diaspora key for: ".$handle);
733 $r = self::person_by_handle($handle);
742 * @brief Fetches data for a given handle
744 * @param string $handle The handle
746 * @return array the queried data
748 public static function person_by_handle($handle)
751 "SELECT * FROM `fcontact` WHERE `network` = '%s' AND `addr` = '%s' LIMIT 1",
752 dbesc(NETWORK_DIASPORA),
757 logger("In cache " . print_r($r, true), LOGGER_DEBUG);
759 // update record occasionally so it doesn't get stale
760 $d = strtotime($person["updated"]." +00:00");
761 if ($d < strtotime("now - 14 days")) {
765 if ($person["guid"] == "") {
770 if (!$person || $update) {
771 logger("create or refresh", LOGGER_DEBUG);
772 $r = Probe::uri($handle, NETWORK_DIASPORA);
774 // Note that Friendica contacts will return a "Diaspora person"
775 // if Diaspora connectivity is enabled on their server
776 if ($r && ($r["network"] === NETWORK_DIASPORA)) {
777 self::add_fcontact($r, $update);
785 * @brief Updates the fcontact table
787 * @param array $arr The fcontact data
788 * @param bool $update Update or insert?
790 * @return string The id of the fcontact entry
792 private static function add_fcontact($arr, $update = false)
796 "UPDATE `fcontact` SET
810 WHERE `url` = '%s' AND `network` = '%s'",
812 dbesc($arr["photo"]),
813 dbesc($arr["request"]),
815 dbesc(strtolower($arr["addr"])),
817 dbesc($arr["batch"]),
818 dbesc($arr["notify"]),
820 dbesc($arr["confirm"]),
821 dbesc($arr["alias"]),
822 dbesc($arr["pubkey"]),
823 dbesc(datetime_convert()),
825 dbesc($arr["network"])
829 "INSERT INTO `fcontact` (`url`,`name`,`photo`,`request`,`nick`,`addr`, `guid`,
830 `batch`, `notify`,`poll`,`confirm`,`network`,`alias`,`pubkey`,`updated`)
831 VALUES ('%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s')",
834 dbesc($arr["photo"]),
835 dbesc($arr["request"]),
839 dbesc($arr["batch"]),
840 dbesc($arr["notify"]),
842 dbesc($arr["confirm"]),
843 dbesc($arr["network"]),
844 dbesc($arr["alias"]),
845 dbesc($arr["pubkey"]),
846 dbesc(datetime_convert())
854 * @brief get a handle (user@domain.tld) from a given contact id or gcontact id
856 * @param int $contact_id The id in the contact table
857 * @param int $gcontact_id The id in the gcontact table
859 * @return string the handle
861 public static function handle_from_contact($contact_id, $gcontact_id = 0)
865 logger("contact id is ".$contact_id." - gcontact id is ".$gcontact_id, LOGGER_DEBUG);
867 if ($gcontact_id != 0) {
869 "SELECT `addr` FROM `gcontact` WHERE `id` = %d AND `addr` != ''",
873 if (DBM::is_result($r)) {
874 return strtolower($r[0]["addr"]);
879 "SELECT `network`, `addr`, `self`, `url`, `nick` FROM `contact` WHERE `id` = %d",
883 if (DBM::is_result($r)) {
886 logger("contact 'self' = ".$contact['self']." 'url' = ".$contact['url'], LOGGER_DEBUG);
888 if ($contact['addr'] != "") {
889 $handle = $contact['addr'];
891 $baseurl_start = strpos($contact['url'], '://') + 3;
892 // allows installations in a subdirectory--not sure how Diaspora will handle
893 $baseurl_length = strpos($contact['url'], '/profile') - $baseurl_start;
894 $baseurl = substr($contact['url'], $baseurl_start, $baseurl_length);
895 $handle = $contact['nick'].'@'.$baseurl;
899 return strtolower($handle);
903 * @brief get a url (scheme://domain.tld/u/user) from a given Diaspora*
906 * @param mixed $fcontact_guid Hexadecimal string guid
908 * @return string the contact url or null
910 public static function url_from_contact_guid($fcontact_guid)
912 logger("fcontact guid is ".$fcontact_guid, LOGGER_DEBUG);
915 "SELECT `url` FROM `fcontact` WHERE `url` != '' AND `network` = '%s' AND `guid` = '%s'",
916 dbesc(NETWORK_DIASPORA),
917 dbesc($fcontact_guid)
920 if (DBM::is_result($r)) {
928 * @brief Get a contact id for a given handle
930 * @param int $uid The user id
931 * @param string $handle The handle in the format user@domain.tld
933 * @return The contact id
935 private static function contact_by_handle($uid, $handle)
937 // First do a direct search on the contact table
939 "SELECT * FROM `contact` WHERE `uid` = %d AND `addr` = '%s' LIMIT 1",
944 if (DBM::is_result($r)) {
948 * We haven't found it?
949 * We use another function for it that will possibly create a contact entry.
951 $cid = get_contact($handle, $uid);
954 /// @TODO Contact retrieval should be encapsulated into an "entity" class like `Contact`
955 $r = q("SELECT * FROM `contact` WHERE `id` = %d LIMIT 1", intval($cid));
957 if (DBM::is_result($r)) {
963 $handle_parts = explode("@", $handle);
964 $nurl_sql = "%%://".$handle_parts[1]."%%/profile/".$handle_parts[0];
966 "SELECT * FROM `contact` WHERE `network` = '%s' AND `uid` = %d AND `nurl` LIKE '%s' LIMIT 1",
971 if (DBM::is_result($r)) {
975 logger("Haven't found contact for user ".$uid." and handle ".$handle, LOGGER_DEBUG);
980 * @brief Check if posting is allowed for this contact
982 * @param array $importer Array of the importer user
983 * @param array $contact The contact that is checked
984 * @param bool $is_comment Is the check for a comment?
986 * @return bool is the contact allowed to post?
988 private static function post_allow($importer, $contact, $is_comment = false) {
991 * Perhaps we were already sharing with this person. Now they're sharing with us.
992 * That makes us friends.
993 * Normally this should have handled by getting a request - but this could get lost
995 if ($contact["rel"] == CONTACT_IS_FOLLOWER && in_array($importer["page-flags"], array(PAGE_FREELOVE))) {
998 array('rel' => CONTACT_IS_FRIEND, 'writable' => true),
999 array('id' => $contact["id"], 'uid' => $contact["uid"])
1002 $contact["rel"] = CONTACT_IS_FRIEND;
1003 logger("defining user ".$contact["nick"]." as friend");
1006 // We don't seem to like that person
1007 if ($contact["blocked"] || $contact["readonly"] || $contact["archive"]) {
1008 // Maybe blocked, don't accept.
1010 // We are following this person?
1011 } elseif (($contact["rel"] == CONTACT_IS_SHARING) || ($contact["rel"] == CONTACT_IS_FRIEND)) {
1012 // Yes, then it is fine.
1014 // Is it a post to a community?
1015 } elseif (($contact["rel"] == CONTACT_IS_FOLLOWER) && ($importer["page-flags"] == PAGE_COMMUNITY)) {
1018 // Is the message a global user or a comment?
1019 } elseif (($importer["uid"] == 0) || $is_comment) {
1020 // Messages for the global users and comments are always accepted
1028 * @brief Fetches the contact id for a handle and checks if posting is allowed
1030 * @param array $importer Array of the importer user
1031 * @param string $handle The checked handle in the format user@domain.tld
1032 * @param bool $is_comment Is the check for a comment?
1034 * @return array The contact data
1036 private static function allowed_contact_by_handle($importer, $handle, $is_comment = false)
1038 $contact = self::contact_by_handle($importer["uid"], $handle);
1040 logger("A Contact for handle ".$handle." and user ".$importer["uid"]." was not found");
1041 // If a contact isn't found, we accept it anyway if it is a comment
1049 if (!self::post_allow($importer, $contact, $is_comment)) {
1050 logger("The handle: ".$handle." is not allowed to post to user ".$importer["uid"]);
1057 * @brief Does the message already exists on the system?
1059 * @param int $uid The user id
1060 * @param string $guid The guid of the message
1062 * @return int|bool message id if the message already was stored into the system - or false.
1064 private static function message_exists($uid, $guid)
1067 "SELECT `id` FROM `item` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1072 if (DBM::is_result($r)) {
1073 logger("message ".$guid." already exists for user ".$uid);
1081 * @brief Checks for links to posts in a message
1083 * @param array $item The item array
1085 private static function fetch_guid($item)
1087 $expression = "=diaspora://.*?/post/([0-9A-Za-z\-_@.:]{15,254}[0-9A-Za-z])=ism";
1088 preg_replace_callback(
1090 function ($match) use ($item) {
1091 return self::fetch_guid_sub($match, $item);
1096 preg_replace_callback(
1097 "&\[url=/posts/([^\[\]]*)\](.*)\[\/url\]&Usi",
1098 function ($match) use ($item) {
1099 return self::fetch_guid_sub($match, $item);
1106 * @brief Checks for relative /people/* links in an item body to match local
1107 * contacts or prepends the remote host taken from the author link.
1109 * @param string $body The item body to replace links from
1110 * @param string $author_link The author link for missing local contact fallback
1112 * @return the replaced string
1114 public static function replace_people_guid($body, $author_link)
1116 $return = preg_replace_callback(
1117 "&\[url=/people/([^\[\]]*)\](.*)\[\/url\]&Usi",
1118 function ($match) use ($author_link) {
1120 // 0 => '[url=/people/0123456789abcdef]Foo Bar[/url]'
1121 // 1 => '0123456789abcdef'
1123 $handle = self::url_from_contact_guid($match[1]);
1126 $return = '@[url='.$handle.']'.$match[2].'[/url]';
1128 // No local match, restoring absolute remote URL from author scheme and host
1129 $author_url = parse_url($author_link);
1130 $return = '[url='.$author_url['scheme'].'://'.$author_url['host'].'/people/'.$match[1].']'.$match[2].'[/url]';
1142 * @brief sub function of "fetch_guid" which checks for links in messages
1144 * @param array $match array containing a link that has to be checked for a message link
1145 * @param array $item The item array
1147 private static function fetch_guid_sub($match, $item)
1149 if (!self::store_by_guid($match[1], $item["author-link"])) {
1150 self::store_by_guid($match[1], $item["owner-link"]);
1155 * @brief Fetches an item with a given guid from a given server
1157 * @param string $guid the message guid
1158 * @param string $server The server address
1159 * @param int $uid The user id of the user
1161 * @return int the message id of the stored message or false
1163 private static function store_by_guid($guid, $server, $uid = 0)
1165 $serverparts = parse_url($server);
1166 $server = $serverparts["scheme"]."://".$serverparts["host"];
1168 logger("Trying to fetch item ".$guid." from ".$server, LOGGER_DEBUG);
1170 $msg = self::message($guid, $server);
1176 logger("Successfully fetched item ".$guid." from ".$server, LOGGER_DEBUG);
1178 // Now call the dispatcher
1179 return self::dispatch_public($msg);
1183 * @brief Fetches a message from a server
1185 * @param string $guid message guid
1186 * @param string $server The url of the server
1187 * @param int $level Endless loop prevention
1190 * 'message' => The message XML
1191 * 'author' => The author handle
1192 * 'key' => The public key of the author
1194 private static function message($guid, $server, $level = 0)
1200 // This will work for new Diaspora servers and Friendica servers from 3.5
1201 $source_url = $server."/fetch/post/".urlencode($guid);
1203 logger("Fetch post from ".$source_url, LOGGER_DEBUG);
1205 $envelope = fetch_url($source_url);
1207 logger("Envelope was fetched.", LOGGER_DEBUG);
1208 $x = self::verify_magic_envelope($envelope);
1210 logger("Envelope could not be verified.", LOGGER_DEBUG);
1212 logger("Envelope was verified.", LOGGER_DEBUG);
1218 // This will work for older Diaspora and Friendica servers
1220 $source_url = $server."/p/".urlencode($guid).".xml";
1221 logger("Fetch post from ".$source_url, LOGGER_DEBUG);
1223 $x = fetch_url($source_url);
1229 $source_xml = parse_xml_string($x);
1231 if (!is_object($source_xml)) {
1235 if ($source_xml->post->reshare) {
1236 // Reshare of a reshare - old Diaspora version
1237 logger("Message is a reshare", LOGGER_DEBUG);
1238 return self::message($source_xml->post->reshare->root_guid, $server, ++$level);
1239 } elseif ($source_xml->getName() == "reshare") {
1240 // Reshare of a reshare - new Diaspora version
1241 logger("Message is a new reshare", LOGGER_DEBUG);
1242 return self::message($source_xml->root_guid, $server, ++$level);
1247 // Fetch the author - for the old and the new Diaspora version
1248 if ($source_xml->post->status_message->diaspora_handle) {
1249 $author = (string)$source_xml->post->status_message->diaspora_handle;
1250 } elseif ($source_xml->author && ($source_xml->getName() == "status_message")) {
1251 $author = (string)$source_xml->author;
1254 // If this isn't a "status_message" then quit
1256 logger("Message doesn't seem to be a status message", LOGGER_DEBUG);
1260 $msg = array("message" => $x, "author" => $author);
1262 $msg["key"] = self::key($msg["author"]);
1268 * @brief Fetches the item record of a given guid
1270 * @param int $uid The user id
1271 * @param string $guid message guid
1272 * @param string $author The handle of the item
1273 * @param array $contact The contact of the item owner
1275 * @return array the item record
1277 private static function parent_item($uid, $guid, $author, $contact)
1280 "SELECT `id`, `parent`, `body`, `wall`, `uri`, `guid`, `private`, `origin`,
1281 `author-name`, `author-link`, `author-avatar`,
1282 `owner-name`, `owner-link`, `owner-avatar`
1283 FROM `item` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1289 $result = self::store_by_guid($guid, $contact["url"], $uid);
1292 $person = self::person_by_handle($author);
1293 $result = self::store_by_guid($guid, $person["url"], $uid);
1297 logger("Fetched missing item ".$guid." - result: ".$result, LOGGER_DEBUG);
1300 "SELECT `id`, `body`, `wall`, `uri`, `private`, `origin`,
1301 `author-name`, `author-link`, `author-avatar`,
1302 `owner-name`, `owner-link`, `owner-avatar`
1303 FROM `item` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1311 logger("parent item not found: parent: ".$guid." - user: ".$uid);
1314 logger("parent item found: parent: ".$guid." - user: ".$uid);
1320 * @brief returns contact details
1322 * @param array $contact The default contact if the person isn't found
1323 * @param array $person The record of the person
1324 * @param int $uid The user id
1327 * 'cid' => contact id
1328 * 'network' => network type
1330 private static function author_contact_by_url($contact, $person, $uid)
1333 "SELECT `id`, `network`, `url` FROM `contact` WHERE `nurl` = '%s' AND `uid` = %d LIMIT 1",
1334 dbesc(normalise_link($person["url"])),
1339 $network = $r[0]["network"];
1341 // We are receiving content from a user that possibly is about to be terminated
1342 // This means the user is vital, so we remove a possible termination date.
1343 unmark_for_death($r[0]);
1345 $cid = $contact["id"];
1346 $network = NETWORK_DIASPORA;
1349 return array("cid" => $cid, "network" => $network);
1353 * @brief Is the profile a hubzilla profile?
1355 * @param string $url The profile link
1357 * @return bool is it a hubzilla server?
1359 public static function is_redmatrix($url)
1361 return(strstr($url, "/channel/"));
1365 * @brief Generate a post link with a given handle and message guid
1367 * @param string $addr The user handle
1368 * @param string $guid message guid
1369 * @param string $parent_guid optional parent guid
1371 * @return string the post link
1373 private static function plink($addr, $guid, $parent_guid = '')
1375 $r = q("SELECT `url`, `nick`, `network` FROM `fcontact` WHERE `addr`='%s' LIMIT 1", dbesc($addr));
1378 if (!DBM::is_result($r)) {
1379 if ($parent_guid != '') {
1380 return "https://".substr($addr, strpos($addr, "@") + 1) . "/posts/" . $parent_guid . "#" . $guid;
1382 return "https://".substr($addr, strpos($addr, "@") + 1) . "/posts/" . $guid;
1386 // Friendica contacts are often detected as Diaspora contacts in the "fcontact" table
1387 // So we try another way as well.
1388 $s = q("SELECT `network` FROM `gcontact` WHERE `nurl`='%s' LIMIT 1", dbesc(normalise_link($r[0]["url"])));
1389 if (DBM::is_result($s)) {
1390 $r[0]["network"] = $s[0]["network"];
1393 if ($r[0]["network"] == NETWORK_DFRN) {
1394 return str_replace("/profile/".$r[0]["nick"]."/", "/display/".$guid, $r[0]["url"]."/");
1397 if (self::is_redmatrix($r[0]["url"])) {
1398 return $r[0]["url"]."/?f=&mid=".$guid;
1401 if ($parent_guid != '') {
1402 return "https://".substr($addr, strpos($addr, "@") + 1) . "/posts/" . $parent_guid . "#" . $guid;
1404 return "https://".substr($addr, strpos($addr, "@") + 1) . "/posts/" . $guid;
1409 * @brief Receives account migration
1411 * @param array $importer Array of the importer user
1412 * @param object $data The message object
1414 * @return bool Success
1416 private static function receiveAccountMigration($importer, $data)
1418 $old_handle = notags(unxmlify($data->author));
1419 $new_handle = notags(unxmlify($data->profile->author));
1420 $signature = notags(unxmlify($data->signature));
1422 $contact = self::contact_by_handle($importer["uid"], $old_handle);
1424 logger("cannot find contact for sender: ".$old_handle." and user ".$importer["uid"]);
1428 logger("Got migration for ".$old_handle.", to ".$new_handle." with user ".$importer["uid"]);
1431 $signed_text = 'AccountMigration:'.$old_handle.':'.$new_handle;
1432 $key = self::key($old_handle);
1433 if (!rsa_verify($signed_text, $signature, $key, "sha256")) {
1434 logger('No valid signature for migration.');
1438 // Update the profile
1439 self::receive_profile($importer, $data->profile);
1441 // change the technical stuff in contact and gcontact
1442 $data = Probe::uri($new_handle);
1443 if ($data['network'] == NETWORK_PHANTOM) {
1444 logger('Account for '.$new_handle." couldn't be probed.");
1448 $fields = array('url' => $data['url'], 'nurl' => normalise_link($data['url']),
1449 'name' => $data['name'], 'nick' => $data['nick'],
1450 'addr' => $data['addr'], 'batch' => $data['batch'],
1451 'notify' => $data['notify'], 'poll' => $data['poll'],
1452 'network' => $data['network']);
1454 dba::update('contact', $fields, array('addr' => $old_handle));
1456 $fields = array('url' => $data['url'], 'nurl' => normalise_link($data['url']),
1457 'name' => $data['name'], 'nick' => $data['nick'],
1458 'addr' => $data['addr'], 'connect' => $data['addr'],
1459 'notify' => $data['notify'], 'photo' => $data['photo'],
1460 'server_url' => $data['baseurl'], 'network' => $data['network']);
1462 dba::update('gcontact', $fields, array('addr' => $old_handle));
1464 logger('Contacts are updated.');
1467 /// @todo This is an extreme performance killer
1469 'owner-link' => array($contact["url"], $data["url"]),
1470 'author-link' => array($contact["url"], $data["url"]),
1472 foreach ($fields as $n => $f) {
1474 "SELECT `id` FROM `item` WHERE `%s` = '%s' AND `uid` = %d LIMIT 1",
1477 intval($importer["uid"])
1480 if (DBM::is_result($r)) {
1482 "UPDATE `item` SET `%s` = '%s' WHERE `%s` = '%s' AND `uid` = %d",
1487 intval($importer["uid"])
1496 logger('Items are updated.');
1502 * @brief Processes an account deletion
1504 * @param array $importer Array of the importer user
1505 * @param object $data The message object
1507 * @return bool Success
1509 private static function receive_account_deletion($importer, $data)
1511 /// @todo Account deletion should remove the contact from the global contacts as well
1513 $author = notags(unxmlify($data->author));
1515 $contact = self::contact_by_handle($importer["uid"], $author);
1517 logger("cannot find contact for author: ".$author);
1521 // We now remove the contact
1522 contact_remove($contact["id"]);
1527 * @brief Fetch the uri from our database if we already have this item (maybe from ourselves)
1529 * @param string $author Author handle
1530 * @param string $guid Message guid
1531 * @param boolean $onlyfound Only return uri when found in the database
1533 * @return string The constructed uri or the one from our database
1535 private static function get_uri_from_guid($author, $guid, $onlyfound = false)
1537 $r = q("SELECT `uri` FROM `item` WHERE `guid` = '%s' LIMIT 1", dbesc($guid));
1538 if (DBM::is_result($r)) {
1539 return $r[0]["uri"];
1540 } elseif (!$onlyfound) {
1541 return $author.":".$guid;
1548 * @brief Fetch the guid from our database with a given uri
1550 * @param string $uri Message uri
1551 * @param string $uid Author handle
1553 * @return string The post guid
1555 private static function get_guid_from_uri($uri, $uid)
1557 $r = q("SELECT `guid` FROM `item` WHERE `uri` = '%s' AND `uid` = %d LIMIT 1", dbesc($uri), intval($uid));
1558 if (DBM::is_result($r)) {
1559 return $r[0]["guid"];
1566 * @brief Find the best importer for a comment, like, ...
1568 * @param string $guid The guid of the item
1570 * @return array|boolean the origin owner of that post - or false
1572 private static function importer_for_guid($guid)
1574 $item = dba::fetch_first("SELECT `uid` FROM `item` WHERE `origin` AND `guid` = ? LIMIT 1", $guid);
1576 if (DBM::is_result($item)) {
1577 logger("Found user ".$item['uid']." as owner of item ".$guid, LOGGER_DEBUG);
1578 $contact = dba::fetch_first("SELECT * FROM `contact` WHERE `self` AND `uid` = ?", $item['uid']);
1579 if (DBM::is_result($contact)) {
1587 * @brief Processes an incoming comment
1589 * @param array $importer Array of the importer user
1590 * @param string $sender The sender of the message
1591 * @param object $data The message object
1592 * @param string $xml The original XML of the message
1594 * @return int The message id of the generated comment or "false" if there was an error
1596 private static function receive_comment($importer, $sender, $data, $xml)
1598 $author = notags(unxmlify($data->author));
1599 $guid = notags(unxmlify($data->guid));
1600 $parent_guid = notags(unxmlify($data->parent_guid));
1601 $text = unxmlify($data->text);
1603 if (isset($data->created_at)) {
1604 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
1606 $created_at = datetime_convert();
1609 if (isset($data->thread_parent_guid)) {
1610 $thread_parent_guid = notags(unxmlify($data->thread_parent_guid));
1611 $thr_uri = self::get_uri_from_guid("", $thread_parent_guid, true);
1616 $contact = self::allowed_contact_by_handle($importer, $sender, true);
1621 $message_id = self::message_exists($importer["uid"], $guid);
1626 $parent_item = self::parent_item($importer["uid"], $parent_guid, $author, $contact);
1627 if (!$parent_item) {
1631 $person = self::person_by_handle($author);
1632 if (!is_array($person)) {
1633 logger("unable to find author details");
1637 // Fetch the contact id - if we know this contact
1638 $author_contact = self::author_contact_by_url($contact, $person, $importer["uid"]);
1640 $datarray = array();
1642 $datarray["uid"] = $importer["uid"];
1643 $datarray["contact-id"] = $author_contact["cid"];
1644 $datarray["network"] = $author_contact["network"];
1646 $datarray["author-name"] = $person["name"];
1647 $datarray["author-link"] = $person["url"];
1648 $datarray["author-avatar"] = ((x($person, "thumb")) ? $person["thumb"] : $person["photo"]);
1650 $datarray["owner-name"] = $contact["name"];
1651 $datarray["owner-link"] = $contact["url"];
1652 $datarray["owner-avatar"] = ((x($contact, "thumb")) ? $contact["thumb"] : $contact["photo"]);
1654 $datarray["guid"] = $guid;
1655 $datarray["uri"] = self::get_uri_from_guid($author, $guid);
1657 $datarray["type"] = "remote-comment";
1658 $datarray["verb"] = ACTIVITY_POST;
1659 $datarray["gravity"] = GRAVITY_COMMENT;
1661 if ($thr_uri != "") {
1662 $datarray["parent-uri"] = $thr_uri;
1664 $datarray["parent-uri"] = $parent_item["uri"];
1667 $datarray["object-type"] = ACTIVITY_OBJ_COMMENT;
1669 $datarray["protocol"] = PROTOCOL_DIASPORA;
1670 $datarray["source"] = $xml;
1672 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
1674 $datarray["plink"] = self::plink($author, $guid, $parent_item['guid']);
1676 $body = diaspora2bb($text);
1678 $datarray["body"] = self::replace_people_guid($body, $person["url"]);
1680 self::fetch_guid($datarray);
1682 $message_id = item_store($datarray);
1684 if ($message_id <= 0) {
1689 logger("Stored comment ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
1692 // If we are the origin of the parent we store the original data and notify our followers
1693 if ($message_id && $parent_item["origin"]) {
1694 // Formerly we stored the signed text, the signature and the author in different fields.
1695 // We now store the raw data so that we are more flexible.
1696 dba::insert('sign', array('iid' => $message_id, 'signed_text' => json_encode($data)));
1699 Worker::add(PRIORITY_HIGH, "notifier", "comment-import", $message_id);
1706 * @brief processes and stores private messages
1708 * @param array $importer Array of the importer user
1709 * @param array $contact The contact of the message
1710 * @param object $data The message object
1711 * @param array $msg Array of the processed message, author handle and key
1712 * @param object $mesg The private message
1713 * @param array $conversation The conversation record to which this message belongs
1715 * @return bool "true" if it was successful
1717 private static function receive_conversation_message($importer, $contact, $data, $msg, $mesg, $conversation)
1719 $author = notags(unxmlify($data->author));
1720 $guid = notags(unxmlify($data->guid));
1721 $subject = notags(unxmlify($data->subject));
1723 // "diaspora_handle" is the element name from the old version
1724 // "author" is the element name from the new version
1725 if ($mesg->author) {
1726 $msg_author = notags(unxmlify($mesg->author));
1727 } elseif ($mesg->diaspora_handle) {
1728 $msg_author = notags(unxmlify($mesg->diaspora_handle));
1733 $msg_guid = notags(unxmlify($mesg->guid));
1734 $msg_conversation_guid = notags(unxmlify($mesg->conversation_guid));
1735 $msg_text = unxmlify($mesg->text);
1736 $msg_created_at = datetime_convert("UTC", "UTC", notags(unxmlify($mesg->created_at)));
1738 if ($msg_conversation_guid != $guid) {
1739 logger("message conversation guid does not belong to the current conversation.");
1743 $body = diaspora2bb($msg_text);
1744 $message_uri = $msg_author.":".$msg_guid;
1746 $person = self::person_by_handle($msg_author);
1751 "SELECT `id` FROM `mail` WHERE `guid` = '%s' AND `uid` = %d LIMIT 1",
1753 intval($importer["uid"])
1755 if (DBM::is_result($r)) {
1756 logger("duplicate message already delivered.", LOGGER_DEBUG);
1761 "INSERT INTO `mail` (`uid`, `guid`, `convid`, `from-name`,`from-photo`,`from-url`,`contact-id`,`title`,`body`,`seen`,`reply`,`uri`,`parent-uri`,`created`)
1762 VALUES (%d, '%s', %d, '%s', '%s', '%s', %d, '%s', '%s', %d, %d, '%s','%s','%s')",
1763 intval($importer["uid"]),
1765 intval($conversation["id"]),
1766 dbesc($person["name"]),
1767 dbesc($person["photo"]),
1768 dbesc($person["url"]),
1769 intval($contact["id"]),
1774 dbesc($message_uri),
1775 dbesc($author.":".$guid),
1776 dbesc($msg_created_at)
1781 dba::update('conv', array('updated' => datetime_convert()), array('id' => $conversation["id"]));
1785 "type" => NOTIFY_MAIL,
1786 "notify_flags" => $importer["notify-flags"],
1787 "language" => $importer["language"],
1788 "to_name" => $importer["username"],
1789 "to_email" => $importer["email"],
1790 "uid" =>$importer["uid"],
1791 "item" => array("subject" => $subject, "body" => $body),
1792 "source_name" => $person["name"],
1793 "source_link" => $person["url"],
1794 "source_photo" => $person["thumb"],
1795 "verb" => ACTIVITY_POST,
1802 * @brief Processes new private messages (answers to private messages are processed elsewhere)
1804 * @param array $importer Array of the importer user
1805 * @param array $msg Array of the processed message, author handle and key
1806 * @param object $data The message object
1808 * @return bool Success
1810 private static function receive_conversation($importer, $msg, $data)
1812 $author = notags(unxmlify($data->author));
1813 $guid = notags(unxmlify($data->guid));
1814 $subject = notags(unxmlify($data->subject));
1815 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
1816 $participants = notags(unxmlify($data->participants));
1818 $messages = $data->message;
1820 if (!count($messages)) {
1821 logger("empty conversation");
1825 $contact = self::allowed_contact_by_handle($importer, $msg["author"], true);
1830 $conversation = null;
1833 "SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1834 intval($importer["uid"]),
1838 $conversation = $c[0];
1841 "INSERT INTO `conv` (`uid`, `guid`, `creator`, `created`, `updated`, `subject`, `recips`)
1842 VALUES (%d, '%s', '%s', '%s', '%s', '%s', '%s')",
1843 intval($importer["uid"]),
1847 dbesc(datetime_convert()),
1849 dbesc($participants)
1853 "SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1854 intval($importer["uid"]),
1860 $conversation = $c[0];
1863 if (!$conversation) {
1864 logger("unable to create conversation.");
1868 foreach ($messages as $mesg) {
1869 self::receive_conversation_message($importer, $contact, $data, $msg, $mesg, $conversation);
1876 * @brief Creates the body for a "like" message
1878 * @param array $contact The contact that send us the "like"
1879 * @param array $parent_item The item array of the parent item
1880 * @param string $guid message guid
1882 * @return string the body
1884 private static function construct_like_body($contact, $parent_item, $guid) {
1885 $bodyverb = t('%1$s likes %2$s\'s %3$s');
1887 $ulink = "[url=".$contact["url"]."]".$contact["name"]."[/url]";
1888 $alink = "[url=".$parent_item["author-link"]."]".$parent_item["author-name"]."[/url]";
1889 $plink = "[url=".System::baseUrl()."/display/".urlencode($guid)."]".t("status")."[/url]";
1891 return sprintf($bodyverb, $ulink, $alink, $plink);
1895 * @brief Creates a XML object for a "like"
1897 * @param array $importer Array of the importer user
1898 * @param array $parent_item The item array of the parent item
1900 * @return string The XML
1902 private static function construct_like_object($importer, $parent_item)
1904 $objtype = ACTIVITY_OBJ_NOTE;
1905 $link = '<link rel="alternate" type="text/html" href="'.System::baseUrl()."/display/".$importer["nickname"]."/".$parent_item["id"].'" />';
1906 $parent_body = $parent_item["body"];
1908 $xmldata = array("object" => array("type" => $objtype,
1910 "id" => $parent_item["uri"],
1913 "content" => $parent_body));
1915 return xml::from_array($xmldata, $xml, true);
1919 * @brief Processes "like" messages
1921 * @param array $importer Array of the importer user
1922 * @param string $sender The sender of the message
1923 * @param object $data The message object
1925 * @return int The message id of the generated like or "false" if there was an error
1927 private static function receive_like($importer, $sender, $data)
1929 $author = notags(unxmlify($data->author));
1930 $guid = notags(unxmlify($data->guid));
1931 $parent_guid = notags(unxmlify($data->parent_guid));
1932 $parent_type = notags(unxmlify($data->parent_type));
1933 $positive = notags(unxmlify($data->positive));
1935 // likes on comments aren't supported by Diaspora - only on posts
1936 // But maybe this will be supported in the future, so we will accept it.
1937 if (!in_array($parent_type, array("Post", "Comment"))) {
1941 $contact = self::allowed_contact_by_handle($importer, $sender, true);
1946 $message_id = self::message_exists($importer["uid"], $guid);
1951 $parent_item = self::parent_item($importer["uid"], $parent_guid, $author, $contact);
1952 if (!$parent_item) {
1956 $person = self::person_by_handle($author);
1957 if (!is_array($person)) {
1958 logger("unable to find author details");
1962 // Fetch the contact id - if we know this contact
1963 $author_contact = self::author_contact_by_url($contact, $person, $importer["uid"]);
1965 // "positive" = "false" would be a Dislike - wich isn't currently supported by Diaspora
1966 // We would accept this anyhow.
1967 if ($positive == "true") {
1968 $verb = ACTIVITY_LIKE;
1970 $verb = ACTIVITY_DISLIKE;
1973 $datarray = array();
1975 $datarray["protocol"] = PROTOCOL_DIASPORA;
1977 $datarray["uid"] = $importer["uid"];
1978 $datarray["contact-id"] = $author_contact["cid"];
1979 $datarray["network"] = $author_contact["network"];
1981 $datarray["author-name"] = $person["name"];
1982 $datarray["author-link"] = $person["url"];
1983 $datarray["author-avatar"] = ((x($person, "thumb")) ? $person["thumb"] : $person["photo"]);
1985 $datarray["owner-name"] = $contact["name"];
1986 $datarray["owner-link"] = $contact["url"];
1987 $datarray["owner-avatar"] = ((x($contact, "thumb")) ? $contact["thumb"] : $contact["photo"]);
1989 $datarray["guid"] = $guid;
1990 $datarray["uri"] = self::get_uri_from_guid($author, $guid);
1992 $datarray["type"] = "activity";
1993 $datarray["verb"] = $verb;
1994 $datarray["gravity"] = GRAVITY_LIKE;
1995 $datarray["parent-uri"] = $parent_item["uri"];
1997 $datarray["object-type"] = ACTIVITY_OBJ_NOTE;
1998 $datarray["object"] = self::construct_like_object($importer, $parent_item);
2000 $datarray["body"] = self::construct_like_body($contact, $parent_item, $guid);
2002 $message_id = item_store($datarray);
2004 if ($message_id <= 0) {
2009 logger("Stored like ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
2012 // like on comments have the comment as parent. So we need to fetch the toplevel parent
2013 if ($parent_item["id"] != $parent_item["parent"]) {
2014 $toplevel = dba::select('item', array('origin'), array('id' => $parent_item["parent"]), array('limit' => 1));
2015 $origin = $toplevel["origin"];
2017 $origin = $parent_item["origin"];
2020 // If we are the origin of the parent we store the original data and notify our followers
2021 if ($message_id && $origin) {
2022 // Formerly we stored the signed text, the signature and the author in different fields.
2023 // We now store the raw data so that we are more flexible.
2024 dba::insert('sign', array('iid' => $message_id, 'signed_text' => json_encode($data)));
2027 Worker::add(PRIORITY_HIGH, "notifier", "comment-import", $message_id);
2034 * @brief Processes private messages
2036 * @param array $importer Array of the importer user
2037 * @param object $data The message object
2039 * @return bool Success?
2041 private static function receive_message($importer, $data)
2043 $author = notags(unxmlify($data->author));
2044 $guid = notags(unxmlify($data->guid));
2045 $conversation_guid = notags(unxmlify($data->conversation_guid));
2046 $text = unxmlify($data->text);
2047 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
2049 $contact = self::allowed_contact_by_handle($importer, $author, true);
2054 $conversation = null;
2057 "SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
2058 intval($importer["uid"]),
2059 dbesc($conversation_guid)
2062 $conversation = $c[0];
2064 logger("conversation not available.");
2068 $message_uri = $author.":".$guid;
2070 $person = self::person_by_handle($author);
2072 logger("unable to find author details");
2076 $body = diaspora2bb($text);
2078 $body = self::replace_people_guid($body, $person["url"]);
2083 "SELECT `id` FROM `mail` WHERE `guid` = '%s' AND `uid` = %d LIMIT 1",
2085 intval($importer["uid"])
2087 if (DBM::is_result($r)) {
2088 logger("duplicate message already delivered.", LOGGER_DEBUG);
2093 "INSERT INTO `mail` (`uid`, `guid`, `convid`, `from-name`,`from-photo`,`from-url`,`contact-id`,`title`,`body`,`seen`,`reply`,`uri`,`parent-uri`,`created`)
2094 VALUES ( %d, '%s', %d, '%s', '%s', '%s', %d, '%s', '%s', %d, %d, '%s','%s','%s')",
2095 intval($importer["uid"]),
2097 intval($conversation["id"]),
2098 dbesc($person["name"]),
2099 dbesc($person["photo"]),
2100 dbesc($person["url"]),
2101 intval($contact["id"]),
2102 dbesc($conversation["subject"]),
2106 dbesc($message_uri),
2107 dbesc($author.":".$conversation["guid"]),
2113 dba::update('conv', array('updated' => datetime_convert()), array('id' => $conversation["id"]));
2118 * @brief Processes participations - unsupported by now
2120 * @param array $importer Array of the importer user
2121 * @param object $data The message object
2123 * @return bool always true
2125 private static function receive_participation($importer, $data)
2127 // I'm not sure if we can fully support this message type
2132 * @brief Processes photos - unneeded
2134 * @param array $importer Array of the importer user
2135 * @param object $data The message object
2137 * @return bool always true
2139 private static function receive_photo($importer, $data)
2141 // There doesn't seem to be a reason for this function,
2142 // since the photo data is transmitted in the status message as well
2147 * @brief Processes poll participations - unssupported
2149 * @param array $importer Array of the importer user
2150 * @param object $data The message object
2152 * @return bool always true
2154 private static function receive_poll_participation($importer, $data)
2156 // We don't support polls by now
2161 * @brief Processes incoming profile updates
2163 * @param array $importer Array of the importer user
2164 * @param object $data The message object
2166 * @return bool Success
2168 private static function receive_profile($importer, $data)
2170 $author = strtolower(notags(unxmlify($data->author)));
2172 $contact = self::contact_by_handle($importer["uid"], $author);
2177 $name = unxmlify($data->first_name).((strlen($data->last_name)) ? " ".unxmlify($data->last_name) : "");
2178 $image_url = unxmlify($data->image_url);
2179 $birthday = unxmlify($data->birthday);
2180 $gender = unxmlify($data->gender);
2181 $about = diaspora2bb(unxmlify($data->bio));
2182 $location = diaspora2bb(unxmlify($data->location));
2183 $searchable = (unxmlify($data->searchable) == "true");
2184 $nsfw = (unxmlify($data->nsfw) == "true");
2185 $tags = unxmlify($data->tag_string);
2187 $tags = explode("#", $tags);
2189 $keywords = array();
2190 foreach ($tags as $tag) {
2191 $tag = trim(strtolower($tag));
2197 $keywords = implode(", ", $keywords);
2199 $handle_parts = explode("@", $author);
2200 $nick = $handle_parts[0];
2203 $name = $handle_parts[0];
2206 if (preg_match("|^https?://|", $image_url) === 0) {
2207 $image_url = "http://".$handle_parts[1].$image_url;
2210 update_contact_avatar($image_url, $importer["uid"], $contact["id"]);
2212 // Generic birthday. We don't know the timezone. The year is irrelevant.
2214 $birthday = str_replace("1000", "1901", $birthday);
2216 if ($birthday != "") {
2217 $birthday = datetime_convert("UTC", "UTC", $birthday, "Y-m-d");
2220 // this is to prevent multiple birthday notifications in a single year
2221 // if we already have a stored birthday and the 'm-d' part hasn't changed, preserve the entry, which will preserve the notify year
2223 if (substr($birthday, 5) === substr($contact["bd"], 5)) {
2224 $birthday = $contact["bd"];
2228 "UPDATE `contact` SET `name` = '%s', `nick` = '%s', `addr` = '%s', `name-date` = '%s', `bd` = '%s',
2229 `location` = '%s', `about` = '%s', `keywords` = '%s', `gender` = '%s' WHERE `id` = %d AND `uid` = %d",
2233 dbesc(datetime_convert()),
2239 intval($contact["id"]),
2240 intval($importer["uid"])
2243 $gcontact = array("url" => $contact["url"], "network" => NETWORK_DIASPORA, "generation" => 2,
2244 "photo" => $image_url, "name" => $name, "location" => $location,
2245 "about" => $about, "birthday" => $birthday, "gender" => $gender,
2246 "addr" => $author, "nick" => $nick, "keywords" => $keywords,
2247 "hide" => !$searchable, "nsfw" => $nsfw);
2249 $gcid = update_gcontact($gcontact);
2251 link_gcontact($gcid, $importer["uid"], $contact["id"]);
2253 logger("Profile of contact ".$contact["id"]." stored for user ".$importer["uid"], LOGGER_DEBUG);
2259 * @brief Processes incoming friend requests
2261 * @param array $importer Array of the importer user
2262 * @param array $contact The contact that send the request
2264 private static function receive_request_make_friend($importer, $contact)
2268 if ($contact["rel"] == CONTACT_IS_SHARING) {
2271 array('rel' => CONTACT_IS_FRIEND, 'writable' => true),
2272 array('id' => $contact["id"], 'uid' => $importer["uid"])
2275 // send notification
2278 "SELECT `hide-friends` FROM `profile` WHERE `uid` = %d AND `is-default` = 1 LIMIT 1",
2279 intval($importer["uid"])
2282 if ($r && !$r[0]["hide-friends"] && !$contact["hidden"] && intval(PConfig::get($importer["uid"], "system", "post_newfriend"))) {
2285 "SELECT * FROM `contact` WHERE `self` AND `uid` = %d LIMIT 1",
2286 intval($importer["uid"])
2289 // they are not CONTACT_IS_FOLLOWER anymore but that's what we have in the array
2291 if ($self && $contact["rel"] == CONTACT_IS_FOLLOWER) {
2293 $arr["protocol"] = PROTOCOL_DIASPORA;
2294 $arr["uri"] = $arr["parent-uri"] = item_new_uri($a->get_hostname(), $importer["uid"]);
2295 $arr["uid"] = $importer["uid"];
2296 $arr["contact-id"] = $self[0]["id"];
2298 $arr["type"] = 'wall';
2299 $arr["gravity"] = 0;
2301 $arr["author-name"] = $arr["owner-name"] = $self[0]["name"];
2302 $arr["author-link"] = $arr["owner-link"] = $self[0]["url"];
2303 $arr["author-avatar"] = $arr["owner-avatar"] = $self[0]["thumb"];
2304 $arr["verb"] = ACTIVITY_FRIEND;
2305 $arr["object-type"] = ACTIVITY_OBJ_PERSON;
2307 $A = "[url=".$self[0]["url"]."]".$self[0]["name"]."[/url]";
2308 $B = "[url=".$contact["url"]."]".$contact["name"]."[/url]";
2309 $BPhoto = "[url=".$contact["url"]."][img]".$contact["thumb"]."[/img][/url]";
2310 $arr["body"] = sprintf(t("%1$s is now friends with %2$s"), $A, $B)."\n\n\n".$Bphoto;
2312 $arr["object"] = self::construct_new_friend_object($contact);
2314 $arr["last-child"] = 1;
2316 $arr["allow_cid"] = $user[0]["allow_cid"];
2317 $arr["allow_gid"] = $user[0]["allow_gid"];
2318 $arr["deny_cid"] = $user[0]["deny_cid"];
2319 $arr["deny_gid"] = $user[0]["deny_gid"];
2321 $i = item_store($arr);
2323 Worker::add(PRIORITY_HIGH, "notifier", "activity", $i);
2330 * @brief Creates a XML object for a "new friend" message
2332 * @param array $contact Array of the contact
2334 * @return string The XML
2336 private static function construct_new_friend_object($contact)
2338 $objtype = ACTIVITY_OBJ_PERSON;
2339 $link = '<link rel="alternate" type="text/html" href="'.$contact["url"].'" />'."\n".
2340 '<link rel="photo" type="image/jpeg" href="'.$contact["thumb"].'" />'."\n";
2342 $xmldata = array("object" => array("type" => $objtype,
2343 "title" => $contact["name"],
2344 "id" => $contact["url"]."/".$contact["name"],
2347 return xml::from_array($xmldata, $xml, true);
2351 * @brief Processes incoming sharing notification
2353 * @param array $importer Array of the importer user
2354 * @param object $data The message object
2356 * @return bool Success
2358 private static function receive_contact_request($importer, $data)
2360 $author = unxmlify($data->author);
2361 $recipient = unxmlify($data->recipient);
2363 if (!$author || !$recipient) {
2367 // the current protocol version doesn't know these fields
2368 // That means that we will assume their existance
2369 if (isset($data->following)) {
2370 $following = (unxmlify($data->following) == "true");
2375 if (isset($data->sharing)) {
2376 $sharing = (unxmlify($data->sharing) == "true");
2381 $contact = self::contact_by_handle($importer["uid"], $author);
2383 // perhaps we were already sharing with this person. Now they're sharing with us.
2384 // That makes us friends.
2387 logger("Author ".$author." (Contact ".$contact["id"].") wants to follow us.", LOGGER_DEBUG);
2388 self::receive_request_make_friend($importer, $contact);
2390 // refetch the contact array
2391 $contact = self::contact_by_handle($importer["uid"], $author);
2393 // If we are now friends, we are sending a share message.
2394 // Normally we needn't to do so, but the first message could have been vanished.
2395 if (in_array($contact["rel"], array(CONTACT_IS_FRIEND))) {
2396 $u = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval($importer["uid"]));
2398 logger("Sending share message to author ".$author." - Contact: ".$contact["id"]." - User: ".$importer["uid"], LOGGER_DEBUG);
2399 $ret = self::send_share($u[0], $contact);
2404 logger("Author ".$author." doesn't want to follow us anymore.", LOGGER_DEBUG);
2405 lose_follower($importer, $contact);
2410 if (!$following && $sharing && in_array($importer["page-flags"], array(PAGE_SOAPBOX, PAGE_NORMAL))) {
2411 logger("Author ".$author." wants to share with us - but doesn't want to listen. Request is ignored.", LOGGER_DEBUG);
2413 } elseif (!$following && !$sharing) {
2414 logger("Author ".$author." doesn't want anything - and we don't know the author. Request is ignored.", LOGGER_DEBUG);
2416 } elseif (!$following && $sharing) {
2417 logger("Author ".$author." wants to share with us.", LOGGER_DEBUG);
2418 } elseif ($following && $sharing) {
2419 logger("Author ".$author." wants to have a bidirectional conection.", LOGGER_DEBUG);
2420 } elseif ($following && !$sharing) {
2421 logger("Author ".$author." wants to listen to us.", LOGGER_DEBUG);
2424 $ret = self::person_by_handle($author);
2426 if (!$ret || ($ret["network"] != NETWORK_DIASPORA)) {
2427 logger("Cannot resolve diaspora handle ".$author." for ".$recipient);
2431 $batch = (($ret["batch"]) ? $ret["batch"] : implode("/", array_slice(explode("/", $ret["url"]), 0, 3))."/receive/public");
2434 "INSERT INTO `contact` (`uid`, `network`,`addr`,`created`,`url`,`nurl`,`batch`,`name`,`nick`,`photo`,`pubkey`,`notify`,`poll`,`blocked`,`priority`)
2435 VALUES (%d, '%s', '%s', '%s', '%s','%s','%s','%s','%s','%s','%s','%s','%s',%d,%d)",
2436 intval($importer["uid"]),
2437 dbesc($ret["network"]),
2438 dbesc($ret["addr"]),
2441 dbesc(normalise_link($ret["url"])),
2443 dbesc($ret["name"]),
2444 dbesc($ret["nick"]),
2445 dbesc($ret["photo"]),
2446 dbesc($ret["pubkey"]),
2447 dbesc($ret["notify"]),
2448 dbesc($ret["poll"]),
2453 // find the contact record we just created
2455 $contact_record = self::contact_by_handle($importer["uid"], $author);
2457 if (!$contact_record) {
2458 logger("unable to locate newly created contact record.");
2462 logger("Author ".$author." was added as contact number ".$contact_record["id"].".", LOGGER_DEBUG);
2464 $def_gid = get_default_group($importer['uid'], $ret["network"]);
2466 if (intval($def_gid)) {
2467 group_add_member($importer["uid"], "", $contact_record["id"], $def_gid);
2470 update_contact_avatar($ret["photo"], $importer['uid'], $contact_record["id"], true);
2472 if ($importer["page-flags"] == PAGE_NORMAL) {
2473 logger("Sending intra message for author ".$author.".", LOGGER_DEBUG);
2475 $hash = random_string().(string)time(); // Generate a confirm_key
2478 "INSERT INTO `intro` (`uid`, `contact-id`, `blocked`, `knowyou`, `note`, `hash`, `datetime`)
2479 VALUES (%d, %d, %d, %d, '%s', '%s', '%s')",
2480 intval($importer["uid"]),
2481 intval($contact_record["id"]),
2484 dbesc(t("Sharing notification from Diaspora network")),
2486 dbesc(datetime_convert())
2489 // automatic friend approval
2491 logger("Does an automatic friend approval for author ".$author.".", LOGGER_DEBUG);
2493 update_contact_avatar($contact_record["photo"], $importer["uid"], $contact_record["id"]);
2495 // technically they are sharing with us (CONTACT_IS_SHARING),
2496 // but if our page-type is PAGE_COMMUNITY or PAGE_SOAPBOX
2497 // we are going to change the relationship and make them a follower.
2499 if (($importer["page-flags"] == PAGE_FREELOVE) && $sharing && $following) {
2500 $new_relation = CONTACT_IS_FRIEND;
2501 } elseif (($importer["page-flags"] == PAGE_FREELOVE) && $sharing) {
2502 $new_relation = CONTACT_IS_SHARING;
2504 $new_relation = CONTACT_IS_FOLLOWER;
2508 "UPDATE `contact` SET `rel` = %d,
2516 intval($new_relation),
2517 dbesc(datetime_convert()),
2518 dbesc(datetime_convert()),
2519 intval($contact_record["id"])
2522 $u = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval($importer["uid"]));
2524 logger("Sending share message (Relation: ".$new_relation.") to author ".$author." - Contact: ".$contact_record["id"]." - User: ".$importer["uid"], LOGGER_DEBUG);
2525 $ret = self::send_share($u[0], $contact_record);
2527 // Send the profile data, maybe it weren't transmitted before
2528 self::send_profile($importer["uid"], array($contact_record));
2536 * @brief Fetches a message with a given guid
2538 * @param string $guid message guid
2539 * @param string $orig_author handle of the original post
2540 * @param string $author handle of the sharer
2542 * @return array The fetched item
2544 private static function original_item($guid, $orig_author, $author)
2546 // Do we already have this item?
2548 "SELECT `body`, `tag`, `app`, `created`, `object-type`, `uri`, `guid`,
2549 `author-name`, `author-link`, `author-avatar`
2550 FROM `item` WHERE `guid` = '%s' AND `visible` AND NOT `deleted` AND `body` != '' LIMIT 1",
2554 if (DBM::is_result($r)) {
2555 logger("reshared message ".$guid." already exists on system.");
2557 // Maybe it is already a reshared item?
2558 // Then refetch the content, if it is a reshare from a reshare.
2559 // If it is a reshared post from another network then reformat to avoid display problems with two share elements
2560 if (self::is_reshare($r[0]["body"], true)) {
2562 } elseif (self::is_reshare($r[0]["body"], false) || strstr($r[0]["body"], "[share")) {
2563 $r[0]["body"] = diaspora2bb(bb2diaspora($r[0]["body"]));
2565 $r[0]["body"] = self::replace_people_guid($r[0]["body"], $r[0]["author-link"]);
2567 // Add OEmbed and other information to the body
2568 $r[0]["body"] = add_page_info_to_body($r[0]["body"], false, true);
2576 if (!DBM::is_result($r)) {
2577 $server = "https://".substr($orig_author, strpos($orig_author, "@") + 1);
2578 logger("1st try: reshared message ".$guid." will be fetched via SSL from the server ".$server);
2579 $item_id = self::store_by_guid($guid, $server);
2582 $server = "http://".substr($orig_author, strpos($orig_author, "@") + 1);
2583 logger("2nd try: reshared message ".$guid." will be fetched without SLL from the server ".$server);
2584 $item_id = self::store_by_guid($guid, $server);
2589 "SELECT `body`, `tag`, `app`, `created`, `object-type`, `uri`, `guid`,
2590 `author-name`, `author-link`, `author-avatar`
2591 FROM `item` WHERE `id` = %d AND `visible` AND NOT `deleted` AND `body` != '' LIMIT 1",
2595 if (DBM::is_result($r)) {
2596 // If it is a reshared post from another network then reformat to avoid display problems with two share elements
2597 if (self::is_reshare($r[0]["body"], false)) {
2598 $r[0]["body"] = diaspora2bb(bb2diaspora($r[0]["body"]));
2599 $r[0]["body"] = self::replace_people_guid($r[0]["body"], $r[0]["author-link"]);
2610 * @brief Processes a reshare message
2612 * @param array $importer Array of the importer user
2613 * @param object $data The message object
2614 * @param string $xml The original XML of the message
2616 * @return int the message id
2618 private static function receive_reshare($importer, $data, $xml)
2620 $author = notags(unxmlify($data->author));
2621 $guid = notags(unxmlify($data->guid));
2622 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
2623 $root_author = notags(unxmlify($data->root_author));
2624 $root_guid = notags(unxmlify($data->root_guid));
2625 /// @todo handle unprocessed property "provider_display_name"
2626 $public = notags(unxmlify($data->public));
2628 $contact = self::allowed_contact_by_handle($importer, $author, false);
2633 $message_id = self::message_exists($importer["uid"], $guid);
2638 $original_item = self::original_item($root_guid, $root_author, $author);
2639 if (!$original_item) {
2643 $orig_url = System::baseUrl()."/display/".$original_item["guid"];
2645 $datarray = array();
2647 $datarray["uid"] = $importer["uid"];
2648 $datarray["contact-id"] = $contact["id"];
2649 $datarray["network"] = NETWORK_DIASPORA;
2651 $datarray["author-name"] = $contact["name"];
2652 $datarray["author-link"] = $contact["url"];
2653 $datarray["author-avatar"] = ((x($contact, "thumb")) ? $contact["thumb"] : $contact["photo"]);
2655 $datarray["owner-name"] = $datarray["author-name"];
2656 $datarray["owner-link"] = $datarray["author-link"];
2657 $datarray["owner-avatar"] = $datarray["author-avatar"];
2659 $datarray["guid"] = $guid;
2660 $datarray["uri"] = $datarray["parent-uri"] = self::get_uri_from_guid($author, $guid);
2662 $datarray["verb"] = ACTIVITY_POST;
2663 $datarray["gravity"] = GRAVITY_PARENT;
2665 $datarray["protocol"] = PROTOCOL_DIASPORA;
2666 $datarray["source"] = $xml;
2668 $prefix = share_header(
2669 $original_item["author-name"],
2670 $original_item["author-link"],
2671 $original_item["author-avatar"],
2672 $original_item["guid"],
2673 $original_item["created"],
2676 $datarray["body"] = $prefix.$original_item["body"]."[/share]";
2678 $datarray["tag"] = $original_item["tag"];
2679 $datarray["app"] = $original_item["app"];
2681 $datarray["plink"] = self::plink($author, $guid);
2682 $datarray["private"] = (($public == "false") ? 1 : 0);
2683 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
2685 $datarray["object-type"] = $original_item["object-type"];
2687 self::fetch_guid($datarray);
2688 $message_id = item_store($datarray);
2691 logger("Stored reshare ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
2699 * @brief Processes retractions
2701 * @param array $importer Array of the importer user
2702 * @param array $contact The contact of the item owner
2703 * @param object $data The message object
2705 * @return bool success
2707 private static function item_retraction($importer, $contact, $data)
2709 $author = notags(unxmlify($data->author));
2710 $target_guid = notags(unxmlify($data->target_guid));
2711 $target_type = notags(unxmlify($data->target_type));
2713 $person = self::person_by_handle($author);
2714 if (!is_array($person)) {
2715 logger("unable to find author detail for ".$author);
2719 if (empty($contact["url"])) {
2720 $contact["url"] = $person["url"];
2723 // Fetch items that are about to be deleted
2724 $fields = array('uid', 'id', 'parent', 'parent-uri', 'author-link');
2726 // When we receive a public retraction, we delete every item that we find.
2727 if ($importer['uid'] == 0) {
2728 $condition = array("`guid` = ? AND NOT `file` LIKE '%%[%%' AND NOT `deleted`", $target_guid);
2730 $condition = array("`guid` = ? AND `uid` = ? AND NOT `file` LIKE '%%[%%' AND NOT `deleted`", $target_guid, $importer['uid']);
2732 $r = dba::select('item', $fields, $condition);
2733 if (!DBM::is_result($r)) {
2734 logger("Target guid ".$target_guid." was not found on this system for user ".$importer['uid'].".");
2738 while ($item = dba::fetch($r)) {
2739 // Fetch the parent item
2740 $parent = dba::select('item', array('author-link', 'origin'), array('id' => $item["parent"]), array('limit' => 1));
2742 // Only delete it if the parent author really fits
2743 if (!link_compare($parent["author-link"], $contact["url"]) && !link_compare($item["author-link"], $contact["url"])) {
2744 logger("Thread author ".$parent["author-link"]." and item author ".$item["author-link"]." don't fit to expected contact ".$contact["url"], LOGGER_DEBUG);
2748 // Currently we don't have a central deletion function that we could use in this case.
2749 // The function "item_drop" doesn't work for that case
2756 'edited' => datetime_convert(),
2757 'changed' => datetime_convert()),
2758 array('id' => $item["id"])
2761 // Delete the thread - if it is a starting post and not a comment
2762 if ($target_type != 'Comment') {
2763 delete_thread($item["id"], $item["parent-uri"]);
2766 logger("Deleted target ".$target_guid." (".$item["id"].") from user ".$item["uid"]." parent: ".$item["parent"], LOGGER_DEBUG);
2768 // Now check if the retraction needs to be relayed by us
2769 if ($parent["origin"]) {
2771 Worker::add(PRIORITY_HIGH, "notifier", "drop", $item["id"]);
2779 * @brief Receives retraction messages
2781 * @param array $importer Array of the importer user
2782 * @param string $sender The sender of the message
2783 * @param object $data The message object
2785 * @return bool Success
2787 private static function receive_retraction($importer, $sender, $data)
2789 $target_type = notags(unxmlify($data->target_type));
2791 $contact = self::contact_by_handle($importer["uid"], $sender);
2792 if (!$contact && (in_array($target_type, array("Contact", "Person")))) {
2793 logger("cannot find contact for sender: ".$sender." and user ".$importer["uid"]);
2797 logger("Got retraction for ".$target_type.", sender ".$sender." and user ".$importer["uid"], LOGGER_DEBUG);
2799 switch ($target_type) {
2804 case "StatusMessage":
2805 return self::item_retraction($importer, $contact, $data);
2809 /// @todo What should we do with an "unshare"?
2810 // Removing the contact isn't correct since we still can read the public items
2811 contact_remove($contact["id"]);
2815 logger("Unknown target type ".$target_type);
2822 * @brief Receives status messages
2824 * @param array $importer Array of the importer user
2825 * @param object $data The message object
2826 * @param string $xml The original XML of the message
2828 * @return int The message id of the newly created item
2830 private static function receive_status_message($importer, $data, $xml)
2832 $author = notags(unxmlify($data->author));
2833 $guid = notags(unxmlify($data->guid));
2834 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
2835 $public = notags(unxmlify($data->public));
2836 $text = unxmlify($data->text);
2837 $provider_display_name = notags(unxmlify($data->provider_display_name));
2839 $contact = self::allowed_contact_by_handle($importer, $author, false);
2844 $message_id = self::message_exists($importer["uid"], $guid);
2850 if ($data->location) {
2851 foreach ($data->location->children() as $fieldname => $data) {
2852 $address[$fieldname] = notags(unxmlify($data));
2856 $body = diaspora2bb($text);
2858 $datarray = array();
2860 // Attach embedded pictures to the body
2862 foreach ($data->photo as $photo) {
2863 $body = "[img]".unxmlify($photo->remote_photo_path).
2864 unxmlify($photo->remote_photo_name)."[/img]\n".$body;
2867 $datarray["object-type"] = ACTIVITY_OBJ_IMAGE;
2869 $datarray["object-type"] = ACTIVITY_OBJ_NOTE;
2871 // Add OEmbed and other information to the body
2872 if (!self::is_redmatrix($contact["url"])) {
2873 $body = add_page_info_to_body($body, false, true);
2877 /// @todo enable support for polls
2878 //if ($data->poll) {
2879 // foreach ($data->poll AS $poll)
2884 /// @todo enable support for events
2886 $datarray["uid"] = $importer["uid"];
2887 $datarray["contact-id"] = $contact["id"];
2888 $datarray["network"] = NETWORK_DIASPORA;
2890 $datarray["author-name"] = $contact["name"];
2891 $datarray["author-link"] = $contact["url"];
2892 $datarray["author-avatar"] = ((x($contact, "thumb")) ? $contact["thumb"] : $contact["photo"]);
2894 $datarray["owner-name"] = $datarray["author-name"];
2895 $datarray["owner-link"] = $datarray["author-link"];
2896 $datarray["owner-avatar"] = $datarray["author-avatar"];
2898 $datarray["guid"] = $guid;
2899 $datarray["uri"] = $datarray["parent-uri"] = self::get_uri_from_guid($author, $guid);
2901 $datarray["verb"] = ACTIVITY_POST;
2902 $datarray["gravity"] = GRAVITY_PARENT;
2904 $datarray["protocol"] = PROTOCOL_DIASPORA;
2905 $datarray["source"] = $xml;
2907 $datarray["body"] = self::replace_people_guid($body, $contact["url"]);
2909 if ($provider_display_name != "") {
2910 $datarray["app"] = $provider_display_name;
2913 $datarray["plink"] = self::plink($author, $guid);
2914 $datarray["private"] = (($public == "false") ? 1 : 0);
2915 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
2917 if (isset($address["address"])) {
2918 $datarray["location"] = $address["address"];
2921 if (isset($address["lat"]) && isset($address["lng"])) {
2922 $datarray["coord"] = $address["lat"]." ".$address["lng"];
2925 self::fetch_guid($datarray);
2926 $message_id = item_store($datarray);
2929 logger("Stored item ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
2936 /* ************************************************************************************** *
2937 * Here are all the functions that are needed to transmit data with the Diaspora protocol *
2938 * ************************************************************************************** */
2941 * @brief returnes the handle of a contact
2943 * @param array $contact contact array
2945 * @return string the handle in the format user@domain.tld
2947 private static function my_handle($contact)
2949 if ($contact["addr"] != "") {
2950 return $contact["addr"];
2953 // Normally we should have a filled "addr" field - but in the past this wasn't the case
2954 // So - just in case - we build the the address here.
2955 if ($contact["nickname"] != "") {
2956 $nick = $contact["nickname"];
2958 $nick = $contact["nick"];
2961 return $nick."@".substr(System::baseUrl(), strpos(System::baseUrl(), "://") + 3);
2966 * @brief Creates the data for a private message in the new format
2968 * @param string $msg The message that is to be transmitted
2969 * @param array $user The record of the sender
2970 * @param array $contact Target of the communication
2971 * @param string $prvkey The private key of the sender
2972 * @param string $pubkey The public key of the receiver
2974 * @return string The encrypted data
2976 public static function encode_private_data($msg, $user, $contact, $prvkey, $pubkey)
2978 logger("Message: ".$msg, LOGGER_DATA);
2980 // without a public key nothing will work
2982 logger("pubkey missing: contact id: ".$contact["id"]);
2986 $aes_key = openssl_random_pseudo_bytes(32);
2987 $b_aes_key = base64_encode($aes_key);
2988 $iv = openssl_random_pseudo_bytes(16);
2989 $b_iv = base64_encode($iv);
2991 $ciphertext = self::aes_encrypt($aes_key, $iv, $msg);
2993 $json = json_encode(array("iv" => $b_iv, "key" => $b_aes_key));
2995 $encrypted_key_bundle = "";
2996 openssl_public_encrypt($json, $encrypted_key_bundle, $pubkey);
2998 $json_object = json_encode(
2999 array("aes_key" => base64_encode($encrypted_key_bundle),
3000 "encrypted_magic_envelope" => base64_encode($ciphertext))
3003 return $json_object;
3007 * @brief Creates the envelope for the "fetch" endpoint and for the new format
3009 * @param string $msg The message that is to be transmitted
3010 * @param array $user The record of the sender
3012 * @return string The envelope
3014 public static function build_magic_envelope($msg, $user)
3016 $b64url_data = base64url_encode($msg);
3017 $data = str_replace(array("\n", "\r", " ", "\t"), array("", "", "", ""), $b64url_data);
3019 $key_id = base64url_encode(self::my_handle($user));
3020 $type = "application/xml";
3021 $encoding = "base64url";
3022 $alg = "RSA-SHA256";
3023 $signable_data = $data.".".base64url_encode($type).".".base64url_encode($encoding).".".base64url_encode($alg);
3025 // Fallback if the private key wasn't transmitted in the expected field
3026 if ($user['uprvkey'] == "") {
3027 $user['uprvkey'] = $user['prvkey'];
3030 $signature = rsa_sign($signable_data, $user["uprvkey"]);
3031 $sig = base64url_encode($signature);
3033 $xmldata = array("me:env" => array("me:data" => $data,
3034 "@attributes" => array("type" => $type),
3035 "me:encoding" => $encoding,
3038 "@attributes2" => array("key_id" => $key_id)));
3040 $namespaces = array("me" => "http://salmon-protocol.org/ns/magic-env");
3042 return xml::from_array($xmldata, $xml, false, $namespaces);
3046 * @brief Create the envelope for a message
3048 * @param string $msg The message that is to be transmitted
3049 * @param array $user The record of the sender
3050 * @param array $contact Target of the communication
3051 * @param string $prvkey The private key of the sender
3052 * @param string $pubkey The public key of the receiver
3053 * @param bool $public Is the message public?
3055 * @return string The message that will be transmitted to other servers
3057 private static function build_message($msg, $user, $contact, $prvkey, $pubkey, $public = false)
3059 // The message is put into an envelope with the sender's signature
3060 $envelope = self::build_magic_envelope($msg, $user);
3062 // Private messages are put into a second envelope, encrypted with the receivers public key
3064 $envelope = self::encode_private_data($envelope, $user, $contact, $prvkey, $pubkey);
3071 * @brief Creates a signature for a message
3073 * @param array $owner the array of the owner of the message
3074 * @param array $message The message that is to be signed
3076 * @return string The signature
3078 private static function signature($owner, $message)
3081 unset($sigmsg["author_signature"]);
3082 unset($sigmsg["parent_author_signature"]);
3084 $signed_text = implode(";", $sigmsg);
3086 return base64_encode(rsa_sign($signed_text, $owner["uprvkey"], "sha256"));
3090 * @brief Transmit a message to a target server
3092 * @param array $owner the array of the item owner
3093 * @param array $contact Target of the communication
3094 * @param string $envelope The message that is to be transmitted
3095 * @param bool $public_batch Is it a public post?
3096 * @param bool $queue_run Is the transmission called from the queue?
3097 * @param string $guid message guid
3099 * @return int Result of the transmission
3101 public static function transmit($owner, $contact, $envelope, $public_batch, $queue_run = false, $guid = "")
3105 $enabled = intval(Config::get("system", "diaspora_enabled"));
3110 $logid = random_string(4);
3111 $dest_url = (($public_batch) ? $contact["batch"] : $contact["notify"]);
3113 logger("no url for contact: ".$contact["id"]." batch mode =".$public_batch);
3117 logger("transmit: ".$logid."-".$guid." ".$dest_url);
3119 if (!$queue_run && was_recently_delayed($contact["id"])) {
3122 if (!intval(Config::get("system", "diaspora_test"))) {
3123 $content_type = (($public_batch) ? "application/magic-envelope+xml" : "application/json");
3125 post_url($dest_url."/", $envelope, array("Content-Type: ".$content_type));
3126 $return_code = $a->get_curl_code();
3128 logger("test_mode");
3133 logger("transmit: ".$logid."-".$guid." returns: ".$return_code);
3135 if (!$return_code || (($return_code == 503) && (stristr($a->get_curl_headers(), "retry-after")))) {
3136 logger("queue message");
3139 "SELECT `id` FROM `queue` WHERE `cid` = %d AND `network` = '%s' AND `content` = '%s' AND `batch` = %d LIMIT 1",
3140 intval($contact["id"]),
3141 dbesc(NETWORK_DIASPORA),
3143 intval($public_batch)
3146 logger("add_to_queue ignored - identical item already in queue");
3148 // queue message for redelivery
3149 add_to_queue($contact["id"], NETWORK_DIASPORA, $envelope, $public_batch);
3151 // The message could not be delivered. We mark the contact as "dead"
3152 mark_for_death($contact);
3154 } elseif (($return_code >= 200) && ($return_code <= 299)) {
3155 // We successfully delivered a message, the contact is alive
3156 unmark_for_death($contact);
3159 return(($return_code) ? $return_code : (-1));
3164 * @brief Build the post xml
3166 * @param string $type The message type
3167 * @param array $message The message data
3169 * @return string The post XML
3171 public static function build_post_xml($type, $message)
3173 $data = array($type => $message);
3175 return xml::from_array($data, $xml);
3179 * @brief Builds and transmit messages
3181 * @param array $owner the array of the item owner
3182 * @param array $contact Target of the communication
3183 * @param string $type The message type
3184 * @param array $message The message data
3185 * @param bool $public_batch Is it a public post?
3186 * @param string $guid message guid
3187 * @param bool $spool Should the transmission be spooled or transmitted?
3189 * @return int Result of the transmission
3191 private static function build_and_transmit($owner, $contact, $type, $message, $public_batch = false, $guid = "", $spool = false)
3193 $msg = self::build_post_xml($type, $message);
3195 logger('message: '.$msg, LOGGER_DATA);
3196 logger('send guid '.$guid, LOGGER_DEBUG);
3198 // Fallback if the private key wasn't transmitted in the expected field
3199 if ($owner['uprvkey'] == "") {
3200 $owner['uprvkey'] = $owner['prvkey'];
3203 $envelope = self::build_message($msg, $owner, $contact, $owner['uprvkey'], $contact['pubkey'], $public_batch);
3206 add_to_queue($contact['id'], NETWORK_DIASPORA, $envelope, $public_batch);
3209 $return_code = self::transmit($owner, $contact, $envelope, $public_batch, false, $guid);
3212 logger("guid: ".$item["guid"]." result ".$return_code, LOGGER_DEBUG);
3214 return $return_code;
3218 * @brief sends an account migration
3220 * @param array $owner the array of the item owner
3221 * @param array $contact Target of the communication
3222 * @param int $uid User ID
3224 * @return int The result of the transmission
3226 public static function sendAccountMigration($owner, $contact, $uid)
3228 $old_handle = PConfig::get($uid, 'system', 'previous_addr');
3229 $profile = self::createProfileData($uid);
3231 $signed_text = 'AccountMigration:'.$old_handle.':'.$profile['author'];
3232 $signature = base64_encode(rsa_sign($signed_text, $owner["uprvkey"], "sha256"));
3234 $message = array("author" => $old_handle,
3235 "profile" => $profile,
3236 "signature" => $signature);
3238 logger("Send account migration ".print_r($message, true), LOGGER_DEBUG);
3240 return self::build_and_transmit($owner, $contact, "account_migration", $message);
3244 * @brief Sends a "share" message
3246 * @param array $owner the array of the item owner
3247 * @param array $contact Target of the communication
3249 * @return int The result of the transmission
3251 public static function send_share($owner, $contact)
3254 * @todo support the different possible combinations of "following" and "sharing"
3255 * Currently, Diaspora only interprets the "sharing" field
3257 * Before switching this code productive, we have to check all "send_share" calls if "rel" is set correctly
3261 switch ($contact["rel"]) {
3262 case CONTACT_IS_FRIEND:
3265 case CONTACT_IS_SHARING:
3268 case CONTACT_IS_FOLLOWER:
3274 $message = array("author" => self::my_handle($owner),
3275 "recipient" => $contact["addr"],
3276 "following" => "true",
3277 "sharing" => "true");
3279 logger("Send share ".print_r($message, true), LOGGER_DEBUG);
3281 return self::build_and_transmit($owner, $contact, "contact", $message);
3285 * @brief sends an "unshare"
3287 * @param array $owner the array of the item owner
3288 * @param array $contact Target of the communication
3290 * @return int The result of the transmission
3292 public static function send_unshare($owner, $contact)
3294 $message = array("author" => self::my_handle($owner),
3295 "recipient" => $contact["addr"],
3296 "following" => "false",
3297 "sharing" => "false");
3299 logger("Send unshare ".print_r($message, true), LOGGER_DEBUG);
3301 return self::build_and_transmit($owner, $contact, "contact", $message);
3305 * @brief Checks a message body if it is a reshare
3307 * @param string $body The message body that is to be check
3308 * @param bool $complete Should it be a complete check or a simple check?
3310 * @return array|bool Reshare details or "false" if no reshare
3312 public static function is_reshare($body, $complete = true)
3314 $body = trim($body);
3316 // Skip if it isn't a pure repeated messages
3317 // Does it start with a share?
3318 if ((strpos($body, "[share") > 0) && $complete) {
3322 // Does it end with a share?
3323 if (strlen($body) > (strrpos($body, "[/share]") + 8)) {
3327 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
3328 // Skip if there is no shared message in there
3329 if ($body == $attributes) {
3333 // If we don't do the complete check we quit here
3339 preg_match("/guid='(.*?)'/ism", $attributes, $matches);
3340 if ($matches[1] != "") {
3341 $guid = $matches[1];
3344 preg_match('/guid="(.*?)"/ism', $attributes, $matches);
3345 if ($matches[1] != "") {
3346 $guid = $matches[1];
3351 "SELECT `contact-id` FROM `item` WHERE `guid` = '%s' AND `network` IN ('%s', '%s') LIMIT 1",
3358 $ret["root_handle"] = self::handle_from_contact($r[0]["contact-id"]);
3359 $ret["root_guid"] = $guid;
3365 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
3366 if ($matches[1] != "") {
3367 $profile = $matches[1];
3370 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
3371 if ($matches[1] != "") {
3372 $profile = $matches[1];
3377 $ret["root_handle"] = preg_replace("=https?://(.*)/u/(.*)=ism", "$2@$1", $profile);
3378 if (($ret["root_handle"] == $profile) || ($ret["root_handle"] == "")) {
3383 preg_match("/link='(.*?)'/ism", $attributes, $matches);
3384 if ($matches[1] != "") {
3385 $link = $matches[1];
3388 preg_match('/link="(.*?)"/ism', $attributes, $matches);
3389 if ($matches[1] != "") {
3390 $link = $matches[1];
3393 $ret["root_guid"] = preg_replace("=https?://(.*)/posts/(.*)=ism", "$2", $link);
3394 if (($ret["root_guid"] == $link) || (trim($ret["root_guid"]) == "")) {
3402 * @brief Create an event array
3404 * @param integer $event_id The id of the event
3406 * @return array with event data
3408 private static function build_event($event_id)
3410 $r = q("SELECT `guid`, `uid`, `start`, `finish`, `nofinish`, `summary`, `desc`, `location`, `adjust` FROM `event` WHERE `id` = %d", intval($event_id));
3411 if (!DBM::is_result($r)) {
3417 $eventdata = array();
3419 $r = q("SELECT `timezone` FROM `user` WHERE `uid` = %d", intval($event['uid']));
3420 if (!DBM::is_result($r)) {
3426 $r = q("SELECT `addr`, `nick` FROM `contact` WHERE `uid` = %d AND `self`", intval($event['uid']));
3427 if (!DBM::is_result($r)) {
3433 $eventdata['author'] = self::my_handle($owner);
3435 if ($event['guid']) {
3436 $eventdata['guid'] = $event['guid'];
3439 $mask = 'Y-m-d\TH:i:s\Z';
3441 /// @todo - establish "all day" events in Friendica
3442 $eventdata["all_day"] = "false";
3444 if (!$event['adjust']) {
3445 $eventdata['timezone'] = $user['timezone'];
3447 if ($eventdata['timezone'] == "") {
3448 $eventdata['timezone'] = 'UTC';
3452 if ($event['start']) {
3453 $eventdata['start'] = datetime_convert($eventdata['timezone'], "UTC", $event['start'], $mask);
3455 if ($event['finish'] && !$event['nofinish']) {
3456 $eventdata['end'] = datetime_convert($eventdata['timezone'], "UTC", $event['finish'], $mask);
3458 if ($event['summary']) {
3459 $eventdata['summary'] = html_entity_decode(bb2diaspora($event['summary']));
3461 if ($event['desc']) {
3462 $eventdata['description'] = html_entity_decode(bb2diaspora($event['desc']));
3464 if ($event['location']) {
3465 $location = array();
3466 $location["address"] = html_entity_decode(bb2diaspora($event['location']));
3467 $location["lat"] = 0;
3468 $location["lng"] = 0;
3469 $eventdata['location'] = $location;
3476 * @brief Create a post (status message or reshare)
3478 * @param array $item The item that will be exported
3479 * @param array $owner the array of the item owner
3482 * 'type' -> Message type ("status_message" or "reshare")
3483 * 'message' -> Array of XML elements of the status
3485 public static function build_status($item, $owner)
3487 $cachekey = "diaspora:build_status:".$item['guid'];
3489 $result = Cache::get($cachekey);
3490 if (!is_null($result)) {
3494 $myaddr = self::my_handle($owner);
3496 $public = (($item["private"]) ? "false" : "true");
3498 $created = datetime_convert("UTC", "UTC", $item["created"], 'Y-m-d\TH:i:s\Z');
3500 // Detect a share element and do a reshare
3501 if (!$item['private'] && ($ret = self::is_reshare($item["body"]))) {
3502 $message = array("author" => $myaddr,
3503 "guid" => $item["guid"],
3504 "created_at" => $created,
3505 "root_author" => $ret["root_handle"],
3506 "root_guid" => $ret["root_guid"],
3507 "provider_display_name" => $item["app"],
3508 "public" => $public);
3512 $title = $item["title"];
3513 $body = $item["body"];
3515 // convert to markdown
3516 $body = html_entity_decode(bb2diaspora($body));
3519 if (strlen($title)) {
3520 $body = "## ".html_entity_decode($title)."\n\n".$body;
3523 if ($item["attach"]) {
3524 $cnt = preg_match_all('/href=\"(.*?)\"(.*?)title=\"(.*?)\"/ism', $item["attach"], $matches, PREG_SET_ORDER);
3526 $body .= "\n".t("Attachments:")."\n";
3527 foreach ($matches as $mtch) {
3528 $body .= "[".$mtch[3]."](".$mtch[1].")\n";
3533 $location = array();
3535 if ($item["location"] != "")
3536 $location["address"] = $item["location"];
3538 if ($item["coord"] != "") {
3539 $coord = explode(" ", $item["coord"]);
3540 $location["lat"] = $coord[0];
3541 $location["lng"] = $coord[1];
3544 $message = array("author" => $myaddr,
3545 "guid" => $item["guid"],
3546 "created_at" => $created,
3547 "public" => $public,
3549 "provider_display_name" => $item["app"],
3550 "location" => $location);
3552 // Diaspora rejects messages when they contain a location without "lat" or "lng"
3553 if (!isset($location["lat"]) || !isset($location["lng"])) {
3554 unset($message["location"]);
3557 if ($item['event-id'] > 0) {
3558 $event = self::build_event($item['event-id']);
3559 if (count($event)) {
3560 $message['event'] = $event;
3562 /// @todo Once Diaspora supports it, we will remove the body
3563 // $message['text'] = '';
3567 $type = "status_message";
3570 $msg = array("type" => $type, "message" => $message);
3572 Cache::set($cachekey, $msg, CACHE_QUARTER_HOUR);
3578 * @brief Sends a post
3580 * @param array $item The item that will be exported
3581 * @param array $owner the array of the item owner
3582 * @param array $contact Target of the communication
3583 * @param bool $public_batch Is it a public post?
3585 * @return int The result of the transmission
3587 public static function send_status($item, $owner, $contact, $public_batch = false)
3589 $status = self::build_status($item, $owner);
3591 return self::build_and_transmit($owner, $contact, $status["type"], $status["message"], $public_batch, $item["guid"]);
3595 * @brief Creates a "like" object
3597 * @param array $item The item that will be exported
3598 * @param array $owner the array of the item owner
3600 * @return array The data for a "like"
3602 private static function construct_like($item, $owner)
3605 "SELECT `guid`, `uri`, `parent-uri` FROM `item` WHERE `uri` = '%s' LIMIT 1",
3606 dbesc($item["thr-parent"])
3608 if (!DBM::is_result($p)) {
3614 $target_type = ($parent["uri"] === $parent["parent-uri"] ? "Post" : "Comment");
3615 if ($item['verb'] === ACTIVITY_LIKE) {
3617 } elseif ($item['verb'] === ACTIVITY_DISLIKE) {
3618 $positive = "false";
3621 return(array("author" => self::my_handle($owner),
3622 "guid" => $item["guid"],
3623 "parent_guid" => $parent["guid"],
3624 "parent_type" => $target_type,
3625 "positive" => $positive,
3626 "author_signature" => ""));
3630 * @brief Creates an "EventParticipation" object
3632 * @param array $item The item that will be exported
3633 * @param array $owner the array of the item owner
3635 * @return array The data for an "EventParticipation"
3637 private static function construct_attend($item, $owner) {
3640 "SELECT `guid`, `uri`, `parent-uri` FROM `item` WHERE `uri` = '%s' LIMIT 1",
3641 dbesc($item["thr-parent"])
3643 if (!DBM::is_result($p)) {
3649 switch ($item['verb']) {
3650 case ACTIVITY_ATTEND:
3651 $attend_answer = 'accepted';
3653 case ACTIVITY_ATTENDNO:
3654 $attend_answer = 'declined';
3656 case ACTIVITY_ATTENDMAYBE:
3657 $attend_answer = 'tentative';
3660 logger('Unknown verb '.$item['verb'].' in item '.$item['guid']);
3664 return(array("author" => self::my_handle($owner),
3665 "guid" => $item["guid"],
3666 "parent_guid" => $parent["guid"],
3667 "status" => $attend_answer,
3668 "author_signature" => ""));
3672 * @brief Creates the object for a comment
3674 * @param array $item The item that will be exported
3675 * @param array $owner the array of the item owner
3677 * @return array The data for a comment
3679 private static function construct_comment($item, $owner)
3681 $cachekey = "diaspora:construct_comment:".$item['guid'];
3683 $result = Cache::get($cachekey);
3684 if (!is_null($result)) {
3689 "SELECT `guid` FROM `item` WHERE `parent` = %d AND `id` = %d LIMIT 1",
3690 intval($item["parent"]),
3691 intval($item["parent"])
3694 if (!DBM::is_result($p)) {
3700 $text = html_entity_decode(bb2diaspora($item["body"]));
3701 $created = datetime_convert("UTC", "UTC", $item["created"], 'Y-m-d\TH:i:s\Z');
3703 $comment = array("author" => self::my_handle($owner),
3704 "guid" => $item["guid"],
3705 "created_at" => $created,
3706 "parent_guid" => $parent["guid"],
3708 "author_signature" => "");
3710 // Send the thread parent guid only if it is a threaded comment
3711 if ($item['thr-parent'] != $item['parent-uri']) {
3712 $comment['thread_parent_guid'] = self::get_guid_from_uri($item['thr-parent'], $item['uid']);
3715 Cache::set($cachekey, $comment, CACHE_QUARTER_HOUR);
3721 * @brief Send a like or a comment
3723 * @param array $item The item that will be exported
3724 * @param array $owner the array of the item owner
3725 * @param array $contact Target of the communication
3726 * @param bool $public_batch Is it a public post?
3728 * @return int The result of the transmission
3730 public static function send_followup($item, $owner, $contact, $public_batch = false)
3732 if (in_array($item['verb'], array(ACTIVITY_ATTEND, ACTIVITY_ATTENDNO, ACTIVITY_ATTENDMAYBE))) {
3733 $message = self::construct_attend($item, $owner);
3734 $type = "event_participation";
3735 } elseif (in_array($item["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
3736 $message = self::construct_like($item, $owner);
3739 $message = self::construct_comment($item, $owner);
3747 $message["author_signature"] = self::signature($owner, $message);
3749 return self::build_and_transmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
3753 * @brief Creates a message from a signature record entry
3755 * @param array $item The item that will be exported
3756 * @param array $signature The entry of the "sign" record
3758 * @return string The message
3760 private static function message_from_signature($item, $signature)
3762 // Split the signed text
3763 $signed_parts = explode(";", $signature['signed_text']);
3765 if ($item["deleted"]) {
3766 $message = array("author" => $signature['signer'],
3767 "target_guid" => $signed_parts[0],
3768 "target_type" => $signed_parts[1]);
3769 } elseif (in_array($item["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
3770 $message = array("author" => $signed_parts[4],
3771 "guid" => $signed_parts[1],
3772 "parent_guid" => $signed_parts[3],
3773 "parent_type" => $signed_parts[2],
3774 "positive" => $signed_parts[0],
3775 "author_signature" => $signature['signature'],
3776 "parent_author_signature" => "");
3778 // Remove the comment guid
3779 $guid = array_shift($signed_parts);
3781 // Remove the parent guid
3782 $parent_guid = array_shift($signed_parts);
3784 // Remove the handle
3785 $handle = array_pop($signed_parts);
3787 // Glue the parts together
3788 $text = implode(";", $signed_parts);
3790 $message = array("author" => $handle,
3792 "parent_guid" => $parent_guid,
3793 "text" => implode(";", $signed_parts),
3794 "author_signature" => $signature['signature'],
3795 "parent_author_signature" => "");
3801 * @brief Relays messages (like, comment, retraction) to other servers if we are the thread owner
3803 * @param array $item The item that will be exported
3804 * @param array $owner the array of the item owner
3805 * @param array $contact Target of the communication
3806 * @param bool $public_batch Is it a public post?
3808 * @return int The result of the transmission
3810 public static function send_relay($item, $owner, $contact, $public_batch = false)
3812 if ($item["deleted"]) {
3813 return self::send_retraction($item, $owner, $contact, $public_batch, true);
3814 } elseif (in_array($item["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
3820 logger("Got relayable data ".$type." for item ".$item["guid"]." (".$item["id"].")", LOGGER_DEBUG);
3822 // fetch the original signature
3825 "SELECT `signed_text`, `signature`, `signer` FROM `sign` WHERE `iid` = %d LIMIT 1",
3830 logger("Couldn't fetch signatur for item ".$item["guid"]." (".$item["id"].")", LOGGER_DEBUG);
3836 // Old way - is used by the internal Friendica functions
3837 /// @todo Change all signatur storing functions to the new format
3838 if ($signature['signed_text'] && $signature['signature'] && $signature['signer']) {
3839 $message = self::message_from_signature($item, $signature);
3841 $msg = json_decode($signature['signed_text'], true);
3844 if (is_array($msg)) {
3845 foreach ($msg AS $field => $data) {
3846 if (!$item["deleted"]) {
3847 if ($field == "diaspora_handle") {
3850 if ($field == "target_type") {
3851 $field = "parent_type";
3855 $message[$field] = $data;
3858 logger("Signature text for item ".$item["guid"]." (".$item["id"].") couldn't be extracted: ".$signature['signed_text'], LOGGER_DEBUG);
3862 $message["parent_author_signature"] = self::signature($owner, $message);
3864 logger("Relayed data ".print_r($message, true), LOGGER_DEBUG);
3866 return self::build_and_transmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
3870 * @brief Sends a retraction (deletion) of a message, like or comment
3872 * @param array $item The item that will be exported
3873 * @param array $owner the array of the item owner
3874 * @param array $contact Target of the communication
3875 * @param bool $public_batch Is it a public post?
3876 * @param bool $relay Is the retraction transmitted from a relay?
3878 * @return int The result of the transmission
3880 public static function send_retraction($item, $owner, $contact, $public_batch = false, $relay = false)
3882 $itemaddr = self::handle_from_contact($item["contact-id"], $item["gcontact-id"]);
3884 $msg_type = "retraction";
3886 if ($item['id'] == $item['parent']) {
3887 $target_type = "Post";
3888 } elseif (in_array($item["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
3889 $target_type = "Like";
3891 $target_type = "Comment";
3894 $message = array("author" => $itemaddr,
3895 "target_guid" => $item['guid'],
3896 "target_type" => $target_type);
3898 logger("Got message ".print_r($message, true), LOGGER_DEBUG);
3900 return self::build_and_transmit($owner, $contact, $msg_type, $message, $public_batch, $item["guid"]);
3904 * @brief Sends a mail
3906 * @param array $item The item that will be exported
3907 * @param array $owner The owner
3908 * @param array $contact Target of the communication
3910 * @return int The result of the transmission
3912 public static function send_mail($item, $owner, $contact)
3914 $myaddr = self::my_handle($owner);
3917 "SELECT * FROM `conv` WHERE `id` = %d AND `uid` = %d LIMIT 1",
3918 intval($item["convid"]),
3919 intval($item["uid"])
3922 if (!DBM::is_result($r)) {
3923 logger("conversation not found.");
3929 "author" => $cnv["creator"],
3930 "guid" => $cnv["guid"],
3931 "subject" => $cnv["subject"],
3932 "created_at" => datetime_convert("UTC", "UTC", $cnv['created'], 'Y-m-d\TH:i:s\Z'),
3933 "participants" => $cnv["recips"]
3936 $body = bb2diaspora($item["body"]);
3937 $created = datetime_convert("UTC", "UTC", $item["created"], 'Y-m-d\TH:i:s\Z');
3940 "author" => $myaddr,
3941 "guid" => $item["guid"],
3942 "conversation_guid" => $cnv["guid"],
3944 "created_at" => $created,
3947 if ($item["reply"]) {
3952 "author" => $cnv["creator"],
3953 "guid" => $cnv["guid"],
3954 "subject" => $cnv["subject"],
3955 "created_at" => datetime_convert("UTC", "UTC", $cnv['created'], 'Y-m-d\TH:i:s\Z'),
3956 "participants" => $cnv["recips"],
3959 $type = "conversation";
3962 return self::build_and_transmit($owner, $contact, $type, $message, false, $item["guid"]);
3966 * @brief Create profile data
3968 * @param int $uid The user id
3970 * @return array The profile data
3972 private static function createProfileData($uid)
3975 "SELECT `profile`.`uid` AS `profile_uid`, `profile`.* , `user`.*, `user`.`prvkey` AS `uprvkey`, `contact`.`addr`
3977 INNER JOIN `user` ON `profile`.`uid` = `user`.`uid`
3978 INNER JOIN `contact` ON `profile`.`uid` = `contact`.`uid`
3979 WHERE `user`.`uid` = %d AND `profile`.`is-default` AND `contact`.`self` LIMIT 1",
3989 $handle = $profile["addr"];
3990 $first = ((strpos($profile['name'], ' ')
3991 ? trim(substr($profile['name'], 0, strpos($profile['name'], ' '))) : $profile['name']));
3992 $last = (($first === $profile['name']) ? '' : trim(substr($profile['name'], strlen($first))));
3993 $large = System::baseUrl().'/photo/custom/300/'.$profile['uid'].'.jpg';
3994 $medium = System::baseUrl().'/photo/custom/100/'.$profile['uid'].'.jpg';
3995 $small = System::baseUrl().'/photo/custom/50/' .$profile['uid'].'.jpg';
3996 $searchable = (($profile['publish'] && $profile['net-publish']) ? 'true' : 'false');
3998 if ($searchable === 'true') {
3999 $dob = '1000-00-00';
4001 if (($profile['dob']) && ($profile['dob'] > '0001-01-01')) {
4002 $dob = ((intval($profile['dob'])) ? intval($profile['dob']) : '1000') .'-'. datetime_convert('UTC', 'UTC', $profile['dob'],'m-d');
4005 $about = $profile['about'];
4006 $about = strip_tags(bbcode($about));
4008 $location = formatted_location($profile);
4010 if ($profile['pub_keywords']) {
4011 $kw = str_replace(',', ' ', $profile['pub_keywords']);
4012 $kw = str_replace(' ', ' ', $kw);
4013 $arr = explode(' ', $profile['pub_keywords']);
4015 for ($x = 0; $x < 5; $x ++) {
4016 if (trim($arr[$x])) {
4017 $tags .= '#'. trim($arr[$x]) .' ';
4022 $tags = trim($tags);
4025 return array("author" => $handle,
4026 "first_name" => $first,
4027 "last_name" => $last,
4028 "image_url" => $large,
4029 "image_url_medium" => $medium,
4030 "image_url_small" => $small,
4032 "gender" => $profile['gender'],
4034 "location" => $location,
4035 "searchable" => $searchable,
4037 "tag_string" => $tags);
4041 * @brief Sends profile data
4043 * @param int $uid The user id
4045 public static function send_profile($uid, $recips = false)
4053 "SELECT `id`,`name`,`network`,`pubkey`,`notify` FROM `contact` WHERE `network` = '%s'
4054 AND `uid` = %d AND `rel` != %d",
4055 dbesc(NETWORK_DIASPORA),
4057 intval(CONTACT_IS_SHARING)
4065 $message = self::createProfileData($uid);
4067 foreach ($recips as $recip) {
4068 logger("Send updated profile data for user ".$uid." to contact ".$recip["id"], LOGGER_DEBUG);
4069 self::build_and_transmit($profile, $recip, "profile", $message, false, "", true);
4074 * @brief Stores the signature for likes that are created on our system
4076 * @param array $contact The contact array of the "like"
4077 * @param int $post_id The post id of the "like"
4079 * @return bool Success
4081 public static function store_like_signature($contact, $post_id)
4083 // Is the contact the owner? Then fetch the private key
4084 if (!$contact['self'] || ($contact['uid'] == 0)) {
4085 logger("No owner post, so not storing signature", LOGGER_DEBUG);
4089 $r = q("SELECT `prvkey` FROM `user` WHERE `uid` = %d LIMIT 1", intval($contact['uid']));
4090 if (!DBM::is_result($r)) {
4094 $contact["uprvkey"] = $r[0]['prvkey'];
4096 $r = q("SELECT * FROM `item` WHERE `id` = %d LIMIT 1", intval($post_id));
4097 if (!DBM::is_result($r)) {
4101 if (!in_array($r[0]["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
4105 $message = self::construct_like($r[0], $contact);
4106 $message["author_signature"] = self::signature($contact, $message);
4109 * Now store the signature more flexible to dynamically support new fields.
4110 * This will break Diaspora compatibility with Friendica versions prior to 3.5.
4112 dba::insert('sign', array('iid' => $post_id, 'signed_text' => json_encode($message)));
4114 logger('Stored diaspora like signature');
4119 * @brief Stores the signature for comments that are created on our system
4121 * @param array $item The item array of the comment
4122 * @param array $contact The contact array of the item owner
4123 * @param string $uprvkey The private key of the sender
4124 * @param int $message_id The message id of the comment
4126 * @return bool Success
4128 public static function store_comment_signature($item, $contact, $uprvkey, $message_id)
4130 if ($uprvkey == "") {
4131 logger('No private key, so not storing comment signature', LOGGER_DEBUG);
4135 $contact["uprvkey"] = $uprvkey;
4137 $message = self::construct_comment($item, $contact);
4138 $message["author_signature"] = self::signature($contact, $message);
4141 * Now store the signature more flexible to dynamically support new fields.
4142 * This will break Diaspora compatibility with Friendica versions prior to 3.5.
4144 dba::insert('sign', array('iid' => $message_id, 'signed_text' => json_encode($message)));
4146 logger('Stored diaspora comment signature');