Action.php

<?php

namespace TypechoPlugin\CommentToMail;

/**
 * CommentToMail
 * Typecho 异步评论邮件提醒插件
 * 
 * @copyright  Copyright (c) 2022 xcsoft
 * @license    GNU General Public License 3.0
 */

use \Utils\Helper;
use \Typecho\{Widget, Db};
use \TypechoPlugin\CommentToMail\lib\Email;

use PHPMailer\PHPMailer\PHPMailer;
use PHPMailer\PHPMailer\Exception;

if (!defined('__TYPECHO_ROOT_DIR__')) exit;

require_once 'PHPMailer/SMTP.php';
require_once 'PHPMailer/PHPMailer.php';
require_once 'PHPMailer/Exception.php';

/**
 * action
 * 
 * @package CommentToMail
 */
class Action extends Widget implements \Widget\ActionInterface
{
    /** 
     * 数据库对象 
     * 
     * @var Db  
     */
    private Db $_db;

    /** 
     * 表前缀  
     * 
     * @var string  
     */
    private string $_prefix;

    /** 
     * 插件配置信息 
     * 
     * @var \Typecho\Config
     */
    private \Typecho\Config $_cfg;

    /** 
     * 系统配置信息 
     * 
     * @var \Widget\Options
     */
    private \Widget\Options $_options;

    /** 
     * 当前登录用户 
     * 
     * @var object 
     */
    private object $_user;

    /** 
     * 模板文件目录
     * 
     *  @var string 
     */
    private string $_template_dir = __DIR__ . '/template/';

    /**
     * 邮件对象
     *
     * @var Email
     */
    private Email $_email;

    /**
     * 评论对象
     *
     * @var \TypechoPlugin\CommentToMail\lib\Comment
     */
    private \TypechoPlugin\CommentToMail\lib\Comment $_comment;

    /**
     * 入口方法
     *
     * @access public
     * @return void
     */
    public function action()
    {
        $this->init();

        $this->on($this->request->is('do=deliverMail'))->deliverMail($this->request->key);  //邮件队列

        if (!$this->_user->hasLogin()) $this->response->redirect($this->_options->loginUrl); //用户未登录
        $this->on($this->request->is('do=testMail'))->testMail();                           //测试邮件
        $this->on($this->request->is('do=editTheme'))->editTheme($this->request->edit);     //编辑主题
    }

    /**
     * 初始化
     *
     * @return void
     */
    public function init()
    {
        $this->_db = Db::get();
        $this->_prefix = $this->_db->getPrefix();

        $this->_user = $this->widget('\Widget\User');
        $this->_options = $this->widget('\Widget\Options');
        $this->_cfg = Helper::options()->plugin('CommentToMail');
    }

    /**
     * 发送邮件
     * 
     * @param string $key
     * @return void
     */
    private function deliverMail(string $key): void
    {
        if ($key != $this->_cfg->key) {
            $this->response->throwJson([
                'code' => -1,
                'msg' => 'Permission deniend'
            ]);
        }

        $mailQueue = $this->_db->fetchAll($this->_db->select('id', 'content')->from($this->_prefix . 'mail')->where('sent = ?', 0)); // 获取所有未发送的邮件

        //计数器
        $success = 0;
        foreach ($mailQueue as &$mail) {

            $this->_comment = unserialize(base64_decode($mail['content']));

            /** 发送邮件 */
            if (!$this->_comment) continue;

            if ($this->processMail()) {
                $this->_db->query($this->_db->update($this->_prefix . 'mail')->rows(['sent' => 1])->where('id = ?', $mail['id'])); //标识为已发送
                $success++;
            }

            usleep(100); //休眠100毫秒 防止QPS限制
        }
        //清除已发送的数据
        $this->_db->query(
            $this->_db->delete($this->_prefix . 'mail')->where('sent = ?', 1)
        );
        $this->response->throwJson([
            'code' => 0,
            'msg' => 'success',
            'count' => [
                'all' => count($mailQueue),
                'success' => $success,
                'fail' => count($mailQueue) - $success,
            ],
        ]);
    }

