Skip to content

armgit / peach

Public Imported from GitHub
0

Peach: Local-first video metadata scraper and media manager.

feat(media): 统一挂载来源与目录代理流量保护策略

longmeidao27f1f6c75865
diff --git a/resources/media-sources.json b/resources/media-sources.json
new file mode 100644
index 000000000..ffea3f7d1
--- /dev/null
+++ b/resources/media-sources.json
@@ -0,0 +1,8 @@
+[
+ {"id":"local","name":"本地磁盘","label":"本地磁盘","default_cost":"free","cloud":false,"read_only":false,"icon":"hard-drive"},
+ {"id":"115","name":"115","label":"CloudDrive · 115","default_cost":"free","cloud":true,"read_only":false,"icon":"database"},
+ {"id":"pikpak","name":"PikPak","label":"CloudDrive · PikPak","default_cost":"metered","cloud":true,"read_only":false,"icon":"database"},
+ {"id":"guangya","name":"光鸭云盘","label":"光鸭云盘","default_cost":"free","cloud":true,"read_only":true,"icon":"database"},
+ {"id":"onedrive","name":"OneDrive","label":"OneDrive","default_cost":"metered","cloud":true,"read_only":true,"icon":"database"},
+ {"id":"mounted","name":"其他已挂载网盘","label":"其他已挂载网盘","default_cost":"metered","cloud":true,"read_only":true,"icon":"database"}
+]
diff --git a/src/peach/media_configuration.py b/src/peach/media_configuration.py
index 0cbf2a0e1..09b280442 100644
--- a/src/peach/media_configuration.py
+++ b/src/peach/media_configuration.py
@@ -7,9 +7,7 @@ import sys
from typing import Any
from . import platform
-
-SOURCE_OPTIONS = (("local", "本地磁盘"), ("115", "CloudDrive · 115"),
- ("pikpak", "CloudDrive · PikPak"), ("guangya", "CloudDrive · 光鸭云盘(只读)"))
+from .media_sources import SOURCE_OPTIONS, cost_for
def _windows_installed_names() -> list[str]:
@@ -61,6 +59,7 @@ def rows(config, *, windows: bool, probe: bool = False) -> list[dict[str, Any]]:
result.append({"location": location, "root": root, "path": mount,
"library": config.library_names.get(root) or PureWindowsPath(root).name or root,
"library_icon": config.library_icons.get(root, ""),
+ "cost": cost_for(location, root, config),
"online": platform.root_online(Path(mount)) if probe and mount else False})
return result
@@ -79,7 +78,9 @@ def validate(raws: object, *, windows: bool) -> tuple[dict, dict, list[str]]:
raise ValueError("媒体来源格式不正确")
location = row.get("location")
if not isinstance(location, str) or location not in dict(SOURCE_OPTIONS):
- raise ValueError("请选择本地磁盘、115、PikPak 或光鸭云盘")
+ raise ValueError("请选择列表中的媒体来源")
+ if "cost" in row and row["cost"] not in ("free", "metered"):
+ raise ValueError("请选择代理流量保护设置")
text = str(row.get("path", "")).strip()
root = text if windows else str(row.get("root", "")).strip()
if any(ord(char) < 32 for char in text + root):
@@ -107,3 +108,15 @@ def validate(raws: object, *, windows: bool) -> tuple[dict, dict, list[str]]:
return ({key: tuple(value) for key, value in locations.items()},
{key: tuple(value) for key, value in mounts.items()},
errors if any(errors) else [])
+
+
+def costs(raws: list[dict], config, *, windows: bool) -> dict[str, str]:
+ """为已校验的媒体行保存声明根保护设置。"""
+ result = dict(config.media_costs)
+ for row in raws:
+ root = str(PureWindowsPath(row["path"] if windows else row["root"]))
+ for previous in tuple(result):
+ if PureWindowsPath(previous) == PureWindowsPath(root):
+ del result[previous]
+ result[root] = row.get("cost", cost_for(row["location"], root, config))
+ return result
diff --git a/src/peach/media_sources.py b/src/peach/media_sources.py
index d59f0b9ac..4054b1598 100644
--- a/src/peach/media_sources.py
+++ b/src/peach/media_sources.py
@@ -1,11 +1,91 @@
-"""挂载来源的读取与文件写入能力。"""
+"""挂载来源能力与按声明根配置的代理流量保护。"""
+from dataclasses import dataclass
+import json
+from pathlib import PureWindowsPath
+import re
-SCANNABLE_LOCATIONS = ("local", "115", "pikpak", "guangya")
-CLOUD_LOCATIONS = frozenset({"115", "pikpak", "guangya"})
-READ_ONLY_LOCATIONS = frozenset({"guangya"})
+from .settings_file import PROJECT_ROOT
+
+
+@dataclass(frozen=True)
+class MediaSource:
+ id: str
+ name: str
+ label: str
+ default_cost: str
+ cloud: bool
+ read_only: bool
+ icon: str
+
+
+SOURCE_REGISTRY = tuple(MediaSource(**row) for row in json.loads(
+ (PROJECT_ROOT / "resources" / "media-sources.json").read_text(encoding="utf-8")))
+SOURCES = {source.id: source for source in SOURCE_REGISTRY}
+SOURCE_OPTIONS = tuple((source.id, source.label + ("(只读)" if source.read_only else ""))
+ for source in SOURCE_REGISTRY)
+SOURCE_COSTS = {source.id: source.default_cost for source in SOURCE_REGISTRY}
+SCANNABLE_LOCATIONS = tuple(SOURCES)
+CLOUD_LOCATIONS = frozenset(source.id for source in SOURCE_REGISTRY if source.cloud)
+READ_ONLY_LOCATIONS = frozenset(source.id for source in SOURCE_REGISTRY if source.read_only)
+
+
+def _config(config):
+ if config is None:
+ from .settings_file import active
+ return active()
+ return config
+
+
+def _root_key(path: str) -> str:
+ # 与 SQLite COLLATE NOCASE 一致;路径只比较,不访问挂载。
+ return str(PureWindowsPath(path)).rstrip("\\").translate(
+ str.maketrans("ABCDEFGHIJKLMNOPQRSTUVWXYZ", "abcdefghijklmnopqrstuvwxyz"))
+
+
+def _root_costs(config):
+ overrides = {_root_key(root): cost for root, cost in config.media_costs.items()}
+ return sorted(((location, str(PureWindowsPath(root)),
+ overrides.get(_root_key(root), SOURCE_COSTS.get(location, "metered")))
+ for location, roots in config.locations.items() for root in roots),
+ key=lambda row: len(_root_key(row[1])), reverse=True)
+
+
+def cost_for(location: str, path: str = "", config=None) -> str:
+ """实际路径按最长声明根取保护设置;空路径聚合同来源的已配置根。"""
+ roots = [row for row in _root_costs(_config(config)) if row[0] == location]
+ if not path and roots:
+ return "metered" if any(cost == "metered" for _, _, cost in roots) else "free"
+ key = _root_key(path) if path else ""
+ for _, root, cost in roots:
+ declared = _root_key(root)
+ if key == declared or key.startswith(declared + "\\"):
+ return cost
+ return SOURCE_COSTS.get(location, "metered")
+
+
+def cost_sql(location_column: str = "location", path_column: str = "path", *, config=None) -> tuple[str, tuple]:
+ """返回求值为 free/metered 的参数化 CASE;NULL/空路径使用来源聚合值。"""
+ for column in (location_column, path_column):
+ if not re.fullmatch(r"[A-Za-z_]\w*(?:\.[A-Za-z_]\w*)?", column, flags=re.ASCII):
+ raise ValueError("成本查询列名不正确")
+ config = _config(config)
+ clauses, parameters = [], []
+ for location in config.locations:
+ clauses.append(f"WHEN {location_column}=? AND COALESCE({path_column},'')='' THEN ?")
+ parameters.extend((location, cost_for(location, config=config)))
+ for location, root, cost in _root_costs(config):
+ root = root.rstrip("\\")
+ prefix = root + "\\"
+ clauses.append(f"WHEN {location_column}=? AND ({path_column}=? COLLATE NOCASE "
+ f"OR substr({path_column},1,?)=? COLLATE NOCASE) THEN ?")
+ parameters.extend((location, root, len(prefix), prefix, cost))
+ for location, cost in SOURCE_COSTS.items():
+ clauses.append(f"WHEN {location_column}=? THEN ?")
+ parameters.extend((location, cost))
+ return "CASE " + " ".join(clauses) + " ELSE 'metered' END", tuple(parameters)
def require_writable_location(location: str | None) -> None:
"""只读挂载在任何文件系统写入之前拒绝。"""
if location in READ_ONLY_LOCATIONS:
- raise ValueError("光鸭云盘为只读来源,请在光鸭云盘客户端管理文件")
+ raise ValueError(f"{SOURCES[location].name}为只读来源,请在网盘客户端管理文件")
diff --git a/src/peach/settings_file.py b/src/peach/settings_file.py
index 3832f76b7..99e1a9d5c 100644
--- a/src/peach/settings_file.py
+++ b/src/peach/settings_file.py
@@ -229,6 +229,7 @@ class PeachConfig:
mounts: dict[str, tuple[str, ...]] = field(default_factory=dict)
library_names: dict[str, str] = field(default_factory=dict)
library_icons: dict[str, str] = field(default_factory=dict)
+ media_costs: dict[str, str] = field(default_factory=dict)
#: `asset.location` -> 账本口径的声明根,至少一个。
locations: dict[str, tuple[str, ...]] = field(
default_factory=lambda: dict(DEFAULT_LOCATION_ROOTS))
@@ -355,7 +356,7 @@ def _merge(
raise _fail(path, "`directories` 里有不认识的键:" + "、".join(unknown))
media = _table(document, "media", path)
- stray = sorted(set(media) - {_LOCATIONS_KEY, _MOUNTS_KEY, "libraries", "library_icons"})
+ stray = sorted(set(media) - {_LOCATIONS_KEY, _MOUNTS_KEY, "libraries", "library_icons", "costs"})
if stray:
# 第一阶段的 `[media] R = '/Volumes/RESOURCES'`。键空间从盘符换成了 location ID,
# 把它当未知键忽略等于「所有来源都没挂」——整台机器安静地进脱盘模式。
@@ -438,11 +439,15 @@ def _merge(
tunnel_table, "hostname", tunnel_defaults.hostname, path, "tunnel."),
)
+ media_costs = _string_map(_table(media, "costs", path), path, "media.costs.")
+ if any(cost not in {"free", "metered"} for cost in media_costs.values()):
+ raise _fail(path, "`[media.costs]` 只接受 free 或 metered")
config = PeachConfig(
data_root=data_root, path=path, present=present, data_root_found=found,
directories=directories, mounts=mounts, locations=locations,
library_names=_string_map(_table(media, "libraries", path), path, "media.libraries."),
library_icons=_string_map(_table(media, "library_icons", path), path, "media.library_icons."),
+ media_costs=media_costs,
server=server, replication=replication, tunnel=tunnel,
)
return _apply_environment(config, environ)
@@ -610,6 +615,8 @@ def render(config: PeachConfig) -> str:
"# 不认识的值忽略:只含一个来源的馆藏回落到该来源的图标,跨来源的用 database。",
]
lines += [f"{_render_value(root)} = {_render_value(icon)}" for root, icon in config.library_icons.items()]
+ lines += ["", "[media.costs]", "# 声明根 -> 代理流量保护。free 关闭,metered 开启。"]
+ lines += [f"{_render_value(root)} = {_render_value(cost)}" for root, cost in config.media_costs.items()]
lines += [
"",
"[media.mounts]",
diff --git a/tests/test_guangya_sources.py b/tests/test_guangya_sources.py
index e52be457d..c1e6172b7 100644
--- a/tests/test_guangya_sources.py
+++ b/tests/test_guangya_sources.py
@@ -9,7 +9,7 @@ from unittest.mock import Mock, patch
from peach import media_configuration, onboarding, organize, resource_identification, settings_file
from peach import web_batch, web_catalog, web_organize, web_resource_sync
-from peach.media_sources import READ_ONLY_LOCATIONS, SCANNABLE_LOCATIONS
+from peach.media_sources import READ_ONLY_LOCATIONS, SCANNABLE_LOCATIONS, cost_for
from support.ledger import fresh_ledger
@@ -45,10 +45,10 @@ class GuangyaSourceTests(unittest.TestCase):
self.assertEqual(answers.media_sources[0]["location"], "guangya")
self.assertIn("只读", dict(media_configuration.SOURCE_OPTIONS)["guangya"])
- def test_guangya_is_scannable_metered_and_read_only(self):
+ def test_guangya_is_scannable_free_and_read_only(self):
self.assertIn("guangya", SCANNABLE_LOCATIONS)
self.assertIn("guangya", READ_ONLY_LOCATIONS)
- self.assertEqual(web_catalog.COST["guangya"], "metered")
+ self.assertEqual(cost_for("guangya"), "free")
with patch.object(web_resource_sync, "LOCATION_ROOT_DECLARATIONS", {"guangya": ("G:/",)}):
self.assertEqual(web_resource_sync.configured_resource_locations(), ("guangya",))
diff --git a/tests/test_media_sources.py b/tests/test_media_sources.py
new file mode 100644
index 000000000..62ad6c6b2
--- /dev/null
+++ b/tests/test_media_sources.py
@@ -0,0 +1,100 @@
+"""挂载来源注册表、配置保护与 SQL/逐项求值的一致性。"""
+from dataclasses import replace
+from pathlib import Path
+import sqlite3
+import tempfile
+import unittest
+
+from peach import media_configuration, media_sources, settings_file
+
+
+class MediaSourceCostTests(unittest.TestCase):
+ def setUp(self):
+ self.tmp = tempfile.TemporaryDirectory()
+ self.addCleanup(self.tmp.cleanup)
+ self.root = Path(self.tmp.name).resolve()
+ self.config = replace(settings_file.PeachConfig(self.root, self.root / "config.toml"),
+ locations={"guangya": ("G:/Movies", "G:/Movies/Direct"),
+ "onedrive": ("O:/Public", "O:/Private"), "mounted": ("M:/",)},
+ media_costs={"g:/movies": "metered", "G:/Movies/Direct": "free", "O:/Public": "free"})
+
+ def test_registry_has_mount_only_read_only_sources_and_proxy_defaults(self):
+ self.assertTrue({"onedrive", "guangya", "mounted"}.issubset(media_sources.READ_ONLY_LOCATIONS))
+ self.assertEqual(media_sources.SOURCE_COSTS["guangya"], "free")
+ self.assertEqual(media_sources.SOURCE_COSTS["115"], "free")
+ self.assertEqual(media_sources.SOURCE_COSTS["pikpak"], "metered")
+ self.assertEqual(media_sources.SOURCE_COSTS["onedrive"], "metered")
+ roots, _, errors = media_configuration.validate([
+ {"location": "onedrive", "path": "O:/", "cost": "free"},
+ {"location": "mounted", "path": "M:/", "cost": "metered"}], windows=True)
+ self.assertEqual(errors, [])
+ self.assertEqual(set(roots), {"onedrive", "mounted"})
+ for location in ("onedrive", "mounted"):
+ with self.assertRaisesRegex(ValueError, "只读"):
+ media_sources.require_writable_location(location)
+
+ def test_longest_root_directory_boundary_and_unknown_paths(self):
+ cases = [
+ ("guangya", "G:\\Movies\\film.mp4", "metered"),
+ ("guangya", "g:\\movies\\Direct\\film.mp4", "free"),
+ ("guangya", "G:\\MoviesOther\\film.mp4", "free"),
+ ("onedrive", "O:\\Public\\film.mp4", "free"),
+ ("onedrive", "O:\\Private\\film.mp4", "metered"),
+ ("onedrive", "O:\\Outside\\film.mp4", "metered"),
+ ("mounted", "M:\\film.mp4", "metered"),
+ ("unknown", "X:\\film.mp4", "metered"),
+ ("local", "R:\\film.mp4", "free"),
+ ("115", "B:\\film.mp4", "free"),
+ ]
+ expression, params = media_sources.cost_sql("a.location", "a.path", config=self.config)
+ with sqlite3.connect(":memory:") as connection:
+ for location, path, expected in cases:
+ with self.subTest(location=location, path=path):
+ actual = media_sources.cost_for(location, path, self.config)
+ result = connection.execute(
+ f"SELECT {expression} FROM (SELECT ? AS location, ? AS path) a",
+ (*params, location, path)).fetchone()[0]
+ self.assertEqual((actual, result), (expected, expected))
+
+ def test_null_and_empty_paths_aggregate_configured_root_protection(self):
+ config = replace(self.config, media_costs={"G:/Movies": "free", "G:/Movies/Direct": "free",
+ "O:/Public": "free", "O:/Private": "metered", "M:/": "free"})
+ expression, params = media_sources.cost_sql(config=config)
+ with sqlite3.connect(":memory:") as connection:
+ for location, expected in (("guangya", "free"), ("onedrive", "metered"), ("mounted", "free")):
+ for path in (None, ""):
+ result = connection.execute(
+ f"SELECT {expression} FROM (SELECT ? AS location, ? AS path)",
+ (*params, location, path)).fetchone()[0]
+ self.assertEqual(result, expected)
+ self.assertEqual(media_sources.cost_for(location, config=config), expected)
+
+ def test_sql_expression_can_filter_assets_with_bound_parameters(self):
+ expression, params = media_sources.cost_sql(config=self.config)
+ with sqlite3.connect(":memory:") as connection:
+ connection.execute("CREATE TABLE asset(location TEXT,path TEXT)")
+ connection.executemany("INSERT INTO asset VALUES(?,?)", [
+ ("onedrive", "O:\\Public\\film.mp4"), ("onedrive", "O:\\Private\\film.mp4")])
+ rows = connection.execute(f"SELECT path FROM asset WHERE ({expression})=?",
+ (*params, "free")).fetchall()
+ self.assertEqual(rows, [("O:\\Public\\film.mp4",)])
+
+ def test_config_roundtrip_preserves_root_overrides_and_effective_form_cost(self):
+ settings_file.write(self.config)
+ loaded = settings_file.load_config(environ={"PEACH_DATA_ROOT": str(self.root)})
+ self.assertEqual(loaded.media_costs, self.config.media_costs)
+ rows = media_configuration.rows(loaded, windows=True)
+ self.assertEqual([row["cost"] for row in rows], ["metered", "free", "free", "metered", "metered"])
+ costs = media_configuration.costs([{"location": "guangya", "path": "G:/Movies", "cost": "free"}],
+ loaded, windows=True)
+ self.assertEqual(costs["G:\\Movies"], "free")
+
+ def test_invalid_cost_values_are_rejected_without_filesystem_work(self):
+ for value in (True, "proxy", [], None):
+ self.assertTrue(media_configuration.validate([
+ {"location": "onedrive", "path": "O:/", "cost": value}], windows=True)[2])
+ settings_file.write(replace(self.config, media_costs={"G:/": "unknown"}))
+ with self.assertRaisesRegex(settings_file.SettingsFileError, "free.*metered"):
+ settings_file.load_config(environ={"PEACH_DATA_ROOT": str(self.root)})
+ with self.assertRaisesRegex(ValueError, "列名"):
+ media_sources.cost_sql("a.location; DROP TABLE asset", config=self.config)