Mail.inc.php

<?php
 
define('MAIL_WRAP', 76);
 
class Mail extends DataObject {
   var $privateParams;
 
   function __construct() {
      parent::__construct();
      $this->privateParams = array();
      if (Config::getVar('email', 'allow_envelope_sender')) {
         $defaultEnvelopeSender = Config::getVar('email', 'default_envelope_sender');
         if (!empty($defaultEnvelopeSender)) $this->setEnvelopeSender($defaultEnvelopeSender);
      }
   }
 
   function addPrivateParam($name, $value) {
      $this->privateParams[$name] = $value;
   }
 
   function setPrivateParams($privateParams) {
      $this->privateParams = $privateParams;
   }
 
   function addRecipient($email, $name = '') {
      if (($recipients = $this->getData('recipients')) == null) {
         $recipients = array();
      }
      array_push($recipients, array('name' => $name, 'email' => $email));
 
      $this->setData('recipients', $recipients);
   }
 
   function setEnvelopeSender($envelopeSender) {
      $this->setData('envelopeSender', $envelopeSender);
   }
 
   function getEnvelopeSender() {
      if (Config::getVar('email', 'force_default_envelope_sender') && Config::getVar('email', 'default_envelope_sender')) {
         return Config::getVar('email', 'default_envelope_sender');
      } else {
         return $this->getData('envelopeSender');
      }
   }
 
 
   function getContentType() {
      return $this->getData('content_type');
   }
 
   function setContentType($contentType) {
      $this->setData('content_type', $contentType);
   }
 
   function getRecipients() {
      return $this->getData('recipients');
   }
 
   function setRecipients($recipients) {
      $this->setData('recipients', $recipients);
   }
 
   function addCc($email, $name = '') {
      if (($ccs = $this->getData('ccs')) == null) {
         $ccs = array();
      }
      array_push($ccs, array('name' => $name, 'email' => $email));
 
      $this->setData('ccs', $ccs);
   }
 
   function getCcs() {
      return $this->getData('ccs');
   }
 
   function setCcs($ccs) {
      $this->setData('ccs', $ccs);
   }
 
   function addBcc($email, $name = '') {
      if (($bccs = $this->getData('bccs')) == null) {
         $bccs = array();
      }
      array_push($bccs, array('name' => $name, 'email' => $email));
 
      $this->setData('bccs', $bccs);
   }
 
   function getBccs() {
      return $this->getData('bccs');
   }
 
   function setBccs($bccs) {
      $this->setData('bccs', $bccs);
   }
 
   function promoteCcsIfNoRecipients() {
      $ccs = $this->getCcs();
      $recipients = $this->getRecipients();
      if (empty($recipients)) {
         $this->setRecipients($ccs);
         $this->setCcs(array());
         return true;
      }
      return false;
   }
 
   function clearAllRecipients() {
      $this->setRecipients(array());
      $this->setCcs(array());
      $this->setBccs(array());
   }
 
   function addHeader($name, $content) {
      $updated = false;
 
      if (($headers = $this->getData('headers')) == null) {
         $headers = array();
      }
 
      foreach ($headers as $key => $value) {
         if ($value['name'] == $name) {
            $headers[$key]['content'] = $content;
            $updated = true;
         }
      }
 
      if (!$updated) {
         array_push($headers, array('name' => $name,'content' => $content));
      }
 
      $this->setData('headers', $headers);
   }
 
   function getHeaders() {
      return $this->getData('headers');
   }
 
   function setHeaders(&$headers) {
      $this->setData('headers', $headers);
   }
 
   function addAttachment($filePath, $fileName = '', $contentType = '', $contentDisposition = 'attachment') {
      if ($attachments =& $this->getData('attachments') == null) {
         $attachments = array();
      }
 
      /* If the arguments $fileName and $contentType are not specified,
         then try and determine them automatically. */
      if (empty($fileName)) {
         $fileName = basename($filePath);
      }
 
      if (empty($contentType)) {
         $contentType = PKPString::mime_content_type($filePath);
         if (empty($contentType)) $contentType = 'application/x-unknown-content-type';
      }
 
      array_push($attachments, array(
         'path' => $filePath,
         'filename' => $fileName,
         'content-type' => $contentType
      ));
 
      $this->setData('attachments', $attachments);
   }
 
