cli command add init

Author: Fallen-Breath

docs/cli.md

@@ -10,7 +10,7 @@ You can run it with a valid Python 3 interpreter, provided all requirements are
 ```
 $ python3 PrimeBackup.pyz
 usage: PrimeBackup.pyz [-h] [-d DB] [-c CONFIG] [--version] [--debug]
-                       {back,overview,export,extract,fuse,import,list,make,migrate_db,show}
+                       {back,overview,export,extract,fuse,import,init,list,make,migrate_db,show}
                        ...
 
 Prime Backup v1.x.x CLI tools
@@ -29,7 +29,7 @@ options:
   --debug               Enable debug logging (default: False)
 
 Command:
-  {back,overview,export,extract,fuse,import,list,make,migrate_db,show}
+  {back,overview,export,extract,fuse,import,init,list,make,migrate_db,show}
                         Available commands
     back                Restore the server files to a backup
     overview            Show overview information of the database
@@ -40,6 +40,7 @@ Command:
                         needs to have a backup metadata file
                         '.prime_backup.meta.json', or the --auto-meta option
                         need to be supplied
+    init                Initialize a new database at the directory given by --db
     list                List backups
     make                Create a new backup
     migrate_db          Migrate the database to the current version X

docs/cli.zh.md

@@ -10,7 +10,7 @@ Prime Backup 的 `*.pyz` 文件除了是一个 MCDR 插件外，也是一个命
 ```
 $ python3 PrimeBackup.pyz
 usage: PrimeBackup.pyz [-h] [-d DB] [-c CONFIG] [--version] [--debug]
-                       {back,overview,export,extract,fuse,import,list,make,migrate_db,show}
+                       {back,overview,export,extract,fuse,import,init,list,make,migrate_db,show}
                        ...
 
 Prime Backup v1.x.x CLI tools
@@ -29,7 +29,7 @@ options:
   --debug               Enable debug logging (default: False)
 
 Command:
-  {back,overview,export,extract,fuse,import,list,make,migrate_db,show}
+  {back,overview,export,extract,fuse,import,init,list,make,migrate_db,show}
                         Available commands
     back                Restore the server files to a backup
     overview            Show overview information of the database
@@ -40,6 +40,7 @@ Command:
                         needs to have a backup metadata file
                         '.prime_backup.meta.json', or the --auto-meta option
                         need to be supplied
+    init                Initialize a new database at the directory given by --db
     list                List backups
     make                Create a new backup
     migrate_db          Migrate the database to the current version X

prime_backup/cli/cli_entrypoint.py

@@ -10,6 +10,7 @@
 from prime_backup.cli.cmd.cmd_extract import ExtractCommandAdapter
 from prime_backup.cli.cmd.cmd_fuse import FuseCommandAdapter
 from prime_backup.cli.cmd.cmd_import import ImportCommandAdapter
+from prime_backup.cli.cmd.cmd_init import InitCommandAdapter
 from prime_backup.cli.cmd.cmd_list import ListCommandAdapter
 from prime_backup.cli.cmd.cmd_make import MakeCommandAdapter
 from prime_backup.cli.cmd.cmd_migrate_db import MigrateDbCommandAdapter
@@ -48,6 +49,7 @@ def __create_command_adapters(cls) -> Dict[str, CliCommandAdapterBase]:
 			ExtractCommandAdapter(),
 			FuseCommandAdapter(),
 			ImportCommandAdapter(),
+			InitCommandAdapter(),
 			ListCommandAdapter(),
 			MakeCommandAdapter(),
 			MigrateDbCommandAdapter(),

prime_backup/cli/cmd/__init__.py

