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\DI;
  28 use Friendica\Util\DateTimeFormat;
  29 use Friendica\Util\JsonLD;
  30
  31 /**
  32  * This class handles the processing of incoming posts
  33  */
  34 class Queue
  35 {
  36         /**
  37          * Add activity to the queue
  38          *
  39          * @param array $activity
  40          * @param string $type
  41          * @param integer $uid
  42          * @param string $http_signer
  43          * @param boolean $push
  44          * @return array
  45          */
  46         public static function add(array $activity, string $type, int $uid, string $http_signer, bool $push, bool $trust_source): array
  47         {
  48                 $fields = [
  49                         'activity-id' => $activity['id'],
  50                         'object-id'   => $activity['object_id'],
  51                         'type'        => $type,
  52                         'object-type' => $activity['object_type'],
  53                         'activity'    => json_encode($activity, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT),
  54                         'received'    => DateTimeFormat::utcNow(),
  55                         'push'        => $push,
  56                         'trust'       => $trust_source,
  57                 ];
  58
  59                 if (!empty($activity['reply-to-id'])) {
  60                         $fields['in-reply-to-id'] = $activity['reply-to-id'];
  61                 }
  62
  63                 if (!empty($activity['context'])) {
  64                         $fields['conversation'] = $activity['context'];
  65                 } elseif (!empty($activity['conversation'])) {
  66                         $fields['conversation'] = $activity['conversation'];
  67                 }
  68
  69                 if (!empty($activity['object_object_type'])) {
  70                         $fields['object-object-type'] = $activity['object_object_type'];
  71                 }
  72
  73                 if (!empty($http_signer)) {
  74                         $fields['signer'] = $http_signer;
  75                 }
  76
  77                 DBA::insert('inbox-entry', $fields, Database::INSERT_IGNORE);
  78
  79                 $queue = DBA::selectFirst('inbox-entry', ['id'], ['activity-id' => $activity['id']]);
  80                 if (!empty($queue['id'])) {
  81                         $activity['entry-id'] = $queue['id'];
  82                         DBA::insert('inbox-entry-receiver', ['queue-id' => $queue['id'], 'uid' => $uid], Database::INSERT_IGNORE);
  83                 }
  84                 return $activity;
  85         }
  86
  87         /**
  88          * Remove activity from the queue
  89          *
  90          * @param array $activity
  91          * @return void
  92          */
  93         public static function remove(array $activity = [])
  94         {
  95                 if (empty($activity['entry-id'])) {
  96                         return;
  97                 }
  98                 DBA::delete('inbox-entry', ['id' => $activity['entry-id']]);
  99         }
 100
 101         /**
 102          * Delete all entries that depend on the given worker id
 103          *
 104          * @param integer $wid
 105          * @return void
 106          */
 107         public static function deleteByWorkerId(int $wid)
 108         {
 109                 $entries = DBA::select('inbox-entry', ['id'], ['wid' => $wid]);
 110                 while ($entry = DBA::fetch($entries)) {
 111                         self::deleteById($entry['id']);
 112                 }
 113                 DBA::close($entries);
 114         }
 115
 116         /**
 117          * Delete recursively an entry and all their children
 118          *
 119          * @param integer $id
 120          * @return void
 121          */
 122         public static function deleteById(int $id)
 123         {
 124                 $entry = DBA::selectFirst('inbox-entry', ['id', 'object-id'], ['id' => $id]);
 125                 if (empty($entry)) {
 126                         return;
 127                 }
 128
 129                 $children = DBA::select('inbox-entry', ['id'], ['in-reply-to-id' => $entry['object-id']]);
 130                 while ($child = DBA::fetch($children)) {
 131                         self::deleteById($child['id']);
 132                 }
 133                 DBA::close($children);
 134                 DBA::delete('inbox-entry', ['id' => $entry['id']]);
 135         }
 136
 137         /**
 138          * Set the worker id for the queue entry
 139          *
 140          * @param array $activity
 141          * @param int   $wid
 142          * @return void
 143          */
 144         public static function setWorkerId(array $activity, int $wid)
 145         {
 146                 if (empty($activity['entry-id']) || empty($wid)) {
 147                         return;
 148                 }
 149                 DBA::update('inbox-entry', ['wid' => $wid], ['id' => $activity['entry-id']]);
 150         }
 151
 152         /**
 153          * Check if there is an assigned worker task
 154          *
 155          * @param array $activity
 156          * @return bool
 157          */
 158         public static function hasWorker(array $activity = []): bool
 159         {
 160                 if (empty($activity['worker-id'])) {
 161                         return false;
 162                 }
 163                 return DBA::exists('workerqueue', ['id' => $activity['worker-id'], 'done' => false]);
 164         }
 165
 166         /**
 167          * Process the activity with the given id
 168          *
 169          * @param integer $id
 170          *
 171          * @return bool
 172          */
 173         public static function process(int $id): bool
 174         {
 175                 $entry = DBA::selectFirst('inbox-entry', [], ['id' => $id]);
 176                 if (empty($entry)) {
 177                         return false;
 178                 }
 179
 180                 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']]);
 181
 182                 $activity = json_decode($entry['activity'], true);
 183                 $type     = $entry['type'];
 184                 $push     = $entry['push'];
 185
 186                 $activity['entry-id']        = $entry['id'];
 187                 $activity['worker-id']       = $entry['wid'];
 188                 $activity['recursion-depth'] = 0;
 189
 190                 $receivers = DBA::select('inbox-entry-receiver', ['uid'], ['queue-id' => $entry['id']]);
 191                 while ($receiver = DBA::fetch($receivers)) {
 192                         if (!in_array($receiver['uid'], $activity['receiver'])) {
 193                                 $activity['receiver'][] = $receiver['uid'];
 194                         }
 195                 }
 196                 DBA::close($receivers);
 197
 198                 if (!Receiver::routeActivities($activity, $type, $push)) {
 199                         self::remove($activity);
 200                 }
 201
 202                 return true;
 203         }
 204
 205         /**
 206          * Process all activities
 207          *
 208          * @return void
 209          */
 210         public static function processAll()
 211         {
 212                 $entries = DBA::select('inbox-entry', ['id', 'type', 'object-type', 'object-id', 'in-reply-to-id'], ["`trust` AND `wid` IS NULL"], ['order' => ['id' => true]]);
 213                 while ($entry = DBA::fetch($entries)) {
 214                         // We don't need to process entries that depend on already existing entries.
 215                         if (!empty($entry['in-reply-to-id']) && DBA::exists('inbox-entry', ["`id` != ? AND `object-id` = ?", $entry['id'], $entry['in-reply-to-id']])) {
 216                                 continue;
 217                         }
 218                         Logger::debug('Process leftover entry', $entry);
 219                         self::process($entry['id']);
 220                 }
 221                 DBA::close($entries);
 222         }
 223
 224         /**
 225          * Clear old activities
 226          *
 227          * @return void
 228          */
 229         public static function clear()
 230         {
 231                 // We delete all entries that aren't associated with a worker entry after seven days.
 232                 // The other entries are deleted when the worker deferred for too long.
 233                 DBA::delete('inbox-entry', ["`wid` IS NULL AND `received` < ?", DateTimeFormat::utc('now - 7 days')]);
 234
 235                 // Optimizing this table only last seconds
 236                 if (DI::config()->get('system', 'optimize_tables')) {
 237                         Logger::info('Optimize start');
 238                         DBA::e("OPTIMIZE TABLE `inbox-entry`");
 239                         Logger::info('Optimize end');
 240                 }
 241         }
 242
 243         /**
 244          * Process all activities that are children of a given post url
 245          *
 246          * @param string $uri
 247          * @return int
 248          */
 249         public static function processReplyByUri(string $uri): int
 250         {
 251                 $count = 0;
 252                 $entries = DBA::select('inbox-entry', ['id'], ["`in-reply-to-id` = ? AND `object-id` != ?", $uri, $uri]);
 253                 while ($entry = DBA::fetch($entries)) {
 254                         $count += 1;
 255                         self::process($entry['id']);
 256                 }
 257                 DBA::close($entries);
 258                 return $count;
 259         }
 260
 261         /**
 262          * Checks if there are children of the given uri
 263          *
 264          * @param string $uri
 265          *
 266          * @return bool
 267          */
 268         public static function hasChildren(string $uri): bool
 269         {
 270                 return DBA::exists('inbox-entry', ["`in-reply-to-id` = ? AND `object-id` != ?", $uri, $uri]);
 271         }
 272
 273         /**
 274          * Prepare the queue entry.
 275          * This is a test function that is used solely for development.
 276          *
 277          * @param integer $id
 278          * @return array
 279          */
 280         public static function reprepareActivityById(int $id): array
 281         {
 282                 $entry = DBA::selectFirst('inbox-entry', [], ['id' => $id]);
 283                 if (empty($entry)) {
 284                         return [];
 285                 }
 286
 287                 $receiver = DBA::selectFirst('inbox-entry-receiver', ['uid'], ['queue-id' => $id]);
 288                 if (!empty($receiver)) {
 289                         $uid = $receiver['uid'];
 290                 } else {
 291                         $uid = 0;
 292                 }
 293
 294                 $trust_source = $entry['trust'];
 295
 296                 $data     = json_decode($entry['activity'], true);
 297                 $activity = json_decode($data['raw'], true);
 298
 299                 $ldactivity = JsonLD::compact($activity);
 300                 return [
 301                         'data'  => Receiver::prepareObjectData($ldactivity, $uid, $entry['push'], $trust_source),
 302                         'trust' => $trust_source
 303                 ];
 304         }
 305
 306         /**
 307          * Set the trust for all untrusted entries.
 308          * This is a test function that is used solely for development.
 309          *
 310          * @return void
 311          */
 312         public static function reprepareAll()
 313         {
 314                 $entries = DBA::select('inbox-entry', ['id'], ["NOT `trust` AND `wid` IS NULL"], ['order' => ['id' => true]]);
 315                 while ($entry = DBA::fetch($entries)) {
 316                         $data = self::reprepareActivityById($entry['id'], false);
 317                         if ($data['trust']) {
 318                                 DBA::update('inbox-entry', ['trust' => true], ['id' => $entry['id']]);
 319                         }
 320                 }
 321                 DBA::close($entries);
 322
 323         }
 324 }