CoreLibs/development
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Bug fix in Email for encoding subject/body with empty replace

Browse Source 
Also store encoding in json log if test and debug print is given
This commit is contained in:
Clemens Schwaighofer
2022-06-30 18:16:28 +09:00
parent 8c8f14ec74
commit 3220180d58
2 changed files with 400 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

383
4dev/tests/CoreLibsCreateEmailTest.php
View File

@@ -143,7 +143,325 @@ final class CoreLibsCreateEmailTest extends TestCase
'encoding' => null, 'encoding' => null,
'expected_status' => -2, 'expected_status' => -2,
'expected_content' => [], 'expected_content' => [],
] ],
'sending email 1' => [
'subject' => 'SUBJECT',
'body' => 'BODY',
'from_email' => 'test@test.com',
'from_name' => '',
'to_email' => [
'test@test.com'
],
'replace' => null,
'encoding' => null,
'expected_status' => 2,
'expected_content' => [
[
'header' => [
'From' => 'test@test.com'
],
'to' => 'test@test.com',
'subject' => 'SUBJECT',
'body' => 'BODY',
]
],
],
'sending email 1, encoded' => [
'subject' => 'SUBJECT 日本語',
'body' => 'BODY 日本語',
'from_email' => 'test@test.com',
'from_name' => '',
'to_email' => [
'test@test.com'
],
'replace' => null,
'encoding' => null,
'expected_status' => 2,
'expected_content' => [
[
'header' => [
'From' => 'test@test.com'
],
'to' => 'test@test.com',
'subject' => 'SUBJECT =?UTF-8?B?5pel5pys6Kqe?=',
'body' => 'BODY 日本語',
]
],
],
'sending email 1, encoded subject ISO-2022-JP' => [
'subject' => 'SUBJECT 日本語',
'body' => 'BODY 日本語',
'from_email' => 'test@test.com',
'from_name' => '',
'to_email' => [
'test@test.com'
],
'replace' => null,
'encoding' => 'ISO-2022-JP',
'expected_status' => 2,
'expected_content' => [
[
'header' => [
'From' => 'test@test.com'
],
'to' => 'test@test.com',
'subject' => 'SUBJECT =?ISO-2022-JP?B?GyRCRnxLXDhsGyhC?=',
// body is stored as UTF-8 in log and here, so both must be translated
'body' => 'BODY 日本語',
]
],
],
'sending email 2' => [
'subject' => 'SUBJECT',
'body' => 'BODY',
'from_email' => 'test@test.com',
'from_name' => '',
'to_email' => [
'e1@test.com',
'e2@test.com'
],
'replace' => null,
'encoding' => null,
'expected_status' => 2,
'expected_content' => [
[
'header' => [
'From' => 'test@test.com'
],
'to' => 'e1@test.com',
'subject' => 'SUBJECT',
'body' => 'BODY',
],
[
'header' => [
'From' => 'test@test.com'
],
'to' => 'e2@test.com',
'subject' => 'SUBJECT',
'body' => 'BODY',
]
],
],
'sending email 1: dynamic' => [
'subject' => 'SUBJECT {FOO}',
'body' => 'BODY {FOO} {VAR}',
'from_email' => 'test@test.com',
'from_name' => '',
'to_email' => [
'test@test.com'
],
'replace' => [
'FOO' => 'foo',
'VAR' => 'bar',
],
'encoding' => null,
'expected_status' => 2,
'expected_content' => [
[
'header' => [
'From' => 'test@test.com'
],
'to' => 'test@test.com',
'subject' => 'SUBJECT foo',
'body' => 'BODY foo bar',
]
],
],
'sending email 1: dynamic encoded' => [
'subject' => 'SUBJECT 日本語 {FOO}',
'body' => 'BODY 日本語 {FOO} {VAR}',
'from_email' => 'test@test.com',
'from_name' => '',
'to_email' => [
'test@test.com'
],
'replace' => [
'FOO' => 'foo',
'VAR' => 'bar',
],
'encoding' => null,
'expected_status' => 2,
'expected_content' => [
[
'header' => [
'From' => 'test@test.com'
],
'to' => 'test@test.com',
'subject' => 'SUBJECT =?UTF-8?B?5pel5pys6KqeIGZvbw==?=',
'body' => 'BODY 日本語 foo bar',
]
],
],
'sending email 1: dynamic, to override' => [
'subject' => 'SUBJECT {FOO}',
'body' => 'BODY {FOO} {VAR}',
'from_email' => 'test@test.com',
'from_name' => '',
'to_email' => [
[
'email' => 'test@test.com',
'replace' => [
'FOO' => 'foo to'
]
]
],
'replace' => [
'FOO' => 'foo',
'VAR' => 'bar',
],
'encoding' => null,
'expected_status' => 2,
'expected_content' => [
[
'header' => [
'From' => 'test@test.com'
],
'to' => 'test@test.com',
'subject' => 'SUBJECT foo to',
'body' => 'BODY foo to bar',
]
],
],
'sending email 1: dynamic, to override encoded' => [
'subject' => 'SUBJECT 日本語 {FOO}',
'body' => 'BODY 日本語 {FOO} {VAR}',
'from_email' => 'test@test.com',
'from_name' => '',
'to_email' => [
[
'email' => 'test@test.com',
'replace' => [
'FOO' => 'foo to'
]
]
],
'replace' => [
'FOO' => 'foo',
'VAR' => 'bar',
],
'encoding' => null,
'expected_status' => 2,
'expected_content' => [
[
'header' => [
'From' => 'test@test.com'
],
'to' => 'test@test.com',
'subject' => 'SUBJECT =?UTF-8?B?5pel5pys6KqeIGZvbyB0bw==?=',
'body' => 'BODY 日本語 foo to bar',
]
],
],
'sending email 3: dynamic, to mixed override' => [
'subject' => 'SUBJECT {FOO}',
'body' => 'BODY {FOO} {VAR}',
'from_email' => 'test@test.com',
'from_name' => '',
'to_email' => [
[
'email' => 't1@test.com',
'replace' => [
'FOO' => 'foo to 1'
]
],
[
'email' => 't2@test.com',
'replace' => [
'FOO' => 'foo to 2'
]
],
[
'email' => 't3@test.com',
],
],
'replace' => [
'FOO' => 'foo',
'VAR' => 'bar',
],
'encoding' => null,
'expected_status' => 2,
'expected_content' => [
[
'header' => [
'From' => 'test@test.com'
],
'to' => 't1@test.com',
'subject' => 'SUBJECT foo to 1',
'body' => 'BODY foo to 1 bar',
],
[
'header' => [
'From' => 'test@test.com'
],
'to' => 't2@test.com',
'subject' => 'SUBJECT foo to 2',
'body' => 'BODY foo to 2 bar',
],
[
'header' => [
'From' => 'test@test.com'
],
'to' => 't3@test.com',
'subject' => 'SUBJECT foo',
'body' => 'BODY foo bar',
],
],
],
'sending email 3: dynamic, to mixed override encoded' => [
'subject' => 'SUBJECT 日本語 {FOO}',
'body' => 'BODY 日本語 {FOO} {VAR}',
'from_email' => 'test@test.com',
'from_name' => '',
'to_email' => [
[
'email' => 't1@test.com',
'replace' => [
'FOO' => 'foo to 1'
]
],
[
'email' => 't2@test.com',
'replace' => [
'FOO' => 'foo to 2'
]
],
[
'email' => 't3@test.com',
],
],
'replace' => [
'FOO' => 'foo',
'VAR' => 'bar',
],
'encoding' => null,
'expected_status' => 2,
'expected_content' => [
[
'header' => [
'From' => 'test@test.com'
],
'to' => 't1@test.com',
'subject' => 'SUBJECT =?UTF-8?B?5pel5pys6KqeIGZvbyB0byAx?=',
'body' => 'BODY 日本語 foo to 1 bar',
],
[
'header' => [
'From' => 'test@test.com'
],
'to' => 't2@test.com',
'subject' => 'SUBJECT =?UTF-8?B?5pel5pys6KqeIGZvbyB0byAy?=',
'body' => 'BODY 日本語 foo to 2 bar',
],
[
'header' => [
'From' => 'test@test.com'
],
'to' => 't3@test.com',
'subject' => 'SUBJECT =?UTF-8?B?5pel5pys6KqeIGZvbw==?=',
'body' => 'BODY 日本語 foo bar',
],
],
],
]; ];
} }
@@ -181,6 +499,11 @@ final class CoreLibsCreateEmailTest extends TestCase
if ($encoding === null) { if ($encoding === null) {
$encoding = 'UTF-8'; $encoding = 'UTF-8';
} }
// force new set for each run
self::$log->setLogUniqueId(true);
// set on of unique log id
self::$log->setLogPer('run', true);
// init logger
$status = \CoreLibs\Create\Email::sendEmail( $status = \CoreLibs\Create\Email::sendEmail(
$subject, $subject,
$body, $body,
@@ -197,7 +520,63 @@ final class CoreLibsCreateEmailTest extends TestCase
$status, $status,
'Assert sending status' 'Assert sending status'
); );
// assert content: must load JSON from log file? // assert content: must load JSON from log file
if ($status == 2) {
// open file, get last entry with 'SEND EMAIL JSON' key
$file = file_get_contents(self::$log->getLogFileName());
if ($file !== false) {
// extract SEND EMAIL JSON line
$found = preg_match_all("/^.* <SEND EMAIL JSON> - (.*)$/m", $file, $matches);
// print "Found: $found | EMAIL: " . print_r($matches, true) . "\n";
if (!empty($matches[1])) {
foreach ($matches[1] as $pos => $email_json) {
$email = \CoreLibs\Convert\Json::jsonConvertToArray($email_json);
// print "EMAIL: " . print_r($email, true) . "\n";
$this->assertEquals(
$expected_content[$pos]['header']['From'] ?? 'MISSING FROM',
$email['header']['From'] ?? '',
'Email check: assert header from'
);
$this->assertEquals(
'text/plain; charset=' . $encoding ?? 'UTF-8',
$email['header']['Content-type'] ?? '',
'Email check: assert header content type'
);
$this->assertEquals(
'1.0',
$email['header']['MIME-Version'] ?? '',
'Email check: assert header mime version'
);
$this->assertEquals(
$expected_content[$pos]['to'] ?? 'MISSING TO',
$email['to'] ?? '',
'Email check: assert to'
);
$this->assertEquals(
$expected_content[$pos]['subject'] ?? 'MISSING SUBJECT',
$email['subject'] ?? '',
'Email check: assert subject'
);
// body must be translated back to encoding if encoding is not UTF-8
$this->assertEquals(
$encoding != 'UTF-8' ?
mb_convert_encoding($expected_content[$pos]['body'] ?? '', $encoding, 'UTF-8') :
$expected_content[$pos]['body'] ?? 'MISSING BODY',
$encoding != 'UTF-8' ?
mb_convert_encoding($email['body'] ?? '', $encoding, 'UTF-8') :
$email['body'] ?? '',
'Email check: assert body'
);
/*
[header] [From] => test@test.com
[to] => test@test.com
[subject] => SUBJECT
[body] => BODY
*/
}
}
}
}
} }
} }

