<?php
/**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
namespace Friendica\Protocol\ActivityPub;
use Friendica\Core\Logger;
+use Friendica\Core\System;
use Friendica\Database\Database;
use Friendica\Database\DBA;
+use Friendica\DI;
+use Friendica\Model\ItemURI;
+use Friendica\Model\Post;
use Friendica\Util\DateTimeFormat;
+use Friendica\Util\JsonLD;
/**
* This class handles the processing of incoming posts
*/
class Queue
{
- public static function add(array $activity, string $type, int $uid, string $http_signer, bool $push): array
+ /**
+ * Add activity to the queue
+ *
+ * @param array $activity
+ * @param string $type
+ * @param integer $uid
+ * @param string $http_signer
+ * @param boolean $push
+ * @return array
+ */
+ public static function add(array $activity, string $type, int $uid, string $http_signer, bool $push, bool $trust_source): array
{
$fields = [
- 'activity-id' => $activity['id'],
+ 'activity-id' => $activity['id'],
'object-id' => $activity['object_id'],
'type' => $type,
'object-type' => $activity['object_type'],
'activity' => json_encode($activity, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT),
'received' => DateTimeFormat::utcNow(),
'push' => $push,
+ 'trust' => $trust_source,
];
if (!empty($activity['reply-to-id'])) {
$fields['in-reply-to-id'] = $activity['reply-to-id'];
}
+ if (!empty($activity['context'])) {
+ $fields['conversation'] = $activity['context'];
+ } elseif (!empty($activity['conversation'])) {
+ $fields['conversation'] = $activity['conversation'];
+ }
+
if (!empty($activity['object_object_type'])) {
$fields['object-object-type'] = $activity['object_object_type'];
}
return $activity;
}
+ /**
+ * Checks if an entry for a given url and type already exists
+ *
+ * @param string $url
+ * @param string $type
+ * @return boolean
+ */
+ public static function exists(string $url, string $type): bool
+ {
+ return DBA::exists('inbox-entry', ['type' => $type, 'object-id' => $url]);
+ }
+
+ /**
+ * Remove activity from the queue
+ *
+ * @param array $activity
+ * @return void
+ */
public static function remove(array $activity = [])
{
if (empty($activity['entry-id'])) {
return;
}
DBA::delete('inbox-entry', ['id' => $activity['entry-id']]);
- //echo "Delete ".$activity['entry-id']."\n";
+ }
+ /**
+ * Delete all entries that depend on the given worker id
+ *
+ * @param integer $wid
+ * @return void
+ */
+ public static function deleteByWorkerId(int $wid)
+ {
+ $entries = DBA::select('inbox-entry', ['id'], ['wid' => $wid]);
+ while ($entry = DBA::fetch($entries)) {
+ self::deleteById($entry['id']);
+ }
+ DBA::close($entries);
}
- public static function process(int $id)
+ /**
+ * Delete recursively an entry and all their children
+ *
+ * @param integer $id
+ * @return void
+ */
+ public static function deleteById(int $id)
{
- $entry = DBA::selectFirst('inbox-entry', [], ['id' => $id]);
+ $entry = DBA::selectFirst('inbox-entry', ['id', 'object-id'], ['id' => $id]);
if (empty($entry)) {
return;
}
-
- 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']]);
- $activity = json_decode($entry['activity'], true);
- $type = $entry['type'];
- $push = $entry['push'];
+ Logger::debug('Delete inbox-entry', ['id' => $entry['id']]);
+
+ DBA::delete('inbox-entry', ['id' => $entry['id']]);
+
+ $children = DBA::select('inbox-entry', ['id'], ['in-reply-to-id' => $entry['object-id']]);
+ while ($child = DBA::fetch($children)) {
+ self::deleteById($child['id']);
+ }
+ DBA::close($children);
+ }
+
+ /**
+ * Set the worker id for the queue entry
+ *
+ * @param int $entry_id
+ * @param int $wid
+ * @return void
+ */
+ public static function setWorkerId(int $entry_id, int $wid)
+ {
+ if (empty($entry_id) || empty($wid)) {
+ return;
+ }
+ DBA::update('inbox-entry', ['wid' => $wid], ['id' => $entry_id]);
+ }
+
+ /**
+ * Check if there is an assigned worker task
+ *
+ * @param int $wid
+ *
+ * @return bool
+ */
+ public static function hasWorker(int $wid): bool
+ {
+ if (empty($wid)) {
+ return false;
+ }
+ return DBA::exists('workerqueue', ['id' => $wid, 'done' => false]);
+ }
+
+ /**
+ * Process the activity with the given id
+ *
+ * @param integer $id
+ * @param bool $fetch_parents
+ *
+ * @return bool
+ */
+ public static function process(int $id, bool $fetch_parents = true): bool
+ {
+ $entry = DBA::selectFirst('inbox-entry', [], ['id' => $id]);
+ if (empty($entry)) {
+ return false;
+ }
+
+ if (!self::isProcessable($id)) {
+ Logger::debug('Other queue entries need to be processed first.', ['id' => $id]);
+ return false;
+ }
+
+ if (!empty($entry['wid'])) {
+ $worker = DI::app()->getQueue();
+ $wid = $worker['id'] ?? 0;
+ if ($entry['wid'] != $wid) {
+ $workerqueue = DBA::selectFirst('workerqueue', ['pid'], ['id' => $entry['wid'], 'done' => false]);
+ if (!empty($workerqueue['pid']) && posix_kill($workerqueue['pid'], 0)) {
+ Logger::notice('Entry is already processed via another process.', ['current' => $wid, 'processor' => $entry['wid']]);
+ return false;
+ }
+ }
+ }
+
+ 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'], 'callstack' => System::callstack(20)]);
+
+ $activity = json_decode($entry['activity'], true);
+ $type = $entry['type'];
+ $push = $entry['push'];
+
+ $activity['entry-id'] = $entry['id'];
+ $activity['worker-id'] = $entry['wid'];
+ $activity['recursion-depth'] = 0;
- $activity['entry-id'] = $entry['id'];
+ if (empty($activity['thread-children-type'])) {
+ $activity['thread-children-type'] = $type;
+ }
+
+ $receivers = DBA::select('inbox-entry-receiver', ['uid'], ["`queue-id` = ? AND `uid` != ?", $entry['id'], 0]);
+ while ($receiver = DBA::fetch($receivers)) {
+ if (!in_array($receiver['uid'], $activity['receiver'])) {
+ $activity['receiver'][] = $receiver['uid'];
+ }
+ }
+ DBA::close($receivers);
- if (!Receiver::routeActivities($activity, $type, $push)) {
+ if (!Receiver::routeActivities($activity, $type, $push, $fetch_parents, $activity['receiver'][0] ?? 0)) {
self::remove($activity);
}
+
+ return true;
}
+ /**
+ * Process all activities
+ *
+ * @return void
+ */
public static function processAll()
{
- $entries = DBA::select('inbox-entry', ['id', 'type', 'object-type'], [], ['order' => ['id' => true]]);
+ $entries = DBA::select('inbox-entry', ['id', 'type', 'object-type', 'object-id', 'in-reply-to-id'], ["`trust` AND `wid` IS NULL"], ['order' => ['id' => true]]);
while ($entry = DBA::fetch($entries)) {
- echo $entry['id'] . "\t" . $entry['type'] . "\t" . $entry['object-type'] . "\n";
- self::process($entry['id']);
+ // Don't process entries of items that are answer to non existing posts
+ if (!empty($entry['in-reply-to-id']) && !Post::exists(['uri' => $entry['in-reply-to-id']])) {
+ continue;
+ }
+ // We don't need to process entries that depend on already existing entries.
+ if (!empty($entry['in-reply-to-id']) && DBA::exists('inbox-entry', ["`id` != ? AND `object-id` = ?", $entry['id'], $entry['in-reply-to-id']])) {
+ continue;
+ }
+ Logger::debug('Process leftover entry', $entry);
+ self::process($entry['id'], false);
}
+ DBA::close($entries);
+ }
+
+ public static function isProcessable(int $id): bool
+ {
+ $entry = DBA::selectFirst('inbox-entry', [], ['id' => $id]);
+ if (empty($entry)) {
+ return false;
+ }
+
+ if (!empty($entry['object-id']) && Post::exists(['uri' => $entry['object-id']])) {
+ // The object already exists, so processing can be done
+ return true;
+ }
+
+ if (!empty($entry['conversation'])) {
+ $conv_id = ItemURI::getIdByURI($entry['conversation'], false);
+ if (DBA::exists('post-thread', ['conversation-id' => $conv_id])) {
+ // We have got the conversation in the system, so the post can be processed
+ return true;
+ }
+ }
+
+ if (!empty($entry['object-id']) && !empty($entry['in-reply-to-id']) && ($entry['object-id'] != $entry['in-reply-to-id']) && DBA::exists('inbox-entry', ['object-id' => $entry['in-reply-to-id']])) {
+ // This entry belongs to some other entry that should be processed first
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Clear old activities
+ *
+ * @return void
+ */
+ public static function clear()
+ {
+ // We delete all entries that aren't associated with a worker entry after seven days.
+ // The other entries are deleted when the worker deferred for too long.
+ $entries = DBA::select('inbox-entry', ['id'], ["`wid` IS NULL AND `received` < ?", DateTimeFormat::utc('now - 7 days')]);
+ while ($entry = DBA::fetch($entries)) {
+ self::deleteById($entry['id']);
+ }
+ DBA::close($entries);
+
+ // Optimizing this table only last seconds
+ if (DI::config()->get('system', 'optimize_tables')) {
+ Logger::info('Optimize start');
+ DBA::e("OPTIMIZE TABLE `inbox-entry`");
+ Logger::info('Optimize end');
+ }
+ }
+
+ /**
+ * Process all activities that are children of a given post url
+ *
+ * @param string $uri
+ * @return int
+ */
+ public static function processReplyByUri(string $uri): int
+ {
+ $count = 0;
+ $entries = DBA::select('inbox-entry', ['id'], ["`in-reply-to-id` = ? AND `object-id` != ?", $uri, $uri]);
+ while ($entry = DBA::fetch($entries)) {
+ $count += 1;
+ self::process($entry['id'], false);
+ }
+ DBA::close($entries);
+ return $count;
+ }
+
+ /**
+ * Checks if there are children of the given uri
+ *
+ * @param string $uri
+ *
+ * @return bool
+ */
+ public static function hasChildren(string $uri): bool
+ {
+ return DBA::exists('inbox-entry', ["`in-reply-to-id` = ? AND `object-id` != ?", $uri, $uri]);
+ }
+
+ /**
+ * Prepare the queue entry.
+ * This is a test function that is used solely for development.
+ *
+ * @param integer $id
+ * @return array
+ */
+ public static function reprepareActivityById(int $id): array
+ {
+ $entry = DBA::selectFirst('inbox-entry', [], ['id' => $id]);
+ if (empty($entry)) {
+ return [];
+ }
+
+ $receiver = DBA::selectFirst('inbox-entry-receiver', ['uid'], ['queue-id' => $id]);
+ if (!empty($receiver)) {
+ $uid = $receiver['uid'];
+ } else {
+ $uid = 0;
+ }
+
+ $trust_source = $entry['trust'];
+
+ $data = json_decode($entry['activity'], true);
+ $activity = json_decode($data['raw'], true);
+
+ $ldactivity = JsonLD::compact($activity);
+ return [
+ 'data' => Receiver::prepareObjectData($ldactivity, $uid, $entry['push'], $trust_source),
+ 'trust' => $trust_source
+ ];
}
- public static function processReplyByUri(string $uri)
+ /**
+ * Set the trust for all untrusted entries.
+ * This is a test function that is used solely for development.
+ *
+ * @return void
+ */
+ public static function reprepareAll()
{
- $entries = DBA::select('inbox-entry', ['id'], ['in-reply-to-id' => $uri], ['order' => ['id' => true]]);
+ $entries = DBA::select('inbox-entry', ['id'], ["NOT `trust` AND `wid` IS NULL"], ['order' => ['id' => true]]);
while ($entry = DBA::fetch($entries)) {
- self::process($entry['id']);
+ $data = self::reprepareActivityById($entry['id'], false);
+ if ($data['trust']) {
+ DBA::update('inbox-entry', ['trust' => true], ['id' => $entry['id']]);
+ }
}
+ DBA::close($entries);
}
}