Add search of artist's albums.
[clinton/xbmc-groove.git] / resources / lib / GroovesharkAPI.py
index 85a1ad1..d571670 100644 (file)
@@ -1,42 +1,51 @@
-import socket, hmac, urllib, urllib2, pprint, md5, uuid, re, hashlib, time, random, os, pickle
+import socket, hmac, urllib, urllib2, pprint, md5, re, sha, time, random, os, pickle, uuid, tempfile
+
+SESSION_EXPIRY = 518400 # 6 days in seconds
 
 # GrooveAPI constants
 THUMB_URL = 'http://beta.grooveshark.com/static/amazonart/'
-THUMB_URL_DEFAULT = 'http://grooveshark.com/webincludes/logo/Grooveshark_Logo_No-Text.png'
 SONG_LIMIT = 25
 ALBUM_LIMIT = 15
 ARTIST_LIMIT = 15
+SONG_SUFFIX = '.mp3'
 
 # GrooveSong constants
 DOMAIN = "grooveshark.com"
 HOME_URL = "http://listen." + DOMAIN
-TOKEN_URL = "http://cowbell." + DOMAIN + "/more.php"
 API_URL = "http://cowbell." + DOMAIN + "/more.php"
 SERVICE_URL = "http://cowbell." + DOMAIN + "/service.php"
+TOKEN_URL = "http://cowbell." + DOMAIN + "/more.php"
 
-CLIENT_NAME = "gslite" #htmlshark #jsqueue
-CLIENT_VERSION = "20101012.37" #"20100831.25"
+CLIENT_NAME = "gslite"
+CLIENT_VERSION = "20101012.37"
 HEADERS = {"Content-Type": "application/json",
        "User-Agent": "Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.12) Gecko/20101026 Firefox/3.6.12 (.NET CLR 3.5.30729)",                        
        "Referer": "http://listen.grooveshark.com/main.swf?cowbell=fe87233106a6cef919a1294fb2c3c05f"}
 
-RE_SESSION = re.compile('"sessionID":"\s*?([A-z0-9]+)"') #re.compile('sessionID:\s*?\'([A-z0-9]+)\',')
+RE_SESSION = re.compile('"sessionID":"\s*?([A-z0-9]+)"')
 RANDOM_CHARS = "1234567890abcdef"
 
 # Get a song
 class GrooveSong:
        
-       def __init__(self, cacheDir):
+       def __init__(self):
 
                import simplejson
                self.simplejson = simplejson
-
-               self.cacheDir = cacheDir
-               self._lastTokenTime = 0
+               
+               self.cacheDir = os.path.join(tempfile.gettempdir(), 'groovesong')
+               self._lastSessionTime = 0
                self.uuid = self._getUUID()
-               self.sessionID = self._getSession(HOME_URL)
-               if self.sessionID == None:
-                       raise StandardError("Cannot get session id")
+               
+               self._getSavedSession()
+               # session ids last 1 week
+               if self.sessionID == '' or time.time() - self._lastSessionTime >= SESSION_EXPIRY:
+                       self.sessionID = self._getSession(HOME_URL)
+                       if self.sessionID == '':
+                               raise StandardError('Failed to get session id')
+                       else:
+                               print "New GrooveSong session id: " + self.sessionID
+                               self._setSavedSession()
                
        # The actual call to the API
        def _callRemote(self, method, params, type="default"):
@@ -85,17 +94,16 @@ class GrooveSong:
 
        #  Make a token ready for a request header
        def _getMethodToken(self, method):
-               if (time.time() - self._lastTokenTime) >= 1000:
-                       self._token = self._getCommunicationToken()
-                       if self._token == None:
-                               return None
-                       self._lastTokenTime = time.time()
+               self._token = self._getCommunicationToken()
+               if self._token == None:
+                       return None
 
                randomChars = ""
                while 6 > len(randomChars):
                        randomChars = randomChars + random.choice(RANDOM_CHARS)
 
-               token = hashlib.sha1(method + ":" + self._token + ":quitStealinMahShit:" + randomChars).hexdigest()
+               token = sha.new(method + ":" + self._token + ":quitStealinMahShit:" + randomChars).hexdigest()
+
                return randomChars + token
 
        # Generate a communication token
