src/Worker/APDelivery.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Worker;
  23
  24 use Friendica\Core\Logger;
  25 use Friendica\Core\Worker;
  26 use Friendica\Model\Contact;
  27 use Friendica\Model\GServer;
  28 use Friendica\Model\Item;
  29 use Friendica\Model\Post;
  30 use Friendica\Protocol\ActivityPub;
  31 use Friendica\Util\HTTPSignature;
  32
  33 class APDelivery
  34 {
  35         /**
  36          * Delivers ActivityPub messages
  37          *
  38          * @param string  $cmd       One of the Worker\Delivery constant values
  39          * @param integer $item_id   0 if no item is involved (like Delivery::REMOVAL and Delivery::PROFILEUPDATE)
  40          * @param string  $inbox     The URL of the recipient profile
  41          * @param integer $uid       The ID of the user who triggered this delivery
  42          * @param array   $receivers The contact IDs related to the inbox URL for contact archival housekeeping
  43          * @param int     $uri_id    URI-ID of item to be transmitted
  44          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  45          * @throws \ImagickException
  46          */
  47         public static function execute(string $cmd, int $item_id, string $inbox, int $uid, array $receivers = [], int $uri_id = 0)
  48         {
  49                 if (ActivityPub\Transmitter::archivedInbox($inbox)) {
  50                         Logger::info('Inbox is archived', ['cmd' => $cmd, 'inbox' => $inbox, 'id' => $item_id, 'uri-id' => $uri_id, 'uid' => $uid]);
  51                         if (empty($uri_id) && !empty($item_id)) {
  52                                 $item = Post::selectFirst(['uri-id'], ['id' => $item_id]);
  53                                 $uri_id = $item['uri-id'] ?? 0;
  54                         }
  55                         if (empty($uri_id)) {
  56                                 $posts   = Post\Delivery::selectForInbox($inbox);
  57                                 $uri_ids = array_column($posts, 'uri-id');
  58                         } else {
  59                                 $uri_ids = [$uri_id];
  60                         }
  61
  62                         foreach ($uri_ids as $uri_id) {
  63                                 Post\Delivery::remove($uri_id, $inbox);
  64                                 Post\DeliveryData::incrementQueueFailed($uri_id);
  65                         }
  66                         return;
  67                 }
  68
  69                 Logger::info('Invoked', ['cmd' => $cmd, 'inbox' => $inbox, 'id' => $item_id, 'uri-id' => $uri_id, 'uid' => $uid]);
  70
  71                 if (empty($uri_id)) {
  72                         $result = self::deliver($inbox);
  73                         $success = $result['success'];
  74                         $uri_ids = $result['uri_ids'];
  75                 } else {
  76                         $success = self::deliverToInbox($cmd, $item_id, $inbox, $uid, $receivers, $uri_id);
  77                         $uri_ids = [$uri_id];
  78                 }
  79
  80                 if (!$success && !Worker::defer() && !empty($uri_ids)) {
  81                         foreach ($uri_ids as $uri_id) {
  82                                 Post\Delivery::remove($uri_id, $inbox);
  83                                 Post\DeliveryData::incrementQueueFailed($uri_id);
  84                         }
  85                 }
  86         }
  87
  88         private static function deliver(string $inbox)
  89         {
  90                 Post\Delivery::removeFailed($inbox);
  91
  92                 $uri_ids = [];
  93                 $posts   = Post\Delivery::selectForInbox($inbox);
  94
  95                 foreach ($posts as $post) {
  96                         if (!self::deliverToInbox($post['command'], 0, $inbox, $post['uid'], [], $post['uri-id'])) {
  97                                 $uri_ids[] = $post['uri-id'];
  98                         }
  99                 }
 100
 101                 Logger::debug('Inbox delivery done', ['inbox' => $inbox, 'posts' => count($posts), 'failed' => count($uri_ids)]);
 102                 return ['success' => empty($uri_ids), 'uri_ids' => $uri_ids];
 103         }
 104
 105         private static function deliverToInbox(string $cmd, int $item_id, string $inbox, int $uid, array $receivers, int $uri_id)
 106         {
 107                 if (empty($item_id) && !empty($uri_id) && !empty($uid)) {
 108                         $item = Post::selectFirst(['id', 'parent', 'origin'], ['uri-id' => $uri_id, 'uid' => [$uid, 0]], ['order' => ['uid' => true]]);
 109                         $item_id = $item['id'] ?? 0;
 110                         if (empty($receivers) && !empty($item)) {
 111                                 $parent = Post::selectFirst(Item::DELIVER_FIELDLIST, ['id' => $item['parent']]);
 112
 113                                 $inboxes = ActivityPub\Transmitter::fetchTargetInboxes($parent, $uid);
 114                                 $receivers = $inboxes[$inbox] ?? [];
 115
 116                                 // When we haven't fetched the receiver list, it can be a personal inbox
 117                                 if (empty($receivers)) {
 118                                         $inboxes = ActivityPub\Transmitter::fetchTargetInboxes($parent, $uid, true);
 119                                         $receivers = $inboxes[$inbox] ?? [];
 120                                 }
 121                         } elseif (empty($item_id)) {
 122                                 Logger::debug('Item not found, removing delivery', ['uri-id' => $uri_id, 'uid' => $uid, 'cmd' => $cmd, 'inbox' => $inbox]);
 123                                 Post\Delivery::remove($uri_id, $inbox);
 124                                 return true;
 125                         }
 126                 }
 127
 128                 $success = true;
 129
 130                 if ($cmd == Delivery::MAIL) {
 131                         $data = ActivityPub\Transmitter::createActivityFromMail($item_id);
 132                         if (!empty($data)) {
 133                                 $success = HTTPSignature::transmit($data, $inbox, $uid);
 134                         }
 135                 } elseif ($cmd == Delivery::SUGGESTION) {
 136                         $success = ActivityPub\Transmitter::sendContactSuggestion($uid, $inbox, $item_id);
 137                 } elseif ($cmd == Delivery::RELOCATION) {
 138                         // @todo Implementation pending
 139                 } elseif ($cmd == Delivery::POKE) {
 140                         // Implementation not planned
 141                 } elseif ($cmd == Delivery::REMOVAL) {
 142                         $success = ActivityPub\Transmitter::sendProfileDeletion($uid, $inbox);
 143                 } elseif ($cmd == Delivery::PROFILEUPDATE) {
 144                         $success = ActivityPub\Transmitter::sendProfileUpdate($uid, $inbox);
 145                 } else {
 146                         $data = ActivityPub\Transmitter::createCachedActivityFromItem($item_id);
 147                         if (!empty($data)) {
 148                                 $success = HTTPSignature::transmit($data, $inbox, $uid);
 149                                 if ($uri_id) {
 150                                         if ($success) {
 151                                                 Post\Delivery::remove($uri_id, $inbox);
 152                                         } else {
 153                                                 Post\Delivery::incrementFailed($uri_id, $inbox);
 154                                         }
 155                                 }
 156                         }
 157                 }
 158
 159                 self::setSuccess($receivers, $success);
 160
 161                 Logger::info('Delivered', ['uri-id' => $uri_id, 'uid' => $uid, 'item_id' => $item_id, 'cmd' => $cmd, 'inbox' => $inbox, 'success' => $success]);
 162
 163                 if ($success && in_array($cmd, [Delivery::POST])) {
 164                         Post\DeliveryData::incrementQueueDone($uri_id, Post\DeliveryData::ACTIVITYPUB);
 165                 }
 166
 167                 return $success;
 168         }
 169
 170         private static function setSuccess(array $receivers, bool $success)
 171         {
 172                 $gsid = null;
 173
 174                 foreach ($receivers as $receiver) {
 175                         $contact = Contact::getById($receiver);
 176                         if (empty($contact)) {
 177                                 continue;
 178                         }
 179
 180                         $gsid = $gsid ?: $contact['gsid'];
 181
 182                         if ($success) {
 183                                 Contact::unmarkForArchival($contact);
 184                         } else {
 185                                 Contact::markForArchival($contact);
 186                         }
 187                 }
 188
 189                 if (!empty($gsid)) {
 190                         GServer::setProtocol($gsid, Post\DeliveryData::ACTIVITYPUB);
 191                 }
 192         }
 193 }