]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/imdb.rb
imdb plugin: command to display the characters (and actors) in a given movie
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / imdb.rb
index 3f750793cc1969a86e38a34ce0ebdb679e5b4163..240ded86303cfb35420bc2b1d37dee588ee09d9d 100644 (file)
@@ -18,17 +18,28 @@ class Imdb
   TITLE_OR_NAME_MATCH = /<a href="(\/(?:title|name)\/(?:tt|nm)[0-9]+\/?)[^"]*"(?:[^>]*)>([^<]*)<\/a>/
   TITLE_MATCH = /<a href="(\/title\/tt[0-9]+\/?)[^"]*"(?:[^>]*)>([^<]*)<\/a>/
   NAME_MATCH = /<a href="(\/name\/nm[0-9]+\/?)[^"]*"(?:[^>]*)>([^<]*)<\/a>/
+  CREDIT_NAME_MATCH = /#{NAME_MATCH}<\/td><td[^>]+> \.\.\. <\/td><td[^>]+>(.+?)<\/td>/
+  FINAL_ARTICLE_MATCH = /, ([A-Z]\S{0,2})$/
+
+  MATCHER = {
+    :title => TITLE_MATCH,
+    :name => NAME_MATCH,
+    :both => TITLE_OR_NAME_MATCH
+  }
 
   def initialize(bot)
     @bot = bot
   end
 
-  def search(rawstr)
-    str = URI.escape(rawstr) << ";site=aka"
-    return do_search(str)
+  def search(rawstr, rawopts={})
+    str = URI.escape(rawstr)
+    str << ";site=aka" if @bot.config['imdb.aka']
+    opts = rawopts.dup
+    opts[:type] = :both unless opts[:type]
+    return do_search(str, opts)
   end
 