31
www/lib/CoreLibs/Create/Email.php
View File

@@ -79,8 +79,8 @@ class Email
} }
// if encoding is NOT UTF-8 convert to target // if encoding is NOT UTF-8 convert to target
if ($encoding != 'UTF-8') { if ($encoding != 'UTF-8') {
$out_subject = mb_convert_encoding($out_subject, $encoding, 'UTF-8'); $subject = mb_convert_encoding($subject, $encoding, 'UTF-8');
$out_body = mb_convert_encoding($out_body, $encoding, 'UTF-8'); $body = mb_convert_encoding($body, $encoding, 'UTF-8');
} }
// we need to encodde the subject // we need to encodde the subject
$subject = mb_encode_mimeheader($subject, $encoding); $subject = mb_encode_mimeheader($subject, $encoding);
@@ -142,11 +142,11 @@ class Email
// else expect 'email' & 'name' // else expect 'email' & 'name'
if ( if (
is_array($to_email) && is_array($to_email) &&
isset($to_email['name']) && isset($to_email['email']) isset($to_email['email'])
) { ) {
$_to_email = self::encodeEmailName( $_to_email = self::encodeEmailName(
$to_email['email'], $to_email['email'],
$to_email['name'], $to_email['name'] ?? '',
$encoding $encoding
); );
$to_emails[] = $_to_email; $to_emails[] = $_to_email;
@@ -176,7 +176,12 @@ class Email
// if we have a replace string, we need to do replace run // if we have a replace string, we need to do replace run
// only if there is no dedicated to replace // only if there is no dedicated to replace
if (count($replace_content) && !count($to_replace)) { // also run replace if there is nothing to replace at all
// this will mime encode the subject
if (
!count($to_replace) &&
count($replace_content) || !count($replace_content)
) {
list($out_subject, $out_body) = self::replaceContent( list($out_subject, $out_body) = self::replaceContent(
$subject, $subject,
$body, $body,
@@ -185,9 +190,10 @@ class Email
); );
} }
$mail_sent_status = 1; $mail_delivery_status = 1;
// send the email // send the email
foreach ($to_emails as $to_email) { foreach ($to_emails as $to_email) {
$mail_status = true;
// if there is a to replace, if not use the original replace content // if there is a to replace, if not use the original replace content
if (count($to_replace)) { if (count($to_replace)) {
$_replace = []; $_replace = [];
@@ -206,7 +212,7 @@ class Email
} }
} }
if ($test === false) { if ($test === false) {
$status = mail($to_email, $out_subject, $out_body, $headers); $mail_status = mail($to_email, $out_subject, $out_body, $headers);
} else { } else {
if ($log instanceof \CoreLibs\Debug\Logging) { if ($log instanceof \CoreLibs\Debug\Logging) {
// build debug strings: convert to UTF-8 if not utf-8 // build debug strings: convert to UTF-8 if not utf-8
@@ -217,21 +223,22 @@ class Email
$out_body : $out_body :
mb_convert_encoding($out_body, 'UTF-8', $encoding))); mb_convert_encoding($out_body, 'UTF-8', $encoding)));
$log->debug('SEND EMAIL JSON', json_encode([ $log->debug('SEND EMAIL JSON', json_encode([
'encoding' => $encoding,
'header' => $headers, 'header' => $headers,
'to' => $to_email, 'to' => $to_email,
'subject' => $out_subject, 'subject' => $out_subject,
'body' => ($encoding == 'UTF-8' ? 'body' => ($encoding == 'UTF-8' ?
$out_body : $out_body :
mb_convert_encoding($out_body, 'UTF-8', $encoding)) mb_convert_encoding($out_body, 'UTF-8', $encoding))
])); ]) ?: '{}');
} }
$mail_sent_status = 2; $mail_delivery_status = 2;
} }
if (!$status) { if (!$mail_status) {
$mail_sent_status = 0; $mail_delivery_status = 0;
} }
} }
return $mail_sent_status; return $mail_delivery_status;
} }
} }