X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=data%2Frbot%2Fplugins%2Flastfm.rb;h=9be57d1617e9e18016f767c0a0df397a88da8df4;hb=ff452ad1bf111025f0661274ac7fb8b2f769a293;hp=a9a0a582c99e946655aae50788d0989b38cb73fc;hpb=0d7db1134621991016be58af3ec44c910abc7958;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git

diff --git a/data/rbot/plugins/lastfm.rb b/data/rbot/plugins/lastfm.rb
index a9a0a582..9be57d16 100644
--- a/data/rbot/plugins/lastfm.rb
+++ b/data/rbot/plugins/lastfm.rb
@@ -6,10 +6,12 @@
 # Author:: Jeremy Voorhis
 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
 # Author:: Casey Link <unnamedrambler@gmail.com>
+# Author:: Raine Virta <rane@kapsi.fi>
 #
 # Copyright:: (C) 2005 Jeremy Voorhis
 # Copyright:: (C) 2007 Giuseppe Bilotta
 # Copyright:: (C) 2008 Casey Link
+# Copyright:: (C) 2009 Raine Virta
 #
 # License:: GPL v2
 
@@ -36,7 +38,7 @@ class ::LastFmEvent
   end
 
   def compact_display
-   if @attendance
+   unless @attendance.zero?
      return "%s %s @ %s (%s attending) %s" % [@date.strftime("%a, %b %d"), @artist_string, @location, @attendance, @url]
    end
    return "%s %s @ %s %s" % [@date.strftime("%a, %b %d"), @artist_string, @location, @url]
@@ -53,6 +55,18 @@ class LastFmPlugin < Plugin
   Config.register Config::IntegerValue.new('lastfm.default_events',
     :default => 3, :validate => Proc.new{|v| v > 1},
     :desc => "Default number of events to display.")
+  Config.register Config::IntegerValue.new('lastfm.max_shouts',
+    :default => 5, :validate => Proc.new{|v| v > 1},
+    :desc => "Maximum number of user shouts to display.")
+  Config.register Config::IntegerValue.new('lastfm.default_shouts',
+    :default => 3, :validate => Proc.new{|v| v > 1},
+    :desc => "Default number of user shouts to display.")
+  Config.register Config::IntegerValue.new('lastfm.max_user_data',
+    :default => 25, :validate => Proc.new{|v| v > 1},
+    :desc => "Maximum number of user data entries (except events and shouts) to display.")
+  Config.register Config::IntegerValue.new('lastfm.default_user_data',
+    :default => 10, :validate => Proc.new{|v| v > 1},
+    :desc => "Default number of user data entries (except events and shouts) to display.")
 
   APIKEY = "b25b959554ed76058ac220b7b2e0a026"
   APIURL = "http://ws.audioscrobbler.com/2.0/?api_key=#{APIKEY}&"
@@ -70,6 +84,7 @@ class LastFmPlugin < Plugin
   end
 
   def help(plugin, topic="")
+    period = _(", where <period> can be one of: 3|6|12 months, a year")
     case (topic.intern rescue nil)
     when :event, :events
       _("lastfm [<num>] events in <location> => show information on events in or near <location>. lastfm [<num>] events by <artist/group> => show information on events by <artist/group>. The number of events <num> that can be displayed is optional, defaults to %{d} and cannot be higher than %{m}") % {:d => @bot.config['lastfm.default_events'], :m => @bot.config['lastfm.max_events']}
@@ -80,15 +95,37 @@ class LastFmPlugin < Plugin
     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.")
+      _("lastfm now [<nick>] => show the now playing track from last.fm. np [<nick>] does the same.")
     when :set
       _("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 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")
