Transform email header string to header array & replace it at various situations.
[friendica.git/.git] / include / enotify.php
index 8b24423..478b034 100644 (file)
@@ -87,12 +87,15 @@ function notification($params)
        }
        $nickname = $user["nickname"];
 
+       // Creates a new email builder for the notification email
+       $emailBuilder = DI::emailer()->newNotifyMail();
+
        // with $params['show_in_notification_page'] == false, the notification isn't inserted into
        // the database, and an email is sent if applicable.
        // default, if not specified: true
        $show_in_notification_page = isset($params['show_in_notification_page']) ? $params['show_in_notification_page'] : true;
 
-       $additional_mail_header = "X-Friendica-Account: <".$nickname."@".$hostname.">\n";
+       $emailBuilder->setHeader('X-Friendica-Account', '<' . $nickname . '@' . $hostname . '>');
 
        if (array_key_exists('item', $params)) {
                $title = $params['item']['title'];
@@ -107,12 +110,24 @@ function notification($params)
                $item_id = 0;
        }
 
+       if (isset($params['item']['uri-id'])) {
+               $uri_id = $params['item']['uri-id'];
+       } else {
+               $uri_id = 0;
+       }
+
        if (isset($params['parent'])) {
                $parent_id = $params['parent'];
        } else {
                $parent_id = 0;
        }
 
+       if (isset($params['item']['parent-uri-id'])) {
+               $parent_uri_id = $params['item']['parent-uri-id'];
+       } else {
+               $parent_uri_id = 0;
+       }
+
        $epreamble = '';
        $preamble  = '';
        $subject   = '';
@@ -174,39 +189,39 @@ function notification($params)
 
                // "George Bull's post"
                if ($params['activity']['origin_comment']) {
-                       $message = '%1$s replied to you on %2$s\'s %3$s %4$s';
+                       $message = $l10n->t('%1$s replied to you on %2$s\'s %3$s %4$s');
                } elseif ($params['activity']['explicit_tagged']) {
-                       $message = '%1$s tagged you on %2$s\'s %3$s %4$s';
+                       $message = $l10n->t('%1$s tagged you on %2$s\'s %3$s %4$s');
                } else {
-                       $message = '%1$s commented on %2$s\'s %3$s %4$s';
+                       $message = $l10n->t('%1$s commented on %2$s\'s %3$s %4$s');
                }
 
-               $dest_str = $l10n->t($message, $params['source_name'], $item['author-name'], $item_post_type, $title);
+               $dest_str = sprintf($message, $params['source_name'], $item['author-name'], $item_post_type, $title);
 
                // Then look for the special cases
 
                // "your post"
                if ($params['activity']['origin_thread']) {
                        if ($params['activity']['origin_comment']) {
-                               $message = '%1$s replied to you on your %2$s %3$s';
+                               $message = $l10n->t('%1$s replied to you on your %2$s %3$s');
                        } elseif ($params['activity']['explicit_tagged']) {
-                               $message = '%1$s tagged you on your %2$s %3$s';
+                               $message = $l10n->t('%1$s tagged you on your %2$s %3$s');
                        } else {
-                               $message = '%1$s commented on your %2$s %3$s';
+                               $message = $l10n->t('%1$s commented on your %2$s %3$s');
                        }
 
-                       $dest_str = $l10n->t($message, $params['source_name'], $item_post_type, $title);
+                       $dest_str = sprintf($message, $params['source_name'], $item_post_type, $title);
                // "their post"
                } elseif ($item['author-link'] == $params['source_link']) {
                        if ($params['activity']['origin_comment']) {
-                               $message = '%1$s replied to you on their %2$s %3$s';
+                               $message = $l10n->t('%1$s replied to you on their %2$s %3$s');
                        } elseif ($params['activity']['explicit_tagged']) {
-                               $message = '%1$s tagged you on their %2$s %3$s';
+                               $message = $l10n->t('%1$s tagged you on their %2$s %3$s');
                        } else {
-                               $message = '%1$s commented on their %2$s %3$s';
+                               $message = $l10n->t('%1$s commented on their %2$s %3$s');
                        }
 
-                       $dest_str = $l10n->t($message, $params['source_name'], $item_post_type, $title);
+                       $dest_str = sprintf($message, $params['source_name'], $item_post_type, $title);
                }
 
                // Some mail software relies on subject field for threading.