   function &getAttachments() {
      $attachments =& $this->getData('attachments');
      return $attachments;
   }
 
   function hasAttachments() {
      $attachments =& $this->getAttachments();
      return ($attachments != null && count($attachments) != 0);
   }
 
   function setFrom($email, $name = '') {
      $this->setData('from', array('name' => $name, 'email' => $email));
   }
 
   function getFrom() {
      return $this->getData('from');
   }
 
   function setReplyTo($email, $name = '') {
      if ($email === null) $this->setData('replyTo', null);
      $this->setData('replyTo', array(array('name' => $name, 'email' => $email)));
   }
 
   function addReplyTo($email, $name = '') {
      if (($replyTos = $this->getData('replyTo')) == null) {
         $replyTos = array();
      }
      array_push($replyTos, array('name' => $name, 'email' => $email));
 
      $this->setData('replyTo', $replyTo);
   }
 
 
   function getReplyTo() {
      return $this->getData('replyTo');
   }
 
   function getReplyToString($send = false) {
      return $this->getAddressArrayString($this->getReplyTo(), true, $send);
   }
 
   function setSubject($subject) {
      $this->setData('subject', $subject);
   }
 
   function getSubject() {
      return $this->getData('subject');
   }
 
   function setBody($body) {
      $this->setData('body', $body);
   }
 
   function getBody() {
      return $this->getData('body');
   }
 
   function getFromString($send = false) {
      $from = $this->getFrom();
      if ($from == null) {
         return null;
      } 
      return (self::encodeDisplayName($from['name'], $send) . ' <'.$from['email'].'>');
   }
 
   function getAddressArrayString($addresses, $includeNames = true, $send = false) {
      if ($addresses == null) {
         return null;
 
      } else {
         $addressString = '';
 
         foreach ($addresses as $address) {
            if (!empty($addressString)) {
               $addressString .= ', ';
            }
 
            if (empty($address['name']) || !$includeNames) {
               $addressString .= $address['email'];
 
            } else {
               $addressString .= self::encodeDisplayName($address['name'], $send) . ' <'.$address['email'].'>';
            }
         }
 
         return $addressString;
      }
   }
 
   function getRecipientString() {
      return $this->getAddressArrayString($this->getRecipients());
   }
 
   function getCcString() {
      return $this->getAddressArrayString($this->getCcs());
   }
 