@@ -128,16 +136,44 @@ class GrooveSong:
                
        # Generate a secret key from a sessionID
        def _getSecretKey(self, sessionID):
-               return hashlib.md5(sessionID).hexdigest()
+               return md5.new(sessionID).hexdigest()
        
        # Get a session id from some HTML
        def _getSession(self, html):
                html = urllib2.urlopen(HOME_URL).read()
                session = RE_SESSION.search(html)
                if session:
+                       self._lastSessionTime = time.time()
                        return session.group(1)
                else:
                        return None
+               
+       def _getSavedSession(self):
+               path = os.path.join(self.cacheDir, 'session.dmp')
+               try:
+                       f = open(path, 'rb')
+                       session = pickle.load(f)
+                       self.sessionID = session['sessionID']
+                       self._lastSessionTime = session['lastSessionTime']
+                       f.close()
+               except:
+                       self.sessionID = ''
+                       self._lastSessionTime = 0
+                       pass            
+
+       def _setSavedSession(self):                     
+               try:
+                       # Create the 'data' directory if it doesn't exist.
+                       if not os.path.exists(self.cacheDir):
+                               os.makedirs(self.cacheDir)
+                       path = os.path.join(self.cacheDir, 'session.dmp')
+                       f = open(path, 'wb')
+                       session = {'sessionID' : self.sessionID, 'lastSessionTime' : self._lastSessionTime}
+                       pickle.dump(session, f, protocol=pickle.HIGHEST_PROTOCOL)
+                       f.close()
+               except:
+                       print "An error occurred during save session"
+                       pass
        
        # Gets a stream key and host to get song content
        def _getStreamDetails(self, songID):
@@ -148,9 +184,13 @@ class GrooveSong:
                        "country": {"IPR":"1021","ID":"223", "CC1":"0", "CC2":"0", "CC3":"0", "CC4":"2147483648"}
                        }
                response = self._callRemote("getStreamKeyFromSongIDEx", params)
-               self._lastStreamKey = response["result"]["streamKey"]
-               self._lastStreamServer = response["result"]["ip"]
-               self._lastStreamServerID = response["result"]["streamServerID"]
+               try: 
+                       self._lastStreamKey = response["result"]["streamKey"]
+                       self._lastStreamServer = response["result"]["ip"]
+                       self._lastStreamServerID = response["result"]["streamServerID"]
+                       return True
+               except:
+                       return False
                
        # Tells Grooveshark you have downloaded a song
        def _markSongDownloaded(self, songID):
@@ -160,17 +200,14 @@ class GrooveSong:
                        "songID": songID}
                self._callRemote("markSongDownloaded", params)
 
-       # Download a song to a temporary file
+       # Get the song URL
        def getSongURL(self, songID):
-               filename = os.path.join(self.cacheDir, songID + '.mp3')
-               if os.path.isfile(filename) == False:
-                       self._getStreamDetails(songID)
+               if self._getStreamDetails(songID) == True:
                        postData = {"streamKey": self._lastStreamKey}
                        postData = urllib.urlencode(postData)
-                       urllib.FancyURLopener().retrieve( "http://" + self._lastStreamServer + "/stream.php", filename, data=postData)
-                       self._markSongDownloaded(songID)
-               return filename
-
+                       return "http://" + self._lastStreamServer + "/stream.php?" + str(postData)
+               else:
+                       return ''
 
 # Main API
 class GrooveAPI:
@@ -181,20 +218,26 @@ class GrooveAPI:
        lastSessionTime = 0
 
        # Constructor
-       def __init__(self, cacheDir):
+       def __init__(self):
+               
                import simplejson
                self.simplejson = simplejson
                socket.setdefaulttimeout(40)
-               self.cacheDir = cacheDir
-               self._getSavedSessionID()
+               
+               self.cacheDir = os.path.join(tempfile.gettempdir(), 'grooveapi')
+               if os.path.isdir(self.cacheDir) == False:
+                       os.makedirs(self.cacheDir)
+                       print "Made " + self.cacheDir
+
+               self._getSavedSession()
                # session ids last 1 week