    /**
     * 处理发信
     *
     * @return boolean
     */
    private function processMail(): bool
    {
        $this->_email = new Email();

        //发件人邮箱
        $this->_email->from = $this->_cfg->user;
        //发件人名称
        $this->_email->fromName = $this->_cfg->fromName ? $this->_cfg->fromName : $this->_options->title;

        //向博主发邮件的标题格式
        $this->_email->titleForOwner = $this->_cfg->titleForOwner;

        //向访客发邮件的标题格式
        $this->_email->titleForGuest = $this->_cfg->titleForGuest;

        //验证博主是否接收自己的邮件
        $toMe = (in_array('to_me', $this->_cfg->other) && $this->_comment->ownerId == $this->_comment->authorId) ? true : false;

        //向博主发信
        // TODO $this->_comment->parent === '0' // parent === ‘0’ 时 为根评论
        // 如果在此处判断 会导致 别人评论别人的评论时 不会发送邮件给博主 后续fix
        if (in_array($this->_comment->status, $this->_cfg->status) && $this->_comment->type !== '1' && in_array('to_owner', $this->_cfg->other) && ($toMe || $this->_comment->ownerId != $this->_comment->authorId)) {
            if (!$this->_cfg->mail) {
                self::widget('\Widget\Users\Author@temp' . $this->_comment->cid, ['uid' => $this->_comment->ownerId])->to($user);
                $this->_email->reciver = $user->mail;
            } else {
                $this->_email->reciver = $this->_cfg->mail;
            }
            if (!$this->_cfg->name) {
                self::widget('\Widget\Users\Author@temp' . $this->_comment->cid, ['uid' => $this->_comment->ownerId])->to($user);
                $this->_email->reciverName = $user->name;
            } else {
                $this->_email->reciverName = $this->_cfg->name;
            }

            // 设置邮件回复信息
            $this->_email->replyTo = $this->_comment->mail; //评论者的邮箱
            $this->_email->replyToName = $this->_comment->author;
            $this->authorMail()->sendMail();
        }

        /** 向访客发信 */
        if ($this->_comment->parent !== '0' && $this->_comment->status == 'approved' && in_array('to_guest', $this->_cfg->other)) {
            /**  如果联系我的邮件地址为空，则使用文章作者的邮件地址 */
            if (!$this->_cfg->contactme) {
                if (!isset($user) || !$user) {
                    self::widget('\Widget\Users\Author@temp' . $this->_comment->cid, array('uid' => $this->_comment->ownerId))->to($user);
                }
                $this->_comment->contactme = $user->mail;
            } else {
                $this->_comment->contactme = $this->_cfg->contactme;
            }

            $original = $this->_db->fetchRow($this->_db->select('author', 'mail', 'text')->from('table.comments')->where('coid = ?', $this->_comment->parent));
            // 被评论者
            if (in_array('to_me', $this->_cfg->other) || $this->_comment->mail != $original['mail']) {
                $this->_comment->originalText   = $original['text'];
                $this->_comment->originalAuthor = $original['author'];

                $this->_email->reciver = $original['mail'];
                $this->_email->reciverName = $original['author'];
                $this->_email->replyTo  = $this->_comment->mail; //当前评论者的邮箱
                $this->_email->replyToName = $this->_comment->author ? $this->_comment->author : $this->_options->title;
                $this->guestMail()->sendMail();
            }
        }

        unset($this->_comment); //销毁评论对象
        unset($this->_email); //销毁对象
        return true;
    }

    /**
     * 作者邮件信息
     * @return $this
     */
    private function authorMail()
    {
        $date = new \Typecho\Date($this->_comment->created);
        $status = [
            "approved" => '通过',
            "waiting"  => '待审',
            "spam"     => '垃圾'
        ];
        $search  = array(
            '{{siteTitle}}',
            '{{title}}',
            '{{author}}',
            '{{ip}}',
            '{{mail}}',
            '{{permalink}}',
            '{{manage}}',
            '{{text}}',
            '{{time}}',
            '{{status}}'
        );
        $replace = [
            $this->_options->title,
            $this->_comment->title,
            $this->_comment->author,
            $this->_comment->ip,
            $this->_comment->mail,
            $this->_comment->permalink,
            $this->_options->siteUrl . __TYPECHO_ADMIN_DIR__ . "manage-comments.php",
            $this->_comment->text,
            $date->format('Y-m-d H:i:s'),
            $status[$this->_comment->status]
        ];

        $this->_email->msgHtml = str_replace($search, $replace, $this->getTemplate('owner'));
        $this->_email->subject = str_replace($search, $replace, $this->_email->titleForOwner);
        $this->_email->altBody = "作者:" . $this->_comment->author . "\r\n链接:" . $this->_comment->permalink . "\r\n评论:\r\n" . $this->_comment->text;

        return $this;
    }

    /**
     * 访客邮件信息
     */
    public function guestMail()
    {
        $date = new \Typecho\Date($this->_comment->created);
        $search = [
            '{{siteTitle}}',
            '{{title}}',
            '{{author_p}}',
            '{{author}}',
            '{{permalink}}',
            '{{text}}',
            '{{text_p}}',
            '{{contactme}}',
            '{{time}}'
        ];
        $replace = [
            $this->_options->title,
            $this->_comment->title,
            $this->_comment->originalAuthor,
            $this->_comment->author,
            $this->_comment->permalink,
            $this->_comment->text,
            $this->_comment->originalText,
            $this->_comment->contactme,
            $date->format('Y-m-d H:i:s'),
        ];

        $this->_email->msgHtml = str_replace($search, $replace, $this->getTemplate('guest'));
        $this->_email->subject = str_replace($search, $replace, $this->_email->titleForGuest);
        $this->_email->altBody = "作者:" . $this->_comment->author . "\r\n链接:" . $this->_comment->permalink . "\r\n评论:\r\n" . $this->_comment->text;

        return $this;
    }