+    when :shouts
+      _("lastfm shouts [<nick>] => show shouts to <nick>")
+    when :friends
+      _("lastfm friends [<nick>] => show <nick>'s friends")
+    when :neighbors, :neighbours
+      _("lastfm neighbors [<nick>] => show people who share similar musical taste as <nick>")
+    when :lovedtracks
+      _("lastfm loved[tracks] [<nick>] => show tracks that <nick> has loved")
+    when :recenttracks, :recentracks
+      _("lastfm recent[tracks] [<nick>] => show tracks that <nick> has recently played")
+    when :topalbums
+      _("lastfm topalbums [<nick>] [over <period>] => show <nick>'s top albums%{p}") % { :p => period }
+    when :topartists
+      _("lastfm topartists [<nick>] [over <period>] => show <nick>'s top artists%{p}") % { :p => period }
+    when :toptracks
+      _("lastfm toptracks [<nick>] [over <period>] => show <nick>'s top tracks%{p}") % { :p => period }
+    when :weeklyalbumchart
+      _("lastfm weeklyalbumchart [<nick>] => show <nick>'s weekly album chart")
+    when :weeklyartistchart
+      _("lastfm weeklyartistchart [<nick>] => show <nick>'s weekly artist chart")
+    when :weeklytrackchart
+      _("lastfm weeklyartistchart [<nick>] => show <nick>'s weekly track chart")
     else
-      _("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")
+      _("last.fm plugin - topics: events, artist, album, track, now, set, who, compare, shouts, friends, neighbors, (loved|recent)tracks, top(albums|tracks|artists), weekly(album|artist|track)chart")
     end
   end
 
@@ -96,17 +133,19 @@ class LastFmPlugin < Plugin
     num = params[:num] || @bot.config['lastfm.default_events']
     num = num.to_i.clip(1, @bot.config['lastfm.max_events'])
 
-    location = artist = nil
-    location = params[:location].to_s if params[:location]
-    artist = params[:who].to_s if params[:who]
+    location = params[:location]
+    artist = params[:who]
+    user = resolve_username(m, params[:user])
 
-    uri = nil
-    if artist == nil
-      uri = "#{APIURL}method=geo.getevents&location=#{CGI.escape location}"
-      emptymsg = _("no events found in %{location}") % {:location => location}
-    else
-      uri = "#{APIURL}method=artist.getevents&artist=#{CGI.escape artist}"
-      emptymsg = _("no events found by %{artist}") % {:artist => artist}
+    if location
+      uri = "#{APIURL}method=geo.getevents&location=#{CGI.escape location.to_s}"
+      emptymsg = _("no events found in %{location}") % {:location => location.to_s}
+    elsif artist
+      uri = "#{APIURL}method=artist.getevents&artist=#{CGI.escape artist.to_s}"
+      emptymsg = _("no events found by %{artist}") % {:artist => artist.to_s}
+    elsif user
+      uri = "#{APIURL}method=user.getevents&user=#{CGI.escape user}"
+      emptymsg = _("%{user} is not attending any events") % {:user => user}
     end
     xml = @bot.httputil.get_response(uri)
 
@@ -131,11 +170,7 @@ class LastFmPlugin < Plugin
       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
-      }
+      h[:attendance] = e.elements["attendance"].text.to_i
       artists = Array.new
       e.elements.each("artists/artist"){ |a|
         artists << a.text
@@ -219,7 +254,7 @@ class LastFmPlugin < Plugin
     end
     if xml.class == Net::HTTPBadRequest
       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>") % {
+        m.reply _("%{user} doesn't exist on last.fm, perhaps they need to: lastfm user <username>") % {
           :user => user
         }
         return
@@ -266,22 +301,39 @@ class LastFmPlugin < Plugin
   end
 
   def find_artist(m, params)
-    xml = @bot.httputil.get("#{APIURL}method=artist.getinfo&artist=#{CGI.escape params[:artist].to_s}")
-    unless xml
+    info_xml = @bot.httputil.get("#{APIURL}method=artist.getinfo&artist=#{CGI.escape params[:artist].to_s}")
+    unless info_xml
       m.reply _("I had problems getting info for %{a}") % {:a => params[:artist]}
       return
     end
-    doc = Document.new xml
-    unless doc
+    info_doc = Document.new info_xml
+    unless info_doc
       m.reply _("last.fm parsing failed")
       return
     end
-    first = doc.root.elements["artist"]
+    tags_xml = @bot.httputil.get("#{APIURL}method=artist.gettoptags&artist=#{CGI.escape params[:artist].to_s}")
+    tags_doc = Document.new tags_xml
+
+    first = info_doc.root.elements["artist"]
     artist = first.elements["name"].text
-    playcount = first.elements["stats"].elements["playcount"].text
-    listeners = first.elements["stats"].elements["listeners"].text
+    url = first.elements["url"].text
+    stats = {}
+    %w(playcount listeners).each do |e|
+      t = first.elements["stats/#{e}"].text
+      stats[e.to_sym] = t.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
+    end
     summary = first.elements["bio"].elements["summary"].text
-    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}
+    similar = first.get_elements("similar/artist").map { |a|
+      _("%{b}%{a}%{b}") % { :a => a.elements["name"].text, :b => Bold } }
+    tags = tags_doc.root.get_elements("toptags/tag")[0..4].map { |t|
+      _("%{u}%{t}%{u}") % { :t => t.elements["name"].text, :u => Underline } }
+    reply = _("%{b}%{a}%{b} <%{u}> has been played %{b}%{c}%{b} times and is being listened to by %{b}%{l}%{b} people") % {
+      :b => Bold, :a => artist, :u => url, :c => stats[:playcount], :l => stats[:listeners] }
+    reply << _(". Tagged as: %{t}") % {
+      :t => tags.join(", "), :b => Bold } unless tags.empty?
+    reply << _(". Similar artists: %{s}") % {
+      :s => similar.join(", "), :b => Bold } unless similar.empty?
+    m.reply reply
     m.reply summary.ircify_html
   end
 