-               if self.sessionID == '' or time.time()- self.lastSessionTime >= 6*86400:
+               if self.sessionID == '' or time.time()- self.lastSessionTime >= SESSION_EXPIRY:
                        self.sessionID = self._getSessionID()
                        if self.sessionID == '':
                                raise StandardError('Failed to get session id')
                        else:
-                               print "New session id: " + self.sessionID
-                               self._setSavedSessionID()
+                               print "New GrooveAPI session id: " + self.sessionID
+                               self._setSavedSession()
 
        # Sort keys             
        def _keySort(self, d):
@@ -219,6 +262,7 @@ class GrooveAPI:
                req = urllib2.Request(url)
                response = urllib2.urlopen(req)
                result = response.read()
+               print "Response..."
                pprint.pprint(result)
                response.close()
                try:
@@ -234,32 +278,33 @@ class GrooveAPI:
                self.lastSessionTime = time.time()
                return result['result']['sessionID']
        
-       def _getSavedSessionID(self):
-               path = os.path.join(self.cacheDir, 'session', 'session.dmp')
+       def _getSavedSession(self):
+               path = os.path.join(self.cacheDir, 'session.dmp')
                try:
                        f = open(path, 'rb')
                        session = pickle.load(f)
                        self.sessionID = session['sessionID']
                        self.lastSessionTime = session['lastSessionTime']
+                       self.userID = session['userID']
                        f.close()
                except:
                        self.sessionID = ''
                        self.lastSessionTime = 0
+                       self.userID = 0
                        pass            
 
-       def _setSavedSessionID(self):                   
+       def _setSavedSession(self):                     
                try:
-                       dir = os.path.join(self.cacheDir, '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.dmp')
+                       # Create the directory if it doesn't exist.
+                       if not os.path.exists(self.cacheDir):
+                               os.makedirs(self.cacheDir)
+                       path = os.path.join(self.cacheDir, 'session.dmp')
                        f = open(path, 'wb')
-                       session = { 'sessionID' : self.sessionID, 'lastSessionTime' : self.lastSessionTime}
+                       session = { 'sessionID' : self.sessionID, 'lastSessionTime' : self.lastSessionTime, 'userID': self.userID}
                        pickle.dump(session, f, protocol=pickle.HIGHEST_PROTOCOL)
                        f.close()
                except:
-                       print "An error occured during save session"
+                       print "An error occurred during save session"
                        pass
        
        # Make user authentication token
@@ -274,18 +319,25 @@ class GrooveAPI:
        
        # Login
        def login(self, username, password):
-               token = self._getUserToken(username, password)
-               self.userID = self._authenticateUser(username, token)
+               if self.userID <= 0:
+                       # Check cache
+                       self._getSavedSession()
+                       if self.userID <= 0: 
+                               token = self._getUserToken(username, password)
+                               self.userID = self._authenticateUser(username, token)
+                               if self.userID > 0:
+                                       self._setSavedSession()
                return self.userID
                
        # Logs the user out
        def logout(self):
-               self._callRemote('logout', {'sessionID' : self.sessionID})
+               result = self._callRemote('logout', {'sessionID' : self.sessionID})
+               if 'result' in result and result['result']['success'] == True: 
+                       self.userID = 0
+                       self._setSavedSession()
+                       return True
+               return False
 
-       # Return user id
-       def getUserID(self):
-               return self.userID
-       
        # Search for albums
        def getArtistSearchResults(self, query, limit=ARTIST_LIMIT):
                result = self._callRemote('getArtistSearchResults', {'query' : query,'limit' : limit})
@@ -309,12 +361,29 @@ class GrooveAPI:
                        return self._parseSongs(result)
                else:
                        return []
-       
+               
+       # Get artists albums
+       def getArtistAlbums(self, artistID, limit=ALBUM_LIMIT):
+               result = self._callRemote('getArtistAlbums', {'artistID' : artistID})
+               if 'result' in result:
+                       return self._parseAlbums(result, limit)
+               else:
+                       return []
+
+       # Get album songs
+       def getAlbumSongs(self, albumID, limit=SONG_LIMIT):
+               result = self._callRemote('getAlbumSongsEx', {'albumID' : albumID, 'limit' : limit})
+               if 'result' in result:
+                       return self._parseSongs(result)
+               else:
+                       return []
+               
        # Gets the popular songs
        def getPopularSongsToday(self, limit=SONG_LIMIT):
                result = self._callRemote('getPopularSongsToday', {'limit' : limit})
                if 'result' in result:
