【代码札记】Comment2Pushover，Typecho评论推送Pushover提醒

前几天发现一直在用的Server酱出了点问题，之前一直还是挺好用的，能够将网站上的评论推送到微信上进行提示，但最近不能用了，我才想起来两年前买的Pushover这个东西，遂魔改大佬的插件以令其能推送评论提醒到Pushover上。插件源文件内附。

简介

这个插件的原型是Y!an大佬写的Comment2Wechat，我修改了其中向Server酱的API推送消息的部分代码，使其可以利用Pushover推送评论通知。此处需要声明原插件在Github的项目是使用GNU General Public License v3.0协议授权的，因此修改后的代码仍需要使用相同的协议授权，并且注明版权归属声明。但你可以自由使用这些代码。

对于修改处的说明

1. 插件的基础配置

首先要修改的就是插件的名称，显然这个插件不应当和原插件重名，其次便是随名称变动而变动的注册插件监听器（可能是叫这个名字吧，我没能找到一个官方的Typecho插件开发手册）的语句，以及启用插件成功时的提示消息：显然Pushover需要的配置和Server酱是不太一样的。

Pushover需要两个参数：USER_KEY和API_TOKEN，前者是你一登陆Pushover控制台就能看见的，后者是你需要创建一个APP，并在APP的设定中找到的。这两个不能够弄反，二者皆在每次推送通知时和通知内容一并发给Pushover的API，由API判断二者是否正确。这两个参数我也对应的有关配置页面处的函数中做出了修改。

2. 插件的核心功能

对于插件推送通知的功能我修改的不多。我很高兴两个API使用的都是HTTP的POST请求工作的，而唯一的差别是POST请求的内容不一样罢了。因此我按照原来的格式，照猫画虎，实现了Pushover的API所需要的POST请求的构建。并且替换了请求要发送到的URL。

3. 其他未提到的修改

其他未提到或上面没说清楚的修改，应该都是和API有关的地方，请先参阅Pushover和/或Server酱的手册。若仍存疑问，欢迎评论。

使用

完整地复制以下代码，贴进一个文件名是Plugin.php的文件中。在Typecho 的插件目录下新建名为Comment2Pushover的目录（上述两个名字请务必区分大小写），并将此文件放置于其中。最后进入Typecho后台启用插件并配置好即可。

<?php
/**
 * Pushover推送评论通知，修改自Y!an的微信推送评论通知。
 * 
 * @package Comment2Pushover
 * @author 天空Blond
 * @version 1.0.0
 * @link https://skyblond.info
 */
class Comment2Pushover_Plugin implements Typecho_Plugin_Interface
{
    /**
     * 激活插件方法,如果激活失败,直接抛出异常
     * 
     * @access public
     * @return void
     * @throws Typecho_Plugin_Exception
     */
    public static function activate()
    {
    
        Typecho_Plugin::factory('Widget_Feedback')->comment = array('Comment2Pushover_Plugin', 'sc_send');
        Typecho_Plugin::factory('Widget_Feedback')->trackback = array('Comment2Pushover_Plugin', 'sc_send');
        Typecho_Plugin::factory('Widget_XmlRpc')->pingback = array('Comment2Pushover_Plugin', 'sc_send');
        
        return _t('请配置此插件的 USER_KEY 和 API_TOKEN, 以使您的Pushover推送生效');
    }
    
    /**
     * 禁用插件方法,如果禁用失败,直接抛出异常
     * 
     * @static
     * @access public
     * @return void
     * @throws Typecho_Plugin_Exception
     */
    public static function deactivate(){}
    
    /**
     * 获取插件配置面板
     * 
     * @access public
     * @param Typecho_Widget_Helper_Form $form 配置面板
     * @return void
     */
    public static function config(Typecho_Widget_Helper_Form $form)
    {
        $key = new Typecho_Widget_Helper_Form_Element_Text('user', NULL, NULL, _t('USER_KEY'), _t('USER_KEY 可以在 Pushover 账户的控制台中找到'));
        $form->addInput($key->addRule('required', _t('您必须填写一个正确的 USER_KEY')));
        
        $key2 = new Typecho_Widget_Helper_Form_Element_Text('token', NULL, NULL, _t('API_TOKEN'), _t('API_TOKEN 可以在 Pushover 的 APP 的控制台中找到'));
        $form->addInput($key2->addRule('required', _t('您必须填写一个正确的 API_TOKEN')));
    }
    
    /**
     * 个人用户的配置面板
     * 
     * @access public
     * @param Typecho_Widget_Helper_Form $form
     * @return void
     */
    public static function personalConfig(Typecho_Widget_Helper_Form $form){}

    /**
     * 微信推送
     * 
     * @access public
     * @param array $comment 评论结构
     * @param Typecho_Widget $post 被评论的文章
     * @return void
     */
    public static function sc_send($comment, $post)
    {
        $options = Typecho_Widget::widget('Widget_Options');

        $token = $options->plugin('Comment2Pushover')->token;
        $user = $options->plugin('Comment2Pushover')->user;

        $text = "有人在您的博客发表了评论";
        $desp = "".$comment['author']." 在「".$post->title."」中说到: \n\n > ".$comment['text'];

        $postdata = http_build_query(
            array(
                'token' => $token,
                'user' => $user,
                'message' => $desp,
                'title' => $text,
                'url' => $post->permalink,
                'url_title' => $post->title
                )
            );

        $opts = array('http' =>
            array(
                'method'  => 'POST',
                'header'  => 'Content-type: application/x-www-form-urlencoded',
                'content' => $postdata
                )
            );
        $context  = stream_context_create($opts);
        $result = file_get_contents('https://api.pushover.net/1/messages.json', false, $context);
        return  $comment;
    }
}

-全文完-