[kaltura] Add new extractor
[youtube-dl] / youtube_dl / extractor / kaltura.py
1 # coding: utf-8
2 from __future__ import unicode_literals
3
4 import re
5
6 from .common import InfoExtractor
7 from ..compat import compat_urllib_parse
8 from ..utils import (
9     ExtractorError,
10     int_or_none,
11 )
12
13
14 class KalturaIE(InfoExtractor):
15     _VALID_URL = r'''(?x)
16     (?:kaltura:|
17        https?://(:?www\.)?kaltura\.com/index\.php/kwidget/(?:[^/]+/)*?wid/_
18     )(?P<partner_id>\d+)
19     (?::|
20        /(?:[^/]+/)*?entry_id/
21     )(?P<id>[0-9a-z_]+)'''
22     _API_BASE = 'http://cdnapi.kaltura.com/api_v3/index.php?'
23     _TESTS = [
24         {
25             'url': 'kaltura:269692:1_1jc2y3e4',
26             'md5': '3adcbdb3dcc02d647539e53f284ba171',
27             'info_dict': {
28                 'id': '1_1jc2y3e4',
29                 'ext': 'mp4',
30                 'title': 'Track 4',
31                 'upload_date': '20131219',
32                 'uploader_id': 'mlundberg@wolfgangsvault.com',
33                 'description': 'The Allman Brothers Band, 12/16/1981',
34                 'thumbnail': 're:^https?://.*/thumbnail/.*',
35                 'timestamp': int,
36             },
37         },
38         {
39             'url': 'http://www.kaltura.com/index.php/kwidget/cache_st/1300318621/wid/_269692/uiconf_id/3873291/entry_id/1_1jc2y3e4',
40             'only_matching': True,
41         },
42     ]
43
44     def _kaltura_api_call(self, video_id, actions, *args, **kwargs):
45         params = actions[0]
46         if len(actions) > 1:
47             for i, a in enumerate(actions[1:], start=1):
48                 for k, v in a.items():
49                     params['%d:%s' % (i, k)] = v
50
51         query = compat_urllib_parse.urlencode(params)
52         url = self._API_BASE + query
53         data = self._download_json(url, video_id, *args, **kwargs)
54
55         status = data if len(actions) == 1 else data[0]
56         if status.get('objectType') == 'KalturaAPIException':
57             raise ExtractorError(
58                 '%s said: %s' % (self.IE_NAME, status['message']))
59
60         return data
61
62     def _get_kaltura_signature(self, video_id, partner_id):
63         actions = [{
64             'apiVersion': '3.1',
65             'expiry': 86400,
66             'format': 1,
67             'service': 'session',
68             'action': 'startWidgetSession',
69             'widgetId': '_%s' % partner_id,
70         }]
71         return self._kaltura_api_call(
72             video_id, actions, note='Downloading Kaltura signature')['ks']
73
74     def _get_video_info(self, video_id, partner_id):
75         signature = self._get_kaltura_signature(video_id, partner_id)
76         actions = [
77             {
78                 'action': 'null',
79                 'apiVersion': '3.1.5',
80                 'clientTag': 'kdp:v3.8.5',
81                 'format': 1,  # JSON, 2 = XML, 3 = PHP
82                 'service': 'multirequest',
83                 'ks': signature,
84             },
85             {
86                 'action': 'get',
87                 'entryId': video_id,
88                 'service': 'baseentry',
89                 'version': '-1',
90             },
91             {
92                 'action': 'getContextData',
93                 'contextDataParams:objectType': 'KalturaEntryContextDataParams',
94                 'contextDataParams:referrer': 'http://www.kaltura.com/',
95                 'contextDataParams:streamerType': 'http',
96                 'entryId': video_id,
97                 'service': 'baseentry',
98             },
99         ]
100         return self._kaltura_api_call(
101             video_id, actions, note='Downloading video info JSON')
102
103     def _real_extract(self, url):
104         video_id = self._match_id(url)
105         mobj = re.match(self._VALID_URL, url)
106         partner_id, entry_id = mobj.group('partner_id'), mobj.group('id')
107
108         info, source_data = self._get_video_info(entry_id, partner_id)
109
110         formats = [{
111             'format_id': '%(fileExt)s-%(bitrate)s' % f,
112             'ext': f['fileExt'],
113             'tbr': f['bitrate'],
114             'fps': f.get('frameRate'),
115             'filesize_approx': int_or_none(f.get('size'), invscale=1024),
116             'container': f.get('containerFormat'),
117             'vcodec': f.get('videoCodecId'),
118             'height': f.get('height'),
119             'width': f.get('width'),
120             'url': '%s/flavorId/%s' % (info['dataUrl'], f['id']),
121         } for f in source_data['flavorAssets']]
122         self._sort_formats(formats)
123
124         return {
125             'id': video_id,
126             'title': info['name'],
127             'formats': formats,
128             'description': info.get('description'),
129             'thumbnail': info.get('thumbnailUrl'),
130             'duration': info.get('duration'),
131             'timestamp': info.get('createdAt'),
132             'uploader_id': info.get('userId'),
133             'view_count': info.get('plays'),
134         }