lib/rbot/core/utils/utils.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: rbot utilities provider
   5 #
   6 # Author:: Tom Gilbert <tom@linuxbrit.co.uk>
   7 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
   8 #
   9 # Copyright:: (C) 2002-2006 Tom Gilbert
  10 # Copyright:: (C) 2007 Giuseppe Bilotta
  11 #
  12 # TODO some of these Utils should be rewritten as extensions to the approriate
  13 # standard Ruby classes and accordingly be moved to extends.rb
  14
  15 require 'tempfile'
  16 require 'set'
  17
  18 # Try to load htmlentities, fall back to an HTML escape table.
  19 begin
  20   require 'htmlentities'
  21 rescue LoadError
  22   gems = nil
  23   begin
  24     gems = require 'rubygems'
  25   rescue LoadError
  26     gems = false
  27   end
  28   if gems
  29     retry
  30   else
  31     module ::Irc
  32       module Utils
  33         UNESCAPE_TABLE = {
  34     'laquo' => '<<',
  35     'raquo' => '>>',
  36     'quot' => '"',
  37     'apos' => '\'',
  38     'micro' => 'u',
  39     'copy' => '(c)',
  40     'trade' => '(tm)',
  41     'reg' => '(R)',
  42     '#174' => '(R)',
  43     '#8220' => '"',
  44     '#8221' => '"',
  45     '#8212' => '--',
  46     '#39' => '\'',
  47     'amp' => '&',
  48     'lt' => '<',
  49     'gt' => '>',
  50     'hellip' => '...',
  51     'nbsp' => ' ',
  52 =begin
  53     # extras codes, for future use...
  54     'zwnj' => '&#8204;',
  55     'aring' => '\xe5',
  56     'gt' => '>',
  57     'yen' => '\xa5',
  58     'ograve' => '\xf2',
  59     'Chi' => '&#935;',
  60     'bull' => '&#8226;',
  61     'Egrave' => '\xc8',
  62     'Ntilde' => '\xd1',
  63     'upsih' => '&#978;',
  64     'Yacute' => '\xdd',
  65     'asymp' => '&#8776;',
  66     'radic' => '&#8730;',
  67     'otimes' => '&#8855;',
  68     'nabla' => '&#8711;',
  69     'aelig' => '\xe6',
  70     'oelig' => '&#339;',
  71     'equiv' => '&#8801;',
  72     'Psi' => '&#936;',
  73     'auml' => '\xe4',
  74     'circ' => '&#710;',
  75     'Acirc' => '\xc2',
  76     'Epsilon' => '&#917;',
  77     'Yuml' => '&#376;',
  78     'Eta' => '&#919;',
  79     'Icirc' => '\xce',
  80     'Upsilon' => '&#933;',
  81     'ndash' => '&#8211;',
  82     'there4' => '&#8756;',
  83     'Prime' => '&#8243;',
  84     'prime' => '&#8242;',
  85     'psi' => '&#968;',
  86     'Kappa' => '&#922;',
  87     'rsaquo' => '&#8250;',
  88     'Tau' => '&#932;',
  89     'darr' => '&#8595;',
  90     'ocirc' => '\xf4',
  91     'lrm' => '&#8206;',
  92     'zwj' => '&#8205;',
  93     'cedil' => '\xb8',
  94     'Ecirc' => '\xca',
  95     'not' => '\xac',
  96     'AElig' => '\xc6',
  97     'oslash' => '\xf8',
  98     'acute' => '\xb4',
  99     'lceil' => '&#8968;',
 100     'shy' => '\xad',
 101     'rdquo' => '&#8221;',
 102     'ge' => '&#8805;',
 103     'Igrave' => '\xcc',
 104     'Ograve' => '\xd2',
 105     'euro' => '&#8364;',
 106     'dArr' => '&#8659;',
 107     'sdot' => '&#8901;',
 108     'nbsp' => '\xa0',
 109     'lfloor' => '&#8970;',
 110     'lArr' => '&#8656;',
 111     'Auml' => '\xc4',
 112     'larr' => '&#8592;',
 113     'Atilde' => '\xc3',
 114     'Otilde' => '\xd5',
 115     'szlig' => '\xdf',
 116     'clubs' => '&#9827;',
 117     'diams' => '&#9830;',
 118     'agrave' => '\xe0',
 119     'Ocirc' => '\xd4',
 120     'Iota' => '&#921;',
 121     'Theta' => '&#920;',
 122     'Pi' => '&#928;',
 123     'OElig' => '&#338;',
 124     'Scaron' => '&#352;',
 125     'frac14' => '\xbc',
 126     'egrave' => '\xe8',
 127     'sub' => '&#8834;',
 128     'iexcl' => '\xa1',
 129     'frac12' => '\xbd',
 130     'sbquo' => '&#8218;',
 131     'ordf' => '\xaa',
 132     'sum' => '&#8721;',
 133     'prop' => '&#8733;',
 134     'Uuml' => '\xdc',
 135     'ntilde' => '\xf1',
 136     'sup' => '&#8835;',
 137     'theta' => '&#952;',
 138     'prod' => '&#8719;',
 139     'nsub' => '&#8836;',
 140     'hArr' => '&#8660;',
 141     'rlm' => '&#8207;',
 142     'THORN' => '\xde',
 143     'infin' => '&#8734;',
 144     'yuml' => '\xff',
 145     'Mu' => '&#924;',
 146     'le' => '&#8804;',
 147     'Eacute' => '\xc9',
 148     'thinsp' => '&#8201;',
 149     'ecirc' => '\xea',
 150     'bdquo' => '&#8222;',
 151     'Sigma' => '&#931;',
 152     'fnof' => '&#402;',
 153     'Aring' => '\xc5',
 154     'tilde' => '&#732;',
 155     'frac34' => '\xbe',
 156     'emsp' => '&#8195;',
 157     'mdash' => '&#8212;',
 158     'uarr' => '&#8593;',
 159     'permil' => '&#8240;',
 160     'Ugrave' => '\xd9',
 161     'rarr' => '&#8594;',
 162     'Agrave' => '\xc0',
 163     'chi' => '&#967;',
 164     'forall' => '&#8704;',
 165     'eth' => '\xf0',
 166     'rceil' => '&#8969;',
 167     'iuml' => '\xef',
 168     'gamma' => '&#947;',
 169     'lambda' => '&#955;',
 170     'harr' => '&#8596;',
 171     'rang' => '&#9002;',
 172     'xi' => '&#958;',
 173     'dagger' => '&#8224;',
 174     'divide' => '\xf7',
 175     'Ouml' => '\xd6',
 176     'image' => '&#8465;',
 177     'alefsym' => '&#8501;',
 178     'igrave' => '\xec',
 179     'otilde' => '\xf5',
 180     'Oacute' => '\xd3',
 181     'sube' => '&#8838;',
 182     'alpha' => '&#945;',
 183     'frasl' => '&#8260;',
 184     'ETH' => '\xd0',
 185     'lowast' => '&#8727;',
 186     'Nu' => '&#925;',
 187     'plusmn' => '\xb1',
 188     'Euml' => '\xcb',
 189     'real' => '&#8476;',
 190     'sup1' => '\xb9',
 191     'sup2' => '\xb2',
 192     'sup3' => '\xb3',
 193     'Oslash' => '\xd8',
 194     'Aacute' => '\xc1',
 195     'cent' => '\xa2',
 196     'oline' => '&#8254;',
 197     'Beta' => '&#914;',
 198     'perp' => '&#8869;',
 199     'Delta' => '&#916;',
 200     'loz' => '&#9674;',
 201     'pi' => '&#960;',
 202     'iota' => '&#953;',
 203     'empty' => '&#8709;',
 204     'euml' => '\xeb',
 205     'brvbar' => '\xa6',
 206     'iacute' => '\xed',
 207     'para' => '\xb6',
 208     'micro' => '\xb5',
 209     'cup' => '&#8746;',
 210     'weierp' => '&#8472;',
 211     'uuml' => '\xfc',
 212     'part' => '&#8706;',
 213     'icirc' => '\xee',
 214     'delta' => '&#948;',
 215     'omicron' => '&#959;',
 216     'upsilon' => '&#965;',
 217     'Iuml' => '\xcf',
 218     'Lambda' => '&#923;',
 219     'Xi' => '&#926;',
 220     'kappa' => '&#954;',
 221     'ccedil' => '\xe7',
 222     'Ucirc' => '\xdb',
 223     'cap' => '&#8745;',
 224     'mu' => '&#956;',
 225     'scaron' => '&#353;',
 226     'lsquo' => '&#8216;',
 227     'isin' => '&#8712;',
 228     'Zeta' => '&#918;',
 229     'supe' => '&#8839;',
 230     'deg' => '\xb0',
 231     'and' => '&#8743;',
 232     'tau' => '&#964;',
 233     'pound' => '\xa3',
 234     'hellip' => '&#8230;',
 235     'curren' => '\xa4',
 236     'int' => '&#8747;',
 237     'ucirc' => '\xfb',
 238     'rfloor' => '&#8971;',
 239     'ensp' => '&#8194;',
 240     'crarr' => '&#8629;',
 241     'ugrave' => '\xf9',
 242     'notin' => '&#8713;',
 243     'exist' => '&#8707;',
 244     'uArr' => '&#8657;',
 245     'cong' => '&#8773;',
 246     'Dagger' => '&#8225;',
 247     'oplus' => '&#8853;',
 248     'times' => '\xd7',
 249     'atilde' => '\xe3',
 250     'piv' => '&#982;',
 251     'ni' => '&#8715;',
 252     'Phi' => '&#934;',
 253     'lsaquo' => '&#8249;',
 254     'Uacute' => '\xda',
 255     'Omicron' => '&#927;',
 256     'ang' => '&#8736;',
 257     'ne' => '&#8800;',
 258     'iquest' => '\xbf',
 259     'eta' => '&#951;',
 260     'yacute' => '\xfd',
 261     'Rho' => '&#929;',
 262     'uacute' => '\xfa',
 263     'Alpha' => '&#913;',
 264     'zeta' => '&#950;',
 265     'Omega' => '&#937;',
 266     'nu' => '&#957;',
 267     'sim' => '&#8764;',
 268     'sect' => '\xa7',
 269     'phi' => '&#966;',
 270     'sigmaf' => '&#962;',
 271     'macr' => '\xaf',
 272     'minus' => '&#8722;',
 273     'Ccedil' => '\xc7',
 274     'ordm' => '\xba',
 275     'epsilon' => '&#949;',
 276     'beta' => '&#946;',
 277     'rArr' => '&#8658;',
 278     'rho' => '&#961;',
 279     'aacute' => '\xe1',
 280     'eacute' => '\xe9',
 281     'omega' => '&#969;',
 282     'middot' => '\xb7',
 283     'Gamma' => '&#915;',
 284     'Iacute' => '\xcd',
 285     'lang' => '&#9001;',
 286     'spades' => '&#9824;',
 287     'rsquo' => '&#8217;',
 288     'uml' => '\xa8',
 289     'thorn' => '\xfe',
 290     'ouml' => '\xf6',
 291     'thetasym' => '&#977;',
 292     'or' => '&#8744;',
 293     'raquo' => '\xbb',
 294     'acirc' => '\xe2',
 295     'ldquo' => '&#8220;',
 296     'hearts' => '&#9829;',
 297     'sigma' => '&#963;',
 298     'oacute' => '\xf3',
 299 =end
 300         }
 301       end
 302     end
 303   end
 304 end
 305
 306
 307 module ::Irc
 308
 309   # miscellaneous useful functions
 310   module Utils
 311     @@bot = nil unless defined? @@bot
 312     @@safe_save_dir = nil unless defined?(@@safe_save_dir)
 313
 314     def Utils.bot
 315       @@bot
 316     end
 317
 318     def Utils.bot=(b)
 319       debug "initializing utils"
 320       @@bot = b
 321       @@safe_save_dir = "#{@@bot.botclass}/safe_save"
 322     end
 323
 324
 325     SEC_PER_MIN = 60
 326     SEC_PER_HR = SEC_PER_MIN * 60
 327     SEC_PER_DAY = SEC_PER_HR * 24
 328     SEC_PER_MNTH = SEC_PER_DAY * 30
 329     SEC_PER_YR = SEC_PER_MNTH * 12
 330
 331     def Utils.secs_to_string_case(array, var, string, plural)
 332       case var
 333       when 1
 334         array << "1 #{string}"
 335       else
 336         array << "#{var} #{plural}"
 337       end
 338     end
 339
 340     # turn a number of seconds into a human readable string, e.g
 341     # 2 days, 3 hours, 18 minutes, 10 seconds
 342     def Utils.secs_to_string(secs)
 343       ret = []
 344       years, secs = secs.divmod SEC_PER_YR
 345       secs_to_string_case(ret, years, _("year"), _("years")) if years > 0
 346       months, secs = secs.divmod SEC_PER_MNTH
 347       secs_to_string_case(ret, months, _("month"), _("months")) if months > 0
 348       days, secs = secs.divmod SEC_PER_DAY
 349       secs_to_string_case(ret, days, _("day"), _("days")) if days > 0
 350       hours, secs = secs.divmod SEC_PER_HR
 351       secs_to_string_case(ret, hours, _("hour"), _("hours")) if hours > 0
 352       mins, secs = secs.divmod SEC_PER_MIN
 353       secs_to_string_case(ret, mins, _("minute"), _("minutes")) if mins > 0
 354       secs = secs.to_i
 355       secs_to_string_case(ret, secs, _("second"), _("seconds")) if secs > 0 or ret.empty?
 356       case ret.length
 357       when 0
 358         raise "Empty ret array!"
 359       when 1
 360         return ret.to_s
 361       else
 362         return [ret[0, ret.length-1].join(", ") , ret[-1]].join(_(" and "))
 363       end
 364     end
 365
 366
 367     def Utils.safe_exec(command, *args)
 368       IO.popen("-") {|p|
 369         if(p)
 370           return p.readlines.join("\n")
 371         else
 372           begin
 373             $stderr.reopen($stdout)
 374             exec(command, *args)
 375           rescue Exception => e
 376             puts "exec of #{command} led to exception: #{e.pretty_inspect}"
 377             Kernel::exit! 0
 378           end
 379           puts "exec of #{command} failed"
 380           Kernel::exit! 0
 381         end
 382       }
 383     end
 384
 385
 386     def Utils.safe_save(file)
 387       raise 'No safe save directory defined!' if @@safe_save_dir.nil?
 388       basename = File.basename(file)
 389       temp = Tempfile.new(basename,@@safe_save_dir)
 390       temp.binmode
 391       yield temp if block_given?
 392       temp.close
 393       File.rename(temp.path, file)
 394     end
 395
 396
 397     def Utils.decode_html_entities(str)
 398       if defined? ::HTMLEntities
 399         return HTMLEntities.decode_entities(str)
 400       else
 401         str.gsub(/(&(.+?);)/) {
 402           symbol = $2
 403           # remove the 0-paddng from unicode integers
 404           if symbol =~ /#(.+)/
 405             symbol = "##{$1.to_i.to_s}"
 406           end
 407
 408           # output the symbol's irc-translated character, or a * if it's unknown
 409           UNESCAPE_TABLE[symbol] || [symbol[/\d+/].to_i].pack("U") rescue '*'
 410         }
 411       end
 412     end
 413
 414     HX_REGEX = /<h(\d)(?:\s+[^>]*)?>(.*?)<\/h\1>/im
 415     PAR_REGEX = /<p(?:\s+[^>]*)?>.*?<\/?(?:p|div|html|body|table|td|tr)(?:\s+[^>]*)?>/im
 416
 417     # Some blogging and forum platforms use spans or divs with a 'body' or 'message' or 'text' in their class
 418     # to mark actual text
 419     AFTER_PAR1_REGEX = /<\w+\s+[^>]*(?:body|message|text)[^>]*>.*?<\/?(?:p|div|html|body|table|td|tr)(?:\s+[^>]*)?>/im
 420
 421     # At worst, we can try stuff which is comprised between two <br>
 422     AFTER_PAR2_REGEX = /<br(?:\s+[^>]*)?\/?>.*?<\/?(?:br|p|div|html|body|table|td|tr)(?:\s+[^>]*)?\/?>/im
 423
 424     # Try to grab and IRCify the first HTML par (<p> tag) in the given string.
 425     # If possible, grab the one after the first heading
 426     #
 427     # It is possible to pass some options to determine how the stripping
 428     # occurs. Currently supported options are
 429     #   * :strip => Regex or String to strip at the beginning of the obtained
 430     #               text
 431     #   * :min_spaces => Minimum number of spaces a paragraph should have
 432     #
 433     def Utils.ircify_first_html_par(xml_org, opts={})
 434       xml = xml_org.gsub(/<!--.*?-->/m, '').gsub(/<script(?:\s+[^>]*)?>.*?<\/script>/im, "").gsub(/<style(?:\s+[^>]*)?>.*?<\/style>/im, "")
 435
 436       strip = opts[:strip]
 437       strip = Regexp.new(/^#{Regexp.escape(strip)}/) if strip.kind_of?(String)
 438
 439       min_spaces = opts[:min_spaces] || 8
 440       min_spaces = 0 if min_spaces < 0
 441
 442       txt = String.new
 443
 444       while true
 445         debug "Minimum number of spaces: #{min_spaces}"
 446         header_found = xml.match(HX_REGEX)
 447         if header_found
 448           header_found = $'
 449           while txt.empty? or txt.count(" ") < min_spaces
 450             candidate = header_found[PAR_REGEX]
 451             break unless candidate
 452             txt = candidate.ircify_html
 453             header_found = $'
 454             txt.sub!(strip, '') if strip
 455             debug "(Hx attempt) #{txt.inspect} has #{txt.count(" ")} spaces"
 456           end
 457         end
 458
 459         return txt unless txt.empty? or txt.count(" ") < min_spaces
 460
 461         # If we haven't found a first par yet, try to get it from the whole
 462         # document
 463         header_found = xml
 464         while txt.empty? or txt.count(" ") < min_spaces
 465           candidate = header_found[PAR_REGEX]
 466           break unless candidate
 467           txt = candidate.ircify_html
 468           header_found = $'
 469           txt.sub!(strip, '') if strip
 470           debug "(par attempt) #{txt.inspect} has #{txt.count(" ")} spaces"
 471         end
 472
 473         return txt unless txt.empty? or txt.count(" ") < min_spaces
 474
 475         # Nothing yet ... let's get drastic: we look for non-par elements too,
 476         # but only for those that match something that we know is likely to
 477         # contain text
 478
 479         # Attempt #1
 480         header_found = xml
 481         while txt.empty? or txt.count(" ") < min_spaces
 482           candidate = header_found[AFTER_PAR1_REGEX]
 483           break unless candidate
 484           txt = candidate.ircify_html
 485           header_found = $'
 486           txt.sub!(strip, '') if strip
 487           debug "(other attempt \#1) #{txt.inspect} has #{txt.count(" ")} spaces"
 488         end
 489
 490         return txt unless txt.empty? or txt.count(" ") < min_spaces
 491
 492         # Attempt #2
 493         header_found = xml
 494         while txt.empty? or txt.count(" ") < min_spaces
 495           candidate = header_found[AFTER_PAR2_REGEX]
 496           break unless candidate
 497           txt = candidate.ircify_html
 498           header_found = $'
 499           txt.sub!(strip, '') if strip
 500           debug "(other attempt \#2) #{txt.inspect} has #{txt.count(" ")} spaces"
 501         end
 502
 503         debug "Last candidate #{txt.inspect} has #{txt.count(" ")} spaces"
 504         return txt unless txt.count(" ") < min_spaces
 505         min_spaces /= 2
 506       end
 507     end
 508
 509     # Get the first pars of the first _count_ _urls_.
 510     # The pages are downloaded using the bot httputil service.
 511     # Returns an array of the first paragraphs fetched.
 512     # If (optional) _opts_ :message is specified, those paragraphs are
 513     # echoed as replies to the IRC message passed as _opts_ :message
 514     #
 515     def Utils.get_first_pars(urls, count, opts={})
 516       idx = 0
 517       msg = opts[:message]
 518       retval = Array.new
 519       while count > 0 and urls.length > 0
 520         url = urls.shift
 521         idx += 1
 522
 523         # FIXME what happens if some big file is returned? We should share
 524         # code with the url plugin to only retrieve partial file content!
 525         xml = self.bot.httputil.get(url)
 526         if xml.nil?
 527           debug "Unable to retrieve #{url}"
 528           next
 529         end
 530         par = Utils.ircify_first_html_par(xml, opts)
 531         if par.empty?
 532           debug "No first par found\n#{xml}"
 533           # FIXME only do this if the 'url' plugin is loaded
 534           # TODO even better, put the code here
 535           # par = @bot.plugins['url'].get_title_from_html(xml)
 536           if par.empty?
 537             retval.push(nil)
 538             next
 539           end
 540         end
 541         msg.reply "[#{idx}] #{par}", :overlong => :truncate if msg
 542         count -=1
 543         retval.push(par)
 544       end
 545       return retval
 546     end
 547
 548   end
 549 end
 550
 551 Irc::Utils.bot = Irc::Plugins.manager.bot