weather plugin: refactor HTML cleanup code

[user/henk/code/ruby/rbot.git] / data / rbot / plugins / imdb.rb

diff --git a/data/rbot/plugins/imdb.rb b/data/rbot/plugins/imdb.rb
index 8c46f3fe24fae918000cbbd5fab0130e51a5296c..84d0bb17254589365866961e21e5c6394d738cb6 100644 (file)
--- a/data/rbot/plugins/imdb.rb
+++ b/data/rbot/plugins/imdb.rb
@@ -11,8 +11,6 @@
 #
 # License:: MIT license
 
-require 'uri/common'
-
 class Imdb
   IMDB = "http://us.imdb.com"
   TITLE_OR_NAME_MATCH = /<a href="(\/(?:title|name)\/(?:tt|nm)[0-9]+\/?)[^"]*"(?:[^>]*)>([^<]*)<\/a>/
@@ -280,7 +278,7 @@ class Imdb
     return nil
   end
 
-  def year_movies(urls, years_txt_org)
+  def year_movies(urls, years_txt_org, role_req)
     years_txt = years_txt_org.dup
     years_txt.sub!(/^'/,'')
     years_txt = "9#{years_txt}" if years_txt.match(/^\d\ds?$/)
@@ -321,16 +319,32 @@ class Imdb
         title << " (#{year})" unless years.length == 1
         role_array = []
         pre_roles.strip.scan(/\[([^\]]+)\]((?:\s+\([^\[]+\))+)?/) { |txt, comm|
+          role = nil
+          extra = nil
           if txt.match(/^(.*)\s+\.\.\.\.\s+(.*)$/)
-            role_array << "#{$1} (#{$2})"
+            role = $1
+            extra = "(#{$2.ircify_html})"
           else
-            role_array << txt
+            role = txt
+          end
+          next if role_req and not role.match(/^#{role_req}/i)
+          if comm
+            extra ||= ""
+            extra += comm.ircify_html if comm
           end
-          role_array.last << " " + comm.ircify_html if comm
+          role_array << [role, extra]
         }
+        next if role_req and role_array.empty?
 
-        roles = role_array.join(', ')
-        movies << [roles, title].join(": ")
+        roles = role_array.map { |ar|
+          if role_req
+            ar[1] # works for us both if it's nil and if it's something
+          else
+            ar.compact.join(" ")
+          end
+        }.compact.join(', ')
+        roles = nil if roles.empty?
+        movies << [roles, title].compact.join(": ")
       }
 
       if movies.empty?
@@ -362,24 +376,31 @@ class Imdb
 end
 
 class ImdbPlugin < Plugin
-  BotConfig.register BotConfigBooleanValue.new('imdb.aka',
+  Config.register Config::BooleanValue.new('imdb.aka',
     :default => true,
     :desc => "Look for IMDB matches also in translated titles and other 'also known as' information")
-  BotConfig.register BotConfigBooleanValue.new('imdb.popular',
+  Config.register Config::BooleanValue.new('imdb.popular',
     :default => true,
     :desc => "Display info on popular IMDB entries matching the request closely")
-  BotConfig.register BotConfigBooleanValue.new('imdb.exact',
+  Config.register Config::BooleanValue.new('imdb.exact',
     :default => true,
     :desc => "Display info on IMDB entries matching the request exactly")
-  BotConfig.register BotConfigBooleanValue.new('imdb.fix_article',
+  Config.register Config::BooleanValue.new('imdb.fix_article',
     :default => false,
     :desc => "Try to detect an article placed at the end and move it in front of the title")
-  BotConfig.register BotConfigBooleanValue.new('imdb.tv_series_in_movies',
+  Config.register Config::BooleanValue.new('imdb.tv_series_in_movies',
     :default => false,
     :desc => "Whether searching movies by person/year should also return TV series")
 
   def help(plugin, topic="")
-    "imdb <string> => search http://www.imdb.org for <string>: prefix <string> with 'name' or 'title' if you only want to search for people or films respectively, e.g.: imdb name ed wood"
+    case plugin
+    when "movies"
+      "movies by <who> in <years> [as <role>] => display the movies in the <years> where which <who> was <role>; <role> can be one of actor, actress, director or anything: if it's omitted, the role is defined by the prefix: \"movies by ...\" implies director, \"movies with ...\" implies actor or actress; the years can be specified as \"in the 60s\" or as \"in 1953\""
+    when /characters?/
+      "character played by <who> in <movie> => show the character played by <who> in movie <movie>. characters in <movie> => show the actors and characters in movie <movie>"
+    else
+      "imdb <string> => search http://www.imdb.org for <string>: prefix <string> with 'name' or 'title' if you only want to search for people or films respectively, e.g.: imdb name ed wood. see also movies and characters"
+    end
   end
 
   attr_reader :i
@@ -406,7 +427,7 @@ class ImdbPlugin < Plugin
       end
     end
     if info.length == 1
-      m.reply Utils.decode_html_entities info.first.join("\n")
+      m.reply Utils.decode_html_entities(info.first.join("\n"))
     else
       m.reply info.map { |si|
         Utils.decode_html_entities si.join(" | ")
@@ -420,6 +441,17 @@ class ImdbPlugin < Plugin
   def movies(m, params)
     who = params[:who].to_s
     years = params[:years]
+    role = params[:role]
+    if role and role.downcase == 'anything'
+      role = nil
+    elsif not role
+      case params[:prefix].intern
+      when :with
+        role = /actor|actress/i
+      when :by
+        role = 'director'
+      end
+    end
 
     name_urls = i.search(who, :type => :name)
     unless name_urls
@@ -427,7 +459,7 @@ class ImdbPlugin < Plugin
       return
     end
 
-    movie_urls = i.year_movies(name_urls, years)
+    movie_urls = i.year_movies(name_urls, years, role)
     debug movie_urls.inspect
     debug movie_urls[0][1]
 
@@ -484,7 +516,7 @@ end
 plugin = ImdbPlugin.new
 
 plugin.map "imdb [:type] *what", :requirements => { :type => /name|title/ }, :defaults => { :type => 'both' }
-plugin.map "movies :prefix *who in [the] :years", :requirements => { :prefix => /with|by|from/, :years => /'?\d+s?/ }
+plugin.map "movies :prefix *who in [the] :years [as :role]", :requirements => { :prefix => /with|by|from/, :years => /'?\d+s?/ }
 plugin.map "character [played] by *who in *movie"
 plugin.map "character of *who in *movie"
 plugin.map "characters in *movie", :action => :imdb