4 # :title: lastfm plugin for rbot
6 # Author:: Jeremy Voorhis
7 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
8 # Author:: Casey Link <unnamedrambler@gmail.com>
10 # Copyright:: (C) 2005 Jeremy Voorhis
11 # Copyright:: (C) 2007 Giuseppe Bilotta
12 # Copyright:: (C) 2008 Casey Link
16 require 'rexml/document'
23 @location = hash[:location]
24 @description = hash[:description]
25 @attendance = hash[:attendance]
27 @artists = hash[:artists]
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}
34 @artist_string = Bold + @artists.join(', ') + Bold
40 return "%s %s @ %s (%s attending) %s" % [@date.strftime("%a %b, %d %Y"), @artist_string, @location, @attendance, @url]
42 return "%s %s @ %s %s" % [@date.strftime("%a %b, %d %Y"), @artist_string, @location, @url]
44 alias :to_s :compact_display
48 class LastFmPlugin < Plugin
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.")
57 APIKEY = "b25b959554ed76058ac220b7b2e0a026"
58 APIURL = "http://ws.audioscrobbler.com/2.0/?api_key=#{APIKEY}&"
72 def help(plugin, topic="")
73 case (topic.intern rescue nil)
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']}
77 _("lastfm artist <name> => show information on artist <name> from last.fm")
79 _("lastfm album <name> => show information on album <name> from last.fm [not implemented yet]")
81 _("lastfm track <name> => search tracks matching <name> on last.fm")
83 _("lastfm now [<user>] => show the now playing track from last.fm. np [<user>] does the same.")
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/just played verbs. default \"is listening to\" and \"listened to\".")
87 _("lastfm who [<nick>] => show who <nick> is on last.fm. if <nick> is empty, show who you are on lastfm.")
89 _("lastfm compare [<nick1>] <nick2> => show musical taste compatibility between nick1 (or user if omitted) and nick2")
91 _("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")
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'])
99 location = artist = nil
100 location = params[:location].to_s if params[:location]
101 artist = params[:who].to_s if params[:who]
105 uri = "#{APIURL}method=geo.getevents&location=#{CGI.escape location}"
106 emptymsg = _("no events found in %{location}") % {:location => location}
108 uri = "#{APIURL}method=artist.getevents&artist=#{CGI.escape artist}"
109 emptymsg = _("no events found by %{artist}") % {:artist => artist}
111 xml = @bot.httputil.get_response(uri)
113 doc = Document.new xml.body
114 if xml.class == Net::HTTPInternalServerError
115 if doc.root and doc.root.attributes["status"] == "failed"
116 m.reply doc.root.elements["error"].text
118 m.reply _("could not retrieve events")
121 disp_events = Array.new
123 doc.root.elements.each("events/event"){ |e|
125 h[:title] = e.elements["title"].text
126 venue = e.elements["venue"].elements["name"].text
127 city = e.elements["venue"].elements["location"].elements["city"].text
128 country = e.elements["venue"].elements["location"].elements["country"].text
129 h[:location] = Underline + venue + Underline + " #{Bold + city + Bold}, #{country}"
130 date = e.elements["startDate"].text.split
131 h[:date] = Time.utc(date[3].to_i, date[2], date[1].to_i)
132 h[:desc] = e.elements["description"].text
133 h[:url] = e.elements["url"].text
135 if node.kind_of? Element and node.attributes["name"] == "attendance" then
136 h[:attendance] = node.text
140 e.elements.each("artists/artist"){ |a|
143 h[:artists] = artists
144 events << LastFmEvent.new(h)
150 events[0...num].each { |event|
151 disp_events << event.to_s
153 m.reply disp_events.join(' | '), :split_at => /\s+\|\s+/
157 def tasteometer(m, params)
158 opts = { :cache => false }
159 user1 = resolve_username(m, params[:user1])
160 user2 = resolve_username(m, params[:user2])
161 xml = @bot.httputil.get_response("#{APIURL}method=tasteometer.compare&type1=user&type2=user&value1=#{CGI.escape user1}&value2=#{CGI.escape user2}", opts)
162 doc = Document.new xml.body
164 m.reply _("last.fm parsing failed")
167 if xml.class == Net::HTTPBadRequest
168 if doc.root.elements["error"].attributes["code"] == "7" then
169 error = doc.root.elements["error"].text
170 error.match(/Invalid username: \[(.*)\]/);
173 m.reply _("%{u} doesn't exist on last.fm") % {:u => baduser}
176 m.reply _("error: %{e}") % {:e => doc.root.element["error"].text}
180 now = artist = track = albumtxt = date = nil
181 score = doc.root.elements["comparison/result/score"].text.to_f
187 rating = _("Very High")
195 rating = _("Very Low")
197 m.reply _("%{a}'s and %{b}'s musical compatibility rating is: %{r}") % {:a => user1, :b => user2, :r => rating}
200 def now_playing(m, params)
201 opts = { :cache => false }
202 user = resolve_username(m, params[:who])
203 xml = @bot.httputil.get_response("#{APIURL}method=user.getrecenttracks&user=#{CGI.escape user}", opts)
204 doc = Document.new xml.body
206 m.reply _("last.fm parsing failed")
209 if xml.class == Net::HTTPBadRequest
210 if doc.root.elements["error"].text == "Invalid user name supplied" then
211 m.reply _("%{user} doesn't exist on last.fm, perhaps they need to: lastfm 2 <username>") % {
216 m.reply _("error: %{e}") % {:e => doc.root.element["error"].text}
220 now = artist = track = albumtxt = date = nil
221 unless doc.root.elements[1].has_elements?
222 m.reply _("%{u} hasn't played anything recently") % {:u => user}
225 first = doc.root.elements[1].elements[1]
226 now = first.attributes["nowplaying"]
227 artist = first.elements["artist"].text
228 track = first.elements["name"].text
229 albumtxt = first.elements["album"].text
232 year = get_album(artist, albumtxt)[2]
233 album = "[#{albumtxt}, #{year}] " if year
236 date = XPath.first(first, "//date")
238 time = date.attributes["uts"]
239 past = Time.at(time.to_i)
242 verb = _("is listening to")
243 if @registry.has_key? "#{m.sourcenick}_verb_present"
244 verb = @registry["#{m.sourcenick}_verb_present"]
246 m.reply _("%{u} %{v} \"%{t}\" by %{a} %{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album}
248 verb = _("listened to")
249 if @registry.has_key? "#{m.sourcenick}_verb_past"
250 verb = @registry["#{m.sourcenick}_verb_past"]
252 ago = Utils.timeago(past)
253 m.reply _("%{u} %{v} \"%{t}\" by %{a} %{b}%{p}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago}
257 def find_artist(m, params)
258 xml = @bot.httputil.get("#{APIURL}method=artist.getinfo&artist=#{CGI.escape params[:artist].to_s}")
260 m.reply _("I had problems getting info for %{a}") % {:a => params[:artist]}
263 doc = Document.new xml
265 m.reply _("last.fm parsing failed")
268 first = doc.root.elements["artist"]
269 artist = first.elements["name"].text
270 playcount = first.elements["stats"].elements["playcount"].text
271 listeners = first.elements["stats"].elements["listeners"].text
272 summary = first.elements["bio"].elements["summary"].text
273 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}
274 m.reply summary.ircify_html
277 def find_track(m, params)
278 track = params[:track].to_s
279 xml = @bot.httputil.get("#{APIURL}method=track.search&track=#{CGI.escape track}")
281 m.reply _("I had problems getting info for %{a}") % {:a => track}
285 doc = Document.new xml
287 m.reply _("last.fm parsing failed")
291 results = doc.root.elements["results/opensearch:totalResults"].text.to_i rescue 0
295 doc.root.each_element("results/trackmatches/track") do |track|
296 hits << _("%{bold}%{t}%{bold} by %{bold}%{a}%{bold} (%{n} listeners)") % {
297 :t => track.elements["name"].text,
298 :a => track.elements["artist"].text,
299 :n => track.elements["listeners"].text,
303 m.reply hits.join(' -- '), :split_at => ' -- '
306 m.reply _("last.fm parsing failed")
309 m.reply _("track %{a} not found") % {:a => track}
313 def get_album(artist, album)
314 xml = @bot.httputil.get("#{APIURL}method=album.getinfo&artist=#{CGI.escape artist}&album=#{CGI.escape album}")
316 return [_("I had problems getting album info")]
318 doc = Document.new xml
320 return [_("last.fm parsing failed")]
322 album = date = playcount = artist = date = year = nil
323 first = doc.root.elements["album"]
324 artist = first.elements["artist"].text
325 playcount = first.elements["playcount"].text
326 album = first.elements["name"].text
327 date = first.elements["releasedate"].text
328 unless date.strip.length < 2
329 year = date.strip.split[2].chop
331 result = [artist, album, year, playcount]
335 def find_album(m, params)
336 album = get_album(params[:artist].to_s, params[:album].to_s)
338 m.reply _("I couldn't locate: \"%{a}\" by %{r}") % {:a => params[:album], :r => params[:artist]}
341 year = "(#{album[2]}) " unless album[2] == nil
342 m.reply _("the album \"%{a}\" by %{r} %{y}has been played %{c} times") % {:a => album[1], :r => album[0], :y => year, :c => album[3]}
345 def set_user(m, params)
346 user = params[:who].to_s
348 @registry[ nick ] = user
349 m.reply _("okay, I'll remember that %{n} is %{u} on last.fm") % {:n => nick, :u => user}
352 def set_verb(m, params)
353 past = params[:past].to_s
354 present = params[:present].to_s
355 key = "#{m.sourcenick}_verb_"
356 @registry[ "#{key}past" ] = past
357 @registry[ "#{key}present" ] = present
358 m.reply _("okay, I'll remember that %{n} prefers \"%{r}\" and \"%{p}\"") % {:n => m.sourcenick, :p => past, :r => present}
361 def get_user(m, params)
364 nick = params[:who].to_s
368 if @registry.has_key? nick
369 user = @registry[ nick ]
370 m.reply _("%{nick} is %{user} on last.fm") % {
375 m.reply _("sorry, I don't know who %{n} is on last.fm, perhaps they need to: lastfm set user <username>") % {:n => nick}
379 # TODO this user data retrieval should be upgraded to API 2.0 but it would need separate parsing
380 # for each dataset, or almost
381 def lastfm(m, params)
382 action = params[:action].intern
383 action = :neighbours if action == :neighbors
384 action = :recenttracks if action == :recentracks
385 action = :topalbums if action == :topalbum
386 action = :topartists if action == :topartist
387 action = :toptags if action == :toptag
388 user = resolve_username(m, params[:user])
390 data = @bot.httputil.get("http://ws.audioscrobbler.com/1.0/user/#{user}/#{action}.txt")
391 m.reply "#{action} for #{user}:"
392 m.reply data.to_a[0..3].map{|l| l.split(',',2)[-1].chomp}.join(", ")
394 m.reply "could not find #{action} for #{user} (is #{user} a user?). perhaps you need to: lastfm set <username>"
398 def resolve_username(m, name)
399 name = m.sourcenick if name.nil?
400 @registry[name] or name
404 plugin = LastFmPlugin.new
405 plugin.map 'lastfm [:num] event[s] in *location', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
406 plugin.map 'lastfm [:num] event[s] by *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
407 plugin.map 'lastfm [:num] event[s] [for] *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
408 plugin.map 'lastfm artist *artist', :action => :find_artist, :thread => true
409 plugin.map 'lastfm album *album [by *artist]', :action => :find_album
410 plugin.map 'lastfm track *track', :action => :find_track, :thread => true
411 plugin.map 'lastfm set user[name] :who', :action => :set_user, :thread => true
412 plugin.map 'lastfm set verb *present, *past', :action => :set_verb, :thread => true
413 plugin.map 'lastfm who [:who]', :action => :get_user, :thread => true
414 plugin.map 'lastfm compare to :user2', :action => :tasteometer, :thread => true
415 plugin.map 'lastfm compare [:user1] [to] :user2', :action => :tasteometer, :thread => true
416 plugin.map "lastfm [user] :action [:user]", :thread => true,
417 :requirements => { :action =>
418 /^(?:events|friends|neighbou?rs|playlists|recent?tracks|top(?:album|artist|tag)s?|weekly(?:album|artist|track)chart|weeklychartlist)$/
420 plugin.map 'lastfm [now] [:who]', :action => :now_playing, :thread => true
421 plugin.map 'np [:who]', :action => :now_playing, :thread => true