devmate 1.0.0__py3-none-any.whl

devmate/core/config.py

@@ -0,0 +1,115 @@
+"""配置管理——Pydantic + YAML + 环境变量"""
+
+import os
+from pathlib import Path
+from typing import Any
+
+import yaml
+from pydantic import BaseModel
+from pydantic_settings import BaseSettings
+
+# ── 路径常量 ─────────────────────────────────────────
+DEVMATE_HOME = Path.home() / ".devmate"
+CONFIG_PATH = DEVMATE_HOME / "config.yml"
+DATA_PATH = DEVMATE_HOME / "data.db"
+VAULT_PATH = DEVMATE_HOME / "vault"
+LOG_PATH = DEVMATE_HOME / "devmate.log"
+AUDIT_PATH = DEVMATE_HOME / "audit.log"
+EVENT_STORE_PATH = DEVMATE_HOME / "event_store"
+
+
+# ── 安全配置 ─────────────────────────────────────────
+class SafetyConfig(BaseModel):
+    confirm_sensitive: bool = True
+    require_password_for_vault: bool = True
+    auto_lock_minutes: int = 30
+    password_min_length: int = 8
+    require_special_char: bool = True
+
+
+# ── Web 配置 ─────────────────────────────────────────
+class AuthConfig(BaseModel):
+    mode: str = "local"  # local | oauth | token
+    session_expire_hours: int = 24
+    refresh_token: bool = True
+
+
+class WebConfig(BaseModel):
+    host: str = "127.0.0.1"
+    port: int = 8600
+    auth: AuthConfig = AuthConfig()
+
+
+# ── 审计配置 ─────────────────────────────────────────
+class AuditConfig(BaseModel):
+    enabled: bool = True
+    log_path: str = str(AUDIT_PATH)
+    levels: list[str] = ["SENSITIVE", "HIGH"]
+    hash_chain: bool = False
+
+
+# ── 根配置 ───────────────────────────────────────────
+class DevMateConfig(BaseSettings):
+    """应用配置——从 config.yml + 环境变量加载"""
+
+    theme: str = "dark"
+    default_editor: str = os.environ.get("EDITOR", "vim")
+    db_path: str = str(DATA_PATH)
+
+    web: WebConfig = WebConfig()
+    safety: SafetyConfig = SafetyConfig()
+    audit: AuditConfig = AuditConfig()
+
+    model_config = {"arbitrary_types_allowed": True}
+
+    @classmethod
+    def load(cls) -> "DevMateConfig":
+        """加载配置：默认值 → config.yml → 环境变量"""
+        DEVMATE_HOME.mkdir(parents=True, exist_ok=True)
+
+        config = cls()
+
+        if CONFIG_PATH.exists():
+            with open(CONFIG_PATH) as f:
+                raw = yaml.safe_load(f) or {}
+            config = cls(**raw.get("devmate", {}))
+
+        # 确保配置目录和文件存在
+        _ensure_dirs()
+        _ensure_config_file(config)
+
+        return config
+
+    def save(self):
+        """保存当前配置到文件"""
+        with open(CONFIG_PATH, "w") as f:
+            yaml.dump({"devmate": self.model_dump()}, f, default_flow_style=False)
+
+    def get(self, key: str, default: Any = None) -> Any:
+        """按点号路径取值，如 'web.auth.mode'"""
+        parts = key.split(".")
+        value = self
+        for part in parts:
+            if isinstance(value, dict):
+                value = value.get(part)
+            else:
+                value = getattr(value, part, None)
+            if value is None:
+                return default
+        return value
+
+
+def _ensure_dirs():
+    """确保数据目录存在"""
+    for d in [VAULT_PATH, EVENT_STORE_PATH]:
+        d.mkdir(parents=True, exist_ok=True)
+
+
+def _ensure_config_file(config: DevMateConfig):
+    """确保配置文件存在"""
+    if not CONFIG_PATH.exists():
+        config.save()
+
+
+# ── 全局实例 ─────────────────────────────────────────
+config: DevMateConfig = DevMateConfig.load()

devmate/core/logging.py

