xoopsmailer.php

<?php
 
if (!defined('XOOPS_ROOT_PATH')) {
    exit();
}
 
if (isset($GLOBALS['xoopsConfig']['language']) && file_exists(XOOPS_ROOT_PATH.'/language/'.$GLOBALS['xoopsConfig']['language'].'/mail.php')) {
    include_once XOOPS_ROOT_PATH.'/language/'.$GLOBALS['xoopsConfig']['language'].'/mail.php';
} else {
    include_once XOOPS_ROOT_PATH.'/language/english/mail.php';
}

include_once(XOOPS_ROOT_PATH . '/class/mail/xoopsmultimailer.php');
 

class xoopsmailer
{
    public $multimailer;
 
    // sender email address
    // private
    public $fromEmail;
 
    // sender name
    // private
    public $fromName;
 
    // RMV-NOTIFY
    // sender UID
    // private
    public $fromUser;
 
    // array of user class objects
    // private
    public $toUsers;
 
    // array of email addresses
    // private
    public $toEmails;
 
    // custom headers
    // private
    public $headers;
 
    // subjet of mail
    // private
    public $subject;
 
    // body of mail
    // private
    public $body;
 
    // error messages
    // private
    public $errors;
 
    // messages upon success
    // private
    public $success;
 
    // private
    public $isMail;
 
    // private
    public $isPM;
 
    // private
    public $assignedTags;
 
    // private
    public $template;
 
    // private
    public $templatedir;
 
    // protected
    // replace iso by utf-8
    // public $charSet = 'iso-8859-1';
    public $charSet = 'UTF-8';
 
    // protected
    public $encoding = '8bit';
 
    private $properties = [
        'fromEmail'    => '',
        'fromName'     => '',
        'fromUser'     => null, // RMV-NOTIFY
        'priority'     => '',
        'toUsers'      => [],
        'toEmails'     => [],
        'headers'      => [],
        'subject'      => '',
        'body'         => '',
        'errors'       => [],
        'success'      => [],
        'isMail'       => false,
        'isPM'         => false,
        'assignedTags' => [],
        'template'     => '',
        'templatedir'  => '',
        // Change below to \r\n if you have problem sending mail
        'LE'           => "\n"
    ];
 
    public function __construct()
    {
        $this->multimailer = new XoopsMultiMailer();
        $this->reset();
    }
 
    // public
    // reset all properties to default
    public function reset()
    {
        foreach ($this->properties as $key => $val) {
            $this->$key = $val;
        }
    }
 
    // public
    public function setTemplateDir($value)
    {
        if ('/' != substr($value, -1, 1)) {
            $value .= '/';
        }
        $this->templatedir = $value;
    }
 
    // public
    public function setTemplate($value)
    {
        $this->template = $value;
    }
 
    // pupblic
    public function setFromEmail($value)
    {
        $this->fromEmail = trim($value);
    }
 
    // public
    public function setFromName($value)
    {
        $this->fromName = trim($value);
    }
 
    // RMV-NOTIFY
    // public
    public function setFromUser(&$user)
    {
        if ('xoopsuser' == strtolower(get_class($user))) {
            $this->fromUser =& $user;
        }
    }
 
    // public
    public function setPriority($value)
    {
        $this->priority = trim($value);
    }
 
 
    // public
    public function setSubject($value)
    {
        $this->subject = trim($value);
    }
 
    // public
    public function setBody($value)
    {
        $this->body = trim($value);
    }
 
    // public
    public function useMail()
    {
        $this->isMail = true;
    }
 
    // public
    public function usePM()
    {
        $this->isPM = true;
    }
 
    public function getVar($key)
    {
        if (isset($this->properties[$key])) {
            return $this->$key;
        } else {
            return null;
        }
    }
 
