chore(typing): snapshot local pinyin WIP before syncing cloud branch

Preserve the in-progress local typing/pinyin implementation so feat/pinyin can safely reset to origin/feat/pinyin (cloud English + Chinese typing).
2026-08-03 13:14:01 +08:00
parent c037be3654
commit d1e5fed964
58 changed files with 370539 additions and 121 deletions
@@ -0,0 +1,169 @@
+// RimeResourceInstaller.swift
+// OSGKeyboard · Shared
+//
+// The host app owns Rime deployment. The keyboard extension only opens
+// an already-built session, keeping expensive maintenance work out of
+// the extension's constrained lifecycle.
+
+import Foundation
+import Darwin
+
+public enum RimeResourceError: LocalizedError {
+    case appGroupUnavailable
+    case bundledResourceMissing(String)
+    case lockUnavailable
+    case deploymentFailed
+    case resourcesNotInstalled
+
+    public var errorDescription: String? {
+        switch self {
+        case .appGroupUnavailable:
+            return "App Group 不可用"
+        case .bundledResourceMissing(let name):
+            return "缺少输入法资源：\(name)"
+        case .lockUnavailable:
+            return "输入法资源正在被其他进程更新"
+        case .deploymentFailed:
+            return "输入法资源部署失败"
+        case .resourcesNotInstalled:
+            return "请先打开 OSGKeyboard 完成输入法初始化"
+        }
+    }
+}
+
+public struct RimeResourcePaths: Sendable {
+    public let root: URL
+    public let sharedData: URL
+    public let userData: URL
+    public let lockFile: URL
+
+    public static func resolve() throws -> RimeResourcePaths {
+        guard let container = FileManager.default.containerURL(
+            forSecurityApplicationGroupIdentifier: AppGroup.identifier
+        ) else {
+            throw RimeResourceError.appGroupUnavailable
+        }
+        let root = container.appendingPathComponent("Rime", isDirectory: true)
+        return RimeResourcePaths(
+            root: root,
+            sharedData: root.appendingPathComponent("SharedSupport", isDirectory: true),
+            userData: root.appendingPathComponent("UserData", isDirectory: true),
+            lockFile: root.appendingPathComponent(".deployment.lock")
+        )
+    }
+}
+
+public actor RimeResourceInstaller {
+    public static let shared = RimeResourceInstaller()
+    public static let resourceVersion = "2.0.0"
+
+    public init() {}
+
+    public static var isReady: Bool {
+        guard TypingInputConfiguration.installedResourceVersion() == resourceVersion,
+              let paths = try? RimeResourcePaths.resolve() else {
+            return false
+        }
+        return FileManager.default.fileExists(
+            atPath: paths.userData.appendingPathComponent("build").path
+        )
+    }
+
+    /// Installs source data and asks librime to prebuild schemas. Call only
+    /// from the host app, never from the keyboard extension.
+    public func installIfNeeded(
+        configuration: TypingInputConfigurationSnapshot,
+        force: Bool = false
+    ) throws {
+        if !force, Self.isReady { return }
+
+        let paths = try RimeResourcePaths.resolve()
+        let fileManager = FileManager.default
+        try fileManager.createDirectory(at: paths.root, withIntermediateDirectories: true)
+        try fileManager.createDirectory(at: paths.userData, withIntermediateDirectories: true)
+
+        let descriptor = open(paths.lockFile.path, O_CREAT | O_RDWR, S_IRUSR | S_IWUSR)
+        guard descriptor >= 0 else { throw RimeResourceError.lockUnavailable }
+        defer {
+            flock(descriptor, LOCK_UN)
+            close(descriptor)
+        }
+        guard flock(descriptor, LOCK_EX | LOCK_NB) == 0 else {
+            throw RimeResourceError.lockUnavailable
+        }
+
+        let staging = paths.root.appendingPathComponent(
+            "SharedSupport.staging-\(UUID().uuidString)",
+            isDirectory: true
+        )
+        defer { try? fileManager.removeItem(at: staging) }
+        try fileManager.createDirectory(at: staging, withIntermediateDirectories: true)
+
+        for resource in ["osg_pinyin.dict", "manifest"] {
+            let ext = resource == "manifest" ? "json" : "yaml"
+            guard let source = Bundle(for: RimeResourceBundleToken.self).url(
+                forResource: resource,
+                withExtension: ext
+            ) else {
+                throw RimeResourceError.bundledResourceMissing("\(resource).\(ext)")
+            }
+            try fileManager.copyItem(
+                at: source,
+                to: staging.appendingPathComponent("\(resource).\(ext)")
+            )
+        }
+
+        try RimeSchemaGenerator.defaultConfiguration().write(
+            to: staging.appendingPathComponent("default.yaml"),
+            atomically: true,
+            encoding: .utf8
+        )
+        for schema in TypingInputSchema.allCases {
+            try RimeSchemaGenerator.schema(
+                for: schema,
+                fuzzyPairs: configuration.fuzzyPairs
+            ).write(
+                to: staging.appendingPathComponent("\(schema.rawValue).schema.yaml"),
+                atomically: true,
+                encoding: .utf8
+            )
+        }
+
+        if fileManager.fileExists(atPath: paths.sharedData.path) {
+            try fileManager.removeItem(at: paths.sharedData)
+        }
+        try fileManager.moveItem(at: staging, to: paths.sharedData)
+
+        let bridge = OSGRimeBridge(
+            sharedDataDirectory: paths.sharedData.path,
+            userDataDirectory: paths.userData.path,
+            distributionVersion: Self.resourceVersion
+        )
+        do {
+            try bridge.deploy(withFullCheck: true)
+        } catch {
+            bridge.finalizeRuntime()
+            throw error
+        }
+        bridge.finalizeRuntime()
+
+        TypingInputConfiguration.setInstalledResourceVersion(Self.resourceVersion)
+        AppGroupConfigDarwin.postConfigChanged()
+    }
+
+    public func syncUserData() throws {
+        let paths = try RimeResourcePaths.resolve()
+        let bridge = OSGRimeBridge(
+            sharedDataDirectory: paths.sharedData.path,
+            userDataDirectory: paths.userData.path,
+            distributionVersion: Self.resourceVersion
+        )
+        try bridge.start()
+        // Destroying the session and finalizing librime flushes LevelDB
+        // user dictionaries. `sync_user_data` is for external Rime sync
+        // deployments and is intentionally not needed here.
+        bridge.finalizeRuntime()
+    }
+}
+
+private final class RimeResourceBundleToken: NSObject {}