data/rbot/plugins/lastfm.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: lastfm plugin for rbot
   5 #
   6 # Author:: Jeremy Voorhis
   7 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
   8 # Author:: Casey Link <unnamedrambler@gmail.com>
   9 # Author:: Raine Virta <rane@kapsi.fi>
  10 #
  11 # Copyright:: (C) 2005 Jeremy Voorhis
  12 # Copyright:: (C) 2007 Giuseppe Bilotta
  13 # Copyright:: (C) 2008 Casey Link
  14 # Copyright:: (C) 2009 Raine Virta
  15 #
  16 # License:: GPL v2
  17
  18 require 'rexml/document'
  19 require 'cgi'
  20
  21 class ::LastFmEvent
  22   attr_reader :attendance, :date
  23
  24   def initialize(hash)
  25     @url = hash[:url]
  26     @date = hash[:date]
  27     @location = hash[:location]
  28     @description = hash[:description]
  29     @attendance = hash[:attendance]
  30
  31     @artists = hash[:artists]
  32
  33     if @artists.length > 10 #more than 10 artists and it floods
  34       diff = @artists.length - 10
  35       @artist_string = Bold + @artists[0..10].join(', ') + Bold
  36       @artist_string << _(" and %{n} more...") % {:n => diff}
  37     else
  38       @artist_string = Bold + @artists.join(', ') + Bold
  39     end
  40   end
  41
  42   def compact_display
  43    unless @attendance.zero?
  44      return "%s %s @ %s (%s attending) %s" % [@date.strftime("%a, %b %d"), @artist_string, @location, @attendance, @url]
  45    end
  46    return "%s %s @ %s %s" % [@date.strftime("%a, %b %d"), @artist_string, @location, @url]
  47   end
  48   alias :to_s :compact_display
  49
  50 end
  51
  52 define_structure :LastFmVenue, :id, :city, :street, :postal, :country, :name, :url, :lat, :long
  53 class ::Struct::LastFmVenue
  54   def to_s
  55     str = self.name.dup
  56     if self.country
  57       str << " (" << [self.city, self.country].compact.join(", ") << ")"
  58     end
  59     str
  60   end
  61 end
  62
  63 class LastFmPlugin < Plugin
  64   include REXML
  65   Config.register Config::IntegerValue.new('lastfm.max_events',
  66     :default => 25, :validate => Proc.new{|v| v > 1},
  67     :desc => "Maximum number of events to display.")
  68   Config.register Config::IntegerValue.new('lastfm.default_events',
  69     :default => 3, :validate => Proc.new{|v| v > 1},
  70     :desc => "Default number of events to display.")
  71   Config.register Config::IntegerValue.new('lastfm.max_shouts',
  72     :default => 5, :validate => Proc.new{|v| v > 1},
  73     :desc => "Maximum number of user shouts to display.")
  74   Config.register Config::IntegerValue.new('lastfm.default_shouts',
  75     :default => 3, :validate => Proc.new{|v| v > 1},
  76     :desc => "Default number of user shouts to display.")
  77   Config.register Config::IntegerValue.new('lastfm.max_user_data',
  78     :default => 25, :validate => Proc.new{|v| v > 1},
  79     :desc => "Maximum number of user data entries (except events and shouts) to display.")
  80   Config.register Config::IntegerValue.new('lastfm.default_user_data',
  81     :default => 10, :validate => Proc.new{|v| v > 1},
  82     :desc => "Default number of user data entries (except events and shouts) to display.")
  83
  84   APIKEY = "b25b959554ed76058ac220b7b2e0a026"
  85   APIURL = "http://ws.audioscrobbler.com/2.0/?api_key=#{APIKEY}&"
  86
  87   def initialize
  88     super
  89     class << @registry
  90       def store(val)
  91         val
  92       end
  93       def restore(val)
  94         val
  95       end
  96     end
  97   end
  98
  99   def help(plugin, topic="")
 100     period = _(", where <period> can be one of: 3|6|12 months, a year")
 101     case (topic.intern rescue nil)
 102     when :event, :events
 103       _("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']}
 104     when :artist
 105       _("lastfm artist <name> => show information on artist <name> from last.fm")
 106     when :album
 107       _("lastfm album <name> => show information on album <name> from last.fm [not implemented yet]")
 108     when :track
 109       _("lastfm track <name> => search tracks matching <name> on last.fm")
 110     when :now, :np
 111       _("lastfm now [<nick>] => show the now playing track from last.fm. np [<nick>] does the same.")
 112     when :set
 113       _("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\".")
 114     when :who
 115       _("lastfm who [<nick>] => show who <nick> is on last.fm. if <nick> is empty, show who you are on lastfm.")
 116     when :compare
 117       _("lastfm compare [<nick1>] <nick2> => show musical taste compatibility between nick1 (or user if omitted) and nick2")
 118     when :shouts
 119       _("lastfm shouts [<nick>] => show shouts to <nick>")
 120     when :friends
 121       _("lastfm friends [<nick>] => show <nick>'s friends")
 122     when :neighbors, :neighbours
 123       _("lastfm neighbors [<nick>] => show people who share similar musical taste as <nick>")
 124     when :lovedtracks
 125       _("lastfm loved[tracks] [<nick>] => show tracks that <nick> has loved")
 126     when :recenttracks, :recentracks
 127       _("lastfm recent[tracks] [<nick>] => show tracks that <nick> has recently played")
 128     when :topalbums
 129       _("lastfm topalbums [<nick>] [over <period>] => show <nick>'s top albums%{p}") % { :p => period }
 130     when :topartists
 131       _("lastfm topartists [<nick>] [over <period>] => show <nick>'s top artists%{p}") % { :p => period }
 132     when :toptracks
 133       _("lastfm toptracks [<nick>] [over <period>] => show <nick>'s top tracks%{p}") % { :p => period }
 134     when :weeklyalbumchart
 135       _("lastfm weeklyalbumchart [<nick>] => show <nick>'s weekly album chart")
 136     when :weeklyartistchart
 137       _("lastfm weeklyartistchart [<nick>] => show <nick>'s weekly artist chart")
 138     when :weeklytrackchart
 139       _("lastfm weeklyartistchart [<nick>] => show <nick>'s weekly track chart")
 140     else
 141       _("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")
 142     end
 143   end
 144
 145   # TODO allow searching by country etc.
 146   #
 147   # Options: name, limit
 148   def search_venue_by(options)
 149     params = {}
 150     params[:venue] = CGI.escape(options[:name])
 151     options.delete(:name)
 152     params.merge!(options)
 153
 154     uri = "#{APIURL}method=venue.search&"
 155     uri << params.to_a.map {|e| e.join("=")}.join("&")
 156
 157     xml = @bot.httputil.get_response(uri)
 158     doc = Document.new xml.body
 159     results = []
 160
 161     doc.root.elements.each("results/venuematches/venue") do |v|
 162       venue = LastFmVenue.new
 163       venue.id      = v.elements["id"].text.to_i
 164       venue.url     = v.elements["url"].text
 165       venue.lat     = v.elements["location/geo:point/geo:lat"].text.to_f
 166       venue.long    = v.elements["location/geo:point/geo:long"].text.to_f
 167       venue.name    = v.elements["name"].text
 168       venue.city    = v.elements["location/city"].text
 169       venue.street  = v.elements["location/street"].text
 170       venue.postal  = v.elements["location/postalcode"].text
 171       venue.country = v.elements["location/country"].text
 172
 173       results << venue
 174     end
 175     results
 176   end
 177
 178   def find_events(m, params)
 179     num = params[:num] || @bot.config['lastfm.default_events']
 180     num = num.to_i.clip(1, @bot.config['lastfm.max_events'])
 181
 182     sort_by    = params[:sort_by] || :date
 183     sort_order = params[:sort_order]
 184     sort_order = sort_order.to_sym unless sort_order.nil?
 185
 186     location = params[:location]
 187     artist = params[:who]
 188     venue = params[:venue]
 189     user = resolve_username(m, params[:user])
 190
 191     if location
 192       uri = "#{APIURL}method=geo.getevents&location=#{CGI.escape location.to_s}"
 193       emptymsg = _("no events found in %{location}") % {:location => location.to_s}
 194     elsif venue
 195       begin
 196         venues = search_venue_by(:name => venue.to_s, :limit => 1)
 197       rescue Exception => e
 198         error e
 199         m.reply _("an error occurred looking for venue %{venue}: %{e}") % {
 200           :venue => venue.to_s,
 201           :e => e.message
 202         }
 203       end
 204
 205       if venues.empty?
 206         m.reply _("no venue found matching %{venue}") % {:venue => venue.to_s}
 207         return
 208       end
 209       venue  = venues.first
 210       uri = "#{APIURL}method=venue.getevents&venue=#{venue.id}"
 211       emptymsg = _("no events found at %{venue}") % {:venue => venue.to_s}
 212     elsif artist
 213       uri = "#{APIURL}method=artist.getevents&artist=#{CGI.escape artist.to_s}"
 214       emptymsg = _("no events found by %{artist}") % {:artist => artist.to_s}
 215     elsif user
 216       uri = "#{APIURL}method=user.getevents&user=#{CGI.escape user}"
 217       emptymsg = _("%{user} is not attending any events") % {:user => user}
 218     end
 219     xml = @bot.httputil.get_response(uri)
 220
 221     doc = Document.new xml.body
 222     if xml.class == Net::HTTPInternalServerError
 223       if doc.root and doc.root.attributes["status"] == "failed"
 224         m.reply doc.root.elements["error"].text
 225       else
 226         m.reply _("could not retrieve events")
 227       end
 228     end
 229     disp_events = Array.new
 230     events = Array.new
 231     doc.root.elements.each("events/event"){ |e|
 232       h = {}
 233       h[:title] = e.elements["title"].text
 234       venue = e.elements["venue"].elements["name"].text
 235       city = e.elements["venue"].elements["location"].elements["city"].text
 236       country =  e.elements["venue"].elements["location"].elements["country"].text
 237       h[:location] = Underline + venue + Underline + " #{Bold + city + Bold}, #{country}"
 238       date = e.elements["startDate"].text.split
 239       h[:date] = Time.utc(date[3].to_i, date[2], date[1].to_i)
 240       h[:desc] = e.elements["description"].text
 241       h[:url] = e.elements["url"].text
 242       h[:attendance] = e.elements["attendance"].text.to_i
 243       artists = Array.new
 244       e.elements.each("artists/artist"){ |a|
 245         artists << a.text
 246       }
 247       h[:artists] = artists
 248       events << LastFmEvent.new(h)
 249     }
 250     if events.empty?
 251       m.reply emptymsg
 252       return
 253     end
 254
 255     # sort order when sorted by date is ascending by default
 256     # and descending when sorted by attendance
 257     case sort_by.to_sym
 258     when :attendance
 259       events = events.sort_by { |e| e.attendance }.reverse
 260       events.reverse! if [:ascending, :asc].include? sort_order
 261     when :date
 262       events = events.sort_by { |e| e.date }
 263       events.reverse! if [:descending, :desc].include? sort_order
 264     end
 265
 266     events[0...num].each { |event|
 267       disp_events << event.to_s
 268     }
 269     m.reply disp_events.join(' | '), :split_at => /\s+\|\s+/
 270
 271   end
 272
 273   def tasteometer(m, params)
 274     opts = { :cache => false }
 275     user1 = resolve_username(m, params[:user1])
 276     user2 = resolve_username(m, params[:user2])
 277     xml = @bot.httputil.get_response("#{APIURL}method=tasteometer.compare&type1=user&type2=user&value1=#{CGI.escape user1}&value2=#{CGI.escape user2}", opts)
 278     doc = Document.new xml.body
 279     unless doc
 280       m.reply _("last.fm parsing failed")
 281       return
 282     end
 283     if xml.class == Net::HTTPBadRequest
 284       if doc.root.elements["error"].attributes["code"] == "7" then
 285         error = doc.root.elements["error"].text
 286         error.match(/Invalid username: \[(.*)\]/);
 287         baduser = $1
 288
 289         m.reply _("%{u} doesn't exist on last.fm") % {:u => baduser}
 290         return
 291       else
 292         m.reply _("error: %{e}") % {:e => doc.root.element["error"].text}
 293         return
 294       end
 295     end
 296     score = doc.root.elements["comparison/result/score"].text.to_f
 297     artists = doc.root.get_elements("comparison/result/artists/artist").map { |e| e.elements["name"].text}
 298     case
 299       when score >= 0.9
 300         rating = _("Super")
 301       when score >= 0.7
 302         rating = _("Very High")
 303       when score >= 0.5
 304         rating = _("High")
 305       when score >= 0.3
 306         rating = _("Medium")
 307       when score >= 0.1
 308         rating = _("Low")
 309       else
 310         rating = _("Very Low")
 311     end
 312
 313     common_artists = unless artists.empty?
 314       _(" and music they have in common includes: %{artists}") % {
 315         :artists => Utils.comma_list(artists) }
 316     else
 317       nil
 318     end
 319
 320     m.reply _("%{a}'s and %{b}'s musical compatibility rating is %{bold}%{r}%{bold}%{common}") % {
 321       :a => user1,
 322       :b => user2,
 323       :r => rating.downcase,
 324       :bold => Bold,
 325       :common => common_artists
 326     }
 327   end
 328
 329   def now_playing(m, params)
 330     opts = { :cache => false }
 331     user = resolve_username(m, params[:who])
 332     xml = @bot.httputil.get_response("#{APIURL}method=user.getrecenttracks&user=#{CGI.escape user}", opts)
 333     doc = Document.new xml.body
 334     unless doc
 335       m.reply _("last.fm parsing failed")
 336       return
 337     end
 338     if xml.class == Net::HTTPBadRequest
 339       if doc.root.elements["error"].attributes["code"] == "6" then
 340         m.reply _("%{user} doesn't exist on last.fm, perhaps they need to: lastfm user <username>") % {
 341           :user => user
 342         }
 343         return
 344       else
 345         m.reply _("error: %{e}") % {:e => doc.root.element["error"].text}
 346         return
 347       end
 348     end
 349     now = artist = track = albumtxt = date = nil
 350     unless doc.root.elements[1].has_elements?
 351      m.reply _("%{u} hasn't played anything recently") % {:u => user}
 352      return
 353     end
 354     first = doc.root.elements[1].elements[1]
 355     now = first.attributes["nowplaying"]
 356     artist = first.elements["artist"].text
 357     track = first.elements["name"].text
 358     albumtxt = first.elements["album"].text
 359     album = if albumtxt
 360       year = get_album(artist, albumtxt)[2]
 361       if year
 362         _(" [%{albumtext}, %{year}]") % { :albumtext => albumtxt, :year => year }
 363       else
 364         _(" [%{albumtext}]") % { :albumtext => albumtxt }
 365       end
 366     else
 367       nil
 368     end
 369     past = nil
 370     date = XPath.first(first, "//date")
 371     if date != nil
 372       time = date.attributes["uts"]
 373       past = Time.at(time.to_i)
 374     end
 375     if now == "true"
 376        verb = _("is listening to")
 377        if @registry.has_key? "#{m.sourcenick}_verb_present"
 378          verb = @registry["#{m.sourcenick}_verb_present"]
 379        end
 380        reply = _("%{u} %{v} \"%{t}\" by %{bold}%{a}%{bold}%{b}") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :bold => Bold}
 381     else
 382       verb = _("listened to")
 383        if @registry.has_key? "#{m.sourcenick}_verb_past"
 384          verb = @registry["#{m.sourcenick}_verb_past"]
 385        end
 386       ago = Utils.timeago(past)
 387       reply = _("%{u} %{v} \"%{t}\" by %{bold}%{a}%{bold}%{b} %{p};") % {:u => user, :v => verb, :t => track, :a => artist, :b => album, :p => ago, :bold => Bold}
 388     end
 389
 390     if Object.const_defined?('Spotify')
 391       if track = Spotify.search(:track, "#{artist} #{track}")
 392         reply << _(" [%{u}%{url}%{u}]") % {:u => Underline, :url => track.url}
 393       end
 394     end
 395
 396     reply << _(" -- see %{uri} for more") % { :uri => "http://www.last.fm/user/#{CGI.escape user}"}
 397     m.reply reply
 398   end
 399
 400   def find_artist(m, params)
 401     info_xml = @bot.httputil.get("#{APIURL}method=artist.getinfo&artist=#{CGI.escape params[:artist].to_s}")
 402     unless info_xml
 403       m.reply _("I had problems getting info for %{a}") % {:a => params[:artist]}
 404       return
 405     end
 406     info_doc = Document.new info_xml
 407     unless info_doc
 408       m.reply _("last.fm parsing failed")
 409       return
 410     end
 411     tags_xml = @bot.httputil.get("#{APIURL}method=artist.gettoptags&artist=#{CGI.escape params[:artist].to_s}")
 412     tags_doc = Document.new tags_xml
 413
 414     first = info_doc.root.elements["artist"]
 415     artist = first.elements["name"].text
 416     url = first.elements["url"].text
 417     stats = {}
 418     %w(playcount listeners).each do |e|
 419       t = first.elements["stats/#{e}"].text
 420       stats[e.to_sym] = t.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
 421     end
 422     summary = first.elements["bio"].elements["summary"].text
 423     similar = first.get_elements("similar/artist").map { |a|
 424       _("%{b}%{a}%{b}") % { :a => a.elements["name"].text, :b => Bold } }
 425     tags = tags_doc.root.get_elements("toptags/tag")[0..4].map { |t|
 426       _("%{u}%{t}%{u}") % { :t => t.elements["name"].text, :u => Underline } }
 427     reply = _("%{b}%{a}%{b} <%{u}> has been played %{b}%{c}%{b} times and is being listened to by %{b}%{l}%{b} people") % {
 428       :b => Bold, :a => artist, :u => url, :c => stats[:playcount], :l => stats[:listeners] }
 429     reply << _(". Tagged as: %{t}") % {
 430       :t => tags.join(", "), :b => Bold } unless tags.empty?
 431     reply << _(". Similar artists: %{s}") % {
 432       :s => similar.join(", "), :b => Bold } unless similar.empty?
 433     m.reply reply
 434     m.reply summary.ircify_html
 435   end
 436
 437   def find_track(m, params)
 438     track = params[:track].to_s
 439     xml = @bot.httputil.get("#{APIURL}method=track.search&track=#{CGI.escape track}")
 440     unless xml
 441       m.reply _("I had problems getting info for %{a}") % {:a => track}
 442       return
 443     end
 444     debug xml
 445     doc = Document.new xml
 446     unless doc
 447       m.reply _("last.fm parsing failed")
 448       return
 449     end
 450     debug doc.root
 451     results = doc.root.elements["results/opensearch:totalResults"].text.to_i rescue 0
 452     if results > 0
 453       begin
 454         hits = []
 455         doc.root.each_element("results/trackmatches/track") do |track|
 456           hits << _("%{bold}%{t}%{bold} by %{bold}%{a}%{bold} (%{n} listeners)") % {
 457             :t => track.elements["name"].text,
 458             :a => track.elements["artist"].text,
 459             :n => track.elements["listeners"].text,
 460             :bold => Bold
 461           }
 462         end
 463         m.reply hits.join(' -- '), :split_at => ' -- '
 464       rescue
 465         error $!
 466         m.reply _("last.fm parsing failed")
 467       end
 468     else
 469       m.reply _("track %{a} not found") % {:a => track}
 470     end
 471   end
 472
 473   def find_venue(m, params)
 474     venue  = params[:venue].to_s
 475     venues = search_venue_by(:name => venue, :limit => 1)
 476     venue  = venues.last
 477
 478     if venues.empty?
 479       m.reply "sorry, can't find such venue"
 480       return
 481     end
 482
 483     reply = _("%{b}%{name}%{b}, %{street}, %{u}%{city}%{u}, %{country}, see %{url} for more info") % {
 484       :u => Underline, :b => Bold, :name => venue.name, :city => venue.city, :street => venue.street,
 485       :country => venue.country, :url => venue.url
 486     }
 487
 488     if venue.street && venue.city
 489       maps_uri = "http://maps.google.com/maps?q=#{venue.street},+#{venue.city}"
 490       maps_uri << ",+#{venue.postal}" if venue.postal
 491     elsif venue.lat && venue.long
 492       maps_uri = "http://maps.google.com/maps?q=#{venue.lat},+#{venue.long}"
 493     else
 494       m.reply reply
 495       return
 496     end
 497
 498     maps_uri << "+(#{venue.name.gsub(" ", "%A0")})"
 499
 500     begin
 501       require "shorturl"
 502       maps_uri = ShortURL.shorten(CGI.escape(maps_uri))
 503     rescue LoadError => e
 504       error e
 505     end
 506
 507     reply << _(" and %{maps} for maps") % { :maps => maps_uri, :b => Bold }
 508     m.reply reply
 509   end
 510
 511   def get_album(artist, album)
 512     xml = @bot.httputil.get("#{APIURL}method=album.getinfo&artist=#{CGI.escape artist}&album=#{CGI.escape album}")
 513     unless xml
 514       return [_("I had problems getting album info")]
 515     end
 516     doc = Document.new xml
 517     unless doc
 518       return [_("last.fm parsing failed")]
 519     end
 520     album = date = playcount = artist = date = year = nil
 521     first = doc.root.elements["album"]
 522     artist = first.elements["artist"].text
 523     playcount = first.elements["playcount"].text
 524     album = first.elements["name"].text
 525     date = first.elements["releasedate"].text
 526     unless date.strip.length < 2
 527       year = date.strip.split[2].chop
 528     end
 529     result = [artist, album, year, playcount]
 530     return result
 531   end
 532
 533   def find_album(m, params)
 534     album = get_album(params[:artist].to_s, params[:album].to_s)
 535     if album.length == 1
 536       m.reply _("I couldn't locate: \"%{a}\" by %{r}") % {:a => params[:album], :r => params[:artist]}
 537       return
 538     end
 539     year = "(#{album[2]}) " unless album[2] == nil
 540     m.reply _("the album \"%{a}\" by %{r} %{y}has been played %{c} times") % {:a => album[1], :r => album[0], :y => year, :c => album[3]}
 541   end
 542
 543   def set_user(m, params)
 544     user = params[:who].to_s
 545     nick = m.sourcenick
 546     @registry[ nick ] = user
 547     m.reply _("okay, I'll remember that %{n} is %{u} on last.fm") % {:n => nick, :u => user}
 548   end
 549
 550   def set_verb(m, params)
 551     past = params[:past].to_s
 552     present = params[:present].to_s
 553     key = "#{m.sourcenick}_verb_"
 554     @registry[ "#{key}past" ] = past
 555     @registry[ "#{key}present" ] = present
 556     m.reply _("okay, I'll remember that %{n} prefers \"%{r}\" and \"%{p}\"") % {:n => m.sourcenick, :p => past, :r => present}
 557   end
 558
 559   def get_user(m, params)
 560     nick = ""
 561     if params[:who]
 562       nick = params[:who].to_s
 563     else
 564       nick = m.sourcenick
 565     end
 566     if @registry.has_key? nick
 567       user = @registry[ nick ]
 568       m.reply _("%{nick} is %{user} on last.fm") % {
 569         :nick => nick,
 570         :user => user
 571       }
 572     else
 573       m.reply _("sorry, I don't know who %{n} is on last.fm, perhaps they need to: lastfm set user <username>") % {:n => nick}
 574     end
 575   end
 576
 577   def lastfm(m, params)
 578     action = case params[:action]
 579     when "neighbors" then "neighbours"
 580     when "recentracks", "recent" then "recenttracks"
 581     when "loved" then "lovedtracks"
 582     when /^weekly(track|album|artist)s$/
 583       "weekly#{$1}chart"
 584     when "events"
 585       find_events(m, params)
 586       return
 587     else
 588       params[:action]
 589     end.to_sym
 590
 591     if action == :shouts
 592       num = params[:num] || @bot.config['lastfm.default_shouts']
 593       num = num.to_i.clip(1, @bot.config['lastfm.max_shouts'])
 594     else
 595       num = params[:num] || @bot.config['lastfm.default_user_data']
 596       num = num.to_i.clip(1, @bot.config['lastfm.max_user_data'])
 597     end
 598
 599     user = resolve_username(m, params[:user])
 600     uri = "#{APIURL}method=user.get#{action}&user=#{CGI.escape user}"
 601
 602     if period = params[:period]
 603       period_uri = (period.last == "year" ? "12month" : period.first + "month")
 604       uri << "&period=#{period_uri}"
 605     end
 606
 607     begin
 608       res = @bot.httputil.get_response(uri)
 609       raise _("no response body") unless res.body
 610     rescue Exception => e
 611         m.reply _("I had problems accessing last.fm: %{e}") % {:e => e.message}
 612         return
 613     end
 614     doc = Document.new(res.body)
 615     unless doc
 616       m.reply _("last.fm parsing failed")
 617       return
 618     end
 619
 620     case res
 621     when Net::HTTPBadRequest
 622       if doc.root and doc.root.attributes["status"] == "failed"
 623         m.reply "error: " << doc.root.elements["error"].text.downcase
 624       end
 625       return
 626     end
 627
 628     seemore =  _("; see %{uri} for more")
 629     case action
 630     when :friends
 631       friends = doc.root.get_elements("friends/user").map do |u|
 632         u.elements["name"].text
 633       end
 634
 635       if friends.empty?
 636         reply = _("%{user} has no friends :(")
 637       elsif friends.length <= num
 638         reply = _("%{user} has %{total} friends: %{friends}")
 639       else
 640         reply = _("%{user} has %{total} friends, including %{friends}%{seemore}")
 641       end
 642       m.reply reply % {
 643         :user => user,
 644         :total => friends.size,
 645         :friends => Utils.comma_list(friends.shuffle[0, num]),
 646         :seemore => seemore % { :uri => "http://www.last.fm/user/#{CGI.escape user}/friends" }
 647       }
 648     when :lovedtracks
 649       loved = doc.root.get_elements("lovedtracks/track").map do |track|
 650         [track.elements["artist/name"].text, track.elements["name"].text].join(" - ")
 651       end
 652       loved_prep = loved.shuffle[0, num].to_enum(:each_with_index).collect { |e,i| (i % 2).zero? ? Underline+e+Underline : e }
 653
 654       if loved.empty?
 655         reply = _("%{user} has not loved any tracks")
 656       elsif loved.length <= num
 657         reply = _("%{user} has loved %{total} tracks: %{tracks}")
 658       else
 659         reply = _("%{user} has loved %{total} tracks, including %{tracks}%{seemore}")
 660       end
 661
 662       m.reply reply % {
 663           :user => user,
 664           :total => loved.size,
 665           :tracks => Utils.comma_list(loved_prep),
 666           :seemore => seemore % { :uri => "http://www.last.fm/user/#{CGI.escape user}/library/loved" }
 667         }
 668     when :neighbours
 669       nbrs = doc.root.get_elements("neighbours/user").map do |u|
 670         u.elements["name"].text
 671       end
 672
 673       if nbrs.empty?
 674         reply = _("no one seems to share %{user}'s musical taste")
 675       elsif nbrs.length <= num
 676         reply = _("%{user}'s musical neighbours are %{nbrs}")
 677       else
 678         reply = _("%{user}'s musical neighbours include %{nbrs}%{seemore}")
 679       end
 680       m.reply reply % {
 681           :user    => user,
 682           :nbrs    => Utils.comma_list(nbrs.shuffle[0, num]),
 683           :seemore => seemore % { :uri => "http://www.last.fm/user/#{CGI.escape user}/neighbours" }
 684       }
 685     when :recenttracks
 686       tracks = doc.root.get_elements("recenttracks/track").map do |track|
 687         [track.elements["artist"].text, track.elements["name"].text].join(" - ")
 688       end
 689
 690       counts = []
 691       tracks.each do |track|
 692         if t = counts.assoc(track)
 693           counts[counts.rindex(t)] = [track, t[-1] += 1]
 694         else
 695           counts << [track, 1]
 696         end
 697       end
 698
 699       tracks_prep = counts[0, num].to_enum(:each_with_index).map do |e,i|
 700         str = (i % 2).zero? ? Underline+e[0]+Underline : e[0]
 701         str << " (%{i} times%{m})" % {
 702           :i => e.last,
 703           :m => counts.size == 1 ? _(" or more") : nil
 704         } if e.last > 1
 705         str
 706       end
 707
 708       if tracks.empty?
 709         m.reply _("%{user} hasn't played anything recently") % { :user => user }
 710       else
 711         m.reply _("%{user} has recently played %{tracks}") %
 712           { :user => user, :tracks => Utils.comma_list(tracks_prep) }
 713       end
 714     when :shouts
 715       shouts = doc.root.get_elements("shouts/shout")
 716       if shouts.empty?
 717         m.reply _("there are no shouts for %{user}") % { :user => user }
 718       else
 719         shouts[0, num].each do |shout|
 720           m.reply _("<%{author}> %{body}") % {
 721             :body   => shout.elements["body"].text,
 722             :author => shout.elements["author"].text,
 723           }
 724         end
 725       end
 726     when :toptracks, :topalbums, :topartists, :weeklytrackchart, :weeklyalbumchart, :weeklyartistchart
 727       type  = action.to_s.scan(/track|album|artist/).to_s
 728       items = doc.root.get_elements("#{action}/#{type}").map do |item|
 729         case action
 730         when :weeklytrackchart, :weeklyalbumchart
 731           format = "%{artist} - %{title} (%{bold}%{plays}%{bold})"
 732           artist = item.elements["artist"].text
 733         when :weeklyartistchart, :topartists
 734           format = "%{artist} (%{bold}%{plays}%{bold})"
 735           artist = item.elements["name"].text
 736         when :toptracks, :topalbums
 737           format = "%{artist} - %{title} (%{bold}%{plays}%{bold})"
 738           artist = item.elements["artist/name"].text
 739         end
 740
 741         _(format) % {
 742           :artist => artist,
 743           :title  => item.elements["name"].text,
 744           :plays  => item.elements["playcount"].text,
 745           :bold   => Bold
 746         }
 747       end
 748       if items.empty?
 749         m.reply _("%{user} hasn't played anything in this period of time") % { :user => user }
 750       else
 751         m.reply items[0, num].join(", ")
 752       end
 753     end
 754   end
 755
 756   def resolve_username(m, name)
 757     name = m.sourcenick if name.nil?
 758     @registry[name] or name
 759   end
 760 end
 761
 762 event_map_options = {
 763  :action => :find_events,
 764  :requirements => {
 765   :num => /\d+/,
 766   :sort_order => /(?:asc|desc)(?:ending)?/
 767  },
 768  :thread => true
 769 }
 770
 771 plugin = LastFmPlugin.new
 772 plugin.map 'lastfm [:num] event[s] in *location [sort[ed] by :sort_by] [[in] :sort_order [order]]', event_map_options.dup
 773 plugin.map 'lastfm [:num] event[s] by *who [sort[ed] by :sort_by] [[in] :sort_order [order]]', event_map_options.dup
 774 plugin.map 'lastfm [:num] event[s] at *venue [sort[ed] by :sort_by] [[in] :sort_order [order]]', event_map_options.dup
 775 plugin.map 'lastfm [:num] event[s] [for] *who [sort[ed] by :sort_by] [[in] :sort_order [order]]', event_map_options.dup
 776 plugin.map 'lastfm artist *artist', :action => :find_artist, :thread => true
 777 plugin.map 'lastfm album *album [by *artist]', :action => :find_album
 778 plugin.map 'lastfm track *track', :action => :find_track, :thread => true
 779 plugin.map 'lastfm venue *venue', :action => :find_venue, :thread => true
 780 plugin.map 'lastfm set user[name] :who', :action => :set_user, :thread => true
 781 plugin.map 'lastfm set verb *present, *past', :action => :set_verb, :thread => true
 782 plugin.map 'lastfm who [:who]', :action => :get_user, :thread => true
 783 plugin.map 'lastfm compare to :user2', :action => :tasteometer, :thread => true
 784 plugin.map 'lastfm compare [:user1] [to] :user2', :action => :tasteometer, :thread => true
 785 plugin.map "lastfm [user] [:num] :action [:user]", :thread => true,
 786   :requirements => {
 787     :action => /^(?:events|shouts|friends|neighbou?rs|loved(?:tracks)?|recent(?:t?racks)?|top(?:album|artist|track)s?|weekly(?:albums?|artists?|tracks?)(?:chart)?)$/,
 788     :num => /^\d+$/
 789 }
 790 plugin.map 'lastfm [user] [:num] :action [:user] over [*period]', :thread => true,
 791   :requirements => {
 792     :action => /^(?:top(?:album|artist|track)s?)$/,
 793     :period => /^(?:(?:3|6|12) months)|(?:a\s|1\s)?year$/,
 794     :num => /^\d+$/
 795 }
 796 plugin.map 'lastfm [now] [:who]', :action => :now_playing, :thread => true
 797 plugin.map 'np [:who]', :action => :now_playing, :thread => true