update to 1.2 version

Generate systemd script
Default info_level set to 2
Modify & add some comment for Example module
Brand new Console
Add daemon command argument
Add #OnTick annotation
Add ZMRobot API class

src/ZM/Utils/DataProvider.php

@@ -12,43 +12,53 @@ class DataProvider
 {
     public static $buffer_list = [];
 
-    public static function getResourceFolder() {
+    public static function getResourceFolder()
+    {
         return WORKING_DIR . '/resources/';
     }
 
-    public static function getDataConfig(){
+    public static function getDataConfig()
+    {
         return CONFIG_DIR;
     }
 
-    public static function addSaveBuffer($buf_name, $sub_folder = null) {
+    public static function addSaveBuffer($buf_name, $sub_folder = null)
+    {
         $name = ($sub_folder ?? "") . "/" . $buf_name . ".json";
         self::$buffer_list[$buf_name] = $name;
         ZMBuf::set($buf_name, self::getJsonData($name));
     }
 
-    public static function saveBuffer() {
-        $head = Console::setColor(date("[H:i:s ") . "INFO] Saving buffer......", "lightblue");
-        echo $head;
-        foreach(self::$buffer_list as $k => $v) {
+    public static function saveBuffer()
+    {
+        $head = Console::setColor(date("[H:i:s] ") . "[V] Saving buffer......", "blue");
+        if (ZMBuf::$atomics["info_level"]->get() >= 3)
+            echo $head;
+        foreach (self::$buffer_list as $k => $v) {
             self::setJsonData($v, ZMBuf::get($k));
         }
-        echo Console::setColor("saved", "lightblue").PHP_EOL;
+        if (ZMBuf::$atomics["info_level"]->get() >= 3)
+            echo Console::setColor("saved", "blue") . PHP_EOL;
     }
 
-    public static function getFrameworkLink(){
+    public static function getFrameworkLink()
+    {
         return ZMBuf::globals("http_reverse_link");
     }
 
-    public static function getJsonData(string $string) {
-        if(!file_exists(self::getDataConfig().$string)) return [];
-        return json_decode(Co::readFile(self::getDataConfig().$string), true);
+    public static function getJsonData(string $string)
+    {
+        if (!file_exists(self::getDataConfig() . $string)) return [];
+        return json_decode(Co::readFile(self::getDataConfig() . $string), true);
     }
 
-    private static function setJsonData($filename, array $args) {
+    private static function setJsonData($filename, array $args)
+    {
         Co::writeFile(self::getDataConfig() . $filename, json_encode($args, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT | JSON_BIGINT_AS_STRING));
     }
 
-    public static function getDataFolder() {
+    public static function getDataFolder()
+    {
         return ZM_DATA;
     }
 }

src/ZM/Utils/ZMRobot.php

@@ -0,0 +1,412 @@
+<?php
+
+
+namespace ZM\Utils;
+
+use ZM\API\CQAPI;
+use ZM\Connection\ConnectionManager;
+use ZM\Connection\CQConnection;
+use ZM\Exception\RobotNotFoundException;
+
+/**
+ * Class ZMRobot
+ * @package ZM\Utils
+ * @since 1.2
+ */
+class ZMRobot
+{
+    const API_ASYNC = 1;
+    const API_NORMAL = 0;
+    const API_RATE_LIMITED = 2;
+
+    private $connection;
+
+    private $callback = null;
+    private $prefix = 0;
+
+    /**
+     * @param $robot_id
+     * @return ZMRobot
+     * @throws RobotNotFoundException
+     */
+    public static function get($robot_id) {
+        $r = ConnectionManager::getByType("qq", ["self_id" => $robot_id]);
+        if ($r == []) throw new RobotNotFoundException("机器人 " . $robot_id . " 未连接到框架！");
+        return new ZMRobot($r[0]);
+    }
+
+    /**
+     * @throws RobotNotFoundException
+     * @return ZMRobot
+     */
+    public static function getRandom() {
+        $r = ConnectionManager::getByType("qq");
+        if($r == []) throw new RobotNotFoundException("没有任何机器人连接到框架！");
+        return new ZMRobot($r[array_rand($r)]);
+    }
+
+    public function __construct(CQConnection $connection) {
+        $this->connection = $connection;
+    }
+
+    public function setCallback($callback = true) {
+        $this->callback = $callback;
+        return $this;
+    }
+
+    public function setPrefix($prefix = self::API_NORMAL) {
+        $this->prefix = $prefix;
+        return $this;
+    }
+
+    public function sendPrivateMsg($user_id, $message, $auto_escape = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'user_id' => $user_id,
+                'message' => $message,
+                'auto_escape' => $auto_escape
+            ]
+        ], $this->callback);
+    }
+
+    public function sendGroupMsg($group_id, $message, $auto_escape = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'message' => $message,
+                'auto_escape' => $auto_escape
+            ]
+        ], $this->callback);
+    }
+
+    public function sendDiscussMsg($discuss_id, $message, $auto_escape = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'discuss_id' => $discuss_id,
+                'message' => $message,
+                'auto_escape' => $auto_escape
+            ]
+        ], $this->callback);
+    }
+
+    public function sendMsg($message_type, $target_id, $message, $auto_escape = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'message_type' => $message_type,
+                ($message_type == 'private' ? 'user' : $message_type) . '_id' => $target_id,
+                'message' => $message,
+                'auto_escape' => $auto_escape
+            ]
+        ], $this->callback);
+    }
+
+    public function deleteMsg($message_id) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'message_id' => $message_id
+            ]
+        ], $this->callback);
+    }
+
+    public function sendLike($user_id, $times = 1) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'user_id' => $user_id,
+                'times' => $times
+            ]
+        ], $this->callback);
+    }
+
+    public function setGroupKick($group_id, $user_id, $reject_add_request = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'user_id' => $user_id,
+                'reject_add_request' => $reject_add_request
+            ]
+        ], $this->callback);
+    }
+
+    public function setGroupBan($group_id, $user_id, $duration = 1800) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'user_id' => $user_id,
+                'duration' => $duration
+            ]
+        ], $this->callback);
+    }
+
+    public function setGroupAnonymousBan($group_id, $anonymous_or_flag, $duration = 1800) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                (is_string($anonymous_or_flag) ? 'flag' : 'anonymous') => $anonymous_or_flag,
+                'duration' => $duration
+            ]
+        ], $this->callback);
+    }
+
+    public function setGroupWholeBan($group_id, $enable = true) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'enable' => $enable
+            ]
+        ], $this->callback);
+    }
+
+    public function setGroupAdmin($group_id, $user_id, $enable = true) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'user_id' => $user_id,
+                'enable' => $enable
+            ]
+        ], $this->callback);
+    }
+
+    public function setGroupAnonymous($group_id, $enable = true) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'enable' => $enable
+            ]
+        ], $this->callback);
+    }
+
+    public function setGroupCard($group_id, $user_id, $card = "") {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'user_id' => $user_id,
+                'card' => $card
+            ]
+        ], $this->callback);
+    }
+
+    public function setGroupLeave($group_id, $is_dismiss = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'is_dismiss' => $is_dismiss
+            ]
+        ], $this->callback);
+    }
+
+    public function setGroupSpecialTitle($group_id, $user_id, $special_title = "", $duration = -1) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'user_id' => $user_id,
+                'special_title' => $special_title,
+                'duration' => $duration
+            ]
+        ], $this->callback);
+    }
+
+    public function setDiscussLeave($discuss_id) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'discuss_id' => $discuss_id
+            ]
+        ], $this->callback);
+    }
+
+    public function setFriendAddRequest($flag, $approve = true, $remark = "") {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'flag' => $flag,
+                'approve' => $approve,
+                'remark' => $remark
+            ]
+        ], $this->callback);
+    }
+
+    public function setGroupAddRequest($flag, $sub_type, $approve = true, $reason = "") {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'flag' => $flag,
+                'sub_type' => $sub_type,
+                'approve' => $approve,
+                'reason' => $reason
+            ]
+        ], $this->callback);
+    }
+
+    public function getLoginInfo() {
+        return CQAPI::processAPI($this->connection, ['action' => $this->getActionName(__FUNCTION__)], $this->callback);
+    }
+
+    public function getStrangerInfo($user_id, $no_cache = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'user_id' => $user_id,
+                'no_cache' => $no_cache
+            ]
+        ], $this->callback);
+    }
+
+    public function getFriendList() {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__)
+        ], $this->callback);
+    }
+
+    public function getGroupList() {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__)
+        ], $this->callback);
+    }
+
+    public function getGroupInfo($group_id, $no_cache = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'no_cache' => $no_cache
+            ]
+        ], $this->callback);
+    }
+
+    public function getGroupMemberInfo($group_id, $user_id, $no_cache = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'user_id' => $user_id,
+                'no_cache' => $no_cache
+            ]
+        ], $this->callback);
+    }
+
+    public function getGroupMemberList($group_id) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id
+            ]
+        ]);
+    }
+
+    public function getCookie($domain = "") {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'domain' => $domain
+            ]
+        ]);
+    }
+
+    public function getCsrfToken() {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__)
+        ], $this->callback);
+    }
+
+    public function getCredentials($domain = "") {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'domain' => $domain
+            ]
+        ], $this->callback);
+    }
+
+    public function getRecord($file, $out_format, $full_path = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'file' => $file,
+                'out_format' => $out_format,
+                'full_path' => $full_path
+            ]
+        ], $this->callback);
+    }
+
+    public function getImage($file) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'file' => $file
+            ]
+        ], $this->callback);
+    }
+
+    public function canSendImage() {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__)
+        ], $this->callback);
+    }
+
+    public function canSendRecord() {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__)
+        ], $this->callback);
+    }
+
+    public function getStatus() {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__)
+        ], $this->callback);
+    }
+
+    public function getVersionInfo() {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__)
+        ], $this->callback);
+    }
+
+    public function setRestartPlugin($delay = 0) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'delay' => $delay
+            ]
+        ], $this->callback);
+    }
+
+    public function cleanDataDir($data_dir) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__),
+            'params' => [
+                'data_dir' => $data_dir
+            ]
+        ], $this->callback);
+    }
+
+    public function cleanPluginLog() {
+        return CQAPI::processAPI($this->connection, [
+            'action' => $this->getActionName(__FUNCTION__)
+        ], $this->callback);
+    }
+
+    public function getExperimentAPI() {
+        return new ZMRobotExperiment($this->connection, $this->callback, $this->prefix);
+    }
+
+    private function getActionName(string $method) {
+        $prefix = ($this->prefix == self::API_ASYNC ? '_async' : ($this->prefix == self::API_RATE_LIMITED ? '_rate_limited' : ''));
+        $func_name = strtolower(preg_replace('/(?<=[a-z])([A-Z])/', '_$1', $method));
+        return $prefix . $func_name;
+    }
+}

