]> git.mxchange.org Git - friendica.git/blobdiff - include/enotify.php
Update more PHPDoc, including in include/
[friendica.git] / include / enotify.php
index 0ef3c56765e413610a0d1542cb4bcf2c48502e60..be8552ed6e710477bcbc2b97ffdcc76314e2b5b2 100644 (file)
@@ -4,34 +4,53 @@
  */
 
 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;
 use Friendica\Core\System;
 use Friendica\Database\DBA;
 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'])) {
-               logger('Missing parameters.' . System::callstack());
+               Logger::log('Missing parameters.' . System::callstack());
        }
 
+       // Ensure that the important fields are set at any time
+       $fields = ['notify-flags', 'language', 'username', 'email'];
+       $user = DBA::selectFirst('user', $fields, ['uid' => $params['uid']]);
+
+       if (!DBA::isResult($user)) {
+               Logger::log('Unknown user ' . $params['uid']);
+               return;
+       }
+
+       $params['notify_flags'] = defaults($params, 'notify_flags', $user['notify-flags']);
+       $params['language']     = defaults($params, 'language'    , $user['language']);
+       $params['to_name']      = defaults($params, 'to_name'     , $user['username']);
+       $params['to_email']     = defaults($params, 'to_email'    , $user['email']);
+
        // from here on everything is in the recipients language
        L10n::pushLang($params['language']);
 
@@ -47,7 +66,7 @@ function notification($params)
        }
 
        $sender_name = $sitename;
-       $hostname = $a->get_hostname();
+       $hostname = $a->getHostName();
        if (strpos($hostname, ':')) {
                $hostname = substr($hostname, 0, strpos($hostname, ':'));
        }
@@ -70,7 +89,7 @@ function notification($params)
        // 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 = ((x($params, 'show_in_notification_page')) ? $params['show_in_notification_page']:true);
+       $show_in_notification_page = isset($params['show_in_notification_page']) ? $params['show_in_notification_page'] : true;
 
        $additional_mail_header = "";
        $additional_mail_header .= "Precedence: list\n";
@@ -109,17 +128,18 @@ 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("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;
                }
 
@@ -133,55 +153,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'];
        }
 
@@ -200,21 +266,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']);
 
@@ -423,7 +474,7 @@ function notification($params)
                'itemlink'  => $itemlink
        ];
 
-       Addon::callHooks('enotify', $h);
+       Hook::callAll('enotify', $h);
 
        $subject   = $h['subject'];
 
@@ -437,10 +488,10 @@ function notification($params)
        $itemlink  = $h['itemlink'];
 
        if ($show_in_notification_page) {
-               logger("adding notification entry", LOGGER_DEBUG);
+               Logger::log("adding notification entry", Logger::DEBUG);
                do {
                        $dups = false;
-                       $hash = random_string();
+                       $hash = Strings::getRandomHex();
                        if (DBA::exists('notify', ['hash' => $hash])) {
                                $dups = true;
                        }
@@ -463,7 +514,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();
@@ -501,7 +552,7 @@ function notification($params)
                }
 
                $itemlink = System::baseUrl().'/notify/view/'.$notify_id;
-               $msg = replace_macros($epreamble, ['$itemlink' => $itemlink]);
+               $msg = Renderer::replaceMacros($epreamble, ['$itemlink' => $itemlink]);
                $msg_cache = format_notification_message($datarray['name_cache'], strip_tags(BBCode::convert($msg)));
 
                $fields = ['msg' => $msg, 'msg_cache' => $msg_cache];
@@ -510,18 +561,18 @@ function notification($params)
        }
 
        // send email notification if notification preferences permit
-       if ((!empty($params['notify_flags']) & intval($params['type']))
+       if ((intval($params['notify_flags']) & intval($params['type']))
                || $params['type'] == NOTIFY_SYSTEM
                || $params['type'] == SYSTEM_EMAIL) {
 
-               logger('sending notification email');
+               Logger::log('sending notification email');
 
                if (isset($params['parent']) && (intval($params['parent']) != 0)) {
                        $id_for_parent = $params['parent']."@".$hostname;
 
                        // 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("notify_id:".intval($notify_id).", parent: ".intval($params['parent'])."uid: ".intval($params['uid']), LOGGER_DEBUG);
+                               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];
@@ -530,11 +581,11 @@ function notification($params)
                                $additional_mail_header .= "Message-ID: <${id_for_parent}>\n";
                                $log_msg = "include/enotify: No previous notification found for this parent:\n".
                                                "  parent: ${params['parent']}\n"."  uid   : ${params['uid']}\n";
-                               logger($log_msg, LOGGER_DEBUG);
+                               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";
-                               logger("There's already a notification for this parent.", LOGGER_DEBUG);
+                               Logger::log("There's already a notification for this parent.", Logger::DEBUG);
                        }
                }
 
@@ -566,15 +617,15 @@ 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
                $content_allowed = ((!Config::get('system', 'enotify_no_content')) || ($params['type'] == SYSTEM_EMAIL));
 
                // load the template for private message notifications
-               $tpl = get_markup_template('email_notify_html.tpl');
-               $email_html_body = replace_macros($tpl, [
+               $tpl = Renderer::getMarkupTemplate('email_notify_html.tpl');
+               $email_html_body = Renderer::replaceMacros($tpl, [
                        '$banner'       => $datarray['banner'],
                        '$product'      => $datarray['product'],
                        '$preamble'     => str_replace("\n", "<br>\n", $datarray['preamble']),
@@ -594,8 +645,8 @@ function notification($params)
                ]);
 
                // load the template for private message notifications
-               $tpl = get_markup_template('email_notify_text.tpl');
-               $email_text_body = replace_macros($tpl, [
+               $tpl = Renderer::getMarkupTemplate('email_notify_text.tpl');
+               $email_text_body = Renderer::replaceMacros($tpl, [
                        '$banner'       => $datarray['banner'],
                        '$product'      => $datarray['product'],
                        '$preamble'     => $datarray['preamble'],
@@ -614,6 +665,7 @@ function notification($params)
                        '$content_allowed'      => $content_allowed,
                ]);
 
+               L10n::popLang();
                // use the Emailer class to send the message
                return Emailer::send(
                        [
@@ -629,6 +681,7 @@ function notification($params)
                );
        }
 
+       L10n::popLang();
        return false;
 }
 
@@ -636,6 +689,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
@@ -651,17 +705,19 @@ 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"];
 
-       $fields = ['notify-flags', 'language', 'username', 'email', 'nickname'];
+       $fields = ['nickname'];
        $user = DBA::selectFirst('user', $fields, ['uid' => $uid]);
        if (!DBA::isResult($user)) {
                return false;
@@ -684,11 +740,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;
 
@@ -724,10 +780,6 @@ function check_item_notification($itemid, $uid, $defaulttype = "") {
        // Generate the notification array
        $params = [];
        $params["uid"] = $uid;
-       $params["notify_flags"] = $user["notify-flags"];
-       $params["language"] = $user["language"];
-       $params["to_name"] = $user["username"];
-       $params["to_email"] = $user["email"];
        $params["item"] = $item;
        $params["parent"] = $item["parent"];
        $params["link"] = System::baseUrl().'/display/'.urlencode($item["guid"]);
@@ -746,7 +798,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;