Mail.php

Go to the documentation of this file.

<?php
 
namespace Rsi\Fred;
 
class Mail extends Component{
 
  const STYLE_INLINE_NONE = null; //!< Do not inline stylesheets or style blocks.
  const STYLE_INLINE_FILE = 'file'; //!< Convert stylesheets to inline style blocks.
  const STYLE_INLINE_HTML = 'html'; //!< Inline all style blocks (including files) to inline style.
 
  public $defaultFrom = null;
  public $restrict = []; //!< Regular expressions that the e-mail address has to match (at least one; empty = allow all).
  public $mailers = []; //!< Domain specific mailer/transport (key = domain name; value = array with mailer or host, port,
    // username, and password for SMTP - all optional).
  public $subjectId = '*Subject'; //!< Get subject from translation component (when body is array of tags); asterisk is
    // replaced with the subject (code).
  public $bodyId = '*Message'; //!< Get message body from translation component (when body is array of tags); asterisk is
    // replaced with the subject (code).
  public $markup = ['b' => '*','i' => '/','u' => '_'];
  public $styleInline = self::STYLE_INLINE_FILE;
  public $dataPrefix = 'data-'; //!< Prefix for data tags (empty = do not allow).
  public $imageExtMask = '(gif|jpe?g|png|svg)'; //!< Allowed file extensions for (local) embedable images.
  public $attachmentExtMask = '(docx?|pdf|txt|xlsx?)'; //!< Allowed file extensions for (local) attachments.
  public $forward = []; //!< Forwarding rules (array of records with regex for from, to, cc, bcc, subject, and/or body; if all
    // match the mail is forwarded to the null key).
 
  protected $_logger = null;
  protected $_mailer = null;
  protected $_transport = null;
  protected $_imap = null;
  protected $_queue = null;
 