src/ZM/Utils/ZMRobotExperiment.php

@@ -0,0 +1,104 @@
+<?php
+
+
+namespace ZM\Utils;
+
+
+use ZM\API\CQAPI;
+use ZM\Connection\CQConnection;
+
+/**
+ * Class ZMRobotExperiment
+ * @package ZM\Utils
+ * @since 1.2
+ */
+class ZMRobotExperiment
+{
+    /**
+     * @var CQConnection
+     */
+    private $connection;
+
+    private $callback = null;
+    private $prefix = 0;
+
+    public function __construct(CQConnection $connection, $callback, $prefix) {
+        $this->connection = $connection;
+        $this->callback = $callback;
+        $this->prefix = $prefix;
+    }
+
+    public function setCallback($callback = true) {
+        $this->callback = $callback;
+        return $this;
+    }
+
+    public function setPrefix($prefix = ZMRobot::API_NORMAL) {
+        $this->prefix = $prefix;
+        return $this;
+    }
+
+    public function getFriendList($flat = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => '_' . $this->getActionName(__FUNCTION__),
+            'params' => [
+                'flat' => $flat
+            ]
+        ], $this->callback);
+    }
+
+    public function getGroupInfo($group_id) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => '_' . $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id
+            ]
+        ], $this->callback);
+    }
+
+    public function getVipInfo($user_id) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => '_' . $this->getActionName(__FUNCTION__),
+            'params' => [
+                'user_id' => $user_id
+            ]
+        ], $this->callback);
+    }
+
+    public function getGroupNotice($group_id) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => '_' . $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id
+            ]
+        ], $this->callback);
+    }
+
+    public function sendGroupNotice($group_id, $title, $content) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => '_' . $this->getActionName(__FUNCTION__),
+            'params' => [
+                'group_id' => $group_id,
+                'title' => $title,
+                'content' => $content
+            ]
+        ], $this->callback);
+    }
+
+    public function setRestart($clean_log = false, $clean_cache = false, $clean_event = false) {
+        return CQAPI::processAPI($this->connection, [
+            'action' => '_' . $this->getActionName(__FUNCTION__),
+            'params' => [
+                'clean_log' => $clean_log,
+                'clean_cache' => $clean_cache,
+                'clean_event' => $clean_event
+            ]
+        ], $this->callback);
+    }
+
+    private function getActionName(string $method) {
+        $prefix = ($this->prefix == ZMRobot::API_ASYNC ? '_async' : ($this->prefix == ZMRobot::API_RATE_LIMITED ? '_rate_limited' : ''));
+        $func_name = strtolower(preg_replace('/(?<=[a-z])([A-Z])/', '_$1', $method));
+        return $prefix . $func_name;
+    }
+}

