src/Worker/Notifier.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, 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\Worker;
  23
  24 use Friendica\Core\Hook;
  25 use Friendica\Core\Logger;
  26 use Friendica\Core\Protocol;
  27 use Friendica\Core\Worker;
  28 use Friendica\Database\DBA;
  29 use Friendica\DI;
  30 use Friendica\Model\Contact;
  31 use Friendica\Model\Conversation;
  32 use Friendica\Model\Group;
  33 use Friendica\Model\GServer;
  34 use Friendica\Model\Item;
  35 use Friendica\Model\Post;
  36 use Friendica\Model\PushSubscriber;
  37 use Friendica\Model\Tag;
  38 use Friendica\Model\User;
  39 use Friendica\Protocol\Activity;
  40 use Friendica\Protocol\ActivityPub;
  41 use Friendica\Protocol\Diaspora;
  42 use Friendica\Protocol\Delivery;
  43 use Friendica\Protocol\OStatus;
  44 use Friendica\Protocol\Salmon;
  45 use Friendica\Util\LDSignature;
  46 use Friendica\Util\Network;
  47 use Friendica\Util\Strings;
  48
  49 /*
  50  * The notifier is typically called with:
  51  *
  52  *              Worker::add(PRIORITY_HIGH, "Notifier", COMMAND, ITEM_ID);
  53  *
  54  * where COMMAND is one of the constants that are defined in Worker/Delivery.php
  55  * and ITEM_ID is the id of the item in the database that needs to be sent to others.
  56  */
  57
  58 class Notifier
  59 {
  60         public static function execute(string $cmd, int $post_uriid, int $sender_uid = 0)
  61         {
  62                 $a = DI::app();
  63
  64                 Logger::info('Invoked', ['cmd' => $cmd, 'target' => $post_uriid, 'sender_uid' => $sender_uid]);
  65
  66                 $target_id = $post_uriid;
  67                 $top_level = false;
  68                 $recipients = [];
  69                 $url_recipients = [];
  70
  71                 $delivery_contacts_stmt = null;
  72                 $target_item = [];
  73                 $parent = [];
  74                 $thr_parent = [];
  75                 $items = [];
  76                 $delivery_queue_count = 0;
  77                 $ap_contacts = [];
  78
  79                 if ($cmd == Delivery::MAIL) {
  80                         $message = DBA::selectFirst('mail', ['uid', 'contact-id'], ['id' => $target_id]);
  81                         if (!DBA::isResult($message)) {
  82                                 return;
  83                         }
  84                         $uid = $message['uid'];
  85                         $recipients[] = $message['contact-id'];
  86
  87                         $mail = ActivityPub\Transmitter::getItemArrayFromMail($target_id);
  88                         $inboxes = ActivityPub\Transmitter::fetchTargetInboxes($mail, $uid, true);
  89                         foreach ($inboxes as $inbox => $receivers) {
  90                                 $ap_contacts = array_merge($ap_contacts, $receivers);
  91                                 Logger::info('Delivery via ActivityPub', ['cmd' => $cmd, 'target' => $target_id, 'inbox' => $inbox]);
  92                                 Worker::add(['priority' => Worker::PRIORITY_HIGH, 'created' => $a->getQueueValue('created'), 'dont_fork' => true],
  93                                         'APDelivery', $cmd, $target_id, $inbox, $uid, $receivers, $post_uriid);
  94                         }
  95                 } elseif ($cmd == Delivery::SUGGESTION) {
  96                         $suggest = DI::fsuggest()->selectOneById($target_id);
  97                         $uid = $suggest->uid;
  98                         $recipients[] = $suggest->cid;
  99                 } elseif ($cmd == Delivery::REMOVAL) {
 100                         return self::notifySelfRemoval($target_id, $a->getQueueValue('priority'), $a->getQueueValue('created'));
 101                 } elseif ($cmd == Delivery::RELOCATION) {
 102                         $uid = $target_id;
 103
 104                         $condition = ['uid' => $target_id, 'self' => false, 'network' => [Protocol::DFRN, Protocol::DIASPORA]];
 105                         $delivery_contacts_stmt = DBA::select('contact', ['id', 'url', 'addr', 'network', 'protocol', 'baseurl', 'gsid', 'batch'], $condition);
 106                 } else {
 107                         $post = Post::selectFirst(['id'], ['uri-id' => $post_uriid, 'uid' => $sender_uid]);
 108                         if (!DBA::isResult($post)) {
 109                                 Logger::warning('Post not found', ['uri-id' => $post_uriid, 'uid' => $sender_uid]);
 110                                 return;
 111                         }
 112                         $target_id = $post['id'];
 113
 114                         // find ancestors
 115                         $condition = ['id' => $target_id, 'visible' => true];
 116                         $target_item = Post::selectFirst(Item::DELIVER_FIELDLIST, $condition);
 117
 118                         if (!DBA::isResult($target_item) || !intval($target_item['parent'])) {
 119                                 Logger::info('No target item', ['cmd' => $cmd, 'target' => $target_id]);
 120                                 return;
 121                         }
 122
 123                         if (!empty($target_item['contact-uid'])) {
 124                                 $uid = $target_item['contact-uid'];
 125                         } elseif (!empty($target_item['uid'])) {
 126                                 $uid = $target_item['uid'];
 127                         } else {
 128                                 Logger::info('Only public users, quitting', ['target' => $target_id]);
 129                                 return;
 130                         }
 131
 132                         $condition = ['parent' => $target_item['parent'], 'visible' => true];
 133                         $params = ['order' => ['id']];
 134                         $items_stmt = Post::select(Item::DELIVER_FIELDLIST, $condition, $params);
 135                         if (!DBA::isResult($items_stmt)) {
 136                                 Logger::info('No item found', ['cmd' => $cmd, 'target' => $target_id]);
 137                                 return;
 138                         }
 139
 140                         $items = Post::toArray($items_stmt);
 141
 142                         // avoid race condition with deleting entries
 143                         if ($items[0]['deleted']) {
 144                                 foreach ($items as $item) {
 145                                         $item['deleted'] = 1;
 146                                 }
 147                         }
 148
 149                         $top_level = $target_item['gravity'] == Item::GRAVITY_PARENT;
 150                 }
 151
 152                 $owner = User::getOwnerDataById($uid);
 153                 if (!$owner) {
 154                         Logger::info('Owner not found', ['cmd' => $cmd, 'target' => $target_id]);
 155                         return;
 156                 }
 157
 158                 // Should the post be transmitted to Diaspora?
 159                 $diaspora_delivery = ($owner['account-type'] != User::ACCOUNT_TYPE_COMMUNITY);
 160
 161                 // If this is a public conversation, notify the feed hub
 162                 $public_message = true;
 163
 164                 $unlisted = false;
 165
 166                 // Do a PuSH
 167                 $push_notify = false;
 168
 169                 // Deliver directly to a forum, don't PuSH
 170                 $direct_forum_delivery = false;
 171
 172                 $followup = false;
 173                 $recipients_followup = [];
 174
 175                 if (!empty($target_item) && !empty($items)) {
 176                         $parent = $items[0];
 177
 178                         $fields = ['network', 'author-id', 'author-link', 'author-network', 'owner-id'];
 179                         $condition = ['uri' => $target_item['thr-parent'], 'uid' => $target_item['uid']];
 180                         $thr_parent = Post::selectFirst($fields, $condition);
 181                         if (empty($thr_parent)) {
 182                                 $thr_parent = $parent;
 183                         }
 184
 185                         Logger::info('Got post', ['guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id'], 'network' => $target_item['network'], 'parent-network' => $parent['network'], 'thread-parent-network' => $thr_parent['network']]);
 186
 187                         if (!self::isRemovalActivity($cmd, $owner, Protocol::ACTIVITYPUB)) {
 188                                 $apdelivery = self::activityPubDelivery($cmd, $target_item, $parent, $thr_parent, $a->getQueueValue('priority'), $a->getQueueValue('created'), $owner);
 189                                 $ap_contacts = $apdelivery['contacts'];
 190                                 $delivery_queue_count += $apdelivery['count'];
 191                         }
 192
 193                         // Only deliver threaded replies (comment to a comment) to Diaspora
 194                         // when the original comment author does support the Diaspora protocol.
 195                         if ($thr_parent['author-link'] && $target_item['parent-uri'] != $target_item['thr-parent']) {
 196                                 $diaspora_delivery = Diaspora::isSupportedByContactUrl($thr_parent['author-link']);
 197                                 if ($diaspora_delivery && empty($target_item['signed_text'])) {
 198                                         Logger::debug('Post has got no Diaspora signature, so there will be no Diaspora delivery', ['guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id']]);
 199                                         $diaspora_delivery = false;
 200                                 }
 201                                 Logger::info('Threaded comment', ['diaspora_delivery' => (int)$diaspora_delivery]);
 202                         }
 203
 204                         $unlisted = $target_item['private'] == Item::UNLISTED;
 205
 206                         // This is IMPORTANT!!!!
 207
 208                         // We will only send a "notify owner to relay" or followup message if the referenced post
 209                         // originated on our system by virtue of having our hostname somewhere
 210                         // in the URI, AND it was a comment (not top_level) AND the parent originated elsewhere.
 211
 212                         // if $parent['wall'] == 1 we will already have the parent message in our array
 213                         // and we will relay the whole lot.
 214
 215                         $localhost = str_replace('www.','', DI::baseUrl()->getHostname());
 216                         if (strpos($localhost,':')) {
 217                                 $localhost = substr($localhost,0,strpos($localhost,':'));
 218                         }
 219                         /**
 220                          *
 221                          * Be VERY CAREFUL if you make any changes to the following several lines. Seemingly innocuous changes
 222                          * have been known to cause runaway conditions which affected several servers, along with
 223                          * permissions issues.
 224                          *
 225                          */
 226
 227                         $relay_to_owner = false;
 228
 229                         if (!$top_level && ($parent['wall'] == 0) && (stristr($target_item['uri'],$localhost))) {
 230                                 $relay_to_owner = true;
 231                         }
 232
 233                         // until the 'origin' flag has been in use for several months
 234                         // we will just use it as a fallback test
 235                         // later we will be able to use it as the primary test of whether or not to relay.
 236
 237                         if (!$target_item['origin']) {
 238                                 $relay_to_owner = false;
 239                         }
 240                         if ($parent['origin']) {
 241                                 $relay_to_owner = false;
 242                         }
 243
 244                         // Special treatment for forum posts
 245                         if (Item::isForumPost($target_item['uri-id'])) {
 246                                 $relay_to_owner = true;
 247                                 $direct_forum_delivery = true;
 248                         }
 249
 250                         // Avoid that comments in a forum thread are sent to OStatus
 251                         if (Item::isForumPost($parent['uri-id'])) {
 252                                 $direct_forum_delivery = true;
 253                         }
 254
 255                         $exclusive_delivery = false;
 256
 257                         $exclusive_targets = Tag::getByURIId($parent['uri-id'], [Tag::EXCLUSIVE_MENTION]);
 258                         if (!empty($exclusive_targets)) {
 259                                 $exclusive_delivery = true;
 260                                 Logger::info('Possible Exclusively delivering', ['uid' => $target_item['uid'], 'guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id']]);
 261                                 foreach ($exclusive_targets as $target) {
 262                                         if (Strings::compareLink($owner['url'], $target['url'])) {
 263                                                 $exclusive_delivery = false;
 264                                                 Logger::info('False Exclusively delivering', ['uid' => $target_item['uid'], 'guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id'], 'url' => $target['url']]);
 265                                         }
 266                                 }
 267                         }
 268
 269                         if ($relay_to_owner) {
 270                                 // local followup to remote post
 271                                 $followup = true;
 272                                 $public_message = false; // not public
 273                                 $recipients = [$parent['contact-id']];
 274                                 $recipients_followup  = [$parent['contact-id']];
 275
 276                                 Logger::info('Followup', ['target' => $target_id, 'guid' => $target_item['guid'], 'to' => $parent['contact-id']]);
 277
 278                                 if (($target_item['private'] != Item::PRIVATE) &&
 279                                         (strlen($target_item['allow_cid'].$target_item['allow_gid'].
 280                                                 $target_item['deny_cid'].$target_item['deny_gid']) == 0))
 281                                         $push_notify = true;
 282
 283                                 if (($thr_parent && ($thr_parent['network'] == Protocol::OSTATUS)) || ($parent['network'] == Protocol::OSTATUS)) {
 284                                         $push_notify = true;
 285
 286                                         if ($parent["network"] == Protocol::OSTATUS) {
 287                                                 // Distribute the message to the DFRN contacts as if this wasn't a followup since OStatus can't relay comments
 288                                                 // Currently it is work at progress
 289                                                 $condition = ['uid' => $uid, 'network' => Protocol::DFRN, 'blocked' => false, 'pending' => false, 'archive' => false];
 290                                                 $followup_contacts_stmt = DBA::select('contact', ['id'], $condition);
 291                                                 while($followup_contact = DBA::fetch($followup_contacts_stmt)) {
 292                                                         $recipients_followup[] = $followup_contact['id'];
 293                                                 }
 294                                                 DBA::close($followup_contacts_stmt);
 295                                         }
 296                                 }
 297
 298                                 if ($direct_forum_delivery) {
 299                                         $push_notify = false;
 300                                 }
 301
 302                                 Logger::info('Notify ' . $target_item["guid"] .' via PuSH: ' . ($push_notify ? "Yes":"No"));
 303                         } elseif ($exclusive_delivery) {
 304                                 $followup = true;
 305
 306                                 foreach ($exclusive_targets as $target) {
 307                                         $cid = Contact::getIdForURL($target['url'], $uid, false);
 308                                         if ($cid) {
 309                                                 $recipients_followup[] = $cid;
 310                                                 Logger::info('Exclusively delivering', ['uid' => $target_item['uid'], 'guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id'], 'url' => $target['url']]);
 311                                         }
 312                                 }
 313                         } else {
 314                                 $followup = false;
 315
 316                                 Logger::info('Distributing directly', ['target' => $target_id, 'guid' => $target_item['guid']]);
 317
 318                                 // don't send deletions onward for other people's stuff
 319
 320                                 if ($target_item['deleted'] && !intval($target_item['wall'])) {
 321                                         Logger::notice('Ignoring delete notification for non-wall item');
 322                                         return;
 323                                 }
 324
 325                                 if (strlen($parent['allow_cid'])
 326                                         || strlen($parent['allow_gid'])
 327                                         || strlen($parent['deny_cid'])
 328                                         || strlen($parent['deny_gid'])) {
 329                                         $public_message = false; // private recipients, not public
 330                                 }
 331
 332                                 $aclFormatter = DI::aclFormatter();
 333
 334                                 $allow_people = $aclFormatter->expand($parent['allow_cid']);
 335                                 $allow_groups = Group::expand($uid, $aclFormatter->expand($parent['allow_gid']),true);
 336                                 $deny_people  = $aclFormatter->expand($parent['deny_cid']);
 337                                 $deny_groups  = Group::expand($uid, $aclFormatter->expand($parent['deny_gid']));
 338
 339                                 foreach ($items as $item) {
 340                                         $recipients[] = $item['contact-id'];
 341                                         // pull out additional tagged people to notify (if public message)
 342                                         if ($public_message && $item['inform']) {
 343                                                 $people = explode(',',$item['inform']);
 344                                                 foreach ($people as $person) {
 345                                                         if (substr($person,0,4) === 'cid:') {
 346                                                                 $recipients[] = intval(substr($person,4));
 347                                                         } else {
 348                                                                 $url_recipients[] = substr($person,4);
 349                                                         }
 350                                                 }
 351                                         }
 352                                 }
 353
 354                                 if (count($url_recipients)) {
 355                                         Logger::notice('Deliver', ['target' => $target_id, 'guid' => $target_item['guid'], 'recipients' => $url_recipients]);
 356                                 }
 357
 358                                 $recipients = array_unique(array_merge($recipients, $allow_people, $allow_groups));
 359                                 $deny = array_unique(array_merge($deny_people, $deny_groups));
 360                                 $recipients = array_diff($recipients, $deny);
 361
 362                                 // If this is a public message and pubmail is set on the parent, include all your email contacts
 363                                 if (
 364                                         function_exists('imap_open')
 365                                         && !DI::config()->get('system','imap_disabled')
 366                                         && $public_message
 367                                         && intval($target_item['pubmail'])
 368                                 ) {
 369                                         $mail_contacts_stmt = DBA::select('contact', ['id'], ['uid' => $uid, 'network' => Protocol::MAIL]);
 370                                         while ($mail_contact = DBA::fetch($mail_contacts_stmt)) {
 371                                                 $recipients[] = $mail_contact['id'];
 372                                         }
 373                                         DBA::close($mail_contacts_stmt);
 374                                 }
 375                         }
 376
 377                         // If the thread parent is OStatus then do some magic to distribute the messages.
 378                         // We have not only to look at the parent, since it could be a Friendica thread.
 379                         if (($thr_parent && ($thr_parent['network'] == Protocol::OSTATUS)) || ($parent['network'] == Protocol::OSTATUS)) {
 380                                 $diaspora_delivery = false;
 381
 382                                 Logger::info('Some parent is OStatus for ' . $target_item['guid'] . ' - Author: ' . $thr_parent['author-id'] . ' - Owner: ' . $thr_parent['owner-id']);
 383
 384                                 // Send a salmon to the parent author
 385                                 $probed_contact = DBA::selectFirst('contact', ['url', 'notify'], ['id' => $thr_parent['author-id']]);
 386                                 if (DBA::isResult($probed_contact) && !empty($probed_contact['notify'])) {
 387                                         Logger::notice('Notify parent author', ['url' => $probed_contact['url'], 'notify' => $probed_contact['notify']]);
 388                                         $url_recipients[$probed_contact['notify']] = $probed_contact['notify'];
 389                                 }
 390
 391                                 // Send a salmon to the parent owner
 392                                 $probed_contact = DBA::selectFirst('contact', ['url', 'notify'], ['id' => $thr_parent['owner-id']]);
 393                                 if (DBA::isResult($probed_contact) && !empty($probed_contact['notify'])) {
 394                                         Logger::notice('Notify parent owner', ['url' => $probed_contact['url'], 'notify' => $probed_contact['notify']]);
 395                                         $url_recipients[$probed_contact['notify']] = $probed_contact['notify'];
 396                                 }
 397
 398                                 // Send a salmon notification to every person we mentioned in the post
 399                                 foreach (Tag::getByURIId($target_item['uri-id'], [Tag::MENTION, Tag::EXCLUSIVE_MENTION, Tag::IMPLICIT_MENTION]) as $tag) {
 400                                         $probed_contact = Contact::getByURL($tag['url']);
 401                                         if (!empty($probed_contact['notify'])) {
 402                                                 Logger::notice('Notify mentioned user', ['url' => $probed_contact['url'], 'notify' => $probed_contact['notify']]);
 403                                                 $url_recipients[$probed_contact['notify']] = $probed_contact['notify'];
 404                                         }
 405                                 }
 406
 407                                 // It only makes sense to distribute answers to OStatus messages to Friendica and OStatus - but not Diaspora
 408                                 $networks = [Protocol::DFRN];
 409                         } elseif ($diaspora_delivery) {
 410                                 $networks = [Protocol::DFRN, Protocol::DIASPORA, Protocol::MAIL];
 411                                 if (($parent['network'] == Protocol::DIASPORA) || ($thr_parent['network'] == Protocol::DIASPORA)) {
 412                                         Logger::info('Add AP contacts', ['target' => $target_id, 'guid' => $target_item['guid']]);
 413                                         $networks[] = Protocol::ACTIVITYPUB;
 414                                 }
 415                         } else {
 416                                 $networks = [Protocol::DFRN, Protocol::MAIL];
 417                         }
 418                 } else {
 419                         $public_message = false;
 420                 }
 421
 422                 if (empty($delivery_contacts_stmt)) {
 423                         if ($followup) {
 424                                 $recipients = $recipients_followup;
 425                         }
 426                         $condition = ['id' => $recipients, 'self' => false, 'uid' => [0, $uid],
 427                                 'blocked' => false, 'pending' => false, 'archive' => false];
 428                         if (!empty($networks)) {
 429                                 $condition['network'] = $networks;
 430                         }
 431                         $delivery_contacts_stmt = DBA::select('contact', ['id', 'addr', 'url', 'network', 'protocol', 'baseurl', 'gsid', 'batch'], $condition);
 432                 }
 433
 434                 $conversants = [];
 435                 $batch_delivery = false;
 436
 437                 if ($public_message && !in_array($cmd, [Delivery::MAIL, Delivery::SUGGESTION]) && !$followup) {
 438                         $participants = [];
 439
 440                         if ($diaspora_delivery && !$unlisted) {
 441                                 $batch_delivery = true;
 442
 443                                 $participants = DBA::selectToArray('contact', ['batch', 'network', 'protocol', 'baseurl', 'gsid', 'id', 'url', 'name'],
 444                                         ["`network` = ? AND `batch` != '' AND `uid` = ? AND `rel` != ? AND NOT `blocked` AND NOT `pending` AND NOT `archive`", Protocol::DIASPORA, $owner['uid'], Contact::SHARING],
 445                                         ['group_by' => ['batch', 'network', 'protocol']]);
 446
 447                                 // Fetch the participation list
 448                                 // The function will ensure that there are no duplicates
 449                                 $participants = Diaspora::participantsForThread($target_item, $participants);
 450                         }
 451
 452                         $condition = ['network' => Protocol::DFRN, 'uid' => $owner['uid'], 'blocked' => false,
 453                                 'pending' => false, 'archive' => false, 'rel' => [Contact::FOLLOWER, Contact::FRIEND]];
 454
 455                         $contacts = DBA::selectToArray('contact', ['id', 'url', 'addr', 'name', 'network', 'protocol', 'baseurl', 'gsid'], $condition);
 456
 457                         $conversants = array_merge($contacts, $participants);
 458
 459                         $delivery_queue_count += self::delivery($cmd, $post_uriid, $sender_uid, $target_item, $thr_parent, $owner, $batch_delivery, true, $conversants, $ap_contacts, []);
 460
 461                         $push_notify = true;
 462                 }
 463
 464                 $contacts = DBA::toArray($delivery_contacts_stmt);
 465                 $delivery_queue_count += self::delivery($cmd, $post_uriid, $sender_uid, $target_item, $thr_parent, $owner, $batch_delivery, false, $contacts, $ap_contacts, $conversants);
 466
 467                 $delivery_queue_count += self::deliverOStatus($target_id, $target_item, $owner, $url_recipients, $public_message, $push_notify);
 468
 469                 if (!empty($target_item)) {
 470                         Logger::info('Calling hooks for ' . $cmd . ' ' . $target_id);
 471
 472                         Hook::fork($a->getQueueValue('priority'), 'notifier_normal', $target_item);
 473
 474                         Hook::callAll('notifier_end', $target_item);
 475
 476                         // Workaround for pure connector posts
 477                         if ($cmd == Delivery::POST) {
 478                                 if ($delivery_queue_count == 0) {
 479                                         Post\DeliveryData::incrementQueueDone($target_item['uri-id']);
 480                                         $delivery_queue_count = 1;
 481                                 }
 482
 483                                 Post\DeliveryData::incrementQueueCount($target_item['uri-id'], $delivery_queue_count);
 484                         }
 485                 }
 486
 487                 return;
 488         }
 489
 490         /**
 491          * Deliver the message to the contacts
 492          *
 493          * @param string $cmd
 494          * @param int $post_uriid
 495          * @param int $sender_uid
 496          * @param array $target_item
 497          * @param array $thr_parent
 498          * @param array $owner
 499          * @param bool $batch_delivery
 500          * @param array $contacts
 501          * @param array $ap_contacts
 502          * @param array $conversants
 503          *
 504          * @return int Count of delivery queue
 505          * @throws InternalServerErrorException
 506          * @throws Exception
 507          */
 508         private static function delivery(string $cmd, int $post_uriid, int $sender_uid, array $target_item, array $thr_parent, array $owner, bool $batch_delivery, bool $in_batch, array $contacts, array $ap_contacts, array $conversants = []): int
 509         {
 510                 $a = DI::app();
 511                 $delivery_queue_count = 0;
 512
 513                 if (!empty($target_item['verb']) && ($target_item['verb'] == Activity::ANNOUNCE)) {
 514                         Logger::notice('Announces are only delivery via ActivityPub', ['cmd' => $cmd, 'id' => $target_item['id'], 'guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id'], 'uri' => $target_item['uri']]);
 515                         return 0;
 516                 }
 517
 518                 foreach ($contacts as $contact) {
 519                         // Direct delivery of local contacts
 520                         if (!in_array($cmd, [Delivery::RELOCATION, Delivery::SUGGESTION, Delivery::MAIL]) && $target_uid = User::getIdForURL($contact['url'])) {
 521                                 if ($cmd == Delivery::DELETION) {
 522                                         Logger::info('No need to deliver deletions internally', ['uid' => $target_uid, 'guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id'], 'uri' => $target_item['uri']]);
 523                                         continue;
 524                                 }
 525                                 if ($target_item['origin'] || ($target_item['network'] != Protocol::ACTIVITYPUB)) {
 526                                         if ($target_uid != $target_item['uid']) {
 527                                                 $fields = ['protocol' => Conversation::PARCEL_LOCAL_DFRN, 'direction' => Conversation::PUSH, 'post-reason' => Item::PR_DIRECT];
 528                                                 Item::storeForUserByUriId($target_item['uri-id'], $target_uid, $fields, $target_item['uid']);
 529                                                 Logger::info('Delivered locally', ['cmd' => $cmd, 'id' => $target_item['id'], 'target' => $target_uid]);
 530                                         } else {
 531                                                 Logger::info('No need to deliver to myself', ['uid' => $target_uid, 'guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id'], 'uri' => $target_item['uri']]);
 532                                         }
 533                                 } else {
 534                                         Logger::info('Remote item does not need to be delivered locally', ['guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id'], 'uri' => $target_item['uri']]);
 535                                 }
 536                                 continue;
 537                         }
 538
 539                         // Deletions are always sent via DFRN as well.
 540                         // This is done until we can perform deletions of foreign comments on our own threads via AP.
 541                         if (($cmd != Delivery::DELETION) && in_array($contact['id'], $ap_contacts)) {
 542                                 Logger::info('Contact is already delivered via AP, so skip delivery via legacy DFRN/Diaspora', ['target' => $post_uriid, 'uid' => $sender_uid, 'contact' => $contact['url']]);
 543                                 continue;
 544                         }
 545
 546                         if (!empty($contact['id']) && Contact::isArchived($contact['id'])) {
 547                                 Logger::info('Contact is archived, so skip delivery', ['target' => $post_uriid, 'uid' => $sender_uid, 'contact' => $contact['url']]);
 548                                 continue;
 549                         }
 550
 551                         if (self::isRemovalActivity($cmd, $owner, $contact['network'])) {
 552                                 Logger::info('Contact does no supports account removal commands, so skip delivery', ['target' => $post_uriid, 'uid' => $sender_uid, 'contact' => $contact['url']]);
 553                                 continue;
 554                         }
 555
 556                         if (self::skipActivityPubForDiaspora($contact, $target_item, $thr_parent)) {
 557                                 Logger::info('Contact is from Diaspora, but the replied author is from ActivityPub, so skip delivery via Diaspora', ['id' => $post_uriid, 'uid' => $sender_uid, 'url' => $contact['url']]);
 558                                 continue;
 559                         }
 560
 561                         // Don't deliver to Diaspora if it already had been done as batch delivery
 562                         if (!$in_batch && $batch_delivery && ($contact['network'] == Protocol::DIASPORA)) {
 563                                 Logger::info('Diaspora contact is already delivered via batch', ['id' => $post_uriid, 'uid' => $sender_uid, 'contact' => $contact]);
 564                                 continue;
 565                         }
 566
 567                         // Don't deliver to folks who have already been delivered to
 568                         if (in_array($contact['id'], $conversants)) {
 569                                 Logger::info('Already delivery', ['id' => $post_uriid, 'uid' => $sender_uid, 'contact' => $contact]);
 570                                 continue;
 571                         }
 572
 573                         if (empty($contact['gsid'])) {
 574                                 $reachable = GServer::reachable($contact);
 575                         } elseif (!DI::config()->get('system', 'bulk_delivery')) {
 576                                 $reachable = GServer::isReachableById($contact['gsid']);
 577                         } else {
 578                                 $reachable = !GServer::isDefunctById($contact['gsid']);
 579                         }
 580
 581                         if (!$reachable) {
 582                                 Logger::info('Server is not reachable', ['id' => $post_uriid, 'uid' => $sender_uid, 'contact' => $contact]);
 583                                 continue;
 584                         }
 585
 586                         Logger::info('Delivery', ['batch' => $in_batch, 'target' => $post_uriid, 'uid' => $sender_uid, 'guid' => $target_item['guid'] ?? '', 'to' => $contact]);
 587
 588                         // Ensure that posts with our own protocol arrives before Diaspora posts arrive.
 589                         // Situation is that sometimes Friendica servers receive Friendica posts over the Diaspora protocol first.
 590                         // The conversion in Markdown reduces the formatting, so these posts should arrive after the Friendica posts.
 591                         // This is only important for high and medium priority tasks and not for Low priority jobs like deletions.
 592                         if (($contact['network'] == Protocol::DIASPORA) && in_array($a->getQueueValue('priority'), [Worker::PRIORITY_HIGH, Worker::PRIORITY_MEDIUM])) {
 593                                 $deliver_options = ['priority' => $a->getQueueValue('priority'), 'dont_fork' => true];
 594                         } else {
 595                                 $deliver_options = ['priority' => $a->getQueueValue('priority'), 'created' => $a->getQueueValue('created'), 'dont_fork' => true];
 596                         }
 597
 598                         if (!empty($contact['gsid']) && DI::config()->get('system', 'bulk_delivery')) {
 599                                 $delivery_queue_count++;
 600                                 $deliveryQueueItem = DI::deliveryQueueItemFactory()->createFromDelivery($cmd, $post_uriid, new \DateTimeImmutable($target_item['created']), $contact['id'], $contact['gsid'], $sender_uid);
 601                                 DI::deliveryQueueItemRepo()->save($deliveryQueueItem);
 602                                 Worker::add(['priority' => Worker::PRIORITY_HIGH, 'dont_fork' => true], 'BulkDelivery', $contact['gsid']);
 603                         } else {
 604                                 if (Worker::add($deliver_options, 'Delivery', $cmd, $post_uriid, (int)$contact['id'], $sender_uid)) {
 605                                         $delivery_queue_count++;
 606                                 }
 607                         }
 608
 609                         Worker::coolDown();
 610                 }
 611                 return $delivery_queue_count;
 612         }
 613
 614         /**
 615          * Deliver the message via OStatus
 616          *
 617          * @param int $target_id
 618          * @param array $target_item
 619          * @param array $owner
 620          * @param array $url_recipients
 621          * @param bool $public_message
 622          * @param bool $push_notify
 623          *
 624          * @return int Count of sent Salmon notifications
 625          * @throws InternalServerErrorException
 626          * @throws Exception
 627          */
 628         private static function deliverOStatus(int $target_id, array $target_item, array $owner, array $url_recipients, bool $public_message, bool $push_notify): int
 629         {
 630                 $a = DI::app();
 631                 $delivery_queue_count = 0;
 632
 633                 $url_recipients = array_filter($url_recipients);
 634                 // send salmon slaps to mentioned remote tags (@foo@example.com) in OStatus posts
 635                 // They are especially used for notifications to OStatus users that don't follow us.
 636                 if (count($url_recipients) && ($public_message || $push_notify) && !empty($target_item)) {
 637                         $slap = OStatus::salmon($target_item, $owner);
 638                         foreach ($url_recipients as $url) {
 639                                 Logger::info('Salmon delivery', ['item' => $target_id, 'to' => $url]);
 640
 641                                 $delivery_queue_count++;
 642                                 Salmon::slapper($owner, $url, $slap);
 643                                 Post\DeliveryData::incrementQueueDone($target_item['uri-id'], Post\DeliveryData::OSTATUS);
 644                         }
 645                 }
 646
 647                 // Notify PuSH subscribers (Used for OStatus distribution of regular posts)
 648                 if ($push_notify) {
 649                         Logger::info('Activating internal PuSH', ['uid' => $owner['uid']]);
 650
 651                         // Handling the pubsubhubbub requests
 652                         PushSubscriber::publishFeed($owner['uid'], $a->getQueueValue('priority'));
 653                 }
 654                 return $delivery_queue_count;
 655         }
 656
 657         /**
 658          * Checks if the current delivery shouldn't be transported to Diaspora.
 659          * This is done for posts from AP authors or posts that are comments to AP authors.
 660          *
 661          * @param array  $contact    Receiver of the post
 662          * @param array  $item       The post
 663          * @param array  $thr_parent The thread parent
 664          *
 665          * @return bool
 666          */
 667         private static function skipActivityPubForDiaspora(array $contact, array $item, array $thr_parent): bool
 668         {
 669                 // No skipping needs to be done when delivery isn't done to Diaspora
 670                 if ($contact['network'] != Protocol::DIASPORA) {
 671                         return false;
 672                 }
 673
 674                 // Skip the delivery to Diaspora if the item is from an ActivityPub author
 675                 if (!empty($item['author-network']) && ($item['author-network'] == Protocol::ACTIVITYPUB)) {
 676                         return true;
 677                 }
 678
 679                 // Skip the delivery to Diaspora if the thread parent is from an ActivityPub author
 680                 if (!empty($thr_parent['author-network']) && ($thr_parent['author-network'] == Protocol::ACTIVITYPUB)) {
 681                         return true;
 682                 }
 683
 684                 return false;
 685         }
 686
 687         /**
 688          * Checks if the current action is a deletion command of a account removal activity
 689          * For Diaspora and ActivityPub we don't need to send single item deletion calls.
 690          * These protocols do have a dedicated command for deleting a whole account.
 691          *
 692          * @param string $cmd     Notifier command
 693          * @param array  $owner   Sender of the post
 694          * @param string $network Receiver network
 695          *
 696          * @return bool
 697          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 698          * @throws \ImagickException
 699          */
 700         private static function isRemovalActivity(string $cmd, array $owner, string $network): bool
 701         {
 702                 return ($cmd == Delivery::DELETION) && $owner['account_removed'] && in_array($network, [Protocol::ACTIVITYPUB, Protocol::DIASPORA]);
 703         }
 704
 705         /**
 706          * @param int    $self_user_id
 707          * @param int    $priority The priority the Notifier queue item was created with
 708          * @param string $created  The date the Notifier queue item was created on
 709          *
 710          * @return bool
 711          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 712          * @throws \ImagickException
 713          */
 714         private static function notifySelfRemoval(int $self_user_id, int $priority, string $created): bool
 715         {
 716                 $owner = User::getOwnerDataById($self_user_id);
 717                 if (empty($self_user_id) || empty($owner)) {
 718                         return false;
 719                 }
 720
 721                 $contacts_stmt = DBA::select('contact', [], ['self' => false, 'uid' => $self_user_id]);
 722                 if (!DBA::isResult($contacts_stmt)) {
 723                         return false;
 724                 }
 725
 726                 while($contact = DBA::fetch($contacts_stmt)) {
 727                         Contact::terminateFriendship($contact);
 728                 }
 729                 DBA::close($contacts_stmt);
 730
 731                 $inboxes = ActivityPub\Transmitter::fetchTargetInboxesforUser($self_user_id);
 732                 foreach ($inboxes as $inbox => $receivers) {
 733                         Logger::info('Account removal via ActivityPub', ['uid' => $self_user_id, 'inbox' => $inbox]);
 734                         Worker::add(['priority' => Worker::PRIORITY_NEGLIGIBLE, 'created' => $created, 'dont_fork' => true],
 735                                 'APDelivery', Delivery::REMOVAL, 0, $inbox, $self_user_id, $receivers);
 736                         Worker::coolDown();
 737                 }
 738
 739                 return true;
 740         }
 741
 742         /**
 743          * @param string $cmd
 744          * @param array  $target_item
 745          * @param array  $parent
 746          * @param array  $thr_parent
 747          * @param int    $priority The priority the Notifier queue item was created with
 748          * @param string $created  The date the Notifier queue item was created on
 749          *
 750          * @return array 'count' => The number of delivery tasks created, 'contacts' => their contact ids
 751          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 752          * @throws \ImagickException
 753          * @todo Unused parameter $owner
 754          */
 755         private static function activityPubDelivery($cmd, array $target_item, array $parent, array $thr_parent, int $priority, string $created, $owner): array
 756         {
 757                 // Don't deliver via AP when the starting post isn't from a federated network
 758                 if (!in_array($parent['network'], Protocol::FEDERATED)) {
 759                         Logger::info('Parent network is no federated network, so no AP delivery', ['network' => $parent['network']]);
 760                         return ['count' => 0, 'contacts' => []];
 761                 }
 762
 763                 // Don't deliver via AP when the starting post is delivered via Diaspora
 764                 if ($parent['network'] == Protocol::DIASPORA) {
 765                         Logger::info('Parent network is Diaspora, so no AP delivery');
 766                         return ['count' => 0, 'contacts' => []];
 767                 }
 768
 769                 // Also don't deliver when the direct thread parent was delivered via Diaspora
 770                 if ($thr_parent['network'] == Protocol::DIASPORA) {
 771                         Logger::info('Thread parent network is Diaspora, so no AP delivery');
 772                         return ['count' => 0, 'contacts' => []];
 773                 }
 774
 775                 // Posts from Diaspora contacts are transmitted via Diaspora
 776                 if ($target_item['network'] == Protocol::DIASPORA) {
 777                         Logger::info('Post network is Diaspora, so no AP delivery');
 778                         return ['count' => 0, 'contacts' => []];
 779                 }
 780
 781                 $inboxes = [];
 782                 $relay_inboxes = [];
 783
 784                 $uid = $target_item['contact-uid'] ?: $target_item['uid'];
 785
 786                 // Update the locally stored follower list when we deliver to a forum
 787                 foreach (Tag::getByURIId($target_item['uri-id'], [Tag::MENTION, Tag::EXCLUSIVE_MENTION]) as $tag) {
 788                         $target_contact = Contact::getByURL(Strings::normaliseLink($tag['url']), null, [], $uid);
 789                         if ($target_contact && $target_contact['contact-type'] == Contact::TYPE_COMMUNITY && $target_contact['manually-approve']) {
 790                                 Group::updateMembersForForum($target_contact['id']);
 791                         }
 792                 }
 793
 794                 if ($target_item['origin']) {
 795                         $inboxes = ActivityPub\Transmitter::fetchTargetInboxes($target_item, $uid);
 796
 797                         if (in_array($target_item['private'], [Item::PUBLIC])) {
 798                                 $inboxes = ActivityPub\Transmitter::addRelayServerInboxesForItem($target_item['id'], $inboxes);
 799                                 $relay_inboxes = ActivityPub\Transmitter::addRelayServerInboxes();
 800                         }
 801
 802                         Logger::info('Origin item will be distributed', ['id' => $target_item['id'], 'url' => $target_item['uri'], 'verb' => $target_item['verb']]);
 803                         $check_signature = false;
 804                 } elseif (!Post\Activity::exists($target_item['uri-id'])) {
 805                         Logger::info('Remote item is no AP post. It will not be distributed.', ['id' => $target_item['id'], 'url' => $target_item['uri'], 'verb' => $target_item['verb']]);
 806                         return ['count' => 0, 'contacts' => []];
 807                 } elseif ($parent['origin'] && (($target_item['gravity'] != Item::GRAVITY_ACTIVITY) || DI::config()->get('system', 'redistribute_activities'))) {
 808                         $inboxes = ActivityPub\Transmitter::fetchTargetInboxes($parent, $uid, false, $target_item['id']);
 809
 810                         if (in_array($target_item['private'], [Item::PUBLIC])) {
 811                                 $inboxes = ActivityPub\Transmitter::addRelayServerInboxesForItem($parent['id'], $inboxes);
 812                         }
 813
 814                         Logger::info('Remote item will be distributed', ['id' => $target_item['id'], 'url' => $target_item['uri'], 'verb' => $target_item['verb']]);
 815                         $check_signature = ($target_item['gravity'] == Item::GRAVITY_ACTIVITY);
 816                 } else {
 817                         Logger::info('Remote activity will not be distributed', ['id' => $target_item['id'], 'url' => $target_item['uri'], 'verb' => $target_item['verb']]);
 818                         return ['count' => 0, 'contacts' => []];
 819                 }
 820
 821                 if (empty($inboxes) && empty($relay_inboxes)) {
 822                         Logger::info('No inboxes found for item ' . $target_item['id'] . ' with URL ' . $target_item['uri'] . '. It will not be distributed.');
 823                         return ['count' => 0, 'contacts' => []];
 824                 }
 825
 826                 // Fill the item cache
 827                 $activity = ActivityPub\Transmitter::createCachedActivityFromItem($target_item['id'], true);
 828                 if (empty($activity)) {
 829                         Logger::info('Item cache was not created. The post will not be distributed.', ['id' => $target_item['id'], 'url' => $target_item['uri'], 'verb' => $target_item['verb']]);
 830                         return ['count' => 0, 'contacts' => []];
 831                 }
 832
 833                 if ($check_signature && !LDSignature::isSigned($activity)) {
 834                         Logger::info('Unsigned remote activity will not be distributed', ['id' => $target_item['id'], 'url' => $target_item['uri'], 'verb' => $target_item['verb']]);
 835                         return ['count' => 0, 'contacts' => []];
 836                 }
 837
 838                 $delivery_queue_count = 0;
 839                 $contacts = [];
 840
 841                 foreach ($inboxes as $inbox => $receivers) {
 842                         $contacts = array_merge($contacts, $receivers);
 843
 844                         if ((count($receivers) == 1) && Network::isLocalLink($inbox)) {
 845                                 $contact = Contact::getById($receivers[0], ['url']);
 846                                 if (!in_array($cmd, [Delivery::RELOCATION, Delivery::SUGGESTION, Delivery::MAIL]) && ($target_uid = User::getIdForURL($contact['url']))) {
 847                                         if ($cmd == Delivery::DELETION) {
 848                                                 Logger::info('No need to deliver deletions internally', ['uid' => $target_uid, 'guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id'], 'uri' => $target_item['uri']]);
 849                                                 continue;
 850                                         }
 851                                         if ($target_item['origin'] || ($target_item['network'] != Protocol::ACTIVITYPUB)) {
 852                                                 if ($target_uid != $target_item['uid']) {
 853                                                         $fields = ['protocol' => Conversation::PARCEL_LOCAL_DFRN, 'direction' => Conversation::PUSH, 'post-reason' => Item::PR_BCC];
 854                                                         Item::storeForUserByUriId($target_item['uri-id'], $target_uid, $fields, $target_item['uid']);
 855                                                         Logger::info('Delivered locally', ['cmd' => $cmd, 'id' => $target_item['id'], 'inbox' => $inbox]);
 856                                                 } else {
 857                                                         Logger::info('No need to deliver to myself', ['uid' => $target_uid, 'guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id'], 'uri' => $target_item['uri']]);
 858                                                 }
 859                                         } else {
 860                                                 Logger::info('Remote item does not need to be delivered locally', ['guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id'], 'uri' => $target_item['uri']]);
 861                                         }
 862                                         continue;
 863                                 }
 864                         } elseif ((count($receivers) >= 1) && Network::isLocalLink($inbox)) {
 865                                 Logger::info('Is this a thing?', ['guid' => $target_item['guid'], 'uri-id' => $target_item['uri-id'], 'uri' => $target_item['uri']]);
 866                         }
 867
 868                         Logger::info('Delivery via ActivityPub', ['cmd' => $cmd, 'id' => $target_item['id'], 'inbox' => $inbox]);
 869
 870                         if (DI::config()->get('system', 'bulk_delivery')) {
 871                                 $delivery_queue_count++;
 872                                 Post\Delivery::add($target_item['uri-id'], $uid, $inbox, $target_item['created'], $cmd, $receivers);
 873                                 Worker::add([Worker::PRIORITY_HIGH, 'dont_fork' => true], 'APDelivery', '', 0, $inbox, 0);
 874                         } else {
 875                                 if (Worker::add(['priority' => $priority, 'created' => $created, 'dont_fork' => true],
 876                                                 'APDelivery', $cmd, $target_item['id'], $inbox, $uid, $receivers, $target_item['uri-id'])) {
 877                                         $delivery_queue_count++;
 878                                 }
 879                         }
 880                         Worker::coolDown();
 881                 }
 882
 883                 // We deliver posts to relay servers slightly delayed to priorize the direct delivery
 884                 foreach ($relay_inboxes as $inbox) {
 885                         Logger::info('Delivery to relay servers via ActivityPub', ['cmd' => $cmd, 'id' => $target_item['id'], 'inbox' => $inbox]);
 886
 887                         if (DI::config()->get('system', 'bulk_delivery')) {
 888                                 $delivery_queue_count++;
 889                                 Post\Delivery::add($target_item['uri-id'], $uid, $inbox, $target_item['created'], $cmd, []);
 890                                 Worker::add([Worker::PRIORITY_MEDIUM, 'dont_fork' => true], 'APDelivery', '', 0, $inbox, 0);
 891                         } else {
 892                                 if (Worker::add(['priority' => $priority, 'dont_fork' => true], 'APDelivery', $cmd, $target_item['id'], $inbox, $uid, [], $target_item['uri-id'])) {
 893                                         $delivery_queue_count++;
 894                                 }
 895                         }
 896                         Worker::coolDown();
 897                 }
 898
 899                 return ['count' => $delivery_queue_count, 'contacts' => $contacts];
 900         }
 901 }