Merge a94b69e4d3862c9549585782f308c03b17ed8699 into 3eb8d22ddb8982ca4fb56bb7a8d6517538bf14c6

* thx seproDev, yt-dlp/yt-dlp/pull/12694/commits/ae69e3c
* also add documenting comment in `InfoExtractor`

youtube_dl/extractor/bokecc.py

@@ -32,7 +32,7 @@ class BokeCCBaseIE(InfoExtractor):
 
 
 class BokeCCIE(BokeCCBaseIE):
-    _IE_DESC = 'CC视频'
+    IE_DESC = 'CC视频'
     _VALID_URL = r'https?://union\.bokecc\.com/playvideo\.bo\?(?P<query>.*)'
 
     _TESTS = [{

youtube_dl/extractor/cloudy.py

@@ -9,7 +9,7 @@ from ..utils import (
 
 
 class CloudyIE(InfoExtractor):
-    _IE_DESC = 'cloudy.ec'
+    IE_DESC = 'cloudy.ec'
     _VALID_URL = r'https?://(?:www\.)?cloudy\.ec/(?:v/|embed\.php\?.*?\bid=)(?P<id>[A-Za-z0-9]+)'
     _TESTS = [{
         'url': 'https://www.cloudy.ec/v/af511e2527aac',

youtube_dl/extractor/common.py

@@ -422,6 +422,8 @@ class InfoExtractor(object):
     _GEO_COUNTRIES = None
     _GEO_IP_BLOCKS = None
     _WORKING = True
+    # supply this in public subclasses: used in supported sites list, etc
+    # IE_DESC = 'short description of IE'
 
     def __init__(self, downloader=None):
         """Constructor. Receives an optional downloader."""

youtube_dl/extractor/extractors.py

@@ -506,6 +506,7 @@ from .hungama import (
     HungamaSongIE,
 )
 from .hypem import HypemIE
+from .icareus import IcareusIE 
 from .ign import (
     IGNIE,
     IGNVideoIE,

youtube_dl/extractor/icareus.py

@@ -0,0 +1,230 @@
+# coding: utf-8
+from __future__ import unicode_literals
+
+import re
+
+from .common import InfoExtractor
+from ..utils import (
+    clean_html,
+    determine_ext,
+    get_element_by_attribute,
+    get_element_by_class,
+    int_or_none,
+    parse_bitrate,
+    parse_resolution,
+    unified_timestamp,
+    urlencode_postdata,
+    url_or_none,
+)
+
+
+class IcareusIE(InfoExtractor):
+    _VALID_URL = r'''(?x)
+                    https?://(?:www\.)?
+                        (?:
+                            asahitv\.fi|
+                            helsinkikanava\.fi|
+                            hyvinvointitv\.fi|
+                            inez\.fi|
+                            midastv\.ke|
+                            permanto\.fi|
+                            suite.icareus.com|
+                            videos\.minifiddlers\.org
+                        )
+                        /.+/player/.*(?:assetId|eventId)=(?P<id>\d+).*'''
+    _TESTS = [{
+        'url': 'https://www.helsinkikanava.fi/fi_FI/web/helsinkikanava/player/vod?assetId=68021894',
+        'md5': 'ca0b62ffc814a5411dfa6349cf5adb8a',
+        'info_dict': {
+            'id': '68021894',
+            'ext': 'mp4',
+            'title': 'Perheiden parhaaksi',
+            'description': 'md5:fe4e4ec742a34f53022f3a0409b0f6e7',
+            'thumbnail': 'https://www.helsinkikanava.fi/image/image_gallery?img_id=68022501',
+            'upload_date': '20200924',
+            'timestamp': 1600938300,
+        },
+    }, {  # Recorded livestream
+        'url': 'https://www.helsinkikanava.fi/fi/web/helsinkikanava/player/event/view?eventId=76241489',
+        'md5': '014327e69dfa7b949fcc861f6d162d6d',
+        'info_dict': {
+            'id': '76258304',
+            'ext': 'mp4',
+            'title': 'Helsingin kaupungin ja HUSin tiedotustilaisuus koronaepidemiatilanteesta 24.11.2020',
+            'description': 'md5:3129d041c6fbbcdc7fe68d9a938fef1c',
+            'thumbnail': 'https://icareus-suite.secure2.footprint.net/image/image_gallery?img_id=76288630',
+            'upload_date': '20201124',
+            'timestamp': 1606206600,
+        },
+    }, {
+        'url': 'https://asahitv.fi/fi/web/asahi/player/vod?assetId=89415818',
+        'only_matching': True
+    }, {
+        'url': 'https://hyvinvointitv.fi/fi/web/hyvinvointitv/player/vod?assetId=89149730',
+        'only_matching': True
+    }, {
+        'url': 'https://inez.fi/fi/web/inez-media/player/vod?assetId=71328822',
+        'only_matching': True
+    }, {
+        'url': 'https://www.midastv.ke/en/web/midas-tv/player/embed/vod?assetId=65714535',
+        'only_matching': True
+    }, {
+        'url': 'https://www.permanto.fi/fi/web/alfatv/player/vod?assetId=95010095',
+        'only_matching': True
+    }, {
+        'url': 'https://suite.icareus.com/fi/web/westend-indians/player/vod?assetId=47567389',
+        'only_matching': True
+    }, {
+        'url': 'https://videos.minifiddlers.org/web/international-minifiddlers/player/vod?assetId=1982759',
+        'only_matching': True
+    }]
+    _API2_PATH = '/icareus-suite-api-portlet/publishing'
+
+    def _real_extract(self, url):
+        maybe_id = self._match_id(url)
+        page = self._download_webpage(url, maybe_id)
+        video_id = self._search_regex(
+            r"_icareus\['itemId'\]='(\d+)'", page, "video_id")
+        api_base = self._search_regex(
+            r'var publishingServiceURL = "(http.*?)";', page, "api_base")
+        organization_id = self._search_regex(
+            r"_icareus\['organizationId'\]='(\d+)'", page, "organization_id")
+        token = self._search_regex(
+            r"_icareus\['token'\]='([a-f0-9]+)'", page, "token")
+
+        token2 = self._search_regex(
+            r'''data\s*:\s*{action:"getAsset".*?token:'([a-f0-9]+)'}''', page,
+            "token2", default=None, fatal=False)
+        metajson = get_element_by_attribute('type', 'application/ld+json', page)
+
+        metad = None
+        if metajson:
+            # The description can contain newlines, HTML tags, quote chars etc.
+            # so we'll extract it manually
+            mo = re.match(
+                r'(.*",)\s*"description": "(.*?)",(\s*"thumbnailUrl":.*)',
+                metajson, flags=re.DOTALL)
+            if mo:
+                desc_text = mo.group(2)
+                metajson = mo.group(1) + mo.group(3)
+                metad = self._parse_json(metajson, video_id, fatal=False)
+            else:
+                self.report_warning("Could not fix metadata JSON", video_id)
+
+        livestream_title = get_element_by_class(
+            'unpublished-info-item future-event-title', page)
+
+        duration = None
+        thumbnail = None
+        if metad:
+            title = metad.get('name')
+            description = desc_text
+            timestamp = unified_timestamp(metad.get('uploadDate'))
+            thumbnail = url_or_none(metad.get('thumbnailUrl'))
+        elif token2:
+            base_url = self._search_regex(r'(https?://[^/]+)/', url, 'base_url')
+            data = {
+                "version": "03",
+                "action": "getAsset",
+                "organizationId": organization_id,
+                "assetId": video_id,
+                "languageId": "en_US",
+                "userId": "0",
+                "token": token2,
+            }
+            metad = self._download_json(base_url + self._API2_PATH, video_id,
+                                        data=urlencode_postdata(data))
+            title = metad.get('name')
+            description = metad.get('description')
+            timestamp = int_or_none(metad.get('date'), scale=1000)
+            duration = int_or_none(metad.get('duration'))
+            thumbnail = url_or_none(metad.get('thumbnailMedium'))
+        elif livestream_title:  # Recorded livestream
+            title = livestream_title
+            description = get_element_by_class(
+                'unpublished-info-item future-event-description', page)
+            timestamp = int_or_none(self._search_regex(
+                r"var startEvent\s*=\s*(\d+);", page, "uploadDate",
+                fatal=False), scale=1000)
+        else:
+            self.report_warning("Could not extract metadata", video_id)
+            description = None
+            timestamp = None
+
+        title = title if title else video_id
+        description = clean_html(description)
+
+        data = {
+            "version": "03",
+            "action": "getAssetPlaybackUrls",
+            "organizationId": organization_id,
+            "assetId": video_id,
+            "token": token,
+        }
+        jsond = self._download_json(api_base, video_id,
+                                    data=urlencode_postdata(data))
+
+        if thumbnail is None:
+            thumbnail = url_or_none(jsond.get('thumbnail'))
+
+        formats = []
+        for item in jsond.get('urls', []):
+            video_url = url_or_none(item.get('url'))
+            ext = determine_ext(video_url)
+            if ext == 'm3u8':
+                formats.extend(self._extract_m3u8_formats(
+                    video_url, video_id, 'mp4',
+                    entry_protocol='m3u8_native', m3u8_id='hls',
+                    fatal=False))
+            else:
+                fd = {'url': video_url}
+                fmt = item.get('name')
+                if fmt:
+                    fd['format'] = fmt
+                    fd.update(parse_resolution(fmt))
+                    mo = re.search(r'\((\d+)\s*kbps\)\s*\+\s*(\d+)\s*kbps', fmt)
+                    if mo:
+                        fd['vbr'] = int_or_none(mo.group(1))
+                        fd['abr'] = int_or_none(mo.group(2))
+                    else:
+                        fd['tbr'] = parse_bitrate(fmt)
+                fmt_id = item.get('id')
+                if fmt_id:
+                    fd['format_id'] = str(fmt_id)
+                formats.append(fd)
+
+        for item in jsond.get('audio_urls', []):
+            fmt = item.get('name')
+            mo = re.match(r'.*\((\d+)k\).*', fmt if fmt else '')
+            abr = int_or_none(mo.group(1)) if mo else None
+            fd = {
+                'format': fmt,
+                'format_id': 'audio',
+                'url': url_or_none(item.get('url')),
+                'vcodec': 'none',
+            }
+            if abr:
+                fd['abr'] = abr
+            formats.append(fd)
+
+        subtitles = {}
+        for sub in jsond.get('subtitles', []):
+            scode, sdesc, surl = sub
+            lang = sdesc.split(' ')[0]
+            lang = lang[:-1] if lang.endswith(':') else lang
+            subtitles[lang] = [{"url": url_or_none(surl)}]
+
+        info = {
+            'id': video_id,
+            'title': title,
+            'description': description,
+            'thumbnail': thumbnail,
+            'timestamp': timestamp,
+            'formats': formats,
+        }
+        if duration:
+            info['duration'] = duration
+        if subtitles:
+            info['subtitles'] = subtitles
+
+        return info

youtube_dl/extractor/itv.py

@@ -35,15 +35,6 @@ from ..utils import (
 
 class ITVBaseIE(InfoExtractor):
 
-    def _search_nextjs_data(self, webpage, video_id, **kw):
-        transform_source = kw.pop('transform_source', None)
-        fatal = kw.pop('fatal', True)
-        return self._parse_json(
-            self._search_regex(
-                r'''<script\b[^>]+\bid=('|")__NEXT_DATA__\1[^>]*>(?P<js>[^<]+)</script>''',
-                webpage, 'next.js data', group='js', fatal=fatal, **kw),
-            video_id, transform_source=transform_source, fatal=fatal)
-
     def __handle_request_webpage_error(self, err, video_id=None, errnote=None, fatal=True):
         if errnote is False:
             return False
@@ -109,7 +100,9 @@ class ITVBaseIE(InfoExtractor):
 
 class ITVIE(ITVBaseIE):
     _VALID_URL = r'https?://(?:www\.)?itv\.com/(?:(?P<w>watch)|hub)/[^/]+/(?(w)[\w-]+/)(?P<id>\w+)'
-    _IE_DESC = 'ITVX'
+    IE_DESC = 'ITVX'
+    _WORKING = False
+
     _TESTS = [{
         'note': 'Hub URLs redirect to ITVX',
         'url': 'https://www.itv.com/hub/liar/2a4547a0012',
@@ -270,7 +263,7 @@ class ITVIE(ITVBaseIE):
                 'ext': determine_ext(href, 'vtt'),
             })
 
-        next_data = self._search_nextjs_data(webpage, video_id, fatal=False, default='{}')
+        next_data = self._search_nextjs_data(webpage, video_id, fatal=False, default={})
         video_data.update(traverse_obj(next_data, ('props', 'pageProps', ('title', 'episode')), expected_type=dict)[0] or {})
         title = traverse_obj(video_data, 'headerTitle', 'episodeTitle')
         info = self._og_extract(webpage, require_title=not title)
@@ -323,7 +316,7 @@ class ITVIE(ITVBaseIE):
 
 class ITVBTCCIE(ITVBaseIE):
     _VALID_URL = r'https?://(?:www\.)?itv\.com/(?!(?:watch|hub)/)(?:[^/]+/)+(?P<id>[^/?#&]+)'
-    _IE_DESC = 'ITV articles: News, British Touring Car Championship'
+    IE_DESC = 'ITV articles: News, British Touring Car Championship'
     _TESTS = [{
         'note': 'British Touring Car Championship',
         'url': 'https://www.itv.com/btcc/articles/btcc-2018-all-the-action-from-brands-hatch',

youtube_dl/extractor/senateisvp.py

@@ -47,7 +47,7 @@ class SenateISVPIE(InfoExtractor):
         ['vetaff', '76462', 'http://vetaff-f.akamaihd.net'],
         ['arch', '', 'http://ussenate-f.akamaihd.net/']
     ]
-    _IE_NAME = 'senate.gov'
+    IE_NAME = 'senate.gov'
     _VALID_URL = r'https?://(?:www\.)?senate\.gov/isvp/?\?(?P<qs>.+)'
     _TESTS = [{
         'url': 'http://www.senate.gov/isvp/?comm=judiciary&type=live&stt=&filename=judiciary031715&auto_play=false&wmode=transparent&poster=http%3A%2F%2Fwww.judiciary.senate.gov%2Fthemes%2Fjudiciary%2Fimages%2Fvideo-poster-flash-fit.png',

youtube_dl/jsinterp.py

@@ -686,6 +686,8 @@ class JSInterpreter(object):
             raise self.Exception('Cannot get index {idx!r:.100}'.format(**locals()), expr=repr(obj), cause=e)
 
     def _dump(self, obj, namespace):
+        if obj is JS_Undefined:
+            return 'undefined'
         try:
             return json.dumps(obj)
         except TypeError: