X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=data%2Frbot%2Fplugins%2Flastfm.rb;h=67f8d5f78852d7eebb2ee3b8999baaabb0514d78;hb=2e33012eb5eb8cf121059d06f07f6950141deccc;hp=dec9ef5d9478631584a7605f41207531ffb63860;hpb=0eec0897dc75de79ec31a2d3fcb03dbbd18648bb;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/data/rbot/plugins/lastfm.rb b/data/rbot/plugins/lastfm.rb index dec9ef5d..67f8d5f7 100644 --- a/data/rbot/plugins/lastfm.rb +++ b/data/rbot/plugins/lastfm.rb @@ -5,76 +5,436 @@ # # Author:: Jeremy Voorhis # Author:: Giuseppe "Oblomov" Bilotta +# Author:: Casey Link # # Copyright:: (C) 2005 Jeremy Voorhis # Copyright:: (C) 2007 Giuseppe Bilotta +# Copyright:: (C) 2008 Casey Link # # License:: GPL v2 -require 'open-uri' +require 'rexml/document' +require 'cgi' + +class ::LastFmEvent + def initialize(hash) + @url = hash[:url] + @date = hash[:date] + @location = hash[:location] + @description = hash[:description] + @attendance = hash[:attendance] + + @artists = hash[:artists] + + if @artists.length > 10 #more than 10 artists and it floods + diff = @artists.length - 10 + @artist_string = Bold + @artists[0..10].join(', ') + Bold + @artist_string << _(" and %{n} more...") % {:n => diff} + else + @artist_string = Bold + @artists.join(', ') + Bold + end + end + + def compact_display + if @attendance + return "%s %s @ %s (%s attending) %s" % [@date.strftime("%a %b, %d %Y"), @artist_string, @location, @attendance, @url] + end + return "%s %s @ %s %s" % [@date.strftime("%a %b, %d %Y"), @artist_string, @location, @url] + end + alias :to_s :compact_display + +end class LastFmPlugin < Plugin + include REXML + Config.register Config::IntegerValue.new('lastfm.max_events', + :default => 25, :validate => Proc.new{|v| v > 1}, + :desc => "Maximum number of events to display.") + Config.register Config::IntegerValue.new('lastfm.default_events', + :default => 3, :validate => Proc.new{|v| v > 1}, + :desc => "Default number of events to display.") - LASTFM = "http://www.last.fm" + APIKEY = "b25b959554ed76058ac220b7b2e0a026" + APIURL = "http://ws.audioscrobbler.com/2.0/?api_key=#{APIKEY}&" + + def initialize + super + class << @registry + def store(val) + val + end + def restore(val) + val + end + end + end def help(plugin, topic="") - case topic.intern - when :artist, :group - "lastfm artist => show information on artist/group from last.fm" - when :song, :track - "lastfm track => show information on track/song from last.fm [not implemented yet]" + case (topic.intern rescue nil) + when :event, :events + _("lastfm [] events in => show information on events in or near . lastfm [] events by => show information on events by . The number of events 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']} + when :artist + _("lastfm artist => show information on artist from last.fm") when :album - "lastfm album => show information on album from last.fm" + _("lastfm album => show information on album from last.fm [not implemented yet]") + when :track + _("lastfm track => search tracks matching on last.fm") + when :now, :np + _("lastfm now [] => show the now playing track from last.fm. np [] does the same.") + when :set + _("lastfm set user => associate your current irc nick with a last.fm user. lastfm set verb => set your preferred now playing verb. default \"listening\" and \"listened\".") + when :who + _("lastfm who [] => show who is at last.fm. if is empty, show who you are at lastfm.") + when :compare + _("lastfm compare => show musical taste compatibility between nick1 and nick2.") else - "lastfm => lastfm data for on last.fm where in [recenttracks, topartists, topalbums, toptracks, tags, friends, neighbors]. other topics: artist, group, song, track, album" + _("lastfm [] => show your or 's now playing track at lastfm. np [] => same as 'lastfm'. other topics: events, artist, album, track, now, set, who, compare") end end - def lastfm(m, params) - action = params[:action].intern - action = :neighbours if action == :neighbors - what = params[:what] - case action - when :artist, :group - artist = what.to_s - begin - esc = URI.escape(artist) - page = @bot.httputil.get "#{LASTFM}/music/#{esc}" - if page - if page.match(/

