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