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__)
231 class CoverFetcher(threading.Thread):
233 threading.Thread.__init__(self)
235 self.cond = threading.Condition()
238 def _fetch_cover(self, albumid, size):
239 coverdir = _COVERDIR if _COVERDIR else '/tmp'
240 to = os.path.join(coverdir, '%d-%d.jpg'%(albumid, size))
241 if not os.path.isfile(to):
242 url = _GET2+'image/album/redirect/?id=%d&imagesize=%d'%(albumid, size)
243 urllib.urlretrieve(url, to)
246 def request_cover(self, albumid, size, cb):
248 self.work.insert(0, (albumid, size, cb))
264 for albumid, size, cb in work:
265 cover = self._fetch_cover(albumid, size)
266 cb(albumid, size, cover)
268 class CoverCache(object):
270 cache and fetch covers
271 TODO: background thread that
272 fetches and returns covers,
276 self._covers = {} # (albumid, size) -> file
277 coverdir = _COVERDIR if _COVERDIR else '/tmp'
278 if os.path.isdir(coverdir):
279 covermatch = re.compile(r'(\d+)\-(\d+)\.jpg')
280 for fil in os.listdir(coverdir):
281 fl = os.path.join(coverdir, fil)
282 m = covermatch.match(fil)
283 if m and os.path.isfile(fl):
284 self._covers[(int(m.group(1)), int(m.group(2)))] = fl
285 self._fetcher = CoverFetcher()
286 self._fetcher.start()
288 def fetch_cover(self, albumid, size):
289 coverdir = _COVERDIR if _COVERDIR else '/tmp'
290 to = os.path.join(coverdir, '%d-%d.jpg'%(albumid, size))
291 if not os.path.isfile(to):
292 url = _GET2+'image/album/redirect/?id=%d&imagesize=%d'%(albumid, size)
293 urllib.urlretrieve(url, to)
294 self._covers[(albumid, size)] = to
297 def get_cover(self, albumid, size):
298 cover = self._covers.get((albumid, size), None)
300 cover = self.fetch_cover(albumid, size)
303 def get_async(self, albumid, size, cb):
304 cover = self._covers.get((albumid, size), None)
308 self._fetcher.request_cover(albumid, size, cb)
310 _cover_cache = CoverCache()
312 def get_album_cover(albumid, size=200):
313 return _cover_cache.get_cover(albumid, size)
315 def get_album_cover_async(cb, albumid, size=200):
316 _cover_cache.get_async(albumid, size, cb)
318 class CustomQuery(Query):
319 def __init__(self, url):
324 return self._geturl(self.url)
329 class GetQuery(Query):
332 'url' : _GET2+'+'.join(_ARTIST_FIELDS)+'/artist/json/?',
333 'params' : 'artist_id=%d',
334 'constructor' : Artist
337 'url' : _GET2+'+'.join(_ALBUM_FIELDS)+'/album/json/?',
338 'params' : 'album_id=%d',
339 'constructor' : Album
342 'url' : _GET2+'+'.join(_ALBUM_FIELDS)+'/album/json/?',
343 'params' : 'artist_id=%d',
344 'constructor' : [Album]
347 'url' : _GET2+'+'.join(_TRACK_FIELDS)+'/track/json/track_album+album_artist?',
349 'constructor' : Track
352 'url' : _GET2+'+'.join(_TRACK_FIELDS)+'/track/json/track_album+album_artist?',
353 'params' : 'order=numalbum_asc&album_id=%d',
354 'constructor' : [Track]
357 'url' : _GET2+'+'.join(_TRACK_FIELDS)+'/track/json/radio_track_inradioplaylist+track_album+album_artist/?',
358 'params' : 'order=random_asc&radio_id=%d',
359 'constructor' : [Track]
361 'favorite_albums' : {
362 'url' : _GET2+'+'.join(_ALBUM_FIELDS)+'/album/json/album_user_starred/?',
363 'params' : 'user_idstr=%s',
364 'constructor' : [Album]
366 #http://api.jamendo.com/get2/id+name+url+image+artist_name/album/jsonpretty/album_user_starred/?user_idstr=sylvinus&n=all
367 #q = SearchQuery('album', user_idstr=user)
370 #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
372 def __init__(self, what, ID):
375 info = GetQuery.queries[what]
376 self.url = info['url']
377 self.params = info['params']
378 self.constructor = info['constructor']
380 def construct(self, data):
381 constructor = self.constructor
382 if isinstance(constructor, list):
383 constructor = constructor[0]
384 if isinstance(data, list):
385 return [constructor(int(x['id']), json=x) for x in data]
387 return constructor(int(data['id']), json=data)
390 js = self._geturl(self.url + self.params % (self.ID))
393 return self.construct(js)
396 return self.url + self.params % (self.ID)
398 class SearchQuery(GetQuery):
399 def __init__(self, what, query=None, order=None, user=None, count=10):
400 GetQuery.__init__(self, what, None)
409 params['searchquery'] = self.query
411 params['order'] = self.order
413 params['n'] = self.count
415 params['user_idstr'] = self.user
416 js = self._geturl(self.url + urllib.urlencode(params))
419 return self.construct(js)
422 params = {'searchquery':self.query, 'order':self.order, 'n':self.count}
423 return self.url + urllib.urlencode(params)
425 class JamendoAPIException(Exception):
426 def __init__(self, url):
427 Exception.__init__(self, url)
429 def _update_cache(cache, new_items):
430 if not isinstance(new_items, list):
431 new_items = [new_items]
432 for item in new_items:
433 old = cache.get(item.ID)
437 cache[item.ID] = item
439 def get_artist(artist_id):
440 """Returns: Artist"""
441 a = _artists.get(artist_id, None)
443 q = GetQuery('artist', artist_id)
446 raise JamendoAPIException(str(q))
447 _update_cache(_artists, a)
448 if isinstance(a, list):
452 def get_albums(artist_id):
453 """Returns: [Album]"""
454 q = GetQuery('albums', artist_id)
457 raise JamendoAPIException(str(q))
458 _update_cache(_artists, a)
461 def get_album(album_id):
463 a = _albums.get(album_id, None)
465 q = GetQuery('album', album_id)
468 raise JamendoAPIException(str(q))
469 _update_cache(_albums, a)
470 if isinstance(a, list):
474 def get_tracks(album_id):
475 """Returns: [Track]"""
476 q = GetQuery('tracks', album_id)
479 raise JamendoAPIException(str(q))
480 _update_cache(_tracks, a)
483 def get_track(track_id):
485 a = _tracks.get(track_id, None)
487 q = GetQuery('track', track_id)
490 raise JamendoAPIException(str(q))
491 _update_cache(_tracks, a)
492 if isinstance(a, list):
496 def get_radio_tracks(radio_id):
497 """Returns: [Track]"""
498 q = GetQuery('radio', radio_id)
501 raise JamendoAPIException(str(q))
502 _update_cache(_tracks, a)
505 def search_artists(query):
506 """Returns: [Artist]"""
507 q = SearchQuery('artist', query, 'searchweight_desc')
510 raise JamendoAPIException(str(q))
511 _update_cache(_artists, a)
514 def search_albums(query):
515 """Returns: [Album]"""
516 q = SearchQuery('album', query, 'searchweight_desc')
519 raise JamendoAPIException(str(q))
520 _update_cache(_albums, a)
523 def search_tracks(query):
524 """Returns: [Track]"""
525 q = SearchQuery('track', query=query, order='searchweight_desc')
528 raise JamendoAPIException(str(q))
529 _update_cache(_tracks, a)
532 def albums_of_the_week():
533 """Returns: [Album]"""
534 q = SearchQuery('album', order='ratingweek_desc')
537 raise JamendoAPIException(str(q))
538 _update_cache(_albums, a)
542 """Returns: [Track] (playlist)"""
543 q = SearchQuery('track', order='releasedate_desc')
546 raise JamendoAPIException(str(q))
547 _update_cache(_tracks, a)
550 def tracks_of_the_week():
551 """Returns: [Track] (playlist)"""
552 q = SearchQuery('track', order='ratingweek_desc')
555 raise JamendoAPIException(str(q))
556 _update_cache(_tracks, a)
559 def get_radio(radio_id):
561 q = CustomQuery(_GET2+"id+name+idstr+image/radio/json?id=%d"%(radio_id))
564 raise JamendoAPIException(str(q))
565 if isinstance(js, list):
567 return Radio(radio_id, json=js)
569 def starred_radios():
570 """Returns: [Radio]"""
571 q = CustomQuery(_GET2+"id+name+idstr+image/radio/json?order=starred_desc")
574 raise JamendoAPIException(str(q))
575 return [Radio(int(radio['id']), json=radio) for radio in js]
577 def favorite_albums(user):
578 """Returns: [Album]"""
579 q = SearchQuery('favorite_albums', user=user, count=20)
582 raise JamendoAPIException(str(q))
583 _update_cache(_albums, a)
586 ### Set loader functions for classes
588 def _artist_loader(self):
589 if self._needs_load():
590 artist = get_artist(self.ID)
591 self._set_from(artist)
592 Artist.load = _artist_loader
594 def _album_loader(self):
595 if self._needs_load():
596 album = get_album(self.ID)
597 album.tracks = get_tracks(self.ID)
598 self._set_from(album)
599 Album.load = _album_loader
601 def _track_loader(self):
602 track = get_track(self.ID)
603 self._set_from(track)
604 Track.load = _track_loader
606 def _radio_loader(self):
607 radio = get_radio(self.ID)
608 self._set_from(radio)
609 Radio.load = _radio_loader