]> git.mxchange.org Git - friendica.git/blobdiff - include/enotify.php
Fix potential bugs without expected behavior change
[friendica.git] / include / enotify.php
index 339e31a3c810e01c14d3fc681e2462e687e42086..800158d9ae98df54b6687791e2c53ec0469b0b69 100644 (file)
@@ -4,8 +4,8 @@
  */
 
 use Friendica\Content\Text\BBCode;
-use Friendica\Core\Addon;
 use Friendica\Core\Config;
+use Friendica\Core\Hook;
 use Friendica\Core\L10n;
 use Friendica\Core\Logger;
 use Friendica\Core\Renderer;
@@ -15,19 +15,22 @@ use Friendica\Model\Contact;
 use Friendica\Model\Item;
 use Friendica\Util\DateTimeFormat;
 use Friendica\Util\Emailer;
+use Friendica\Util\Strings;
 
 /**
  * @brief Creates a notification entry and possibly sends a mail
  *
  * @param array $params Array with the elements:
- *                     uid, item, parent, type, otype, verb, event,
- *                     link, subject, body, to_name, to_email, source_name,
- *                     source_link, activity, preamble, notify_flags,
- *                     language, show_in_notification_page
+ *                      uid, item, parent, type, otype, verb, event,
+ *                      link, subject, body, to_name, to_email, source_name,
+ *                      source_link, activity, preamble, notify_flags,
+ *                      language, show_in_notification_page
+ * @return bool|object
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  */
 function notification($params)
 {
-       $a = get_app();
+       $a = \get_app();
 
        // Temporary logging for finding the origin
        if (!isset($params['language']) || !isset($params['uid'])) {
@@ -75,7 +78,7 @@ function notification($params)
                        ['uid' => $params['uid']]);
 
                // There is no need to create notifications for forum accounts
-               if (!DBA::isResult($user) || in_array($user["page-flags"], [Contact::PAGE_COMMUNITY, Contact::PAGE_PRVGROUP])) {
+               if (!DBA::isResult($user) || in_array($user["page-flags"], [User::PAGE_FLAGS_COMMUNITY, User::PAGE_FLAGS_PRVGROUP])) {
                        return;
                }
                $nickname = $user["nickname"];
@@ -117,6 +120,12 @@ function notification($params)
        }
 
        $epreamble = '';
+       $preamble  = '';
+       $subject   = '';
+       $sitelink  = '';
+       $tsitelink = '';
+       $hsitelink = '';
+       $itemlink  = '';
 
        if ($params['type'] == NOTIFY_MAIL) {
                $itemlink = $siteurl.'/message/'.$params['item']['id'];
@@ -125,17 +134,17 @@ function notification($params)
                $subject = L10n::t('[Friendica:Notify] New mail received at %s', $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]');
+               $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]');
 
                $sitelink = L10n::t('Please visit %s to view and/or reply to your private messages.');
                $tsitelink = sprintf($sitelink, $siteurl.'/message/'.$params['item']['id']);
                $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'/message/'.$params['item']['id'].'">'.$sitename.'</a>');
        }
 
