267 lines
11 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

'use strict';
const MainService = require('../main');
/**
* 系统方法层:frontConfig(前端独立部署配置接口包装层)。
*
* 业务实现全部委托 ctx.service.systems.frontConfig:本层只做参数白名单过滤、
* 鉴权出口与统一成功/失败包装。
*/
class FrontConfigMethodsService extends MainService {
constructor(ctx) {
super(ctx);
// 公共按域名拉取:免登录、免权限、免鉴权(保留系统日志,与 workbench 公共接口口径一致)
// 注意:getByDomain 是唯一免登录接口;域名验证接口(setDomain/getDomain/checkDomain)一律需登录
const _noNeedLogin = 'getByDomain';
// settings 页配置接口:需登录、免权限、免鉴权(权限由业务层 isWarehouse 判定),不记系统日志
const _noNeedRight = 'getByDomain,getInfo,getCert,saveInfo,saveCert,setDomain,getDomain,checkDomain';
const _noNeedLog = 'getInfo,getCert,saveInfo,saveCert,setDomain,getDomain,checkDomain';
const _noNeedAuth = 'getByDomain,getInfo,getCert,saveInfo,saveCert,setDomain,getDomain,checkDomain';
this.systemInit(_noNeedLogin, _noNeedRight, _noNeedLog, _noNeedAuth);
}
/**
* 获取前端独立部署业务服务(systems/frontConfig)。
*
* @return {Object|null} 业务服务实例;不可用时返回 null。
*/
getFrontConfigService() {
return (this.service && this.service.systems && this.service.systems.frontConfig) || null;
}
/**
* 按域名拉取仓库前端公开配置(公共无鉴权接口)。
*
* 安全红线:响应仅含公开字段(domain/title/logo_url/login_bg_url/favicon_url/theme),
* 不含 cert_pem/key_pem/cert_path/key_path/sync_status/sync_attempts/last_sync_error 等内部字段。
*
* @param {Object} [data={}] 请求参数。
* @param {string} data.domain 待查询域名(必填,非空)。
* @return {Promise<Object>} 统一响应结构;命中返回公开字段配置(code=200),
* 未登记域名返回 code=404「域名未配置」。
*/
async getByDomain(data = {}) {
const { domain } = data || {};
const targetService = this.getFrontConfigService();
if (!targetService || typeof targetService.getByDomain !== 'function') {
return this.fail('获取前端配置失败', { code: 500 });
}
try {
const result = await targetService.getByDomain(domain);
return this.success('获取成功', { ...result, code: 200 });
} catch (error) {
return this.fail(error.message || '获取前端配置失败', {
code: Number(error.code) || 500,
});
}
}
/**
* 查询当前仓库前端独立部署品牌配置(settings 页回显,需登录)。
*
* 仅返回品牌与基础字段(warehouse_id/domain/title/logo_url/favicon_url/login_bg_url/theme/updated_at),
* 不含证书/私钥原文与同步状态等内部字段(证书回显走 frontConfig.getCert)。
*
* @return {Promise<Object>} 统一响应结果。
*/
async getInfo() {
const targetService = this.getFrontConfigService();
if (!targetService || typeof targetService.getInfo !== 'function') {
return this.fail('获取前端配置失败', { code: 500 });
}
try {
const result = await targetService.getInfo();
return this.success('ok', result);
} catch (error) {
return this.fail(error.message || '获取前端配置失败', {
code: Number(error.code) || 500,
});
}
}
/**
* 查询当前仓库前端独立部署证书配置(settings 页回显,需登录)。
*
* 响应含证书原文(cert_pem)与私钥原文(key_pem,取自 cert_key 列),
* 仅供仓库主体登录后的 settings 页回显,公共无鉴权接口 frontConfig.getByDomain
* 仍只返回公开字段白名单。
*
* @return {Promise<Object>} 统一响应结果。
*/
async getCert() {
const targetService = this.getFrontConfigService();
if (!targetService || typeof targetService.getCert !== 'function') {
return this.fail('获取前端证书配置失败', { code: 500 });
}
try {
const result = await targetService.getCert();
return this.success('ok', result);
} catch (error) {
return this.fail(error.message || '获取前端证书配置失败', {
code: Number(error.code) || 500,
});
}
}
/**
* 保存当前仓库前端独立部署品牌配置(upsert,一仓一行,仅品牌字段部分更新,需登录)。
*
* domain 与证书字段不再受理:domain 变更必须走 frontConfig.setDomain(域名验证通过后方可上传证书);
* cert_pem/key_pem/cert_path/key_path/cert_expire_at 一律被白名单过滤忽略。
*
* @param {Object} data 请求参数。
* @param {string} [data.title] 站点标题(≤100 字符,空值清空)。
* @param {string} [data.logo_url] Logo 地址(≤255 字符,空值清空)。
* @param {string} [data.favicon_url] 站点 favicon 图标地址(≤255 字符,空值清空)。
* @param {string} [data.login_bg_url] 登录页背景图地址(≤255 字符,空值清空)。
* @param {Object|string} [data.theme] 主题配置(合法 JSON 对象或 JSON 字符串,空值清空)。
* @return {Promise<Object>} 统一响应结果。
*/
async saveInfo(data = {}) {
const targetService = this.getFrontConfigService();
if (!targetService || typeof targetService.saveInfo !== 'function') {
return this.fail('保存前端配置失败', { code: 500 });
}
try {
const source = data || {};
const params = {};
// domain/cert_path/key_path/cert_pem/key_pem/cert_expire_at 均不受理:
// domain 变更走 setDomain,证书与有效期字段由后端权威维护,前端传值直接忽略
for (const key of [ 'title', 'logo_url', 'favicon_url', 'login_bg_url', 'theme' ]) {
if (Object.prototype.hasOwnProperty.call(source, key)) {
params[key] = source[key];
}
}
const result = await targetService.saveInfo(params);
return this.success('ok', result);
} catch (error) {
return this.fail(error.message || '保存前端配置失败', {
code: Number(error.code) || 500,
});
}
}
/**
* 上传当前仓库前端独立部署证书(需登录、仅仓库主体)。
*
* domain 不再受理:域名一律取库内已设置且验证通过的值(前端若仍传 data.domain 一律忽略),
* 未设置域名或域名未通过 TXT 验证时由业务层返回 400。
* 后端自动写入 cert_expire_at(证书 validTo 权威值),证书/私钥内容直接入库(不落盘),
* 保存后清理该域名的公共拉取缓存并返回证书配置输出
* (响应含证书/私钥原文回显,13 字段,口径与 frontConfig.getCert 一致)。
*
* @param {Object} data 请求参数。
* @param {string} data.pem 证书 PEM 文本(必填)。
* @param {string} data.key 私钥 PEM 文本(必填,与证书成对)。
* @return {Promise<Object>} 统一响应结果。
*/
async saveCert(data = {}) {
const targetService = this.getFrontConfigService();
if (!targetService || typeof targetService.saveCert !== 'function') {
return this.fail('上传前端证书失败', { code: 500 });
}
try {
const source = data || {};
const { pem, key } = source;
// data.domain 不再受理:域名只认库内已设置并验证通过的值,前端若仍传 domain 一律忽略
const result = await targetService.saveCert({
pem,
key,
});
return this.success('ok', result);
} catch (error) {
return this.fail(error.message || '上传前端证书失败', {
code: Number(error.code) || 500,
});
}
}
/**
* 设置当前仓库前端独立部署域名(需登录、仅仓库主体)。
*
* 设置成功会下发一次性 DNS TXT 校验记录(verify_host/verify_value)与 CNAME 目标(cname);
* 域名发生变更时会同时清空既有证书并重置同步状态(旧证书不覆盖新域名)。
*
* @param {Object} data 请求参数。
* @param {string} data.domain 仓库自持域名(必填,非空,≤100 字符,全局唯一)。
* @return {Promise<Object>} 统一响应结果(code=1);data 含
* warehouse_id/domain/domain_status/verify_host/verify_value/cname/verified_at/attempts/last_error。
*/
async setDomain(data = {}) {
const targetService = this.getFrontConfigService();
if (!targetService || typeof targetService.setDomain !== 'function') {
return this.fail('设置域名失败', { code: 500 });
}
try {
const result = await targetService.setDomain(data || {});
return this.success('ok', result);
} catch (error) {
return this.fail(error.message || '设置域名失败', {
code: Number(error.code) || 500,
});
}
}
/**
* 查询当前仓库前端独立部署域名与验证状态(需登录、仅仓库主体)。
*
* 返回待校验的 verify_host/verify_value 与 cname;domain_status=1(已验证)时
* verify_host/verify_value 返回空串(校验令牌已无用途);无记录时返回空值默认。
*
* @return {Promise<Object>} 统一响应结果(code=1);data 含
* warehouse_id/domain/domain_status/verify_host/verify_value/cname/verified_at/attempts/last_error。
*/
async getDomain() {
const targetService = this.getFrontConfigService();
if (!targetService || typeof targetService.getDomain !== 'function') {
return this.fail('获取域名配置失败', { code: 500 });
}
try {
const result = await targetService.getDomain();
return this.success('ok', result);
} catch (error) {
return this.fail(error.message || '获取域名配置失败', {
code: Number(error.code) || 500,
});
}
}
/**
* 主动校验当前仓库前端独立部署域名的 DNS TXT 记录(需登录、仅仓库主体)。
*
* 校验结果会回写 domain_status/domain_verified_at/attempts/last_error;
* 响应额外含 verified(本次是否通过)与 resolved_values(本次解析到的 TXT 值,最多 5 条)。
*
* @return {Promise<Object>} 统一响应结果(code=1);未设置域名时 code=400。
*/
async checkDomain() {
const targetService = this.getFrontConfigService();
if (!targetService || typeof targetService.checkDomain !== 'function') {
return this.fail('校验域名失败', { code: 500 });
}
try {
const result = await targetService.checkDomain();
return this.success('ok', result);
} catch (error) {
return this.fail(error.message || '校验域名失败', {
code: Number(error.code) || 500,
});
}
}
}
module.exports = FrontConfigMethodsService;