    /**
     * 发送邮件
     * 
     * @return bool|string|null
     */
    public function sendMail(): bool|string|NULL
    {
        /** 载入邮件组件 */
        $mailer = new PHPMailer();
        $mailer->CharSet = 'UTF-8';
        $mailer->Encoding = 'base64';

        /** 选择发信模式 */
        switch ($this->_cfg->mode) {
            case 'mail':
                break;
            case 'sendmail':
                $mailer->IsSendmail();
                break;
            case 'smtp':
                $mailer->IsSMTP();
                if (in_array('validate', $this->_cfg->validate)) $mailer->SMTPAuth = true;

                if (in_array('ssl', $this->_cfg->validate)) {
                    $mailer->SMTPSecure = "ssl";
                } else if (in_array('tls', $this->_cfg->validate)) {
                    $mailer->SMTPSecure = "tls";
                }

                $mailer->Host     = $this->_cfg->host;
                $mailer->Port     = $this->_cfg->port;
                $mailer->Username = $this->_cfg->user;
                $mailer->Password = $this->_cfg->pass;
                break;
        }

        $mailer->SetFrom($this->_email->from, $this->_email->fromName);
        if (isset($this->_email->replyTo) && isset($this->_email->replyToName)) $mailer->AddReplyTo($this->_email->replyTo, $this->_email->replyToName);
        $mailer->Subject = $this->_email->subject;
        $mailer->AltBody = $this->_email->altBody;
        if (in_array('solve544', $this->_cfg->validate)) $mailer->AddCC($this->_email->from); // 躲避审查造成的 544 错误 

        $mailer->MsgHTML($this->_email->msgHtml);
        $mailer->AddAddress($this->_email->reciver, $this->_email->reciverName);
        $mailer->SMTPOptions = array('ssl' => array('verify_peer' => false, 'verify_peer_name' => false, 'allow_self_signed' => true));

        $result = $mailer->Send();
        if (!$result) $result = $mailer->ErrorInfo;

        $mailer->ClearAddresses();
        $mailer->ClearReplyTos();

        return $result;
    }

    /**
     * 获取邮件模板
     * 
     * @param string $type
     * @return string
     */
    public function getTemplate(string $template = 'owner'): string
    {
        $filename = $this->_template_dir  . $template . '.html';

        if (!file_exists($filename)) {
            throw new \Typecho\Widget\Exception('模板文件' . $template . '不存在', 404);
        }

        return file_get_contents($filename);
    }

    /**
     * 邮件发送测试
     */
    public function testMail()
    {
        if (self::widget('TypechoPlugin\CommentToMail\Console')->testMailForm()->validate()) {
            $this->response->goBack();
        }

        $email = $this->request->from('toName', 'to', 'title', 'content');

        $this->_email = new Email();

        $this->_email->from = $this->_cfg->user;
        $this->_email->fromName = $this->_cfg->fromName ? $this->_cfg->fromName : $this->_options->title;
        $this->_email->reciver = $email['to'] ? $email['to'] : $this->_user->mail;
        $this->_email->reciverName = $email['toName'] ? $email['toName'] : $this->_user->screenName;
        $this->_email->subject = $email['title'];
        $this->_email->altBody = $email['content'];
        $this->_email->msgHtml = $email['content'];

        $result = $this->sendMail();

        /** 提示信息 */
        $this->widget('\Widget\Notice')->set(
            $result ? _t('邮件发送成功') : _t('邮件发送失败: ' . $result),
            $result ? 'success' : 'notice'
        );

        /** 转向原页 */
        $this->response->goBack();
    }

    /**
     * 编辑模板文件
     * @param $file
     * @throws \Typecho\Widget\Exception
     */
    public function editTheme($file)
    {
        $path = $this->_template_dir . $file;

        if (file_exists($path) && is_writeable($path)) {
            $handle = fopen($path, 'wb');
            if ($handle && fwrite($handle, $this->request->content)) {
                fclose($handle);
                $this->widget('Widget_Notice')->set(_t("文件 %s 的更改已经保存", $file), 'success');
            } else {
                $this->widget('Widget_Notice')->set(_t("文件 %s 无法被写入", $file), 'error');
            }
            $this->response->goBack();
        } else {
            throw new \Typecho\Widget\Exception(_t('您编辑的模板文件不存在'));
        }
    }
}