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 (in_array($cmd, [Delivery::POST])) {
  52                                 if (empty($uri_id) && !empty($item_id)) {
  53                                         $item = Post::selectFirst(['uri-id'], ['id' => $item_id]);
  54                                         $uri_id = $item['uri-id'] ?? 0;
  55                                 }
  56                                 if (empty($uri_id)) {
  57                                         $posts   = Post\Delivery::selectForInbox($inbox);
  58                                         $uri_ids = array_column($posts, 'uri-id');
  59                                 } else {
  60                                         $uri_ids = [$uri_id];
  61                                 }
  62
  63                                 foreach ($uri_ids as $uri_id) {
  64                                         Post\Delivery::remove($uri_id, $inbox);
  65                                         Post\DeliveryData::incrementQueueFailed($uri_id);
  66                                 }
  67                         }
  68                         return;
  69                 }
  70
  71                 Logger::info('Invoked', ['cmd' => $cmd, 'inbox' => $inbox, 'id' => $item_id, 'uri-id' => $uri_id, 'uid' => $uid]);
  72
  73                 if (empty($uri_id)) {
  74                         $result = self::deliver($inbox);
  75                         $success = $result['success'];
  76                         $uri_ids = $result['uri_ids'];
  77                 } else {
  78                         $success = self::deliverToInbox($cmd, $item_id, $inbox, $uid, $receivers, $uri_id);
  79                         $uri_ids = [$uri_id];
  80                 }
  81
  82                 if (!$success && !Worker::defer() && in_array($cmd, [Delivery::POST])) {
  83                         foreach ($uri_ids as $uri_id) {
  84                                 Post\Delivery::remove($uri_id, $inbox);
  85                                 Post\DeliveryData::incrementQueueFailed($uri_id);
  86                         }
  87                 }
  88         }
  89
  90         private static function deliver(string $inbox)
  91         {
  92                 Post\Delivery::removeFailed($inbox);
  93
  94                 $uri_ids = [];
  95                 $posts   = Post\Delivery::selectForInbox($inbox);
  96
  97                 foreach ($posts as $post) {
  98                         if (!self::deliverToInbox($post['command'], 0, $inbox, $post['uid'], [], $post['uri-id'])) {
  99                                 $uri_ids[] = $post['uri-id'];
 100                         }
 101                 }
 102
 103                 Logger::debug('Inbox delivery done', ['inbox' => $inbox, 'posts' => count($posts), 'failed' => count($uri_ids)]);
 104                 return ['success' => empty($uri_ids), 'uri_ids' => $uri_ids];
 105         }
 106
 107         private static function deliverToInbox(string $cmd, int $item_id, string $inbox, int $uid, array $receivers, int $uri_id)
 108         {
 109                 if (empty($item_id) && !empty($uri_id) && !empty($uid)) {
 110                         $item = Post::selectFirst(['id', 'parent', 'origin'], ['uri-id' => $uri_id, 'uid' => [$uid, 0]], ['order' => ['uid' => true]]);
 111                         $item_id = $item['id'] ?? 0;
 112                         if (empty($receivers) && !empty($item)) {
 113                                 $parent = Post::selectFirst(Item::DELIVER_FIELDLIST, ['id' => $item['parent']]);
 114
 115                                 $inboxes = ActivityPub\Transmitter::fetchTargetInboxes($parent, $uid);
 116                                 $receivers = $inboxes[$inbox] ?? [];
 117
 118                                 // When we haven't fetched the receiver list, it can be a personal inbox
 119                                 if (empty($receivers)) {
 120                                         $inboxes = ActivityPub\Transmitter::fetchTargetInboxes($parent, $uid, true);
 121                                         $receivers = $inboxes[$inbox] ?? [];
 122                                 }
 123                         } elseif (empty($item_id)) {
 124                                 Logger::debug('Item not found, removing delivery', ['uri-id' => $uri_id, 'uid' => $uid, 'cmd' => $cmd, 'inbox' => $inbox]);
 125                                 Post\Delivery::remove($uri_id, $inbox);
 126                                 return true;
 127                         }
 128                 }
 129
 130                 $success = true;
 131
 132                 if ($cmd == Delivery::MAIL) {
 133                         $data = ActivityPub\Transmitter::createActivityFromMail($item_id);
 134                         if (!empty($data)) {
 135                                 $success = HTTPSignature::transmit($data, $inbox, $uid);
 136                         }
 137                 } elseif ($cmd == Delivery::SUGGESTION) {
 138                         $success = ActivityPub\Transmitter::sendContactSuggestion($uid, $inbox, $item_id);
 139                 } elseif ($cmd == Delivery::RELOCATION) {
 140                         // @todo Implementation pending
 141                 } elseif ($cmd == Delivery::POKE) {
 142                         // Implementation not planned
 143                 } elseif ($cmd == Delivery::REMOVAL) {
 144                         $success = ActivityPub\Transmitter::sendProfileDeletion($uid, $inbox);
 145                 } elseif ($cmd == Delivery::PROFILEUPDATE) {
 146                         $success = ActivityPub\Transmitter::sendProfileUpdate($uid, $inbox);
 147                 } else {
 148                         $data = ActivityPub\Transmitter::createCachedActivityFromItem($item_id);
 149                         if (!empty($data)) {
 150                                 $success = HTTPSignature::transmit($data, $inbox, $uid);
 151                                 if ($uri_id) {
 152                                         if ($success) {
 153                                                 Post\Delivery::remove($uri_id, $inbox);
 154                                         } else {
 155                                                 Post\Delivery::incrementFailed($uri_id, $inbox);
 156                                         }
 157                                 }
 158                         }
 159                 }
 160
 161                 self::setSuccess($receivers, $success);
 162
 163                 Logger::info('Delivered', ['uri-id' => $uri_id, 'uid' => $uid, 'item_id' => $item_id, 'cmd' => $cmd, 'inbox' => $inbox, 'success' => $success]);
 164
 165                 if ($success && in_array($cmd, [Delivery::POST])) {
 166                         Post\DeliveryData::incrementQueueDone($uri_id, Post\DeliveryData::ACTIVITYPUB);
 167                 }
 168
 169                 return $success;
 170         }
 171
 172         private static function setSuccess(array $receivers, bool $success)
 173         {
 174                 $gsid = null;
 175
 176                 foreach ($receivers as $receiver) {
 177                         $contact = Contact::getById($receiver);
 178                         if (empty($contact)) {
 179                                 continue;
 180                         }
 181
 182                         $gsid = $gsid ?: $contact['gsid'];
 183
 184                         if ($success) {
 185                                 Contact::unmarkForArchival($contact);
 186                         } else {
 187                                 Contact::markForArchival($contact);
 188                         }
 189                 }
 190
 191                 if (!empty($gsid)) {
 192                         GServer::setProtocol($gsid, Post\DeliveryData::ACTIVITYPUB);
 193                 }
 194         }
 195 }