[pluralsight] Adapt to new API (closes #10972)
[youtube-dl] / youtube_dl / extractor / pluralsight.py
1 from __future__ import unicode_literals
2
3 import collections
4 import json
5 import os
6 import random
7 import re
8
9 from .common import InfoExtractor
10 from ..compat import (
11     compat_str,
12     compat_urlparse,
13 )
14 from ..utils import (
15     ExtractorError,
16     float_or_none,
17     int_or_none,
18     parse_duration,
19     qualities,
20     srt_subtitles_timecode,
21     urlencode_postdata,
22 )
23
24
25 class PluralsightBaseIE(InfoExtractor):
26     _API_BASE = 'https://app.pluralsight.com'
27
28
29 class PluralsightIE(PluralsightBaseIE):
30     IE_NAME = 'pluralsight'
31     _VALID_URL = r'https?://(?:(?:www|app)\.)?pluralsight\.com/(?:training/)?player\?'
32     _LOGIN_URL = 'https://app.pluralsight.com/id/'
33
34     _NETRC_MACHINE = 'pluralsight'
35
36     _TESTS = [{
37         'url': 'http://www.pluralsight.com/training/player?author=mike-mckeown&name=hosting-sql-server-windows-azure-iaas-m7-mgmt&mode=live&clip=3&course=hosting-sql-server-windows-azure-iaas',
38         'md5': '4d458cf5cf4c593788672419a8dd4cf8',
39         'info_dict': {
40             'id': 'hosting-sql-server-windows-azure-iaas-m7-mgmt-04',
41             'ext': 'mp4',
42             'title': 'Management of SQL Server - Demo Monitoring',
43             'duration': 338,
44         },
45         'skip': 'Requires pluralsight account credentials',
46     }, {
47         'url': 'https://app.pluralsight.com/training/player?course=angularjs-get-started&author=scott-allen&name=angularjs-get-started-m1-introduction&clip=0&mode=live',
48         'only_matching': True,
49     }, {
50         # available without pluralsight account
51         'url': 'http://app.pluralsight.com/training/player?author=scott-allen&name=angularjs-get-started-m1-introduction&mode=live&clip=0&course=angularjs-get-started',
52         'only_matching': True,
53     }, {
54         'url': 'https://app.pluralsight.com/player?course=ccna-intro-networking&author=ross-bagurdes&name=ccna-intro-networking-m06&clip=0',
55         'only_matching': True,
56     }]
57
58     def _real_initialize(self):
59         self._login()
60
61     def _login(self):
62         (username, password) = self._get_login_info()
63         if username is None:
64             return
65
66         login_page = self._download_webpage(
67             self._LOGIN_URL, None, 'Downloading login page')
68
69         login_form = self._hidden_inputs(login_page)
70
71         login_form.update({
72             'Username': username,
73             'Password': password,
74         })
75
76         post_url = self._search_regex(
77             r'<form[^>]+action=(["\'])(?P<url>.+?)\1', login_page,
78             'post url', default=self._LOGIN_URL, group='url')
79
80         if not post_url.startswith('http'):
81             post_url = compat_urlparse.urljoin(self._LOGIN_URL, post_url)
82
83         response = self._download_webpage(
84             post_url, None, 'Logging in as %s' % username,
85             data=urlencode_postdata(login_form),
86             headers={'Content-Type': 'application/x-www-form-urlencoded'})
87
88         error = self._search_regex(
89             r'<span[^>]+class="field-validation-error"[^>]*>([^<]+)</span>',
90             response, 'error message', default=None)
91         if error:
92             raise ExtractorError('Unable to login: %s' % error, expected=True)
93
94         if all(p not in response for p in ('__INITIAL_STATE__', '"currentUser"')):
95             raise ExtractorError('Unable to log in')
96
97     def _get_subtitles(self, author, clip_id, lang, name, duration, video_id):
98         captions_post = {
99             'a': author,
100             'cn': clip_id,
101             'lc': lang,
102             'm': name,
103         }
104         captions = self._download_json(
105             '%s/player/retrieve-captions' % self._API_BASE, video_id,
106             'Downloading captions JSON', 'Unable to download captions JSON',
107             fatal=False, data=json.dumps(captions_post).encode('utf-8'),
108             headers={'Content-Type': 'application/json;charset=utf-8'})
109         if captions:
110             return {
111                 lang: [{
112                     'ext': 'json',
113                     'data': json.dumps(captions),
114                 }, {
115                     'ext': 'srt',
116                     'data': self._convert_subtitles(duration, captions),
117                 }]
118             }
119
120     @staticmethod
121     def _convert_subtitles(duration, subs):
122         srt = ''
123         for num, current in enumerate(subs):
124             current = subs[num]
125             start, text = float_or_none(
126                 current.get('DisplayTimeOffset')), current.get('Text')
127             if start is None or text is None:
128                 continue
129             end = duration if num == len(subs) - 1 else float_or_none(
130                 subs[num + 1].get('DisplayTimeOffset'))
131             if end is None:
132                 continue
133             srt += os.linesep.join(
134                 (
135                     '%d' % num,
136                     '%s --> %s' % (
137                         srt_subtitles_timecode(start),
138                         srt_subtitles_timecode(end)),
139                     text,
140                     os.linesep,
141                 ))
142         return srt
143
144     def _real_extract(self, url):
145         qs = compat_urlparse.parse_qs(compat_urlparse.urlparse(url).query)
146
147         author = qs.get('author', [None])[0]
148         name = qs.get('name', [None])[0]
149         clip_id = qs.get('clip', [None])[0]
150         course_name = qs.get('course', [None])[0]
151
152         if any(not f for f in (author, name, clip_id, course_name,)):
153             raise ExtractorError('Invalid URL', expected=True)
154
155         display_id = '%s-%s' % (name, clip_id)
156
157         parsed_url = compat_urlparse.urlparse(url)
158
159         payload_url = compat_urlparse.urlunparse(parsed_url._replace(
160             netloc='app.pluralsight.com', path='player/api/v1/payload'))
161
162         course = self._download_json(
163             payload_url, display_id, headers={'Referer': url})['payload']['course']
164
165         collection = course['modules']
166
167         module, clip = None, None
168
169         for module_ in collection:
170             if name in (module_.get('moduleName'), module_.get('name')):
171                 module = module_
172                 for clip_ in module_.get('clips', []):
173                     clip_index = clip_.get('clipIndex')
174                     if clip_index is None:
175                         clip_index = clip_.get('index')
176                     if clip_index is None:
177                         continue
178                     if compat_str(clip_index) == clip_id:
179                         clip = clip_
180                         break
181
182         if not clip:
183             raise ExtractorError('Unable to resolve clip')
184
185         title = '%s - %s' % (module['title'], clip['title'])
186
187         QUALITIES = {
188             'low': {'width': 640, 'height': 480},
189             'medium': {'width': 848, 'height': 640},
190             'high': {'width': 1024, 'height': 768},
191             'high-widescreen': {'width': 1280, 'height': 720},
192         }
193
194         QUALITIES_PREFERENCE = ('low', 'medium', 'high', 'high-widescreen',)
195         quality_key = qualities(QUALITIES_PREFERENCE)
196
197         AllowedQuality = collections.namedtuple('AllowedQuality', ['ext', 'qualities'])
198
199         ALLOWED_QUALITIES = (
200             AllowedQuality('webm', ['high', ]),
201             AllowedQuality('mp4', ['low', 'medium', 'high', ]),
202         )
203
204         # Some courses also offer widescreen resolution for high quality (see
205         # https://github.com/rg3/youtube-dl/issues/7766)
206         widescreen = course.get('supportsWideScreenVideoFormats') is True
207         best_quality = 'high-widescreen' if widescreen else 'high'
208         if widescreen:
209             for allowed_quality in ALLOWED_QUALITIES:
210                 allowed_quality.qualities.append(best_quality)
211
212         # In order to minimize the number of calls to ViewClip API and reduce
213         # the probability of being throttled or banned by Pluralsight we will request
214         # only single format until formats listing was explicitly requested.
215         if self._downloader.params.get('listformats', False):
216             allowed_qualities = ALLOWED_QUALITIES
217         else:
218             def guess_allowed_qualities():
219                 req_format = self._downloader.params.get('format') or 'best'
220                 req_format_split = req_format.split('-', 1)
221                 if len(req_format_split) > 1:
222                     req_ext, req_quality = req_format_split
223                     for allowed_quality in ALLOWED_QUALITIES:
224                         if req_ext == allowed_quality.ext and req_quality in allowed_quality.qualities:
225                             return (AllowedQuality(req_ext, (req_quality, )), )
226                 req_ext = 'webm' if self._downloader.params.get('prefer_free_formats') else 'mp4'
227                 return (AllowedQuality(req_ext, (best_quality, )), )
228             allowed_qualities = guess_allowed_qualities()
229
230         formats = []
231         for ext, qualities_ in allowed_qualities:
232             for quality in qualities_:
233                 f = QUALITIES[quality].copy()
234                 clip_post = {
235                     'author': author,
236                     'includeCaptions': False,
237                     'clipIndex': int(clip_id),
238                     'courseName': course_name,
239                     'locale': 'en',
240                     'moduleName': name,
241                     'mediaType': ext,
242                     'quality': '%dx%d' % (f['width'], f['height']),
243                 }
244                 format_id = '%s-%s' % (ext, quality)
245                 clip_url = self._download_webpage(
246                     '%s/video/clips/viewclip' % self._API_BASE, display_id,
247                     'Downloading %s URL' % format_id, fatal=False,
248                     data=json.dumps(clip_post).encode('utf-8'),
249                     headers={'Content-Type': 'application/json;charset=utf-8'})
250
251                 # Pluralsight tracks multiple sequential calls to ViewClip API and start
252                 # to return 429 HTTP errors after some time (see
253                 # https://github.com/rg3/youtube-dl/pull/6989). Moreover it may even lead
254                 # to account ban (see https://github.com/rg3/youtube-dl/issues/6842).
255                 # To somewhat reduce the probability of these consequences
256                 # we will sleep random amount of time before each call to ViewClip.
257                 self._sleep(
258                     random.randint(2, 5), display_id,
259                     '%(video_id)s: Waiting for %(timeout)s seconds to avoid throttling')
260
261                 if not clip_url:
262                     continue
263                 f.update({
264                     'url': clip_url,
265                     'ext': ext,
266                     'format_id': format_id,
267                     'quality': quality_key(quality),
268                 })
269                 formats.append(f)
270         self._sort_formats(formats)
271
272         duration = int_or_none(
273             clip.get('duration')) or parse_duration(clip.get('formattedDuration'))
274
275         # TODO: other languages?
276         subtitles = self.extract_subtitles(
277             author, clip_id, 'en', name, duration, display_id)
278
279         return {
280             'id': clip.get('clipName') or clip['name'],
281             'title': title,
282             'duration': duration,
283             'creator': author,
284             'formats': formats,
285             'subtitles': subtitles,
286         }
287
288
289 class PluralsightCourseIE(PluralsightBaseIE):
290     IE_NAME = 'pluralsight:course'
291     _VALID_URL = r'https?://(?:(?:www|app)\.)?pluralsight\.com/(?:library/)?courses/(?P<id>[^/]+)'
292     _TESTS = [{
293         # Free course from Pluralsight Starter Subscription for Microsoft TechNet
294         # https://offers.pluralsight.com/technet?loc=zTS3z&prod=zOTprodz&tech=zOttechz&prog=zOTprogz&type=zSOz&media=zOTmediaz&country=zUSz
295         'url': 'http://www.pluralsight.com/courses/hosting-sql-server-windows-azure-iaas',
296         'info_dict': {
297             'id': 'hosting-sql-server-windows-azure-iaas',
298             'title': 'Hosting SQL Server in Microsoft Azure IaaS Fundamentals',
299             'description': 'md5:61b37e60f21c4b2f91dc621a977d0986',
300         },
301         'playlist_count': 31,
302     }, {
303         # available without pluralsight account
304         'url': 'https://www.pluralsight.com/courses/angularjs-get-started',
305         'only_matching': True,
306     }, {
307         'url': 'https://app.pluralsight.com/library/courses/understanding-microsoft-azure-amazon-aws/table-of-contents',
308         'only_matching': True,
309     }]
310
311     def _real_extract(self, url):
312         course_id = self._match_id(url)
313
314         # TODO: PSM cookie
315
316         course = self._download_json(
317             '%s/data/course/%s' % (self._API_BASE, course_id),
318             course_id, 'Downloading course JSON')
319
320         title = course['title']
321         description = course.get('description') or course.get('shortDescription')
322
323         course_data = self._download_json(
324             '%s/data/course/content/%s' % (self._API_BASE, course_id),
325             course_id, 'Downloading course data JSON')
326
327         entries = []
328         for num, module in enumerate(course_data, 1):
329             for clip in module.get('clips', []):
330                 player_parameters = clip.get('playerParameters')
331                 if not player_parameters:
332                     continue
333                 entries.append({
334                     '_type': 'url_transparent',
335                     'url': '%s/training/player?%s' % (self._API_BASE, player_parameters),
336                     'ie_key': PluralsightIE.ie_key(),
337                     'chapter': module.get('title'),
338                     'chapter_number': num,
339                     'chapter_id': module.get('moduleRef'),
340                 })
341
342         return self.playlist_result(entries, course_id, title, description)