]> git.mxchange.org Git - friendica.git/blobdiff - src/Protocol/DFRN.php
New function to fetch endpoint items
[friendica.git] / src / Protocol / DFRN.php
index 354653c9b9898ea30b28acd269cbdc4939f96e83..4c88db1d944a47c0a70d69e7618566438fb652f9 100644 (file)
@@ -1,11 +1,24 @@
 <?php
 /**
- * @file include/dfrn.php
- * @brief The implementation of the dfrn protocol
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  *
- * @see https://github.com/friendica/friendica/wiki/Protocol and
- * https://github.com/friendica/friendica/blob/master/spec/dfrn2.pdf
  */
+
 namespace Friendica\Protocol;
 
 use DOMDocument;
@@ -14,7 +27,6 @@ use Friendica\App\BaseURL;
 use Friendica\Content\OEmbed;
 use Friendica\Content\Text\BBCode;
 use Friendica\Content\Text\HTML;
-use Friendica\Core\Config;
 use Friendica\Core\Hook;
 use Friendica\Core\Logger;
 use Friendica\Core\Protocol;
@@ -26,6 +38,7 @@ use Friendica\Model\Event;
 use Friendica\Model\GContact;
 use Friendica\Model\Item;
 use Friendica\Model\Mail;
+use Friendica\Model\Notify\Type;
 use Friendica\Model\PermissionSet;
 use Friendica\Model\Profile;
 use Friendica\Model\User;
