]> git.mxchange.org Git - friendica.git/blobdiff - src/Protocol/Delivery.php
Merge pull request #13561 from annando/log-callstack
[friendica.git] / src / Protocol / Delivery.php
index 59b4ea6c300947199c32b45cebed9b417d169b70..9f8174e2d4e08a0ff6e5c87e88e3aa507150dbb2 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
  *
  */
 
-namespace Friendica\Worker;
+namespace Friendica\Protocol;
 
 use Friendica\Contact\FriendSuggest\Collection\FriendSuggests;
 use Friendica\Contact\FriendSuggest\Exception\FriendSuggestNotFoundException;
 use Friendica\Core\Logger;
 use Friendica\Core\Protocol;
 use Friendica\Core\Worker;
+use Friendica\Database\Database;
 use Friendica\Database\DBA;
 use Friendica\DI;
 use Friendica\Model\Contact;
@@ -33,11 +34,6 @@ use Friendica\Model\GServer;
 use Friendica\Model\Item;
 use Friendica\Model\Post;
 use Friendica\Model\User;
-use Friendica\Protocol\Activity;
-use Friendica\Protocol\DFRN;
-use Friendica\Protocol\Diaspora;
-use Friendica\Protocol\Email;
-use Friendica\Protocol\Relay;
 use Friendica\Util\Network;
 
 class Delivery
@@ -50,19 +46,28 @@ class Delivery
        const REMOVAL       = 'removeme';
        const PROFILEUPDATE = 'profileupdate';
 
