]> git.mxchange.org Git - friendica.git/blobdiff - include/diaspora.php
There were undecoded entities in the title
[friendica.git] / include / diaspora.php
index 4e1b3005076c53e7bbbc311755741eb19b023916..2ff7a90cfbe677cc4eb92a880a4fb7be39bfb09d 100644 (file)
@@ -2,41 +2,6 @@
 /**
  * @file include/diaspora.php
  * @brief The implementation of the diaspora protocol
- *
- * Checklist:
- *
- * Checked:
- * - send status
- * - send comment
- * - send like
- * - send mail
- * - send status retraction
- * - send comment retraction on own post
- * - send like retraction on own post
- * - send comment retraction on diaspora post
- * - send like retraction on diaspora post
- * - receive status
- * - receive reshare
- * - receive comment
- * - receive like
- * - receive connect request
- * - receive profile data
- * - receive mail
- * - receive comment retraction
- * - receive like retraction
- * - relay comment
- * - relay like
- * - relay comment retraction from diaspora
- * - relay comment retraction from friendica
- * - relay like retraction from diaspora
- * - relay like retraction from friendica
- * - send share
- *
- * Should work:
- * - receive account deletion
- * - send unshare
- *
- * Unchecked:
  */
 
 require_once("include/items.php");
@@ -116,9 +81,9 @@ class diaspora {
         * @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 the repaired signature
+        * @return string the repaired signature
         */
-       function repair_signature($signature, $handle = "", $level = 1) {
+       private function repair_signature($signature, $handle = "", $level = 1) {
 
                if ($signature == "")
                        return ($signature);
@@ -146,7 +111,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);
@@ -179,16 +144,6 @@ class diaspora {
 
                        $decrypted = pkcs5_unpad($decrypted);
 
-                       /**
-                        * $decrypted now contains something like
-                        *
-                        *  <decrypted_header>
-                        *     <iv>8e+G2+ET8l5BPuW0sVTnQw==</iv>
-                        *     <aes_key>UvSMb4puPeB14STkcDWq+4QE302Edu15oaprAQSkLKU=</aes_key>
-                        *     <author_id>galaxor@diaspora.priateship.org</author_id>
-                        *  </decrypted_header>
-                        */
-
                        logger('decrypted: '.$decrypted, LOGGER_DEBUG);
                        $idom = parse_xml_string($decrypted,false);
 
@@ -287,7 +242,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) {
 
@@ -299,7 +254,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
@@ -316,7 +271,7 @@ class diaspora {
                } else
                        logger("No subscribers for ".$msg["author"]." ".print_r($msg, true));
 
-               return $item_id;
+               return $message_id;
        }
 
        /**
@@ -325,7 +280,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) {
 
@@ -349,6 +304,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);
 
@@ -370,9 +328,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"]);
 
@@ -428,6 +383,9 @@ class diaspora {
                if (in_array($type, array("signed_retraction", "relayable_retraction")))
                        $type = "retraction";
 
+               if ($type == "request")
+                       $type = "contact";
+
                $fields = new SimpleXMLElement("<".$type."/>");
 
                $signed_data = "";
@@ -657,7 +615,7 @@ class diaspora {
 
                        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);
@@ -744,7 +702,7 @@ class diaspora {
         * @param string $handle The checked handle in the format user@domain.tld
         * @param bool $is_comment Is the check for a comment?
         *
-        * @return bool is posting allowed?
+        * @return array The contact data
         */
        private function allowed_contact_by_handle($importer, $handle, $is_comment = false) {
                $contact = self::contact_by_handle($importer["uid"], $handle);
@@ -766,7 +724,7 @@ class diaspora {
         * @param int $uid The user id
         * @param string $guid The guid of the message
         *
-        * @return bool "true" if the message already was stored into the system
+        * @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",
@@ -776,7 +734,7 @@ class diaspora {
 
                if($r) {
                        logger("message ".$guid." already exists for user ".$uid);
-                       return true;
+                       return $r[0]["id"];
                }
 
                return false;
@@ -795,7 +753,7 @@ class diaspora {
        }
 
        /**
-        * @brief sub function of "fetch_guid"
+        * @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
@@ -838,7 +796,10 @@ class diaspora {
         * @param string $server The url of the server
         * @param int $level Endless loop prevention
         *
-        * @return array of message, author and public key
+        * @return array
+        *      'message' => The message XML
+        *      'author' => The author handle
+        *      'key' => The public key of the author
         */
        private function message($guid, $server, $level = 0) {
 
@@ -935,7 +896,9 @@ class diaspora {
         * @param array $person The record of the person
         * @param int $uid The user id
         *
-        * @return array of contact id and network type
+        * @return array
+        *      'cid' => contact id
+        *      'network' => network type
         */
        private function author_contact_by_url($contact, $person, $uid) {
 
@@ -1002,6 +965,9 @@ class diaspora {
         * @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);
@@ -1035,8 +1001,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)
@@ -1364,8 +1331,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)
@@ -1382,7 +1350,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;
@@ -1699,11 +1667,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"] = "<object><type>".ACTIVITY_OBJ_PERSON."</type><title>".$contact["name"]."</title>"
-                                       ."<id>".$contact["url"]."/".$contact["name"]."</id>";
-                               $arr["object"] .= "<link>".xmlify('<link rel="alternate" type="text/html" href="'.$contact["url"].'" />'."\n");
-                               $arr["object"] .= xmlify('<link rel="photo" type="image/jpeg" href="'.$contact["thumb"].'" />'."\n");
-                               $arr["object"] .= "</link></object>\n";
+                               $arr["object"] = self::construct_new_friend_object($contact);
+
                                $arr["last-child"] = 1;
 
                                $arr["allow_cid"] = $user[0]["allow_cid"];
@@ -1718,6 +1683,26 @@ class diaspora {
                }
        }
 
+       /**
+        * @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 = '<link rel="alternate" type="text/html" href="'.$contact["url"].'" />'."\n".
+                        '<link rel="photo" type="image/jpeg" href="'.$contact["thumb"].'" />'."\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
         *
@@ -1726,22 +1711,43 @@ class diaspora {
         *
         * @return bool Success
         */
-       private function receive_request($importer, $data) {
+       private function receive_contact_request($importer, $data) {
                $author = unxmlify($data->author);
                $recipient = unxmlify($data->recipient);
 
                if (!$author || !$recipient)
                        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) {
+                               self::receive_request_make_friend($importer, $contact);
+                               return true;
+                       } else /// @todo Handle all possible variations of adding and retracting of permissions
+                               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;
                }
 
                $ret = self::person_by_handle($author);
@@ -1781,12 +1787,10 @@ class diaspora {
                        return;
                }
 
-               $g = q("SELECT `def_gid` FROM `user` WHERE `uid` = %d LIMIT 1",
-                       intval($importer["uid"])
-               );
+               $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);
 
                if($importer["page-flags"] == PAGE_NORMAL) {
 
@@ -1812,8 +1816,10 @@ class diaspora {
                        // 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;
 
@@ -1860,10 +1866,18 @@ 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"], false))
+                       // 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];
                }
 
@@ -1896,8 +1910,13 @@ class diaspora {
                                        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];
+                               }
 
                        }
                }
@@ -1925,8 +1944,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;
 
                $original_item = self::original_item($root_guid, $root_author, $author);
                if (!$original_item)
@@ -2068,10 +2088,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:
@@ -2109,8 +2130,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)
@@ -2121,6 +2143,7 @@ class diaspora {
 
                $datarray = array();
 
+               // Attach embedded pictures to the body
                if ($data->photo) {
                        foreach ($data->photo AS $photo)
                                $body = "[img]".unxmlify($photo->remote_photo_path).
@@ -2179,9 +2202,9 @@ class diaspora {
                return $message_id;
        }
 
-       /******************************************************************************************
+       /* ************************************************************************************** *
         * Here are all the functions that are needed to transmit data with the Diaspora protocol *
-        ******************************************************************************************/
+        * ************************************************************************************** */
 
        /**
         * @brief returnes the handle of a contact
@@ -2190,13 +2213,18 @@ class diaspora {
         *
         * @return string the handle in the format user@domain.tld
         */
-       private function my_handle($me) {
+       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);
        }
 
        /**
@@ -2522,7 +2550,7 @@ class diaspora {
 
                // 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?
@@ -2583,8 +2611,9 @@ 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);
        }
 
@@ -2689,7 +2718,7 @@ class diaspora {
                                "guid" => $item["guid"],
                                "target_type" => $target_type,
                                "parent_guid" => $parent["guid"],
-                               "author_signature" => $authorsig,
+                               "author_signature" => "",
                                "diaspora_handle" => self::my_handle($owner)));
        }
 
@@ -3052,5 +3081,106 @@ class diaspora {
                foreach($recips as $recip)
                        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;
+       }
 }
 ?>