@@ -40,7 +53,7 @@ use HTMLPurifier;
 use HTMLPurifier_Config;
 
 /**
- * @brief This class contain functions to create and send DFRN XML files
+ * This class contain functions to create and send DFRN XML files
  */
 class DFRN
 {
@@ -50,7 +63,7 @@ class DFRN
        const REPLY_RC = 2;     // Reply that will be relayed
 
        /**
-        * @brief Generates an array of contact and user for DFRN imports
+        * Generates an array of contact and user for DFRN imports
         *
         * This array contains not only the receiver but also the sender of the message.
         *
@@ -91,7 +104,7 @@ class DFRN
        }
 
        /**
-        * @brief Generates the atom entries for delivery.php
+        * Generates the atom entries for delivery.php
         *
         * This function is used whenever content is transmitted via DFRN.
         *
@@ -130,7 +143,7 @@ class DFRN
        }
 
        /**
-        * @brief Generate an atom feed for the given user
+        * Generate an atom feed for the given user
         *
         * This function is called when another server is pulling data from the user feed.
         *
@@ -146,7 +159,7 @@ class DFRN
         */
        public static function feed($dfrn_id, $owner_nick, $last_update, $direction = 0, $onlyheader = false)
        {
-               $a = \get_app();
+               $a = DI::app();
 
                $sitefeed    = ((strlen($owner_nick)) ? false : true); // not yet implemented, need to rewrite huge chunks of following logic
                $public_feed = (($dfrn_id) ? false : true);
@@ -169,7 +182,7 @@ class DFRN
 
                // default permissions - anonymous user
 
-               $sql_extra = " AND NOT `item`.`private` ";
+               $sql_extra = sprintf(" AND `item`.`private` != %s ", Item::PRIVATE);
 
                $r = q(
                        "SELECT `contact`.*, `user`.`nickname`, `user`.`timezone`, `user`.`page-flags`, `user`.`account-type`
@@ -221,7 +234,7 @@ class DFRN
                        if (!empty($set)) {
                                $sql_extra = " AND `item`.`psid` IN (" . implode(',', $set) .")";
                        } else {
-                               $sql_extra = " AND NOT `item`.`private`";
+                               $sql_extra = sprintf(" AND `item`.`private` != %s", Item::PRIVATE);
                        }
                }
 
@@ -319,7 +332,7 @@ class DFRN
                        if ($public_feed) {
                                $type = 'html';
                                // catch any email that's in a public conversation and make sure it doesn't leak
-                               if ($item['private']) {
+                               if ($item['private'] == Item::PRIVATE) {
                                        continue;
                                }
                        } else {
@@ -340,7 +353,7 @@ class DFRN
        }
 
        /**
-        * @brief Generate an atom entry for a given item id
+        * Generate an atom entry for a given item id
         *
         * @param int     $item_id      The item id
         * @param boolean $conversation Show the conversation. If false show the single post.
@@ -409,7 +422,7 @@ class DFRN
        }
 
        /**
-        * @brief Create XML text for DFRN mails
+        * Create XML text for DFRN mails
         *
         * @param array $item  message elements
         * @param array $owner Owner record
@@ -446,7 +459,7 @@ class DFRN
        }
 
        /**
-        * @brief Create XML text for DFRN friend suggestions
+        * Create XML text for DFRN friend suggestions
         *
         * @param array $item  suggestion elements
         * @param array $owner Owner record
@@ -476,7 +489,7 @@ class DFRN
        }
 
        /**
-        * @brief Create XML text for DFRN relocations
+        * Create XML text for DFRN relocations
         *
         * @param array $owner Owner record
         * @param int   $uid   User ID
@@ -489,11 +502,11 @@ class DFRN
        {
 
                /* get site pubkey. this could be a new installation with no site keys*/
-               $pubkey = Config::get('system', 'site_pubkey');
+               $pubkey = DI::config()->get('system', 'site_pubkey');
                if (! $pubkey) {
                        $res = Crypto::newKeypair(1024);
-                       Config::set('system', 'site_prvkey', $res['prvkey']);
-                       Config::set('system', 'site_pubkey', $res['pubkey']);
+                       DI::config()->set('system', 'site_prvkey', $res['prvkey']);
+                       DI::config()->set('system', 'site_pubkey', $res['pubkey']);
                }
 
                $rp = q(
@@ -527,7 +540,7 @@ class DFRN
                XML::addElement($doc, $relocate, "dfrn:confirm", $owner['confirm']);
                XML::addElement($doc, $relocate, "dfrn:notify", $owner['notify']);
                XML::addElement($doc, $relocate, "dfrn:poll", $owner['poll']);
-               XML::addElement($doc, $relocate, "dfrn:sitepubkey", Config::get('system', 'site_pubkey'));
+               XML::addElement($doc, $relocate, "dfrn:sitepubkey", DI::config()->get('system', 'site_pubkey'));
 
                $root->appendChild($relocate);
 
@@ -535,7 +548,7 @@ class DFRN
        }
 
        /**
-        * @brief Adds the header elements for the DFRN protocol
+        * Adds the header elements for the DFRN protocol
         *
         * @param DOMDocument $doc           XML document
         * @param array       $owner         Owner record
@@ -613,7 +626,7 @@ class DFRN
        }
 
        /**
-        * @brief Adds the author element in the header for the DFRN protocol
+        * Adds the author element in the header for the DFRN protocol
         *
         * @param DOMDocument $doc           XML document
         * @param array       $owner         Owner record
@@ -626,27 +639,17 @@ class DFRN
         */
        private static function addAuthor(DOMDocument $doc, array $owner, $authorelement, $public)
        {
-               // Is the profile hidden or shouldn't be published in the net? Then add the "hide" element
-               $r = q(
-                       "SELECT `id` FROM `profile` INNER JOIN `user` ON `user`.`uid` = `profile`.`uid`
-                               WHERE (`hidewall` OR NOT `net-publish`) AND `user`.`uid` = %d",
-                       intval($owner['uid'])
-               );
-               if (DBA::isResult($r)) {
-                       $hidewall = true;
-               } else {
-                       $hidewall = false;
-               }
+               // Should the profile be "unsearchable" in the net? Then add the "hide" element
+               $hide = DBA::exists('profile', ['uid' => $owner['uid'], 'net-publish' => false]);
 
                $author = $doc->createElement($authorelement);
 
                $namdate = DateTimeFormat::utc($owner['name-date'].'+00:00', DateTimeFormat::ATOM);
-               $uridate = DateTimeFormat::utc($owner['uri-date'].'+00:00', DateTimeFormat::ATOM);
                $picdate = DateTimeFormat::utc($owner['avatar-date'].'+00:00', DateTimeFormat::ATOM);
 
                $attributes = [];
 
-               if (!$public || !$hidewall) {
+               if (!$public || !$hide) {
                        $attributes = ["dfrn:updated" => $namdate];
                }
 
@@ -657,7 +660,7 @@ class DFRN
                $attributes = ["rel" => "photo", "type" => "image/jpeg",
                                        "media:width" => 300, "media:height" => 300, "href" => $owner['photo']];
 
-               if (!$public || !$hidewall) {
+               if (!$public || !$hide) {
                        $attributes["dfrn:updated"] = $picdate;
                }
 
@@ -666,7 +669,7 @@ class DFRN
                $attributes["rel"] = "avatar";
                XML::addElement($doc, $author, "link", "", $attributes);
 
-               if ($hidewall) {
+               if ($hide) {
                        XML::addElement($doc, $author, "dfrn:hide", "true");
                }
 
@@ -688,7 +691,7 @@ class DFRN
                                `profile`.`pub_keywords`, `profile`.`xmpp`, `profile`.`dob`
                        FROM `profile`
                                INNER JOIN `user` ON `user`.`uid` = `profile`.`uid`
-                               WHERE `profile`.`is-default` AND NOT `user`.`hidewall` AND `user`.`uid` = %d",
+                               WHERE NOT `user`.`hidewall` AND `user`.`uid` = %d",
                        intval($owner['uid'])
                );
                if (DBA::isResult($r)) {
@@ -758,7 +761,7 @@ class DFRN
        }
 
        /**
-        * @brief Adds the author elements in the "entry" elements of the DFRN protocol
+        * Adds the author elements in the "entry" elements of the DFRN protocol
         *
         * @param DOMDocument $doc         XML document
         * @param string $element     Element name for the author
@@ -803,7 +806,7 @@ class DFRN
        }
 
        /**
-        * @brief Adds the activity elements
+        * Adds the activity elements
         *
         * @param DOMDocument $doc      XML document
         * @param string      $element  Element name for the activity
@@ -870,7 +873,7 @@ class DFRN
        }
 
        /**
-        * @brief Adds the elements for attachments
+        * Adds the elements for attachments
         *
         * @param object $doc  XML document
         * @param object $root XML root
@@ -906,7 +909,7 @@ class DFRN
        }
 
        /**
-        * @brief Adds the "entry" elements for the DFRN protocol
+        * Adds the "entry" elements for the DFRN protocol
         *
         * @param DOMDocument $doc     XML document
         * @param string      $type    "text" or "html"
@@ -952,7 +955,7 @@ class DFRN
                        $entry->setAttribute("xmlns:statusnet", ActivityNamespace::STATUSNET);
                }
 
-               if ($item['private']) {
+               if ($item['private'] == Item::PRIVATE) {
                        $body = Item::fixPrivatePhotos($item['body'], $owner['uid'], $item, $cid);
                } else {
                        $body = $item['body'];
@@ -1047,7 +1050,9 @@ class DFRN
                }
 
                if ($item['private']) {
-                       XML::addElement($doc, $entry, "dfrn:private", ($item['private'] ? $item['private'] : 1));
+                       // Friendica versions prior to 2020.3 can't handle "unlisted" properly. So we can only transmit public and private
+                       XML::addElement($doc, $entry, "dfrn:private", ($item['private'] == Item::PRIVATE ? Item::PRIVATE : Item::PUBLIC));
+                       XML::addElement($doc, $entry, "dfrn:unlisted", $item['private'] == Item::UNLISTED);
                }
 
                if ($item['extid']) {
@@ -1143,7 +1148,7 @@ class DFRN
        }
 
        /**
-        * @brief encrypts data via AES
+        * encrypts data via AES
         *
         * @param string $data The data that is to be encrypted
         * @param string $key  The AES key
@@ -1156,7 +1161,7 @@ class DFRN
        }
 
        /**
-        * @brief decrypts data via AES
+        * decrypts data via AES
         *
         * @param string $encrypted The encrypted data
         * @param string $key       The AES key
@@ -1169,7 +1174,7 @@ class DFRN
        }
 
        /**
-        * @brief Delivers the atom content to the contacts
+        * Delivers the atom content to the contacts
         *
         * @param array  $owner    Owner record
         * @param array  $contact  Contact record of the receiver
@@ -1192,12 +1197,12 @@ class DFRN
                        $idtosend = '1:' . $orig_id;
                }
 
-               $rino = Config::get('system', 'rino_encrypt');
+               $rino = DI::config()->get('system', 'rino_encrypt');
                $rino = intval($rino);
 
                Logger::log("Local rino version: ". $rino, Logger::DEBUG);
 
-               $ssl_val = intval(Config::get('system', 'ssl_policy'));
+               $ssl_val = intval(DI::config()->get('system', 'ssl_policy'));
 
                switch ($ssl_val) {
                        case BaseURL::SSL_POLICY_FULL:
@@ -1405,7 +1410,7 @@ class DFRN
        }
 
        /**
-        * @brief Transmits atom content to the contacts via the Diaspora transport layer
+        * Transmits atom content to the contacts via the Diaspora transport layer
         *
         * @param array  $owner   Owner record
         * @param array  $contact Contact record of the receiver
@@ -1495,7 +1500,7 @@ class DFRN
        }
 
        /**
-        * @brief Fetch the author data from head or entry items
+        * Fetch the author data from head or entry items
         *
         * @param object $xpath     XPath object
         * @param object $context   In which context should the data be searched
@@ -1729,7 +1734,7 @@ class DFRN
        }
 
        /**
-        * @brief Transforms activity objects into an XML string
+        * Transforms activity objects into an XML string
         *
         * @param object $xpath    XPath object
         * @param object $activity Activity object
@@ -1784,7 +1789,7 @@ class DFRN
        }
 
        /**
-        * @brief Processes the mail elements
+        * Processes the mail elements
         *
         * @param object $xpath    XPath object
         * @param object $mail     mail elements
@@ -1813,7 +1818,7 @@ class DFRN
        }
 
        /**
-        * @brief Processes the suggestion elements
+        * Processes the suggestion elements
         *
         * @param object $xpath      XPath object
         * @param object $suggestion suggestion elements
@@ -1893,7 +1898,7 @@ class DFRN
 
                notification(
                        [
-                               'type'         => NOTIFY_SUGGEST,
+                               'type'         => Type::SUGGEST,
                                'notify_flags' => $importer['notify-flags'],
                                'language'     => $importer['language'],
                                'to_name'      => $importer['username'],
@@ -1912,7 +1917,7 @@ class DFRN
        }
 
        /**
-        * @brief Processes the relocation elements
+        * Processes the relocation elements
         *
         * @param object $xpath      XPath object
         * @param object $relocation relocation elements
@@ -1997,7 +2002,7 @@ class DFRN
        }
 
        /**
-        * @brief Updates an item
+        * Updates an item
         *
         * @param array $current   the current item record
         * @param array $item      the new item record
@@ -2030,7 +2035,7 @@ class DFRN
        }
 
        /**
-        * @brief Detects the entry type of the item
+        * Detects the entry type of the item
         *
         * @param array $importer Record of the importer user mixed with contact of the content
         * @param array $item     the new item record
@@ -2098,7 +2103,7 @@ class DFRN
        }
 
        /**
-        * @brief Send a "poke"
+        * Send a "poke"
         *
         * @param array $item      The new item record
         * @param array $importer  Record of the importer user mixed with contact of the content
@@ -2137,7 +2142,7 @@ class DFRN
                                // send a notification
                                notification(
                                        [
-                                       "type"         => NOTIFY_POKE,
+                                       "type"         => Type::POKE,
                                        "notify_flags" => $importer["notify-flags"],
                                        "language"     => $importer["language"],
                                        "to_name"      => $importer["username"],
@@ -2158,7 +2163,7 @@ class DFRN
        }
 
        /**
-        * @brief Processes several actions, depending on the verb
+        * Processes several actions, depending on the verb
         *
         * @param int   $entrytype Is it a toplevel entry, a comment or a relayed comment?
         * @param array $importer  Record of the importer user mixed with contact of the content
@@ -2260,7 +2265,7 @@ class DFRN
        }
 
        /**
-        * @brief Processes the link elements
+        * Processes the link elements
         *
         * @param object $links link elements
         * @param array  $item  the item record
@@ -2304,7 +2309,7 @@ class DFRN
        }
 
        /**
-        * @brief Processes the entry elements which contain the items and comments
+        * Processes the entry elements which contain the items and comments
         *
         * @param array  $header   Array of the header elements that always stay the same
         * @param object $xpath    XPath object
@@ -2365,7 +2370,7 @@ class DFRN
                $item["body"] = XML::getFirstNodeValue($xpath, "dfrn:env/text()", $entry);
                $item["body"] = str_replace([' ',"\t","\r","\n"], ['','','',''], $item["body"]);
                // make sure nobody is trying to sneak some html tags by us
-               $item["body"] = Strings::escapeTags(Strings::base64UrlDecode($item["body"]));
+               $item["body"] = Strings::base64UrlDecode($item["body"]);
 
                $item["body"] = BBCode::limitBodySize($item["body"]);
 
@@ -2401,6 +2406,11 @@ class DFRN
 
                $item["private"] = XML::getFirstNodeValue($xpath, "dfrn:private/text()", $entry);
 
+               $unlisted = XML::getFirstNodeValue($xpath, "dfrn:unlisted/text()", $entry);
+               if (!empty($unlisted) && ($item['private'] != Item::PRIVATE)) {
+                       $item['private'] = Item::UNLISTED;
+               }
+
                $item["extid"] = XML::getFirstNodeValue($xpath, "dfrn:extid/text()", $entry);
 
                if (XML::getFirstNodeValue($xpath, "dfrn:bookmark/text()", $entry) == "true") {
@@ -2649,7 +2659,7 @@ class DFRN
        }
 
        /**
-        * @brief Deletes items
+        * Deletes items
         *
         * @param object $xpath    XPath object
         * @param object $deletion deletion elements
@@ -2710,7 +2720,7 @@ class DFRN
        }
 
        /**
-        * @brief Imports a DFRN message
+        * Imports a DFRN message
         *
         * @param string $xml          The DFRN message
         * @param array  $importer     Record of the importer user mixed with contact of the content
@@ -2853,7 +2863,7 @@ class DFRN
        }
 
        /**
-        * @brief Returns the activity verb
+        * Returns the activity verb
         *
         * @param array $item Item array
         *