[cbc] Improve playlist support (closes #11704)
[youtube-dl] / youtube_dl / extractor / cbc.py
1 # coding: utf-8
2 from __future__ import unicode_literals
3
4 import re
5
6 from .common import InfoExtractor
7 from ..compat import compat_str
8 from ..utils import (
9     js_to_json,
10     smuggle_url,
11     try_get,
12     xpath_text,
13     xpath_element,
14     xpath_with_ns,
15     find_xpath_attr,
16     parse_iso8601,
17     parse_age_limit,
18     int_or_none,
19     ExtractorError,
20 )
21
22
23 class CBCIE(InfoExtractor):
24     IE_NAME = 'cbc.ca'
25     _VALID_URL = r'https?://(?:www\.)?cbc\.ca/(?!player/)(?:[^/]+/)+(?P<id>[^/?#]+)'
26     _TESTS = [{
27         # with mediaId
28         'url': 'http://www.cbc.ca/22minutes/videos/clips-season-23/don-cherry-play-offs',
29         'md5': '97e24d09672fc4cf56256d6faa6c25bc',
30         'info_dict': {
31             'id': '2682904050',
32             'ext': 'mp4',
33             'title': 'Don Cherry – All-Stars',
34             'description': 'Don Cherry has a bee in his bonnet about AHL player John Scott because that guy’s got heart.',
35             'timestamp': 1454463000,
36             'upload_date': '20160203',
37             'uploader': 'CBCC-NEW',
38         },
39         'skip': 'Geo-restricted to Canada',
40     }, {
41         # with clipId, feed available via tpfeed.cbc.ca and feed.theplatform.com
42         'url': 'http://www.cbc.ca/22minutes/videos/22-minutes-update/22-minutes-update-episode-4',
43         'md5': '162adfa070274b144f4fdc3c3b8207db',
44         'info_dict': {
45             'id': '2414435309',
46             'ext': 'mp4',
47             'title': '22 Minutes Update: What Not To Wear Quebec',
48             'description': "This week's latest Canadian top political story is What Not To Wear Quebec.",
49             'upload_date': '20131025',
50             'uploader': 'CBCC-NEW',
51             'timestamp': 1382717907,
52         },
53     }, {
54         # with clipId, feed only available via tpfeed.cbc.ca
55         'url': 'http://www.cbc.ca/archives/entry/1978-robin-williams-freestyles-on-90-minutes-live',
56         'md5': '0274a90b51a9b4971fe005c63f592f12',
57         'info_dict': {
58             'id': '2487345465',
59             'ext': 'mp4',
60             'title': 'Robin Williams freestyles on 90 Minutes Live',
61             'description': 'Wacky American comedian Robin Williams shows off his infamous "freestyle" comedic talents while being interviewed on CBC\'s 90 Minutes Live.',
62             'upload_date': '19780210',
63             'uploader': 'CBCC-NEW',
64             'timestamp': 255977160,
65         },
66     }, {
67         # multiple iframes
68         'url': 'http://www.cbc.ca/natureofthings/blog/birds-eye-view-from-vancouvers-burrard-street-bridge-how-we-got-the-shot',
69         'playlist': [{
70             'md5': '377572d0b49c4ce0c9ad77470e0b96b4',
71             'info_dict': {
72                 'id': '2680832926',
73                 'ext': 'mp4',
74                 'title': 'An Eagle\'s-Eye View Off Burrard Bridge',
75                 'description': 'Hercules the eagle flies from Vancouver\'s Burrard Bridge down to a nearby park with a mini-camera strapped to his back.',
76                 'upload_date': '20160201',
77                 'timestamp': 1454342820,
78                 'uploader': 'CBCC-NEW',
79             },
80         }, {
81             'md5': '415a0e3f586113894174dfb31aa5bb1a',
82             'info_dict': {
83                 'id': '2658915080',
84                 'ext': 'mp4',
85                 'title': 'Fly like an eagle!',
86                 'description': 'Eagle equipped with a mini camera flies from the world\'s tallest tower',
87                 'upload_date': '20150315',
88                 'timestamp': 1426443984,
89                 'uploader': 'CBCC-NEW',
90             },
91         }],
92         'skip': 'Geo-restricted to Canada',
93     }, {
94         # multiple CBC.APP.Caffeine.initInstance(...)
95         'url': 'http://www.cbc.ca/news/canada/calgary/dog-indoor-exercise-winter-1.3928238',
96         'info_dict': {
97             'title': 'Keep Rover active during the deep freeze with doggie pushups and other fun indoor tasks',
98             'id': 'dog-indoor-exercise-winter-1.3928238',
99         },
100         'playlist_mincount': 6,
101     }]
102
103     @classmethod
104     def suitable(cls, url):
105         return False if CBCPlayerIE.suitable(url) else super(CBCIE, cls).suitable(url)
106
107     def _extract_player_init(self, player_init, display_id):
108         player_info = self._parse_json(player_init, display_id, js_to_json)
109         media_id = player_info.get('mediaId')
110         if not media_id:
111             clip_id = player_info['clipId']
112             feed = self._download_json(
113                 'http://tpfeed.cbc.ca/f/ExhSPC/vms_5akSXx4Ng_Zn?byCustomValue={:mpsReleases}{%s}' % clip_id,
114                 clip_id, fatal=False)
115             if feed:
116                 media_id = try_get(feed, lambda x: x['entries'][0]['guid'], compat_str)
117             if not media_id:
118                 media_id = self._download_json(
119                     'http://feed.theplatform.com/f/h9dtGB/punlNGjMlc1F?fields=id&byContent=byReleases%3DbyId%253D' + clip_id,
120                     clip_id)['entries'][0]['id'].split('/')[-1]
121         return self.url_result('cbcplayer:%s' % media_id, 'CBCPlayer', media_id)
122
123     def _real_extract(self, url):
124         display_id = self._match_id(url)
125         webpage = self._download_webpage(url, display_id)
126         entries = [
127             self._extract_player_init(player_init, display_id)
128             for player_init in re.findall(r'CBC\.APP\.Caffeine\.initInstance\(({.+?})\);', webpage)]
129         entries.extend([
130             self.url_result('cbcplayer:%s' % media_id, 'CBCPlayer', media_id)
131             for media_id in re.findall(r'<iframe[^>]+src="[^"]+?mediaId=(\d+)"', webpage)])
132         return self.playlist_result(
133             entries, display_id,
134             self._og_search_title(webpage, fatal=False),
135             self._og_search_description(webpage))
136
137
138 class CBCPlayerIE(InfoExtractor):
139     IE_NAME = 'cbc.ca:player'
140     _VALID_URL = r'(?:cbcplayer:|https?://(?:www\.)?cbc\.ca/(?:player/play/|i/caffeine/syndicate/\?mediaId=))(?P<id>\d+)'
141     _TESTS = [{
142         'url': 'http://www.cbc.ca/player/play/2683190193',
143         'md5': '64d25f841ddf4ddb28a235338af32e2c',
144         'info_dict': {
145             'id': '2683190193',
146             'ext': 'mp4',
147             'title': 'Gerry Runs a Sweat Shop',
148             'description': 'md5:b457e1c01e8ff408d9d801c1c2cd29b0',
149             'timestamp': 1455071400,
150             'upload_date': '20160210',
151             'uploader': 'CBCC-NEW',
152         },
153         'skip': 'Geo-restricted to Canada',
154     }, {
155         # Redirected from http://www.cbc.ca/player/AudioMobile/All%20in%20a%20Weekend%20Montreal/ID/2657632011/
156         'url': 'http://www.cbc.ca/player/play/2657631896',
157         'md5': 'e5e708c34ae6fca156aafe17c43e8b75',
158         'info_dict': {
159             'id': '2657631896',
160             'ext': 'mp3',
161             'title': 'CBC Montreal is organizing its first ever community hackathon!',
162             'description': 'The modern technology we tend to depend on so heavily, is never without it\'s share of hiccups and headaches. Next weekend - CBC Montreal will be getting members of the public for its first Hackathon.',
163             'timestamp': 1425704400,
164             'upload_date': '20150307',
165             'uploader': 'CBCC-NEW',
166         },
167     }, {
168         # available only when we add `formats=MPEG4,FLV,MP3` to theplatform url
169         'url': 'http://www.cbc.ca/player/play/2164402062',
170         'md5': '17a61eb813539abea40618d6323a7f82',
171         'info_dict': {
172             'id': '2164402062',
173             'ext': 'flv',
174             'title': 'Cancer survivor four times over',
175             'description': 'Tim Mayer has beaten three different forms of cancer four times in five years.',
176             'timestamp': 1320410746,
177             'upload_date': '20111104',
178             'uploader': 'CBCC-NEW',
179         },
180     }]
181
182     def _real_extract(self, url):
183         video_id = self._match_id(url)
184         return {
185             '_type': 'url_transparent',
186             'ie_key': 'ThePlatform',
187             'url': smuggle_url(
188                 'http://link.theplatform.com/s/ExhSPC/media/guid/2655402169/%s?mbr=true&formats=MPEG4,FLV,MP3' % video_id, {
189                     'force_smil_url': True
190                 }),
191             'id': video_id,
192         }
193
194
195 class CBCWatchBaseIE(InfoExtractor):
196     _device_id = None
197     _device_token = None
198     _API_BASE_URL = 'https://api-cbc.cloud.clearleap.com/cloffice/client/'
199     _NS_MAP = {
200         'media': 'http://search.yahoo.com/mrss/',
201         'clearleap': 'http://www.clearleap.com/namespace/clearleap/1.0/',
202     }
203
204     def _call_api(self, path, video_id):
205         url = path if path.startswith('http') else self._API_BASE_URL + path
206         result = self._download_xml(url, video_id, headers={
207             'X-Clearleap-DeviceId': self._device_id,
208             'X-Clearleap-DeviceToken': self._device_token,
209         })
210         error_message = xpath_text(result, 'userMessage') or xpath_text(result, 'systemMessage')
211         if error_message:
212             raise ExtractorError('%s said: %s' % (self.IE_NAME, error_message))
213         return result
214
215     def _real_initialize(self):
216         if not self._device_id or not self._device_token:
217             device = self._downloader.cache.load('cbcwatch', 'device') or {}
218             self._device_id, self._device_token = device.get('id'), device.get('token')
219             if not self._device_id or not self._device_token:
220                 result = self._download_xml(
221                     self._API_BASE_URL + 'device/register',
222                     None, data=b'<device><type>web</type></device>')
223                 self._device_id = xpath_text(result, 'deviceId', fatal=True)
224                 self._device_token = xpath_text(result, 'deviceToken', fatal=True)
225                 self._downloader.cache.store(
226                     'cbcwatch', 'device', {
227                         'id': self._device_id,
228                         'token': self._device_token,
229                     })
230
231     def _parse_rss_feed(self, rss):
232         channel = xpath_element(rss, 'channel', fatal=True)
233
234         def _add_ns(path):
235             return xpath_with_ns(path, self._NS_MAP)
236
237         entries = []
238         for item in channel.findall('item'):
239             guid = xpath_text(item, 'guid', fatal=True)
240             title = xpath_text(item, 'title', fatal=True)
241
242             media_group = xpath_element(item, _add_ns('media:group'), fatal=True)
243             content = xpath_element(media_group, _add_ns('media:content'), fatal=True)
244             content_url = content.attrib['url']
245
246             thumbnails = []
247             for thumbnail in media_group.findall(_add_ns('media:thumbnail')):
248                 thumbnail_url = thumbnail.get('url')
249                 if not thumbnail_url:
250                     continue
251                 thumbnails.append({
252                     'id': thumbnail.get('profile'),
253                     'url': thumbnail_url,
254                     'width': int_or_none(thumbnail.get('width')),
255                     'height': int_or_none(thumbnail.get('height')),
256                 })
257
258             timestamp = None
259             release_date = find_xpath_attr(
260                 item, _add_ns('media:credit'), 'role', 'releaseDate')
261             if release_date is not None:
262                 timestamp = parse_iso8601(release_date.text)
263
264             entries.append({
265                 '_type': 'url_transparent',
266                 'url': content_url,
267                 'id': guid,
268                 'title': title,
269                 'description': xpath_text(item, 'description'),
270                 'timestamp': timestamp,
271                 'duration': int_or_none(content.get('duration')),
272                 'age_limit': parse_age_limit(xpath_text(item, _add_ns('media:rating'))),
273                 'episode': xpath_text(item, _add_ns('clearleap:episode')),
274                 'episode_number': int_or_none(xpath_text(item, _add_ns('clearleap:episodeInSeason'))),
275                 'series': xpath_text(item, _add_ns('clearleap:series')),
276                 'season_number': int_or_none(xpath_text(item, _add_ns('clearleap:season'))),
277                 'thumbnails': thumbnails,
278                 'ie_key': 'CBCWatchVideo',
279             })
280
281         return self.playlist_result(
282             entries, xpath_text(channel, 'guid'),
283             xpath_text(channel, 'title'),
284             xpath_text(channel, 'description'))
285
286
287 class CBCWatchVideoIE(CBCWatchBaseIE):
288     IE_NAME = 'cbc.ca:watch:video'
289     _VALID_URL = r'https?://api-cbc\.cloud\.clearleap\.com/cloffice/client/web/play/?\?.*?\bcontentId=(?P<id>[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12})'
290
291     def _real_extract(self, url):
292         video_id = self._match_id(url)
293         result = self._call_api(url, video_id)
294
295         m3u8_url = xpath_text(result, 'url', fatal=True)
296         formats = self._extract_m3u8_formats(re.sub(r'/([^/]+)/[^/?]+\.m3u8', r'/\1/\1.m3u8', m3u8_url), video_id, 'mp4', fatal=False)
297         if len(formats) < 2:
298             formats = self._extract_m3u8_formats(m3u8_url, video_id, 'mp4')
299         self._sort_formats(formats)
300
301         info = {
302             'id': video_id,
303             'title': video_id,
304             'formats': formats,
305         }
306
307         rss = xpath_element(result, 'rss')
308         if rss:
309             info.update(self._parse_rss_feed(rss)['entries'][0])
310             del info['url']
311             del info['_type']
312             del info['ie_key']
313         return info
314
315
316 class CBCWatchIE(CBCWatchBaseIE):
317     IE_NAME = 'cbc.ca:watch'
318     _VALID_URL = r'https?://watch\.cbc\.ca/(?:[^/]+/)+(?P<id>[0-9a-f-]+)'
319     _TESTS = [{
320         'url': 'http://watch.cbc.ca/doc-zone/season-6/customer-disservice/38e815a-009e3ab12e4',
321         'info_dict': {
322             'id': '38e815a-009e3ab12e4',
323             'ext': 'mp4',
324             'title': 'Customer (Dis)Service',
325             'description': 'md5:8bdd6913a0fe03d4b2a17ebe169c7c87',
326             'upload_date': '20160219',
327             'timestamp': 1455840000,
328         },
329         'params': {
330             # m3u8 download
331             'skip_download': True,
332             'format': 'bestvideo',
333         },
334         'skip': 'Geo-restricted to Canada',
335     }, {
336         'url': 'http://watch.cbc.ca/arthur/all/1ed4b385-cd84-49cf-95f0-80f004680057',
337         'info_dict': {
338             'id': '1ed4b385-cd84-49cf-95f0-80f004680057',
339             'title': 'Arthur',
340             'description': 'Arthur, the sweetest 8-year-old aardvark, and his pals solve all kinds of problems with humour, kindness and teamwork.',
341         },
342         'playlist_mincount': 30,
343         'skip': 'Geo-restricted to Canada',
344     }]
345
346     def _real_extract(self, url):
347         video_id = self._match_id(url)
348         rss = self._call_api('web/browse/' + video_id, video_id)
349         return self._parse_rss_feed(rss)