]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/lastfm.rb
[plugin] geoip small fixes, needs more work
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / lastfm.rb
index 96c2d23bd52d7a153895e271e9e87d15d5da847c..e29ae31ea477fa91a1daf888578caef86c2a5c6a 100644 (file)
@@ -19,6 +19,8 @@ require 'rexml/document'
 require 'cgi'
 
 class ::LastFmEvent
+  attr_reader :attendance, :date
+
   def initialize(hash)
     @url = hash[:url]
     @date = hash[:date]
@@ -47,6 +49,17 @@ class ::LastFmEvent
 
 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',
@@ -87,7 +100,7 @@ class LastFmPlugin < Plugin
     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
@@ -129,17 +142,73 @@ class LastFmPlugin < Plugin
     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 => err
+        error err
+        m.reply _("an error occurred looking for venue %{venue}: %{e}") % {
+          :venue => venue.to_s,
+          :e => err.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}
@@ -182,6 +251,18 @@ class LastFmPlugin < Plugin
       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
     }
@@ -229,18 +310,20 @@ class LastFmPlugin < Plugin
         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)
@@ -253,9 +336,10 @@ class LastFmPlugin < Plugin
       return
     end
     if xml.class == Net::HTTPBadRequest
-      if doc.root.elements["error"].text == "Invalid user name supplied" then
-        m.reply _("%{user} doesn't exist on last.fm, perhaps they need to: lastfm user <username>") % {
-          :user => user
+      if doc.root.elements["error"].attributes["code"] == "6" then
+        m.reply _("%{user} doesn't exist on last.fm, perhaps they need to: %{prefix}lastfm set user <username>") % {
+          :user => user,
+          :prefix => @bot.config['core.address_prefix'].first
         }
         return
       else
@@ -270,13 +354,18 @@ class LastFmPlugin < Plugin
     end
     first = doc.root.elements[1].elements[1]
     now = first.attributes["nowplaying"]
-    artist = first.elements["artist"].text
+    artist = first.elements["artist/name"].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")
@@ -289,15 +378,24 @@ class LastFmPlugin < Plugin
        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 %{bold}%{a}%{bold}%{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :bold => Bold}
     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 %{bold}%{a}%{bold}%{b} %{p};") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago, :bold => Bold}
     end
+
+    if @bot.plugins['spotify'] && Object.const_defined?('Spotify')
+      if track = Spotify.search(:track, "#{artist} #{track}")
+        reply << _(" [%{u}%{url}%{u}]") % {:u => Underline, :url => track.url}
+      end
+    end
+
+    reply << _(" -- see %{uri} for more") % { :uri => "http://www.last.fm/user/#{CGI.escape user}"}
+    m.reply reply
   end
 
   def find_artist(m, params)
@@ -314,7 +412,7 @@ class LastFmPlugin < Plugin
     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"]
+    first = info_doc.root.elements["artist/name"]
     artist = first.elements["name"].text
     url = first.elements["url"].text
     stats = {}
@@ -355,11 +453,11 @@ class LastFmPlugin < Plugin
     if results > 0
       begin
         hits = []
-        doc.root.each_element("results/trackmatches/track") do |track|
+        doc.root.each_element("results/trackmatches/track") do |trck|
           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,
+            :t => trck.elements["name"].text,
+            :a => trck.elements["artist/name"].text,
+            :n => trck.elements["listeners"].text,
             :bold => Bold
           }
         end
@@ -373,6 +471,44 @@ class LastFmPlugin < Plugin
     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
@@ -472,8 +608,8 @@ class LastFmPlugin < Plugin
     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}
+    rescue Exception => err
+        m.reply _("I had problems accessing last.fm: %{e}") % {:e => err.message}
         return
     end
     doc = Document.new(res.body)
@@ -502,14 +638,13 @@ class LastFmPlugin < Plugin
       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]),
+        :seemore => seemore % { :uri => "http://www.last.fm/user/#{CGI.escape user}/friends" }
       }
     when :lovedtracks
       loved = doc.root.get_elements("lovedtracks/track").map do |track|
@@ -522,14 +657,14 @@ class LastFmPlugin < Plugin
       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),
+          :seemore => seemore % { :uri => "http://www.last.fm/user/#{CGI.escape user}/library/loved" }
         }
     when :neighbours
       nbrs = doc.root.get_elements("neighbours/user").map do |u|
@@ -541,25 +676,41 @@ class LastFmPlugin < Plugin
       elsif nbrs.length <= num
         reply = _("%{user}'s musical neighbours are %{nbrs}")
       else
-        reply = _("%{user}'s 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]),
+          :seemore => seemore % { :uri => "http://www.last.fm/user/#{CGI.escape user}/neighbours" }
       }
     when :recenttracks
       tracks = doc.root.get_elements("recenttracks/track").map do |track|
-        [track.elements["artist"].text, track.elements["name"].text].join(" - ")
+        [track.elements["artist/name"].text, track.elements["name"].text].join(" - ")
+      end
+
+      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
-      tracks_prep = tracks[0, num].to_enum(:each_with_index).collect { |e,i| (i % 2).zero? ? Underline+e+Underline : e }
 
       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")
@@ -579,7 +730,7 @@ class LastFmPlugin < Plugin
         case action
         when :weeklytrackchart, :weeklyalbumchart
           format = "%{artist} - %{title} (%{bold}%{plays}%{bold})"
-          artist = item.elements["artist"].text
+          artist = item.elements["artist/name"].text
         when :weeklyartistchart, :topartists
           format = "%{artist} (%{bold}%{plays}%{bold})"
           artist = item.elements["name"].text
@@ -609,13 +760,24 @@ class LastFmPlugin < Plugin
   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