3 * @file src/Protocol/diaspora.php
4 * @brief The implementation of the diaspora protocol
6 * The new protocol is described here: http://diaspora.github.io/diaspora_federation/index.html
7 * This implementation here interprets the old and the new protocol and sends the new one.
8 * In the future we will remove most stuff from "validPosting" and interpret only the new protocol.
10 namespace Friendica\Protocol;
13 use Friendica\Core\System;
14 use Friendica\Core\Cache;
15 use Friendica\Core\Config;
16 use Friendica\Core\PConfig;
17 use Friendica\Core\Worker;
18 use Friendica\Database\DBM;
19 use Friendica\Model\Contact;
20 use Friendica\Model\GContact;
21 use Friendica\Model\Group;
22 use Friendica\Model\Profile;
23 use Friendica\Model\User;
24 use Friendica\Network\Probe;
25 use Friendica\Util\XML;
30 require_once 'include/dba.php';
31 require_once 'include/items.php';
32 require_once 'include/bb2diaspora.php';
33 require_once 'include/datetime.php';
34 require_once 'include/queue_fn.php';
37 * @brief This class contain functions to create and send Diaspora XML files
43 * @brief Return a list of relay servers
45 * This is an experimental Diaspora feature.
47 * @return array of relay servers
49 public static function relayList()
51 $serverdata = Config::get("system", "relay_server");
52 if ($serverdata == "") {
58 $servers = explode(",", $serverdata);
60 foreach ($servers as $server) {
61 $server = trim($server);
62 $addr = "relay@".str_replace("http://", "", normalise_link($server));
63 $batch = $server."/receive/public";
66 "SELECT `batch`, `id`, `name`,`network` FROM `contact` WHERE `uid` = 0 AND `batch` = '%s' AND `addr` = '%s' AND `nurl` = '%s' LIMIT 1",
69 dbesc(normalise_link($server))
74 "INSERT INTO `contact` (`uid`, `created`, `name`, `nick`, `addr`, `url`, `nurl`, `batch`, `network`, `rel`, `blocked`, `pending`, `writable`, `name-date`, `uri-date`, `avatar-date`)
75 VALUES (0, '%s', '%s', 'relay', '%s', '%s', '%s', '%s', '%s', %d, 0, 0, 1, '%s', '%s', '%s')",
80 dbesc(normalise_link($server)),
82 dbesc(NETWORK_DIASPORA),
83 intval(CONTACT_IS_FOLLOWER),
84 dbesc(datetime_convert()),
85 dbesc(datetime_convert()),
86 dbesc(datetime_convert())
89 $relais = q("SELECT `batch`, `id`, `name`,`network` FROM `contact` WHERE `uid` = 0 AND `batch` = '%s' LIMIT 1", dbesc($batch));
91 $relay[] = $relais[0];
94 $relay[] = $relais[0];
102 * @brief repairs a signature that was double encoded
104 * The function is unused at the moment. It was copied from the old implementation.
106 * @param string $signature The signature
107 * @param string $handle The handle of the signature owner
108 * @param integer $level This value is only set inside this function to avoid endless loops
110 * @return string the repaired signature
112 private static function repairSignature($signature, $handle = "", $level = 1)
114 if ($signature == "") {
118 if (base64_encode(base64_decode(base64_decode($signature))) == base64_decode($signature)) {
119 $signature = base64_decode($signature);
120 logger("Repaired double encoded signature from Diaspora/Hubzilla handle ".$handle." - level ".$level, LOGGER_DEBUG);
122 // Do a recursive call to be able to fix even multiple levels
124 $signature = self::repairSignature($signature, $handle, ++$level);
132 * @brief verify the envelope and return the verified data
134 * @param string $envelope The magic envelope
136 * @return string verified data
138 private static function verifyMagicEnvelope($envelope)
140 $basedom = parse_xml_string($envelope);
142 if (!is_object($basedom)) {
143 logger("Envelope is no XML file");
147 $children = $basedom->children('http://salmon-protocol.org/ns/magic-env');
149 if (sizeof($children) == 0) {
150 logger("XML has no children");
156 $data = base64url_decode($children->data);
157 $type = $children->data->attributes()->type[0];
159 $encoding = $children->encoding;
161 $alg = $children->alg;
163 $sig = base64url_decode($children->sig);
164 $key_id = $children->sig->attributes()->key_id[0];
166 $handle = base64url_decode($key_id);
169 $b64url_data = base64url_encode($data);
170 $msg = str_replace(array("\n", "\r", " ", "\t"), array("", "", "", ""), $b64url_data);
172 $signable_data = $msg.".".base64url_encode($type).".".base64url_encode($encoding).".".base64url_encode($alg);
174 $key = self::key($handle);
176 $verify = rsa_verify($signable_data, $sig, $key);
178 logger('Message did not verify. Discarding.');
186 * @brief encrypts data via AES
188 * @param string $key The AES key
189 * @param string $iv The IV (is used for CBC encoding)
190 * @param string $data The data that is to be encrypted
192 * @return string encrypted data
194 private static function aesEncrypt($key, $iv, $data)
196 return openssl_encrypt($data, 'aes-256-cbc', str_pad($key, 32, "\0"), OPENSSL_RAW_DATA, str_pad($iv, 16, "\0"));
200 * @brief decrypts data via AES
202 * @param string $key The AES key
203 * @param string $iv The IV (is used for CBC encoding)
204 * @param string $encrypted The encrypted data
206 * @return string decrypted data
208 private static function aesDecrypt($key, $iv, $encrypted)
210 return openssl_decrypt($encrypted, 'aes-256-cbc', str_pad($key, 32, "\0"), OPENSSL_RAW_DATA, str_pad($iv, 16, "\0"));
214 * @brief: Decodes incoming Diaspora message in the new format
216 * @param array $importer Array of the importer user
217 * @param string $raw raw post message
220 * 'message' -> decoded Diaspora XML message
221 * 'author' -> author diaspora handle
222 * 'key' -> author public key (converted to pkcs#8)
224 public static function decodeRaw($importer, $raw)
226 $data = json_decode($raw);
228 // Is it a private post? Then decrypt the outer Salmon
229 if (is_object($data)) {
230 $encrypted_aes_key_bundle = base64_decode($data->aes_key);
231 $ciphertext = base64_decode($data->encrypted_magic_envelope);
233 $outer_key_bundle = '';
234 @openssl_private_decrypt($encrypted_aes_key_bundle, $outer_key_bundle, $importer['prvkey']);
235 $j_outer_key_bundle = json_decode($outer_key_bundle);
237 if (!is_object($j_outer_key_bundle)) {
238 logger('Outer Salmon did not verify. Discarding.');
239 http_status_exit(400);
242 $outer_iv = base64_decode($j_outer_key_bundle->iv);
243 $outer_key = base64_decode($j_outer_key_bundle->key);
245 $xml = self::aesDecrypt($outer_key, $outer_iv, $ciphertext);
250 $basedom = parse_xml_string($xml);
252 if (!is_object($basedom)) {
253 logger('Received data does not seem to be an XML. Discarding. '.$xml);
254 http_status_exit(400);
257 $base = $basedom->children(NAMESPACE_SALMON_ME);
259 // Not sure if this cleaning is needed
260 $data = str_replace(array(" ", "\t", "\r", "\n"), array("", "", "", ""), $base->data);
262 // Build the signed data
263 $type = $base->data[0]->attributes()->type[0];
264 $encoding = $base->encoding;
266 $signed_data = $data.'.'.base64url_encode($type).'.'.base64url_encode($encoding).'.'.base64url_encode($alg);
268 // This is the signature
269 $signature = base64url_decode($base->sig);
271 // Get the senders' public key
272 $key_id = $base->sig[0]->attributes()->key_id[0];
273 $author_addr = base64_decode($key_id);
274 $key = self::key($author_addr);
276 $verify = rsa_verify($signed_data, $signature, $key);
278 logger('Message did not verify. Discarding.');
279 http_status_exit(400);
282 return array('message' => (string)base64url_decode($base->data),
283 'author' => unxmlify($author_addr),
284 'key' => (string)$key);
288 * @brief: Decodes incoming Diaspora message in the deprecated format
290 * @param array $importer Array of the importer user
291 * @param string $xml urldecoded Diaspora salmon
294 * 'message' -> decoded Diaspora XML message
295 * 'author' -> author diaspora handle
296 * 'key' -> author public key (converted to pkcs#8)
298 public static function decode($importer, $xml)
301 $basedom = parse_xml_string($xml);
303 if (!is_object($basedom)) {
304 logger("XML is not parseable.");
307 $children = $basedom->children('https://joindiaspora.com/protocol');
309 if ($children->header) {
311 $author_link = str_replace('acct:', '', $children->header->author_id);
313 // This happens with posts from a relais
315 logger("This is no private post in the old format", LOGGER_DEBUG);
319 $encrypted_header = json_decode(base64_decode($children->encrypted_header));
321 $encrypted_aes_key_bundle = base64_decode($encrypted_header->aes_key);
322 $ciphertext = base64_decode($encrypted_header->ciphertext);
324 $outer_key_bundle = '';
325 openssl_private_decrypt($encrypted_aes_key_bundle, $outer_key_bundle, $importer['prvkey']);
327 $j_outer_key_bundle = json_decode($outer_key_bundle);
329 $outer_iv = base64_decode($j_outer_key_bundle->iv);
330 $outer_key = base64_decode($j_outer_key_bundle->key);
332 $decrypted = self::aesDecrypt($outer_key, $outer_iv, $ciphertext);
334 logger('decrypted: '.$decrypted, LOGGER_DEBUG);
335 $idom = parse_xml_string($decrypted);
337 $inner_iv = base64_decode($idom->iv);
338 $inner_aes_key = base64_decode($idom->aes_key);
340 $author_link = str_replace('acct:', '', $idom->author_id);
343 $dom = $basedom->children(NAMESPACE_SALMON_ME);
345 // figure out where in the DOM tree our data is hiding
347 if ($dom->provenance->data) {
348 $base = $dom->provenance;
349 } elseif ($dom->env->data) {
351 } elseif ($dom->data) {
356 logger('unable to locate salmon data in xml');
357 http_status_exit(400);
361 // Stash the signature away for now. We have to find their key or it won't be good for anything.
362 $signature = base64url_decode($base->sig);
366 // strip whitespace so our data element will return to one big base64 blob
367 $data = str_replace(array(" ", "\t", "\r", "\n"), array("", "", "", ""), $base->data);
370 // stash away some other stuff for later
372 $type = $base->data[0]->attributes()->type[0];
373 $keyhash = $base->sig[0]->attributes()->keyhash[0];
374 $encoding = $base->encoding;
378 $signed_data = $data.'.'.base64url_encode($type).'.'.base64url_encode($encoding).'.'.base64url_encode($alg);
382 $data = base64url_decode($data);
386 $inner_decrypted = $data;
388 // Decode the encrypted blob
389 $inner_encrypted = base64_decode($data);
390 $inner_decrypted = self::aesDecrypt($inner_aes_key, $inner_iv, $inner_encrypted);
394 logger('Could not retrieve author URI.');
395 http_status_exit(400);
397 // Once we have the author URI, go to the web and try to find their public key
398 // (first this will look it up locally if it is in the fcontact cache)
399 // This will also convert diaspora public key from pkcs#1 to pkcs#8
401 logger('Fetching key for '.$author_link);
402 $key = self::key($author_link);
405 logger('Could not retrieve author key.');
406 http_status_exit(400);
409 $verify = rsa_verify($signed_data, $signature, $key);
412 logger('Message did not verify. Discarding.');
413 http_status_exit(400);
416 logger('Message verified.');
418 return array('message' => (string)$inner_decrypted,
419 'author' => unxmlify($author_link),
420 'key' => (string)$key);
425 * @brief Dispatches public messages and find the fitting receivers
427 * @param array $msg The post that will be dispatched
429 * @return int The message id of the generated message, "true" or "false" if there was an error
431 public static function dispatchPublic($msg)
433 $enabled = intval(Config::get("system", "diaspora_enabled"));
435 logger("diaspora is disabled");
439 if (!($postdata = self::validPosting($msg))) {
440 logger("Invalid posting");
444 $fields = $postdata['fields'];
446 // Is it a an action (comment, like, ...) for our own post?
447 if (isset($fields->parent_guid) && !$postdata["relayed"]) {
448 $guid = notags(unxmlify($fields->parent_guid));
449 $importer = self::importerForGuid($guid);
450 if (is_array($importer)) {
451 logger("delivering to origin: ".$importer["name"]);
452 $message_id = self::dispatch($importer, $msg, $fields);
457 // Process item retractions. This has to be done separated from the other stuff,
458 // since retractions for comments could come even from non followers.
459 if (!empty($fields) && in_array($fields->getName(), array('retraction'))) {
460 $target = notags(unxmlify($fields->target_type));
461 if (in_array($target, array("Comment", "Like", "Post", "Reshare", "StatusMessage"))) {
462 logger('processing retraction for '.$target, LOGGER_DEBUG);
463 $importer = array("uid" => 0, "page-flags" => PAGE_FREELOVE);
464 $message_id = self::dispatch($importer, $msg, $fields);
469 // Now distribute it to the followers
471 "SELECT `user`.* FROM `user` WHERE `user`.`uid` IN
472 (SELECT `contact`.`uid` FROM `contact` WHERE `contact`.`network` = '%s' AND `contact`.`addr` = '%s')
473 AND NOT `account_expired` AND NOT `account_removed`",
474 dbesc(NETWORK_DIASPORA),
475 dbesc($msg["author"])
478 if (DBM::is_result($r)) {
479 foreach ($r as $rr) {
480 logger("delivering to: ".$rr["username"]);
481 self::dispatch($rr, $msg, $fields);
483 } elseif (!Config::get('system', 'relay_subscribe', false)) {
484 logger("Unwanted message from ".$msg["author"]." send by ".$_SERVER["REMOTE_ADDR"]." with ".$_SERVER["HTTP_USER_AGENT"].": ".print_r($msg, true), LOGGER_DEBUG);
486 // Use a dummy importer to import the data for the public copy
487 $importer = array("uid" => 0, "page-flags" => PAGE_FREELOVE);
488 $message_id = self::dispatch($importer, $msg, $fields);
495 * @brief Dispatches the different message types to the different functions
497 * @param array $importer Array of the importer user
498 * @param array $msg The post that will be dispatched
499 * @param object $fields SimpleXML object that contains the message
501 * @return int The message id of the generated message, "true" or "false" if there was an error
503 public static function dispatch($importer, $msg, $fields = null)
505 // The sender is the handle of the contact that sent the message.
506 // This will often be different with relayed messages (for example "like" and "comment")
507 $sender = $msg["author"];
509 // This is only needed for private postings since this is already done for public ones before
510 if (is_null($fields)) {
511 if (!($postdata = self::validPosting($msg))) {
512 logger("Invalid posting");
515 $fields = $postdata['fields'];
518 $type = $fields->getName();
520 logger("Received message type ".$type." from ".$sender." for user ".$importer["uid"], LOGGER_DEBUG);
523 case "account_migration":
524 return self::receiveAccountMigration($importer, $fields);
526 case "account_deletion":
527 return self::receiveAccountDeletion($importer, $fields);
530 return self::receiveComment($importer, $sender, $fields, $msg["message"]);
533 return self::receiveContactRequest($importer, $fields);
536 return self::receiveConversation($importer, $msg, $fields);
539 return self::receiveLike($importer, $sender, $fields);
542 return self::receiveMessage($importer, $fields);
544 case "participation": // Not implemented
545 return self::receiveParticipation($importer, $fields);
547 case "photo": // Not implemented
548 return self::receivePhoto($importer, $fields);
550 case "poll_participation": // Not implemented
551 return self::receivePollParticipation($importer, $fields);
554 return self::receiveProfile($importer, $fields);
557 return self::receiveReshare($importer, $fields, $msg["message"]);
560 return self::receiveRetraction($importer, $sender, $fields);
562 case "status_message":
563 return self::receiveStatusMessage($importer, $fields, $msg["message"]);
566 logger("Unknown message type ".$type);
574 * @brief Checks if a posting is valid and fetches the data fields.
576 * This function does not only check the signature.
577 * It also does the conversion between the old and the new diaspora format.
579 * @param array $msg Array with the XML, the sender handle and the sender signature
581 * @return bool|array If the posting is valid then an array with an SimpleXML object is returned
583 private static function validPosting($msg)
585 $data = parse_xml_string($msg["message"]);
587 if (!is_object($data)) {
588 logger("No valid XML ".$msg["message"], LOGGER_DEBUG);
592 $first_child = $data->getName();
594 // Is this the new or the old version?
595 if ($data->getName() == "XML") {
597 foreach ($data->post->children() as $child) {
605 $type = $element->getName();
608 logger("Got message type ".$type.": ".$msg["message"], LOGGER_DATA);
610 // All retractions are handled identically from now on.
611 // In the new version there will only be "retraction".
612 if (in_array($type, array("signed_retraction", "relayable_retraction")))
613 $type = "retraction";
615 if ($type == "request") {
619 $fields = new SimpleXMLElement("<".$type."/>");
623 foreach ($element->children() as $fieldname => $entry) {
625 // Translation for the old XML structure
626 if ($fieldname == "diaspora_handle") {
627 $fieldname = "author";
629 if ($fieldname == "participant_handles") {
630 $fieldname = "participants";
632 if (in_array($type, array("like", "participation"))) {
633 if ($fieldname == "target_type") {
634 $fieldname = "parent_type";
637 if ($fieldname == "sender_handle") {
638 $fieldname = "author";
640 if ($fieldname == "recipient_handle") {
641 $fieldname = "recipient";
643 if ($fieldname == "root_diaspora_id") {
644 $fieldname = "root_author";
646 if ($type == "status_message") {
647 if ($fieldname == "raw_message") {
651 if ($type == "retraction") {
652 if ($fieldname == "post_guid") {
653 $fieldname = "target_guid";
655 if ($fieldname == "type") {
656 $fieldname = "target_type";
661 if (($fieldname == "author_signature") && ($entry != "")) {
662 $author_signature = base64_decode($entry);
663 } elseif (($fieldname == "parent_author_signature") && ($entry != "")) {
664 $parent_author_signature = base64_decode($entry);
665 } elseif (!in_array($fieldname, array("author_signature", "parent_author_signature", "target_author_signature"))) {
666 if ($signed_data != "") {
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::personByHandle($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 personByHandle($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::addFContact($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 addFContact($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 handleFromContact($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 urlFromContactGuid($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 * @todo Move to Friendica\Model\Contact
932 * @param int $uid The user id
933 * @param string $handle The handle in the format user@domain.tld
935 * @return int Contact id
937 private static function contactByHandle($uid, $handle)
939 // First do a direct search on the contact table
941 "SELECT * FROM `contact` WHERE `uid` = %d AND `addr` = '%s' LIMIT 1",
946 if (DBM::is_result($r)) {
950 * We haven't found it?
951 * We use another function for it that will possibly create a contact entry.
953 $cid = Contact::getIdForURL($handle, $uid);
956 /// @TODO Contact retrieval should be encapsulated into an "entity" class like `Contact`
957 $r = q("SELECT * FROM `contact` WHERE `id` = %d LIMIT 1", intval($cid));
959 if (DBM::is_result($r)) {
965 $handle_parts = explode("@", $handle);
966 $nurl_sql = "%%://".$handle_parts[1]."%%/profile/".$handle_parts[0];
968 "SELECT * FROM `contact` WHERE `network` = '%s' AND `uid` = %d AND `nurl` LIKE '%s' LIMIT 1",
973 if (DBM::is_result($r)) {
977 logger("Haven't found contact for user ".$uid." and handle ".$handle, LOGGER_DEBUG);
982 * @brief Check if posting is allowed for this contact
984 * @param array $importer Array of the importer user
985 * @param array $contact The contact that is checked
986 * @param bool $is_comment Is the check for a comment?
988 * @return bool is the contact allowed to post?
990 private static function postAllow($importer, $contact, $is_comment = false)
993 * Perhaps we were already sharing with this person. Now they're sharing with us.
994 * That makes us friends.
995 * Normally this should have handled by getting a request - but this could get lost
997 // It is deactivated by now, due to side effects. See issue https://github.com/friendica/friendica/pull/4033
998 // It is not removed by now. Possibly the code is needed?
999 //if (!$is_comment && $contact["rel"] == CONTACT_IS_FOLLOWER && in_array($importer["page-flags"], array(PAGE_FREELOVE))) {
1002 // array('rel' => CONTACT_IS_FRIEND, 'writable' => true),
1003 // array('id' => $contact["id"], 'uid' => $contact["uid"])
1006 // $contact["rel"] = CONTACT_IS_FRIEND;
1007 // logger("defining user ".$contact["nick"]." as friend");
1010 // We don't seem to like that person
1011 if ($contact["blocked"] || $contact["readonly"] || $contact["archive"]) {
1012 // Maybe blocked, don't accept.
1014 // We are following this person?
1015 } elseif (($contact["rel"] == CONTACT_IS_SHARING) || ($contact["rel"] == CONTACT_IS_FRIEND)) {
1016 // Yes, then it is fine.
1018 // Is it a post to a community?
1019 } elseif (($contact["rel"] == CONTACT_IS_FOLLOWER) && ($importer["page-flags"] == PAGE_COMMUNITY)) {
1022 // Is the message a global user or a comment?
1023 } elseif (($importer["uid"] == 0) || $is_comment) {
1024 // Messages for the global users and comments are always accepted
1032 * @brief Fetches the contact id for a handle and checks if posting is allowed
1034 * @param array $importer Array of the importer user
1035 * @param string $handle The checked handle in the format user@domain.tld
1036 * @param bool $is_comment Is the check for a comment?
1038 * @return array The contact data
1040 private static function allowedContactByHandle($importer, $handle, $is_comment = false)
1042 $contact = self::contactByHandle($importer["uid"], $handle);
1044 logger("A Contact for handle ".$handle." and user ".$importer["uid"]." was not found");
1045 // If a contact isn't found, we accept it anyway if it is a comment
1053 if (!self::postAllow($importer, $contact, $is_comment)) {
1054 logger("The handle: ".$handle." is not allowed to post to user ".$importer["uid"]);
1061 * @brief Does the message already exists on the system?
1063 * @param int $uid The user id
1064 * @param string $guid The guid of the message
1066 * @return int|bool message id if the message already was stored into the system - or false.
1068 private static function messageExists($uid, $guid)
1071 "SELECT `id` FROM `item` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1076 if (DBM::is_result($r)) {
1077 logger("message ".$guid." already exists for user ".$uid);
1085 * @brief Checks for links to posts in a message
1087 * @param array $item The item array
1090 private static function fetchGuid($item)
1092 $expression = "=diaspora://.*?/post/([0-9A-Za-z\-_@.:]{15,254}[0-9A-Za-z])=ism";
1093 preg_replace_callback(
1095 function ($match) use ($item) {
1096 self::fetchGuidSub($match, $item);
1101 preg_replace_callback(
1102 "&\[url=/posts/([^\[\]]*)\](.*)\[\/url\]&Usi",
1103 function ($match) use ($item) {
1104 self::fetchGuidSub($match, $item);
1111 * @brief Checks for relative /people/* links in an item body to match local
1112 * contacts or prepends the remote host taken from the author link.
1114 * @param string $body The item body to replace links from
1115 * @param string $author_link The author link for missing local contact fallback
1117 * @return string the replaced string
1119 public static function replacePeopleGuid($body, $author_link)
1121 $return = preg_replace_callback(
1122 "&\[url=/people/([^\[\]]*)\](.*)\[\/url\]&Usi",
1123 function ($match) use ($author_link) {
1125 // 0 => '[url=/people/0123456789abcdef]Foo Bar[/url]'
1126 // 1 => '0123456789abcdef'
1128 $handle = self::urlFromContactGuid($match[1]);
1131 $return = '@[url='.$handle.']'.$match[2].'[/url]';
1133 // No local match, restoring absolute remote URL from author scheme and host
1134 $author_url = parse_url($author_link);
1135 $return = '[url='.$author_url['scheme'].'://'.$author_url['host'].'/people/'.$match[1].']'.$match[2].'[/url]';
1147 * @brief sub function of "fetchGuid" which checks for links in messages
1149 * @param array $match array containing a link that has to be checked for a message link
1150 * @param array $item The item array
1153 private static function fetchGuidSub($match, $item)
1155 if (!self::storeByGuid($match[1], $item["author-link"])) {
1156 self::storeByGuid($match[1], $item["owner-link"]);
1161 * @brief Fetches an item with a given guid from a given server
1163 * @param string $guid the message guid
1164 * @param string $server The server address
1165 * @param int $uid The user id of the user
1167 * @return int the message id of the stored message or false
1169 private static function storeByGuid($guid, $server, $uid = 0)
1171 $serverparts = parse_url($server);
1172 $server = $serverparts["scheme"]."://".$serverparts["host"];
1174 logger("Trying to fetch item ".$guid." from ".$server, LOGGER_DEBUG);
1176 $msg = self::message($guid, $server);
1182 logger("Successfully fetched item ".$guid." from ".$server, LOGGER_DEBUG);
1184 // Now call the dispatcher
1185 return self::dispatchPublic($msg);
1189 * @brief Fetches a message from a server
1191 * @param string $guid message guid
1192 * @param string $server The url of the server
1193 * @param int $level Endless loop prevention
1196 * 'message' => The message XML
1197 * 'author' => The author handle
1198 * 'key' => The public key of the author
1200 private static function message($guid, $server, $level = 0)
1206 // This will work for new Diaspora servers and Friendica servers from 3.5
1207 $source_url = $server."/fetch/post/".urlencode($guid);
1209 logger("Fetch post from ".$source_url, LOGGER_DEBUG);
1211 $envelope = fetch_url($source_url);
1213 logger("Envelope was fetched.", LOGGER_DEBUG);
1214 $x = self::verifyMagicEnvelope($envelope);
1216 logger("Envelope could not be verified.", LOGGER_DEBUG);
1218 logger("Envelope was verified.", LOGGER_DEBUG);
1224 // This will work for older Diaspora and Friendica servers
1226 $source_url = $server."/p/".urlencode($guid).".xml";
1227 logger("Fetch post from ".$source_url, LOGGER_DEBUG);
1229 $x = fetch_url($source_url);
1235 $source_xml = parse_xml_string($x);
1237 if (!is_object($source_xml)) {
1241 if ($source_xml->post->reshare) {
1242 // Reshare of a reshare - old Diaspora version
1243 logger("Message is a reshare", LOGGER_DEBUG);
1244 return self::message($source_xml->post->reshare->root_guid, $server, ++$level);
1245 } elseif ($source_xml->getName() == "reshare") {
1246 // Reshare of a reshare - new Diaspora version
1247 logger("Message is a new reshare", LOGGER_DEBUG);
1248 return self::message($source_xml->root_guid, $server, ++$level);
1253 // Fetch the author - for the old and the new Diaspora version
1254 if ($source_xml->post->status_message->diaspora_handle) {
1255 $author = (string)$source_xml->post->status_message->diaspora_handle;
1256 } elseif ($source_xml->author && ($source_xml->getName() == "status_message")) {
1257 $author = (string)$source_xml->author;
1260 // If this isn't a "status_message" then quit
1262 logger("Message doesn't seem to be a status message", LOGGER_DEBUG);
1266 $msg = array("message" => $x, "author" => $author);
1268 $msg["key"] = self::key($msg["author"]);
1274 * @brief Fetches the item record of a given guid
1276 * @param int $uid The user id
1277 * @param string $guid message guid
1278 * @param string $author The handle of the item
1279 * @param array $contact The contact of the item owner
1281 * @return array the item record
1283 private static function parentItem($uid, $guid, $author, $contact)
1286 "SELECT `id`, `parent`, `body`, `wall`, `uri`, `guid`, `private`, `origin`,
1287 `author-name`, `author-link`, `author-avatar`,
1288 `owner-name`, `owner-link`, `owner-avatar`
1289 FROM `item` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1295 $result = self::storeByGuid($guid, $contact["url"], $uid);
1298 $person = self::personByHandle($author);
1299 $result = self::storeByGuid($guid, $person["url"], $uid);
1303 logger("Fetched missing item ".$guid." - result: ".$result, LOGGER_DEBUG);
1306 "SELECT `id`, `body`, `wall`, `uri`, `private`, `origin`,
1307 `author-name`, `author-link`, `author-avatar`,
1308 `owner-name`, `owner-link`, `owner-avatar`
1309 FROM `item` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1317 logger("parent item not found: parent: ".$guid." - user: ".$uid);
1320 logger("parent item found: parent: ".$guid." - user: ".$uid);
1326 * @brief returns contact details
1328 * @param array $contact The default contact if the person isn't found
1329 * @param array $person The record of the person
1330 * @param int $uid The user id
1333 * 'cid' => contact id
1334 * 'network' => network type
1336 private static function authorContactByUrl($contact, $person, $uid)
1339 "SELECT `id`, `network`, `url` FROM `contact` WHERE `nurl` = '%s' AND `uid` = %d LIMIT 1",
1340 dbesc(normalise_link($person["url"])),
1345 $network = $r[0]["network"];
1347 $cid = $contact["id"];
1348 $network = NETWORK_DIASPORA;
1351 return array("cid" => $cid, "network" => $network);
1355 * @brief Is the profile a hubzilla profile?
1357 * @param string $url The profile link
1359 * @return bool is it a hubzilla server?
1361 public static function isRedmatrix($url)
1363 return(strstr($url, "/channel/"));
1367 * @brief Generate a post link with a given handle and message guid
1369 * @param string $addr The user handle
1370 * @param string $guid message guid
1371 * @param string $parent_guid optional parent guid
1373 * @return string the post link
1375 private static function plink($addr, $guid, $parent_guid = '')
1377 $r = q("SELECT `url`, `nick`, `network` FROM `fcontact` WHERE `addr`='%s' LIMIT 1", dbesc($addr));
1380 if (!DBM::is_result($r)) {
1381 if ($parent_guid != '') {
1382 return "https://".substr($addr, strpos($addr, "@") + 1) . "/posts/" . $parent_guid . "#" . $guid;
1384 return "https://".substr($addr, strpos($addr, "@") + 1) . "/posts/" . $guid;
1388 // Friendica contacts are often detected as Diaspora contacts in the "fcontact" table
1389 // So we try another way as well.
1390 $s = q("SELECT `network` FROM `gcontact` WHERE `nurl`='%s' LIMIT 1", dbesc(normalise_link($r[0]["url"])));
1391 if (DBM::is_result($s)) {
1392 $r[0]["network"] = $s[0]["network"];
1395 if ($r[0]["network"] == NETWORK_DFRN) {
1396 return str_replace("/profile/".$r[0]["nick"]."/", "/display/".$guid, $r[0]["url"]."/");
1399 if (self::isRedmatrix($r[0]["url"])) {
1400 return $r[0]["url"]."/?f=&mid=".$guid;
1403 if ($parent_guid != '') {
1404 return "https://".substr($addr, strpos($addr, "@") + 1) . "/posts/" . $parent_guid . "#" . $guid;
1406 return "https://".substr($addr, strpos($addr, "@") + 1) . "/posts/" . $guid;
1411 * @brief Receives account migration
1413 * @param array $importer Array of the importer user
1414 * @param object $data The message object
1416 * @return bool Success
1418 private static function receiveAccountMigration($importer, $data)
1420 $old_handle = notags(unxmlify($data->author));
1421 $new_handle = notags(unxmlify($data->profile->author));
1422 $signature = notags(unxmlify($data->signature));
1424 $contact = self::contactByHandle($importer["uid"], $old_handle);
1426 logger("cannot find contact for sender: ".$old_handle." and user ".$importer["uid"]);
1430 logger("Got migration for ".$old_handle.", to ".$new_handle." with user ".$importer["uid"]);
1433 $signed_text = 'AccountMigration:'.$old_handle.':'.$new_handle;
1434 $key = self::key($old_handle);
1435 if (!rsa_verify($signed_text, $signature, $key, "sha256")) {
1436 logger('No valid signature for migration.');
1440 // Update the profile
1441 self::receiveProfile($importer, $data->profile);
1443 // change the technical stuff in contact and gcontact
1444 $data = Probe::uri($new_handle);
1445 if ($data['network'] == NETWORK_PHANTOM) {
1446 logger('Account for '.$new_handle." couldn't be probed.");
1450 $fields = array('url' => $data['url'], 'nurl' => normalise_link($data['url']),
1451 'name' => $data['name'], 'nick' => $data['nick'],
1452 'addr' => $data['addr'], 'batch' => $data['batch'],
1453 'notify' => $data['notify'], 'poll' => $data['poll'],
1454 'network' => $data['network']);
1456 dba::update('contact', $fields, array('addr' => $old_handle));
1458 $fields = array('url' => $data['url'], 'nurl' => normalise_link($data['url']),
1459 'name' => $data['name'], 'nick' => $data['nick'],
1460 'addr' => $data['addr'], 'connect' => $data['addr'],
1461 'notify' => $data['notify'], 'photo' => $data['photo'],
1462 'server_url' => $data['baseurl'], 'network' => $data['network']);
1464 dba::update('gcontact', $fields, array('addr' => $old_handle));
1466 logger('Contacts are updated.');
1469 /// @todo This is an extreme performance killer
1471 'owner-link' => array($contact["url"], $data["url"]),
1472 'author-link' => array($contact["url"], $data["url"]),
1474 foreach ($fields as $n => $f) {
1476 "SELECT `id` FROM `item` WHERE `%s` = '%s' AND `uid` = %d LIMIT 1",
1479 intval($importer["uid"])
1482 if (DBM::is_result($r)) {
1484 "UPDATE `item` SET `%s` = '%s' WHERE `%s` = '%s' AND `uid` = %d",
1489 intval($importer["uid"])
1498 logger('Items are updated.');
1504 * @brief Processes an account deletion
1506 * @param array $importer Array of the importer user
1507 * @param object $data The message object
1509 * @return bool Success
1511 private static function receiveAccountDeletion($importer, $data)
1513 /// @todo Account deletion should remove the contact from the global contacts as well
1515 $author = notags(unxmlify($data->author));
1517 $contact = self::contactByHandle($importer["uid"], $author);
1519 logger("cannot find contact for author: ".$author);
1523 // We now remove the contact
1524 Contact::remove($contact["id"]);
1529 * @brief Fetch the uri from our database if we already have this item (maybe from ourselves)
1531 * @param string $author Author handle
1532 * @param string $guid Message guid
1533 * @param boolean $onlyfound Only return uri when found in the database
1535 * @return string The constructed uri or the one from our database
1537 private static function getUriFromGuid($author, $guid, $onlyfound = false)
1539 $r = q("SELECT `uri` FROM `item` WHERE `guid` = '%s' LIMIT 1", dbesc($guid));
1540 if (DBM::is_result($r)) {
1541 return $r[0]["uri"];
1542 } elseif (!$onlyfound) {
1543 return $author.":".$guid;
1550 * @brief Fetch the guid from our database with a given uri
1552 * @param string $uri Message uri
1553 * @param string $uid Author handle
1555 * @return string The post guid
1557 private static function getGuidFromUri($uri, $uid)
1559 $r = q("SELECT `guid` FROM `item` WHERE `uri` = '%s' AND `uid` = %d LIMIT 1", dbesc($uri), intval($uid));
1560 if (DBM::is_result($r)) {
1561 return $r[0]["guid"];
1568 * @brief Find the best importer for a comment, like, ...
1570 * @param string $guid The guid of the item
1572 * @return array|boolean the origin owner of that post - or false
1574 private static function importerForGuid($guid)
1576 $item = dba::fetch_first("SELECT `uid` FROM `item` WHERE `origin` AND `guid` = ? LIMIT 1", $guid);
1578 if (DBM::is_result($item)) {
1579 logger("Found user ".$item['uid']." as owner of item ".$guid, LOGGER_DEBUG);
1580 $contact = dba::fetch_first("SELECT * FROM `contact` WHERE `self` AND `uid` = ?", $item['uid']);
1581 if (DBM::is_result($contact)) {
1589 * @brief Processes an incoming comment
1591 * @param array $importer Array of the importer user
1592 * @param string $sender The sender of the message
1593 * @param object $data The message object
1594 * @param string $xml The original XML of the message
1596 * @return int The message id of the generated comment or "false" if there was an error
1598 private static function receiveComment($importer, $sender, $data, $xml)
1600 $author = notags(unxmlify($data->author));
1601 $guid = notags(unxmlify($data->guid));
1602 $parent_guid = notags(unxmlify($data->parent_guid));
1603 $text = unxmlify($data->text);
1605 if (isset($data->created_at)) {
1606 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
1608 $created_at = datetime_convert();
1611 if (isset($data->thread_parent_guid)) {
1612 $thread_parent_guid = notags(unxmlify($data->thread_parent_guid));
1613 $thr_uri = self::getUriFromGuid("", $thread_parent_guid, true);
1618 $contact = self::allowedContactByHandle($importer, $sender, true);
1623 $message_id = self::messageExists($importer["uid"], $guid);
1628 $parent_item = self::parentItem($importer["uid"], $parent_guid, $author, $contact);
1629 if (!$parent_item) {
1633 $person = self::personByHandle($author);
1634 if (!is_array($person)) {
1635 logger("unable to find author details");
1639 // Fetch the contact id - if we know this contact
1640 $author_contact = self::authorContactByUrl($contact, $person, $importer["uid"]);
1642 $datarray = array();
1644 $datarray["uid"] = $importer["uid"];
1645 $datarray["contact-id"] = $author_contact["cid"];
1646 $datarray["network"] = $author_contact["network"];
1648 $datarray["author-name"] = $person["name"];
1649 $datarray["author-link"] = $person["url"];
1650 $datarray["author-avatar"] = ((x($person, "thumb")) ? $person["thumb"] : $person["photo"]);
1652 $datarray["owner-name"] = $contact["name"];
1653 $datarray["owner-link"] = $contact["url"];
1654 $datarray["owner-avatar"] = ((x($contact, "thumb")) ? $contact["thumb"] : $contact["photo"]);
1656 $datarray["guid"] = $guid;
1657 $datarray["uri"] = self::getUriFromGuid($author, $guid);
1659 $datarray["type"] = "remote-comment";
1660 $datarray["verb"] = ACTIVITY_POST;
1661 $datarray["gravity"] = GRAVITY_COMMENT;
1663 if ($thr_uri != "") {
1664 $datarray["parent-uri"] = $thr_uri;
1666 $datarray["parent-uri"] = $parent_item["uri"];
1669 $datarray["object-type"] = ACTIVITY_OBJ_COMMENT;
1671 $datarray["protocol"] = PROTOCOL_DIASPORA;
1672 $datarray["source"] = $xml;
1674 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
1676 $datarray["plink"] = self::plink($author, $guid, $parent_item['guid']);
1678 $body = diaspora2bb($text);
1680 $datarray["body"] = self::replacePeopleGuid($body, $person["url"]);
1682 self::fetchGuid($datarray);
1684 $message_id = item_store($datarray);
1686 if ($message_id <= 0) {
1691 logger("Stored comment ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
1694 // If we are the origin of the parent we store the original data and notify our followers
1695 if ($message_id && $parent_item["origin"]) {
1696 // Formerly we stored the signed text, the signature and the author in different fields.
1697 // We now store the raw data so that we are more flexible.
1698 dba::insert('sign', array('iid' => $message_id, 'signed_text' => json_encode($data)));
1701 Worker::add(PRIORITY_HIGH, "Notifier", "comment-import", $message_id);
1708 * @brief processes and stores private messages
1710 * @param array $importer Array of the importer user
1711 * @param array $contact The contact of the message
1712 * @param object $data The message object
1713 * @param array $msg Array of the processed message, author handle and key
1714 * @param object $mesg The private message
1715 * @param array $conversation The conversation record to which this message belongs
1717 * @return bool "true" if it was successful
1719 private static function receiveConversationMessage($importer, $contact, $data, $msg, $mesg, $conversation)
1721 $author = notags(unxmlify($data->author));
1722 $guid = notags(unxmlify($data->guid));
1723 $subject = notags(unxmlify($data->subject));
1725 // "diaspora_handle" is the element name from the old version
1726 // "author" is the element name from the new version
1727 if ($mesg->author) {
1728 $msg_author = notags(unxmlify($mesg->author));
1729 } elseif ($mesg->diaspora_handle) {
1730 $msg_author = notags(unxmlify($mesg->diaspora_handle));
1735 $msg_guid = notags(unxmlify($mesg->guid));
1736 $msg_conversation_guid = notags(unxmlify($mesg->conversation_guid));
1737 $msg_text = unxmlify($mesg->text);
1738 $msg_created_at = datetime_convert("UTC", "UTC", notags(unxmlify($mesg->created_at)));
1740 if ($msg_conversation_guid != $guid) {
1741 logger("message conversation guid does not belong to the current conversation.");
1745 $body = diaspora2bb($msg_text);
1746 $message_uri = $msg_author.":".$msg_guid;
1748 $person = self::personByHandle($msg_author);
1753 "SELECT `id` FROM `mail` WHERE `guid` = '%s' AND `uid` = %d LIMIT 1",
1755 intval($importer["uid"])
1757 if (DBM::is_result($r)) {
1758 logger("duplicate message already delivered.", LOGGER_DEBUG);
1763 "INSERT INTO `mail` (`uid`, `guid`, `convid`, `from-name`,`from-photo`,`from-url`,`contact-id`,`title`,`body`,`seen`,`reply`,`uri`,`parent-uri`,`created`)
1764 VALUES (%d, '%s', %d, '%s', '%s', '%s', %d, '%s', '%s', %d, %d, '%s','%s','%s')",
1765 intval($importer["uid"]),
1767 intval($conversation["id"]),
1768 dbesc($person["name"]),
1769 dbesc($person["photo"]),
1770 dbesc($person["url"]),
1771 intval($contact["id"]),
1776 dbesc($message_uri),
1777 dbesc($author.":".$guid),
1778 dbesc($msg_created_at)
1783 dba::update('conv', array('updated' => datetime_convert()), array('id' => $conversation["id"]));
1787 "type" => NOTIFY_MAIL,
1788 "notify_flags" => $importer["notify-flags"],
1789 "language" => $importer["language"],
1790 "to_name" => $importer["username"],
1791 "to_email" => $importer["email"],
1792 "uid" =>$importer["uid"],
1793 "item" => array("subject" => $subject, "body" => $body),
1794 "source_name" => $person["name"],
1795 "source_link" => $person["url"],
1796 "source_photo" => $person["thumb"],
1797 "verb" => ACTIVITY_POST,
1804 * @brief Processes new private messages (answers to private messages are processed elsewhere)
1806 * @param array $importer Array of the importer user
1807 * @param array $msg Array of the processed message, author handle and key
1808 * @param object $data The message object
1810 * @return bool Success
1812 private static function receiveConversation($importer, $msg, $data)
1814 $author = notags(unxmlify($data->author));
1815 $guid = notags(unxmlify($data->guid));
1816 $subject = notags(unxmlify($data->subject));
1817 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
1818 $participants = notags(unxmlify($data->participants));
1820 $messages = $data->message;
1822 if (!count($messages)) {
1823 logger("empty conversation");
1827 $contact = self::allowedContactByHandle($importer, $msg["author"], true);
1832 $conversation = null;
1835 "SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1836 intval($importer["uid"]),
1840 $conversation = $c[0];
1843 "INSERT INTO `conv` (`uid`, `guid`, `creator`, `created`, `updated`, `subject`, `recips`)
1844 VALUES (%d, '%s', '%s', '%s', '%s', '%s', '%s')",
1845 intval($importer["uid"]),
1849 dbesc(datetime_convert()),
1851 dbesc($participants)
1855 "SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
1856 intval($importer["uid"]),
1862 $conversation = $c[0];
1865 if (!$conversation) {
1866 logger("unable to create conversation.");
1870 foreach ($messages as $mesg) {
1871 self::receiveConversationMessage($importer, $contact, $data, $msg, $mesg, $conversation);
1878 * @brief Creates the body for a "like" message
1880 * @param array $contact The contact that send us the "like"
1881 * @param array $parent_item The item array of the parent item
1882 * @param string $guid message guid
1884 * @return string the body
1886 private static function constructLikeBody($contact, $parent_item, $guid)
1888 $bodyverb = t('%1$s likes %2$s\'s %3$s');
1890 $ulink = "[url=".$contact["url"]."]".$contact["name"]."[/url]";
1891 $alink = "[url=".$parent_item["author-link"]."]".$parent_item["author-name"]."[/url]";
1892 $plink = "[url=".System::baseUrl()."/display/".urlencode($guid)."]".t("status")."[/url]";
1894 return sprintf($bodyverb, $ulink, $alink, $plink);
1898 * @brief Creates a XML object for a "like"
1900 * @param array $importer Array of the importer user
1901 * @param array $parent_item The item array of the parent item
1903 * @return string The XML
1905 private static function constructLikeObject($importer, $parent_item)
1907 $objtype = ACTIVITY_OBJ_NOTE;
1908 $link = '<link rel="alternate" type="text/html" href="'.System::baseUrl()."/display/".$importer["nickname"]."/".$parent_item["id"].'" />';
1909 $parent_body = $parent_item["body"];
1911 $xmldata = array("object" => array("type" => $objtype,
1913 "id" => $parent_item["uri"],
1916 "content" => $parent_body));
1918 return XML::fromArray($xmldata, $xml, true);
1922 * @brief Processes "like" messages
1924 * @param array $importer Array of the importer user
1925 * @param string $sender The sender of the message
1926 * @param object $data The message object
1928 * @return int The message id of the generated like or "false" if there was an error
1930 private static function receiveLike($importer, $sender, $data)
1932 $author = notags(unxmlify($data->author));
1933 $guid = notags(unxmlify($data->guid));
1934 $parent_guid = notags(unxmlify($data->parent_guid));
1935 $parent_type = notags(unxmlify($data->parent_type));
1936 $positive = notags(unxmlify($data->positive));
1938 // likes on comments aren't supported by Diaspora - only on posts
1939 // But maybe this will be supported in the future, so we will accept it.
1940 if (!in_array($parent_type, array("Post", "Comment"))) {
1944 $contact = self::allowedContactByHandle($importer, $sender, true);
1949 $message_id = self::messageExists($importer["uid"], $guid);
1954 $parent_item = self::parentItem($importer["uid"], $parent_guid, $author, $contact);
1955 if (!$parent_item) {
1959 $person = self::personByHandle($author);
1960 if (!is_array($person)) {
1961 logger("unable to find author details");
1965 // Fetch the contact id - if we know this contact
1966 $author_contact = self::authorContactByUrl($contact, $person, $importer["uid"]);
1968 // "positive" = "false" would be a Dislike - wich isn't currently supported by Diaspora
1969 // We would accept this anyhow.
1970 if ($positive == "true") {
1971 $verb = ACTIVITY_LIKE;
1973 $verb = ACTIVITY_DISLIKE;
1976 $datarray = array();
1978 $datarray["protocol"] = PROTOCOL_DIASPORA;
1980 $datarray["uid"] = $importer["uid"];
1981 $datarray["contact-id"] = $author_contact["cid"];
1982 $datarray["network"] = $author_contact["network"];
1984 $datarray["author-name"] = $person["name"];
1985 $datarray["author-link"] = $person["url"];
1986 $datarray["author-avatar"] = ((x($person, "thumb")) ? $person["thumb"] : $person["photo"]);
1988 $datarray["owner-name"] = $contact["name"];
1989 $datarray["owner-link"] = $contact["url"];
1990 $datarray["owner-avatar"] = ((x($contact, "thumb")) ? $contact["thumb"] : $contact["photo"]);
1992 $datarray["guid"] = $guid;
1993 $datarray["uri"] = self::getUriFromGuid($author, $guid);
1995 $datarray["type"] = "activity";
1996 $datarray["verb"] = $verb;
1997 $datarray["gravity"] = GRAVITY_LIKE;
1998 $datarray["parent-uri"] = $parent_item["uri"];
2000 $datarray["object-type"] = ACTIVITY_OBJ_NOTE;
2001 $datarray["object"] = self::constructLikeObject($importer, $parent_item);
2003 $datarray["body"] = self::constructLikeBody($contact, $parent_item, $guid);
2005 $message_id = item_store($datarray);
2007 if ($message_id <= 0) {
2012 logger("Stored like ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
2015 // like on comments have the comment as parent. So we need to fetch the toplevel parent
2016 if ($parent_item["id"] != $parent_item["parent"]) {
2017 $toplevel = dba::select('item', array('origin'), array('id' => $parent_item["parent"]), array('limit' => 1));
2018 $origin = $toplevel["origin"];
2020 $origin = $parent_item["origin"];
2023 // If we are the origin of the parent we store the original data and notify our followers
2024 if ($message_id && $origin) {
2025 // Formerly we stored the signed text, the signature and the author in different fields.
2026 // We now store the raw data so that we are more flexible.
2027 dba::insert('sign', array('iid' => $message_id, 'signed_text' => json_encode($data)));
2030 Worker::add(PRIORITY_HIGH, "Notifier", "comment-import", $message_id);
2037 * @brief Processes private messages
2039 * @param array $importer Array of the importer user
2040 * @param object $data The message object
2042 * @return bool Success?
2044 private static function receiveMessage($importer, $data)
2046 $author = notags(unxmlify($data->author));
2047 $guid = notags(unxmlify($data->guid));
2048 $conversation_guid = notags(unxmlify($data->conversation_guid));
2049 $text = unxmlify($data->text);
2050 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
2052 $contact = self::allowedContactByHandle($importer, $author, true);
2057 $conversation = null;
2060 "SELECT * FROM `conv` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
2061 intval($importer["uid"]),
2062 dbesc($conversation_guid)
2065 $conversation = $c[0];
2067 logger("conversation not available.");
2071 $message_uri = $author.":".$guid;
2073 $person = self::personByHandle($author);
2075 logger("unable to find author details");
2079 $body = diaspora2bb($text);
2081 $body = self::replacePeopleGuid($body, $person["url"]);
2086 "SELECT `id` FROM `mail` WHERE `guid` = '%s' AND `uid` = %d LIMIT 1",
2088 intval($importer["uid"])
2090 if (DBM::is_result($r)) {
2091 logger("duplicate message already delivered.", LOGGER_DEBUG);
2096 "INSERT INTO `mail` (`uid`, `guid`, `convid`, `from-name`,`from-photo`,`from-url`,`contact-id`,`title`,`body`,`seen`,`reply`,`uri`,`parent-uri`,`created`)
2097 VALUES ( %d, '%s', %d, '%s', '%s', '%s', %d, '%s', '%s', %d, %d, '%s','%s','%s')",
2098 intval($importer["uid"]),
2100 intval($conversation["id"]),
2101 dbesc($person["name"]),
2102 dbesc($person["photo"]),
2103 dbesc($person["url"]),
2104 intval($contact["id"]),
2105 dbesc($conversation["subject"]),
2109 dbesc($message_uri),
2110 dbesc($author.":".$conversation["guid"]),
2116 dba::update('conv', array('updated' => datetime_convert()), array('id' => $conversation["id"]));
2121 * @brief Processes participations - unsupported by now
2123 * @param array $importer Array of the importer user
2124 * @param object $data The message object
2126 * @return bool always true
2128 private static function receiveParticipation($importer, $data)
2130 // I'm not sure if we can fully support this message type
2135 * @brief Processes photos - unneeded
2137 * @param array $importer Array of the importer user
2138 * @param object $data The message object
2140 * @return bool always true
2142 private static function receivePhoto($importer, $data)
2144 // There doesn't seem to be a reason for this function,
2145 // since the photo data is transmitted in the status message as well
2150 * @brief Processes poll participations - unssupported
2152 * @param array $importer Array of the importer user
2153 * @param object $data The message object
2155 * @return bool always true
2157 private static function receivePollParticipation($importer, $data)
2159 // We don't support polls by now
2164 * @brief Processes incoming profile updates
2166 * @param array $importer Array of the importer user
2167 * @param object $data The message object
2169 * @return bool Success
2171 private static function receiveProfile($importer, $data)
2173 $author = strtolower(notags(unxmlify($data->author)));
2175 $contact = self::contactByHandle($importer["uid"], $author);
2180 $name = unxmlify($data->first_name).((strlen($data->last_name)) ? " ".unxmlify($data->last_name) : "");
2181 $image_url = unxmlify($data->image_url);
2182 $birthday = unxmlify($data->birthday);
2183 $gender = unxmlify($data->gender);
2184 $about = diaspora2bb(unxmlify($data->bio));
2185 $location = diaspora2bb(unxmlify($data->location));
2186 $searchable = (unxmlify($data->searchable) == "true");
2187 $nsfw = (unxmlify($data->nsfw) == "true");
2188 $tags = unxmlify($data->tag_string);
2190 $tags = explode("#", $tags);
2192 $keywords = array();
2193 foreach ($tags as $tag) {
2194 $tag = trim(strtolower($tag));
2200 $keywords = implode(", ", $keywords);
2202 $handle_parts = explode("@", $author);
2203 $nick = $handle_parts[0];
2206 $name = $handle_parts[0];
2209 if (preg_match("|^https?://|", $image_url) === 0) {
2210 $image_url = "http://".$handle_parts[1].$image_url;
2213 Contact::updateAvatar($image_url, $importer["uid"], $contact["id"]);
2215 // Generic birthday. We don't know the timezone. The year is irrelevant.
2217 $birthday = str_replace("1000", "1901", $birthday);
2219 if ($birthday != "") {
2220 $birthday = datetime_convert("UTC", "UTC", $birthday, "Y-m-d");
2223 // this is to prevent multiple birthday notifications in a single year
2224 // if we already have a stored birthday and the 'm-d' part hasn't changed, preserve the entry, which will preserve the notify year
2226 if (substr($birthday, 5) === substr($contact["bd"], 5)) {
2227 $birthday = $contact["bd"];
2231 "UPDATE `contact` SET `name` = '%s', `nick` = '%s', `addr` = '%s', `name-date` = '%s', `bd` = '%s',
2232 `location` = '%s', `about` = '%s', `keywords` = '%s', `gender` = '%s' WHERE `id` = %d AND `uid` = %d",
2236 dbesc(datetime_convert()),
2242 intval($contact["id"]),
2243 intval($importer["uid"])
2246 $gcontact = array("url" => $contact["url"], "network" => NETWORK_DIASPORA, "generation" => 2,
2247 "photo" => $image_url, "name" => $name, "location" => $location,
2248 "about" => $about, "birthday" => $birthday, "gender" => $gender,
2249 "addr" => $author, "nick" => $nick, "keywords" => $keywords,
2250 "hide" => !$searchable, "nsfw" => $nsfw);
2252 $gcid = GContact::update($gcontact);
2254 GContact::link($gcid, $importer["uid"], $contact["id"]);
2256 logger("Profile of contact ".$contact["id"]." stored for user ".$importer["uid"], LOGGER_DEBUG);
2262 * @brief Processes incoming friend requests
2264 * @param array $importer Array of the importer user
2265 * @param array $contact The contact that send the request
2268 private static function receiveRequestMakeFriend($importer, $contact)
2272 if ($contact["rel"] == CONTACT_IS_SHARING) {
2275 array('rel' => CONTACT_IS_FRIEND, 'writable' => true),
2276 array('id' => $contact["id"], 'uid' => $importer["uid"])
2279 // send notification
2282 "SELECT `hide-friends` FROM `profile` WHERE `uid` = %d AND `is-default` = 1 LIMIT 1",
2283 intval($importer["uid"])
2286 if ($r && !$r[0]["hide-friends"] && !$contact["hidden"] && intval(PConfig::get($importer["uid"], "system", "post_newfriend"))) {
2288 "SELECT * FROM `contact` WHERE `self` AND `uid` = %d LIMIT 1",
2289 intval($importer["uid"])
2292 // they are not CONTACT_IS_FOLLOWER anymore but that's what we have in the array
2294 if ($self && $contact["rel"] == CONTACT_IS_FOLLOWER) {
2296 $arr["protocol"] = PROTOCOL_DIASPORA;
2297 $arr["uri"] = $arr["parent-uri"] = item_new_uri($a->get_hostname(), $importer["uid"]);
2298 $arr["uid"] = $importer["uid"];
2299 $arr["contact-id"] = $self[0]["id"];
2301 $arr["type"] = 'wall';
2302 $arr["gravity"] = 0;
2304 $arr["author-name"] = $arr["owner-name"] = $self[0]["name"];
2305 $arr["author-link"] = $arr["owner-link"] = $self[0]["url"];
2306 $arr["author-avatar"] = $arr["owner-avatar"] = $self[0]["thumb"];
2307 $arr["verb"] = ACTIVITY_FRIEND;
2308 $arr["object-type"] = ACTIVITY_OBJ_PERSON;
2310 $A = "[url=".$self[0]["url"]."]".$self[0]["name"]."[/url]";
2311 $B = "[url=".$contact["url"]."]".$contact["name"]."[/url]";
2312 $BPhoto = "[url=".$contact["url"]."][img]".$contact["thumb"]."[/img][/url]";
2313 $arr["body"] = sprintf(t('%1$s is now friends with %2$s'), $A, $B)."\n\n\n".$BPhoto;
2315 $arr["object"] = self::constructNewFriendObject($contact);
2317 $arr["last-child"] = 1;
2319 $user = dba::select('user', ['allow_cid', 'allow_gid', 'deny_cid', 'deny_gid'], ['uid' => $importer["uid"]], ['limit' => 1]);
2321 $arr["allow_cid"] = $user["allow_cid"];
2322 $arr["allow_gid"] = $user["allow_gid"];
2323 $arr["deny_cid"] = $user["deny_cid"];
2324 $arr["deny_gid"] = $user["deny_gid"];
2326 $i = item_store($arr);
2328 Worker::add(PRIORITY_HIGH, "Notifier", "activity", $i);
2335 * @brief Creates a XML object for a "new friend" message
2337 * @param array $contact Array of the contact
2339 * @return string The XML
2341 private static function constructNewFriendObject($contact)
2343 $objtype = ACTIVITY_OBJ_PERSON;
2344 $link = '<link rel="alternate" type="text/html" href="'.$contact["url"].'" />'."\n".
2345 '<link rel="photo" type="image/jpeg" href="'.$contact["thumb"].'" />'."\n";
2347 $xmldata = array("object" => array("type" => $objtype,
2348 "title" => $contact["name"],
2349 "id" => $contact["url"]."/".$contact["name"],
2352 return XML::fromArray($xmldata, $xml, true);
2356 * @brief Processes incoming sharing notification
2358 * @param array $importer Array of the importer user
2359 * @param object $data The message object
2361 * @return bool Success
2363 private static function receiveContactRequest($importer, $data)
2365 $author = unxmlify($data->author);
2366 $recipient = unxmlify($data->recipient);
2368 if (!$author || !$recipient) {
2372 // the current protocol version doesn't know these fields
2373 // That means that we will assume their existance
2374 if (isset($data->following)) {
2375 $following = (unxmlify($data->following) == "true");
2380 if (isset($data->sharing)) {
2381 $sharing = (unxmlify($data->sharing) == "true");
2386 $contact = self::contactByHandle($importer["uid"], $author);
2388 // perhaps we were already sharing with this person. Now they're sharing with us.
2389 // That makes us friends.
2392 logger("Author ".$author." (Contact ".$contact["id"].") wants to follow us.", LOGGER_DEBUG);
2393 self::receiveRequestMakeFriend($importer, $contact);
2395 // refetch the contact array
2396 $contact = self::contactByHandle($importer["uid"], $author);
2398 // If we are now friends, we are sending a share message.
2399 // Normally we needn't to do so, but the first message could have been vanished.
2400 if (in_array($contact["rel"], array(CONTACT_IS_FRIEND))) {
2401 $u = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval($importer["uid"]));
2403 logger("Sending share message to author ".$author." - Contact: ".$contact["id"]." - User: ".$importer["uid"], LOGGER_DEBUG);
2404 $ret = self::sendShare($u[0], $contact);
2409 logger("Author ".$author." doesn't want to follow us anymore.", LOGGER_DEBUG);
2410 lose_follower($importer, $contact);
2415 if (!$following && $sharing && in_array($importer["page-flags"], array(PAGE_SOAPBOX, PAGE_NORMAL))) {
2416 logger("Author ".$author." wants to share with us - but doesn't want to listen. Request is ignored.", LOGGER_DEBUG);
2418 } elseif (!$following && !$sharing) {
2419 logger("Author ".$author." doesn't want anything - and we don't know the author. Request is ignored.", LOGGER_DEBUG);
2421 } elseif (!$following && $sharing) {
2422 logger("Author ".$author." wants to share with us.", LOGGER_DEBUG);
2423 } elseif ($following && $sharing) {
2424 logger("Author ".$author." wants to have a bidirectional conection.", LOGGER_DEBUG);
2425 } elseif ($following && !$sharing) {
2426 logger("Author ".$author." wants to listen to us.", LOGGER_DEBUG);
2429 $ret = self::personByHandle($author);
2431 if (!$ret || ($ret["network"] != NETWORK_DIASPORA)) {
2432 logger("Cannot resolve diaspora handle ".$author." for ".$recipient);
2436 $batch = (($ret["batch"]) ? $ret["batch"] : implode("/", array_slice(explode("/", $ret["url"]), 0, 3))."/receive/public");
2439 "INSERT INTO `contact` (`uid`, `network`,`addr`,`created`,`url`,`nurl`,`batch`,`name`,`nick`,`photo`,`pubkey`,`notify`,`poll`,`blocked`,`priority`)
2440 VALUES (%d, '%s', '%s', '%s', '%s','%s','%s','%s','%s','%s','%s','%s','%s',%d,%d)",
2441 intval($importer["uid"]),
2442 dbesc($ret["network"]),
2443 dbesc($ret["addr"]),
2446 dbesc(normalise_link($ret["url"])),
2448 dbesc($ret["name"]),
2449 dbesc($ret["nick"]),
2450 dbesc($ret["photo"]),
2451 dbesc($ret["pubkey"]),
2452 dbesc($ret["notify"]),
2453 dbesc($ret["poll"]),
2458 // find the contact record we just created
2460 $contact_record = self::contactByHandle($importer["uid"], $author);
2462 if (!$contact_record) {
2463 logger("unable to locate newly created contact record.");
2467 logger("Author ".$author." was added as contact number ".$contact_record["id"].".", LOGGER_DEBUG);
2469 Group::addMember(User::getDefaultGroup($importer['uid'], $ret["network"]), $contact_record['id']);
2471 Contact::updateAvatar($ret["photo"], $importer['uid'], $contact_record["id"], true);
2473 if ($importer["page-flags"] == PAGE_NORMAL) {
2474 logger("Sending intra message for author ".$author.".", LOGGER_DEBUG);
2476 $hash = random_string().(string)time(); // Generate a confirm_key
2479 "INSERT INTO `intro` (`uid`, `contact-id`, `blocked`, `knowyou`, `note`, `hash`, `datetime`)
2480 VALUES (%d, %d, %d, %d, '%s', '%s', '%s')",
2481 intval($importer["uid"]),
2482 intval($contact_record["id"]),
2485 dbesc(t("Sharing notification from Diaspora network")),
2487 dbesc(datetime_convert())
2490 // automatic friend approval
2492 logger("Does an automatic friend approval for author ".$author.".", LOGGER_DEBUG);
2494 Contact::updateAvatar($contact_record["photo"], $importer["uid"], $contact_record["id"]);
2496 // technically they are sharing with us (CONTACT_IS_SHARING),
2497 // but if our page-type is PAGE_COMMUNITY or PAGE_SOAPBOX
2498 // we are going to change the relationship and make them a follower.
2500 if (($importer["page-flags"] == PAGE_FREELOVE) && $sharing && $following) {
2501 $new_relation = CONTACT_IS_FRIEND;
2502 } elseif (($importer["page-flags"] == PAGE_FREELOVE) && $sharing) {
2503 $new_relation = CONTACT_IS_SHARING;
2505 $new_relation = CONTACT_IS_FOLLOWER;
2509 "UPDATE `contact` SET `rel` = %d,
2517 intval($new_relation),
2518 dbesc(datetime_convert()),
2519 dbesc(datetime_convert()),
2520 intval($contact_record["id"])
2523 $u = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval($importer["uid"]));
2525 logger("Sending share message (Relation: ".$new_relation.") to author ".$author." - Contact: ".$contact_record["id"]." - User: ".$importer["uid"], LOGGER_DEBUG);
2526 $ret = self::sendShare($u[0], $contact_record);
2528 // Send the profile data, maybe it weren't transmitted before
2529 self::sendProfile($importer["uid"], array($contact_record));
2537 * @brief Fetches a message with a given guid
2539 * @param string $guid message guid
2540 * @param string $orig_author handle of the original post
2541 * @param string $author handle of the sharer
2543 * @return array The fetched item
2545 private static function originalItem($guid, $orig_author, $author)
2547 // Do we already have this item?
2549 "SELECT `body`, `tag`, `app`, `created`, `object-type`, `uri`, `guid`,
2550 `author-name`, `author-link`, `author-avatar`
2551 FROM `item` WHERE `guid` = '%s' AND `visible` AND NOT `deleted` AND `body` != '' LIMIT 1",
2555 if (DBM::is_result($r)) {
2556 logger("reshared message ".$guid." already exists on system.");
2558 // Maybe it is already a reshared item?
2559 // Then refetch the content, if it is a reshare from a reshare.
2560 // If it is a reshared post from another network then reformat to avoid display problems with two share elements
2561 if (self::isReshare($r[0]["body"], true)) {
2563 } elseif (self::isReshare($r[0]["body"], false) || strstr($r[0]["body"], "[share")) {
2564 $r[0]["body"] = diaspora2bb(bb2diaspora($r[0]["body"]));
2566 $r[0]["body"] = self::replacePeopleGuid($r[0]["body"], $r[0]["author-link"]);
2568 // Add OEmbed and other information to the body
2569 $r[0]["body"] = add_page_info_to_body($r[0]["body"], false, true);
2577 if (!DBM::is_result($r)) {
2578 $server = "https://".substr($orig_author, strpos($orig_author, "@") + 1);
2579 logger("1st try: reshared message ".$guid." will be fetched via SSL from the server ".$server);
2580 $item_id = self::storeByGuid($guid, $server);
2583 $server = "http://".substr($orig_author, strpos($orig_author, "@") + 1);
2584 logger("2nd try: reshared message ".$guid." will be fetched without SLL from the server ".$server);
2585 $item_id = self::storeByGuid($guid, $server);
2590 "SELECT `body`, `tag`, `app`, `created`, `object-type`, `uri`, `guid`,
2591 `author-name`, `author-link`, `author-avatar`
2592 FROM `item` WHERE `id` = %d AND `visible` AND NOT `deleted` AND `body` != '' LIMIT 1",
2596 if (DBM::is_result($r)) {
2597 // If it is a reshared post from another network then reformat to avoid display problems with two share elements
2598 if (self::isReshare($r[0]["body"], false)) {
2599 $r[0]["body"] = diaspora2bb(bb2diaspora($r[0]["body"]));
2600 $r[0]["body"] = self::replacePeopleGuid($r[0]["body"], $r[0]["author-link"]);
2611 * @brief Processes a reshare message
2613 * @param array $importer Array of the importer user
2614 * @param object $data The message object
2615 * @param string $xml The original XML of the message
2617 * @return int the message id
2619 private static function receiveReshare($importer, $data, $xml)
2621 $author = notags(unxmlify($data->author));
2622 $guid = notags(unxmlify($data->guid));
2623 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
2624 $root_author = notags(unxmlify($data->root_author));
2625 $root_guid = notags(unxmlify($data->root_guid));
2626 /// @todo handle unprocessed property "provider_display_name"
2627 $public = notags(unxmlify($data->public));
2629 $contact = self::allowedContactByHandle($importer, $author, false);
2634 $message_id = self::messageExists($importer["uid"], $guid);
2639 $original_item = self::originalItem($root_guid, $root_author, $author);
2640 if (!$original_item) {
2644 $orig_url = System::baseUrl()."/display/".$original_item["guid"];
2646 $datarray = array();
2648 $datarray["uid"] = $importer["uid"];
2649 $datarray["contact-id"] = $contact["id"];
2650 $datarray["network"] = NETWORK_DIASPORA;
2652 $datarray["author-name"] = $contact["name"];
2653 $datarray["author-link"] = $contact["url"];
2654 $datarray["author-avatar"] = ((x($contact, "thumb")) ? $contact["thumb"] : $contact["photo"]);
2656 $datarray["owner-name"] = $datarray["author-name"];
2657 $datarray["owner-link"] = $datarray["author-link"];
2658 $datarray["owner-avatar"] = $datarray["author-avatar"];
2660 $datarray["guid"] = $guid;
2661 $datarray["uri"] = $datarray["parent-uri"] = self::getUriFromGuid($author, $guid);
2663 $datarray["verb"] = ACTIVITY_POST;
2664 $datarray["gravity"] = GRAVITY_PARENT;
2666 $datarray["protocol"] = PROTOCOL_DIASPORA;
2667 $datarray["source"] = $xml;
2669 $prefix = share_header(
2670 $original_item["author-name"],
2671 $original_item["author-link"],
2672 $original_item["author-avatar"],
2673 $original_item["guid"],
2674 $original_item["created"],
2677 $datarray["body"] = $prefix.$original_item["body"]."[/share]";
2679 $datarray["tag"] = $original_item["tag"];
2680 $datarray["app"] = $original_item["app"];
2682 $datarray["plink"] = self::plink($author, $guid);
2683 $datarray["private"] = (($public == "false") ? 1 : 0);
2684 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
2686 $datarray["object-type"] = $original_item["object-type"];
2688 self::fetchGuid($datarray);
2689 $message_id = item_store($datarray);
2691 self::sendParticipation($contact, $datarray);
2694 logger("Stored reshare ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
2702 * @brief Processes retractions
2704 * @param array $importer Array of the importer user
2705 * @param array $contact The contact of the item owner
2706 * @param object $data The message object
2708 * @return bool success
2710 private static function itemRetraction($importer, $contact, $data)
2712 $author = notags(unxmlify($data->author));
2713 $target_guid = notags(unxmlify($data->target_guid));
2714 $target_type = notags(unxmlify($data->target_type));
2716 $person = self::personByHandle($author);
2717 if (!is_array($person)) {
2718 logger("unable to find author detail for ".$author);
2722 if (empty($contact["url"])) {
2723 $contact["url"] = $person["url"];
2726 // Fetch items that are about to be deleted
2727 $fields = array('uid', 'id', 'parent', 'parent-uri', 'author-link');
2729 // When we receive a public retraction, we delete every item that we find.
2730 if ($importer['uid'] == 0) {
2731 $condition = array("`guid` = ? AND NOT `file` LIKE '%%[%%' AND NOT `deleted`", $target_guid);
2733 $condition = array("`guid` = ? AND `uid` = ? AND NOT `file` LIKE '%%[%%' AND NOT `deleted`", $target_guid, $importer['uid']);
2735 $r = dba::select('item', $fields, $condition);
2736 if (!DBM::is_result($r)) {
2737 logger("Target guid ".$target_guid." was not found on this system for user ".$importer['uid'].".");
2741 while ($item = dba::fetch($r)) {
2742 // Fetch the parent item
2743 $parent = dba::select('item', array('author-link', 'origin'), array('id' => $item["parent"]), array('limit' => 1));
2745 // Only delete it if the parent author really fits
2746 if (!link_compare($parent["author-link"], $contact["url"]) && !link_compare($item["author-link"], $contact["url"])) {
2747 logger("Thread author ".$parent["author-link"]." and item author ".$item["author-link"]." don't fit to expected contact ".$contact["url"], LOGGER_DEBUG);
2751 // Currently we don't have a central deletion function that we could use in this case.
2752 // The function "item_drop" doesn't work for that case
2759 'edited' => datetime_convert(),
2760 'changed' => datetime_convert()),
2761 array('id' => $item["id"])
2764 // Delete the thread - if it is a starting post and not a comment
2765 if ($target_type != 'Comment') {
2766 delete_thread($item["id"], $item["parent-uri"]);
2769 logger("Deleted target ".$target_guid." (".$item["id"].") from user ".$item["uid"]." parent: ".$item["parent"], LOGGER_DEBUG);
2771 // Now check if the retraction needs to be relayed by us
2772 if ($parent["origin"]) {
2774 Worker::add(PRIORITY_HIGH, "Notifier", "drop", $item["id"]);
2782 * @brief Receives retraction messages
2784 * @param array $importer Array of the importer user
2785 * @param string $sender The sender of the message
2786 * @param object $data The message object
2788 * @return bool Success
2790 private static function receiveRetraction($importer, $sender, $data)
2792 $target_type = notags(unxmlify($data->target_type));
2794 $contact = self::contactByHandle($importer["uid"], $sender);
2795 if (!$contact && (in_array($target_type, array("Contact", "Person")))) {
2796 logger("cannot find contact for sender: ".$sender." and user ".$importer["uid"]);
2800 logger("Got retraction for ".$target_type.", sender ".$sender." and user ".$importer["uid"], LOGGER_DEBUG);
2802 switch ($target_type) {
2807 case "StatusMessage":
2808 return self::itemRetraction($importer, $contact, $data);
2812 /// @todo What should we do with an "unshare"?
2813 // Removing the contact isn't correct since we still can read the public items
2814 Contact::remove($contact["id"]);
2818 logger("Unknown target type ".$target_type);
2825 * @brief Receives status messages
2827 * @param array $importer Array of the importer user
2828 * @param object $data The message object
2829 * @param string $xml The original XML of the message
2831 * @return int The message id of the newly created item
2833 private static function receiveStatusMessage($importer, $data, $xml)
2835 $author = notags(unxmlify($data->author));
2836 $guid = notags(unxmlify($data->guid));
2837 $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
2838 $public = notags(unxmlify($data->public));
2839 $text = unxmlify($data->text);
2840 $provider_display_name = notags(unxmlify($data->provider_display_name));
2842 $contact = self::allowedContactByHandle($importer, $author, false);
2847 $message_id = self::messageExists($importer["uid"], $guid);
2853 if ($data->location) {
2854 foreach ($data->location->children() as $fieldname => $data) {
2855 $address[$fieldname] = notags(unxmlify($data));
2859 $body = diaspora2bb($text);
2861 $datarray = array();
2863 // Attach embedded pictures to the body
2865 foreach ($data->photo as $photo) {
2866 $body = "[img]".unxmlify($photo->remote_photo_path).
2867 unxmlify($photo->remote_photo_name)."[/img]\n".$body;
2870 $datarray["object-type"] = ACTIVITY_OBJ_IMAGE;
2872 $datarray["object-type"] = ACTIVITY_OBJ_NOTE;
2874 // Add OEmbed and other information to the body
2875 if (!self::isRedmatrix($contact["url"])) {
2876 $body = add_page_info_to_body($body, false, true);
2880 /// @todo enable support for polls
2881 //if ($data->poll) {
2882 // foreach ($data->poll AS $poll)
2887 /// @todo enable support for events
2889 $datarray["uid"] = $importer["uid"];
2890 $datarray["contact-id"] = $contact["id"];
2891 $datarray["network"] = NETWORK_DIASPORA;
2893 $datarray["author-name"] = $contact["name"];
2894 $datarray["author-link"] = $contact["url"];
2895 $datarray["author-avatar"] = ((x($contact, "thumb")) ? $contact["thumb"] : $contact["photo"]);
2897 $datarray["owner-name"] = $datarray["author-name"];
2898 $datarray["owner-link"] = $datarray["author-link"];
2899 $datarray["owner-avatar"] = $datarray["author-avatar"];
2901 $datarray["guid"] = $guid;
2902 $datarray["uri"] = $datarray["parent-uri"] = self::getUriFromGuid($author, $guid);
2904 $datarray["verb"] = ACTIVITY_POST;
2905 $datarray["gravity"] = GRAVITY_PARENT;
2907 $datarray["protocol"] = PROTOCOL_DIASPORA;
2908 $datarray["source"] = $xml;
2910 $datarray["body"] = self::replacePeopleGuid($body, $contact["url"]);
2912 if ($provider_display_name != "") {
2913 $datarray["app"] = $provider_display_name;
2916 $datarray["plink"] = self::plink($author, $guid);
2917 $datarray["private"] = (($public == "false") ? 1 : 0);
2918 $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
2920 if (isset($address["address"])) {
2921 $datarray["location"] = $address["address"];
2924 if (isset($address["lat"]) && isset($address["lng"])) {
2925 $datarray["coord"] = $address["lat"]." ".$address["lng"];
2928 self::fetchGuid($datarray);
2929 $message_id = item_store($datarray);
2931 self::sendParticipation($contact, $datarray);
2934 logger("Stored item ".$datarray["guid"]." with message id ".$message_id, LOGGER_DEBUG);
2941 /* ************************************************************************************** *
2942 * Here are all the functions that are needed to transmit data with the Diaspora protocol *
2943 * ************************************************************************************** */
2946 * @brief returnes the handle of a contact
2948 * @param array $contact contact array
2950 * @return string the handle in the format user@domain.tld
2952 private static function myHandle($contact)
2954 if ($contact["addr"] != "") {
2955 return $contact["addr"];
2958 // Normally we should have a filled "addr" field - but in the past this wasn't the case
2959 // So - just in case - we build the the address here.
2960 if ($contact["nickname"] != "") {
2961 $nick = $contact["nickname"];
2963 $nick = $contact["nick"];
2966 return $nick."@".substr(System::baseUrl(), strpos(System::baseUrl(), "://") + 3);
2971 * @brief Creates the data for a private message in the new format
2973 * @param string $msg The message that is to be transmitted
2974 * @param array $user The record of the sender
2975 * @param array $contact Target of the communication
2976 * @param string $prvkey The private key of the sender
2977 * @param string $pubkey The public key of the receiver
2979 * @return string The encrypted data
2981 public static function encodePrivateData($msg, $user, $contact, $prvkey, $pubkey)
2983 logger("Message: ".$msg, LOGGER_DATA);
2985 // without a public key nothing will work
2987 logger("pubkey missing: contact id: ".$contact["id"]);
2991 $aes_key = openssl_random_pseudo_bytes(32);
2992 $b_aes_key = base64_encode($aes_key);
2993 $iv = openssl_random_pseudo_bytes(16);
2994 $b_iv = base64_encode($iv);
2996 $ciphertext = self::aesEncrypt($aes_key, $iv, $msg);
2998 $json = json_encode(array("iv" => $b_iv, "key" => $b_aes_key));
3000 $encrypted_key_bundle = "";
3001 openssl_public_encrypt($json, $encrypted_key_bundle, $pubkey);
3003 $json_object = json_encode(
3004 array("aes_key" => base64_encode($encrypted_key_bundle),
3005 "encrypted_magic_envelope" => base64_encode($ciphertext))
3008 return $json_object;
3012 * @brief Creates the envelope for the "fetch" endpoint and for the new format
3014 * @param string $msg The message that is to be transmitted
3015 * @param array $user The record of the sender
3017 * @return string The envelope
3019 public static function buildMagicEnvelope($msg, $user)
3021 $b64url_data = base64url_encode($msg);
3022 $data = str_replace(array("\n", "\r", " ", "\t"), array("", "", "", ""), $b64url_data);
3024 $key_id = base64url_encode(self::myHandle($user));
3025 $type = "application/xml";
3026 $encoding = "base64url";
3027 $alg = "RSA-SHA256";
3028 $signable_data = $data.".".base64url_encode($type).".".base64url_encode($encoding).".".base64url_encode($alg);
3030 // Fallback if the private key wasn't transmitted in the expected field
3031 if ($user['uprvkey'] == "") {
3032 $user['uprvkey'] = $user['prvkey'];
3035 $signature = rsa_sign($signable_data, $user["uprvkey"]);
3036 $sig = base64url_encode($signature);
3038 $xmldata = array("me:env" => array("me:data" => $data,
3039 "@attributes" => array("type" => $type),
3040 "me:encoding" => $encoding,
3043 "@attributes2" => array("key_id" => $key_id)));
3045 $namespaces = array("me" => "http://salmon-protocol.org/ns/magic-env");
3047 return XML::fromArray($xmldata, $xml, false, $namespaces);
3051 * @brief Create the envelope for a message
3053 * @param string $msg The message that is to be transmitted
3054 * @param array $user The record of the sender
3055 * @param array $contact Target of the communication
3056 * @param string $prvkey The private key of the sender
3057 * @param string $pubkey The public key of the receiver
3058 * @param bool $public Is the message public?
3060 * @return string The message that will be transmitted to other servers
3062 private static function buildMessage($msg, $user, $contact, $prvkey, $pubkey, $public = false)
3064 // The message is put into an envelope with the sender's signature
3065 $envelope = self::buildMagicEnvelope($msg, $user);
3067 // Private messages are put into a second envelope, encrypted with the receivers public key
3069 $envelope = self::encodePrivateData($envelope, $user, $contact, $prvkey, $pubkey);
3076 * @brief Creates a signature for a message
3078 * @param array $owner the array of the owner of the message
3079 * @param array $message The message that is to be signed
3081 * @return string The signature
3083 private static function signature($owner, $message)
3086 unset($sigmsg["author_signature"]);
3087 unset($sigmsg["parent_author_signature"]);
3089 $signed_text = implode(";", $sigmsg);
3091 return base64_encode(rsa_sign($signed_text, $owner["uprvkey"], "sha256"));
3095 * @brief Transmit a message to a target server
3097 * @param array $owner the array of the item owner
3098 * @param array $contact Target of the communication
3099 * @param string $envelope The message that is to be transmitted
3100 * @param bool $public_batch Is it a public post?
3101 * @param bool $queue_run Is the transmission called from the queue?
3102 * @param string $guid message guid
3104 * @return int Result of the transmission
3106 public static function transmit($owner, $contact, $envelope, $public_batch, $queue_run = false, $guid = "")
3110 $enabled = intval(Config::get("system", "diaspora_enabled"));
3115 $logid = random_string(4);
3116 $dest_url = (($public_batch) ? $contact["batch"] : $contact["notify"]);
3118 logger("no url for contact: ".$contact["id"]." batch mode =".$public_batch);
3122 logger("transmit: ".$logid."-".$guid." ".$dest_url);
3124 if (!$queue_run && was_recently_delayed($contact["id"])) {
3127 if (!intval(Config::get("system", "diaspora_test"))) {
3128 $content_type = (($public_batch) ? "application/magic-envelope+xml" : "application/json");
3130 post_url($dest_url."/", $envelope, array("Content-Type: ".$content_type));
3131 $return_code = $a->get_curl_code();
3133 logger("test_mode");
3138 logger("transmit: ".$logid."-".$guid." returns: ".$return_code);
3140 if (!$return_code || (($return_code == 503) && (stristr($a->get_curl_headers(), "retry-after")))) {
3141 logger("queue message");
3144 "SELECT `id` FROM `queue` WHERE `cid` = %d AND `network` = '%s' AND `content` = '%s' AND `batch` = %d LIMIT 1",
3145 intval($contact["id"]),
3146 dbesc(NETWORK_DIASPORA),
3148 intval($public_batch)
3151 logger("add_to_queue ignored - identical item already in queue");
3153 // queue message for redelivery
3154 add_to_queue($contact["id"], NETWORK_DIASPORA, $envelope, $public_batch);
3156 // The message could not be delivered. We mark the contact as "dead"
3157 Contact::markForArchival($contact);
3159 } elseif (($return_code >= 200) && ($return_code <= 299)) {
3160 // We successfully delivered a message, the contact is alive
3161 Contact::unmarkForArchival($contact);
3164 return(($return_code) ? $return_code : (-1));
3169 * @brief Build the post xml
3171 * @param string $type The message type
3172 * @param array $message The message data
3174 * @return string The post XML
3176 public static function buildPostXml($type, $message)
3178 $data = array($type => $message);
3180 return XML::fromArray($data, $xml);
3184 * @brief Builds and transmit messages
3186 * @param array $owner the array of the item owner
3187 * @param array $contact Target of the communication
3188 * @param string $type The message type
3189 * @param array $message The message data
3190 * @param bool $public_batch Is it a public post?
3191 * @param string $guid message guid
3192 * @param bool $spool Should the transmission be spooled or transmitted?
3194 * @return int Result of the transmission
3196 private static function buildAndTransmit($owner, $contact, $type, $message, $public_batch = false, $guid = "", $spool = false)
3198 $msg = self::buildPostXml($type, $message);
3200 logger('message: '.$msg, LOGGER_DATA);
3201 logger('send guid '.$guid, LOGGER_DEBUG);
3203 // Fallback if the private key wasn't transmitted in the expected field
3204 if ($owner['uprvkey'] == "") {
3205 $owner['uprvkey'] = $owner['prvkey'];
3208 $envelope = self::buildMessage($msg, $owner, $contact, $owner['uprvkey'], $contact['pubkey'], $public_batch);
3211 add_to_queue($contact['id'], NETWORK_DIASPORA, $envelope, $public_batch);
3214 $return_code = self::transmit($owner, $contact, $envelope, $public_batch, false, $guid);
3217 logger("guid: ".$guid." result ".$return_code, LOGGER_DEBUG);
3219 return $return_code;
3223 * @brief sends a participation (Used to get all further updates)
3225 * @param array $contact Target of the communication
3226 * @param array $item Item array
3228 * @return int The result of the transmission
3230 private static function sendParticipation($contact, $item)
3232 // Don't send notifications for private postings
3233 if ($item['private']) {
3237 $cachekey = "diaspora:sendParticipation:".$item['guid'];
3239 $result = Cache::get($cachekey);
3240 if (!is_null($result)) {
3244 // Fetch some user id to have a valid handle to transmit the participation.
3245 // In fact it doesn't matter which user sends this - but it is needed by the protocol.
3246 // If the item belongs to a user, we take this user id.
3247 if ($item['uid'] == 0) {
3248 $condition = ['verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false];
3249 $first_user = dba::select('user', ['uid'], $condition, ['limit' => 1]);
3250 $owner = User::getOwnerDataById($first_user['uid']);
3252 $owner = User::getOwnerDataById($item['uid']);
3255 $author = self::myHandle($owner);
3257 $message = array("author" => $author,
3258 "guid" => get_guid(32),
3259 "parent_type" => "Post",
3260 "parent_guid" => $item["guid"]);
3262 logger("Send participation for ".$item["guid"]." by ".$author, LOGGER_DEBUG);
3264 // It doesn't matter what we store, we only want to avoid sending repeated notifications for the same item
3265 Cache::set($cachekey, $item["guid"], CACHE_QUARTER_HOUR);
3267 return self::buildAndTransmit($owner, $contact, "participation", $message);
3271 * @brief sends an account migration
3273 * @param array $owner the array of the item owner
3274 * @param array $contact Target of the communication
3275 * @param int $uid User ID
3277 * @return int The result of the transmission
3279 public static function sendAccountMigration($owner, $contact, $uid)
3281 $old_handle = PConfig::get($uid, 'system', 'previous_addr');
3282 $profile = self::createProfileData($uid);
3284 $signed_text = 'AccountMigration:'.$old_handle.':'.$profile['author'];
3285 $signature = base64_encode(rsa_sign($signed_text, $owner["uprvkey"], "sha256"));
3287 $message = array("author" => $old_handle,
3288 "profile" => $profile,
3289 "signature" => $signature);
3291 logger("Send account migration ".print_r($message, true), LOGGER_DEBUG);
3293 return self::buildAndTransmit($owner, $contact, "account_migration", $message);
3297 * @brief Sends a "share" message
3299 * @param array $owner the array of the item owner
3300 * @param array $contact Target of the communication
3302 * @return int The result of the transmission
3304 public static function sendShare($owner, $contact)
3307 * @todo support the different possible combinations of "following" and "sharing"
3308 * Currently, Diaspora only interprets the "sharing" field
3310 * Before switching this code productive, we have to check all "sendShare" calls if "rel" is set correctly
3314 switch ($contact["rel"]) {
3315 case CONTACT_IS_FRIEND:
3318 case CONTACT_IS_SHARING:
3321 case CONTACT_IS_FOLLOWER:
3327 $message = array("author" => self::myHandle($owner),
3328 "recipient" => $contact["addr"],
3329 "following" => "true",
3330 "sharing" => "true");
3332 logger("Send share ".print_r($message, true), LOGGER_DEBUG);
3334 return self::buildAndTransmit($owner, $contact, "contact", $message);
3338 * @brief sends an "unshare"
3340 * @param array $owner the array of the item owner
3341 * @param array $contact Target of the communication
3343 * @return int The result of the transmission
3345 public static function sendUnshare($owner, $contact)
3347 $message = array("author" => self::myHandle($owner),
3348 "recipient" => $contact["addr"],
3349 "following" => "false",
3350 "sharing" => "false");
3352 logger("Send unshare ".print_r($message, true), LOGGER_DEBUG);
3354 return self::buildAndTransmit($owner, $contact, "contact", $message);
3358 * @brief Checks a message body if it is a reshare
3360 * @param string $body The message body that is to be check
3361 * @param bool $complete Should it be a complete check or a simple check?
3363 * @return array|bool Reshare details or "false" if no reshare
3365 public static function isReshare($body, $complete = true)
3367 $body = trim($body);
3369 // Skip if it isn't a pure repeated messages
3370 // Does it start with a share?
3371 if ((strpos($body, "[share") > 0) && $complete) {
3375 // Does it end with a share?
3376 if (strlen($body) > (strrpos($body, "[/share]") + 8)) {
3380 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
3381 // Skip if there is no shared message in there
3382 if ($body == $attributes) {
3386 // If we don't do the complete check we quit here
3392 preg_match("/guid='(.*?)'/ism", $attributes, $matches);
3393 if ($matches[1] != "") {
3394 $guid = $matches[1];
3397 preg_match('/guid="(.*?)"/ism', $attributes, $matches);
3398 if ($matches[1] != "") {
3399 $guid = $matches[1];
3404 "SELECT `contact-id` FROM `item` WHERE `guid` = '%s' AND `network` IN ('%s', '%s') LIMIT 1",
3411 $ret["root_handle"] = self::handleFromContact($r[0]["contact-id"]);
3412 $ret["root_guid"] = $guid;
3418 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
3419 if ($matches[1] != "") {
3420 $profile = $matches[1];
3423 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
3424 if ($matches[1] != "") {
3425 $profile = $matches[1];
3430 $ret["root_handle"] = preg_replace("=https?://(.*)/u/(.*)=ism", "$2@$1", $profile);
3431 if (($ret["root_handle"] == $profile) || ($ret["root_handle"] == "")) {
3436 preg_match("/link='(.*?)'/ism", $attributes, $matches);
3437 if ($matches[1] != "") {
3438 $link = $matches[1];
3441 preg_match('/link="(.*?)"/ism', $attributes, $matches);
3442 if ($matches[1] != "") {
3443 $link = $matches[1];
3446 $ret["root_guid"] = preg_replace("=https?://(.*)/posts/(.*)=ism", "$2", $link);
3447 if (($ret["root_guid"] == $link) || (trim($ret["root_guid"]) == "")) {
3455 * @brief Create an event array
3457 * @param integer $event_id The id of the event
3459 * @return array with event data
3461 private static function buildEvent($event_id)
3463 $r = q("SELECT `guid`, `uid`, `start`, `finish`, `nofinish`, `summary`, `desc`, `location`, `adjust` FROM `event` WHERE `id` = %d", intval($event_id));
3464 if (!DBM::is_result($r)) {
3470 $eventdata = array();
3472 $r = q("SELECT `timezone` FROM `user` WHERE `uid` = %d", intval($event['uid']));
3473 if (!DBM::is_result($r)) {
3479 $r = q("SELECT `addr`, `nick` FROM `contact` WHERE `uid` = %d AND `self`", intval($event['uid']));
3480 if (!DBM::is_result($r)) {
3486 $eventdata['author'] = self::myHandle($owner);
3488 if ($event['guid']) {
3489 $eventdata['guid'] = $event['guid'];
3492 $mask = 'Y-m-d\TH:i:s\Z';
3494 /// @todo - establish "all day" events in Friendica
3495 $eventdata["all_day"] = "false";
3497 if (!$event['adjust']) {
3498 $eventdata['timezone'] = $user['timezone'];
3500 if ($eventdata['timezone'] == "") {
3501 $eventdata['timezone'] = 'UTC';
3505 if ($event['start']) {
3506 $eventdata['start'] = datetime_convert($eventdata['timezone'], "UTC", $event['start'], $mask);
3508 if ($event['finish'] && !$event['nofinish']) {
3509 $eventdata['end'] = datetime_convert($eventdata['timezone'], "UTC", $event['finish'], $mask);
3511 if ($event['summary']) {
3512 $eventdata['summary'] = html_entity_decode(bb2diaspora($event['summary']));
3514 if ($event['desc']) {
3515 $eventdata['description'] = html_entity_decode(bb2diaspora($event['desc']));
3517 if ($event['location']) {
3518 $location = array();
3519 $location["address"] = html_entity_decode(bb2diaspora($event['location']));
3520 $location["lat"] = 0;
3521 $location["lng"] = 0;
3522 $eventdata['location'] = $location;
3529 * @brief Create a post (status message or reshare)
3531 * @param array $item The item that will be exported
3532 * @param array $owner the array of the item owner
3535 * 'type' -> Message type ("status_message" or "reshare")
3536 * 'message' -> Array of XML elements of the status
3538 public static function buildStatus($item, $owner)
3540 $cachekey = "diaspora:buildStatus:".$item['guid'];
3542 $result = Cache::get($cachekey);
3543 if (!is_null($result)) {
3547 $myaddr = self::myHandle($owner);
3549 $public = (($item["private"]) ? "false" : "true");
3551 $created = datetime_convert("UTC", "UTC", $item["created"], 'Y-m-d\TH:i:s\Z');
3553 // Detect a share element and do a reshare
3554 if (!$item['private'] && ($ret = self::isReshare($item["body"]))) {
3555 $message = array("author" => $myaddr,
3556 "guid" => $item["guid"],
3557 "created_at" => $created,
3558 "root_author" => $ret["root_handle"],
3559 "root_guid" => $ret["root_guid"],
3560 "provider_display_name" => $item["app"],
3561 "public" => $public);
3565 $title = $item["title"];
3566 $body = $item["body"];
3568 // convert to markdown
3569 $body = html_entity_decode(bb2diaspora($body));
3572 if (strlen($title)) {
3573 $body = "## ".html_entity_decode($title)."\n\n".$body;
3576 if ($item["attach"]) {
3577 $cnt = preg_match_all('/href=\"(.*?)\"(.*?)title=\"(.*?)\"/ism', $item["attach"], $matches, PREG_SET_ORDER);
3579 $body .= "\n".t("Attachments:")."\n";
3580 foreach ($matches as $mtch) {
3581 $body .= "[".$mtch[3]."](".$mtch[1].")\n";
3586 $location = array();
3588 if ($item["location"] != "")
3589 $location["address"] = $item["location"];
3591 if ($item["coord"] != "") {
3592 $coord = explode(" ", $item["coord"]);
3593 $location["lat"] = $coord[0];
3594 $location["lng"] = $coord[1];
3597 $message = array("author" => $myaddr,
3598 "guid" => $item["guid"],
3599 "created_at" => $created,
3600 "public" => $public,
3602 "provider_display_name" => $item["app"],
3603 "location" => $location);
3605 // Diaspora rejects messages when they contain a location without "lat" or "lng"
3606 if (!isset($location["lat"]) || !isset($location["lng"])) {
3607 unset($message["location"]);
3610 if ($item['event-id'] > 0) {
3611 $event = self::buildEvent($item['event-id']);
3612 if (count($event)) {
3613 $message['event'] = $event;
3615 /// @todo Once Diaspora supports it, we will remove the body
3616 // $message['text'] = '';
3620 $type = "status_message";
3623 $msg = array("type" => $type, "message" => $message);
3625 Cache::set($cachekey, $msg, CACHE_QUARTER_HOUR);
3631 * @brief Sends a post
3633 * @param array $item The item that will be exported
3634 * @param array $owner the array of the item owner
3635 * @param array $contact Target of the communication
3636 * @param bool $public_batch Is it a public post?
3638 * @return int The result of the transmission
3640 public static function sendStatus($item, $owner, $contact, $public_batch = false)
3642 $status = self::buildStatus($item, $owner);
3644 return self::buildAndTransmit($owner, $contact, $status["type"], $status["message"], $public_batch, $item["guid"]);
3648 * @brief Creates a "like" object
3650 * @param array $item The item that will be exported
3651 * @param array $owner the array of the item owner
3653 * @return array The data for a "like"
3655 private static function constructLike($item, $owner)
3658 "SELECT `guid`, `uri`, `parent-uri` FROM `item` WHERE `uri` = '%s' LIMIT 1",
3659 dbesc($item["thr-parent"])
3661 if (!DBM::is_result($p)) {
3667 $target_type = ($parent["uri"] === $parent["parent-uri"] ? "Post" : "Comment");
3668 if ($item['verb'] === ACTIVITY_LIKE) {
3670 } elseif ($item['verb'] === ACTIVITY_DISLIKE) {
3671 $positive = "false";
3674 return(array("author" => self::myHandle($owner),
3675 "guid" => $item["guid"],
3676 "parent_guid" => $parent["guid"],
3677 "parent_type" => $target_type,
3678 "positive" => $positive,
3679 "author_signature" => ""));
3683 * @brief Creates an "EventParticipation" object
3685 * @param array $item The item that will be exported
3686 * @param array $owner the array of the item owner
3688 * @return array The data for an "EventParticipation"
3690 private static function constructAttend($item, $owner)
3693 "SELECT `guid`, `uri`, `parent-uri` FROM `item` WHERE `uri` = '%s' LIMIT 1",
3694 dbesc($item["thr-parent"])
3696 if (!DBM::is_result($p)) {
3702 switch ($item['verb']) {
3703 case ACTIVITY_ATTEND:
3704 $attend_answer = 'accepted';
3706 case ACTIVITY_ATTENDNO:
3707 $attend_answer = 'declined';
3709 case ACTIVITY_ATTENDMAYBE:
3710 $attend_answer = 'tentative';
3713 logger('Unknown verb '.$item['verb'].' in item '.$item['guid']);
3717 return(array("author" => self::myHandle($owner),
3718 "guid" => $item["guid"],
3719 "parent_guid" => $parent["guid"],
3720 "status" => $attend_answer,
3721 "author_signature" => ""));
3725 * @brief Creates the object for a comment
3727 * @param array $item The item that will be exported
3728 * @param array $owner the array of the item owner
3730 * @return array The data for a comment
3732 private static function constructComment($item, $owner)
3734 $cachekey = "diaspora:constructComment:".$item['guid'];
3736 $result = Cache::get($cachekey);
3737 if (!is_null($result)) {
3742 "SELECT `guid` FROM `item` WHERE `parent` = %d AND `id` = %d LIMIT 1",
3743 intval($item["parent"]),
3744 intval($item["parent"])
3747 if (!DBM::is_result($p)) {
3753 $text = html_entity_decode(bb2diaspora($item["body"]));
3754 $created = datetime_convert("UTC", "UTC", $item["created"], 'Y-m-d\TH:i:s\Z');
3756 $comment = array("author" => self::myHandle($owner),
3757 "guid" => $item["guid"],
3758 "created_at" => $created,
3759 "parent_guid" => $parent["guid"],
3761 "author_signature" => "");
3763 // Send the thread parent guid only if it is a threaded comment
3764 if ($item['thr-parent'] != $item['parent-uri']) {
3765 $comment['thread_parent_guid'] = self::getGuidFromUri($item['thr-parent'], $item['uid']);
3768 Cache::set($cachekey, $comment, CACHE_QUARTER_HOUR);
3774 * @brief Send a like or a comment
3776 * @param array $item The item that will be exported
3777 * @param array $owner the array of the item owner
3778 * @param array $contact Target of the communication
3779 * @param bool $public_batch Is it a public post?
3781 * @return int The result of the transmission
3783 public static function sendFollowup($item, $owner, $contact, $public_batch = false)
3785 if (in_array($item['verb'], array(ACTIVITY_ATTEND, ACTIVITY_ATTENDNO, ACTIVITY_ATTENDMAYBE))) {
3786 $message = self::constructAttend($item, $owner);
3787 $type = "event_participation";
3788 } elseif (in_array($item["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
3789 $message = self::constructLike($item, $owner);
3792 $message = self::constructComment($item, $owner);
3800 $message["author_signature"] = self::signature($owner, $message);
3802 return self::buildAndTransmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
3806 * @brief Creates a message from a signature record entry
3808 * @param array $item The item that will be exported
3809 * @param array $signature The entry of the "sign" record
3811 * @return string The message
3813 private static function messageFromSignature($item, $signature)
3815 // Split the signed text
3816 $signed_parts = explode(";", $signature['signed_text']);
3818 if ($item["deleted"]) {
3819 $message = array("author" => $signature['signer'],
3820 "target_guid" => $signed_parts[0],
3821 "target_type" => $signed_parts[1]);
3822 } elseif (in_array($item["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
3823 $message = array("author" => $signed_parts[4],
3824 "guid" => $signed_parts[1],
3825 "parent_guid" => $signed_parts[3],
3826 "parent_type" => $signed_parts[2],
3827 "positive" => $signed_parts[0],
3828 "author_signature" => $signature['signature'],
3829 "parent_author_signature" => "");
3831 // Remove the comment guid
3832 $guid = array_shift($signed_parts);
3834 // Remove the parent guid
3835 $parent_guid = array_shift($signed_parts);
3837 // Remove the handle
3838 $handle = array_pop($signed_parts);
3840 // Glue the parts together
3841 $text = implode(";", $signed_parts);
3843 $message = array("author" => $handle,
3845 "parent_guid" => $parent_guid,
3846 "text" => implode(";", $signed_parts),
3847 "author_signature" => $signature['signature'],
3848 "parent_author_signature" => "");
3854 * @brief Relays messages (like, comment, retraction) to other servers if we are the thread owner
3856 * @param array $item The item that will be exported
3857 * @param array $owner the array of the item owner
3858 * @param array $contact Target of the communication
3859 * @param bool $public_batch Is it a public post?
3861 * @return int The result of the transmission
3863 public static function sendRelay($item, $owner, $contact, $public_batch = false)
3865 if ($item["deleted"]) {
3866 return self::sendRetraction($item, $owner, $contact, $public_batch, true);
3867 } elseif (in_array($item["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
3873 logger("Got relayable data ".$type." for item ".$item["guid"]." (".$item["id"].")", LOGGER_DEBUG);
3875 // fetch the original signature
3878 "SELECT `signed_text`, `signature`, `signer` FROM `sign` WHERE `iid` = %d LIMIT 1",
3883 logger("Couldn't fetch signatur for item ".$item["guid"]." (".$item["id"].")", LOGGER_DEBUG);
3889 // Old way - is used by the internal Friendica functions
3890 /// @todo Change all signatur storing functions to the new format
3891 if ($signature['signed_text'] && $signature['signature'] && $signature['signer']) {
3892 $message = self::messageFromSignature($item, $signature);
3894 $msg = json_decode($signature['signed_text'], true);
3897 if (is_array($msg)) {
3898 foreach ($msg as $field => $data) {
3899 if (!$item["deleted"]) {
3900 if ($field == "diaspora_handle") {
3903 if ($field == "target_type") {
3904 $field = "parent_type";
3908 $message[$field] = $data;
3911 logger("Signature text for item ".$item["guid"]." (".$item["id"].") couldn't be extracted: ".$signature['signed_text'], LOGGER_DEBUG);
3915 $message["parent_author_signature"] = self::signature($owner, $message);
3917 logger("Relayed data ".print_r($message, true), LOGGER_DEBUG);
3919 return self::buildAndTransmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
3923 * @brief Sends a retraction (deletion) of a message, like or comment
3925 * @param array $item The item that will be exported
3926 * @param array $owner the array of the item owner
3927 * @param array $contact Target of the communication
3928 * @param bool $public_batch Is it a public post?
3929 * @param bool $relay Is the retraction transmitted from a relay?
3931 * @return int The result of the transmission
3933 public static function sendRetraction($item, $owner, $contact, $public_batch = false, $relay = false)
3935 $itemaddr = self::handleFromContact($item["contact-id"], $item["gcontact-id"]);
3937 $msg_type = "retraction";
3939 if ($item['id'] == $item['parent']) {
3940 $target_type = "Post";
3941 } elseif (in_array($item["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
3942 $target_type = "Like";
3944 $target_type = "Comment";
3947 $message = array("author" => $itemaddr,
3948 "target_guid" => $item['guid'],
3949 "target_type" => $target_type);
3951 logger("Got message ".print_r($message, true), LOGGER_DEBUG);
3953 return self::buildAndTransmit($owner, $contact, $msg_type, $message, $public_batch, $item["guid"]);
3957 * @brief Sends a mail
3959 * @param array $item The item that will be exported
3960 * @param array $owner The owner
3961 * @param array $contact Target of the communication
3963 * @return int The result of the transmission
3965 public static function sendMail($item, $owner, $contact)
3967 $myaddr = self::myHandle($owner);
3970 "SELECT * FROM `conv` WHERE `id` = %d AND `uid` = %d LIMIT 1",
3971 intval($item["convid"]),
3972 intval($item["uid"])
3975 if (!DBM::is_result($r)) {
3976 logger("conversation not found.");
3982 "author" => $cnv["creator"],
3983 "guid" => $cnv["guid"],
3984 "subject" => $cnv["subject"],
3985 "created_at" => datetime_convert("UTC", "UTC", $cnv['created'], 'Y-m-d\TH:i:s\Z'),
3986 "participants" => $cnv["recips"]
3989 $body = bb2diaspora($item["body"]);
3990 $created = datetime_convert("UTC", "UTC", $item["created"], 'Y-m-d\TH:i:s\Z');
3993 "author" => $myaddr,
3994 "guid" => $item["guid"],
3995 "conversation_guid" => $cnv["guid"],
3997 "created_at" => $created,
4000 if ($item["reply"]) {
4005 "author" => $cnv["creator"],
4006 "guid" => $cnv["guid"],
4007 "subject" => $cnv["subject"],
4008 "created_at" => datetime_convert("UTC", "UTC", $cnv['created'], 'Y-m-d\TH:i:s\Z'),
4009 "participants" => $cnv["recips"],
4012 $type = "conversation";
4015 return self::buildAndTransmit($owner, $contact, $type, $message, false, $item["guid"]);
4019 * @brief Split a name into first name and last name
4021 * @param string $name The name
4023 * @return array The array with "first" and "last"
4025 public static function splitName($name) {
4026 $name = trim($name);
4028 // Is the name longer than 64 characters? Then cut the rest of it.
4029 if (strlen($name) > 64) {
4030 if ((strpos($name, ' ') <= 64) && (strpos($name, ' ') !== false)) {
4031 $name = trim(substr($name, 0, strrpos(substr($name, 0, 65), ' ')));
4033 $name = substr($name, 0, 64);
4037 // Take the first word as first name
4038 $first = ((strpos($name, ' ') ? trim(substr($name, 0, strpos($name, ' '))) : $name));
4039 $last = (($first === $name) ? '' : trim(substr($name, strlen($first))));
4040 if ((strlen($first) < 32) && (strlen($last) < 32)) {
4041 return ['first' => $first, 'last' => $last];
4044 // Take the last word as last name
4045 $first = ((strrpos($name, ' ') ? trim(substr($name, 0, strrpos($name, ' '))) : $name));
4046 $last = (($first === $name) ? '' : trim(substr($name, strlen($first))));
4048 if ((strlen($first) < 32) && (strlen($last) < 32)) {
4049 return ['first' => $first, 'last' => $last];
4052 // Take the first 32 characters if there is no space in the first 32 characters
4053 if ((strpos($name, ' ') > 32) || (strpos($name, ' ') === false)) {
4054 $first = substr($name, 0, 32);
4055 $last = substr($name, 32);
4056 return ['first' => $first, 'last' => $last];
4059 $first = trim(substr($name, 0, strrpos(substr($name, 0, 33), ' ')));
4060 $last = (($first === $name) ? '' : trim(substr($name, strlen($first))));
4062 // Check if the last name is longer than 32 characters
4063 if (strlen($last) > 32) {
4064 if (strpos($last, ' ') <= 32) {
4065 $last = trim(substr($last, 0, strrpos(substr($last, 0, 33), ' ')));
4067 $last = substr($last, 0, 32);
4071 return ['first' => $first, 'last' => $last];
4075 * @brief Create profile data
4077 * @param int $uid The user id
4079 * @return array The profile data
4081 private static function createProfileData($uid)
4084 "SELECT `profile`.`uid` AS `profile_uid`, `profile`.* , `user`.*, `user`.`prvkey` AS `uprvkey`, `contact`.`addr`
4086 INNER JOIN `user` ON `profile`.`uid` = `user`.`uid`
4087 INNER JOIN `contact` ON `profile`.`uid` = `contact`.`uid`
4088 WHERE `user`.`uid` = %d AND `profile`.`is-default` AND `contact`.`self` LIMIT 1",
4097 $handle = $profile["addr"];
4099 $split_name = self::splitName($profile['name']);
4100 $first = $split_name['first'];
4101 $last = $split_name['last'];
4103 $large = System::baseUrl().'/photo/custom/300/'.$profile['uid'].'.jpg';
4104 $medium = System::baseUrl().'/photo/custom/100/'.$profile['uid'].'.jpg';
4105 $small = System::baseUrl().'/photo/custom/50/' .$profile['uid'].'.jpg';
4106 $searchable = (($profile['publish'] && $profile['net-publish']) ? 'true' : 'false');
4108 if ($searchable === 'true') {
4109 $dob = '1000-00-00';
4111 if (($profile['dob']) && ($profile['dob'] > '0001-01-01')) {
4112 $dob = ((intval($profile['dob'])) ? intval($profile['dob']) : '1000') .'-'. datetime_convert('UTC', 'UTC', $profile['dob'],'m-d');
4115 $about = $profile['about'];
4116 $about = strip_tags(bbcode($about));
4118 $location = Profile::formatLocation($profile);
4120 if ($profile['pub_keywords']) {
4121 $kw = str_replace(',', ' ', $profile['pub_keywords']);
4122 $kw = str_replace(' ', ' ', $kw);
4123 $arr = explode(' ', $profile['pub_keywords']);
4125 for ($x = 0; $x < 5; $x ++) {
4126 if (trim($arr[$x])) {
4127 $tags .= '#'. trim($arr[$x]) .' ';
4132 $tags = trim($tags);
4135 return array("author" => $handle,
4136 "first_name" => $first,
4137 "last_name" => $last,
4138 "image_url" => $large,
4139 "image_url_medium" => $medium,
4140 "image_url_small" => $small,
4142 "gender" => $profile['gender'],
4144 "location" => $location,
4145 "searchable" => $searchable,
4147 "tag_string" => $tags);
4151 * @brief Sends profile data
4153 * @param int $uid The user id
4154 * @param bool $recips optional, default false
4157 public static function sendProfile($uid, $recips = false)
4163 $owner = User::getOwnerDataById($uid);
4170 "SELECT `id`,`name`,`network`,`pubkey`,`notify` FROM `contact` WHERE `network` = '%s'
4171 AND `uid` = %d AND `rel` != %d",
4172 dbesc(NETWORK_DIASPORA),
4174 intval(CONTACT_IS_SHARING)
4182 $message = self::createProfileData($uid);
4184 foreach ($recips as $recip) {
4185 logger("Send updated profile data for user ".$uid." to contact ".$recip["id"], LOGGER_DEBUG);
4186 self::buildAndTransmit($owner, $recip, "profile", $message, false, "", true);
4191 * @brief Stores the signature for likes that are created on our system
4193 * @param array $contact The contact array of the "like"
4194 * @param int $post_id The post id of the "like"
4196 * @return bool Success
4198 public static function storeLikeSignature($contact, $post_id)
4200 // Is the contact the owner? Then fetch the private key
4201 if (!$contact['self'] || ($contact['uid'] == 0)) {
4202 logger("No owner post, so not storing signature", LOGGER_DEBUG);
4206 $r = q("SELECT `prvkey` FROM `user` WHERE `uid` = %d LIMIT 1", intval($contact['uid']));
4207 if (!DBM::is_result($r)) {
4211 $contact["uprvkey"] = $r[0]['prvkey'];
4213 $r = q("SELECT * FROM `item` WHERE `id` = %d LIMIT 1", intval($post_id));
4214 if (!DBM::is_result($r)) {
4218 if (!in_array($r[0]["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE))) {
4222 $message = self::constructLike($r[0], $contact);
4223 $message["author_signature"] = self::signature($contact, $message);
4226 * Now store the signature more flexible to dynamically support new fields.
4227 * This will break Diaspora compatibility with Friendica versions prior to 3.5.
4229 dba::insert('sign', array('iid' => $post_id, 'signed_text' => json_encode($message)));
4231 logger('Stored diaspora like signature');
4236 * @brief Stores the signature for comments that are created on our system
4238 * @param array $item The item array of the comment
4239 * @param array $contact The contact array of the item owner
4240 * @param string $uprvkey The private key of the sender
4241 * @param int $message_id The message id of the comment
4243 * @return bool Success
4245 public static function storeCommentSignature($item, $contact, $uprvkey, $message_id)
4247 if ($uprvkey == "") {
4248 logger('No private key, so not storing comment signature', LOGGER_DEBUG);
4252 $contact["uprvkey"] = $uprvkey;
4254 $message = self::constructComment($item, $contact);
4255 $message["author_signature"] = self::signature($contact, $message);
4258 * Now store the signature more flexible to dynamically support new fields.
4259 * This will break Diaspora compatibility with Friendica versions prior to 3.5.
4261 dba::insert('sign', array('iid' => $message_id, 'signed_text' => json_encode($message)));
4263 logger('Stored diaspora comment signature');