   function getBccString() {
      return $this->getAddressArrayString($this->getBccs(), false);
   }
 
 
   function send() {
      if (HookRegistry::call('Mail::send', array($this))) return true;
 
      // Replace all the private parameters for this message.
      $mailBody = $this->getBody();
      if (is_array($this->privateParams)) {
         foreach ($this->privateParams as $name => $value) {
            $mailBody = str_replace($name, $value, $mailBody);
         }
      }
 
      $mailer = new \PHPMailer\PHPMailer\PHPMailer();
      $mailer->IsHTML(true);
      $mailer->Encoding = 'base64';
      if (Config::getVar('email', 'smtp')) {
         $mailer->IsSMTP();
         $mailer->Port = Config::getVar('email', 'smtp_port');
         if (($s = Config::getVar('email', 'smtp_auth')) != '') {
            $mailer->SMTPSecure = $s;
            $mailer->SMTPAuth = true;
         }
         $mailer->Host = Config::getVar('email', 'smtp_server');
         $mailer->Username = Config::getVar('email', 'smtp_username');
         $mailer->Password = Config::getVar('email', 'smtp_password');
         if (Config::getVar('debug', 'show_stacktrace')) {
            // debug level 3 represents client and server interaction, plus initial connection debugging
            $mailer->SMTPDebug = 3;
            $mailer->Debugoutput = 'error_log';
         }
         if (Config::getVar('email', 'smtp_suppress_cert_check')) {
            // disabling the SMTP certificate check.
            $mailer->SMTPOptions = array(
               'ssl' => array(
                  'verify_peer' => false,
                  'verify_peer_name' => false,
                  'allow_self_signed' => true
               )
            );
         }
      }
      $mailer->CharSet = Config::getVar('i18n', 'client_charset');
      if (($t = $this->getContentType()) != null) $mailer->ContentType = $t;
      $mailer->XMailer = 'Public Knowledge Project Suite v3';
      $mailer->WordWrap = MAIL_WRAP;
      foreach ((array) $this->getHeaders() as $header) {
         $mailer->AddCustomHeader($header['key'], $mailer->SecureHeader($header['content']));
      }
      $request = Application::get()->getRequest();
      if (($f = $this->getFrom()) != null) {
         if (Config::getVar('email', 'force_default_envelope_sender') && Config::getVar('email', 'default_envelope_sender') && Config::getVar('email', 'force_dmarc_compliant_from')) {
            /* If a DMARC compliant RFC5322.From was requested we need to promote the original RFC5322.From into a Reply-to header
             * and then munge the RFC5322.From */
            $alreadyExists = false;
            foreach ((array) $this->getReplyTo() as $r) {
               if ($r['email'] === $f['email']) {
                  $alreadyExists = true;
               }
            }
            if (!$alreadyExists) {
               $mailer->AddReplyTo($f['email'], $f['name']);
            }
 
            $site = $request->getSite();
 
            // Munge the RFC5322.From
            if (Config::getVar('email', 'dmarc_compliant_from_displayname')) {
               $patterns = array('#%n#', '#%s#');
               $replacements = array($f['name'], $site->getLocalizedTitle());
               $f['name'] = preg_replace($patterns, $replacements, Config::getVar('email', 'dmarc_compliant_from_displayname'));
            } else {
               $f['name'] = '';
            }
            $f['email'] = Config::getVar('email', 'default_envelope_sender');
         }
         // this sets both the envelope sender (RFC5321.MailFrom) and the From: header (RFC5322.From)
         $mailer->SetFrom($f['email'], $f['name']);
      }
      // Set the envelope sender (RFC5321.MailFrom)
      if (($s = $this->getEnvelopeSender()) != null) $mailer->Sender = $s;
      foreach ((array) $this->getReplyTo() as $r) {
         $mailer->AddReplyTo($r['email'], $r['name']);
      }
      foreach ((array) $this->getRecipients() as $recipientInfo) {
         $mailer->AddAddress($recipientInfo['email'], $recipientInfo['name']);
      }
      foreach ((array) $this->getCcs() as $ccInfo) {
         $mailer->AddCC($ccInfo['email'], $ccInfo['name']);
      }
      foreach ((array) $this->getBccs() as $bccInfo) {
         $mailer->AddBCC($bccInfo['email'], $bccInfo['name']);
      }
      $mailer->Subject = $this->getSubject();
      $mailer->Body = $mailBody;
      $mailer->AltBody = PKPString::html2text($mailBody);
 
      $remoteAddr = $mailer->SecureHeader($request->getRemoteAddr());
      if ($remoteAddr != '') $mailer->AddCustomHeader("X-Originating-IP: $remoteAddr");
 
      foreach ((array) $this->getAttachments() as $attachmentInfo) {
         $mailer->AddAttachment(
            $attachmentInfo['path'],
            $attachmentInfo['filename'],
            'base64',
            $attachmentInfo['content-type']
         );
      }
 
      try {
         $success = $mailer->Send();
         if (!$success) {
            error_log($mailer->ErrorInfo);
            return false;
         }
      } catch (phpmailerException $e) {
         error_log($mailer->ErrorInfo);
         return false;
      }
      return true;
   }
 
   static function encodeDisplayName($displayName, $send = false) {
      if (PKPString::regexp_match('!^[-A-Za-z0-9\!#\$%&\'\*\+\/=\?\^_\`\{\|\}~]+$!', $displayName)) return $displayName;
      return ('"' . ($send ? PKPString::encode_mime_header(str_replace(
         array('"', '\\'),
         '',
         $displayName
      )) : str_replace(
         array('"', '\\'),
         '',
         $displayName
      )) . '"');
   }
}