@@ -247,13 +262,23 @@ function notification($params)
        }
 
        if ($params['type'] == Notify\Type::SHARE) {
-               $subject = $l10n->t('%s %s shared a new post', $subjectPrefix, $params['source_name']);
+               if ($params['origin_link'] == $params['source_link']) {
+                       $subject = $l10n->t('%s %s shared a new post', $subjectPrefix, $params['source_name']);
 
-               $preamble = $l10n->t('%1$s shared a new post at %2$s', $params['source_name'], $sitename);
-               $epreamble = $l10n->t('%1$s [url=%2$s]shared a post[/url].',
-                       '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
-                       $params['link']
-               );
+                       $preamble = $l10n->t('%1$s shared a new post at %2$s', $params['source_name'], $sitename);
+                       $epreamble = $l10n->t('%1$s [url=%2$s]shared a post[/url].',
+                               '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
+                               $params['link']
+                       );
+               } else {
+                       $subject = $l10n->t('%s %s shared a post from %s', $subjectPrefix, $params['source_name'], $params['origin_name']);
+
+                       $preamble = $l10n->t('%1$s shared a post from %2$s at %3$s', $params['source_name'], $params['origin_name'], $sitename);
+                       $epreamble = $l10n->t('%1$s [url=%2$s]shared a post[/url] from %3$s.',
+                               '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
+                               $params['link'], '[url='.$params['origin_link'].']'.$params['origin_name'].'[/url]'
+                       );                      
+               }
 
                $sitelink = $l10n->t('Please visit %s to view and/or reply to the conversation.');
                $tsitelink = sprintf($sitelink, $siteurl);
@@ -452,19 +477,26 @@ function notification($params)
 
        if ($show_in_notification_page) {
                $notification = DI::notify()->insert([
-                       'name'       => $params['source_name'] ?? '',
-                       'name_cache' => strip_tags(BBCode::convert($params['source_name'] ?? '')),
-                       'url'        => $params['source_link'] ?? '',
-                       'photo'      => $params['source_photo'] ?? '',
-                       'link'       => $itemlink ?? '',
-                       'uid'        => $params['uid'] ?? 0,
-                       'iid'        => $item_id ?? 0,
-                       'parent'     => $parent_id ?? 0,
-                       'type'       => $params['type'] ?? '',
-                       'verb'       => $params['verb'] ?? '',
-                       'otype'      => $params['otype'] ?? '',
+                       'name'          => $params['source_name'] ?? '',
+                       'name_cache'    => substr(strip_tags(BBCode::convert($params['source_name'])), 0, 255),
+                       'url'           => $params['source_link'] ?? '',
+                       'photo'         => $params['source_photo'] ?? '',
+                       'link'          => $itemlink ?? '',
+                       'uid'           => $params['uid'] ?? 0,
+                       'iid'           => $item_id,
+                       'uri-id'        => $uri_id,
+                       'parent'        => $parent_id,
+                       'parent-uri-id' => $parent_uri_id,
+                       'type'          => $params['type'] ?? '',
+                       'verb'          => $params['verb'] ?? '',
+                       'otype'         => $params['otype'] ?? '',
                ]);
 
+               // Notification insertion can be intercepted by an addon registering the 'enotify_store' hook
+               if (!$notification) {
+                       return false;
+               }
+
                $notification->msg = Renderer::replaceMacros($epreamble, ['$itemlink' => $notification->link]);
 
                DI::notify()->update($notification);
@@ -480,23 +512,26 @@ function notification($params)
                Logger::log('sending notification email');
 
                if (isset($params['parent']) && (intval($params['parent']) != 0)) {
-                       $id_for_parent = $params['parent'] . "@" . $hostname;
+                       $parent = Item::selectFirst(['guid'], ['id' => $params['parent']]);
+                       $message_id = "<" . $parent['guid'] . "@" . gethostname() . ">";
 
                        // Is this the first email notification for this parent item and user?
                        if (!DBA::exists('notify-threads', ['master-parent-item' => $params['parent'], 'receiver-uid' => $params['uid']])) {
                                Logger::log("notify_id:" . intval($notify_id) . ", parent: " . intval($params['parent']) . "uid: " . intval($params['uid']), Logger::DEBUG);
 
-                               $fields = ['notify-id'    => $notify_id, 'master-parent-item' => $params['parent'],
-                                          'receiver-uid' => $params['uid'], 'parent-item' => 0];
+                               $fields = ['notify-id' => $notify_id, 'master-parent-item' => $params['parent'],
+                                       'master-parent-uri-id' => $parent_uri_id,
+                                       'receiver-uid' => $params['uid'], 'parent-item' => 0];
                                DBA::insert('notify-threads', $fields);
 
-                               $additional_mail_header .= "Message-ID: <${id_for_parent}>\n";
+                               $emailBuilder->setHeader('Message-ID', $message_id);
                                $log_msg                = "include/enotify: No previous notification found for this parent:\n" .
                                                          "  parent: ${params['parent']}\n" . "  uid   : ${params['uid']}\n";
                                Logger::log($log_msg, Logger::DEBUG);
                        } else {
                                // If not, just "follow" the thread.
-                               $additional_mail_header .= "References: <${id_for_parent}>\nIn-Reply-To: <${id_for_parent}>\n";
+                               $emailBuilder->setHeader('References', $message_id);
+                               $emailBuilder->setHeader('In-Reply-To', $message_id);
                                Logger::log("There's already a notification for this parent.", Logger::DEBUG);
                        }
                }
@@ -515,7 +550,6 @@ function notification($params)
                        'title'        => $title,
                        'body'         => $body,
                        'subject'      => $subject,
-                       'headers'      => $additional_mail_header,
                ];
 
                Hook::callAll('enotify_mail', $datarray);
@@ -534,13 +568,13 @@ function notification($params)
 
                // If a photo is present, add it to the email
                if (!empty($datarray['source_photo'])) {
-                       $builder->withPhoto(
+                       $emailBuilder->withPhoto(
                                $datarray['source_photo'],
                                $datarray['source_link'] ?? $sitelink,
                                $datarray['source_name'] ?? $sitename);
                }
 
-               $email = $builder->build();
+               $email = $emailBuilder->build();
 
                // use the Emailer class to send the message
                return DI::emailer()->send($email);
@@ -574,10 +608,10 @@ function check_user_notification($itemid) {
  * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  */
 function check_item_notification($itemid, $uid, $notification_type) {
-       $fields = ['id', 'mention', 'tag', 'parent', 'title', 'body',
-               'author-link', 'author-name', 'author-avatar', 'author-id',
-               'guid', 'parent-uri', 'uri', 'contact-id', 'network'];
-       $condition = ['id' => $itemid, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT], 'deleted' => false];
+       $fields = ['id', 'uri-id', 'mention', 'parent', 'parent-uri-id', 'thr-parent-id',
+               'title', 'body', 'author-link', 'author-name', 'author-avatar', 'author-id',
+               'gravity', 'guid', 'parent-uri', 'uri', 'contact-id', 'network'];
+       $condition = ['id' => $itemid, 'deleted' => false];
        $item = Item::selectFirstForUser($uid, $fields, $condition);
        if (!DBA::isResult($item)) {
                return false;
@@ -590,9 +624,9 @@ function check_item_notification($itemid, $uid, $notification_type) {
        $params['parent'] = $item['parent'];
        $params['link'] = DI::baseUrl() . '/display/' . urlencode($item['guid']);
        $params['otype'] = 'item';
-       $params['source_name'] = $item['author-name'];
-       $params['source_link'] = $item['author-link'];
-       $params['source_photo'] = $item['author-avatar'];
+       $params['origin_name'] = $params['source_name'] = $item['author-name'];
+       $params['origin_link'] = $params['source_link'] = $item['author-link'];
+       $params['origin_photo'] = $params['source_photo'] = $item['author-avatar'];
 
        // Set the activity flags
        $params['activity']['explicit_tagged'] = ($notification_type & UserItem::NOTIF_EXPLICIT_TAGGED);
@@ -610,6 +644,22 @@ function check_item_notification($itemid, $uid, $notification_type) {
        if ($notification_type & UserItem::NOTIF_SHARED) {
                $params['type'] = Notify\Type::SHARE;
                $params['verb'] = Activity::POST;
+
+               // Special treatment for posts that had been shared via "announce"
+               if ($item['gravity'] == GRAVITY_ACTIVITY) {
+                       $parent_item = Item::selectFirst($fields, ['uri-id' => $item['thr-parent-id'], 'uid' => [$uid, 0]]);
+                       if (DBA::isResult($parent_item)) {
+                               // Don't notify on own entries
+                               if (User::getIdForURL($parent_item['author-link']) == $uid) {
+                                       return false;
+                               }
+
+                               $params['origin_name'] = $parent_item['author-name'];
+                               $params['origin_link'] = $parent_item['author-link'];
+                               $params['origin_photo'] = $parent_item['author-avatar'];
+                               $params['item'] = $parent_item;
+                       }
+               }
        } elseif ($notification_type & UserItem::NOTIF_EXPLICIT_TAGGED) {
                $params['type'] = Notify\Type::TAG_SELF;
                $params['verb'] = Activity::TAG;