]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/lastfm.rb
last.fm plugin: removed redundant mappings
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / lastfm.rb
index cd2329e09299ea753505a8780b80ce1c7270c7eb..030c5e07622358ddc77773a62fed8f7050ef9cce 100644 (file)
@@ -28,10 +28,10 @@ class ::LastFmEvent
 
     if @artists.length > 10 #more than 10 artists and it floods
       diff = @artists.length - 10
-      @artist_string = @artists[0..10].join(', ')
+      @artist_string = Bold + @artists[0..10].join(', ') + Bold
       @artist_string << _(" and %{n} more...") % {:n => diff}
     else
-      @artist_string = @artists.join(', ')
+      @artist_string = Bold + @artists.join(', ') + Bold
     end
   end
 
@@ -82,11 +82,13 @@ class LastFmPlugin < Plugin
     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/just played verbs. default \"is listening to\" and \"listened to\".")
     when :who
-      _("lastfm who [<nick>] => show who <nick> is at last.fm. if <nick> is empty, show who you are at lastfm.")
+      _("lastfm who [<nick>] => show who <nick> is on last.fm. if <nick> is empty, show who you are on lastfm.")
+    when :compare
+      _("lastfm compare [<nick1>] <nick2> => show musical taste compatibility between nick1 (or user if omitted) and nick2")
     else
-      _("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")
+      _("lastfm [<user>] => show your or <user>'s now playing track on lastfm. np [<user>] => same as 'lastfm'. other topics: events, artist, album, track, now, set, who, compare")
     end
   end
 
@@ -100,18 +102,18 @@ 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")
+        m.reply _("could not retrieve events")
       end
     end
     disp_events = Array.new
@@ -122,7 +124,7 @@ class LastFmPlugin < Plugin
       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
-      h[:location] = Bold + venue + Bold + " #{city}, #{country}"
+      h[:location] = Underline + venue + Underline + " #{Bold + city + Bold}, #{country}"
       date = e.elements["startDate"].text.split
       h[:date] = Time.utc(date[3].to_i, date[2], date[1].to_i)
       h[:desc] = e.elements["description"].text
@@ -144,36 +146,28 @@ class LastFmPlugin < Plugin
     }
     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)
+    user1 = resolve_username(m, params[:user1])
+    user2 = resolve_username(m, params[:user2])
+    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 xml.class == Net::HTTPBadRequest
+      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]
-          if user1 == $1
-            params[:user1] = @registry[ $1 ]
-          elsif user2 == $1
-            params[:user2] = @registry[ $1 ]
-          end
-          params[:recurs] = true
-          tasteometer(m, params)
-        else
-          m.reply _("%{u} doesn't exist at last.fm. Perhaps you need to: lastfm set <username>") % {:u => baduser}
-          return
-        end
+        baduser = $1
+
+        m.reply _("%{u} doesn't exist on last.fm") % {:u => baduser}
+        return
       else
-        m.reply _("Bad: %{e}") % {:e => doc.root.element["error"].text}
+        m.reply _("error: %{e}") % {:e => doc.root.element["error"].text}
         return
       end
     end
@@ -199,32 +193,21 @@ class LastFmPlugin < Plugin
 
   def now_playing(m, params)
     opts = { :cache => false }
-    user = nil
-    if params[:who]
-      user = params[:who].to_s
-    elsif @registry.has_key? m.sourcenick
-      user = @registry[ m.sourcenick ]
-    else
-      user = m.sourcenick
-    end
-    xml = @bot.httputil.get_response("#{APIURL}method=user.getrecenttracks&user=#{user}", opts)
+    user = resolve_username(m, params[:who])
+    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 @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
+      if doc.root.elements["error"].text == "Invalid user name supplied" then
+        m.reply _("%{user} doesn't exist on last.fm, perhaps they need to: lastfm 2 <username>") % {
+          :user => user
+        }
+        return
       else
-        m.reply _("Error %{e}") % {:e => doc.root.element["error"].text}
+        m.reply _("error: %{e}") % {:e => doc.root.element["error"].text}
         return
       end
     end
@@ -243,28 +226,32 @@ class LastFmPlugin < Plugin
       year = get_album(artist, albumtxt)[2]
       album = "[#{albumtxt}, #{year}] " if year
     end
-    date = first.elements["date"].attributes["uts"]
-    past = Time.at(date.to_i)
+    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")
+       verb = _("is listening to")
        if @registry.has_key? "#{m.sourcenick}_verb_present"
          verb = @registry["#{m.sourcenick}_verb_present"]
        end