@@ -0,0 +1,54 @@
+"""结构化日志系统——JSON Lines 格式"""
+
+import json
+import logging
+import sys
+from datetime import UTC, datetime
+from pathlib import Path
+from typing import Any
+
+from devmate.core.config import LOG_PATH
+
+
+class JsonFormatter(logging.Formatter):
+    """JSON Lines 日志格式化器"""
+
+    def format(self, record: logging.LogRecord) -> str:
+        log_entry: dict[str, Any] = {
+            "timestamp": datetime.now(UTC).isoformat(),
+            "level": record.levelname,
+            "module": record.name,
+            "message": record.getMessage(),
+        }
+        if record.exc_info and record.exc_info[0]:
+            log_entry["exception"] = self.formatException(record.exc_info)
+        if hasattr(record, "extra_fields"):
+            log_entry.update(record.extra_fields)
+        return json.dumps(log_entry, ensure_ascii=False)
+
+
+def setup_logger(name: str = "devmate", level: str = "INFO") -> logging.Logger:
+    """初始化日志系统"""
+    logger = logging.getLogger(name)
+    logger.setLevel(getattr(logging, level.upper(), logging.INFO))
+
+    # 控制台输出（人类可读）
+    console_handler = logging.StreamHandler(sys.stderr)
+    console_handler.setFormatter(logging.Formatter(
+        "%(asctime)s [%(levelname)s] %(name)s: %(message)s",
+        datefmt="%H:%M:%S",
+    ))
+    logger.addHandler(console_handler)
+
+    # 文件输出（JSON Lines）
+    log_path = Path(LOG_PATH)
+    log_path.parent.mkdir(parents=True, exist_ok=True)
+    file_handler = logging.FileHandler(log_path, encoding="utf-8")
+    file_handler.setFormatter(JsonFormatter())
+    logger.addHandler(file_handler)
+
+    return logger
+
+
+# ── 全局日志实例 ─────────────────────────────────────
+logger = setup_logger()

devmate/core/security.py

@@ -0,0 +1,61 @@
+"""安全基础——三级权限模型 + 敏感操作确认装饰器"""
+
+import functools
+from collections.abc import Callable
+from enum import StrEnum
+from typing import Any
+
+import click
+
+
+class PermissionLevel(StrEnum):
+    """三级权限模型"""
+    SAFE = "safe"
+    SENSITIVE = "sensitive"
+    HIGH = "high"
+
+
+# ── 敏感操作确认装饰器 ────────────────────────────────
+
+def confirm(message: str = "确认执行此操作？", level: PermissionLevel = PermissionLevel.SENSITIVE):
+    """敏感操作确认装饰器
+
+    用法：
+        @confirm("即将删除数据库，确认？", level=PermissionLevel.HIGH)
+        def delete_database(name: str): ...
+    """
+    def decorator(func: Callable) -> Callable:
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            if level == PermissionLevel.SENSITIVE:
+                click.confirm(message, abort=True)
+            elif level == PermissionLevel.HIGH:
+                click.confirm(f"⚠️ 高危操作：{message}", abort=True)
+            return func(*args, **kwargs)
+        return wrapper
+    return decorator
+
+
+# ── 敏感字段脱敏 ──────────────────────────────────────
+
+SENSITIVE_KEYS = {"key", "secret", "password", "token", "credential", "api_key"}
+
+
+def sanitize(value: Any, key: str = "") -> Any:
+    """脱敏敏感字段值"""
+    if any(k in key.lower() for k in SENSITIVE_KEYS):
+        if isinstance(value, str) and len(value) > 8:
+            return value[:4] + "****" + value[-4:]
+        return "****"
+    return value
+
+
+def sanitize_dict(data: dict) -> dict:
+    """递归脱敏字典中的敏感字段"""
+    result = {}
+    for k, v in data.items():
+        if isinstance(v, dict):
+            result[k] = sanitize_dict(v)
+        else:
+            result[k] = sanitize(v, k)
+    return result

devmate/events/__init__.py

@@ -0,0 +1 @@
+"""Event system — Domain events, EventBus"""

devmate/events/bus.py