-       if ($params['type'] == NOTIFY_COMMENT) {
-               $thread = Item::selectFirstThreadForUser($params['uid'] ,['ignored'], ['iid' => $parent_id]);
-               if (DBA::isResult($thread) && $thread["ignored"]) {
-                       Logger::log("Thread ".$parent_id." will be ignored", Logger::DEBUG);
+       if ($params['type'] == NOTIFY_COMMENT || $params['type'] == NOTIFY_TAGSELF) {
+               $thread = Item::selectFirstThreadForUser($params['uid']['ignored'], ['iid' => $parent_id]);
+               if (DBA::isResult($thread) && $thread['ignored']) {
+                       Logger::log('Thread ' . $parent_id . ' will be ignored', Logger::DEBUG);
                        L10n::popLang();
                        return;
                }
@@ -150,55 +159,101 @@ function notification($params)
                }
 
                // if it's a post figure out who's post it is.
-
                $item = null;
-
                if ($params['otype'] === 'item' && $parent_id) {
                        $item = Item::selectFirstForUser($params['uid'], Item::ITEM_FIELDLIST, ['id' => $parent_id]);
                }
 
-               $item_post_type = item_post_type($item);
+               $item_post_type = Item::postType($item);
                $itemlink = $item['plink'];
 
                // "a post"
-               $dest_str = L10n::t('%1$s commented on [url=%2$s]a %3$s[/url]',
-                       '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
-                       $itemlink,
-                       $item_post_type
-               );
-
-               // "George Bull's post"
-               if ($item) {
-                       $dest_str = L10n::t('%1$s commented on [url=%2$s]%3$s\'s %4$s[/url]',
-                               '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
+               if ($params['type'] == NOTIFY_TAGSELF) {
+                       $dest_str = L10n::t('%1$s tagged you on [url=%2$s]a %3$s[/url]',
+                               '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
                                $itemlink,
-                               $item['author-name'],
                                $item_post_type
                        );
+               } else {
+                       $dest_str = L10n::t('%1$s commented on [url=%2$s]a %3$s[/url]',
+                               '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
+                               $itemlink,
+                               $item_post_type
+                       );
+               }
+
+               // "George Bull's post"
+               if (DBA::isResult($item)) {
+                       if ($params['type'] == NOTIFY_TAGSELF) {
+                               $dest_str = L10n::t('%1$s tagged you on [url=%2$s]%3$s\'s %4$s[/url]',
+                                       '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
+                                       $itemlink,
+                                       $item['author-name'],
+                                       $item_post_type
+                               );
+                       } else {
+                               $dest_str = L10n::t('%1$s commented on [url=%2$s]%3$s\'s %4$s[/url]',
+                                       '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
+                                       $itemlink,
+                                       $item['author-name'],
+                                       $item_post_type
+                               );
+                       }
                }
 
                // "your post"
                if (DBA::isResult($item) && $item['owner-id'] == $item['author-id'] && $item['wall']) {
-                       $dest_str = L10n::t('%1$s commented on [url=%2$s]your %3$s[/url]',
-                               '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
-                               $itemlink,
-                               $item_post_type
-                       );
+                       if ($params['type'] == NOTIFY_TAGSELF) {
+                               $dest_str = L10n::t('%1$s tagged you on [url=%2$s]your %3$s[/url]',
+                                       '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
+                                       $itemlink,
+                                       $item_post_type
+                               );
+                       } else {
+                               $dest_str = L10n::t('%1$s commented on [url=%2$s]your %3$s[/url]',
+                                       '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
+                                       $itemlink,
+                                       $item_post_type
+                               );
+                       }
                }
 
-               // Some mail softwares relies on subject field for threading.
+               // "their post"
+               if (DBA::isResult($item) && $item['author-link'] == $params['source_link']) {
+                       if ($params['type'] == NOTIFY_TAGSELF) {
+                               $dest_str = L10n::t('%1$s tagged you on [url=%2$s]their %3$s[/url]',
+                                       '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
+                                       $itemlink,
+                                       $item_post_type
+                               );
+                       } else {
+                               $dest_str = L10n::t('%1$s commented on [url=%2$s]their %3$s[/url]',
+                                       '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
+                                       $itemlink,
+                                       $item_post_type
+                               );
+                       }
+               }
+
+               // 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
-               // differents subjects for messages on the same thread.
+               // different subjects for messages on the same thread.
+               if ($params['type'] == NOTIFY_TAGSELF) {
+                       $subject = L10n::t('[Friendica:Notify] %s tagged you', $params['source_name']);
 
-               $subject = L10n::t('[Friendica:Notify] Comment to conversation #%1$d by %2$s', $parent_id, $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']);
+
+                       $preamble = L10n::t('%s commented on an item/conversation you have been following.', $params['source_name']);
+               }
 
-               $preamble = L10n::t('%s commented on an item/conversation you have been following.', $params['source_name']);
                $epreamble = $dest_str;
 
                $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>');
+               $hsitelink = sprintf($sitelink, '<a href="' . $siteurl . '">' . $sitename . '</a>');
                $itemlink =  $params['link'];
        }
 
@@ -217,21 +272,6 @@ function notification($params)
                $itemlink =  $params['link'];
        }
 
-       if ($params['type'] == NOTIFY_TAGSELF) {
-               $subject = L10n::t('[Friendica:Notify] %s tagged you', $params['source_name']);
-
-               $preamble = L10n::t('%1$s tagged you at %2$s', $params['source_name'], $sitename);
-               $epreamble = L10n::t('%1$s [url=%2$s]tagged you[/url].',
-                       '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
-                       $params['link']
-               );
-
-               $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'];
-       }
-
        if ($params['type'] == NOTIFY_SHARE) {
                $subject = L10n::t('[Friendica:Notify] %s shared a new post', $params['source_name']);
 
@@ -419,10 +459,6 @@ function notification($params)
 
                $body =  $params['body'];
 
-               $sitelink = "";
-               $tsitelink = "";
-               $hsitelink = "";
-               $itemlink =  "";
                $show_in_notification_page = false;
        }
 
@@ -440,7 +476,7 @@ function notification($params)
                'itemlink'  => $itemlink
        ];
 
-       Addon::callHooks('enotify', $h);
+       Hook::callAll('enotify', $h);
 
        $subject   = $h['subject'];
 
@@ -453,11 +489,13 @@ function notification($params)
        $hsitelink = $h['hsitelink'];
        $itemlink  = $h['itemlink'];
 
+       $notify_id = 0;
+
        if ($show_in_notification_page) {
                Logger::log("adding notification entry", Logger::DEBUG);
                do {
                        $dups = false;
-                       $hash = random_string();
+                       $hash = Strings::getRandomHex();
                        if (DBA::exists('notify', ['hash' => $hash])) {
                                $dups = true;
                        }
@@ -480,7 +518,7 @@ function notification($params)
                $datarray['otype'] = $params['otype'];
                $datarray['abort'] = false;
 
-               Addon::callHooks('enotify_store', $datarray);
+               Hook::callAll('enotify_store', $datarray);
 
                if ($datarray['abort']) {
                        L10n::popLang();
@@ -583,7 +621,7 @@ function notification($params)
                $datarray['subject'] = $subject;
                $datarray['headers'] = $additional_mail_header;
 
-               Addon::callHooks('enotify_mail', $datarray);
+               Hook::callAll('enotify_mail', $datarray);
 
                // check whether sending post content in email notifications is allowed
                // always true for SYSTEM_EMAIL
@@ -655,6 +693,7 @@ function notification($params)
  * @brief Checks for users who should be notified
  *
  * @param int $itemid ID of the item for which the check should be done
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  */
 function check_user_notification($itemid) {
        // fetch all users in the thread
@@ -670,13 +709,15 @@ function check_user_notification($itemid) {
 /**
  * @brief Checks for item related notifications and sends them
  *
- * @param int $itemid ID of the item for which the check should be done
- * @param int $uid User ID
+ * @param int    $itemid      ID of the item for which the check should be done
+ * @param int    $uid         User ID
  * @param string $defaulttype (Optional) Forces a notification with this type.
+ * @return bool
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  */
 function check_item_notification($itemid, $uid, $defaulttype = "") {
        $notification_data = ["uid" => $uid, "profiles" => []];
-       Addon::callHooks('check_item_notification', $notification_data);
+       Hook::callAll('check_item_notification', $notification_data);
 
        $profiles = $notification_data["profiles"];
 
@@ -703,11 +744,11 @@ function check_item_notification($itemid, $uid, $defaulttype = "") {
                // Check for invalid profile urls. 13 should be the shortest possible profile length:
                // http://a.bc/d
                // Additionally check for invalid urls that would return the normalised value "http:"
-               if ((strlen($profile) >= 13) && (normalise_link($profile) != "http:")) {
+               if ((strlen($profile) >= 13) && (Strings::normaliseLink($profile) != "http:")) {
                        if (!in_array($profile, $profiles2))
                                $profiles2[] = $profile;
 
-                       $profile = normalise_link($profile);
+                       $profile = Strings::normaliseLink($profile);
                        if (!in_array($profile, $profiles2))
                                $profiles2[] = $profile;
 
@@ -761,7 +802,7 @@ function check_item_notification($itemid, $uid, $defaulttype = "") {
 
                        if (DBA::isResult($tags)) {
                                foreach ($tags AS $tag) {
-                                       $condition = ['nurl' => normalise_link($tag["url"]), 'uid' => $uid, 'notify_new_posts' => true];
+                                       $condition = ['nurl' => Strings::normaliseLink($tag["url"]), 'uid' => $uid, 'notify_new_posts' => true];
                                        $r = DBA::exists('contact', $condition);
                                        if ($r) {
                                                $send_notification = true;