3 * @file src/Worker/Notifier.php
5 namespace Friendica\Worker;
7 use Friendica\Core\Config;
8 use Friendica\Core\Worker;
9 use Friendica\Database\DBM;
10 use Friendica\Network\Probe;
11 use Friendica\Object\Contact;
12 use Friendica\Protocol\Diaspora;
13 use Friendica\Protocol\OStatus;
14 use Friendica\Protocol\Salmon;
17 require_once 'include/queue_fn.php';
18 require_once 'include/html2plain.php';
19 require_once 'include/datetime.php';
20 require_once 'include/items.php';
21 require_once 'include/bbcode.php';
24 * This file was at one time responsible for doing all deliveries, but this caused
25 * big problems when the process was killed or stalled during the delivery process.
26 * It now invokes separate queues that are delivering via delivery.php and pubsubpublish.php.
30 * The notifier is typically called with:
32 * Worker::add(PRIORITY_HIGH, "Notifier", COMMAND, ITEM_ID);
34 * where COMMAND is one of the following:
36 * activity (in diaspora.php, dfrn_confirm.php, profiles.php)
37 * comment-import (in diaspora.php, items.php)
38 * comment-new (in item.php)
39 * drop (in diaspora.php, items.php, photos.php)
40 * edit_post (in item.php)
41 * event (in events.php)
42 * expire (in items.php)
43 * like (in like.php, poke.php)
44 * mail (in message.php)
45 * suggest (in fsuggest.php)
46 * tag (in photos.php, poke.php, tagger.php)
47 * tgroup (in items.php)
48 * wall-new (in photos.php, item.php)
49 * removeme (in Contact.php)
50 * relocate (in uimport.php)
52 * and ITEM_ID is the id of the item in the database that needs to be sent to others.
56 public static function execute($cmd, $item_id) {
59 logger('notifier: invoked: '.$cmd.': '.$item_id, LOGGER_DEBUG);
66 $recipients = array();
67 $url_recipients = array();
71 if ($cmd === 'mail') {
74 $message = q("SELECT * FROM `mail` WHERE `id` = %d LIMIT 1",
77 if (! count($message)) {
80 $uid = $message[0]['uid'];
81 $recipients[] = $message[0]['contact-id'];
84 } elseif ($cmd === 'expire') {
87 $items = q("SELECT * FROM `item` WHERE `uid` = %d AND `wall` = 1
88 AND `deleted` = 1 AND `changed` > UTC_TIMESTAMP() - INTERVAL 10 MINUTE",
93 if (! count($items)) {
96 } elseif ($cmd === 'suggest') {
100 $suggest = q("SELECT * FROM `fsuggest` WHERE `id` = %d LIMIT 1",
103 if (! count($suggest)) {
106 $uid = $suggest[0]['uid'];
107 $recipients[] = $suggest[0]['cid'];
109 } elseif ($cmd === 'removeme') {
110 $r = q("SELECT `contact`.*, `user`.`prvkey` AS `uprvkey`,
111 `user`.`timezone`, `user`.`nickname`, `user`.`sprvkey`, `user`.`spubkey`,
112 `user`.`page-flags`, `user`.`prvnets`, `user`.`account-type`, `user`.`guid`
113 FROM `contact` INNER JOIN `user` ON `user`.`uid` = `contact`.`uid`
114 WHERE `contact`.`uid` = %d AND `contact`.`self` LIMIT 1",
121 $r = q("SELECT * FROM `contact` WHERE NOT `self` AND `uid` = %d", intval($item_id));
125 foreach ($r as $contact) {
126 Contact::terminateFriendship($user, $contact);
129 } elseif ($cmd === 'relocate') {
130 $normal_mode = false;
134 $recipients_relocate = q("SELECT * FROM `contact` WHERE `uid` = %d AND NOT `self` AND `network` IN ('%s', '%s')",
135 intval($uid), NETWORK_DFRN, NETWORK_DIASPORA);
138 $r = q("SELECT * FROM `item` WHERE `id` = %d AND visible = 1 AND moderated = 0 LIMIT 1",
142 if ((! DBM::is_result($r)) || (! intval($r[0]['parent']))) {
146 $target_item = $r[0];
147 $parent_id = intval($r[0]['parent']);
149 $updated = $r[0]['edited'];
151 $items = q("SELECT `item`.*, `sign`.`signed_text`,`sign`.`signature`,`sign`.`signer`
152 FROM `item` LEFT JOIN `sign` ON `sign`.`iid` = `item`.`id` WHERE `parent` = %d AND visible = 1 AND moderated = 0 ORDER BY `id` ASC",
156 if (! count($items)) {
160 // avoid race condition with deleting entries
162 if ($items[0]['deleted']) {
163 foreach ($items as $item) {
164 $item['deleted'] = 1;
168 if ((count($items) == 1) && ($items[0]['id'] === $target_item['id']) && ($items[0]['uri'] === $items[0]['parent-uri'])) {
169 logger('notifier: top level post');
175 $r = q("SELECT `contact`.*, `user`.`prvkey` AS `uprvkey`,
176 `user`.`timezone`, `user`.`nickname`, `user`.`sprvkey`, `user`.`spubkey`,
177 `user`.`page-flags`, `user`.`prvnets`, `user`.`account-type`
178 FROM `contact` INNER JOIN `user` ON `user`.`uid` = `contact`.`uid`
179 WHERE `contact`.`uid` = %d AND `contact`.`self` = 1 LIMIT 1",
183 if (! DBM::is_result($r)) {
189 $walltowall = ((($top_level) && ($owner['id'] != $items[0]['contact-id'])) ? true : false);
191 // Should the post be transmitted to Diaspora?
192 $diaspora_delivery = true;
194 // If this is a public conversation, notify the feed hub
195 $public_message = true;
198 $push_notify = false;
200 // Deliver directly to a forum, don't PuSH
201 $direct_forum_delivery = false;
203 // fill this in with a single salmon slap if applicable
206 if (! ($mail || $fsuggest || $relocate)) {
208 $slap = OStatus::salmon($target_item, $owner);
210 require_once 'include/group.php';
214 $thr_parent = q("SELECT `network`, `author-link`, `owner-link` FROM `item` WHERE `uri` = '%s' AND `uid` = %d",
215 dbesc($target_item["thr-parent"]), intval($target_item["uid"]));
217 logger('GUID: '.$target_item["guid"].': Parent is '.$parent['network'].'. Thread parent is '.$thr_parent[0]['network'], LOGGER_DEBUG);
219 // This is IMPORTANT!!!!
221 // We will only send a "notify owner to relay" or followup message if the referenced post
222 // originated on our system by virtue of having our hostname somewhere
223 // in the URI, AND it was a comment (not top_level) AND the parent originated elsewhere.
225 // if $parent['wall'] == 1 we will already have the parent message in our array
226 // and we will relay the whole lot.
228 // expire sends an entire group of expire messages and cannot be forwarded.
229 // However the conversation owner will be a part of the conversation and will
230 // be notified during this run.
231 // Other DFRN conversation members will be alerted during polled updates.
235 // Diaspora members currently are not notified of expirations, and other networks have
236 // either limited or no ability to process deletions. We should at least fix Diaspora
237 // by stringing togther an array of retractions and sending them onward.
240 $localhost = str_replace('www.','',$a->get_hostname());
241 if (strpos($localhost,':')) {
242 $localhost = substr($localhost,0,strpos($localhost,':'));
246 * Be VERY CAREFUL if you make any changes to the following several lines. Seemingly innocuous changes
247 * have been known to cause runaway conditions which affected several servers, along with
248 * permissions issues.
252 $relay_to_owner = false;
254 if (!$top_level && ($parent['wall'] == 0) && !$expire && (stristr($target_item['uri'],$localhost))) {
255 $relay_to_owner = true;
259 if (($cmd === 'uplink') && (intval($parent['forum_mode']) == 1) && !$top_level) {
260 $relay_to_owner = true;
263 // until the 'origin' flag has been in use for several months
264 // we will just use it as a fallback test
265 // later we will be able to use it as the primary test of whether or not to relay.
267 if (! $target_item['origin']) {
268 $relay_to_owner = false;
270 if ($parent['origin']) {
271 $relay_to_owner = false;
274 // Special treatment for forum posts
275 if (($target_item['author-link'] != $target_item['owner-link']) &&
276 ($owner['id'] != $target_item['contact-id']) &&
277 ($target_item['uri'] === $target_item['parent-uri'])) {
279 $fields = array('forum', 'prv');
280 $condition = array('id' => $target_item['contact-id']);
281 $contact = dba::select('contact', $fields, $condition, array('limit' => 1));
282 if (!DBM::is_result($contact)) {
283 // Should never happen
287 // Is the post from a forum?
288 if ($contact['forum'] || $contact['prv']) {
289 $relay_to_owner = true;
290 $direct_forum_delivery = true;
293 if ($relay_to_owner) {
294 logger('notifier: followup '.$target_item["guid"], LOGGER_DEBUG);
295 // local followup to remote post
297 $public_message = false; // not public
298 $conversant_str = dbesc($parent['contact-id']);
299 $recipients = array($parent['contact-id']);
300 $recipients_followup = array($parent['contact-id']);
302 //if (!$target_item['private'] && $target_item['wall'] &&
303 if (!$target_item['private'] &&
304 (strlen($target_item['allow_cid'].$target_item['allow_gid'].
305 $target_item['deny_cid'].$target_item['deny_gid']) == 0))
308 if (($thr_parent && ($thr_parent[0]['network'] == NETWORK_OSTATUS)) || ($parent['network'] == NETWORK_OSTATUS)) {
312 if ($parent["network"] == NETWORK_OSTATUS) {
313 // Distribute the message to the DFRN contacts as if this wasn't a followup since OStatus can't relay comments
314 // Currently it is work at progress
315 $r = q("SELECT `id` FROM `contact` WHERE `uid` = %d AND `network` = '%s' AND NOT `blocked` AND NOT `pending` AND NOT `archive`",
319 if (DBM::is_result($r)) {
320 foreach ($r as $rr) {
321 $recipients_followup[] = $rr['id'];
327 if ($direct_forum_delivery) {
328 $push_notify = false;
331 logger("Notify ".$target_item["guid"]." via PuSH: ".($push_notify?"Yes":"No"), LOGGER_DEBUG);
335 logger('Distributing directly '.$target_item["guid"], LOGGER_DEBUG);
337 // don't send deletions onward for other people's stuff
339 if ($target_item['deleted'] && (! intval($target_item['wall']))) {
340 logger('notifier: ignoring delete notification for non-wall item');
344 if ((strlen($parent['allow_cid']))
345 || (strlen($parent['allow_gid']))
346 || (strlen($parent['deny_cid']))
347 || (strlen($parent['deny_gid']))) {
348 $public_message = false; // private recipients, not public
351 $allow_people = expand_acl($parent['allow_cid']);
352 $allow_groups = expand_groups(expand_acl($parent['allow_gid']),true);
353 $deny_people = expand_acl($parent['deny_cid']);
354 $deny_groups = expand_groups(expand_acl($parent['deny_gid']));
356 // if our parent is a public forum (forum_mode == 1), uplink to the origional author causing
357 // a delivery fork. private groups (forum_mode == 2) do not uplink
359 if ((intval($parent['forum_mode']) == 1) && (! $top_level) && ($cmd !== 'uplink')) {
360 Worker::add($a->queue['priority'], 'Notifier', 'uplink', $item_id);
363 $conversants = array();
365 foreach ($items as $item) {
366 $recipients[] = $item['contact-id'];
367 $conversants[] = $item['contact-id'];
368 // pull out additional tagged people to notify (if public message)
369 if ($public_message && strlen($item['inform'])) {
370 $people = explode(',',$item['inform']);
371 foreach ($people as $person) {
372 if (substr($person,0,4) === 'cid:') {
373 $recipients[] = intval(substr($person,4));
374 $conversants[] = intval(substr($person,4));
376 $url_recipients[] = substr($person,4);
382 if (count($url_recipients))
383 logger('notifier: '.$target_item["guid"].' url_recipients ' . print_r($url_recipients,true));
385 $conversants = array_unique($conversants);
388 $recipients = array_unique(array_merge($recipients,$allow_people,$allow_groups));
389 $deny = array_unique(array_merge($deny_people,$deny_groups));
390 $recipients = array_diff($recipients,$deny);
392 $conversant_str = dbesc(implode(', ',$conversants));
395 // If the thread parent is OStatus then do some magic to distribute the messages.
396 // We have not only to look at the parent, since it could be a Friendica thread.
397 if (($thr_parent && ($thr_parent[0]['network'] == NETWORK_OSTATUS)) || ($parent['network'] == NETWORK_OSTATUS)) {
399 $diaspora_delivery = false;
401 logger('Some parent is OStatus for '.$target_item["guid"]." - Author: ".$thr_parent[0]['author-link']." - Owner: ".$thr_parent[0]['owner-link'], LOGGER_DEBUG);
403 // Send a salmon to the parent author
404 $r = q("SELECT `url`, `notify` FROM `contact` WHERE `nurl`='%s' AND `uid` IN (0, %d) AND `notify` != ''",
405 dbesc(normalise_link($thr_parent[0]['author-link'])),
407 if (DBM::is_result($r)) {
408 $probed_contact = $r[0];
410 $probed_contact = Probe::uri($thr_parent[0]['author-link']);
413 if ($probed_contact["notify"] != "") {
414 logger('Notify parent author '.$probed_contact["url"].': '.$probed_contact["notify"]);
415 $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
418 // Send a salmon to the parent owner
419 $r = q("SELECT `url`, `notify` FROM `contact` WHERE `nurl`='%s' AND `uid` IN (0, %d) AND `notify` != ''",
420 dbesc(normalise_link($thr_parent[0]['owner-link'])),
422 if (DBM::is_result($r)) {
423 $probed_contact = $r[0];
425 $probed_contact = Probe::uri($thr_parent[0]['owner-link']);
428 if ($probed_contact["notify"] != "") {
429 logger('Notify parent owner '.$probed_contact["url"].': '.$probed_contact["notify"]);
430 $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
433 // Send a salmon notification to every person we mentioned in the post
434 $arr = explode(',',$target_item['tag']);
435 foreach ($arr as $x) {
436 //logger('Checking tag '.$x, LOGGER_DEBUG);
438 if (preg_match('/@\[url=([^\]]*)\]/',$x,$matches)) {
439 $probed_contact = Probe::uri($matches[1]);
440 if ($probed_contact["notify"] != "") {
441 logger('Notify mentioned user '.$probed_contact["url"].': '.$probed_contact["notify"]);
442 $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
447 // It only makes sense to distribute answers to OStatus messages to Friendica and OStatus - but not Diaspora
448 $sql_extra = " AND `network` IN ('".NETWORK_OSTATUS."', '".NETWORK_DFRN."')";
450 $sql_extra = " AND `network` IN ('".NETWORK_OSTATUS."', '".NETWORK_DFRN."', '".NETWORK_DIASPORA."', '".NETWORK_MAIL."')";
453 $public_message = false;
456 // If this is a public message and pubmail is set on the parent, include all your email contacts
458 $mail_disabled = ((function_exists('imap_open') && (!Config::get('system','imap_disabled'))) ? 0 : 1);
460 if (! $mail_disabled) {
461 if ((! strlen($target_item['allow_cid'])) && (! strlen($target_item['allow_gid']))
462 && (! strlen($target_item['deny_cid'])) && (! strlen($target_item['deny_gid']))
463 && (intval($target_item['pubmail']))) {
464 $r = q("SELECT `id` FROM `contact` WHERE `uid` = %d AND `network` = '%s'",
468 if (DBM::is_result($r)) {
469 foreach ($r as $rr) {
470 $recipients[] = $rr['id'];
477 $recip_str = implode(', ', $recipients_followup);
479 $recip_str = implode(', ', $recipients);
482 $r = $recipients_relocate;
484 $r = q("SELECT `id`, `url`, `network`, `self` FROM `contact`
485 WHERE `id` IN (%s) AND NOT `blocked` AND NOT `pending` AND NOT `archive`".$sql_extra,
492 if (DBM::is_result($r)) {
493 foreach ($r as $contact) {
494 if ($contact['self']) {
497 logger("Deliver ".$target_item["guid"]." to ".$contact['url']." via network ".$contact['network'], LOGGER_DEBUG);
499 Worker::add(array('priority' => $a->queue['priority'], 'created' => $a->queue['created'], 'dont_fork' => true),
500 'Delivery', $cmd, $item_id, (int)$contact['id']);
504 // send salmon slaps to mentioned remote tags (@foo@example.com) in OStatus posts
505 // They are especially used for notifications to OStatus users that don't follow us.
507 if ($slap && count($url_recipients) && ($public_message || $push_notify) && $normal_mode) {
508 if (!Config::get('system', 'dfrn_only')) {
509 foreach ($url_recipients as $url) {
511 logger('notifier: urldelivery: ' . $url);
512 $deliver_status = Salmon::slapper($owner, $url, $slap);
513 /// @TODO Redeliver/queue these items on failure, though there is no contact record
520 if ($public_message) {
525 if ($diaspora_delivery) {
527 $r0 = Diaspora::relayList();
530 $r1 = q("SELECT `batch`, ANY_VALUE(`id`) AS `id`, ANY_VALUE(`name`) AS `name`, ANY_VALUE(`network`) AS `network`
531 FROM `contact` WHERE `network` = '%s' AND `batch` != ''
532 AND `uid` = %d AND `rel` != %d AND NOT `blocked` AND NOT `pending` AND NOT `archive` GROUP BY `batch`",
533 dbesc(NETWORK_DIASPORA),
534 intval($owner['uid']),
535 intval(CONTACT_IS_SHARING)
539 $r2 = q("SELECT `id`, `name`,`network` FROM `contact`
540 WHERE `network` in ('%s') AND `uid` = %d AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND `rel` != %d",
542 intval($owner['uid']),
543 intval(CONTACT_IS_SHARING)
546 $r = array_merge($r2,$r1,$r0);
548 if (DBM::is_result($r)) {
549 logger('pubdeliver '.$target_item["guid"].': '.print_r($r,true), LOGGER_DEBUG);
551 foreach ($r as $rr) {
553 // except for Diaspora batch jobs
554 // Don't deliver to folks who have already been delivered to
556 if (($rr['network'] !== NETWORK_DIASPORA) && (in_array($rr['id'],$conversants))) {
557 logger('notifier: already delivered id=' . $rr['id']);
561 if ((! $mail) && (! $fsuggest) && (! $followup)) {
562 logger('notifier: delivery agent: '.$rr['name'].' '.$rr['id'].' '.$rr['network'].' '.$target_item["guid"]);
563 Worker::add(array('priority' => $a->queue['priority'], 'created' => $a->queue['created'], 'dont_fork' => true),
564 'Delivery', $cmd, $item_id, (int)$rr['id']);
573 // Notify PuSH subscribers (Used for OStatus distribution of regular posts)
575 // Set push flag for PuSH subscribers to this topic,
576 // they will be notified in queue.php
577 q("UPDATE `push_subscriber` SET `push` = 1 ".
578 "WHERE `nickname` = '%s' AND `push` = 0", dbesc($owner['nickname']));
580 logger('Activating internal PuSH for item '.$item_id, LOGGER_DEBUG);
582 // Handling the pubsubhubbub requests
583 Worker::add(array('priority' => PRIORITY_HIGH, 'created' => $a->queue['created'], 'dont_fork' => true),
587 logger('notifier: calling hooks', LOGGER_DEBUG);
590 call_hooks('notifier_normal',$target_item);
593 call_hooks('notifier_end',$target_item);