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