Skip to content

[4.0] Remove Exception-catching from JMail #21320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Aug 8, 2018
Merged

[4.0] Remove Exception-catching from JMail #21320

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
3687322
Updated the Mail.php file to the changes in PR #12179
jonasgonka Jul 25, 2018
90a6220
Added Exception Handling for the Mails that get send after sending pr…
jonasgonka Jul 27, 2018
219201a
Update Mass-Mail Function to handle the Exceptions from the JMail class
jonasgonka Jul 27, 2018
d648673
Update the update notification plugin to handle the new Exceptions fr…
jonasgonka Jul 27, 2018
677920d
Update the Contact-Module to handle the exceptions thrown by the JMai…
jonasgonka Jul 27, 2018
59b66f1
Update joomla.php
jonasgonka Jul 27, 2018
dce551d
Update DisplayController.php
jonasgonka Jul 30, 2018
0b53666
Update RemindModel.php
jonasgonka Jul 30, 2018
5839c8e
Update ResetModel.php
jonasgonka Jul 30, 2018
692e449
Update RegistrationModel.php
jonasgonka Jul 30, 2018
0e056e7
Updated multiple files to better handle the new exceptions thrown by …
jonasgonka Jul 30, 2018
061933e
Updated MessageModel.php to better handle the Exceptions thrown in th…
jonasgonka Jul 30, 2018
62d2508
Removed unnecessary redirect from DisplayController.php
jonasgonka Jul 31, 2018
198c7d0
Improved Exception handling in the joomla.php that is used when creat…
jonasgonka Jul 31, 2018
0122796
Updated translation file
jonasgonka Jul 31, 2018
6bdc62b
Fixed a code-style issue
jonasgonka Jul 31, 2018
2434081
Merge branch '4.0-dev' into JMailFixes
jonasgonka Jul 31, 2018
89529e4
Merge branch '4.0-dev' into JMailFixes
jonasgonka Aug 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 41 additions & 19 deletions administrator/components/com_messages/Model/MessageModel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,40 +360,62 @@ public function save($data)
// Send the email
$mailer = Factory::getMailer();

if (!$mailer->addReplyTo($fromUser->email, $fromUser->name))
try
{
try
if (!$mailer->addReplyTo($fromUser->email, $fromUser->name))
{
Log::add(Text::_('COM_MESSAGES_ERROR_COULD_NOT_SEND_INVALID_REPLYTO'), Log::WARNING, 'jerror');
try
{
Log::add(Text::_('COM_MESSAGES_ERROR_COULD_NOT_SEND_INVALID_REPLYTO'), Log::WARNING, 'jerror');
}
catch (\RuntimeException $exception)
{
Factory::getApplication()->enqueueMessage(Text::_('COM_MESSAGES_ERROR_COULD_NOT_SEND_INVALID_REPLYTO'), 'warning');
}

// The message is still saved in the database, we do not allow this failure to cause the entire save routine to fail
return true;
}
catch (\RuntimeException $exception)

if (!$mailer->addRecipient($toUser->email, $toUser->name))
{
Factory::getApplication()->enqueueMessage(Text::_('COM_MESSAGES_ERROR_COULD_NOT_SEND_INVALID_REPLYTO'), 'warning');
try
{
Log::add(Text::_('COM_MESSAGES_ERROR_COULD_NOT_SEND_INVALID_RECIPIENT'), Log::WARNING, 'jerror');
}
catch (\RuntimeException $exception)
{
Factory::getApplication()->enqueueMessage(Text::_('COM_MESSAGES_ERROR_COULD_NOT_SEND_INVALID_RECIPIENT'), 'warning');
}

// The message is still saved in the database, we do not allow this failure to cause the entire save routine to fail
return true;
}

// The message is still saved in the database, we do not allow this failure to cause the entire save routine to fail
return true;
}
$mailer->setSubject($subject);
$mailer->setBody($msg);

if (!$mailer->addRecipient($toUser->email, $toUser->name))
$mailer->Send();
}
catch (\Exception $exception)
{
try
{
Log::add(Text::_('COM_MESSAGES_ERROR_COULD_NOT_SEND_INVALID_RECIPIENT'), Log::WARNING, 'jerror');
Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror');

$this->setError(Text::_('COM_MESSAGES_ERROR_MAIL_FAILED'), 500);

return false;
}
catch (\RuntimeException $exception)
{
Factory::getApplication()->enqueueMessage(Text::_('COM_MESSAGES_ERROR_COULD_NOT_SEND_INVALID_RECIPIENT'), 'warning');
}

// The message is still saved in the database, we do not allow this failure to cause the entire save routine to fail
return true;
}
Factory::getApplication()->enqueueMessage(Text::_($exception->errorMessage()), 'warning');

$mailer->setSubject($subject);
$mailer->setBody($msg);
$this->setError(Text::_('COM_MESSAGES_ERROR_MAIL_FAILED'), 500);

$mailer->Send();
return false;
}
}
}

