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.
12 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
13 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
14 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
15 # DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
16 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
17 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
18 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
19 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
20 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
21 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 # An improved, structured jamendo API wrapper for the N900 with cacheing
24 # Image / cover downloads.. and more?
25 import urllib, threading, os, time, simplejson, re
26 import logging, hashlib
27 import pycurl, StringIO
31 _GET2 = '''http://api.jamendo.com/get2/'''
32 _MP3URL = _GET2+'stream/track/redirect/?id=%d&streamencoding=mp31'
33 _OGGURL = _GET2+'stream/track/redirect/?id=%d&streamencoding=ogg2'
34 _TORRENTURL = _GET2+'bittorrent/file/redirect/?album_id=%d&type=archive&class=mp32'
37 log = logging.getLogger(__name__)
39 class StdoutLogger(object):
40 def info(self, s, *args):
42 def debug(self, s, *args):
46 # These classes can be partially constructed,
47 # and if asked for a property they don't know,
48 # makes a query internally to get the full story
50 _ARTIST_FIELDS = ['id', 'name', 'image']
51 _ALBUM_FIELDS = ['id', 'name', 'image', 'artist_name', 'artist_id', 'license_url']
52 _TRACK_FIELDS = ['id', 'name', 'album_image', 'artist_id', 'artist_name', 'album_name', 'album_id', 'numalbum', 'duration']
53 _RADIO_FIELDS = ['id', 'name', 'idstr', 'image']
54 _TAG_FIELDS = ['id', 'name']
58 s = StringIO.StringIO()
59 c.setopt(pycurl.FOLLOWLOCATION, 1)
60 c.setopt(pycurl.URL, url)
61 c.setopt(pycurl.WRITEFUNCTION, s.write)
69 class LazyQuery(object):
70 def set_from_json(self, json):
71 for key, value in json.iteritems():
73 assert(self.ID == int(value))
75 if key.endswith('_id'):
77 setattr(self, key, value)
80 """Not automatic for now,
81 will have to do artist.load()
83 This is filled in further down
88 def _needs_load(self):
91 def _set_from(self, other):
94 def _needs_load_impl(self, *attrs):
96 if getattr(self, attr) is None:
100 def _set_from_impl(self, other, *attrs):
102 self._set_if(other, attr)
104 def _set_if(self, other, attrname):
105 if getattr(self, attrname) is None and getattr(other, attrname) is not None:
106 setattr(self, attrname, getattr(other, attrname))
110 return u"%s(%s)"%(self.__class__.__name__,
111 u", ".join(("%s:%s"%(k,repr(v))) for k,v in self.__dict__.iteritems() if not k.startswith('_')))
112 except UnicodeEncodeError:
114 #traceback.print_exc()
115 return u"%s(?)"%(self.__class__.__name__)
117 class Artist(LazyQuery):
118 def __init__(self, ID, json=None):
122 self.albums = None # None means not downloaded
124 self.set_from_json(json)
126 def _needs_load(self):
127 return self._needs_load_impl('name', 'albums')
129 def _set_from(self, other):
130 return self._set_from_impl(other, 'name', 'image', 'albums')
132 class Album(LazyQuery):
133 def __init__(self, ID, json=None):
137 self.artist_name = None
138 self.artist_id = None
139 self.license_url = None
140 self.tracks = None # None means not downloaded
142 self.set_from_json(json)
144 def torrent_url(self):
145 return _TORRENTURL%(self.ID)
148 def _needs_load(self):
149 return self._needs_load_impl('name', 'image', 'artist_name', 'artist_id', 'license_url', 'tracks')
151 def _set_from(self, other):
152 return self._set_from_impl(other, 'name', 'image', 'artist_name', 'artist_id', 'license_url', 'tracks')
154 class Track(LazyQuery):
155 def __init__(self, ID, json=None):
158 self.artist_id = None
159 self.artist_name = None
160 self.album_image = None
161 self.album_name = None
166 self.set_from_json(json)
169 return _MP3URL%(self.ID)
172 return _OGGURL%(self.ID)
174 def _needs_load(self):
175 return self._needs_load_impl('name', 'artist_name', 'artist_id', 'album_name', 'album_id', 'numalbum', 'duration')
177 def _set_from(self, other):
178 return self._set_from_impl(other, 'name', 'album_image', 'artist_name', 'artist_id', 'album_name', 'album_id', 'numalbum', 'duration')
180 class Radio(LazyQuery):
181 def __init__(self, ID, json=None):
187 self.set_from_json(json)
189 def _needs_load(self):
190 return self._needs_load_impl('name', 'idstr', 'image')
192 def _set_from(self, other):
193 return self._set_from_impl(other, 'name', 'idstr', 'image')
195 class Tag(LazyQuery):
196 def __init__(self, ID, json=None):
200 self.set_from_json(json)
202 def _needs_load(self):
203 return self._needs_load_impl('name')
205 def _set_from(self, other):
206 return self._set_from_impl(other, 'name')
208 _artists = {} # id -> Artist()
209 _albums = {} # id -> Album()
210 _tracks = {} # id -> Track()
211 _radios = {} # id -> Radio()
214 # cache sizes per session (TODO)
215 _CACHED_ARTISTS = 100
219 # cache sizes, persistant
220 _CACHED_COVERS = 2048
222 # TODO: cache queries?
225 rate_limit = 1.1 # seconds between queries
226 last_query = time.time() - 1.5
231 if now - cls.last_query < cls.rate_limit:
232 time.sleep(cls.rate_limit - (now - cls.last_query))
238 def _geturl(self, url):
242 ret = simplejson.loads(curlGET(url))
248 return "#%s" % (self.__class__.__name__)
253 class CoverFetcher(threading.Thread):
255 threading.Thread.__init__(self)
257 self.cond = threading.Condition()
260 def _retrieve(self, url, fname):
261 f = open(fname, 'wb')
263 c.setopt(pycurl.FOLLOWLOCATION, 1)
264 c.setopt(pycurl.URL, str(url))
265 c.setopt(pycurl.WRITEFUNCTION, f.write)
273 log.debug("Coverfetch: %s -> %s", url, fname)
276 def _fetch_cover(self, albumid, size):
278 coverdir = _COVERDIR if _COVERDIR else '/tmp'
279 to = os.path.join(coverdir, '%d-%d.jpg'%(albumid, size))
280 if not os.path.isfile(to):
281 url = _GET2+'image/album/redirect/?id=%d&imagesize=%d'%(albumid, size)
282 to = self._retrieve(url, to)
287 def _fetch_image(self, url):
289 h = hashlib.md5(url).hexdigest()
290 coverdir = _COVERDIR if _COVERDIR else '/tmp'
291 to = os.path.join(coverdir, h+'.jpg')
292 if not os.path.isfile(to):
293 to = self._retrieve(url, to)
298 def request_cover(self, albumid, size, cb):
300 self.work.insert(0, (albumid, size, cb))
304 def request_images(self, urls, cb):
305 """cb([(url, image)])"""
307 self.work = [('image', url, cb) for url in urls] + self.work
323 multi = len(work) > 1
325 if job[0] == 'image':
326 self.process_image(job[1], job[2])
328 self.process_cover(*job)
330 def process_cover(self, albumid, size, cb):
331 cover = self._fetch_cover(albumid, size)
333 cb(albumid, size, cover)
335 def process_image(self, url, cb):
336 image = self._fetch_image(url)
340 class CoverCache(object):
342 cache and fetch covers
343 TODO: background thread that
344 fetches and returns covers,
348 self._covers = {} # (albumid, size) -> file
350 self._fetcher = CoverFetcher()
351 self._fetcher.start()
352 if _COVERDIR and os.path.isdir(_COVERDIR):
355 def prime_cache(self):
357 covermatch = re.compile(r'(\d+)\-(\d+)\.jpg')
359 prev_covers = os.listdir(coverdir)
361 if len(prev_covers) > _CACHED_COVERS:
363 dropn = len(prev_covers) - _CACHED_COVERS
364 todrop = random.sample(prev_covers, dropn)
365 log.warning("Deleting from cache: %s", todrop)
367 m = covermatch.match(d)
370 os.unlink(os.path.join(coverdir, d))
372 log.exception('unlinking failed')
374 for fil in os.listdir(coverdir):
375 fl = os.path.join(coverdir, fil)
376 m = covermatch.match(fil)
377 if m and os.path.isfile(fl):
378 self._covers[(int(m.group(1)), int(m.group(2)))] = fl
380 def fetch_cover(self, albumid, size):
383 to = os.path.join(coverdir, '%d-%d.jpg'%(albumid, size))
384 if not os.path.isfile(to):
385 url = _GET2+'image/album/redirect/?id=%d&imagesize=%d'%(albumid, size)
386 urllib.urlretrieve(url, to)
387 self._covers[(albumid, size)] = to
391 def get_cover(self, albumid, size):
392 cover = self._covers.get((albumid, size), None)
394 cover = self.fetch_cover(albumid, size)
397 def get_async(self, albumid, size, cb):
398 cover = self._covers.get((albumid, size), None)
400 cb(albumid, size, cover)
402 def cb2(albumid, size, cover):
403 self._covers[(albumid, size)] = cover
404 cb(albumid, size, cover)
405 self._fetcher.request_cover(albumid, size, cb2)
407 def get_images_async(self, url_list, cb):
411 image = self._images.get(url, None)
413 found.append((url, image))
421 for url, image in results:
422 self._images[url] = image
424 self._fetcher.request_images(lookup, cb2)
426 _cover_cache = CoverCache()
428 def set_cache_dir(cachedir):
432 _COVERDIR = os.path.join(_CACHEDIR, 'covers')
435 os.makedirs(_CACHEDIR)
440 os.makedirs(_COVERDIR)
444 _cover_cache.prime_cache()
446 def get_album_cover(albumid, size=100):
447 return _cover_cache.get_cover(albumid, size)
449 def get_album_cover_async(cb, albumid, size=100):
450 _cover_cache.get_async(albumid, size, cb)
452 def get_images_async(cb, url_list):
453 _cover_cache.get_images_async(url_list, cb)
455 class CustomQuery(Query):
456 def __init__(self, url):
461 return self._geturl(self.url)
466 class GetQuery(Query):
469 'url' : _GET2+'+'.join(_ARTIST_FIELDS)+'/artist/json/?',
470 'params' : 'artist_id=%d',
471 'constructor' : Artist
474 'url' : _GET2+'+'.join(_ALBUM_FIELDS)+'/artist/json/?',
475 'params' : 'artist_id=%s',
476 'constructor' : Album
479 'url' : _GET2+'+'.join(_ALBUM_FIELDS)+'/album/json/?',
480 'params' : 'album_id=%d',
481 'constructor' : Album
484 'url' : _GET2+'+'.join(_ALBUM_FIELDS)+'/album/json/?',
485 'params' : 'album_id=%s',
486 'constructor' : Album
489 'url' : _GET2+'+'.join(_ALBUM_FIELDS)+'/album/json/?',
490 'params' : 'artist_id=%d',
491 'constructor' : [Album]
494 'url' : _GET2+'+'.join(_TRACK_FIELDS)+'/track/json/track_album+album_artist?',
496 'constructor' : Track
499 'url' : _GET2+'+'.join(_TRACK_FIELDS)+'/track/json/track_album+album_artist?',
501 'constructor' : Track
504 'url' : _GET2+'+'.join(_TRACK_FIELDS)+'/track/json/track_album+album_artist?',
505 'params' : 'order=numalbum_asc&album_id=%d',
506 'constructor' : [Track]
509 'url' : _GET2+'+'.join(_TRACK_FIELDS)+'/track/json/radio_track_inradioplaylist+track_album+album_artist/?',
510 'params' : 'order=random_asc&radio_id=%d&n=16',
511 'constructor' : [Track]
513 'favorite_albums' : {
514 'url' : _GET2+'+'.join(_ALBUM_FIELDS)+'/album/json/album_user_starred/?',
515 'params' : 'user_idstr=%s',
516 'constructor' : [Album]
519 'url' : _GET2+'+'.join(_TRACK_FIELDS)+'/track/json/track_album+album_artist?',
520 'params' : 'tag_id=%d&n=50&order=rating_desc',
521 'constructor' : [Track]
525 def __init__(self, what, ID):
528 info = GetQuery.queries[what]
529 self.url = info['url']
530 self.params = info['params']
531 self.constructor = info['constructor']
533 def construct(self, data):
534 constructor = self.constructor
535 if isinstance(constructor, list):
536 constructor = constructor[0]
537 if isinstance(data, list):
538 return [constructor(int(x['id']), json=x) for x in data]
540 return constructor(int(data['id']), json=data)
543 js = self._geturl(self.url + self.params % (self.ID))
546 return self.construct(js)
549 return self.url + self.params % (self.ID)
551 class SearchQuery(GetQuery):
552 def __init__(self, what, query=None, order=None, user=None, count=20):
553 GetQuery.__init__(self, what, None)
562 params['searchquery'] = self.query
564 params['order'] = self.order
566 params['n'] = self.count
568 params['user_idstr'] = self.user
569 js = self._geturl(self.url + urllib.urlencode(params))
572 return self.construct(js)
575 params = {'searchquery':self.query, 'order':self.order, 'n':self.count}
576 return self.url + urllib.urlencode(params)
578 class JamendoAPIException(Exception):
579 def __init__(self, url):
580 Exception.__init__(self, url)
582 def _update_cache(cache, new_items):
583 if not isinstance(new_items, list):
584 new_items = [new_items]
585 for item in new_items:
586 old = cache.get(item.ID)
590 cache[item.ID] = item
591 if isinstance(item, Artist) and item.albums:
592 for album in item.albums:
593 _update_cache(_albums, album)
594 elif isinstance(item, Album) and item.tracks:
595 for track in item.tracks:
596 _update_cache(_tracks, track)
597 # enforce cache limits here!
598 # also, TODO: save/load cache between sessions
599 # that will require storing a timestamp with
600 # each item, though..
602 # artists: 1 day - changes often
603 # albums: 2-5 days - changes less often (?)
604 # tracks: 1 week - changes rarely, queried often
606 def get_artist(artist_id):
607 """Returns: Artist"""
608 a = _artists.get(artist_id, None)
610 q = GetQuery('artist', artist_id)
613 raise JamendoAPIException(str(q))
614 _update_cache(_artists, a)
615 if isinstance(a, list):
619 def get_artists(artist_ids):
620 """Returns: [Artist]"""
621 assert(isinstance(artist_ids, list))
624 for artist_id in artist_ids:
625 a = _artists.get(artist_id, None)
627 lookup.append(artist_id)
631 q = GetQuery('artist_list', '+'.join(str(x) for x in lookup))
634 raise JamendoAPIException(str(q))
635 _update_cache(_artists, a)
637 return found + lookup
639 def get_album_list(album_ids):
640 """Returns: [Album]"""
641 assert(isinstance(album_ids, list))
644 for album_id in album_ids:
645 a = _albums.get(album_id, None)
647 lookup.append(album_id)
651 q = GetQuery('album_list', '+'.join(str(x) for x in lookup))
654 raise JamendoAPIException(str(q))
655 _update_cache(_albums, a)
657 return found + lookup
659 def get_albums(artist_id):
661 Parameter can either be an artist_id or a list of album ids.
663 if isinstance(artist_id, list):
664 return get_album_list(artist_id)
665 a = _artists.get(artist_id, None)
669 q = GetQuery('albums', artist_id)
672 raise JamendoAPIException(str(q))
673 _update_cache(_albums, a)
676 def get_album(album_id):
678 a = _albums.get(album_id, None)
680 q = GetQuery('album', album_id)
683 raise JamendoAPIException(str(q))
684 _update_cache(_albums, a)
685 if isinstance(a, list):
689 def get_track_list(track_ids):
690 """Returns: [Track]"""
691 assert(isinstance(track_ids, list))
694 for track_id in track_ids:
695 a = _tracks.get(track_id, None)
697 lookup.append(track_id)
701 q = GetQuery('track_list', '+'.join(str(x) for x in lookup))
704 raise JamendoAPIException(str(q))
705 _update_cache(_tracks, a)
707 return found + lookup
709 def get_tracks(album_id):
711 Parameter can either be an album_id or a list of track ids.
713 if isinstance(album_id, list):
714 return get_track_list(album_id)
715 a = _albums.get(album_id, None)
719 q = GetQuery('tracks', album_id)
722 raise JamendoAPIException(str(q))
723 _update_cache(_tracks, a)
726 def get_track(track_id):
728 a = _tracks.get(track_id, None)
730 q = GetQuery('track', track_id)
733 raise JamendoAPIException(str(q))
734 _update_cache(_tracks, a)
735 if isinstance(a, list):
739 def get_radio_tracks(radio_id):
740 """Returns: [Track]"""
741 q = GetQuery('radio', radio_id)
744 raise JamendoAPIException(str(q))
745 _update_cache(_tracks, a)
748 #http://api.jamendo.com/get2/id+name/track/plain/?tag_id=327&n=50&order=rating_desc
749 def get_tag_tracks(tag_id):
750 """Returns: [Track]"""
751 q = GetQuery('tag', tag_id)
754 raise JamendoAPIException(str(q))
755 _update_cache(_tracks, a)
758 def search_artists(query):
759 """Returns: [Artist]"""
760 q = SearchQuery('artist', query, 'searchweight_desc')
763 raise JamendoAPIException(str(q))
764 _update_cache(_artists, a)
767 def search_albums(query):
768 """Returns: [Album]"""
769 q = SearchQuery('album', query, 'searchweight_desc')
772 raise JamendoAPIException(str(q))
773 _update_cache(_albums, a)
776 def search_tracks(query):
777 """Returns: [Track]"""
778 q = SearchQuery('track', query=query, order='searchweight_desc')
781 raise JamendoAPIException(str(q))
782 _update_cache(_tracks, a)
785 def albums_of_the_week():
786 """Returns: [Album]"""
787 q = SearchQuery('album', order='ratingweek_desc')
790 raise JamendoAPIException(str(q))
791 _update_cache(_albums, a)
795 """Returns: [Track] (playlist)"""
796 q = SearchQuery('track', order='releasedate_desc')
799 raise JamendoAPIException(str(q))
800 _update_cache(_tracks, a)
803 def tracks_of_the_week():
804 """Returns: [Track] (playlist)"""
805 q = SearchQuery('track', order='ratingweek_desc')
808 raise JamendoAPIException(str(q))
809 _update_cache(_tracks, a)
812 def top_artists(order='rating_desc', count=20):
813 """Returns: [Artist]"""
814 q = SearchQuery('artist', order=order, count=count)
817 raise JamendoAPIException(str(q))
818 _update_cache(_artists, a)
821 def top_albums(order='rating_desc', count=20):
822 """Returns: [Album]"""
823 q = SearchQuery('album', order=order, count=count)
826 raise JamendoAPIException(str(q))
827 _update_cache(_albums, a)
830 def top_tracks(order='rating_desc', count=20):
831 """Returns: [Track]"""
832 q = SearchQuery('track', order=order, count=count)
835 raise JamendoAPIException(str(q))
836 _update_cache(_tracks, a)
839 def get_radio(radio_id):
841 q = CustomQuery(_GET2+"id+name+idstr+image/radio/json?id=%d"%(radio_id))
844 raise JamendoAPIException(str(q))
845 if isinstance(js, list):
847 return Radio(radio_id, json=js)
849 def starred_radios():
850 """Returns: [Radio]"""
851 q = CustomQuery(_GET2+"id+name+idstr+image/radio/json?order=starred_desc")
854 raise JamendoAPIException(str(q))
855 return [Radio(int(radio['id']), json=radio) for radio in js]
857 def top_tags(count=50, order='rating_desc'):
859 q = CustomQuery(_GET2+"id+name/tag/json?n=%d&order=%s"%(count, order))
862 raise JamendoAPIException(str(q))
863 return [Tag(int(tag['id']), json=tag) for tag in js]
865 def favorite_albums(user):
866 """Returns: [Album]"""
867 q = SearchQuery('favorite_albums', user=user, count=20)
870 raise JamendoAPIException(str(q))
871 _update_cache(_albums, a)
874 ### Set loader functions for classes
876 def _artist_loader(self):
877 if self._needs_load():
878 artist = get_artist(self.ID)
879 artist.albums = get_albums(self.ID)
880 self._set_from(artist)
881 Artist.load = _artist_loader
883 def _album_loader(self):
884 if self._needs_load():
885 album = get_album(self.ID)
886 album.tracks = get_tracks(self.ID)
887 self._set_from(album)
888 Album.load = _album_loader
890 def _track_loader(self):
891 track = get_track(self.ID)
892 self._set_from(track)
893 Track.load = _track_loader
895 def _radio_loader(self):
896 radio = get_radio(self.ID)
897 self._set_from(radio)
898 Radio.load = _radio_loader