]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/lastfm.rb
grouphug: refactor confession retrieval
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / lastfm.rb
index 45280d2fc291b9f4b1eee9de882ae8fffa0c78e8..67f8d5f78852d7eebb2ee3b8999baaabb0514d78 100644 (file)
 # License:: GPL v2
 
 require 'rexml/document'
+require 'cgi'
 
 class ::LastFmEvent
-  def initialize(url, date, artist, location, description)
-    @url = url
-    @date = date
-    @artist = artist
-    @location = location
-    @description = description
+  def initialize(hash)
+    @url = hash[:url]
+    @date = hash[:date]
+    @location = hash[:location]
+    @description = hash[:description]
+    @attendance = hash[:attendance]
+
+    @artists = hash[:artists]
+
+    if @artists.length > 10 #more than 10 artists and it floods
+      diff = @artists.length - 10
+      @artist_string = Bold + @artists[0..10].join(', ') + Bold
+      @artist_string << _(" and %{n} more...") % {:n => diff}
+    else
+      @artist_string = Bold + @artists.join(', ') + Bold
+    end
   end
 
   def compact_display
-    return "%s %s @ %s %s" % [@date.strftime("%a %b, %d %Y"), @artist, @location, @url]
+   if @attendance
+     return "%s %s @ %s (%s attending) %s" % [@date.strftime("%a %b, %d %Y"), @artist_string, @location, @attendance, @url]
+   end
+   return "%s %s @ %s %s" % [@date.strftime("%a %b, %d %Y"), @artist_string, @location, @url]
   end
   alias :to_s :compact_display
 
@@ -40,8 +54,6 @@ class LastFmPlugin < Plugin
     :default => 3, :validate => Proc.new{|v| v > 1},
     :desc => "Default number of events to display.")
 
-  LASTFM = "http://www.last.fm"
-
   APIKEY = "b25b959554ed76058ac220b7b2e0a026"
   APIURL = "http://ws.audioscrobbler.com/2.0/?api_key=#{APIKEY}&"
 
@@ -65,14 +77,18 @@ class LastFmPlugin < Plugin
       _("lastfm artist <name> => show information on artist <name> from last.fm")
     when :album
       _("lastfm album <name> => show information on album <name> from last.fm [not implemented yet]")
+    when :track
+      _("lastfm track <name> => search tracks matching <name> on last.fm")
     when :now, :np
       _("lastfm now [<user>] => show the now playing track from last.fm.  np [<user>] does the same.")
     when :set
-      _("lastfm set nick <user> => associate your current irc nick with a last.fm user. lastfm set verb <present> <past> => set your preferred now playing verb. default \"listening\" and \"listened\".")
+      _("lastfm set user <user> => associate your current irc nick with a last.fm user. lastfm set verb <present> <past> => set your preferred now playing verb. default \"listening\" and \"listened\".")
     when :who
       _("lastfm who [<nick>] => show who <nick> is at last.fm. if <nick> is empty, show who you are at lastfm.")
+    when :compare
+      _("lastfm compare <nick1> <nick2> => show musical taste compatibility between nick1 and nick2.")
     else
-      _("lastfm [<user>] => show your or <user>'s now playing track at lastfm. np [<user>] => same as 'lastfm'. lastfm <function> [<user>] => lastfm data for <user> on last.fm where <function> in [recenttracks, topartists, topalbums, toptracks, tags, friends, neighbors]. other topics: events, artist, album, now, set, who")
+      _("lastfm [<user>] => show your or <user>'s now playing track at lastfm. np [<user>] => same as 'lastfm'. other topics: events, artist, album, track, now, set, who, compare")
     end
   end
 
@@ -86,15 +102,15 @@ class LastFmPlugin < Plugin
 
     uri = nil
     if artist == nil
-      uri = URI.escape("#{APIURL}method=geo.getevents&location=#{location}")
+      uri = "#{APIURL}method=geo.getevents&location=#{CGI.escape location}"
     else
