CRM/Admin/Form/Setting/Smtp.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  */
  33
  34 /**
  35  * This class generates form components for Smtp Server.
  36  */
  37 class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting {
  38   protected $_testButtonName;
  39
  40   /**
  41    * Build the form object.
  42    */
  43   public function buildQuickForm() {
  44
  45     $outBoundOption = array(
  46       CRM_Mailing_Config::OUTBOUND_OPTION_MAIL => ts('mail()'),
  47       CRM_Mailing_Config::OUTBOUND_OPTION_SMTP => ts('SMTP'),
  48       CRM_Mailing_Config::OUTBOUND_OPTION_SENDMAIL => ts('Sendmail'),
  49       CRM_Mailing_Config::OUTBOUND_OPTION_DISABLED => ts('Disable Outbound Email'),
  50       CRM_Mailing_Config::OUTBOUND_OPTION_REDIRECT_TO_DB => ts('Redirect to Database'),
  51     );
  52     $this->addRadio('outBound_option', ts('Select Mailer'), $outBoundOption);
  53
  54     CRM_Utils_System::setTitle(ts('Settings - Outbound Mail'));
  55     $this->add('checkbox', 'allow_mail_from_logged_in_contact', ts('Allow Mail to be sent from logged in contact\'s email address'));
  56     $this->add('text', 'sendmail_path', ts('Sendmail Path'));
  57     $this->add('text', 'sendmail_args', ts('Sendmail Argument'));
  58     $this->add('text', 'smtpServer', ts('SMTP Server'));
  59     $this->add('text', 'smtpPort', ts('SMTP Port'));
  60     $this->addYesNo('smtpAuth', ts('Authentication?'));
  61     $this->addElement('text', 'smtpUsername', ts('SMTP Username'));
  62     $this->addElement('password', 'smtpPassword', ts('SMTP Password'));
  63
  64     $this->_testButtonName = $this->getButtonName('refresh', 'test');
  65
  66     $this->addFormRule(array('CRM_Admin_Form_Setting_Smtp', 'formRule'));
  67     parent::buildQuickForm();
  68     $buttons = $this->getElement('buttons')->getElements();
  69     $buttons[] = $this->createElement('submit', $this->_testButtonName, ts('Save & Send Test Email'), array('crm-icon' => 'fa-envelope-o'));
  70     $this->getElement('buttons')->setElements($buttons);
  71   }
  72
  73   /**
  74    * Process the form submission.
  75    */
  76   public function postProcess() {
  77     // flush caches so we reload details for future requests
  78     // CRM-11967
  79     CRM_Utils_System::flushCache();
  80
  81     $formValues = $this->controller->exportValues($this->_name);
  82
  83     Civi::settings()->set('allow_mail_from_logged_in_contact', (!empty($formValues['allow_mail_from_logged_in_contact'])));
  84     unset($formValues['allow_mail_from_logged_in_contact']);
  85
  86     $buttonName = $this->controller->getButtonName();
  87     // check if test button
  88     if ($buttonName == $this->_testButtonName) {
  89       if ($formValues['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_DISABLED) {
  90         CRM_Core_Session::setStatus(ts('You have selected "Disable Outbound Email". A test email can not be sent.'), ts("Email Disabled"), "error");
  91       }
  92       elseif ($formValues['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_REDIRECT_TO_DB) {
  93         CRM_Core_Session::setStatus(ts('You have selected "Redirect to Database". A test email can not be sent.'), ts("Email Disabled"), "error");
  94       }
  95       else {
  96         $session = CRM_Core_Session::singleton();
  97         $userID = $session->get('userID');
  98         list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact::getContactDetails($userID);
  99
 100         //get the default domain email address.CRM-4250
 101         list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain::getNameAndEmail();
 102
 103         if (!$domainEmailAddress || $domainEmailAddress == 'info@EXAMPLE.ORG') {
 104           $fixUrl = CRM_Utils_System::url("civicrm/admin/domain", 'action=update&reset=1');
 105           CRM_Core_Error::fatal(ts('The site administrator needs to enter a valid \'FROM Email Address\' in <a href="%1">Administer CiviCRM &raquo; Communications &raquo; FROM Email Addresses</a>. The email address used may need to be a valid mail account with your email service provider.', array(1 => $fixUrl)));
 106         }
 107
 108         if (!$toEmail) {
 109           CRM_Core_Error::statusBounce(ts('Cannot send a test email because your user record does not have a valid email address.'));
 110         }
 111
 112         if (!trim($toDisplayName)) {
 113           $toDisplayName = $toEmail;
 114         }
 115
 116         $to = '"' . $toDisplayName . '"' . "<$toEmail>";
 117         $from = '"' . $domainEmailName . '" <' . $domainEmailAddress . '>';
 118         $testMailStatusMsg = ts('Sending test email') . ':<br />'
 119           . ts('From: %1', array(1 => $domainEmailAddress)) . '<br />'
 120           . ts('To: %1', array(1 => $toEmail)) . '<br />';
 121
 122         $params = array();
 123         if ($formValues['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_SMTP) {
 124           $subject = "Test for SMTP settings";
 125           $message = "SMTP settings are correct.";
 126
 127           $params['host'] = $formValues['smtpServer'];
 128           $params['port'] = $formValues['smtpPort'];
 129
 130           if ($formValues['smtpAuth']) {
 131             $params['username'] = $formValues['smtpUsername'];
 132             $params['password'] = $formValues['smtpPassword'];
 133             $params['auth'] = TRUE;
 134           }
 135           else {
 136             $params['auth'] = FALSE;
 137           }
 138
 139           // set the localhost value, CRM-3153, CRM-9332
 140           $params['localhost'] = $_SERVER['SERVER_NAME'];
 141
 142           // also set the timeout value, lets set it to 30 seconds
 143           // CRM-7510, CRM-9332
 144           $params['timeout'] = 30;
 145
 146           $mailerName = 'smtp';
 147         }
 148         elseif ($formValues['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_SENDMAIL) {
 149           $subject = "Test for Sendmail settings";
 150           $message = "Sendmail settings are correct.";
 151           $params['sendmail_path'] = $formValues['sendmail_path'];
 152           $params['sendmail_args'] = $formValues['sendmail_args'];
 153           $mailerName = 'sendmail';
 154         }
 155         elseif ($formValues['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_MAIL) {
 156           $subject = "Test for PHP mail settings";
 157           $message = "mail settings are correct.";
 158           $mailerName = 'mail';
 159         }
 160
 161         $headers = array(
 162           'From' => $from,
 163           'To' => $to,
 164           'Subject' => $subject,
 165         );
 166
 167         $mailer = Mail::factory($mailerName, $params);
 168
 169         $errorScope = CRM_Core_TemporaryErrorScope::ignoreException();
 170         $result = $mailer->send($toEmail, $headers, $message);
 171         unset($errorScope);
 172         if (defined('CIVICRM_MAIL_LOG') && defined('CIVICRM_MAIL_LOG_AND_SEND')) {
 173           $testMailStatusMsg .= '<br />' . ts('You have defined CIVICRM_MAIL_LOG_AND_SEND - mail will be logged.') . '<br /><br />';
 174         }
 175         if (defined('CIVICRM_MAIL_LOG') && !defined('CIVICRM_MAIL_LOG_AND_SEND')) {
 176           CRM_Core_Session::setStatus($testMailStatusMsg . ts('You have defined CIVICRM_MAIL_LOG - no mail will be sent.  Your %1 settings have not been tested.', array(1 => strtoupper($mailerName))), ts("Mail not sent"), "warning");
 177         }
 178         elseif (!is_a($result, 'PEAR_Error')) {
 179           CRM_Core_Session::setStatus($testMailStatusMsg . ts('Your %1 settings are correct. A test email has been sent to your email address.', array(1 => strtoupper($mailerName))), ts("Mail Sent"), "success");
 180         }
 181         else {
 182           $message = CRM_Utils_Mail::errorMessage($mailer, $result);
 183           CRM_Core_Session::setStatus($testMailStatusMsg . ts('Oops. Your %1 settings are incorrect. No test mail has been sent.', array(1 => strtoupper($mailerName))) . $message, ts("Mail Not Sent"), "error");
 184         }
 185       }
 186     }
 187
 188     $mailingBackend = Civi::settings()->get('mailing_backend');
 189
 190     if (!empty($mailingBackend)) {
 191       $formValues = array_merge($mailingBackend, $formValues);
 192     }
 193
 194     // if password is present, encrypt it
 195     if (!empty($formValues['smtpPassword'])) {
 196       $formValues['smtpPassword'] = CRM_Utils_Crypt::encrypt($formValues['smtpPassword']);
 197     }
 198
 199     Civi::settings()->set('mailing_backend', $formValues);
 200   }
 201
 202   /**
 203    * Global validation rules for the form.
 204    *
 205    * @param array $fields
 206    *   Posted values of the form.
 207    *
 208    * @return array
 209    *   list of errors to be posted back to the form
 210    */
 211   public static function formRule($fields) {
 212     if ($fields['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_SMTP) {
 213       if (empty($fields['smtpServer'])) {
 214         $errors['smtpServer'] = 'SMTP Server name is a required field.';
 215       }
 216       if (empty($fields['smtpPort'])) {
 217         $errors['smtpPort'] = 'SMTP Port is a required field.';
 218       }
 219       if (!empty($fields['smtpAuth'])) {
 220         if (empty($fields['smtpUsername'])) {
 221           $errors['smtpUsername'] = 'If your SMTP server requires authentication please provide a valid user name.';
 222         }
 223         if (empty($fields['smtpPassword'])) {
 224           $errors['smtpPassword'] = 'If your SMTP server requires authentication, please provide a password.';
 225         }
 226       }
 227     }
 228     if ($fields['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_SENDMAIL) {
 229       if (!$fields['sendmail_path']) {
 230         $errors['sendmail_path'] = 'Sendmail Path is a required field.';
 231       }
 232       if (!$fields['sendmail_args']) {
 233         $errors['sendmail_args'] = 'Sendmail Argument is a required field.';
 234       }
 235     }
 236
 237     return empty($errors) ? TRUE : $errors;
 238   }
 239
 240   /**
 241    * Set default values for the form.
 242    */
 243   public function setDefaultValues() {
 244     if (!$this->_defaults) {
 245       $this->_defaults = array();
 246
 247       $mailingBackend = Civi::settings()->get('mailing_backend');
 248       if (!empty($mailingBackend)) {
 249         $this->_defaults = $mailingBackend;
 250
 251         if (!empty($this->_defaults['smtpPassword'])) {
 252           $this->_defaults['smtpPassword'] = CRM_Utils_Crypt::decrypt($this->_defaults['smtpPassword']);
 253         }
 254       }
 255       else {
 256         if (!isset($this->_defaults['smtpServer'])) {
 257           $this->_defaults['smtpServer'] = 'localhost';
 258           $this->_defaults['smtpPort'] = 25;
 259           $this->_defaults['smtpAuth'] = 0;
 260         }
 261
 262         if (!isset($this->_defaults['sendmail_path'])) {
 263           $this->_defaults['sendmail_path'] = '/usr/sbin/sendmail';
 264           $this->_defaults['sendmail_args'] = '-i';
 265         }
 266       }
 267     }
 268     $this->_defaults['allow_mail_from_logged_in_contact'] = Civi::settings()->get('allow_mail_from_logged_in_contact');
 269     return $this->_defaults;
 270   }
 271
 272 }