Merge pull request #8 from sakkyoi/rewrite-architecture

Rewrite architecture

Author: sakkyoi

.github/workflows/main.yml

@@ -25,7 +25,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: 3.12
     - run: pip install -r requirements.txt pyinstaller Pillow
     - run: pyinstaller main.py --onefile --collect-data=grapheme --name=ncp-${{ matrix.name }}
     - run: ./dist/ncp-${{ matrix.name }} --help

README.md

@@ -1,7 +1,8 @@
-ncp-downloader is a tool to do network testing by download videos from a well-known video platform. 
+`ncp-downloader` is a tool for network performance testing by downloading videos from a well-known online video platform. 
 
 # Installation
-download the latest release from the [releases page](https://github.com/sakkyoi/ncp-downloader/releases/latest) and extract it.
+Download the latest release from the [Releases](https://github.com/sakkyoi/ncp-downloader/releases/latest) page
+and extract it to the directory of your choice on your local machine.
 
 # Usage
 `ncp QUERY [OUTPUT_DIR] [OPTIONS]`
@@ -11,28 +12,30 @@ QUERY is a URL of video or channel.
 ```
 -r RESOLUTION, --resolution RESOLUTION      Target resolution. Defaults to highest resolution.
 -R, --resume                                Resume download.
--e, --experimental                          Experimental download method.
 -t, --transcode                             Transcode video.
 --ffmpeg FFMPEG                             Path to ffmpeg. Defaults to ffmpeg in PATH.
 --vcodec VCODEC                             Video codec for transcoding.
 --acodec ACODEC                             Audio codec for transcoding.
 --ffmpeg-options FFMPEG_OPTIONS             Additional ffmpeg options. (e.g. --ffmpeg-options "-acodec copy -vcodec copy")
 --thread THREAD                             Number of threads for downloading. Defaults to 1. (highly not recommended)
+--select-manually                           Select video manually. This option only works with channel.
 --username USERNAME                         Username for login.
 --password PASSWORD                         Password for login.
 --debug                                     Enable debug mode.
 --help                                      Show help message.
 ```
-**If username and password are provided, a token will be generated and saved in the current directory. 
+
+**If login credentials are provided, a session token will be generated and saved locally.
 DO NOT SHARE THE TOKEN WITH ANYONE.**<br>
-Sometime this tool may not work properly, you can delete temp files and folder to make it re-download the video.
-(feel free to modify the json file when you know what you are doing)
+Sometimes this tool may not function properly, delete temp files and folder to make it re-download the video.<br>
+(Feel free to modify the .json file if you understand what you are doing.)
 
-## `This tool may cause account suspension or ban. Use it at your own risk.`
+## `Using this tool may lead to account suspension or ban. Use it at your own discretion.`
 
 # Disclaimer
 Please do use this tool responsibly and respect the rights of the content creators.<br>
-Every data downloaded using this tool should be for personal use only and should be just for network testing purposes.
+You should **ONLY** use this tool for network performance testing under any circumstances.<br>
+Data downloaded using this tool should be for personal use only. Obtain permission from the original creator before use.
 
 # License
 This project is licensed under the LGPLv3 License - see the [LICENSE](LICENSE) file for details.

api/api.py

@@ -77,7 +77,6 @@ def __init__(self, site_base: str, username: Optional[str], password: Optional[s
         self.api_public_status = f'{self.api_base}/video_pages/%s/public_status'  # content_code
         self.api_session_id = f'{self.api_base}/video_pages/%s/session_ids'  # content_code
         self.api_video_list = f'{self.api_base}/fanclub_sites/%s/video_pages?vod_type=%d&page=%d&per_page=%d&sort=%s'
-        self.api_views_comments = f'{self.api_base}/fanclub_sites/%s/views_comments'  # channel_id
         self.api_video_index = 'https://hls-auth.cloud.stream.co.jp/auth/index.m3u8?session_id=%s'  # session_id
 
     def __initial_api(self) -> Tuple[str, str, str]:
@@ -120,14 +119,6 @@ def list_channels(self) -> list:
         r = requests.get(self.api_channels, headers=self.headers)
         return r.json()['data']['content_providers']
 
-    def list_views_comments(self, channel_id: ChannelID) -> list:
-        """Get count of views and comments of channel from channel id \n
-        This api using different method to get video list \n
-        This api can set specific video, like ?content_codes[]=xxxxxx&content_codes[]=xxxxxx&..., \
-        but it's not implemented here"""
-        r = requests.get(self.api_views_comments % channel_id, headers=self.headers)
-        return r.json()['data']['video_aggregate_infos']
-
     def list_videos(self,
                     channel_id: ChannelID,
                     vod_type: int = 0,
@@ -145,11 +136,6 @@ def list_videos(self,
                 video_list += r.json()['data']['video_pages']['list']
         return video_list
 
-    def list_videos_x(self, channel_id: ChannelID) -> list:
-        """Get video list of channel from channel id by views and comments count list"""
-        views_comments = self.list_views_comments(channel_id)
-        return [ContentCode(video['content_code']) for video in views_comments]
-
     def list_lives(self, channel_id: str, live_type) -> list:
         """Get live list of channel from channel id"""
         # TODO: I'm lazy, and who cares about it?

main.py

@@ -1,18 +1,22 @@
 import sys
+import platform
 
 import click
-from click import confirm
+import inquirer
 import typer
 from typing_extensions import Annotated
 from typing import Optional
-from rich.console import Console
 from urllib.parse import urlparse
 from pathlib import Path
+import pylibimport
 
 from api.api import NCP, ContentCode
 from util.ffmpeg import FFMPEG
 from util.m3u8_downloader import M3U8Downloader
 from util.channel_downloader import ChannelDownloader
+from util.progress import ProgressManager
+
+__import__('util.inquirer_console_render')  # hook for inquirer console render
 
 
 class Resolution(click.ParamType):
@@ -71,14 +75,6 @@ def main(
                 help='Resume download.',
             ),
         ] = None,
-        experimental: Annotated[
-            Optional[bool],
-            typer.Option(
-                '--experimental/--normal', '-e/-ne',
-                show_default=False,
-                help='Experimental download method',
-            ),
-        ] = None,
         yes: Annotated[
             Optional[bool],
             typer.Option(
@@ -130,9 +126,17 @@ def main(
             typer.Option(
                 '--thread',
                 show_default=True,
-                help='Number of threads.',
+                help='Number of threads. Be careful with this option.',
             ),
         ] = 1,
+        select_manually: Annotated[
+            bool,
+            typer.Option(
+                '--select-manually',
+                show_default=False,
+                help='Select which video to download manually. This option only works with channel.',
+            ),
+        ] = False,
         username: Annotated[
             str,
             typer.Option(
@@ -157,10 +161,8 @@ def main(
         ] = False,
 ) -> None:
     """The NCP Downloader"""
-    err_console = Console(stderr=True)
-
-    # nico
-    nico = NCP(urlparse(query).netloc, username, password)
+    api_client = NCP(urlparse(query).netloc, username, password)
+    progress_manager = ProgressManager()
 
     try:
         # Check ffmpeg if transcode is enabled
@@ -170,60 +172,83 @@ def main(
 
         # If yes is enabled, skip all confirmation
         if yes:
-            experimental = resume = yes
+            resume = yes
 
         # tell user multithreading is dengerous
-        if (thread > 1 and
-                not confirm('Download with multithreading may got you banned from Server. Continue?', default=False)):
-            raise RuntimeError('Aborted.')
+        # can not be skipped by --yes
+        if thread > 1:
+            with progress_manager.pause():
+                if inquirer.prompt([inquirer.List('thread',
+                                                  message='Multithreading is dangerous, are you sure to continue?',
+                                                  choices=['Yes', 'No'], default='No')],
+                                   raise_keyboard_interrupt=True)['thread'] == 'No':
+                    raise RuntimeError('Aborted.')
 
         # Check if query is channel or video
-        if nico.get_channel_id(query) is None:
+        if api_client.get_channel_id(query) is None:
             query = urlparse(query).path.strip('/').split('/')[-1]
-            session_id = nico.get_session_id(ContentCode(query))
+            session_id = api_client.get_session_id(ContentCode(query))
 
             # Check if video exists
             if session_id is None:
                 raise ValueError('Video not found or permission denied.')
 
-            output_name, _ = nico.get_video_name(ContentCode(query))
+            output_name, _ = api_client.get_video_name(ContentCode(query))
 
             output = str(Path(output).joinpath(output_name))
 
-            M3U8Downloader(nico, session_id, output, resolution, resume, transcode,
-                           ffmpeg, vcodec, acodec, ffmpeg_options, thread)
+            with progress_manager:
+                m3u8_downloader = M3U8Downloader(api_client, progress_manager, session_id, output, resolution, resume,
+                                                 transcode, ffmpeg, vcodec, acodec, ffmpeg_options, thread)
+                if not m3u8_downloader.start():
+                    raise RuntimeError('Failed to download video.')
         else:
+            # warning for downloading whole channel if --yes is not set
             if not yes:
-                if not confirm('Sure to download whole channel?', default=True):
-                    raise RuntimeError('Aborted.')
-
-            if experimental is None:
-                experimental = confirm('Using experimental download method?', default=True)
+                with progress_manager.pause():
+                    if inquirer.prompt([
+                        inquirer.List('channel', message='Sure to download whole channel?',
+                                      choices=['Sure', 'No'], default='No')
+                    ], raise_keyboard_interrupt=True)['channel'] == 'No':
+                        raise RuntimeError('Aborted.')
 
             # Get channel infomation
-            channel_id = nico.get_channel_id(query)
-            channel_name = nico.get_channel_info(channel_id)['fanclub_site_name']
+            channel_id = api_client.get_channel_id(query)
+            channel_name = api_client.get_channel_info(channel_id)['fanclub_site_name']
 
             # Get video list
-            if experimental:
-                video_list = nico.list_videos_x(channel_id)
-            else:
-                video_list = nico.list_videos(channel_id)
-                video_list = [ContentCode(video['content_code']) for video in video_list]
+            video_list = api_client.list_videos(channel_id)
+            video_list = [ContentCode(video['content_code']) for video in video_list]
 
             output = str(Path(output).joinpath(channel_name))
 
-            ChannelDownloader(nico, channel_id, video_list, output, resolution, resume,
-                              transcode, ffmpeg, vcodec, acodec, ffmpeg_options, thread)
+            with progress_manager:
+                channel_downloader = ChannelDownloader(api_client, progress_manager, channel_id, video_list, output,
+                                                       resolution, resume,
+                                                       transcode, ffmpeg, vcodec, acodec, ffmpeg_options,
+                                                       thread, select_manually)
+                channel_downloader.start()
     except Exception as e:
         # Raise exception again if debug is enabled
         if debug:
             raise e
         # Print error message and exit if debug is disabled
         else:
-            err_console.print(f'[red]{e}[/red]')
+            progress_manager.live.console.print(f'{e}', style='red')
             sys.exit(1)
 
 
 if __name__ == "__main__":
+    # find all the .pyd(win) or .so(linux and macos), files in the current directory
+    if platform.system() == 'Windows':
+        pyds = Path('.').glob('*.pyd')
+    elif platform.system() == 'Linux' or platform.system() == 'Darwin':
+        pyds = Path('.').glob('*.so')
+    else:
+        raise RuntimeError('Unsupported platform')
+
+    # import all the .pyd or .so files
+    for pyd in pyds:
+        pylibimport.import_module(pyd.stem)
+
     typer.run(main)

requirements.txt

@@ -2,9 +2,11 @@ click==8.1.7
 requests==2.32.3
 m3u8==5.1.0
 pycryptodome==3.19.1
-alive-progress==3.1.5
+inquirer==3.3.0
 tinydb==4.8.0
 pathvalidate==3.2.0
 typer[all]==0.12.3
 rich==13.7.1
-pyjwt==2.8.0
+pyjwt==2.8.0
+setuptools==72.1.0
+pylibimport==1.9.2