4 # :title: Standard classes extensions
6 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
8 # This file collects extensions to standard Ruby classes and to some core rbot
9 # classes to be used by the various plugins
11 # Please note that global symbols have to be prefixed by :: because this plugin
12 # will be read into an anonymous module
14 # Extensions to the Module class
18 # Many plugins define Struct objects to hold their data. On rescans, lots of
19 # warnings are echoed because of the redefinitions. Using this method solves
20 # the problem, by checking if the Struct already exists, and if it has the
23 def define_structure(name, *members)
25 if Struct.const_defined?(sym)
26 kl = Struct.const_get(sym)
27 if kl.new.members.map { |member| member.intern } == members.map
28 debug "Struct #{sym} previously defined, skipping"
33 debug "Defining struct #{sym} with members #{members.inspect}"
34 const_set(sym, Struct.new(name.to_s, *members))
39 # DottedIndex mixin: extend a Hash or Array class with this module
40 # to achieve [] and []= methods that automatically split indices
41 # at dots (indices are automatically converted to symbols, too)
43 # You have to define the single_retrieve(_key_) and
44 # single_assign(_key_,_value_) methods (usually aliased at the
45 # original :[] and :[]= methods)
48 def rbot_index_split(*ar)
49 keys = ([] << ar).flatten
51 k.to_s.split('.').map { |kk| kk.to_sym rescue nil }.compact
56 keys = self.rbot_index_split(ar)
57 return self.single_retrieve(keys.first) if keys.length == 1
61 h[k] ||= self.class.new
70 keys = self.rbot_index_split(ar)
71 return self.single_assign(keys.first, val) if keys.length == 1
75 h[k] ||= self.class.new
83 # Extensions to the Array class
87 # This method returns a random element from the array, or nil if the array is
91 return nil if self.empty?
92 self[rand(self.length)]
95 # This method returns a given element from the array, deleting it from the
96 # array itself. The method returns nil if the element couldn't be found.
98 # If nil is specified, a random element is returned and deleted.
100 def delete_one(val=nil)
101 return nil if self.empty?
103 index = rand(self.length)
105 index = self.index(val)
106 return nil unless index
108 self.delete_at(index)
111 # This method deletes a given object _el_ if it's found at the given
112 # position _pos_. The position can be either an integer or a range.
113 def delete_if_at(el, pos)
122 # Taken from Ruby backports:
123 # shuffle and shuffle! are defined in Ruby >= 1.8.7
125 # This method returns a new array with the
126 # same items as the receiver, but shuffled
129 end unless method_defined? :shuffle
133 r = i + Kernel.rand(size - i)
134 self[i], self[r] = self[r], self[i]
137 end unless method_defined? :shuffle!
141 # This method is an advanced version of #join
142 # allowing fine control of separators:
144 # [1,2,3].conjoin(', ', ' and ')
147 # [1,2,3,4].conjoin{ |i, a, b| i % 2 == 0 ? '.' : '-' }
150 # Code lifted from the ruby facets project:
151 # <http://facets.rubyforge.org>
152 # git-rev: c8b7395255b977d3c7de268ff563e3c5bc7f1441
153 # file: lib/core/facets/array/conjoin.rb
154 def conjoin(*args, &block)
157 return first.to_s if num < 1
163 sep << yield(i, *slice(i, 2))
166 options = (Hash === args.last) ? args.pop : {}
167 separator = args.shift || ""
168 options[-1] = args.shift unless args.empty?
170 sep = [separator] * num
172 if options.key?(:last)
173 options[-1] = options.delete(:last)
175 options[-1] ||= _(" and ")
177 options.each{ |i, s| sep[i] = s }
184 # Extensions to the Range class
188 # This method returns a random number between the lower and upper bound
191 len = self.last - self.first
192 len += 1 unless self.exclude_end?
193 self.first + Kernel::rand(len)
195 alias :rand :pick_one
198 # Extensions for the Numeric classes
202 # This method forces a real number to be not more than a given positive
203 # number or not less than a given positive number, or between two any given
206 def clip(left,right=0)
207 raise ArgumentError unless left.kind_of?(Numeric) and right.kind_of?(Numeric)
216 # Extensions to the String class
218 # TODO make riphtml() just call ircify_html() with stronger purify options.
222 # This method will return a purified version of the receiver, with all HTML
223 # stripped off and some of it converted to IRC formatting
225 def ircify_html(opts={})
229 txt.gsub!(/<script(?:\s+[^>]*)?>.*?<\/script>/im, "")
232 txt.gsub!(/<style(?:\s+[^>]*)?>.*?<\/style>/im, "")
234 # bold and strong -> bold
235 txt.gsub!(/<\/?(?:b|strong)(?:\s+[^>]*)?>/im, "#{Bold}")
237 # italic, emphasis and underline -> underline
238 txt.gsub!(/<\/?(?:i|em|u)(?:\s+[^>]*)?>/im, "#{Underline}")
240 ## This would be a nice addition, but the results are horrible
241 ## Maybe make it configurable?
242 # txt.gsub!(/<\/?a( [^>]*)?>/, "#{Reverse}")
243 case val = opts[:a_href]
244 when Reverse, Bold, Underline
245 txt.gsub!(/<(?:\/a\s*|a (?:[^>]*\s+)?href\s*=\s*(?:[^>]*\s*)?)>/, val)
247 # Not good for nested links, but the best we can do without something like hpricot
248 txt.gsub!(/<a (?:[^>]*\s+)?href\s*=\s*(?:([^"'>][^\s>]*)\s+|"((?:[^"]|\\")*)"|'((?:[^']|\\')*)')(?:[^>]*\s+)?>(.*?)<\/a>/) { |match|
250 debug [$1, $2, $3, $4].inspect
251 link = $1 || $2 || $3
256 warning "unknown :a_href option #{val} passed to ircify_html" if val
259 # If opts[:img] is defined, it should be a String. Each image
260 # will be replaced by the string itself, replacing occurrences of
261 # %{alt} %{dimensions} and %{src} with the alt text, image dimensions
264 if val.kind_of? String
265 txt.gsub!(/<img\s+(.*?)\s*\/?>/) do |imgtag|
267 imgtag.scan(/([[:alpha:]]+)\s*=\s*(['"])?(.*?)\2/) do |key, quote, value|
268 k = key.downcase.intern rescue 'junk'
271 attrs[:alt] ||= attrs[:title]
272 attrs[:width] ||= '...'
273 attrs[:height] ||= '...'
274 attrs[:dimensions] ||= "#{attrs[:width]}x#{attrs[:height]}"
278 warning ":img option is not a string"
282 # Paragraph and br tags are converted to whitespace
283 txt.gsub!(/<\/?(p|br)(?:\s+[^>]*)?\s*\/?\s*>/i, ' ')
287 # Superscripts and subscripts are turned into ^{...} and _{...}
288 # where the {} are omitted for single characters
289 txt.gsub!(/<sup>(.*?)<\/sup>/, '^{\1}')
290 txt.gsub!(/<sub>(.*?)<\/sub>/, '_{\1}')
291 txt.gsub!(/(^|_)\{(.)\}/, '\1\2')
293 # List items are converted to *). We don't have special support for
294 # nested or ordered lists.
295 txt.gsub!(/<li>/, ' *) ')
297 # All other tags are just removed
298 txt.gsub!(/<[^>]+>/, '')
300 # Convert HTML entities. We do it now to be able to handle stuff
302 txt = Utils.decode_html_entities(txt)
304 # Keep unbreakable spaces or conver them to plain spaces?
305 case val = opts[:nbsp]
307 txt.gsub!([160].pack('U'), ' ')
309 warning "unknown :nbsp option #{val} passed to ircify_html" if val
312 # Remove double formatting options, since they only waste bytes
313 txt.gsub!(/#{Bold}(\s*)#{Bold}/, '\1')
314 txt.gsub!(/#{Underline}(\s*)#{Underline}/, '\1')
316 # Simplify whitespace that appears on both sides of a formatting option
317 txt.gsub!(/\s+(#{Bold}|#{Underline})\s+/, ' \1')
318 txt.sub!(/\s+(#{Bold}|#{Underline})\z/, '\1')
319 txt.sub!(/\A(#{Bold}|#{Underline})\s+/, '\1')
321 # And finally whitespace is squeezed
322 txt.gsub!(/\s+/, ' ')
325 if opts[:limit] && txt.size > opts[:limit]
326 txt = txt.slice(0, opts[:limit]) + "#{Reverse}...#{Reverse}"
329 # Decode entities and strip whitespace
333 # As above, but modify the receiver
335 def ircify_html!(opts={})
337 replace self.ircify_html(opts)
338 return self unless self.hash == old_hash
341 # This method will strip all HTML crud from the receiver
344 Utils.decode_html_entities(self.gsub("\n",' ').gsub(/<\s*br\s*\/?\s*>/, ' ').gsub(/<[^>]+>/, '')).gsub(/\s+/,' ')
347 # This method tries to find an HTML title in the string,
348 # and returns it if found
350 if defined? ::Hpricot
351 Hpricot(self).at("title").inner_html
353 return unless Irc::Utils::TITLE_REGEX.match(self)
358 # This method returns the IRC-formatted version of an
359 # HTML title found in the string
360 def ircify_html_title
361 self.get_html_title.ircify_html rescue nil
364 # This method is used to wrap a nonempty String by adding
365 # the prefix and postfix
366 def wrap_nonempty(pre, post, opts={})
370 "#{pre}#{self}#{post}"
374 # Format a string using IRC colors
379 txt.gsub!(/\*([^\*]+)\*/, Bold + '\\1' + NormalText)
385 # Extensions to the Regexp class, with some common and/or complex regular
390 # A method to build a regexp that matches a list of something separated by
391 # optional commas and/or the word "and", an optionally repeated prefix,
393 def Regexp.new_list(reg, pfx = "")
394 if pfx.kind_of?(String) and pfx.empty?
395 return %r(#{reg}(?:,?(?:\s+and)?\s+#{reg})*)
397 return %r(#{reg}(?:,?(?:\s+and)?(?:\s+#{pfx})?\s+#{reg})*)
404 # Match a list of channel anmes separated by optional commas, whitespace
405 # and optionally the word "and"
406 CHAN_LIST = Regexp.new_list(GEN_CHAN)
408 # Match "in #channel" or "on #channel" and/or "in private" (optionally
409 # shortened to "in pvt"), returning the channel name or the word 'private'
410 # or 'pvt' as capture
411 IN_CHAN = /#{IN_ON}\s+(#{GEN_CHAN})|(here)|/
412 IN_CHAN_PVT = /#{IN_CHAN}|in\s+(private|pvt)/
414 # As above, but with channel lists
415 IN_CHAN_LIST_SFX = Regexp.new_list(/#{GEN_CHAN}|here/, IN_ON)
416 IN_CHAN_LIST = /#{IN_ON}\s+#{IN_CHAN_LIST_SFX}|anywhere|everywhere/
417 IN_CHAN_LIST_PVT_SFX = Regexp.new_list(/#{GEN_CHAN}|here|private|pvt/, IN_ON)
418 IN_CHAN_LIST_PVT = /#{IN_ON}\s+#{IN_CHAN_LIST_PVT_SFX}|anywhere|everywhere/
420 # Match a list of nicknames separated by optional commas, whitespace and
421 # optionally the word "and"
422 NICK_LIST = Regexp.new_list(GEN_NICK)
432 class BasicUserMessage
434 # We extend the BasicUserMessage class with a method that parses a string
435 # which is a channel list as matched by IN_CHAN(_LIST) and co. The method
436 # returns an array of channel names, where 'private' or 'pvt' is replaced
437 # by the Symbol :"?", 'here' is replaced by the channel of the message or
438 # by :"?" (depending on whether the message target is the bot or a
439 # Channel), and 'anywhere' and 'everywhere' are replaced by Symbol :*
441 def parse_channel_list(string)
442 return [:*] if [:anywhere, :everywhere].include? string.to_sym
444 /(?:^|,?(?:\s+and)?\s+)(?:in|on\s+)?(#{Regexp::Irc::GEN_CHAN}|here|private|pvt)/
463 # The recurse depth of a message, for fake messages. 0 means an original
466 unless defined? @recurse_depth
472 # Set the recurse depth of a message, for fake messages. 0 should only
473 # be used by original messages
474 def recurse_depth=(val)
482 # Maximum fake message recursion
483 MAX_RECURSE_DEPTH = 10
485 class RecurseTooDeep < RuntimeError
489 # Sometimes plugins need to create a new fake message based on an existing
490 # message: for example, this is done by alias, linkbot, reaction and remotectl.
492 # This method simplifies the message creation, including a recursion depth
495 # In the options you can specify the :bot, the :server, the :source,
496 # the :target, the message :class and whether or not to :delegate. To
497 # initialize these entries from an existing message, you can use :from
499 # Additionally, if :from is given, the reply method of created message
500 # is overriden to reply to :from instead. The #in_thread attribute
501 # for created mesage is also copied from :from
503 # If you don't specify a :from you should specify a :source.
505 def fake_message(string, opts={})
506 if from = opts[:from]
508 :bot => from.bot, :server => from.server, :source => from.source,
509 :target => from.target, :class => from.class, :delegate => true,
510 :depth => from.recurse_depth + 1
514 :bot => @bot, :server => @bot.server, :target => @bot.myself,
515 :class => PrivMessage, :delegate => true, :depth => 1
518 raise RecurseTooDeep if o[:depth] > MAX_RECURSE_DEPTH
519 new_m = o[:class].new(o[:bot], o[:server], o[:source], o[:target], string)
520 new_m.recurse_depth = o[:depth]
522 # the created message will reply to the originating message, but we
523 # must remember to set 'replied' on the fake message too, to
524 # prevent infinite loops that could be created for example with the reaction
525 # plugin by setting up a reaction to ping with cmd:ping
528 end.send(:define_method, :reply) do |*args|
529 debug "replying to '#{from.message}' with #{args.first}"
533 # the created message will follow originating message's in_thread
534 new_m.in_thread = from.in_thread if from.respond_to?(:in_thread)
536 return new_m unless o[:delegate]
537 method = o[:class].to_s.gsub(/^Irc::|Message$/,'').downcase
538 method = 'privmsg' if method == 'priv'
539 o[:bot].plugins.irc_delegate(method, new_m)