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\Util\Strings;
19 use Friendica\Util\Network;
20 use Friendica\Core\Worker;
22 class Delivery extends BaseObject
25 const SUGGESTION = 'suggest';
26 const RELOCATION = 'relocate';
27 const DELETION = 'drop';
28 const POST = 'wall-new';
30 const UPLINK = 'uplink';
31 const REMOVAL = 'removeme';
32 const PROFILEUPDATE = 'profileupdate';
34 public static function execute($cmd, $target_id, $contact_id)
36 Logger::info('Invoked', ['cmd' => $cmd, 'target' => $target_id, 'contact' => $contact_id]);
40 $public_message = false;
43 if ($cmd == self::MAIL) {
44 $target_item = DBA::selectFirst('mail', [], ['id' => $target_id]);
45 if (!DBA::isResult($target_item)) {
46 self::setFailedQueue($cmd, $target_id);
49 $uid = $target_item['uid'];
50 } elseif ($cmd == self::SUGGESTION) {
51 $target_item = DBA::selectFirst('fsuggest', [], ['id' => $target_id]);
52 if (!DBA::isResult($target_item)) {
53 self::setFailedQueue($cmd, $target_id);
56 $uid = $target_item['uid'];
57 } elseif ($cmd == self::RELOCATION) {
61 $item = Model\Item::selectFirst(['parent'], ['id' => $target_id]);
62 if (!DBA::isResult($item) || empty($item['parent'])) {
63 self::setFailedQueue($cmd, $target_id);
66 $parent_id = intval($item['parent']);
68 $condition = ['id' => [$target_id, $parent_id], 'visible' => true, 'moderated' => false];
69 $params = ['order' => ['id']];
70 $itemdata = Model\Item::select([], $condition, $params);
72 while ($item = Model\Item::fetch($itemdata)) {
73 if ($item['id'] == $parent_id) {
76 if ($item['id'] == $target_id) {
81 DBA::close($itemdata);
83 if (empty($target_item)) {
84 Logger::log('Item ' . $target_id . "wasn't found. Quitting here.");
85 self::setFailedQueue($cmd, $target_id);
90 Logger::log('Parent ' . $parent_id . ' for item ' . $target_id . "wasn't found. Quitting here.");
91 self::setFailedQueue($cmd, $target_id);
95 if (!empty($target_item['contact-uid'])) {
96 $uid = $target_item['contact-uid'];
97 } elseif (!empty($target_item['uid'])) {
98 $uid = $target_item['uid'];
100 Logger::log('Only public users for item ' . $target_id, Logger::DEBUG);
101 self::setFailedQueue($cmd, $target_id);
105 $condition = ['uri' => $target_item['thr-parent'], 'uid' => $target_item['uid']];
106 $thr_parent = Model\Item::selectFirst(['network'], $condition);
107 if (!DBA::isResult($thr_parent)) {
108 // Shouldn't happen. But when this does, we just take the parent as thread parent.
109 // That's totally okay for what we use this variable here.
110 $thr_parent = $parent;
113 if (!empty($contact_id) && Model\Contact::isArchived($contact_id)) {
114 Logger::info('Contact is archived', ['id' => $contact_id, 'cmd' => $cmd, 'item' => $target_item['id']]);
115 self::setFailedQueue($cmd, $target_id);
119 // avoid race condition with deleting entries
120 if ($items[0]['deleted']) {
121 foreach ($items as $item) {
122 $item['deleted'] = 1;
126 // When commenting too fast after delivery, a post wasn't recognized as top level post.
127 // The count then showed more than one entry. The additional check should help.
128 // The check for the "count" should be superfluous, but I'm not totally sure by now, so we keep it.
129 if ((($parent['id'] == $target_id) || (count($items) == 1)) && ($parent['uri'] === $parent['parent-uri'])) {
130 Logger::log('Top level post');
134 // This is IMPORTANT!!!!
136 // We will only send a "notify owner to relay" or followup message if the referenced post
137 // originated on our system by virtue of having our hostname somewhere
138 // in the URI, AND it was a comment (not top_level) AND the parent originated elsewhere.
139 // if $parent['wall'] == 1 we will already have the parent message in our array
140 // and we will relay the whole lot.
142 $localhost = self::getApp()->getHostName();
143 if (strpos($localhost, ':')) {
144 $localhost = substr($localhost, 0, strpos($localhost, ':'));
148 * Be VERY CAREFUL if you make any changes to the following line. Seemingly innocuous changes
149 * have been known to cause runaway conditions which affected several servers, along with
150 * permissions issues.
154 if (!$top_level && ($parent['wall'] == 0) && stristr($target_item['uri'], $localhost)) {
155 Logger::log('Followup ' . $target_item["guid"], Logger::DEBUG);
156 // local followup to remote post
160 if (empty($parent['allow_cid'])
161 && empty($parent['allow_gid'])
162 && empty($parent['deny_cid'])
163 && empty($parent['deny_gid'])
164 && !$parent["private"]) {
165 $public_message = true;
170 Logger::log('No delivery data for ' . $cmd . ' - Item ID: ' .$target_id . ' - Contact ID: ' . $contact_id);
173 $owner = Model\User::getOwnerDataById($uid);
174 if (!DBA::isResult($owner)) {
175 self::setFailedQueue($cmd, $target_id);
179 // We don't deliver our items to blocked or pending contacts, and not to ourselves either
180 $contact = DBA::selectFirst('contact', [],
181 ['id' => $contact_id, 'blocked' => false, 'pending' => false, 'self' => false]
183 if (!DBA::isResult($contact)) {
184 self::setFailedQueue($cmd, $target_id);
188 if (Network::isUrlBlocked($contact['url'])) {
189 self::setFailedQueue($cmd, $target_id);
193 // Transmit via Diaspora if the thread had started as Diaspora post.
194 // Also transmit via Diaspora if this is a direct answer to a Diaspora comment.
195 // This is done since the uri wouldn't match (Diaspora doesn't transmit it)
196 if (!empty($parent) && !empty($thr_parent) && in_array(Protocol::DIASPORA, [$parent['network'], $thr_parent['network']])) {
197 $contact['network'] = Protocol::DIASPORA;
200 Logger::notice('Delivering', ['cmd' => $cmd, 'target' => $target_id, 'followup' => $followup, 'network' => $contact['network']]);
202 switch ($contact['network']) {
204 self::deliverDFRN($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
207 case Protocol::DIASPORA:
208 self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
212 self::deliverMail($cmd, $contact, $owner, $target_item);
223 * Increased the "failed" counter in the item delivery data
225 * @param string $cmd Command
226 * @param integer $id Item id
228 private static function setFailedQueue(string $cmd, int $id)
230 if (!in_array($cmd, [Delivery::POST, Delivery::POKE])) {
234 Model\ItemDeliveryData::incrementQueueFailed($id);
238 * @brief Deliver content via DFRN
240 * @param string $cmd Command
241 * @param array $contact Contact record of the receiver
242 * @param array $owner Owner record of the sender
243 * @param array $items Item record of the content and the parent
244 * @param array $target_item Item record of the content
245 * @param boolean $public_message Is the content public?
246 * @param boolean $top_level Is it a thread starter?
247 * @param boolean $followup Is it an answer to a remote post?
248 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
249 * @throws \ImagickException
251 private static function deliverDFRN($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup)
253 Logger::info('Deliver ' . (($target_item['guid'] ?? '') ?: $target_item['id']) . ' via DFRN to ' . (($contact['addr'] ?? '') ?: $contact['url']));
255 if ($cmd == self::MAIL) {
256 $item = $target_item;
257 $item['body'] = Model\Item::fixPrivatePhotos($item['body'], $owner['uid'], null, $item['contact-id']);
258 $atom = DFRN::mail($item, $owner);
259 } elseif ($cmd == self::SUGGESTION) {
260 $item = $target_item;
261 $atom = DFRN::fsuggest($item, $owner);
262 DBA::delete('fsuggest', ['id' => $item['id']]);
263 } elseif ($cmd == self::RELOCATION) {
264 $atom = DFRN::relocate($owner, $owner['uid']);
265 } elseif ($followup) {
266 $msgitems = [$target_item];
267 $atom = DFRN::entries($msgitems, $owner);
270 foreach ($items as $item) {
271 // Only add the parent when we don't delete other items.
272 if (($target_item['id'] == $item['id']) || ($cmd != self::DELETION)) {
273 $item["entry:comment-allow"] = true;
274 $item["entry:cid"] = ($top_level ? $contact['id'] : 0);
278 $atom = DFRN::entries($msgitems, $owner);
281 Logger::debug('Notifier entry: ' . $contact["url"] . ' ' . (($target_item['guid'] ?? '') ?: $target_item['id']) . ' entry: ' . $atom);
283 $basepath = implode('/', array_slice(explode('/', $contact['url']), 0, 3));
285 // perform local delivery if we are on the same site
287 if (Strings::compareLink($basepath, System::baseUrl())) {
288 $condition = ['nurl' => Strings::normaliseLink($contact['url']), 'self' => true];
289 $target_self = DBA::selectFirst('contact', ['uid'], $condition);
290 if (!DBA::isResult($target_self)) {
293 $target_uid = $target_self['uid'];
295 // Check if the user has got this contact
296 $cid = Model\Contact::getIdForURL($owner['url'], $target_uid);
298 // Otherwise there should be a public contact
299 $cid = Model\Contact::getIdForURL($owner['url']);
305 $target_importer = DFRN::getImporter($cid, $target_uid);
306 if (empty($target_importer)) {
307 // This should never happen
311 DFRN::import($atom, $target_importer);
313 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
314 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], Model\ItemDeliveryData::DFRN);
320 $protocol = Model\ItemDeliveryData::DFRN;
322 // We don't have a relationship with contacts on a public post.
323 // Se we transmit with the new method and via Diaspora as a fallback
324 if (!empty($items) && (($items[0]['uid'] == 0) || ($contact['uid'] == 0))) {
325 // Transmit in public if it's a relay post
326 $public_dfrn = ($contact['contact-type'] == Model\Contact::TYPE_RELAY);
328 $deliver_status = DFRN::transmit($owner, $contact, $atom, $public_dfrn);
330 // We never spool failed relay deliveries
332 Logger::info('Relay delivery to ' . $contact["url"] . ' with guid ' . $target_item["guid"] . ' returns ' . $deliver_status);
334 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
335 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
336 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], $protocol);
338 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
344 if (($deliver_status < 200) || ($deliver_status > 299)) {
345 // Transmit via Diaspora if not possible via Friendica
346 self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
349 } elseif ($cmd != self::RELOCATION) {
350 // DFRN payload over Diaspora transport layer
351 $deliver_status = DFRN::transmit($owner, $contact, $atom);
352 if ($deliver_status < 200) {
354 $deliver_status = DFRN::deliver($owner, $contact, $atom);
355 $protocol = Model\ItemDeliveryData::LEGACY_DFRN;
358 $deliver_status = DFRN::deliver($owner, $contact, $atom);
359 $protocol = Model\ItemDeliveryData::LEGACY_DFRN;
362 Logger::info('DFRN Delivery', ['cmd' => $cmd, 'url' => $contact['url'], 'guid' => ($target_item['guid'] ?? '') ?: $target_item['id'], 'return' => $deliver_status]);
364 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
365 // We successfully delivered a message, the contact is alive
366 Model\Contact::unmarkForArchival($contact);
368 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
369 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], $protocol);
372 // The message could not be delivered. We mark the contact as "dead"
373 Model\Contact::markForArchival($contact);
375 Logger::info('Delivery failed: defer message', ['id' => ($target_item['guid'] ?? '') ?: $target_item['id']]);
376 if (!Worker::defer() && in_array($cmd, [Delivery::POST, Delivery::POKE])) {
377 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
383 * @brief Deliver content via Diaspora
385 * @param string $cmd Command
386 * @param array $contact Contact record of the receiver
387 * @param array $owner Owner record of the sender
388 * @param array $items Item record of the content and the parent
389 * @param array $target_item Item record of the content
390 * @param boolean $public_message Is the content public?
391 * @param boolean $top_level Is it a thread starter?
392 * @param boolean $followup Is it an answer to a remote post?
393 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
394 * @throws \ImagickException
396 private static function deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup)
398 // We don't treat Forum posts as "wall-to-wall" to be able to post them via Diaspora
399 $walltowall = $top_level && ($owner['id'] != $items[0]['contact-id']) & ($owner['account-type'] != Model\User::ACCOUNT_TYPE_COMMUNITY);
401 if ($public_message) {
402 $loc = 'public batch ' . $contact['batch'];
404 $loc = $contact['addr'];
407 Logger::notice('Deliver via Diaspora', ['target' => $target_item['id'], 'guid' => $target_item['guid'], 'to' => $loc]);
409 if (Config::get('system', 'dfrn_only') || !Config::get('system', 'diaspora_enabled')) {
413 if ($cmd == self::MAIL) {
414 Diaspora::sendMail($target_item, $owner, $contact);
418 if ($cmd == self::SUGGESTION) {
422 if (!$contact['pubkey'] && !$public_message) {
426 if ($cmd == self::RELOCATION) {
427 $deliver_status = Diaspora::sendAccountMigration($owner, $contact, $owner['uid']);
428 } elseif ($target_item['deleted'] && (($target_item['uri'] === $target_item['parent-uri']) || $followup)) {
429 // top-level retraction
430 Logger::log('diaspora retract: ' . $loc);
431 $deliver_status = Diaspora::sendRetraction($target_item, $owner, $contact, $public_message);
432 } elseif ($followup) {
433 // send comments and likes to owner to relay
434 Logger::log('diaspora followup: ' . $loc);
435 $deliver_status = Diaspora::sendFollowup($target_item, $owner, $contact, $public_message);
436 } elseif ($target_item['uri'] !== $target_item['parent-uri']) {
437 // we are the relay - send comments, likes and relayable_retractions to our conversants
438 Logger::log('diaspora relay: ' . $loc);
439 $deliver_status = Diaspora::sendRelay($target_item, $owner, $contact, $public_message);
440 } elseif ($top_level && !$walltowall) {
441 // currently no workable solution for sending walltowall
442 Logger::log('diaspora status: ' . $loc);
443 $deliver_status = Diaspora::sendStatus($target_item, $owner, $contact, $public_message);
445 Logger::log('Unknown mode ' . $cmd . ' for ' . $loc);
449 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
450 // We successfully delivered a message, the contact is alive
451 Model\Contact::unmarkForArchival($contact);
453 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
454 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], Model\ItemDeliveryData::DIASPORA);
457 // The message could not be delivered. We mark the contact as "dead"
458 Model\Contact::markForArchival($contact);
460 // When it is delivered to the public endpoint, we do mark the relay contact for archival as well
461 if ($public_message) {
462 Diaspora::markRelayForArchival($contact);
465 if (empty($contact['contact-type']) || ($contact['contact-type'] != Model\Contact::TYPE_RELAY)) {
466 Logger::info('Delivery failed: defer message', ['id' => ($target_item['guid'] ?? '') ?: $target_item['id']]);
467 // defer message for redelivery
468 if (!Worker::defer() && in_array($cmd, [Delivery::POST, Delivery::POKE])) {
469 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
471 } elseif (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
472 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
478 * @brief Deliver content via mail
480 * @param string $cmd Command
481 * @param array $contact Contact record of the receiver
482 * @param array $owner Owner record of the sender
483 * @param array $target_item Item record of the content
484 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
485 * @throws \ImagickException
487 private static function deliverMail($cmd, $contact, $owner, $target_item)
489 if (Config::get('system','dfrn_only')) {
492 // WARNING: does not currently convert to RFC2047 header encodings, etc.
494 $addr = $contact['addr'];
495 if (!strlen($addr)) {
499 if (!in_array($cmd, [self::POST, self::POKE])) {
503 $local_user = DBA::selectFirst('user', [], ['uid' => $owner['uid']]);
504 if (!DBA::isResult($local_user)) {
508 Logger::log('Deliver ' . $target_item["guid"] . ' via mail to ' . $contact['addr']);
511 $mailacct = DBA::selectFirst('mailacct', ['reply_to'], ['uid' => $owner['uid']]);
512 if (DBA::isResult($mailacct) && !empty($mailacct['reply_to'])) {
513 $reply_to = $mailacct['reply_to'];
516 $subject = ($target_item['title'] ? Email::encodeHeader($target_item['title'], 'UTF-8') : L10n::t("\x28no subject\x29"));
518 // only expose our real email address to true friends
520 if (($contact['rel'] == Model\Contact::FRIEND) && !$contact['blocked']) {
522 $headers = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8') . ' <' . $reply_to.'>' . "\n";
523 $headers .= 'Sender: ' . $local_user['email'] . "\n";
525 $headers = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8').' <' . $local_user['email'] . '>' . "\n";
528 $headers = 'From: '. Email::encodeHeader($local_user['username'], 'UTF-8') . ' <noreply@' . self::getApp()->getHostName() . '>' . "\n";
531 $headers .= 'Message-Id: <' . Email::iri2msgid($target_item['uri']) . '>' . "\n";
533 if ($target_item['uri'] !== $target_item['parent-uri']) {
534 $headers .= "References: <" . Email::iri2msgid($target_item["parent-uri"]) . ">";
536 // If Threading is enabled, write down the correct parent
537 if (($target_item["thr-parent"] != "") && ($target_item["thr-parent"] != $target_item["parent-uri"])) {
538 $headers .= " <".Email::iri2msgid($target_item["thr-parent"]).">";
543 if (empty($target_item['title'])) {
544 $condition = ['uri' => $target_item['parent-uri'], 'uid' => $owner['uid']];
545 $title = Model\Item::selectFirst(['title'], $condition);
547 if (DBA::isResult($title) && ($title['title'] != '')) {
548 $subject = $title['title'];
550 $condition = ['parent-uri' => $target_item['parent-uri'], 'uid' => $owner['uid']];
551 $title = Model\Item::selectFirst(['title'], $condition);
553 if (DBA::isResult($title) && ($title['title'] != '')) {
554 $subject = $title['title'];
559 if (strncasecmp($subject, 'RE:', 3)) {
560 $subject = 'Re: ' . $subject;
564 Email::send($addr, $subject, $headers, $target_item);