]> git.mxchange.org Git - friendica.git/blobdiff - include/enotify.php
Reliably diasplay "like" and "share" notifications
[friendica.git] / include / enotify.php
index eb56603277c5dc8f374224688ffb7980fcf6ee7e..7eae51a0b5f2c86e3efcb1ff66f839124f55139c 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2021, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -32,7 +32,7 @@ use Friendica\Model\Item;
 use Friendica\Model\Notification;
 use Friendica\Model\Post;
 use Friendica\Model\User;
-use Friendica\Model\UserItem;
+use Friendica\Model\Verb;
 use Friendica\Protocol\Activity;
 
 /**
@@ -42,7 +42,7 @@ use Friendica\Protocol\Activity;
  *                      type, event, otype, activity, verb, uid, cid, origin_cid, item, link,
  *                      source_name, source_mail, source_nick, source_link, source_photo,
  *                      show_in_notification_page
- * 
+ *
  * @return bool
  * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  */
@@ -70,8 +70,6 @@ function notification($params)
                return false;
        }
 
-       $nickname = $user['nickname'];
-
        $params['notify_flags'] = $user['notify-flags'];
        $params['language']     = $user['language'];
        $params['to_name']      = $user['username'];
@@ -101,26 +99,14 @@ function notification($params)
        $siteurl = DI::baseUrl()->get(true);
        $sitename = DI::config()->get('config', 'sitename');
 
-       $hostname = DI::baseUrl()->getHostname();
-       if (strpos($hostname, ':')) {
-               $hostname = substr($hostname, 0, strpos($hostname, ':'));
-       }
-
-       // 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;
 
-       $emailBuilder->setHeader('X-Friendica-Account', '<' . $nickname . '@' . $hostname . '>');
-
        $title = $params['item']['title'] ?? '';
        $body = $params['item']['body'] ?? '';
 
-       $item_id = $params['item']['id'] ?? 0;
-       $uri_id = $params['item']['uri-id'] ?? 0;
        $parent_id = $params['item']['parent'] ?? 0;
        $parent_uri_id = $params['item']['parent-uri-id'] ?? 0;
 
@@ -148,21 +134,21 @@ function notification($params)
                $show_in_notification_page = false;
        }
 
-       if ($params['type'] == Notification\Type::COMMENT || $params['type'] == Notification\Type::TAG_SELF) {
-               $thread = Post::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);
-                       return false;
-               }
-
-               // 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
+       // Check to see if there was already a tag notify or comment notify for this post.
+       // If so don't create a second notification
+       if (in_array($params['type'], [Notification\Type::TAG_SELF, Notification\Type::COMMENT, Notification\Type::SHARE])) {
                $condition = ['type' => [Notification\Type::TAG_SELF, Notification\Type::COMMENT, Notification\Type::SHARE],
                        'link' => $params['link'], 'uid' => $params['uid']];
                if (DBA::exists('notify', $condition)) {
                        return false;
                }
+       }
+
+       if ($params['type'] == Notification\Type::COMMENT || $params['type'] == Notification\Type::TAG_SELF) {
+               if (Post\ThreadUser::getIgnored($parent_uri_id, $params['uid'])) {
+                       Logger::info('Thread is ignored', ['parent' => $parent_id, 'parent-uri-id' => $parent_uri_id]);
+                       return false;
+               }
 
                // if it's a post figure out who's post it is.
                $item = null;
@@ -174,7 +160,7 @@ function notification($params)
                        return false;
                }
 