    // public
    public function send($debug = false)
    {
        global $xoopsConfig;
        if ('' == $this->body && '' == $this->template) {
            if ($debug) {
                $this->errors[] = _MAIL_MSGBODY;
            }
            return false;
        } elseif ('' != $this->template) {
            $path = ('' != $this->templatedir) ? $this->templatedir . '' . $this->template : (XOOPS_ROOT_PATH . '/language/' . $xoopsConfig['language'] . '/mail_template/' . $this->template);
            if (!($fd = @fopen($path, 'r'))) {
                if ($debug) {
                    $this->errors[] = _MAIL_FAILOPTPL;
                }
                return false;
            }
            $this->setBody(fread($fd, filesize($path)));
        }
 
        // for sending mail only
        if ($this->isMail  || !empty($this->toEmails)) {
            if (!empty($this->priority)) {
                $this->headers[] = 'X-Priority: ' . $this->priority;
            }
            $this->headers[] = 'X-Mailer: XOOPSCube';
            $this->headers[] = 'Return-Path: ' . $this->fromEmail;
            $headers = implode($this->LE, $this->headers);
        }
 
// TODO: we should have an option of no-reply for private messages and emails
// to which we do not accept replies.  e.g. the site admin doesn't want a
// a lot of message from people trying to unsubscribe.  Just make sure to
// give good instructions in the message.
 
        // add some standard tags (user-dependent tags are included later)
        global $xoopsConfig;
        $this->assign('X_ADMINMAIL', $xoopsConfig['adminmail']);
        $this->assign('X_SITENAME', $xoopsConfig['sitename']);
        $this->assign('X_SITEURL', XOOPS_URL);
        // TODO: also X_ADMINNAME??
        // TODO: X_SIGNATURE, X_DISCLAIMER ?? - these are probably best
        //  done as includes if mail templates ever get this sophisticated
 
        // replace tags with actual values
        foreach ($this->assignedTags as $k => $v) {
            $this->body = str_replace('{' . $k . '}', $v, $this->body);
            $this->subject = str_replace('{' . $k . '}', $v, $this->subject);
        }
        $this->body = str_replace("\r\n", "\n", $this->body);
        $this->body = str_replace("\r", "\n", $this->body);
        $this->body = str_replace("\n", $this->LE, $this->body);
 
        // send mail to specified mail addresses, if any
        foreach ($this->toEmails as $mailaddr) {
            if (!$this->sendMail($mailaddr, $this->subject, $this->body, $headers)) {
                if ($debug) {
                    $this->errors[] = sprintf(_MAIL_SENDMAILNG, $mailaddr);
                }
            } else {
                if ($debug) {
                    $this->success[] = sprintf(_MAIL_MAILGOOD, $mailaddr);
                }
            }
        }
 
        // send message to specified users, if any
 
        // NOTE: we don't send to LIST of recipients, because the tags
        // below are dependent on the user identity; i.e. each user
        // receives (potentially) a different message
 
        foreach ($this->toUsers as $user) {
            // set some user specific variables
            $subject = str_replace('{X_UNAME}', $user->getVar('uname'), $this->subject);
            $text = str_replace('{X_UID}', $user->getVar('uid'), $this->body);
            $text = str_replace('{X_UEMAIL}', $user->getVar('email'), $text);
            $text = str_replace('{X_UNAME}', $user->getVar('uname'), $text);
            $text = str_replace('{X_UACTLINK}', XOOPS_URL . '/user.php?op=actv&id=' . $user->getVar('uid') . '&actkey=' . $user->getVar('actkey'), $text);
 
            // send mail
            if ($this->isMail) {
                if (!$this->sendMail($user->getVar('email'), $subject, $text, $headers)) {
                    if ($debug) {
                        $this->errors[] = sprintf(_MAIL_SENDMAILNG, $user->getVar('uname'));
                    }
                } else {
                    if ($debug) {
                        $this->success[] = sprintf(_MAIL_MAILGOOD, $user->getVar('uname'));
                    }
                }
            }
            // send private message
            if ($this->isPM) {
                if (!$this->sendPM($user->getVar('uid'), $subject, $text)) {
                    if ($debug) {
                        $this->errors[] = sprintf(_MAIL_SENDPMNG, $user->getVar('uname'));
                    }
                } else {
                    if ($debug) {
                        $this->success[] = sprintf(_MAIL_PMGOOD, $user->getVar('uname'));
                    }
                }
            }
 
        }
        if (count($this->errors) > 0) {
            return false;
        }
        return true;
    }
 
