]> Raphaël G. Git Repositories - youtubedl/blob - youtube_dl/extractor/brightcove.py
Prepare for release.
[youtubedl] / youtube_dl / extractor / brightcove.py
1 # encoding: utf-8
2 from __future__ import unicode_literals
3
4 import re
5 import json
6 import xml.etree.ElementTree
7
8 from .common import InfoExtractor
9 from ..compat import (
10 compat_parse_qs,
11 compat_str,
12 compat_urllib_parse,
13 compat_urllib_parse_urlparse,
14 compat_urllib_request,
15 compat_urlparse,
16 )
17 from ..utils import (
18 determine_ext,
19 ExtractorError,
20 find_xpath_attr,
21 fix_xml_ampersands,
22 unescapeHTML,
23 unsmuggle_url,
24 )
25
26
27 class BrightcoveIE(InfoExtractor):
28 _VALID_URL = r'(?:https?://.*brightcove\.com/(services|viewer).*?\?|brightcove:)(?P<query>.*)'
29 _FEDERATED_URL_TEMPLATE = 'http://c.brightcove.com/services/viewer/htmlFederated?%s'
30
31 _TESTS = [
32 {
33 # From http://www.8tv.cat/8aldia/videos/xavier-sala-i-martin-aquesta-tarda-a-8-al-dia/
34 'url': 'http://c.brightcove.com/services/viewer/htmlFederated?playerID=1654948606001&flashID=myExperience&%40videoPlayer=2371591881001',
35 'md5': '5423e113865d26e40624dce2e4b45d95',
36 'note': 'Test Brightcove downloads and detection in GenericIE',
37 'info_dict': {
38 'id': '2371591881001',
39 'ext': 'mp4',
40 'title': 'Xavier Sala i Martín: “Un banc que no presta és un banc zombi que no serveix per a res”',
41 'uploader': '8TV',
42 'description': 'md5:a950cc4285c43e44d763d036710cd9cd',
43 }
44 },
45 {
46 # From http://medianetwork.oracle.com/video/player/1785452137001
47 'url': 'http://c.brightcove.com/services/viewer/htmlFederated?playerID=1217746023001&flashID=myPlayer&%40videoPlayer=1785452137001',
48 'info_dict': {
49 'id': '1785452137001',
50 'ext': 'flv',
51 'title': 'JVMLS 2012: Arrays 2.0 - Opportunities and Challenges',
52 'description': 'John Rose speaks at the JVM Language Summit, August 1, 2012.',
53 'uploader': 'Oracle',
54 },
55 },
56 {
57 # From http://mashable.com/2013/10/26/thermoelectric-bracelet-lets-you-control-your-body-temperature/
58 'url': 'http://c.brightcove.com/services/viewer/federated_f9?&playerID=1265504713001&publisherID=AQ%7E%7E%2CAAABBzUwv1E%7E%2CxP-xFHVUstiMFlNYfvF4G9yFnNaqCw_9&videoID=2750934548001',
59 'info_dict': {
60 'id': '2750934548001',
61 'ext': 'mp4',
62 'title': 'This Bracelet Acts as a Personal Thermostat',
63 'description': 'md5:547b78c64f4112766ccf4e151c20b6a0',
64 'uploader': 'Mashable',
65 },
66 },
67 {
68 # test that the default referer works
69 # from http://national.ballet.ca/interact/video/Lost_in_Motion_II/
70 'url': 'http://link.brightcove.com/services/player/bcpid756015033001?bckey=AQ~~,AAAApYJi_Ck~,GxhXCegT1Dp39ilhXuxMJxasUhVNZiil&bctid=2878862109001',
71 'info_dict': {
72 'id': '2878862109001',
73 'ext': 'mp4',
74 'title': 'Lost in Motion II',
75 'description': 'md5:363109c02998fee92ec02211bd8000df',
76 'uploader': 'National Ballet of Canada',
77 },
78 },
79 {
80 # test flv videos served by akamaihd.net
81 # From http://www.redbull.com/en/bike/stories/1331655643987/replay-uci-dh-world-cup-2014-from-fort-william
82 'url': 'http://c.brightcove.com/services/viewer/htmlFederated?%40videoPlayer=ref%3ABC2996102916001&linkBaseURL=http%3A%2F%2Fwww.redbull.com%2Fen%2Fbike%2Fvideos%2F1331655630249%2Freplay-uci-fort-william-2014-dh&playerKey=AQ%7E%7E%2CAAAApYJ7UqE%7E%2Cxqr_zXk0I-zzNndy8NlHogrCb5QdyZRf&playerID=1398061561001#__youtubedl_smuggle=%7B%22Referer%22%3A+%22http%3A%2F%2Fwww.redbull.com%2Fen%2Fbike%2Fstories%2F1331655643987%2Freplay-uci-dh-world-cup-2014-from-fort-william%22%7D',
83 # The md5 checksum changes on each download
84 'info_dict': {
85 'id': '2996102916001',
86 'ext': 'flv',
87 'title': 'UCI MTB World Cup 2014: Fort William, UK - Downhill Finals',
88 'uploader': 'Red Bull TV',
89 'description': 'UCI MTB World Cup 2014: Fort William, UK - Downhill Finals',
90 },
91 },
92 {
93 # playlist test
94 # from http://support.brightcove.com/en/video-cloud/docs/playlist-support-single-video-players
95 'url': 'http://c.brightcove.com/services/viewer/htmlFederated?playerID=3550052898001&playerKey=AQ%7E%7E%2CAAABmA9XpXk%7E%2C-Kp7jNgisre1fG5OdqpAFUTcs0lP_ZoL',
96 'info_dict': {
97 'title': 'Sealife',
98 },
99 'playlist_mincount': 7,
100 },
101 ]
102
103 @classmethod
104 def _build_brighcove_url(cls, object_str):
105 """
106 Build a Brightcove url from a xml string containing
107 <object class="BrightcoveExperience">{params}</object>
108 """
109
110 # Fix up some stupid HTML, see https://github.com/rg3/youtube-dl/issues/1553
111 object_str = re.sub(r'(<param(?:\s+[a-zA-Z0-9_]+="[^"]*")*)>',
112 lambda m: m.group(1) + '/>', object_str)
113 # Fix up some stupid XML, see https://github.com/rg3/youtube-dl/issues/1608
114 object_str = object_str.replace('<--', '<!--')
115 # remove namespace to simplify extraction
116 object_str = re.sub(r'(<object[^>]*)(xmlns=".*?")', r'\1', object_str)
117 object_str = fix_xml_ampersands(object_str)
118
119 object_doc = xml.etree.ElementTree.fromstring(object_str.encode('utf-8'))
120
121 fv_el = find_xpath_attr(object_doc, './param', 'name', 'flashVars')
122 if fv_el is not None:
123 flashvars = dict(
124 (k, v[0])
125 for k, v in compat_parse_qs(fv_el.attrib['value']).items())
126 else:
127 flashvars = {}
128
129 def find_param(name):
130 if name in flashvars:
131 return flashvars[name]
132 node = find_xpath_attr(object_doc, './param', 'name', name)
133 if node is not None:
134 return node.attrib['value']
135 return None
136
137 params = {}
138
139 playerID = find_param('playerID')
140 if playerID is None:
141 raise ExtractorError('Cannot find player ID')
142 params['playerID'] = playerID
143
144 playerKey = find_param('playerKey')
145 # Not all pages define this value
146 if playerKey is not None:
147 params['playerKey'] = playerKey
148 # The three fields hold the id of the video
149 videoPlayer = find_param('@videoPlayer') or find_param('videoId') or find_param('videoID')
150 if videoPlayer is not None:
151 params['@videoPlayer'] = videoPlayer
152 linkBase = find_param('linkBaseURL')
153 if linkBase is not None:
154 params['linkBaseURL'] = linkBase
155 data = compat_urllib_parse.urlencode(params)
156 return cls._FEDERATED_URL_TEMPLATE % data
157
158 @classmethod
159 def _extract_brightcove_url(cls, webpage):
160 """Try to extract the brightcove url from the webpage, returns None
161 if it can't be found
162 """
163 urls = cls._extract_brightcove_urls(webpage)
164 return urls[0] if urls else None
165
166 @classmethod
167 def _extract_brightcove_urls(cls, webpage):
168 """Return a list of all Brightcove URLs from the webpage """
169
170 url_m = re.search(
171 r'<meta\s+property="og:video"\s+content="(https?://(?:secure|c)\.brightcove.com/[^"]+)"',
172 webpage)
173 if url_m:
174 url = unescapeHTML(url_m.group(1))
175 # Some sites don't add it, we can't download with this url, for example:
176 # http://www.ktvu.com/videos/news/raw-video-caltrain-releases-video-of-man-almost/vCTZdY/
177 if 'playerKey' in url or 'videoId' in url:
178 return [url]
179
180 matches = re.findall(
181 r'''(?sx)<object
182 (?:
183 [^>]+?class=[\'"][^>]*?BrightcoveExperience.*?[\'"] |
184 [^>]*?>\s*<param\s+name="movie"\s+value="https?://[^/]*brightcove\.com/
185 ).+?</object>''',
186 webpage)
187 return [cls._build_brighcove_url(m) for m in matches]
188
189 def _real_extract(self, url):
190 url, smuggled_data = unsmuggle_url(url, {})
191
192 # Change the 'videoId' and others field to '@videoPlayer'
193 url = re.sub(r'(?<=[?&])(videoI(d|D)|bctid)', '%40videoPlayer', url)
194 # Change bckey (used by bcove.me urls) to playerKey
195 url = re.sub(r'(?<=[?&])bckey', 'playerKey', url)
196 mobj = re.match(self._VALID_URL, url)
197 query_str = mobj.group('query')
198 query = compat_urlparse.parse_qs(query_str)
199
200 videoPlayer = query.get('@videoPlayer')
201 if videoPlayer:
202 # We set the original url as the default 'Referer' header
203 referer = smuggled_data.get('Referer', url)
204 return self._get_video_info(
205 videoPlayer[0], query_str, query, referer=referer)
206 elif 'playerKey' in query:
207 player_key = query['playerKey']
208 return self._get_playlist_info(player_key[0])
209 else:
210 raise ExtractorError(
211 'Cannot find playerKey= variable. Did you forget quotes in a shell invocation?',
212 expected=True)
213
214 def _get_video_info(self, video_id, query_str, query, referer=None):
215 request_url = self._FEDERATED_URL_TEMPLATE % query_str
216 req = compat_urllib_request.Request(request_url)
217 linkBase = query.get('linkBaseURL')
218 if linkBase is not None:
219 referer = linkBase[0]
220 if referer is not None:
221 req.add_header('Referer', referer)
222 webpage = self._download_webpage(req, video_id)
223
224 error_msg = self._html_search_regex(
225 r"<h1>We're sorry.</h1>([\s\n]*<p>.*?</p>)+", webpage,
226 'error message', default=None)
227 if error_msg is not None:
228 raise ExtractorError(
229 'brightcove said: %s' % error_msg, expected=True)
230
231 self.report_extraction(video_id)
232 info = self._search_regex(r'var experienceJSON = ({.*});', webpage, 'json')
233 info = json.loads(info)['data']
234 video_info = info['programmedContent']['videoPlayer']['mediaDTO']
235 video_info['_youtubedl_adServerURL'] = info.get('adServerURL')
236
237 return self._extract_video_info(video_info)
238
239 def _get_playlist_info(self, player_key):
240 info_url = 'http://c.brightcove.com/services/json/experience/runtime/?command=get_programming_for_experience&playerKey=%s' % player_key
241 playlist_info = self._download_webpage(
242 info_url, player_key, 'Downloading playlist information')
243
244 json_data = json.loads(playlist_info)
245 if 'videoList' not in json_data:
246 raise ExtractorError('Empty playlist')
247 playlist_info = json_data['videoList']
248 videos = [self._extract_video_info(video_info) for video_info in playlist_info['mediaCollectionDTO']['videoDTOs']]
249
250 return self.playlist_result(videos, playlist_id=playlist_info['id'],
251 playlist_title=playlist_info['mediaCollectionDTO']['displayName'])
252
253 def _extract_video_info(self, video_info):
254 info = {
255 'id': compat_str(video_info['id']),
256 'title': video_info['displayName'].strip(),
257 'description': video_info.get('shortDescription'),
258 'thumbnail': video_info.get('videoStillURL') or video_info.get('thumbnailURL'),
259 'uploader': video_info.get('publisherName'),
260 }
261
262 renditions = video_info.get('renditions')
263 if renditions:
264 formats = []
265 for rend in renditions:
266 url = rend['defaultURL']
267 if not url:
268 continue
269 ext = None
270 if rend['remote']:
271 url_comp = compat_urllib_parse_urlparse(url)
272 if url_comp.path.endswith('.m3u8'):
273 formats.extend(
274 self._extract_m3u8_formats(url, info['id'], 'mp4'))
275 continue
276 elif 'akamaihd.net' in url_comp.netloc:
277 # This type of renditions are served through
278 # akamaihd.net, but they don't use f4m manifests
279 url = url.replace('control/', '') + '?&v=3.3.0&fp=13&r=FEEFJ&g=RTSJIMBMPFPB'
280 ext = 'flv'
281 if ext is None:
282 ext = determine_ext(url)
283 size = rend.get('size')
284 formats.append({
285 'url': url,
286 'ext': ext,
287 'height': rend.get('frameHeight'),
288 'width': rend.get('frameWidth'),
289 'filesize': size if size != 0 else None,
290 })
291 self._sort_formats(formats)
292 info['formats'] = formats
293 elif video_info.get('FLVFullLengthURL') is not None:
294 info.update({
295 'url': video_info['FLVFullLengthURL'],
296 })
297
298 if self._downloader.params.get('include_ads', False):
299 adServerURL = video_info.get('_youtubedl_adServerURL')
300 if adServerURL:
301 ad_info = {
302 '_type': 'url',
303 'url': adServerURL,
304 }
305 if 'url' in info:
306 return {
307 '_type': 'playlist',
308 'title': info['title'],
309 'entries': [ad_info, info],
310 }
311 else:
312 return ad_info
313
314 if 'url' not in info and not info.get('formats'):
315 raise ExtractorError('Unable to extract video url for %s' % info['id'])
316 return info