<?php
/**
- * @file include/enotify.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
use Friendica\Content\Text\BBCode;
*/
function notification($params)
{
+ /** @var string the common prefix of a notification subject */
+ $subjectPrefix = DI::l10n()->t('[Friendica:Notify]');
+
// Temporary logging for finding the origin
if (!isset($params['uid'])) {
Logger::notice('Missing parameters "uid".', ['params' => $params, 'callstack' => System::callstack()]);
}
$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'];
$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 = '';
$hsitelink = '';
$itemlink = '';
- if ($params['type'] == NOTIFY_MAIL) {
+ if ($params['type'] == Notify\Type::MAIL) {
$itemlink = $siteurl.'/message/'.$params['item']['id'];
$params["link"] = $itemlink;
- $subject = $l10n->t('[Friendica:Notify] New mail received at %s', $sitename);
+ $subject = $l10n->t('%s New mail received at %s', $subjectPrefix, $sitename);
$preamble = $l10n->t('%1$s sent you a new private message at %2$s.', $params['source_name'], $sitename);
$epreamble = $l10n->t('%1$s sent you %2$s.', '[url='.$params['source_link'].']'.$params['source_name'].'[/url]', '[url=' . $itemlink . ']' . $l10n->t('a private message').'[/url]');
$hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'/message/'.$params['item']['id'].'">'.$sitename.'</a>');
}
- if ($params['type'] == NOTIFY_COMMENT || $params['type'] == NOTIFY_TAGSELF) {
+ if ($params['type'] == Notify\Type::COMMENT || $params['type'] == Notify\Type::TAG_SELF) {
$thread = Item::selectFirstThreadForUser($params['uid'], ['ignored'], ['iid' => $parent_id, 'deleted' => false]);
if (DBA::isResult($thread) && $thread['ignored']) {
Logger::log('Thread ' . $parent_id . ' will be ignored', Logger::DEBUG);
// Check to see if there was already a tag notify or comment notify for this post.
// If so don't create a second notification
/// @todo In the future we should store the notification with the highest "value" and replace notifications
- $condition = ['type' => [NOTIFY_TAGSELF, NOTIFY_COMMENT, NOTIFY_SHARE],
+ $condition = ['type' => [Notify\Type::TAG_SELF, Notify\Type::COMMENT, Notify\Type::SHARE],
'link' => $params['link'], 'uid' => $params['uid']];
if (DBA::exists('notify', $condition)) {
return false;
// "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.
// Before this we have the name of the replier on the subject rendering
// different subjects for messages on the same thread.
if ($params['activity']['explicit_tagged']) {
- $subject = $l10n->t('[Friendica:Notify] %s tagged you', $params['source_name']);
+ $subject = $l10n->t('%s %s tagged you', $subjectPrefix, $params['source_name']);
$preamble = $l10n->t('%1$s tagged you at %2$s', $params['source_name'], $sitename);
} else {
- $subject = $l10n->t('[Friendica:Notify] Comment to conversation #%1$d by %2$s', $parent_id, $params['source_name']);
+ $subject = $l10n->t('%1$s Comment to conversation #%2$d by %3$s', $subjectPrefix, $parent_id, $params['source_name']);
$preamble = $l10n->t('%s commented on an item/conversation you have been following.', $params['source_name']);
}
$itemlink = $params['link'];
}
- if ($params['type'] == NOTIFY_WALL) {
- $subject = $l10n->t('[Friendica:Notify] %s posted to your profile wall', $params['source_name']);
+ if ($params['type'] == Notify\Type::WALL) {
+ $subject = $l10n->t('%s %s posted to your profile wall', $subjectPrefix, $params['source_name']);
$preamble = $l10n->t('%1$s posted to your profile wall at %2$s', $params['source_name'], $sitename);
$epreamble = $l10n->t('%1$s posted to [url=%2$s]your wall[/url]',
$itemlink = $params['link'];
}
- if ($params['type'] == NOTIFY_SHARE) {
- $subject = $l10n->t('[Friendica:Notify] %s shared a new post', $params['source_name']);
+ if ($params['type'] == Notify\Type::SHARE) {
+ 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);
$itemlink = $params['link'];
}
- if ($params['type'] == NOTIFY_POKE) {
- $subject = $l10n->t('[Friendica:Notify] %1$s poked you', $params['source_name']);
+ if ($params['type'] == Notify\Type::POKE) {
+ $subject = $l10n->t('%1$s %2$s poked you', $subjectPrefix, $params['source_name']);
$preamble = $l10n->t('%1$s poked you at %2$s', $params['source_name'], $sitename);
$epreamble = $l10n->t('%1$s [url=%2$s]poked you[/url].',
$itemlink = $params['link'];
}
- if ($params['type'] == NOTIFY_TAGSHARE) {
+ if ($params['type'] == Notify\Type::TAG_SHARE) {
$itemlink = $params['link'];
- $subject = $l10n->t('[Friendica:Notify] %s tagged your post', $params['source_name']);
+ $subject = $l10n->t('%s %s tagged your post', $subjectPrefix, $params['source_name']);
$preamble = $l10n->t('%1$s tagged your post at %2$s', $params['source_name'], $sitename);
$epreamble = $l10n->t('%1$s tagged [url=%2$s]your post[/url]',
if ($params['type'] == Notify\Type::INTRO) {
$itemlink = $params['link'];
- $subject = $l10n->t('[Friendica:Notify] Introduction received');
+ $subject = $l10n->t('%s Introduction received', $subjectPrefix);
$preamble = $l10n->t('You\'ve received an introduction from \'%1$s\' at %2$s', $params['source_name'], $sitename);
$epreamble = $l10n->t('You\'ve received [url=%1$s]an introduction[/url] from %2$s.',
switch ($params['verb']) {
case Activity::FRIEND:
// someone started to share with user (mostly OStatus)
- $subject = $l10n->t('[Friendica:Notify] A new person is sharing with you');
+ $subject = $l10n->t('%s A new person is sharing with you', $subjectPrefix);
$preamble = $l10n->t('%1$s is sharing with you at %2$s', $params['source_name'], $sitename);
$epreamble = $l10n->t('%1$s is sharing with you at %2$s',
break;
case Activity::FOLLOW:
// someone started to follow the user (mostly OStatus)
- $subject = $l10n->t('[Friendica:Notify] You have a new follower');
+ $subject = $l10n->t('%s You have a new follower', $subjectPrefix);
$preamble = $l10n->t('You have a new follower at %2$s : %1$s', $params['source_name'], $sitename);
$epreamble = $l10n->t('You have a new follower at %2$s : %1$s',
}
}
- if ($params['type'] == NOTIFY_SUGGEST) {
+ if ($params['type'] == Notify\Type::SUGGEST) {
$itemlink = $params['link'];
- $subject = $l10n->t('[Friendica:Notify] Friend suggestion received');
+ $subject = $l10n->t('%s Friend suggestion received', $subjectPrefix);
$preamble = $l10n->t('You\'ve received a friend suggestion from \'%1$s\' at %2$s', $params['source_name'], $sitename);
$epreamble = $l10n->t('You\'ve received [url=%1$s]a friend suggestion[/url] for %2$s from %3$s.',
if ($params['type'] == Notify\Type::CONFIRM) {
if ($params['verb'] == Activity::FRIEND) { // mutual connection
$itemlink = $params['link'];
- $subject = $l10n->t('[Friendica:Notify] Connection accepted');
+ $subject = $l10n->t('%s Connection accepted', $subjectPrefix);
$preamble = $l10n->t('\'%1$s\' has accepted your connection request at %2$s', $params['source_name'], $sitename);
$epreamble = $l10n->t('%2$s has accepted your [url=%1$s]connection request[/url].',
$hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
} else { // ACTIVITY_FOLLOW
$itemlink = $params['link'];
- $subject = $l10n->t('[Friendica:Notify] Connection accepted');
+ $subject = $l10n->t('%s Connection accepted', $subjectPrefix);
$preamble = $l10n->t('\'%1$s\' has accepted your connection request at %2$s', $params['source_name'], $sitename);
$epreamble = $l10n->t('%2$s has accepted your [url=%1$s]connection request[/url].',
}
}
- if ($params['type'] == NOTIFY_SYSTEM) {
+ if ($params['type'] == Notify\Type::SYSTEM) {
switch($params['event']) {
case "SYSTEM_REGISTER_REQUEST":
$itemlink = $params['link'];
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);
// send email notification if notification preferences permit
if ((intval($params['notify_flags']) & intval($params['type']))
- || $params['type'] == NOTIFY_SYSTEM) {
+ || $params['type'] == Notify\Type::SYSTEM) {
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);
}
}
'title' => $title,
'body' => $body,
'subject' => $subject,
- 'headers' => $additional_mail_header,
];
Hook::callAll('enotify_mail', $datarray);
// 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);
* @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;
$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);
}
if ($notification_type & UserItem::NOTIF_SHARED) {
- $params['type'] = NOTIFY_SHARE;
+ $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_TAGSELF;
+ $params['type'] = Notify\Type::TAG_SELF;
$params['verb'] = Activity::TAG;
} elseif ($notification_type & UserItem::NOTIF_IMPLICIT_TAGGED) {
- $params['type'] = NOTIFY_COMMENT;
+ $params['type'] = Notify\Type::COMMENT;
$params['verb'] = Activity::POST;
} elseif ($notification_type & UserItem::NOTIF_THREAD_COMMENT) {
- $params['type'] = NOTIFY_COMMENT;
+ $params['type'] = Notify\Type::COMMENT;
$params['verb'] = Activity::POST;
} elseif ($notification_type & UserItem::NOTIF_DIRECT_COMMENT) {
- $params['type'] = NOTIFY_COMMENT;
+ $params['type'] = Notify\Type::COMMENT;
$params['verb'] = Activity::POST;
} elseif ($notification_type & UserItem::NOTIF_COMMENT_PARTICIPATION) {
- $params['type'] = NOTIFY_COMMENT;
+ $params['type'] = Notify\Type::COMMENT;
$params['verb'] = Activity::POST;
} elseif ($notification_type & UserItem::NOTIF_ACTIVITY_PARTICIPATION) {
- $params['type'] = NOTIFY_COMMENT;
+ $params['type'] = Notify\Type::COMMENT;
$params['verb'] = Activity::POST;
} else {
return false;
https://reisub.nsupdate.info/git / friendica.git / .git / blobdiff