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'
19 def initialize(url, date, artist, location, description)
24 @description = description
28 return "%s %s @ %s %s" % [@date.strftime("%a %b, %d %Y"), @artist, @location, @url]
30 alias :to_s :compact_display
34 class LastFmPlugin < Plugin
36 Config.register Config::IntegerValue.new('lastfm.max_events',
37 :default => 25, :validate => Proc.new{|v| v > 1},
38 :desc => "Maximum number of events to display.")
39 Config.register Config::IntegerValue.new('lastfm.default_events',
40 :default => 3, :validate => Proc.new{|v| v > 1},
41 :desc => "Default number of events to display.")
43 LASTFM = "http://www.last.fm"
45 APIKEY = "b25b959554ed76058ac220b7b2e0a026"
46 APIURL = "http://ws.audioscrobbler.com/2.0/?api_key=#{APIKEY}&"
60 def help(plugin, topic="")
61 case (topic.intern rescue nil)
63 _("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']}
65 _("lastfm artist <name> => show information on artist <name> from last.fm")
67 _("lastfm album <name> => show information on album <name> from last.fm [not implemented yet]")
69 _("lastfm now [<user>] => show the now playing track from last.fm. np [<user>] does the same.")
71 _("lastfm set nick <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\".")
73 _("lastfm who [<nick>] => show who <nick> is at last.fm. if <nick> is empty, show who you are at lastfm.")
75 _("lastfm [<user>] => show your or <user>'s now playing track at lastfm. np [<user>] => same as 'lastfm'. lastfm <function> [<user>] => lastfm data for <user> on last.fm where <function> in [recenttracks, topartists, topalbums, toptracks, tags, friends, neighbors]. other topics: events, artist, album, now, set, who")
79 def find_events(m, params)
80 num = params[:num] || @bot.config['lastfm.default_events']
81 num = num.to_i.clip(1, @bot.config['lastfm.max_events'])
83 location = artist = nil
84 location = params[:location].to_s if params[:location]
85 artist = params[:who].to_s if params[:who]
89 uri = URI.escape("#{APIURL}method=geo.getevents&location=#{location}")
91 uri = URI.escape("#{APIURL}method=artist.getevents&artist=#{artist}")
93 xml = @bot.httputil.get_response(uri)
95 doc = Document.new xml.body
96 if xml.class == Net::HTTPInternalServerError
97 if doc.root.attributes["status"] == "failed"
98 m.reply doc.root.elements["error"].text
100 m.reply _("Could not retrieve events")
103 disp_events = Array.new
105 doc.root.elements.each("events/event"){ |e|
106 title = e.elements["title"].text
107 venue = e.elements["venue"].elements["name"].text
108 city = e.elements["venue"].elements["location"].elements["city"].text
109 country = e.elements["venue"].elements["location"].elements["country"].text
110 loc = Bold + venue + Bold + " #{city}, #{country}"
111 date = e.elements["startDate"].text.split
112 date = Time.utc(date[3].to_i, date[2], date[1].to_i)
113 desc = e.elements["description"].text
114 url = e.elements["url"].text
116 e.elements.each("artists/artist"){ |a|
119 if artists.length > 10 #more than 10 artists and it floods
120 diff = artists.length - 10
121 artists = artists[0..10]
122 artists << _(" and %{n} more...") % {:n => diff}
124 artists = artists.join(", ")
125 events << LastFmEvent.new(url, date, artists, loc, desc)
127 events[0...num].each { |event|
128 disp_events << event.to_s
130 m.reply disp_events.join(' | '), :split_at => /\s+\|\s+/
134 def tasteometer(m, params)
135 opts = { :cache => false }
136 user1 = params[:user1].to_s
137 user2 = params[:user2].to_s
138 xml = @bot.httputil.get_response("#{APIURL}method=tasteometer.compare&type1=user&type2=user&value1=#{user1}&value2=#{user2}", opts)
139 doc = Document.new xml.body
141 m.reply _("last.fm parsing failed")
144 if xml.class == Net::HTTPInternalServerError
145 if doc.root.elements["error"].attributes["code"] == "7" then
146 error = doc.root.elements["error"].text
147 error.match(/Invalid username: \[(.*)\]/);
148 if @registry.has_key? $1 and not params[:recurs]
150 params[:user1] = @registry[ $1 ]
152 params[:user2] = @registry[ $1 ]
154 params[:recurs] = true
155 tasteometer(m, params)
157 m.reply _("%{u} doesn't exist at last.fm. Perhaps you need to: lastfm set <username>") % {:u => baduser}
160 m.reply _("Bad: %{e}") % {:e => doc.root.element["error"].text}
163 now = artist = track = albumtxt = date = nil
164 score = doc.root.elements["comparison/result/score"].text.to_f
170 rating = _("Very High")
178 rating = _("Very Low")
180 m.reply _("%{a}'s and %{b}'s musical compatibility rating is: %{r}") % {:a => user1, :b => user2, :r => rating}
183 def now_playing(m, params)
184 opts = { :cache => false }
187 user = params[:who].to_s
188 elsif @registry.has_key? m.sourcenick
189 user = @registry[ m.sourcenick ]
193 xml = @bot.httputil.get_response("#{APIURL}method=user.getrecenttracks&user=#{user}", opts)
194 doc = Document.new xml.body
196 m.reply _("last.fm parsing failed")
199 if xml.class == Net::HTTPBadRequest
200 if doc.root.elements["error"].text == "Invalid user name supplied" then
201 if @registry.has_key? user and not params[:recurs]
202 params[:who] = @registry[ user ]
203 params[:recurs] = true
204 now_playing(m, params)
206 m.reply "#{user} doesn't exist at last.fm. Perhaps you need to: lastfm set <username>"
209 m.reply _("Error %{e}") % {:e => doc.root.element["error"].text}
212 now = artist = track = albumtxt = date = nil
213 unless doc.root.elements["recenttracks"].has_elements?
214 m.reply _("%{u} hasn't played anything recently") % {:u => user}
216 first = doc.root.elements[1].elements[1]
217 now = first.attributes["nowplaying"]
218 artist = first.elements["artist"].text
219 track = first.elements["name"].text
220 albumtxt = first.elements["album"].text
221 year = get_album(artist, albumtxt)[2]
222 album = "[#{albumtxt}, #{year}] " unless albumtxt == nil or year.length == 1
223 date = first.elements["date"].attributes["uts"]
224 past = Time.at(date.to_i)
226 verb = _("listening")
227 if @registry.has_key? "#{m.sourcenick}_verb_present"
228 verb = @registry["#{m.sourcenick}_verb_present"]
230 m.reply _("%{u} is %{v} to \"%{t}\" by %{a} %{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album}
233 if @registry.has_key? "#{m.sourcenick}_verb_past"
234 verb = @registry["#{m.sourcenick}_verb_past"]
236 ago = Utils.timeago(past)
237 m.reply _("%{u} %{v} to \"%{t}\" by %{a} %{b}%{p}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago}
241 def find_artist(m, params)
242 xml = @bot.httputil.get(URI.escape("#{APIURL}method=artist.getinfo&artist=#{params[:artist]}"))
244 m.reply _("I had problems getting info for %{a}.") % {:a => params[:artist]}
246 doc = Document.new xml
248 m.reply _("last.fm parsing failed")
250 first = doc.root.elements["artist"]
251 artist = first.elements["name"].text
252 playcount = first.elements["stats"].elements["plays"].text
253 listeners = first.elements["stats"].elements["listeners"].text
254 summary = first.elements["bio"].elements["summary"].text
255 m.reply _("\"%{a}\" has been played %{c} times and is being listened to by %{l} people.") % {:a => artist, :c => playcount, :l => listeners}
256 m.reply summary.strip
259 def get_album(artist, album)
260 xml = @bot.httputil.get(URI.escape("#{APIURL}method=album.getinfo&artist=#{artist}&album=#{album}"))
262 return [_("I had problems getting album info")]
264 doc = Document.new xml
266 return [_("last.fm parsing failed")]
268 album = date = playcount = artist = date = year = nil
269 first = doc.root.elements["album"]
270 artist = first.elements["artist"].text
271 playcount = first.elements["playcount"].text
272 album = first.elements["name"].text
273 date = first.elements["releasedate"].text
274 unless date.strip.length < 2
275 year = date.strip.split[2].chop
277 result = [artist, album, year, playcount]
281 def find_album(m, params)
282 album = get_album(params[:artist].to_s, params[:album].to_s)
284 m.reply _("I couldn't locate: \"%{a}\" by %{r}") % {:a => params[:album], :r => params[:artist]}
287 year = "(#{album[2]}) " unless album[2] == nil
288 m.reply _("The album \"%{a}\" by %{r} %{y}has been played %{c} times.") % {:a => album[1], :r => album[0], :y => year, :c => album[3]}
291 def set_user(m, params)
292 user = params[:who].to_s
294 @registry[ nick ] = user
295 m.reply _("Ok, I'll remember that %{n} is %{u} at last.fm") % {:n => nick, :u => user}
298 def set_verb(m, params)
299 past = params[:past].to_s
300 present = params[:present].to_s
301 key = "#{m.sourcenick}_verb_"
302 @registry[ "#{key}past" ] = past
303 @registry[ "#{key}present" ] = present
304 m.reply _("Ok, I'll remember that %{n} prefers %{p} and %{r}.") % {:n => m.sourcenick, :p => past, :r => present}
307 def get_user(m, params)
310 nick = params[:who].to_s
314 if @registry.has_key? nick
315 user = @registry[ nick ]
316 m.reply "#{nick} is #{user} at last.fm"
318 m.reply _("Sorry, I don't know who %{n} is at last.fm perhaps you need to: lastfm set <username>") % {:n => nick}
322 def lastfm(m, params)
323 action = params[:action].intern
324 action = :neighbours if action == :neighbors
326 if params[:user] then
327 user = params[:user].to_s
328 elsif @registry.has_key? m.sourcenick
329 user = @registry[ m.sourcenick ]
331 # m.reply "I don't know who you are on last.fm. Use 'lastfm set username' to identify yourself."
336 data = @bot.httputil.get("http://ws.audioscrobbler.com/1.0/user/#{user}/#{action}.txt")
337 m.reply "#{action} for #{user}:"
338 m.reply data.to_a[0..3].map{|l| l.split(',',2)[-1].chomp}.join(", ")
340 m.reply "could not find #{action} for #{user} (is #{user} a user?). perhaps you need to: lastfm set <username>"
345 plugin = LastFmPlugin.new
346 plugin.map 'lastfm [:num] event[s] in *location', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
347 plugin.map 'lastfm [:num] event[s] by *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
348 plugin.map 'lastfm [:num] event[s] [for] *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
349 plugin.map 'lastfm now :who', :action => :now_playing, :thread => true
350 plugin.map 'lastfm now', :action => :now_playing, :thread => true
351 plugin.map 'np :who', :action => :now_playing, :thread => true
352 plugin.map 'lastfm artist *artist', :action => :find_artist, :thread => true
353 plugin.map 'lastfm album *album [by *artist]', :action => :find_album
354 plugin.map 'lastfm set nick :who', :action => :set_user, :thread => true
355 plugin.map 'lastfm set verb :present :past', :action => :set_verb, :thread => true
356 plugin.map 'lastfm who :who', :action => :get_user, :thread => true
357 plugin.map 'lastfm who', :action => :get_user, :thread => true
358 plugin.map 'lastfm compare :user1 :user2', :action => :tasteometer, :thread => true
359 #plugin.map 'lastfm :action :user', :thread => true
360 #plugin.map 'lastfm :action', :thread => true
361 plugin.map 'np', :action => :now_playing, :thread => true
362 plugin.map 'lastfm', :action => :now_playing, :thread => true