src/Worker/Notifier.php

   1 <?php
   2 /**
   3  * @file src/Worker/Notifier.php
   4  */
   5 namespace Friendica\Worker;
   6
   7 use Friendica\BaseObject;
   8 use Friendica\Core\Addon;
   9 use Friendica\Core\Config;
  10 use Friendica\Core\Protocol;
  11 use Friendica\Core\Worker;
  12 use Friendica\Database\DBA;
  13 use Friendica\Model\Contact;
  14 use Friendica\Model\Group;
  15 use Friendica\Model\Item;
  16 use Friendica\Model\PushSubscriber;
  17 use Friendica\Model\User;
  18 use Friendica\Network\Probe;
  19 use Friendica\Protocol\ActivityPub;
  20 use Friendica\Protocol\Diaspora;
  21 use Friendica\Protocol\OStatus;
  22 use Friendica\Protocol\Salmon;
  23
  24 require_once 'include/dba.php';
  25 require_once 'include/items.php';
  26
  27 /*
  28  * The notifier is typically called with:
  29  *
  30  *              Worker::add(PRIORITY_HIGH, "Notifier", COMMAND, ITEM_ID);
  31  *
  32  * where COMMAND is one of the following:
  33  *
  34  *              activity                                (in diaspora.php, dfrn_confirm.php, profiles.php)
  35  *              comment-import                  (in diaspora.php, items.php)
  36  *              comment-new                             (in item.php)
  37  *              drop                                    (in diaspora.php, items.php, photos.php)
  38  *              edit_post                               (in item.php)
  39  *              event                                   (in events.php)
  40  *              like                                    (in like.php, poke.php)
  41  *              mail                                    (in message.php)
  42  *              suggest                                 (in fsuggest.php)
  43  *              tag                                             (in photos.php, poke.php, tagger.php)
  44  *              tgroup                                  (in items.php)
  45  *              wall-new                                (in photos.php, item.php)
  46  *              removeme                                (in Contact.php)
  47  *              relocate                                (in uimport.php)
  48  *
  49  * and ITEM_ID is the id of the item in the database that needs to be sent to others.
  50  */
  51
  52 class Notifier
  53 {
  54         public static function execute($cmd, $item_id)
  55         {
  56                 $a = BaseObject::getApp();
  57
  58                 logger('notifier: invoked: '.$cmd.': '.$item_id, LOGGER_DEBUG);
  59
  60                 $top_level = false;
  61                 $recipients = [];
  62                 $url_recipients = [];
  63
  64                 $normal_mode = true;
  65                 $recipients_relocate = [];
  66
  67                 if ($cmd == Delivery::MAIL) {
  68                         $normal_mode = false;
  69                         $message = DBA::selectFirst('mail', ['uid', 'contact-id'], ['id' => $item_id]);
  70                         if (!DBA::isResult($message)) {
  71                                 return;
  72                         }
  73                         $uid = $message['uid'];
  74                         $recipients[] = $message['contact-id'];
  75                 } elseif ($cmd == Delivery::SUGGESTION) {
  76                         $normal_mode = false;
  77                         $suggest = DBA::selectFirst('fsuggest', ['uid', 'cid'], ['id' => $item_id]);
  78                         if (!DBA::isResult($suggest)) {
  79                                 return;
  80                         }
  81                         $uid = $suggest['uid'];
  82                         $recipients[] = $suggest['cid'];
  83                 } elseif ($cmd == Delivery::REMOVAL) {
  84                         $r = q("SELECT `contact`.*, `user`.`prvkey` AS `uprvkey`,
  85                                         `user`.`timezone`, `user`.`nickname`, `user`.`sprvkey`, `user`.`spubkey`,
  86                                         `user`.`page-flags`, `user`.`prvnets`, `user`.`account-type`, `user`.`guid`
  87                                 FROM `contact` INNER JOIN `user` ON `user`.`uid` = `contact`.`uid`
  88                                         WHERE `contact`.`uid` = %d AND `contact`.`self` LIMIT 1",
  89                                         intval($item_id));
  90                         if (!$r) {
  91                                 return;
  92                         }
  93                         $user = $r[0];
  94
  95                         $r = q("SELECT * FROM `contact` WHERE NOT `self` AND `uid` = %d", intval($item_id));
  96                         if (!$r) {
  97                                 return;
  98                         }
  99                         foreach ($r as $contact) {
 100                                 Contact::terminateFriendship($user, $contact, true);
 101                         }
 102                         return;
 103                 } elseif ($cmd == Delivery::RELOCATION) {
 104                         $normal_mode = false;
 105                         $uid = $item_id;
 106
 107                         $recipients_relocate = q("SELECT * FROM `contact` WHERE `uid` = %d AND NOT `self` AND `network` IN ('%s', '%s')",
 108                                                 intval($uid), Protocol::DFRN, Protocol::DIASPORA);
 109                 } else {
 110                         // find ancestors
 111                         $condition = ['id' => $item_id, 'visible' => true, 'moderated' => false];
 112                         $target_item = Item::selectFirst([], $condition);
 113
 114                         if (!DBA::isResult($target_item) || !intval($target_item['parent'])) {
 115                                 return;
 116                         }
 117
 118                         $parent_id = intval($target_item['parent']);
 119                         $uid = $target_item['contact-uid'];
 120                         $updated = $target_item['edited'];
 121
 122                         $condition = ['parent' => $parent_id, 'visible' => true, 'moderated' => false];
 123                         $params = ['order' => ['id']];
 124                         $ret = Item::select([], $condition, $params);
 125
 126                         if (!DBA::isResult($ret)) {
 127                                 return;
 128                         }
 129
 130                         $items = Item::inArray($ret);
 131
 132                         // avoid race condition with deleting entries
 133                         if ($items[0]['deleted']) {
 134                                 foreach ($items as $item) {
 135                                         $item['deleted'] = 1;
 136                                 }
 137                         }
 138
 139                         if ((count($items) == 1) && ($items[0]['id'] === $target_item['id']) && ($items[0]['uri'] === $items[0]['parent-uri'])) {
 140                                 logger('notifier: top level post');
 141                                 $top_level = true;
 142                         }
 143                 }
 144
 145                 $owner = User::getOwnerDataById($uid);
 146                 if (!$owner) {
 147                         return;
 148                 }
 149
 150                 $walltowall = ($top_level && ($owner['id'] != $items[0]['contact-id']) ? true : false);
 151
 152                 // Should the post be transmitted to Diaspora?
 153                 $diaspora_delivery = true;
 154
 155                 // If this is a public conversation, notify the feed hub
 156                 $public_message = true;
 157
 158                 // Do a PuSH
 159                 $push_notify = false;
 160
 161                 // Deliver directly to a forum, don't PuSH
 162                 $direct_forum_delivery = false;
 163
 164                 $followup = false;
 165                 $recipients_followup = [];
 166                 $conversants = [];
 167
 168                 if (!in_array($cmd, [Delivery::MAIL, Delivery::SUGGESTION, Delivery::RELOCATION])) {
 169                         $parent = $items[0];
 170
 171                         $fields = ['network', 'author-id', 'owner-id'];
 172                         $condition = ['uri' => $target_item["thr-parent"], 'uid' => $target_item["uid"]];
 173                         $thr_parent = Item::selectFirst($fields, $condition);
 174
 175                         logger('GUID: '.$target_item["guid"].': Parent is '.$parent['network'].'. Thread parent is '.$thr_parent['network'], LOGGER_DEBUG);
 176
 177                         // This is IMPORTANT!!!!
 178
 179                         // We will only send a "notify owner to relay" or followup message if the referenced post
 180                         // originated on our system by virtue of having our hostname somewhere
 181                         // in the URI, AND it was a comment (not top_level) AND the parent originated elsewhere.
 182
 183                         // if $parent['wall'] == 1 we will already have the parent message in our array
 184                         // and we will relay the whole lot.
 185
 186                         $localhost = str_replace('www.','',$a->get_hostname());
 187                         if (strpos($localhost,':')) {
 188                                 $localhost = substr($localhost,0,strpos($localhost,':'));
 189                         }
 190                         /**
 191                          *
 192                          * Be VERY CAREFUL if you make any changes to the following several lines. Seemingly innocuous changes
 193                          * have been known to cause runaway conditions which affected several servers, along with
 194                          * permissions issues.
 195                          *
 196                          */
 197
 198                         $relay_to_owner = false;
 199
 200                         if (!$top_level && ($parent['wall'] == 0) && (stristr($target_item['uri'],$localhost))) {
 201                                 $relay_to_owner = true;
 202                         }
 203
 204
 205                         if (($cmd === 'uplink') && (intval($parent['forum_mode']) == 1) && !$top_level) {
 206                                 $relay_to_owner = true;
 207                         }
 208
 209                         // until the 'origin' flag has been in use for several months
 210                         // we will just use it as a fallback test
 211                         // later we will be able to use it as the primary test of whether or not to relay.
 212
 213                         if (!$target_item['origin']) {
 214                                 $relay_to_owner = false;
 215                         }
 216                         if ($parent['origin']) {
 217                                 $relay_to_owner = false;
 218                         }
 219
 220                         // Special treatment for forum posts
 221                         if (self::isForumPost($target_item, $owner)) {
 222                                 $relay_to_owner = true;
 223                                 $direct_forum_delivery = true;
 224                         }
 225
 226                         // Avoid that comments in a forum thread are sent to OStatus
 227                         if (self::isForumPost($parent, $owner)) {
 228                                 $direct_forum_delivery = true;
 229                         }
 230
 231                         if ($relay_to_owner) {
 232                                 // local followup to remote post
 233                                 $followup = true;
 234                                 $public_message = false; // not public
 235                                 $conversant_str = DBA::escape($parent['contact-id']);
 236                                 $recipients = [$parent['contact-id']];
 237                                 $recipients_followup  = [$parent['contact-id']];
 238
 239                                 logger('notifier: followup '.$target_item["guid"].' to '.$conversant_str, LOGGER_DEBUG);
 240
 241                                 //if (!$target_item['private'] && $target_item['wall'] &&
 242                                 if (!$target_item['private'] &&
 243                                         (strlen($target_item['allow_cid'].$target_item['allow_gid'].
 244                                                 $target_item['deny_cid'].$target_item['deny_gid']) == 0))
 245                                         $push_notify = true;
 246
 247                                 if (($thr_parent && ($thr_parent['network'] == Protocol::OSTATUS)) || ($parent['network'] == Protocol::OSTATUS)) {
 248                                         $push_notify = true;
 249
 250                                         if ($parent["network"] == Protocol::OSTATUS) {
 251                                                 // Distribute the message to the DFRN contacts as if this wasn't a followup since OStatus can't relay comments
 252                                                 // Currently it is work at progress
 253                                                 $r = q("SELECT `id` FROM `contact` WHERE `uid` = %d AND `network` = '%s' AND NOT `blocked` AND NOT `pending` AND NOT `archive`",
 254                                                         intval($uid),
 255                                                         DBA::escape(Protocol::DFRN)
 256                                                 );
 257                                                 if (DBA::isResult($r)) {
 258                                                         foreach ($r as $rr) {
 259                                                                 $recipients_followup[] = $rr['id'];
 260                                                         }
 261                                                 }
 262                                         }
 263                                 }
 264
 265                                 if ($direct_forum_delivery) {
 266                                         $push_notify = false;
 267                                 }
 268
 269                                 logger("Notify ".$target_item["guid"]." via PuSH: ".($push_notify?"Yes":"No"), LOGGER_DEBUG);
 270                         } else {
 271                                 $followup = false;
 272
 273                                 logger('Distributing directly '.$target_item["guid"], LOGGER_DEBUG);
 274
 275                                 // don't send deletions onward for other people's stuff
 276
 277                                 if ($target_item['deleted'] && !intval($target_item['wall'])) {
 278                                         logger('notifier: ignoring delete notification for non-wall item');
 279                                         return;
 280                                 }
 281
 282                                 if (strlen($parent['allow_cid'])
 283                                         || strlen($parent['allow_gid'])
 284                                         || strlen($parent['deny_cid'])
 285                                         || strlen($parent['deny_gid'])) {
 286                                         $public_message = false; // private recipients, not public
 287                                 }
 288
 289                                 $allow_people = expand_acl($parent['allow_cid']);
 290                                 $allow_groups = Group::expand(expand_acl($parent['allow_gid']),true);
 291                                 $deny_people  = expand_acl($parent['deny_cid']);
 292                                 $deny_groups  = Group::expand(expand_acl($parent['deny_gid']));
 293
 294                                 // if our parent is a public forum (forum_mode == 1), uplink to the origional author causing
 295                                 // a delivery fork. private groups (forum_mode == 2) do not uplink
 296
 297                                 if ((intval($parent['forum_mode']) == 1) && !$top_level && ($cmd !== 'uplink')) {
 298                                         Worker::add($a->queue['priority'], 'Notifier', 'uplink', $item_id);
 299                                 }
 300
 301                                 foreach ($items as $item) {
 302                                         $recipients[] = $item['contact-id'];
 303                                         $conversants[] = $item['contact-id'];
 304                                         // pull out additional tagged people to notify (if public message)
 305                                         if ($public_message && strlen($item['inform'])) {
 306                                                 $people = explode(',',$item['inform']);
 307                                                 foreach ($people as $person) {
 308                                                         if (substr($person,0,4) === 'cid:') {
 309                                                                 $recipients[] = intval(substr($person,4));
 310                                                                 $conversants[] = intval(substr($person,4));
 311                                                         } else {
 312                                                                 $url_recipients[] = substr($person,4);
 313                                                         }
 314                                                 }
 315                                         }
 316                                 }
 317
 318                                 if (count($url_recipients)) {
 319                                         logger('notifier: '.$target_item["guid"].' url_recipients ' . print_r($url_recipients,true));
 320                                 }
 321
 322                                 $conversants = array_unique($conversants);
 323
 324                                 $recipients = array_unique(array_merge($recipients,$allow_people,$allow_groups));
 325                                 $deny = array_unique(array_merge($deny_people,$deny_groups));
 326                                 $recipients = array_diff($recipients,$deny);
 327
 328                                 $conversant_str = DBA::escape(implode(', ',$conversants));
 329                         }
 330
 331                         // If the thread parent is OStatus then do some magic to distribute the messages.
 332                         // We have not only to look at the parent, since it could be a Friendica thread.
 333                         if (($thr_parent && ($thr_parent['network'] == Protocol::OSTATUS)) || ($parent['network'] == Protocol::OSTATUS)) {
 334                                 $diaspora_delivery = false;
 335
 336                                 logger('Some parent is OStatus for '.$target_item["guid"]." - Author: ".$thr_parent['author-id']." - Owner: ".$thr_parent['owner-id'], LOGGER_DEBUG);
 337
 338                                 // Send a salmon to the parent author
 339                                 $probed_contact = DBA::selectFirst('contact', ['url', 'notify'], ['id' => $thr_parent['author-id']]);
 340                                 if (DBA::isResult($probed_contact) && !empty($probed_contact["notify"])) {
 341                                         logger('Notify parent author '.$probed_contact["url"].': '.$probed_contact["notify"]);
 342                                         $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
 343                                 }
 344
 345                                 // Send a salmon to the parent owner
 346                                 $probed_contact = DBA::selectFirst('contact', ['url', 'notify'], ['id' => $thr_parent['owner-id']]);
 347                                 if (DBA::isResult($probed_contact) && !empty($probed_contact["notify"])) {
 348                                         logger('Notify parent owner '.$probed_contact["url"].': '.$probed_contact["notify"]);
 349                                         $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
 350                                 }
 351
 352                                 // Send a salmon notification to every person we mentioned in the post
 353                                 $arr = explode(',',$target_item['tag']);
 354                                 foreach ($arr as $x) {
 355                                         //logger('Checking tag '.$x, LOGGER_DEBUG);
 356                                         $matches = null;
 357                                         if (preg_match('/@\[url=([^\]]*)\]/',$x,$matches)) {
 358                                                         $probed_contact = Probe::uri($matches[1]);
 359                                                 if ($probed_contact["notify"] != "") {
 360                                                         logger('Notify mentioned user '.$probed_contact["url"].': '.$probed_contact["notify"]);
 361                                                         $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
 362                                                 }
 363                                         }
 364                                 }
 365
 366                                 // It only makes sense to distribute answers to OStatus messages to Friendica and OStatus - but not Diaspora
 367                                 $networks = [Protocol::OSTATUS, Protocol::DFRN];
 368                         } else {
 369                                 $networks = [Protocol::OSTATUS, Protocol::DFRN, Protocol::DIASPORA, Protocol::MAIL];
 370                         }
 371                 } else {
 372                         $public_message = false;
 373                 }
 374
 375                 // If this is a public message and pubmail is set on the parent, include all your email contacts
 376                 if (!empty($target_item) && function_exists('imap_open') && !Config::get('system','imap_disabled')) {
 377                         if (!strlen($target_item['allow_cid']) && !strlen($target_item['allow_gid'])
 378                                 && !strlen($target_item['deny_cid']) && !strlen($target_item['deny_gid'])
 379                                 && intval($target_item['pubmail'])) {
 380                                 $r = q("SELECT `id` FROM `contact` WHERE `uid` = %d AND `network` = '%s'",
 381                                         intval($uid),
 382                                         DBA::escape(Protocol::MAIL)
 383                                 );
 384                                 if (DBA::isResult($r)) {
 385                                         foreach ($r as $rr) {
 386                                                 $recipients[] = $rr['id'];
 387                                         }
 388                                 }
 389                         }
 390                 }
 391
 392                 if (($cmd == Delivery::RELOCATION)) {
 393                         $r = $recipients_relocate;
 394                 } else {
 395                         if ($followup) {
 396                                 $recipients = $recipients_followup;
 397                         }
 398                         $condition = ['id' => $recipients, 'self' => false,
 399                                 'blocked' => false, 'pending' => false, 'archive' => false];
 400                         if (!empty($networks)) {
 401                                 $condition['network'] = $networks;
 402                         }
 403                         $contacts = DBA::select('contact', ['id', 'url', 'network'], $condition);
 404                         $r = DBA::toArray($contacts);
 405                 }
 406
 407                 // delivery loop
 408                 if (DBA::isResult($r)) {
 409                         foreach ($r as $contact) {
 410                                 logger("Deliver ".$item_id." to ".$contact['url']." via network ".$contact['network'], LOGGER_DEBUG);
 411
 412                                 Worker::add(['priority' => $a->queue['priority'], 'created' => $a->queue['created'], 'dont_fork' => true],
 413                                                 'Delivery', $cmd, $item_id, (int)$contact['id']);
 414                         }
 415                 }
 416
 417                 $inboxes = [];
 418
 419                 if ($followup) {
 420                         $profile = ActivityPub::fetchprofile($parent['author-link']);
 421                         if (!empty($profile)) {
 422                                 $target = defaults($profile, 'sharedinbox', $profile['inbox']);
 423                                 $inboxes[$target] = $target;
 424                         }
 425                 } else {
 426                         if ($target_item['origin']) {
 427                                 $inboxes = ActivityPub::fetchTargetInboxes($target_item);
 428                         }
 429
 430                         if ($parent['origin']) {
 431                                 $parent_inboxes = ActivityPub::fetchTargetInboxes($parent);
 432                                 $inboxes = array_merge($inboxes, $parent_inboxes);
 433                         }
 434                 }
 435
 436                 foreach ($inboxes as $inbox) {
 437                         logger('Deliver ' . $item_id .' to ' . $inbox .' via ActivityPub', LOGGER_DEBUG);
 438
 439                         Worker::add(['priority' => $a->queue['priority'], 'created' => $a->queue['created'], 'dont_fork' => true],
 440                                         'APDelivery', $cmd, $item_id, $inbox);
 441                 }
 442
 443                 // send salmon slaps to mentioned remote tags (@foo@example.com) in OStatus posts
 444                 // They are especially used for notifications to OStatus users that don't follow us.
 445                 if (!Config::get('system', 'dfrn_only') && count($url_recipients) && ($public_message || $push_notify) && $normal_mode) {
 446                         $slap = OStatus::salmon($target_item, $owner);
 447                         foreach ($url_recipients as $url) {
 448                                 if ($url) {
 449                                         logger('notifier: urldelivery: ' . $url);
 450                                         $deliver_status = Salmon::slapper($owner, $url, $slap);
 451                                         /// @TODO Redeliver/queue these items on failure, though there is no contact record
 452                                 }
 453                         }
 454                 }
 455
 456                 if ($public_message) {
 457                         $r1 = [];
 458
 459                         if ($diaspora_delivery) {
 460                                 $r1 = q("SELECT `batch`, ANY_VALUE(`id`) AS `id`, ANY_VALUE(`name`) AS `name`, ANY_VALUE(`network`) AS `network`
 461                                         FROM `contact` WHERE `network` = '%s' AND `batch` != ''
 462                                         AND `uid` = %d AND `rel` != %d AND NOT `blocked` AND NOT `pending` AND NOT `archive` GROUP BY `batch`",
 463                                         DBA::escape(Protocol::DIASPORA),
 464                                         intval($owner['uid']),
 465                                         intval(Contact::SHARING)
 466                                 );
 467
 468                                 // Fetch the participation list
 469                                 // The function will ensure that there are no duplicates
 470                                 $r1 = Diaspora::participantsForThread($item_id, $r1);
 471
 472                                 // Add the relay to the list, avoid duplicates
 473                                 if (!$followup) {
 474                                         $r1 = Diaspora::relayList($item_id, $r1);
 475                                 }
 476                         }
 477
 478                         $condition = ['network' => Protocol::DFRN, 'uid' => $owner['uid'], 'blocked' => false,
 479                                 'pending' => false, 'archive' => false, 'rel' => [Contact::FOLLOWER, Contact::FRIEND]];
 480
 481                         $r2 = DBA::toArray(DBA::select('contact', ['id', 'name', 'network'], $condition));
 482
 483                         $r = array_merge($r2, $r1);
 484
 485                         if (DBA::isResult($r)) {
 486                                 logger('pubdeliver '.$target_item["guid"].': '.print_r($r,true), LOGGER_DEBUG);
 487
 488                                 foreach ($r as $rr) {
 489                                         // except for Diaspora batch jobs
 490                                         // Don't deliver to folks who have already been delivered to
 491
 492                                         if (($rr['network'] !== Protocol::DIASPORA) && (in_array($rr['id'], $conversants))) {
 493                                                 logger('notifier: already delivered id=' . $rr['id']);
 494                                                 continue;
 495                                         }
 496
 497                                         if (!in_array($cmd, [Delivery::MAIL, Delivery::SUGGESTION]) && !$followup) {
 498                                                 logger('notifier: delivery agent: '.$rr['name'].' '.$rr['id'].' '.$rr['network'].' '.$target_item["guid"]);
 499                                                 Worker::add(['priority' => $a->queue['priority'], 'created' => $a->queue['created'], 'dont_fork' => true],
 500                                                                 'Delivery', $cmd, $item_id, (int)$rr['id']);
 501                                         }
 502                                 }
 503                         }
 504
 505                         $push_notify = true;
 506                 }
 507
 508                 // Notify PuSH subscribers (Used for OStatus distribution of regular posts)
 509                 if ($push_notify) {
 510                         logger('Activating internal PuSH for item '.$item_id, LOGGER_DEBUG);
 511
 512                         // Handling the pubsubhubbub requests
 513                         PushSubscriber::publishFeed($owner['uid'], $a->queue['priority']);
 514                 }
 515
 516                 logger('notifier: calling hooks for ' . $cmd . ' ' . $item_id, LOGGER_DEBUG);
 517
 518                 if ($normal_mode) {
 519                         Addon::forkHooks($a->queue['priority'], 'notifier_normal', $target_item);
 520                 }
 521
 522                 Addon::callHooks('notifier_end',$target_item);
 523
 524                 return;
 525         }
 526
 527         private static function isForumPost($item, $owner) {
 528                 if (($item['author-id'] == $item['owner-id']) ||
 529                         ($owner['id'] == $item['contact-id']) ||
 530                         ($item['uri'] != $item['parent-uri'])) {
 531                         return false;
 532                 }
 533
 534                 $fields = ['forum', 'prv'];
 535                 $condition = ['id' => $item['contact-id']];
 536                 $contact = DBA::selectFirst('contact', $fields, $condition);
 537                 if (!DBA::isResult($contact)) {
 538                         // Should never happen
 539                         return false;
 540                 }
 541
 542                 // Is the post from a forum?
 543                 return ($contact['forum'] || $contact['prv']);
 544         }
 545 }