src/Protocol/ActivityPub/Queue.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\Protocol\ActivityPub;
  23
  24 use Friendica\Core\Logger;
  25 use Friendica\Database\Database;
  26 use Friendica\Database\DBA;
  27 use Friendica\Util\DateTimeFormat;
  28
  29 /**
  30  * This class handles the processing of incoming posts
  31  */
  32 class Queue
  33 {
  34         /**
  35          * Add activity to the queue
  36          *
  37          * @param array $activity
  38          * @param string $type
  39          * @param integer $uid
  40          * @param string $http_signer
  41          * @param boolean $push
  42          * @return array
  43          */
  44         public static function add(array $activity, string $type, int $uid, string $http_signer, bool $push): array
  45         {
  46                 $fields = [
  47                         'activity-id' => $activity['id'],
  48                         'object-id'   => $activity['object_id'],
  49                         'type'        => $type,
  50                         'object-type' => $activity['object_type'],
  51                         'activity'    => json_encode($activity, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT),
  52                         'received'    => DateTimeFormat::utcNow(),
  53                         'push'        => $push,
  54                 ];
  55
  56                 if (!empty($activity['reply-to-id'])) {
  57                         $fields['in-reply-to-id'] = $activity['reply-to-id'];
  58                 }
  59
  60                 if (!empty($activity['context'])) {
  61                         $fields['conversation'] = $activity['context'];
  62                 } elseif (!empty($activity['conversation'])) {
  63                         $fields['conversation'] = $activity['conversation'];
  64                 }
  65
  66                 if (!empty($activity['object_object_type'])) {
  67                         $fields['object-object-type'] = $activity['object_object_type'];
  68                 }
  69
  70                 if (!empty($http_signer)) {
  71                         $fields['signer'] = $http_signer;
  72                 }
  73
  74                 DBA::insert('inbox-entry', $fields, Database::INSERT_IGNORE);
  75
  76                 $queue = DBA::selectFirst('inbox-entry', ['id'], ['activity-id' => $activity['id']]);
  77                 if (!empty($queue['id'])) {
  78                         $activity['entry-id'] = $queue['id'];
  79                         DBA::insert('inbox-entry-receiver', ['queue-id' => $queue['id'], 'uid' => $uid], Database::INSERT_IGNORE);
  80                 }
  81                 return $activity;
  82         }
  83
  84         /**
  85          * Remove activity from the queue
  86          *
  87          * @param array $activity
  88          * @return void
  89          */
  90         public static function remove(array $activity = [])
  91         {
  92                 if (empty($activity['entry-id'])) {
  93                         return;
  94                 }
  95                 DBA::delete('inbox-entry', ['id' => $activity['entry-id']]);
  96         }
  97
  98         /**
  99          * Delete all entries that depend on the given worker id
 100          *
 101          * @param integer $wid
 102          * @return void
 103          */
 104         public static function deleteByWorkerId(int $wid)
 105         {
 106                 $entries = DBA::select('inbox-entry', ['id'], ['wid' => $wid]);
 107                 while ($entry = DBA::fetch($entries)) {
 108                         self::deleteById($entry['id']);
 109                 }
 110                 DBA::close($entries);
 111         }
 112
 113         /**
 114          * Delete recursively an entry and all their children
 115          *
 116          * @param integer $id
 117          * @return void
 118          */
 119         public static function deleteById(int $id)
 120         {
 121                 $entry = DBA::selectFirst('inbox-entry', ['id', 'object-id'], ['id' => $id]);
 122                 if (empty($entry)) {
 123                         return;
 124                 }
 125
 126                 $children = DBA::select('inbox-entry', ['id'], ['in-reply-to-id' => $entry['object-id']]);
 127                 while ($child = DBA::fetch($children)) {
 128                         self::deleteById($child['id']);
 129                 }
 130                 DBA::close($children);
 131                 DBA::delete('inbox-entry', ['id' => $entry['id']]);
 132         }
 133
 134         /**
 135          * Set the worker id for the queue entry
 136          *
 137          * @param array $activity
 138          * @param int   $wid
 139          * @return void
 140          */
 141         public static function setWorkerId(array $activity, int $wid)
 142         {
 143                 if (empty($activity['entry-id']) || empty($wid)) {
 144                         return;
 145                 }
 146                 DBA::update('inbox-entry', ['wid' => $wid], ['id' => $activity['entry-id']]);
 147         }
 148
 149         /**
 150          * Check if there is an assigned worker task
 151          *
 152          * @param array $activity
 153          * @return bool
 154          */
 155         public static function hasWorker(array $activity = []): bool
 156         {
 157                 if (empty($activity['worker-id'])) {
 158                         return false;
 159                 }
 160                 return DBA::exists('workerqueue', ['id' => $activity['worker-id'], 'done' => false]);
 161         }
 162
 163         /**
 164          * Process the activity with the given id
 165          *
 166          * @param integer $id
 167          * @return void
 168          */
 169         public static function process(int $id)
 170         {
 171                 $entry = DBA::selectFirst('inbox-entry', [], ['id' => $id]);
 172                 if (empty($entry)) {
 173                         return;
 174                 }
 175
 176                 Logger::debug('Processing queue entry', ['id' => $entry['id'], 'type' => $entry['type'], 'object-type' => $entry['object-type'], 'uri' => $entry['object-id'], 'in-reply-to' => $entry['in-reply-to-id']]);
 177
 178                 $activity = json_decode($entry['activity'], true);
 179                 $type     = $entry['type'];
 180                 $push     = $entry['push'];
 181
 182                 $activity['entry-id']        = $entry['id'];
 183                 $activity['worker-id']       = $entry['wid'];
 184                 $activity['recursion-depth'] = 0;
 185
 186                 $receivers = DBA::select('inbox-entry-receiver', ['uid'], ['queue-id' => $entry['id']]);
 187                 while ($receiver = DBA::fetch($receivers)) {
 188                         if (!in_array($receiver['uid'], $activity['receiver'])) {
 189                                 $activity['receiver'][] = $receiver['uid'];
 190                         }
 191                 }
 192                 DBA::close($receivers);
 193
 194                 if (!Receiver::routeActivities($activity, $type, $push)) {
 195                         self::remove($activity);
 196                 }
 197         }
 198
 199         /**
 200          * Process all activities
 201          *
 202          * @return void
 203          */
 204         public static function processAll()
 205         {
 206                 $entries = DBA::select('inbox-entry', ['id', 'type', 'object-type', 'object-id', 'in-reply-to-id'], ["`wid` IS NULL"], ['order' => ['id' => true]]);
 207                 while ($entry = DBA::fetch($entries)) {
 208                         // We don't need to process entries that depend on already existing entries.
 209                         if (!empty($entry['in-reply-to-id']) && DBA::exists('inbox-entry', ["`id` != ? AND `object-id` = ?", $entry['id'], $entry['in-reply-to-id']])) {
 210                                 continue;
 211                         }
 212                         Logger::debug('Process leftover entry', $entry);
 213                         self::process($entry['id']);
 214                 }
 215         }
 216
 217         /**
 218          * Clear old activities
 219          *
 220          * @return void
 221          */
 222         public static function clear()
 223         {
 224                 // We delete all entries that aren't associated with a worker entry after seven days.
 225                 // The other entries are deleted when the worker deferred for too long.
 226                 DBA::delete('inbox-entry', ["`wid` IS NULL AND `received` < ?", DateTimeFormat::utc('now - 7 days')]);
 227         }
 228
 229         /**
 230          * Process all activities that are children of a given post url
 231          *
 232          * @param string $uri
 233          * @return void
 234          */
 235         public static function processReplyByUri(string $uri)
 236         {
 237                 $entries = DBA::select('inbox-entry', ['id'], ["`in-reply-to-id` = ? AND `object-id` != ?", $uri, $uri]);
 238                 while ($entry = DBA::fetch($entries)) {
 239                         self::process($entry['id']);
 240                 }
 241         }
 242 }