3 * @file src/Worker/Notifier.php
5 namespace Friendica\Worker;
8 use Friendica\Core\Config;
9 use Friendica\Core\Worker;
10 use Friendica\Database\DBM;
11 use Friendica\Network\Probe;
12 use Friendica\Object\Contact;
13 use Friendica\Protocol\Diaspora;
14 use Friendica\Protocol\OStatus;
17 require_once 'include/queue_fn.php';
18 require_once 'include/html2plain.php';
19 require_once 'include/salmon.php';
20 require_once 'include/datetime.php';
21 require_once 'include/items.php';
22 require_once 'include/bbcode.php';
23 require_once 'include/email.php';
26 * This file was at one time responsible for doing all deliveries, but this caused
27 * big problems when the process was killed or stalled during the delivery process.
28 * It now invokes separate queues that are delivering via delivery.php and pubsubpublish.php.
32 * The notifier is typically called with:
34 * Worker::add(PRIORITY_HIGH, "Notifier", COMMAND, ITEM_ID);
36 * where COMMAND is one of the following:
38 * activity (in diaspora.php, dfrn_confirm.php, profiles.php)
39 * comment-import (in diaspora.php, items.php)
40 * comment-new (in item.php)
41 * drop (in diaspora.php, items.php, photos.php)
42 * edit_post (in item.php)
43 * event (in events.php)
44 * expire (in items.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)
54 * and ITEM_ID is the id of the item in the database that needs to be sent to others.
58 public static function execute($cmd, $item_id) {
61 logger('notifier: invoked: '.$cmd.': '.$item_id, LOGGER_DEBUG);
68 $recipients = array();
69 $url_recipients = array();
73 if ($cmd === 'mail') {
76 $message = q("SELECT * FROM `mail` WHERE `id` = %d LIMIT 1",
79 if (! count($message)) {
82 $uid = $message[0]['uid'];
83 $recipients[] = $message[0]['contact-id'];
86 } elseif ($cmd === 'expire') {
89 $items = q("SELECT * FROM `item` WHERE `uid` = %d AND `wall` = 1
90 AND `deleted` = 1 AND `changed` > UTC_TIMESTAMP() - INTERVAL 10 MINUTE",
95 if (! count($items)) {
98 } elseif ($cmd === 'suggest') {
102 $suggest = q("SELECT * FROM `fsuggest` WHERE `id` = %d LIMIT 1",
105 if (! count($suggest)) {
108 $uid = $suggest[0]['uid'];
109 $recipients[] = $suggest[0]['cid'];
111 } elseif ($cmd === 'removeme') {
112 $r = q("SELECT `contact`.*, `user`.`pubkey` AS `upubkey`, `user`.`prvkey` AS `uprvkey`,
113 `user`.`timezone`, `user`.`nickname`, `user`.`sprvkey`, `user`.`spubkey`,
114 `user`.`page-flags`, `user`.`prvnets`, `user`.`account-type`, `user`.`guid`
115 FROM `contact` INNER JOIN `user` ON `user`.`uid` = `contact`.`uid`
116 WHERE `contact`.`uid` = %d AND `contact`.`self` LIMIT 1",
123 $r = q("SELECT * FROM `contact` WHERE NOT `self` AND `uid` = %d", intval($item_id));
127 require_once 'include/Contact.php';
128 foreach ($r as $contact) {
129 Contact::terminateFriendship($user, $contact);
132 } elseif ($cmd === 'relocate') {
133 $normal_mode = false;
137 $recipients_relocate = q("SELECT * FROM `contact` WHERE `uid` = %d AND NOT `self` AND `network` IN ('%s', '%s')",
138 intval($uid), NETWORK_DFRN, NETWORK_DIASPORA);
141 $r = q("SELECT * FROM `item` WHERE `id` = %d AND visible = 1 AND moderated = 0 LIMIT 1",
145 if ((! DBM::is_result($r)) || (! intval($r[0]['parent']))) {
149 $target_item = $r[0];
150 $parent_id = intval($r[0]['parent']);
152 $updated = $r[0]['edited'];
154 $items = q("SELECT `item`.*, `sign`.`signed_text`,`sign`.`signature`,`sign`.`signer`
155 FROM `item` LEFT JOIN `sign` ON `sign`.`iid` = `item`.`id` WHERE `parent` = %d AND visible = 1 AND moderated = 0 ORDER BY `id` ASC",
159 if (! count($items)) {
163 // avoid race condition with deleting entries
165 if ($items[0]['deleted']) {
166 foreach ($items as $item) {
167 $item['deleted'] = 1;
171 if ((count($items) == 1) && ($items[0]['id'] === $target_item['id']) && ($items[0]['uri'] === $items[0]['parent-uri'])) {
172 logger('notifier: top level post');
178 $r = q("SELECT `contact`.*, `user`.`pubkey` AS `upubkey`, `user`.`prvkey` AS `uprvkey`,
179 `user`.`timezone`, `user`.`nickname`, `user`.`sprvkey`, `user`.`spubkey`,
180 `user`.`page-flags`, `user`.`prvnets`, `user`.`account-type`
181 FROM `contact` INNER JOIN `user` ON `user`.`uid` = `contact`.`uid`
182 WHERE `contact`.`uid` = %d AND `contact`.`self` = 1 LIMIT 1",
186 if (! DBM::is_result($r)) {
192 $walltowall = ((($top_level) && ($owner['id'] != $items[0]['contact-id'])) ? true : false);
194 // Should the post be transmitted to Diaspora?
195 $diaspora_delivery = true;
197 // If this is a public conversation, notify the feed hub
198 $public_message = true;
201 $push_notify = false;
203 // Deliver directly to a forum, don't PuSH
204 $direct_forum_delivery = false;
206 // fill this in with a single salmon slap if applicable
209 if (! ($mail || $fsuggest || $relocate)) {
211 $slap = OStatus::salmon($target_item, $owner);
213 require_once 'include/group.php';
217 $thr_parent = q("SELECT `network`, `author-link`, `owner-link` FROM `item` WHERE `uri` = '%s' AND `uid` = %d",
218 dbesc($target_item["thr-parent"]), intval($target_item["uid"]));
220 logger('GUID: '.$target_item["guid"].': Parent is '.$parent['network'].'. Thread parent is '.$thr_parent[0]['network'], LOGGER_DEBUG);
222 // This is IMPORTANT!!!!
224 // We will only send a "notify owner to relay" or followup message if the referenced post
225 // originated on our system by virtue of having our hostname somewhere
226 // in the URI, AND it was a comment (not top_level) AND the parent originated elsewhere.
228 // if $parent['wall'] == 1 we will already have the parent message in our array
229 // and we will relay the whole lot.
231 // expire sends an entire group of expire messages and cannot be forwarded.
232 // However the conversation owner will be a part of the conversation and will
233 // be notified during this run.
234 // Other DFRN conversation members will be alerted during polled updates.
238 // Diaspora members currently are not notified of expirations, and other networks have
239 // either limited or no ability to process deletions. We should at least fix Diaspora
240 // by stringing togther an array of retractions and sending them onward.
243 $localhost = str_replace('www.','',$a->get_hostname());
244 if (strpos($localhost,':')) {
245 $localhost = substr($localhost,0,strpos($localhost,':'));
249 * Be VERY CAREFUL if you make any changes to the following several lines. Seemingly innocuous changes
250 * have been known to cause runaway conditions which affected several servers, along with
251 * permissions issues.
255 $relay_to_owner = false;
257 if (!$top_level && ($parent['wall'] == 0) && !$expire && (stristr($target_item['uri'],$localhost))) {
258 $relay_to_owner = true;
262 if (($cmd === 'uplink') && (intval($parent['forum_mode']) == 1) && !$top_level) {
263 $relay_to_owner = true;
266 // until the 'origin' flag has been in use for several months
267 // we will just use it as a fallback test
268 // later we will be able to use it as the primary test of whether or not to relay.
270 if (! $target_item['origin']) {
271 $relay_to_owner = false;
273 if ($parent['origin']) {
274 $relay_to_owner = false;
277 // Special treatment for forum posts
278 if (($target_item['author-link'] != $target_item['owner-link']) &&
279 ($owner['id'] != $target_item['contact-id']) &&
280 ($target_item['uri'] === $target_item['parent-uri'])) {
282 $fields = array('forum', 'prv');
283 $condition = array('id' => $target_item['contact-id']);
284 $contact = dba::select('contact', $fields, $condition, array('limit' => 1));
285 if (!DBM::is_result($contact)) {
286 // Should never happen
290 // Is the post from a forum?
291 if ($contact['forum'] || $contact['prv']) {
292 $relay_to_owner = true;
293 $direct_forum_delivery = true;
296 if ($relay_to_owner) {
297 logger('notifier: followup '.$target_item["guid"], LOGGER_DEBUG);
298 // local followup to remote post
300 $public_message = false; // not public
301 $conversant_str = dbesc($parent['contact-id']);
302 $recipients = array($parent['contact-id']);
303 $recipients_followup = array($parent['contact-id']);
305 //if (!$target_item['private'] && $target_item['wall'] &&
306 if (!$target_item['private'] &&
307 (strlen($target_item['allow_cid'].$target_item['allow_gid'].
308 $target_item['deny_cid'].$target_item['deny_gid']) == 0))
311 if (($thr_parent && ($thr_parent[0]['network'] == NETWORK_OSTATUS)) || ($parent['network'] == NETWORK_OSTATUS)) {
315 if ($parent["network"] == NETWORK_OSTATUS) {
316 // Distribute the message to the DFRN contacts as if this wasn't a followup since OStatus can't relay comments
317 // Currently it is work at progress
318 $r = q("SELECT `id` FROM `contact` WHERE `uid` = %d AND `network` = '%s' AND NOT `blocked` AND NOT `pending` AND NOT `archive`",
322 if (DBM::is_result($r)) {
323 foreach ($r as $rr) {
324 $recipients_followup[] = $rr['id'];
330 if ($direct_forum_delivery) {
331 $push_notify = false;
334 logger("Notify ".$target_item["guid"]." via PuSH: ".($push_notify?"Yes":"No"), LOGGER_DEBUG);
338 logger('Distributing directly '.$target_item["guid"], LOGGER_DEBUG);
340 // don't send deletions onward for other people's stuff
342 if ($target_item['deleted'] && (! intval($target_item['wall']))) {
343 logger('notifier: ignoring delete notification for non-wall item');
347 if ((strlen($parent['allow_cid']))
348 || (strlen($parent['allow_gid']))
349 || (strlen($parent['deny_cid']))
350 || (strlen($parent['deny_gid']))) {
351 $public_message = false; // private recipients, not public
354 $allow_people = expand_acl($parent['allow_cid']);
355 $allow_groups = expand_groups(expand_acl($parent['allow_gid']),true);
356 $deny_people = expand_acl($parent['deny_cid']);
357 $deny_groups = expand_groups(expand_acl($parent['deny_gid']));
359 // if our parent is a public forum (forum_mode == 1), uplink to the origional author causing
360 // a delivery fork. private groups (forum_mode == 2) do not uplink
362 if ((intval($parent['forum_mode']) == 1) && (! $top_level) && ($cmd !== 'uplink')) {
363 Worker::add($a->queue['priority'], 'Notifier', 'uplink', $item_id);
366 $conversants = array();
368 foreach ($items as $item) {
369 $recipients[] = $item['contact-id'];
370 $conversants[] = $item['contact-id'];
371 // pull out additional tagged people to notify (if public message)
372 if ($public_message && strlen($item['inform'])) {
373 $people = explode(',',$item['inform']);
374 foreach ($people as $person) {
375 if (substr($person,0,4) === 'cid:') {
376 $recipients[] = intval(substr($person,4));
377 $conversants[] = intval(substr($person,4));
379 $url_recipients[] = substr($person,4);
385 if (count($url_recipients))
386 logger('notifier: '.$target_item["guid"].' url_recipients ' . print_r($url_recipients,true));
388 $conversants = array_unique($conversants);
391 $recipients = array_unique(array_merge($recipients,$allow_people,$allow_groups));
392 $deny = array_unique(array_merge($deny_people,$deny_groups));
393 $recipients = array_diff($recipients,$deny);
395 $conversant_str = dbesc(implode(', ',$conversants));
398 // If the thread parent is OStatus then do some magic to distribute the messages.
399 // We have not only to look at the parent, since it could be a Friendica thread.
400 if (($thr_parent && ($thr_parent[0]['network'] == NETWORK_OSTATUS)) || ($parent['network'] == NETWORK_OSTATUS)) {
402 $diaspora_delivery = false;
404 logger('Some parent is OStatus for '.$target_item["guid"]." - Author: ".$thr_parent[0]['author-link']." - Owner: ".$thr_parent[0]['owner-link'], LOGGER_DEBUG);
406 // Send a salmon to the parent author
407 $r = q("SELECT `url`, `notify` FROM `contact` WHERE `nurl`='%s' AND `uid` IN (0, %d) AND `notify` != ''",
408 dbesc(normalise_link($thr_parent[0]['author-link'])),
410 if (DBM::is_result($r)) {
411 $probed_contact = $r[0];
413 $probed_contact = Probe::uri($thr_parent[0]['author-link']);
416 if ($probed_contact["notify"] != "") {
417 logger('Notify parent author '.$probed_contact["url"].': '.$probed_contact["notify"]);
418 $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
421 // Send a salmon to the parent owner
422 $r = q("SELECT `url`, `notify` FROM `contact` WHERE `nurl`='%s' AND `uid` IN (0, %d) AND `notify` != ''",
423 dbesc(normalise_link($thr_parent[0]['owner-link'])),
425 if (DBM::is_result($r)) {
426 $probed_contact = $r[0];
428 $probed_contact = Probe::uri($thr_parent[0]['owner-link']);
431 if ($probed_contact["notify"] != "") {
432 logger('Notify parent owner '.$probed_contact["url"].': '.$probed_contact["notify"]);
433 $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
436 // Send a salmon notification to every person we mentioned in the post
437 $arr = explode(',',$target_item['tag']);
438 foreach ($arr as $x) {
439 //logger('Checking tag '.$x, LOGGER_DEBUG);
441 if (preg_match('/@\[url=([^\]]*)\]/',$x,$matches)) {
442 $probed_contact = Probe::uri($matches[1]);
443 if ($probed_contact["notify"] != "") {
444 logger('Notify mentioned user '.$probed_contact["url"].': '.$probed_contact["notify"]);
445 $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
450 // It only makes sense to distribute answers to OStatus messages to Friendica and OStatus - but not Diaspora
451 $sql_extra = " AND `network` IN ('".NETWORK_OSTATUS."', '".NETWORK_DFRN."')";
453 $sql_extra = " AND `network` IN ('".NETWORK_OSTATUS."', '".NETWORK_DFRN."', '".NETWORK_DIASPORA."', '".NETWORK_MAIL."', '".NETWORK_MAIL2."')";
456 $public_message = false;
459 // If this is a public message and pubmail is set on the parent, include all your email contacts
461 $mail_disabled = ((function_exists('imap_open') && (!Config::get('system','imap_disabled'))) ? 0 : 1);
463 if (! $mail_disabled) {
464 if ((! strlen($target_item['allow_cid'])) && (! strlen($target_item['allow_gid']))
465 && (! strlen($target_item['deny_cid'])) && (! strlen($target_item['deny_gid']))
466 && (intval($target_item['pubmail']))) {
467 $r = q("SELECT `id` FROM `contact` WHERE `uid` = %d AND `network` = '%s'",
471 if (DBM::is_result($r)) {
472 foreach ($r as $rr) {
473 $recipients[] = $rr['id'];
480 $recip_str = implode(', ', $recipients_followup);
482 $recip_str = implode(', ', $recipients);
485 $r = $recipients_relocate;
487 $r = q("SELECT `id`, `url`, `network`, `self` FROM `contact`
488 WHERE `id` IN (%s) AND NOT `blocked` AND NOT `pending` AND NOT `archive`".$sql_extra,
495 if (DBM::is_result($r)) {
496 foreach ($r as $contact) {
497 if ($contact['self']) {
500 logger("Deliver ".$target_item["guid"]." to ".$contact['url']." via network ".$contact['network'], LOGGER_DEBUG);
502 Worker::add(array('priority' => $a->queue['priority'], 'created' => $a->queue['created'], 'dont_fork' => true),
503 'Delivery', $cmd, $item_id, (int)$contact['id']);
507 // send salmon slaps to mentioned remote tags (@foo@example.com) in OStatus posts
508 // They are especially used for notifications to OStatus users that don't follow us.
510 if ($slap && count($url_recipients) && ($public_message || $push_notify) && $normal_mode) {
511 if (!Config::get('system','dfrn_only')) {
512 foreach ($url_recipients as $url) {
514 logger('notifier: urldelivery: ' . $url);
515 $deliver_status = slapper($owner,$url,$slap);
516 /// @TODO Redeliver/queue these items on failure, though there is no contact record
523 if ($public_message) {
528 if ($diaspora_delivery) {
530 $r0 = Diaspora::relay_list();
533 $r1 = q("SELECT `batch`, ANY_VALUE(`id`) AS `id`, ANY_VALUE(`name`) AS `name`, ANY_VALUE(`network`) AS `network`
534 FROM `contact` WHERE `network` = '%s' AND `batch` != ''
535 AND `uid` = %d AND `rel` != %d AND NOT `blocked` AND NOT `pending` AND NOT `archive` GROUP BY `batch`",
536 dbesc(NETWORK_DIASPORA),
537 intval($owner['uid']),
538 intval(CONTACT_IS_SHARING)
542 $r2 = q("SELECT `id`, `name`,`network` FROM `contact`
543 WHERE `network` in ('%s', '%s') AND `uid` = %d AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND `rel` != %d",
545 dbesc(NETWORK_MAIL2),
546 intval($owner['uid']),
547 intval(CONTACT_IS_SHARING)
550 $r = array_merge($r2,$r1,$r0);
552 if (DBM::is_result($r)) {
553 logger('pubdeliver '.$target_item["guid"].': '.print_r($r,true), LOGGER_DEBUG);
555 foreach ($r as $rr) {
557 // except for Diaspora batch jobs
558 // Don't deliver to folks who have already been delivered to
560 if (($rr['network'] !== NETWORK_DIASPORA) && (in_array($rr['id'],$conversants))) {
561 logger('notifier: already delivered id=' . $rr['id']);
565 if ((! $mail) && (! $fsuggest) && (! $followup)) {
566 logger('notifier: delivery agent: '.$rr['name'].' '.$rr['id'].' '.$rr['network'].' '.$target_item["guid"]);
567 Worker::add(array('priority' => $a->queue['priority'], 'created' => $a->queue['created'], 'dont_fork' => true),
568 'Delivery', $cmd, $item_id, (int)$rr['id']);
577 // Notify PuSH subscribers (Used for OStatus distribution of regular posts)
579 // Set push flag for PuSH subscribers to this topic,
580 // they will be notified in queue.php
581 q("UPDATE `push_subscriber` SET `push` = 1 ".
582 "WHERE `nickname` = '%s' AND `push` = 0", dbesc($owner['nickname']));
584 logger('Activating internal PuSH for item '.$item_id, LOGGER_DEBUG);
586 // Handling the pubsubhubbub requests
587 Worker::add(array('priority' => PRIORITY_HIGH, 'created' => $a->queue['created'], 'dont_fork' => true),
591 logger('notifier: calling hooks', LOGGER_DEBUG);
594 call_hooks('notifier_normal',$target_item);
597 call_hooks('notifier_end',$target_item);