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

Generated by cgit