  protected function init(){
    parent::init();
    $this->component('log')->debug('Initializing Swift Mailer version ' . \Swift::VERSION,__FILE__,__LINE__); //initialize Swift Mailer autoloader
  }
  /**
   * Translate attachment filenames before downloading them.
   * @param string $filename  Original filename.
   * @return string  Translated filename.
   */
  protected function translateFilename($filename){
    return $filename;
  }
  /**
   * Filter a list of recipients.
   * @param array $recipients  A list of recipients.
   * @return array  Filtered list of recipients (only those matched by the restriction set, or all if no restrictions).
   */
  public function filterRecipients($recipients){
    if(!$this->restrict) return $recipients;
    $allowed = [];
    foreach(\Rsi\Record::explode($recipients) as $key => $value){
      $email = is_numeric($key) ? $value : $key;
      foreach($this->restrict as $filter) if(preg_match(substr($filter,0,1) == '/' ? $filter : '/' . preg_quote($filter,'/') . '/',$email)){
        $allowed[$key] = $value;
        break;
      }
    }
    return $allowed;
  }
  /**
   * Add a sent message to the log.
   * @param \\Swift_Message $message
   * @param int $result  Result from the send function.
   * @param array $failures  Addresses that failed.
   * @param array $context  Extra context for the log message.
   */
  protected function log($message,$result,$failures = null,$context = null){
    $context = array_merge($context ?: [],compact('result','failures'));
    foreach(['from','to','cc','bcc','subject','body'] as $key) if($value = call_user_func([$message,'get' . ucfirst($key)])) $context[$key] = $value;
    $this->component('log')->debug('Sending mail "' . $message->getSubject() .'"',__FILE__,__LINE__,$context);
  }
  /**
   * Check if a filename is valid (external or in document root).
   * @param string $filename
   * @param string $ext  Allowed extension (local file only).
   * @return bool  True when valid.
   */
  protected function validFilename($filename,$ext){
    return
      preg_match('/^https?:\\/\\//i',$filename) ||
      (preg_match('/^[\\w\\-\\/]+\\.' . $ext . '$/i',$filename) && is_file($filename = \Rsi\Http::docRoot() . DIRECTORY_SEPARATOR . $filename));
  }
  /**
   * Find all tags with a certain data tag.
   * @param string $body  HTML message body.
   * @param string $data  Data tag to look for (without prefix).
   * @param string $tag  HTML tag.
   * @return array  Array with matches (full tags).
   */
  protected function dataTags($body,$data,$tag = null){
    return $this->dataPrefix && preg_match_all("/<$tag(?=\\s)[^>]*\\s{$this->dataPrefix}$data(?=[=\\s>]).*?>/is",$body,$matches) ? $matches[0] : [];
  }
  /**
   * Remove all tags from the message body.
   * Link addresses are placed between parenthesis after the original anchor text.
   * @param string $body  Message in HTML format.
   * @return string  Message in plain text.
   */
  protected function textBody($body){
    $body = preg_replace('/<style>.*?<\\/style>/s','',$body);
    foreach($this->markup as $tag => $char) $body = preg_replace("/<($tag\\b.*?|\\/$tag)>/",$char,$body);
    if(preg_match_all('/<a.*?href\s*=\s*([^\s>]+).*?>(.*?)<\\/a>/',$body,$matches,PREG_SET_ORDER)) foreach($matches as list($full,$link,$descr)){
      $link = \Rsi\Str::stripQuotes($link);
      $body = str_replace($full,$descr . ($link == $descr ? '' : " ($link)"),$body);
    }
    return strip_tags($body);
  }
  /**
   * Process HTML body.
   * @param string $body  Message in HTML format.
   * @param \\Swift_Message $message  Swift Mailer message object.
   * @return string  Message in HTML format.
   */
  protected function htmlBody($body,$message){
    $log = $this->component('log');
    //inline style
    if($this->styleInline){
      $style = null;
      if(preg_match_all('/<link rel=[\'"]stylesheet[\'"] href=[\'"]\\/?([^\'"]+)[\'"].*?>/i',$body,$matches,PREG_SET_ORDER)) foreach($matches as list($full,$filename)){
        if(!$this->validFilename($filename,'css')) $body = str_replace($full,basename($filename) . ' not found!',$body);
        elseif($this->styleInline == self::STYLE_INLINE_FILE) $body = str_replace($full,'<style>' . file_get_contents($filename) . '</style>',$body);
        else{
          $style .= file_get_contents($filename);
          $body = str_replace($full,'',$body);
        }
      }
      if(($this->styleInline == self::STYLE_INLINE_HTML) && preg_match_all('/<style>(.*?)<\\/style>/is',$body,$matches,PREG_SET_ORDER)) foreach($matches as list($full,$inline)){
        $style .= $inline;
        $body = str_replace($full,'',$body);
      }
      if($style) $body = (new \TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body,$style))->convert();
    }
    //embed images (optional)
    $cids = [];
    foreach($this->dataTags($body,'embed','img') as $tag) if($this->validFilename($filename = \Rsi\Record::iget(\Rsi\Str::attributes($tag),'src'),$this->imageExtMask)) try{
      if(!array_key_exists($filename,$cids)){
        $cids[$filename] = $cid = $message->embed(\Swift_Image::fromPath($this->translateFilename($filename)));
        $log->debug("Embedded image '$filename' as '$cid'",__FILE__,__LINE__);
      }
      $body = str_replace($tag,str_replace($filename,$cids[$filename],$tag),$body);
    }
    catch(\Exception $e){
      $log->info("Could not inline image '$tag': " . $e->getMessage(),$e->getFile(),$e->getLine(),$e->getTrace());
    }
    //add attachments (optional)
    foreach($this->dataTags($body,$data = 'attach','a') as $tag) if($this->validFilename($filename = \Rsi\Record::iget($attributes = \Rsi\Str::attributes($tag),'href'),$this->attachmentExtMask)) try{
      $attachment = \Swift_Attachment::fromPath($this->translateFilename($filename));
      if($download = \Rsi\Record::iget($attributes,'download')) $attachment->setFilename($download);
      $message->attach($attachment);
      $log->debug("Attached file '$filename'",__FILE__,__LINE__);
      if(!is_bool($replace = \Rsi\Record::iget($attributes,$this->dataPrefix . $data))) $body = preg_replace('/' . preg_quote($tag,'/') . '.*?<\\/a>/is',$replace,$body);
    }
    catch(\Exception $e){
      $log->info("Could not attach file '$tag': " . $e->getMessage(),$e->getFile(),$e->getLine(),$e->getTrace());
    }
    return $body;
  }
  /**
   * Create a new Swift Mailer message object.
   * @param mixed $from  Sender address (defaultFrom or ini sendmail_from when empty).
   * @param mixed $to  Recipient(s).
   * @param string $subject  Subject line, or translation ID when the body is an array.
   * @param string|array $body  Message body, or translation tags.
   * @param bool $html  True when the message body is in HTML format.
   * @return \\Swift_Message
   */
  public function message($from = null,$to = null,$subject = null,$body = null,$html = false){
    if(is_array($tags = $body)){
      $trans = $this->component('trans');
      $body = $trans->id(str_replace('*',$id = $subject,$this->bodyId),$tags);
      $subject = $trans->id(str_replace('*',$id,$this->subjectId),$tags);
    }
    $message = new \Swift_Message();
    $message->setFrom($from ?: ($this->defaultFrom ?: ini_get('sendmail_from')));
    $message->setTo($to);
    if($subject) $message->setSubject($subject);
    if($body){
      if($html) $message->setBody($this->htmlBody($body,$message),'text/html')->addPart($this->textBody($body),'text/plain');
      else $message->setBody($body);
    }
    return $message;
  }
  /**
   * Forward a message (copy subject, body, and attachments).
   * @param \\Rsi\\Imap\\Mailbox\\Message $message  Message to forward.
   * @return \\Swift_Message
   */
  public function forward($message){
    $forward = new \Swift_Message();
    $html = $message->html;
    foreach($message->attachments as $attachment) if($html && $attachment->id)
      $html = preg_replace('/\\bcid:' . preg_quote($attachment->id,'/') . '\\b/',$forward->embed(new \Swift_Image($attachment->data,$attachment->name)),$html);
    else $forward->attach(new \Swift_Attachment($attachment->data,$attachment->name));
    if($html) $forward->setBody($html,'text/html')->addPart($message->plain,'text/plain');
    else $forward->setBody($message->plain);
    return $forward;
  }
  /**
   * Domain specific mailer.
   * @param string $host  Host name of the sender.
   * @return \\Swift_MailTransport  Specific mailer, or default mailer.
   */
  public function mailer($host = null){
    $mailer = $this->mailer; //init optional logger
    if(array_key_exists($host,$this->mailers)){
      if(!array_key_exists('mailer',$config = $this->mailers[$host])){
        $this->mailers[$host]['mailer'] = new \Swift_Mailer(new \Swift_SmtpTransport($config['host'] ?? $host,$config['port'] ?? 25));
        if($this->_logger) $this->mailers[$host]['mailer']->registerPlugin(new \Swift_Plugins_LoggerPlugin($this->_logger));
      }
      $mailer = $this->mailers[$host]['mailer'];
    }
    return $mailer;
  }
  /**
   * Send a message.
   * If the message is not an object, it is created from all the parameters.
   * @see message()
   * @param \\Swift_Message $message
   * @return int  Number of addresses that succeeded.
   */
  public function send($message){
    if(!($message instanceof \Swift_Message)) $message = call_user_func_array([$this,'message'],func_get_args());
    $count = 0;
    foreach(['To','Cc','Bcc'] as $key) if($recipients = call_user_func([$message,'get' . $key])){
      $count += count($recipients = $this->filterRecipients($recipients));
      call_user_func([$message,'set' . $key],$recipients);
    }
    $result = $failures = false;
    if($count) try{
      $result = $this->mailer(($from = imap_rfc822_parse_adrlist(\Rsi\Record::key($message->getFrom()),'')) ? $from[0]->host : null)->send($message,$failures);
      $this->log($message,$result,$failures);
      $message->setCc(null);
      $message->setBcc(null);
      if($result) foreach($this->forward as $forward){
        foreach($forward as $key => $mask) if($key && !preg_match($mask,implode('#',(array)call_user_func([$message,'get' . ucfirst($key)])))) continue 2;
        $message->setTo($forward[null]);
        $this->mailer->send($message);
      }
    }
    catch(\Exception $e){
      $this->log($message,null,null,$this->_logger ? ['logger' => $this->_logger->dump()] : null);
      throw $e;
    }
    return $result;
  }
  /**
   * Add a message to the queue (with possible delay).
   * Note: requires the calling of spool() on a regular interval.
   * @param \\Swift_Message $message
   * @param int $delay  Delay in seconds.
   * @param string $id  ID for the message (if two messages have the same ID, the previous one is overwritten; empty = random).
   * @return bool  ID when added to the queue successfully, false on failure.
   */
  public function queue($message,$delay = 0,$id = null){
    $result = false;
    if($this->queue->path){
      if(!$id) while(file_exists($this->queue->path . ($id = \Rsi\Str::random(32,'+')) . $this->queue->ext));
      if(
        \Rsi\File::serialize($temp = ($filename = $this->queue->path . $id . $this->queue->ext) . $this->queue->tempExt,$message) &&
        touch($temp,time() + $delay)
      ) $result = \Rsi\File::rename($temp,$filename);
      else $this->component('log')->error("Could not queue message '$id': " . $message->getSubject());
    }
    return $result ? $id : false;
  }
  /**
   * Delete a message from the queue.
   * @param string $id  Message ID.
   * @return bool  True if the message was deleted.
   */
  public function delete($id){
    return \Rsi\File::unlink($this->queue->path . $id . $this->queue->ext);
  }
  /**
   * Spool the message queue.
   * @param int $time  Maximum execution time (seconds; empty = unlimited).
   * @return int  Number of sent messages.
   */
  public function spool($time = null){
    $log = $this->component('log');
    if($time) $time += time();
    $count = 0;
    foreach((new \FilesystemIterator($this->queue->path)) as $filename => $file) try{
      if(\Rsi\Str::endsWith($filename,$this->queue->ext . $this->queue->tempExt)){
        if($file->getMTime() < time() - $this->queue->timeout)
          $log->warning('Purged temp message',['result' => \Rsi\File::unlink($file->getPathname())]);;
      }
      elseif(\Rsi\Str::endsWith($filename,$this->queue->ext . $this->queue->busyExt)){
        if($file->getMTime() < time() - $this->queue->timeout)
          $log->warning('Reset busy message',['result' => rename($filename,substr($file->getPathname(),0,-strlen($this->queue->busyExt)))]);
      }
      elseif(
        \Rsi\Str::endsWith($filename,$this->queue->ext) &&
        ($file->getMTime() <= time()) &&
        class_exists('Swift_Message') &&
        rename($filename,$busy = $filename . $this->queue->busyExt) &&
        $this->send(\Rsi\File::unserialize($busy)) &&
        unlink($busy)
      ) $count++;
      if($time && ($time < time())) break;
    }
    catch(\Exception $e){
      $log->error($e);
    }
    return $count;
  }
  /**
   * Restart the connection.
   */
  public function restart(){
    $this->_mailer = $this->_transport = null;
  }
  /**
   * Open an IMAP mailbox.
   * @param string $name  Mailbox to connect to (empty = default).
   * @return \\Rsi\\Imap\\Mailbox
   */
  public function box($name = null){
    return $this->imap->mailbox($name);
  }
 
  protected function getImap(){
    if(!$this->_imap){
      $imap = new \Rsi\Wrapper\Record($this->config('imap'));
      $this->_imap = new \Rsi\Imap($imap->host,$imap->username,$imap->password,$imap->options,$imap->port);
    }
    return $this->_imap;
  }
 
  protected function getMailer(){
    if(!$this->_mailer){
      $this->_mailer = new \Swift_Mailer($this->transport);
      if($this->_fred->debug) $this->_mailer->registerPlugin(new \Swift_Plugins_LoggerPlugin(
        $this->_logger = new \Swift_Plugins_Loggers_ArrayLogger()
      ));
    }
    return $this->_mailer;
  }
 
  protected function getTransport(){
    if(!$this->_transport){
      if($smtp = $this->config('smtp')){
        if($host = $smtp['host'] ?? null) $port = $smtp['port'] ?? 25;
        else{
          $host = ini_get('SMTP');
          $port = ini_get('smtp_port');
        }
        $this->_transport = new \Swift_SmtpTransport($host,$port,$smtp['security'] ?? null);
        if($stream = $smtp['stream'] ?? null) $this->_transport->setStreamOptions($stream);
        if($username = $smtp['username'] ?? null) $this->_transport->setUsername($username);
        if($password = $smtp['password'] ?? null) $this->_transport->setPassword($password);
      }
      elseif($sendmail = $this->config('sendmail')) $this->_transport = new \Swift_SendmailTransport($sendmail);
      else $this->_transport = new \Swift_MailTransport();
    }
    return $this->_transport;
  }
 
  protected function getQueue(){
    if(!$this->_queue) $this->_queue = new \Rsi\Wrapper\Record($this->config('queue') + [
      'path' => null,
      'ext' => '.message',
      'tempExt' => '.temp',
      'busyExt' => '.busy',
      'timeout' => 60
    ]);
    return $this->_queue;
  }
 
  public function __invoke($from = null,$to = null,$subject = null,$body = null,$html = false){
    return $this->send($from,$to,$subject,$body,$html);
  }
 
}