-       public static function execute(string $cmd, int $post_uriid, int $contact_id, int $sender_uid = 0)
+       /**
+        * Deliver posts to other systems
+        *
+        * @param string $cmd
+        * @param integer $post_uriid
+        * @param integer $contact_id
+        * @param integer $sender_uid
+        * @return bool "false" on remote system error. "true" when delivery was successful or we shouldn't retry.
+        */
+       public static function deliver(string $cmd, int $post_uriid, int $contact_id, int $sender_uid = 0): bool
        {
                Logger::info('Invoked', ['cmd' => $cmd, 'target' => $post_uriid, 'sender_uid' => $sender_uid, 'contact' => $contact_id]);
 
-               $top_level = false;
-               $followup = false;
+               $top_level      = false;
+               $followup       = false;
                $public_message = false;
 
                $items = [];
                if ($cmd == self::MAIL) {
                        $target_item = DBA::selectFirst('mail', [], ['id' => $post_uriid]);
                        if (!DBA::isResult($target_item)) {
-                               return;
+                               return true;
                        }
                        $uid = $target_item['uid'];
                } elseif ($cmd == self::SUGGESTION) {
@@ -70,24 +75,24 @@ class Delivery
                                $target_item = DI::fsuggest()->selectOneById($post_uriid)->toArray();
                        } catch (FriendSuggestNotFoundException $e) {
                                DI::logger()->info('Cannot find FriendSuggestion', ['id' => $post_uriid]);
-                               return;
+                               return true;
                        }
                        $uid = $target_item['uid'];
                } elseif ($cmd == self::RELOCATION) {
-                       $uid = $post_uriid;
+                       $uid         = $post_uriid;
                        $target_item = [];
                } else {
                        $item = Post::selectFirst(['id', 'parent'], ['uri-id' => $post_uriid, 'uid' => $sender_uid]);
                        if (!DBA::isResult($item) || empty($item['parent'])) {
                                Logger::warning('Post not found', ['uri-id' => $post_uriid, 'uid' => $sender_uid]);
-                               return;
+                               return true;
                        }
                        $target_id = intval($item['id']);
                        $parent_id = intval($item['parent']);
 
                        $condition = ['id' => [$target_id, $parent_id], 'visible' => true];
-                       $params = ['order' => ['id']];
-                       $itemdata = Post::select(Item::DELIVER_FIELDLIST, $condition, $params);
+                       $params    = ['order' => ['id']];
+                       $itemdata  = Post::select(Item::DELIVER_FIELDLIST, $condition, $params);
 
                        while ($item = Post::fetch($itemdata)) {
                                if ($item['verb'] == Activity::ANNOUNCE) {
@@ -106,13 +111,13 @@ class Delivery
 
                        if (empty($target_item)) {
                                Logger::warning("No target item data. Quitting here.", ['id' => $target_id]);
-                               return;
+                               return true;
                        }
 
                        if (empty($parent)) {
                                Logger::warning('Parent ' . $parent_id . ' for item ' . $target_id . "wasn't found. Quitting here.");
                                self::setFailedQueue($cmd, $target_item);
-                               return;
+                               return true;
                        }
 
                        if (!empty($target_item['contact-uid'])) {
@@ -122,10 +127,10 @@ class Delivery
                        } else {
                                Logger::info('Only public users for item ' . $target_id);
                                self::setFailedQueue($cmd, $target_item);
-                               return;
+                               return true;
                        }
 
-                       $condition = ['uri' => $target_item['thr-parent'], 'uid' => $target_item['uid']];
+                       $condition  = ['uri' => $target_item['thr-parent'], 'uid' => $target_item['uid']];
                        $thr_parent = Post::selectFirst(['network', 'object'], $condition);
                        if (!DBA::isResult($thr_parent)) {
                                // Shouldn't happen. But when this does, we just take the parent as thread parent.
@@ -136,7 +141,7 @@ class Delivery
                        if (!empty($contact_id) && Contact::isArchived($contact_id)) {
                                Logger::info('Contact is archived', ['id' => $contact_id, 'cmd' => $cmd, 'item' => $target_item['id']]);
                                self::setFailedQueue($cmd, $target_item);
-                               return;
+                               return true;
                        }
 
                        // avoid race condition with deleting entries
@@ -156,7 +161,7 @@ class Delivery
                        // if $parent['wall'] == 1 we will already have the parent message in our array
                        // and we will relay the whole lot.
 
-                       $localhost = DI::baseUrl()->getHostname();
+                       $localhost = DI::baseUrl()->getHost();
                        if (strpos($localhost, ':')) {
                                $localhost = substr($localhost, 0, strpos($localhost, ':'));
                        }
@@ -190,7 +195,7 @@ class Delivery
                $owner = User::getOwnerDataById($uid);
                if (!DBA::isResult($owner)) {
                        self::setFailedQueue($cmd, $target_item);
-                       return;
+                       return true;
                }
 
                // We don't deliver our items to blocked, archived or pending contacts, and not to ourselves either
@@ -199,12 +204,12 @@ class Delivery
                );
                if (!DBA::isResult($contact)) {
                        self::setFailedQueue($cmd, $target_item);
-                       return;
+                       return true;
                }
 
                if (Network::isUrlBlocked($contact['url'])) {
                        self::setFailedQueue($cmd, $target_item);
-                       return;
+                       return true;
                }
 
                $protocol = GServer::getProtocol($contact['gsid'] ?? 0);
@@ -222,22 +227,23 @@ class Delivery
 
                switch ($contact['network']) {
                        case Protocol::DFRN:
-                               self::deliverDFRN($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup, $protocol);
+                               $success = self::deliverDFRN($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup, $protocol);
                                break;
 
                        case Protocol::DIASPORA:
-                               self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
+                               $success = self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
                                break;
 
                        case Protocol::MAIL:
-                               self::deliverMail($cmd, $contact, $owner, $target_item, $thr_parent);
+                               $success = self::deliverMail($cmd, $contact, $owner, $target_item, $thr_parent);
                                break;
 
                        default:
+                               $success = true;
                                break;
                }
 
-               return;
+               return $success;
        }
 
        /**
@@ -270,27 +276,26 @@ class Delivery
         * @param boolean  $followup        Is it an answer to a remote post?
         * @param int|null $server_protocol The protocol of the server
         *
-        * @return void
+        * @return bool "false" on remote system error. "true" when delivery was successful or we shouldn't retry.
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       private static function deliverDFRN(string $cmd, array $contact, array $owner, array $items, array $target_item, bool $public_message, bool $top_level, bool $followup, int $server_protocol = null)
+       private static function deliverDFRN(string $cmd, array $contact, array $owner, array $items, array $target_item, bool $public_message, bool $top_level, bool $followup, int $server_protocol = null): bool
        {
                $target_item_id = $target_item['guid'] ?? '' ?: $target_item['id'] ?? null;
 
                // Transmit Diaspora reshares via Diaspora if the Friendica contact support Diaspora
                if (Diaspora::getReshareDetails($target_item) && Diaspora::isSupportedByContactUrl($contact['addr'])) {
                        Logger::info('Reshare will be transmitted via Diaspora', ['url' => $contact['url'], 'guid' => $target_item_id]);
-                       self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
-                       return;
+                       return self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
                }
 
                Logger::info('Deliver ' . ($target_item_id ?? 'relocation') . ' via DFRN to ' . ($contact['addr'] ?? '' ?: $contact['url']));
 
                if ($cmd == self::MAIL) {
-                       $item = $target_item;
+                       $item         = $target_item;
                        $item['body'] = Item::fixPrivatePhotos($item['body'], $owner['uid'], null, $item['contact-id']);
-                       $atom = DFRN::mail($item, $owner);
+                       $atom         = DFRN::mail($item, $owner);
                } elseif ($cmd == self::SUGGESTION) {
                        $item = $target_item;
                        $atom = DFRN::fsuggest($item, $owner);
@@ -299,7 +304,7 @@ class Delivery
                        $atom = DFRN::relocate($owner, $owner['uid']);
                } elseif ($followup) {
                        $msgitems = [$target_item];
-                       $atom = DFRN::entries($msgitems, $owner);
+                       $atom     = DFRN::entries($msgitems, $owner);
                } else {
                        if ($target_item['deleted']) {
                                $msgitems = [$target_item];
@@ -309,8 +314,8 @@ class Delivery
                                        // Only add the parent when we don't delete other items.
                                        if (($target_item['id'] == $item['id']) || ($cmd != self::DELETION)) {
                                                $item['entry:comment-allow'] = true;
-                                               $item['entry:cid'] = ($top_level ? $contact['id'] : 0);
-                                               $msgitems[] = $item;
+                                               $item['entry:cid']           = ($top_level ? $contact['id'] : 0);
+                                               $msgitems[]                  = $item;
                                        }
                                }
                        }
@@ -338,17 +343,18 @@ class Delivery
                                                Post\DeliveryData::incrementQueueDone($target_item['uri-id'], $protocol);
 
                                                GServer::setProtocol($contact['gsid'] ?? 0, $protocol);
+                                               $success = true;
                                        } else {
                                                Post\DeliveryData::incrementQueueFailed($target_item['uri-id']);
+                                               $success = false;
                                        }
                                }
-                               return;
+                               return $success;
                        }
 
                        if ((($deliver_status < 200) || ($deliver_status > 299)) && (empty($server_protocol) || ($server_protocol == Post\DeliveryData::LEGACY_DFRN))) {
                                // Transmit via Diaspora if not possible via Friendica
-                               self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
-                               return;
+                               return self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
                        }
                } else {
                        // DFRN payload over Diaspora transport layer
@@ -366,6 +372,7 @@ class Delivery
                        if ($cmd == Delivery::POST) {
                                Post\DeliveryData::incrementQueueDone($target_item['uri-id'], $protocol);
                        }
+                       $success = true;
                } else {
                        // The message could not be delivered. We mark the contact as "dead"
                        Contact::markForArchival($contact);
@@ -374,7 +381,9 @@ class Delivery
                        if (!Worker::defer() && $cmd == Delivery::POST) {
                                Post\DeliveryData::incrementQueueFailed($target_item['uri-id']);
                        }
+                       $success = false;
                }
+               return $success;
        }
 
        /**
@@ -389,13 +398,13 @@ class Delivery
         * @param boolean $top_level      Is it a thread starter?
         * @param boolean $followup       Is it an answer to a remote post?
         *
-        * @return void
+        * @return bool "false" on remote system error. "true" when delivery was successful or we shouldn't retry.
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       private static function deliverDiaspora(string $cmd, array $contact, array $owner, array $items, array $target_item, bool $public_message, bool $top_level, bool $followup)
+       private static function deliverDiaspora(string $cmd, array $contact, array $owner, array $items, array $target_item, bool $public_message, bool $top_level, bool $followup): bool
        {
-               // We don't treat Forum posts as "wall-to-wall" to be able to post them via Diaspora
+               // We don't treat group posts as "wall-to-wall" to be able to post them via Diaspora
                $walltowall = $top_level && ($owner['id'] != $items[0]['contact-id']) & ($owner['account-type'] != User::ACCOUNT_TYPE_COMMUNITY);
 
                if ($public_message) {
@@ -407,20 +416,20 @@ class Delivery
                Logger::notice('Deliver via Diaspora', ['target' => $target_item['id'], 'guid' => $target_item['guid'], 'to' => $loc]);
 
                if (!DI::config()->get('system', 'diaspora_enabled')) {
-                       return;
+                       return true;
                }
 
                if ($cmd == self::MAIL) {
-                       Diaspora::sendMail($target_item, $owner, $contact);
-                       return;
+                       $deliver_status = Diaspora::sendMail($target_item, $owner, $contact);
+                       return ($deliver_status >= 200) && ($deliver_status <= 299);
                }
 
                if ($cmd == self::SUGGESTION) {
-                       return;
+                       return true;
                }
 
                if (!$contact['pubkey'] && !$public_message) {
-                       return;
+                       return true;
                }
 
                if ($cmd == self::RELOCATION) {
@@ -443,7 +452,7 @@ class Delivery
                        $deliver_status = Diaspora::sendStatus($target_item, $owner, $contact, $public_message);
                } else {
                        Logger::warning('Unknown mode', ['command' => $cmd, 'target' => $loc]);
-                       return;
+                       return true;
                }
 
                if (($deliver_status >= 200) && ($deliver_status <= 299)) {
@@ -455,6 +464,7 @@ class Delivery
                        if ($cmd == Delivery::POST) {
                                Post\DeliveryData::incrementQueueDone($target_item['uri-id'], Post\DeliveryData::DIASPORA);
                        }
+                       $success = true;
                } else {
                        // The message could not be delivered. We mark the contact as "dead"
                        Contact::markForArchival($contact);
@@ -473,7 +483,9 @@ class Delivery
                        } elseif ($cmd == Delivery::POST) {
                                Post\DeliveryData::incrementQueueFailed($target_item['uri-id']);
                        }
+                       $success = false;
                }
+               return $success;
        }
 
        /**
@@ -485,27 +497,27 @@ class Delivery
         * @param array  $target_item Item record of the content
         * @param array  $thr_parent  Item record of the direct parent in the thread
         *
-        * @return void
+        * @return bool "false" on remote system error. "true" when delivery was successful or we shouldn't retry.
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       private static function deliverMail(string $cmd, array $contact, array $owner, array $target_item, array $thr_parent)
+       private static function deliverMail(string $cmd, array $contact, array $owner, array $target_item, array $thr_parent): bool
        {
                if (DI::config()->get('system', 'imap_disabled')) {
-                       return;
+                       return true;
                }
 
                $addr = $contact['addr'];
                if (!strlen($addr)) {
-                       return;
+                       return true;
                }
 
                if ($cmd != self::POST) {
-                       return;
+                       return true;
                }
 
                if ($target_item['verb'] != Activity::POST) {
-                       return;
+                       return true;
                }
 
                if (!empty($thr_parent['object'])) {
@@ -521,7 +533,7 @@ class Delivery
 
                $local_user = DBA::selectFirst('user', [], ['uid' => $owner['uid']]);
                if (!DBA::isResult($local_user)) {
-                       return;
+                       return true;
                }
 
                Logger::info('About to deliver via mail', ['guid' => $target_item['guid'], 'to' => $addr]);
@@ -532,20 +544,20 @@ class Delivery
                        $reply_to = $mailacct['reply_to'];
                }
 
-               $subject  = ($target_item['title'] ? Email::encodeHeader($target_item['title'], 'UTF-8') : DI::l10n()->t("\x28no subject\x29"));
+               $subject = ($target_item['title'] ? Email::encodeHeader($target_item['title'], 'UTF-8') : DI::l10n()->t("\x28no subject\x29"));
 
                // only expose our real email address to true friends
 
                if (($contact['rel'] == Contact::FRIEND) && !$contact['blocked']) {
                        if ($reply_to) {
-                               $headers  = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8') . ' <' . $reply_to . '>' . "\n";
+                               $headers = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8') . ' <' . $reply_to . '>' . "\n";
                                $headers .= 'Sender: ' . $local_user['email'] . "\n";
                        } else {
-                               $headers  = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8') . ' <' . $local_user['email'] . '>' . "\n";
+                               $headers = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8') . ' <' . $local_user['email'] . '>' . "\n";
                        }
                } else {
-                       $sender = DI::config()->get('config', 'sender_email', 'noreply@' . DI::baseUrl()->getHostname());
-                       $headers  = 'From: '. Email::encodeHeader($local_user['username'], 'UTF-8') . ' <' . $sender . '>' . "\n";
+                       $sender  = DI::config()->get('config', 'sender_email', 'noreply@' . DI::baseUrl()->getHost());
+                       $headers = 'From: '. Email::encodeHeader($local_user['username'], 'UTF-8') . ' <' . $sender . '>' . "\n";
                }
 
                $headers .= 'Message-Id: <' . Email::iri2msgid($target_item['uri']) . '>' . "\n";
@@ -562,13 +574,13 @@ class Delivery
 
                        if (empty($target_item['title'])) {
                                $condition = ['uri' => $target_item['parent-uri'], 'uid' => $owner['uid']];
-                               $title = Post::selectFirst(['title'], $condition);
+                               $title     = Post::selectFirst(['title'], $condition);
 
                                if (DBA::isResult($title) && ($title['title'] != '')) {
                                        $subject = $title['title'];
                                } else {
                                        $condition = ['parent-uri' => $target_item['parent-uri'], 'uid' => $owner['uid']];
-                                       $title = Post::selectFirst(['title'], $condition);
+                                       $title     = Post::selectFirst(['title'], $condition);
 
                                        if (DBA::isResult($title) && ($title['title'] != '')) {
                                                $subject = $title['title'];
@@ -592,5 +604,6 @@ class Delivery
                        // Failed
                        Logger::warning('Delivery of mail has FAILED', ['to' => $addr, 'subject' => $subject, 'guid' => $target_item['guid']]);
                }
+               return $success;
        }
 }