wechat-bot2 0.1.1

data/lib/wechat/bot/contact.rb

@@ -0,0 +1,214 @@
+module WeChat::Bot
+  # 微信联系人
+  #
+  # 可以是用户、公众号、群组等
+  class Contact
+    # 联系人分类
+    module Kind
+      User = :user
+      Group = :group
+      MP = :mp
+      Special = :special
+    end
+
+    def self.parse(obj, bot)
+      self.new(bot).parse(obj)
+    end
+
+    def initialize(bot)
+      @bot = bot
+      @data = {}
+    end
+
+    # 用户唯一 ID
+    def username
+      attr(:username)
+    end
+
+    # 用户昵称
+    def nickname
+      attr(:nickname)
+    end
+
+    # 备注名
+    def remarkname
+      attr(:remarkname)
+    end
+
+    # 群聊显示名
+    def displayname
+      attr(:displayname)
+    end
+
+    # 性别
+    def sex
+      attr(:sex)
+    end
+
+    # 个人签名
+    def signature
+      attr(:signature)
+    end
+
+    # 用户类型
+    def kind
+      attr(:kind)
+    end
+
+    # 省份
+    def province
+      attr(:province)
+    end
+
+    # 城市
+    def city
+      attr(:city)
+    end
+
+    # 是否特殊账户
+    def special?
+      kind == Kind::Special
+    end
+
+    # 是否群聊
+    def group?
+      kind == Kind::Group
+    end
+
+    # 是否公众号
+    def mp?
+      kind == Kind::MP
+    end
+
+    # 群组成员列表
+    #
+    # 只有群组才有内容，根据 {#kind} 或 {#group?} 来判断
+    # 不是群组类型的返回空数组
+    #
+    # @return [Hash]
+    def members
+      attr(:members)
+    end
+
+    # 联系人解析
+    #
+    # @param [Hash<Object, Object>] raw
+    # @return [Contact]
+    def parse(raw, update = false)
+      @raw = raw
+
+      parse_kind
+      parse_members
+
+      @raw.each do |key, value|
+        if attribute = mapping[key]
+          next if value.to_s.empty? && update
+
+          sync(attribute, value)
+        end
+      end
+
+      self
+    end
+
+    def update(raw)
+      @raw = raw
+      parse(@raw, true)
+    end
+
+    def to_s
+      "#<#{self.class}:#{object_id.to_s(16)} username='#{username}' nickname='#{nickname}' kind='#{kind}'>"
+    end
+
+    private
+
+    # 更新或新写入变量值
+    #
+    # @param [Symbol] attribute
+    # @param [String, Integer, Hash] value
+    # @param [Boolean] data
+    # @return [void]
+    def sync(attribute, value, data = false)
+      value = value.convert_emoji if attribute.to_sym == :nickname
+
+      # 满足群组类型且 nickname 为空时补充一个默认的群组名（参考微信 App 设计）
+      if attribute.to_sym == :nickname && value.to_s.empty? && @kind == Kind::Group
+        value = members.map { |m| m.nickname }.join("、")
+      end
+
+      if data
+        @data[attribute.to_sym] = value
+      else
+        instance_variable_set("@#{attribute}", value)
+      end
+    end
+
+    # 获取属性
+    #
+    # @param [Symbol] attribute
+    # @param [Boolean] data 默认 false
+    # @return [String, Integer, Hash]
+    def attr(attribute, data = false)
+      if data
+        @data[attribute.to_sym]
+      else
+        instance_variable_get("@#{attribute}")
+      end
+    end
+
+    # 解析联系人类型
+    #
+    # 详见 {Contact::Kind} 成员变量
+    # @return [void]
+    def parse_kind
+      kind = if @bot.config.special_users.include?(@raw["UserName"])
+               # 特殊账户
+               Kind::Special
+             elsif @raw["UserName"].include?("@@")
+               # 群聊
+               Kind::Group
+             elsif @raw["VerifyFlag"] && (@raw["VerifyFlag"] & 8) != 0
+               # 公众号
+               Kind::MP
+             else
+               # 普通用户
+               Kind::User
+             end
+
+      sync(:kind, kind)
+    end
+
+    # 解析群组成员列表
+    #
+    # 只有群组才有内容，根据 {#kind} 或 {#group?} 来判断
+    #
+    # @return [void]
+    def parse_members
+      members = []
+
+      if @raw["MemberList"]
+        @raw["MemberList"].each do |m|
+          members.push(Contact.parse(m, @bot))
+        end
+      end
+
+      sync(:members, members)
+    end
+
+    # 字段映射
+    #
+    # @return [Hash<String, String>]
+    def mapping
+      {
+        "NickName" => "nickname",
+        "UserName" => "username",
+        "RemarkName" => "remarkname",
+        "DisplayName" => "displayname",
+        "Signature" => "signature",
+        "Sex" => "sex",
+        "Province" => "province",
+        "City" => 'city'
+      }
+    end
+  end
+end

