git.oblomov.eu Git - rbot/blob - data/rbot/plugins/bash.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: bash.org quote retrieval
   5 #
   6 # Author:: Robin Kearney <robin@riviera.org.uk>
   7 # Author:: cs
   8 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
   9 #
  10 # Copyright:: (C) 2005 Robin Kearney
  11 # Copyright:: (C) 2007 cs, Giuseppe Bilotta
  12 #
  13 # License:: public domain
  14 #
  15 # TODO improve output of quote
  16 # TODO show more than one quote
  17 # TODO allow selection of only quotes with vote > 0
  18
  19 require 'rexml/document'
  20
  21 class ::BashQuote
  22   attr_accessor :num, :text, :irc_text, :vote
  23
  24   def initialize(num, text, vote)
  25     @num = num.to_i
  26     @text = text
  27     @vote = vote
  28     @irc_text = mk_irc_text
  29   end
  30
  31   def url
  32     "http://www.bash.org/?#{@num}"
  33   end
  34
  35   def to_s
  36     "#%d (%d): %s" % [self.num, self.vote, self.irc_text]
  37   end
  38
  39   private
  40   def mk_irc_text
  41     cur_nick = nil
  42     last_nick = nil
  43     text = String.new
  44     @text.each_line { |l|
  45       debug "line: #{l.inspect}"
  46       cur_nick = l.match(/^\s*(&lt;.*?&gt;|\(.*?\)|.*?:)\s/)[1] rescue nil
  47       debug "nick: #{cur_nick.inspect}; last: #{last_nick.inspect}"
  48       if cur_nick and cur_nick == last_nick
  49         text << l.sub(cur_nick,"")
  50       else
  51         last_nick = cur_nick.dup if cur_nick
  52         text << l
  53       end
  54     }
  55     debug text
  56     # TODO: the gsub of br tags to | should be an ircify_html option
  57     text.gsub(/(?:<br \/>\s*)+/, ' | ').ircify_html
  58   end
  59
  60 end
  61
  62 class BashPlugin < Plugin
  63
  64   Config.register Config::EnumValue.new('bash.access',
  65     :values => ['xml', 'html'], :default => 'html',
  66     :desc => "Which method the bot should use to access bash.org quotes: xml files or standard webpages")
  67
  68   include REXML
  69   def help(plugin, topic="")
  70     "bash => print a random quote from bash.org, bash quote_id => print that quote id from bash.org, bash latest => print the latest quote from bash.org (currently broken, need to get josh@bash.org to fix the xml)"
  71   end
  72
  73   def bash_filter(s)
  74     # check if we like the location of the page
  75     loc = Utils.check_location(s, %r{http://(?:www\.)?bash\.org/\?})
  76     return unless loc
  77     # check if there are any quotes
  78     quotes = get_html_quotes(s[:text])
  79     return if quotes.empty?
  80     title = s[:text].ircify_html_title
  81     # return the first quote
  82     return {
  83           :title => title,
  84           :content => quotes.first.to_s,
  85           :bash_quotes => quotes
  86     }
  87   end
  88
  89   def initialize
  90     super
  91
  92     @bot.register_filter(:bash, :htmlinfo) { |s| bash_filter(s) }
  93   end
  94
  95   def bash(m, params)
  96     id = params[:id]
  97     case @bot.config['bash.access'].intern
  98     when :xml
  99       xml_bash(m, id)
 100     else
 101       html_bash(m, :id => id)
 102     end
 103   end
 104
 105   def search(m, params)
 106     esc = CGI.escape(params[:words].to_s)
 107     html = @bot.httputil.get("http://bash.org/?search=#{esc}")
 108     html_bash(m, :html => html)
 109   end
 110
 111   def get_html_quotes(html)
 112     quotes = []
 113
 114     html_quotes = html.split(/<p class="quote">/)
 115     html_quotes.each { |htqt|
 116       # debug htqt.inspect
 117       if htqt.match(/<a href="\?(\d+)"[^>]*>.*?\((-?\d+)\).*?<p class="qt">(.*)<\/p>\s+(?:<\/td>.*)?\z/m)
 118         num = $1
 119         vote = $2
 120         text = $3
 121         quotes << BashQuote.new(num, text, vote)
 122       end
 123     }
 124     return quotes
 125   end
 126
 127   def html_bash(m, opts={})
 128     html = opts[:html]
 129     if not html
 130       id = opts[:id]
 131       case id
 132       when 'latest'
 133         html = @bot.httputil.get("http://bash.org/?latest")
 134       when nil
 135         html = @bot.httputil.get("http://bash.org/?random", :cache => false)
 136       else
 137         html = @bot.httputil.get("http://bash.org/?" + id)
 138       end
 139     end
 140
 141     if not html
 142       m.reply "unable to retrieve quotes"
 143       return
 144     end
 145
 146     quotes = get_html_quotes(html)
 147
 148     case quotes.length
 149     when 0
 150       m.reply "no quotes found"
 151       return
 152     when 1
 153       quote = quotes.first
 154     else
 155       # For the time being, we only echo the first quote, but in the future we
 156       # may want to echo more than one for latest/random
 157       quote = quotes.first
 158     end
 159     m.reply quote.to_s
 160   end
 161
 162   def xml_bash(m, id=nil)
 163     case id
 164     when 'latest'
 165       xml = @bot.httputil.get("http://bash.org/xml/?latest&num=1")
 166     when nil
 167       xml = @bot.httputil.get("http://bash.org/xml/?random&num=1", :cache => false)
 168     else
 169       xml = @bot.httputil.get("http://bash.org/xml/?" + id + "&num=1")
 170     end
 171
 172     unless xml
 173       m.reply "bash.org rss parse failed"
 174       return
 175     end
 176     doc = Document.new xml
 177     unless doc
 178       m.reply "bash.org rss parse failed"
 179       return
 180     end
 181     doc.elements.each("*/item") {|e|
 182       if(id != 0)
 183         reply = e.elements["title"].text.gsub(/QDB: /,"") + " " + e.elements["link"].text.gsub(/QDB: /,"") + "\n"
 184         reply = reply + e.elements["description"].text.gsub(/\<br \/\>/, "\n")
 185       else
 186         reply = e.elements["title"].text.gsub(/QDB: /,"") + " " + e.elements["link"].text.gsub(/QDB: /,"") + "\n"
 187         reply = reply + e.elements["description"].text.gsub(/\<br \/\>/, "\n")
 188       end
 189       m.reply reply
 190     }
 191   end
 192 end
 193
 194 plugin = BashPlugin.new
 195
 196 plugin.map "bash search *words", :action => :search
 197 plugin.map "bash [:id]"
 198