3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Protocol\ActivityPub;
24 use Friendica\Core\Logger;
25 use Friendica\Database\Database;
26 use Friendica\Database\DBA;
28 use Friendica\Util\DateTimeFormat;
29 use Friendica\Util\JsonLD;
32 * This class handles the processing of incoming posts
37 * Add activity to the queue
39 * @param array $activity
42 * @param string $http_signer
43 * @param boolean $push
46 public static function add(array $activity, string $type, int $uid, string $http_signer, bool $push, bool $trust_source): array
49 'activity-id' => $activity['id'],
50 'object-id' => $activity['object_id'],
52 'object-type' => $activity['object_type'],
53 'activity' => json_encode($activity, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT),
54 'received' => DateTimeFormat::utcNow(),
56 'trust' => $trust_source,
59 if (!empty($activity['reply-to-id'])) {
60 $fields['in-reply-to-id'] = $activity['reply-to-id'];
63 if (!empty($activity['context'])) {
64 $fields['conversation'] = $activity['context'];
65 } elseif (!empty($activity['conversation'])) {
66 $fields['conversation'] = $activity['conversation'];
69 if (!empty($activity['object_object_type'])) {
70 $fields['object-object-type'] = $activity['object_object_type'];
73 if (!empty($http_signer)) {
74 $fields['signer'] = $http_signer;
77 DBA::insert('inbox-entry', $fields, Database::INSERT_IGNORE);
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);
88 * Checks if an entry for a given url and type already exists
94 public static function exists(string $url, string $type): bool
96 return DBA::exists('inbox-entry', ['type' => $type, 'object-id' => $url]);
100 * Remove activity from the queue
102 * @param array $activity
105 public static function remove(array $activity = [])
107 if (empty($activity['entry-id'])) {
110 DBA::delete('inbox-entry', ['id' => $activity['entry-id']]);
114 * Delete all entries that depend on the given worker id
116 * @param integer $wid
119 public static function deleteByWorkerId(int $wid)
121 $entries = DBA::select('inbox-entry', ['id'], ['wid' => $wid]);
122 while ($entry = DBA::fetch($entries)) {
123 self::deleteById($entry['id']);
125 DBA::close($entries);
129 * Delete recursively an entry and all their children
134 public static function deleteById(int $id)
136 $entry = DBA::selectFirst('inbox-entry', ['id', 'object-id'], ['id' => $id]);
141 DBA::delete('inbox-entry', ['id' => $entry['id']]);
145 * Set the worker id for the queue entry
147 * @param int $entry_id
151 public static function setWorkerId(int $entry_id, int $wid)
153 if (empty($entry_id) || empty($wid)) {
156 DBA::update('inbox-entry', ['wid' => $wid], ['id' => $entry_id]);
160 * Check if there is an assigned worker task
166 public static function hasWorker(int $wid): bool
171 return DBA::exists('workerqueue', ['id' => $wid, 'done' => false]);
175 * Process the activity with the given id
181 public static function process(int $id): bool
183 $entry = DBA::selectFirst('inbox-entry', [], ['id' => $id]);
188 if (!empty($entry['wid'])) {
189 $worker = DI::app()->getQueue();
190 $wid = $worker['id'] ?? 0;
191 if ($entry['wid'] != $wid) {
192 $workerqueue = DBA::selectFirst('workerqueue', ['pid'], ['id' => $entry['wid'], 'done' => false]);
193 if (!empty($workerqueue['pid']) && posix_kill($workerqueue['pid'], 0)) {
194 Logger::notice('Entry is already processed via another process.', ['current' => $wid, 'processor' => $entry['wid']]);
200 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']]);
202 $activity = json_decode($entry['activity'], true);
203 $type = $entry['type'];
204 $push = $entry['push'];
206 $activity['entry-id'] = $entry['id'];
207 $activity['worker-id'] = $entry['wid'];
208 $activity['recursion-depth'] = 0;
210 $receivers = DBA::select('inbox-entry-receiver', ['uid'], ["`queue-id` = ? AND `uid` != ?", $entry['id'], 0]);
211 while ($receiver = DBA::fetch($receivers)) {
212 if (!in_array($receiver['uid'], $activity['receiver'])) {
213 $activity['receiver'][] = $receiver['uid'];
216 DBA::close($receivers);
218 if (!Receiver::routeActivities($activity, $type, $push)) {
219 self::remove($activity);
226 * Process all activities
230 public static function processAll()
232 $entries = DBA::select('inbox-entry', ['id', 'type', 'object-type', 'object-id', 'in-reply-to-id'], ["`trust` AND `wid` IS NULL"], ['order' => ['id' => true]]);
233 while ($entry = DBA::fetch($entries)) {
234 // We don't need to process entries that depend on already existing entries.
235 if (!empty($entry['in-reply-to-id']) && DBA::exists('inbox-entry', ["`id` != ? AND `object-id` = ?", $entry['id'], $entry['in-reply-to-id']])) {
238 Logger::debug('Process leftover entry', $entry);
239 self::process($entry['id']);
241 DBA::close($entries);
245 * Clear old activities
249 public static function clear()
251 // We delete all entries that aren't associated with a worker entry after seven days.
252 // The other entries are deleted when the worker deferred for too long.
253 DBA::delete('inbox-entry', ["`wid` IS NULL AND `received` < ?", DateTimeFormat::utc('now - 7 days')]);
255 // Optimizing this table only last seconds
256 if (DI::config()->get('system', 'optimize_tables')) {
257 Logger::info('Optimize start');
258 DBA::e("OPTIMIZE TABLE `inbox-entry`");
259 Logger::info('Optimize end');
264 * Process all activities that are children of a given post url
269 public static function processReplyByUri(string $uri): int
272 $entries = DBA::select('inbox-entry', ['id'], ["`in-reply-to-id` = ? AND `object-id` != ?", $uri, $uri]);
273 while ($entry = DBA::fetch($entries)) {
275 self::process($entry['id']);
277 DBA::close($entries);
282 * Checks if there are children of the given uri
288 public static function hasChildren(string $uri): bool
290 return DBA::exists('inbox-entry', ["`in-reply-to-id` = ? AND `object-id` != ?", $uri, $uri]);
294 * Prepare the queue entry.
295 * This is a test function that is used solely for development.
300 public static function reprepareActivityById(int $id): array
302 $entry = DBA::selectFirst('inbox-entry', [], ['id' => $id]);
307 $receiver = DBA::selectFirst('inbox-entry-receiver', ['uid'], ['queue-id' => $id]);
308 if (!empty($receiver)) {
309 $uid = $receiver['uid'];
314 $trust_source = $entry['trust'];
316 $data = json_decode($entry['activity'], true);
317 $activity = json_decode($data['raw'], true);
319 $ldactivity = JsonLD::compact($activity);
321 'data' => Receiver::prepareObjectData($ldactivity, $uid, $entry['push'], $trust_source),
322 'trust' => $trust_source
327 * Set the trust for all untrusted entries.
328 * This is a test function that is used solely for development.
332 public static function reprepareAll()
334 $entries = DBA::select('inbox-entry', ['id'], ["NOT `trust` AND `wid` IS NULL"], ['order' => ['id' => true]]);
335 while ($entry = DBA::fetch($entries)) {
336 $data = self::reprepareActivityById($entry['id'], false);
337 if ($data['trust']) {
338 DBA::update('inbox-entry', ['trust' => true], ['id' => $entry['id']]);
341 DBA::close($entries);