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 riphtml() just call ircify_html() with stronger purify options.
  89 #
  90 class ::String
  91
  92   # This method will return a purified version of the receiver, with all HTML
  93   # stripped off and some of it converted to IRC formatting
  94   #
  95   def ircify_html(opts={})
  96     txt = self.dup
  97
  98     # remove scripts
  99     txt.gsub!(/<script(?:\s+[^>]*)?>.*?<\/script>/im, "")
 100
 101     # remove styles
 102     txt.gsub!(/<style(?:\s+[^>]*)?>.*?<\/style>/im, "")
 103
 104     # bold and strong -> bold
 105     txt.gsub!(/<\/?(?:b|strong)(?:\s+[^>]*)?>/im, "#{Bold}")
 106
 107     # italic, emphasis and underline -> underline
 108     txt.gsub!(/<\/?(?:i|em|u)(?:\s+[^>]*)?>/im, "#{Underline}")
 109
 110     ## This would be a nice addition, but the results are horrible
 111     ## Maybe make it configurable?
 112     # txt.gsub!(/<\/?a( [^>]*)?>/, "#{Reverse}")
 113     case val = opts[:a_href]
 114     when Reverse, Bold, Underline
 115       txt.gsub!(/<(?:\/a\s*|a (?:[^>]*\s+)?href\s*=\s*(?:[^>]*\s*)?)>/, val)
 116     when :link_out
 117       # Not good for nested links, but the best we can do without something like hpricot
 118       txt.gsub!(/<a (?:[^>]*\s+)?href\s*=\s*(?:([^"'>][^\s>]*)\s+|"((?:[^"]|\\")*)"|'((?:[^']|\\')*)')(?:[^>]*\s+)?>(.*?)<\/a>/) { |match|
 119         debug match
 120         debug [$1, $2, $3, $4].inspect
 121         link = $1 || $2 || $3
 122         str = $4
 123         str + ": " + link
 124       }
 125     else
 126       warning "unknown :a_href option #{val} passed to ircify_html" if val
 127     end
 128
 129     # Paragraph and br tags are converted to whitespace
 130     txt.gsub!(/<\/?(p|br)(?:\s+[^>]*)?\s*\/?\s*>/i, ' ')
 131     txt.gsub!("\n", ' ')
 132     txt.gsub!("\r", ' ')
 133
 134     # Superscripts and subscripts are turned into ^{...} and _{...}
 135     # where the {} are omitted for single characters
 136     txt.gsub!(/<sup>(.*?)<\/sup>/, '^{\1}')
 137     txt.gsub!(/<sub>(.*?)<\/sub>/, '_{\1}')
 138     txt.gsub!(/(^|_)\{(.)\}/, '\1\2')
 139
 140     # All other tags are just removed
 141     txt.gsub!(/<[^>]+>/, '')
 142
 143     # Convert HTML entities. We do it now to be able to handle stuff
 144     # such as &nbsp;
 145     txt = Utils.decode_html_entities(txt)
 146
 147     # Keep unbreakable spaces or conver them to plain spaces?
 148     case val = opts[:nbsp]
 149     when :space, ' '
 150       txt.gsub!([160].pack('U'), ' ')
 151     else
 152       warning "unknown :nbsp option #{val} passed to ircify_html" if val
 153     end
 154
 155     # Remove double formatting options, since they only waste bytes
 156     txt.gsub!(/#{Bold}(\s*)#{Bold}/, '\1')
 157     txt.gsub!(/#{Underline}(\s*)#{Underline}/, '\1')
 158
 159     # Simplify whitespace that appears on both sides of a formatting option
 160     txt.gsub!(/\s+(#{Bold}|#{Underline})\s+/, ' \1')
 161     txt.sub!(/\s+(#{Bold}|#{Underline})\z/, '\1')
 162     txt.sub!(/\A(#{Bold}|#{Underline})\s+/, '\1')
 163
 164     # And finally whitespace is squeezed
 165     txt.gsub!(/\s+/, ' ')
 166     txt.strip!
 167
 168     if opts[:limit] && txt.size > opts[:limit]
 169       txt = txt.slice(0, opts[:limit]) + "#{Reverse}...#{Reverse}"
 170     end
 171
 172     # Decode entities and strip whitespace
 173     return txt
 174   end
 175
 176   # As above, but modify the receiver
 177   #
 178   def ircify_html!(opts={})
 179     old_hash = self.hash
 180     replace self.ircify_html(opts)
 181     return self unless self.hash == old_hash
 182   end
 183
 184   # This method will strip all HTML crud from the receiver
 185   #
 186   def riphtml
 187     self.gsub(/<[^>]+>/, '').gsub(/&amp;/,'&').gsub(/&quot;/,'"').gsub(/&lt;/,'<').gsub(/&gt;/,'>').gsub(/&ellip;/,'...').gsub(/&apos;/, "'").gsub("\n",'')
 188   end
 189
 190   # This method tries to find an HTML title in the string,
 191   # and returns it if found
 192   def get_html_title
 193     if defined? ::Hpricot
 194       Hpricot(self).at("title").inner_html
 195     else
 196       return unless Irc::Utils::TITLE_REGEX.match(self)
 197       $1
 198     end
 199   end
 200
 201   # This method returns the IRC-formatted version of an
 202   # HTML title found in the string
 203   def ircify_html_title
 204     self.get_html_title.ircify_html rescue nil
 205   end
 206 end
 207
 208
 209 # Extensions to the Regexp class, with some common and/or complex regular
 210 # expressions.
 211 #
 212 class ::Regexp
 213
 214   # A method to build a regexp that matches a list of something separated by
 215   # optional commas and/or the word "and", an optionally repeated prefix,
 216   # and whitespace.
 217   def Regexp.new_list(reg, pfx = "")
 218     if pfx.kind_of?(String) and pfx.empty?
 219       return %r(#{reg}(?:,?(?:\s+and)?\s+#{reg})*)
 220     else
 221       return %r(#{reg}(?:,?(?:\s+and)?(?:\s+#{pfx})?\s+#{reg})*)
 222     end
 223   end
 224
 225   IN_ON = /in|on/
 226
 227   module Irc
 228     # Match a list of channel anmes separated by optional commas, whitespace
 229     # and optionally the word "and"
 230     CHAN_LIST = Regexp.new_list(GEN_CHAN)
 231
 232     # Match "in #channel" or "on #channel" and/or "in private" (optionally
 233     # shortened to "in pvt"), returning the channel name or the word 'private'
 234     # or 'pvt' as capture
 235     IN_CHAN = /#{IN_ON}\s+(#{GEN_CHAN})|(here)|/
 236     IN_CHAN_PVT = /#{IN_CHAN}|in\s+(private|pvt)/
 237
 238     # As above, but with channel lists
 239     IN_CHAN_LIST_SFX = Regexp.new_list(/#{GEN_CHAN}|here/, IN_ON)
 240     IN_CHAN_LIST = /#{IN_ON}\s+#{IN_CHAN_LIST_SFX}|anywhere|everywhere/
 241     IN_CHAN_LIST_PVT_SFX = Regexp.new_list(/#{GEN_CHAN}|here|private|pvt/, IN_ON)
 242     IN_CHAN_LIST_PVT = /#{IN_ON}\s+#{IN_CHAN_LIST_PVT_SFX}|anywhere|everywhere/
 243
 244     # Match a list of nicknames separated by optional commas, whitespace and
 245     # optionally the word "and"
 246     NICK_LIST = Regexp.new_list(GEN_NICK)
 247
 248   end
 249
 250 end
 251
 252
 253 module ::Irc
 254
 255
 256   class BasicUserMessage
 257
 258     # We extend the BasicUserMessage class with a method that parses a string
 259     # which is a channel list as matched by IN_CHAN(_LIST) and co. The method
 260     # returns an array of channel names, where 'private' or 'pvt' is replaced
 261     # by the Symbol :"?", 'here' is replaced by the channel of the message or
 262     # by :"?" (depending on whether the message target is the bot or a
 263     # Channel), and 'anywhere' and 'everywhere' are replaced by Symbol :*
 264     #
 265     def parse_channel_list(string)
 266       return [:*] if [:anywhere, :everywhere].include? string.to_sym
 267       string.scan(
 268       /(?:^|,?(?:\s+and)?\s+)(?:in|on\s+)?(#{Regexp::Irc::GEN_CHAN}|here|private|pvt)/
 269                  ).map { |chan_ar|
 270         chan = chan_ar.first
 271         case chan.to_sym
 272         when :private, :pvt
 273           :"?"
 274         when :here
 275           case self.target
 276           when Channel
 277             self.target.name
 278           else
 279             :"?"
 280           end
 281         else
 282           chan
 283         end
 284       }.uniq
 285     end
 286   end
 287 end