X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fmessagemapper.rb;h=b6125538b49b1ba24be54ead551c42b9511181f6;hb=78978a4654ad851b0fa18bcd3d165b9c173f0375;hp=144669d88445d7a2142e59e27062007178cba143;hpb=3fb12ca2c704d18d434b417d549122325e78225d;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/messagemapper.rb b/lib/rbot/messagemapper.rb index 144669d8..b6125538 100644 --- a/lib/rbot/messagemapper.rb +++ b/lib/rbot/messagemapper.rb @@ -1,9 +1,9 @@ # First of all we add a method to the Regexp class class Regexp - # a Regexp has captures when its source has open parenthesis - # which are preceded by an even number of slashes and followed by - # a question mark + # a Regexp has captures when its source has open parenthesis which are + # preceded by an even number of slashes and not followed by a question mark + # def has_captures? self.source.match(/(?:^|[^\\])(?:\\\\)*\([^?]/) end @@ -13,13 +13,29 @@ class Regexp new = self.source.gsub(/(^|[^\\])((?:\\\\)*)\(([^?])/) { "%s%s(?:%s" % [$1, $2, $3] } - Regexp.new(new) + Regexp.new(new, self.options) + end + + # We may want to remove head and tail anchors + def remove_head_tail + new = self.source.sub(/^\^/,'').sub(/\$$/,'') + Regexp.new(new, self.options) + end + + # The MessageMapper cleanup method: does both remove_capture + # and remove_head_tail + def mm_cleanup + new = self.source.gsub(/(^|[^\\])((?:\\\\)*)\(([^?])/) { + "%s%s(?:%s" % [$1, $2, $3] + }.sub(/^\^/,'').sub(/\$$/,'') + Regexp.new(new, self.options) end end module Irc +class Bot - # +MessageMapper+ is a class designed to reduce the amount of regexps and + # MessageMapper is a class designed to reduce the amount of regexps and # string parsing plugins and bot modules need to do, in order to process # and respond to messages. # @@ -32,7 +48,7 @@ module Irc # A template such as "foo :option :otheroption" will match the string "foo # bar baz" and, by default, result in method +foo+ being called, if # present, in the parent class. It will receive two parameters, the - # Message (derived from BasicUserMessage) and a Hash containing + # message (derived from BasicUserMessage) and a Hash containing # {:option => "bar", :otheroption => "baz"} # See the #map method for more details. class MessageMapper @@ -40,74 +56,114 @@ module Irc # The default fallback is a method called "usage". attr_writer :fallback - # parent:: parent class which will receive mapped messages + # _parent_:: parent class which will receive mapped messages # - # create a new MessageMapper with parent class +parent+. This class will + # Create a new MessageMapper with parent class _parent_. This class will # receive messages from the mapper via the handle() method. def initialize(parent) @parent = parent @templates = Array.new - @fallback = 'usage' + @fallback = :usage end - # args:: hash format containing arguments for this template + # call-seq: map(botmodule, template, options) + # + # _botmodule_:: the BotModule which will handle this map + # _template_:: a String describing the messages to be matched + # _options_:: a Hash holding variouns options # - # map a template string to an action. example: - # map 'myplugin :parameter1 :parameter2' - # (other examples follow). By default, maps a matched string to an - # action with the name of the first word in the template. The action is - # a method which takes a message and a parameter hash for arguments. + # This method is used to register a new MessageTemplate that will map any + # BasicUserMessage matching the given _template_ to a corresponding action. + # A simple example: + # plugin.map 'myplugin :parameter' + # (other examples follow). # - # The :action => 'method_name' option can be used to override this - # default behaviour. Example: - # map 'myplugin :parameter1 :parameter2', :action => 'mymethod' + # By default, the action to which the messages are mapped is a method named + # like the first word of the template. The + # :action => 'method_name' + # option can be used to override this default behaviour. Example: + # plugin.map 'myplugin :parameter', :action => 'mymethod' # - # By default whether a handler is fired depends on an auth check. The - # first component of the string is used for the auth check, unless - # overridden via the :auth => 'auth_name' option. + # By default whether a handler is fired depends on an auth check. In rbot + # versions up to 0.9.10, the first component of the string was used for the + # auth check, unless overridden via the :auth => 'auth_name' option. Since + # version 0.9.11, a new auth method has been implemented. TODO document. # # Static parameters (not prefixed with ':' or '*') must match the # respective component of the message exactly. Example: - # map 'myplugin :foo is :bar' + # plugin.map 'myplugin :foo is :bar' # will only match messages of the form "myplugin something is # somethingelse" # # Dynamic parameters can be specified by a colon ':' to match a single - # component (whitespace seperated), or a * to suck up all following + # component (whitespace separated), or a * to suck up all following # parameters into an array. Example: - # map 'myplugin :parameter1 *rest' + # plugin.map 'myplugin :parameter1 *rest' # # You can provide defaults for dynamic components using the :defaults # parameter. If a component has a default, then it is optional. e.g: - # map 'myplugin :foo :bar', :defaults => {:bar => 'qux'} + # plugin.map 'myplugin :foo :bar', :defaults => {:bar => 'qux'} # would match 'myplugin param param2' and also 'myplugin param'. In the # latter case, :bar would be provided from the default. # + # Static and dynamic parameters can also be made optional by wrapping them + # in square brackets []. For example + # plugin.map 'myplugin :foo [is] :bar' + # will match both 'myplugin something is somethingelse' and 'myplugin + # something somethingelse'. + # # Components can be validated before being allowed to match, for # example if you need a component to be a number: - # map 'myplugin :param', :requirements => {:param => /^\d+$/} + # plugin.map 'myplugin :param', :requirements => {:param => /^\d+$/} # will only match strings of the form 'myplugin 1234' or some other # number. # # Templates can be set not to match public or private messages using the # :public or :private boolean options. # + # Summary of recognized options: + # + # action:: + # method to call when the template is matched + # auth_path:: + # TODO document + # requirements:: + # a Hash whose keys are names of dynamic parameters and whose values are + # regular expressions that the parameters must match + # defaults:: + # a Hash whose keys are names of dynamic parameters and whose values are + # the values to be assigned to those parameters when they are missing from + # the message. Any dynamic parameter appearing in the :defaults Hash is + # therefore optional + # public:: + # a boolean (defaults to true) that determines whether the template should + # match public (in channel) messages. + # private:: + # a boolean (defaults to true) that determines whether the template should + # match private (not in channel) messages. + # threaded:: + # a boolean (defaults to false) that determines whether the action should be + # called in a separate thread. + # + # # Further examples: # # # match 'karmastats' and call my stats() method - # map 'karmastats', :action => 'stats' + # plugin.map 'karmastats', :action => 'stats' # # match 'karma' with an optional 'key' and call my karma() method - # map 'karma :key', :defaults => {:key => false} + # plugin.map 'karma :key', :defaults => {:key => false} # # match 'karma for something' and call my karma() method - # map 'karma for :key' + # plugin.map 'karma for :key' # # # two matches, one for public messages in a channel, one for # # private messages which therefore require a channel argument - # map 'urls search :channel :limit :string', :action => 'search', + # plugin.map 'urls search :channel :limit :string', + # :action => 'search', # :defaults => {:limit => 4}, # :requirements => {:limit => /^\d+$/}, # :public => false - # plugin.map 'urls search :limit :string', :action => 'search', + # plugin.map 'urls search :limit :string', + # :action => 'search', # :defaults => {:limit => 4}, # :requirements => {:limit => /^\d+$/}, # :private => false @@ -116,21 +172,23 @@ module Irc @templates << MessageTemplate.new(botmodule, *args) end + # Iterate over each MessageTemplate handled. def each @templates.each {|tmpl| yield tmpl} end + # Return the last added MessageTemplate def last @templates.last end - # m:: derived from BasicUserMessage + # _m_:: derived from BasicUserMessage # - # examine the message +m+, comparing it with each map()'d template to + # Examine the message _m_, comparing it with each map()'d template to # find and process a match. Templates are examined in the order they # were map()'d - first match wins. # - # returns +true+ if a match is found including fallbacks, +false+ + # Returns +true+ if a match is found including fallbacks, +false+ # otherwise. def handle(m) return false if @templates.empty? @@ -149,7 +207,19 @@ module Irc debug "checking auth for #{auth}" if m.bot.auth.allow?(auth, m.source, m.replyto) debug "template match found and auth'd: #{action.inspect} #{options.inspect}" - @parent.send(action, m, options) + if !m.in_thread && (tmpl.options[:thread] || tmpl.options[:threaded]) + Thread.new do + begin + @parent.send(action, m, options) + rescue Exception => e + error "In threaded action: #{e.message}" + debug e.backtrace.join("\n") + end + end + else + @parent.send(action, m, options) + end + return true end debug "auth failed for #{auth}" @@ -162,7 +232,7 @@ module Irc debug "#{f.inspect} => #{r}" } debug "no handler found, trying fallback" - if @fallback != nil && @parent.respond_to?(@fallback) + if @fallback && @parent.respond_to?(@fallback) if m.bot.auth.allow?(@fallback, m.source, m.replyto) @parent.send(@fallback, m, {}) return true @@ -173,9 +243,9 @@ module Irc end - # +MessageParameter+ is a class that collects all the necessary information - # about a message parameter (the :param or *param that can be found in a - # #map). + # MessageParameter is a class that collects all the necessary information + # about a message (dynamic) parameter (the :param or *param that can be found + # in a #map). # # It has a +name+ attribute, +multi+ and +optional+ booleans that tell if the # parameter collects more than one word, and if it's optional (respectively). @@ -267,22 +337,39 @@ module Irc else reg = nil end - "<#{self.class.to_s}%s%s%s%s>" % [name, mul, opt, reg] + "<%s %s%s%s%s>" % [self.class, name, mul, opt, reg] end end + # MessageTemplate is the class that holds the actual message template map()'d + # by a BotModule and handled by a MessageMapper + # class MessageTemplate - attr_reader :defaults # The defaults hash - attr_reader :options # The options hash - attr_reader :template - attr_reader :items - attr_reader :regexp - + attr_reader :defaults # the defaults hash + attr_reader :options # the options hash + attr_reader :template # the actual template string + attr_reader :items # the collection of dynamic and static items in the template + attr_reader :regexp # the Regexp corresponding to the template + attr_reader :botmodule # the BotModule that map()'d this MessageTemplate + + # call-seq: initialize(botmodule, template, opts={}) + # + # Create a new MessageTemplate associated to BotModule _botmodule_, with + # template _template_ and options _opts_ + # def initialize(botmodule, template, hash={}) raise ArgumentError, "Third argument must be a hash!" unless hash.kind_of?(Hash) @defaults = hash[:defaults].kind_of?(Hash) ? hash.delete(:defaults) : {} @requirements = hash[:requirements].kind_of?(Hash) ? hash.delete(:requirements) : {} @template = template + case botmodule + when String + @botmodule = botmodule + when Plugins::BotModule + @botmodule = botmodule.name + else + raise ArgumentError, "#{botmodule.inspect} is not a botmodule nor a botmodule name" + end self.items = template # @dyn_items is an array of MessageParameters, except for the first entry @@ -306,9 +393,9 @@ module Irc debug "Items: #{@items.inspect}; dyn items: #{@dyn_items.inspect}" self.regexp = template - debug "Command #{template.inspect} in #{botmodule} will match using #{@regexp}" + debug "Command #{template.inspect} in #{@botmodule} will match using #{@regexp}" - set_auth_path(botmodule, hash) + set_auth_path(hash) unless hash.has_key?(:action) hash[:action] = items[0] @@ -319,21 +406,14 @@ module Irc # debug "Create template #{self.inspect}" end - def set_auth_path(botmodule, hash) + def set_auth_path(hash) if hash.has_key?(:auth) - warning "Command #{@template.inspect} in #{botmodule} uses old :auth syntax, please upgrade" + warning "Command #{@template.inspect} in #{@botmodule} uses old :auth syntax, please upgrade" end if hash.has_key?(:full_auth_path) - warning "Command #{@template.inspect} in #{botmodule} sets :full_auth_path, please don't do this" + warning "Command #{@template.inspect} in #{@botmodule} sets :full_auth_path, please don't do this" else - case botmodule - when String - pre = botmodule - when Plugins::BotModule - pre = botmodule.name - else - raise ArgumentError, "Can't find auth base in #{botmodule.inspect}" - end + pre = @botmodule words = items.reject{ |x| x == pre || x.kind_of?(Symbol) || x =~ /\[|\]/ } @@ -355,6 +435,7 @@ module Irc end pre = nil if extra.sub!(/^!/, "") post = nil if extra.sub!(/!$/, "") + extra = nil if extra.empty? else extra = nil end @@ -415,16 +496,16 @@ module Irc debug "Requirements for #{name}: #{has_req.inspect}" case has_req when nil - sub = is_single ? "\\S+" : ".*" + sub = is_single ? "\\S+" : ".*?" when Regexp # Remove captures and the ^ and $ that are sometimes placed in requirement regexps - sub = has_req.remove_captures.source.sub(/^\^/,'').sub(/\$$/,'') + sub = has_req.mm_cleanup when String sub = Regexp.escape(has_req) when Array - sub = has_req[0].remove_captures.source.sub(/^\^/,'').sub(/\$$/,'') + sub = has_req[0].mm_cleanup when Hash - sub = has_req[:regexp].remove_captures.source.sub(/^\^/,'').sub(/\$$/,'') + sub = has_req[:regexp].mm_cleanup else warning "Odd requirement #{has_req.inspect} of class #{has_req.class} for parameter '#{name}'" sub = Regexp.escape(has_req.to_s) rescue "\\S+" @@ -438,7 +519,8 @@ module Irc # debug "Delimited optionals: #{rx.inspect}" rx.gsub!(/(?:\\ )+/, "\\s+") # debug "Corrected spaces: #{rx.inspect}" - @regexp = Regexp.new(rx) + # Created message (such as by fake_message) can contain multiple lines + @regexp = /\A#{rx}\z/m end # Recognize the provided string components, returning a hash of @@ -455,7 +537,7 @@ module Irc matching = @regexp.match(m.message) return nil, "#{m.message.inspect} doesn't match #{@template} (#{@regexp})" unless matching - return nil, "#{m.message.inspect} only matches #{@template} (#{@regexp}) partially" unless matching[0] == m.message + return nil, "#{m.message.inspect} only matches #{@template} (#{@regexp}) partially: #{matching[0].inspect}" unless matching[0] == m.message debug_match = matching[1..-1].collect{ |d| d.inspect}.join(', ') debug "#{m.message.inspect} matched #{@regexp} with #{debug_match}" @@ -529,3 +611,4 @@ module Irc end end end +end