lib/rbot/core/utils/extends.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: Standard classes extensions
   5 #
   6 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
   7 # Copyright:: (C) 2006,2007 Giuseppe Bilotta
   8 # License:: GPL v2
   9 #
  10 # This file collects extensions to standard Ruby classes and to some core rbot
  11 # classes to be used by the various plugins
  12 #
  13 # Please note that global symbols have to be prefixed by :: because this plugin
  14 # will be read into an anonymous module
  15
  16 # Extensions to the Module class
  17 #
  18 class ::Module
  19
  20   # Many plugins define Struct objects to hold their data. On rescans, lots of
  21   # warnings are echoed because of the redefinitions. Using this method solves
  22   # the problem, by checking if the Struct already exists, and if it has the
  23   # same attributes
  24   #
  25   def define_structure(name, *members)
  26     sym = name.to_sym
  27     if Struct.const_defined?(sym)
  28       kl = Struct.const_get(sym)
  29       if kl.new.members.map { |member| member.intern } == members.map
  30         debug "Struct #{sym} previously defined, skipping"
  31         const_set(sym, kl)
  32         return
  33       end
  34     end
  35     debug "Defining struct #{sym} with members #{members.inspect}"
  36     const_set(sym, Struct.new(name.to_s, *members))
  37   end
  38 end
  39
  40
  41 # Extensions to the Array class
  42 #
  43 class ::Array
  44
  45   # This method returns a random element from the array, or nil if the array is
  46   # empty
  47   #
  48   def pick_one
  49     return nil if self.empty?
  50     self[rand(self.length)]
  51   end
  52 end
  53
  54 # Extensions to the Range class
  55 #
  56 class ::Range
  57
  58   # This method returns a random number between the lower and upper bound
  59   #
  60   def pick_one
  61     len = self.last - self.first
  62     len += 1 unless self.exclude_end?
  63     self.first + Kernel::rand(len)
  64   end
  65   alias :rand :pick_one
  66 end
  67
  68 # Extensions for the Numeric classes
  69 #
  70 class ::Numeric
  71
  72   # This method forces a real number to be not more than a given positive
  73   # number or not less than a given positive number, or between two any given
  74   # numbers
  75   #
  76   def clip(left,right=0)
  77     raise ArgumentError unless left.kind_of?(Numeric) and right.kind_of?(Numeric)
  78     l = [left,right].min
  79     u = [left,right].max
  80     return l if self < l
  81     return u if self > u
  82     return self
  83   end
  84 end
  85
  86 # Extensions to the String class
  87 #
  88 # TODO make ircify_html() accept an Hash of options, and make riphtml() just
  89 # call ircify_html() with stronger purify options.
  90 #
  91 class ::String
  92
  93   # This method will return a purified version of the receiver, with all HTML
  94   # stripped off and some of it converted to IRC formatting
  95   #
  96   def ircify_html(opts={})
  97     txt = self.dup
  98
  99     # remove scripts
 100     txt.gsub!(/<script(?:\s+[^>]*)?>.*?<\/script>/im, "")
 101
 102     # remove styles
 103     txt.gsub!(/<style(?:\s+[^>]*)?>.*?<\/style>/im, "")
 104
 105     # bold and strong -> bold
 106     txt.gsub!(/<\/?(?:b|strong)(?:\s+[^>]*)?>/im, "#{Bold}")
 107
 108     # italic, emphasis and underline -> underline
 109     txt.gsub!(/<\/?(?:i|em|u)(?:\s+[^>]*)?>/im, "#{Underline}")
 110
 111     ## This would be a nice addition, but the results are horrible
 112     ## Maybe make it configurable?
 113     # txt.gsub!(/<\/?a( [^>]*)?>/, "#{Reverse}")
 114     case val = opts[:a_href]
 115     when Reverse, Bold, Underline
 116       txt.gsub!(/<(?:\/a\s*|a (?:[^>]*\s+)?href\s*=\s*(?:[^>]*\s*)?)>/, val)
 117     when :link_out
 118       # Not good for nested links, but the best we can do without something like hpricot
 119       txt.gsub!(/<a (?:[^>]*\s+)?href\s*=\s*(?:([^"'>][^\s>]*)\s+|"((?:[^"]|\\")*)"|'((?:[^']|\\')*)')(?:[^>]*\s+)?>(.*?)<\/a>/) { |match|
 120         debug match
 121         debug [$1, $2, $3, $4].inspect
 122         link = $1 || $2 || $3
 123         str = $4
 124         str + ": " + link
 125       }
 126     else
 127       warn "unknown :a_href option #{val} passed to ircify_html" if val
 128     end
 129
 130     # Paragraph and br tags are converted to whitespace
 131     txt.gsub!(/<\/?(p|br)(?:\s+[^>]*)?\s*\/?\s*>/i, ' ')
 132     txt.gsub!("\n", ' ')
 133     txt.gsub!("\r", ' ')
 134
 135     # Superscripts and subscripts are turned into ^{...} and _{...}
 136     # where the {} are omitted for single characters
 137     txt.gsub!(/<sup>(.*?)<\/sup>/, '^{\1}')
 138     txt.gsub!(/<sub>(.*?)<\/sub>/, '_{\1}')
 139     txt.gsub!(/(^|_)\{(.)\}/, '\1\2')
 140
 141     # All other tags are just removed
 142     txt.gsub!(/<[^>]+>/, '')
 143
 144     # Convert HTML entities. We do it now to be able to handle stuff
 145     # such as &nbsp;
 146     txt = Utils.decode_html_entities(txt)
 147
 148     # Remove double formatting options, since they only waste bytes
 149     txt.gsub!(/#{Bold}(\s*)#{Bold}/, '\1')
 150     txt.gsub!(/#{Underline}(\s*)#{Underline}/, '\1')
 151
 152     # Simplify whitespace that appears on both sides of a formatting option
 153     txt.gsub!(/\s+(#{Bold}|#{Underline})\s+/, ' \1')
 154     txt.sub!(/\s+(#{Bold}|#{Underline})\z/, '\1')
 155     txt.sub!(/\A(#{Bold}|#{Underline})\s+/, '\1')
 156
 157     # And finally whitespace is squeezed
 158     txt.gsub!(/\s+/, ' ')
 159
 160     # Decode entities and strip whitespace
 161     return txt.strip
 162   end
 163
 164   # As above, but modify the receiver
 165   #
 166   def ircify_html!(opts={})
 167     old_hash = self.hash
 168     replace self.ircify_html(opts)
 169     return self unless self.hash == old_hash
 170   end
 171
 172   # This method will strip all HTML crud from the receiver
 173   #
 174   def riphtml
 175     self.gsub(/<[^>]+>/, '').gsub(/&amp;/,'&').gsub(/&quot;/,'"').gsub(/&lt;/,'<').gsub(/&gt;/,'>').gsub(/&ellip;/,'...').gsub(/&apos;/, "'").gsub("\n",'')
 176   end
 177 end
 178
 179
 180 # Extensions to the Regexp class, with some common and/or complex regular
 181 # expressions.
 182 #
 183 class ::Regexp
 184
 185   # A method to build a regexp that matches a list of something separated by
 186   # optional commas and/or the word "and", an optionally repeated prefix,
 187   # and whitespace.
 188   def Regexp.new_list(reg, pfx = "")
 189     if pfx.kind_of?(String) and pfx.empty?
 190       return %r(#{reg}(?:,?(?:\s+and)?\s+#{reg})*)
 191     else
 192       return %r(#{reg}(?:,?(?:\s+and)?(?:\s+#{pfx})?\s+#{reg})*)
 193     end
 194   end
 195
 196   IN_ON = /in|on/
 197
 198   module Irc
 199     # Match a list of channel anmes separated by optional commas, whitespace
 200     # and optionally the word "and"
 201     CHAN_LIST = Regexp.new_list(GEN_CHAN)
 202
 203     # Match "in #channel" or "on #channel" and/or "in private" (optionally
 204     # shortened to "in pvt"), returning the channel name or the word 'private'
 205     # or 'pvt' as capture
 206     IN_CHAN = /#{IN_ON}\s+(#{GEN_CHAN})|(here)|/
 207     IN_CHAN_PVT = /#{IN_CHAN}|in\s+(private|pvt)/
 208
 209     # As above, but with channel lists
 210     IN_CHAN_LIST_SFX = Regexp.new_list(/#{GEN_CHAN}|here/, IN_ON)
 211     IN_CHAN_LIST = /#{IN_ON}\s+#{IN_CHAN_LIST_SFX}|anywhere|everywhere/
 212     IN_CHAN_LIST_PVT_SFX = Regexp.new_list(/#{GEN_CHAN}|here|private|pvt/, IN_ON)
 213     IN_CHAN_LIST_PVT = /#{IN_ON}\s+#{IN_CHAN_LIST_PVT_SFX}|anywhere|everywhere/
 214
 215     # Match a list of nicknames separated by optional commas, whitespace and
 216     # optionally the word "and"
 217     NICK_LIST = Regexp.new_list(GEN_NICK)
 218
 219   end
 220
 221 end
 222
 223
 224 module ::Irc
 225
 226
 227   class BasicUserMessage
 228
 229     # We extend the BasicUserMessage class with a method that parses a string
 230     # which is a channel list as matched by IN_CHAN(_LIST) and co. The method
 231     # returns an array of channel names, where 'private' or 'pvt' is replaced
 232     # by the Symbol :"?", 'here' is replaced by the channel of the message or
 233     # by :"?" (depending on whether the message target is the bot or a
 234     # Channel), and 'anywhere' and 'everywhere' are replaced by Symbol :*
 235     #
 236     def parse_channel_list(string)
 237       return [:*] if [:anywhere, :everywhere].include? string.to_sym
 238       string.scan(
 239       /(?:^|,?(?:\s+and)?\s+)(?:in|on\s+)?(#{Regexp::Irc::GEN_CHAN}|here|private|pvt)/
 240                  ).map { |chan_ar|
 241         chan = chan_ar.first
 242         case chan.to_sym
 243         when :private, :pvt
 244           :"?"
 245         when :here
 246           case self.target
 247           when Channel
 248             self.target.name
 249           else
 250             :"?"
 251           end
 252         else
 253           chan
 254         end
 255       }.uniq
 256     end
 257   end
 258 end