]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/lastfm.rb
hangman: IRCify HTML in definitions
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / lastfm.rb
index f97da63f453f04911008dda96d1dbb4a2a95ba08..57cf3ec14596078c0aec421f3eecb2a7b5d758c6 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]
@@ -48,6 +50,15 @@ 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
@@ -89,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
@@ -168,6 +179,10 @@ class LastFmPlugin < Plugin
     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]
@@ -177,9 +192,23 @@ class LastFmPlugin < Plugin
       uri = "#{APIURL}method=geo.getevents&location=#{CGI.escape location.to_s}"
       emptymsg = _("no events found in %{location}") % {:location => location.to_s}
     elsif venue
-      venues = search_venue_by(:name => venue.to_s, :limit => 1)
+      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}
@@ -222,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
     }
@@ -295,7 +336,7 @@ class LastFmPlugin < Plugin
       return
     end
     if xml.class == Net::HTTPBadRequest
-      if doc.root.elements["error"].text == "Invalid user name supplied" then
+      if doc.root.elements["error"].attributes["code"] == "6" then
         m.reply _("%{user} doesn't exist on last.fm, perhaps they need to: lastfm user <username>") % {
           :user => user
         }
@@ -318,9 +359,9 @@ class LastFmPlugin < Plugin
     album = if albumtxt
       year = get_album(artist, albumtxt)[2]
       if year
-        "[#{albumtxt}, #{year}]"
+        _(" [%{albumtext}, %{year}]") % { :albumtext => albumtxt, :year => year }
       else
-        "[#{albumtxt}]"
+        _(" [%{albumtext}]") % { :albumtext => albumtxt }
       end
     else
       nil
@@ -336,17 +377,23 @@ class LastFmPlugin < Plugin
        if @registry.has_key? "#{m.sourcenick}_verb_present"
          verb = @registry["#{m.sourcenick}_verb_present"]
        end
-       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)
-      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 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}"}
+    reply << _(" -- see %{uri} for more") % { :uri => "http://www.last.fm/user/#{CGI.escape user}"}
     m.reply reply
   end
 
@@ -596,8 +643,7 @@ class LastFmPlugin < Plugin
         :user => user,
         :total => friends.size,
         :friends => Utils.comma_list(friends.shuffle[0, num]),
-        :uri => "http://www.last.fm/user/#{CGI.escape user}/friends",
-        :seemore => seemore
+        :seemore => seemore % { :uri => "http://www.last.fm/user/#{CGI.escape user}/friends" }
       }
     when :lovedtracks
       loved = doc.root.get_elements("lovedtracks/track").map do |track|
@@ -612,12 +658,12 @@ class LastFmPlugin < Plugin
       else
         reply = _("%{user} has loved %{total} tracks, including %{tracks}%{seemore}")
       end
+
       m.reply reply % {
           :user => user,
           :total => loved.size,
           :tracks => Utils.comma_list(loved_prep),
-          :uri => "http://www.last.fm/user/#{CGI.escape user}/library/loved",
-          :seemore => seemore
+          :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|
@@ -634,8 +680,7 @@ class LastFmPlugin < Plugin
       m.reply reply % {
           :user    => user,
           :nbrs    => Utils.comma_list(nbrs.shuffle[0, num]),
-          :uri     => "http://www.last.fm/user/#{CGI.escape user}/neighbours",
-          :seemore => seemore
+          :seemore => seemore % { :uri => "http://www.last.fm/user/#{CGI.escape user}/neighbours" }
       }
     when :recenttracks
       tracks = doc.root.get_elements("recenttracks/track").map do |track|
@@ -714,11 +759,20 @@ 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] at *venue', :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