(.*?)<\/a><\/h1>/) - url = LASTFM + $1 - title = $2 - else - raise "No URL/Title found for #{artist}" + def find_events(m, params) + num = params[:num] || @bot.config['lastfm.default_events'] + num = num.to_i.clip(1, @bot.config['lastfm.max_events']) + + location = artist = nil + location = params[:location].to_s if params[:location] + artist = params[:who].to_s if params[:who] + + uri = nil + if artist == nil + uri = "#{APIURL}method=geo.getevents&location=#{CGI.escape location}" + else + uri = "#{APIURL}method=artist.getevents&artist=#{CGI.escape artist}" + end + xml = @bot.httputil.get_response(uri) + + doc = Document.new xml.body + if xml.class == Net::HTTPInternalServerError + if doc.root and doc.root.attributes["status"] == "failed" + m.reply doc.root.elements["error"].text + else + m.reply _("Could not retrieve events") + end + end + disp_events = Array.new + events = Array.new + doc.root.elements.each("events/event"){ |e| + h = {} + h[:title] = e.elements["title"].text + venue = e.elements["venue"].elements["name"].text + city = e.elements["venue"].elements["location"].elements["city"].text + country = e.elements["venue"].elements["location"].elements["country"].text + h[:location] = Underline + venue + Underline + " #{Bold + city + Bold}, #{country}" + date = e.elements["startDate"].text.split + h[:date] = Time.utc(date[3].to_i, date[2], date[1].to_i) + h[:desc] = e.elements["description"].text + h[:url] = e.elements["url"].text + e.detect {|node| + if node.kind_of? Element and node.attributes["name"] == "attendance" then + h[:attendance] = node.text + end + } + artists = Array.new + e.elements.each("artists/artist"){ |a| + artists << a.text + } + h[:artists] = artists + events << LastFmEvent.new(h) + } + events[0...num].each { |event| + disp_events << event.to_s + } + m.reply disp_events.join(' | '), :split_at => /\s+\|\s+/ + + end + + def tasteometer(m, params) + opts = { :cache => false } + user1 = params[:user1].to_s + user2 = params[:user2].to_s + xml = @bot.httputil.get_response("#{APIURL}method=tasteometer.compare&type1=user&type2=user&value1=#{CGI.escape user1}&value2=#{CGI.escape user2}", opts) + doc = Document.new xml.body + unless doc + m.reply _("last.fm parsing failed") + return + end + if xml.class == Net::HTTPInternalServerError + if doc.root.elements["error"].attributes["code"] == "7" then + error = doc.root.elements["error"].text + error.match(/Invalid username: \[(.*)\]/); + if @registry.has_key? $1 and not params[:recurs] + if user1 == $1 + params[:user1] = @registry[ $1 ] + elsif user2 == $1 + params[:user2] = @registry[ $1 ] end + params[:recurs] = true + tasteometer(m, params) + else + m.reply _("%{u} doesn't exist at last.fm. Perhaps you need to: lastfm set ") % {:u => baduser} + return + end + else + m.reply _("Bad: %{e}") % {:e => doc.root.element["error"].text} + return + end + end + now = artist = track = albumtxt = date = nil + score = doc.root.elements["comparison/result/score"].text.to_f + rating = nil + case + when score >= 0.9 + rating = _("Super") + when score >= 0.7 + rating = _("Very High") + when score >= 0.5 + rating = _("High") + when score >= 0.3 + rating = _("Medium") + when score >= 0.1 + rating = _("Low") + else + rating = _("Very Low") + end + m.reply _("%{a}'s and %{b}'s musical compatibility rating is: %{r}") % {:a => user1, :b => user2, :r => rating} + end - wiki = page.match(/
(.*?)<\/div>/m)[1].ircify_html - m.reply "%s : %s\n%s" % [title, url, wiki] + def now_playing(m, params) + opts = { :cache => false } + user = nil + if params[:who] + user = params[:who].to_s + elsif @registry.has_key? m.sourcenick + user = @registry[ m.sourcenick ] + else + user = m.sourcenick + end + xml = @bot.httputil.get_response("#{APIURL}method=user.getrecenttracks&user=#{CGI.escape user}", opts) + doc = Document.new xml.body + unless doc + m.reply _("last.fm parsing failed") + return + end + if xml.class == Net::HTTPBadRequest + if doc.root.elements["error"].text == "Invalid user name supplied" then + if @registry.has_key? user and not params[:recurs] + params[:who] = @registry[ user ] + params[:recurs] = true + now_playing(m, params) else - m.reply "no data found on #{artist}" + m.reply "#{user} doesn't exist at last.fm. Perhaps you need to: lastfm set " + return end - rescue - m.reply "I had problems looking for #{artist}" - debug page + else + m.reply _("Error %{e}") % {:e => doc.root.element["error"].text} return end - when :song, :track - m.reply "not implemented yet, sorry" - when :album - m.reply "not implemented yet, sorry" + end + now = artist = track = albumtxt = date = nil + unless doc.root.elements[1].has_elements? + m.reply _("%{u} hasn't played anything recently") % {:u => user} + return + end + first = doc.root.elements[1].elements[1] + now = first.attributes["nowplaying"] + artist = first.elements["artist"].text + track = first.elements["name"].text + albumtxt = first.elements["album"].text + album = "" + if albumtxt + year = get_album(artist, albumtxt)[2] + album = "[#{albumtxt}, #{year}] " if year + end + past = nil + date = XPath.first(first, "//date") + if date != nil + time = date.attributes["uts"] + past = Time.at(time.to_i) + end + if now == "true" + verb = _("listening") + if @registry.has_key? "#{m.sourcenick}_verb_present" + verb = @registry["#{m.sourcenick}_verb_present"] + end + m.reply _("%{u} is %{v} to \"%{t}\" by %{a} %{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album} else - return usage unless what.length == 1 - user = what.first + verb = _("listened") + if @registry.has_key? "#{m.sourcenick}_verb_past" + verb = @registry["#{m.sourcenick}_verb_past"] + end + ago = Utils.timeago(past) + m.reply _("%{u} %{v} to \"%{t}\" by %{a} %{b}%{p}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago} + end + end + + def find_artist(m, params) + xml = @bot.httputil.get("#{APIURL}method=artist.getinfo&artist=#{CGI.escape params[:artist].to_s}") + unless xml + m.reply _("I had problems getting info for %{a}.") % {:a => params[:artist]} + return + end + doc = Document.new xml + unless doc + m.reply _("last.fm parsing failed") + return + end + first = doc.root.elements["artist"] + artist = first.elements["name"].text + playcount = first.elements["stats"].elements["playcount"].text + listeners = first.elements["stats"].elements["listeners"].text + summary = first.elements["bio"].elements["summary"].text + 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} + m.reply summary.ircify_html + end + + def find_track(m, params) + track = params[:track].to_s + xml = @bot.httputil.get("#{APIURL}method=track.search&track=#{CGI.escape track}") + unless xml + m.reply _("I had problems getting info for %{a}.") % {:a => track} + return + end + debug xml + doc = Document.new xml + unless doc + m.reply _("last.fm parsing failed") + return + end + debug doc.root + results = doc.root.elements["results/opensearch:totalResults"].text.to_i rescue 0 + if results > 0 begin - data = open("http://ws.audioscrobbler.com/1.0/user/#{user}/#{action}.txt") - m.reply "#{action} for #{user}:" - m.reply data.to_a[0..3].map{|l| l.split(',',2)[-1].chomp}.join(", ") + hits = [] + doc.root.each_element("results/trackmatches/track") do |track| + hits << _("%{bold}%{t}%{bold} by %{bold}%{a}%{bold} (%{n} listeners)") % { + :t => track.elements["name"].text, + :a => track.elements["artist"].text, + :n => track.elements["listeners"].text, + :bold => Bold + } + end + m.reply hits.join(' -- '), :split_at => ' -- ' rescue - m.reply "could not find #{action} for #{user} (is #{user} a user?)" + error $! + m.reply _("last.fm parsing failed") end + else + m.reply _("track %{a} not found") % {:a => track} + end + end + + def get_album(artist, album) + xml = @bot.httputil.get("#{APIURL}method=album.getinfo&artist=#{CGI.escape artist}&album=#{CGI.escape album}") + unless xml + return [_("I had problems getting album info")] + end + doc = Document.new xml + unless doc + return [_("last.fm parsing failed")] + end + album = date = playcount = artist = date = year = nil + first = doc.root.elements["album"] + artist = first.elements["artist"].text + playcount = first.elements["playcount"].text + album = first.elements["name"].text + date = first.elements["releasedate"].text + unless date.strip.length < 2 + year = date.strip.split[2].chop + end + result = [artist, album, year, playcount] + return result + end + + def find_album(m, params) + album = get_album(params[:artist].to_s, params[:album].to_s) + if album.length == 1 + m.reply _("I couldn't locate: \"%{a}\" by %{r}") % {:a => params[:album], :r => params[:artist]} + return + end + year = "(#{album[2]}) " unless album[2] == nil + m.reply _("The album \"%{a}\" by %{r} %{y}has been played %{c} times.") % {:a => album[1], :r => album[0], :y => year, :c => album[3]} + end + + def set_user(m, params) + user = params[:who].to_s + nick = m.sourcenick + @registry[ nick ] = user + m.reply _("Ok, I'll remember that %{n} is %{u} at last.fm") % {:n => nick, :u => user} + end + + def set_verb(m, params) + past = params[:past].to_s + present = params[:present].to_s + key = "#{m.sourcenick}_verb_" + @registry[ "#{key}past" ] = past + @registry[ "#{key}present" ] = present + m.reply _("Ok, I'll remember that %{n} prefers %{r} and %{p}.") % {:n => m.sourcenick, :p => past, :r => present} + end + + def get_user(m, params) + nick = "" + if params[:who] + nick = params[:who].to_s + else + nick = m.sourcenick + end + if @registry.has_key? nick + user = @registry[ nick ] + m.reply "#{nick} is #{user} at last.fm" + else + m.reply _("Sorry, I don't know who %{n} is at last.fm perhaps you need to: lastfm set ") % {:n => nick} + end + end + + # TODO this user data retrieval should be upgraded to API 2.0 but it would need separate parsing + # for each dataset, or almost + def lastfm(m, params) + action = params[:action].intern + action = :neighbours if action == :neighbors + action = :recenttracks if action == :recentracks + action = :topalbums if action == :topalbum + action = :topartists if action == :topartist + action = :toptags if action == :toptag + user = nil + if params[:user] then + user = params[:user].to_s + elsif @registry.has_key? m.sourcenick + user = @registry[ m.sourcenick ] + else + # m.reply "I don't know who you are on last.fm. Use 'lastfm set username' to identify yourself." + # return + user = m.sourcenick + end + begin + data = @bot.httputil.get("http://ws.audioscrobbler.com/1.0/user/#{user}/#{action}.txt") + m.reply "#{action} for #{user}:" + m.reply data.to_a[0..3].map{|l| l.split(',',2)[-1].chomp}.join(", ") + rescue + m.reply "could not find #{action} for #{user} (is #{user} a user?). perhaps you need to: lastfm set " end end end plugin = LastFmPlugin.new -plugin.map 'lastfm :action *what' +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 now :who', :action => :now_playing, :thread => true +plugin.map 'lastfm now', :action => :now_playing, :thread => true +plugin.map 'np :who', :action => :now_playing, :thread => true +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 set nick :who', :action => :set_user, :thread => true +plugin.map 'lastfm set user :who', :action => :set_user, :thread => true +plugin.map 'lastfm set username :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 who', :action => :get_user, :thread => true +plugin.map 'lastfm compare :user1 :user2', :action => :tasteometer, :thread => true +plugin.map 'np', :action => :now_playing, :thread => true +plugin.map "lastfm [user] :action [:user]", :thread => true, + :requirements => { :action => + /^(?:events|friends|neighbou?rs|playlists|recent?tracks|top(?:album|artist|tag)s?|weekly(?:album|artist|track)chart|weeklychartlist)$/ +} +plugin.map "lastfm [:who]", :action => :now_playing, :thread => true