src/Protocol/ActivityPub/FetchQueue.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 /**
  25  * This class prevents maximum function nesting errors by flattening recursive calls to Processor::fetchMissingActivity
  26  */
  27 class FetchQueue
  28 {
  29         /** @var FetchQueueItem[] */
  30         protected $queue = [];
  31
  32         public function push(FetchQueueItem $item)
  33         {
  34                 array_push($this->queue, $item);
  35         }
  36
  37         /**
  38          * Processes missing activities one by one. It is possible that a processing call will add additional missing
  39          * activities, they will be processed in subsequent iterations of the loop.
  40          *
  41          * Since this process is self-contained, it isn't suitable to retrieve the URI of a single activity.
  42          *
  43          * The simplest way to get the URI of the first activity and ensures all the parents are fetched is this way:
  44          *
  45          * $fetchQueue = new ActivityPub\FetchQueue();
  46          * $fetchedUri = ActivityPub\Processor::fetchMissingActivity($fetchQueue, $activityUri);
  47          * $fetchQueue->process();
  48          */
  49         public function process()
  50         {
  51                 while (count($this->queue)) {
  52                         $fetchQueueItem = array_pop($this->queue);
  53
  54                         call_user_func_array([Processor::class, 'fetchMissingActivity'], array_merge([$this], $fetchQueueItem->toParameters()));
  55                 }
  56         }
  57 }