Fixes.

[clinton/xbmc-groove.git] / resources / lib / GrooveAPI.py

import urllib2, md5, unicodedata, re, os, traceback, sys, pickle, socket, xbmc
from operator import itemgetter, attrgetter

class LoginTokensExceededError(Exception):
	def __init__(self):
		self.value = 'You have created to many tokens. Only 12 are allowed'
	def __str__(self):
		return repr(self.value)
		
class LoginUnknownError(Exception):
	def __init__(self):
		self.value = 'Unable to get a new session ID. Wait a few minutes and try again'
	def __str__(self):
		return repr(self.value)

class SessionIDTryAgainError(Exception):
	def __init__(self):
		self.value = 'Unable to get a new session ID. Wait a few minutes and try again'
	def __str__(self):
		return repr(self.value)

class GrooveAPI:
	def __init__(self, enableDebug = False, isXbox = False):
		import simplejson
		self.simplejson = simplejson
		timeout = 40
		socket.setdefaulttimeout(timeout)
		self.enableDebug = enableDebug
		self.loggedIn = 0
		self.radioEnabled = 0
		self.userId = 0
		self.seedArtists = []
		self.frowns = []
		self.songIDsAlreadySeen = []
		self.recentArtists = []
		self.removeDuplicates = False
		self.dataDir = 'plugin_data/music/'
		self.confDir = xbmc.translatePath(os.path.join('special://masterprofile/' + self.dataDir, os.path.basename(os.getcwd())))
		self.sessionID = self.getSavedSession()
		self.debug('Saved sessionID: ' + self.sessionID)
		#self.sessionID = self.getSessionFromAPI()
		#self.debug('API sessionID: ' + self.sessionID)
		if self.sessionID == '':
			self.sessionID = self.startSession()
			self.debug('Start() sessionID: ' + self.sessionID)
			if self.sessionID == '':
				self.debug('Could not get a sessionID. Try again in a few minutes')
				raise SessionIDTryAgainError()
			else:
				self.saveSession()
		
		self.debug('sessionID: ' + self.sessionID)

	def __del__(self):
		try:
			if self.loggedIn == 1:
				self.logout()
		except:
			pass
			
	def debug(self, msg):
		if self.enableDebug == True:
			print msg

	def setRemoveDuplicates(self, enable):
		if enable == True or enable == 'true' or enable == 'True':
			self.removeDuplicates = True
		else:
			self.removeDuplicates = False
			
	def getSavedSession(self):
		sessionID = ''
		path = os.path.join(self.confDir, 'session', 'session.txt')

		try:
			f = open(path, 'rb')
			sessionID = pickle.load(f)
			f.close()
		except:
			sessionID = ''
			pass		
		
		return sessionID

	def saveSession(self):			
		try:
			dir = os.path.join(self.confDir, 'session')
			# Create the 'data' directory if it doesn't exist.
			if not os.path.exists(dir):
				os.makedirs(dir)
			path = os.path.join(dir, 'session.txt')
			f = open(path, 'wb')
			pickle.dump(self.sessionID, f, protocol=pickle.HIGHEST_PROTOCOL)
			f.close()
		except IOError, e:
			print 'There was an error while saving the session pickle (%s)' % e
			pass
		except:
			print "An unknown error occured during save session: " + str(sys.exc_info()[0])
			pass
			
	def saveSettings(self):			
		try:
			dir = os.path.join(self.confDir, 'data')
			# Create the 'data' directory if it doesn't exist.
			if not os.path.exists(dir):
				os.makedirs(dir)
			path = os.path.join(dir, 'settings1.txt')
			f = open(path, 'wb')
			pickle.dump(self.settings, f, protocol=pickle.HIGHEST_PROTOCOL)
			f.close()
		except IOError, e:
			print 'There was an error while saving the settings pickle (%s)' % e
			pass
		except:
			print "An unknown error occured during save settings\n"
			pass

	def callRemote(self, method, params={}):
		data = {'header': {'sessionID': self.sessionID}, 'method': method, 'parameters': params}
		data = self.simplejson.dumps(data)
		req = urllib2.Request("http://api.grooveshark.com/ws/1.0/?json")
		req.add_header('Host', 'api.grooveshark.com')
		req.add_header('Content-type', 'text/json')
		req.add_header('Content-length', str(len(data)))
		req.add_data(data)
		response = urllib2.urlopen(req)
		result = response.read()
		response.close()
		try:
			result = self.simplejson.loads(result)
			if 'fault' in result:
				self.debug(result)
				if result['fault']['code'] == 8: #Session ID has expired. Get a new and try again if possible.
					self.debug(result['fault']['message'])
					self.sessionID = self.startSession()
					if self.sessionID != '':
						self.saveSession()
						return self.callRemote(method, params)
					else:
						self.debug('GrooveShark: SessionID expired, but unable to get new')
						return []
			return result
		except:
			return []

	def startSession(self):
		response = urllib2.urlopen("http://www.moovida.com/services/grooveshark/session_start")
		result = response.read()
		result = self.simplejson.loads(result)
		response.close()
		if 'fault' in result:
			return ''
		else:
			return result['header']['sessionID']

	def sessionDestroy(self):
		return self.callRemote("session.destroy")
			
	def getSessionFromAPI(self):
		result = self.callRemote("session.get")
		if 'fault' in result:
			return ''
		else:
			return result['header']['sessionID']												

	def getStreamURL(self, songID):
		result = self.callRemote("song.getStreamUrlEx", {"songID": songID})
		if 'result' in result:
			return result['result']['url']
		else:
			return ''
	
	def createUserAuthToken(self, username, password):
		hashpass = md5.new(password).hexdigest()
		hashpass = username + hashpass
		hashpass = md5.new(hashpass).hexdigest()
		result = self.callRemote("session.createUserAuthToken", {"username": username, "hashpass": hashpass})
		if 'result' in result:
			return result['result']['token'], result['result']['userID']
		elif 'fault' in result:
			if result['fault']['code'] == 256:
				return -1 # Exceeded the number of allowed tokens. Should not happen
			else:
				return -2 # Unknown error
		else:
			return -2 # Unknown error
	
	def destroyUserAuthToken(self, token):
		self.callRemote("session.destroyAuthToken", {"token": token})
		
	def loginViaAuthToken(self, token):
		result = self.callRemote("session.loginViaAuthToken", {"token": token})
		self.destroyUserAuthToken(token)
		if 'result' in result:
			self.userID = result['result']['userID']
			return result['result']['userID']
		else:
			return 0
	
	def login(self, username, password):
		if self.loggedIn == 1:
			return self.userId
		result = self.createUserAuthToken(username, password)
		if result == -1:
			raise LoginTokensExceededError()
		elif result == -2:
			raise LoginUnknownError()
		else:
			self.token = result[0]
			self.debug('Token:' + self.token)
			self.userId = self.loginViaAuthToken(self.token)
			if self.userId == 0:
				raise LoginUnknownError()
			else:
				self.loggedIn = 1
				return self.userId

			
	def loginExt(self, username, password):
		if self.loggedIn == 1:
			return self.userId
		token = md5.new(username.lower() + md5.new(password).hexdigest()).hexdigest()
		result = self.callRemote("session.loginExt", {"username": username, "token": token})
		if 'result' in result:
			if 'userID' in result['result']:
				self.loggedIn = 1
				self.userId = result['result']['userID']
				return result['result']['userID'] 
		else:
			return 0
			
				
	def loginBasic(self, username, password):
		if self.loggedIn == 1:
			return self.userId
		result = self.callRemote("session.login", {"username": username, "password": password})
		if 'result' in result:
			if 'userID' in result['result']:
				self.loggedIn = 1
				self.userId = result['result']['userID']
				return result['result']['userID'] 
		else:
			return 0

	def loggedInStatus(self):
		return self.loggedIn
	
	def logout(self):
		self.callRemote("session.logout", {})
		self.loggedIn = 0
		
	def getSongInfo(self, songID):
		return self.callRemote("song.about", {"songID": songID})['result']['song']
	
	def userGetFavoriteSongs(self, userID):
		result = self.callRemote("user.getFavoriteSongs", {"userID": userID})
		list = self.parseSongs(result)
		return list
	
	def userGetPlaylists(self, limit=25):
		if self.loggedIn == 1:
			result = self.callRemote("user.getPlaylists", {"userID": self.userId, "limit": limit})
			if 'result' in result:
				playlists = result['result']['playlists']
			else:
				return []
			i = 0
			list = []
			while(i < len(playlists)):
				p = playlists[i]
				list.append([p['playlistName'].encode('ascii', 'ignore'), p['playlistID']])
				i = i + 1	
			return sorted(list, key=itemgetter(0))
		else:
			return []

	def playlistCreate(self, name, about):
		if self.loggedIn == 1:
			result = self.callRemote("playlist.create", {"name": name, "about": about})
			if 'result' in result:
				return result['result']['playlistID']
			else:
				return 0
		else:
			return 0
			
	def playlistGetSongs(self, playlistId, limit=25):
		result = self.callRemote("playlist.getSongs", {"playlistID": playlistId})
		list = self.parseSongs(result)
		return list
			
	def playlistDelete(self, playlistId):
		if self.loggedIn == 1:
			return self.callRemote("playlist.delete", {"playlistID": playlistId})

	def playlistRename(self, playlistId, name):
		if self.loggedIn == 1:
			result = self.callRemote("playlist.rename", {"playlistID": playlistId, "name": name})
			if 'fault' in result:
				return 0
			else:
				return 1
		else:
			return 0

	def playlistClearSongs(self, playlistId):
		if self.loggedIn == 1:
			return self.callRemote("playlist.clearSongs", {"playlistID": playlistId})

	def playlistAddSong(self, playlistId, songId, position):
		if self.loggedIn == 1:
			result = self.callRemote("playlist.addSong", {"playlistID": playlistId, "songID": songId, "position": position})
			if 'fault' in result:
				return 0
			else:
				return 1
		else:
			return 0
			
	def playlistReplace(self, playlistId, songIds):
		if self.loggedIn == 1:
			result = self.callRemote("playlist.replace", {"playlistID": playlistId, "songIDs": songIds})
			if 'fault' in result:
				return 0
			else:
				return 1
		else:
			return 0

	def autoplayStartWithArtistIDs(self, artistIds):
		result = self.callRemote("autoplay.startWithArtistIDs", {"artistIDs": artistIds})
		if 'fault' in result:
			self.radioEnabled = 0
			return 0
		else:
			self.radioEnabled = 1
			return 1		

	def autoplayStart(self, songIds):
		result = self.callRemote("autoplay.start", {"songIDs": songIds})
		if 'fault' in result:
			self.radioEnabled = 0
			return 0
		else:
			self.radioEnabled = 1
			return 1

	def autoplayGetNextSongEx(self, seedArtists = [], frowns = [], songIDsAlreadySeen = [], recentArtists = []):
		result = self.callRemote("autoplay.getNextSongEx", {"seedArtists": seedArtists, "frowns": frowns, "songIDsAlreadySeen": songIDsAlreadySeen, "recentArtists": recentArtists})
		if 'fault' in result:
			return []
		else:
			return result
	
	def radioGetNextSong(self):
		radio = self.getSavedRadio()
		if radio == None:
			return None
		else:
			seedArtists = []
			for song in radio['seedArtists']:
				seedArtists.append(song[7])
			result = self.autoplayGetNextSongEx(seedArtists, radio['frowns'], radio['songIDsAlreadySeen'], radio['recentArtists'])
			if 'fault' in result:
				return []
			else:
				song = self.parseSongs(result)
				self.radioSetAlreadyListenedSong(songId = song[0][1])
				return song

	def radioFrown(self, songId):
		self.frown.append(songId)

	def radioAlreadySeen(self, songId):
		self.songIDsAlreadySeen.append(songId)

	def radioAddArtist(self, song = None, radioName = None):
		radio = self.getSavedRadio(name = radioName)
		if radio != None and song != None:
			radio['seedArtists'].append(song)
			return self.saveRadio(radio = radio)
		else:
			return 0

	def radioStart(self, artists = [], frowns = []):
		for artist in artists:
			self.seedArtists.append(artist)
		for artist in frowns:
			self.frowns.append(artist)
		if self.autoplayStartWithArtistIDs(self.seedArtists) == 1:
			self.radioEnabled = 1
			return 1
		else:
			self.radioEnabled = 0
			return 0

	def radioStop(self):
		self.seedArtists = []
		self.frowns = []
		self.songIDsAlreadySeen = []
		self.recentArtists = []
		self.radioEnabled = 0

	def radioTurnedOn(self):
		return self.radioEnabled

	def radioSetAlreadyListenedSong(self, name = None, songId = ''):
		radio = self.getSavedRadio(name = name)
		if radio != None and songId != '':
			radio['songIDsAlreadySeen'].append(songId)
			while len(radio['songIDsAlreadySeen']) > 20:
				radio['songIDsAlreadySeen'].pop(0) # Trim
			return self.saveRadio(radio = radio)
		else:
			return 0

	def getSavedRadio(self, name = None):
		if name == None:
			path = os.path.join(self.confDir, 'radio', 'default.txt')
		else:
			path = os.path.join(self.confDir, 'radio', 'saved', name)
		try:
			f = open(path, 'rb')
			radio = pickle.load(f)
			f.close()
		except:
			radio = None
		return radio

	def saveRadio(self, name = None, radio = {}): #blaher
		try:
			dir = os.path.join(self.confDir, 'radio')
			# Create the 'data' directory if it doesn't exist.
			if not os.path.exists(dir):
				os.mkdir(dir)
				os.mkdir(os.path.join(dir, 'saved'))
			if name == None:
				path = os.path.join(dir, 'default.txt')
			else:
				path = os.path.join(dir, 'saved', name)
			f = open(path, 'wb')
			pickle.dump(radio, f, protocol=pickle.HIGHEST_PROTOCOL)
			f.close()
			return 1
		except IOError, e:
			print 'There was an error while saving the radio pickle (%s)' % e
			return 0
		except:
			print "An unknown error occured during save radio: " + str(sys.exc_info()[0])
			return 0

	def favoriteSong(self, songID):
		return self.callRemote("song.favorite", {"songID": songID})

	def unfavoriteSong(self, songID):
		return self.callRemote("song.unfavorite", {"songID": songID})
		
	def getMethods(self):
		return self.callRemote("service.getMethods")

	def searchSongsExactMatch(self, songName, artistName, albumName):
		result = self.callRemote("search.songExactMatch", {"songName": songName, "artistName": artistName, "albumName": albumName})
		list = self.parseSongs(result)
		return list

	def searchSongs(self, query, limit, page=0, sortKey=6):
		result = self.callRemote("search.songs", {"query": query, "limit": limit, "page:": page, "streamableOnly": 1})
		list = self.parseSongs(result)
		return list
		#return sorted(list, key=itemgetter(sortKey))

	def searchArtists(self, query, limit, sortKey=0):
		result = self.callRemote("search.artists", {"query": query, "limit": limit, "streamableOnly": 1})
		list = self.parseArtists(result)
		return list
		#return sorted(list, key=itemgetter(sortKey))

	def searchAlbums(self, query, limit, sortKey=2):
		result = self.callRemote("search.albums", {"query": query, "limit": limit, "streamableOnly": 1})
		list = self.parseAlbums(result)
		return list
		#return sorted(list, key=itemgetter(sortKey))

	def searchPlaylists(self, query, limit):
		result = self.callRemote("search.playlists", {"query": query, "limit": limit, "streamableOnly": 1})
		list = self.parsePlaylists(result)
		return list

	def popularGetSongs(self, limit):
		result = self.callRemote("popular.getSongs", {"limit": limit})
		list = self.parseSongs(result)
		return list
		
	def popularGetArtists(self, limit):
		result = self.callRemote("popular.getArtists", {"limit": limit})
		list = self.parseArtists(result)
		return list

	def popularGetAlbums(self, limit):
		result = self.callRemote("popular.getAlbums", {"limit": limit})
		list = self.parseAlbums(result)
		return list
		
	def artistAbout(self, artistId):
		result = self.callRemote("artist.about", {"artistID": artistId})
		return result
		
	def artistGetAlbums(self, artistId, limit, sortKey=2):
		result = self.callRemote("artist.getAlbums", {"artistID": artistId, "limit": limit})
		list = self.parseAlbums(result)
		return list
		#return sorted(list, key=itemgetter(sortKey))

	def artistGetVerifiedAlbums(self, artistId, limit):
		result = self.callRemote("artist.getVerifiedAlbums", {"artistID": artistId, "limit": limit})
		list = self.parseSongs(result)
		return list

	def albumGetSongs(self, albumId, limit):
		result = self.callRemote("album.getSongs", {"albumID": albumId, "limit": limit})
		list = self.parseSongs(result)
		return list

	def songGetSimilar(self, songId, limit):
		result = self.callRemote("song.getSimilar", {"songID": songId, "limit": limit})
		list = self.parseSongs(result)
		return list

	def artistGetSimilar(self, artistId, limit):
		result = self.callRemote("artist.getSimilar", {"artistID": artistId, "limit": limit})
		list = self.parseArtists(result)
		return list

	def songAbout(self, songId):
		result = self.callRemote("song.about", {"songID": songId})
		return result['result']['song']

	def getVersion(self):
		result = self.callRemote("service.getVersion", {})
		return result

	def parseSongs(self, items):
		try:
			if 'result' in items:
				i = 0
				list = []
				if 'songs' in items['result']:
					l = len(items['result']['songs'])
					index = 'songs'
				elif 'song' in items['result']:
					l = 1
					index = 'song'
				else:
					l = 0
					index = ''
				while(i < l):
					if index == 'songs':
						s = items['result'][index][i]
					else:
						s = items['result'][index]
					if 'estDurationSecs' in s:
						dur = s['estDurationSecs']
					else:
						dur = 0
					try:
						notIn = True
						for entry in list:
							songName = s['songName'].encode('ascii', 'ignore')
							albumName = s['albumName'].encode('ascii', 'ignore')
							artistName = s['artistName'].encode('ascii', 'ignore')
							if self.removeDuplicates == True:
								if (entry[0].lower() == songName.lower()) and (entry[3].lower() == albumName.lower()) and (entry[6].lower() == artistName.lower()):
									notIn = False
						if notIn == True:
							list.append([s['songName'].encode('ascii', 'ignore'),\
							s['songID'],\
							dur,\
							s['albumName'].encode('ascii', 'ignore'),\
							s['albumID'],\
							s['image']['tiny'].encode('ascii', 'ignore'),\
							s['artistName'].encode('ascii', 'ignore'),\
							s['artistID'],\
							s['image']['small'].encode('ascii', 'ignore'),\
							s['image']['medium'].encode('ascii', 'ignore')])
					except:
						print 'GrooveShark: Could not parse song number: ' + str(i)
						traceback.print_exc()
					i = i + 1
				return list
			else:
				return []
				pass
		except:
			print 'GrooveShark: Could not parse songs. Got this:'
			traceback.print_exc()
			return []

	def parseArtists(self, items):
		try:
			if 'result' in items:
				i = 0
				list = []
				artists = items['result']['artists']
				while(i < len(artists)):
					s = artists[i]
					try:
						list.append([s['artistName'].encode('ascii', 'ignore'),\
						s['artistID']])
					except:
						print 'GrooveShark: Could not parse album number: ' + str(i)
						traceback.print_exc()
					i = i + 1
				return list
			else:
				return []
		except:
			print 'GrooveShark: Could not parse artists. Got this:'
			traceback.print_exc()
			return []

	def parseAlbums(self, items):
		try:
			if 'result' in items:
				i = 0
				list = []
				albums = items['result']['albums']
				while(i < len(albums)):
					s = albums[i]
					try: # Avoid ascii ancoding errors
						list.append([s['artistName'].encode('ascii', 'ignore'),\
						s['artistID'],\
						s['albumName'].encode('ascii', 'ignore'),\
						s['albumID'],\
						s['image']['tiny'].encode('ascii', 'ignore')])
					except:
						print 'GrooveShark: Could not parse album number: ' + str(i)
						traceback.print_exc()
					i = i + 1
				return list
			else:
				return []
		except:
			print 'GrooveShark: Could not parse albums. Got this'
			traceback.print_exc()
			return []

	def parsePlaylists(self, items):
		try:
			if 'result' in items:
				i = 0
				list = []
				playlists = items['result']['playlists']
				while(i < len(playlists)):
					s = playlists[i]
					try: # Avoid ascii ancoding errors
						list.append([s['playlistID'],\
						s['playlistName'].encode('ascii', 'ignore'),\
						s['username'].encode('ascii', 'ignore')])
					except:
						print 'GrooveShark: Could not parse playlist number: ' + str(i)
						traceback.print_exc()
					i = i + 1
				return list
			else:
				return []
		except:
			print 'GrooveShark: Could not parse playlists. Got this:'
			print items
			return []