-  def do_search(str)
+  def do_search(str, opts={})
     resp = nil
     begin
       resp = @bot.httputil.get_response(IMDB + "/find?q=#{str}",
@@ -39,11 +50,14 @@ class Imdb
       return nil
     end
 
+
+    matcher = MATCHER[opts[:type]]
+
     if resp.code == "200"
       m = []
-      m << TITLE_OR_NAME_MATCH.match(resp.body) if @bot.config['imdb.popular']
+      m << matcher.match(resp.body) if @bot.config['imdb.popular']
       if resp.body.match(/\(Exact Matches\)<\/b>/) and @bot.config['imdb.exact']
-        m << TITLE_OR_NAME_MATCH.match($')
+        m << matcher.match($')
       end
       m.compact!
       unless m.empty?
@@ -55,7 +69,7 @@ class Imdb
       debug "automatic redirection"
       new_loc = resp['location'].gsub(IMDB, "")
       if new_loc.match(/\/find\?q=(.*)/)
-        return do_search($1)
+        return do_search($1, opts)
       else
         return [new_loc.gsub(/\?.*/, "")]
       end
@@ -63,8 +77,9 @@ class Imdb
     return nil
   end
 
-  def info(rawstr)
-    urls = search(rawstr)
+  def info(rawstr, opts={})
+    debug opts.inspect
+    urls = search(rawstr, opts)
     debug urls
     if urls.nil_or_empty?
       debug "IMDB: search returned NIL"
@@ -75,9 +90,9 @@ class Imdb
       type = sr.match(/^\/([^\/]+)\//)[1].downcase.intern rescue nil
       case type
       when :title
-        results << info_title(sr)
+        results << info_title(sr, opts)
       when :name
-        results << info_name(sr)
+        results << info_name(sr, opts)
       else
         results << "#{sr}"
       end
@@ -89,7 +104,24 @@ class Imdb
     /<div class="info">\s+<h5>#{info}:<\/h5>\s+(.*?)<\/div>/mi.match(body)[1] rescue nil
   end
 
-  def info_title(sr)
+  def fix_article(org_tit)
+    title = org_tit.dup
+    debug title.inspect
+    if title.match(/^"(.*)"$/)
+      return "\"#{fix_article($1)}\""
+    end
+    if @bot.config['imdb.fix_article'] and title.gsub!(FINAL_ARTICLE_MATCH, '')
+      art = $1.dup
+      debug art.inspect
+      if art[-1,1].match(/[A-Za-z]/)
+        art << " "
+      end
+      return art + title
+    end
+    return title
+  end
+
+  def info_title(sr, opts={})
     resp = nil
     begin
       resp = @bot.httputil.get_response(IMDB + sr, :max_redir => -1)
@@ -105,25 +137,35 @@ class Imdb
       m = /<title>([^<]*)<\/title>/.match(resp.body)
       return nil if !m
       title_date = m[1]
-      title, date, extra = title_date.scan(/^(.*)\((\d\d\d\d(?:[IV]+)?)\)\s*(.+)?$/).first
-      title.strip!
+      pre_title, date, extra = title_date.scan(/^(.*)\((\d\d\d\d(?:\/[IV]+)?)\)\s*(.+)?$/).first
+      pre_title.strip!
+      title = fix_article(pre_title.ircify_html)
 
       dir = nil
       data = grab_info(/Directors?/, resp.body)
       if data
         dir = data.scan(NAME_MATCH).map { |url, name|
-          name
+          name.ircify_html
         }.join(', ')
       end
 
       country = nil
       data = grab_info(/Country/, resp.body)
       if data
-        country = data.ircify_html
+        country = data.ircify_html.gsub(' / ','/')
       end
 
       info << [title, "(#{country}, #{date})", extra, dir ? "[#{dir}]" : nil, ": http://us.imdb.com#{sr}"].compact.join(" ")
 
+      return info if opts[:title_only]
+
+      if opts[:characters]
+        info << resp.body.scan(CREDIT_NAME_MATCH).map { |url, name, role|
+          "%s: %s" % [name, role]
+        }.join('; ')
+        return info
+      end
+
       ratings = "no votes"
       m = /<b>([0-9.]+)\/10<\/b>\n?\r?\s+<small>\(<a href="ratings">([0-9,]+) votes?<\/a>\)<\/small>/.match(resp.body)
       if m
@@ -148,7 +190,7 @@ class Imdb
     return nil
   end
 
-  def info_name(sr)
+  def info_name(sr, opts={})
     resp = nil
     begin
       resp = @bot.httputil.get_response(IMDB + sr, :max_redir => -1)
@@ -167,6 +209,16 @@ class Imdb
 
       info << "#{name} : http://us.imdb.com#{sr}"
 
+      return info if opts[:name_only]
+
+      if year = opts[:movies_in_year]
+        filmoyear = @bot.httputil.get(IMDB + sr + "filmoyear")
+        if filmoyear
+          info << filmoyear.scan(/#{TITLE_MATCH} \(#{year}\)[^\[\n]*((?:\s+\[[^\]]+\](?:\s+\([^\[<]+\))*)+)\s+</)
+        end
+        return info
+      end
+
       birth = nil
       data = grab_info("Date of Birth", resp.body)
       if data
@@ -194,7 +246,7 @@ class Imdb
           what = str.match(/<a name="[^"]+">([^<]+)<\/a>/)[1] rescue nil
           next unless what
           movies[what] = str.scan(TITLE_MATCH)[0..2].map { |url, tit|
-            tit
+            fix_article(tit.ircify_html)
           }
         }
       end
@@ -227,38 +279,195 @@ class Imdb
     end
     return nil
   end
+
+  def year_movies(urls, year)
+    urls.map { |url|
+      info = info_name(url, :movies_in_year => year)
+
+      debug info.inspect
+
+      name_url = info.first
+      data = info[1]
+
+      movies = []
+      # Sort by pre-title putting movies before TV series
+      data.sort { |a, b|
+        aclip = a[1][0,5]
+        bclip = b[1][0,5]
+        quot = '&#34;'
+        (aclip == quot ? 1 : -1) <=> (bclip == quot ? 1 : -1)
+      }.each { |url, pre_title, pre_roles|
+        title = fix_article(pre_title.ircify_html)
+        if title[0] == ?" and not @bot.config['imdb.tv_series_in_movies']
+          next
+        end
+        role_array = []
+        pre_roles.strip.scan(/\[([^\]]+)\]((?:\s+\([^\[]+\))+)?/) { |txt, comm|
+          if txt.match(/^(.*)\s+\.\.\.\.\s+(.*)$/)
+            role_array << "#{$1} (#{$2})"
+          else
+            role_array << txt
+          end
+          role_array.last << " " + comm.ircify_html if comm
+        }
+
+        roles = role_array.join(', ')
+        movies << [roles, title].join(": ")
+      }
+
+      if movies.empty?
+        [name_url, nil]
+      else
+        [name_url, movies.join(" | ")]
+      end
+    }
+  end
+
+  def name_in_movie(name_urls, movie_urls)
+    info = []
+    movie_urls.each { |movie|
+      title_info = info_title(movie, :title_only => true)
+      valid = []
+
+      data = @bot.httputil.get(IMDB + movie + "fullcredits")
+      data.scan(CREDIT_NAME_MATCH).each { |url, name, role|
+        valid << [url, name.ircify_html, role.ircify_html] if name_urls.include?(url)
+      }
+      valid.each { |url, name, role|
+        info << "%s : %s was %s in %s" % [name, IMDB + url, role, title_info]
+      }
+    }
+    return info
+  end
+
+
 end
 
 class ImdbPlugin < Plugin
+  BotConfig.register BotConfigBooleanValue.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',
     :default => true,
     :desc => "Display info on popular IMDB entries matching the request closely")
   BotConfig.register BotConfigBooleanValue.new('imdb.exact',
     :default => true,
     :desc => "Display info on IMDB entries matching the request exactly")
+  BotConfig.register BotConfigBooleanValue.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',
+    :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>"
+    "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"
   end
 
+  attr_reader :i
+
+  def initialize
+    super
+    @i = Imdb.new(@bot)
+  end
+
+  # Find a person or movie on IMDB. A :type (name/title, default both) can be
+  # specified to limit the search to either.
+  #
   def imdb(m, params)
-    what = params[:what].to_s
-    i = Imdb.new(@bot)
-    info = i.info(what)
-    if !info
-      m.reply "Nothing found for #{what}"
-      return nil
+    if params[:movie]
+      movie = params[:movie].to_s
+      info = i.info(movie, :type => :title, :characters => true)
+    else
+      what = params[:what].to_s
+      type = params[:type].intern
+      info = i.info(what, :type => type)
+      if !info
+        m.reply "nothing found for #{what}"
+        return nil
+      end
     end
     if info.length == 1
       m.reply Utils.decode_html_entities info.first.join("\n")
     else
-      m.reply info.map { |i|
-        Utils.decode_html_entities i.join(" | ")
+      m.reply info.map { |si|
+        Utils.decode_html_entities si.join(" | ")
       }.join("\n")
     end
   end
+
+  # Find the movies with a participation of :who in the year :year
+  # TODO: allow year to be either a year or a decade ('[in the] 1960s') 
+  #
+  def movies(m, params)
+    who = params[:who].to_s
+    year = params[:year]
+
+    name_urls = i.search(who, :type => :name)
+    unless name_urls
+      m.reply "nothing found about #{who}, sorry"
+      return
+    end
+
+    movie_urls = i.year_movies(name_urls, year)
+    debug movie_urls.inspect
+    debug movie_urls[0][1]
+
+    if movie_urls.length == 1 and movie_urls[0][1]
+      m.reply movie_urls.join("\n")
+    else
+      m.reply movie_urls.map { |si|
+        si[1] = "no movies in #{year}" unless si[1]
+        Utils.decode_html_entities si.join(" | ")
+      }.join("\n")
+    end
+  end
+
+  # Find the character played by :who in :movie
+  #
+  def character(m, params)
+    who = params[:who].to_s
+    movie = params[:movie].to_s
+
+    name_urls = i.search(who, :type => :name)
+    unless name_urls
+      m.reply "nothing found about #{who}, sorry"
+      return
+    end
+
+    movie_urls = i.search(movie, :type => :title)
+    unless movie_urls
+      m.reply "nothing found about #{who}, sorry"
+      return
+    end
+
+    info = i.name_in_movie(name_urls, movie_urls)
+    if info.empty?
+      m.reply "nothing found about #{who} in #{movie}, sorry"
+    else
+      m.reply info.join("\n")
+    end
+  end
+
+  # Report the characters in movie :movie
+  #
+  def characters(m, params)
+    movie = params[:movie].to_s
+
+    urls = i.search(movie, :type => :title)
+    unless urls
+      m.reply "nothing found about #{movie}"
+    end
+
+  end
+
 end
 
 plugin = ImdbPlugin.new
-plugin.map "imdb *what"
+
+plugin.map "imdb [:type] *what", :requirements => { :type => /name|title/ }, :defaults => { :type => 'both' }
+plugin.map "movies :prefix *who in :year", :requirements => { :prefix => /with|by|from/, :year => /\d+/ }
+plugin.map "character [played] by *who in *movie"
+plugin.map "character of *who in *movie"
+plugin.map "characters in *movie", :action => :imdb