]+>(.+?)<(br|/td)>}
+
+DDG_API_SEARCH = "http://api.duckduckgo.com/?format=xml&no_html=1&skip_disambig=1&no_redirect=0&q="
+
+WOLFRAM_API_SEARCH = "http://api.wolframalpha.com/v2/query?input=%{terms}&appid=%{key}&format=plaintext" +
+ "&scantimeout=3.0&podtimeout=4.0&formattimeout=8.0&parsetimeout=5.0" +
+ "&excludepodid=SeriesRepresentations:*"
+WOLFRAM_API_KEY = "4EU37Y-TX9WJG3JH3"
class SearchPlugin < Plugin
- BotConfig.register BotConfigIntegerValue.new('google.hits',
+ 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")
- BotConfig.register BotConfigIntegerValue.new('google.first_par',
+ Config.register Config::IntegerValue.new('google.first_par',
:default => 0,
:desc => "When set to n > 0, the bot will return the first paragraph from the first n search hits")
- BotConfig.register BotConfigIntegerValue.new('wikipedia.hits',
+ Config.register Config::IntegerValue.new('wikipedia.hits',
:default => 3,
:desc => "Number of hits to return from Wikipedia searches")
- BotConfig.register BotConfigIntegerValue.new('wikipedia.first_par',
+ Config.register Config::IntegerValue.new('wikipedia.first_par',
:default => 1,
:desc => "When set to n > 0, the bot will return the first paragraph from the first n wikipedia search hits")
def help(plugin, topic="")
case topic
+ when "ddg"
+ "Use '#{topic} ' to return a search or calculation from " +
+ "DuckDuckGo. Use #{topic} define to return a definition."
when "search", "google"
"#{topic} => search google for "
when "gcalc"
"gcalc => use the google calculator to find the answer to "
when "gdef"
"gdef => use the google define mechanism to find a definition of "
+ when "gtime"
+ "gtime => use the google clock to find the current time at "
+ when "wa"
+ "wa => searches WolframAlpha for "
when "wp"
"wp [] => search for on Wikipedia. You can select a national to only search the national Wikipedia"
when "unpedia"
"unpedia => search for on Uncyclopedia"
else
- "search (or: google ) => search google for | wp => search for on Wikipedia | unpedia => search for on Uncyclopedia"
+ "search (or: google ) => search google for | ddg to search DuckDuckGo | wp => search for on Wikipedia | wa => search for on WolframAlpha | unpedia => search for 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
+ abfrom = ""
+ unless abstract.empty?
+ absrc = xml.elements['//AbstractSource/text()'].to_s
+ aburl = xml.elements['//AbstractURL/text()'].to_s
+ unless absrc.empty? and aburl.empty?
+ abfrom = " --"
+ abfrom << " " << absrc unless absrc.empty?
+ abfrom << " " << aburl unless aburl.empty?
+ end
+ end
+
+ # but also definition (yes, you can have both, see e.g. printf)
+ definition = xml.elements['//Definition/text()'].to_s
+ deffrom = ""
+ unless definition.empty?
+ defsrc = xml.elements['//Definition/@source/text()'].to_s
+ defurl = xml.elements['//Definition/@url/text()'].to_s
+ unless defsrc.empty? and defurl.empty?
+ deffrom = " --"
+ deffrom << " " << defsrc unless defsrc.empty?
+ deffrom << " " << defurl unless defurl.empty?
+ end
+ 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}%{abfrom}" % {
+ :bold => Bold, :heading => heading,
+ :abstract => abstract, :abfrom => abfrom
+ }
+ end
+ unless heading.empty? or definition.empty?
+ m.reply "%{bold}%{heading}:%{bold} %{abstract}%{abfrom}" % {
+ :bold => Bold, :heading => heading,
+ :abstract => definition, :abfrom => deffrom
+ }
+ 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)
what = params[:words].to_s
+ if what.match(/^define:/)
+ return google_define(m, what, params)
+ end
+
searchfor = CGI.escape what
# This method is also called by other methods to restrict searching to some sites
if params[:site]
@@ -68,10 +209,11 @@ class SearchPlugin < Plugin
url = GOOGLE_WAP_SEARCH + site + searchfor
hits = params[:hits] || @bot.config['google.hits']
+ hits = 1 if params[:lucky]
first_pars = params[:firstpar] || @bot.config['google.first_par']
- single = (hits == 1 and first_pars == 1)
+ single = params[:lucky] || (hits == 1 and first_pars == 1)
begin
wml = @bot.httputil.get(url)
@@ -81,27 +223,61 @@ class SearchPlugin < Plugin
return
end
results = wml.scan(GOOGLE_WAP_LINK)
+
if results.length == 0
m.reply "no results found for #{what}"
return
end
+
single ||= (results.length==1)
- urls = Array.new
- results = results[0...hits].map { |res|
- n = res[0]
- t = Utils.decode_html_entities res[2].gsub(filter, '').strip
- u = URI.unescape res[1]
- urls.push(u)
- single ? u : "#{n}. #{Bold}#{t}#{Bold}: #{u}"
- }.join(" | ")
+ pretty = []
+
+ begin
+ urls = Array.new
+
+ debug results
+ results.each do |res|
+ t = res[1].ircify_html(:img => "[%{src} %{alt} %{dimensions}]").strip
+ u = res[0]
+ if u.sub!(%r{^http://www.google.com/aclk\?},'')
+ u = CGI::parse(u)['adurl'].first
+ debug "skipping ad for #{u}"
+ next
+ elsif u.sub!(%r{^http://www.google.com/gwt/x\?},'')
+ u = CGI::parse(u)['u'].first
+ elsif u.sub!(%r{^/url\?},'')
+ u = CGI::parse(u)['q'].first
+ end
+ urls.push(u)
+ pretty.push("%{n}%{b}%{t}%{b}%{sep}%{u}" % {
+ :n => (single ? "" : "#{urls.length}. "),
+ :sep => (single ? " -- " : ": "),
+ :b => Bold, :t => t, :u => u
+ })
+ break if urls.length == hits
+ end
+ rescue => e
+ m.reply "failed to understand what google found for #{what}"
+ error e
+ debug wml
+ debug results
+ return
+ end
+
+ if params[:lucky]
+ m.reply pretty.first
+ return
+ end
+
+ result_string = pretty.join(" | ")
# If we return a single, full result, change the output to a more compact representation
if single
- m.reply "Result for %s: %s -- %s" % [what, results, Utils.get_first_pars(urls, first_pars)], :overlong => :truncate
+ m.reply "Result for %s: %s -- %s" % [what, result_string, Utils.get_first_pars(urls, first_pars)], :overlong => :truncate
return
end
- m.reply "Results for #{what}: #{results}", :split_at => /\s+\|\s+/
+ m.reply "Results for #{what}: #{result_string}", :split_at => /\s+\|\s+/
return unless first_pars > 0
@@ -109,12 +285,45 @@ class SearchPlugin < Plugin
end
+ def google_define(m, what, params)
+ begin
+ wml = @bot.httputil.get(GOOGLE_SEARCH + CGI.escape(what))
+ raise unless wml
+ rescue => e
+ m.reply "error googling for #{what}"
+ return
+ end
+
+ begin
+ related_index = wml.index(/Related phrases:/, 0)
+ raise unless related_index
+ defs_index = wml.index(/Definitions of /, related_index)
+ raise unless defs_index
+ defs_end = wml.index(/ e
+ m.reply "no results found for #{what}"
+ return
+ end
+
+ related = wml[related_index...defs_index]
+ defs = wml[defs_index...defs_end]
+
+ m.reply defs.ircify_html(:a_href => Underline), :split_at => (Underline + ' ')
+
+ end
+
+ def lucky(m, params)
+ params.merge!(:lucky => true)
+ google(m, params)
+ end
+
def gcalc(m, params)
what = params[:words].to_s
searchfor = CGI.escape(what)
-
+
debug "Getting gcalc thing: #{searchfor.inspect}"
- url = GOOGLE_SEARCH + searchfor
+ url = GOOGLE_WAP_SEARCH + searchfor
begin
html = @bot.httputil.get(url)
@@ -124,24 +333,55 @@ class SearchPlugin < Plugin
end
debug "#{html.size} bytes of html recieved"
-
- results = html.scan(GOOGLE_CALC_RESULT)
+ debug html
+
+ candidates = html.match(GOOGLE_CALC_RESULT)
+ debug "candidates: #{candidates.inspect}"
+
+ if candidates.nil?
+ m.reply "couldn't calculate #{what}"
+ return
+ end
+ result = candidates[1]
+
+ debug "replying with: #{result.inspect}"
+ m.reply result.ircify_html
+ end
+
+ def gcount(m, params)
+ what = params[:words].to_s
+ searchfor = CGI.escape(what)
+
+ debug "Getting gcount thing: #{searchfor.inspect}"
+ url = GOOGLE_SEARCH + searchfor
+
+ begin
+ html = @bot.httputil.get(url)
+ rescue => e
+ m.reply "error googlecounting #{what}"
+ return
+ end
+
+ debug "#{html.size} bytes of html recieved"
+
+ results = html.scan(GOOGLE_COUNT_RESULT)
debug "results: #{results.inspect}"
-
+
if results.length != 1
- m.reply "couldn't calculate #{what}"
+ m.reply "couldn't count #{what}"
return
end
-
+
result = results[0][0].ircify_html
debug "replying with: #{result.inspect}"
- m.reply "#{result}"
+ m.reply "total results: #{result}"
+
end
def gdef(m, params)
what = params[:words].to_s
searchfor = CGI.escape("define " + what)
-
+
debug "Getting gdef thing: #{searchfor.inspect}"
url = GOOGLE_WAP_SEARCH + searchfor
@@ -155,16 +395,63 @@ class SearchPlugin < Plugin
debug html
results = html.scan(GOOGLE_DEF_RESULT)
debug "results: #{results.inspect}"
-
+
if results.length != 1
m.reply "couldn't find a definition for #{what} on Google"
return
end
-
+
head = results[0][0].ircify_html
text = results[0][1].ircify_html
- link = results[0][2]
- m.reply "#{head} -- #{link}\n#{text}"
+ m.reply "#{head} -- #{text}"
+ end
+
+ def wolfram(m, params)
+ what = params[:words].to_s
+ terms = CGI.escape what
+ url = WOLFRAM_API_SEARCH % {
+ :terms => terms, :key => WOLFRAM_API_KEY
+ }
+
+ begin
+ feed = @bot.httputil.get(url)
+ raise unless feed
+ rescue => e
+ m.reply "error asking WolframAlfa about #{what}"
+ return
+ end
+ debug feed
+
+ xml = REXML::Document.new feed
+ if xml.elements['/queryresult'].attributes['error'] == "true"
+ m.reply xml.elements['/queryresult/error/text()'].to_s
+ return
+ end
+ unless xml.elements['/queryresult'].attributes['success'] == "true"
+ m.reply "no data available"
+ return
+ end
+ answer_type, answer = [], []
+ xml.elements.each("//pod") { |element|
+ answer_type << element.attributes['title']
+ answer << element.elements['subpod/plaintext'].text
+ }
+ # find the first answer that isn't nil,
+ # starting on the second pod in the array
+ n = 1
+ answer[1..-1].each { |a|
+ break unless a.nil?
+ n += 1
+ }
+ if answer[n].nil?
+ m.reply "no results"
+ return
+ end
+ # strip spaces, pipes, and line breaks
+ sep = Bold + ' :: ' + Bold
+ chars = [ [/\n/, sep], [/\t/, " "], [/\s+/, " "], ["|", "-"] ]
+ chars.each { |c| answer[n].gsub!(c[0], c[1]) }
+ m.reply answer_type[n] + sep + answer[n]
end
def wikipedia(m, params)
@@ -187,15 +474,45 @@ class SearchPlugin < Plugin
params[:firstpar] = @bot.config['wikipedia.first_par']
return google(m, params)
end
+
+ def gtime(m, params)
+ where = params[:words].to_s
+ where.sub!(/^\s*in\s*/, '')
+ searchfor = CGI.escape("time in " + where)
+ url = GOOGLE_SEARCH + searchfor
+
+ begin
+ html = @bot.httputil.get(url)
+ rescue => e
+ m.reply "Error googletiming #{where}"
+ return
+ end
+
+ debug html
+ results = html.scan(GOOGLE_TIME_RESULT)
+ debug "results: #{results.inspect}"
+
+ if results.length != 1
+ m.reply "Couldn't find the time for #{where} on Google"
+ return
+ end
+
+ time = results[0][0].ircify_html
+ m.reply "#{time}"
+ end
end
plugin = SearchPlugin.new
-plugin.map "search *words", :action => 'google'
-plugin.map "google *words", :action => 'google'
-plugin.map "gcalc *words", :action => 'gcalc'
-plugin.map "gdef *words", :action => 'gdef'
-plugin.map "wp :lang *words", :action => 'wikipedia', :requirements => { :lang => /^\w\w\w?$/ }
-plugin.map "wp *words", :action => 'wikipedia'
-plugin.map "unpedia *words", :action => 'unpedia'
-
+plugin.map "ddg *words", :action => 'duckduckgo', :threaded => true
+plugin.map "search *words", :action => 'google', :threaded => true
+plugin.map "google *words", :action => 'google', :threaded => true
+plugin.map "lucky *words", :action => 'lucky', :threaded => true
+plugin.map "gcount *words", :action => 'gcount', :threaded => true
+plugin.map "gcalc *words", :action => 'gcalc', :threaded => true
+plugin.map "gdef *words", :action => 'gdef', :threaded => true
+plugin.map "gtime *words", :action => 'gtime', :threaded => true
+plugin.map "wa *words", :action => 'wolfram', :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
|