Merge pull request #163 from HanSon/dev

增加拓展支持
Hanson · Jun 16, 2017 · 4c7558f · 4c7558f
2 parents 0b82fd8 + f2cfd6a
commit 4c7558f
Show file tree

Hide file tree

Showing 13 changed files with 287 additions and 75 deletions.
diff --git a/example/Example.php b/example/Example.php
@@ -23,6 +23,10 @@ public function run()
 
         $robot->messageHandler->setHandler([MessageHandler::class, 'messageHandler']);
 
+        $robot->messageExtension->load([
+            // some extensions
+        ]);
+
         $robot->observer->setQrCodeObserver([Observer::class, 'setQrCodeObserver']);
 
         $robot->observer->setLoginSuccessObserver([Observer::class, 'setLoginSuccessObserver']);

diff --git a/example/Handlers/Service/GuessNumber.php b/example/Handlers/Service/GuessNumber.php
diff --git a/example/Handlers/Type/TextType.php b/example/Handlers/Type/TextType.php
@@ -38,29 +38,6 @@ public static function messageHandler(Collection $message, Friends $friends, Gro
                 $username = $groups->getUsernameByNickname('vbot 反馈群');
                 $groups->addMember($username, $message['from']['UserName']);
             }
-
-            if ($message['fromType'] === 'Friend') {
-                Text::send($message['from']['UserName'], static::reply($message['content'], $message['from']['UserName']));
-            }
-
-            if ($message['fromType'] === 'Group' && $message['isAt']) {
-                Text::send($message['from']['UserName'], static::reply($message['pure'], $message['from']['UserName']));
-            }
-        }
-    }
-
-    private static function reply($content, $id)
-    {
-        try {
-            $result = vbot('http')->post('http://www.tuling123.com/openapi/api', [
-                'key'    => '9c598b601d8e47acafd81f07770d4bba',
-                'info'   => $content,
-                'userid' => $id,
-            ], true);
-
-            return isset($result['url']) ? $result['text'].$result['url'] : $result['text'];
-        } catch (\Exception $e) {
-            return '图灵API连不上了，再问问试试';
         }
     }
 }
diff --git a/example/MessageHandler.php b/example/MessageHandler.php
@@ -9,7 +9,6 @@
 use Hanson\Vbot\Example\Handlers\Contact\ExperienceGroup;
 use Hanson\Vbot\Example\Handlers\Contact\FeedbackGroup;
 use Hanson\Vbot\Example\Handlers\Contact\Hanson;
-use Hanson\Vbot\Example\Handlers\Service\GuessNumber;
 use Hanson\Vbot\Example\Handlers\Type\RecallType;
 use Hanson\Vbot\Example\Handlers\Type\TextType;
 use Hanson\Vbot\Message\Emoticon;
@@ -40,7 +39,6 @@ public static function messageHandler(Collection $message)
 
         TextType::messageHandler($message, $friends, $groups);
         RecallType::messageHandler($message);
-        GuessNumber::messageHandler($message);
 
         if ($message['type'] === 'new_friend') {
             Text::send($message['from']['UserName'], '客官，等你很久了！感谢跟 vbot 交朋友，如果可以帮我点个star，谢谢了！https://github.com/HanSon/vbot');

diff --git a/example/config.php b/example/config.php
@@ -66,4 +66,16 @@
             ],
         ],
     ],
+    /*
+     * 拓展配置
+     * ==============================
+     * 如果加载拓展则必须加载此配置项
+     */
+    'extension' => [
+        // 管理员配置（必选），优先加载 remark_name
+        'admin' => [
+            'remark'   => '',
+            'nickname' => 'vbot',
+        ],
+    ],
 ];
diff --git a/src/Core/MessageHandler.php b/src/Core/MessageHandler.php
@@ -26,6 +26,8 @@ public function listen($server = null)
     {
         $this->vbot->beforeMessageObserver->trigger();
 
+        $this->vbot->messageExtension->initExtensions();
+
         $time = 0;
 
         while (true) {
@@ -122,6 +124,7 @@ private function handleMessage($selector)
                     if ($this->handler) {
                         call_user_func_array($this->handler, [$collection]);
                     }
+                    $this->vbot->messageExtension->exec($collection);
                 }
             }
         }

