From 698beb9a497f51693e64d167e572ff9efa4bc25f Mon Sep 17 00:00:00 2001
From: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
Date: Sun, 24 Sep 2023 06:36:34 +0800
Subject: [PATCH] [ie/niconicochannelplus] Add extractors (#5686)

Closes #2537
Authored by: pzhlkj6612
---
 README.md                               |   3 +
 yt_dlp/extractor/_extractors.py         |   5 +
 yt_dlp/extractor/niconicochannelplus.py | 426 ++++++++++++++++++++++++
 3 files changed, 434 insertions(+)
 create mode 100644 yt_dlp/extractor/niconicochannelplus.py

diff --git a/README.md b/README.md
index d9b11952de..40515d48dc 100644
--- a/README.md
+++ b/README.md
@@ -1845,6 +1845,9 @@ #### hotstar
 * `vcodec`: vcodec to ignore - one or more of `h264`, `h265`, `dvh265`
 * `dr`: dynamic range to ignore - one or more of `sdr`, `hdr10`, `dv`
 
+#### niconicochannelplus
+* `max_comments`: Maximum number of comments to extract - default is `120`
+
 #### tiktok
 * `api_hostname`: Hostname to use for mobile API requests, e.g. `api-h2.tiktokv.com`
 * `app_version`: App version to call mobile APIs with - should be set along with `manifest_app_version`, e.g. `20.2.1`
diff --git a/yt_dlp/extractor/_extractors.py b/yt_dlp/extractor/_extractors.py
index 2535ed929a..f325864d15 100644
--- a/yt_dlp/extractor/_extractors.py
+++ b/yt_dlp/extractor/_extractors.py
@@ -1299,6 +1299,11 @@
     NineCNineMediaIE,
     CPTwentyFourIE,
 )
+from .niconicochannelplus import (
+    NiconicoChannelPlusIE,
+    NiconicoChannelPlusChannelVideosIE,
+    NiconicoChannelPlusChannelLivesIE,
+)
 from .ninegag import NineGagIE
 from .ninenow import NineNowIE
 from .nintendo import NintendoIE
