3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Worker;
24 use Friendica\Contact\FriendSuggest\Collection\FriendSuggests;
25 use Friendica\Contact\FriendSuggest\Exception\FriendSuggestNotFoundException;
26 use Friendica\Core\Logger;
27 use Friendica\Core\Protocol;
28 use Friendica\Core\Worker;
29 use Friendica\Database\DBA;
31 use Friendica\Model\Contact;
32 use Friendica\Model\GServer;
33 use Friendica\Model\Item;
34 use Friendica\Model\Post;
35 use Friendica\Model\User;
36 use Friendica\Protocol\Activity;
37 use Friendica\Protocol\DFRN;
38 use Friendica\Protocol\Diaspora;
39 use Friendica\Protocol\Email;
40 use Friendica\Protocol\Relay;
41 use Friendica\Util\Network;
46 const SUGGESTION = 'suggest';
47 const RELOCATION = 'relocate';
48 const DELETION = 'drop';
49 const POST = 'wall-new';
50 const REMOVAL = 'removeme';
51 const PROFILEUPDATE = 'profileupdate';
53 public static function execute(string $cmd, int $post_uriid, int $contact_id, int $sender_uid = 0)
55 Logger::info('Invoked', ['cmd' => $cmd, 'target' => $post_uriid, 'sender_uid' => $sender_uid, 'contact' => $contact_id]);
59 $public_message = false;
62 if ($cmd == self::MAIL) {
63 $target_item = DBA::selectFirst('mail', [], ['id' => $post_uriid]);
64 if (!DBA::isResult($target_item)) {
67 $uid = $target_item['uid'];
68 } elseif ($cmd == self::SUGGESTION) {
70 $target_item = DI::fsuggest()->selectOneById($post_uriid)->toArray();
71 } catch (FriendSuggestNotFoundException $e) {
72 DI::logger()->info('Cannot find FriendSuggestion', ['id' => $post_uriid]);
75 $uid = $target_item['uid'];
76 } elseif ($cmd == self::RELOCATION) {
80 $item = Post::selectFirst(['id', 'parent'], ['uri-id' => $post_uriid, 'uid' => $sender_uid]);
81 if (!DBA::isResult($item) || empty($item['parent'])) {
82 Logger::warning('Post not found', ['uri-id' => $post_uriid, 'uid' => $sender_uid]);
85 $target_id = intval($item['id']);
86 $parent_id = intval($item['parent']);
88 $condition = ['id' => [$target_id, $parent_id], 'visible' => true];
89 $params = ['order' => ['id']];
90 $itemdata = Post::select(Item::DELIVER_FIELDLIST, $condition, $params);
92 while ($item = Post::fetch($itemdata)) {
93 if ($item['verb'] == Activity::ANNOUNCE) {
97 if ($item['id'] == $parent_id) {
100 if ($item['id'] == $target_id) {
101 $target_item = $item;
105 DBA::close($itemdata);
107 if (empty($target_item)) {
108 Logger::warning("No target item data. Quitting here.", ['id' => $target_id]);
112 if (empty($parent)) {
113 Logger::warning('Parent ' . $parent_id . ' for item ' . $target_id . "wasn't found. Quitting here.");
114 self::setFailedQueue($cmd, $target_item);
118 if (!empty($target_item['contact-uid'])) {
119 $uid = $target_item['contact-uid'];
120 } elseif (!empty($target_item['uid'])) {
121 $uid = $target_item['uid'];
123 Logger::info('Only public users for item ' . $target_id);
124 self::setFailedQueue($cmd, $target_item);
128 $condition = ['uri' => $target_item['thr-parent'], 'uid' => $target_item['uid']];
129 $thr_parent = Post::selectFirst(['network', 'object'], $condition);
130 if (!DBA::isResult($thr_parent)) {
131 // Shouldn't happen. But when this does, we just take the parent as thread parent.
132 // That's totally okay for what we use this variable here.
133 $thr_parent = $parent;
136 if (!empty($contact_id) && Contact::isArchived($contact_id)) {
137 Logger::info('Contact is archived', ['id' => $contact_id, 'cmd' => $cmd, 'item' => $target_item['id']]);
138 self::setFailedQueue($cmd, $target_item);
142 // avoid race condition with deleting entries
143 if ($items[0]['deleted']) {
144 foreach ($items as $item) {
145 $item['deleted'] = 1;
149 $top_level = $target_item['gravity'] == Item::GRAVITY_PARENT;
151 // This is IMPORTANT!!!!
153 // We will only send a "notify owner to relay" or followup message if the referenced post
154 // originated on our system by virtue of having our hostname somewhere
155 // in the URI, AND it was a comment (not top_level) AND the parent originated elsewhere.
156 // if $parent['wall'] == 1 we will already have the parent message in our array
157 // and we will relay the whole lot.
159 $localhost = DI::baseUrl()->getHostname();
160 if (strpos($localhost, ':')) {
161 $localhost = substr($localhost, 0, strpos($localhost, ':'));
165 * Be VERY CAREFUL if you make any changes to the following line. Seemingly innocuous changes
166 * have been known to cause runaway conditions which affected several servers, along with
167 * permissions issues.
171 if (!$top_level && ($parent['wall'] == 0) && stristr($target_item['uri'], $localhost)) {
172 Logger::info('Followup ' . $target_item["guid"]);
173 // local followup to remote post
177 if (empty($parent['allow_cid'])
178 && empty($parent['allow_gid'])
179 && empty($parent['deny_cid'])
180 && empty($parent['deny_gid'])
181 && ($parent['private'] != Item::PRIVATE)) {
182 $public_message = true;
187 Logger::warning('No delivery data', ['command' => $cmd, 'uri-id' => $post_uriid, 'cid' => $contact_id]);
190 $owner = User::getOwnerDataById($uid);
191 if (!DBA::isResult($owner)) {
192 self::setFailedQueue($cmd, $target_item);
196 // We don't deliver our items to blocked, archived or pending contacts, and not to ourselves either
197 $contact = DBA::selectFirst('contact', [],
198 ['id' => $contact_id, 'archive' => false, 'blocked' => false, 'pending' => false, 'self' => false]
200 if (!DBA::isResult($contact)) {
201 self::setFailedQueue($cmd, $target_item);
205 if (Network::isUrlBlocked($contact['url'])) {
206 self::setFailedQueue($cmd, $target_item);
210 $protocol = GServer::getProtocol($contact['gsid'] ?? 0);
212 // Transmit via Diaspora if the thread had started as Diaspora post.
213 // Also transmit via Diaspora if this is a direct answer to a Diaspora comment.
214 // This is done since the uri wouldn't match (Diaspora doesn't transmit it)
215 // Also transmit relayed posts from Diaspora contacts via Diaspora.
216 if (($contact['network'] != Protocol::DIASPORA) && in_array(Protocol::DIASPORA, [$parent['network'] ?? '', $thr_parent['network'] ?? '', $target_item['network'] ?? ''])) {
217 Logger::info('Enforcing the Diaspora protocol', ['id' => $contact['id'], 'network' => $contact['network'], 'parent' => $parent['network'], 'thread-parent' => $thr_parent['network'], 'post' => $target_item['network']]);
218 $contact['network'] = Protocol::DIASPORA;
221 Logger::notice('Delivering', ['cmd' => $cmd, 'uri-id' => $post_uriid, 'followup' => $followup, 'network' => $contact['network']]);
223 switch ($contact['network']) {
225 self::deliverDFRN($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup, $protocol);
228 case Protocol::DIASPORA:
229 self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
233 self::deliverMail($cmd, $contact, $owner, $target_item, $thr_parent);
244 * Increased the "failed" counter in the item delivery data
246 * @param string $cmd Command
247 * @param array $item Item array
251 private static function setFailedQueue(string $cmd, array $item)
253 if ($cmd != Delivery::POST) {
257 Post\DeliveryData::incrementQueueFailed($item['uri-id'] ?? $item['id']);
261 * Deliver content via DFRN
263 * @param string $cmd Command
264 * @param array $contact Contact record of the receiver
265 * @param array $owner Owner record of the sender
266 * @param array $items Item record of the content and the parent
267 * @param array $target_item Item record of the content
268 * @param boolean $public_message Is the content public?
269 * @param boolean $top_level Is it a thread starter?
270 * @param boolean $followup Is it an answer to a remote post?
271 * @param int|null $server_protocol The protocol of the server
274 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
275 * @throws \ImagickException
277 private static function deliverDFRN(string $cmd, array $contact, array $owner, array $items, array $target_item, bool $public_message, bool $top_level, bool $followup, int $server_protocol = null)
279 $target_item_id = $target_item['guid'] ?? '' ?: $target_item['id'] ?? null;
281 // Transmit Diaspora reshares via Diaspora if the Friendica contact support Diaspora
282 if (Diaspora::getReshareDetails($target_item) && Diaspora::isSupportedByContactUrl($contact['addr'])) {
283 Logger::info('Reshare will be transmitted via Diaspora', ['url' => $contact['url'], 'guid' => $target_item_id]);
284 self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
288 Logger::info('Deliver ' . ($target_item_id ?? 'relocation') . ' via DFRN to ' . ($contact['addr'] ?? '' ?: $contact['url']));
290 if ($cmd == self::MAIL) {
291 $item = $target_item;
292 $item['body'] = Item::fixPrivatePhotos($item['body'], $owner['uid'], null, $item['contact-id']);
293 $atom = DFRN::mail($item, $owner);
294 } elseif ($cmd == self::SUGGESTION) {
295 $item = $target_item;
296 $atom = DFRN::fsuggest($item, $owner);
297 DI::fsuggest()->delete(new FriendSuggests([DI::fsuggest()->selectOneById($item['id'])]));
298 } elseif ($cmd == self::RELOCATION) {
299 $atom = DFRN::relocate($owner, $owner['uid']);
300 } elseif ($followup) {
301 $msgitems = [$target_item];
302 $atom = DFRN::entries($msgitems, $owner);
304 if ($target_item['deleted']) {
305 $msgitems = [$target_item];
308 foreach ($items as $item) {
309 // Only add the parent when we don't delete other items.
310 if (($target_item['id'] == $item['id']) || ($cmd != self::DELETION)) {
311 $item['entry:comment-allow'] = true;
312 $item['entry:cid'] = ($top_level ? $contact['id'] : 0);
317 $atom = DFRN::entries($msgitems, $owner);
320 Logger::debug('Notifier entry: ' . $contact['url'] . ' ' . ($target_item_id ?? 'relocation') . ' entry: ' . $atom);
322 $protocol = Post\DeliveryData::DFRN;
324 // We don't have a relationship with contacts on a public post.
325 // Se we transmit with the new method and via Diaspora as a fallback
326 if (!empty($items) && (($items[0]['uid'] == 0) || ($contact['uid'] == 0))) {
327 // Transmit in public if it's a relay post
328 $public_dfrn = ($contact['contact-type'] == Contact::TYPE_RELAY);
330 $deliver_status = DFRN::transmit($owner, $contact, $atom, $public_dfrn);
332 // We never spool failed relay deliveries
334 Logger::info('Relay delivery to ' . $contact['url'] . ' with guid ' . $target_item['guid'] . ' returns ' . $deliver_status);
336 if ($cmd == Delivery::POST) {
337 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
338 Post\DeliveryData::incrementQueueDone($target_item['uri-id'], $protocol);
340 GServer::setProtocol($contact['gsid'] ?? 0, $protocol);
342 Post\DeliveryData::incrementQueueFailed($target_item['uri-id']);
348 if ((($deliver_status < 200) || ($deliver_status > 299)) && (empty($server_protocol) || ($server_protocol == Post\DeliveryData::LEGACY_DFRN))) {
349 // Transmit via Diaspora if not possible via Friendica
350 self::deliverDiaspora($cmd, $contact, $owner, $items, $target_item, $public_message, $top_level, $followup);
354 // DFRN payload over Diaspora transport layer
355 $deliver_status = DFRN::transmit($owner, $contact, $atom);
358 Logger::info('DFRN Delivery', ['cmd' => $cmd, 'url' => $contact['url'], 'guid' => $target_item_id, 'return' => $deliver_status]);
360 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
361 // We successfully delivered a message, the contact is alive
362 Contact::unmarkForArchival($contact);
364 GServer::setProtocol($contact['gsid'] ?? 0, $protocol);
366 if ($cmd == Delivery::POST) {
367 Post\DeliveryData::incrementQueueDone($target_item['uri-id'], $protocol);
370 // The message could not be delivered. We mark the contact as "dead"
371 Contact::markForArchival($contact);
373 Logger::info('Delivery failed: defer message', ['id' => $target_item_id]);
374 if (!Worker::defer() && $cmd == Delivery::POST) {
375 Post\DeliveryData::incrementQueueFailed($target_item['uri-id']);
381 * Deliver content via Diaspora
383 * @param string $cmd Command
384 * @param array $contact Contact record of the receiver
385 * @param array $owner Owner record of the sender
386 * @param array $items Item record of the content and the parent
387 * @param array $target_item Item record of the content
388 * @param boolean $public_message Is the content public?
389 * @param boolean $top_level Is it a thread starter?
390 * @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(string $cmd, array $contact, array $owner, array $items, array $target_item, bool $public_message, bool $top_level, bool $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'] != 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 (!DI::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::notice('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::notice('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::notice('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::notice('diaspora status: ' . $loc);
443 $deliver_status = Diaspora::sendStatus($target_item, $owner, $contact, $public_message);
445 Logger::warning('Unknown mode', ['command' => $cmd, 'target' => $loc]);
449 if (($deliver_status >= 200) && ($deliver_status <= 299)) {
450 // We successfully delivered a message, the contact is alive
451 Contact::unmarkForArchival($contact);
453 GServer::setProtocol($contact['gsid'] ?? 0, Post\DeliveryData::DIASPORA);
455 if ($cmd == Delivery::POST) {
456 Post\DeliveryData::incrementQueueDone($target_item['uri-id'], Post\DeliveryData::DIASPORA);
459 // The message could not be delivered. We mark the contact as "dead"
460 Contact::markForArchival($contact);
462 // When it is delivered to the public endpoint, we do mark the relay contact for archival as well
463 if ($public_message) {
464 Relay::markForArchival($contact);
467 if (empty($contact['contact-type']) || ($contact['contact-type'] != Contact::TYPE_RELAY)) {
468 Logger::info('Delivery failed: defer message', ['id' => ($target_item['guid'] ?? '') ?: $target_item['id']]);
469 // defer message for redelivery
470 if (!Worker::defer() && $cmd == Delivery::POST) {
471 Post\DeliveryData::incrementQueueFailed($target_item['uri-id']);
473 } elseif ($cmd == Delivery::POST) {
474 Post\DeliveryData::incrementQueueFailed($target_item['uri-id']);
480 * Deliver content via mail
482 * @param string $cmd Command
483 * @param array $contact Contact record of the receiver
484 * @param array $owner Owner record of the sender
485 * @param array $target_item Item record of the content
486 * @param array $thr_parent Item record of the direct parent in the thread
489 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
490 * @throws \ImagickException
492 private static function deliverMail(string $cmd, array $contact, array $owner, array $target_item, array $thr_parent)
494 if (DI::config()->get('system', 'imap_disabled')) {
498 $addr = $contact['addr'];
499 if (!strlen($addr)) {
503 if ($cmd != self::POST) {
507 if ($target_item['verb'] != Activity::POST) {
511 if (!empty($thr_parent['object'])) {
512 $data = json_decode($thr_parent['object'], true);
513 if (!empty($data['reply_to'])) {
514 $addr = $data['reply_to'][0]['mailbox'] . '@' . $data['reply_to'][0]['host'];
515 Logger::info('Use "reply-to" address of the thread parent', ['addr' => $addr]);
516 } elseif (!empty($data['from'])) {
517 $addr = $data['from'][0]['mailbox'] . '@' . $data['from'][0]['host'];
518 Logger::info('Use "from" address of the thread parent', ['addr' => $addr]);
522 $local_user = DBA::selectFirst('user', [], ['uid' => $owner['uid']]);
523 if (!DBA::isResult($local_user)) {
527 Logger::info('About to deliver via mail', ['guid' => $target_item['guid'], 'to' => $addr]);
530 $mailacct = DBA::selectFirst('mailacct', ['reply_to'], ['uid' => $owner['uid']]);
531 if (DBA::isResult($mailacct) && !empty($mailacct['reply_to'])) {
532 $reply_to = $mailacct['reply_to'];
535 $subject = ($target_item['title'] ? Email::encodeHeader($target_item['title'], 'UTF-8') : DI::l10n()->t("\x28no subject\x29"));
537 // only expose our real email address to true friends
539 if (($contact['rel'] == Contact::FRIEND) && !$contact['blocked']) {
541 $headers = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8') . ' <' . $reply_to . '>' . "\n";
542 $headers .= 'Sender: ' . $local_user['email'] . "\n";
544 $headers = 'From: ' . Email::encodeHeader($local_user['username'],'UTF-8') . ' <' . $local_user['email'] . '>' . "\n";
547 $sender = DI::config()->get('config', 'sender_email', 'noreply@' . DI::baseUrl()->getHostname());
548 $headers = 'From: '. Email::encodeHeader($local_user['username'], 'UTF-8') . ' <' . $sender . '>' . "\n";
551 $headers .= 'Message-Id: <' . Email::iri2msgid($target_item['uri']) . '>' . "\n";
553 if ($target_item['uri'] !== $target_item['parent-uri']) {
554 $headers .= 'References: <' . Email::iri2msgid($target_item['parent-uri']) . '>';
556 // Export more references on deeper nested threads
557 if (($target_item['thr-parent'] != '') && ($target_item['thr-parent'] != $target_item['parent-uri'])) {
558 $headers .= ' <' . Email::iri2msgid($target_item['thr-parent']) . '>';
563 if (empty($target_item['title'])) {
564 $condition = ['uri' => $target_item['parent-uri'], 'uid' => $owner['uid']];
565 $title = Post::selectFirst(['title'], $condition);
567 if (DBA::isResult($title) && ($title['title'] != '')) {
568 $subject = $title['title'];
570 $condition = ['parent-uri' => $target_item['parent-uri'], 'uid' => $owner['uid']];
571 $title = Post::selectFirst(['title'], $condition);
573 if (DBA::isResult($title) && ($title['title'] != '')) {
574 $subject = $title['title'];
579 if (strncasecmp($subject, 'RE:', 3)) {
580 $subject = 'Re: ' . $subject;
585 $success = Email::send($addr, $subject, $headers, $target_item);
589 Post\DeliveryData::incrementQueueDone($target_item['uri-id'], Post\DeliveryData::MAIL);
590 Logger::info('Delivered via mail', ['guid' => $target_item['guid'], 'to' => $addr, 'subject' => $subject]);
593 Logger::warning('Delivery of mail has FAILED', ['to' => $addr, 'subject' => $subject, 'guid' => $target_item['guid']]);