a l10n call too much
[friendica.git/.git] / include / enotify.php
index 18f5dec..10421fb 100644 (file)
@@ -1,6 +1,22 @@
 <?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;
@@ -30,6 +46,9 @@ use Friendica\Protocol\Activity;
  */
 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()]);
@@ -102,11 +121,11 @@ function notification($params)
        $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]');
@@ -116,7 +135,7 @@ function notification($params)
                $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);
@@ -126,7 +145,7 @@ function notification($params)
                // 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;
@@ -134,7 +153,7 @@ function notification($params)
 
                // if it's a post figure out who's post it is.
                $item = null;
-               if ($params['otype'] === Notify::OTYPE_ITEM && $parent_id) {
+               if ($params['otype'] === Notify\ObjectType::ITEM && $parent_id) {
                        $item = Item::selectFirstForUser($params['uid'], Item::ITEM_FIELDLIST, ['id' => $parent_id, 'deleted' => false]);
                }
 
@@ -155,39 +174,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.
@@ -195,11 +214,11 @@ function notification($params)
                // 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']);
                }
@@ -212,8 +231,8 @@ function notification($params)
                $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]',
@@ -227,8 +246,8 @@ function notification($params)
                $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) {
+               $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].',
@@ -242,8 +261,8 @@ function notification($params)
                $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].',
@@ -261,9 +280,9 @@ function notification($params)
                $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]',
@@ -276,9 +295,9 @@ function notification($params)
                $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
        }
 
-       if ($params['type'] == NOTIFY_INTRO) {
+       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.',
@@ -295,7 +314,7 @@ function notification($params)
                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',
@@ -305,7 +324,7 @@ function notification($params)
                                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',
@@ -319,9 +338,9 @@ function notification($params)
                }
        }
 
-       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.',
@@ -339,10 +358,10 @@ function notification($params)
                $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
        }
 
-       if ($params['type'] == NOTIFY_CONFIRM) {
+       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].',
@@ -357,7 +376,7 @@ function notification($params)
                        $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].',
@@ -375,7 +394,7 @@ function notification($params)
                }
        }
 
-       if ($params['type'] == NOTIFY_SYSTEM) {
+       if ($params['type'] == Notify\Type::SYSTEM) {
                switch($params['event']) {
                        case "SYSTEM_REGISTER_REQUEST":
                                $itemlink =  $params['link'];
@@ -456,7 +475,7 @@ function notification($params)
 
        // 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');
 
@@ -589,25 +608,25 @@ function check_item_notification($itemid, $uid, $notification_type) {
        }
 
        if ($notification_type & UserItem::NOTIF_SHARED) {
-               $params['type'] = NOTIFY_SHARE;
+               $params['type'] = Notify\Type::SHARE;
                $params['verb'] = Activity::POST;
        } 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;