VkontakteSearch.py

# -*- Mode: python; coding: utf-8; tab-width: 4; indent-tabs-mode: nil; -*-
#
# Copyright (C) 2012 Huhlaev Alexander  <sancheolz@gmail.com>
#
# 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 2, or (at your option)
# any later version.
#
# The Rhythmbox authors hereby grant permission for non-GPL compatible
# GStreamer plugins to be used and distributed together with GStreamer
# and Rhythmbox. This permission is above and beyond the permissions granted
# by the GPL license by which Rhythmbox is covered. If you modify this code
# you may extend this exception to your version of the code, but you are not
# obligated to do so. If you do not wish to do so, delete this exception
# statement from your 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, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA.

import urllib
import urllib2
import codecs
import rb

from xml.dom import minidom
from gi.repository import RB
from html_decode import decode_htmlentities

from VkontakteResult import VkontakteResult

def utf8ise(s):
    return codecs.utf_8_encode(s)[0]

class VkontakteSearch:
    def __init__(self, token, user_id, search_term, db, entry_type):
        print "search_term ='%s'" % search_term
        self.token = token
        self.user_id = user_id
        self.search_term = search_term
        self.db = db
        self.entry_type = entry_type
        self.search_complete = False
        self.entries_hashes = []
        self.query_model = RB.RhythmDBQueryModel.new_empty(db)

    def is_complete(self):
        print "complete = %s" % self.search_complete
        return self.search_complete

    def add_entry(self, result):
        entry = self.db.entry_lookup_by_location(result.url)
        # add only distinct songs (unique by title+artist+duration) to prevent duplicates
        hash = ('%s%s%s' % (result.title, result.artist, result.duration)).lower()
        if hash in self.entries_hashes:
            return
        self.entries_hashes.append(hash)
        if entry is None:
            entry = RB.RhythmDBEntry.new(self.db, self.entry_type, result.url)
            if result.title:
                self.db.entry_set(entry, RB.RhythmDBPropType.TITLE, utf8ise(decode_htmlentities(result.title)))
            if result.duration:
                self.db.entry_set(entry, RB.RhythmDBPropType.DURATION, result.duration)
            if result.artist:
                self.db.entry_set(entry, RB.RhythmDBPropType.ARTIST, utf8ise(decode_htmlentities(result.artist)))
        self.query_model.add_entry(entry, -1)
        self.db.commit()

    def on_search_results_recieved(self, data):
        # vkontakte sometimes returns invalid XML with empty first line
        print "got data\n" + str(data)
        if isinstance(data, str):
            data = data.lstrip()
        # remove invalid symbol that occured in titles/artist
        #data = data.replace(u'\uffff', '')
            xmldoc = minidom.parseString(data)
        # Check for errors
            if xmldoc.getElementsByTagName("error_msg").length > 0:
                self.error_msg = xmldoc.getElementsByTagName('error_msg')[0].firstChild.nodeValue.strip()
                print "got error '%s'" % self.error_msg

            audios = xmldoc.getElementsByTagName("audio")
            for audio in audios:
                self.add_entry(VkontakteResult(audio))
            self.search_complete = True

    # Starts searching
    def start(self):
        print "start search call"
        self.error_msg = ''
        params = {}
        method = ''
        if len(self.search_term) == 0:
            params['uid'] = self.user_id
            method = 'audio.get'
        else:
            params['sort'] = '2'
            params['q'] = self.search_term
            params['count'] = '100'
            params['auto_complete'] = '1'
            method = 'audio.search'
        url = self.make_url(method, params, self.token)
        print "path='%s'" % url
        loader = rb.Loader()
        loader.get_url(url, self.on_search_results_recieved)

    def make_url(self, method, params, token):
        print "make url method='%s', params='%s', token='%s'" % (method, params, token)
        if isinstance(params, list):
            params_list = [kv for kv in params]
        elif isinstance(params, dict):
            params_list = params.items()
        else:
            params_list = [params]
        params_list.append(("access_token", token))
        url = "https://api.vk.com/method/%s.xml?%s" % (method, urllib.urlencode(params_list)) 
        return url