spotify.py

# -*- coding: utf-8 -*-
#
#Copyright (c) 2009 by xt <xt@bash.no>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

#
#
# If someone posts a spotify track URL in a configured channel
# this script will post back which track it is using spotify.url.fi service

# 
#
# History:
# 2010-01-12, xt
#   version 0.5: add option to use notice instead of message
# 2009-12-02, xt
#   version 0.4 small bugfix with some songs and popularity
# 2009-10-29, xt
#   version 0.3 use official spotify API, and add support for albums
# 2009-09-25, xt
#   version 0.2: use spotify.url.fi
# 2009-06-19, xt <xt@bash.no>
#     version 0.1: initial
#

import weechat
w = weechat
import re
import urllib2

SCRIPT_NAME    = "spotify"
SCRIPT_AUTHOR  = "xt <xt@bash.no>"
SCRIPT_VERSION = "0.5"
SCRIPT_LICENSE = "GPL"
SCRIPT_DESC    = "Look up spotify urls"

import_ok = True
try:
    from BeautifulSoup import BeautifulSoup # install package python-beautifulsoup
except:
    print "Package python-beautifulsoup must be installed for script '%s'." % SCRIPT_NAME
    import_ok = False

settings = {
    "buffers"        : 'freenode.#mychan,',     # comma separated list of buffers
    "emit_notice"    : 'off',                   # on or off, use notice or msg
}

gateway =  'http://ws.spotify.com/lookup/1/'  # http spotify gw address

spotify_track_res = ( re.compile(r'spotify:(?P<type>\w+):(?P<track_id>\w{22})'),
            re.compile(r'http://open.spotify.com/(?P<type>\w+)/(?P<track_id>\w{22})') )


spotify_hook_process = ''
buffer_name = ''


def get_buffer_name(bufferp):
    bufferd = weechat.buffer_get_string(bufferp, "name")
    return bufferd


def get_spotify_ids(s):
    for r in spotify_track_res:
        for type, track in r.findall(s):
            yield type, track


def spotify_print_cb(data, buffer, time, tags, displayed, highlight, prefix, message):

    global spotify_hook_process, buffer_name

    msg_buffer_name = get_buffer_name(buffer)
    # Skip ignored buffers
    found = False
    for active_buffer in weechat.config_get_plugin('buffers').split(','):
        if active_buffer.lower() == msg_buffer_name.lower():
            found = True
            buffer_name = msg_buffer_name
            break

    if not found:
        return weechat.WEECHAT_RC_OK

       
    for type, spotify_id in get_spotify_ids(message):
        url = '%s?uri=spotify:%s:%s' %(gateway, type, spotify_id)
        if spotify_hook_process != "":
            weechat.unhook(spotify_hook_process)
            spotify_hook_process = ""
        spotify_hook_process = weechat.hook_process(
            "python -c \"import urllib2; print urllib2.urlopen('" + url + "').read()\"",
            30 * 1000, "spotify_process_cb", "")

    return weechat.WEECHAT_RC_OK

def spotify_process_cb(data, command, rc, stdout, stderr):
    """ Callback reading XML data from website. """

    global spotify_hook_process, buffer_name

    spotify_hook_process = ""

    #if int(rc) >= 0:
    if stdout.strip():
        #stdout = stdout.decode('UTF-8').encode('UTF-8')
        soup = BeautifulSoup(stdout)
        lookup_type = soup.contents[2].name
        if lookup_type == 'track':
            name = soup.find('name').string
            album_name = soup.find('album').find('name').string
            artist_name = soup.find('artist').find('name').string
            popularity = soup.find('popularity')
            if popularity:
                popularity = float(popularity.string)*100
            length = float(soup.find('length').string)
            minutes = int(length)/60
            seconds =  int(length)%60

            reply = '%s - %s / %s %s:%.2d %2d%%' %(artist_name, name,
                    album_name, minutes, seconds, popularity)
        elif lookup_type == 'album':
            album_name = soup.find('album').find('name').string
            artist_name = soup.find('artist').find('name').string
            released = soup.find('released').string
            reply = '%s - %s - %s' %(artist_name, album_name, released)
        else:
            # Unsupported lookup type
            return weechat.WEECHAT_RC_OK


        reply = reply.replace('&amp;', '&')
        reply = reply.encode('UTF-8')

        splits = buffer_name.split('.') #FIXME bad code
        server = splits[0]
        buffer = '.'.join(splits[1:])
        emit_command = 'msg'
        if weechat.config_get_plugin('emit_notice') == 'on':
            emit_command = 'notice'
        w.command('', '/%s -server %s %s %s' %(emit_command, server, buffer, reply))

    return weechat.WEECHAT_RC_OK




if __name__ == "__main__" and import_ok:
    if weechat.register(SCRIPT_NAME, SCRIPT_AUTHOR, SCRIPT_VERSION, SCRIPT_LICENSE,
                        SCRIPT_DESC, "", ""):
        # Set default settings
        for option, default_value in settings.iteritems():
            if not weechat.config_is_set_plugin(option):
                weechat.config_set_plugin(option, default_value)

        weechat.hook_print("", "", "spotify", 1, "spotify_print_cb", "")