-
Notifications
You must be signed in to change notification settings - Fork 1
/
audioscrobbler.py
954 lines (762 loc) · 32.4 KB
/
audioscrobbler.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
# $Id$
"""
~~~~~~~~~~~
PyScrobbler
~~~~~~~~~~~
Python Classes for AudioScrobbler
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A set of python classes for interacting with the Last.fm AudioScrobbler
services.
AudioScrobblerQuery
AudioScrobblerQuery is used to consume the web services that provide
similar artists, charts, tags and so on
AudioScrobblerPost
AudioScrobblerPost is used to update your personal play information for
those of you (like me) who've been stoopid enough to write your own player.
AudioScrobblerQuery: AudioScrobbler Web Service Consumption
=============================================================
A set of classes for consuming the AudioScrobbler web services.
Currently we consume protocol 1.0, as defined at:
http://www.audioscrobbler.net/data/webservices
Basic usage
-----------
>>> lips = AudioScrobblerQuery(artist='The Flaming Lips')
>>> for artist in lips.similar():
... print artist.name, artist.mbid
...
or
>>> for i in AudioScrobblerQuery(user='offmessage').topalbums()
... print i.name, i.image.small
...
A certain number of the services take a querystring (for example a user's
weekly artist chart takes a start and end date). These can be passed as
follows:
>>> offmessage = AudioScrobblerQuery(user='offmessage')
>>> for i in offmessage.weeklyartistchart(_from=1114965332, to=1115570132):
... print i.name, i.chartposition
...
Note that we have had to prefix the ``from`` keyword with an underscore
(``_``). This is because ``from`` is a reserved word in Python and can't be
used as a parameter name. Any parameter passed with a leading underscore will
have that underscore stripped (so ``_from`` is passed as ``from``, as ``_foo``
would be passed as ``foo``).
If an element has an attribute (for example the artist has an ``mbid`` in
/user/.../topalbums.xml) these can be accessed as a dictionary key of that
element:
>>> offmessage = AudioScrobblerQuery(user='offmessage')
>>> for i in offmessage.topalbums():
... print i.name, i.artist, i.artist['mbid']
...
if you're not sure if an element has an attribute they can be accessed instead
using the ``get()`` method:
>>> offmessage = AudioScrobblerQuery(user='offmessage')
>>> for i in offmessage.topalbums():
... print i.name, i.artist, i.artist.get('mbid', '')
...
More control
------------
There are 2 additional keyword arguments that you can offer at the point of
instantiation of the AudioScrobblerQuery object:
host
If the lovely people at Last.fm change their server name, or if you set up
some kind of local proxy of their services you can set the host from which
you get the XML.
Usage:
>>> lips = AudioScrobblerQuery(artist='The Flaming Lips',
... host='audioscrobbler.isotoma.com')
Default is ``'ws.audioscrobbler.com'``
version
If another version of the web services is released, and this code still
holds up you can set the protocol version at instantiation. This is
inserted into the request URL at the correct point (i.e.
ws.audioscrobbler.com/**1.0**/artist/The+Flaming+Lips).
Usage:
>>> lips = AudioScrobberRequest(artist='The Flaming Lips', version='1.1')
Default is ``'1.0'``
Caching
-------
Each instance of the ``AudioScrobblerQuery`` maintains its own internal cache
of requests, which are checked against the server's response. If the server
returns a ``304`` (content not modified) we return the cached value, otherwise
we return the result that the server gave us.
This is all well and good, however at the time of writing the
``ws.audioscrobbler.com`` server does not support the ``304`` response for all
pages, so you may find yourself making requests that you are sure should be
cached, but in fact aren't.
For example:
http://ws.audioscrobbler.com/1.0/user/offmessage/topalbums.xml returns a ``304``
http://ws.audioscrobbler.com/1.0/artist/The+Flaming+Lips/similar.xml does not
I have assumed that this is for a reason, and as such honour this behaviour.
If a page does not return a ``Last-Modified`` header we do not cache it. Any
page that does return such a header (but not the ``Pragma: no-cache`` header)
gets cached. Any page that does return a ``Last-Modified`` header gets exactly
what it sent to us sent back to it as the ``If-Modified-Since``. This is a fit
of pragmatism based on the fact that calculating local dates and avoiding
clock disparaties is not worth the effort.
Also, note that the AudioScrobbler servers do not return the ``ETag`` header
and so we do not look for it or refer to it.
A last note
-----------
These classes are for consuming the AudioScrobbler web services. As such each
of the classes here have no ``set``, ``__setitem__`` or ``__setattr__``
methods. They are read only. If you want to actually manipulate the
resulting XML you should access the underlying ElementTree_ instances directly
using either the ``raw()`` or ``element()`` methods provided. You can then
make use of the innate power of those classes directly:
``raw()`` returns an ElementTree:
>>> tree = AudioScrobblerQuery(user='offmessage').topalbums().raw()
while ``element()`` returns an Element at the point within the tree that you
currently are:
>>> lips = AudioScrobblerQuery(artist='The Flaming Lips')
>>> elements = [ x.name.element() for x in lips.similar() ]
which is equivalent to:
>>> lips = AudioScrobberRequest(artist='The Flaming Lips')
>>> elements = lips.similar().raw().findall('*/name')
As an alternative you could also look at XMLTramp_, which is another XML
manipulator designed primarily for consuming web services (and used in the
FlickrClient_ script that gave me much inspiration for these classes).
Last but not least a mention should go to BeautifulSoup_, just because it is
the most powerful and flexible of this type of application that I've used. It
specialises in badly formed XML/HTML though, and luckily is not required in
this instance. That said, it's a powerful beast and you should have a look at
it the minute your requirements become more complex than this code supports.
.. _ElementTree: http://effbot.org/zone/element.htm
.. _XMLTramp: http://www.aaronsw.com/2002/xmltramp/
.. _BeautifulSoup: http://www.crummy.com/software/BeautifulSoup/
AudioScrobblerPost: Update Your Personal Play History
=====================================================
A set of classes for posting playlist information to your Last.fm account.
Please note that you will need your own account to use these classes.
Updated to work with version 1.2 of the Audioscrobbler protocol.
Some stuff about the time management and internal cache should go here.
Basic usage (outdated)
-----------
>>> track = dict(artist_name="The Flaming Lips",
song_title="The Yeah Yeah Yeah Song",
length=291,
date_played="2006-04-29 04:20:00",
album="At War With The Mystics",
mbid=""
)
>>> post = AudioScrobblerPost(user='offmessage', password='mypasswd')
>>> post(**track)
>>>
More control
------------
There are a number of keywords that can be passed at the time of instantiation
of the ``AudioScrobblerPost`` class:
verbose
Boolean. If you pass ``verbose=True`` every log line is also printed.
Useful for debugging and in interactive scripts.
client_name
By default pyscrobbler uses the ``tst`` client name. If you deploy these
classes in an application with a wide user base it seems to be advisable to
apply for your own client name. If lots of people start to use these
classes as is I will apply for a unique name for them. If you have your
own, pass it in here (as a string)
client_version
Currently we use ``1.0``. This is because we are using the ``tst`` client
name (see above) and anything lower seems to raise an ``UPDATE`` message
from the post server at handshake.
protocol_version
By default we use ``1.1``. These classes are not compatible with Protocol
1.0. It's unlikely they will be compatible with any later versions. The
changes between 1.0 and 1.1 were pretty major; I can't see they'd be any
less major for the next version.
host
By default we use ``post.audioscrobbler.com``. If the server name changes
(or you want to run tests) you can pass a different host name here. In
fact, the url that we authenticate against is built as
``"http://%s/?%s" % (host, params)`` so as long as your host string makes
a valid url in that format, go for it. Note the trailing slash between
host and the query string. This seems to be a requirement of urllib2. This
means that your test auth script should be able to be called that way.
Putting them to use in real life
================================
Some advice on using these classes.
``timeout``
-----------
I've not done anything about the socket timeout on the running system. It's
not really this code's place to do anything about it, but it is something that
probably needs sorting out, otherwise your scripts will hang for as long as your
timeout setting if there is a problem with the Last.fm servers (which there
appears to be fairly frequently with the submissions servers).
Generally, if you are on a slow link or one with poor latency you can up the
timeout so that your requests don't keep failing unnecessarily. However, if
you're on a quick link you may want to lower it as low as 10 seconds, as the
wait can be agonising if you're making a few requests and the server is not
responding.
Thanks
======
I took a considerable amount of inspiration from Michael Campeotto's
FlickrClient_ script for AudioScrobblerQuery
I've taken even greater amounts of inspiration from Mike Bleyer's
iPodScrobbler_ script for AudioScrobblerPost.
.. _FlickrClient: http://micampe.it/things/flickrclient
.. _iPodScrobbler: http://www.hoc.net/mike/source/iPodScrobbler/
TODO
====
Mad leet reStructuredText epydoc mashup
Get that sorted.
Example query script
Actually write some example query scripts :)
Document use of the factory class
AudioScrobbler
"""
__author__ = "Andy Theyers <andy@isotoma.com>"
__version__ = "$Revision$"[11:-2]
__docformat__ = "restructuredtext"
import datetime, locale, hashlib, site, sys, time, urllib, urllib2, ConfigParser, os
from xml.etree import ElementTree
# This is lifted in the most part from iPodScrobbler (see docs above)
# Get the base local encoding
enc = 'ascii'
try:
enc = site.encoding
except:
pass
if enc == 'ascii' and locale.getpreferredencoding():
enc = locale.getpreferredencoding()
# if we are on MacOSX, we default to UTF8
# because apples python reports 'ISO8859-1' as locale, but MacOSX uses utf8
if sys.platform=='darwin':
enc = 'utf8'
# AudioScrobblerQuery configuration settings
audioscrobbler_request_version = '1.0'
audioscrobbler_request_host = 'ws.audioscrobbler.com'
# AudioScrobblerPost configuration settings
audioscrobbler_post_version = u'1.2' #updated
audioscrobbler_post_host = 'post.audioscrobbler.com'
client_name = u'sna'
pyscrobbler_version = u'1.0.0.0' # This is set to 1.0 while we use
# client_name = u'tst' as we keep getting
# UPDATE responses with anything less.
class AudioScrobblerError(Exception):
"""
The base AudioScrobbler error from which all our other exceptions derive
"""
def __init__(self, message):
""" Create a new AudioScrobblerError.
:Parameters:
- `message`: The message that will be displayed to the user
"""
self.message = message
def __repr__(self):
msg = "%s: %s"
return msg % (self.__class__.__name__, self.message,)
def __str__(self):
return self.__repr__()
class AudioScrobblerConnectionError(AudioScrobblerError):
"""
The base network error, raise by invalid HTTP responses or failures to
connect to the server specified (DNS, timeouts, etc.)
"""
def __init__(self, type, code, message):
self.type = type
self.code = code
self.message = message
def __repr__(self):
msg = "AudioScrobblerConnectionError: %s: %s %s"
return msg % (self.type.upper(), self.code, self.message,)
class AudioScrobblerTypeError(AudioScrobblerError):
"""
If we would normally raise a TypeError we raise this instead
"""
pass
class AudioScrobblerPostUpdate(AudioScrobblerError):
"""
If the POST server returns an ``UPDATE`` message we raise this exception.
This is the only case when this exception is raised, allowing you to
happily ignore it.
"""
def __repr__(self):
msg = "An update to your AudioScrobbler client is available at %s"
return msg % (self.message,)
class AudioScrobblerPostFailed(AudioScrobblerError):
"""
If the POST server returns an ``FAILED`` message we raise this exception.
"""
def __repr__(self):
msg = "Posting track to AudioScrobbler failed. Reason given: %s"
return msg % (self.message,)
class AudioScrobblerHandshakeError(AudioScrobblerError):
"""
If we fail the handshake this is raised. If you're running in a long
running process you should pass on this error, as the system keeps a
cache which ``flushcache()`` will clear for you when the server is back.
"""
pass
class AudioScrobbler:
""" Factory for Queries and Posts. Holds configuration for the session """
def __init__(self,
audioscrobbler_request_version=audioscrobbler_request_version,
audioscrobbler_post_version=audioscrobbler_post_version,
audioscrobbler_request_host=audioscrobbler_request_host,
audioscrobbler_post_host=audioscrobbler_post_host,
client_name=client_name,
client_version=pyscrobbler_version):
self.audioscrobbler_request_version=audioscrobbler_request_version
self.audioscrobbler_post_version=audioscrobbler_post_version
self.audioscrobbler_request_host=audioscrobbler_request_host
self.audioscrobbler_post_host=audioscrobbler_post_host
self.client_name=client_name
self.client_version=pyscrobbler_version
def query(self, **kwargs):
""" Create a new AudioScrobblerQuery """
if len(kwargs) != 1:
raise TypeError("__init__() takes exactly 1 argument, %s "
"given" % (len(kwargs),))
ret = AudioScrobblerQuery(version=self.audioscrobbler_request_version,
host=self.audioscrobbler_request_host,
**kwargs)
return ret
def post(self, username, md5_password, verbose=False):
""" Create a new AudioScrobblerPost """
ret = AudioScrobblerPost(username=username.encode('utf8'),
md5_password=md5_password.encode('utf8'),
host=self.audioscrobbler_post_host,
protocol_version=self.audioscrobbler_post_version,
client_name=self.client_name,
client_version=self.client_version,
verbose=verbose)
return ret
class AudioScrobblerCache:
def __init__(self, elemtree, last):
self.elemtree = elemtree
self.requestdate = last
def created(self):
return self.requestdate
def gettree(self):
return self.elemtree
class AudioScrobblerQuery:
def __init__(self,
version=audioscrobbler_request_version,
host=audioscrobbler_request_host,
**kwargs):
if len(kwargs) != 1:
raise TypeError("__init__() takes exactly 1 audioscrobbler "
"request argument, %s given" % str(len(kwargs))
)
self.type = kwargs.keys()[0]
self.param = str(kwargs[self.type])
self.baseurl = 'http://%s/%s/%s/%s' % (host,
version,
urllib.quote(self.type),
urllib.quote(self.param),
)
self._cache = {}
def __getattr__(self, name):
def method(_self=self, name=name, **params):
# Build the URL
url = '%s/%s.xml' % (_self.baseurl, urllib.quote(name))
if len(params) != 0:
for key in params.keys():
# This little mess is required to get round the fact that
# 'from' is a reserved word and can't be passed as a
# parameter name.
if key.startswith('_'):
params[key[1:]] = params[key]
del params[key]
url = '%s?%s' % (url, urllib.urlencode(params))
req = urllib2.Request(url)
# Check the cache
cache = _self._cache
if url in cache and cache[url].created() is not None:
req.add_header('If-Modified-Since', cache[url].created())
# Open the URL and test the response
try:
response = urllib2.urlopen(url)
except urllib2.HTTPError, error:
if error.code == 304:
return AudioScrobblerItem(cache[url].getroot(), _self, url)
if error.code == 400:
raise AudioScrobblerConnectionError('ws', 400, error.fp.read())
raise AudioScrobblerConnectionError('http', error.code, error.msg)
except urllib2.URLError, error:
code = error.reason.args[0]
message = error.reason.args[1]
raise AudioScrobblerConnectionError('network', code, message)
elemtree = ElementTree.ElementTree(file=response)
if response.headers.get('pragma', None) != 'no-cache':
last_modified = response.headers.get('last-modified', None)
else:
last_modified = None
_self._cache[url] = AudioScrobblerCache(elemtree, last_modified)
return AudioScrobblerItem(elemtree.getroot(), _self, url)
return method
def __repr__(self):
return "AudioScrobblerQuery(%s='%s')" % (self.type, self.param)
def __str__(self):
return self.__repr__()
class AudioScrobblerItem:
def __init__(self, element, parent, url=None):
self._element = element
self._parent = parent
self.tag = element.tag
self.text = element.text
self._url = url
if self._url is None:
self._url = self._parent._url
def __repr__(self):
if isinstance(self._parent, AudioScrobblerQuery):
return "<AudioScrobbler response from %s>" % (self._url,)
return "<AudioScrobbler %s element at %s>" % (self.tag, id(self))
def __str__(self):
if self.text is None:
return ''
text = self.text
try:
retval = text.encode(enc)
except AttributeError:
retval = text
return retval
def __getattr__(self, name):
result = self._element.findall(name)
if len(result) == 0:
raise AttributeError("AudioScrobbler %s element has no "
"subelement '%s'" % (self.tag, name)
)
ret = [ AudioScrobblerItem(i, self) for i in result ]
if len(ret) == 1:
return ret[0]
return ret
def __iter__(self):
for i in self._element:
yield AudioScrobblerItem(i, self)
def __getitem__(self, i):
return self._element.attrib[i]
def get(self, i, default):
if i in self._element.attrib:
return self._element.attrib[i]
else:
return default
def __getslice__(self, i, j):
return [ AudioScrobblerItem(x, self) for x in self._element[i:j] ]
def raw(self):
def getparent(obj):
if isinstance(obj._parent, AudioScrobblerQuery):
return obj._parent
return getparent(obj._parent)
return getparent(self)._cache[self._url].gettree()
def element(self):
return self._element
class AudioScrobblerPost:
"""
Provide the ability to post tracks played to a user's Last.fm
account
"""
#Updated to protocol version 1.2
def __init__(self,
username=u'',
md5_password=u'',
client_name=client_name,
client_version=pyscrobbler_version,
protocol_version=audioscrobbler_post_version,
host=audioscrobbler_post_host,
verbose=False):
# Capture the information passed for future use
self.params = dict(username=username,
md5_password=md5_password,
client_name=client_name,
client_version=client_version,
protocol_version=protocol_version,
host=host)
self.verbose = verbose
self.auth_details = {}
self.last_post = None
self.interval = 0
self.cache = []
self.loglines = []
self.last_shake = None
self.authenticated = False
self.updateurl = None
self.posturl = None
self.npurl = None
def auth(self):
""" Authenticate against the server """
if self.authenticated:
return True
timestamp = str(int(time.time()))
md5_password = self.params['md5_password']
auth_token = hashlib.md5(md5_password + timestamp).hexdigest()
p = {}
p['hs'] = 'true'
p['p'] = self.params['protocol_version']
p['c'] = self.params['client_name']
p['v'] = self.params['client_version']
p['u'] = self.params['username']
p['t'] = timestamp
p['a'] = auth_token
plist = [(k, urllib.quote_plus(v.encode('utf8'))) for k, v in p.items()]
authparams = urllib.urlencode(plist)
url = 'http://%s/?%s' % (self.params['host'], authparams)
req = urllib2.Request(url)
try:
url_handle = urllib2.urlopen(req)
except urllib2.HTTPError, error:
self.authenticated = False
raise AudioScrobblerConnectionError('http', error.code, error.msg)
except urllib2.URLError, error:
self.authenticated = False
code = error.reason#.args[0]
message = error.reason#.args[1]
raise AudioScrobblerConnectionError('network', code, message)
response = url_handle.readlines()
if len(response) == 0:
raise AudioScrobblerHandshakeError('Got nothing back from the server')
username = self.params['username']
md5_password = self.params['md5_password']
# First we test the best and most likely case
if response[0].startswith('OK'):
answer = response[1].strip()
self.auth_details['s'] = answer
self.npurl = response[2].strip()
self.posturl = response[3].strip()
self.authenticated = True
# Then the various failure states....
elif response[0].startswith('BANNED'):
self.authenticated = False
msg = "this client version has been banned from the server."
raise AudioScrobblerHandshakeError(msg)
elif response[0].startswith('BADAUTH'):
self.authenticated = False
msg = "The authentication details provided were incorrect."
raise AudioScrobblerHandshakeError(msg)
elif response[0].startswith('BADTIME'):
self.authenticated = False
msg = "The timestamp provided was not close enough to the current time."
raise AudioScrobblerHandshakeError(msg)
elif response[0].startswith('FAILED'):
self.authenticated = False
reason = response[0][6:]
try:
msg = reason.decode('utf8').encode(enc)
except:
msg = reason
raise AudioScrobblerHandshakeError(msg)
else:
self.authenticated = False
msg = "Unknown response from server: %r" % (response,)
raise AudioScrobblerHandshakeError(msg)
def posttrack(self,
artist_name,
song_title,
length,
date_played,
tracknumber=u'',
album=u'',
mbid=u'',
source=u'P'):
"""
Add the track to the local cache, and try to post it to the server
"""
self.addtrack(artist_name=artist_name,
song_title=song_title,
length=length,
date_played=date_played,
tracknumber=tracknumber,
album=album,
mbid=mbid,
source=source)
self.post()
__call__ = posttrack
def addtrack(self,
artist_name,
song_title,
length,
date_played,
tracknumber=u'',
album=u'',
mbid=u'',
source=u'P'):
""" Add a track to the local cache """
# Quick sanity check on track length
if type(length) == type(0):
sane_length = length
elif type(length) == type('') and length.isdigit():
sane_length = int(length)
else:
sane_length = -1
# If the track length is less than 30 move on
if sane_length < 30:
msg = ("Track '%s' by '%s' only %s seconds in length, so "
"not added" % (song_title, artist_name, sane_length))
self.log(msg)
# Otherwise build the track dictionary and add it to the local cache
else:
try:
track = {'a[%s]': artist_name.encode('utf8'),
't[%s]': song_title.encode('utf8'),
'l[%s]': str(sane_length),
'i[%s]': date_played,
'b[%s]': album.encode('utf8'),
'm[%s]': mbid.encode('utf8'),
'r[%s]': u'',
'n[%s]': tracknumber.encode('utf8'),
'o[%s]': source.encode('utf8'),
}
except:
track = {'a[%s]': artist_name,
't[%s]': song_title,
'l[%s]': str(sane_length),
'i[%s]': date_played,
'b[%s]': album,
'm[%s]': mbid.encode('utf8'),
'r[%s]': u'',
'n[%s]': tracknumber.encode('utf8'),
'o[%s]': source.encode('utf8'),
}
self.cache.append(track)
def nowplaying(self,
artist_name,
song_title,
length=u'',
tracknumber=u'',
album=u'',
mbid=u''):
self.auth()
p = {}
p['s'] = self.auth_details['s']
try:
p['a'] = artist_name.encode('utf8')
p['t'] = song_title.encode('utf8')
p['b'] = album.encode('utf8')
p['l'] = length.encode('utf8')
p['n'] = tracknumber.encode('utf8')
p['m'] = mbid.encode('utf8')
except:
p['a'] = artist_name
p['t'] = song_title
p['b'] = album
p['l'] = length.encode('utf8')
p['n'] = tracknumber.encode('utf8')
p['m'] = mbid.encode('utf8')
npdata = urllib.urlencode(p)
req = urllib2.Request(url=self.npurl, data=npdata)
try:
url_handle = urllib2.urlopen(req)
except urllib2.HTTPError, error:
self.authenticated = False
print AudioScrobblerConnectionError('http', error.code, error.msg)
return
except:
code = '000'
message = sys.exc_info()[1]
print AudioScrobblerConnectionError('network', code, message)
return
response = url_handle.readlines()
if response[0].startswith('OK'):
self.log("Now playing track updated ('%s' by '%s')." % (p['t'], p['a']))
elif response[0].startswith('BADSESSION'):
self.authenticated = False
def post(self):
"""
Post the tracks by popping the first ten off the cache and attempting
to post them.
"""
if len(self.cache) == 0:
return
if len(self.cache) > 10:
number = 10
else:
number = len(self.cache)
params = {}
count = 0
for track in self.cache[:number]:
for k in track.keys():
params[k % (count,)] = track[k]
count += 1
self.auth()
params.update(self.auth_details)
postdata = urllib.urlencode(params)
req = urllib2.Request(url=self.posturl, data=postdata)
now = datetime.datetime.utcnow()
try:
url_handle = urllib2.urlopen(req)
except urllib2.HTTPError, error:
raise AudioScrobblerConnectionError('http', error.code, error.msg)
except urllib2.URLError, error:
args = getattr(error.reason, 'args', None)
code = '000'
message = str(error)
if args is not None:
if len(args) == 1:
message = error.reason.args[0]
elif len(args) == 2:
code = error.reason.args[0]
message = error.reason.args[1]
raise AudioScrobblerConnectionError('network', code, message)
except:
code = '000'
message = sys.exc_info()[1]
raise AudioScrobblerConnectionError('network', code, message)
self.last_post = now
response = url_handle.readlines()
# Test the various responses possibilities:
if response[0].startswith('OK'):
for song in self.cache[:number]:
self.log("Uploaded track successfully ('%s' by '%s')." % (song['t[%s]'], song['a[%s]']))
del self.cache[:number]
elif response[0].startswith('BADSESSION'):
self.log("Got BADSESSION.")
self.authenticated = False
elif response[0].startswith('FAILED'):
reason = response[0][6:].strip()
raise AudioScrobblerPostFailed(reason)
else:
msg = "Server returned something unexpected."
raise AudioScrobblerPostFailed(msg)
def flushcache(self):
""" Post all the tracks in the cache """
while len(self.cache) > 0:
self.post()
def savecache(self, filename):
""" Save all tracks in the cache to a file """
conf = ConfigParser.ConfigParser()
# Save each track in cache:
count = 0
for track in self.cache:
conf.add_section('Track ' + str(count))
for k in track.keys():
conf.set('Track ' + str(count), k, track[k])
count += 1
try:
conf.write(file(filename, 'w'))
except IOError:
pass
def retrievecache(self, filename):
"""
Retrieve all cached tracks from a file so that cached tracks
are preserved across client restarts
"""
if not os.path.isfile(filename):
return
conf = ConfigParser.ConfigParser()
try:
conf.read(filename)
except IOError:
return
# Retrieve each cached track from file:
count = 0
while conf.has_section('Track ' + str(count)):
track = {}
for key in ['a','t','l','i','b','m','r','n','o']:
if conf.has_option('Track ' + str(count), key + '[%s]'):
track[key + '[%s]'] = conf.get('Track ' + str(count), key + '[%s]')
self.cache.append(track)
count += 1
# Cached tracks retrieved, delete file:
os.remove(filename)
def log(self, msg):
""" Add a line to the log, print it if verbose """
time = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
self.loglines.append("%s: %s" % (time, msg))
if self.verbose:
print self.loglines[-1]
def getlog(self, clear=False):
""" Return the entire log, clear it if requested """
if clear:
retval = self.loglines
self.loglines = []
return retval
return self.loglines