X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fmessagemapper.rb;h=8b21ee2efcd4ff79a46928364bdf33e3f19818d9;hb=9c50738a84bec26402902513a4cd21b54dcc0a80;hp=2214780b3c875c8c9ef6595782764d3c7d57db1c;hpb=158056c6f68bbe75e4c9a33433e1502c445c26b8;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/messagemapper.rb b/lib/rbot/messagemapper.rb index 2214780b..8b21ee2e 100644 --- a/lib/rbot/messagemapper.rb +++ b/lib/rbot/messagemapper.rb @@ -1,3 +1,22 @@ +# 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 not followed by a question mark + # + def has_captures? + self.source.match(/(?:^|[^\\])(?:\\\\)*\([^?]/) + end + + # We may want to remove captures + def remove_captures + new = self.source.gsub(/(^|[^\\])((?:\\\\)*)\(([^?])/) { + "%s%s(?:%s" % [$1, $2, $3] + } + Regexp.new(new) + end +end + module Irc # +MessageMapper+ is a class designed to reduce the amount of regexps and @@ -28,7 +47,7 @@ module Irc def initialize(parent) @parent = parent @templates = Array.new - @fallback = 'usage' + @fallback = :usage end # args:: hash format containing arguments for this template @@ -94,7 +113,7 @@ module Irc # :private => false # def map(botmodule, *args) - @templates << Template.new(botmodule, *args) + @templates << MessageTemplate.new(botmodule, *args) end def each @@ -121,7 +140,7 @@ module Irc if options.nil? failures << [tmpl, failure] else - action = tmpl.options[:action] ? tmpl.options[:action] : tmpl.items[0] + action = tmpl.options[:action] unless @parent.respond_to?(action) failures << [tmpl, "class does not respond to action #{action}"] next @@ -143,7 +162,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 @@ -154,62 +173,221 @@ module Irc end - class Template + # +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). + # + # 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). + # In the latter case, it can also have a default value. + # + # It is possible to assign a collector to a MessageParameter. This can be either + # a Regexp with captures or an Array or a Hash. The collector defines what the + # collect() method is supposed to return. + class MessageParameter + attr_reader :name + attr_writer :multi + attr_writer :optional + attr_accessor :default + + def initialize(name) + self.name = name + @multi = false + @optional = false + @default = nil + @regexp = nil + @index = nil + end + + def name=(val) + @name = val.to_sym + end + + def multi? + @multi + end + + def optional? + @optional + end + + # This method is used to turn a matched item into the actual parameter value. + # It only does something when collector= set the @regexp to something. In + # this case, _val_ is matched against @regexp and then the match result + # specified in @index is selected. As a special case, when @index is nil + # the first non-nil captured group is returned. + def collect(val) + return val unless @regexp + mdata = @regexp.match(val) + if @index + return mdata[@index] + else + return mdata[1..-1].compact.first + end + end + + # This method allow the plugin programmer to choose to only pick a subset of the + # string matched by a parameter. This is done by passing the collector=() + # method either a Regexp with captures or an Array or a Hash. + # + # When the method is passed a Regexp with captures, the collect() method will + # return the first non-nil captured group. + # + # When the method is passed an Array, it will grab a regexp from the first + # element, and possibly an index from the second element. The index can + # also be nil. + # + # When the method is passed a Hash, it will grab a regexp from the :regexp + # element, and possibly an index from the :index element. The index can + # also be nil. + def collector=(val) + return unless val + case val + when Regexp + return unless val.has_captures? + @regexp = val + when Array + warning "Collector #{val.inspect} is too long, ignoring extra entries" unless val.length <= 2 + @regexp = val[0] + @index = val[1] rescue nil + when Hash + raise "Collector #{val.inspect} doesn't have a :regexp key" unless val.has_key?(:regexp) + @regexp = val[:regexp] + @index = val.fetch(:regexp, nil) + end + raise "The regexp of collector #{val.inspect} isn't a Regexp" unless @regexp.kind_of?(Regexp) + raise "The index of collector #{val.inspect} is present but not an integer " if @index and not @index.kind_of?(Fixnum) + end + + def inspect + mul = multi? ? " multi" : " single" + opt = optional? ? " optional" : " needed" + if @regexp + reg = " regexp=%s index=%d" % [@regexp, @index] + else + reg = nil + end + "<#{self.class.to_s}%s%s%s%s>" % [name, mul, opt, reg] + end + end + + 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 :botmodule 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 + # which is the template + @dyn_items = @items.collect { |it| + if it.kind_of?(Symbol) + i = it.to_s + opt = MessageParameter.new(i) + if i.sub!(/^\*/,"") + opt.name = i + opt.multi = true + end + opt.default = @defaults[opt.name] + opt.collector = @requirements[opt.name] + opt + else + nil + end + } + @dyn_items.unshift(template).compact! + debug "Items: #{@items.inspect}; dyn items: #{@dyn_items.inspect}" + + self.regexp = template + debug "Command #{template.inspect} in #{@botmodule} will match using #{@regexp}" + + set_auth_path(hash) + + unless hash.has_key?(:action) + hash[:action] = items[0] + end + + @options = hash + + # debug "Create template #{self.inspect}" + end + + def set_auth_path(hash) if hash.has_key?(:auth) - warning "Command #{template} 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} 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 - post = items.reject{ |x| - x == pre || x.kind_of?(Symbol) + pre = @botmodule + words = items.reject{ |x| + x == pre || x.kind_of?(Symbol) || x =~ /\[|\]/ } - if post.empty? + if words.empty? post = nil else - post = post.first + post = words.first end if hash.has_key?(:auth_path) extra = hash[:auth_path] + if extra.sub!(/^:/, "") + pre += "::" + post + post = nil + end + if extra.sub!(/:$/, "") + if words.length > 1 + post = [post,words[1]].compact.join("::") + end + end pre = nil if extra.sub!(/^!/, "") post = nil if extra.sub!(/!$/, "") else extra = nil end hash[:full_auth_path] = [pre,extra,post].compact.join("::") + debug "Command #{@template} in #{botmodule} will use authPath #{hash[:full_auth_path]}" # TODO check if the full_auth_path is sane end - - @options = hash - # debug "Create template #{self.inspect}" end def items=(str) - items = str.split(/\s+/).collect {|c| (/^(:|\*)(\w+)$/ =~ c) ? (($1 == ':' ) ? $2.intern : "*#{$2}".intern) : c} if str.kind_of?(String) # split and convert ':xyz' to symbols - items.shift if items.first == "" - items.pop if items.last == "" + raise ArgumentError, "template #{str.inspect} should be a String" unless str.kind_of?(String) + + # split and convert ':xyz' to symbols + items = str.strip.split(/\]?\s+\[?|\]?$/).collect { |c| + # there might be extra (non-alphanumeric) stuff (e.g. punctuation) after the symbol name + if /^(:|\*)(\w+)(.*)/ =~ c + sym = ($1 == ':' ) ? $2.intern : "*#{$2}".intern + if $3.empty? + sym + else + [sym, $3] + end + else + c + end + }.flatten @items = items - if @items.first.kind_of? Symbol - raise ArgumentError, "Illegal template -- first component cannot be dynamic\n #{str.inspect}" - end + raise ArgumentError, "Illegal template -- first component cannot be dynamic: #{str.inspect}" if @items.first.kind_of? Symbol + + raise ArgumentError, "Illegal template -- first component cannot be optional: #{str.inspect}" if @items.first =~ /\[|\]/ # Verify uniqueness of each component. @items.inject({}) do |seen, item| @@ -224,46 +402,109 @@ module Irc end end + def regexp=(str) + # debug "Original string: #{str.inspect}" + rx = Regexp.escape(str) + # debug "Escaped: #{rx.inspect}" + rx.gsub!(/((?:\\ )*)(:|\\\*)(\w+)/) { |m| + whites = $1 + is_single = $2 == ":" + name = $3.intern + + not_needed = @defaults.has_key?(name) + + has_req = @requirements[name] + debug "Requirements for #{name}: #{has_req.inspect}" + case has_req + when nil + 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(/\$$/,'') + when String + sub = Regexp.escape(has_req) + when Array + sub = has_req[0].remove_captures.source.sub(/^\^/,'').sub(/\$$/,'') + when Hash + sub = has_req[:regexp].remove_captures.source.sub(/^\^/,'').sub(/\$$/,'') + else + warning "Odd requirement #{has_req.inspect} of class #{has_req.class} for parameter '#{name}'" + sub = Regexp.escape(has_req.to_s) rescue "\\S+" + end + debug "Regexp for #{name}: #{sub.inspect}" + s = "#{not_needed ? "(?:" : ""}#{whites}(#{sub})#{ not_needed ? ")?" : ""}" + } + # debug "Replaced dyns: #{rx.inspect}" + rx.gsub!(/((?:\\ )*)\\\[/, "(?:\\1") + rx.gsub!(/\\\]/, ")?") + # debug "Delimited optionals: #{rx.inspect}" + rx.gsub!(/(?:\\ )+/, "\\s+") + # debug "Corrected spaces: #{rx.inspect}" + @regexp = Regexp.new("^#{rx}$") + end + # Recognize the provided string components, returning a hash of # recognized values, or [nil, reason] if the string isn't recognized. def recognize(m) - components = m.message.split(/\s+/) + + debug "Testing #{m.message.inspect} against #{self.inspect}" + + # Early out + return nil, "template #{@template} is not configured for private messages" if @options.has_key?(:private) && !@options[:private] && m.private? + return nil, "template #{@template} is not configured for public messages" if @options.has_key?(:public) && !@options[:public] && !m.private? + options = {} - @items.each do |item| - if /^\*/ =~ item.to_s - if components.empty? - value = @defaults.has_key?(item) ? @defaults[item].clone : [] - else - value = components.clone - end - components = [] - def value.to_s() self.join(' ') end - options[item.to_s.sub(/^\*/,"").intern] = value - elsif item.kind_of? Symbol - value = components.shift || @defaults[item] - if passes_requirements?(item, value) - options[item] = value - else - if @defaults.has_key?(item) - options[item] = @defaults[item] - # push the test-failed component back on the stack - components.unshift value + 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: #{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}" + debug "Associating #{debug_match} with dyn items #{@dyn_items.join(', ')}" + + @dyn_items.each_with_index { |it, i| + next if i == 0 + item = it.name + debug "dyn item #{item} (multi-word: #{it.multi?.inspect})" + if it.multi? + if matching[i].nil? + default = it.default + case default + when Array + value = default.clone + when String + value = default.strip.split + when nil, false, [] + value = [] else - return nil, requirements_for(item) + warning "Unmanageable default #{default} detected for :*#{item.to_s}, using []" + value = [] end + case default + when String + value.instance_variable_set(:@string_value, default) + else + value.instance_variable_set(:@string_value, value.join(' ')) + end + else + value = matching[i].split + value.instance_variable_set(:@string_value, matching[i]) + end + def value.to_s + @string_value end else - return nil, "No value available for component #{item.inspect}" if components.empty? - component = components.shift - return nil, "Value for component #{item.inspect} doesn't match #{component}" if component != item + if matching[i].nil? + warning "No default value for option #{item.inspect} specified" unless @defaults.has_key?(item) + value = it.default + else + value = it.collect(matching[i]) + end end - end - - return nil, "Unused components were left: #{components.join '/'}" unless components.empty? - - return nil, "template is not configured for private messages" if @options.has_key?(:private) && !@options[:private] && m.private? - return nil, "template is not configured for public messages" if @options.has_key?(:public) && !@options[:public] && !m.private? + options[item] = value + debug "set #{item} to #{options[item].inspect}" + } options.delete_if {|k, v| v.nil?} # Remove nil values. return options, nil @@ -272,22 +513,7 @@ module Irc def inspect when_str = @requirements.empty? ? "" : " when #{@requirements.inspect}" default_str = @defaults.empty? ? "" : " || #{@defaults.inspect}" - "<#{self.class.to_s} #{@items.collect{|c| c.kind_of?(String) ? c : c.inspect}.join(' ').inspect}#{default_str}#{when_str}>" - end - - # Verify that the given value passes this template's requirements - def passes_requirements?(name, value) - return @defaults.key?(name) && @defaults[name].nil? if value.nil? # Make sure it's there if it should be - - case @requirements[name] - when nil then true - when Regexp then - value = value.to_s - match = @requirements[name].match(value) - match && match[0].length == value.length - else - @requirements[name] == value.to_s - end + "<#{self.class.to_s} #{@items.map { |c| c.inspect }.join(' ').inspect}#{default_str}#{when_str}>" end def requirements_for(name)