diff --git a/yt_dlp/extractor/niconicochannelplus.py b/yt_dlp/extractor/niconicochannelplus.py
new file mode 100644
index 0000000000..89af3f7b53
--- /dev/null
+++ b/yt_dlp/extractor/niconicochannelplus.py
@@ -0,0 +1,426 @@
+import functools
+import json
+
+from .common import InfoExtractor
+from ..utils import (
+    ExtractorError,
+    OnDemandPagedList,
+    filter_dict,
+    int_or_none,
+    parse_qs,
+    str_or_none,
+    traverse_obj,
+    unified_timestamp,
+    url_or_none,
+)
+
+
+class NiconicoChannelPlusBaseIE(InfoExtractor):
+    _WEBPAGE_BASE_URL = 'https://nicochannel.jp'
+
+    def _call_api(self, path, item_id, *args, **kwargs):
+        return self._download_json(
+            f'https://nfc-api.nicochannel.jp/fc/{path}', video_id=item_id, *args, **kwargs)
+
+    def _find_fanclub_site_id(self, channel_name):
+        fanclub_list_json = self._call_api(
+            'content_providers/channels', item_id=f'channels/{channel_name}',
+            note='Fetching channel list', errnote='Unable to fetch channel list',
+        )['data']['content_providers']
+        fanclub_id = traverse_obj(fanclub_list_json, (
+            lambda _, v: v['domain'] == f'{self._WEBPAGE_BASE_URL}/{channel_name}', 'id'),
+            get_all=False)
+        if not fanclub_id:
+            raise ExtractorError(f'Channel {channel_name} does not exist', expected=True)
+        return fanclub_id
+
+    def _get_channel_base_info(self, fanclub_site_id):
+        return traverse_obj(self._call_api(
+            f'fanclub_sites/{fanclub_site_id}/page_base_info', item_id=f'fanclub_sites/{fanclub_site_id}',
+            note='Fetching channel base info', errnote='Unable to fetch channel base info', fatal=False,
+        ), ('data', 'fanclub_site', {dict})) or {}
+
+    def _get_channel_user_info(self, fanclub_site_id):
+        return traverse_obj(self._call_api(
+            f'fanclub_sites/{fanclub_site_id}/user_info', item_id=f'fanclub_sites/{fanclub_site_id}',
+            note='Fetching channel user info', errnote='Unable to fetch channel user info', fatal=False,
+            data=json.dumps('null').encode('ascii'),
+        ), ('data', 'fanclub_site', {dict})) or {}
+
+
+class NiconicoChannelPlusIE(NiconicoChannelPlusBaseIE):
+    IE_NAME = 'NiconicoChannelPlus'
+    IE_DESC = 'ニコニコチャンネルプラス'
+    _VALID_URL = r'https?://nicochannel\.jp/(?P<channel>[\w.-]+)/(?:video|live)/(?P<code>sm\w+)'
+    _TESTS = [{
+        'url': 'https://nicochannel.jp/kaorin/video/smsDd8EdFLcVZk9yyAhD6H7H',
+        'info_dict': {
+            'id': 'smsDd8EdFLcVZk9yyAhD6H7H',
+            'title': '前田佳織里はニコ生がしたい！',
+            'ext': 'mp4',
+            'channel': '前田佳織里の世界攻略計画',
+            'channel_id': 'kaorin',
+            'channel_url': 'https://nicochannel.jp/kaorin',
+            'live_status': 'not_live',
+            'thumbnail': 'https://nicochannel.jp/public_html/contents/video_pages/74/thumbnail_path',
+            'description': '２０２１年１１月に放送された\n「前田佳織里はニコ生がしたい！」アーカイブになります。',
+            'timestamp': 1641360276,
+            'duration': 4097,
+            'comment_count': int,
+            'view_count': int,
+            'tags': [],
+            'upload_date': '20220105',
+        },
+        'params': {
+            'skip_download': True,
+        },
+    }, {
+        # age limited video; test purpose channel.
+        'url': 'https://nicochannel.jp/testman/video/smDXbcrtyPNxLx9jc4BW69Ve',
+        'info_dict': {
+            'id': 'smDXbcrtyPNxLx9jc4BW69Ve',
+            'title': 'test oshiro',
+            'ext': 'mp4',
+            'channel': '本番チャンネルプラステストマン',
+            'channel_id': 'testman',
+            'channel_url': 'https://nicochannel.jp/testman',
+            'age_limit': 18,
+            'live_status': 'was_live',
+            'timestamp': 1666344616,
+            'duration': 86465,
+            'comment_count': int,
+            'view_count': int,
+            'tags': [],
+            'upload_date': '20221021',
+        },
+        'params': {
+            'skip_download': True,
+        },
+    }]
+
+    def _real_extract(self, url):
+        content_code, channel_id = self._match_valid_url(url).group('code', 'channel')
+        fanclub_site_id = self._find_fanclub_site_id(channel_id)
+
+        data_json = self._call_api(
+            f'video_pages/{content_code}', item_id=content_code, headers={'fc_use_device': 'null'},
+            note='Fetching video page info', errnote='Unable to fetch video page info',
+        )['data']['video_page']
+
+        live_status, session_id = self._get_live_status_and_session_id(content_code, data_json)
+
+        release_timestamp_str = data_json.get('live_scheduled_start_at')
+
+        formats = []
+
+        if live_status == 'is_upcoming':
+            if release_timestamp_str:
+                msg = f'This live event will begin at {release_timestamp_str} UTC'
+            else:
+                msg = 'This event has not started yet'
+            self.raise_no_formats(msg, expected=True, video_id=content_code)
+        else:
+            formats = self._extract_m3u8_formats(
+                # "authenticated_url" is a format string that contains "{session_id}".
+                m3u8_url=data_json['video_stream']['authenticated_url'].format(session_id=session_id),
+                video_id=content_code)
+
+        return {
+            'id': content_code,
+            'formats': formats,
+            '_format_sort_fields': ('tbr', 'vcodec', 'acodec'),
+            'channel': self._get_channel_base_info(fanclub_site_id).get('fanclub_site_name'),
+            'channel_id': channel_id,
+            'channel_url': f'{self._WEBPAGE_BASE_URL}/{channel_id}',
+            'age_limit': traverse_obj(self._get_channel_user_info(fanclub_site_id), ('content_provider', 'age_limit')),
+            'live_status': live_status,
+            'release_timestamp': unified_timestamp(release_timestamp_str),
+            **traverse_obj(data_json, {
+                'title': ('title', {str}),
+                'thumbnail': ('thumbnail_url', {url_or_none}),
+                'description': ('description', {str}),
+                'timestamp': ('released_at', {unified_timestamp}),
+                'duration': ('active_video_filename', 'length', {int_or_none}),
+                'comment_count': ('video_aggregate_info', 'number_of_comments', {int_or_none}),
+                'view_count': ('video_aggregate_info', 'total_views', {int_or_none}),
+                'tags': ('video_tags', ..., 'tag', {str}),
+            }),
+            '__post_extractor': self.extract_comments(
+                content_code=content_code,
+                comment_group_id=traverse_obj(data_json, ('video_comment_setting', 'comment_group_id'))),
+        }
+
+    def _get_comments(self, content_code, comment_group_id):
+        item_id = f'{content_code}/comments'
+
+        if not comment_group_id:
+            return None
+
+        comment_access_token = self._call_api(
+            f'video_pages/{content_code}/comments_user_token', item_id,
+            note='Getting comment token', errnote='Unable to get comment token',
+        )['data']['access_token']
+
+        comment_list = self._download_json(
+            'https://comm-api.sheeta.com/messages.history', video_id=item_id,
+            note='Fetching comments', errnote='Unable to fetch comments',
+            headers={'Content-Type': 'application/json'},
+            query={
+                'sort_direction': 'asc',
+                'limit': int_or_none(self._configuration_arg('max_comments', [''])[0]) or 120,
+            },
+            data=json.dumps({
+                'token': comment_access_token,
+                'group_id': comment_group_id,
+            }).encode('ascii'))
+
+        for comment in traverse_obj(comment_list, ...):
+            yield traverse_obj(comment, {
+                'author': ('nickname', {str}),
+                'author_id': ('sender_id', {str_or_none}),
+                'id': ('id', {str_or_none}),
+                'text': ('message', {str}),
+                'timestamp': (('updated_at', 'sent_at', 'created_at'), {unified_timestamp}),
+                'author_is_uploader': ('sender_id', {lambda x: x == '-1'}),
+            }, get_all=False)
+
+    def _get_live_status_and_session_id(self, content_code, data_json):
+        video_type = data_json.get('type')
+        live_finished_at = data_json.get('live_finished_at')
+
+        payload = {}
+        if video_type == 'vod':
+            if live_finished_at:
+                live_status = 'was_live'
+            else:
+                live_status = 'not_live'
+        elif video_type == 'live':
+            if not data_json.get('live_started_at'):
+                return 'is_upcoming', ''
+
+            if not live_finished_at:
+                live_status = 'is_live'
+            else:
+                live_status = 'was_live'
+                payload = {'broadcast_type': 'dvr'}
+
+                video_allow_dvr_flg = traverse_obj(data_json, ('video', 'allow_dvr_flg'))
+                video_convert_to_vod_flg = traverse_obj(data_json, ('video', 'convert_to_vod_flg'))
+
+                self.write_debug(f'allow_dvr_flg = {video_allow_dvr_flg}, convert_to_vod_flg = {video_convert_to_vod_flg}.')
+
+                if not (video_allow_dvr_flg and video_convert_to_vod_flg):
+                    raise ExtractorError(
+                        'Live was ended, there is no video for download.', video_id=content_code, expected=True)
+        else:
+            raise ExtractorError(f'Unknown type: {video_type}', video_id=content_code, expected=False)
+
+        self.write_debug(f'{content_code}: video_type={video_type}, live_status={live_status}')
+
+        session_id = self._call_api(
+            f'video_pages/{content_code}/session_ids', item_id=f'{content_code}/session',
+            data=json.dumps(payload).encode('ascii'), headers={
+                'Content-Type': 'application/json',
+                'fc_use_device': 'null',
+                'origin': 'https://nicochannel.jp',
+            },
+            note='Getting session id', errnote='Unable to get session id',
+        )['data']['session_id']
+
+        return live_status, session_id
+
+
+class NiconicoChannelPlusChannelBaseIE(NiconicoChannelPlusBaseIE):
+    _PAGE_SIZE = 12
+
+    def _fetch_paged_channel_video_list(self, path, query, channel_name, item_id, page):
+        response = self._call_api(
+            path, item_id, query={
+                **query,
+                'page': (page + 1),
+                'per_page': self._PAGE_SIZE,
+            },
+            headers={'fc_use_device': 'null'},
+            note=f'Getting channel info (page {page + 1})',
+            errnote=f'Unable to get channel info (page {page + 1})')
+
+        for content_code in traverse_obj(response, ('data', 'video_pages', 'list', ..., 'content_code')):
+            # "video/{content_code}" works for both VOD and live, but "live/{content_code}" doesn't work for VOD
+            yield self.url_result(
+                f'{self._WEBPAGE_BASE_URL}/{channel_name}/video/{content_code}', NiconicoChannelPlusIE)
+
+
+class NiconicoChannelPlusChannelVideosIE(NiconicoChannelPlusChannelBaseIE):
+    IE_NAME = 'NiconicoChannelPlus:channel:videos'
+    IE_DESC = 'ニコニコチャンネルプラス - チャンネル - 動画リスト. nicochannel.jp/channel/videos'
+    _VALID_URL = r'https?://nicochannel\.jp/(?P<id>[a-z\d\._-]+)/videos(?:\?.*)?'
+    _TESTS = [{
+        # query: None
+        'url': 'https://nicochannel.jp/testman/videos',
+        'info_dict': {
+            'id': 'testman-videos',
+            'title': '本番チャンネルプラステストマン-videos',
+        },
+        'playlist_mincount': 18,
+    }, {
+        # query: None
+        'url': 'https://nicochannel.jp/testtarou/videos',
+        'info_dict': {
+            'id': 'testtarou-videos',
+            'title': 'チャンネルプラステスト太郎-videos',
+        },
+        'playlist_mincount': 2,
+    }, {
+        # query: None
+        'url': 'https://nicochannel.jp/testjirou/videos',
+        'info_dict': {
+            'id': 'testjirou-videos',
+            'title': 'チャンネルプラステスト二郎-videos',
+        },
+        'playlist_mincount': 12,
+    }, {
+        # query: tag
+        'url': 'https://nicochannel.jp/testman/videos?tag=%E6%A4%9C%E8%A8%BC%E7%94%A8',
+        'info_dict': {
+            'id': 'testman-videos',
+            'title': '本番チャンネルプラステストマン-videos',
+        },
+        'playlist_mincount': 6,
+    }, {
+        # query: vodType
+        'url': 'https://nicochannel.jp/testman/videos?vodType=1',
+        'info_dict': {
+            'id': 'testman-videos',
+            'title': '本番チャンネルプラステストマン-videos',
+        },
+        'playlist_mincount': 18,
+    }, {
+        # query: sort
+        'url': 'https://nicochannel.jp/testman/videos?sort=-released_at',
+        'info_dict': {
+            'id': 'testman-videos',
+            'title': '本番チャンネルプラステストマン-videos',
+        },
+        'playlist_mincount': 18,
+    }, {
+        # query: tag, vodType
+        'url': 'https://nicochannel.jp/testman/videos?tag=%E6%A4%9C%E8%A8%BC%E7%94%A8&vodType=1',
+        'info_dict': {
+            'id': 'testman-videos',
+            'title': '本番チャンネルプラステストマン-videos',
+        },
+        'playlist_mincount': 6,
+    }, {
+        # query: tag, sort
+        'url': 'https://nicochannel.jp/testman/videos?tag=%E6%A4%9C%E8%A8%BC%E7%94%A8&sort=-released_at',
+        'info_dict': {
+            'id': 'testman-videos',
+            'title': '本番チャンネルプラステストマン-videos',
+        },
+        'playlist_mincount': 6,
+    }, {
+        # query: vodType, sort
+        'url': 'https://nicochannel.jp/testman/videos?vodType=1&sort=-released_at',
+        'info_dict': {
+            'id': 'testman-videos',
+            'title': '本番チャンネルプラステストマン-videos',
+        },
+        'playlist_mincount': 18,
+    }, {
+        # query: tag, vodType, sort
+        'url': 'https://nicochannel.jp/testman/videos?tag=%E6%A4%9C%E8%A8%BC%E7%94%A8&vodType=1&sort=-released_at',
+        'info_dict': {
+            'id': 'testman-videos',
+            'title': '本番チャンネルプラステストマン-videos',
+        },
+        'playlist_mincount': 6,
+    }]
+
+    def _real_extract(self, url):
+        """
+        API parameters:
+            sort:
+                -released_at         公開日が新しい順 (newest to oldest)
+                 released_at         公開日が古い順 (oldest to newest)
+                -number_of_vod_views 再生数が多い順 (most play count)
+                 number_of_vod_views コメントが多い順 (most comments)
+            vod_type (is "vodType" in "url"):
+                0 すべて (all)
+                1 会員限定 (members only)
+                2 一部無料 (partially free)
+                3 レンタル (rental)
+                4 生放送アーカイブ (live archives)
+                5 アップロード動画 (uploaded videos)
+        """
+
+        channel_id = self._match_id(url)
+        fanclub_site_id = self._find_fanclub_site_id(channel_id)
+        channel_name = self._get_channel_base_info(fanclub_site_id).get('fanclub_site_name')
+        qs = parse_qs(url)
+
+        return self.playlist_result(
+            OnDemandPagedList(
+                functools.partial(
+                    self._fetch_paged_channel_video_list, f'fanclub_sites/{fanclub_site_id}/video_pages',
+                    filter_dict({
+                        'tag': traverse_obj(qs, ('tag', 0)),
+                        'sort': traverse_obj(qs, ('sort', 0), default='-released_at'),
+                        'vod_type': traverse_obj(qs, ('vodType', 0), default='0'),
+                    }),
+                    channel_id, f'{channel_id}/videos'),
+                self._PAGE_SIZE),
+            playlist_id=f'{channel_id}-videos', playlist_title=f'{channel_name}-videos')
+
+
+class NiconicoChannelPlusChannelLivesIE(NiconicoChannelPlusChannelBaseIE):
+    IE_NAME = 'NiconicoChannelPlus:channel:lives'
+    IE_DESC = 'ニコニコチャンネルプラス - チャンネル - ライブリスト. nicochannel.jp/channel/lives'
+    _VALID_URL = r'https?://nicochannel\.jp/(?P<id>[a-z\d\._-]+)/lives'
+    _TESTS = [{
+        'url': 'https://nicochannel.jp/testman/lives',
+        'info_dict': {
+            'id': 'testman-lives',
+            'title': '本番チャンネルプラステストマン-lives',
+        },
+        'playlist_mincount': 18,
+    }, {
+        'url': 'https://nicochannel.jp/testtarou/lives',
+        'info_dict': {
+            'id': 'testtarou-lives',
+            'title': 'チャンネルプラステスト太郎-lives',
+        },
+        'playlist_mincount': 2,
+    }, {
+        'url': 'https://nicochannel.jp/testjirou/lives',
+        'info_dict': {
+            'id': 'testjirou-lives',
+            'title': 'チャンネルプラステスト二郎-lives',
+        },
+        'playlist_mincount': 6,
+    }]
+
+    def _real_extract(self, url):
+        """
+        API parameters:
+            live_type:
+                1 放送中 (on air)
+                2 放送予定 (scheduled live streams, oldest to newest)
+                3 過去の放送 - すべて (all ended live streams, newest to oldest)
+                4 過去の放送 - 生放送アーカイブ (all archives for live streams, oldest to newest)
+            We use "4" instead of "3" because some recently ended live streams could not be downloaded.
+        """
+
+        channel_id = self._match_id(url)
+        fanclub_site_id = self._find_fanclub_site_id(channel_id)
+        channel_name = self._get_channel_base_info(fanclub_site_id).get('fanclub_site_name')
+
+        return self.playlist_result(
+            OnDemandPagedList(
+                functools.partial(
+                    self._fetch_paged_channel_video_list, f'fanclub_sites/{fanclub_site_id}/live_pages',
+                    {
+                        'live_type': 4,
+                    },
+                    channel_id, f'{channel_id}/lives'),
+                self._PAGE_SIZE),
+            playlist_id=f'{channel_id}-lives', playlist_title=f'{channel_name}-lives')