diff --git a/src/Exceptions/ExtensionException.php b/src/Exceptions/ExtensionException.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Hanson\Vbot\Exceptions;
+
+use Exception;
+
+class ExtensionException extends Exception
+{
+}
diff --git a/src/Extension/AbstractMessageHandler.php b/src/Extension/AbstractMessageHandler.php
@@ -0,0 +1,147 @@
+<?php
+
+namespace Hanson\Vbot\Extension;
+
+use Hanson\Vbot\Exceptions\ExtensionException;
+use Hanson\Vbot\Message\Text;
+use Illuminate\Support\Collection;
+
+abstract class AbstractMessageHandler
+{
+    public $version = '1.0';
+
+    public $author = 'HanSon';
+
+    public $name;
+
+    public $zhName;
+
+    public static $status = true;
+
+    public static $admin;
+
+    /**
+     * 拓展配置.
+     *
+     * @var
+     */
+    public static $config;
+
+    /**
+     * 初始化拓展.
+     */
+    public function init()
+    {
+        static::$config = vbot('config')->get('extension.'.$this->name);
+
+        $this->admin();
+
+        $this->register();
+    }
+
+    /**
+     * 注册拓展时的操作.
+     */
+    abstract public function register();
+
+    /**
+     * 开发者需要实现的方法.
+     *
+     * @param Collection $collection
+     *
+     * @return mixed
+     */
+    abstract public function handler(Collection $collection);
+
+    /**
+     * 消息处理器.
+     *
+     * @param Collection $collection
+     */
+    final public function messageHandler(Collection $collection)
+    {
+        if ($collection['type'] === 'text' && $this->isAdmin($collection['username'])) {
+            if (starts_with($collection['content'], $this->name.' ')) {
+                $content = str_replace($this->name.' ', '', $collection['content']);
+
+                switch ($content) {
+                    case  'info':
+                        $this->applicationInfo($collection);
+                        break;
+                    case 'on':
+                        $this->setStatus(true, $collection);
+                        break;
+                    case 'off':
+                        $this->setStatus(false, $collection);
+                        break;
+                    default:
+                        break;
+                }
+            }
+        }
+
+        if (!static::$status) {
+            return;
+        }
+
+        $this->handler($collection);
+    }
+
+    final public function applicationInfo($collection)
+    {
+        $status = static::$status ? '开' : '关';
+
+        $admin = static::$admin;
+
+        Text::send($collection['from']['UserName'], "当前应用名称：{$this->zhName}\n名称：{$this->name}\n状态：{$status}\n版本：{$this->version}\n作者：{$this->author}\n管理员 Username：{$admin}");
+    }
+
+    /**
+     * 设置拓展开关.
+     *
+     * @param bool $boolean
+     * @param $collection
+     */
+    final public function setStatus(bool $boolean, $collection)
+    {
+        static::$status = $boolean;
+
+        $status = static::$status ? '开' : '关';
+
+        Text::send($collection['from']['UserName'], "应用：{$this->zhName} 状态已更改为：{$status}");
+    }
+
+    /**
+     * 设置管理员.
+     *
+     * @throws ExtensionException
+     */
+    final public function admin()
+    {
+        $remark = vbot('config')->get('extension.admin.remark');
+
+        if ($remark) {
+            static::$admin = vbot('friends')->getUsernameByRemarkName($remark);
+        }
+
+        if (!$remark && ($nickname = vbot('config')->get('extension.admin.nickname'))) {
+            static::$admin = vbot('friends')->getUsernameByNickname($nickname);
+        }
+
+        if (!static::$admin) {
+            throw new ExtensionException('extension admin invalid.');
+        }
+    }
+
+    /**
+     * 判断是否管理员.
+     *
+     * @param $username
+     *
+     * @return bool
+     */
+    private function isAdmin($username)
+    {
+        return $username === static::$admin || $username === vbot('myself')->username;
+    }
+}
diff --git a/src/Extension/MessageExtension.php b/src/Extension/MessageExtension.php
@@ -0,0 +1,77 @@
+<?php
+
+namespace Hanson\Vbot\Extension;
+
+use Hanson\Vbot\Exceptions\ExtensionException;
+use Hanson\Vbot\Foundation\Vbot;
+
+class MessageExtension
+{
+    /**
+     * @var Vbot
+     */
+    protected $vbot;
+
+    protected $extensions = [];
+
+    public function __construct(Vbot $vbot)
+    {
+        $this->vbot = $vbot;
+    }
+
+    /**
+     * 读取消息拓展.
+     *
+     * @param $extensions
+     *
+     * @throws ExtensionException
+     */
+    public function load($extensions)
+    {
+        if (!is_array($extensions)) {
+            throw new ExtensionException('extensions must pass an array.');
+        }
+
+        foreach ($extensions as $extension) {
+            $this->addExtension($extension);
+        }
+    }
+
+    /**
+     * 初始化拓展.
+     */
+    public function initExtensions()
+    {
+        foreach ($this->extensions as $extension) {
+            (new $extension())->init();
+        }
+    }
+
+    /**
+     * 执行拓展.
+     *
+     * @param $collection
+     */
+    public function exec($collection)
+    {
+        foreach ($this->extensions as $extension) {
+            (new $extension())->messageHandler($collection);
+        }
+    }
+
+    /**
+     * 添加消息拓展.
+     *
+     * @param $extension
+     *
+     * @throws ExtensionException
+     */
+    private function addExtension($extension)
+    {
+        if ($extension instanceof AbstractMessageHandler) {
+            throw new ExtensionException($extension.' is not extend AbstractMessageHandler');
+        }
+
+        $this->extensions[] = $extension;
+    }
+}
diff --git a/src/Foundation/ExceptionHandler.php b/src/Foundation/ExceptionHandler.php
@@ -8,6 +8,7 @@
 use Hanson\Vbot\Exceptions\ArgumentException;
 use Hanson\Vbot\Exceptions\ConfigErrorException;
 use Hanson\Vbot\Exceptions\CreateGroupException;
+use Hanson\Vbot\Exceptions\ExtensionException;
 use Hanson\Vbot\Exceptions\FetchUuidException;
 use Hanson\Vbot\Exceptions\LoginFailedException;
 use Hanson\Vbot\Exceptions\LoginTimeoutException;
@@ -26,6 +27,7 @@ class ExceptionHandler
         LoginTimeoutException::class,
         ConfigErrorException::class,
         LoginFailedException::class,
+        ExtensionException::class,
     ];
 
     /**