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>
9 # Author:: Raine Virta <rane@kapsi.fi>
11 # Copyright:: (C) 2005 Jeremy Voorhis
12 # Copyright:: (C) 2007 Giuseppe Bilotta
13 # Copyright:: (C) 2008 Casey Link
14 # Copyright:: (C) 2009 Raine Virta
18 require 'rexml/document'
25 @location = hash[:location]
26 @description = hash[:description]
27 @attendance = hash[:attendance]
29 @artists = hash[:artists]
31 if @artists.length > 10 #more than 10 artists and it floods
32 diff = @artists.length - 10
33 @artist_string = Bold + @artists[0..10].join(', ') + Bold
34 @artist_string << _(" and %{n} more...") % {:n => diff}
36 @artist_string = Bold + @artists.join(', ') + Bold
41 unless @attendance.zero?
42 return "%s %s @ %s (%s attending) %s" % [@date.strftime("%a, %b %d"), @artist_string, @location, @attendance, @url]
44 return "%s %s @ %s %s" % [@date.strftime("%a, %b %d"), @artist_string, @location, @url]
46 alias :to_s :compact_display
50 define_structure :LastFmVenue, :id, :city, :street, :postal, :country, :name, :url, :lat, :long
52 class LastFmPlugin < Plugin
54 Config.register Config::IntegerValue.new('lastfm.max_events',
55 :default => 25, :validate => Proc.new{|v| v > 1},
56 :desc => "Maximum number of events to display.")
57 Config.register Config::IntegerValue.new('lastfm.default_events',
58 :default => 3, :validate => Proc.new{|v| v > 1},
59 :desc => "Default number of events to display.")
60 Config.register Config::IntegerValue.new('lastfm.max_shouts',
61 :default => 5, :validate => Proc.new{|v| v > 1},
62 :desc => "Maximum number of user shouts to display.")
63 Config.register Config::IntegerValue.new('lastfm.default_shouts',
64 :default => 3, :validate => Proc.new{|v| v > 1},
65 :desc => "Default number of user shouts to display.")
66 Config.register Config::IntegerValue.new('lastfm.max_user_data',
67 :default => 25, :validate => Proc.new{|v| v > 1},
68 :desc => "Maximum number of user data entries (except events and shouts) to display.")
69 Config.register Config::IntegerValue.new('lastfm.default_user_data',
70 :default => 10, :validate => Proc.new{|v| v > 1},
71 :desc => "Default number of user data entries (except events and shouts) to display.")
73 APIKEY = "b25b959554ed76058ac220b7b2e0a026"
74 APIURL = "http://ws.audioscrobbler.com/2.0/?api_key=#{APIKEY}&"
88 def help(plugin, topic="")
89 period = _(", where <period> can be one of: 3|6|12 months, a year")
90 case (topic.intern rescue nil)
92 _("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']}
94 _("lastfm artist <name> => show information on artist <name> from last.fm")
96 _("lastfm album <name> => show information on album <name> from last.fm [not implemented yet]")
98 _("lastfm track <name> => search tracks matching <name> on last.fm")
100 _("lastfm now [<nick>] => show the now playing track from last.fm. np [<nick>] does the same.")
102 _("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\".")
104 _("lastfm who [<nick>] => show who <nick> is on last.fm. if <nick> is empty, show who you are on lastfm.")
106 _("lastfm compare [<nick1>] <nick2> => show musical taste compatibility between nick1 (or user if omitted) and nick2")
108 _("lastfm shouts [<nick>] => show shouts to <nick>")
110 _("lastfm friends [<nick>] => show <nick>'s friends")
111 when :neighbors, :neighbours
112 _("lastfm neighbors [<nick>] => show people who share similar musical taste as <nick>")
114 _("lastfm loved[tracks] [<nick>] => show tracks that <nick> has loved")
115 when :recenttracks, :recentracks
116 _("lastfm recent[tracks] [<nick>] => show tracks that <nick> has recently played")
118 _("lastfm topalbums [<nick>] [over <period>] => show <nick>'s top albums%{p}") % { :p => period }
120 _("lastfm topartists [<nick>] [over <period>] => show <nick>'s top artists%{p}") % { :p => period }
122 _("lastfm toptracks [<nick>] [over <period>] => show <nick>'s top tracks%{p}") % { :p => period }
123 when :weeklyalbumchart
124 _("lastfm weeklyalbumchart [<nick>] => show <nick>'s weekly album chart")
125 when :weeklyartistchart
126 _("lastfm weeklyartistchart [<nick>] => show <nick>'s weekly artist chart")
127 when :weeklytrackchart
128 _("lastfm weeklyartistchart [<nick>] => show <nick>'s weekly track chart")
130 _("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")
134 # TODO allow searching by country etc.
136 # Options: name, limit
137 def search_venue_by(options)
139 params[:venue] = CGI.escape(options[:name])
140 options.delete(:name)
141 params.merge!(options)
143 uri = "#{APIURL}method=venue.search&"
144 uri << params.to_a.map {|e| e.join("=")}.join("&")
146 xml = @bot.httputil.get_response(uri)
147 doc = Document.new xml.body
150 doc.root.elements.each("results/venuematches/venue") do |v|
151 venue = LastFmVenue.new
152 venue.id = v.elements["id"].text.to_i
153 venue.url = v.elements["url"].text
154 venue.lat = v.elements["location/geo:point/geo:lat"].text.to_f
155 venue.long = v.elements["location/geo:point/geo:long"].text.to_f
156 venue.name = v.elements["name"].text
157 venue.city = v.elements["location/city"].text
158 venue.street = v.elements["location/street"].text
159 venue.postal = v.elements["location/postalcode"].text
160 venue.country = v.elements["location/country"].text
167 def find_events(m, params)
168 num = params[:num] || @bot.config['lastfm.default_events']
169 num = num.to_i.clip(1, @bot.config['lastfm.max_events'])
171 location = params[:location]
172 artist = params[:who]
173 venue = params[:venue]
174 user = resolve_username(m, params[:user])
177 uri = "#{APIURL}method=geo.getevents&location=#{CGI.escape location.to_s}"
178 emptymsg = _("no events found in %{location}") % {:location => location.to_s}
180 venues = search_venue_by(:name => venue.to_s, :limit => 1)
182 uri = "#{APIURL}method=venue.getevents&venue=#{venue.id}"
184 uri = "#{APIURL}method=artist.getevents&artist=#{CGI.escape artist.to_s}"
185 emptymsg = _("no events found by %{artist}") % {:artist => artist.to_s}
187 uri = "#{APIURL}method=user.getevents&user=#{CGI.escape user}"
188 emptymsg = _("%{user} is not attending any events") % {:user => user}
190 xml = @bot.httputil.get_response(uri)
192 doc = Document.new xml.body
193 if xml.class == Net::HTTPInternalServerError
194 if doc.root and doc.root.attributes["status"] == "failed"
195 m.reply doc.root.elements["error"].text
197 m.reply _("could not retrieve events")
200 disp_events = Array.new
202 doc.root.elements.each("events/event"){ |e|
204 h[:title] = e.elements["title"].text
205 venue = e.elements["venue"].elements["name"].text
206 city = e.elements["venue"].elements["location"].elements["city"].text
207 country = e.elements["venue"].elements["location"].elements["country"].text
208 h[:location] = Underline + venue + Underline + " #{Bold + city + Bold}, #{country}"
209 date = e.elements["startDate"].text.split
210 h[:date] = Time.utc(date[3].to_i, date[2], date[1].to_i)
211 h[:desc] = e.elements["description"].text
212 h[:url] = e.elements["url"].text
213 h[:attendance] = e.elements["attendance"].text.to_i
215 e.elements.each("artists/artist"){ |a|
218 h[:artists] = artists
219 events << LastFmEvent.new(h)
225 events[0...num].each { |event|
226 disp_events << event.to_s
228 m.reply disp_events.join(' | '), :split_at => /\s+\|\s+/
232 def tasteometer(m, params)
233 opts = { :cache => false }
234 user1 = resolve_username(m, params[:user1])
235 user2 = resolve_username(m, params[:user2])
236 xml = @bot.httputil.get_response("#{APIURL}method=tasteometer.compare&type1=user&type2=user&value1=#{CGI.escape user1}&value2=#{CGI.escape user2}", opts)
237 doc = Document.new xml.body
239 m.reply _("last.fm parsing failed")
242 if xml.class == Net::HTTPBadRequest
243 if doc.root.elements["error"].attributes["code"] == "7" then
244 error = doc.root.elements["error"].text
245 error.match(/Invalid username: \[(.*)\]/);
248 m.reply _("%{u} doesn't exist on last.fm") % {:u => baduser}
251 m.reply _("error: %{e}") % {:e => doc.root.element["error"].text}
255 score = doc.root.elements["comparison/result/score"].text.to_f
256 artists = doc.root.get_elements("comparison/result/artists/artist").map { |e| e.elements["name"].text}
261 rating = _("Very High")
269 rating = _("Very Low")
272 reply = _("%{a}'s and %{b}'s musical compatibility rating is %{bold}%{r}%{bold}") % {
275 :r => rating.downcase,
279 reply << _(" and music they have in common includes: %{artists}") % {
280 :artists => artists.join(", ")
281 } unless artists.empty?
286 def now_playing(m, params)
287 opts = { :cache => false }
288 user = resolve_username(m, params[:who])
289 xml = @bot.httputil.get_response("#{APIURL}method=user.getrecenttracks&user=#{CGI.escape user}", opts)
290 doc = Document.new xml.body
292 m.reply _("last.fm parsing failed")
295 if xml.class == Net::HTTPBadRequest
296 if doc.root.elements["error"].text == "Invalid user name supplied" then
297 m.reply _("%{user} doesn't exist on last.fm, perhaps they need to: lastfm user <username>") % {
302 m.reply _("error: %{e}") % {:e => doc.root.element["error"].text}
306 now = artist = track = albumtxt = date = nil
307 unless doc.root.elements[1].has_elements?
308 m.reply _("%{u} hasn't played anything recently") % {:u => user}
311 first = doc.root.elements[1].elements[1]
312 now = first.attributes["nowplaying"]
313 artist = first.elements["artist"].text
314 track = first.elements["name"].text
315 albumtxt = first.elements["album"].text
318 year = get_album(artist, albumtxt)[2]
319 album = "[#{albumtxt}, #{year}]" if year
322 date = XPath.first(first, "//date")
324 time = date.attributes["uts"]
325 past = Time.at(time.to_i)
328 verb = _("is listening to")
329 if @registry.has_key? "#{m.sourcenick}_verb_present"
330 verb = @registry["#{m.sourcenick}_verb_present"]
332 reply = _("%{u} %{v} \"%{t}\" by %{a} %{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album}
334 verb = _("listened to")
335 if @registry.has_key? "#{m.sourcenick}_verb_past"
336 verb = @registry["#{m.sourcenick}_verb_past"]
338 ago = Utils.timeago(past)
339 reply = _("%{u} %{v} \"%{t}\" by %{a} %{b} %{p}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago}
342 reply << _("; see %{uri} for more") % { :uri => "http://www.last.fm/user/#{CGI.escape user}"}
346 def find_artist(m, params)
347 info_xml = @bot.httputil.get("#{APIURL}method=artist.getinfo&artist=#{CGI.escape params[:artist].to_s}")
349 m.reply _("I had problems getting info for %{a}") % {:a => params[:artist]}
352 info_doc = Document.new info_xml
354 m.reply _("last.fm parsing failed")
357 tags_xml = @bot.httputil.get("#{APIURL}method=artist.gettoptags&artist=#{CGI.escape params[:artist].to_s}")
358 tags_doc = Document.new tags_xml
360 first = info_doc.root.elements["artist"]
361 artist = first.elements["name"].text
362 url = first.elements["url"].text
364 %w(playcount listeners).each do |e|
365 t = first.elements["stats/#{e}"].text
366 stats[e.to_sym] = t.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
368 summary = first.elements["bio"].elements["summary"].text
369 similar = first.get_elements("similar/artist").map { |a|
370 _("%{b}%{a}%{b}") % { :a => a.elements["name"].text, :b => Bold } }
371 tags = tags_doc.root.get_elements("toptags/tag")[0..4].map { |t|
372 _("%{u}%{t}%{u}") % { :t => t.elements["name"].text, :u => Underline } }
373 reply = _("%{b}%{a}%{b} <%{u}> has been played %{b}%{c}%{b} times and is being listened to by %{b}%{l}%{b} people") % {
374 :b => Bold, :a => artist, :u => url, :c => stats[:playcount], :l => stats[:listeners] }
375 reply << _(". Tagged as: %{t}") % {
376 :t => tags.join(", "), :b => Bold } unless tags.empty?
377 reply << _(". Similar artists: %{s}") % {
378 :s => similar.join(", "), :b => Bold } unless similar.empty?
380 m.reply summary.ircify_html
383 def find_track(m, params)
384 track = params[:track].to_s
385 xml = @bot.httputil.get("#{APIURL}method=track.search&track=#{CGI.escape track}")
387 m.reply _("I had problems getting info for %{a}") % {:a => track}
391 doc = Document.new xml
393 m.reply _("last.fm parsing failed")
397 results = doc.root.elements["results/opensearch:totalResults"].text.to_i rescue 0
401 doc.root.each_element("results/trackmatches/track") do |track|
402 hits << _("%{bold}%{t}%{bold} by %{bold}%{a}%{bold} (%{n} listeners)") % {
403 :t => track.elements["name"].text,
404 :a => track.elements["artist"].text,
405 :n => track.elements["listeners"].text,
409 m.reply hits.join(' -- '), :split_at => ' -- '
412 m.reply _("last.fm parsing failed")
415 m.reply _("track %{a} not found") % {:a => track}
419 def get_album(artist, album)
420 xml = @bot.httputil.get("#{APIURL}method=album.getinfo&artist=#{CGI.escape artist}&album=#{CGI.escape album}")
422 return [_("I had problems getting album info")]
424 doc = Document.new xml
426 return [_("last.fm parsing failed")]
428 album = date = playcount = artist = date = year = nil
429 first = doc.root.elements["album"]
430 artist = first.elements["artist"].text
431 playcount = first.elements["playcount"].text
432 album = first.elements["name"].text
433 date = first.elements["releasedate"].text
434 unless date.strip.length < 2
435 year = date.strip.split[2].chop
437 result = [artist, album, year, playcount]
441 def find_album(m, params)
442 album = get_album(params[:artist].to_s, params[:album].to_s)
444 m.reply _("I couldn't locate: \"%{a}\" by %{r}") % {:a => params[:album], :r => params[:artist]}
447 year = "(#{album[2]}) " unless album[2] == nil
448 m.reply _("the album \"%{a}\" by %{r} %{y}has been played %{c} times") % {:a => album[1], :r => album[0], :y => year, :c => album[3]}
451 def set_user(m, params)
452 user = params[:who].to_s
454 @registry[ nick ] = user
455 m.reply _("okay, I'll remember that %{n} is %{u} on last.fm") % {:n => nick, :u => user}
458 def set_verb(m, params)
459 past = params[:past].to_s
460 present = params[:present].to_s
461 key = "#{m.sourcenick}_verb_"
462 @registry[ "#{key}past" ] = past
463 @registry[ "#{key}present" ] = present
464 m.reply _("okay, I'll remember that %{n} prefers \"%{r}\" and \"%{p}\"") % {:n => m.sourcenick, :p => past, :r => present}
467 def get_user(m, params)
470 nick = params[:who].to_s
474 if @registry.has_key? nick
475 user = @registry[ nick ]
476 m.reply _("%{nick} is %{user} on last.fm") % {
481 m.reply _("sorry, I don't know who %{n} is on last.fm, perhaps they need to: lastfm set user <username>") % {:n => nick}
485 def lastfm(m, params)
486 action = case params[:action]
487 when "neighbors" then "neighbours"
488 when "recentracks", "recent" then "recenttracks"
489 when "loved" then "lovedtracks"
490 when /^weekly(track|album|artist)s$/
493 find_events(m, params)
500 num = params[:num] || @bot.config['lastfm.default_shouts']
501 num = num.to_i.clip(1, @bot.config['lastfm.max_shouts'])
503 num = params[:num] || @bot.config['lastfm.default_user_data']
504 num = num.to_i.clip(1, @bot.config['lastfm.max_user_data'])
507 user = resolve_username(m, params[:user])
508 uri = "#{APIURL}method=user.get#{action}&user=#{CGI.escape user}"
510 if period = params[:period]
511 period_uri = (period.last == "year" ? "12month" : period.first + "month")
512 uri << "&period=#{period_uri}"
516 res = @bot.httputil.get_response(uri)
517 raise _("no response body") unless res.body
518 rescue Exception => e
519 m.reply _("I had problems accessing last.fm: %{e}") % {:e => e.message}
522 doc = Document.new(res.body)
524 m.reply _("last.fm parsing failed")
529 when Net::HTTPBadRequest
530 if doc.root and doc.root.attributes["status"] == "failed"
531 m.reply "error: " << doc.root.elements["error"].text.downcase
536 seemore = _("; see %{uri} for more")
539 friends = doc.root.get_elements("friends/user").map do |u|
540 u.elements["name"].text
544 reply = _("%{user} has no friends :(")
545 elsif friends.length <= num
546 reply = _("%{user} has %{total} friends: %{friends}")
548 reply = _("%{user} has %{total} friends, including %{friends}")
553 :total => friends.size,
554 :friends => friends.shuffle[0, num].join(", "),
555 :uri => "http://www.last.fm/user/#{CGI.escape user}/friends"
558 loved = doc.root.get_elements("lovedtracks/track").map do |track|
559 [track.elements["artist/name"].text, track.elements["name"].text].join(" - ")
561 loved_prep = loved.shuffle[0, num].to_enum(:each_with_index).collect { |e,i| (i % 2).zero? ? Underline+e+Underline : e }
564 reply = _("%{user} has not loved any tracks")
565 elsif loved.length <= num
566 reply = _("%{user} has loved %{total} tracks: %{tracks}")
568 reply = _("%{user} has loved %{total} tracks, including %{tracks}")
573 :total => loved.size,
574 :tracks => loved_prep.join(", "),
575 :uri => "http://www.last.fm/user/#{CGI.escape user}/library/loved"
578 nbrs = doc.root.get_elements("neighbours/user").map do |u|
579 u.elements["name"].text
583 reply = _("no one seems to share %{user}'s musical taste")
584 elsif nbrs.length <= num
585 reply = _("%{user}'s musical neighbours are %{nbrs}")
587 reply = _("%{user}'s musical neighbours include %{nbrs}")
592 :nbrs => nbrs.shuffle[0, num].join(", "),
593 :uri => "http://www.last.fm/user/#{CGI.escape user}/neighbours"
596 tracks = doc.root.get_elements("recenttracks/track").map do |track|
597 [track.elements["artist"].text, track.elements["name"].text].join(" - ")
601 tracks.each do |track|
602 if t = counts.assoc(track)
603 counts[counts.rindex(t)] = [track, t[-1] += 1]
609 tracks_prep = counts[0, num].to_enum(:each_with_index).map do |e,i|
610 str = (i % 2).zero? ? Underline+e[0]+Underline : e[0]
611 str << " (%{i} times%{m})" % {
613 :m => counts.size == 1 ? _(" or more") : nil
619 m.reply _("%{user} hasn't played anything recently") % { :user => user }
621 m.reply _("%{user} has recently played %{tracks}") %
622 { :user => user, :tracks => tracks_prep.join(", ") }
625 shouts = doc.root.get_elements("shouts/shout")
627 m.reply _("there are no shouts for %{user}") % { :user => user }
629 shouts[0, num].each do |shout|
630 m.reply _("<%{author}> %{body}") % {
631 :body => shout.elements["body"].text,
632 :author => shout.elements["author"].text,
636 when :toptracks, :topalbums, :topartists, :weeklytrackchart, :weeklyalbumchart, :weeklyartistchart
637 type = action.to_s.scan(/track|album|artist/).to_s
638 items = doc.root.get_elements("#{action}/#{type}").map do |item|
640 when :weeklytrackchart, :weeklyalbumchart
641 format = "%{artist} - %{title} (%{bold}%{plays}%{bold})"
642 artist = item.elements["artist"].text
643 when :weeklyartistchart, :topartists
644 format = "%{artist} (%{bold}%{plays}%{bold})"
645 artist = item.elements["name"].text
646 when :toptracks, :topalbums
647 format = "%{artist} - %{title} (%{bold}%{plays}%{bold})"
648 artist = item.elements["artist/name"].text
653 :title => item.elements["name"].text,
654 :plays => item.elements["playcount"].text,
659 m.reply _("%{user} hasn't played anything in this period of time") % { :user => user }
661 m.reply items[0, num].join(", ")
666 def resolve_username(m, name)
667 name = m.sourcenick if name.nil?
668 @registry[name] or name
672 plugin = LastFmPlugin.new
673 plugin.map 'lastfm [:num] event[s] in *location', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
674 plugin.map 'lastfm [:num] event[s] by *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
675 plugin.map 'lastfm [:num] event[s] at *venue', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
676 plugin.map 'lastfm [:num] event[s] [for] *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
677 plugin.map 'lastfm artist *artist', :action => :find_artist, :thread => true
678 plugin.map 'lastfm album *album [by *artist]', :action => :find_album
679 plugin.map 'lastfm track *track', :action => :find_track, :thread => true
680 plugin.map 'lastfm set user[name] :who', :action => :set_user, :thread => true
681 plugin.map 'lastfm set verb *present, *past', :action => :set_verb, :thread => true
682 plugin.map 'lastfm who [:who]', :action => :get_user, :thread => true
683 plugin.map 'lastfm compare to :user2', :action => :tasteometer, :thread => true
684 plugin.map 'lastfm compare [:user1] [to] :user2', :action => :tasteometer, :thread => true
685 plugin.map "lastfm [user] [:num] :action [:user]", :thread => true,
687 :action => /^(?:events|shouts|friends|neighbou?rs|loved(?:tracks)?|recent(?:t?racks)?|top(?:album|artist|track)s?|weekly(?:albums?|artists?|tracks?)(?:chart)?)$/,
690 plugin.map 'lastfm [user] [:num] :action [:user] over [*period]', :thread => true,
692 :action => /^(?:top(?:album|artist|track)s?)$/,
693 :period => /^(?:(?:3|6|12) months)|(?:a\s|1\s)?year$/,
696 plugin.map 'lastfm [now] [:who]', :action => :now_playing, :thread => true
697 plugin.map 'np [:who]', :action => :now_playing, :thread => true