path: root/data/rbot/plugins/lastfm.rb

#-- vim:sw=2:et
#++
#
# :title: lastfm plugin for rbot
#
# Author:: Jeremy Voorhis
# Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
# Author:: Casey Link <unnamedrambler@gmail.com>
#
# Copyright:: (C) 2005 Jeremy Voorhis
# Copyright:: (C) 2007 Giuseppe Bilotta
# Copyright:: (C) 2008 Casey Link
#
# License:: GPL v2

class ::LastFmEvent
  SELECTOR = /<tr class="vevent.*?<\/tr>/m
  # matches are:
  # 1. day 2. moth 3. year 4. url_who 5. who 6. url_where 7. where 8. how_many
  # TODO festival have TWO dates  -------+
  # TODO event type -------------+       |
  #                              V       V
  MATCHER = /<tr class="vevent\s+\w+\s+(?:\S+\s+)?\S+?-(\d\d)-(\d\d)-(\d\d\d\d)\s*">.*?<a class="url summary" href="(\/event\/\d+)">(.*?)<\/a>.*?<a href="(\/venue\/\d+)">(.*?)<\/a>.*?<td>(?:(.*?) attending\s+)?.*?<\/td>\s+<\/tr>/m
  attr_accessor :url, :date, :artist, :location, :attendance
  def initialize(url, date, artist, location, attendance)
    @url = url
    @date = date
    @artist = artist
    @location = location
    @attendance = attendance
  end

  def compact_display
    if @attendance.empty?
      return "%s %s @ %s %s" % [@date.strftime("%a %b, %d %Y"), @artist, @location, @url]
    else
      return "%s %s @ %s (%s) %s" % [@date.strftime("%a %b, %d %Y"), @artist, @location, @attendance, @url]
    end
  end
  alias :to_s :compact_display

end

