Merge pull request #9747 from TRox1972/lynda
[youtube-dl] / youtube_dl / extractor / lynda.py
1 from __future__ import unicode_literals
2
3 import re
4
5 from .common import InfoExtractor
6 from ..compat import (
7     compat_HTTPError,
8     compat_str,
9     compat_urlparse,
10 )
11 from ..utils import (
12     ExtractorError,
13     int_or_none,
14     urlencode_postdata,
15 )
16
17
18 class LyndaBaseIE(InfoExtractor):
19     _SIGNIN_URL = 'https://www.lynda.com/signin'
20     _PASSWORD_URL = 'https://www.lynda.com/signin/password'
21     _USER_URL = 'https://www.lynda.com/signin/user'
22     _ACCOUNT_CREDENTIALS_HINT = 'Use --username and --password options to provide lynda.com account credentials.'
23     _NETRC_MACHINE = 'lynda'
24
25     def _real_initialize(self):
26         self._login()
27
28     @staticmethod
29     def _check_error(json_string, key_or_keys):
30         keys = [key_or_keys] if isinstance(key_or_keys, compat_str) else key_or_keys
31         for key in keys:
32             error = json_string.get(key)
33             if error:
34                 raise ExtractorError('Unable to login: %s' % error, expected=True)
35
36     def _login_step(self, form_html, fallback_action_url, extra_form_data, note, referrer_url):
37         action_url = self._search_regex(
38             r'<form[^>]+action=(["\'])(?P<url>.+?)\1', form_html,
39             'post url', default=fallback_action_url, group='url')
40
41         if not action_url.startswith('http'):
42             action_url = compat_urlparse.urljoin(self._SIGNIN_URL, action_url)
43
44         form_data = self._hidden_inputs(form_html)
45         form_data.update(extra_form_data)
46
47         try:
48             response = self._download_json(
49                 action_url, None, note,
50                 data=urlencode_postdata(form_data),
51                 headers={
52                     'Referer': referrer_url,
53                     'X-Requested-With': 'XMLHttpRequest',
54                 })
55         except ExtractorError as e:
56             if isinstance(e.cause, compat_HTTPError) and e.cause.code == 500:
57                 response = self._parse_json(e.cause.read().decode('utf-8'), None)
58                 self._check_error(response, ('email', 'password'))
59             raise
60
61         self._check_error(response, 'ErrorMessage')
62
63         return response, action_url
64
65     def _login(self):
66         username, password = self._get_login_info()
67         if username is None:
68             return
69
70         # Step 1: download signin page
71         signin_page = self._download_webpage(
72             self._SIGNIN_URL, None, 'Downloading signin page')
73
74         # Already logged in
75         if any(re.search(p, signin_page) for p in (
76                 'isLoggedIn\s*:\s*true', r'logout\.aspx', r'>Log out<')):
77             return
78
79         # Step 2: submit email
80         signin_form = self._search_regex(
81             r'(?s)(<form[^>]+data-form-name=["\']signin["\'][^>]*>.+?</form>)',
82             signin_page, 'signin form')
83         signin_page, signin_url = self._login_step(
84             signin_form, self._PASSWORD_URL, {'email': username},
85             'Submitting email', self._SIGNIN_URL)
86
87         # Step 3: submit password
88         password_form = signin_page['body']
89         self._login_step(
90             password_form, self._USER_URL, {'email': username, 'password': password},
91             'Submitting password', signin_url)
92
93
94 class LyndaIE(LyndaBaseIE):
95     IE_NAME = 'lynda'
96     IE_DESC = 'lynda.com videos'
97     _VALID_URL = r'https?://www\.lynda\.com/(?:[^/]+/[^/]+/\d+|player/embed)/(?P<id>\d+)'
98     _NETRC_MACHINE = 'lynda'
99
100     _TIMECODE_REGEX = r'\[(?P<timecode>\d+:\d+:\d+[\.,]\d+)\]'
101
102     _TESTS = [{
103         'url': 'http://www.lynda.com/Bootstrap-tutorials/Using-exercise-files/110885/114408-4.html',
104         'md5': 'ecfc6862da89489161fb9cd5f5a6fac1',
105         'info_dict': {
106             'id': '114408',
107             'ext': 'mp4',
108             'title': 'Using the exercise files',
109             'duration': 68
110         }
111     }, {
112         'url': 'https://www.lynda.com/player/embed/133770?tr=foo=1;bar=g;fizz=rt&fs=0',
113         'only_matching': True,
114     }]
115
116     def _real_extract(self, url):
117         video_id = self._match_id(url)
118
119         video = self._download_json(
120             'http://www.lynda.com/ajax/player?videoId=%s&type=video' % video_id,
121             video_id, 'Downloading video JSON')
122
123         if 'Status' in video:
124             raise ExtractorError(
125                 'lynda returned error: %s' % video['Message'], expected=True)
126
127         if video.get('HasAccess') is False:
128             self.raise_login_required('Video %s is only available for members' % video_id)
129
130         video_id = compat_str(video.get('ID') or video_id)
131         duration = int_or_none(video.get('DurationInSeconds'))
132         title = video['Title']
133
134         formats = []
135
136         fmts = video.get('Formats')
137         if fmts:
138             formats.extend([{
139                 'url': f['Url'],
140                 'ext': f.get('Extension'),
141                 'width': int_or_none(f.get('Width')),
142                 'height': int_or_none(f.get('Height')),
143                 'filesize': int_or_none(f.get('FileSize')),
144                 'format_id': compat_str(f.get('Resolution')) if f.get('Resolution') else None,
145             } for f in fmts if f.get('Url')])
146
147         prioritized_streams = video.get('PrioritizedStreams')
148         if prioritized_streams:
149             for prioritized_stream_id, prioritized_stream in prioritized_streams.items():
150                 formats.extend([{
151                     'url': video_url,
152                     'width': int_or_none(format_id),
153                     'format_id': '%s-%s' % (prioritized_stream_id, format_id),
154                 } for format_id, video_url in prioritized_stream.items()])
155
156         self._check_formats(formats, video_id)
157         self._sort_formats(formats)
158
159         subtitles = self.extract_subtitles(video_id)
160
161         return {
162             'id': video_id,
163             'title': title,
164             'duration': duration,
165             'subtitles': subtitles,
166             'formats': formats
167         }
168
169     def _fix_subtitles(self, subs):
170         srt = ''
171         seq_counter = 0
172         for pos in range(0, len(subs) - 1):
173             seq_current = subs[pos]
174             m_current = re.match(self._TIMECODE_REGEX, seq_current['Timecode'])
175             if m_current is None:
176                 continue
177             seq_next = subs[pos + 1]
178             m_next = re.match(self._TIMECODE_REGEX, seq_next['Timecode'])
179             if m_next is None:
180                 continue
181             appear_time = m_current.group('timecode')
182             disappear_time = m_next.group('timecode')
183             text = seq_current['Caption'].strip()
184             if text:
185                 seq_counter += 1
186                 srt += '%s\r\n%s --> %s\r\n%s\r\n\r\n' % (seq_counter, appear_time, disappear_time, text)
187         if srt:
188             return srt
189
190     def _get_subtitles(self, video_id):
191         url = 'http://www.lynda.com/ajax/player?videoId=%s&type=transcript' % video_id
192         subs = self._download_json(url, None, False)
193         if subs:
194             return {'en': [{'ext': 'srt', 'data': self._fix_subtitles(subs)}]}
195         else:
196             return {}
197
198
199 class LyndaCourseIE(LyndaBaseIE):
200     IE_NAME = 'lynda:course'
201     IE_DESC = 'lynda.com online courses'
202
203     # Course link equals to welcome/introduction video link of same course
204     # We will recognize it as course link
205     _VALID_URL = r'https?://(?:www|m)\.lynda\.com/(?P<coursepath>[^/]+/[^/]+/(?P<courseid>\d+))-\d\.html'
206
207     def _real_extract(self, url):
208         mobj = re.match(self._VALID_URL, url)
209         course_path = mobj.group('coursepath')
210         course_id = mobj.group('courseid')
211
212         course = self._download_json(
213             'http://www.lynda.com/ajax/player?courseId=%s&type=course' % course_id,
214             course_id, 'Downloading course JSON')
215
216         if course.get('Status') == 'NotFound':
217             raise ExtractorError(
218                 'Course %s does not exist' % course_id, expected=True)
219
220         unaccessible_videos = 0
221         entries = []
222
223         # Might want to extract videos right here from video['Formats'] as it seems 'Formats' is not provided
224         # by single video API anymore
225
226         for chapter in course['Chapters']:
227             for video in chapter.get('Videos', []):
228                 if video.get('HasAccess') is False:
229                     unaccessible_videos += 1
230                     continue
231                 video_id = video.get('ID')
232                 if video_id:
233                     entries.append({
234                         '_type': 'url_transparent',
235                         'url': 'http://www.lynda.com/%s/%s-4.html' % (course_path, video_id),
236                         'ie_key': LyndaIE.ie_key(),
237                         'chapter': chapter.get('Title'),
238                         'chapter_number': int_or_none(chapter.get('ChapterIndex')),
239                         'chapter_id': compat_str(chapter.get('ID')),
240                     })
241
242         if unaccessible_videos > 0:
243             self._downloader.report_warning(
244                 '%s videos are only available for members (or paid members) and will not be downloaded. '
245                 % unaccessible_videos + self._ACCOUNT_CREDENTIALS_HINT)
246
247         course_title = course.get('Title')
248         course_description = course.get('Description')
249
250         return self.playlist_result(entries, course_id, course_title, course_description)