    // private
    public function sendPM($uid, $subject, $body)
    {
        global $xoopsUser;
        $pm_handler =& xoops_gethandler('privmessage');
        $pm =& $pm_handler->create();
        $pm->setVar('subject', $subject);
        // RMV-NOTIFY
        $pm->setVar('from_userid', !empty($this->fromUser) ? $this->fromUser->getVar('uid') : $xoopsUser->getVar('uid'));
        $pm->setVar('msg_text', $body);
        $pm->setVar('to_userid', $uid);
        if (!$pm_handler->insert($pm)) {
            return false;
        }
        return true;
    }

 
    public function sendMail($email, $subject, $body, $headers)
    {
        $subject = $this->encodeSubject($subject);
        $this->encodeBody($body);
        $this->multimailer->ClearAllRecipients();
        $this->multimailer->AddAddress($email);
        $this->multimailer->Subject = $subject;
        $this->multimailer->Body = $body;
        $this->multimailer->CharSet = $this->charSet;
        $this->multimailer->Encoding = $this->encoding;
        if (!empty($this->fromName)) {
            $this->multimailer->FromName = $this->encodeFromName($this->fromName);
        }
        if (!empty($this->fromEmail)) {
            $this->multimailer->From = $this->fromEmail;
        }
        $this->multimailer->ClearCustomHeaders();
        foreach ($this->headers as $header) {
            $this->multimailer->AddCustomHeader($header);
        }
        if (!$this->multimailer->Send()) {
            $this->errors[] = $this->multimailer->ErrorInfo;
            return false;
        }
        return true;
    }
 
    // public
    public function getErrors($ashtml = true)
    {
        if (!$ashtml) {
            return $this->errors;
        } else {
            if (!empty($this->errors)) {
                $ret = '<h4>' . _ERRORS . '</h4>';
                foreach ($this->errors as $error) {
                    $ret .= $error . '<br>';
                }
            } else {
                $ret = '';
            }
            return $ret;
        }
    }
 
    // public
    public function getSuccess($ashtml = true)
    {
        if (!$ashtml) {
            return $this->success;
        } else {
            $ret = '';
            if (!empty($this->success)) {
                foreach ($this->success as $suc) {
                    $ret .= $suc . '<br>';
                }
            }
            return $ret;
        }
    }
 
    // public
    public function assign($tag, $value=null)
    {
        if (is_array($tag)) {
            foreach ($tag as $k => $v) {
                $this->assign($k, $v);
            }
        } else {
            if (!empty($tag) && isset($value)) {
                $tag = strtoupper(trim($tag));
                $this->assignedTags[$tag] = $value;
            }
        }
    }
 
    // public
    public function addHeaders($value)
    {
        $this->headers[] = trim($value).$this->LE;
    }
 
    // public
    public function setToEmails($email)
    {
        if (!is_array($email)) {
            if (preg_match("/^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+([\.][a-z0-9-]+)+$/i", $email)) {
                array_push($this->toEmails, $email);
            }
        } else {
            foreach ($email as $e) {
                $this->setToEmails($e);
            }
        }
    }
 
    // public
    public function setToUsers(&$user)
    {
        if (!is_array($user)) {
            //@ToDo $user should be either XoopsUser or UserUsersObject now
            if (in_array(strtolower(get_class($user)), ['xoopsuser', 'userusersobject'])) {
                array_push($this->toUsers, $user);
            }
        } else {
            foreach ($user as $u) {
                $this->setToUsers($u);
            }
        }
    }
 
    // public
    public function setToGroups($group)
    {
        if (!is_array($group)) {
            if ('xoopsgroup' == strtolower(get_class($group))) {
                $member_handler =& xoops_gethandler('member');
                $groups=&$member_handler->getUsersByGroup($group->getVar('groupid'), true);
                $this->setToUsers($groups, true);
            }
        } else {
            foreach ($group as $g) {
                $this->setToGroups($g);
            }
        }
    }
 
    // abstract
    // to be overidden by lang specific mail class, if needed
    public function encodeFromName($text)
    {
        return $text;
    }
 
    // abstract
    // to be overidden by lang specific mail class, if needed
    public function encodeSubject($text)
    {
        return $text;
    }
 
    // abstract
    // to be overidden by lang specific mail class, if needed
    public function encodeBody(&$text)
    {
    }
}