# Author:: Jeremy Voorhis
# Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
# Author:: Casey Link <unnamedrambler@gmail.com>
+# Author:: Raine Virta <rane@kapsi.fi>
#
# Copyright:: (C) 2005 Jeremy Voorhis
# Copyright:: (C) 2007 Giuseppe Bilotta
# Copyright:: (C) 2008 Casey Link
+# Copyright:: (C) 2009 Raine Virta
#
# License:: GPL v2
require 'cgi'
class ::LastFmEvent
+ attr_reader :attendance, :date
+
def initialize(hash)
@url = hash[:url]
@date = hash[:date]
end
+define_structure :LastFmVenue, :id, :city, :street, :postal, :country, :name, :url, :lat, :long
+class ::Struct::LastFmVenue
+ def to_s
+ str = self.name.dup
+ if self.country
+ str << " (" << [self.city, self.country].compact.join(", ") << ")"
+ end
+ str
+ end
+end
+
class LastFmPlugin < Plugin
include REXML
Config.register Config::IntegerValue.new('lastfm.max_events',
end
def help(plugin, topic="")
+ period = _(", where <period> can be one of: 3|6|12 months, a year")
case (topic.intern rescue nil)
when :event, :events
- _("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']}
+ _("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>. lastfm [<num>] events at <venue> => show information on events at specific <venue>. The number of events <num> that can be displayed is optional, defaults to %{d} and cannot be higher than %{m}. Append 'sort by <what> [in <order> order]' to sort events. Events can be sorted by attendance or date (default) in ascending or descending order.") % {:d => @bot.config['lastfm.default_events'], :m => @bot.config['lastfm.max_events']}
when :artist
_("lastfm artist <name> => show information on artist <name> from last.fm")
when :album
when :track
_("lastfm track <name> => search tracks matching <name> on last.fm")
when :now, :np
- _("lastfm now [<user>] => show the now playing track from last.fm. np [<user>] does the same.")
+ _("lastfm now [<nick>] => show the now playing track from last.fm. np [<nick>] does the same.")
when :set
_("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\".")
when :who
_("lastfm who [<nick>] => show who <nick> is on last.fm. if <nick> is empty, show who you are on lastfm.")
when :compare
_("lastfm compare [<nick1>] <nick2> => show musical taste compatibility between nick1 (or user if omitted) and nick2")
+ when :shouts
+ _("lastfm shouts [<nick>] => show shouts to <nick>")
+ when :friends
+ _("lastfm friends [<nick>] => show <nick>'s friends")
+ when :neighbors, :neighbours
+ _("lastfm neighbors [<nick>] => show people who share similar musical taste as <nick>")
+ when :lovedtracks
+ _("lastfm loved[tracks] [<nick>] => show tracks that <nick> has loved")
+ when :recenttracks, :recentracks
+ _("lastfm recent[tracks] [<nick>] => show tracks that <nick> has recently played")
+ when :topalbums
+ _("lastfm topalbums [<nick>] [over <period>] => show <nick>'s top albums%{p}") % { :p => period }
+ when :topartists
+ _("lastfm topartists [<nick>] [over <period>] => show <nick>'s top artists%{p}") % { :p => period }
+ when :toptracks
+ _("lastfm toptracks [<nick>] [over <period>] => show <nick>'s top tracks%{p}") % { :p => period }
+ when :weeklyalbumchart
+ _("lastfm weeklyalbumchart [<nick>] => show <nick>'s weekly album chart")
+ when :weeklyartistchart
+ _("lastfm weeklyartistchart [<nick>] => show <nick>'s weekly artist chart")
+ when :weeklytrackchart
+ _("lastfm weeklyartistchart [<nick>] => show <nick>'s weekly track chart")
else
- _("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")
+ _("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")
end
end
+ # TODO allow searching by country etc.
+ #
+ # Options: name, limit
+ def search_venue_by(options)
+ params = {}
+ params[:venue] = CGI.escape(options[:name])
+ options.delete(:name)
+ params.merge!(options)
+
+ uri = "#{APIURL}method=venue.search&"
+ uri << params.to_a.map {|e| e.join("=")}.join("&")
+
+ xml = @bot.httputil.get_response(uri)
+ doc = Document.new xml.body
+ results = []
+
+ doc.root.elements.each("results/venuematches/venue") do |v|
+ venue = LastFmVenue.new
+ venue.id = v.elements["id"].text.to_i
+ venue.url = v.elements["url"].text
+ venue.lat = v.elements["location/geo:point/geo:lat"].text.to_f
+ venue.long = v.elements["location/geo:point/geo:long"].text.to_f
+ venue.name = v.elements["name"].text
+ venue.city = v.elements["location/city"].text
+ venue.street = v.elements["location/street"].text
+ venue.postal = v.elements["location/postalcode"].text
+ venue.country = v.elements["location/country"].text
+
+ results << venue
+ end
+ results
+ end
+
def find_events(m, params)
num = params[:num] || @bot.config['lastfm.default_events']
num = num.to_i.clip(1, @bot.config['lastfm.max_events'])
+ sort_by = params[:sort_by] || :date
+ sort_order = params[:sort_order]
+ sort_order = sort_order.to_sym unless sort_order.nil?
+
location = params[:location]
artist = params[:who]
+ venue = params[:venue]
user = resolve_username(m, params[:user])
if location
uri = "#{APIURL}method=geo.getevents&location=#{CGI.escape location.to_s}"
emptymsg = _("no events found in %{location}") % {:location => location.to_s}
+ elsif venue
+ begin
+ venues = search_venue_by(:name => venue.to_s, :limit => 1)
+ rescue Exception => e
+ error e
+ m.reply _("an error occurred looking for venue %{venue}: %{e}") % {
+ :venue => venue.to_s,
+ :e => e.message
+ }
+ end
+
+ if venues.empty?
+ m.reply _("no venue found matching %{venue}") % {:venue => venue.to_s}
+ return
+ end
+ venue = venues.first
+ uri = "#{APIURL}method=venue.getevents&venue=#{venue.id}"
+ emptymsg = _("no events found at %{venue}") % {:venue => venue.to_s}
elsif artist
uri = "#{APIURL}method=artist.getevents&artist=#{CGI.escape artist.to_s}"
emptymsg = _("no events found by %{artist}") % {:artist => artist.to_s}
m.reply emptymsg
return
end
+
+ # sort order when sorted by date is ascending by default
+ # and descending when sorted by attendance
+ case sort_by.to_sym
+ when :attendance
+ events = events.sort_by { |e| e.attendance }.reverse
+ events.reverse! if [:ascending, :asc].include? sort_order
+ when :date
+ events = events.sort_by { |e| e.date }
+ events.reverse! if [:descending, :desc].include? sort_order
+ end
+
events[0...num].each { |event|
disp_events << event.to_s
}
rating = _("Very Low")
end
- reply = _("%{a}'s and %{b}'s musical compatibility rating is %{bold}%{r}%{bold}") % {
+ common_artists = unless artists.empty?
+ _(" and music they have in common includes: %{artists}") % {
+ :artists => Utils.comma_list(artists) }
+ else
+ nil
+ end
+
+ m.reply _("%{a}'s and %{b}'s musical compatibility rating is %{bold}%{r}%{bold}%{common}") % {
:a => user1,
:b => user2,
:r => rating.downcase,
- :bold => Bold
+ :bold => Bold,
+ :common => common_artists
}
-
- reply << _(" and music they have in common includes: %{artists}") % {
- :artists => artists.join(", ")
- } unless artists.empty?
-
- m.reply reply
end
def now_playing(m, params)
artist = first.elements["artist"].text
track = first.elements["name"].text
albumtxt = first.elements["album"].text
- album = ""
- if albumtxt
+ album = if albumtxt
year = get_album(artist, albumtxt)[2]
- album = "[#{albumtxt}, #{year}] " if year
+ if year
+ _(" [%{albumtext}, %{year}]") % { :albumtext => albumtxt, :year => year }
+ else
+ _(" [%{albumtext}]") % { :albumtext => albumtxt }
+ end
+ else
+ nil
end
past = nil
date = XPath.first(first, "//date")
if @registry.has_key? "#{m.sourcenick}_verb_present"
verb = @registry["#{m.sourcenick}_verb_present"]
end
- m.reply _("%{u} %{v} \"%{t}\" by %{a} %{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album}
+ reply = _("%{u} %{v} \"%{t}\" by %{a}%{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album}
else
verb = _("listened to")
if @registry.has_key? "#{m.sourcenick}_verb_past"
verb = @registry["#{m.sourcenick}_verb_past"]
end
ago = Utils.timeago(past)
- m.reply _("%{u} %{v} \"%{t}\" by %{a} %{b}%{p}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago}
+ reply = _("%{u} %{v} \"%{t}\" by %{a}%{b} %{p}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago}
end
+
+ reply << _("; see %{uri} for more") % { :uri => "http://www.last.fm/user/#{CGI.escape user}"}
+ m.reply reply
end
def find_artist(m, params)
- xml = @bot.httputil.get("#{APIURL}method=artist.getinfo&artist=#{CGI.escape params[:artist].to_s}")
- unless xml
+ info_xml = @bot.httputil.get("#{APIURL}method=artist.getinfo&artist=#{CGI.escape params[:artist].to_s}")
+ unless info_xml
m.reply _("I had problems getting info for %{a}") % {:a => params[:artist]}
return
end
- doc = Document.new xml
- unless doc
+ info_doc = Document.new info_xml
+ unless info_doc
m.reply _("last.fm parsing failed")
return
end
- first = doc.root.elements["artist"]
+ tags_xml = @bot.httputil.get("#{APIURL}method=artist.gettoptags&artist=#{CGI.escape params[:artist].to_s}")
+ tags_doc = Document.new tags_xml
+
+ first = info_doc.root.elements["artist"]
artist = first.elements["name"].text
url = first.elements["url"].text
- playcount = first.elements["stats"].elements["playcount"].text
- listeners = first.elements["stats"].elements["listeners"].text
+ stats = {}
+ %w(playcount listeners).each do |e|
+ t = first.elements["stats/#{e}"].text
+ stats[e.to_sym] = t.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
+ end
summary = first.elements["bio"].elements["summary"].text
- m.reply _("%{b}%{a}%{b} <%{u}> has been played %{c} times and is being listened to by %{l} people") % {
- :b => Bold, :a => artist, :u => url, :c => playcount, :l => listeners}
+ similar = first.get_elements("similar/artist").map { |a|
+ _("%{b}%{a}%{b}") % { :a => a.elements["name"].text, :b => Bold } }
+ tags = tags_doc.root.get_elements("toptags/tag")[0..4].map { |t|
+ _("%{u}%{t}%{u}") % { :t => t.elements["name"].text, :u => Underline } }
+ reply = _("%{b}%{a}%{b} <%{u}> has been played %{b}%{c}%{b} times and is being listened to by %{b}%{l}%{b} people") % {
+ :b => Bold, :a => artist, :u => url, :c => stats[:playcount], :l => stats[:listeners] }
+ reply << _(". Tagged as: %{t}") % {
+ :t => tags.join(", "), :b => Bold } unless tags.empty?
+ reply << _(". Similar artists: %{s}") % {
+ :s => similar.join(", "), :b => Bold } unless similar.empty?
+ m.reply reply
m.reply summary.ircify_html
end
end
end
+ def find_venue(m, params)
+ venue = params[:venue].to_s
+ venues = search_venue_by(:name => venue, :limit => 1)
+ venue = venues.last
+
+ if venues.empty?
+ m.reply "sorry, can't find such venue"
+ return
+ end
+
+ reply = _("%{b}%{name}%{b}, %{street}, %{u}%{city}%{u}, %{country}, see %{url} for more info") % {
+ :u => Underline, :b => Bold, :name => venue.name, :city => venue.city, :street => venue.street,
+ :country => venue.country, :url => venue.url
+ }
+
+ if venue.street && venue.city
+ maps_uri = "http://maps.google.com/maps?q=#{venue.street},+#{venue.city}"
+ maps_uri << ",+#{venue.postal}" if venue.postal
+ elsif venue.lat && venue.long
+ maps_uri = "http://maps.google.com/maps?q=#{venue.lat},+#{venue.long}"
+ else
+ m.reply reply
+ return
+ end
+
+ maps_uri << "+(#{venue.name.gsub(" ", "%A0")})"
+
+ begin
+ require "shorturl"
+ maps_uri = ShortURL.shorten(CGI.escape(maps_uri))
+ rescue LoadError => e
+ error e
+ end
+
+ reply << _(" and %{maps} for maps") % { :maps => maps_uri, :b => Bold }
+ m.reply reply
+ end
+
def get_album(artist, album)
xml = @bot.httputil.get("#{APIURL}method=album.getinfo&artist=#{CGI.escape artist}&album=#{CGI.escape album}")
unless xml
def lastfm(m, params)
action = case params[:action]
- when "neighbors" then "neighbours"
- when "recentracks" then "recenttracks"
+ when "neighbors" then "neighbours"
+ when "recentracks", "recent" then "recenttracks"
+ when "loved" then "lovedtracks"
when /^weekly(track|album|artist)s$/
"weekly#{$1}chart"
when "events"
uri << "&period=#{period_uri}"
end
- res = @bot.httputil.get_response(uri)
- unless res.body
- m.reply _("I had problems accessing last.fm")
- return
+ begin
+ res = @bot.httputil.get_response(uri)
+ raise _("no response body") unless res.body
+ rescue Exception => e
+ m.reply _("I had problems accessing last.fm: %{e}") % {:e => e.message}
+ return
end
doc = Document.new(res.body)
unless doc
elsif friends.length <= num
reply = _("%{user} has %{total} friends: %{friends}")
else
- reply = _("%{user} has %{total} friends, including %{friends}")
- reply << seemore
+ reply = _("%{user} has %{total} friends, including %{friends}%{seemore}")
end
m.reply reply % {
:user => user,
:total => friends.size,
- :friends => friends.shuffle[0, num].join(", "),
- :uri => "http://www.last.fm/user/#{CGI.escape user}/friends"
+ :friends => Utils.comma_list(friends.shuffle[0, num]),
+ :uri => "http://www.last.fm/user/#{CGI.escape user}/friends",
+ :seemore => seemore
}
when :lovedtracks
loved = doc.root.get_elements("lovedtracks/track").map do |track|
elsif loved.length <= num
reply = _("%{user} has loved %{total} tracks: %{tracks}")
else
- reply = _("%{user} has loved %{total} tracks, including %{tracks}")
- reply << seemore
+ reply = _("%{user} has loved %{total} tracks, including %{tracks}%{seemore}")
end
m.reply reply % {
:user => user,
:total => loved.size,
- :tracks => loved_prep.join(", "),
- :uri => "http://www.last.fm/user/#{CGI.escape user}/library/loved"
+ :tracks => Utils.comma_list(loved_prep),
+ :uri => "http://www.last.fm/user/#{CGI.escape user}/library/loved",
+ :seemore => seemore
}
when :neighbours
nbrs = doc.root.get_elements("neighbours/user").map do |u|
if nbrs.empty?
reply = _("no one seems to share %{user}'s musical taste")
elsif nbrs.length <= num
- reply = _("%{user} musical neighbours are %{nbrs}")
+ reply = _("%{user}'s musical neighbours are %{nbrs}")
else
- reply = _("%{user} musical neighbours include %{nbrs}")
- reply << seemore
+ reply = _("%{user}'s musical neighbours include %{nbrs}%{seemore}")
end
m.reply reply % {
- :user => user,
- :nbrs => nbrs.shuffle[0, num].join(", "),
- :uri => "http://www.last.fm/user/#{CGI.escape user}/neighbours"
+ :user => user,
+ :nbrs => Utils.comma_list(nbrs.shuffle[0, num]),
+ :uri => "http://www.last.fm/user/#{CGI.escape user}/neighbours",
+ :seemore => seemore
}
when :recenttracks
tracks = doc.root.get_elements("recenttracks/track").map do |track|
[track.elements["artist"].text, track.elements["name"].text].join(" - ")
end
- tracks_prep = tracks[0, num].to_enum(:each_with_index).collect { |e,i| (i % 2).zero? ? Underline+e+Underline : e }
+
+ counts = []
+ tracks.each do |track|
+ if t = counts.assoc(track)
+ counts[counts.rindex(t)] = [track, t[-1] += 1]
+ else
+ counts << [track, 1]
+ end
+ end
+
+ tracks_prep = counts[0, num].to_enum(:each_with_index).map do |e,i|
+ str = (i % 2).zero? ? Underline+e[0]+Underline : e[0]
+ str << " (%{i} times%{m})" % {
+ :i => e.last,
+ :m => counts.size == 1 ? _(" or more") : nil
+ } if e.last > 1
+ str
+ end
if tracks.empty?
m.reply _("%{user} hasn't played anything recently") % { :user => user }
else
m.reply _("%{user} has recently played %{tracks}") %
- { :user => user, :tracks => tracks_prep.join(", ") }
+ { :user => user, :tracks => Utils.comma_list(tracks_prep) }
end
when :shouts
shouts = doc.root.get_elements("shouts/shout")
format = "%{artist} (%{bold}%{plays}%{bold})"
artist = item.elements["name"].text
when :toptracks, :topalbums
- format = "%{artist} - (%{title} %{bold}%{plays}%{bold})"
+ format = "%{artist} - %{title} (%{bold}%{plays}%{bold})"
artist = item.elements["artist/name"].text
end
end
end
+event_map_options = {
+ :action => :find_events,
+ :requirements => {
+ :num => /\d+/,
+ :sort_order => /(?:asc|desc)(?:ending)?/
+ },
+ :thread => true
+}
+
plugin = LastFmPlugin.new
-plugin.map 'lastfm [:num] event[s] in *location', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
-plugin.map 'lastfm [:num] event[s] by *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
-plugin.map 'lastfm [:num] event[s] [for] *who', :action => :find_events, :requirements => { :num => /\d+/ }, :thread => true
+plugin.map 'lastfm [:num] event[s] in *location [sort[ed] by :sort_by] [[in] :sort_order [order]]', event_map_options.dup
+plugin.map 'lastfm [:num] event[s] by *who [sort[ed] by :sort_by] [[in] :sort_order [order]]', event_map_options.dup
+plugin.map 'lastfm [:num] event[s] at *venue [sort[ed] by :sort_by] [[in] :sort_order [order]]', event_map_options.dup
+plugin.map 'lastfm [:num] event[s] [for] *who [sort[ed] by :sort_by] [[in] :sort_order [order]]', event_map_options.dup
plugin.map 'lastfm artist *artist', :action => :find_artist, :thread => true
plugin.map 'lastfm album *album [by *artist]', :action => :find_album
plugin.map 'lastfm track *track', :action => :find_track, :thread => true
+plugin.map 'lastfm venue *venue', :action => :find_venue, :thread => true
plugin.map 'lastfm set user[name] :who', :action => :set_user, :thread => true
plugin.map 'lastfm set verb *present, *past', :action => :set_verb, :thread => true
plugin.map 'lastfm who [:who]', :action => :get_user, :thread => true
plugin.map 'lastfm compare to :user2', :action => :tasteometer, :thread => true
plugin.map 'lastfm compare [:user1] [to] :user2', :action => :tasteometer, :thread => true
plugin.map "lastfm [user] [:num] :action [:user]", :thread => true,
- :requirements => { :action =>
- /^(?:events|shouts|friends|neighbou?rs|(?:loved|recent?)tracks|top(?:album|artist|track)s?|weekly(?:albums?|artists?|tracks?)(?:chart)?)$/
+ :requirements => {
+ :action => /^(?:events|shouts|friends|neighbou?rs|loved(?:tracks)?|recent(?:t?racks)?|top(?:album|artist|track)s?|weekly(?:albums?|artists?|tracks?)(?:chart)?)$/,
+ :num => /^\d+$/
}
plugin.map 'lastfm [user] [:num] :action [:user] over [*period]', :thread => true,
:requirements => {
:action => /^(?:top(?:album|artist|track)s?)$/,
- :period => /^(?:(?:3|6|12) months)|(?:a\s|1\s)?year$/
+ :period => /^(?:(?:3|6|12) months)|(?:a\s|1\s)?year$/,
+ :num => /^\d+$/
}
plugin.map 'lastfm [now] [:who]', :action => :now_playing, :thread => true
plugin.map 'np [:who]', :action => :now_playing, :thread => true