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/datetime.php';
23 require_once 'include/items.php';
24 require_once 'include/bbcode.php';
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.
33 * The notifier is typically called with:
35 * Worker::add(PRIORITY_HIGH, "Notifier", COMMAND, ITEM_ID);
37 * where COMMAND is one of the following:
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)
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);
72 if ($cmd === 'mail') {
75 $message = q("SELECT * FROM `mail` WHERE `id` = %d LIMIT 1",
78 if (!count($message)) {
81 $uid = $message[0]['uid'];
82 $recipients[] = $message[0]['contact-id'];
84 } elseif ($cmd === 'suggest') {
88 $suggest = q("SELECT * FROM `fsuggest` WHERE `id` = %d LIMIT 1",
91 if (!count($suggest)) {
94 $uid = $suggest[0]['uid'];
95 $recipients[] = $suggest[0]['cid'];
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",
109 $r = q("SELECT * FROM `contact` WHERE NOT `self` AND `uid` = %d", intval($item_id));
113 foreach ($r as $contact) {
114 Contact::terminateFriendship($user, $contact);
117 } elseif ($cmd === 'relocate') {
118 $normal_mode = false;
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);
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);
130 if (!DBM::is_result($target_item) || !intval($target_item['parent'])) {
134 $parent_id = intval($target_item['parent']);
135 $uid = $target_item['cuid'];
136 $updated = $target_item['edited'];
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",
143 if (!count($items)) {
147 // avoid race condition with deleting entries
148 if ($items[0]['deleted']) {
149 foreach ($items as $item) {
150 $item['deleted'] = 1;
154 if ((count($items) == 1) && ($items[0]['id'] === $target_item['id']) && ($items[0]['uri'] === $items[0]['parent-uri'])) {
155 logger('notifier: top level post');
160 $owner = User::getOwnerDataById($uid);
165 $walltowall = ($top_level && ($owner['id'] != $items[0]['contact-id']) ? true : false);
167 // Should the post be transmitted to Diaspora?
168 $diaspora_delivery = true;
170 // If this is a public conversation, notify the feed hub
171 $public_message = true;
174 $push_notify = false;
176 // Deliver directly to a forum, don't PuSH
177 $direct_forum_delivery = false;
179 // fill this in with a single salmon slap if applicable
182 if (! ($mail || $fsuggest || $relocate)) {
184 $slap = OStatus::salmon($target_item, $owner);
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"]));
191 logger('GUID: '.$target_item["guid"].': Parent is '.$parent['network'].'. Thread parent is '.$thr_parent[0]['network'], LOGGER_DEBUG);
193 // This is IMPORTANT!!!!
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.
199 // if $parent['wall'] == 1 we will already have the parent message in our array
200 // and we will relay the whole lot.
202 $localhost = str_replace('www.','',$a->get_hostname());
203 if (strpos($localhost,':')) {
204 $localhost = substr($localhost,0,strpos($localhost,':'));
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.
214 $relay_to_owner = false;
216 if (!$top_level && ($parent['wall'] == 0) && (stristr($target_item['uri'],$localhost))) {
217 $relay_to_owner = true;
221 if (($cmd === 'uplink') && (intval($parent['forum_mode']) == 1) && !$top_level) {
222 $relay_to_owner = true;
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.
229 if (!$target_item['origin']) {
230 $relay_to_owner = false;
232 if ($parent['origin']) {
233 $relay_to_owner = false;
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'])) {
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
249 // Is the post from a forum?
250 if ($contact['forum'] || $contact['prv']) {
251 $relay_to_owner = true;
252 $direct_forum_delivery = true;
255 if ($relay_to_owner) {
256 // local followup to remote post
258 $public_message = false; // not public
259 $conversant_str = dbesc($parent['contact-id']);
260 $recipients = [$parent['contact-id']];
261 $recipients_followup = [$parent['contact-id']];
263 logger('notifier: followup '.$target_item["guid"].' to '.$conversant_str, LOGGER_DEBUG);
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))
271 if (($thr_parent && ($thr_parent[0]['network'] == NETWORK_OSTATUS)) || ($parent['network'] == NETWORK_OSTATUS)) {
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`",
281 if (DBM::is_result($r)) {
282 foreach ($r as $rr) {
283 $recipients_followup[] = $rr['id'];
289 if ($direct_forum_delivery) {
290 $push_notify = false;
293 logger("Notify ".$target_item["guid"]." via PuSH: ".($push_notify?"Yes":"No"), LOGGER_DEBUG);
297 logger('Distributing directly '.$target_item["guid"], LOGGER_DEBUG);
299 // don't send deletions onward for other people's stuff
301 if ($target_item['deleted'] && !intval($target_item['wall'])) {
302 logger('notifier: ignoring delete notification for non-wall item');
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
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']));
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
321 if ((intval($parent['forum_mode']) == 1) && !$top_level && ($cmd !== 'uplink')) {
322 Worker::add($a->queue['priority'], 'Notifier', 'uplink', $item_id);
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));
338 $url_recipients[] = substr($person,4);
344 if (count($url_recipients)) {
345 logger('notifier: '.$target_item["guid"].' url_recipients ' . print_r($url_recipients,true));
348 $conversants = array_unique($conversants);
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);
354 $conversant_str = dbesc(implode(', ',$conversants));
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;
362 logger('Some parent is OStatus for '.$target_item["guid"]." - Author: ".$thr_parent[0]['author-link']." - Owner: ".$thr_parent[0]['owner-link'], LOGGER_DEBUG);
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'])),
368 if (DBM::is_result($r)) {
369 $probed_contact = $r[0];
371 $probed_contact = Probe::uri($thr_parent[0]['author-link']);
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"];
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'])),
383 if (DBM::is_result($r)) {
384 $probed_contact = $r[0];
386 $probed_contact = Probe::uri($thr_parent[0]['owner-link']);
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"];
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);
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"];
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."')";
411 $sql_extra = " AND `network` IN ('".NETWORK_OSTATUS."', '".NETWORK_DFRN."', '".NETWORK_DIASPORA."', '".NETWORK_MAIL."')";
414 $public_message = false;
417 // If this is a public message and pubmail is set on the parent, include all your email contacts
419 $mail_disabled = ((function_exists('imap_open') && (!Config::get('system','imap_disabled'))) ? 0 : 1);
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'",
429 if (DBM::is_result($r)) {
430 foreach ($r as $rr) {
431 $recipients[] = $rr['id'];
438 $recip_str = implode(', ', $recipients_followup);
440 $recip_str = implode(', ', $recipients);
443 $r = $recipients_relocate;
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,
453 if (DBM::is_result($r)) {
454 foreach ($r as $contact) {
455 if ($contact['self']) {
458 logger("Deliver ".$target_item["guid"]." to ".$contact['url']." via network ".$contact['network'], LOGGER_DEBUG);
460 Worker::add(['priority' => $a->queue['priority'], 'created' => $a->queue['created'], 'dont_fork' => true],
461 'Delivery', $cmd, $item_id, (int)$contact['id']);
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.
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) {
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
481 if ($public_message) {
486 if ($diaspora_delivery) {
488 $r0 = Diaspora::relayList();
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)
499 // Fetch the participation list
500 // The function will ensure that there are no duplicates
501 $r1 = Diaspora::participantsForThread($item_id, $r1);
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",
508 intval($owner['uid']),
509 intval(CONTACT_IS_SHARING)
513 $r = array_merge($r2, $r1, $r0);
515 if (DBM::is_result($r)) {
516 logger('pubdeliver '.$target_item["guid"].': '.print_r($r,true), LOGGER_DEBUG);
518 foreach ($r as $rr) {
520 // except for Diaspora batch jobs
521 // Don't deliver to folks who have already been delivered to
523 if (($rr['network'] !== NETWORK_DIASPORA) && (in_array($rr['id'],$conversants))) {
524 logger('notifier: already delivered id=' . $rr['id']);
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']);
540 // Notify PuSH subscribers (Used for OStatus distribution of regular posts)
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']));
547 logger('Activating internal PuSH for item '.$item_id, LOGGER_DEBUG);
549 // Handling the pubsubhubbub requests
550 Worker::add(['priority' => PRIORITY_HIGH, 'created' => $a->queue['created'], 'dont_fork' => true],
554 logger('notifier: calling hooks', LOGGER_DEBUG);
557 Addon::callHooks('notifier_normal',$target_item);
560 Addon::callHooks('notifier_end',$target_item);