-               $item_post_type = Item::postType($item);
+               $item_post_type = Item::postType($item, $l10n);
 
                $content = Plaintext::getPost($item, 70);
                if (!empty($content['text'])) {
@@ -186,9 +172,9 @@ function notification($params)
                // First go for the general message
 
                // "George Bull's post"
-               if ($params['activity']['origin_comment']) {
+               if (!empty($params['activity']['origin_comment'])) {
                        $message = $l10n->t('%1$s replied to you on %2$s\'s %3$s %4$s');
-               } elseif ($params['activity']['explicit_tagged']) {
+               } elseif (!empty($params['activity']['explicit_tagged'])) {
                        $message = $l10n->t('%1$s tagged you on %2$s\'s %3$s %4$s');
                } else {
                        $message = $l10n->t('%1$s commented on %2$s\'s %3$s %4$s');
@@ -199,10 +185,10 @@ function notification($params)
                // Then look for the special cases
 
                // "your post"
-               if ($params['activity']['origin_thread']) {
-                       if ($params['activity']['origin_comment']) {
+               if (!empty($params['activity']['origin_thread'])) {
+                       if (!empty($params['activity']['origin_comment'])) {
                                $message = $l10n->t('%1$s replied to you on your %2$s %3$s');
-                       } elseif ($params['activity']['explicit_tagged']) {
+                       } elseif (!empty($params['activity']['explicit_tagged'])) {
                                $message = $l10n->t('%1$s tagged you on your %2$s %3$s');
                        } else {
                                $message = $l10n->t('%1$s commented on your %2$s %3$s');
@@ -211,9 +197,9 @@ function notification($params)
                        $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']) {
+                       if (!empty($params['activity']['origin_comment'])) {
                                $message = $l10n->t('%1$s replied to you on their %2$s %3$s');
-                       } elseif ($params['activity']['explicit_tagged']) {
+                       } elseif (!empty($params['activity']['explicit_tagged'])) {
                                $message = $l10n->t('%1$s tagged you on their %2$s %3$s');
                        } else {
                                $message = $l10n->t('%1$s commented on their %2$s %3$s');
@@ -226,7 +212,7 @@ function notification($params)
                // So, we cannot have different subjects for notifications of the same thread.
                // 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']) {
+               if (!empty($params['activity']['explicit_tagged'])) {
                        $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);
@@ -275,7 +261,7 @@ function notification($params)
                        $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.');
@@ -444,6 +430,34 @@ function notification($params)
                }
        }
 
+       return notification_store_and_send($params, $sitelink, $tsitelink, $hsitelink, $title, $subject, $preamble, $epreamble, $body, $itemlink, $show_in_notification_page);
+}
+
+function notification_store_and_send($params, $sitelink, $tsitelink, $hsitelink, $title, $subject, $preamble, $epreamble, $body, $itemlink, $show_in_notification_page)
+{
+       $item_id = $params['item']['id'] ?? 0;
+       $uri_id = $params['item']['uri-id'] ?? 0;
+       $parent_id = $params['item']['parent'] ?? 0;
+       $parent_uri_id = $params['item']['parent-uri-id'] ?? 0;
+
+       // Ensure that the important fields are set at any time
+       $fields = ['nickname'];
+       $user = User::getById($params['uid'], $fields);
+
+       $sitename = DI::config()->get('config', 'sitename');
+
+       $nickname = $user['nickname'];
+
+       $hostname = DI::baseUrl()->getHostname();
+       if (strpos($hostname, ':')) {
+               $hostname = substr($hostname, 0, strpos($hostname, ':'));
+       }
+
+       // Creates a new email builder for the notification email
+       $emailBuilder = DI::emailer()->newNotifyMail();
+
+       $emailBuilder->setHeader('X-Friendica-Account', '<' . $nickname . '@' . $hostname . '>');
+
        $subject .= " (".$nickname."@".$hostname.")";
 
        $h = [
@@ -476,7 +490,7 @@ function notification($params)
        if ($show_in_notification_page) {
                $fields = [
                        'name'          => $params['source_name'] ?? '',
-                       'name_cache'    => substr(strip_tags(BBCode::convert($params['source_name'])), 0, 255),
+                       'name_cache'    => substr(strip_tags(BBCode::convertForUriId($uri_id, $params['source_name'])), 0, 255),
                        'url'           => $params['source_link'] ?? '',
                        'photo'         => $params['source_photo'] ?? '',
                        'link'          => $itemlink ?? '',
@@ -523,17 +537,16 @@ function notification($params)
                        $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']])) {
+                       if (!DBA::exists('notify-threads', ['master-parent-uri-id' => $parent_uri_id, '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'],
-                                       'master-parent-uri-id' => $parent_uri_id,
+                               $fields = ['notify-id' => $notify_id, 'master-parent-uri-id' => $parent_uri_id,
                                        'receiver-uid' => $params['uid'], 'parent-item' => 0];
                                DBA::insert('notify-threads', $fields);
 
                                $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";
+                               $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.
@@ -590,35 +603,146 @@ function notification($params)
        return false;
 }
 
+function notification_from_array(array $notification)
+{
+       Logger::info('Start', ['uid' => $notification['uid'], 'id' => $notification['id'], 'type' => $notification['type']]);
+
+       if ($notification['type'] == Post\UserNotification::NOTIF_NONE) {
+               Logger::info('Not an item based notification, quitting', ['uid' => $notification['uid'], 'id' => $notification['id'], 'type' => $notification['type']]);
+               return false;
+       }
+
+       $params = [];
+       $params['verb'] = Verb::getByID($notification['vid']);
+
+       $params['uid']   = $notification['uid'];
+       $params['otype'] = Notification\ObjectType::ITEM;
+
+       $user = User::getById($notification['uid']);
+
+       $params['notify_flags'] = $user['notify-flags'];
+       $params['language']     = $user['language'];
+       $params['to_name']      = $user['username'];
+       $params['to_email']     = $user['email'];
+
+       // from here on everything is in the recipients language
+       $l10n = DI::l10n()->withLang($user['language']);
+
+       $contact = Contact::getById($notification['actor-id'], ['url', 'name', 'photo']);
+       if (DBA::isResult($contact)) {
+               $params['source_link']  = $params['origin_link']  = $contact['url'];
+               $params['source_name']  = $params['origin_name']  = $contact['name'];
+               $params['source_photo'] = $params['origin_photo'] = $contact['photo'];
+       }
+
+       $item = Post::selectFirstForUser($notification['uid'], Item::ITEM_FIELDLIST,
+               ['uid' => [0, $notification['uid']], 'uri-id' => $notification['target-uri-id'], 'deleted' => false],
+               ['order' => ['uid' => true]]);
+       if (empty($item)) {
+               Logger::info('Item not found', ['uri-id' => $notification['target-uri-id'], 'type' => $notification['type']]);
+               return false;
+       }
+
+       $params['item']   = $item;
+       $params['parent'] = $item['parent'];
+       $params['link']   = DI::baseUrl() . '/display/' . urlencode($item['guid']);
+
+       $subjectPrefix = $l10n->t('[Friendica:Notify]');
+
+       if (Post\ThreadUser::getIgnored($notification['parent-uri-id'], $notification['uid'])) {
+               Logger::info('Thread is ignored', ['parent-uri-id' => $notification['parent-uri-id'], 'type' => $notification['type']]);
+               return false;
+       }
+
+       // Check to see if there was already a tag notify or comment notify for this post.
+       // If so don't create a second notification
+       $condition = ['type' => [Notification\Type::TAG_SELF, Notification\Type::COMMENT, Notification\Type::SHARE],
+               'link' => $params['link'], 'verb' => Activity::POST, 'uid' => $notification['uid']];
+       if (DBA::exists('notify', $condition)) {
+               Logger::info('Duplicate found, quitting', $condition);
+               return false;
+       }
+
+       $content = Plaintext::getPost($item, 70);
+       if (!empty($content['text'])) {
+               $title = '"' . trim(str_replace("\n", " ", $content['text'])) . '"';
+       } else {
+               $title = $item['title'];
+       }
+
+       // Some mail software relies on subject field for threading.
+       // So, we cannot have different subjects for notifications of the same thread.
+       // Before this we have the name of the replier on the subject rendering
+       // different subjects for messages on the same thread.
+       if ($notification['type'] == Post\UserNotification::NOTIF_EXPLICIT_TAGGED) {
+               $params['type'] = Notification\Type::TAG_SELF;
+               $subject        = $l10n->t('%s %s tagged you', $subjectPrefix, $contact['name']);
+       } elseif ($notification['type'] == Post\UserNotification::NOTIF_SHARED) {
+               $params['type'] = Notification\Type::SHARE;
+               $subject        = $l10n->t('%s %s shared a new post', $subjectPrefix, $contact['name']);
+       } else {
+               $params['type'] = Notification\Type::COMMENT;
+               $subject        = $l10n->t('%1$s Comment to conversation #%2$d by %3$s', $subjectPrefix, $item['parent'], $contact['name']);
+       }
+
+       $msg = Notification::getMessage($notification);
+       if (empty($msg)) {
+               Logger::info('No notification message, quitting', ['uid' => $notification['uid'], 'id' => $notification['id'], 'type' => $notification['type']]);
+               return false;
+       }
+
+       $preamble  = $msg['plain'];
+       $epreamble = $msg['rich'];
+
+       $sitename = DI::config()->get('config', 'sitename');
+       $siteurl  = DI::baseUrl()->get(true);
+
+       $sitelink  = $l10n->t('Please visit %s to view and/or reply to the conversation.');
+       $tsitelink = sprintf($sitelink, $siteurl);
+       $hsitelink = sprintf($sitelink, '<a href="' . $siteurl . '">' . $sitename . '</a>');
+       $itemlink  = $params['link'];
+
+       Logger::info('Perform notification', ['uid' => $notification['uid'], 'id' => $notification['id'], 'type' => $notification['type']]);
+
+       return notification_store_and_send($params, $sitelink, $tsitelink, $hsitelink, $title, $subject, $preamble, $epreamble, $item['body'], $itemlink, true);
+}
+
 /**
  * Checks for users who should be notified
  *
- * @param int $itemid ID of the item for which the check should be done
+ * @param int $uri_id URI ID of the item for which the check should be done
+ * @param int $uid    User ID of the item
  * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  */
-function check_user_notification($itemid) {
-       // fetch all users with notifications
-       $useritems = DBA::select('user-item', ['uid', 'notification-type'], ['iid' => $itemid]);
-       while ($useritem = DBA::fetch($useritems)) {
-               check_item_notification($itemid, $useritem['uid'], $useritem['notification-type']);
+function check_user_notification(int $uri_id, int $uid) {
+       $condition = ['uri-id' => $uri_id];
+
+       // fetch all users with notifications on public posts
+       if ($uid != 0) {
+               $condition['uid'] = $uid;
+       }
+
+       $usernotifications = DBA::select('post-user-notification', ['uri-id', 'uid', 'notification-type'], $condition);
+       while ($usernotification = DBA::fetch($usernotifications)) {
+               check_item_notification($usernotification['uri-id'], $usernotification['uid'], $usernotification['notification-type'], $uid);
        }
-       DBA::close($useritems);
+       DBA::close($usernotifications);
 }
 
 /**
  * Checks for item related notifications and sends them
  *
- * @param int    $itemid            ID of the item for which the check should be done
+ * @param int    $uri_id            URI ID of the item for which the check should be done
  * @param int    $uid               User ID
  * @param int    $notification_type Notification bits
  * @return bool
  * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  */
-function check_item_notification($itemid, $uid, $notification_type) {
+function check_item_notification(int $uri_id, int $uid, int $notification_type, $post_uid) {
        $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];
+       $condition = ['uri-id' => $uri_id, 'uid' => [$uid, $post_uid], 'deleted' => false];
        $item = Post::selectFirstForUser($uid, $fields, $condition);
        if (!DBA::isResult($item)) {
                return false;
@@ -638,19 +762,19 @@ function check_item_notification($itemid, $uid, $notification_type) {
        $params['link'] = DI::baseUrl() . '/display/' . urlencode($item['guid']);
 
        // Set the activity flags
-       $params['activity']['explicit_tagged'] = ($notification_type & UserItem::NOTIF_EXPLICIT_TAGGED);
-       $params['activity']['implicit_tagged'] = ($notification_type & UserItem::NOTIF_IMPLICIT_TAGGED);
-       $params['activity']['origin_comment'] = ($notification_type & UserItem::NOTIF_DIRECT_COMMENT);
-       $params['activity']['origin_thread'] = ($notification_type & UserItem::NOTIF_THREAD_COMMENT);
-       $params['activity']['thread_comment'] = ($notification_type & UserItem::NOTIF_COMMENT_PARTICIPATION);
-       $params['activity']['thread_activity'] = ($notification_type & UserItem::NOTIF_ACTIVITY_PARTICIPATION);
+       $params['activity']['explicit_tagged'] = ($notification_type & Post\UserNotification::NOTIF_EXPLICIT_TAGGED);
+       $params['activity']['implicit_tagged'] = ($notification_type & Post\UserNotification::NOTIF_IMPLICIT_TAGGED);
+       $params['activity']['origin_comment'] = ($notification_type & Post\UserNotification::NOTIF_DIRECT_COMMENT);
+       $params['activity']['origin_thread'] = ($notification_type & Post\UserNotification::NOTIF_THREAD_COMMENT);
+       $params['activity']['thread_comment'] = ($notification_type & Post\UserNotification::NOTIF_COMMENT_PARTICIPATION);
+       $params['activity']['thread_activity'] = ($notification_type & Post\UserNotification::NOTIF_ACTIVITY_PARTICIPATION);
 
        // Tagging a user in a direct post (first comment level) means a direct comment
-       if ($params['activity']['explicit_tagged'] && ($notification_type & UserItem::NOTIF_DIRECT_THREAD_COMMENT)) {
+       if ($params['activity']['explicit_tagged'] && ($notification_type & Post\UserNotification::NOTIF_DIRECT_THREAD_COMMENT)) {
                $params['activity']['origin_comment'] = true;
        }
 
-       if ($notification_type & UserItem::NOTIF_SHARED) {
+       if ($notification_type & Post\UserNotification::NOTIF_SHARED) {
                $params['type'] = Notification\Type::SHARE;
                $params['verb'] = Activity::POST;
 
@@ -667,22 +791,22 @@ function check_item_notification($itemid, $uid, $notification_type) {
                                $params['item'] = $parent_item;
                        }
                }
-       } elseif ($notification_type & UserItem::NOTIF_EXPLICIT_TAGGED) {
+       } elseif ($notification_type & Post\UserNotification::NOTIF_EXPLICIT_TAGGED) {
                $params['type'] = Notification\Type::TAG_SELF;
                $params['verb'] = Activity::TAG;
-       } elseif ($notification_type & UserItem::NOTIF_IMPLICIT_TAGGED) {
+       } elseif ($notification_type & Post\UserNotification::NOTIF_IMPLICIT_TAGGED) {
                $params['type'] = Notification\Type::COMMENT;
                $params['verb'] = Activity::POST;
-       } elseif ($notification_type & UserItem::NOTIF_THREAD_COMMENT) {
+       } elseif ($notification_type & Post\UserNotification::NOTIF_THREAD_COMMENT) {
                $params['type'] = Notification\Type::COMMENT;
                $params['verb'] = Activity::POST;
-       } elseif ($notification_type & UserItem::NOTIF_DIRECT_COMMENT) {
+       } elseif ($notification_type & Post\UserNotification::NOTIF_DIRECT_COMMENT) {
                $params['type'] = Notification\Type::COMMENT;
                $params['verb'] = Activity::POST;
-       } elseif ($notification_type & UserItem::NOTIF_COMMENT_PARTICIPATION) {
+       } elseif ($notification_type & Post\UserNotification::NOTIF_COMMENT_PARTICIPATION) {
                $params['type'] = Notification\Type::COMMENT;
                $params['verb'] = Activity::POST;
-       } elseif ($notification_type & UserItem::NOTIF_ACTIVITY_PARTICIPATION) {
+       } elseif ($notification_type & Post\UserNotification::NOTIF_ACTIVITY_PARTICIPATION) {
                $params['type'] = Notification\Type::COMMENT;
                $params['verb'] = Activity::POST;
        } else {