class LastFmPlugin < Plugin
  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"

  def initialize
    super
    class << @registry
      def store(val)
        val
      end
      def restore(val)
        val
      end
    end
  end

  def help(plugin, topic="")
    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 #{@bot.config['lastfm.default_events']} and cannot be higher than #{@bot.config['lastfm.max_events']}"
    when :artist, :group
      "lastfm artist <name> => show information on artist/group <name> from last.fm"
    when :song, :track
      "lastfm track <name> => show information on track/song <name> from last.fm [not implemented yet]"
    when :album
      "lastfm album <name> => show information on album <name> from last.fm [not implemented yet]"
    when :now
      "lastfm now [<user>] => show the now playing track from last.fm"
    when :set
      "lastfm set <user> => associate your current irc nick with a last.fm user"
    when :who
      "lastfm who [<nick>] => show who <nick> is at last.fm. if <nick> is empty, show who you are at lastfm."
    else
      "lastfm => show your now playing track at lastfm. lastfm <function> [<user>] => lastfm data for <user> on last.fm where <function> in [recenttracks, topartists, topalbums, toptracks, tags, friends, neighbors]. other topics: events, artist, group, song, track, album, now, set, who"
    end
  end

  def find_event(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]
    page = nil
    spec = location ? "in #{location}" : "by #{artist}"
    query = location ? "?findloc=#{CGI.escape(location)}" : "?s=#{CGI.escape(artist)}&findloc="
    begin
      page = @bot.httputil.get LASTFM + "/events/" + query
      if page
        events = Array.new
        disp_events = Array.new

        pre_events = page.scan(LastFmEvent::SELECTOR)
        # debug pre_events.inspect
        if pre_events.empty?
          # We may not find any even because the page gives a list
          # of locations instead. In this case, retry with the first of
          # these location
          if page.match(/<a href="(\/events\/\?l=[^"]+)">/)
            debug "Rechecking with #{$1}"
            page = @bot.httputil.get(LASTFM+$1)
            debug page
            pre_events = page.scan(LastFmEvent::SELECTOR) if page
            debug pre_events
          end
          if pre_events.empty?
            m.reply "No events found #{spec}, sorry"
            return
          end
        end
        pre_events.each { |s| s.scan(LastFmEvent::MATCHER) { |day, month, year, url_who, who, url_where, where, how_many|
          date = Time.utc(year.to_i, month.to_i, day.to_i)
          url = LASTFM + url_who
          if who.match(/<strong>(.*?)<\/strong>(.+)?/)
            artist = Bold + $1.ircify_html + Bold
            artist << ", " << $2.ircify_html if $2
          else
            debug "who: #{who.inspect}"
            artist = who.ircify_html
          end
          if where.match(/<strong>(.*?)<\/strong>(?:<br\s*\/>(.+)?)?/)
            loc = Bold + $1.ircify_html + Bold
            loc << ", " << $2.ircify_html if $2
          else
            debug where.inspect
            loc = where.ircify_html
          end
          attendance = how_many ? how_many.ircify_html : ''
          events << LastFmEvent.new(url, date, artist, loc, attendance)
        } }
        # debug events.inspect

        events[0...num].each { |event|
          disp_events << event.to_s
        }
        m.reply disp_events.join(' | '), :split_at => /\s+\|\s+/
      else
        m.reply "No events found #{spec}"
        return
      end
    rescue Exception => e
      m.reply "I had problems looking for events #{spec}"
      error e.inspect
      debug e.backtrace.join("\n")
      debug page[0...10*1024] if page
      return
    end
  end

  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
      # m.reply "I don't know who you are on last.fm. Use 'lastfm set username' to identify yourself."
      # return
      user = m.sourcenick
    end
    page = nil
    begin
      page = @bot.httputil.get("#{LASTFM}/user/#{user}", opts)
      if page
        if page.match(/class="nowListening">\s*<td class="subject">\s*<a href="\/music.*?">(.*)<\/a>\s*<\/td/)
          track = $1
          if page.match(/class="nowListening currentStation">\s*(.*?)<\/a>/m)
            m.reply "#{user} is #{$1.ircify_html}"
          end
          m.reply "#{user} is jammin to #{track.ircify_html}"
        elsif page.match(/class="justlistened first">\s*<td class="subject">.*<\/span><\/a>?(.*)<\/a>\s*<\/td>\s*<td class="date">\s*just/m)
          m.reply "#{user} just jammed to #{$1.ircify_html}"
        else
          params[:action] = "recenttracks"
          params[:user] = user
          lastfm(m, params)
        end
      else
        return if params[:recurs]
        if @registry.has_key? user
          params[:who] = @registry[ user ]
          params[:recurs] = true
          now_playing(m, params)
        else
          m.reply "#{user} doesn't exist at last.fm. Perhaps you need to: lastfm set <username>"
        end
      end
    rescue
      m.reply "I had problems getting #{user}'s current info"
    end
  end

  def find_artist(m, params)
    artist = params[:who].to_s
    page = nil
    begin
      esc = URI.escape(CGI.escape(artist))
      page = @bot.httputil.get "#{LASTFM}/music/#{esc}"
      if page
        if page.match(/<h1 class="h1artist"><a href="([^"]+)">(.*?)<\/a><\/h1>/)
          url = LASTFM + $1
          title = $2.ircify_html
        else
          raise "No URL/Title found for #{artist}"
        end

        wiki = "This artist doesn't have a description yet. You can help by writing it: #{url}/+wiki?action=edit"
        if page.match(/<div (?:class|id)="wikiAbstract">(.*?)<\/div>/m)
          wiki = $1.ircify_html
        end

        m.reply "%s : %s\n%s" % [title, url, wiki], :overlong => :truncate
      else
        m.reply "no data found on #{artist}"
        return
      end
    rescue Exception => e
      m.reply "I had problems looking for #{artist}"
      error e.inspect
      debug e.backtrace.join("\n")
      debug page[0...10*1024] if page
      return
    end
  end

  def find_track(m, params)
    m.reply "not implemented yet, sorry"
  end

  def find_album(m, params)
    m.reply "not implemented yet, sorry"
  end

  def set_user(m, params)
    user = params[:who].to_s
    nick = m.sourcenick
    @registry[ nick ] = user
    m.reply "Ok, I'll remember that #{nick} is #{user} at last.fm"
  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 #{nick} is at last.fm perhaps you need to: lastfm set <username>"
    end
  end

  def lastfm(m, params)
    action = params[:action].intern
    action = :neighbours if action == :neighbors
    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 <username>"
    end
  end
end

plugin = LastFmPlugin.new
plugin.map 'lastfm [:num] event[s] in *location', :action => :find_event, :requirements => { :num => /\d+/ }, :thread => true
plugin.map 'lastfm [:num] event[s] by *who', :action => :find_event, :requirements => { :num => /\d+/ }, :thread => true
plugin.map 'lastfm [:num] event[s] [for] *who', :action => :find_event, :requirements => { :num => /\d+/ }, :thread => true
plugin.map 'lastfm artist *who', :action => :find_artist, :thread => true
plugin.map 'lastfm group *who', :action => :find_artist, :thread => true
plugin.map 'lastfm now *who', :action => :now_playing, :thread => true
plugin.map 'lastfm now', :action => :now_playing, :thread => true
plugin.map 'lastfm track *dunno', :action => :find_track
plugin.map 'lastfm song *dunno', :action => :find_track
plugin.map 'lastfm album *dunno', :action => :find_album
plugin.map 'lastfm set *who', :action => :set_user, :thread => true
plugin.map 'lastfm who *who', :action => :get_user, :thread => true
plugin.map 'lastfm who', :action => :get_user, :thread => true
plugin.map 'lastfm :action *user', :thread => true
plugin.map 'lastfm :action', :thread => true
plugin.map 'lastfm', :action => :now_playing, :thread => true