-      uri = URI.escape("#{APIURL}method=artist.getevents&artist=#{artist}")
+      uri = "#{APIURL}method=artist.getevents&artist=#{CGI.escape artist}"
     end
     xml = @bot.httputil.get_response(uri)
 
     doc = Document.new xml.body
     if xml.class == Net::HTTPInternalServerError
-      if doc.root.attributes["status"] == "failed"
+      if doc.root and doc.root.attributes["status"] == "failed"
         m.reply doc.root.elements["error"].text
       else
         m.reply _("Could not retrieve events")
@@ -103,46 +119,47 @@ class LastFmPlugin < Plugin
     disp_events = Array.new
     events = Array.new
     doc.root.elements.each("events/event"){ |e|
-      title = e.elements["title"].text
+      h = {}
+      h[:title] = e.elements["title"].text
       venue = e.elements["venue"].elements["name"].text
       city = e.elements["venue"].elements["location"].elements["city"].text
       country =  e.elements["venue"].elements["location"].elements["country"].text
-      loc = Bold + venue + Bold + " #{city}, #{country}"
+      h[:location] = Underline + venue + Underline + " #{Bold + city + Bold}, #{country}"
       date = e.elements["startDate"].text.split
-      date = Time.utc(date[3].to_i, date[2], date[1].to_i)
-      desc = e.elements["description"].text
-      url = e.elements["url"].text
+      h[:date] = Time.utc(date[3].to_i, date[2], date[1].to_i)
+      h[:desc] = e.elements["description"].text
+      h[:url] = e.elements["url"].text
+      e.detect {|node|
+        if node.kind_of? Element and node.attributes["name"] == "attendance" then
+          h[:attendance] = node.text
+        end
+      }
       artists = Array.new
       e.elements.each("artists/artist"){ |a|
         artists << a.text
       }
-      if artists.length > 10 #more than 10 artists and it floods
-       diff = artists.length - 10
-       artists = artists[0..10]
-       artists << _(" and %{n} more...") % {:n => diff}
-      end
-      artists = artists.join(", ")
-      events << LastFmEvent.new(url, date, artists, loc, desc)
+      h[:artists] = artists
+      events << LastFmEvent.new(h)
     }
     events[0...num].each { |event|
       disp_events << event.to_s
     }
     m.reply disp_events.join(' | '), :split_at => /\s+\|\s+/
 
-  end  
+  end
 
   def tasteometer(m, params)
     opts = { :cache => false }
     user1 = params[:user1].to_s
     user2 = params[:user2].to_s
-    xml = @bot.httputil.get_response("#{APIURL}method=tasteometer.compare&type1=user&type2=user&value1=#{user1}&value2=#{user2}", opts)
+    xml = @bot.httputil.get_response("#{APIURL}method=tasteometer.compare&type1=user&type2=user&value1=#{CGI.escape user1}&value2=#{CGI.escape user2}", opts)
     doc = Document.new xml.body
     unless doc
       m.reply _("last.fm parsing failed")
       return
     end
     if xml.class == Net::HTTPInternalServerError
-      if doc.root.elements["error"].attributes["code"] == "7" then 
+      if doc.root.elements["error"].attributes["code"] == "7" then
         error = doc.root.elements["error"].text
         error.match(/Invalid username: \[(.*)\]/);
         if @registry.has_key? $1 and not params[:recurs]
@@ -155,9 +172,11 @@ class LastFmPlugin < Plugin
           tasteometer(m, params)
         else
           m.reply _("%{u} doesn't exist at last.fm. Perhaps you need to: lastfm set <username>") % {:u => baduser}
+          return
         end
       else
         m.reply _("Bad: %{e}") % {:e => doc.root.element["error"].text}
+        return
       end
     end
     now = artist = track = albumtxt = date = nil
@@ -190,35 +209,48 @@ class LastFmPlugin < Plugin
     else
       user = m.sourcenick
     end
-    xml = @bot.httputil.get_response("#{APIURL}method=user.getrecenttracks&user=#{user}", opts)
+    xml = @bot.httputil.get_response("#{APIURL}method=user.getrecenttracks&user=#{CGI.escape user}", opts)
     doc = Document.new xml.body
     unless doc
       m.reply _("last.fm parsing failed")
       return
     end
     if xml.class == Net::HTTPBadRequest
