suggest file path in backup/fileset

Fallen-Breath · Fallen-Breath · commit 7e3cec800a11 · 2025-12-09T02:59:22.000+08:00
diff --git a/lang/en_us.yml b/lang/en_us.yml
@@ -186,6 +186,10 @@ prime_backup:
       done: 'Deleted file {1} in backup {0}, freed {2}'
     db_get_fileset_ids:
       name: get fileset id list
+    db_get_backup_file_paths:
+      name: get backup file path list
+    db_get_fileset_file_paths:
+      name: get fileset file path list
     db_inspect_backup:
       name: inspect backup
       title: 'Backup {}'
diff --git a/lang/zh_cn.yml b/lang/zh_cn.yml
@@ -186,6 +186,10 @@ prime_backup:
       done: '已删除备份{0}中的文件{1}, 共释放{2}'
     db_get_fileset_ids:
       name: 获取文件集ID列表
+    db_get_backup_file_paths:
+      name: 获取备份的文件路径列表
+    db_get_fileset_file_paths:
+      name: 获取文件集的文件路径列表
     db_inspect_backup:
       name: 审查备份
       title: '备份{}'
diff --git a/prime_backup/mcdr/command/commands.py b/prime_backup/mcdr/command/commands.py
@@ -11,7 +11,7 @@
 from prime_backup.compressors import CompressMethod
 from prime_backup.config.config import Config
 from prime_backup.mcdr.command.nodes import DateNode, IdRangeNode, HexStringNode, JsonObjectNode, BackupIdNode, MultiBackupIdNode
-from prime_backup.mcdr.command.value_suggestor import BackupIdSuggestor, FilesetIdSuggestor
+from prime_backup.mcdr.command.value_suggestor import ValueSuggesters
 from prime_backup.mcdr.crontab_job import CrontabJobEvent, CrontabJobId
 from prime_backup.mcdr.crontab_manager import CrontabManager
 from prime_backup.mcdr.task.backup.create_backup_task import CreateBackupTask
