X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=include%2Fdiaspora.php;h=10f1be93d24823b8849dcc0190adf69348e7a1e0;hb=85875fc07f9a859d0796adc48bc124c489a486dc;hp=3c3f5cb25af06ab1ab54018b81a05eef9fc7fba7;hpb=eed55664fc61a0e285dcf5c814b39496537c7039;p=friendica.git
diff --git a/include/diaspora.php b/include/diaspora.php
index 3c3f5cb25a..10f1be93d2 100644
--- a/include/diaspora.php
+++ b/include/diaspora.php
@@ -2,6 +2,10 @@
/**
* @file include/diaspora.php
* @brief The implementation of the diaspora protocol
+ *
+ * The new protocol is described here: http://diaspora.github.io/diaspora_federation/index.html
+ * Currently this implementation here interprets the old and the new protocol and sends the old one.
+ * This will change in the future.
*/
require_once("include/items.php");
@@ -13,6 +17,7 @@ require_once("include/socgraph.php");
require_once("include/group.php");
require_once("include/xml.php");
require_once("include/datetime.php");
+require_once("include/queue_fn.php");
/**
* @brief This class contain functions to create and send Diaspora XML files
@@ -20,6 +25,13 @@ require_once("include/datetime.php");
*/
class diaspora {
+ /**
+ * @brief Return a list of relay servers
+ *
+ * This is an experimental Diaspora feature.
+ *
+ * @return array of relay servers
+ */
public static function relay_list() {
$serverdata = get_config("system", "relay_server");
@@ -64,7 +76,18 @@ class diaspora {
return $relay;
}
- function repair_signature($signature, $handle = "", $level = 1) {
+ /**
+ * @brief repairs a signature that was double encoded
+ *
+ * The function is unused at the moment. It was copied from the old implementation.
+ *
+ * @param string $signature The signature
+ * @param string $handle The handle of the signature owner
+ * @param integer $level This value is only set inside this function to avoid endless loops
+ *
+ * @return string the repaired signature
+ */
+ private function repair_signature($signature, $handle = "", $level = 1) {
if ($signature == "")
return ($signature);
@@ -81,10 +104,63 @@ class diaspora {
return($signature);
}
+ /**
+ * @brief verify the envelope and return the verified data
+ *
+ * @param string $envelope The magic envelope
+ *
+ * @return string verified data
+ */
+ private function verify_magic_envelope($envelope) {
+
+ $basedom = parse_xml_string($envelope, false);
+
+ if (!is_object($basedom)) {
+ logger("Envelope is no XML file");
+ return false;
+ }
+
+ $children = $basedom->children('http://salmon-protocol.org/ns/magic-env');
+
+ if (sizeof($children) == 0) {
+ logger("XML has no children");
+ return false;
+ }
+
+ $handle = "";
+
+ $data = base64url_decode($children->data);
+ $type = $children->data->attributes()->type[0];
+
+ $encoding = $children->encoding;
+
+ $alg = $children->alg;
+
+ $sig = base64url_decode($children->sig);
+ $key_id = $children->sig->attributes()->key_id[0];
+ if ($key_id != "")
+ $handle = base64url_decode($key_id);
+
+ $b64url_data = base64url_encode($data);
+ $msg = str_replace(array("\n", "\r", " ", "\t"), array("", "", "", ""), $b64url_data);
+
+ $signable_data = $msg.".".base64url_encode($type).".".base64url_encode($encoding).".".base64url_encode($alg);
+
+ $key = self::key($handle);
+
+ $verify = rsa_verify($signable_data, $sig, $key);
+ if (!$verify) {
+ logger('Message did not verify. Discarding.');
+ return false;
+ }
+
+ return $data;
+ }
+
/**
* @brief: Decodes incoming Diaspora message
*
- * @param array $importer from user table
+ * @param array $importer Array of the importer user
* @param string $xml urldecoded Diaspora salmon
*
* @return array
@@ -92,7 +168,7 @@ class diaspora {
* 'author' -> author diaspora handle
* 'key' -> author public key (converted to pkcs#8)
*/
- function decode($importer, $xml) {
+ public static function decode($importer, $xml) {
$public = false;
$basedom = parse_xml_string($xml);
@@ -125,16 +201,6 @@ class diaspora {
$decrypted = pkcs5_unpad($decrypted);
- /**
- * $decrypted now contains something like
- *
- *
- * 8e+G2+ET8l5BPuW0sVTnQw==
- * UvSMb4puPeB14STkcDWq+4QE302Edu15oaprAQSkLKU=
- * galaxor@diaspora.priateship.org
- *
- */
-
logger('decrypted: '.$decrypted, LOGGER_DEBUG);
$idom = parse_xml_string($decrypted,false);
@@ -221,8 +287,9 @@ class diaspora {
logger('Message verified.');
- return array('message' => $inner_decrypted, 'author' => $author_link, 'key' => $key);
-
+ return array('message' => (string)$inner_decrypted,
+ 'author' => unxmlify($author_link),
+ 'key' => (string)$key);
}
@@ -231,7 +298,7 @@ class diaspora {
*
* @param array $msg The post that will be dispatched
*
- * @return bool Was the message accepted?
+ * @return int The message id of the generated message, "true" or "false" if there was an error
*/
public static function dispatch_public($msg) {
@@ -243,7 +310,7 @@ class diaspora {
// Use a dummy importer to import the data for the public copy
$importer = array("uid" => 0, "page-flags" => PAGE_FREELOVE);
- $item_id = self::dispatch($importer,$msg);
+ $message_id = self::dispatch($importer,$msg);
// Now distribute it to the followers
$r = q("SELECT `user`.* FROM `user` WHERE `user`.`uid` IN
@@ -260,7 +327,7 @@ class diaspora {
} else
logger("No subscribers for ".$msg["author"]." ".print_r($msg, true));
- return $item_id;
+ return $message_id;
}
/**
@@ -269,7 +336,7 @@ class diaspora {
* @param array $importer Array of the importer user
* @param array $msg The post that will be dispatched
*
- * @return bool Was the message accepted?
+ * @return int The message id of the generated message, "true" or "false" if there was an error
*/
public static function dispatch($importer, $msg) {
@@ -293,6 +360,9 @@ class diaspora {
case "comment":
return self::receive_comment($importer, $sender, $fields, $msg["message"]);
+ case "contact":
+ return self::receive_contact_request($importer, $fields);
+
case "conversation":
return self::receive_conversation($importer, $msg, $fields);
@@ -314,9 +384,6 @@ class diaspora {
case "profile":
return self::receive_profile($importer, $fields);
- case "request":
- return self::receive_request($importer, $fields);
-
case "reshare":
return self::receive_reshare($importer, $fields, $msg["message"]);
@@ -349,8 +416,10 @@ class diaspora {
$data = parse_xml_string($msg["message"], false);
- if (!is_object($data))
+ if (!is_object($data)) {
+ logger("No valid XML ".$msg["message"], LOGGER_DEBUG);
return false;
+ }
$first_child = $data->getName();
@@ -367,11 +436,16 @@ class diaspora {
$type = $element->getName();
$orig_type = $type;
+ logger("Got message type ".$type.": ".$msg["message"], LOGGER_DATA);
+
// All retractions are handled identically from now on.
// In the new version there will only be "retraction".
if (in_array($type, array("signed_retraction", "relayable_retraction")))
$type = "retraction";
+ if ($type == "request")
+ $type = "contact";
+
$fields = new SimpleXMLElement("<".$type."/>");
$signed_data = "";
@@ -408,11 +482,11 @@ class diaspora {
}
}
- if ($fieldname == "author_signature")
+ if (($fieldname == "author_signature") AND ($entry != ""))
$author_signature = base64_decode($entry);
- elseif ($fieldname == "parent_author_signature")
+ elseif (($fieldname == "parent_author_signature") AND ($entry != ""))
$parent_author_signature = base64_decode($entry);
- elseif ($fieldname != "target_author_signature") {
+ elseif (!in_array($fieldname, array("author_signature", "parent_author_signature", "target_author_signature"))) {
if ($signed_data != "") {
$signed_data .= ";";
$signed_data_parent .= ";";
@@ -437,19 +511,27 @@ class diaspora {
return true;
// No author_signature? This is a must, so we quit.
- if (!isset($author_signature))
+ if (!isset($author_signature)) {
+ logger("No author signature for type ".$type." - Message: ".$msg["message"], LOGGER_DEBUG);
return false;
+ }
if (isset($parent_author_signature)) {
$key = self::key($msg["author"]);
- if (!rsa_verify($signed_data, $parent_author_signature, $key, "sha256"))
+ if (!rsa_verify($signed_data, $parent_author_signature, $key, "sha256")) {
+ logger("No valid parent author signature for author ".$msg["author"]. " in type ".$type." - signed data: ".$signed_data." - Message: ".$msg["message"]." - Signature ".$parent_author_signature, LOGGER_DEBUG);
return false;
+ }
}
$key = self::key($fields->author);
- return rsa_verify($signed_data, $author_signature, $key, "sha256");
+ if (!rsa_verify($signed_data, $author_signature, $key, "sha256")) {
+ logger("No valid author signature for author ".$msg["author"]. " in type ".$type." - signed data: ".$signed_data." - Message: ".$msg["message"]." - Signature ".$author_signature, LOGGER_DEBUG);
+ return false;
+ } else
+ return true;
}
/**
@@ -492,6 +574,9 @@ class diaspora {
$d = strtotime($person["updated"]." +00:00");
if ($d < strtotime("now - 14 days"))
$update = true;
+
+ if ($person["guid"] == "")
+ $update = true;
}
if (!$person OR $update) {
@@ -517,7 +602,6 @@ class diaspora {
* @return string The id of the fcontact entry
*/
private function add_fcontact($arr, $update = false) {
- /// @todo Remove this function from include/network.php
if($update) {
$r = q("UPDATE `fcontact` SET
@@ -526,6 +610,7 @@ class diaspora {
`request` = '%s',
`nick` = '%s',
`addr` = '%s',
+ `guid` = '%s',
`batch` = '%s',
`notify` = '%s',
`poll` = '%s',
@@ -538,7 +623,8 @@ class diaspora {
dbesc($arr["photo"]),
dbesc($arr["request"]),
dbesc($arr["nick"]),
- dbesc($arr["addr"]),
+ dbesc(strtolower($arr["addr"])),
+ dbesc($arr["guid"]),
dbesc($arr["batch"]),
dbesc($arr["notify"]),
dbesc($arr["poll"]),
@@ -550,15 +636,16 @@ class diaspora {
dbesc($arr["network"])
);
} else {
- $r = q("INSERT INTO `fcontact` (`url`,`name`,`photo`,`request`,`nick`,`addr`,
+ $r = q("INSERT INTO `fcontact` (`url`,`name`,`photo`,`request`,`nick`,`addr`, `guid`,
`batch`, `notify`,`poll`,`confirm`,`network`,`alias`,`pubkey`,`updated`)
- VALUES ('%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s')",
+ VALUES ('%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s','%s')",
dbesc($arr["url"]),
dbesc($arr["name"]),
dbesc($arr["photo"]),
dbesc($arr["request"]),
dbesc($arr["nick"]),
dbesc($arr["addr"]),
+ dbesc($arr["guid"]),
dbesc($arr["batch"]),
dbesc($arr["notify"]),
dbesc($arr["poll"]),
@@ -573,22 +660,36 @@ class diaspora {
return $r;
}
- public static function handle_from_contact($contact_id) {
+ /**
+ * @brief get a handle (user@domain.tld) from a given contact id or gcontact id
+ *
+ * @param int $contact_id The id in the contact table
+ * @param int $gcontact_id The id in the gcontact table
+ *
+ * @return string the handle
+ */
+ public static function handle_from_contact($contact_id, $gcontact_id = 0) {
$handle = False;
- logger("contact id is ".$contact_id, LOGGER_DEBUG);
+ logger("contact id is ".$contact_id." - gcontact id is ".$gcontact_id, LOGGER_DEBUG);
+
+ if ($gcontact_id != 0) {
+ $r = q("SELECT `addr` FROM `gcontact` WHERE `id` = %d AND `addr` != ''",
+ intval($gcontact_id));
+ if ($r)
+ return strtolower($r[0]["addr"]);
+ }
$r = q("SELECT `network`, `addr`, `self`, `url`, `nick` FROM `contact` WHERE `id` = %d",
- intval($contact_id)
- );
- if($r) {
+ intval($contact_id));
+ if ($r) {
$contact = $r[0];
logger("contact 'self' = ".$contact['self']." 'url' = ".$contact['url'], LOGGER_DEBUG);
if($contact['addr'] != "")
$handle = $contact['addr'];
- elseif(($contact['network'] === NETWORK_DFRN) || ($contact['self'] == 1)) {
+ else {
$baseurl_start = strpos($contact['url'],'://') + 3;
$baseurl_length = strpos($contact['url'],'/profile') - $baseurl_start; // allows installations in a subdirectory--not sure how Diaspora will handle
$baseurl = substr($contact['url'], $baseurl_start, $baseurl_length);
@@ -596,9 +697,17 @@ class diaspora {
}
}
- return $handle;
+ return strtolower($handle);
}
+ /**
+ * @brief Get a contact id for a given handle
+ *
+ * @param int $uid The user id
+ * @param string $handle The handle in the format user@domain.tld
+ *
+ * @return The contact id
+ */
private function contact_by_handle($uid, $handle) {
$r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `addr` = '%s' LIMIT 1",
intval($uid),
@@ -621,6 +730,15 @@ class diaspora {
return false;
}
+ /**
+ * @brief Check if posting is allowed for this contact
+ *
+ * @param array $importer Array of the importer user
+ * @param array $contact The contact that is checked
+ * @param bool $is_comment Is the check for a comment?
+ *
+ * @return bool is the contact allowed to post?
+ */
private function post_allow($importer, $contact, $is_comment = false) {
// perhaps we were already sharing with this person. Now they're sharing with us.
@@ -651,6 +769,15 @@ class diaspora {
return false;
}
+ /**
+ * @brief Fetches the contact id for a handle and checks if posting is allowed
+ *
+ * @param array $importer Array of the importer user
+ * @param string $handle The checked handle in the format user@domain.tld
+ * @param bool $is_comment Is the check for a comment?
+ *
+ * @return array The contact data
+ */
private function allowed_contact_by_handle($importer, $handle, $is_comment = false) {
$contact = self::contact_by_handle($importer["uid"], $handle);
if (!$contact) {
@@ -665,6 +792,14 @@ class diaspora {
return $contact;
}
+ /**
+ * @brief Does the message already exists on the system?
+ *
+ * @param int $uid The user id
+ * @param string $guid The guid of the message
+ *
+ * @return int|bool message id if the message already was stored into the system - or false.
+ */
private function message_exists($uid, $guid) {
$r = q("SELECT `id` FROM `item` WHERE `uid` = %d AND `guid` = '%s' LIMIT 1",
intval($uid),
@@ -673,12 +808,17 @@ class diaspora {
if($r) {
logger("message ".$guid." already exists for user ".$uid);
- return true;
+ return $r[0]["id"];
}
return false;
}
+ /**
+ * @brief Checks for links to posts in a message
+ *
+ * @param array $item The item array
+ */
private function fetch_guid($item) {
preg_replace_callback("&\[url=/posts/([^\[\]]*)\](.*)\[\/url\]&Usi",
function ($match) use ($item){
@@ -686,11 +826,26 @@ class diaspora {
},$item["body"]);
}
+ /**
+ * @brief sub function of "fetch_guid" which checks for links in messages
+ *
+ * @param array $match array containing a link that has to be checked for a message link
+ * @param array $item The item array
+ */
private function fetch_guid_sub($match, $item) {
if (!self::store_by_guid($match[1], $item["author-link"]))
self::store_by_guid($match[1], $item["owner-link"]);
}
+ /**
+ * @brief Fetches an item with a given guid from a given server
+ *
+ * @param string $guid the message guid
+ * @param string $server The server address
+ * @param int $uid The user id of the user
+ *
+ * @return int the message id of the stored message or false
+ */
private function store_by_guid($guid, $server, $uid = 0) {
$serverparts = parse_url($server);
$server = $serverparts["scheme"]."://".$serverparts["host"];
@@ -708,16 +863,47 @@ class diaspora {
return self::dispatch_public($msg);
}
+ /**
+ * @brief Fetches a message from a server
+ *
+ * @param string $guid message guid
+ * @param string $server The url of the server
+ * @param int $level Endless loop prevention
+ *
+ * @return array
+ * 'message' => The message XML
+ * 'author' => The author handle
+ * 'key' => The public key of the author
+ */
private function message($guid, $server, $level = 0) {
if ($level > 5)
return false;
- // This will work for Diaspora and newer Friendica servers
- $source_url = $server."/p/".$guid.".xml";
- $x = fetch_url($source_url);
- if(!$x)
- return false;
+ // This will work for new Diaspora servers and Friendica servers from 3.5
+ $source_url = $server."/fetch/post/".$guid;
+ logger("Fetch post from ".$source_url, LOGGER_DEBUG);
+
+ $envelope = fetch_url($source_url);
+ if($envelope) {
+ logger("Envelope was fetched.", LOGGER_DEBUG);
+ $x = self::verify_magic_envelope($envelope);
+ if (!$x)
+ logger("Envelope could not be verified.", LOGGER_DEBUG);
+ else
+ logger("Envelope was verified.", LOGGER_DEBUG);
+ } else
+ $x = false;
+
+ // This will work for older Diaspora and Friendica servers
+ if (!$x) {
+ $source_url = $server."/p/".$guid.".xml";
+ logger("Fetch post from ".$source_url, LOGGER_DEBUG);
+
+ $x = fetch_url($source_url);
+ if(!$x)
+ return false;
+ }
$source_xml = parse_xml_string($x, false);
@@ -726,9 +912,11 @@ class diaspora {
if ($source_xml->post->reshare) {
// Reshare of a reshare - old Diaspora version
+ logger("Message is a reshare", LOGGER_DEBUG);
return self::message($source_xml->post->reshare->root_guid, $server, ++$level);
} elseif ($source_xml->getName() == "reshare") {
// Reshare of a reshare - new Diaspora version
+ logger("Message is a new reshare", LOGGER_DEBUG);
return self::message($source_xml->root_guid, $server, ++$level);
}
@@ -741,8 +929,10 @@ class diaspora {
$author = (string)$source_xml->author;
// If this isn't a "status_message" then quit
- if (!$author)
+ if (!$author) {
+ logger("Message doesn't seem to be a status message", LOGGER_DEBUG);
return false;
+ }
$msg = array("message" => $x, "author" => $author);
@@ -751,6 +941,16 @@ class diaspora {
return $msg;
}
+ /**
+ * @brief Fetches the item record of a given guid
+ *
+ * @param int $uid The user id
+ * @param string $guid message guid
+ * @param string $author The handle of the item
+ * @param array $contact The contact of the item owner
+ *
+ * @return array the item record
+ */
private function parent_item($uid, $guid, $author, $contact) {
$r = q("SELECT `id`, `body`, `wall`, `uri`, `private`, `origin`,
`author-name`, `author-link`, `author-avatar`,
@@ -786,6 +986,17 @@ class diaspora {
}
}
+ /**
+ * @brief returns contact details
+ *
+ * @param array $contact The default contact if the person isn't found
+ * @param array $person The record of the person
+ * @param int $uid The user id
+ *
+ * @return array
+ * 'cid' => contact id
+ * 'network' => network type
+ */
private function author_contact_by_url($contact, $person, $uid) {
$r = q("SELECT `id`, `network` FROM `contact` WHERE `nurl` = '%s' AND `uid` = %d LIMIT 1",
@@ -801,10 +1012,25 @@ class diaspora {
return (array("cid" => $cid, "network" => $network));
}
+ /**
+ * @brief Is the profile a hubzilla profile?
+ *
+ * @param string $url The profile link
+ *
+ * @return bool is it a hubzilla server?
+ */
public static function is_redmatrix($url) {
return(strstr($url, "/channel/"));
}
+ /**
+ * @brief Generate a post link with a given handle and message guid
+ *
+ * @param string $addr The user handle
+ * @param string $guid message guid
+ *
+ * @return string the post link
+ */
private function plink($addr, $guid) {
$r = q("SELECT `url`, `nick`, `network` FROM `fcontact` WHERE `addr`='%s' LIMIT 1", dbesc($addr));
@@ -827,7 +1053,18 @@ class diaspora {
return "https://".substr($addr,strpos($addr,"@")+1)."/posts/".$guid;
}
+ /**
+ * @brief Processes an account deletion
+ *
+ * @param array $importer Array of the importer user
+ * @param object $data The message object
+ *
+ * @return bool Success
+ */
private function receive_account_deletion($importer, $data) {
+
+ /// @todo Account deletion should remove the contact from the global contacts as well
+
$author = notags(unxmlify($data->author));
$contact = self::contact_by_handle($importer["uid"], $author);
@@ -841,18 +1078,51 @@ class diaspora {
return true;
}
+ /**
+ * @brief Fetch the uri from our database if we already have this item (maybe from ourselves)
+ *
+ * @param string $author Author handle
+ * @param string $guid Message guid
+ *
+ * @return string The constructed uri or the one from our database
+ */
+ private function get_uri_from_guid($author, $guid) {
+
+ $r = q("SELECT `uri` FROM `item` WHERE `guid` = '%s' LIMIT 1", dbesc($guid));
+ if ($r)
+ return $r[0]["uri"];
+ else
+ return $author.":".$guid;
+ }
+
+ /**
+ * @brief Processes an incoming comment
+ *
+ * @param array $importer Array of the importer user
+ * @param string $sender The sender of the message
+ * @param object $data The message object
+ * @param string $xml The original XML of the message
+ *
+ * @return int The message id of the generated comment or "false" if there was an error
+ */
private function receive_comment($importer, $sender, $data, $xml) {
$guid = notags(unxmlify($data->guid));
$parent_guid = notags(unxmlify($data->parent_guid));
$text = unxmlify($data->text);
$author = notags(unxmlify($data->author));
+ if (isset($data->created_at))
+ $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
+ else
+ $created_at = datetime_convert();
+
$contact = self::allowed_contact_by_handle($importer, $sender, true);
if (!$contact)
return false;
- if (self::message_exists($importer["uid"], $guid))
- return false;
+ $message_id = self::message_exists($importer["uid"], $guid);
+ if ($message_id)
+ return $message_id;
$parent_item = self::parent_item($importer["uid"], $parent_guid, $author, $contact);
if (!$parent_item)
@@ -882,7 +1152,7 @@ class diaspora {
$datarray["owner-avatar"] = ((x($contact,"thumb")) ? $contact["thumb"] : $contact["photo"]);
$datarray["guid"] = $guid;
- $datarray["uri"] = $author.":".$guid;
+ $datarray["uri"] = self::get_uri_from_guid($author, $guid);
$datarray["type"] = "remote-comment";
$datarray["verb"] = ACTIVITY_POST;
@@ -892,6 +1162,8 @@ class diaspora {
$datarray["object-type"] = ACTIVITY_OBJ_COMMENT;
$datarray["object"] = $xml;
+ $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
+
$datarray["body"] = diaspora2bb($text);
self::fetch_guid($datarray);
@@ -912,12 +1184,24 @@ class diaspora {
);
// notify others
- proc_run("php", "include/notifier.php", "comment-import", $message_id);
+ proc_run(PRIORITY_HIGH, "include/notifier.php", "comment-import", $message_id);
}
return $message_id;
}
+ /**
+ * @brief processes and stores private messages
+ *
+ * @param array $importer Array of the importer user
+ * @param array $contact The contact of the message
+ * @param object $data The message object
+ * @param array $msg Array of the processed message, author handle and key
+ * @param object $mesg The private message
+ * @param array $conversation The conversation record to which this message belongs
+ *
+ * @return bool "true" if it was successful
+ */
private function receive_conversation_message($importer, $contact, $data, $msg, $mesg, $conversation) {
$guid = notags(unxmlify($data->guid));
$subject = notags(unxmlify($data->subject));
@@ -1032,8 +1316,18 @@ class diaspora {
"verb" => ACTIVITY_POST,
"otype" => "mail"
));
+ return true;
}
+ /**
+ * @brief Processes new private messages (answers to private messages are processed elsewhere)
+ *
+ * @param array $importer Array of the importer user
+ * @param array $msg Array of the processed message, author handle and key
+ * @param object $data The message object
+ *
+ * @return bool Success
+ */
private function receive_conversation($importer, $msg, $data) {
$guid = notags(unxmlify($data->guid));
$subject = notags(unxmlify($data->subject));
@@ -1066,7 +1360,7 @@ class diaspora {
intval($importer["uid"]),
dbesc($guid),
dbesc($author),
- dbesc(datetime_convert("UTC", "UTC", $created_at)),
+ dbesc($created_at),
dbesc(datetime_convert()),
dbesc($subject),
dbesc($participants)
@@ -1091,6 +1385,15 @@ class diaspora {
return true;
}
+ /**
+ * @brief Creates the body for a "like" message
+ *
+ * @param array $contact The contact that send us the "like"
+ * @param array $parent_item The item array of the parent item
+ * @param string $guid message guid
+ *
+ * @return string the body
+ */
private function construct_like_body($contact, $parent_item, $guid) {
$bodyverb = t('%1$s likes %2$s\'s %3$s');
@@ -1101,6 +1404,14 @@ class diaspora {
return sprintf($bodyverb, $ulink, $alink, $plink);
}
+ /**
+ * @brief Creates a XML object for a "like"
+ *
+ * @param array $importer Array of the importer user
+ * @param array $parent_item The item array of the parent item
+ *
+ * @return string The XML
+ */
private function construct_like_object($importer, $parent_item) {
$objtype = ACTIVITY_OBJ_NOTE;
$link = '';
@@ -1116,6 +1427,15 @@ class diaspora {
return xml::from_array($xmldata, $xml, true);
}
+ /**
+ * @brief Processes "like" messages
+ *
+ * @param array $importer Array of the importer user
+ * @param string $sender The sender of the message
+ * @param object $data The message object
+ *
+ * @return int The message id of the generated like or "false" if there was an error
+ */
private function receive_like($importer, $sender, $data) {
$positive = notags(unxmlify($data->positive));
$guid = notags(unxmlify($data->guid));
@@ -1132,8 +1452,9 @@ class diaspora {
if (!$contact)
return false;
- if (self::message_exists($importer["uid"], $guid))
- return false;
+ $message_id = self::message_exists($importer["uid"], $guid);
+ if ($message_id)
+ return $message_id;
$parent_item = self::parent_item($importer["uid"], $parent_guid, $author, $contact);
if (!$parent_item)
@@ -1150,7 +1471,7 @@ class diaspora {
// "positive" = "false" would be a Dislike - wich isn't currently supported by Diaspora
// We would accept this anyhow.
- if ($positive === "true")
+ if ($positive == "true")
$verb = ACTIVITY_LIKE;
else
$verb = ACTIVITY_DISLIKE;
@@ -1170,7 +1491,7 @@ class diaspora {
$datarray["owner-avatar"] = ((x($contact,"thumb")) ? $contact["thumb"] : $contact["photo"]);
$datarray["guid"] = $guid;
- $datarray["uri"] = $author.":".$guid;
+ $datarray["uri"] = self::get_uri_from_guid($author, $guid);
$datarray["type"] = "activity";
$datarray["verb"] = $verb;
@@ -1198,12 +1519,20 @@ class diaspora {
);
// notify others
- proc_run("php", "include/notifier.php", "comment-import", $message_id);
+ proc_run(PRIORITY_HIGH, "include/notifier.php", "comment-import", $message_id);
}
return $message_id;
}
+ /**
+ * @brief Processes private messages
+ *
+ * @param array $importer Array of the importer user
+ * @param object $data The message object
+ *
+ * @return bool Success?
+ */
private function receive_message($importer, $data) {
$guid = notags(unxmlify($data->guid));
$parent_guid = notags(unxmlify($data->parent_guid));
@@ -1275,27 +1604,59 @@ class diaspora {
return true;
}
+ /**
+ * @brief Processes participations - unsupported by now
+ *
+ * @param array $importer Array of the importer user
+ * @param object $data The message object
+ *
+ * @return bool always true
+ */
private function receive_participation($importer, $data) {
// I'm not sure if we can fully support this message type
return true;
}
+ /**
+ * @brief Processes photos - unneeded
+ *
+ * @param array $importer Array of the importer user
+ * @param object $data The message object
+ *
+ * @return bool always true
+ */
private function receive_photo($importer, $data) {
// There doesn't seem to be a reason for this function, since the photo data is transmitted in the status message as well
return true;
}
+ /**
+ * @brief Processes poll participations - unssupported
+ *
+ * @param array $importer Array of the importer user
+ * @param object $data The message object
+ *
+ * @return bool always true
+ */
private function receive_poll_participation($importer, $data) {
// We don't support polls by now
return true;
}
+ /**
+ * @brief Processes incoming profile updates
+ *
+ * @param array $importer Array of the importer user
+ * @param object $data The message object
+ *
+ * @return bool Success
+ */
private function receive_profile($importer, $data) {
- $author = notags(unxmlify($data->author));
+ $author = strtolower(notags(unxmlify($data->author)));
$contact = self::contact_by_handle($importer["uid"], $author);
if (!$contact)
- return;
+ return false;
$name = unxmlify($data->first_name).((strlen($data->last_name)) ? " ".unxmlify($data->last_name) : "");
$image_url = unxmlify($data->image_url);
@@ -1375,6 +1736,12 @@ class diaspora {
return true;
}
+ /**
+ * @brief Processes incoming friend requests
+ *
+ * @param array $importer Array of the importer user
+ * @param array $contact The contact that send the request
+ */
private function receive_request_make_friend($importer, $contact) {
$a = get_app();
@@ -1421,11 +1788,8 @@ class diaspora {
$BPhoto = "[url=".$contact["url"]."][img]".$contact["thumb"]."[/img][/url]";
$arr["body"] = sprintf(t("%1$s is now friends with %2$s"), $A, $B)."\n\n\n".$Bphoto;
- $arr["object"] = "\n";
+ $arr["object"] = self::construct_new_friend_object($contact);
+
$arr["last-child"] = 1;
$arr["allow_cid"] = $user[0]["allow_cid"];
@@ -1435,29 +1799,98 @@ class diaspora {
$i = item_store($arr);
if($i)
- proc_run("php", "include/notifier.php", "activity", $i);
-
+ proc_run(PRIORITY_HIGH, "include/notifier.php", "activity", $i);
}
-
}
}
- private function receive_request($importer, $data) {
+ /**
+ * @brief Creates a XML object for a "new friend" message
+ *
+ * @param array $contact Array of the contact
+ *
+ * @return string The XML
+ */
+ private function construct_new_friend_object($contact) {
+ $objtype = ACTIVITY_OBJ_PERSON;
+ $link = ''."\n".
+ ''."\n";
+
+ $xmldata = array("object" => array("type" => $objtype,
+ "title" => $contact["name"],
+ "id" => $contact["url"]."/".$contact["name"],
+ "link" => $link));
+
+ return xml::from_array($xmldata, $xml, true);
+ }
+
+ /**
+ * @brief Processes incoming sharing notification
+ *
+ * @param array $importer Array of the importer user
+ * @param object $data The message object
+ *
+ * @return bool Success
+ */
+ private function receive_contact_request($importer, $data) {
$author = unxmlify($data->author);
$recipient = unxmlify($data->recipient);
if (!$author || !$recipient)
- return;
+ return false;
- $contact = self::contact_by_handle($importer["uid"],$author);
+ // the current protocol version doesn't know these fields
+ // That means that we will assume their existance
+ if (isset($data->following))
+ $following = (unxmlify($data->following) == "true");
+ else
+ $following = true;
- if($contact) {
+ if (isset($data->sharing))
+ $sharing = (unxmlify($data->sharing) == "true");
+ else
+ $sharing = true;
- // perhaps we were already sharing with this person. Now they're sharing with us.
- // That makes us friends.
+ $contact = self::contact_by_handle($importer["uid"],$author);
- self::receive_request_make_friend($importer, $contact);
- return true;
+ // perhaps we were already sharing with this person. Now they're sharing with us.
+ // That makes us friends.
+ if ($contact) {
+ if ($following AND $sharing) {
+ logger("Author ".$author." (Contact ".$contact["id"].") wants to have a bidirectional conection.", LOGGER_DEBUG);
+ self::receive_request_make_friend($importer, $contact);
+
+ // refetch the contact array
+ $contact = self::contact_by_handle($importer["uid"],$author);
+
+ // If we are now friends, we are sending a share message.
+ // Normally we needn't to do so, but the first message could have been vanished.
+ if (in_array($contact["rel"], array(CONTACT_IS_FRIEND, CONTACT_IS_FOLLOWER))) {
+ $u = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval($importer["uid"]));
+ if($u) {
+ logger("Sending share message to author ".$author." - Contact: ".$contact["id"]." - User: ".$importer["uid"], LOGGER_DEBUG);
+ $ret = self::send_share($u[0], $contact);
+ }
+ }
+ return true;
+ } else { /// @todo Handle all possible variations of adding and retracting of permissions
+ logger("Author ".$author." (Contact ".$contact["id"].") wants to change the relationship: Following: ".$following." - sharing: ".$sharing. "(By now unsupported)", LOGGER_DEBUG);
+ return false;
+ }
+ }
+
+ if (!$following AND $sharing AND in_array($importer["page-flags"], array(PAGE_SOAPBOX, PAGE_NORMAL))) {
+ logger("Author ".$author." wants to share with us - but doesn't want to listen. Request is ignored.", LOGGER_DEBUG);
+ return false;
+ } elseif (!$following AND !$sharing) {
+ logger("Author ".$author." doesn't want anything - and we don't know the author. Request is ignored.", LOGGER_DEBUG);
+ return false;
+ } elseif (!$following AND $sharing) {
+ logger("Author ".$author." wants to share with us.", LOGGER_DEBUG);
+ } elseif ($following AND $sharing) {
+ logger("Author ".$author." wants to have a bidirectional conection.", LOGGER_DEBUG);
+ } elseif ($following AND !$sharing) {
+ logger("Author ".$author." wants to listen to us.", LOGGER_DEBUG);
}
$ret = self::person_by_handle($author);
@@ -1497,15 +1930,19 @@ class diaspora {
return;
}
- $g = q("SELECT `def_gid` FROM `user` WHERE `uid` = %d LIMIT 1",
- intval($importer["uid"])
- );
+ logger("Author ".$author." was added as contact number ".$contact_record["id"].".", LOGGER_DEBUG);
+
+ $def_gid = get_default_group($importer['uid'], $ret["network"]);
- if($g && intval($g[0]["def_gid"]))
- group_add_member($importer["uid"], "", $contact_record["id"], $g[0]["def_gid"]);
+ if(intval($def_gid))
+ group_add_member($importer["uid"], "", $contact_record["id"], $def_gid);
+
+ update_contact_avatar($ret["photo"], $importer['uid'], $contact_record["id"], true);
if($importer["page-flags"] == PAGE_NORMAL) {
+ logger("Sending intra message for author ".$author.".", LOGGER_DEBUG);
+
$hash = random_string().(string)time(); // Generate a confirm_key
$ret = q("INSERT INTO `intro` (`uid`, `contact-id`, `blocked`, `knowyou`, `note`, `hash`, `datetime`)
@@ -1522,14 +1959,18 @@ class diaspora {
// automatic friend approval
+ logger("Does an automatic friend approval for author ".$author.".", LOGGER_DEBUG);
+
update_contact_avatar($contact_record["photo"],$importer["uid"],$contact_record["id"]);
// technically they are sharing with us (CONTACT_IS_SHARING),
// but if our page-type is PAGE_COMMUNITY or PAGE_SOAPBOX
// we are going to change the relationship and make them a follower.
- if($importer["page-flags"] == PAGE_FREELOVE)
+ if (($importer["page-flags"] == PAGE_FREELOVE) AND $sharing AND $following)
$new_relation = CONTACT_IS_FRIEND;
+ elseif (($importer["page-flags"] == PAGE_FREELOVE) AND $sharing)
+ $new_relation = CONTACT_IS_SHARING;
else
$new_relation = CONTACT_IS_FOLLOWER;
@@ -1548,13 +1989,27 @@ class diaspora {
);
$u = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval($importer["uid"]));
- if($u)
+ if($u) {
+ logger("Sending share message (Relation: ".$new_relation.") to author ".$author." - Contact: ".$contact_record["id"]." - User: ".$importer["uid"], LOGGER_DEBUG);
$ret = self::send_share($u[0], $contact_record);
+
+ // Send the profile data, maybe it weren't transmitted before
+ self::send_profile($importer["uid"], array($contact_record));
+ }
}
return true;
}
+ /**
+ * @brief Fetches a message with a given guid
+ *
+ * @param string $guid message guid
+ * @param string $orig_author handle of the original post
+ * @param string $author handle of the sharer
+ *
+ * @return array The fetched item
+ */
private function original_item($guid, $orig_author, $author) {
// Do we already have this item?
@@ -1567,64 +2022,75 @@ class diaspora {
logger("reshared message ".$guid." already exists on system.");
// Maybe it is already a reshared item?
- // Then refetch the content, since there can be many side effects with reshared posts from other networks or reshares from reshares
- if (self::is_reshare($r[0]["body"]))
+ // Then refetch the content, if it is a reshare from a reshare.
+ // If it is a reshared post from another network then reformat to avoid display problems with two share elements
+ if (self::is_reshare($r[0]["body"], true))
$r = array();
- else
+ elseif (self::is_reshare($r[0]["body"], false)) {
+ $r[0]["body"] = diaspora2bb(bb2diaspora($r[0]["body"]));
+
+ // Add OEmbed and other information to the body
+ $r[0]["body"] = add_page_info_to_body($r[0]["body"], false, true);
+
+ return $r[0];
+ } else
return $r[0];
}
if (!$r) {
$server = "https://".substr($orig_author, strpos($orig_author, "@") + 1);
- logger("1st try: reshared message ".$guid." will be fetched from original server: ".$server);
+ logger("1st try: reshared message ".$guid." will be fetched via SSL from the server ".$server);
$item_id = self::store_by_guid($guid, $server);
if (!$item_id) {
$server = "http://".substr($orig_author, strpos($orig_author, "@") + 1);
- logger("2nd try: reshared message ".$guid." will be fetched from original server: ".$server);
+ logger("2nd try: reshared message ".$guid." will be fetched without SLL from the server ".$server);
$item_id = self::store_by_guid($guid, $server);
}
- // Deactivated by now since there is a risk that someone could manipulate postings through this method
-/* if (!$item_id) {
- $server = "https://".substr($author, strpos($author, "@") + 1);
- logger("3rd try: reshared message ".$guid." will be fetched from sharer's server: ".$server);
- $item_id = self::store_by_guid($guid, $server);
- }
- if (!$item_id) {
- $server = "http://".substr($author, strpos($author, "@") + 1);
- logger("4th try: reshared message ".$guid." will be fetched from sharer's server: ".$server);
- $item_id = self::store_by_guid($guid, $server);
- }
-*/
if ($item_id) {
$r = q("SELECT `body`, `tag`, `app`, `created`, `object-type`, `uri`, `guid`,
`author-name`, `author-link`, `author-avatar`
FROM `item` WHERE `id` = %d AND `visible` AND NOT `deleted` AND `body` != '' LIMIT 1",
intval($item_id));
- if ($r)
+ if ($r) {
+ // If it is a reshared post from another network then reformat to avoid display problems with two share elements
+ if (self::is_reshare($r[0]["body"], false))
+ $r[0]["body"] = diaspora2bb(bb2diaspora($r[0]["body"]));
+
return $r[0];
+ }
}
}
return false;
}
+ /**
+ * @brief Processes a reshare message
+ *
+ * @param array $importer Array of the importer user
+ * @param object $data The message object
+ * @param string $xml The original XML of the message
+ *
+ * @return int the message id
+ */
private function receive_reshare($importer, $data, $xml) {
$root_author = notags(unxmlify($data->root_author));
$root_guid = notags(unxmlify($data->root_guid));
$guid = notags(unxmlify($data->guid));
$author = notags(unxmlify($data->author));
$public = notags(unxmlify($data->public));
- $created_at = notags(unxmlify($data->created_at));
+ $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
$contact = self::allowed_contact_by_handle($importer, $author, false);
if (!$contact)
return false;
- if (self::message_exists($importer["uid"], $guid))
- return false;
+ $message_id = self::message_exists($importer["uid"], $guid);
+ if ($message_id)
+ return $message_id;
$original_item = self::original_item($root_guid, $root_author, $author);
if (!$original_item)
@@ -1647,7 +2113,7 @@ class diaspora {
$datarray["owner-avatar"] = $datarray["author-avatar"];
$datarray["guid"] = $guid;
- $datarray["uri"] = $datarray["parent-uri"] = $author.":".$guid;
+ $datarray["uri"] = $datarray["parent-uri"] = self::get_uri_from_guid($author, $guid);
$datarray["verb"] = ACTIVITY_POST;
$datarray["gravity"] = GRAVITY_PARENT;
@@ -1663,7 +2129,7 @@ class diaspora {
$datarray["plink"] = self::plink($author, $guid);
$datarray["private"] = (($public == "false") ? 1 : 0);
- $datarray["changed"] = $datarray["created"] = $datarray["edited"] = datetime_convert("UTC", "UTC", $created_at);
+ $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
$datarray["object-type"] = $original_item["object-type"];
@@ -1676,6 +2142,15 @@ class diaspora {
return $message_id;
}
+ /**
+ * @brief Processes retractions
+ *
+ * @param array $importer Array of the importer user
+ * @param array $contact The contact of the item owner
+ * @param object $data The message object
+ *
+ * @return bool success
+ */
private function item_retraction($importer, $contact, $data) {
$target_type = notags(unxmlify($data->target_type));
$target_guid = notags(unxmlify($data->target_guid));
@@ -1694,12 +2169,6 @@ class diaspora {
if (!$r)
return false;
- // Only delete it if the author really fits
- if (!link_compare($r[0]["author-link"], $person["url"])) {
- logger("Item author ".$r[0]["author-link"]." doesn't fit to expected contact ".$person["url"], LOGGER_DEBUG);
- return false;
- }
-
// Check if the sender is the thread owner
$p = q("SELECT `id`, `author-link`, `origin` FROM `item` WHERE `id` = %d",
intval($r[0]["parent"]));
@@ -1722,21 +2191,22 @@ class diaspora {
// Now check if the retraction needs to be relayed by us
if($p[0]["origin"]) {
-
- // Formerly we stored the signed text, the signature and the author in different fields.
- // We now store the raw data so that we are more flexible.
- q("INSERT INTO `sign` (`retract_iid`,`signed_text`) VALUES (%d,'%s')",
- intval($r[0]["id"]),
- dbesc(json_encode($data))
- );
- $s = q("select * from sign where retract_iid = %d", intval($r[0]["id"]));
- logger("Stored signatur for item ".$r[0]["id"]." - ".print_r($s, true), LOGGER_DEBUG);
-
// notify others
- proc_run("php", "include/notifier.php", "drop", $r[0]["id"]);
+ proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $r[0]["id"]);
}
+
+ return true;
}
+ /**
+ * @brief Receives retraction messages
+ *
+ * @param array $importer Array of the importer user
+ * @param string $sender The sender of the message
+ * @param object $data The message object
+ *
+ * @return bool Success
+ */
private function receive_retraction($importer, $sender, $data) {
$target_type = notags(unxmlify($data->target_type));
@@ -1756,10 +2226,11 @@ class diaspora {
case "StatusMessage":
return self::item_retraction($importer, $contact, $data);;
+ case "Contact":
case "Person":
/// @todo What should we do with an "unshare"?
// Removing the contact isn't correct since we still can read the public items
- //contact_remove($contact["id"]);
+ contact_remove($contact["id"]);
return true;
default:
@@ -1769,13 +2240,21 @@ class diaspora {
return true;
}
+ /**
+ * @brief Receives status messages
+ *
+ * @param array $importer Array of the importer user
+ * @param object $data The message object
+ * @param string $xml The original XML of the message
+ *
+ * @return int The message id of the newly created item
+ */
private function receive_status_message($importer, $data, $xml) {
-
$raw_message = unxmlify($data->raw_message);
$guid = notags(unxmlify($data->guid));
$author = notags(unxmlify($data->author));
$public = notags(unxmlify($data->public));
- $created_at = notags(unxmlify($data->created_at));
+ $created_at = datetime_convert("UTC", "UTC", notags(unxmlify($data->created_at)));
$provider_display_name = notags(unxmlify($data->provider_display_name));
/// @todo enable support for polls
@@ -1788,8 +2267,9 @@ class diaspora {
if (!$contact)
return false;
- if (self::message_exists($importer["uid"], $guid))
- return false;
+ $message_id = self::message_exists($importer["uid"], $guid);
+ if ($message_id)
+ return $message_id;
$address = array();
if ($data->location)
@@ -1800,9 +2280,11 @@ class diaspora {
$datarray = array();
+ // Attach embedded pictures to the body
if ($data->photo) {
foreach ($data->photo AS $photo)
- $body = "[img]".$photo->remote_photo_path.$photo->remote_photo_name."[/img]\n".$body;
+ $body = "[img]".unxmlify($photo->remote_photo_path).
+ unxmlify($photo->remote_photo_name)."[/img]\n".$body;
$datarray["object-type"] = ACTIVITY_OBJ_PHOTO;
} else {
@@ -1826,7 +2308,7 @@ class diaspora {
$datarray["owner-avatar"] = $datarray["author-avatar"];
$datarray["guid"] = $guid;
- $datarray["uri"] = $datarray["parent-uri"] = $author.":".$guid;
+ $datarray["uri"] = $datarray["parent-uri"] = self::get_uri_from_guid($author, $guid);
$datarray["verb"] = ACTIVITY_POST;
$datarray["gravity"] = GRAVITY_PARENT;
@@ -1840,7 +2322,7 @@ class diaspora {
$datarray["plink"] = self::plink($author, $guid);
$datarray["private"] = (($public == "false") ? 1 : 0);
- $datarray["changed"] = $datarray["created"] = $datarray["edited"] = datetime_convert("UTC", "UTC", $created_at);
+ $datarray["changed"] = $datarray["created"] = $datarray["edited"] = $created_at;
if (isset($address["address"]))
$datarray["location"] = $address["address"];
@@ -1857,19 +2339,76 @@ class diaspora {
return $message_id;
}
- /******************************************************************************************
+ /* ************************************************************************************** *
* Here are all the functions that are needed to transmit data with the Diaspora protocol *
- ******************************************************************************************/
+ * ************************************************************************************** */
- private function my_handle($me) {
+ /**
+ * @brief returnes the handle of a contact
+ *
+ * @param array $me contact array
+ *
+ * @return string the handle in the format user@domain.tld
+ */
+ private function my_handle($contact) {
if ($contact["addr"] != "")
return $contact["addr"];
// Normally we should have a filled "addr" field - but in the past this wasn't the case
// So - just in case - we build the the address here.
- return $me["nickname"]."@".substr(App::get_baseurl(), strpos(App::get_baseurl(),"://") + 3);
+ if ($contact["nickname"] != "")
+ $nick = $contact["nickname"];
+ else
+ $nick = $contact["nick"];
+
+ return $nick."@".substr(App::get_baseurl(), strpos(App::get_baseurl(),"://") + 3);
+ }
+
+ /**
+ * @brief Creates the envelope for the "fetch" endpoint
+ *
+ * @param string $msg The message that is to be transmitted
+ * @param array $user The record of the sender
+ *
+ * @return string The envelope
+ */
+
+ public static function build_magic_envelope($msg, $user) {
+
+ $b64url_data = base64url_encode($msg);
+ $data = str_replace(array("\n", "\r", " ", "\t"), array("", "", "", ""), $b64url_data);
+
+ $key_id = base64url_encode(diaspora::my_handle($user));
+ $type = "application/xml";
+ $encoding = "base64url";
+ $alg = "RSA-SHA256";
+ $signable_data = $data.".".base64url_encode($type).".".base64url_encode($encoding).".".base64url_encode($alg);
+ $signature = rsa_sign($signable_data, $user["prvkey"]);
+ $sig = base64url_encode($signature);
+
+ $xmldata = array("me:env" => array("me:data" => $data,
+ "@attributes" => array("type" => $type),
+ "me:encoding" => $encoding,
+ "me:alg" => $alg,
+ "me:sig" => $sig,
+ "@attributes2" => array("key_id" => $key_id)));
+
+ $namespaces = array("me" => "http://salmon-protocol.org/ns/magic-env");
+
+ return xml::from_array($xmldata, $xml, false, $namespaces);
}
+ /**
+ * @brief Creates the envelope for a public message
+ *
+ * @param string $msg The message that is to be transmitted
+ * @param array $user The record of the sender
+ * @param array $contact Target of the communication
+ * @param string $prvkey The private key of the sender
+ * @param string $pubkey The public key of the receiver
+ *
+ * @return string The envelope
+ */
private function build_public_message($msg, $user, $contact, $prvkey, $pubkey) {
logger("Message: ".$msg, LOGGER_DATA);
@@ -1890,11 +2429,11 @@ class diaspora {
$sig = base64url_encode($signature);
$xmldata = array("diaspora" => array("header" => array("author_id" => $handle),
- "me:env" => array("me:encoding" => "base64url",
- "me:alg" => "RSA-SHA256",
- "me:data" => $data,
- "@attributes" => array("type" => "application/xml"),
- "me:sig" => $sig)));
+ "me:env" => array("me:encoding" => $encoding,
+ "me:alg" => $alg,
+ "me:data" => $data,
+ "@attributes" => array("type" => $type),
+ "me:sig" => $sig)));
$namespaces = array("" => "https://joindiaspora.com/protocol",
"me" => "http://salmon-protocol.org/ns/magic-env");
@@ -1905,6 +2444,17 @@ class diaspora {
return $magic_env;
}
+ /**
+ * @brief Creates the envelope for a private message
+ *
+ * @param string $msg The message that is to be transmitted
+ * @param array $user The record of the sender
+ * @param array $contact Target of the communication
+ * @param string $prvkey The private key of the sender
+ * @param string $pubkey The public key of the receiver
+ *
+ * @return string The envelope
+ */
private function build_private_message($msg, $user, $contact, $prvkey, $pubkey) {
logger("Message: ".$msg, LOGGER_DATA);
@@ -1969,10 +2519,10 @@ class diaspora {
$cipher_json = base64_encode($encrypted_header_json_object);
$xmldata = array("diaspora" => array("encrypted_header" => $cipher_json,
- "me:env" => array("me:encoding" => "base64url",
- "me:alg" => "RSA-SHA256",
+ "me:env" => array("me:encoding" => $encoding,
+ "me:alg" => $alg,
"me:data" => $data,
- "@attributes" => array("type" => "application/xml"),
+ "@attributes" => array("type" => $type),
"me:sig" => $sig)));
$namespaces = array("" => "https://joindiaspora.com/protocol",
@@ -1984,6 +2534,18 @@ class diaspora {
return $magic_env;
}
+ /**
+ * @brief Create the envelope for a message
+ *
+ * @param string $msg The message that is to be transmitted
+ * @param array $user The record of the sender
+ * @param array $contact Target of the communication
+ * @param string $prvkey The private key of the sender
+ * @param string $pubkey The public key of the receiver
+ * @param bool $public Is the message public?
+ *
+ * @return string The message that will be transmitted to other servers
+ */
private function build_message($msg, $user, $contact, $prvkey, $pubkey, $public = false) {
if ($public)
@@ -1996,6 +2558,14 @@ class diaspora {
return $slap;
}
+ /**
+ * @brief Creates a signature for a message
+ *
+ * @param array $owner the array of the owner of the message
+ * @param array $message The message that is to be signed
+ *
+ * @return string The signature
+ */
private function signature($owner, $message) {
$sigmsg = $message;
unset($sigmsg["author_signature"]);
@@ -2006,6 +2576,18 @@ class diaspora {
return base64_encode(rsa_sign($signed_text, $owner["uprvkey"], "sha256"));
}
+ /**
+ * @brief Transmit a message to a target server
+ *
+ * @param array $owner the array of the item owner
+ * @param array $contact Target of the communication
+ * @param string $slap The message that is to be transmitted
+ * @param bool $public_batch Is it a public post?
+ * @param bool $queue_run Is the transmission called from the queue?
+ * @param string $guid message guid
+ *
+ * @return int Result of the transmission
+ */
public static function transmit($owner, $contact, $slap, $public_batch, $queue_run=false, $guid = "") {
$a = get_app();
@@ -2058,15 +2640,44 @@ class diaspora {
}
- private function build_and_transmit($owner, $contact, $type, $message, $public_batch = false, $guid = "", $spool = false) {
+ /**
+ * @brief Build the post xml
+ *
+ * @param string $type The message type
+ * @param array $message The message data
+ *
+ * @return string The post XML
+ */
+ public static function build_post_xml($type, $message) {
$data = array("XML" => array("post" => array($type => $message)));
+ return xml::from_array($data, $xml);
+ }
- $msg = xml::from_array($data, $xml);
+ /**
+ * @brief Builds and transmit messages
+ *
+ * @param array $owner the array of the item owner
+ * @param array $contact Target of the communication
+ * @param string $type The message type
+ * @param array $message The message data
+ * @param bool $public_batch Is it a public post?
+ * @param string $guid message guid
+ * @param bool $spool Should the transmission be spooled or transmitted?
+ *
+ * @return int Result of the transmission
+ */
+ private function build_and_transmit($owner, $contact, $type, $message, $public_batch = false, $guid = "", $spool = false) {
+
+ $msg = self::build_post_xml($type, $message);
logger('message: '.$msg, LOGGER_DATA);
logger('send guid '.$guid, LOGGER_DEBUG);
+ // Fallback if the private key wasn't transmitted in the expected field
+ if ($owner['uprvkey'] == "")
+ $owner['uprvkey'] = $owner['prvkey'];
+
$slap = self::build_message($msg, $owner, $contact, $owner['uprvkey'], $contact['pubkey'], $public_batch);
if ($spool) {
@@ -2080,29 +2691,57 @@ class diaspora {
return $return_code;
}
+ /**
+ * @brief Sends a "share" message
+ *
+ * @param array $owner the array of the item owner
+ * @param array $contact Target of the communication
+ *
+ * @return int The result of the transmission
+ */
public static function send_share($owner,$contact) {
$message = array("sender_handle" => self::my_handle($owner),
"recipient_handle" => $contact["addr"]);
+ logger("Send share ".print_r($message, true), LOGGER_DEBUG);
+
return self::build_and_transmit($owner, $contact, "request", $message);
}
+ /**
+ * @brief sends an "unshare"
+ *
+ * @param array $owner the array of the item owner
+ * @param array $contact Target of the communication
+ *
+ * @return int The result of the transmission
+ */
public static function send_unshare($owner,$contact) {
$message = array("post_guid" => $owner["guid"],
"diaspora_handle" => self::my_handle($owner),
"type" => "Person");
+ logger("Send unshare ".print_r($message, true), LOGGER_DEBUG);
+
return self::build_and_transmit($owner, $contact, "retraction", $message);
}
- public static function is_reshare($body) {
+ /**
+ * @brief Checks a message body if it is a reshare
+ *
+ * @param string $body The message body that is to be check
+ * @param bool $complete Should it be a complete check or a simple check?
+ *
+ * @return array|bool Reshare details or "false" if no reshare
+ */
+ public static function is_reshare($body, $complete = true) {
$body = trim($body);
// Skip if it isn't a pure repeated messages
// Does it start with a share?
- if (strpos($body, "[share") > 0)
+ if ((strpos($body, "[share") > 0) AND $complete)
return(false);
// Does it end with a share?
@@ -2114,6 +2753,10 @@ class diaspora {
if ($body == $attributes)
return(false);
+ // If we don't do the complete check we quit here
+ if (!$complete)
+ return true;
+
$guid = "";
preg_match("/guid='(.*?)'/ism", $attributes, $matches);
if ($matches[1] != "")
@@ -2159,12 +2802,23 @@ class diaspora {
$link = $matches[1];
$ret["root_guid"] = preg_replace("=https?://(.*)/posts/(.*)=ism", "$2", $link);
- if (($ret["root_guid"] == $link) OR ($ret["root_guid"] == ""))
+ if (($ret["root_guid"] == $link) OR (trim($ret["root_guid"]) == ""))
return(false);
+
return($ret);
}
- public static function send_status($item, $owner, $contact, $public_batch = false) {
+ /**
+ * @brief Create a post (status message or reshare)
+ *
+ * @param array $item The item that will be exported
+ * @param array $owner the array of the item owner
+ *
+ * @return array
+ * 'type' -> Message type ("status_message" or "reshare")
+ * 'message' -> Array of XML elements of the status
+ */
+ public static function build_status($item, $owner) {
$myaddr = self::my_handle($owner);
@@ -2222,19 +2876,43 @@ class diaspora {
"created_at" => $created,
"provider_display_name" => $item["app"]);
- if (count($location) == 0)
+ // Diaspora rejects messages when they contain a location without "lat" or "lng"
+ if (!isset($location["lat"]) OR !isset($location["lng"])) {
unset($message["location"]);
+ }
$type = "status_message";
}
+ return array("type" => $type, "message" => $message);
+ }
- return self::build_and_transmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
+ /**
+ * @brief Sends a post
+ *
+ * @param array $item The item that will be exported
+ * @param array $owner the array of the item owner
+ * @param array $contact Target of the communication
+ * @param bool $public_batch Is it a public post?
+ *
+ * @return int The result of the transmission
+ */
+ public static function send_status($item, $owner, $contact, $public_batch = false) {
+
+ $status = diaspora::build_status($item, $owner);
+
+ return self::build_and_transmit($owner, $contact, $status["type"], $status["message"], $public_batch, $item["guid"]);
}
+ /**
+ * @brief Creates a "like" object
+ *
+ * @param array $item The item that will be exported
+ * @param array $owner the array of the item owner
+ *
+ * @return array The data for a "like"
+ */
private function construct_like($item, $owner) {
- $myaddr = self::my_handle($owner);
-
$p = q("SELECT `guid`, `uri`, `parent-uri` FROM `item` WHERE `uri` = '%s' LIMIT 1",
dbesc($item["thr-parent"]));
if(!$p)
@@ -2249,14 +2927,20 @@ class diaspora {
"guid" => $item["guid"],
"target_type" => $target_type,
"parent_guid" => $parent["guid"],
- "author_signature" => $authorsig,
- "diaspora_handle" => $myaddr));
+ "author_signature" => "",
+ "diaspora_handle" => self::my_handle($owner)));
}
+ /**
+ * @brief Creates the object for a comment
+ *
+ * @param array $item The item that will be exported
+ * @param array $owner the array of the item owner
+ *
+ * @return array The data for a comment
+ */
private function construct_comment($item, $owner) {
- $myaddr = self::my_handle($owner);
-
$p = q("SELECT `guid` FROM `item` WHERE `parent` = %d AND `id` = %d LIMIT 1",
intval($item["parent"]),
intval($item["parent"])
@@ -2273,9 +2957,19 @@ class diaspora {
"parent_guid" => $parent["guid"],
"author_signature" => "",
"text" => $text,
- "diaspora_handle" => $myaddr));
+ "diaspora_handle" => self::my_handle($owner)));
}
+ /**
+ * @brief Send a like or a comment
+ *
+ * @param array $item The item that will be exported
+ * @param array $owner the array of the item owner
+ * @param array $contact Target of the communication
+ * @param bool $public_batch Is it a public post?
+ *
+ * @return int The result of the transmission
+ */
public static function send_followup($item,$owner,$contact,$public_batch = false) {
if($item['verb'] === ACTIVITY_LIKE) {
@@ -2294,7 +2988,15 @@ class diaspora {
return self::build_and_transmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
}
- private function message_from_signatur($item, $signature) {
+ /**
+ * @brief Creates a message from a signature record entry
+ *
+ * @param array $item The item that will be exported
+ * @param array $signature The entry of the "sign" record
+ *
+ * @return string The message
+ */
+ private function message_from_signature($item, $signature) {
// Split the signed text
$signed_parts = explode(";", $signature['signed_text']);
@@ -2336,65 +3038,83 @@ class diaspora {
return $message;
}
+ /**
+ * @brief Relays messages (like, comment, retraction) to other servers if we are the thread owner
+ *
+ * @param array $item The item that will be exported
+ * @param array $owner the array of the item owner
+ * @param array $contact Target of the communication
+ * @param bool $public_batch Is it a public post?
+ *
+ * @return int The result of the transmission
+ */
public static function send_relay($item, $owner, $contact, $public_batch = false) {
- if ($item["deleted"]) {
- $sql_sign_id = "retract_iid";
- $type = "relayable_retraction";
- } elseif ($item['verb'] === ACTIVITY_LIKE) {
- $sql_sign_id = "iid";
+ if ($item["deleted"])
+ return self::send_retraction($item, $owner, $contact, $public_batch, true);
+ elseif ($item['verb'] === ACTIVITY_LIKE)
$type = "like";
- } else {
- $sql_sign_id = "iid";
+ else
$type = "comment";
- }
logger("Got relayable data ".$type." for item ".$item["guid"]." (".$item["id"].")", LOGGER_DEBUG);
// fetch the original signature
- $r = q("SELECT `signed_text`, `signature`, `signer` FROM `sign` WHERE `".$sql_sign_id."` = %d LIMIT 1",
+ $r = q("SELECT `signed_text`, `signature`, `signer` FROM `sign` WHERE `iid` = %d LIMIT 1",
intval($item["id"]));
- if (!$r)
- return self::send_followup($item, $owner, $contact, $public_batch);
+ if (!$r) {
+ logger("Couldn't fetch signatur for item ".$item["guid"]." (".$item["id"].")", LOGGER_DEBUG);
+ return false;
+ }
$signature = $r[0];
// Old way - is used by the internal Friendica functions
/// @todo Change all signatur storing functions to the new format
if ($signature['signed_text'] AND $signature['signature'] AND $signature['signer'])
- $message = self::message_from_signatur($item, $signature);
+ $message = self::message_from_signature($item, $signature);
else {// New way
$msg = json_decode($signature['signed_text'], true);
$message = array();
- foreach ($msg AS $field => $data) {
- if (!$item["deleted"]) {
- if ($field == "author")
- $field = "diaspora_handle";
- if ($field == "parent_type")
- $field = "target_type";
- }
+ if (is_array($msg)) {
+ foreach ($msg AS $field => $data) {
+ if (!$item["deleted"]) {
+ if ($field == "author")
+ $field = "diaspora_handle";
+ if ($field == "parent_type")
+ $field = "target_type";
+ }
- $message[$field] = $data;
- }
+ $message[$field] = $data;
+ }
+ } else
+ logger("Signature text for item ".$item["guid"]." (".$item["id"].") couldn't be extracted: ".$signature['signed_text'], LOGGER_DEBUG);
}
- if ($item["deleted"]) {
- $signed_text = $message["target_guid"].';'.$message["target_type"];
- $message["parent_author_signature"] = base64_encode(rsa_sign($signed_text, $owner["uprvkey"], "sha256"));
- } else
- $message["parent_author_signature"] = self::signature($owner, $message);
+ $message["parent_author_signature"] = self::signature($owner, $message);
logger("Relayed data ".print_r($message, true), LOGGER_DEBUG);
return self::build_and_transmit($owner, $contact, $type, $message, $public_batch, $item["guid"]);
}
- public static function send_retraction($item, $owner, $contact, $public_batch = false) {
+ /**
+ * @brief Sends a retraction (deletion) of a message, like or comment
+ *
+ * @param array $item The item that will be exported
+ * @param array $owner the array of the item owner
+ * @param array $contact Target of the communication
+ * @param bool $public_batch Is it a public post?
+ * @param bool $relay Is the retraction transmitted from a relay?
+ *
+ * @return int The result of the transmission
+ */
+ public static function send_retraction($item, $owner, $contact, $public_batch = false, $relay = false) {
- $myaddr = self::my_handle($owner);
+ $itemaddr = self::handle_from_contact($item["contact-id"], $item["gcontact-id"]);
// Check whether the retraction is for a top-level post or whether it's a relayable
if ($item["uri"] !== $item["parent-uri"]) {
@@ -2405,16 +3125,32 @@ class diaspora {
$target_type = "StatusMessage";
}
+ if ($relay AND ($item["uri"] !== $item["parent-uri"]))
+ $signature = "parent_author_signature";
+ else
+ $signature = "target_author_signature";
+
$signed_text = $item["guid"].";".$target_type;
$message = array("target_guid" => $item['guid'],
"target_type" => $target_type,
- "sender_handle" => $myaddr,
- "target_author_signature" => base64_encode(rsa_sign($signed_text,$owner['uprvkey'],'sha256')));
+ "sender_handle" => $itemaddr,
+ $signature => base64_encode(rsa_sign($signed_text,$owner['uprvkey'],'sha256')));
+
+ logger("Got message ".print_r($message, true), LOGGER_DEBUG);
return self::build_and_transmit($owner, $contact, $msg_type, $message, $public_batch, $item["guid"]);
}
+ /**
+ * @brief Sends a mail
+ *
+ * @param array $item The item that will be exported
+ * @param array $owner The owner
+ * @param array $contact Target of the communication
+ *
+ * @return int The result of the transmission
+ */
public static function send_mail($item, $owner, $contact) {
$myaddr = self::my_handle($owner);
@@ -2472,17 +3208,23 @@ class diaspora {
return self::build_and_transmit($owner, $contact, $type, $message, false, $item["guid"]);
}
- public static function send_profile($uid) {
+ /**
+ * @brief Sends profile data
+ *
+ * @param int $uid The user id
+ */
+ public static function send_profile($uid, $recips = false) {
if (!$uid)
return;
- $recips = q("SELECT `id`,`name`,`network`,`pubkey`,`notify` FROM `contact` WHERE `network` = '%s'
- AND `uid` = %d AND `rel` != %d",
- dbesc(NETWORK_DIASPORA),
- intval($uid),
- intval(CONTACT_IS_SHARING)
- );
+ if (!$recips)
+ $recips = q("SELECT `id`,`name`,`network`,`pubkey`,`notify` FROM `contact` WHERE `network` = '%s'
+ AND `uid` = %d AND `rel` != %d",
+ dbesc(NETWORK_DIASPORA),
+ intval($uid),
+ intval(CONTACT_IS_SHARING)
+ );
if (!$recips)
return;
@@ -2546,8 +3288,111 @@ class diaspora {
"searchable" => $searchable,
"tag_string" => $tags);
- foreach($recips as $recip)
+ foreach($recips as $recip) {
+ logger("Send updated profile data for user ".$uid." to contact ".$recip["id"], LOGGER_DEBUG);
self::build_and_transmit($profile, $recip, "profile", $message, false, "", true);
+ }
+ }
+
+ /**
+ * @brief Stores the signature for likes that are created on our system
+ *
+ * @param array $contact The contact array of the "like"
+ * @param int $post_id The post id of the "like"
+ *
+ * @return bool Success
+ */
+ public static function store_like_signature($contact, $post_id) {
+
+ // Is the contact the owner? Then fetch the private key
+ if (!$contact['self'] OR ($contact['uid'] == 0)) {
+ logger("No owner post, so not storing signature", LOGGER_DEBUG);
+ return false;
+ }
+
+ $r = q("SELECT `prvkey` FROM `user` WHERE `uid` = %d LIMIT 1", intval($contact['uid']));
+ if(!$r)
+ return false;
+
+ $contact["uprvkey"] = $r[0]['prvkey'];
+
+ $r = q("SELECT * FROM `item` WHERE `id` = %d LIMIT 1", intval($post_id));
+ if (!$r)
+ return false;
+
+ if (!in_array($r[0]["verb"], array(ACTIVITY_LIKE, ACTIVITY_DISLIKE)))
+ return false;
+
+ $message = self::construct_like($r[0], $contact);
+ $message["author_signature"] = self::signature($contact, $message);
+
+ // In the future we will store the signature more flexible to support new fields.
+ // Right now we cannot change this since old Friendica versions (prior to 3.5) can only handle this format.
+ // (We are transmitting this data here via DFRN)
+
+ $signed_text = $message["positive"].";".$message["guid"].";".$message["target_type"].";".
+ $message["parent_guid"].";".$message["diaspora_handle"];
+
+ q("INSERT INTO `sign` (`iid`,`signed_text`,`signature`,`signer`) VALUES (%d,'%s','%s','%s')",
+ intval($post_id),
+ dbesc($signed_text),
+ dbesc($message["author_signature"]),
+ dbesc($message["diaspora_handle"])
+ );
+
+ // This here will replace the lines above, once Diaspora changed its protocol
+ //q("INSERT INTO `sign` (`iid`,`signed_text`) VALUES (%d,'%s')",
+ // intval($message_id),
+ // dbesc(json_encode($message))
+ //);
+
+ logger('Stored diaspora like signature');
+ return true;
+ }
+
+ /**
+ * @brief Stores the signature for comments that are created on our system
+ *
+ * @param array $item The item array of the comment
+ * @param array $contact The contact array of the item owner
+ * @param string $uprvkey The private key of the sender
+ * @param int $message_id The message id of the comment
+ *
+ * @return bool Success
+ */
+ public static function store_comment_signature($item, $contact, $uprvkey, $message_id) {
+
+ if ($uprvkey == "") {
+ logger('No private key, so not storing comment signature', LOGGER_DEBUG);
+ return false;
+ }
+
+ $contact["uprvkey"] = $uprvkey;
+
+ $message = self::construct_comment($item, $contact);
+ $message["author_signature"] = self::signature($contact, $message);
+
+ // In the future we will store the signature more flexible to support new fields.
+ // Right now we cannot change this since old Friendica versions (prior to 3.5) can only handle this format.
+ // (We are transmitting this data here via DFRN)
+ $signed_text = $message["guid"].";".$message["parent_guid"].";".
+ $message["text"].";".$message["diaspora_handle"];
+
+ q("INSERT INTO `sign` (`iid`,`signed_text`,`signature`,`signer`) VALUES (%d,'%s','%s','%s')",
+ intval($message_id),
+ dbesc($signed_text),
+ dbesc($message["author_signature"]),
+ dbesc($message["diaspora_handle"])
+ );
+
+ // This here will replace the lines above, once Diaspora changed its protocol
+ //q("INSERT INTO `sign` (`iid`,`signed_text`) VALUES (%d,'%s')",
+ // intval($message_id),
+ // dbesc(json_encode($message))
+ //);
+
+ logger('Stored diaspora comment signature');
+ return true;
}
}
?>