77c5a91721ecdde64e6b6815ad71c32532ea8e72
[youtube-dl] / youtube_dl / extractor / grooveshark.py
1 # coding: utf-8
2 from __future__ import unicode_literals
3
4 import time
5 import math
6 import re
7
8 from urllib import quote, urlencode
9 from os.path import basename
10
11 from .common import InfoExtractor
12 from ..utils import ExtractorError, compat_urllib_request, compat_html_parser
13
14 from ..utils import compat_urlparse
15 urlparse = compat_urlparse.urlparse
16 urlunparse = compat_urlparse.urlunparse
17 urldefrag = compat_urlparse.urldefrag
18
19
20 class GroovesharkHtmlParser(compat_html_parser.HTMLParser):
21     def __init__(self):
22         self._current_object = None
23         self.objects = []
24         compat_html_parser.HTMLParser.__init__(self)
25
26     def handle_starttag(self, tag, attrs):
27         attrs = dict((k, v) for k, v in attrs)
28         if tag == 'object':
29             self._current_object = {'attrs': attrs, 'params': []}
30         elif tag == 'param':
31             self._current_object['params'].append(attrs)
32
33     def handle_endtag(self, tag):
34         if tag == 'object':
35             self.objects.append(self._current_object)
36             self._current_object = None
37
38     @classmethod
39     def extract_object_tags(cls, html):
40         p = cls()
41         p.feed(html)
42         p.close()
43         return p.objects
44
45
46 class GroovesharkIE(InfoExtractor):
47     _VALID_URL = r'https?://(www\.)?grooveshark\.com/#!/s/([^/]+)/([^/]+)'
48     _TEST = {
49         'url': 'http://grooveshark.com/#!/s/Jolene+Tenth+Key+Remix+Ft+Will+Sessions/6SS1DW?src=5',
50         'md5': 'bbccc50b19daca23b8f961152c1dc95b',
51         'info_dict': {
52             'id': '6SS1DW',
53             'title': 'Jolene (Tenth Key Remix ft. Will Sessions)',
54             'ext': 'mp3',
55             'duration': 227
56         }
57     }
58
59     do_playerpage_request = True
60     do_bootstrap_request = True
61
62     def _parse_target(self, target):
63         uri = urlparse(target)
64         hash = uri.fragment[1:].split('?')[0]
65         token = basename(hash.rstrip('/'))
66         return (uri, hash, token)
67
68     def _build_bootstrap_url(self, target):
69         (uri, hash, token) = self._parse_target(target)
70         query = 'getCommunicationToken=1&hash=%s&%d' % (quote(hash, safe=''), self.ts)
71         return (urlunparse((uri.scheme, uri.netloc, '/preload.php', None, query, None)), token)
72
73     def _build_meta_url(self, target):
74         (uri, hash, token) = self._parse_target(target)
75         query = 'hash=%s&%d' % (quote(hash, safe=''), self.ts)
76         return (urlunparse((uri.scheme, uri.netloc, '/preload.php', None, query, None)), token)
77
78     def _build_stream_url(self, meta):
79         return urlunparse(('http', meta['streamKey']['ip'], '/stream.php', None, None, None))
80
81     def _build_swf_referer(self, target, obj):
82         (uri, _, _) = self._parse_target(target)
83         return urlunparse((uri.scheme, uri.netloc, obj['attrs']['data'], None, None, None))
84
85     def _transform_bootstrap(self, js):
86         return re.split('(?m)^\s*try\s*{', js)[0] \
87                  .split(' = ', 1)[1].strip().rstrip(';')
88
89     def _transform_meta(self, js):
90         return js.split('\n')[0].split('=')[1].rstrip(';')
91
92     def _get_meta(self, target):
93         (meta_url, token) = self._build_meta_url(target)
94         self.to_screen('Metadata URL: %s' % meta_url)
95
96         headers = {'Referer': urldefrag(target)[0]}
97         req = compat_urllib_request.Request(meta_url, headers=headers)
98         res = self._download_json(req, token,
99                                   transform_source=self._transform_meta)
100
101         if 'getStreamKeyWithSong' not in res:
102             raise ExtractorError(
103                 'Metadata not found. URL may be malformed, or Grooveshark API may have changed.')
104
105         if res['getStreamKeyWithSong'] is None:
106             raise ExtractorError(
107                 'Metadata download failed, probably due to Grooveshark anti-abuse throttling. Wait at least an hour before retrying from this IP.',
108                 expected=True)
109
110         return res['getStreamKeyWithSong']
111
112     def _get_bootstrap(self, target):
113         (bootstrap_url, token) = self._build_bootstrap_url(target)
114
115         headers = {'Referer': urldefrag(target)[0]}
116         req = compat_urllib_request.Request(bootstrap_url, headers=headers)
117         res = self._download_json(req, token, fatal=False,
118                                   note='Downloading player bootstrap data',
119                                   errnote='Unable to download player bootstrap data',
120                                   transform_source=self._transform_bootstrap)
121         return res
122
123     def _get_playerpage(self, target):
124         (_, _, token) = self._parse_target(target)
125
126         res = self._download_webpage(
127             target, token,
128             note='Downloading player page',
129             errnote='Unable to download player page',
130             fatal=False)
131
132         if res is not None:
133             o = GroovesharkHtmlParser.extract_object_tags(res)
134             return (res, [x for x in o if x['attrs']['id'] == 'jsPlayerEmbed'])
135
136         return (res, None)
137
138     def _real_extract(self, url):
139         (target_uri, _, token) = self._parse_target(url)
140
141         # 1. Fill cookiejar by making a request to the player page
142         if self.do_playerpage_request:
143             (_, player_objs) = self._get_playerpage(url)
144             if player_objs is not None:
145                 swf_referer = self._build_swf_referer(url, player_objs[0])
146                 self.to_screen('SWF Referer: %s' % swf_referer)
147
148         # 2. Ask preload.php for swf bootstrap data to better mimic webapp
149         if self.do_bootstrap_request:
150             bootstrap = self._get_bootstrap(url)
151             self.to_screen('CommunicationToken: %s' % bootstrap['getCommunicationToken'])
152
153         # 3. Ask preload.php for track metadata.
154         meta = self._get_meta(url)
155
156         # 4. Construct stream request for track.
157         stream_url = self._build_stream_url(meta)
158         duration = int(math.ceil(float(meta['streamKey']['uSecs']) / 1000000))
159         post_dict = {'streamKey': meta['streamKey']['streamKey']}
160         post_data = urlencode(post_dict).encode('utf-8')
161         headers = {
162             'Content-Length': len(post_data),
163             'Content-Type': 'application/x-www-form-urlencoded'
164         }
165
166         if 'swf_referer' in locals():
167             headers['Referer'] = swf_referer
168
169         info_dict = {
170             'id': token,
171             'title': meta['song']['Name'],
172             'http_method': 'POST',
173             'url': stream_url,
174             'ext': 'mp3',
175             'format': 'mp3 audio',
176             'duration': duration,
177
178             # various ways of supporting the download request.
179             # remove keys unnecessary to the eventual post implementation
180             'post_data': post_data,
181             'post_dict': post_dict,
182             'headers': headers
183         }
184
185         if 'swf_referer' in locals():
186             info_dict['http_referer'] = swf_referer
187
188         return info_dict
189
190     def _real_initialize(self):
191         self.ts = int(time.time() * 1000)  # timestamp in millis
192
193     def _download_json(self, url_or_request, video_id,
194                        note=u'Downloading JSON metadata',
195                        errnote=u'Unable to download JSON metadata',
196                        fatal=True,
197                        transform_source=None):
198         try:
199             out = super(GroovesharkIE, self)._download_json(
200                 url_or_request, video_id, note, errnote, transform_source)
201             return out
202         except ExtractorError as ee:
203             if fatal:
204                 raise ee
205         return None