]> git.mxchange.org Git - friendica.git/blob - src/Worker/APDelivery.php
Merge pull request #11497 from annando/bulk-delivery
[friendica.git] / 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\Post;
29 use Friendica\Protocol\ActivityPub;
30 use Friendica\Util\HTTPSignature;
31
32 class APDelivery
33 {
34         /**
35          * Delivers ActivityPub messages
36          *
37          * @param string  $cmd       One of the Worker\Delivery constant values
38          * @param integer $item_id   0 if no item is involved (like Delivery::REMOVAL and Delivery::PROFILEUPDATE)
39          * @param string  $inbox     The URL of the recipient profile
40          * @param integer $uid       The ID of the user who triggered this delivery
41          * @param array   $receivers The contact IDs related to the inbox URL for contact archival housekeeping
42          * @param int     $uri_id    URI-ID of item to be transmitted
43          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
44          * @throws \ImagickException
45          */
46         public static function execute(string $cmd, int $item_id, string $inbox, int $uid, array $receivers = [], int $uri_id = 0)
47         {
48                 if (ActivityPub\Transmitter::archivedInbox($inbox)) {
49                         Logger::info('Inbox is archived', ['cmd' => $cmd, 'inbox' => $inbox, 'id' => $item_id, 'uri-id' => $uri_id, 'uid' => $uid]);
50                         if (empty($uri_id) && !empty($item_id)) {
51                                 $item = Post::selectFirst(['uri-id'], ['id' => $item_id]);
52                                 $uri_id = $item['uri-id'] ?? 0;
53                         }
54                         if (empty($uri_id)) {
55                                 $posts   = Post\Delivery::selectForInbox($inbox);
56                                 $uri_ids = array_column($posts, 'uri-id');
57                         } else {
58                                 $uri_ids = [$uri_id];
59                         }
60
61                         foreach ($uri_ids as $uri_id) {
62                                 Post\Delivery::remove($uri_id, $inbox);
63                                 Post\DeliveryData::incrementQueueFailed($uri_id);
64                         }
65                         return;
66                 }
67
68                 Logger::info('Invoked', ['cmd' => $cmd, 'inbox' => $inbox, 'id' => $item_id, 'uri-id' => $uri_id, 'uid' => $uid]);
69
70                 if (empty($uri_id)) {
71                         $result = self::deliver($inbox);
72                         $success = $result['success'];
73                         $uri_ids = $result['uri_ids'];
74                 } else {
75                         $success = self::deliverToInbox($cmd, $item_id, $inbox, $uid, $receivers, $uri_id);
76                         $uri_ids = [$uri_id];
77                 }
78
79                 if (!$success && !Worker::defer() && !empty($uri_ids)) {
80                         foreach ($uri_ids as $uri_id) {
81                                 Post\Delivery::remove($uri_id, $inbox);
82                                 Post\DeliveryData::incrementQueueFailed($uri_id);
83                         }
84                 }
85         }
86
87         private static function deliver(string $inbox)
88         {
89                 $uri_ids = [];
90                 $posts   = Post\Delivery::selectForInbox($inbox);
91
92                 foreach ($posts as $post) {
93                         if (!self::deliverToInbox($post['command'], 0, $inbox, $post['uid'], $post['receivers'], $post['uri-id'])) {
94                                 $uri_ids[] = $post['uri-id'];
95                         }
96                 }
97
98                 Logger::debug('Inbox delivery done', ['inbox' => $inbox, 'posts' => count($posts), 'failed' => count($uri_ids)]);
99                 return ['success' => empty($uri_ids), 'uri_ids' => $uri_ids];
100         }
101
102         private static function deliverToInbox(string $cmd, int $item_id, string $inbox, int $uid, array $receivers, int $uri_id)
103         {
104                 if (empty($item_id) && !empty($uri_id) && !empty($uid)) {
105                         $item = Post::selectFirst(['id', 'parent', 'origin'], ['uri-id' => $uri_id, 'uid' => [$uid, 0]], ['order' => ['uid' => true]]);
106                         if (empty($item['id'])) {
107                                 Logger::debug('Item not found, removing delivery', ['uri-id' => $uri_id, 'uid' => $uid, 'cmd' => $cmd, 'inbox' => $inbox]);
108                                 Post\Delivery::remove($uri_id, $inbox);
109                                 return true;
110                         } else {
111                                 $item_id = $item['id'];
112                         }
113                 }
114
115                 $success = true;
116
117                 if ($cmd == Delivery::MAIL) {
118                         $data = ActivityPub\Transmitter::createActivityFromMail($item_id);
119                         if (!empty($data)) {
120                                 $success = HTTPSignature::transmit($data, $inbox, $uid);
121                         }
122                 } elseif ($cmd == Delivery::SUGGESTION) {
123                         $success = ActivityPub\Transmitter::sendContactSuggestion($uid, $inbox, $item_id);
124                 } elseif ($cmd == Delivery::RELOCATION) {
125                         // @todo Implementation pending
126                 } elseif ($cmd == Delivery::POKE) {
127                         // Implementation not planned
128                 } elseif ($cmd == Delivery::REMOVAL) {
129                         $success = ActivityPub\Transmitter::sendProfileDeletion($uid, $inbox);
130                 } elseif ($cmd == Delivery::PROFILEUPDATE) {
131                         $success = ActivityPub\Transmitter::sendProfileUpdate($uid, $inbox);
132                 } else {
133                         $data = ActivityPub\Transmitter::createCachedActivityFromItem($item_id);
134                         if (!empty($data)) {
135                                 $success = HTTPSignature::transmit($data, $inbox, $uid);
136                                 if ($uri_id) {
137                                         if ($success) {
138                                                 Post\Delivery::remove($uri_id, $inbox);
139                                         } else {
140                                                 Post\Delivery::incrementFailed($uri_id, $inbox);
141                                         }
142                                 }
143                         }
144                 }
145
146                 self::setSuccess($receivers, $success);
147
148                 Logger::info('Delivered', ['uri-id' => $uri_id, 'uid' => $uid, 'item_id' => $item_id, 'cmd' => $cmd, 'inbox' => $inbox, 'success' => $success]);
149
150                 if ($success && in_array($cmd, [Delivery::POST])) {
151                         Post\DeliveryData::incrementQueueDone($uri_id, Post\DeliveryData::ACTIVITYPUB);
152                 }
153
154                 return $success;
155         }
156
157         private static function setSuccess(array $receivers, bool $success)
158         {
159                 $gsid = null;
160
161                 foreach ($receivers as $receiver) {
162                         $contact = Contact::getById($receiver);
163                         if (empty($contact)) {
164                                 continue;
165                         }
166
167                         $gsid = $gsid ?: $contact['gsid'];
168
169                         if ($success) {
170                                 Contact::unmarkForArchival($contact);
171                         } else {
172                                 Contact::markForArchival($contact);
173                         }
174                 }
175
176                 if (!empty($gsid)) {
177                         GServer::setProtocol($gsid, Post\DeliveryData::ACTIVITYPUB);
178                 }
179         }
180 }