data/rbot/plugins/lastfm.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: lastfm plugin for rbot
   5 #
   6 # Author:: Jeremy Voorhis
   7 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
   8 # Author:: Casey Link <unnamedrambler@gmail.com>
   9 #
  10 # Copyright:: (C) 2005 Jeremy Voorhis
  11 # Copyright:: (C) 2007 Giuseppe Bilotta
  12 # Copyright:: (C) 2008 Casey Link
  13 #
  14 # License:: GPL v2
  15
  16 require 'rexml/document'
  17 require 'cgi'
  18
  19 class ::LastFmEvent
  20   def initialize(hash)
  21     @url = hash[:url]
  22     @date = hash[:date]
  23     @location = hash[:location]
  24     @description = hash[:description]
  25     @attendance = hash[:attendance]
  26
  27     @artists = hash[:artists]
  28
  29     if @artists.length > 10 #more than 10 artists and it floods
  30       diff = @artists.length - 10
  31       @artist_string = Bold + @artists[0..10].join(', ') + Bold
  32       @artist_string << _(" and %{n} more...") % {:n => diff}
  33     else
  34       @artist_string = Bold + @artists.join(', ') + Bold
  35     end
  36   end
  37
  38   def compact_display
  39    if @attendance
  40      return "%s %s @ %s (%s attending) %s" % [@date.strftime("%a %b, %d %Y"), @artist_string, @location, @attendance, @url]
  41    end
  42    return "%s %s @ %s %s" % [@date.strftime("%a %b, %d %Y"), @artist_string, @location, @url]
  43   end
  44   alias :to_s :compact_display
  45
  46 end
  47
  48 class LastFmPlugin < Plugin
  49   include REXML
  50   Config.register Config::IntegerValue.new('lastfm.max_events',
  51     :default => 25, :validate => Proc.new{|v| v > 1},
  52     :desc => "Maximum number of events to display.")
  53   Config.register Config::IntegerValue.new('lastfm.default_events',
  54     :default => 3, :validate => Proc.new{|v| v > 1},
  55     :desc => "Default number of events to display.")
  56
  57   APIKEY = "b25b959554ed76058ac220b7b2e0a026"
  58   APIURL = "http://ws.audioscrobbler.com/2.0/?api_key=#{APIKEY}&"
  59
  60   def initialize
  61     super
  62     class << @registry
  63       def store(val)
  64         val
  65       end
  66       def restore(val)
  67         val
  68       end
  69     end
  70   end
  71
  72   def help(plugin, topic="")
  73     case (topic.intern rescue nil)
  74     when :event, :events
  75       _("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']}
  76     when :artist
  77       _("lastfm artist <name> => show information on artist <name> from last.fm")
  78     when :album
  79       _("lastfm album <name> => show information on album <name> from last.fm [not implemented yet]")
  80     when :track
  81       _("lastfm track <name> => search tracks matching <name> on last.fm")
  82     when :now, :np
  83       _("lastfm now [<user>] => show the now playing track from last.fm.  np [<user>] does the same.")
  84     when :set
  85       _("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\".")
  86     when :who
  87       _("lastfm who [<nick>] => show who <nick> is at last.fm. if <nick> is empty, show who you are at lastfm.")
  88     when :compare
  89       _("lastfm compare <nick1> <nick2> => show musical taste compatibility between nick1 and nick2.")
  90     else
  91       _("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")
  92     end
  93   end
  94
  95   def find_events(m, params)
  96     num = params[:num] || @bot.config['lastfm.default_events']
  97     num = num.to_i.clip(1, @bot.config['lastfm.max_events'])
  98
  99     location = artist = nil
 100     location = params[:location].to_s if params[:location]
 101     artist = params[:who].to_s if params[:who]
 102
 103     uri = nil
 104     if artist == nil
 105       uri = "#{APIURL}method=geo.getevents&location=#{CGI.escape location}"
 106     else
 107       uri = "#{APIURL}method=artist.getevents&artist=#{CGI.escape artist}"
 108     end
 109     xml = @bot.httputil.get_response(uri)
 110
 111     doc = Document.new xml.body
 112     if xml.class == Net::HTTPInternalServerError
 113       if doc.root and doc.root.attributes["status"] == "failed"
 114         m.reply doc.root.elements["error"].text
 115       else
 116         m.reply _("Could not retrieve events")
 117       end
 118     end
 119     disp_events = Array.new
 120     events = Array.new
 121     doc.root.elements.each("events/event"){ |e|
 122       h = {}
 123       h[:title] = e.elements["title"].text
 124       venue = e.elements["venue"].elements["name"].text
 125       city = e.elements["venue"].elements["location"].elements["city"].text
 126       country =  e.elements["venue"].elements["location"].elements["country"].text
 127       h[:location] = Underline + venue + Underline + " #{Bold + city + Bold}, #{country}"
 128       date = e.elements["startDate"].text.split
 129       h[:date] = Time.utc(date[3].to_i, date[2], date[1].to_i)
 130       h[:desc] = e.elements["description"].text
 131       h[:url] = e.elements["url"].text
 132       e.detect {|node|
 133         if node.kind_of? Element and node.attributes["name"] == "attendance" then
 134           h[:attendance] = node.text
 135         end
 136       }
 137       artists = Array.new
 138       e.elements.each("artists/artist"){ |a|
 139         artists << a.text
 140       }
 141       h[:artists] = artists
 142       events << LastFmEvent.new(h)
 143     }
 144     events[0...num].each { |event|
 145       disp_events << event.to_s
 146     }
 147     m.reply disp_events.join(' | '), :split_at => /\s+\|\s+/
 148
 149   end
 150
 151   def tasteometer(m, params)
 152     opts = { :cache => false }
 153     user1 = params[:user1].to_s
 154     user2 = params[:user2].to_s
 155     xml = @bot.httputil.get_response("#{APIURL}method=tasteometer.compare&type1=user&type2=user&value1=#{CGI.escape user1}&value2=#{CGI.escape user2}", opts)
 156     doc = Document.new xml.body
 157     unless doc
 158       m.reply _("last.fm parsing failed")
 159       return
 160     end
 161     if xml.class == Net::HTTPInternalServerError
 162       if doc.root.elements["error"].attributes["code"] == "7" then
 163         error = doc.root.elements["error"].text
 164         error.match(/Invalid username: \[(.*)\]/);
 165         if @registry.has_key? $1 and not params[:recurs]
 166           if user1 == $1
 167             params[:user1] = @registry[ $1 ]
 168           elsif user2 == $1
 169             params[:user2] = @registry[ $1 ]
 170           end
 171           params[:recurs] = true
 172           tasteometer(m, params)
 173         else
 174           m.reply _("%{u} doesn't exist at last.fm. Perhaps you need to: lastfm set <username>") % {:u => baduser}
 175           return
 176         end
 177       else
 178         m.reply _("Bad: %{e}") % {:e => doc.root.element["error"].text}
 179         return
 180       end
 181     end
 182     now = artist = track = albumtxt = date = nil
 183     score = doc.root.elements["comparison/result/score"].text.to_f
 184     rating = nil
 185     case
 186       when score >= 0.9
 187         rating = _("Super")
 188       when score >= 0.7
 189         rating = _("Very High")
 190       when score >= 0.5
 191         rating = _("High")
 192       when score >= 0.3
 193         rating = _("Medium")
 194       when score >= 0.1
 195         rating = _("Low")
 196       else
 197         rating = _("Very Low")
 198     end
 199     m.reply _("%{a}'s and %{b}'s musical compatibility rating is: %{r}") % {:a => user1, :b => user2, :r => rating}
 200   end
 201
 202   def now_playing(m, params)
 203     opts = { :cache => false }
 204     user = nil
 205     if params[:who]
 206       user = params[:who].to_s
 207     elsif @registry.has_key? m.sourcenick
 208       user = @registry[ m.sourcenick ]
 209     else
 210       user = m.sourcenick
 211     end
 212     xml = @bot.httputil.get_response("#{APIURL}method=user.getrecenttracks&user=#{CGI.escape user}", opts)
 213     doc = Document.new xml.body
 214     unless doc
 215       m.reply _("last.fm parsing failed")
 216       return
 217     end
 218     if xml.class == Net::HTTPBadRequest
 219       if doc.root.elements["error"].text == "Invalid user name supplied" then
 220         if @registry.has_key? user and not params[:recurs]
 221           params[:who] = @registry[ user ]
 222           params[:recurs] = true
 223           now_playing(m, params)
 224         else
 225           m.reply "#{user} doesn't exist at last.fm. Perhaps you need to: lastfm set <username>"
 226           return
 227         end
 228       else
 229         m.reply _("Error %{e}") % {:e => doc.root.element["error"].text}
 230         return
 231       end
 232     end
 233     now = artist = track = albumtxt = date = nil
 234     unless doc.root.elements[1].has_elements?
 235      m.reply _("%{u} hasn't played anything recently") % {:u => user}
 236      return
 237     end
 238     first = doc.root.elements[1].elements[1]
 239     now = first.attributes["nowplaying"]
 240     artist = first.elements["artist"].text
 241     track = first.elements["name"].text
 242     albumtxt = first.elements["album"].text
 243     album = ""
 244     if albumtxt
 245       year = get_album(artist, albumtxt)[2]
 246       album = "[#{albumtxt}, #{year}] " if year
 247     end
 248     past = nil
 249     date = XPath.first(first, "//date")
 250     if date != nil
 251       time = date.attributes["uts"]
 252       past = Time.at(time.to_i)
 253     end
 254     if now == "true"
 255        verb = _("listening")
 256        if @registry.has_key? "#{m.sourcenick}_verb_present"
 257          verb = @registry["#{m.sourcenick}_verb_present"]
 258        end
 259       m.reply _("%{u} is %{v} to \"%{t}\" by %{a} %{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album}
 260     else
 261       verb = _("listened")
 262        if @registry.has_key? "#{m.sourcenick}_verb_past"
 263          verb = @registry["#{m.sourcenick}_verb_past"]
 264        end
 265       ago = Utils.timeago(past)
 266       m.reply _("%{u} %{v} to \"%{t}\" by %{a} %{b}%{p}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago}
 267     end
 268   end
 269
 270   def find_artist(m, params)
 271     xml = @bot.httputil.get("#{APIURL}method=artist.getinfo&artist=#{CGI.escape params[:artist].to_s}")
 272     unless xml
 273       m.reply _("I had problems getting info for %{a}.") % {:a => params[:artist]}
 274       return
 275     end
 276     doc = Document.new xml
 277     unless doc
 278       m.reply _("last.fm parsing failed")
 279       return
 280     end
 281     first = doc.root.elements["artist"]
 282     artist = first.elements["name"].text
 283     playcount = first.elements["stats"].elements["plays"].text
 284     listeners = first.elements["stats"].elements["listeners"].text
 285     summary = first.elements["bio"].elements["summary"].text
 286     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}
 287     m.reply summary.ircify_html
 288   end
 289
 290   def find_track(m, params)
 291     track = params[:track].to_s
 292     xml = @bot.httputil.get("#{APIURL}method=track.search&track=#{CGI.escape track}")
 293     unless xml
 294       m.reply _("I had problems getting info for %{a}.") % {:a => track}
 295       return
 296     end
 297     debug xml
 298     doc = Document.new xml
 299     unless doc
 300       m.reply _("last.fm parsing failed")
 301       return
 302     end
 303     debug doc.root
 304     results = doc.root.elements["results/opensearch:totalResults"].text.to_i rescue 0
 305     if results > 0
 306       begin
 307         hits = []
 308         doc.root.each_element("results/trackmatches/track") do |track|
 309           hits << _("%{bold}%{t}%{bold} by %{bold}%{a}%{bold} (%{n} listeners)") % {
 310             :t => track.elements["name"].text,
 311             :a => track.elements["artist"].text,
 312             :n => track.elements["listeners"].text,
 313             :bold => Bold
 314           }
 315         end
 316         m.reply hits.join(' -- '), :split_at => ' -- '
 317       rescue
 318         error $!
 319         m.reply _("last.fm parsing failed")
 320       end
 321     else
 322       m.reply _("track %{a} not found") % {:a => track}
 323     end
 324   end
 325
 326   def get_album(artist, album)
 327     xml = @bot.httputil.get("#{APIURL}method=album.getinfo&artist=#{CGI.escape artist}&album=#{CGI.escape album}")
 328     unless xml
 329       return [_("I had problems getting album info")]
 330     end
 331     doc = Document.new xml
 332     unless doc
 333       return [_("last.fm parsing failed")]
 334     end
 335     album = date = playcount = artist = date = year = nil
 336     first = doc.root.elements["album"]
 337     artist = first.elements["artist"].text
 338     playcount = first.elements["playcount"].text
 339     album = first.elements["name"].text
 340     date = first.elements["releasedate"].text
 341     unless date.strip.length < 2
 342       year = date.strip.split[2].chop
 343     end
 344     result = [artist, album, year, playcount]
 345     return result
 346   end
 347
 348   def find_album(m, params)
 349     album = get_album(params[:artist].to_s, params[:album].to_s)
 350     if album.length == 1
 351       m.reply _("I couldn't locate: \"%{a}\" by %{r}") % {:a => params[:album], :r => params[:artist]}
 352       return
 353     end
 354     year = "(#{album[2]}) " unless album[2] == nil
 355     m.reply _("The album \"%{a}\" by %{r} %{y}has been played %{c} times.") % {:a => album[1], :r => album[0], :y => year, :c => album[3]}
 356   end
 357
 358   def set_user(m, params)
 359     user = params[:who].to_s
 360     nick = m.sourcenick
 361     @registry[ nick ] = user
 362     m.reply _("Ok, I'll remember that %{n} is %{u} at last.fm") % {:n => nick, :u => user}
 363   end
 364
 365   def set_verb(m, params)
 366     past = params[:past].to_s
 367     present = params[:present].to_s
 368     key = "#{m.sourcenick}_verb_"
 369     @registry[ "#{key}past" ] = past
 370     @registry[ "#{key}present" ] = present
 371     m.reply _("Ok, I'll remember that %{n} prefers %{r} and %{p}.") % {:n => m.sourcenick, :p => past, :r => present}
 372   end
 373
 374   def get_user(m, params)
 375     nick = ""
 376     if params[:who]
 377       nick = params[:who].to_s
 378     else
 379       nick = m.sourcenick
 380     end
 381     if @registry.has_key? nick
 382       user = @registry[ nick ]
 383       m.reply "#{nick} is #{user} at last.fm"
 384     else
 385       m.reply _("Sorry, I don't know who %{n} is at last.fm perhaps you need to: lastfm set <username>") % {:n => nick}
 386     end
 387   end
 388
 389   # TODO this user data retrieval should be upgraded to API 2.0 but it would need separate parsing
 390   # for each dataset, or almost
 391   def lastfm(m, params)
 392     action = params[:action].intern
 393     action = :neighbours if action == :neighbors
 394     action = :recenttracks if action == :recentracks
 395     action = :topalbums if action == :topalbum
 396     action = :topartists if action == :topartist
 397     action = :toptags if action == :toptag
 398     user = nil
 399     if params[:user] then
 400       user = params[:user].to_s
 401     elsif @registry.has_key? m.sourcenick
 402       user = @registry[ m.sourcenick ]
 403     else
 404       # m.reply "I don't know who you are on last.fm. Use 'lastfm set username' to identify yourself."
 405       # return
 406       user = m.sourcenick
 407     end
 408     begin
 409       data = @bot.httputil.get("http://ws.audioscrobbler.com/1.0/user/#{user}/#{action}.txt")
 410       m.reply "#{action} for #{user}:"
 411       m.reply data.to_a[0..3].map{|l| l.split(',',2)[-1].chomp}.join(", ")
 412     rescue
 413       m.reply "could not find #{action} for #{user} (is #{user} a user?). perhaps you need to: lastfm set <username>"
 414     end
 415   end
 416 end
 417
 418 plugin = LastFmPlugin.new
 419 plugin.map 'lastfm [:num] event[s] in *location', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
 420 plugin.map 'lastfm [:num] event[s] by *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
 421 plugin.map 'lastfm [:num] event[s] [for] *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
 422 plugin.map 'lastfm now :who', :action => :now_playing, :thread => true
 423 plugin.map 'lastfm now', :action => :now_playing, :thread => true
 424 plugin.map 'np :who', :action => :now_playing, :thread => true
 425 plugin.map 'lastfm artist *artist', :action => :find_artist, :thread => true
 426 plugin.map 'lastfm album *album [by *artist]', :action => :find_album
 427 plugin.map 'lastfm track *track', :action => :find_track, :thread => true
 428 plugin.map 'lastfm set nick :who', :action => :set_user, :thread => true
 429 plugin.map 'lastfm set user :who', :action => :set_user, :thread => true
 430 plugin.map 'lastfm set username :who', :action => :set_user, :thread => true
 431 plugin.map 'lastfm set verb :present :past', :action => :set_verb, :thread => true
 432 plugin.map 'lastfm who :who', :action => :get_user, :thread => true
 433 plugin.map 'lastfm who', :action => :get_user, :thread => true
 434 plugin.map 'lastfm compare :user1 :user2', :action => :tasteometer, :thread => true
 435 plugin.map 'np', :action => :now_playing, :thread => true
 436 plugin.map "lastfm [user] :action [:user]", :thread => true,
 437   :requirements => { :action =>
 438     /^(?:events|friends|neighbou?rs|playlists|recent?tracks|top(?:album|artist|tag)s?|weekly(?:album|artist|track)chart|weeklychartlist)$/
 439 }
 440 plugin.map "lastfm [:who]", :action => :now_playing, :thread => true