@@ -387,22 +439,165 @@ 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
+    action = case params[:action]
+    when "neighbors" then "neighbours"
+    when "recentracks", "recent" then "recenttracks"
+    when "loved" then "lovedtracks"
+    when /^weekly(track|album|artist)s$/
+      "weekly#{$1}chart"
+    when "events"
+      find_events(m, params)
+      return
+    else
+      params[:action]
+    end.to_sym
+
+    if action == :shouts
+      num = params[:num] || @bot.config['lastfm.default_shouts']
+      num = num.to_i.clip(1, @bot.config['lastfm.max_shouts'])
+    else
+      num = params[:num] || @bot.config['lastfm.default_user_data']
+      num = num.to_i.clip(1, @bot.config['lastfm.max_user_data'])
+    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}:"
-      m.reply data.to_a[0..3].map{|l| l.split(',',2)[-1].chomp}.join(", ")
-    rescue
-      m.reply "could not find #{action} for #{user} (is #{user} a user?). perhaps you need to: lastfm set <username>"
+    uri = "#{APIURL}method=user.get#{action}&user=#{CGI.escape user}"
+
+    if period = params[:period]
+      period_uri = (period.last == "year" ? "12month" : period.first + "month")
+      uri << "&period=#{period_uri}"
+    end
+
+    res = @bot.httputil.get_response(uri)
+    unless res.body
+      m.reply _("I had problems accessing last.fm")
+      return
+    end
+    doc = Document.new(res.body)
+    unless doc
+      m.reply _("last.fm parsing failed")
+      return
+    end
+
+    case res
+    when Net::HTTPBadRequest
+      if doc.root and doc.root.attributes["status"] == "failed"
+        m.reply "error: " << doc.root.elements["error"].text.downcase
+      end
+      return
+    end
+
+    seemore =  _("; see %{uri} for more")
+    case action
+    when :friends
+      friends = doc.root.get_elements("friends/user").map do |u|
+        u.elements["name"].text
+      end
+
+      if friends.empty?
+        reply = _("%{user} has no friends :(")
+      elsif friends.length <= num
+        reply = _("%{user} has %{total} friends: %{friends}")
+      else
+        reply = _("%{user} has %{total} friends, including %{friends}")
+        reply << seemore
+      end
+      m.reply reply % {
+        :user => user,
+        :total => friends.size,
+        :friends => friends.shuffle[0, num].join(", "),
+        :uri => "http://www.last.fm/user/#{CGI.escape user}/friends"
+      }
+    when :lovedtracks
+      loved = doc.root.get_elements("lovedtracks/track").map do |track|
+        [track.elements["artist/name"].text, track.elements["name"].text].join(" - ")
+      end
+      loved_prep = loved.shuffle[0, num].to_enum(:each_with_index).collect { |e,i| (i % 2).zero? ? Underline+e+Underline : e }
+
+      if loved.empty?
+        reply = _("%{user} has not loved any tracks")
+      elsif loved.length <= num
+        reply = _("%{user} has loved %{total} tracks: %{tracks}")
+      else
+        reply = _("%{user} has loved %{total} tracks, including %{tracks}")
+        reply << seemore
+      end
+      m.reply reply % {
+          :user => user,
+          :total => loved.size,
+          :tracks => loved_prep.join(", "),
+          :uri => "http://www.last.fm/user/#{CGI.escape user}/library/loved"
+        }
+    when :neighbours
+      nbrs = doc.root.get_elements("neighbours/user").map do |u|
+        u.elements["name"].text
+      end
+
+      if nbrs.empty?
+        reply = _("no one seems to share %{user}'s musical taste")
+      elsif nbrs.length <= num
+        reply = _("%{user} musical neighbours are %{nbrs}")
+      else
+        reply = _("%{user} musical neighbours include %{nbrs}")
+        reply << seemore
+      end
+      m.reply reply % {
+          :user  => user,
+          :nbrs  => nbrs.shuffle[0, num].join(", "),
+          :uri   => "http://www.last.fm/user/#{CGI.escape user}/neighbours"
+      }
+    when :recenttracks
+      tracks = doc.root.get_elements("recenttracks/track").map do |track|
+        [track.elements["artist"].text, track.elements["name"].text].join(" - ")
+      end
+      tracks_prep = tracks[0, num].to_enum(:each_with_index).collect { |e,i| (i % 2).zero? ? Underline+e+Underline : e }
+
+      if tracks.empty?
+        m.reply _("%{user} hasn't played anything recently") % { :user => user }
+      else
+        m.reply _("%{user} has recently played %{tracks}") %
+          { :user => user, :tracks => tracks_prep.join(", ") }
+      end
+    when :shouts
+      shouts = doc.root.get_elements("shouts/shout")
+      if shouts.empty?
+        m.reply _("there are no shouts for %{user}") % { :user => user }
+      else
+        shouts[0, num].each do |shout|
+          m.reply _("<%{author}> %{body}") % {
+            :body   => shout.elements["body"].text,
+            :author => shout.elements["author"].text,
+          }
+        end
+      end
+    when :toptracks, :topalbums, :topartists, :weeklytrackchart, :weeklyalbumchart, :weeklyartistchart
+      type  = action.to_s.scan(/track|album|artist/).to_s
+      items = doc.root.get_elements("#{action}/#{type}").map do |item|
+        case action
+        when :weeklytrackchart, :weeklyalbumchart
+          format = "%{artist} - %{title} (%{bold}%{plays}%{bold})"
+          artist = item.elements["artist"].text
+        when :weeklyartistchart, :topartists
+          format = "%{artist} (%{bold}%{plays}%{bold})"
+          artist = item.elements["name"].text
+        when :toptracks, :topalbums
+          format = "%{artist} - %{title} (%{bold}%{plays}%{bold})"
+          artist = item.elements["artist/name"].text
+        end
+
+        _(format) % {
+          :artist => artist,
+          :title  => item.elements["name"].text,
+          :plays  => item.elements["playcount"].text,
+          :bold   => Bold
+        }
+      end
+      if items.empty?
+        m.reply _("%{user} hasn't played anything in this period of time") % { :user => user }
+      else
+        m.reply items[0, num].join(", ")
+      end
     end
   end
 
@@ -424,9 +619,16 @@ plugin.map 'lastfm set verb *present, *past', :action => :set_verb, :thread => t
 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 "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 [user] [:num] :action [:user]", :thread => true,
+  :requirements => {
+    :action => /^(?:events|shouts|friends|neighbou?rs|loved(?:tracks)?|recent(?:t?racks)?|top(?:album|artist|track)s?|weekly(?:albums?|artists?|tracks?)(?:chart)?)$/,
+    :num => /^\d+$/
+}
+plugin.map 'lastfm [user] [:num] :action [:user] over [*period]', :thread => true,
+  :requirements => {
+    :action => /^(?:top(?:album|artist|track)s?)$/,
+    :period => /^(?:(?:3|6|12) months)|(?:a\s|1\s)?year$/,
+    :num => /^\d+$/
 }
 plugin.map 'lastfm [now] [:who]', :action => :now_playing, :thread => true
 plugin.map 'np [:who]', :action => :now_playing, :thread => true