3 * @file src/Worker/Delivery.php
5 namespace Friendica\Worker;
7 use Friendica\BaseObject;
8 use Friendica\Core\Config;
9 use Friendica\Core\L10n;
10 use Friendica\Core\Logger;
11 use Friendica\Core\Protocol;
12 use Friendica\Core\System;
13 use Friendica\Database\DBA;
15 use Friendica\Protocol\DFRN;
16 use Friendica\Protocol\Diaspora;
17 use Friendica\Protocol\Email;
18 use Friendica\Protocol\Activity;
19 use Friendica\Util\Strings;
20 use Friendica\Util\Network;
21 use Friendica\Core\Worker;
23 class Delivery extends BaseObject
26 const SUGGESTION = 'suggest';
27 const RELOCATION = 'relocate';
28 const DELETION = 'drop';
29 const POST = 'wall-new';
31 const UPLINK = 'uplink';
32 const REMOVAL = 'removeme';
33 const PROFILEUPDATE = 'profileupdate';
35 public static function execute($cmd, $target_id, $contact_id)
37 Logger::info('Invoked', ['cmd' => $cmd, 'target' => $target_id, 'contact' => $contact_id]);
41 $public_message = false;
44 if ($cmd == self::MAIL) {
45 $target_item = DBA::selectFirst('mail', [], ['id' => $target_id]);
46 if (!DBA::isResult($target_item)) {
47 self::setFailedQueue($cmd, $target_id);
50 $uid = $target_item['uid'];
51 } elseif ($cmd == self::SUGGESTION) {
52 $target_item = DBA::selectFirst('fsuggest', [], ['id' => $target_id]);
53 if (!DBA::isResult($target_item)) {
54 self::setFailedQueue($cmd, $target_id);
57 $uid = $target_item['uid'];
58 } elseif ($cmd == self::RELOCATION) {
62 $item = Model\Item::selectFirst(['parent'], ['id' => $target_id]);
63 if (!DBA::isResult($item) || empty($item['parent'])) {
64 self::setFailedQueue($cmd, $target_id);
67 $parent_id = intval($item['parent']);
69 $condition = ['id' => [$target_id, $parent_id], 'visible' => true, 'moderated' => false];
70 $params = ['order' => ['id']];
71 $itemdata = Model\Item::select([], $condition, $params);
73 while ($item = Model\Item::fetch($itemdata)) {
74 if ($item['id'] == $parent_id) {
77 if ($item['id'] == $target_id) {
82 DBA::close($itemdata);
84 if (empty($target_item)) {
85 Logger::log('Item ' . $target_id . "wasn't found. Quitting here.");
86 self::setFailedQueue($cmd, $target_id);
91 Logger::log('Parent ' . $parent_id . ' for item ' . $target_id . "wasn't found. Quitting here.");
92 self::setFailedQueue($cmd, $target_id);
96 if (!empty($target_item['contact-uid'])) {
97 $uid = $target_item['contact-uid'];
98 } elseif (!empty($target_item['uid'])) {
99 $uid = $target_item['uid'];
101 Logger::log('Only public users for item ' . $target_id, Logger::DEBUG);
102 self::setFailedQueue($cmd, $target_id);
106 $condition = ['uri' => $target_item['thr-parent'], 'uid' => $target_item['uid']];
107 $thr_parent = Model\Item::selectFirst(['network', 'object'], $condition);
108 if (!DBA::isResult($thr_parent)) {
109 // Shouldn't happen. But when this does, we just take the parent as thread parent.
110 // That's totally okay for what we use this variable here.
111 $thr_parent = $parent;
114 if (!empty($contact_id) && Model\Contact::isArchived($contact_id)) {
115 Logger::info('Contact is archived', ['id' => $contact_id, 'cmd' => $cmd, 'item' => $target_item['id']]);
116 self::setFailedQueue($cmd, $target_id);
120 // avoid race condition with deleting entries
121 if ($items[0]['deleted']) {
122 foreach ($items as $item) {
123 $item['deleted'] = 1;
127 // When commenting too fast after delivery, a post wasn't recognized as top level post.
128 // The count then showed more than one entry. The additional check should help.
129 // The check for the "count" should be superfluous, but I'm not totally sure by now, so we keep it.
130 if ((($parent['id'] == $target_id) || (count($items) == 1)) && ($parent['uri'] === $parent['parent-uri'])) {
131 Logger::log('Top level post');
135 // This is IMPORTANT!!!!
137 // We will only send a "notify owner to relay" or followup message if the referenced post
138 // originated on our system by virtue of having our hostname somewhere
139 // in the URI, AND it was a comment (not top_level) AND the parent originated elsewhere.
140 // if $parent['wall'] == 1 we will already have the parent message in our array
141 // and we will relay the whole lot.
143 $localhost = self::getApp()->getHostName();
144 if (strpos($localhost, ':')) {
145 $localhost = substr($localhost, 0, strpos($localhost, ':'));
149 * Be VERY CAREFUL if you make any changes to the following line. Seemingly innocuous changes
150 * have been known to cause runaway conditions which affected several servers, along with
151 * permissions issues.
155 if (!$top_level && ($parent['wall'] == 0) && stristr($target_item['uri'], $localhost)) {
156 Logger::log('Followup ' . $target_item["guid"], Logger::DEBUG);
157 // local followup to remote post
161 if (empty($parent['allow_cid'])
162 && empty($parent['allow_gid'])
163 && empty($parent['deny_cid'])
164 && empty($parent['deny_gid'])
165 && !$parent["private"]) {
166 $public_message = true;
171 Logger::log('No delivery data for ' . $cmd . ' - Item ID: ' .$target_id . ' - Contact ID: ' . $contact_id);
174 $owner = Model\User::getOwnerDataById($uid);
175 if (!DBA::isResult($owner)) {
176 self::setFailedQueue($cmd, $target_id);
180 // We don't deliver our items to blocked or pending contacts, and not to ourselves either
181 $contact = DBA::selectFirst('contact', [],
182 ['id' => $contact_id, 'blocked' => false, 'pending' => false, 'self' => false]
184 if (!DBA::isResult($contact)) {
185 self::setFailedQueue($cmd, $target_id);
189 if (Network::isUrlBlocked($contact['url'])) {
190 self::setFailedQueue($cmd, $target_id);
194 // Transmit via Diaspora if the thread had started as Diaspora post.
195 // Also transmit via Diaspora if this is a direct answer to a Diaspora comment.
196 // This is done since the uri wouldn't match (Diaspora doesn't transmit it)
197 if (!empty($parent) && !empty($thr_parent) && in_array(Protocol::DIASPORA, [$parent['network'], $thr_parent['network']])) {
198 $contact['network'] = Protocol::DIASPORA;
201 Logger::notice('Delivering', ['cmd' => $cmd, 'target' => $target_id, 'followup' => $followup, 'network' => $contact['network']]);
203 switch ($contact['network']) {
205 self::deliverDFRN($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
208 case Protocol::DIASPORA:
209 self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
213 self::deliverMail($cmd, $contact, $owner, $target_item, $thr_parent);
224 * Increased the "failed" counter in the item delivery data
226 * @param string $cmd Command
227 * @param integer $id Item id
229 private static function setFailedQueue(string $cmd, int $id)
231 if (!in_array($cmd, [Delivery::POST, Delivery::POKE])) {
235 Model\ItemDeliveryData::incrementQueueFailed($id);
239 * @brief Deliver content via DFRN
241 * @param string $cmd Command
242 * @param array $contact Contact record of the receiver
243 * @param array $owner Owner record of the sender
244 * @param array $items Item record of the content and the parent
245 * @param array $target_item Item record of the content
246 * @param boolean $public_message Is the content public?
247 * @param boolean $top_level Is it a thread starter?
248 * @param boolean $followup Is it an answer to a remote post?
249 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
250 * @throws \ImagickException
252 private static function deliverDFRN($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup)
254 // Transmit Diaspora reshares via Diaspora if the Friendica contact support Diaspora
255 if (Diaspora::isReshare($target_item['body']) && !empty(Diaspora::personByHandle($contact['addr'], false))) {
256 Logger::info('Reshare will be transmitted via Diaspora', ['url' => $contact['url'], 'guid' => ($target_item['guid'] ?? '') ?: $target_item['id']]);
257 self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
261 Logger::info('Deliver ' . (($target_item['guid'] ?? '') ?: $target_item['id']) . ' via DFRN to ' . (($contact['addr'] ?? '') ?: $contact['url']));
263 if ($cmd == self::MAIL) {
264 $item = $target_item;
265 $item['body'] = Model\Item::fixPrivatePhotos($item['body'], $owner['uid'], null, $item['contact-id']);
266 $atom = DFRN::mail($item, $owner);
267 } elseif ($cmd == self::SUGGESTION) {
268 $item = $target_item;
269 $atom = DFRN::fsuggest($item, $owner);
270 DBA::delete('fsuggest', ['id' => $item['id']]);
271 } elseif ($cmd == self::RELOCATION) {
272 $atom = DFRN::relocate($owner, $owner['uid']);
273 } elseif ($followup) {
274 $msgitems = [$target_item];
275 $atom = DFRN::entries($msgitems, $owner);
278 foreach ($items as $item) {
279 // Only add the parent when we don't delete other items.
280 if (($target_item['id'] == $item['id']) || ($cmd != self::DELETION)) {
281 $item["entry:comment-allow"] = true;
282 $item["entry:cid"] = ($top_level ? $contact['id'] : 0);
286 $atom = DFRN::entries($msgitems, $owner);
289 Logger::debug('Notifier entry: ' . $contact["url"] . ' ' . (($target_item['guid'] ?? '') ?: $target_item['id']) . ' entry: ' . $atom);
291 $basepath = implode('/', array_slice(explode('/', $contact['url']), 0, 3));
293 // perform local delivery if we are on the same site
295 if (Strings::compareLink($basepath, System::baseUrl())) {
296 $condition = ['nurl' => Strings::normaliseLink($contact['url']), 'self' => true];
297 $target_self = DBA::selectFirst('contact', ['uid'], $condition);
298 if (!DBA::isResult($target_self)) {
301 $target_uid = $target_self['uid'];
303 // Check if the user has got this contact
304 $cid = Model\Contact::getIdForURL($owner['url'], $target_uid);
306 // Otherwise there should be a public contact
307 $cid = Model\Contact::getIdForURL($owner['url']);
313 $target_importer = DFRN::getImporter($cid, $target_uid);
314 if (empty($target_importer)) {
315 // This should never happen
319 DFRN::import($atom, $target_importer);
321 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
322 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], Model\ItemDeliveryData::DFRN);
328 $protocol = Model\ItemDeliveryData::DFRN;
330 // We don't have a relationship with contacts on a public post.
331 // Se we transmit with the new method and via Diaspora as a fallback
332 if (!empty($items) && (($items[0]['uid'] == 0) || ($contact['uid'] == 0))) {
333 // Transmit in public if it's a relay post
334 $public_dfrn = ($contact['contact-type'] == Model\Contact::TYPE_RELAY);
336 $deliver_status = DFRN::transmit($owner, $contact, $atom, $public_dfrn);
338 // We never spool failed relay deliveries
340 Logger::info('Relay delivery to ' . $contact["url"] . ' with guid ' . $target_item["guid"] . ' returns ' . $deliver_status);
342 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
343 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
344 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], $protocol);
346 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
352 if (($deliver_status < 200) || ($deliver_status > 299)) {
353 // Transmit via Diaspora if not possible via Friendica
354 self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
357 } elseif ($cmd != self::RELOCATION) {
358 // DFRN payload over Diaspora transport layer
359 $deliver_status = DFRN::transmit($owner, $contact, $atom);
360 if ($deliver_status < 200) {
362 $deliver_status = DFRN::deliver($owner, $contact, $atom);
363 $protocol = Model\ItemDeliveryData::LEGACY_DFRN;
366 $deliver_status = DFRN::deliver($owner, $contact, $atom);
367 $protocol = Model\ItemDeliveryData::LEGACY_DFRN;
370 Logger::info('DFRN Delivery', ['cmd' => $cmd, 'url' => $contact['url'], 'guid' => ($target_item['guid'] ?? '') ?: $target_item['id'], 'return' => $deliver_status]);
372 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
373 // We successfully delivered a message, the contact is alive
374 Model\Contact::unmarkForArchival($contact);
376 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
377 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], $protocol);
380 // The message could not be delivered. We mark the contact as "dead"
381 Model\Contact::markForArchival($contact);
383 Logger::info('Delivery failed: defer message', ['id' => ($target_item['guid'] ?? '') ?: $target_item['id']]);
384 if (!Worker::defer() && in_array($cmd, [Delivery::POST, Delivery::POKE])) {
385 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
391 * @brief Deliver content via Diaspora
393 * @param string $cmd Command
394 * @param array $contact Contact record of the receiver
395 * @param array $owner Owner record of the sender
396 * @param array $items Item record of the content and the parent
397 * @param array $target_item Item record of the content
398 * @param boolean $public_message Is the content public?
399 * @param boolean $top_level Is it a thread starter?
400 * @param boolean $followup Is it an answer to a remote post?
401 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
402 * @throws \ImagickException
404 private static function deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup)
406 // We don't treat Forum posts as "wall-to-wall" to be able to post them via Diaspora
407 $walltowall = $top_level && ($owner['id'] != $items[0]['contact-id']) & ($owner['account-type'] != Model\User::ACCOUNT_TYPE_COMMUNITY);
409 if ($public_message) {
410 $loc = 'public batch ' . $contact['batch'];
412 $loc = $contact['addr'];
415 Logger::notice('Deliver via Diaspora', ['target' => $target_item['id'], 'guid' => $target_item['guid'], 'to' => $loc]);
417 if (Config::get('system', 'dfrn_only') || !Config::get('system', 'diaspora_enabled')) {
421 if ($cmd == self::MAIL) {
422 Diaspora::sendMail($target_item, $owner, $contact);
426 if ($cmd == self::SUGGESTION) {
430 if (!$contact['pubkey'] && !$public_message) {
434 if ($cmd == self::RELOCATION) {
435 $deliver_status = Diaspora::sendAccountMigration($owner, $contact, $owner['uid']);
436 } elseif ($target_item['deleted'] && (($target_item['uri'] === $target_item['parent-uri']) || $followup)) {
437 // top-level retraction
438 Logger::log('diaspora retract: ' . $loc);
439 $deliver_status = Diaspora::sendRetraction($target_item, $owner, $contact, $public_message);
440 } elseif ($followup) {
441 // send comments and likes to owner to relay
442 Logger::log('diaspora followup: ' . $loc);
443 $deliver_status = Diaspora::sendFollowup($target_item, $owner, $contact, $public_message);
444 } elseif ($target_item['uri'] !== $target_item['parent-uri']) {
445 // we are the relay - send comments, likes and relayable_retractions to our conversants
446 Logger::log('diaspora relay: ' . $loc);
447 $deliver_status = Diaspora::sendRelay($target_item, $owner, $contact, $public_message);
448 } elseif ($top_level && !$walltowall) {
449 // currently no workable solution for sending walltowall
450 Logger::log('diaspora status: ' . $loc);
451 $deliver_status = Diaspora::sendStatus($target_item, $owner, $contact, $public_message);
453 Logger::log('Unknown mode ' . $cmd . ' for ' . $loc);
457 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
458 // We successfully delivered a message, the contact is alive
459 Model\Contact::unmarkForArchival($contact);
461 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
462 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], Model\ItemDeliveryData::DIASPORA);
465 // The message could not be delivered. We mark the contact as "dead"
466 Model\Contact::markForArchival($contact);
468 // When it is delivered to the public endpoint, we do mark the relay contact for archival as well
469 if ($public_message) {
470 Diaspora::markRelayForArchival($contact);
473 if (empty($contact['contact-type']) || ($contact['contact-type'] != Model\Contact::TYPE_RELAY)) {
474 Logger::info('Delivery failed: defer message', ['id' => ($target_item['guid'] ?? '') ?: $target_item['id']]);
475 // defer message for redelivery
476 if (!Worker::defer() && in_array($cmd, [Delivery::POST, Delivery::POKE])) {
477 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
479 } elseif (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
480 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
486 * @brief Deliver content via mail
488 * @param string $cmd Command
489 * @param array $contact Contact record of the receiver
490 * @param array $owner Owner record of the sender
491 * @param array $target_item Item record of the content
492 * @param array $thr_parent Item record of the direct parent in the thread
493 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
494 * @throws \ImagickException
496 private static function deliverMail($cmd, $contact, $owner, $target_item, $thr_parent)
498 if (Config::get('system','dfrn_only')) {
502 $addr = $contact['addr'];
503 if (!strlen($addr)) {
507 if (!in_array($cmd, [self::POST, self::POKE])) {
511 if ($target_item['verb'] != Activity::POST) {
515 if (!empty($thr_parent['object'])) {
516 $data = json_decode($thr_parent['object'], true);
517 if (!empty($data['reply_to'])) {
518 $addr = $data['reply_to'][0]['mailbox'] . '@' . $data['reply_to'][0]['host'];
519 Logger::info('Use "reply-to" address of the thread parent', ['addr' => $addr]);
520 } elseif (!empty($data['from'])) {
521 $addr = $data['from'][0]['mailbox'] . '@' . $data['from'][0]['host'];
522 Logger::info('Use "from" address of the thread parent', ['addr' => $addr]);
526 $local_user = DBA::selectFirst('user', [], ['uid' => $owner['uid']]);
527 if (!DBA::isResult($local_user)) {
531 Logger::info('About to deliver via mail', ['guid' => $target_item['guid'], 'to' => $addr]);
534 $mailacct = DBA::selectFirst('mailacct', ['reply_to'], ['uid' => $owner['uid']]);
535 if (DBA::isResult($mailacct) && !empty($mailacct['reply_to'])) {
536 $reply_to = $mailacct['reply_to'];
539 $subject = ($target_item['title'] ? Email::encodeHeader($target_item['title'], 'UTF-8') : L10n::t("\x28no subject\x29"));
541 // only expose our real email address to true friends
543 if (($contact['rel'] == Model\Contact::FRIEND) && !$contact['blocked']) {
545 $headers = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8') . ' <' . $reply_to . '>' . "\n";
546 $headers .= 'Sender: ' . $local_user['email'] . "\n";
548 $headers = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8') . ' <' . $local_user['email'] . '>' . "\n";
551 $headers = 'From: '. Email::encodeHeader($local_user['username'], 'UTF-8') . ' <noreply@' . self::getApp()->getHostName() . '>' . "\n";
554 $headers .= 'Message-Id: <' . Email::iri2msgid($target_item['uri']) . '>' . "\n";
556 if ($target_item['uri'] !== $target_item['parent-uri']) {
557 $headers .= 'References: <' . Email::iri2msgid($target_item['parent-uri']) . '>';
559 // Export more references on deeper nested threads
560 if (($target_item['thr-parent'] != '') && ($target_item['thr-parent'] != $target_item['parent-uri'])) {
561 $headers .= ' <' . Email::iri2msgid($target_item['thr-parent']) . '>';
566 if (empty($target_item['title'])) {
567 $condition = ['uri' => $target_item['parent-uri'], 'uid' => $owner['uid']];
568 $title = Model\Item::selectFirst(['title'], $condition);
570 if (DBA::isResult($title) && ($title['title'] != '')) {
571 $subject = $title['title'];
573 $condition = ['parent-uri' => $target_item['parent-uri'], 'uid' => $owner['uid']];
574 $title = Model\Item::selectFirst(['title'], $condition);
576 if (DBA::isResult($title) && ($title['title'] != '')) {
577 $subject = $title['title'];
582 if (strncasecmp($subject, 'RE:', 3)) {
583 $subject = 'Re: ' . $subject;
587 Email::send($addr, $subject, $headers, $target_item);
589 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], Model\ItemDeliveryData::MAIL);
591 Logger::info('Delivered via mail', ['guid' => $target_item['guid'], 'to' => $addr, 'subject' => $subject]);