File size: 6,447 Bytes
1f21206 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 | /**
* Settings Service — 读写用户级和项目级设置文件
*
* 设置文件为 JSON 格式:
* - 用户级: ~/.claude/settings.json
* - 项目级: {projectRoot}/.claude/settings.json
*
* 合并策略:Object.assign({}, userSettings, projectSettings)
*/
import * as fs from 'fs/promises'
import { randomBytes } from 'node:crypto'
import * as path from 'path'
import * as os from 'os'
import { ApiError } from '../middleware/errorHandler.js'
import { normalizeJsonObject, readRecoverableJsonFile } from './recoverableJsonFile.js'
import { ensurePersistentStorageUpgraded } from './persistentStorageMigrations.js'
import { resetSettingsCache } from '../../utils/settings/settingsCache.js'
const VALID_PERMISSION_MODES = [
'default',
'acceptEdits',
'plan',
'bypassPermissions',
'dontAsk',
] as const
export type PermissionMode = (typeof VALID_PERMISSION_MODES)[number]
export class SettingsService {
private static writeLocks = new Map<string, Promise<void>>()
private projectRoot?: string
constructor(projectRoot?: string) {
this.projectRoot = projectRoot
}
/** 配置目录,支持通过环境变量覆盖(便于测试) */
private getConfigDir(): string {
return process.env.CLAUDE_CONFIG_DIR || path.join(os.homedir(), '.claude')
}
/** 用户级设置文件路径 */
private getUserSettingsPath(): string {
return path.join(this.getConfigDir(), 'settings.json')
}
/** 项目级设置文件路径 */
private getProjectSettingsPath(projectRoot?: string): string {
const root = projectRoot || this.projectRoot
if (!root) {
throw ApiError.badRequest('Project root is required for project settings')
}
return path.join(root, '.claude', 'settings.json')
}
// ---------------------------------------------------------------------------
// 读取
// ---------------------------------------------------------------------------
/** 安全读取 JSON 文件,文件不存在时返回空对象 */
private async readJsonFile(filePath: string): Promise<Record<string, unknown>> {
await ensurePersistentStorageUpgraded()
return readRecoverableJsonFile({
filePath,
label: 'settings',
defaultValue: {},
normalize: normalizeJsonObject,
})
}
/** 获取合并后的设置(user + project) */
async getSettings(projectRoot?: string): Promise<Record<string, unknown>> {
const user = await this.getUserSettings()
try {
const project = await this.getProjectSettings(projectRoot)
return Object.assign({}, user, project)
} catch {
// project root 未指定时,仅返回 user settings
return user
}
}
/** 获取用户级设置 */
async getUserSettings(): Promise<Record<string, unknown>> {
return this.readJsonFile(this.getUserSettingsPath())
}
/** 获取项目级设置 */
async getProjectSettings(projectRoot?: string): Promise<Record<string, unknown>> {
return this.readJsonFile(this.getProjectSettingsPath(projectRoot))
}
// ---------------------------------------------------------------------------
// 写入(原子写入:先写临时文件,再 rename)
// ---------------------------------------------------------------------------
/** 原子写入 JSON 文件 */
private async withWriteLock<T>(
filePath: string,
task: () => Promise<T>,
): Promise<T> {
const previousWrite = SettingsService.writeLocks.get(filePath) ?? Promise.resolve()
const nextWrite = previousWrite
.catch(() => {})
.then(task)
SettingsService.writeLocks.set(filePath, nextWrite)
try {
return await nextWrite
} finally {
if (SettingsService.writeLocks.get(filePath) === nextWrite) {
SettingsService.writeLocks.delete(filePath)
}
}
}
private async writeJsonFile(
filePath: string,
data: Record<string, unknown>,
): Promise<void> {
const dir = path.dirname(filePath)
const contents = JSON.stringify(data, null, 2) + '\n'
let lastError: unknown
for (let attempt = 0; attempt < 2; attempt++) {
const tmpFile = `${filePath}.tmp.${process.pid}.${Date.now()}.${randomBytes(6).toString('hex')}`
try {
await fs.mkdir(dir, { recursive: true })
await fs.writeFile(tmpFile, contents, 'utf-8')
await fs.rename(tmpFile, filePath)
resetSettingsCache()
return
} catch (err) {
lastError = err
await fs.unlink(tmpFile).catch(() => {})
if (
(err as NodeJS.ErrnoException).code !== 'ENOENT' ||
attempt === 1
) {
break
}
}
}
throw ApiError.internal(
`Failed to write settings to ${filePath}: ${lastError}`,
)
}
/** 更新用户级设置(浅合并) */
async updateUserSettings(settings: Record<string, unknown>): Promise<void> {
const filePath = this.getUserSettingsPath()
await this.withWriteLock(filePath, async () => {
const current = await this.readJsonFile(filePath)
const merged = Object.assign({}, current, settings)
await this.writeJsonFile(filePath, merged)
})
}
/** 更新项目级设置(浅合并) */
async updateProjectSettings(
settings: Record<string, unknown>,
projectRoot?: string,
): Promise<void> {
const filePath = this.getProjectSettingsPath(projectRoot)
await this.withWriteLock(filePath, async () => {
const current = await this.readJsonFile(filePath)
const merged = Object.assign({}, current, settings)
await this.writeJsonFile(filePath, merged)
})
}
// ---------------------------------------------------------------------------
// 权限模式
// ---------------------------------------------------------------------------
/** 获取当前权限模式 */
async getPermissionMode(): Promise<string> {
const settings = await this.getUserSettings()
const mode = settings.defaultMode
return typeof mode === 'string' && VALID_PERMISSION_MODES.includes(mode as PermissionMode)
? mode
: 'default'
}
/** 设置权限模式 */
async setPermissionMode(mode: string): Promise<void> {
if (!VALID_PERMISSION_MODES.includes(mode as PermissionMode)) {
throw ApiError.badRequest(
`Invalid permission mode: "${mode}". Valid modes: ${VALID_PERMISSION_MODES.join(', ')}`,
)
}
await this.updateUserSettings({ defaultMode: mode })
}
}
|