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 if (!empty($contact_id) && Model\Contact::isArchived($contact_id)) {
106 Logger::info('Contact is archived', ['id' => $contact_id, 'cmd' => $cmd, 'item' => $target_item['id']]);
107 self::setFailedQueue($cmd, $target_id);
111 // avoid race condition with deleting entries
112 if ($items[0]['deleted']) {
113 foreach ($items as $item) {
114 $item['deleted'] = 1;
118 // When commenting too fast after delivery, a post wasn't recognized as top level post.
119 // The count then showed more than one entry. The additional check should help.
120 // The check for the "count" should be superfluous, but I'm not totally sure by now, so we keep it.
121 if ((($parent['id'] == $target_id) || (count($items) == 1)) && ($parent['uri'] === $parent['parent-uri'])) {
122 Logger::log('Top level post');
126 // This is IMPORTANT!!!!
128 // We will only send a "notify owner to relay" or followup message if the referenced post
129 // originated on our system by virtue of having our hostname somewhere
130 // in the URI, AND it was a comment (not top_level) AND the parent originated elsewhere.
131 // if $parent['wall'] == 1 we will already have the parent message in our array
132 // and we will relay the whole lot.
134 $localhost = self::getApp()->getHostName();
135 if (strpos($localhost, ':')) {
136 $localhost = substr($localhost, 0, strpos($localhost, ':'));
140 * Be VERY CAREFUL if you make any changes to the following line. Seemingly innocuous changes
141 * have been known to cause runaway conditions which affected several servers, along with
142 * permissions issues.
146 if (!$top_level && ($parent['wall'] == 0) && stristr($target_item['uri'], $localhost)) {
147 Logger::log('Followup ' . $target_item["guid"], Logger::DEBUG);
148 // local followup to remote post
152 if (empty($parent['allow_cid'])
153 && empty($parent['allow_gid'])
154 && empty($parent['deny_cid'])
155 && empty($parent['deny_gid'])
156 && !$parent["private"]) {
157 $public_message = true;
162 Logger::log('No delivery data for ' . $cmd . ' - Item ID: ' .$target_id . ' - Contact ID: ' . $contact_id);
165 $owner = Model\User::getOwnerDataById($uid);
166 if (!DBA::isResult($owner)) {
167 self::setFailedQueue($cmd, $target_id);
171 // We don't deliver our items to blocked or pending contacts, and not to ourselves either
172 $contact = DBA::selectFirst('contact', [],
173 ['id' => $contact_id, 'blocked' => false, 'pending' => false, 'self' => false]
175 if (!DBA::isResult($contact)) {
176 self::setFailedQueue($cmd, $target_id);
180 if (Network::isUrlBlocked($contact['url'])) {
181 self::setFailedQueue($cmd, $target_id);
185 // Transmit via Diaspora if the thread had started as Diaspora post
186 // This is done since the uri wouldn't match (Diaspora doesn't transmit it)
187 if (isset($parent) && ($parent['network'] == Protocol::DIASPORA)) {
188 $contact['network'] = Protocol::DIASPORA;
191 Logger::notice('Delivering', ['cmd' => $cmd, 'target' => $target_id, 'followup' => $followup, 'network' => $contact['network']]);
193 switch ($contact['network']) {
195 self::deliverDFRN($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
198 case Protocol::DIASPORA:
199 self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
203 self::deliverMail($cmd, $contact, $owner, $target_item);
214 * Increased the "failed" counter in the item delivery data
216 * @param string $cmd Command
217 * @param integer $id Item id
219 private static function setFailedQueue(string $cmd, int $id)
221 if (!in_array($cmd, [Delivery::POST, Delivery::POKE])) {
225 Model\ItemDeliveryData::incrementQueueFailed($id);
229 * @brief Deliver content via DFRN
231 * @param string $cmd Command
232 * @param array $contact Contact record of the receiver
233 * @param array $owner Owner record of the sender
234 * @param array $items Item record of the content and the parent
235 * @param array $target_item Item record of the content
236 * @param boolean $public_message Is the content public?
237 * @param boolean $top_level Is it a thread starter?
238 * @param boolean $followup Is it an answer to a remote post?
239 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
240 * @throws \ImagickException
242 private static function deliverDFRN($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup)
244 Logger::log('Deliver ' . defaults($target_item, 'guid', $target_item['id']) . ' via DFRN to ' . (empty($contact['addr']) ? $contact['url'] : $contact['addr']));
246 if ($cmd == self::MAIL) {
247 $item = $target_item;
248 $item['body'] = Model\Item::fixPrivatePhotos($item['body'], $owner['uid'], null, $item['contact-id']);
249 $atom = DFRN::mail($item, $owner);
250 } elseif ($cmd == self::SUGGESTION) {
251 $item = $target_item;
252 $atom = DFRN::fsuggest($item, $owner);
253 DBA::delete('fsuggest', ['id' => $item['id']]);
254 } elseif ($cmd == self::RELOCATION) {
255 $atom = DFRN::relocate($owner, $owner['uid']);
256 } elseif ($followup) {
257 $msgitems = [$target_item];
258 $atom = DFRN::entries($msgitems, $owner);
261 foreach ($items as $item) {
262 // Only add the parent when we don't delete other items.
263 if (($target_item['id'] == $item['id']) || ($cmd != self::DELETION)) {
264 $item["entry:comment-allow"] = true;
265 $item["entry:cid"] = ($top_level ? $contact['id'] : 0);
269 $atom = DFRN::entries($msgitems, $owner);
272 Logger::log('Notifier entry: ' . $contact["url"] . ' ' . defaults($target_item, 'guid', $target_item['id']) . ' entry: ' . $atom, Logger::DATA);
274 $basepath = implode('/', array_slice(explode('/', $contact['url']), 0, 3));
276 // perform local delivery if we are on the same site
278 if (Strings::compareLink($basepath, System::baseUrl())) {
279 $condition = ['nurl' => Strings::normaliseLink($contact['url']), 'self' => true];
280 $target_self = DBA::selectFirst('contact', ['uid'], $condition);
281 if (!DBA::isResult($target_self)) {
284 $target_uid = $target_self['uid'];
286 // Check if the user has got this contact
287 $cid = Model\Contact::getIdForURL($owner['url'], $target_uid);
289 // Otherwise there should be a public contact
290 $cid = Model\Contact::getIdForURL($owner['url']);
296 $target_importer = DFRN::getImporter($cid, $target_uid);
297 if (empty($target_importer)) {
298 // This should never happen
302 DFRN::import($atom, $target_importer);
304 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
305 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], Model\ItemDeliveryData::DFRN);
311 $protocol = Model\ItemDeliveryData::DFRN;
313 // We don't have a relationship with contacts on a public post.
314 // Se we transmit with the new method and via Diaspora as a fallback
315 if (!empty($items) && (($items[0]['uid'] == 0) || ($contact['uid'] == 0))) {
316 // Transmit in public if it's a relay post
317 $public_dfrn = ($contact['contact-type'] == Model\Contact::TYPE_RELAY);
319 $deliver_status = DFRN::transmit($owner, $contact, $atom, $public_dfrn);
321 // We never spool failed relay deliveries
323 Logger::log('Relay delivery to ' . $contact["url"] . ' with guid ' . $target_item["guid"] . ' returns ' . $deliver_status);
325 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
326 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
327 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], $protocol);
329 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
335 if (($deliver_status < 200) || ($deliver_status > 299)) {
336 // Transmit via Diaspora if not possible via Friendica
337 self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
340 } elseif ($cmd != self::RELOCATION) {
341 // DFRN payload over Diaspora transport layer
342 $deliver_status = DFRN::transmit($owner, $contact, $atom);
343 if ($deliver_status < 200) {
345 $deliver_status = DFRN::deliver($owner, $contact, $atom);
346 $protocol = Model\ItemDeliveryData::LEGACY_DFRN;
349 $deliver_status = DFRN::deliver($owner, $contact, $atom);
350 $protocol = Model\ItemDeliveryData::LEGACY_DFRN;
353 Logger::info('DFRN Delivery', ['cmd' => $cmd, 'url' => $contact['url'], 'guid' => defaults($target_item, 'guid', $target_item['id']), 'return' => $deliver_status]);
355 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
356 // We successfully delivered a message, the contact is alive
357 Model\Contact::unmarkForArchival($contact);
359 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
360 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], $protocol);
363 // The message could not be delivered. We mark the contact as "dead"
364 Model\Contact::markForArchival($contact);
366 Logger::info('Delivery failed: defer message', ['id' => defaults($target_item, 'guid', $target_item['id'])]);
367 if (!Worker::defer() && in_array($cmd, [Delivery::POST, Delivery::POKE])) {
368 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
374 * @brief Deliver content via Diaspora
376 * @param string $cmd Command
377 * @param array $contact Contact record of the receiver
378 * @param array $owner Owner record of the sender
379 * @param array $items Item record of the content and the parent
380 * @param array $target_item Item record of the content
381 * @param boolean $public_message Is the content public?
382 * @param boolean $top_level Is it a thread starter?
383 * @param boolean $followup Is it an answer to a remote post?
384 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
385 * @throws \ImagickException
387 private static function deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup)
389 // We don't treat Forum posts as "wall-to-wall" to be able to post them via Diaspora
390 $walltowall = $top_level && ($owner['id'] != $items[0]['contact-id']) & ($owner['account-type'] != Model\User::ACCOUNT_TYPE_COMMUNITY);
392 if ($public_message) {
393 $loc = 'public batch ' . $contact['batch'];
395 $loc = $contact['addr'];
398 Logger::notice('Deliver via Diaspora', ['target' => $target_item['id'], 'guid' => $target_item['guid'], 'to' => $loc]);
400 if (Config::get('system', 'dfrn_only') || !Config::get('system', 'diaspora_enabled')) {
404 if ($cmd == self::MAIL) {
405 Diaspora::sendMail($target_item, $owner, $contact);
409 if ($cmd == self::SUGGESTION) {
413 if (!$contact['pubkey'] && !$public_message) {
417 if ($cmd == self::RELOCATION) {
418 $deliver_status = Diaspora::sendAccountMigration($owner, $contact, $owner['uid']);
419 } elseif ($target_item['deleted'] && (($target_item['uri'] === $target_item['parent-uri']) || $followup)) {
420 // top-level retraction
421 Logger::log('diaspora retract: ' . $loc);
422 $deliver_status = Diaspora::sendRetraction($target_item, $owner, $contact, $public_message);
423 } elseif ($followup) {
424 // send comments and likes to owner to relay
425 Logger::log('diaspora followup: ' . $loc);
426 $deliver_status = Diaspora::sendFollowup($target_item, $owner, $contact, $public_message);
427 } elseif ($target_item['uri'] !== $target_item['parent-uri']) {
428 // we are the relay - send comments, likes and relayable_retractions to our conversants
429 Logger::log('diaspora relay: ' . $loc);
430 $deliver_status = Diaspora::sendRelay($target_item, $owner, $contact, $public_message);
431 } elseif ($top_level && !$walltowall) {
432 // currently no workable solution for sending walltowall
433 Logger::log('diaspora status: ' . $loc);
434 $deliver_status = Diaspora::sendStatus($target_item, $owner, $contact, $public_message);
436 Logger::log('Unknown mode ' . $cmd . ' for ' . $loc);
440 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
441 // We successfully delivered a message, the contact is alive
442 Model\Contact::unmarkForArchival($contact);
444 if (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
445 Model\ItemDeliveryData::incrementQueueDone($target_item['id'], Model\ItemDeliveryData::DIASPORA);
448 // The message could not be delivered. We mark the contact as "dead"
449 Model\Contact::markForArchival($contact);
451 // When it is delivered to the public endpoint, we do mark the relay contact for archival as well
452 if ($public_message) {
453 Diaspora::markRelayForArchival($contact);
456 if (empty($contact['contact-type']) || ($contact['contact-type'] != Model\Contact::TYPE_RELAY)) {
457 Logger::info('Delivery failed: defer message', ['id' => defaults($target_item, 'guid', $target_item['id'])]);
458 // defer message for redelivery
459 if (!Worker::defer() && in_array($cmd, [Delivery::POST, Delivery::POKE])) {
460 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
462 } elseif (in_array($cmd, [Delivery::POST, Delivery::POKE])) {
463 Model\ItemDeliveryData::incrementQueueFailed($target_item['id']);
469 * @brief Deliver content via mail
471 * @param string $cmd Command
472 * @param array $contact Contact record of the receiver
473 * @param array $owner Owner record of the sender
474 * @param array $target_item Item record of the content
475 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
476 * @throws \ImagickException
478 private static function deliverMail($cmd, $contact, $owner, $target_item)
480 if (Config::get('system','dfrn_only')) {
483 // WARNING: does not currently convert to RFC2047 header encodings, etc.
485 $addr = $contact['addr'];
486 if (!strlen($addr)) {
490 if (!in_array($cmd, [self::POST, self::POKE])) {
494 $local_user = DBA::selectFirst('user', [], ['uid' => $owner['uid']]);
495 if (!DBA::isResult($local_user)) {
499 Logger::log('Deliver ' . $target_item["guid"] . ' via mail to ' . $contact['addr']);
502 $mailacct = DBA::selectFirst('mailacct', ['reply_to'], ['uid' => $owner['uid']]);
503 if (DBA::isResult($mailacct) && !empty($mailacct['reply_to'])) {
504 $reply_to = $mailacct['reply_to'];
507 $subject = ($target_item['title'] ? Email::encodeHeader($target_item['title'], 'UTF-8') : L10n::t("\x28no subject\x29"));
509 // only expose our real email address to true friends
511 if (($contact['rel'] == Model\Contact::FRIEND) && !$contact['blocked']) {
513 $headers = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8') . ' <' . $reply_to.'>' . "\n";
514 $headers .= 'Sender: ' . $local_user['email'] . "\n";
516 $headers = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8').' <' . $local_user['email'] . '>' . "\n";
519 $headers = 'From: '. Email::encodeHeader($local_user['username'], 'UTF-8') . ' <noreply@' . self::getApp()->getHostName() . '>' . "\n";
522 $headers .= 'Message-Id: <' . Email::iri2msgid($target_item['uri']) . '>' . "\n";
524 if ($target_item['uri'] !== $target_item['parent-uri']) {
525 $headers .= "References: <" . Email::iri2msgid($target_item["parent-uri"]) . ">";
527 // If Threading is enabled, write down the correct parent
528 if (($target_item["thr-parent"] != "") && ($target_item["thr-parent"] != $target_item["parent-uri"])) {
529 $headers .= " <".Email::iri2msgid($target_item["thr-parent"]).">";
534 if (empty($target_item['title'])) {
535 $condition = ['uri' => $target_item['parent-uri'], 'uid' => $owner['uid']];
536 $title = Model\Item::selectFirst(['title'], $condition);
538 if (DBA::isResult($title) && ($title['title'] != '')) {
539 $subject = $title['title'];
541 $condition = ['parent-uri' => $target_item['parent-uri'], 'uid' => $owner['uid']];
542 $title = Model\Item::selectFirst(['title'], $condition);
544 if (DBA::isResult($title) && ($title['title'] != '')) {
545 $subject = $title['title'];
550 if (strncasecmp($subject, 'RE:', 3)) {
551 $subject = 'Re: ' . $subject;
555 Email::send($addr, $subject, $headers, $target_item);