src/ZM/Utils/ZMUtil.php

@@ -14,25 +14,26 @@ class ZMUtil
      * 检查workerStart是否运行结束
      */
     public static function checkWait() {
-        if(ZMBuf::isset("wait_start")) {
+        if (ZMBuf::isset("wait_start")) {
             ZMBuf::append("wait_start", Co::getCid());
             Co::suspend();
         }
     }
 
-    public static function stop() {
+    public static function stop($without_shutdown = false) {
         Console::info(Console::setColor("Stopping server...", "red"));
         foreach (ZMBuf::$server->connections as $v) {
             ZMBuf::$server->close($v);
         }
         DataProvider::saveBuffer();
-        ZMBuf::$server->shutdown();
+        if (!$without_shutdown)
+            ZMBuf::$server->shutdown();
         ZMBuf::$server->stop();
     }
 
     public static function getHttpCodePage(int $http_code) {
-        if(isset(ZMBuf::globals("http_default_code_page")[$http_code])) {
-            return Co::readFile(DataProvider::getResourceFolder()."html/".ZMBuf::globals("http_default_code_page")[$http_code]);
+        if (isset(ZMBuf::globals("http_default_code_page")[$http_code])) {
+            return Co::readFile(DataProvider::getResourceFolder() . "html/" . ZMBuf::globals("http_default_code_page")[$http_code]);
         } else return null;
     }
 
@@ -68,4 +69,13 @@ class ZMUtil
         }
         return ["type" => $type, "params" => $array, "start" => $start, "end" => $end];
     }
-}
+
+    public static function getModInstance($class) {
+        if (!isset(ZMBuf::$instance[$class])) {
+            ZMBuf::$instance[$class] = new $class();
+            return ZMBuf::$instance[$class];
+        } else {
+            return ZMBuf::$instance[$class];
+        }
+    }
+}