data/lib/wechat/bot/contact_list.rb

@@ -0,0 +1,56 @@
+module WeChat::Bot
+  # 微信联系人列表
+  class ContactList < CachedList
+    # 批量同步联系人数据
+    #
+    # 更多查看 {#sync} 接口
+    # @param [Array<Hash>] list 联系人数组
+    # @return [ContactList]
+    def batch_sync(list)
+      list.each do |item|
+        sync(item)
+      end
+
+      self
+    end
+
+    def size
+      @cache.size
+    end
+
+    # 创建用户或更新用户数据
+    #
+    # @param [Hash] data 微信接口返回的单个用户数据
+    # @return [Contact]
+    def sync(data)
+      @mutex.synchronize do
+        contact = Contact.parse(data, @bot)
+        if @cache[contact.username]
+          @cache[contact.username].update(data)
+        else
+          @cache[contact.username] = contact
+        end
+
+        contact
+      end
+    end
+
+    # 查找用户
+    #
+    # @param [Hash] args 接受两个参数:
+    #   - :nickname 昵称
+    #   - :username 用户ID
+    # @return [Contact]
+    def find(**args)
+      @mutex.synchronize do
+        return @cache[args[:username]] if args[:username]
+
+        if args[:nickname]
+          @cache.each do |_, contact|
+            return contact if contact.nickname == args[:nickname]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wechat/bot/core.rb

