]> git.bitcoin.ninja Git - youtube-dl/blob - brightcove.py
4f60d53660fa7777b9e1b6152967ce2e7e567ec9
[youtube-dl] / 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                 'id': '3550319591001',
99             },
100             'playlist_mincount': 7,
101         },
102     ]
103
104     @classmethod
105     def _build_brighcove_url(cls, object_str):
106         """
107         Build a Brightcove url from a xml string containing
108         <object class="BrightcoveExperience">{params}</object>
109         """
110
111         # Fix up some stupid HTML, see https://github.com/rg3/youtube-dl/issues/1553
112         object_str = re.sub(r'(<param(?:\s+[a-zA-Z0-9_]+="[^"]*")*)>',
113                             lambda m: m.group(1) + '/>', object_str)
114         # Fix up some stupid XML, see https://github.com/rg3/youtube-dl/issues/1608
115         object_str = object_str.replace('<--', '<!--')
116         # remove namespace to simplify extraction
117         object_str = re.sub(r'(<object[^>]*)(xmlns=".*?")', r'\1', object_str)
118         object_str = fix_xml_ampersands(object_str)
119
120         try:
121             object_doc = xml.etree.ElementTree.fromstring(object_str.encode('utf-8'))
122         except xml.etree.ElementTree.ParseError:
123             return
124
125         fv_el = find_xpath_attr(object_doc, './param', 'name', 'flashVars')
126         if fv_el is not None:
127             flashvars = dict(
128                 (k, v[0])
129                 for k, v in compat_parse_qs(fv_el.attrib['value']).items())
130         else:
131             flashvars = {}
132
133         def find_param(name):
134             if name in flashvars:
135                 return flashvars[name]
136             node = find_xpath_attr(object_doc, './param', 'name', name)
137             if node is not None:
138                 return node.attrib['value']
139             return None
140
141         params = {}
142
143         playerID = find_param('playerID')
144         if playerID is None:
145             raise ExtractorError('Cannot find player ID')
146         params['playerID'] = playerID
147
148         playerKey = find_param('playerKey')
149         # Not all pages define this value
150         if playerKey is not None:
151             params['playerKey'] = playerKey
152         # The three fields hold the id of the video
153         videoPlayer = find_param('@videoPlayer') or find_param('videoId') or find_param('videoID')
154         if videoPlayer is not None:
155             params['@videoPlayer'] = videoPlayer
156         linkBase = find_param('linkBaseURL')
157         if linkBase is not None:
158             params['linkBaseURL'] = linkBase
159         data = compat_urllib_parse.urlencode(params)
160         return cls._FEDERATED_URL_TEMPLATE % data
161
162     @classmethod
163     def _extract_brightcove_url(cls, webpage):
164         """Try to extract the brightcove url from the webpage, returns None
165         if it can't be found
166         """
167         urls = cls._extract_brightcove_urls(webpage)
168         return urls[0] if urls else None
169
170     @classmethod
171     def _extract_brightcove_urls(cls, webpage):
172         """Return a list of all Brightcove URLs from the webpage """
173
174         url_m = re.search(
175             r'<meta\s+property="og:video"\s+content="(https?://(?:secure|c)\.brightcove.com/[^"]+)"',
176             webpage)
177         if url_m:
178             url = unescapeHTML(url_m.group(1))
179             # Some sites don't add it, we can't download with this url, for example:
180             # http://www.ktvu.com/videos/news/raw-video-caltrain-releases-video-of-man-almost/vCTZdY/
181             if 'playerKey' in url or 'videoId' in url:
182                 return [url]
183
184         matches = re.findall(
185             r'''(?sx)<object
186             (?:
187                 [^>]+?class=[\'"][^>]*?BrightcoveExperience.*?[\'"] |
188                 [^>]*?>\s*<param\s+name="movie"\s+value="https?://[^/]*brightcove\.com/
189             ).+?>\s*</object>''',
190             webpage)
191         return list(filter(None, [cls._build_brighcove_url(m) for m in matches]))
192
193     def _real_extract(self, url):
194         url, smuggled_data = unsmuggle_url(url, {})
195
196         # Change the 'videoId' and others field to '@videoPlayer'
197         url = re.sub(r'(?<=[?&])(videoI(d|D)|bctid)', '%40videoPlayer', url)
198         # Change bckey (used by bcove.me urls) to playerKey
199         url = re.sub(r'(?<=[?&])bckey', 'playerKey', url)
200         mobj = re.match(self._VALID_URL, url)
201         query_str = mobj.group('query')
202         query = compat_urlparse.parse_qs(query_str)
203
204         videoPlayer = query.get('@videoPlayer')
205         if videoPlayer:
206             # We set the original url as the default 'Referer' header
207             referer = smuggled_data.get('Referer', url)
208             return self._get_video_info(
209                 videoPlayer[0], query_str, query, referer=referer)
210         elif 'playerKey' in query:
211             player_key = query['playerKey']
212             return self._get_playlist_info(player_key[0])
213         else:
214             raise ExtractorError(
215                 'Cannot find playerKey= variable. Did you forget quotes in a shell invocation?',
216                 expected=True)
217
218     def _get_video_info(self, video_id, query_str, query, referer=None):
219         request_url = self._FEDERATED_URL_TEMPLATE % query_str
220         req = compat_urllib_request.Request(request_url)
221         linkBase = query.get('linkBaseURL')
222         if linkBase is not None:
223             referer = linkBase[0]
224         if referer is not None:
225             req.add_header('Referer', referer)
226         webpage = self._download_webpage(req, video_id)
227
228         error_msg = self._html_search_regex(
229             r"<h1>We're sorry.</h1>([\s\n]*<p>.*?</p>)+", webpage,
230             'error message', default=None)
231         if error_msg is not None:
232             raise ExtractorError(
233                 'brightcove said: %s' % error_msg, expected=True)
234
235         self.report_extraction(video_id)
236         info = self._search_regex(r'var experienceJSON = ({.*});', webpage, 'json')
237         info = json.loads(info)['data']
238         video_info = info['programmedContent']['videoPlayer']['mediaDTO']
239         video_info['_youtubedl_adServerURL'] = info.get('adServerURL')
240
241         return self._extract_video_info(video_info)
242
243     def _get_playlist_info(self, player_key):
244         info_url = 'http://c.brightcove.com/services/json/experience/runtime/?command=get_programming_for_experience&playerKey=%s' % player_key
245         playlist_info = self._download_webpage(
246             info_url, player_key, 'Downloading playlist information')
247
248         json_data = json.loads(playlist_info)
249         if 'videoList' not in json_data:
250             raise ExtractorError('Empty playlist')
251         playlist_info = json_data['videoList']
252         videos = [self._extract_video_info(video_info) for video_info in playlist_info['mediaCollectionDTO']['videoDTOs']]
253
254         return self.playlist_result(videos, playlist_id='%s' % playlist_info['id'],
255                                     playlist_title=playlist_info['mediaCollectionDTO']['displayName'])
256
257     def _extract_video_info(self, video_info):
258         info = {
259             'id': compat_str(video_info['id']),
260             'title': video_info['displayName'].strip(),
261             'description': video_info.get('shortDescription'),
262             'thumbnail': video_info.get('videoStillURL') or video_info.get('thumbnailURL'),
263             'uploader': video_info.get('publisherName'),
264         }
265
266         renditions = video_info.get('renditions')
267         if renditions:
268             formats = []
269             for rend in renditions:
270                 url = rend['defaultURL']
271                 if not url:
272                     continue
273                 ext = None
274                 if rend['remote']:
275                     url_comp = compat_urllib_parse_urlparse(url)
276                     if url_comp.path.endswith('.m3u8'):
277                         formats.extend(
278                             self._extract_m3u8_formats(url, info['id'], 'mp4'))
279                         continue
280                     elif 'akamaihd.net' in url_comp.netloc:
281                         # This type of renditions are served through
282                         # akamaihd.net, but they don't use f4m manifests
283                         url = url.replace('control/', '') + '?&v=3.3.0&fp=13&r=FEEFJ&g=RTSJIMBMPFPB'
284                         ext = 'flv'
285                 if ext is None:
286                     ext = determine_ext(url)
287                 size = rend.get('size')
288                 formats.append({
289                     'url': url,
290                     'ext': ext,
291                     'height': rend.get('frameHeight'),
292                     'width': rend.get('frameWidth'),
293                     'filesize': size if size != 0 else None,
294                 })
295             self._sort_formats(formats)
296             info['formats'] = formats
297         elif video_info.get('FLVFullLengthURL') is not None:
298             info.update({
299                 'url': video_info['FLVFullLengthURL'],
300             })
301
302         if self._downloader.params.get('include_ads', False):
303             adServerURL = video_info.get('_youtubedl_adServerURL')
304             if adServerURL:
305                 ad_info = {
306                     '_type': 'url',
307                     'url': adServerURL,
308                 }
309                 if 'url' in info:
310                     return {
311                         '_type': 'playlist',
312                         'title': info['title'],
313                         'entries': [ad_info, info],
314                     }
315                 else:
316                     return ad_info
317
318         if 'url' not in info and not info.get('formats'):
319             raise ExtractorError('Unable to extract video url for %s' % info['id'])
320         return info