@@ -62,8 +62,7 @@ def __init__(self, server: PluginServerInterface, task_manager: TaskManager, cro
 		self.server = server
 		self.task_manager = task_manager
 		self.crontab_manager = crontab_manager
-		self.backup_id_suggestor = BackupIdSuggestor(task_manager)
-		self.fileset_id_suggestor = FilesetIdSuggestor(task_manager)
+		self.value_suggesters = ValueSuggesters(task_manager)
 		self.config = Config.get()
 		self.__state = CommandManagerState.INITIAL
 		self.__root_node = Literal(self.config.command.prefix)
@@ -94,13 +93,13 @@ def backup_id_consumer(backup_id: int):
 
 	def cmd_db_inspect_backup_file(self, source: CommandSource, context: CommandContext):
 		def backup_id_consumer(backup_id: int):
-			file_path = context['file_path']
+			file_path = context['backup_file_path']
 			self.task_manager.add_task(InspectBackupFileTask(source, backup_id, file_path))
 		self.transform_backup_id(source, context['backup_id'], backup_id_consumer)
 
 	def cmd_db_inspect_fileset_file(self, source: CommandSource, context: CommandContext):
 		fileset_id = context['fileset_id']
-		file_path = context['file_path']
+		file_path = context['fileset_file_path']
 		self.task_manager.add_task(InspectFilesetFileTask(source, fileset_id, file_path))
 
 	def cmd_db_inspect_fileset(self, source: CommandSource, context: CommandContext):
@@ -113,7 +112,7 @@ def cmd_db_inspect_blob(self, source: CommandSource, context: CommandContext):
 
 	def cmd_db_delete_file(self, source: CommandSource, context: CommandContext):
 		def backup_id_consumer(backup_id: int):
-			file_path = context['file_path']
+			file_path = context['backup_file_path']
 			needs_confirm = context.get('confirm', 0) == 0
 			recursive = context.get('recursive', 0) > 0
 			self.task_manager.add_task(DeleteBackupFileTask(source, backup_id, file_path, needs_confirm=needs_confirm, recursive=recursive))
@@ -280,11 +279,17 @@ def backup_id_consumer(backup_id: int):
 	def suggest_backup_id(self, source: CommandSource) -> List[str]:
 		return [
 			*BackupIdNode.get_command_suggestions(),
-			*map(str, self.backup_id_suggestor.suggest(source)),
+			*self.value_suggesters.suggest_backup_id(source),
 		]
 
 	def suggest_fileset_id(self, source: CommandSource) -> List[str]:
-		return [str(fileset_id) for fileset_id in self.fileset_id_suggestor.suggest(source)]
+		return self.value_suggesters.suggest_fileset_id(source)
+
+	def suggest_backup_file_path(self, source: CommandSource, ctx: CommandContext) -> List[str]:
+		return self.value_suggesters.suggest_backup_file_path(source, ctx['backup_id'])
+
+	def suggest_fileset_file_path(self, source: CommandSource, ctx: CommandContext) -> List[str]:
+		return self.value_suggesters.suggest_fileset_file_path(source, ctx['fileset_id'])
 
 	def __transform_backup_id_impl(self, source: CommandSource, backup_id_raw: Union[str, List[str]], csm: Union[Callable[[int], Any], Callable[[List[int]], Any]]):
 		if isinstance(backup_id_raw, str):
@@ -357,6 +362,12 @@ def create_backup_id(arg_name: str = 'backup_id', clazz: Type[ArgumentNode] = Ba
 		def create_fileset_id(arg_name: str) -> ArgumentNode:
 			return Integer(arg_name).suggests(self.suggest_fileset_id)
 
+		def create_backup_file_path(arg_name: str) -> ArgumentNode:
+			return QuotableText(arg_name).suggests(self.suggest_backup_file_path)
+
+		def create_fileset_file_path(arg_name: str) -> ArgumentNode:
+			return QuotableText(arg_name).suggests(self.suggest_fileset_file_path)
+
 		# --------------- simple commands ---------------
 
 		builder = SimpleCommandBuilder()
@@ -395,8 +406,8 @@ def create_fileset_id(arg_name: str) -> ArgumentNode:
 		builder.command('database', lambda src: self.cmd_help(src, {'what': 'database'}))
 		builder.command('database overview', self.cmd_db_overview)
 		builder.command('database inspect backup <backup_id>', self.cmd_db_inspect_backup)
-		builder.command('database inspect file <backup_id> <file_path>', self.cmd_db_inspect_backup_file)
-		builder.command('database inspect file2 <fileset_id> <file_path>', self.cmd_db_inspect_fileset_file)
+		builder.command('database inspect file <backup_id> <backup_file_path>', self.cmd_db_inspect_backup_file)
+		builder.command('database inspect file2 <fileset_id> <fileset_file_path>', self.cmd_db_inspect_fileset_file)
 		builder.command('database inspect fileset <fileset_id>', self.cmd_db_inspect_fileset)
 		builder.command('database inspect blob <blob_hash>', self.cmd_db_inspect_blob)
 		builder.command('database validate all', functools.partial(self.cmd_db_validate, parts=ValidatePart.all()))
@@ -408,10 +419,11 @@ def create_fileset_id(arg_name: str) -> ArgumentNode:
 		builder.command('database prune', self.cmd_db_prune)
 		builder.command('database migrate_compress_method <compress_method>', self.cmd_db_migrate_compress_method)
 		builder.command('database migrate_hash_method <hash_method>', self.cmd_db_migrate_hash_method)
-		# `database delete file <backup_id> <file_path>` is handled by `make_db_delete_file_cmd()` below
+		# `database delete file <backup_id> <backup_file_path>` is handled by `make_db_delete_file_cmd()` below
 
-		builder.arg('file_path', QuotableText)  # Notes: it's actually a redefine
 		builder.arg('fileset_id', create_fileset_id)  # not that necessary to provide suggestion here
+		builder.arg('backup_file_path', create_backup_file_path)  # not that necessary to provide suggestion here
+		builder.arg('fileset_file_path', create_fileset_file_path)  # not that necessary to provide suggestion here
 		builder.arg('blob_hash', HexStringNode)
 		builder.arg('compress_method', lambda n: Enumeration(n, CompressMethod))
 		builder.arg('hash_method', lambda n: Enumeration(n, HashMethod))
@@ -541,7 +553,7 @@ def make_tag_cmd() -> Literal:
 		def make_db_delete_file_cmd():
 			__locate_node(['database']).then(Literal('delete').then(node_subcommand := Literal('file')))
 			node_bid = create_backup_id()
-			node_file_path = QuotableText('file_path').runs(self.cmd_db_delete_file)
+			node_file_path = create_backup_file_path('backup_file_path').runs(self.cmd_db_delete_file)
 			node_subcommand.then(node_bid)
 			node_bid.then(node_file_path)
 			for node in [node_bid, node_file_path]:
diff --git a/prime_backup/mcdr/command/value_suggestor.py b/prime_backup/mcdr/command/value_suggestor.py
@@ -3,41 +3,58 @@
 from abc import abstractmethod, ABC
 from typing import Optional, Generic, TypeVar, List
 
-from mcdreforged.api.all import CommandSource
+from mcdreforged.api.all import CommandSource, CommandContext
 from typing_extensions import override
 
 from prime_backup import logger
 from prime_backup.mcdr.task.backup.get_backup_ids_task import GetBackupIdsTask
 from prime_backup.mcdr.task.basic_task import LightTask
+from prime_backup.mcdr.task.db.get_backup_file_paths_task import GetBackupFilePathsTask
+from prime_backup.mcdr.task.db.get_fileset_file_paths_task import GetFilesetFilePathsTask
 from prime_backup.mcdr.task.db.get_fileset_ids_task import GetFilesetIdsTask
 from prime_backup.mcdr.task_manager import TaskManager
 from prime_backup.mcdr.task_queue import TaskQueue
+from prime_backup.utils import misc_utils
 from prime_backup.utils.waitable_value import WaitableValue
 
 _T = TypeVar('_T')
+_P = TypeVar('_P')
 
 
-class ValueSuggestor(ABC, Generic[_T]):
+class ValueSuggestor(ABC, Generic[_T, _P]):
 	def __init__(self, task_manager: TaskManager):
 		self.task_manager = task_manager
 		self.logger = logger.get()
 		self.lock = threading.Lock()
 		self.last_future: WaitableValue[_T] = WaitableValue()
-		self.last_future.set(self._create_fallback())
 		self.current_future: WaitableValue[_T] = WaitableValue()
-		self.current_future.set(self._create_fallback())
+		self.current_task_key: str = ''
 		self.last_fetch_time = 0
+		self.__reset()
 
 	@abstractmethod
 	def _create_fallback(self) -> _T:
 		...
 
 	@abstractmethod
-	def _create_value_task(self, source: CommandSource) -> LightTask[_T]:
+	def _create_value_task(self, source: CommandSource, arg: _P) -> LightTask[_T]:
+		...
+
+	@abstractmethod
+	def _compute_task_key(self, source: CommandSource, arg: _P) -> str:
 		...
 
-	def request(self, source: CommandSource) -> WaitableValue[_T]:
+	def __reset(self):
+		self.last_future.set(self._create_fallback())
+		self.current_future.set(self._create_fallback())
+
+	def request(self, source: CommandSource, arg: _P) -> WaitableValue[_T]:
 		with self.lock:
+			task_key = self._compute_task_key(source, arg)
+			if task_key != self.current_task_key:
+				self.__reset()
+			self.current_task_key = task_key
+
 			if not self.current_future.is_set():
 				return self.last_future
 
@@ -54,7 +71,7 @@ def callback(result: Optional[_T], err: Optional[Exception]):
 
 			self.last_fetch_time = now
 			wv = WaitableValue()
-			task = self._create_value_task(source)
+			task = self._create_value_task(source, arg)
 			try:
 				self.task_manager.add_task(task, callback, handle_tmo_err=False)
 			except TaskQueue.TooManyOngoingTask:
@@ -64,28 +81,94 @@ def callback(result: Optional[_T], err: Optional[Exception]):
 				self.current_future = wv
 				return wv
 
-	def suggest(self, source: CommandSource, timeout: float = 0.2) -> _T:
-		wv = self.request(source)
+	def suggest(self, source: CommandSource, arg: _P, timeout: float = 0.2) -> _T:
+		wv = self.request(source, arg)
 		if wv.wait(timeout) == WaitableValue.EMPTY:
 			return self._create_fallback()
 		return wv.get()
 
 
-class BackupIdSuggestor(ValueSuggestor[List[int]]):
+class BackupIdSuggestor(ValueSuggestor[List[int], None]):
 	@override
 	def _create_fallback(self) -> List[int]:
 		return []
 
 	@override
-	def _create_value_task(self, source: CommandSource) -> LightTask[List[int]]:
+	def _create_value_task(self, source: CommandSource, ctx: CommandContext) -> LightTask[List[int]]:
 		return GetBackupIdsTask(source)
 
+	@override
+	def _compute_task_key(self, source: CommandSource, ctx: CommandContext) -> str:
+		return ''
+
 
-class FilesetIdSuggestor(ValueSuggestor[List[int]]):
+class FilesetIdSuggestor(ValueSuggestor[List[int], None]):
 	@override
 	def _create_fallback(self) -> List[int]:
 		return []
 
 	@override
-	def _create_value_task(self, source: CommandSource) -> LightTask[List[int]]:
+	def _create_value_task(self, source: CommandSource, ctx: CommandContext) -> LightTask[List[int]]:
 		return GetFilesetIdsTask(source)
+
+	@override
+	def _compute_task_key(self, source: CommandSource, ctx: CommandContext) -> str:
+		return ''
+
+
+class BackupFilePathSuggestor(ValueSuggestor[List[str], int]):
+	@override
+	def _create_fallback(self) -> List[str]:
+		return []
+
+	@override
+	def _create_value_task(self, source: CommandSource, backup_id_arg: str) -> LightTask[List[str]]:
+		return GetBackupFilePathsTask(source, backup_id_arg)
+
+	@override
+	def _compute_task_key(self, source: CommandSource, backup_id_arg: str) -> str:
+		return backup_id_arg
+
+	@override
+	def suggest(self, source: CommandSource, backup_id: int, timeout: float = 0.2) -> _T:
+		return super().suggest(source, backup_id, timeout)
+
+
+class FilesetFilePathSuggestor(ValueSuggestor[List[str], int]):
+	@override
+	def _create_fallback(self) -> List[str]:
+		return []
+
+	@override
+	def _create_value_task(self, source: CommandSource, fileset_id: int) -> LightTask[List[str]]:
+		return GetFilesetFilePathsTask(source, fileset_id)
+
+	@override
+	def _compute_task_key(self, source: CommandSource, fileset_id: int) -> str:
+		return str(fileset_id)
+
+	@override
+	def suggest(self, source: CommandSource, fileset_id: int, timeout: float = 0.2) -> _T:
+		return super().suggest(source, fileset_id, timeout)
+
+
+class ValueSuggesters:
+	def __init__(self, task_manager: TaskManager):
+		self.backup_id_suggestor = BackupIdSuggestor(task_manager)
+		self.fileset_id_suggestor = FilesetIdSuggestor(task_manager)
+		self.backup_file_path_suggestor = BackupFilePathSuggestor(task_manager)
+		self.fileset_file_path_suggestor = FilesetFilePathSuggestor(task_manager)
+
+	def suggest_backup_id(self, source: CommandSource) -> List[str]:
+		return [str(backup_id) for backup_id in self.backup_id_suggestor.suggest(source, None)]
+
+	def suggest_fileset_id(self, source: CommandSource) -> List[str]:
+		return [str(fileset_id) for fileset_id in self.fileset_id_suggestor.suggest(source, None)]
+
+	def suggest_backup_file_path(self, source: CommandSource, backup_id_arg: str) -> List[str]:
+		misc_utils.ensure_type(backup_id_arg, str)
+		return self.backup_file_path_suggestor.suggest(source, backup_id_arg)
+
+	def suggest_fileset_file_path(self, source: CommandSource, fileset_id: int) -> List[str]:
+		misc_utils.ensure_type(fileset_id, int)
+		return self.fileset_file_path_suggestor.suggest(source, fileset_id)
diff --git a/prime_backup/mcdr/task/db/get_backup_file_paths_task.py b/prime_backup/mcdr/task/db/get_backup_file_paths_task.py
@@ -0,0 +1,28 @@
+from typing import List, Union
+
+from mcdreforged.api.all import CommandSource
+from typing_extensions import override
+
+from prime_backup.action.get_file_action import GetBackupFilesAction
+from prime_backup.mcdr.task.backup.transform_backup_id_task import TransformBackupIdTask
+from prime_backup.mcdr.task.basic_task import LightTask
+
+
+class GetBackupFilePathsTask(LightTask[List[str]]):
+	def __init__(self, source: CommandSource, backup_id: Union[int, str]):
+		super().__init__(source)
+		self.backup_id = backup_id
+
+	@property
+	@override
+	def id(self) -> str:
+		return 'db_get_backup_file_paths'
+
+	@override
+	def run(self) -> List[str]:
+		if isinstance(self.backup_id, int):
+			backup_id = self.backup_id
+		else:  # backup id raw argument
+			backup_id = TransformBackupIdTask(self.source, [self.backup_id]).run()[0]
+		file_dict = GetBackupFilesAction(backup_id).run()
+		return list(file_dict.keys())
diff --git a/prime_backup/mcdr/task/db/get_fileset_file_paths_task.py b/prime_backup/mcdr/task/db/get_fileset_file_paths_task.py
@@ -0,0 +1,23 @@
+from typing import List
+
+from mcdreforged.api.all import CommandSource
+from typing_extensions import override
+
+from prime_backup.action.get_file_action import GetFilesetFilesAction
+from prime_backup.mcdr.task.basic_task import LightTask
+
+
+class GetFilesetFilePathsTask(LightTask[List[str]]):
+	def __init__(self, source: CommandSource, fileset_id: int):
+		super().__init__(source)
+		self.fileset_id = fileset_id
+
+	@property
+	@override
+	def id(self) -> str:
+		return 'db_get_fileset_file_paths'
+
+	@override
+	def run(self) -> List[str]:
+		file_dict = GetFilesetFilesAction(self.fileset_id).run()
+		return list(file_dict.keys())
