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
  17 # Extensions to the Array class
  18 #
  19 class ::Array
  20
  21   # This method returns a random element from the array, or nil if the array is
  22   # empty
  23   #
  24   def pick_one
  25     return nil if self.empty?
  26     self[rand(self.length)]
  27   end
  28 end
  29
  30 # Extensions for the Numeric classes
  31 #
  32 class ::Numeric
  33
  34   # This method forces a real number to be not more than a given positive
  35   # number or not less than a given positive number, or between two any given
  36   # numbers
  37   #
  38   def clip(left,right=0)
  39     raise ArgumentError unless left.kind_of?(Numeric) and right.kind_of?(Numeric)
  40     l = [left,right].min
  41     u = [left,right].max
  42     return l if self < l
  43     return u if self > u
  44     return self
  45   end
  46 end
  47
  48 # Extensions to the String class
  49 #
  50 # TODO make ircify_html() accept an Hash of options, and make riphtml() just
  51 # call ircify_html() with stronger purify options.
  52 #
  53 class ::String
  54
  55   # This method will return a purified version of the receiver, with all HTML
  56   # stripped off and some of it converted to IRC formatting
  57   #
  58   def ircify_html
  59     txt = self.dup
  60
  61     # remove scripts
  62     txt.gsub!(/<script(?:\s+[^>]*)?>.*?<\/script>/im, "")
  63
  64     # remove styles
  65     txt.gsub!(/<style(?:\s+[^>]*)?>.*?<\/style>/im, "")
  66
  67     # bold and strong -> bold
  68     txt.gsub!(/<\/?(?:b|strong)(?:\s+[^>]*)?>/im, "#{Bold}")
  69
  70     # italic, emphasis and underline -> underline
  71     txt.gsub!(/<\/?(?:i|em|u)(?:\s+[^>]*)?>/im, "#{Underline}")
  72
  73     ## This would be a nice addition, but the results are horrible
  74     ## Maybe make it configurable?
  75     # txt.gsub!(/<\/?a( [^>]*)?>/, "#{Reverse}")
  76
  77     # Paragraph and br tags are converted to whitespace
  78     txt.gsub!(/<\/?(p|br)(?:\s+[^>]*)?\s*\/?\s*>/i, ' ')
  79     txt.gsub!("\n", ' ')
  80     txt.gsub!("\r", ' ')
  81
  82     # Superscripts and subscripts are turned into ^{...} and _{...}
  83     # where the {} are omitted for single characters
  84     txt.gsub!(/<sup>(.*?)<\/sup>/, '^{\1}')
  85     txt.gsub!(/<sub>(.*?)<\/sub>/, '_{\1}')
  86     txt.gsub!(/(^|_)\{(.)\}/, '\1\2')
  87
  88     # All other tags are just removed
  89     txt.gsub!(/<[^>]+>/, '')
  90
  91     # Convert HTML entities. We do it now to be able to handle stuff
  92     # such as &nbsp;
  93     txt = Utils.decode_html_entities(txt)
  94
  95     # Remove double formatting options, since they only waste bytes
  96     txt.gsub!(/#{Bold}(\s*)#{Bold}/, '\1')
  97     txt.gsub!(/#{Underline}(\s*)#{Underline}/, '\1')
  98
  99     # Simplify whitespace that appears on both sides of a formatting option
 100     txt.gsub!(/\s+(#{Bold}|#{Underline})\s+/, ' \1')
 101     txt.sub!(/\s+(#{Bold}|#{Underline})\z/, '\1')
 102     txt.sub!(/\A(#{Bold}|#{Underline})\s+/, '\1')
 103
 104     # And finally whitespace is squeezed
 105     txt.gsub!(/\s+/, ' ')
 106
 107     # Decode entities and strip whitespace
 108     return txt.strip
 109   end
 110
 111   # As above, but modify the receiver
 112   #
 113   def ircify_html!
 114     old_hash = self.hash
 115     replace self.ircify_html
 116     return self unless self.hash == old_hash
 117   end
 118
 119   # This method will strip all HTML crud from the receiver
 120   #
 121   def riphtml
 122     self.gsub(/<[^>]+>/, '').gsub(/&amp;/,'&').gsub(/&quot;/,'"').gsub(/&lt;/,'<').gsub(/&gt;/,'>').gsub(/&ellip;/,'...').gsub(/&apos;/, "'").gsub("\n",'')
 123   end
 124 end
 125
 126
 127 # Extensions to the Regexp class, with some common and/or complex regular
 128 # expressions.
 129 #
 130 class ::Regexp
 131
 132   # A method to build a regexp that matches a list of something separated by
 133   # optional commas and/or the word "and", an optionally repeated prefix,
 134   # and whitespace.
 135   def Regexp.new_list(reg, pfx = "")
 136     if pfx.kind_of?(String) and pfx.empty?
 137       return %r(#{reg}(?:,?(?:\s+and)?\s+#{reg})*)
 138     else
 139       return %r(#{reg}(?:,?(?:\s+and)?(?:\s+#{pfx})?\s+#{reg})*)
 140     end
 141   end
 142
 143   IN_ON = /in|on/
 144
 145   module Irc
 146     # Match a list of channel anmes separated by optional commas, whitespace
 147     # and optionally the word "and"
 148     CHAN_LIST = Regexp.new_list(GEN_CHAN)
 149
 150     # Match "in #channel" or "on #channel" and/or "in private" (optionally
 151     # shortened to "in pvt"), returning the channel name or the word 'private'
 152     # or 'pvt' as capture
 153     IN_CHAN = /#{IN_ON}\s+(#{GEN_CHAN})|(here)|/
 154     IN_CHAN_PVT = /#{IN_CHAN}|in\s+(private|pvt)/
 155
 156     # As above, but with channel lists
 157     IN_CHAN_LIST_SFX = Regexp.new_list(/#{GEN_CHAN}|here/, IN_ON)
 158     IN_CHAN_LIST = /#{IN_ON}\s+#{IN_CHAN_LIST_SFX}|anywhere|everywhere/
 159     IN_CHAN_LIST_PVT_SFX = Regexp.new_list(/#{GEN_CHAN}|here|private|pvt/, IN_ON)
 160     IN_CHAN_LIST_PVT = /#{IN_ON}\s+#{IN_CHAN_LIST_PVT_SFX}|anywhere|everywhere/
 161
 162     # Match a list of nicknames separated by optional commas, whitespace and
 163     # optionally the word "and"
 164     NICK_LIST = Regexp.new_list(GEN_NICK)
 165
 166   end
 167
 168 end
 169
 170
 171 module ::Irc
 172
 173
 174   class BasicUserMessage
 175
 176     # We extend the BasicUserMessage class with a method that parses a string
 177     # which is a channel list as matched by IN_CHAN(_LIST) and co. The method
 178     # returns an array of channel names, where 'private' or 'pvt' is replaced
 179     # by the Symbol :"?", 'here' is replaced by the channel of the message or
 180     # by :"?" (depending on whether the message target is the bot or a
 181     # Channel), and 'anywhere' and 'everywhere' are replaced by Symbol :*
 182     #
 183     def parse_channel_list(string)
 184       return [:*] if [:anywhere, :everywhere].include? string.to_sym
 185       string.scan(
 186       /(?:^|,?(?:\s+and)?\s+)(?:in|on\s+)?(#{Regexp::Irc::GEN_CHAN}|here|private|pvt)/
 187                  ).map { |chan_ar|
 188         chan = chan_ar.first
 189         case chan.to_sym
 190         when :private, :pvt
 191           :"?"
 192         when :here
 193           case self.target
 194           when Channel
 195             self.target.name
 196           else
 197             :"?"
 198           end
 199         else
 200           chan
 201         end
 202       }.uniq
 203     end
 204   end
 205 end