-      m.reply _("%{u} is %{v} to \"%{t}\" by %{a} %{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album}
+       m.reply _("%{u} %{v} \"%{t}\" by %{a} %{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album}
     else
-      verb = _("listened")
+      verb = _("listened to")
        if @registry.has_key? "#{m.sourcenick}_verb_past"
          verb = @registry["#{m.sourcenick}_verb_past"]
        end
       ago = Utils.timeago(past)
-      m.reply _("%{u} %{v} to \"%{t}\" by %{a} %{b}%{p}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago}
+      m.reply _("%{u} %{v} \"%{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]}
+      m.reply _("I had problems getting info for %{a}") % {:a => params[:artist]}
       return
     end
     doc = Document.new xml
@@ -274,18 +261,18 @@ class LastFmPlugin < Plugin
     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(URI.escape("#{APIURL}method=track.search&track=#{CGI.escape track}"))
+    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}
+      m.reply _("I had problems getting info for %{a}") % {:a => track}
       return
     end
     debug xml
@@ -318,7 +305,7 @@ class LastFmPlugin < Plugin
   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
@@ -332,7 +319,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]
@@ -346,14 +333,14 @@ class LastFmPlugin < Plugin
       return
     end
     year = "(#{album[2]}) " unless album[2] == nil
-    m.reply _("The album \"%{a}\" by %{r} %{y}has been played %{c} times.") % {:a => album[1], :r => album[0], :y => year, :c => album[3]}
+    m.reply _("the album \"%{a}\" by %{r} %{y}has been played %{c} times") % {:a => album[1], :r => album[0], :y => year, :c => album[3]}
   end
 
   def set_user(m, params)
     user = params[:who].to_s
     nick = m.sourcenick
     @registry[ nick ] = user
-    m.reply _("Ok, I'll remember that %{n} is %{u} at last.fm") % {:n => nick, :u => user}
+    m.reply _("okay, I'll remember that %{n} is %{u} on last.fm") % {:n => nick, :u => user}
   end
 
   def set_verb(m, params)
@@ -362,21 +349,24 @@ class LastFmPlugin < Plugin
     key = "#{m.sourcenick}_verb_"
     @registry[ "#{key}past" ] = past
     @registry[ "#{key}present" ] = present
-    m.reply _("Ok, I'll remember that %{n} prefers %{r} and %{p}.") % {:n => m.sourcenick, :p => past, :r => present}
+    m.reply _("okay, 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
       user = @registry[ nick ]
-      m.reply "#{nick} is #{user} at last.fm"
+      m.reply _("%{nick} is %{user} on last.fm") % {
+        :nick => nick,
+        :user => user
+      }
     else
-      m.reply _("Sorry, I don't know who %{n} is at last.fm perhaps you need to: lastfm set <username>") % {:n => nick}
+      m.reply _("sorry, I don't know who %{n} is on last.fm, perhaps they need to: lastfm set user <username>") % {:n => nick}
     end
   end
 
@@ -389,16 +379,7 @@ class LastFmPlugin < Plugin
     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
-    elsif @registry.has_key? m.sourcenick
-      user = @registry[ m.sourcenick ]
-    else
-      # m.reply "I don't know who you are on last.fm. Use 'lastfm set username' to identify yourself."
-      # return
-      user = m.sourcenick
-    end
+    user = resolve_username(m, params[:user])
     begin
       data = @bot.httputil.get("http://ws.audioscrobbler.com/1.0/user/#{user}/#{action}.txt")
       m.reply "#{action} for #{user}:"
@@ -407,25 +388,28 @@ class LastFmPlugin < Plugin
       m.reply "could not find #{action} for #{user} (is #{user} a user?). perhaps you need to: lastfm set <username>"
     end
   end
+
+  def resolve_username(m, name)
+    name = m.sourcenick if name.nil?
+    @registry[name] or name
+  end
 end
 
 plugin = LastFmPlugin.new
 plugin.map 'lastfm [:num] event[s] in *location', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
 plugin.map 'lastfm [:num] event[s] by *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
 plugin.map 'lastfm [:num] event[s] [for] *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
-plugin.map 'lastfm now :who', :action => :now_playing, :thread => true
-plugin.map 'lastfm now', :action => :now_playing, :thread => true
+plugin.map 'lastfm [now] [:who]', :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 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 set user[name] :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 compare to :user2', :action => :tasteometer, :thread => true
+plugin.map 'lastfm compare [:user1] [to] :user2', :action => :tasteometer, :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)$/