3 * @file src/Worker/Notifier.php
5 namespace Friendica\Worker;
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;
20 require_once 'include/dba.php';
21 require_once 'include/html2plain.php';
22 require_once 'include/items.php';
23 require_once 'include/bbcode.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 * like (in like.php, poke.php)
45 * mail (in message.php)
46 * suggest (in fsuggest.php)
47 * tag (in photos.php, poke.php, tagger.php)
48 * tgroup (in items.php)
49 * wall-new (in photos.php, item.php)
50 * removeme (in Contact.php)
51 * relocate (in uimport.php)
53 * and ITEM_ID is the id of the item in the database that needs to be sent to others.
57 public static function execute($cmd, $item_id) {
60 logger('notifier: invoked: '.$cmd.': '.$item_id, LOGGER_DEBUG);
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'];
83 } elseif ($cmd === 'suggest') {
87 $suggest = q("SELECT * FROM `fsuggest` WHERE `id` = %d LIMIT 1",
90 if (!count($suggest)) {
93 $uid = $suggest[0]['uid'];
94 $recipients[] = $suggest[0]['cid'];
96 } elseif ($cmd === 'removeme') {
97 $r = q("SELECT `contact`.*, `user`.`prvkey` AS `uprvkey`,
98 `user`.`timezone`, `user`.`nickname`, `user`.`sprvkey`, `user`.`spubkey`,
99 `user`.`page-flags`, `user`.`prvnets`, `user`.`account-type`, `user`.`guid`
100 FROM `contact` INNER JOIN `user` ON `user`.`uid` = `contact`.`uid`
101 WHERE `contact`.`uid` = %d AND `contact`.`self` LIMIT 1",
108 $r = q("SELECT * FROM `contact` WHERE NOT `self` AND `uid` = %d", intval($item_id));
112 foreach ($r as $contact) {
113 Contact::terminateFriendship($user, $contact);
116 } elseif ($cmd === 'relocate') {
117 $normal_mode = false;
121 $recipients_relocate = q("SELECT * FROM `contact` WHERE `uid` = %d AND NOT `self` AND `network` IN ('%s', '%s')",
122 intval($uid), NETWORK_DFRN, NETWORK_DIASPORA);
125 $target_item = dba::fetch_first("SELECT `item`.*, `contact`.`uid` AS `cuid` FROM `item`
126 INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id`
127 WHERE `item`.`id` = ? AND `visible` AND NOT `moderated`", $item_id);
129 if (!DBM::is_result($target_item) || !intval($target_item['parent'])) {
133 $parent_id = intval($target_item['parent']);
134 $uid = $target_item['cuid'];
135 $updated = $target_item['edited'];
137 $items = q("SELECT `item`.*, `sign`.`signed_text`,`sign`.`signature`,`sign`.`signer`
138 FROM `item` LEFT JOIN `sign` ON `sign`.`iid` = `item`.`id` WHERE `parent` = %d AND visible AND NOT moderated ORDER BY `id` ASC",
142 if (!count($items)) {
146 // avoid race condition with deleting entries
147 if ($items[0]['deleted']) {
148 foreach ($items as $item) {
149 $item['deleted'] = 1;
153 if ((count($items) == 1) && ($items[0]['id'] === $target_item['id']) && ($items[0]['uri'] === $items[0]['parent-uri'])) {
154 logger('notifier: top level post');
159 $owner = User::getOwnerDataById($uid);
164 $walltowall = ($top_level && ($owner['id'] != $items[0]['contact-id']) ? true : false);
166 // Should the post be transmitted to Diaspora?
167 $diaspora_delivery = true;
169 // If this is a public conversation, notify the feed hub
170 $public_message = true;
173 $push_notify = false;
175 // Deliver directly to a forum, don't PuSH
176 $direct_forum_delivery = false;
178 // fill this in with a single salmon slap if applicable
181 if (! ($mail || $fsuggest || $relocate)) {
183 $slap = OStatus::salmon($target_item, $owner);
187 $thr_parent = q("SELECT `network`, `author-link`, `owner-link` FROM `item` WHERE `uri` = '%s' AND `uid` = %d",
188 dbesc($target_item["thr-parent"]), intval($target_item["uid"]));
190 logger('GUID: '.$target_item["guid"].': Parent is '.$parent['network'].'. Thread parent is '.$thr_parent[0]['network'], LOGGER_DEBUG);
192 // This is IMPORTANT!!!!
194 // We will only send a "notify owner to relay" or followup message if the referenced post
195 // originated on our system by virtue of having our hostname somewhere
196 // in the URI, AND it was a comment (not top_level) AND the parent originated elsewhere.
198 // if $parent['wall'] == 1 we will already have the parent message in our array
199 // and we will relay the whole lot.
201 $localhost = str_replace('www.','',$a->get_hostname());
202 if (strpos($localhost,':')) {
203 $localhost = substr($localhost,0,strpos($localhost,':'));
207 * Be VERY CAREFUL if you make any changes to the following several lines. Seemingly innocuous changes
208 * have been known to cause runaway conditions which affected several servers, along with
209 * permissions issues.
213 $relay_to_owner = false;
215 if (!$top_level && ($parent['wall'] == 0) && (stristr($target_item['uri'],$localhost))) {
216 $relay_to_owner = true;
220 if (($cmd === 'uplink') && (intval($parent['forum_mode']) == 1) && !$top_level) {
221 $relay_to_owner = true;
224 // until the 'origin' flag has been in use for several months
225 // we will just use it as a fallback test
226 // later we will be able to use it as the primary test of whether or not to relay.
228 if (!$target_item['origin']) {
229 $relay_to_owner = false;
231 if ($parent['origin']) {
232 $relay_to_owner = false;
235 // Special treatment for forum posts
236 if (($target_item['author-link'] != $target_item['owner-link']) &&
237 ($owner['id'] != $target_item['contact-id']) &&
238 ($target_item['uri'] === $target_item['parent-uri'])) {
240 $fields = ['forum', 'prv'];
241 $condition = ['id' => $target_item['contact-id']];
242 $contact = dba::selectFirst('contact', $fields, $condition);
243 if (!DBM::is_result($contact)) {
244 // Should never happen
248 // Is the post from a forum?
249 if ($contact['forum'] || $contact['prv']) {
250 $relay_to_owner = true;
251 $direct_forum_delivery = true;
254 if ($relay_to_owner) {
255 // local followup to remote post
257 $public_message = false; // not public
258 $conversant_str = dbesc($parent['contact-id']);
259 $recipients = [$parent['contact-id']];
260 $recipients_followup = [$parent['contact-id']];
262 logger('notifier: followup '.$target_item["guid"].' to '.$conversant_str, LOGGER_DEBUG);
264 //if (!$target_item['private'] && $target_item['wall'] &&
265 if (!$target_item['private'] &&
266 (strlen($target_item['allow_cid'].$target_item['allow_gid'].
267 $target_item['deny_cid'].$target_item['deny_gid']) == 0))
270 if (($thr_parent && ($thr_parent[0]['network'] == NETWORK_OSTATUS)) || ($parent['network'] == NETWORK_OSTATUS)) {
273 if ($parent["network"] == NETWORK_OSTATUS) {
274 // Distribute the message to the DFRN contacts as if this wasn't a followup since OStatus can't relay comments
275 // Currently it is work at progress
276 $r = q("SELECT `id` FROM `contact` WHERE `uid` = %d AND `network` = '%s' AND NOT `blocked` AND NOT `pending` AND NOT `archive`",
280 if (DBM::is_result($r)) {
281 foreach ($r as $rr) {
282 $recipients_followup[] = $rr['id'];
288 if ($direct_forum_delivery) {
289 $push_notify = false;
292 logger("Notify ".$target_item["guid"]." via PuSH: ".($push_notify?"Yes":"No"), LOGGER_DEBUG);
296 logger('Distributing directly '.$target_item["guid"], LOGGER_DEBUG);
298 // don't send deletions onward for other people's stuff
300 if ($target_item['deleted'] && !intval($target_item['wall'])) {
301 logger('notifier: ignoring delete notification for non-wall item');
305 if (strlen($parent['allow_cid'])
306 || strlen($parent['allow_gid'])
307 || strlen($parent['deny_cid'])
308 || strlen($parent['deny_gid'])) {
309 $public_message = false; // private recipients, not public
312 $allow_people = expand_acl($parent['allow_cid']);
313 $allow_groups = Group::expand(expand_acl($parent['allow_gid']),true);
314 $deny_people = expand_acl($parent['deny_cid']);
315 $deny_groups = Group::expand(expand_acl($parent['deny_gid']));
317 // if our parent is a public forum (forum_mode == 1), uplink to the origional author causing
318 // a delivery fork. private groups (forum_mode == 2) do not uplink
320 if ((intval($parent['forum_mode']) == 1) && !$top_level && ($cmd !== 'uplink')) {
321 Worker::add($a->queue['priority'], 'Notifier', 'uplink', $item_id);
326 foreach ($items as $item) {
327 $recipients[] = $item['contact-id'];
328 $conversants[] = $item['contact-id'];
329 // pull out additional tagged people to notify (if public message)
330 if ($public_message && strlen($item['inform'])) {
331 $people = explode(',',$item['inform']);
332 foreach ($people as $person) {
333 if (substr($person,0,4) === 'cid:') {
334 $recipients[] = intval(substr($person,4));
335 $conversants[] = intval(substr($person,4));
337 $url_recipients[] = substr($person,4);
343 if (count($url_recipients)) {
344 logger('notifier: '.$target_item["guid"].' url_recipients ' . print_r($url_recipients,true));
347 $conversants = array_unique($conversants);
349 $recipients = array_unique(array_merge($recipients,$allow_people,$allow_groups));
350 $deny = array_unique(array_merge($deny_people,$deny_groups));
351 $recipients = array_diff($recipients,$deny);
353 $conversant_str = dbesc(implode(', ',$conversants));
356 // If the thread parent is OStatus then do some magic to distribute the messages.
357 // We have not only to look at the parent, since it could be a Friendica thread.
358 if (($thr_parent && ($thr_parent[0]['network'] == NETWORK_OSTATUS)) || ($parent['network'] == NETWORK_OSTATUS)) {
359 $diaspora_delivery = false;
361 logger('Some parent is OStatus for '.$target_item["guid"]." - Author: ".$thr_parent[0]['author-link']." - Owner: ".$thr_parent[0]['owner-link'], LOGGER_DEBUG);
363 // Send a salmon to the parent author
364 $r = q("SELECT `url`, `notify` FROM `contact` WHERE `nurl`='%s' AND `uid` IN (0, %d) AND `notify` != ''",
365 dbesc(normalise_link($thr_parent[0]['author-link'])),
367 if (DBM::is_result($r)) {
368 $probed_contact = $r[0];
370 $probed_contact = Probe::uri($thr_parent[0]['author-link']);
373 if ($probed_contact["notify"] != "") {
374 logger('Notify parent author '.$probed_contact["url"].': '.$probed_contact["notify"]);
375 $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
378 // Send a salmon to the parent owner
379 $r = q("SELECT `url`, `notify` FROM `contact` WHERE `nurl`='%s' AND `uid` IN (0, %d) AND `notify` != ''",
380 dbesc(normalise_link($thr_parent[0]['owner-link'])),
382 if (DBM::is_result($r)) {
383 $probed_contact = $r[0];
385 $probed_contact = Probe::uri($thr_parent[0]['owner-link']);
388 if ($probed_contact["notify"] != "") {
389 logger('Notify parent owner '.$probed_contact["url"].': '.$probed_contact["notify"]);
390 $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
393 // Send a salmon notification to every person we mentioned in the post
394 $arr = explode(',',$target_item['tag']);
395 foreach ($arr as $x) {
396 //logger('Checking tag '.$x, LOGGER_DEBUG);
398 if (preg_match('/@\[url=([^\]]*)\]/',$x,$matches)) {
399 $probed_contact = Probe::uri($matches[1]);
400 if ($probed_contact["notify"] != "") {
401 logger('Notify mentioned user '.$probed_contact["url"].': '.$probed_contact["notify"]);
402 $url_recipients[$probed_contact["notify"]] = $probed_contact["notify"];
407 // It only makes sense to distribute answers to OStatus messages to Friendica and OStatus - but not Diaspora
408 $sql_extra = " AND `network` IN ('".NETWORK_OSTATUS."', '".NETWORK_DFRN."')";
410 $sql_extra = " AND `network` IN ('".NETWORK_OSTATUS."', '".NETWORK_DFRN."', '".NETWORK_DIASPORA."', '".NETWORK_MAIL."')";
413 $public_message = false;
416 // If this is a public message and pubmail is set on the parent, include all your email contacts
418 $mail_disabled = ((function_exists('imap_open') && (!Config::get('system','imap_disabled'))) ? 0 : 1);
420 if (!$mail_disabled) {
421 if (!strlen($target_item['allow_cid']) && !strlen($target_item['allow_gid'])
422 && !strlen($target_item['deny_cid']) && !strlen($target_item['deny_gid'])
423 && intval($target_item['pubmail'])) {
424 $r = q("SELECT `id` FROM `contact` WHERE `uid` = %d AND `network` = '%s'",
428 if (DBM::is_result($r)) {
429 foreach ($r as $rr) {
430 $recipients[] = $rr['id'];
437 $recip_str = implode(', ', $recipients_followup);
439 $recip_str = implode(', ', $recipients);
442 $r = $recipients_relocate;
444 $r = q("SELECT `id`, `url`, `network`, `self` FROM `contact`
445 WHERE `id` IN (%s) AND NOT `blocked` AND NOT `pending` AND NOT `archive`".$sql_extra,
452 if (DBM::is_result($r)) {
453 foreach ($r as $contact) {
454 if ($contact['self']) {
457 logger("Deliver ".$target_item["guid"]." to ".$contact['url']." via network ".$contact['network'], LOGGER_DEBUG);
459 Worker::add(['priority' => $a->queue['priority'], 'created' => $a->queue['created'], 'dont_fork' => true],
460 'Delivery', $cmd, $item_id, (int)$contact['id']);
464 // send salmon slaps to mentioned remote tags (@foo@example.com) in OStatus posts
465 // They are especially used for notifications to OStatus users that don't follow us.
467 if ($slap && count($url_recipients) && ($public_message || $push_notify) && $normal_mode) {
468 if (!Config::get('system', 'dfrn_only')) {
469 foreach ($url_recipients as $url) {
471 logger('notifier: urldelivery: ' . $url);
472 $deliver_status = Salmon::slapper($owner, $url, $slap);
473 /// @TODO Redeliver/queue these items on failure, though there is no contact record
480 if ($public_message) {
485 if ($diaspora_delivery) {
487 $r0 = Diaspora::relayList();
490 $r1 = q("SELECT `batch`, ANY_VALUE(`id`) AS `id`, ANY_VALUE(`name`) AS `name`, ANY_VALUE(`network`) AS `network`
491 FROM `contact` WHERE `network` = '%s' AND `batch` != ''
492 AND `uid` = %d AND `rel` != %d AND NOT `blocked` AND NOT `pending` AND NOT `archive` GROUP BY `batch`",
493 dbesc(NETWORK_DIASPORA),
494 intval($owner['uid']),
495 intval(CONTACT_IS_SHARING)
498 // Fetch the participation list
499 // The function will ensure that there are no duplicates
500 $r1 = Diaspora::participantsForThread($item_id, $r1);
504 $r2 = q("SELECT `id`, `name`,`network` FROM `contact`
505 WHERE `network` in ('%s') AND `uid` = %d AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND `rel` != %d",
507 intval($owner['uid']),
508 intval(CONTACT_IS_SHARING)
512 $r = array_merge($r2, $r1, $r0);
514 if (DBM::is_result($r)) {
515 logger('pubdeliver '.$target_item["guid"].': '.print_r($r,true), LOGGER_DEBUG);
517 foreach ($r as $rr) {
519 // except for Diaspora batch jobs
520 // Don't deliver to folks who have already been delivered to
522 if (($rr['network'] !== NETWORK_DIASPORA) && (in_array($rr['id'],$conversants))) {
523 logger('notifier: already delivered id=' . $rr['id']);
527 if (!$mail && !$fsuggest && !$followup) {
528 logger('notifier: delivery agent: '.$rr['name'].' '.$rr['id'].' '.$rr['network'].' '.$target_item["guid"]);
529 Worker::add(['priority' => $a->queue['priority'], 'created' => $a->queue['created'], 'dont_fork' => true],
530 'Delivery', $cmd, $item_id, (int)$rr['id']);
539 // Notify PuSH subscribers (Used for OStatus distribution of regular posts)
541 // Set push flag for PuSH subscribers to this topic,
542 // they will be notified in queue.php
543 q("UPDATE `push_subscriber` SET `push` = 1 ".
544 "WHERE `nickname` = '%s' AND `push` = 0", dbesc($owner['nickname']));
546 logger('Activating internal PuSH for item '.$item_id, LOGGER_DEBUG);
548 // Handling the pubsubhubbub requests
549 Worker::add(['priority' => PRIORITY_HIGH, 'created' => $a->queue['created'], 'dont_fork' => true],
553 logger('notifier: calling hooks', LOGGER_DEBUG);
556 Addon::ForkHooks($a->queue['priority'], 'notifier_normal', $target_item);
557 //Addon::callHooks('notifier_normal',$target_item);
560 Addon::callHooks('notifier_end',$target_item);