aabde15f3ff2acf09d5746b749388d5f29eb1d74
[youtube-dl] / youtube_dl / extractor / itv.py
1 # coding: utf-8
2 from __future__ import unicode_literals
3
4 import uuid
5 import xml.etree.ElementTree as etree
6 import json
7
8 from .common import InfoExtractor
9 from ..compat import (
10     compat_str,
11     compat_etree_register_namespace,
12 )
13 from ..utils import (
14     extract_attributes,
15     xpath_with_ns,
16     xpath_element,
17     xpath_text,
18     int_or_none,
19     parse_duration,
20     ExtractorError,
21     determine_ext,
22 )
23
24
25 class ITVIE(InfoExtractor):
26     _VALID_URL = r'https?://(?:www\.)?itv\.com/hub/[^/]+/(?P<id>[0-9a-zA-Z]+)'
27     _TEST = {
28         'url': 'http://www.itv.com/hub/mr-bean-animated-series/2a2936a0053',
29         'info_dict': {
30             'id': '2a2936a0053',
31             'ext': 'flv',
32             'title': 'Home Movie',
33         },
34         'params': {
35             # rtmp download
36             'skip_download': True,
37         },
38     }
39
40     def _real_extract(self, url):
41         video_id = self._match_id(url)
42         webpage = self._download_webpage(url, video_id)
43         params = extract_attributes(self._search_regex(
44             r'(?s)(<[^>]+id="video"[^>]*>)', webpage, 'params'))
45
46         ns_map = {
47             'soapenv': 'http://schemas.xmlsoap.org/soap/envelope/',
48             'tem': 'http://tempuri.org/',
49             'itv': 'http://schemas.datacontract.org/2004/07/Itv.BB.Mercury.Common.Types',
50             'com': 'http://schemas.itv.com/2009/05/Common',
51         }
52         for ns, full_ns in ns_map.items():
53             compat_etree_register_namespace(ns, full_ns)
54
55         def _add_ns(name):
56             return xpath_with_ns(name, ns_map)
57
58         def _add_sub_element(element, name):
59             return etree.SubElement(element, _add_ns(name))
60
61         req_env = etree.Element(_add_ns('soapenv:Envelope'))
62         _add_sub_element(req_env, 'soapenv:Header')
63         body = _add_sub_element(req_env, 'soapenv:Body')
64         get_playlist = _add_sub_element(body, ('tem:GetPlaylist'))
65         request = _add_sub_element(get_playlist, 'tem:request')
66         _add_sub_element(request, 'itv:ProductionId').text = params['data-video-id']
67         _add_sub_element(request, 'itv:RequestGuid').text = compat_str(uuid.uuid4()).upper()
68         vodcrid = _add_sub_element(request, 'itv:Vodcrid')
69         _add_sub_element(vodcrid, 'com:Id')
70         _add_sub_element(request, 'itv:Partition')
71         user_info = _add_sub_element(get_playlist, 'tem:userInfo')
72         _add_sub_element(user_info, 'itv:Broadcaster').text = 'Itv'
73         _add_sub_element(user_info, 'itv:DM')
74         _add_sub_element(user_info, 'itv:RevenueScienceValue')
75         _add_sub_element(user_info, 'itv:SessionId')
76         _add_sub_element(user_info, 'itv:SsoToken')
77         _add_sub_element(user_info, 'itv:UserToken')
78         site_info = _add_sub_element(get_playlist, 'tem:siteInfo')
79         _add_sub_element(site_info, 'itv:AdvertisingRestriction').text = 'None'
80         _add_sub_element(site_info, 'itv:AdvertisingSite').text = 'ITV'
81         _add_sub_element(site_info, 'itv:AdvertisingType').text = 'Any'
82         _add_sub_element(site_info, 'itv:Area').text = 'ITVPLAYER.VIDEO'
83         _add_sub_element(site_info, 'itv:Category')
84         _add_sub_element(site_info, 'itv:Platform').text = 'DotCom'
85         _add_sub_element(site_info, 'itv:Site').text = 'ItvCom'
86         device_info = _add_sub_element(get_playlist, 'tem:deviceInfo')
87         _add_sub_element(device_info, 'itv:ScreenSize').text = 'Big'
88         player_info = _add_sub_element(get_playlist, 'tem:playerInfo')
89         _add_sub_element(player_info, 'itv:Version').text = '2'
90
91         headers = self.geo_verification_headers()
92         headers.update({
93             'Content-Type': 'text/xml; charset=utf-8',
94             'SOAPAction': 'http://tempuri.org/PlaylistService/GetPlaylist',
95         })
96         resp_env = self._download_xml(
97             params['data-playlist-url'], video_id,
98             headers=headers, data=etree.tostring(req_env))
99         playlist = xpath_element(resp_env, './/Playlist')
100         if playlist is None:
101             fault_code = xpath_text(resp_env, './/faultcode')
102             fault_string = xpath_text(resp_env, './/faultstring')
103             if fault_code == 'InvalidGeoRegion':
104                 self.raise_geo_restricted(msg=fault_string, countries=['GB'])
105             raise ExtractorError('%s said: %s' % (self.IE_NAME, fault_string))
106         title = xpath_text(playlist, 'EpisodeTitle', fatal=True)
107         video_element = xpath_element(playlist, 'VideoEntries/Video', fatal=True)
108         media_files = xpath_element(video_element, 'MediaFiles', fatal=True)
109         rtmp_url = media_files.attrib['base']
110
111         formats = []
112         for media_file in media_files.findall('MediaFile'):
113             play_path = xpath_text(media_file, 'URL')
114             if not play_path:
115                 continue
116             tbr = int_or_none(media_file.get('bitrate'), 1000)
117             formats.append({
118                 'format_id': 'rtmp' + ('-%d' % tbr if tbr else ''),
119                 'url': rtmp_url,
120                 'play_path': play_path,
121                 'tbr': tbr,
122                 'ext': 'flv',
123             })
124
125         ios_playlist_url = params.get('data-video-playlist')
126         hmac = params.get('data-video-hmac')
127         if ios_playlist_url and hmac:
128             headers = self.geo_verification_headers()
129             headers.update({
130                 'Accept': 'application/vnd.itv.vod.playlist.v2+json',
131                 'Content-Type': 'application/json',
132                 'hmac': hmac.upper(),
133             })
134             ios_playlist = self._download_json(
135                 ios_playlist_url, video_id, data=json.dumps({
136                     'user': {
137                         'itvUserId': '',
138                         'entitlements': [],
139                         'token': ''
140                     },
141                     'device': {
142                         'manufacturer': 'Apple',
143                         'model': 'iPad',
144                         'os': {
145                             'name': 'iPhone OS',
146                             'version': '9.3',
147                             'type': 'ios'
148                         }
149                     },
150                     'client': {
151                         'version': '4.1',
152                         'id': 'browser'
153                     },
154                     'variantAvailability': {
155                         'featureset': {
156                             'min': ['hls', 'aes'],
157                             'max': ['hls', 'aes']
158                         },
159                         'platformTag': 'mobile'
160                     }
161                 }).encode(), headers=headers, fatal=False)
162             if ios_playlist:
163                 video_data = ios_playlist.get('Playlist', {}).get('Video', {})
164                 ios_base_url = video_data.get('Base')
165                 for media_file in video_data.get('MediaFiles', []):
166                     href = media_file.get('Href')
167                     if not href:
168                         continue
169                     if ios_base_url:
170                         href = ios_base_url + href
171                     ext = determine_ext(href)
172                     if ext == 'm3u8':
173                         formats.extend(self._extract_m3u8_formats(href, video_id, 'mp4', m3u8_id='hls', fatal=False))
174                     else:
175                         formats.append({
176                             'url': href,
177                         })
178         self._sort_formats(formats)
179
180         subtitles = {}
181         for caption_url in video_element.findall('ClosedCaptioningURIs/URL'):
182             if not caption_url.text:
183                 continue
184             ext = determine_ext(caption_url.text, 'ttml')
185             subtitles.setdefault('en', []).append({
186                 'url': caption_url.text,
187                 'ext': 'ttml' if ext == 'xml' else ext,
188             })
189
190         return {
191             'id': video_id,
192             'title': title,
193             'formats': formats,
194             'subtitles': subtitles,
195             'episode_title': title,
196             'episode_number': int_or_none(xpath_text(playlist, 'EpisodeNumber')),
197             'series': xpath_text(playlist, 'ProgrammeTitle'),
198             'duartion': parse_duration(xpath_text(playlist, 'Duration')),
199         }