@@ -0,0 +1,97 @@
+"""
+事件总线——内存版 EventBus + subscribe/emit
+
+设计：
+  - 内存版：进程内 pub/sub，Phase 2 升级为持久化 Event Store
+  - 支持通配符订阅：on("toolkit.*") 匹配所有 toolkit 事件
+  - publish() 先写入 Event Store，再通知内存订阅者
+"""
+
+import re
+from collections.abc import Callable
+from typing import Any
+
+from devmate.core.logging import logger
+from devmate.events.domain_event import DomainEvent
+
+# ── 事件处理函数类型 ────────────────────────────────
+
+EventHandler = Callable[[DomainEvent], Any]
+
+
+# ── 事件总线 ─────────────────────────────────────────
+
+class EventBus:
+    """内存版事件总线——支持通配符订阅"""
+
+    def __init__(self):
+        self._handlers: dict[str, list[EventHandler]] = {}
+        self._history: list[DomainEvent] = []
+
+    # ── 订阅 ────────────────────────────────────
+
+    def on(self, event_pattern: str):
+        """装饰器：订阅事件，支持通配符
+
+        用法：
+            @bus.on("toolkit.*")
+            def handler(event): ...
+        """
+        def decorator(handler: EventHandler) -> EventHandler:
+            self.subscribe(event_pattern, handler)
+            return handler
+        return decorator
+
+    def subscribe(self, event_pattern: str, handler: EventHandler):
+        """订阅事件（直接调用方式）"""
+        self._handlers.setdefault(event_pattern, []).append(handler)
+
+    # ── 发布 ────────────────────────────────────
+
+    def publish(self, event: DomainEvent):
+        """发布事件——通知所有匹配的订阅者"""
+        self._history.append(event)
+
+        for pattern, handlers in self._handlers.items():
+            if not self._matches(pattern, event.event_name):
+                continue
+            for handler in handlers:
+                try:
+                    handler(event)
+                except Exception as e:
+                    logger.error(f"事件处理器失败 [{pattern}]: {e}")
+
+    # ── 通配符匹配 ──────────────────────────────
+
+    @staticmethod
+    def _matches(pattern: str, event_name: str) -> bool:
+        """判断事件名是否匹配模式
+
+        支持通配符：
+          "toolkit.*"       → 匹配所有 toolkit 事件
+          "*.organized"     → 匹配所有 organized 事件
+          "note.created"    → 精确匹配
+        """
+        if pattern == "*":
+            return True
+        if pattern == event_name:
+            return True
+        if "*" in pattern:
+            regex = "^" + re.escape(pattern).replace("\\*", ".*") + "$"
+            return bool(re.match(regex, event_name))
+        return False
+
+    # ── 历史 ────────────────────────────────────
+
+    def recent(self, limit: int = 20) -> list[DomainEvent]:
+        """最近 N 条事件"""
+        return self._history[-limit:]
+
+    @property
+    def event_count(self) -> int:
+        return len(self._history)
+
+
+# ── 全局总线实例 ─────────────────────────────────────
+
+bus = EventBus()

devmate/events/domain_event.py

@@ -0,0 +1,37 @@
+"""
+领域事件数据类——Event + EventMetadata
+
+事件是模块间通信的核心载体。任何"发生了某件事"都用一个
+DomainEvent 表示，通过 EventBus 发布给所有订阅者。
+
+模块之间不直接 import，通过事件解耦。
+"""
+
+from dataclasses import dataclass, field
+from datetime import UTC, datetime
+from typing import Any
+
+
+@dataclass
+class EventMetadata:
+    """事件元数据——追踪事件的来源和链路"""
+    source_module: str = ""              # 来源模块
+    source_endpoint: str = "CLI"         # CLI / TUI / Web / VSCODE
+    user: str = ""                       # 触发用户
+    session_id: str = ""                 # 会话追踪 ID
+    correlation_id: str = ""             # 关联 ID（跨事件追踪）
+
+
+@dataclass
+class DomainEvent:
+    """领域事件——代表系统中发生的一件事
+
+    event_name 命名规范：<module>.<action>
+    例如："toolkit.organized"、"db.query_executed"、"note.created"
+    """
+    event_name: str                      # "toolkit.organized"
+    data: dict[str, Any] = field(default_factory=dict)
+    aggregate_type: str = ""             # 聚合类型
+    aggregate_id: str = ""               # 聚合 ID
+    timestamp: datetime = field(default_factory=lambda: datetime.now(UTC))
+    metadata: EventMetadata = field(default_factory=EventMetadata)

devmate/module/__init__.py

@@ -0,0 +1 @@
+"""Module system — Registry, Meta, Lifecycle"""

devmate/module/registry.py