-                       return self._parseSongs(result)
+                       # Note limit is broken in the Grooveshark getPopularSongsToday method
+                       return self._parseSongs(result, limit)
                else:
                        return []
 
@@ -334,11 +403,13 @@ class GrooveAPI:
                        return False;
                result = self._callRemote('addUserFavoriteSong', {'sessionID' : self.sessionID, 'songID' : songID})
                return result['result']['success']
-               
+
        # Get the url to link to a song on Grooveshark
        def getSongURLFromSongID(self, songID):
-               song = GrooveSong(self.cacheDir)
-               return song.getSongURL(songID)
+               song = GrooveSong()
+               url = song.getSongURL(songID)
+               print "Got song URL " + url
+               return url
 
        # Get the url to link to a song on Grooveshark
        def getSongInfo(self, songID):
@@ -348,10 +419,10 @@ class GrooveAPI:
                        if 'CoverArtFilename' in info and info['CoverArtFilename'] != None:
                                info['CoverArtFilename'] = THUMB_URL+info['CoverArtFilename'].encode('ascii', 'ignore')
                        else:
-                               info['CoverArtFilename'] = THUMB_URL_DEFAULT
+                               info['CoverArtFilename'] = 'None'
                        return info
                else:
-                       return ''
+                       return 'None'
 
        # Gets the playlists of the logged-in user
        def getUserPlaylists(self):
@@ -362,12 +433,31 @@ class GrooveAPI:
                        return self._parsePlaylists(result)
                else:
                        return []
+               
+       # Get userid from name
+       def _getUserIDFromUsername(self, username):
+               result = self._callRemote('getUserIDFromUsername', {'username' : username})
+               if 'result' in result and result['result']['UserID'] > 0:
+                       return result['result']['UserID']
+               else:
+                       return 0
+
+       # Gets the playlists of the logged-in user
+       def getUserPlaylistsEx(self, username):
+               userID = self._getUserIDFromUsername(username)
+               if (userID > 0):
+                       result = self._callRemote('getUserPlaylistsEx', {'userID' : userID})
+                       if 'result' in result and result['result']['playlists'] != None:
+                               playlists = result['result']['playlists']
+                               return self._parsePlaylists(playlists)
+               else:
+                       return []
 
        # Creates a playlist with songs
        def createPlaylist(self, name, songIDs):
                result = self._callRemote('createPlaylist', {'name' : name, 'songIDs' : songIDs, 'sessionID' : self.sessionID})
                if 'result' in result and result['result']['success'] == True: 
-                       return result['result']['PlaylistID']
+                       return result['result']['playlistID']
                elif 'errors' in result:
                        return 0
 
@@ -375,9 +465,9 @@ class GrooveAPI:
        def setPlaylistSongs(self, playlistID, songIDs):
                result = self._callRemote('setPlaylistSongs', {'playlistID' : playlistID, 'songIDs' : songIDs, 'sessionID' : self.sessionID})
                if 'result' in result and result['result']['success'] == True: 
-                       return True;
+                       return True
                else:
-                       return False;
+                       return False
 
        # Gets the songs of a playlist
        def getPlaylistSongs(self, playlistID):
@@ -386,9 +476,17 @@ class GrooveAPI:
                        return self._parseSongs(result)
                else:
                        return []
+
+       # Check the service
+       def pingService(self,):
+               result = self._callRemote('pingService', {});
+               if 'result' in result and result['result'] != '':
+                       return True
+               else:
+                       return False
        
        # Extract song data     
-       def _parseSongs(self, items):
+       def _parseSongs(self, items, limit=0):
                if 'result' in items:
                        i = 0
                        list = []
@@ -401,6 +499,8 @@ class GrooveAPI:
                        else:
                                l = len(items['result'])
                                index = ''