@@ -39,30 +39,42 @@ def init_environment(self, db_path: Path, *, migrate: bool = False, config_path:
 		if root_path.is_file() and root_path.name == db_constants.DB_FILE_NAME:
 			root_path = root_path.parent
 
+		config = self.load_config(root_path, config_path)
+		set_config_instance(config)
+
+		if not (dbf := root_path / db_constants.DB_FILE_NAME).is_file():
+			self.logger.error('Database file {!r} does not exist'.format(dbf.as_posix()))
+			ErrorReturnCodes.invalid_argument.sys_exit()
+		self.init_db(root_path, create=False, migrate=migrate)
+
+	@classmethod
+	def load_config(cls, root_path: Path, config_path: Optional[Path]) -> Config:
 		if config_path is None:
 			auto_config_path = root_path.parent / 'config' / 'prime_backup' / 'config.json'
 			if auto_config_path.is_file():
-				config = self.__load_config(auto_config_path)
-				self.logger.info('Config file auto-detected and loaded from {!r}'.format(auto_config_path.as_posix()))
+				config = cls.__load_config(auto_config_path)
+				logger.get().info('Config file auto-detected and loaded from {!r}'.format(auto_config_path.as_posix()))
 			else:
 				config = Config.get_default()
-				self.logger.info('Config file not provided; auto-detected path {!r} does not exist, using default config'.format(auto_config_path.as_posix()))
+				logger.get().info('Config file not provided; auto-detected path {!r} does not exist, using default config'.format(auto_config_path.as_posix()))
 		else:
-			config = self.__load_config(config_path)
-			self.logger.info('Config file loaded from {!r}'.format(config_path.as_posix()))
-
-		set_config_instance(config)
+			config = cls.__load_config(config_path)
+			logger.get().info('Config file loaded from {!r}'.format(config_path.as_posix()))
+		return config
 
-		if not (dbf := root_path / db_constants.DB_FILE_NAME).is_file():
-			self.logger.error('Database file {!r} does not exist'.format(dbf.as_posix()))
+	def init_db(self, root_path: Path, *, create: bool, migrate: bool):
+		if root_path.is_file():
+			self.logger.error('Storage root {!r} is a file'.format(root_path.as_posix()))
 			ErrorReturnCodes.invalid_argument.sys_exit()
+
+		config = Config.get()
 		config.storage_root = str(root_path.as_posix())
 
 		self.logger.info('Storage root set to {!r}'.format(config.storage_root))
 		try:
 			if DbAccess.is_initialized():
 				DbAccess.shutdown()
-			DbAccess.init(create=False, migrate=migrate)
+			DbAccess.init(create=create, migrate=migrate)
 		except BadDbVersion as e:
 			self.logger.info('Load database failed, you need to ensure the database is accessible with MCDR plugin: {}'.format(e))
 			ErrorReturnCodes.action_failed.sys_exit()

prime_backup/cli/cmd/cmd_init.py

@@ -0,0 +1,65 @@
+import argparse
+import dataclasses
+from pathlib import Path
+
+from typing_extensions import override
+
+from prime_backup.action.get_db_overview_action import GetDbOverviewAction
+from prime_backup.cli.cmd import CliCommandHandlerBase, CommonCommandArgs, CliCommandAdapterBase
+from prime_backup.cli.return_codes import ErrorReturnCodes
+from prime_backup.config.config import set_config_instance
+from prime_backup.db import db_constants
+from prime_backup.db.access import DbAccess
+
+
+@dataclasses.dataclass(frozen=True)
+class InitCommandArgs(CommonCommandArgs):
+	pass
+
+
+class InitCommandHandler(CliCommandHandlerBase):
+	def __init__(self, args: InitCommandArgs):
+		super().__init__()
+		self.args = args
+
+	def handle(self):
+		root_path = self.args.db_path
+		if root_path.name == db_constants.DB_FILE_NAME and not root_path.is_dir():
+			self.logger.error('The init command expects --db to be the database parent directory, not the database file path {!r}'.format(root_path.as_posix()))
+			ErrorReturnCodes.invalid_argument.sys_exit()
+
+		db_file_path = root_path / db_constants.DB_FILE_NAME
+		if db_file_path.exists():
+			self.logger.error('Database file {!r} already exists'.format(db_file_path.as_posix()))
+			ErrorReturnCodes.invalid_argument.sys_exit()
+
+		config = self.load_config(root_path, self.args.config_path)
+		set_config_instance(config)
+		self.init_db(root_path, create=True, migrate=False)
+
+		result = GetDbOverviewAction().run()
+		self.logger.info('Database initialized at {!r}, current DB version: {}'.format(DbAccess.get_db_file_path().as_posix(), result.db_version))
+
+
+class InitCommandAdapter(CliCommandAdapterBase):
+	@property
+	@override
+	def command(self) -> str:
+		return 'init'
+
+	@property
+	@override
+	def description(self) -> str:
+		return 'Initialize a new database at the directory given by --db'
+
+	@override
+	def build_parser(self, parser: argparse.ArgumentParser):
+		pass
+
+	@override
+	def run(self, args: argparse.Namespace):
+		handler = InitCommandHandler(InitCommandArgs(
+			db_path=Path(args.db),
+			config_path=Path(args.config) if args.config is not None else None,
+		))
+		handler.handle()