[ap] improve adobe pass names and parse error handling
[youtube-dl] / youtube_dl / extractor / adobepass.py
1 # -*- coding: utf-8 -*-
2 from __future__ import unicode_literals
3
4 import re
5 import time
6 import xml.etree.ElementTree as etree
7
8 from .common import InfoExtractor
9 from ..compat import compat_urlparse
10 from ..utils import (
11     unescapeHTML,
12     urlencode_postdata,
13     unified_timestamp,
14     ExtractorError,
15 )
16
17
18 MSO_INFO = {
19     'DTV': {
20         'name': 'DirecTV',
21         'username_field': 'username',
22         'password_field': 'password',
23     },
24     'Rogers': {
25         'name': 'Rogers Cable',
26         'username_field': 'UserName',
27         'password_field': 'UserPassword',
28     },
29 }
30
31
32 class AdobePassIE(InfoExtractor):
33     _SERVICE_PROVIDER_TEMPLATE = 'https://sp.auth.adobe.com/adobe-services/%s'
34     _USER_AGENT = 'Mozilla/5.0 (X11; Linux i686; rv:47.0) Gecko/20100101 Firefox/47.0'
35
36     @staticmethod
37     def _get_mvpd_resource(provider_id, title, guid, rating):
38         channel = etree.Element('channel')
39         channel_title = etree.SubElement(channel, 'title')
40         channel_title.text = provider_id
41         item = etree.SubElement(channel, 'item')
42         resource_title = etree.SubElement(item, 'title')
43         resource_title.text = title
44         resource_guid = etree.SubElement(item, 'guid')
45         resource_guid.text = guid
46         resource_rating = etree.SubElement(item, 'media:rating')
47         resource_rating.attrib = {'scheme': 'urn:v-chip'}
48         resource_rating.text = rating
49         return '<rss version="2.0" xmlns:media="http://search.yahoo.com/mrss/">' + etree.tostring(channel).decode() + '</rss>'
50
51     def _extract_mvpd_auth(self, url, video_id, requestor_id, resource):
52         def xml_text(xml_str, tag):
53             return self._search_regex(
54                 '<%s>(.+?)</%s>' % (tag, tag), xml_str, tag)
55
56         def is_expired(token, date_ele):
57             token_expires = unified_timestamp(re.sub(r'[_ ]GMT', '', xml_text(token, date_ele)))
58             return token_expires and token_expires <= int(time.time())
59
60         def post_form(form_page_res, note, data={}):
61             form_page, urlh = form_page_res
62             post_url = self._html_search_regex(r'<form[^>]+action=(["\'])(?P<url>.+?)\1', form_page, 'post url', group='url')
63             if not re.match(r'https?://', post_url):
64                 post_url = compat_urlparse.urljoin(urlh.geturl(), post_url)
65             form_data = self._hidden_inputs(form_page)
66             form_data.update(data)
67             return self._download_webpage_handle(
68                 post_url, video_id, note, data=urlencode_postdata(form_data), headers={
69                     'Content-Type': 'application/x-www-form-urlencoded',
70                 })
71
72         def raise_mvpd_required():
73             raise ExtractorError(
74                 'This video is only available for users of participating TV providers. '
75                 'Use --ap-mso to specify Adobe Pass Multiple-system operator Identifier '
76                 'and --ap-username and --ap-password or --netrc to provide account credentials.', expected=True)
77
78         mvpd_headers = {
79             'ap_42': 'anonymous',
80             'ap_11': 'Linux i686',
81             'ap_z': self._USER_AGENT,
82             'User-Agent': self._USER_AGENT,
83         }
84
85         guid = xml_text(resource, 'guid')
86         count = 0
87         while count < 2:
88             requestor_info = self._downloader.cache.load('mvpd', requestor_id) or {}
89             authn_token = requestor_info.get('authn_token')
90             if authn_token and is_expired(authn_token, 'simpleTokenExpires'):
91                 authn_token = None
92             if not authn_token:
93                 # TODO add support for other TV Providers
94                 mso_id = self._downloader.params.get('ap_mso')
95                 if not mso_id:
96                     raise_mvpd_required()
97                 username, password = self._get_login_info('ap_username', 'ap_password', mso_id)
98                 if not username or not password:
99                     raise_mvpd_required()
100                 mso_info = MSO_INFO[mso_id]
101
102                 provider_redirect_page_res = self._download_webpage_handle(
103                     self._SERVICE_PROVIDER_TEMPLATE % 'authenticate/saml', video_id,
104                     'Downloading Provider Redirect Page', query={
105                         'noflash': 'true',
106                         'mso_id': mso_id,
107                         'requestor_id': requestor_id,
108                         'no_iframe': 'false',
109                         'domain_name': 'adobe.com',
110                         'redirect_url': url,
111                     })
112                 provider_login_page_res = post_form(
113                     provider_redirect_page_res, 'Downloading Provider Login Page')
114                 mvpd_confirm_page_res = post_form(provider_login_page_res, 'Logging in', {
115                     mso_info['username_field']: username,
116                     mso_info['password_field']: password,
117                 })
118                 if mso_id == 'DTV':
119                     post_form(mvpd_confirm_page_res, 'Confirming Login')
120
121                 session = self._download_webpage(
122                     self._SERVICE_PROVIDER_TEMPLATE % 'session', video_id,
123                     'Retrieving Session', data=urlencode_postdata({
124                         '_method': 'GET',
125                         'requestor_id': requestor_id,
126                     }), headers=mvpd_headers)
127                 if '<pendingLogout' in session:
128                     self._downloader.cache.store('mvpd', requestor_id, {})
129                     count += 1
130                     continue
131                 authn_token = unescapeHTML(xml_text(session, 'authnToken'))
132                 requestor_info['authn_token'] = authn_token
133                 self._downloader.cache.store('mvpd', requestor_id, requestor_info)
134
135             authz_token = requestor_info.get(guid)
136             if authz_token and is_expired(authz_token, 'simpleTokenTTL'):
137                 authz_token = None
138             if not authz_token:
139                 authorize = self._download_webpage(
140                     self._SERVICE_PROVIDER_TEMPLATE % 'authorize', video_id,
141                     'Retrieving Authorization Token', data=urlencode_postdata({
142                         'resource_id': resource,
143                         'requestor_id': requestor_id,
144                         'authentication_token': authn_token,
145                         'mso_id': xml_text(authn_token, 'simpleTokenMsoID'),
146                         'userMeta': '1',
147                     }), headers=mvpd_headers)
148                 if '<pendingLogout' in authorize:
149                     self._downloader.cache.store('mvpd', requestor_id, {})
150                     count += 1
151                     continue
152                 authz_token = unescapeHTML(xml_text(authorize, 'authzToken'))
153                 requestor_info[guid] = authz_token
154                 self._downloader.cache.store('mvpd', requestor_id, requestor_info)
155
156             mvpd_headers.update({
157                 'ap_19': xml_text(authn_token, 'simpleSamlNameID'),
158                 'ap_23': xml_text(authn_token, 'simpleSamlSessionIndex'),
159             })
160
161             short_authorize = self._download_webpage(
162                 self._SERVICE_PROVIDER_TEMPLATE % 'shortAuthorize',
163                 video_id, 'Retrieving Media Token', data=urlencode_postdata({
164                     'authz_token': authz_token,
165                     'requestor_id': requestor_id,
166                     'session_guid': xml_text(authn_token, 'simpleTokenAuthenticationGuid'),
167                     'hashed_guid': 'false',
168                 }), headers=mvpd_headers)
169             if '<pendingLogout' in short_authorize:
170                 self._downloader.cache.store('mvpd', requestor_id, {})
171                 count += 1
172                 continue
173             return short_authorize