-      if doc.root.elements["error"].text == "Invalid user name supplied" then 
+      if doc.root.elements["error"].text == "Invalid user name supplied" then
         if @registry.has_key? user and not params[:recurs]
           params[:who] = @registry[ user ]
           params[:recurs] = true
           now_playing(m, params)
         else
           m.reply "#{user} doesn't exist at last.fm. Perhaps you need to: lastfm set <username>"
+          return
         end
       else
         m.reply _("Error %{e}") % {:e => doc.root.element["error"].text}
+        return
       end
     end
     now = artist = track = albumtxt = date = nil
+    unless doc.root.elements[1].has_elements?
+     m.reply _("%{u} hasn't played anything recently") % {:u => user}
+     return
+    end
     first = doc.root.elements[1].elements[1]
     now = first.attributes["nowplaying"]
     artist = first.elements["artist"].text
     track = first.elements["name"].text
     albumtxt = first.elements["album"].text
-    year = get_album(artist, albumtxt)[2]
-    album = "[#{albumtxt}, #{year}] " unless albumtxt == nil or year.length == 1
-    date = first.elements["date"].attributes["uts"]
-    past = Time.at(date.to_i)
+    album = ""
+    if albumtxt
+      year = get_album(artist, albumtxt)[2]
+      album = "[#{albumtxt}, #{year}] " if year
+    end
+    past = nil
+    date = XPath.first(first, "//date")
+    if date != nil
+      time = date.attributes["uts"]
+      past = Time.at(time.to_i)
+    end
     if now == "true"
        verb = _("listening")
        if @registry.has_key? "#{m.sourcenick}_verb_present"
@@ -231,30 +263,68 @@ class LastFmPlugin < Plugin
          verb = @registry["#{m.sourcenick}_verb_past"]
        end
       ago = Utils.timeago(past)
