]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/search.rb
search: some ddg reworking
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / search.rb
index f54c0df6bbadf558a8627783177315c22d0d674b..3a12d30c949e783be05740329e569d5b0f812d78 100644 (file)
 
 GOOGLE_SEARCH = "http://www.google.com/search?oe=UTF-8&q="
 GOOGLE_WAP_SEARCH = "http://www.google.com/m/search?hl=en&q="
-GOOGLE_WAP_LINK = /result">(?:<div[^>]*>)?<a href="([^"]+)"[^>]*>(.*?)<\/a>/im
-GOOGLE_CALC_RESULT = %r{<img src=/images/calc_img\.gif(?: width=40 height=30 alt="")?>.*?<h[1-6] class=r[^>]*><b>(.+?)</b>}
+GOOGLE_WAP_LINK = /"r">(?:<div[^>]*>)?<a href="([^"]+)"[^>]*>(.*?)<\/a>/im
+GOOGLE_CALC_RESULT = %r{<h[1-6] class="r" [^>]*>(.+?)</h}
 GOOGLE_COUNT_RESULT = %r{<font size=-1>Results <b>1<\/b> - <b>10<\/b> of about <b>(.*)<\/b> for}
 GOOGLE_DEF_RESULT = %r{onebox_result">\s*(.*?)\s*<br/>\s*(.*?)<table}
 GOOGLE_TIME_RESULT = %r{alt="Clock"></td><td valign=[^>]+>(.+?)<(br|/td)>}
 
+DDG_API_SEARCH = "http://api.duckduckgo.com/?format=xml&no_html=1&skip_disambig=1&no_redirect=0&q="
+
 class SearchPlugin < Plugin
+  Config.register Config::IntegerValue.new('duckduckgo.hits',
+    :default => 3, :validate => Proc.new{|v| v > 0},
+    :desc => "Number of hits to return from searches")
+  Config.register Config::IntegerValue.new('duckduckgo.first_par',
+    :default => 0,
+    :desc => "When set to n > 0, the bot will return the first paragraph from the first n search hits")
   Config.register Config::IntegerValue.new('google.hits',
     :default => 3,
     :desc => "Number of hits to return from Google searches")
@@ -39,6 +47,9 @@ class SearchPlugin < Plugin
 
   def help(plugin, topic="")
     case topic
+    when "ddg"
+      "Use '#{topic} <string>' to return a search or calculation from " +
+      "DuckDuckGo. Use #{topic} define <string> to return a definition."
     when "search", "google"
       "#{topic} <string> => search google for <string>"
     when "gcalc"
@@ -52,8 +63,110 @@ class SearchPlugin < Plugin
     when "unpedia"
       "unpedia <string> => search for <string> on Uncyclopedia"
     else
-      "search <string> (or: google <string>) => search google for <string> | wp <string> => search for <string> on Wikipedia | unpedia <string> => search for <string> on Uncyclopedia"
+      "search <string> (or: google <string>) => search google for <string> | ddg <string> to search DuckDuckGo | wp <string> => search for <string> on Wikipedia | unpedia <string> => search for <string> on Uncyclopedia"
+    end
+  end
+
+  def duckduckgo(m, params)
+    what = params[:words].to_s
+    terms = CGI.escape what
+    url = DDG_API_SEARCH + terms
+
+    hits = @bot.config['duckduckgo.hits']
+    first_pars = params[:firstpar] || @bot.config['duckduckgo.first_par']
+    single = params[:lucky] || (hits == 1 and first_pars == 1)
+
+    begin
+      feed = @bot.httputil.get(url)
+      raise unless feed
+    rescue => e
+      m.reply "error duckduckgoing for #{what}"
+      return
+    end
+    debug feed
+
+    xml = REXML::Document.new feed
+    heading = xml.elements['//Heading/text()'].to_s
+    # answer is returned for calculations
+    answer = xml.elements['//Answer/text()'].to_s
+    # abstract is returned for definitions etc
+    abstract = xml.elements['//AbstractText/text()'].to_s
+    unless abstract.empty?
+      absrc = xml.elements['//AbstractSource/text()']
+      aburl = xml.elements['//AbstractURL/text()']
+    end
+    # but also definition (yes, you can have both, see e.g. printf)
+    definition = xml.elements['//Definition/text()'].to_s
+    unless definition.empty?
+      defsrc = xml.elements['//Definition/@source/text()'].to_s
+      defurl = xml.elements['//Definition/@url/text()'].to_s
+    end
+
+    if heading.empty? and answer.empty? and abstract.empty? and definition.empty?
+      m.reply "no results"
+      return
+    end
+
+    # if we got a one-shot answer (e.g. a calculation, return it)
+    unless answer.empty?
+      m.reply answer
+      return
+    end
+
+    # otherwise, return the abstract, followed by as many hits as found
+    unless heading.empty? or abstract.empty?
+      m.reply "%{bold}%{heading}:%{bold} %{abstract} -- %{absrc} %{aburl}" % {
+        :bold => Bold, :heading => heading,
+        :abstract => abstract, :absrc => absrc, :aburl => aburl
+      }
+    end
+    unless heading.empty? or definition.empty?
+      m.reply "%{bold}%{heading}:%{bold} %{abstract} -- %{absrc} %{aburl}" % {
+        :bold => Bold, :heading => heading,
+        :abstract => definition, :absrc => defsrc, :aburl => defurl
+      }
+    end
+    # return zeroclick search results
+    links, texts = [], []
+    xml.elements.each("//Results/Result/FirstURL") { |element|
+      links << element.text
+      break if links.size == hits
+    }
+    return if links.empty?
+
+    xml.elements.each("//Results/Result/Text") { |element|
+      texts << " #{element.text}"
+      break if links.size == hits
+    }
+    # TODO see treatment of `single` in google search
+
+    single ||= (links.length == 1)
+    pretty = []
+    links.each_with_index do |u, i|
+      t = texts[i]
+      pretty.push("%{n}%{b}%{t}%{b}%{sep}%{u}" % {
+        :n => (single ? "" : "#{i}. "),
+        :sep => (single ? " -- " : ": "),
+        :b => Bold, :t => t, :u => u
+      })
+    end
+
+    result_string = pretty.join(" | ")
+
+    # If we return a single, full result, change the output to a more compact representation
+    if single
+      fp = first_pars > 0 ? " --  #{Utils.get_first_pars(links, first_pars)}" : ""
+      m.reply("Result for %{what}: %{string}%{fp}" % {
+        :what => what, :string => result_string, :fp => fp
+      }, :overlong => :truncate)
+      return
     end
+
+    m.reply "Results for #{what}: #{result_string}", :split_at => /\s+\|\s+/
+
+    return unless first_pars > 0
+
+    Utils.get_first_pars urls, first_pars, :message => m
   end
 
   def google(m, params)
@@ -202,7 +315,7 @@ class SearchPlugin < Plugin
     debug "#{html.size} bytes of html recieved"
     debug html
 
-    candidates = html.match(/font-weight:bold">(.*?)<\/(?:span|div)>/)
+    candidates = html.match(GOOGLE_CALC_RESULT)
     debug "candidates: #{candidates.inspect}"
 
     if candidates.nil?
@@ -323,6 +436,7 @@ end
 
 plugin = SearchPlugin.new
 
+plugin.map "ddg *words", :action => 'duckduckgo'
 plugin.map "search *words", :action => 'google', :threaded => true
 plugin.map "google *words", :action => 'google', :threaded => true
 plugin.map "lucky *words", :action => 'lucky', :threaded => true
@@ -333,4 +447,3 @@ plugin.map "gtime *words", :action => 'gtime', :threaded => true
 plugin.map "wp :lang *words", :action => 'wikipedia', :requirements => { :lang => /^\w\w\w?$/ }, :threaded => true
 plugin.map "wp *words", :action => 'wikipedia', :threaded => true
 plugin.map "unpedia *words", :action => 'unpedia', :threaded => true
-