3 # This file is part of Jamaendo.
4 # Copyright (c) 2010, Kristoffer Gronlund
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions are met:
9 # * Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
11 # * Redistributions in binary form must reproduce the above copyright
12 # notice, this list of conditions and the following disclaimer in the
13 # documentation and/or other materials provided with the distribution.
14 # * Neither the name of Jamaendo nor the
15 # names of its contributors may be used to endorse or promote products
16 # derived from this software without specific prior written permission.
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 # DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
22 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 # An improved, structured jamendo API wrapper for the N900 with cacheing
30 # Image / cover downloads.. and more?
31 import urllib, threading, os, gzip, time, simplejson, re
35 _GET2 = '''http://api.jamendo.com/get2/'''
36 _MP3URL = _GET2+'stream/track/redirect/?id=%d&streamencoding=mp31'
37 _OGGURL = _GET2+'stream/track/redirect/?id=%d&streamencoding=ogg2'
40 def set_cache_dir(cachedir):
44 _COVERDIR = os.path.join(_CACHEDIR, 'covers')
47 os.makedirs(_CACHEDIR)
52 os.makedirs(_COVERDIR)
56 # These classes can be partially constructed,
57 # and if asked for a property they don't know,
58 # makes a query internally to get the full story
60 _ARTIST_FIELDS = ['id', 'name', 'image']
61 _ALBUM_FIELDS = ['id', 'name', 'image', 'artist_name', 'artist_id', 'license_url']
62 _TRACK_FIELDS = ['id', 'name', 'image', 'artist_name', 'album_name', 'album_id', 'numalbum', 'duration']
63 _RADIO_FIELDS = ['id', 'name', 'idstr', 'image']
65 class LazyQuery(object):
66 def set_from_json(self, json):
67 for key, value in json.iteritems():
69 assert(self.ID == int(value))
71 if key.endswith('_id'):
73 setattr(self, key, value)
76 """Not automatic for now,
77 will have to do artist.load()
79 This is filled in further down
84 def _needs_load(self):
87 def _set_from(self, other):
90 def _needs_load_impl(self, *attrs):
92 if getattr(self, attr) is None:
96 def _set_from_impl(self, other, *attrs):
98 self._set_if(other, attr)
100 def _set_if(self, other, attrname):
101 if getattr(self, attrname) is None and getattr(other, attrname) is not None:
102 setattr(self, attrname, getattr(other, attrname))
106 return u"%s(%s)"%(self.__class__.__name__,
107 u", ".join(repr(v) for k,v in self.__dict__.iteritems() if not k.startswith('_')))
108 except UnicodeEncodeError:
110 traceback.print_exc()
111 return u"%s(?)"%(self.__class__.__name__)
113 class Artist(LazyQuery):
114 def __init__(self, ID, json=None):
118 self.albums = None # None means not downloaded
120 self.set_from_json(json)
122 def _needs_load(self):
123 return self._needs_load_impl('name', 'albums')
125 def _set_from(self, other):
126 return self._set_from_impl(other, 'name', 'image', 'albums')
128 class Album(LazyQuery):
129 def __init__(self, ID, json=None):
133 self.artist_name = None
134 self.artist_id = None
135 self.license_url = None
136 self.tracks = None # None means not downloaded
138 self.set_from_json(json)
140 def _needs_load(self):
141 return self._needs_load_impl('name', 'image', 'artist_name', 'artist_id', 'license_url', 'tracks')
143 def _set_from(self, other):
144 return self._set_from_impl(other, 'name', 'image', 'artist_name', 'artist_id', 'license_url', 'tracks')
146 class Track(LazyQuery):
147 def __init__(self, ID, json=None):
151 self.artist_name = None
152 self.album_name = None
157 self.set_from_json(json)
160 return _MP3URL%(self.ID)
163 return _OGGURL%(self.ID)
165 def _needs_load(self):
166 return self._needs_load_impl('name', 'artist_name', 'album_name', 'album_id', 'numalbum', 'duration')
168 def _set_from(self, other):
169 return self._set_from_impl(other, 'name', 'image', 'artist_name', 'album_name', 'album_id', 'numalbum', 'duration')
171 class Radio(LazyQuery):
172 def __init__(self, ID, json=None):
178 self.set_from_json(json)
180 def _needs_load(self):
181 return self._needs_load_impl('name', 'idstr', 'image')
183 def _set_from(self, other):
184 return self._set_from_impl(other, 'name', 'idstr', 'image')
187 _artists = {} # id -> Artist()
188 _albums = {} # id -> Album()
189 _tracks = {} # id -> Track()
190 _radios = {} # id -> Radio()
193 # cache sizes per session (TODO)
194 _CACHED_ARTISTS = 100
199 # TODO: cache queries?
202 rate_limit = 1.1 # seconds between queries
203 last_query = time.time() - 1.5
208 if now - cls.last_query < cls.rate_limit:
209 time.sleep(cls.rate_limit - (now - cls.last_query))
215 def _geturl(self, url):
216 print "*** %s" % (url)
218 f = urllib.urlopen(url)
219 ret = simplejson.load(f)
224 return "#%s" % (self.__class__.__name__)
229 class CoverCache(object):
231 cache and fetch covers
232 TODO: background thread that
233 fetches and returns covers,
237 self._covers = {} # (albumid, size) -> file
238 coverdir = _COVERDIR if _COVERDIR else '/tmp'
239 if os.path.isdir(coverdir):
240 covermatch = re.compile(r'(\d+)\-(\d+)\.jpg')
241 for fil in os.listdir(coverdir):
242 fl = os.path.join(coverdir, fil)
243 m = covermatch.match(fil)
244 if m and os.path.isfile(fl):
245 self._covers[(int(m.group(1)), int(m.group(2)))] = fl
247 def fetch_cover(self, albumid, size):
248 coverdir = _COVERDIR if _COVERDIR else '/tmp'
249 to = os.path.join(coverdir, '%d-%d.jpg'%(albumid, size))
250 if not os.path.isfile(to):
251 url = _GET2+'image/album/redirect/?id=%d&imagesize=%d'%(albumid, size)
252 urllib.urlretrieve(url, to)
253 self._covers[(albumid, size)] = to
256 def get_cover(self, albumid, size):
257 cover = self._covers.get((albumid, size), None)
259 cover = self.fetch_cover(albumid, size)
262 def get_async(self, albumid, size, cb):
263 cover = self._covers.get((albumid, size), None)
268 cover = self.fetch_cover(albumid, size)
271 _cover_cache = CoverCache()
273 def get_album_cover(albumid, size=200):
274 return _cover_cache.get_cover(albumid, size)
276 def get_album_cover_async(cb, albumid, size=200):
277 _cover_cache.get_async(albumid, size, cb)
279 class CustomQuery(Query):
280 def __init__(self, url):
285 return self._geturl(self.url)
290 class GetQuery(Query):
293 'url' : _GET2+'+'.join(_ARTIST_FIELDS)+'/artist/json/?',
294 'params' : 'artist_id=%d',
295 'constructor' : Artist
298 'url' : _GET2+'+'.join(_ALBUM_FIELDS)+'/album/json/?',
299 'params' : 'album_id=%d',
300 'constructor' : Album
303 'url' : _GET2+'+'.join(_ALBUM_FIELDS)+'/album/json/?',
304 'params' : 'artist_id=%d',
305 'constructor' : [Album]
308 'url' : _GET2+'+'.join(_TRACK_FIELDS)+'/track/json/track_album+album_artist?',
310 'constructor' : Track
313 'url' : _GET2+'+'.join(_TRACK_FIELDS)+'/track/json/track_album+album_artist?',
314 'params' : 'order=numalbum_asc&album_id=%d',
315 'constructor' : [Track]
318 'url' : _GET2+'+'.join(_TRACK_FIELDS)+'/track/json/radio_track_inradioplaylist+track_album+album_artist/?',
319 'params' : 'order=random_asc&radio_id=%d',
320 'constructor' : [Track]
322 'favorite_albums' : {
323 'url' : _GET2+'+'.join(_ALBUM_FIELDS)+'/album/json/album_user_starred/?',
324 'params' : 'user_idstr=%s',
325 'constructor' : [Album]
327 #http://api.jamendo.com/get2/id+name+url+image+artist_name/album/jsonpretty/album_user_starred/?user_idstr=sylvinus&n=all
328 #q = SearchQuery('album', user_idstr=user)
331 #http://api.jamendo.com/get2/id+name+image+artist_name+album_name+album_id+numalbum+duration/track/json/radio_track_inradioplaylist+track_album+album_artist/?order=numradio_asc&radio_id=283
333 def __init__(self, what, ID):
336 info = GetQuery.queries[what]
337 self.url = info['url']
338 self.params = info['params']
339 self.constructor = info['constructor']
341 def construct(self, data):
342 constructor = self.constructor
343 if isinstance(constructor, list):
344 constructor = constructor[0]
345 if isinstance(data, list):
346 return [constructor(int(x['id']), json=x) for x in data]
348 return constructor(int(data['id']), json=data)
351 js = self._geturl(self.url + self.params % (self.ID))
354 return self.construct(js)
357 return self.url + self.params % (self.ID)
359 class SearchQuery(GetQuery):
360 def __init__(self, what, query=None, order=None, user=None, count=10):
361 GetQuery.__init__(self, what, None)
370 params['searchquery'] = self.query
372 params['order'] = self.order
374 params['n'] = self.count
376 params['user_idstr'] = self.user
377 js = self._geturl(self.url + urllib.urlencode(params))
380 return self.construct(js)
383 params = {'searchquery':self.query, 'order':self.order, 'n':self.count}
384 return self.url + urllib.urlencode(params)
386 class JamendoAPIException(Exception):
387 def __init__(self, url):
388 Exception.__init__(self, url)
390 def _update_cache(cache, new_items):
391 if not isinstance(new_items, list):
392 new_items = [new_items]
393 for item in new_items:
394 old = cache.get(item.ID)
398 cache[item.ID] = item
400 def get_artist(artist_id):
401 """Returns: Artist"""
402 a = _artists.get(artist_id, None)
404 q = GetQuery('artist', artist_id)
407 raise JamendoAPIException(str(q))
408 _update_cache(_artists, a)
409 if isinstance(a, list):
413 def get_albums(artist_id):
414 """Returns: [Album]"""
415 q = GetQuery('albums', artist_id)
418 raise JamendoAPIException(str(q))
419 _update_cache(_artists, a)
422 def get_album(album_id):
424 a = _albums.get(album_id, None)
426 q = GetQuery('album', album_id)
429 raise JamendoAPIException(str(q))
430 _update_cache(_albums, a)
431 if isinstance(a, list):
435 def get_tracks(album_id):
436 """Returns: [Track]"""
437 q = GetQuery('tracks', album_id)
440 raise JamendoAPIException(str(q))
441 _update_cache(_tracks, a)
444 def get_track(track_id):
446 a = _tracks.get(track_id, None)
448 q = GetQuery('track', track_id)
451 raise JamendoAPIException(str(q))
452 _update_cache(_tracks, a)
453 if isinstance(a, list):
457 def get_radio_tracks(radio_id):
458 """Returns: [Track]"""
459 q = GetQuery('radio', radio_id)
462 raise JamendoAPIException(str(q))
463 _update_cache(_tracks, a)
466 def search_artists(query):
467 """Returns: [Artist]"""
468 q = SearchQuery('artist', query, 'searchweight_desc')
471 raise JamendoAPIException(str(q))
472 _update_cache(_artists, a)
475 def search_albums(query):
476 """Returns: [Album]"""
477 q = SearchQuery('album', query, 'searchweight_desc')
480 raise JamendoAPIException(str(q))
481 _update_cache(_albums, a)
484 def search_tracks(query):
485 """Returns: [Track]"""
486 q = SearchQuery('track', query=query, order='searchweight_desc')
489 raise JamendoAPIException(str(q))
490 _update_cache(_tracks, a)
493 def albums_of_the_week():
494 """Returns: [Album]"""
495 q = SearchQuery('album', order='ratingweek_desc')
498 raise JamendoAPIException(str(q))
499 _update_cache(_albums, a)
503 """Returns: [Track] (playlist)"""
504 q = SearchQuery('track', order='releasedate_desc')
507 raise JamendoAPIException(str(q))
508 _update_cache(_tracks, a)
511 def tracks_of_the_week():
512 """Returns: [Track] (playlist)"""
513 q = SearchQuery('track', order='ratingweek_desc')
516 raise JamendoAPIException(str(q))
517 _update_cache(_tracks, a)
520 def get_radio(radio_id):
522 q = CustomQuery(_GET2+"id+name+idstr+image/radio/json?id=%d"%(radio_id))
525 raise JamendoAPIException(str(q))
526 if isinstance(js, list):
528 return Radio(radio_id, json=js)
530 def starred_radios():
531 """Returns: [Radio]"""
532 q = CustomQuery(_GET2+"id+name+idstr+image/radio/json?order=starred_desc")
535 raise JamendoAPIException(str(q))
536 return [Radio(int(radio['id']), json=radio) for radio in js]
538 def favorite_albums(user):
539 """Returns: [Album]"""
540 q = SearchQuery('favorite_albums', user=user, count=20)
543 raise JamendoAPIException(str(q))
544 _update_cache(_albums, a)
547 ### Set loader functions for classes
549 def _artist_loader(self):
550 if self._needs_load():
551 artist = get_artist(self.ID)
552 self._set_from(artist)
553 Artist.load = _artist_loader
555 def _album_loader(self):
556 if self._needs_load():
557 album = get_album(self.ID)
558 album.tracks = get_tracks(self.ID)
559 self._set_from(album)
560 Album.load = _album_loader
562 def _track_loader(self):
563 track = get_track(self.ID)
564 self._set_from(track)
565 Track.load = _track_loader
567 def _radio_loader(self):
568 radio = get_radio(self.ID)
569 self._set_from(radio)
570 Radio.load = _radio_loader