+                       if limit > 0 and l > limit:
+                               l = limit
                        while(i < l):
                                if index == 'songs':
                                        s = items['result'][index][i]
@@ -414,7 +514,7 @@ class GrooveAPI:
                                elif s['CoverArtFilename'] != None:
                                        coverart = THUMB_URL+s['CoverArtFilename'].encode('ascii', 'ignore')
                                else:
-                                       coverart = THUMB_URL_DEFAULT
+                                       coverart = 'None'
                                list.append([s['SongName'].encode('ascii', 'ignore'),\
                                s['SongID'],\
                                s['AlbumName'].encode('ascii', 'ignore'),\
@@ -443,17 +543,24 @@ class GrooveAPI:
                        return []
 
        # Extract album data    
-       def _parseAlbums(self, items):
+       def _parseAlbums(self, items, limit=0):
                if 'result' in items:
                        i = 0
                        list = []
-                       albums = items['result']['albums']
-                       while(i < len(albums)):
+                       try:
+                               albums = items['result']['albums']
+                       except:
+                               res = items['result'][0]
+                               albums = res['albums']
+                       l = len(albums)
+                       if limit > 0 and l > limit:
+                               l = limit
+                       while(i < l):
                                s = albums[i]
                                if 'CoverArtFilename' in s and s['CoverArtFilename'] != None:
                                        coverart = THUMB_URL+s['CoverArtFilename'].encode('ascii', 'ignore')
                                else:
-                                       coverart = THUMB_URL_DEFAULT
+                                       coverart = 'None'
                                list.append([s['ArtistName'].encode('ascii', 'ignore'),\
                                s['ArtistID'],\
                                s['AlbumName'].encode('ascii', 'ignore'),\
@@ -465,38 +572,43 @@ class GrooveAPI:
                        return []
 
        def _parsePlaylists(self, items):
+               i = 0
+               list = []
                if 'result' in items:
-                       i = 0
-                       list = []
                        playlists = items['result']
-                       while(i < len(playlists)):
-                               s = playlists[i]
-                               list.append([s['PlaylistID'],\
-                               s['Name'].encode('ascii', 'ignore')])
-                               i = i + 1
-                       return list
+               elif len(items) > 0:
+                       playlists = items
                else:
                        return []
                
-
+               while (i < len(playlists)):
+                       s = playlists[i]
+                       list.append([s['Name'].encode('ascii', 'ignore'), s['PlaylistID']])
+                       i = i + 1
+               return list
 
 # Test
-import sys
-res = []
-groovesharkApi = GrooveAPI('/tmp')
-res = groovesharkApi.login(sys.argv[1], sys.argv[2])
+#import sys
+#res = []
+#groovesharkApi = GrooveAPI()
+#res = groovesharkApi.pingService()
+#res = groovesharkApi.login(sys.argv[1], sys.argv[2])
+#songIDs = ['23404546','23401810','23401157']
+#res = groovesharkApi.createPlaylist("Test")
+#res = groovesharkApi.setPlaylistSongs(res, songIDs)
+#res = groovesharkApi.getPlaylistSongs(42251632)
 #res = groovesharkApi.getSongSearchResults('jimmy jazz', 3)
-#res = groovesharkApi.getPopularSongsToday()
-#res = groovesharkApi.getSongURLFromSongID('27425375')
+#res = groovesharkApi.getPopularSongsToday(3)
+#res = groovesharkApi.getSongURLFromSongID('26579347')
 #res = groovesharkApi.getAlbumSearchResults('london calling', 3)
+#res = groovesharkApi.getArtistAlbums('52283')
 #res = groovesharkApi.getArtistSearchResults('the clash', 3)
 #res = groovesharkApi.getUserFavoriteSongs()
-res = groovesharkApi.getUserPlaylists()
+#res = groovesharkApi.getUserPlaylists()
 #res = groovesharkApi.getSongInfo('27425375')
 #res = groovesharkApi.getPlaylistSongs(40902662)
 #res = groovesharkApi.addUserFavoriteSong('27425375')
-
-pprint.pprint(res)
-
-
-
+#res = groovesharkApi.logout()
+#res = groovesharkApi.getUserPlaylistsEx('stephendenham')
+#
+#pprint.pprint(res)