@@ -0,0 +1,138 @@
+require "wechat/bot/configuration"
+require "wechat/bot/cached_list"
+require "wechat/bot/contact_list"
+require "wechat/bot/contact"
+require "wechat/bot/logger"
+
+require "wechat/bot/handler_list"
+require "wechat/bot/handler"
+require "wechat/bot/message"
+require "wechat/bot/pattern"
+require "wechat/bot/callback"
+
+require "wechat/bot/http/adapter/js"
+require "wechat/bot/http/adapter/xml"
+require "wechat/bot/http/session"
+
+require "logger"
+
+module WeChat::Bot
+  # 机器人的核心类
+  class Core
+    # 微信 API 客户端
+    #
+    # @return [Client]
+    attr_reader :client
+
+    # 当前登录用户信息
+    #
+    # @return [Contact]
+    attr_reader :profile
+
+    # 联系人列表
+    #
+    # @return [ContactList]
+    attr_reader :contact_list
+
+    # @return [Logger]
+    attr_accessor :logger
+
+    # @return [HandlerList]
+    attr_reader :handlers
+
+    # @return [Configuration]
+    attr_reader :config
+
+    # @return [Callback]
+    # @api private
+    attr_reader :callback
+
+    def initialize(&block)
+      # defaults_logger
+      @logger = Logger.new(STDOUT, self)
+      @config = Configuration.new
+      @handlers = HandlerList.new
+      @callback = Callback.new(self)
+
+      @client = Client.new(self)
+      @profile = Contact.new(self)
+      @contact_list = ContactList.new(self)
+
+      instance_eval(&block) if block_given?
+    end
+
+    # 消息触发器
+    #
+    # @param [String, Symbol, Integer] event
+    # @param [Regexp, Pattern, String] regexp
+    # @param [Array<Object>] args
+    # @yieldparam [Array<String>]
+    # @return [Handler]
+    def on(event, regexp = //, *args, &block)
+      event = event.to_s.to_sym
+
+      pattern = case regexp
+                when Pattern
+                  regexp
+                when Regexp
+                  Pattern.new(nil, regexp, nil)
+                else
+                  if event == :ctcp
+                    Pattern.generate(:ctcp, regexp)
+                  else
+                    Pattern.new(/^/, /#{Regexp.escape(regexp.to_s)}/, /$/)
+                  end
+                end
+
+      handler = Handler.new(self, event, pattern, {args: args, execute_in_callback: true}, &block)
+      @handlers.register(handler)
+
+      handler
+    end
+
+    # 用于设置 WeChat::Bot 的配置
+    # 默认无需配置，需要定制化 yield {Core#config} 进行配置
+    #
+    # @yieldparam [Struct] config
+    # @return [void] 没有返回值
+    def configure
+      yield @config
+    end
+
+    # 运行机器人
+    #
+    # @return [void]
+    def start
+      @client.login
+      @client.contacts
+
+      @contact_list.each do |c|
+        @logger.debug "Contact: #{c}"
+      end
+
+      while true
+        break unless @client.logged? || @client.alive?
+        sleep 1
+      end
+    rescue Interrupt => e
+      message = "你使用 Ctrl + C 终止了运行"
+      @logger.warn(message)
+      @client.send_text(@config.fireman, "[告警] 意外下线\n#{message}\n#{e.backtrace.join("\n")}") if @client.logged? && @client.alive?
+    rescue Exception => e
+      message = e.message
+      @logger.fatal(e)
+      @client.send_text(@config.fireman, "[告警] 意外下线\n#{message}\n#{e.backtrace.join("\n")}") if @client.logged? && @client.alive?
+    ensure
+      @client.logout if @client.logged? && @client.alive?
+    end
+
+    # private
+
+    # def defaults_logger
+    #   @logger = Logger.new($stdout)
+    #   @logger.formatter = proc do |severity, datetime, progname, msg|
+    #     "#{severity}\t[#{datetime.strftime("%Y-%m-%d %H:%M:%S.%2N")}]: #{msg}\n"
+    #   end
+    # end
+  end
+end

data/lib/wechat/bot/exception.rb

@@ -0,0 +1,4 @@
+module WeChat::Bot
+  class NoReplyException < RuntimeError
+  end
+end

data/lib/wechat/bot/ext/wechat_emoji_string.rb

@@ -0,0 +1,16 @@
+module WeChat::Bot
+  module WeChatEmojiString
+    def convert_emoji
+      emoji_regex = /<span class="emoji emoji(\w+)"><\/span>/
+      if match = self.match(emoji_regex)
+        return self.gsub(emoji_regex, [match[1].hex].pack("U"))
+      end
+
+      self
+    end
+  end
+end
+
+class String
+  include WeChat::Bot::WeChatEmojiString
+end

data/lib/wechat/bot/handler.rb

@@ -0,0 +1,92 @@
+module WeChat::Bot
+  # Handler
+  class Handler
+    # @return [Core]
+    attr_reader :bot
+
+    # @return [Symbol]
+    attr_reader :event
+
+    # @return [String]
+    attr_reader :pattern
+
+    # @return [Array]
+    attr_reader :args
+
+    # @return [Proc]
+    attr_reader :block
+
+    # @return [Symbol]
+    attr_reader :group
+
+    # @return [ThreadGroup]
+    # @api private
+    attr_reader :thread_group
+
+    def initialize(bot, event, pattern, options = {}, &block)
+      options              = {
+        :group => nil,
+        :execute_in_callback => false,
+        :strip_colors => false,
+        :args => []
+      }.merge(options)
+
+      @bot = bot
+      @event = event
+      @pattern = pattern
+      @block = block
+      @group = options[:group]
+      @execute_in_callback = options[:execute_in_callback]
+      @args = options[:args]
+
+      @thread_group = ThreadGroup.new
+    end
+
+    # 执行 Handler
+    #
+    # @param [Symbol] message
+    # @param [String] captures
+    # @param [Array] arguments
+    # @return [Thread]
+    def call(message, captures, arguments)
+      bargs = captures + arguments
+
+      thread = Thread.new {
+        @bot.logger.debug "[New thread] For #{self}: #{Thread.current} -- #{@thread_group.list.size} in total."
+        begin
+          if @execute_in_callback
+            @bot.callback.instance_exec(message, *@args, *bargs, &@block)
+          else
+            @block.call(message, *@args, *bargs)
+          end
+        rescue => e
+          @bot.logger.error "[Thread error] #{e.message} -> #{e.backtrace.join("\n")}"
+        ensure
+          @bot.logger.debug "[Thread done] For #{self}: #{Thread.current} -- #{@thread_group.list.size - 1} remaining."
+        end
+      }
+
+      @thread_group.add(thread)
+      thread
+    end
+
+    # @return [void]
+    def stop
+      @bot.logger.debug "[Stopping handler] Stopping all threads of handler #{self}: #{@thread_group.list.size} threads..."
+      @thread_group.list.each do |thread|
+        Thread.new do
+          @bot.logger.debug "[Ending thread] Waiting 10 seconds for #{thread} to finish..."
+          thread.join(10)
+          @bot.logger.debug "[Killing thread] Killing #{thread}"
+          thread.kill
+        end
+      end
+    end
+
+    # @return [String]
+    def to_s
+      # TODO maybe add the number of running threads to the output?
+      "#<Cinch::Handler @event=#{@event.inspect} pattern=#{@pattern.inspect}>"
+    end
+  end
+end

data/lib/wechat/bot/handler_list.rb

@@ -0,0 +1,92 @@
+module WeChat::Bot
+  # Handler 列表
+  class HandlerList
+    include Enumerable
+
+    def initialize
+      @handlers = Hash.new {|h,k| h[k] = []}
+      @mutex = Mutex.new
+    end
+
+    # 注册 Handler
+    #
+    # @param [Handler] handler
+    # @return [void]
+    def register(handler)
+      @mutex.synchronize do
+        handler.bot.logger.debug "[on handler] Registering handler with pattern `#{handler.pattern}`, reacting on `#{handler.event}`"
+        @handlers[handler.event].push(handler)
+      end
+    end
+
+    # 取消注册 Handler
+    #
+    # @param [Array<Handler>] handlers
+    # @return [void]
+    def unregister(*handlers)
+      @mutex.synchronize do
+        handlers.each do |handler|
+          @handlers[handler.event].delete(handler)
+        end
+      end
+    end
+
+    # 分派执行 Handler
+    #
+    # @param [Symbol] event
+    # @param [String] message
+    # @param [Array<Object>] args
+    # @return [Array<Thread>]
+    def dispatch(event, message = nil, *args)
+      threads = []
+
+      if handlers = find(event, message)
+        already_run = Set.new
+        handlers.each do |handler|
+          next if already_run.include?(handler.block)
+          already_run.add(handler.block)
+
+          if message
+            captures = message.match(handler.pattern.to_r(message), event).captures
+          else
+            captures = []
+          end
+
+          threads.push(handler.call(message, captures, args))
+        end
+      end
+
+      threads
+    end
+
+    # 查找匹配 Handler
+    #
+    # @param [Symbol] type
+    # @param [String] message
+    # @return [Hander]
+    def find(type, message = nil)
+      if handlers = @handlers[type]
+        if message.nil?
+          return handlers
+        end
+
+        handlers = handlers.select { |handler|
+          message.match(handler.pattern.to_r(message), type)
+        }.group_by {|handler| handler.group}
+
+        handlers.values_at(*(handlers.keys - [nil])).map(&:first) + (handlers[nil] || [])
+      end
+    end
+
+    def each(&block)
+      @handlers.values.flatten.each(&block)
+    end
+
+    # 停止运行所有 Handler
+    #
+    # @return [void]
+    def stop_all
+      each { |h| h.stop }
+    end
+  end
+end

data/lib/wechat/bot/helper.rb

@@ -0,0 +1,2 @@
+module WeChat::Bot
+end

data/lib/wechat/bot/http/adapter/js.rb

@@ -0,0 +1,33 @@
+require "http/mime_type"
+require "http/mime_type/adapter"
+
+module WeChat::Bot
+  module HTTP
+    module MimeType
+      # Javascript 代码解析
+      # 用于解析微信 API 返回的部分 JS 代码，
+      # 提示：不可逆转
+      class JS < ::HTTP::MimeType::Adapter
+        # Encodes object to js
+        def encode(_)
+          "" # NO NEED encode
+        end
+
+        # 转换 JS 代码为 Hash
+        #
+        # @return [Hash]
+        def decode(str)
+          str.split("window.").each_with_object({}) do |item, obj|
+            key, value = item.split(/\s*=\s*/, 2)
+            next unless key || value
+            key = key.split(".")[-1]
+            obj[key] = eval(value)
+          end
+        end
+      end
+    end
+  end
+
+  ::HTTP::MimeType.register_adapter "text/javascript", WeChat::Bot::HTTP::MimeType::JS
+  ::HTTP::MimeType.register_alias   "text/javascript", :js
+end

data/lib/wechat/bot/http/adapter/xml.rb

@@ -0,0 +1,29 @@
+require "http/mime_type"
+require "http/mime_type/adapter"
+require "multi_xml"
+# require "roxml"
+
+module WeChat::Bot
+  module HTTP
+    module MimeType
+      # XML 代码解析
+      # 提示：不可逆转
+      class XML < ::HTTP::MimeType::Adapter
+        # Encodes object to js
+        def encode(_)
+          "" # NO NEED encode
+        end
+
+        # 转换 XML 代码为 Hash
+        #
+        # @return [Hash]
+        def decode(str)
+          MultiXml.parse(str)
+        end
+      end
+    end
+  end
+
+  ::HTTP::MimeType.register_adapter "text/xml", WeChat::Bot::HTTP::MimeType::XML
+  ::HTTP::MimeType.register_alias   "text/xml", :xml
+end