return true;
Expand Down
50 changes: 35 additions & 15 deletions administrator/components/com_users/Model/MailModel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use Joomla\CMS\Filter\InputFilter;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Factory;
use Joomla\CMS\Log\Log;

/**
* Users mail model.
Expand Down Expand Up @@ -170,28 +171,47 @@ public function send()
$mailer = Factory::getMailer();
$params = ComponentHelper::getParams('com_users');

// Build email message format.
$mailer->setSender(array($app->get('mailfrom'), $app->get('fromname')));
$mailer->setSubject($params->get('mailSubjectPrefix') . stripslashes($subject));
$mailer->setBody($message_body . $params->get('mailBodySuffix'));
$mailer->IsHtml($mode);

// Add recipients
if ($bcc)
try
{
$mailer->addBcc($rows);
$mailer->addRecipient($app->get('mailfrom'));
// Build email message format.
$mailer->setSender(array($app->get('mailfrom'), $app->get('fromname')));
$mailer->setSubject($params->get('mailSubjectPrefix') . stripslashes($subject));
$mailer->setBody($message_body . $params->get('mailBodySuffix'));
$mailer->IsHtml($mode);

// Add recipients
if ($bcc)
{
$mailer->addBcc($rows);
$mailer->addRecipient($app->get('mailfrom'));
}
else
{
$mailer->addRecipient($rows);
}

// Send the Mail
$rs = $mailer->Send();
}
else
catch (\Exception $exception)
{
$mailer->addRecipient($rows);
try
{
Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror');

$rs = false;
}
catch (\RuntimeException $exception)
{
Factory::getApplication()->enqueueMessage(Text::_($exception->errorMessage()), 'warning');

$rs = false;
}
}

// Send the Mail
$rs = $mailer->Send();

// Check for an error
if ($rs instanceof \Exception)
if ($rs !== true)
{
$app->setUserState('com_users.display.mail.data', $data);
$this->setError($rs->getError());
Expand Down
1 change: 1 addition & 0 deletions administrator/language/en-GB/en-GB.com_messages.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ COM_MESSAGES_ERROR_INVALID_FROM_USER="Invalid sender"
COM_MESSAGES_ERROR_INVALID_MESSAGE="Invalid message content"
COM_MESSAGES_ERROR_INVALID_SUBJECT="Invalid subject"
COM_MESSAGES_ERROR_INVALID_TO_USER="Invalid recipient"
COM_MESSAGES_ERROR_MAIL_FAILED="The email message could not be sent."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you simplify this to just
"The email could not be sent."

Thanks

COM_MESSAGES_FIELD_AUTO_PURGE_LABEL="Auto-delete Messages (days)"
COM_MESSAGES_FIELD_DATE_TIME_LABEL="Posted"
COM_MESSAGES_FIELD_LOCK_LABEL="Lock Inbox"
Expand Down
56 changes: 37 additions & 19 deletions components/com_contact/Controller/ContactController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use Joomla\CMS\Uri\Uri;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Factory;
use Joomla\CMS\Log\Log;

/**
* Controller for single contact view
Expand Down Expand Up @@ -221,30 +222,47 @@ private function _sendEmail($data, $contact, $copy_email_activated)
}
}

$mail = Factory::getMailer();
$mail->addRecipient($contact->email_to);
$mail->addReplyTo($email, $name);
$mail->setSender(array($mailfrom, $fromname));
$mail->setSubject($sitename . ': ' . $subject);
$mail->setBody($body);
$sent = $mail->Send();

// If we are supposed to copy the sender, do so.

// Check whether email copy function activated
if ($copy_email_activated == true && !empty($data['contact_email_copy']))
try
{
$copytext = Text::sprintf('COM_CONTACT_COPYTEXT_OF', $contact->name, $sitename);
$copytext .= "\r\n\r\n" . $body;
$copysubject = Text::sprintf('COM_CONTACT_COPYSUBJECT_OF', $subject);

$mail = Factory::getMailer();
$mail->addRecipient($email);
$mail->addRecipient($contact->email_to);
$mail->addReplyTo($email, $name);
$mail->setSender(array($mailfrom, $fromname));
$mail->setSubject($copysubject);
$mail->setBody($copytext);
$mail->setSubject($sitename . ': ' . $subject);
$mail->setBody($body);
$sent = $mail->Send();

// If we are supposed to copy the sender, do so.

// Check whether email copy function activated
if ($copy_email_activated == true && !empty($data['contact_email_copy'])) {
$copytext = Text::sprintf('COM_CONTACT_COPYTEXT_OF', $contact->name, $sitename);
$copytext .= "\r\n\r\n" . $body;
$copysubject = Text::sprintf('COM_CONTACT_COPYSUBJECT_OF', $subject);

$mail = Factory::getMailer();
$mail->addRecipient($email);
$mail->addReplyTo($email, $name);
$mail->setSender(array($mailfrom, $fromname));
$mail->setSubject($copysubject);
$mail->setBody($copytext);
$sent = $mail->Send();
}
}
catch (\Exception $exception)
{
try
{
Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror');

$sent = false;
}
catch (\RuntimeException $exception)
{
Factory::getApplication()->enqueueMessage(Text::_($exception->errorMessage()), 'warning');

$sent = false;
}
}

return $sent;
Expand Down
27 changes: 25 additions & 2 deletions components/com_mailto/Controller/DisplayController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
use Joomla\CMS\Uri\Uri;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Factory;
use Joomla\CMS\Log\Log;

/**
* Mailer Component Controller.
Expand Down Expand Up @@ -153,11 +154,33 @@ public function send()
$from = MailHelper::cleanAddress($from);
$email = PunycodeHelper::emailToPunycode($email);

// Send the email
if (Factory::getMailer()->sendMail($from, $sender, $email, $subject, $body) !== true)
// Try to send the email
try
{
$return = Factory::getMailer()->sendMail($from, $sender, $email, $subject, $body);
}
catch (\Exception $exception)
{
try
{
Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror');

$return = false;
}
catch (\RuntimeException $exception)
{
Factory::getApplication()->enqueueMessage(Text::_($exception->errorMessage()), 'warning');

$return = false;
}
}

if ($return !== true)
{
$this->setMessage(Text::_('COM_MAILTO_EMAIL_NOT_SENT'), 'notice');

$this->setRedirect('index.php', 'COM_MAILTO_EMAIL_NOT_SENT');

return $this->mailto();
}

Expand Down
85 changes: 80 additions & 5 deletions components/com_users/Model/RegistrationModel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
use Joomla\CMS\String\PunycodeHelper;
use Joomla\CMS\User\UserHelper;
use Joomla\CMS\Form\Form;
use Joomla\CMS\Log\Log;

/**
* Registration model class for Users.
Expand Down Expand Up @@ -177,7 +178,25 @@ public function activate($token)

if ($usercreator->authorise('core.create', 'com_users'))
{
$return = Factory::getMailer()->sendMail($data['mailfrom'], $data['fromname'], $row->email, $emailSubject, $emailBody);
try
{
$return = Factory::getMailer()->sendMail($data['mailfrom'], $data['fromname'], $row->email, $emailSubject, $emailBody);
}
catch (\Exception $exception)
{
try
{
Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror');

$return = false;
}
catch (\RuntimeException $exception)
{
Factory::getApplication()->enqueueMessage(Text::_($exception->errorMessage()), 'warning');

$return = false;
}
}

// Check for an error.
if ($return !== true)
Expand Down Expand Up @@ -215,7 +234,25 @@ public function activate($token)
$data['username']
);

$return = Factory::getMailer()->sendMail($data['mailfrom'], $data['fromname'], $data['email'], $emailSubject, $emailBody);
try
{
$return = Factory::getMailer()->sendMail($data['mailfrom'], $data['fromname'], $data['email'], $emailSubject, $emailBody);
}
catch (\Exception $exception)
{
try
{
Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror');

$return = false;
}
catch (\RuntimeException $exception)
{
Factory::getApplication()->enqueueMessage(Text::_($exception->errorMessage()), 'warning');

$return = false;
}
}

// Check for an error.
if ($return !== true)
Expand Down Expand Up @@ -594,8 +631,28 @@ public function register($temp)
}
}

// Send the registration email.
$return = Factory::getMailer()->sendMail($data['mailfrom'], $data['fromname'], $data['email'], $emailSubject, $emailBody);
// Try to send the registration email.
try
{
$return = Factory::getMailer()->sendMail($data['mailfrom'], $data['fromname'], $data['email'], $emailSubject, $emailBody);
}
catch (\Exception $exception)
{
try
{
Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror');

$return = false;
}
catch (\RuntimeException $exception)
{
Factory::getApplication()->enqueueMessage(Text::_($exception->errorMessage()), 'warning');

$this->setError(Text::_('COM_MESSAGES_ERROR_MAIL_FAILED'), 500);

$return = false;
}
}

// Send Notification mail to administrators
if (($params->get('useractivation') < 2) && ($params->get('mail_to_admin') == 1))
Expand Down Expand Up @@ -636,7 +693,25 @@ public function register($temp)
// Send mail to all superadministrators id
foreach ($rows as $row)
{
$return = Factory::getMailer()->sendMail($data['mailfrom'], $data['fromname'], $row->email, $emailSubject, $emailBodyAdmin);
try
{
$return = Factory::getMailer()->sendMail($data['mailfrom'], $data['fromname'], $row->email, $emailSubject, $emailBodyAdmin);
}
catch (\Exception $exception)
{
try
{
Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror');

$return = false;
}
catch (\RuntimeException $exception)
{
Factory::getApplication()->enqueueMessage(Text::_($exception->errorMessage()), 'warning');

$return = false;
}
}

// Check for an error.
if ($return !== true)
Expand Down
Loading