-      m.reply _("%{u} is %{v} to \"%{t}\" by %{a} %{b}%{p}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago}
+      m.reply _("%{u} %{v} to \"%{t}\" by %{a} %{b}%{p}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago}
     end
   end
 
   def find_artist(m, params)
-    xml = @bot.httputil.get(URI.escape("#{APIURL}method=artist.getinfo&artist=#{params[:artist]}"))
+    xml = @bot.httputil.get("#{APIURL}method=artist.getinfo&artist=#{CGI.escape params[:artist].to_s}")
     unless xml
       m.reply _("I had problems getting info for %{a}.") % {:a => params[:artist]}
+      return
     end
     doc = Document.new xml
     unless doc
       m.reply _("last.fm parsing failed")
+      return
     end
     first = doc.root.elements["artist"]
     artist = first.elements["name"].text
-    playcount = first.elements["stats"].elements["plays"].text
+    playcount = first.elements["stats"].elements["playcount"].text
     listeners = first.elements["stats"].elements["listeners"].text
     summary = first.elements["bio"].elements["summary"].text
-    m.reply _("\"%{a}\" has been played %{c} times and is being listened to by %{l} people.") % {:a => artist, :c => playcount, :l => listeners}
-    m.reply summary.strip
+    m.reply _("%{b}%{a}%{b} has been played %{c} times and is being listened to by %{l} people.") % {:b => Bold, :a => artist, :c => playcount, :l => listeners}
+    m.reply summary.ircify_html
+  end
+
+  def find_track(m, params)
+    track = params[:track].to_s
+    xml = @bot.httputil.get("#{APIURL}method=track.search&track=#{CGI.escape track}")
+    unless xml
+      m.reply _("I had problems getting info for %{a}.") % {:a => track}
+      return
+    end
+    debug xml
+    doc = Document.new xml
+    unless doc
+      m.reply _("last.fm parsing failed")
+      return
+    end
+    debug doc.root
+    results = doc.root.elements["results/opensearch:totalResults"].text.to_i rescue 0
+    if results > 0
+      begin
+        hits = []
+        doc.root.each_element("results/trackmatches/track") do |track|
+          hits << _("%{bold}%{t}%{bold} by %{bold}%{a}%{bold} (%{n} listeners)") % {
+            :t => track.elements["name"].text,
+            :a => track.elements["artist"].text,
+            :n => track.elements["listeners"].text,
+            :bold => Bold
+          }
+        end
+        m.reply hits.join(' -- '), :split_at => ' -- '
+      rescue
+        error $!
+        m.reply _("last.fm parsing failed")
+      end
+    else
+      m.reply _("track %{a} not found") % {:a => track}
+    end
   end
 
   def get_album(artist, album)
-    xml = @bot.httputil.get(URI.escape("#{APIURL}method=album.getinfo&artist=#{artist}&album=#{album}"))
+    xml = @bot.httputil.get("#{APIURL}method=album.getinfo&artist=#{CGI.escape artist}&album=#{CGI.escape album}")
     unless xml
       return [_("I had problems getting album info")]
     end
@@ -268,7 +338,7 @@ class LastFmPlugin < Plugin
     playcount = first.elements["playcount"].text
     album = first.elements["name"].text
     date = first.elements["releasedate"].text
-    unless date.strip.length < 2 
+    unless date.strip.length < 2
       year = date.strip.split[2].chop
     end
     result = [artist, album, year, playcount]
@@ -298,14 +368,14 @@ class LastFmPlugin < Plugin
     key = "#{m.sourcenick}_verb_"
     @registry[ "#{key}past" ] = past
     @registry[ "#{key}present" ] = present
-    m.reply _("Ok, I'll remember that %{n} prefers %{p} and %{r}.") % {:n => m.sourcenick, :p => past, :r => present}
+    m.reply _("Ok, I'll remember that %{n} prefers %{r} and %{p}.") % {:n => m.sourcenick, :p => past, :r => present}
   end
 
   def get_user(m, params)
     nick = ""
     if params[:who]
       nick = params[:who].to_s
-    else 
+    else
       nick = m.sourcenick
     end
     if @registry.has_key? nick
@@ -316,9 +386,15 @@ class LastFmPlugin < Plugin
     end
   end
 
+  # TODO this user data retrieval should be upgraded to API 2.0 but it would need separate parsing
+  # for each dataset, or almost
   def lastfm(m, params)
     action = params[:action].intern
     action = :neighbours if action == :neighbors
+    action = :recenttracks if action == :recentracks
+    action = :topalbums if action == :topalbum
+    action = :topartists if action == :topartist
+    action = :toptags if action == :toptag
     user = nil
     if params[:user] then
       user = params[:user].to_s
@@ -348,12 +424,17 @@ plugin.map 'lastfm now', :action => :now_playing, :thread => true
 plugin.map 'np :who', :action => :now_playing, :thread => true
 plugin.map 'lastfm artist *artist', :action => :find_artist, :thread => true
 plugin.map 'lastfm album *album [by *artist]', :action => :find_album
+plugin.map 'lastfm track *track', :action => :find_track, :thread => true
 plugin.map 'lastfm set nick :who', :action => :set_user, :thread => true
+plugin.map 'lastfm set user :who', :action => :set_user, :thread => true
+plugin.map 'lastfm set username :who', :action => :set_user, :thread => true
 plugin.map 'lastfm set verb :present :past', :action => :set_verb, :thread => true
 plugin.map 'lastfm who :who', :action => :get_user, :thread => true
 plugin.map 'lastfm who', :action => :get_user, :thread => true
 plugin.map 'lastfm compare :user1 :user2', :action => :tasteometer, :thread => true
-#plugin.map 'lastfm :action :user', :thread => true
-#plugin.map 'lastfm :action', :thread => true
 plugin.map 'np', :action => :now_playing, :thread => true
-plugin.map 'lastfm', :action => :now_playing, :thread => true
+plugin.map "lastfm [user] :action [:user]", :thread => true,
+  :requirements => { :action =>
+    /^(?:events|friends|neighbou?rs|playlists|recent?tracks|top(?:album|artist|tag)s?|weekly(?:album|artist|track)chart|weeklychartlist)$/
+}
+plugin.map "lastfm [:who]", :action => :now_playing, :thread => true