[lynda:course] Modernize and make more robust
[youtube-dl] / youtube_dl / extractor / lynda.py
1 from __future__ import unicode_literals
2
3 import re
4 import json
5
6 from .common import InfoExtractor
7 from ..compat import (
8     compat_str,
9     compat_urllib_parse,
10     compat_urllib_request,
11 )
12 from ..utils import (
13     ExtractorError,
14     clean_html,
15     int_or_none,
16 )
17
18
19 class LyndaBaseIE(InfoExtractor):
20     _LOGIN_URL = 'https://www.lynda.com/login/login.aspx'
21     _ACCOUNT_CREDENTIALS_HINT = 'Use --username and --password options to provide lynda.com account credentials.'
22     _NETRC_MACHINE = 'lynda'
23
24     def _real_initialize(self):
25         self._login()
26
27     def _login(self):
28         (username, password) = self._get_login_info()
29         if username is None:
30             return
31
32         login_form = {
33             'username': username.encode('utf-8'),
34             'password': password.encode('utf-8'),
35             'remember': 'false',
36             'stayPut': 'false'
37         }
38         request = compat_urllib_request.Request(
39             self._LOGIN_URL, compat_urllib_parse.urlencode(login_form).encode('utf-8'))
40         login_page = self._download_webpage(
41             request, None, 'Logging in as %s' % username)
42
43         # Not (yet) logged in
44         m = re.search(r'loginResultJson\s*=\s*\'(?P<json>[^\']+)\';', login_page)
45         if m is not None:
46             response = m.group('json')
47             response_json = json.loads(response)
48             state = response_json['state']
49
50             if state == 'notlogged':
51                 raise ExtractorError(
52                     'Unable to login, incorrect username and/or password',
53                     expected=True)
54
55             # This is when we get popup:
56             # > You're already logged in to lynda.com on two devices.
57             # > If you log in here, we'll log you out of another device.
58             # So, we need to confirm this.
59             if state == 'conflicted':
60                 confirm_form = {
61                     'username': '',
62                     'password': '',
63                     'resolve': 'true',
64                     'remember': 'false',
65                     'stayPut': 'false',
66                 }
67                 request = compat_urllib_request.Request(
68                     self._LOGIN_URL, compat_urllib_parse.urlencode(confirm_form).encode('utf-8'))
69                 login_page = self._download_webpage(
70                     request, None,
71                     'Confirming log in and log out from another device')
72
73         if all(not re.search(p, login_page) for p in ('isLoggedIn\s*:\s*true', r'logout\.aspx', r'>Log out<')):
74             if 'login error' in login_page:
75                 mobj = re.search(
76                     r'(?s)<h1[^>]+class="topmost">(?P<title>[^<]+)</h1>\s*<div>(?P<description>.+?)</div>',
77                     login_page)
78                 if mobj:
79                     raise ExtractorError(
80                         'lynda returned error: %s - %s'
81                         % (mobj.group('title'), clean_html(mobj.group('description'))),
82                         expected=True)
83             raise ExtractorError('Unable to log in')
84
85     def _logout(self):
86         self._download_webpage(
87             'http://www.lynda.com/ajax/logout.aspx', None,
88             'Logging out', 'Unable to log out', fatal=False)
89
90
91 class LyndaIE(LyndaBaseIE):
92     IE_NAME = 'lynda'
93     IE_DESC = 'lynda.com videos'
94     _VALID_URL = r'https?://www\.lynda\.com/(?:[^/]+/[^/]+/\d+|player/embed)/(?P<id>\d+)'
95     _NETRC_MACHINE = 'lynda'
96
97     _TIMECODE_REGEX = r'\[(?P<timecode>\d+:\d+:\d+[\.,]\d+)\]'
98
99     _TESTS = [{
100         'url': 'http://www.lynda.com/Bootstrap-tutorials/Using-exercise-files/110885/114408-4.html',
101         'md5': 'ecfc6862da89489161fb9cd5f5a6fac1',
102         'info_dict': {
103             'id': '114408',
104             'ext': 'mp4',
105             'title': 'Using the exercise files',
106             'duration': 68
107         }
108     }, {
109         'url': 'https://www.lynda.com/player/embed/133770?tr=foo=1;bar=g;fizz=rt&fs=0',
110         'only_matching': True,
111     }]
112
113     def _real_extract(self, url):
114         video_id = self._match_id(url)
115
116         page = self._download_webpage(
117             'http://www.lynda.com/ajax/player?videoId=%s&type=video' % video_id,
118             video_id, 'Downloading video JSON')
119         video_json = json.loads(page)
120
121         if 'Status' in video_json:
122             raise ExtractorError(
123                 'lynda returned error: %s' % video_json['Message'], expected=True)
124
125         if video_json['HasAccess'] is False:
126             self.raise_login_required('Video %s is only available for members' % video_id)
127
128         video_id = compat_str(video_json['ID'])
129         duration = video_json['DurationInSeconds']
130         title = video_json['Title']
131
132         formats = []
133
134         fmts = video_json.get('Formats')
135         if fmts:
136             formats.extend([
137                 {
138                     'url': fmt['Url'],
139                     'ext': fmt['Extension'],
140                     'width': fmt['Width'],
141                     'height': fmt['Height'],
142                     'filesize': fmt['FileSize'],
143                     'format_id': str(fmt['Resolution'])
144                 } for fmt in fmts])
145
146         prioritized_streams = video_json.get('PrioritizedStreams')
147         if prioritized_streams:
148             for prioritized_stream_id, prioritized_stream in prioritized_streams.items():
149                 formats.extend([
150                     {
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
157         self._check_formats(formats, video_id)
158         self._sort_formats(formats)
159
160         subtitles = self.extract_subtitles(video_id, page)
161
162         return {
163             'id': video_id,
164             'title': title,
165             'duration': duration,
166             'subtitles': subtitles,
167             'formats': formats
168         }
169
170     def _fix_subtitles(self, subs):
171         srt = ''
172         seq_counter = 0
173         for pos in range(0, len(subs) - 1):
174             seq_current = subs[pos]
175             m_current = re.match(self._TIMECODE_REGEX, seq_current['Timecode'])
176             if m_current is None:
177                 continue
178             seq_next = subs[pos + 1]
179             m_next = re.match(self._TIMECODE_REGEX, seq_next['Timecode'])
180             if m_next is None:
181                 continue
182             appear_time = m_current.group('timecode')
183             disappear_time = m_next.group('timecode')
184             text = seq_current['Caption'].strip()
185             if text:
186                 seq_counter += 1
187                 srt += '%s\r\n%s --> %s\r\n%s\r\n\r\n' % (seq_counter, appear_time, disappear_time, text)
188         if srt:
189             return srt
190
191     def _get_subtitles(self, video_id, webpage):
192         url = 'http://www.lynda.com/ajax/player?videoId=%s&type=transcript' % video_id
193         subs = self._download_json(url, None, False)
194         if subs:
195             return {'en': [{'ext': 'srt', 'data': self._fix_subtitles(subs)}]}
196         else:
197             return {}
198
199
200 class LyndaCourseIE(LyndaBaseIE):
201     IE_NAME = 'lynda:course'
202     IE_DESC = 'lynda.com online courses'
203
204     # Course link equals to welcome/introduction video link of same course
205     # We will recognize it as course link
206     _VALID_URL = r'https?://(?:www|m)\.lynda\.com/(?P<coursepath>[^/]+/[^/]+/(?P<courseid>\d+))-\d\.html'
207
208     def _real_extract(self, url):
209         mobj = re.match(self._VALID_URL, url)
210         course_path = mobj.group('coursepath')
211         course_id = mobj.group('courseid')
212
213         course = self._download_json(
214             'http://www.lynda.com/ajax/player?courseId=%s&type=course' % course_id,
215             course_id, 'Downloading course JSON')
216
217         self._logout()
218
219         if course.get('Status') == 'NotFound':
220             raise ExtractorError(
221                 'Course %s does not exist' % course_id, expected=True)
222
223         unaccessible_videos = 0
224         videos = []
225
226         # Might want to extract videos right here from video['Formats'] as it seems 'Formats' is not provided
227         # by single video API anymore
228
229         for chapter in course['Chapters']:
230             for video in chapter.get('Videos', []):
231                 if video.get('HasAccess') is False:
232                     unaccessible_videos += 1
233                     continue
234                 video_id = video.get('ID')
235                 if video_id:
236                     videos.append(video_id)
237
238         if unaccessible_videos > 0:
239             self._downloader.report_warning(
240                 '%s videos are only available for members (or paid members) and will not be downloaded. '
241                 % unaccessible_videos + self._ACCOUNT_CREDENTIALS_HINT)
242
243         entries = [
244             self.url_result(
245                 'http://www.lynda.com/%s/%s-4.html' % (course_path, video_id),
246                 'Lynda')
247             for video_id in videos]
248
249         course_title = course.get('Title')
250
251         return self.playlist_result(entries, course_id, course_title)