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    unless @attendance.zero?
  40      return "%s %s @ %s (%s attending) %s" % [@date.strftime("%a, %b %d"), @artist_string, @location, @attendance, @url]
  41    end
  42    return "%s %s @ %s %s" % [@date.strftime("%a, %b %d"), @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   Config.register Config::IntegerValue.new('lastfm.max_shouts',
  57     :default => 5, :validate => Proc.new{|v| v > 1},
  58     :desc => "Maximum number of user shouts to display.")
  59   Config.register Config::IntegerValue.new('lastfm.default_shouts',
  60     :default => 3, :validate => Proc.new{|v| v > 1},
  61     :desc => "Default number of user shouts to display.")
  62   Config.register Config::IntegerValue.new('lastfm.max_user_data',
  63     :default => 25, :validate => Proc.new{|v| v > 1},
  64     :desc => "Maximum number of user data entries (except events and shouts) to display.")
  65   Config.register Config::IntegerValue.new('lastfm.default_user_data',
  66     :default => 10, :validate => Proc.new{|v| v > 1},
  67     :desc => "Default number of user data entries (except events and shouts) to display.")
  68
  69   APIKEY = "b25b959554ed76058ac220b7b2e0a026"
  70   APIURL = "http://ws.audioscrobbler.com/2.0/?api_key=#{APIKEY}&"
  71
  72   def initialize
  73     super
  74     class << @registry
  75       def store(val)
  76         val
  77       end
  78       def restore(val)
  79         val
  80       end
  81     end
  82   end
  83
  84   def help(plugin, topic="")
  85     case (topic.intern rescue nil)
  86     when :event, :events
  87       _("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']}
  88     when :artist
  89       _("lastfm artist <name> => show information on artist <name> from last.fm")
  90     when :album
  91       _("lastfm album <name> => show information on album <name> from last.fm [not implemented yet]")
  92     when :track
  93       _("lastfm track <name> => search tracks matching <name> on last.fm")
  94     when :now, :np
  95       _("lastfm now [<user>] => show the now playing track from last.fm.  np [<user>] does the same.")
  96     when :set
  97       _("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\".")
  98     when :who
  99       _("lastfm who [<nick>] => show who <nick> is on last.fm. if <nick> is empty, show who you are on lastfm.")
 100     when :compare
 101       _("lastfm compare [<nick1>] <nick2> => show musical taste compatibility between nick1 (or user if omitted) and nick2")
 102     else
 103       _("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")
 104     end
 105   end
 106
 107   def find_events(m, params)
 108     num = params[:num] || @bot.config['lastfm.default_events']
 109     num = num.to_i.clip(1, @bot.config['lastfm.max_events'])
 110
 111     location = params[:location]
 112     artist = params[:who]
 113     user = resolve_username(m, params[:user])
 114
 115     if location
 116       uri = "#{APIURL}method=geo.getevents&location=#{CGI.escape location.to_s}"
 117       emptymsg = _("no events found in %{location}") % {:location => location.to_s}
 118     elsif artist
 119       uri = "#{APIURL}method=artist.getevents&artist=#{CGI.escape artist.to_s}"
 120       emptymsg = _("no events found by %{artist}") % {:artist => artist.to_s}
 121     elsif user
 122       uri = "#{APIURL}method=user.getevents&user=#{CGI.escape user}"
 123       emptymsg = _("%{user} is not attending any events") % {:user => user}
 124     end
 125     xml = @bot.httputil.get_response(uri)
 126
 127     doc = Document.new xml.body
 128     if xml.class == Net::HTTPInternalServerError
 129       if doc.root and doc.root.attributes["status"] == "failed"
 130         m.reply doc.root.elements["error"].text
 131       else
 132         m.reply _("could not retrieve events")
 133       end
 134     end
 135     disp_events = Array.new
 136     events = Array.new
 137     doc.root.elements.each("events/event"){ |e|
 138       h = {}
 139       h[:title] = e.elements["title"].text
 140       venue = e.elements["venue"].elements["name"].text
 141       city = e.elements["venue"].elements["location"].elements["city"].text
 142       country =  e.elements["venue"].elements["location"].elements["country"].text
 143       h[:location] = Underline + venue + Underline + " #{Bold + city + Bold}, #{country}"
 144       date = e.elements["startDate"].text.split
 145       h[:date] = Time.utc(date[3].to_i, date[2], date[1].to_i)
 146       h[:desc] = e.elements["description"].text
 147       h[:url] = e.elements["url"].text
 148       h[:attendance] = e.elements["attendance"].text.to_i
 149       artists = Array.new
 150       e.elements.each("artists/artist"){ |a|
 151         artists << a.text
 152       }
 153       h[:artists] = artists
 154       events << LastFmEvent.new(h)
 155     }
 156     if events.empty?
 157       m.reply emptymsg
 158       return
 159     end
 160     events[0...num].each { |event|
 161       disp_events << event.to_s
 162     }
 163     m.reply disp_events.join(' | '), :split_at => /\s+\|\s+/
 164
 165   end
 166
 167   def tasteometer(m, params)
 168     opts = { :cache => false }
 169     user1 = resolve_username(m, params[:user1])
 170     user2 = resolve_username(m, params[:user2])
 171     xml = @bot.httputil.get_response("#{APIURL}method=tasteometer.compare&type1=user&type2=user&value1=#{CGI.escape user1}&value2=#{CGI.escape user2}", opts)
 172     doc = Document.new xml.body
 173     unless doc
 174       m.reply _("last.fm parsing failed")
 175       return
 176     end
 177     if xml.class == Net::HTTPBadRequest
 178       if doc.root.elements["error"].attributes["code"] == "7" then
 179         error = doc.root.elements["error"].text
 180         error.match(/Invalid username: \[(.*)\]/);
 181         baduser = $1
 182
 183         m.reply _("%{u} doesn't exist on last.fm") % {:u => baduser}
 184         return
 185       else
 186         m.reply _("error: %{e}") % {:e => doc.root.element["error"].text}
 187         return
 188       end
 189     end
 190     score = doc.root.elements["comparison/result/score"].text.to_f
 191     artists = doc.root.get_elements("comparison/result/artists/artist").map { |e| e.elements["name"].text}
 192     case
 193       when score >= 0.9
 194         rating = _("Super")
 195       when score >= 0.7
 196         rating = _("Very High")
 197       when score >= 0.5
 198         rating = _("High")
 199       when score >= 0.3
 200         rating = _("Medium")
 201       when score >= 0.1
 202         rating = _("Low")
 203       else
 204         rating = _("Very Low")
 205     end
 206
 207     reply = _("%{a}'s and %{b}'s musical compatibility rating is %{bold}%{r}%{bold}") % {
 208       :a => user1,
 209       :b => user2,
 210       :r => rating.downcase,
 211       :bold => Bold
 212     }
 213
 214     reply << _(" and music they have in common includes: %{artists}") % {
 215       :artists => artists.join(", ")
 216     } unless artists.empty?
 217
 218     m.reply reply
 219   end
 220
 221   def now_playing(m, params)
 222     opts = { :cache => false }
 223     user = resolve_username(m, params[:who])
 224     xml = @bot.httputil.get_response("#{APIURL}method=user.getrecenttracks&user=#{CGI.escape user}", opts)
 225     doc = Document.new xml.body
 226     unless doc
 227       m.reply _("last.fm parsing failed")
 228       return
 229     end
 230     if xml.class == Net::HTTPBadRequest
 231       if doc.root.elements["error"].text == "Invalid user name supplied" then
 232         m.reply _("%{user} doesn't exist on last.fm, perhaps they need to: lastfm user <username>") % {
 233           :user => user
 234         }
 235         return
 236       else
 237         m.reply _("error: %{e}") % {:e => doc.root.element["error"].text}
 238         return
 239       end
 240     end
 241     now = artist = track = albumtxt = date = nil
 242     unless doc.root.elements[1].has_elements?
 243      m.reply _("%{u} hasn't played anything recently") % {:u => user}
 244      return
 245     end
 246     first = doc.root.elements[1].elements[1]
 247     now = first.attributes["nowplaying"]
 248     artist = first.elements["artist"].text
 249     track = first.elements["name"].text
 250     albumtxt = first.elements["album"].text
 251     album = ""
 252     if albumtxt
 253       year = get_album(artist, albumtxt)[2]
 254       album = "[#{albumtxt}, #{year}] " if year
 255     end
 256     past = nil
 257     date = XPath.first(first, "//date")
 258     if date != nil
 259       time = date.attributes["uts"]
 260       past = Time.at(time.to_i)
 261     end
 262     if now == "true"
 263        verb = _("is listening to")
 264        if @registry.has_key? "#{m.sourcenick}_verb_present"
 265          verb = @registry["#{m.sourcenick}_verb_present"]
 266        end
 267        m.reply _("%{u} %{v} \"%{t}\" by %{a} %{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album}
 268     else
 269       verb = _("listened to")
 270        if @registry.has_key? "#{m.sourcenick}_verb_past"
 271          verb = @registry["#{m.sourcenick}_verb_past"]
 272        end
 273       ago = Utils.timeago(past)
 274       m.reply _("%{u} %{v} \"%{t}\" by %{a} %{b}%{p}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago}
 275     end
 276   end
 277
 278   def find_artist(m, params)
 279     xml = @bot.httputil.get("#{APIURL}method=artist.getinfo&artist=#{CGI.escape params[:artist].to_s}")
 280     unless xml
 281       m.reply _("I had problems getting info for %{a}") % {:a => params[:artist]}
 282       return
 283     end
 284     doc = Document.new xml
 285     unless doc
 286       m.reply _("last.fm parsing failed")
 287       return
 288     end
 289     first = doc.root.elements["artist"]
 290     artist = first.elements["name"].text
 291     playcount = first.elements["stats"].elements["playcount"].text
 292     listeners = first.elements["stats"].elements["listeners"].text
 293     summary = first.elements["bio"].elements["summary"].text
 294     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}
 295     m.reply summary.ircify_html
 296   end
 297
 298   def find_track(m, params)
 299     track = params[:track].to_s
 300     xml = @bot.httputil.get("#{APIURL}method=track.search&track=#{CGI.escape track}")
 301     unless xml
 302       m.reply _("I had problems getting info for %{a}") % {:a => track}
 303       return
 304     end
 305     debug xml
 306     doc = Document.new xml
 307     unless doc
 308       m.reply _("last.fm parsing failed")
 309       return
 310     end
 311     debug doc.root
 312     results = doc.root.elements["results/opensearch:totalResults"].text.to_i rescue 0
 313     if results > 0
 314       begin
 315         hits = []
 316         doc.root.each_element("results/trackmatches/track") do |track|
 317           hits << _("%{bold}%{t}%{bold} by %{bold}%{a}%{bold} (%{n} listeners)") % {
 318             :t => track.elements["name"].text,
 319             :a => track.elements["artist"].text,
 320             :n => track.elements["listeners"].text,
 321             :bold => Bold
 322           }
 323         end
 324         m.reply hits.join(' -- '), :split_at => ' -- '
 325       rescue
 326         error $!
 327         m.reply _("last.fm parsing failed")
 328       end
 329     else
 330       m.reply _("track %{a} not found") % {:a => track}
 331     end
 332   end
 333
 334   def get_album(artist, album)
 335     xml = @bot.httputil.get("#{APIURL}method=album.getinfo&artist=#{CGI.escape artist}&album=#{CGI.escape album}")
 336     unless xml
 337       return [_("I had problems getting album info")]
 338     end
 339     doc = Document.new xml
 340     unless doc
 341       return [_("last.fm parsing failed")]
 342     end
 343     album = date = playcount = artist = date = year = nil
 344     first = doc.root.elements["album"]
 345     artist = first.elements["artist"].text
 346     playcount = first.elements["playcount"].text
 347     album = first.elements["name"].text
 348     date = first.elements["releasedate"].text
 349     unless date.strip.length < 2
 350       year = date.strip.split[2].chop
 351     end
 352     result = [artist, album, year, playcount]
 353     return result
 354   end
 355
 356   def find_album(m, params)
 357     album = get_album(params[:artist].to_s, params[:album].to_s)
 358     if album.length == 1
 359       m.reply _("I couldn't locate: \"%{a}\" by %{r}") % {:a => params[:album], :r => params[:artist]}
 360       return
 361     end
 362     year = "(#{album[2]}) " unless album[2] == nil
 363     m.reply _("the album \"%{a}\" by %{r} %{y}has been played %{c} times") % {:a => album[1], :r => album[0], :y => year, :c => album[3]}
 364   end
 365
 366   def set_user(m, params)
 367     user = params[:who].to_s
 368     nick = m.sourcenick
 369     @registry[ nick ] = user
 370     m.reply _("okay, I'll remember that %{n} is %{u} on last.fm") % {:n => nick, :u => user}
 371   end
 372
 373   def set_verb(m, params)
 374     past = params[:past].to_s
 375     present = params[:present].to_s
 376     key = "#{m.sourcenick}_verb_"
 377     @registry[ "#{key}past" ] = past
 378     @registry[ "#{key}present" ] = present
 379     m.reply _("okay, I'll remember that %{n} prefers \"%{r}\" and \"%{p}\"") % {:n => m.sourcenick, :p => past, :r => present}
 380   end
 381
 382   def get_user(m, params)
 383     nick = ""
 384     if params[:who]
 385       nick = params[:who].to_s
 386     else
 387       nick = m.sourcenick
 388     end
 389     if @registry.has_key? nick
 390       user = @registry[ nick ]
 391       m.reply _("%{nick} is %{user} on last.fm") % {
 392         :nick => nick,
 393         :user => user
 394       }
 395     else
 396       m.reply _("sorry, I don't know who %{n} is on last.fm, perhaps they need to: lastfm set user <username>") % {:n => nick}
 397     end
 398   end
 399
 400   def lastfm(m, params)
 401     action = case params[:action]
 402     when "neighbors"   then "neighbours"
 403     when "recentracks" then "recenttracks"
 404     when /^weekly(track|album|artist)s$/
 405       "weekly#{$1}chart"
 406     when "events"
 407       find_events(m, params)
 408       return
 409     else
 410       params[:action]
 411     end.to_sym
 412
 413     if action == :shouts
 414       num = params[:num] || @bot.config['lastfm.default_shouts']
 415       num = num.to_i.clip(1, @bot.config['lastfm.max_shouts'])
 416     else
 417       num = params[:num] || @bot.config['lastfm.default_user_data']
 418       num = num.to_i.clip(1, @bot.config['lastfm.max_user_data'])
 419     end
 420
 421     user = resolve_username(m, params[:user])
 422     uri = "#{APIURL}method=user.get#{action}&user=#{CGI.escape user}"
 423
 424     if period = params[:period]
 425       period_uri = (period.last == "year" ? "12month" : period.first + "month")
 426       uri << "&period=#{period_uri}"
 427     end
 428
 429     res = @bot.httputil.get_response(uri)
 430     unless res.body
 431       m.reply _("I had problems accessing last.fm")
 432       return
 433     end
 434     doc = Document.new(res.body)
 435     unless doc
 436       m.reply _("last.fm parsing failed")
 437       return
 438     end
 439
 440     case res
 441     when Net::HTTPBadRequest
 442       if doc.root and doc.root.attributes["status"] == "failed"
 443         m.reply "error: " << doc.root.elements["error"].text.downcase
 444       end
 445       return
 446     end
 447
 448     seemore =  _("; see %{uri} for more")
 449     case action
 450     when :friends
 451       friends = doc.root.get_elements("friends/user").map do |u|
 452         u.elements["name"].text
 453       end
 454
 455       if friends.empty?
 456         reply = _("%{user} has no friends :(")
 457       elsif friends.length <= num
 458         reply = _("%{user} has %{total} friends: %{friends}")
 459       else
 460         reply = _("%{user} has %{total} friends, including %{friends}")
 461         reply << seemore
 462       end
 463       m.reply reply % {
 464         :user => user,
 465         :total => friends.size,
 466         :friends => friends.shuffle[0, num].join(", "),
 467         :uri => "http://www.last.fm/user/#{CGI.escape user}/friends"
 468       }
 469     when :lovedtracks
 470       loved = doc.root.get_elements("lovedtracks/track").map do |track|
 471         [track.elements["artist/name"].text, track.elements["name"].text].join(" - ")
 472       end
 473       loved_prep = loved.shuffle[0, num].to_enum(:each_with_index).collect { |e,i| (i % 2).zero? ? Underline+e+Underline : e }
 474
 475       if loved.empty?
 476         reply = _("%{user} has not loved any tracks")
 477       elsif loved.length <= num
 478         reply = _("%{user} has loved %{total} tracks: %{tracks}")
 479       else
 480         reply = _("%{user} has loved %{total} tracks, including %{tracks}")
 481         reply << seemore
 482       end
 483       m.reply reply % {
 484           :user => user,
 485           :total => loved.size,
 486           :tracks => loved_prep.join(", "),
 487           :uri => "http://www.last.fm/user/#{CGI.escape user}/library/loved"
 488         }
 489     when :neighbours
 490       nbrs = doc.root.get_elements("neighbours/user").map do |u|
 491         u.elements["name"].text
 492       end
 493
 494       if nbrs.empty?
 495         reply = _("no one seems to share %{user}'s musical taste")
 496       elsif nbrs.length <= num
 497         reply = _("%{user} musical neighbours are %{nbrs}")
 498       else
 499         reply = _("%{user} musical neighbours include %{nbrs}")
 500         reply << seemore
 501       end
 502       m.reply reply % {
 503           :user  => user,
 504           :nbrs  => nbrs.shuffle[0, num].join(", "),
 505           :uri   => "http://www.last.fm/user/#{CGI.escape user}/neighbours"
 506       }
 507     when :recenttracks
 508       tracks = doc.root.get_elements("recenttracks/track").map do |track|
 509         [track.elements["artist"].text, track.elements["name"].text].join(" - ")
 510       end
 511       tracks_prep = tracks[0, num].to_enum(:each_with_index).collect { |e,i| (i % 2).zero? ? Underline+e+Underline : e }
 512
 513       if tracks.empty?
 514         m.reply _("%{user} hasn't played anything recently") % { :user => user }
 515       else
 516         m.reply _("%{user} has recently played %{tracks}") %
 517           { :user => user, :tracks => tracks_prep.join(", ") }
 518       end
 519     when :shouts
 520       shouts = doc.root.get_elements("shouts/shout")
 521       if shouts.empty?
 522         m.reply _("there are no shouts for %{user}") % { :user => user }
 523       else
 524         shouts[0, num].each do |shout|
 525           m.reply _("<%{author}> %{body}") % {
 526             :body   => shout.elements["body"].text,
 527             :author => shout.elements["author"].text,
 528           }
 529         end
 530       end
 531     when :toptracks, :topalbums, :topartists, :weeklytrackchart, :weeklyalbumchart, :weeklyartistchart
 532       type  = action.to_s.scan(/track|album|artist/).to_s
 533       items = doc.root.get_elements("#{action}/#{type}").map do |item|
 534         case action
 535         when :weeklytrackchart, :weeklyalbumchart
 536           format = "%{artist} - %{title} (%{bold}%{plays}%{bold})"
 537           artist = item.elements["artist"].text
 538         when :weeklyartistchart, :topartists
 539           format = "%{artist} (%{bold}%{plays}%{bold})"
 540           artist = item.elements["name"].text
 541         when :toptracks, :topalbums
 542           format = "%{artist} - (%{title} %{bold}%{plays}%{bold})"
 543           artist = item.elements["artist/name"].text
 544         end
 545
 546         _(format) % {
 547           :artist => artist,
 548           :title  => item.elements["name"].text,
 549           :plays  => item.elements["playcount"].text,
 550           :bold   => Bold
 551         }
 552       end
 553       m.reply items[0, num].join(", ")
 554     end
 555   end
 556
 557   def resolve_username(m, name)
 558     name = m.sourcenick if name.nil?
 559     @registry[name] or name
 560   end
 561 end
 562
 563 plugin = LastFmPlugin.new
 564 plugin.map 'lastfm [:num] event[s] in *location', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
 565 plugin.map 'lastfm [:num] event[s] by *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
 566 plugin.map 'lastfm [:num] event[s] [for] *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
 567 plugin.map 'lastfm artist *artist', :action => :find_artist, :thread => true
 568 plugin.map 'lastfm album *album [by *artist]', :action => :find_album
 569 plugin.map 'lastfm track *track', :action => :find_track, :thread => true
 570 plugin.map 'lastfm set user[name] :who', :action => :set_user, :thread => true
 571 plugin.map 'lastfm set verb *present, *past', :action => :set_verb, :thread => true
 572 plugin.map 'lastfm who [:who]', :action => :get_user, :thread => true
 573 plugin.map 'lastfm compare to :user2', :action => :tasteometer, :thread => true
 574 plugin.map 'lastfm compare [:user1] [to] :user2', :action => :tasteometer, :thread => true
 575 plugin.map "lastfm [user] [:num] :action [:user]", :thread => true,
 576   :requirements => { :action =>
 577     /^(?:events|shouts|friends|neighbou?rs|(?:loved|recent?)tracks|top(?:album|artist|track)s?|weekly(?:albums?|artists?|tracks?)(?:chart)?)$/
 578 }
 579 plugin.map 'lastfm [user] [:num] :action [:user] over [*period]', :thread => true,
 580   :requirements => {
 581     :action => /^(?:top(?:album|artist|track)s?)$/,
 582     :period => /^(?:(?:3|6|12) months)|(?:a\s|1\s)?year$/
 583 }
 584 plugin.map 'lastfm [now] [:who]', :action => :now_playing, :thread => true
 585 plugin.map 'np [:who]', :action => :now_playing, :thread => true