@@ -0,0 +1,74 @@
+"""模块系统——ModuleMeta / ModuleManifest / ModuleRegistry"""
+
+from __future__ import annotations
+
+import importlib.metadata
+from dataclasses import dataclass, field
+from enum import StrEnum
+from typing import Any
+
+
+class LoadState(StrEnum):
+    PENDING = "pending"
+    LOADING = "loading"
+    ACTIVE = "active"
+    ERROR = "error"
+    DISABLED = "disabled"
+
+
+@dataclass
+class ModuleMeta:
+    """模块元数据——在导入模块之前就可用"""
+    name: str
+    version: str = "0.1.0"
+    description: str = ""
+    author: str = ""
+    dependencies: list[str] = field(default_factory=list)
+    optional_deps: list[str] = field(default_factory=list)
+    tags: list[str] = field(default_factory=list)
+    devmate_version: str = ">=0.1"
+    python_version: str = ">=3.11"
+
+
+@dataclass
+class ModuleManifest:
+    """模块运行时清单"""
+    meta: ModuleMeta
+    cli_group: Any = None           # click.Group
+    load_state: LoadState = LoadState.PENDING
+    error: str | None = None
+
+
+class ModuleRegistry:
+    """模块注册中心——通过 entry_points 发现模块"""
+
+    def __init__(self):
+        self._modules: dict[str, ModuleManifest] = {}
+
+    def discover(self):
+        """通过 entry_points 扫描已安装模块"""
+        for ep in importlib.metadata.entry_points(group="devmate.modules"):
+            name = ep.name
+            manifest = ModuleManifest(
+                meta=ModuleMeta(name=name, description=ep.value),
+                load_state=LoadState.PENDING,
+            )
+            self._modules[name] = manifest
+
+    def get(self, name: str) -> ModuleManifest | None:
+        return self._modules.get(name)
+
+    def list(self) -> list[ModuleManifest]:
+        return list(self._modules.values())
+
+    @property
+    def active_modules(self) -> list[ModuleManifest]:
+        return [m for m in self._modules.values() if m.load_state == LoadState.ACTIVE]
+
+    @property
+    def module_names(self) -> list[str]:
+        return list(self._modules.keys())
+
+
+# ── 全局注册表实例 ─────────────────────────────────
+registry = ModuleRegistry()

devmate/security/audit.py

@@ -0,0 +1,96 @@
+"""
+audit — 审计日志模块
+
+审计日志记录所有敏感级及以上操作，格式 JSON Lines，
+存储到 ~/.devmate/audit.log。
+
+每条审计记录包含：
+  - 时间戳（ISO 8601）
+  - 操作级别（SAFE / SENSITIVE / HIGH）
+  - 模块名
+  - 操作名
+  - 操作目标
+  - 执行结果
+  - 耗时
+  - 来源（CLI / TUI / Web）
+  - 用户
+"""
+
+import json
+from dataclasses import asdict, dataclass, field
+from datetime import UTC, datetime
+from pathlib import Path
+
+from devmate.core.config import AUDIT_PATH
+
+# ── 审计条目 ──────────────────────────────────────────
+
+@dataclass
+class AuditEntry:
+    """单条审计记录"""
+    timestamp: str = field(default_factory=lambda: datetime.now(UTC).isoformat())
+    level: str = "SAFE"                  # SAFE / SENSITIVE / HIGH
+    module: str = ""                     # 触发模块
+    action: str = ""                     # 触发动作
+    target: str = ""                     # 操作目标
+    result: str = "success"              # success / failure
+    duration_ms: float | None = None     # 执行耗时
+    source: str = "CLI"                  # 来源终端
+    user: str = ""                       # 系统用户
+    detail: str = ""                     # 补充信息
+
+
+# ── 审计日志 ──────────────────────────────────────────
+
+class AuditLog:
+    """审计日志——JSON Lines 追加写入"""
+
+    def __init__(self, path: str | Path = AUDIT_PATH):
+        self._path = Path(path)
+        self._path.parent.mkdir(parents=True, exist_ok=True)
+
+    def log(self, entry: AuditEntry):
+        """写入一条审计记录"""
+        line = json.dumps(asdict(entry), ensure_ascii=False) + "\n"
+        with open(self._path, "a", encoding="utf-8") as f:
+            f.write(line)
+
+    def query(self, level: str | None = None,
+              module: str | None = None,
+              limit: int = 50) -> list[AuditEntry]:
+        """查询审计记录，按时间倒序"""
+        if not self._path.exists():
+            return []
+
+        results: list[AuditEntry] = []
+        with open(self._path, encoding="utf-8") as f:
+            for line in f:
+                line = line.strip()
+                if not line:
+                    continue
+                data = json.loads(line)
+                entry = AuditEntry(**data)
+
+                if level and entry.level != level:
+                    continue
+                if module and entry.module != module:
+                    continue
+
+                results.append(entry)
+
+        # 倒序（最新的在前面）
+        results.reverse()
+        return results[:limit]
+
+    @property
+    def count(self) -> int:
+        """审计记录总数"""
+        if not self._path.exists():
+            return 0
+        with open(self._path, encoding="utf-8") as f:
+            return sum(1 for line in f if line.strip())
+
+
+# ── 全局实例 ──────────────────────────────────────────
+
+audit = AuditLog()