From 915abe8a338a9648a2125e6e0ea96e5def01cb6c Mon Sep 17 00:00:00 2001 From: nupplaPhil Date: Sun, 26 Jan 2020 01:04:54 +0100 Subject: [PATCH] Add explicit parameters to Sender::send() method signature --- include/enotify.php | 141 ++++++++++++++++++++----------------------- mod/item.php | 21 +++---- src/Util/Emailer.php | 30 ++++----- 3 files changed, 90 insertions(+), 102 deletions(-) diff --git a/include/enotify.php b/include/enotify.php index 75ad7ef1f..7b78d556d 100644 --- a/include/enotify.php +++ b/include/enotify.php @@ -512,19 +512,19 @@ function notification($params) Logger::log('sending notification email'); if (isset($params['parent']) && (intval($params['parent']) != 0)) { - $id_for_parent = $params['parent']."@".$hostname; + $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::log("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]; + $fields = ['notify-id' => $notify_id, 'master-parent-item' => $params['parent'], + 'receiver-uid' => $params['uid'], 'parent-item' => 0]; DBA::insert('notify-threads', $fields); $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"; + $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. @@ -536,30 +536,30 @@ function notification($params) $textversion = BBCode::toPlaintext($body); $htmlversion = BBCode::convert($body); - $datarray = []; - $datarray['banner'] = $banner; - $datarray['product'] = $product; - $datarray['preamble'] = $preamble; - $datarray['sitename'] = $sitename; - $datarray['siteurl'] = $siteurl; - $datarray['type'] = $params['type']; - $datarray['parent'] = $parent_id; - $datarray['source_name'] = $params['source_name'] ?? ''; - $datarray['source_link'] = $params['source_link'] ?? ''; + $datarray = []; + $datarray['banner'] = $banner; + $datarray['product'] = $product; + $datarray['preamble'] = $preamble; + $datarray['sitename'] = $sitename; + $datarray['siteurl'] = $siteurl; + $datarray['type'] = $params['type']; + $datarray['parent'] = $parent_id; + $datarray['source_name'] = $params['source_name'] ?? ''; + $datarray['source_link'] = $params['source_link'] ?? ''; $datarray['source_photo'] = $params['source_photo'] ?? ''; - $datarray['uid'] = $params['uid']; - $datarray['username'] = $params['to_name'] ?? ''; - $datarray['hsitelink'] = $hsitelink; - $datarray['tsitelink'] = $tsitelink; - $datarray['hitemlink'] = ''.$itemlink.''; - $datarray['titemlink'] = $itemlink; - $datarray['thanks'] = $thanks; - $datarray['site_admin'] = $site_admin; - $datarray['title'] = stripslashes($title); - $datarray['htmlversion'] = $htmlversion; - $datarray['textversion'] = $textversion; - $datarray['subject'] = $subject; - $datarray['headers'] = $additional_mail_header; + $datarray['uid'] = $params['uid']; + $datarray['username'] = $params['to_name'] ?? ''; + $datarray['hsitelink'] = $hsitelink; + $datarray['tsitelink'] = $tsitelink; + $datarray['hitemlink'] = '' . $itemlink . ''; + $datarray['titemlink'] = $itemlink; + $datarray['thanks'] = $thanks; + $datarray['site_admin'] = $site_admin; + $datarray['title'] = stripslashes($title); + $datarray['htmlversion'] = $htmlversion; + $datarray['textversion'] = $textversion; + $datarray['subject'] = $subject; + $datarray['headers'] = $additional_mail_header; Hook::callAll('enotify_mail', $datarray); @@ -568,59 +568,52 @@ function notification($params) $content_allowed = ((!DI::config()->get('system', 'enotify_no_content')) || ($params['type'] == SYSTEM_EMAIL)); // load the template for private message notifications - $tpl = Renderer::getMarkupTemplate('email_notify_html.tpl'); + $tpl = Renderer::getMarkupTemplate('email_notify_html.tpl'); $email_html_body = Renderer::replaceMacros($tpl, [ - '$banner' => $datarray['banner'], - '$product' => $datarray['product'], - '$preamble' => str_replace("\n", "
\n", $datarray['preamble']), - '$sitename' => $datarray['sitename'], - '$siteurl' => $datarray['siteurl'], - '$source_name' => $datarray['source_name'], - '$source_link' => $datarray['source_link'], - '$source_photo' => $datarray['source_photo'], - '$username' => $datarray['username'], - '$hsitelink' => $datarray['hsitelink'], - '$hitemlink' => $datarray['hitemlink'], - '$thanks' => $datarray['thanks'], - '$site_admin' => $datarray['site_admin'], - '$title' => $datarray['title'], - '$htmlversion' => $datarray['htmlversion'], - '$content_allowed' => $content_allowed, + '$banner' => $datarray['banner'], + '$product' => $datarray['product'], + '$preamble' => str_replace("\n", "
\n", $datarray['preamble']), + '$sitename' => $datarray['sitename'], + '$siteurl' => $datarray['siteurl'], + '$source_name' => $datarray['source_name'], + '$source_link' => $datarray['source_link'], + '$source_photo' => $datarray['source_photo'], + '$username' => $datarray['username'], + '$hsitelink' => $datarray['hsitelink'], + '$hitemlink' => $datarray['hitemlink'], + '$thanks' => $datarray['thanks'], + '$site_admin' => $datarray['site_admin'], + '$title' => $datarray['title'], + '$htmlversion' => $datarray['htmlversion'], + '$content_allowed' => $content_allowed, ]); // load the template for private message notifications - $tpl = Renderer::getMarkupTemplate('email_notify_text.tpl'); + $tpl = Renderer::getMarkupTemplate('email_notify_text.tpl'); $email_text_body = Renderer::replaceMacros($tpl, [ - '$banner' => $datarray['banner'], - '$product' => $datarray['product'], - '$preamble' => $datarray['preamble'], - '$sitename' => $datarray['sitename'], - '$siteurl' => $datarray['siteurl'], - '$source_name' => $datarray['source_name'], - '$source_link' => $datarray['source_link'], - '$source_photo' => $datarray['source_photo'], - '$username' => $datarray['username'], - '$tsitelink' => $datarray['tsitelink'], - '$titemlink' => $datarray['titemlink'], - '$thanks' => $datarray['thanks'], - '$site_admin' => $datarray['site_admin'], - '$title' => $datarray['title'], - '$textversion' => $datarray['textversion'], - '$content_allowed' => $content_allowed, + '$banner' => $datarray['banner'], + '$product' => $datarray['product'], + '$preamble' => $datarray['preamble'], + '$sitename' => $datarray['sitename'], + '$siteurl' => $datarray['siteurl'], + '$source_name' => $datarray['source_name'], + '$source_link' => $datarray['source_link'], + '$source_photo' => $datarray['source_photo'], + '$username' => $datarray['username'], + '$tsitelink' => $datarray['tsitelink'], + '$titemlink' => $datarray['titemlink'], + '$thanks' => $datarray['thanks'], + '$site_admin' => $datarray['site_admin'], + '$title' => $datarray['title'], + '$textversion' => $datarray['textversion'], + '$content_allowed' => $content_allowed, ]); // use the Emailer class to send the message - return DI::emailer()->send([ - 'uid' => $params['uid'], - 'fromName' => $sender_name, - 'fromEmail' => $sender_email, - 'replyTo' => $sender_email, - 'toEmail' => $params['to_email'], - 'messageSubject' => $datarray['subject'], - 'htmlVersion' => $email_html_body, - 'textVersion' => $email_text_body, - 'additionalMailHeader' => $datarray['headers'] - ]); + return DI::emailer()->send($sender_name, $sender_email, $sender_email, $params['to_email'], + $datarray['subject'], $email_html_body, $email_text_body, + $datarray['headers'], $params['uid'] + ); } return false; diff --git a/mod/item.php b/mod/item.php index a5ff594a0..2bda16764 100644 --- a/mod/item.php +++ b/mod/item.php @@ -796,27 +796,20 @@ function item_post(App $a) { continue; } $disclaimer = '
' . DI::l10n()->t('This message was sent to you by %s, a member of the Friendica social network.', $a->user['username']) - . '
'; + . '
'; $disclaimer .= DI::l10n()->t('You may visit them online at %s', DI::baseUrl() . '/profile/' . $a->user['nickname']) . EOL; $disclaimer .= DI::l10n()->t('Please contact the sender by replying to this post if you do not wish to receive these messages.') . EOL; - if (!$datarray['title']=='') { + if (!$datarray['title'] == '') { $subject = Email::encodeHeader($datarray['title'], 'UTF-8'); } else { $subject = Email::encodeHeader('[Friendica]' . ' ' . DI::l10n()->t('%s posted an update.', $a->user['username']), 'UTF-8'); } - $link = '' . $a->user['username'] . '

'; + $link = '' . $a->user['username'] . '

'; $html = Item::prepareBody($datarray); - $message = '' . $link . $html . $disclaimer . ''; - $params = [ - 'fromName' => $a->user['username'], - 'fromEmail' => $a->user['email'], - 'toEmail' => $addr, - 'replyTo' => $a->user['email'], - 'messageSubject' => $subject, - 'htmlVersion' => $message, - 'textVersion' => HTML::toPlaintext($html.$disclaimer) - ]; - DI::emailer()->send($params); + $message = '' . $link . $html . $disclaimer . '';; + DI::emailer()->send($a->user['username'], $a->user['email'], $a->user['email'], $addr, + $subject, $message, HTML::toPlaintext($html . $disclaimer) + ); } } } diff --git a/src/Util/Emailer.php b/src/Util/Emailer.php index 776d35921..b706cacbb 100644 --- a/src/Util/Emailer.php +++ b/src/Util/Emailer.php @@ -31,7 +31,9 @@ class Emailer * @return bool * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ - public function send(array $params) + public function send(string $fromName, string $fromEmail, string $replyTo, string $toEmail, + string $subject, string $msgHtml, string $msgText, + string $additionalMailHeader = '', int $uid = null) { $params['sent'] = false; @@ -42,12 +44,12 @@ class Emailer } $email_textonly = false; - if (!empty($params['uid'])) { - $email_textonly = DI::pConfig()->get($params['uid'], "system", "email_textonly"); + if (!empty($uid)) { + $email_textonly = DI::pConfig()->get($uid, "system", "email_textonly"); } - $fromName = Email::encodeHeader(html_entity_decode($params['fromName'], ENT_QUOTES, 'UTF-8'), 'UTF-8'); - $messageSubject = Email::encodeHeader(html_entity_decode($params['messageSubject'], ENT_QUOTES, 'UTF-8'), 'UTF-8'); + $fromName = Email::encodeHeader(html_entity_decode($fromName, ENT_QUOTES, 'UTF-8'), 'UTF-8'); + $messageSubject = Email::encodeHeader(html_entity_decode($subject, ENT_QUOTES, 'UTF-8'), 'UTF-8'); // generate a mime boundary $mimeBoundary =rand(0, 9)."-" @@ -56,21 +58,21 @@ class Emailer .rand(10000, 99999); // generate a multipart/alternative message header - $messageHeader = ($params['additionalMailHeader'] ?? '') . - "From: $fromName <{$params['fromEmail']}>\n" . - "Reply-To: $fromName <{$params['replyTo']}>\n" . + $messageHeader = $additionalMailHeader . + "From: $fromName <{$fromEmail}>\n" . + "Reply-To: $fromName <{$replyTo}>\n" . "MIME-Version: 1.0\n" . "Content-Type: multipart/alternative; boundary=\"{$mimeBoundary}\""; // assemble the final multipart message body with the text and html types included - $textBody = chunk_split(base64_encode($params['textVersion'])); - $htmlBody = chunk_split(base64_encode($params['htmlVersion'])); + $textBody = chunk_split(base64_encode($msgText)); + $htmlBody = chunk_split(base64_encode($msgHtml)); $multipartMessageBody = "--" . $mimeBoundary . "\n" . // plain text section "Content-Type: text/plain; charset=UTF-8\n" . "Content-Transfer-Encoding: base64\n\n" . $textBody . "\n"; - if (!$email_textonly && !is_null($params['htmlVersion'])) { + if (!$email_textonly && !is_null($msgHtml)) { $multipartMessageBody .= "--" . $mimeBoundary . "\n" . // text/html section "Content-Type: text/html; charset=UTF-8\n" . @@ -81,14 +83,14 @@ class Emailer "--" . $mimeBoundary . "--\n"; // message ending if (DI::config()->get("system", "sendmail_params", true)) { - $sendmail_params = '-f ' . $params['fromEmail']; + $sendmail_params = '-f ' . $fromEmail; } else { $sendmail_params = null; } // send the message $hookdata = [ - 'to' => $params['toEmail'], + 'to' => $toEmail, 'subject' => $messageSubject, 'body' => $multipartMessageBody, 'headers' => $messageHeader, @@ -109,7 +111,7 @@ class Emailer $hookdata['headers'], $hookdata['parameters'] ); - Logger::log("header " . 'To: ' . $params['toEmail'] . "\n" . $messageHeader, Logger::DEBUG); + Logger::log("header " . 'To: ' . $toEmail . "\n" . $messageHeader, Logger::DEBUG); Logger::log("return value " . (($res)?"true":"false"), Logger::DEBUG); return $res; }