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