mirror of
https://github.com/ZeroCatDev/ClassworksKV.git
synced 2025-12-07 13:03:09 +00:00
bb61e6e6f5
- Introduced AutoAuth model to manage automatic authorization configurations for devices. - Added new endpoint to obtain token via namespace and password for automatic authorization. - Implemented functionality to set student names for student-type tokens. - Enhanced AppInstall model to include deviceType and isReadOnly fields. - Updated device creation to allow custom namespaces and ensure uniqueness. - Added routes for managing AutoAuth configurations, including CRUD operations. - Implemented checks for read-only tokens in KV operations. - Created detailed API documentation for AutoAuth and new Apps API endpoints. - Added migration scripts to accommodate new database schema changes.
405 lines
9.7 KiB
JavaScript
405 lines
9.7 KiB
JavaScript
import { Router } from "express";
|
||
const router = Router();
|
||
import kvStore from "../utils/kvStore.js";
|
||
import { broadcastKeyChanged } from "../utils/socket.js";
|
||
import { kvTokenAuth } from "../middleware/kvTokenAuth.js";
|
||
import errors from "../utils/errors.js";
|
||
import { PrismaClient } from "@prisma/client";
|
||
|
||
const prisma = new PrismaClient();
|
||
|
||
// 使用KV专用token认证
|
||
router.use(kvTokenAuth);
|
||
|
||
/**
|
||
* GET /_info
|
||
* 获取当前token所属设备的信息，如果关联了账号也返回账号信息
|
||
*/
|
||
router.get(
|
||
"/_info",
|
||
errors.catchAsync(async (req, res) => {
|
||
const deviceId = res.locals.deviceId;
|
||
|
||
// 获取设备信息，包含关联的账号
|
||
const device = await prisma.device.findUnique({
|
||
where: { id: deviceId },
|
||
include: {
|
||
account: true,
|
||
},
|
||
});
|
||
|
||
if (!device) {
|
||
return next(errors.createError(404, "设备不存在"));
|
||
}
|
||
|
||
// 构建响应对象
|
||
const response = {
|
||
device: {
|
||
id: device.id,
|
||
uuid: device.uuid,
|
||
name: device.name,
|
||
createdAt: device.createdAt,
|
||
updatedAt: device.updatedAt,
|
||
},
|
||
};
|
||
|
||
// 如果关联了账号，添加账号信息
|
||
if (device.account) {
|
||
response.account = {
|
||
id: device.account.id,
|
||
name: device.account.name,
|
||
avatarUrl: device.account.avatarUrl,
|
||
};
|
||
}
|
||
|
||
return res.json(response);
|
||
})
|
||
);
|
||
|
||
/**
|
||
* GET /_token
|
||
* 获取当前 KV Token 的详细信息（类型、备注等）
|
||
*/
|
||
router.get(
|
||
"/_token",
|
||
errors.catchAsync(async (req, res, next) => {
|
||
const token = res.locals.token;
|
||
const deviceId = res.locals.deviceId;
|
||
|
||
// 查找当前 token 对应的应用安装记录
|
||
const appInstall = await prisma.appInstall.findUnique({
|
||
where: { token },
|
||
include: {
|
||
device: {
|
||
select: {
|
||
id: true,
|
||
uuid: true,
|
||
name: true,
|
||
namespace: true,
|
||
},
|
||
},
|
||
},
|
||
});
|
||
|
||
if (!appInstall) {
|
||
return next(errors.createError(404, "Token 信息不存在"));
|
||
}
|
||
|
||
return res.json({
|
||
success: true,
|
||
token: appInstall.token,
|
||
appId: appInstall.appId,
|
||
deviceType: appInstall.deviceType,
|
||
isReadOnly: appInstall.isReadOnly,
|
||
note: appInstall.note,
|
||
installedAt: appInstall.installedAt,
|
||
updatedAt: appInstall.updatedAt,
|
||
device: {
|
||
id: appInstall.device.id,
|
||
uuid: appInstall.device.uuid,
|
||
name: appInstall.device.name,
|
||
namespace: appInstall.device.namespace,
|
||
},
|
||
});
|
||
})
|
||
);
|
||
|
||
/**
|
||
* GET /_keys
|
||
* 获取当前token对应设备的键名列表（分页，不包括内容）
|
||
*/
|
||
router.get(
|
||
"/_keys",
|
||
errors.catchAsync(async (req, res) => {
|
||
const deviceId = res.locals.deviceId;
|
||
const { sortBy, sortDir, limit, skip } = req.query;
|
||
|
||
// 构建选项
|
||
const options = {
|
||
sortBy: sortBy || "key",
|
||
sortDir: sortDir || "asc",
|
||
limit: limit ? parseInt(limit) : 100,
|
||
skip: skip ? parseInt(skip) : 0,
|
||
};
|
||
|
||
const keys = await kvStore.listKeysOnly(deviceId, options);
|
||
const totalRows = keys.length;
|
||
|
||
// 构建响应对象
|
||
const response = {
|
||
keys: keys,
|
||
total_rows: totalRows,
|
||
current_page: {
|
||
limit: options.limit,
|
||
skip: options.skip,
|
||
count: keys.length,
|
||
},
|
||
};
|
||
|
||
// 如果还有更多数据，添加load_more字段
|
||
const nextSkip = options.skip + options.limit;
|
||
if (nextSkip < totalRows) {
|
||
const baseUrl = `${req.baseUrl}/_keys`;
|
||
const queryParams = new URLSearchParams({
|
||
sortBy: options.sortBy,
|
||
sortDir: options.sortDir,
|
||
limit: options.limit,
|
||
skip: nextSkip,
|
||
}).toString();
|
||
|
||
response.load_more = `${baseUrl}?${queryParams}`;
|
||
}
|
||
|
||
return res.json(response);
|
||
})
|
||
);
|
||
|
||
/**
|
||
* GET /
|
||
* 获取当前token对应设备的所有键名及元数据列表
|
||
*/
|
||
router.get(
|
||
"/",
|
||
errors.catchAsync(async (req, res) => {
|
||
const deviceId = res.locals.deviceId;
|
||
const { sortBy, sortDir, limit, skip } = req.query;
|
||
|
||
// 构建选项
|
||
const options = {
|
||
sortBy: sortBy || "key",
|
||
sortDir: sortDir || "asc",
|
||
limit: limit ? parseInt(limit) : 100,
|
||
skip: skip ? parseInt(skip) : 0,
|
||
};
|
||
|
||
const keys = await kvStore.list(deviceId, options);
|
||
const totalRows = await kvStore.count(deviceId);
|
||
|
||
// 构建响应对象
|
||
const response = {
|
||
items: keys,
|
||
total_rows: totalRows,
|
||
};
|
||
|
||
// 如果还有更多数据，添加load_more字段
|
||
const nextSkip = options.skip + options.limit;
|
||
if (nextSkip < totalRows) {
|
||
const baseUrl = `${req.baseUrl}`;
|
||
const queryParams = new URLSearchParams({
|
||
sortBy: options.sortBy,
|
||
sortDir: options.sortDir,
|
||
limit: options.limit,
|
||
skip: nextSkip,
|
||
}).toString();
|
||
|
||
response.load_more = `${baseUrl}?${queryParams}`;
|
||
}
|
||
|
||
return res.json(response);
|
||
})
|
||
);
|
||
|
||
/**
|
||
* GET /:key
|
||
* 通过键名获取键值
|
||
*/
|
||
router.get(
|
||
"/:key",
|
||
errors.catchAsync(async (req, res, next) => {
|
||
const deviceId = res.locals.deviceId;
|
||
const { key } = req.params;
|
||
|
||
const value = await kvStore.get(deviceId, key);
|
||
|
||
if (value === null) {
|
||
return next(
|
||
errors.createError(404, `未找到键名为 '${key}' 的记录`)
|
||
);
|
||
}
|
||
|
||
return res.json(value);
|
||
})
|
||
);
|
||
|
||
/**
|
||
* GET /:key/metadata
|
||
* 获取键的元数据
|
||
*/
|
||
router.get(
|
||
"/:key/metadata",
|
||
errors.catchAsync(async (req, res, next) => {
|
||
const deviceId = res.locals.deviceId;
|
||
const { key } = req.params;
|
||
|
||
const metadata = await kvStore.getMetadata(deviceId, key);
|
||
if (!metadata) {
|
||
return next(
|
||
errors.createError(404, `未找到键名为 '${key}' 的记录`)
|
||
);
|
||
}
|
||
return res.json(metadata);
|
||
})
|
||
);
|
||
|
||
/**
|
||
* POST /_batchimport
|
||
* 批量导入键值对
|
||
*/
|
||
router.post(
|
||
"/_batchimport",
|
||
errors.catchAsync(async (req, res, next) => {
|
||
// 检查token是否为只读
|
||
if (res.locals.appInstall?.isReadOnly) {
|
||
return next(errors.createError(403, "当前token为只读模式,无法修改数据"));
|
||
}
|
||
|
||
const deviceId = res.locals.deviceId;
|
||
const data = req.body;
|
||
|
||
if (!data || Object.keys(data).length === 0) {
|
||
return next(
|
||
errors.createError(
|
||
400,
|
||
'请提供有效的JSON数据，格式为 {"key":{}, "key2":{}}'
|
||
)
|
||
);
|
||
}
|
||
|
||
// 获取客户端IP
|
||
const creatorIp =
|
||
req.headers["x-forwarded-for"] ||
|
||
req.connection.remoteAddress ||
|
||
req.socket.remoteAddress ||
|
||
req.connection.socket?.remoteAddress ||
|
||
"";
|
||
|
||
const results = [];
|
||
const errorList = [];
|
||
|
||
// 批量处理所有键值对
|
||
for (const [key, value] of Object.entries(data)) {
|
||
try {
|
||
const result = await kvStore.upsert(deviceId, key, value, creatorIp);
|
||
results.push({
|
||
key: result.key,
|
||
created: result.createdAt.getTime() === result.updatedAt.getTime(),
|
||
});
|
||
// 广播每个键的变更
|
||
const uuid = res.locals.device?.uuid;
|
||
if (uuid) {
|
||
broadcastKeyChanged(uuid, {
|
||
key: result.key,
|
||
action: "upsert",
|
||
created: result.createdAt.getTime() === result.updatedAt.getTime(),
|
||
updatedAt: result.updatedAt,
|
||
batch: true,
|
||
});
|
||
}
|
||
} catch (error) {
|
||
errorList.push({
|
||
key,
|
||
error: error.message,
|
||
});
|
||
}
|
||
}
|
||
|
||
return res.status(200).json({
|
||
deviceId,
|
||
total: Object.keys(data).length,
|
||
successful: results.length,
|
||
failed: errorList.length,
|
||
results,
|
||
errors: errorList.length > 0 ? errorList : undefined,
|
||
});
|
||
})
|
||
);
|
||
|
||
/**
|
||
* POST /:key
|
||
* 更新或创建键值
|
||
*/
|
||
router.post(
|
||
"/:key",
|
||
errors.catchAsync(async (req, res, next) => {
|
||
// 检查token是否为只读
|
||
if (res.locals.appInstall?.isReadOnly) {
|
||
return next(errors.createError(403, "当前token为只读模式,无法修改数据"));
|
||
}
|
||
|
||
const deviceId = res.locals.deviceId;
|
||
const { key } = req.params;
|
||
const value = req.body;
|
||
|
||
if (!value || Object.keys(value).length === 0) {
|
||
return next(errors.createError(400, "请提供有效的JSON值"));
|
||
}
|
||
|
||
// 获取客户端IP
|
||
const creatorIp =
|
||
req.headers["x-forwarded-for"] ||
|
||
req.connection.remoteAddress ||
|
||
req.socket.remoteAddress ||
|
||
req.connection.socket?.remoteAddress ||
|
||
"";
|
||
|
||
const result = await kvStore.upsert(deviceId, key, value, creatorIp);
|
||
|
||
// 广播单个键的变更
|
||
const uuid = res.locals.device?.uuid;
|
||
if (uuid) {
|
||
broadcastKeyChanged(uuid, {
|
||
key: result.key,
|
||
action: "upsert",
|
||
created: result.createdAt.getTime() === result.updatedAt.getTime(),
|
||
updatedAt: result.updatedAt,
|
||
});
|
||
}
|
||
|
||
return res.status(200).json({
|
||
deviceId: result.deviceId,
|
||
key: result.key,
|
||
created: result.createdAt.getTime() === result.updatedAt.getTime(),
|
||
updatedAt: result.updatedAt,
|
||
});
|
||
})
|
||
);
|
||
|
||
/**
|
||
* DELETE /:key
|
||
* 删除键值对
|
||
*/
|
||
router.delete(
|
||
"/:key",
|
||
errors.catchAsync(async (req, res, next) => {
|
||
// 检查token是否为只读
|
||
if (res.locals.appInstall?.isReadOnly) {
|
||
return next(errors.createError(403, "当前token为只读模式,无法修改数据"));
|
||
}
|
||
|
||
const deviceId = res.locals.deviceId;
|
||
const { key } = req.params;
|
||
|
||
const result = await kvStore.delete(deviceId, key);
|
||
|
||
if (!result) {
|
||
return next(
|
||
errors.createError(404, `未找到键名为 '${key}' 的记录`)
|
||
);
|
||
}
|
||
|
||
// 广播删除
|
||
const uuid = res.locals.device?.uuid;
|
||
if (uuid) {
|
||
broadcastKeyChanged(uuid, {
|
||
key,
|
||
action: "delete",
|
||
deletedAt: new Date(),
|
||
});
|
||
}
|
||
|
||
// 204状态码表示成功但无内容返回
|
||
return res.status(204).end();
|
||
})
|
||
);
|
||
|
||
export default router; |