mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-05 07:01:16 +00:00
a5769b6a62
Add a public route to serve plugin extension pages without auth and update related pieces accordingly. Backend: register GET /plugin/:pluginId/page/:pagePath to locate the plugin router, validate page and HTML file existence, and send the file (returns appropriate 4xx/5xx errors). Frontend: switch iframe and new-window URLs to the new unauthenticated route (remove webui_token usage). Builtin plugin: clarify page registration comment and add a log line for the extension page URL. Minor formatting whitespace tweaks in plugin manager type annotations.
344 lines
12 KiB
TypeScript
344 lines
12 KiB
TypeScript
import type { ActionMap } from 'napcat-types/napcat-onebot/action/index';
|
||
import { EventType } from 'napcat-types/napcat-onebot/event/index';
|
||
import type { PluginModule, PluginLogger, PluginConfigSchema, PluginConfigUIController } from 'napcat-types/napcat-onebot/network/plugin-manger';
|
||
import type { OB11Message, OB11PostSendMsg } from 'napcat-types/napcat-onebot/types/index';
|
||
import fs from 'fs';
|
||
import path from 'path';
|
||
import { NetworkAdapterConfig } from 'napcat-types/napcat-onebot/config/config';
|
||
|
||
|
||
let startTime: number = Date.now();
|
||
let logger: PluginLogger | null = null;
|
||
|
||
interface BuiltinPluginConfig {
|
||
prefix: string;
|
||
enableReply: boolean;
|
||
description: string;
|
||
theme?: string;
|
||
features?: string[];
|
||
apiUrl?: string;
|
||
apiEndpoints?: string[];
|
||
[key: string]: unknown;
|
||
}
|
||
|
||
let currentConfig: BuiltinPluginConfig = {
|
||
prefix: '#napcat',
|
||
enableReply: true,
|
||
description: '这是一个内置插件的配置示例'
|
||
};
|
||
|
||
|
||
export let plugin_config_ui: PluginConfigSchema = [];
|
||
|
||
const plugin_init: PluginModule['plugin_init'] = async (ctx) => {
|
||
logger = ctx.logger;
|
||
logger.info('NapCat 内置插件已初始化');
|
||
plugin_config_ui = ctx.NapCatConfig.combine(
|
||
ctx.NapCatConfig.html('<div style="padding: 10px; background: rgba(0,0,0,0.05); border-radius: 8px;"><h3>👋 Welcome to NapCat Builtin Plugin</h3><p>This is a demonstration of the plugin configuration interface with reactive fields.</p></div>'),
|
||
ctx.NapCatConfig.text('prefix', 'Command Prefix', '#napcat', 'The prefix to trigger the version info command'),
|
||
ctx.NapCatConfig.boolean('enableReply', 'Enable Reply', true, 'Switch to enable or disable the reply functionality'),
|
||
// 代表监听 apiUrl 字段的变化
|
||
ctx.NapCatConfig.text('apiUrl', 'API URL', '', 'Enter an API URL to load available endpoints', true),
|
||
ctx.NapCatConfig.select('theme', 'Theme Selection', [
|
||
{ label: 'Light Mode', value: 'light' },
|
||
{ label: 'Dark Mode', value: 'dark' },
|
||
{ label: 'Auto', value: 'auto' }
|
||
], 'light', 'Select a theme for the response (Demo purpose only)'),
|
||
ctx.NapCatConfig.multiSelect('features', 'Enabled Features', [
|
||
{ label: 'Version Info', value: 'version' },
|
||
{ label: 'Status Report', value: 'status' },
|
||
{ label: 'Debug Log', value: 'debug' }
|
||
], ['version'], 'Select features to enable'),
|
||
ctx.NapCatConfig.text('description', 'Description', '这是一个内置插件的配置示例', 'A multi-line text area for notes')
|
||
);
|
||
|
||
// Try to load config
|
||
try {
|
||
// Use ctx.configPath
|
||
if (fs.existsSync(ctx.configPath)) {
|
||
const savedConfig = JSON.parse(fs.readFileSync(ctx.configPath, 'utf-8'));
|
||
Object.assign(currentConfig, savedConfig);
|
||
}
|
||
} catch (e) {
|
||
logger?.warn('Failed to load config', e);
|
||
}
|
||
|
||
// ==================== 注册 WebUI 路由示例 ====================
|
||
|
||
// 注册静态资源目录
|
||
// 静态资源可通过 /plugin/{pluginId}/files/static/ 访问（无需鉴权）
|
||
ctx.router.static('/static', 'webui');
|
||
|
||
// 注册内存生成的静态资源（无需鉴权）
|
||
// 可通过 /plugin/{pluginId}/mem/dynamic/info.json 访问
|
||
ctx.router.staticOnMem('/dynamic', [
|
||
{
|
||
path: '/info.json',
|
||
contentType: 'application/json',
|
||
// 使用生成器函数动态生成内容
|
||
content: () => JSON.stringify({
|
||
pluginName: ctx.pluginName,
|
||
generatedAt: new Date().toISOString(),
|
||
uptime: Date.now() - startTime,
|
||
config: currentConfig
|
||
}, null, 2)
|
||
},
|
||
{
|
||
path: '/readme.txt',
|
||
contentType: 'text/plain',
|
||
content: `NapCat Builtin Plugin\n=====================\nThis is a demonstration of the staticOnMem feature.\nPlugin: ${ctx.pluginName}\nPath: ${ctx.pluginPath}`
|
||
}
|
||
]);
|
||
|
||
// 注册 API 路由（需要鉴权，挂载到 /api/Plugin/ext/{pluginId}/）
|
||
ctx.router.get('/status', (_req, res) => {
|
||
const uptime = Date.now() - startTime;
|
||
res.json({
|
||
code: 0,
|
||
data: {
|
||
pluginName: ctx.pluginName,
|
||
uptime,
|
||
uptimeFormatted: formatUptime(uptime),
|
||
config: currentConfig,
|
||
platform: process.platform,
|
||
arch: process.arch
|
||
}
|
||
});
|
||
});
|
||
|
||
ctx.router.get('/config', (_req, res) => {
|
||
res.json({
|
||
code: 0,
|
||
data: currentConfig
|
||
});
|
||
});
|
||
|
||
ctx.router.post('/config', (req, res) => {
|
||
try {
|
||
const newConfig = req.body as Partial<BuiltinPluginConfig>;
|
||
Object.assign(currentConfig, newConfig);
|
||
// 保存配置
|
||
const configDir = path.dirname(ctx.configPath);
|
||
if (!fs.existsSync(configDir)) {
|
||
fs.mkdirSync(configDir, { recursive: true });
|
||
}
|
||
fs.writeFileSync(ctx.configPath, JSON.stringify(currentConfig, null, 2), 'utf-8');
|
||
res.json({ code: 0, message: 'Config saved successfully' });
|
||
} catch (e: any) {
|
||
res.status(500).json({ code: -1, message: e.message });
|
||
}
|
||
});
|
||
|
||
// ==================== 插件互调用示例 ====================
|
||
// 演示如何调用其他插件的导出方法
|
||
ctx.router.get('/call-plugin/:pluginId', (req, res) => {
|
||
const { pluginId } = req.params;
|
||
|
||
// 使用 getPluginExports 获取其他插件的导出模块
|
||
const targetPlugin = ctx.getPluginExports<PluginModule>(pluginId);
|
||
|
||
if (!targetPlugin) {
|
||
res.status(404).json({
|
||
code: -1,
|
||
message: `Plugin '${pluginId}' not found or not loaded`
|
||
});
|
||
return;
|
||
}
|
||
|
||
// 返回目标插件的信息
|
||
res.json({
|
||
code: 0,
|
||
data: {
|
||
pluginId,
|
||
hasInit: typeof targetPlugin.plugin_init === 'function',
|
||
hasOnMessage: typeof targetPlugin.plugin_onmessage === 'function',
|
||
hasOnEvent: typeof targetPlugin.plugin_onevent === 'function',
|
||
hasCleanup: typeof targetPlugin.plugin_cleanup === 'function',
|
||
hasConfigSchema: Array.isArray(targetPlugin.plugin_config_schema),
|
||
hasConfigUI: Array.isArray(targetPlugin.plugin_config_ui),
|
||
}
|
||
});
|
||
});
|
||
|
||
// 注册扩展页面（无需鉴权，可通过 /plugin/{pluginId}/page/dashboard 访问）
|
||
ctx.router.page({
|
||
path: 'dashboard',
|
||
title: '插件仪表盘',
|
||
icon: '📊',
|
||
htmlFile: 'webui/dashboard.html',
|
||
description: '查看内置插件的运行状态和配置'
|
||
});
|
||
|
||
logger.info('WebUI 路由已注册:');
|
||
logger.info(' - API 路由: /api/Plugin/ext/' + ctx.pluginName + '/');
|
||
logger.info(' - 扩展页面: /plugin/' + ctx.pluginName + '/page/dashboard');
|
||
logger.info(' - 静态资源: /plugin/' + ctx.pluginName + '/files/static/');
|
||
logger.info(' - 内存资源: /plugin/' + ctx.pluginName + '/mem/dynamic/');
|
||
};
|
||
|
||
export const plugin_get_config: PluginModule['plugin_get_config'] = async () => {
|
||
return currentConfig;
|
||
};
|
||
|
||
export const plugin_set_config: PluginModule['plugin_set_config'] = async (ctx, config) => {
|
||
currentConfig = config as BuiltinPluginConfig;
|
||
if (ctx && ctx.configPath) {
|
||
try {
|
||
const configPath = ctx.configPath;
|
||
const configDir = path.dirname(configPath);
|
||
if (!fs.existsSync(configDir)) {
|
||
fs.mkdirSync(configDir, { recursive: true });
|
||
}
|
||
fs.writeFileSync(configPath, JSON.stringify(config, null, 2), 'utf-8');
|
||
} catch (e) {
|
||
logger?.error('Failed to save config', e);
|
||
throw e;
|
||
}
|
||
}
|
||
};
|
||
|
||
/**
|
||
* 响应式配置控制器 - 当插件配置界面打开时调用
|
||
* 用于初始化动态 UI 控制
|
||
*/
|
||
export const plugin_config_controller: PluginModule['plugin_config_controller'] = async (_ctx, ui, initialConfig) => {
|
||
logger?.info('配置控制器已初始化', initialConfig);
|
||
|
||
// 如果初始配置中有 apiUrl，立即加载端点
|
||
if (initialConfig['apiUrl']) {
|
||
await loadEndpointsForUrl(ui, initialConfig['apiUrl'] as string);
|
||
}
|
||
|
||
// 返回清理函数
|
||
return () => {
|
||
logger?.info('配置控制器已清理');
|
||
};
|
||
};
|
||
|
||
/**
|
||
* 响应式字段变化处理 - 当标记为 reactive 的字段值变化时调用
|
||
*/
|
||
export const plugin_on_config_change: PluginModule['plugin_on_config_change'] = async (_ctx, ui, key, value, _currentConfig: Partial<BuiltinPluginConfig>) => {
|
||
logger?.info(`配置字段变化: ${key} = ${value}`);
|
||
|
||
if (key === 'apiUrl') {
|
||
await loadEndpointsForUrl(ui, value as string);
|
||
}
|
||
};
|
||
|
||
/**
|
||
* 根据 API URL 动态加载端点列表
|
||
*/
|
||
async function loadEndpointsForUrl (ui: PluginConfigUIController, apiUrl: string) {
|
||
if (!apiUrl) {
|
||
// URL 为空时，移除端点选择字段
|
||
ui.removeField('apiEndpoints');
|
||
return;
|
||
}
|
||
|
||
// 模拟从 API 获取端点列表（实际使用时可以 fetch 真实 API）
|
||
const mockEndpoints = [
|
||
{ label: `${apiUrl}/users`, value: '/users' },
|
||
{ label: `${apiUrl}/posts`, value: '/posts' },
|
||
{ label: `${apiUrl}/comments`, value: '/comments' },
|
||
{ label: `${apiUrl}/albums`, value: '/albums' },
|
||
];
|
||
|
||
// 动态添加或更新端点选择字段
|
||
const currentSchema = ui.getCurrentConfig();
|
||
if ('apiEndpoints' in currentSchema) {
|
||
// 更新现有字段的选项
|
||
ui.updateField('apiEndpoints', {
|
||
options: mockEndpoints,
|
||
description: `从 ${apiUrl} 加载的端点`
|
||
});
|
||
} else {
|
||
// 添加新字段
|
||
ui.addField({
|
||
key: 'apiEndpoints',
|
||
type: 'multi-select',
|
||
label: 'API Endpoints',
|
||
description: `从 ${apiUrl} 加载的端点`,
|
||
options: mockEndpoints,
|
||
default: []
|
||
}, 'apiUrl');
|
||
}
|
||
}
|
||
|
||
const plugin_onmessage: PluginModule['plugin_onmessage'] = async (_ctx, event) => {
|
||
if (currentConfig.enableReply === false) {
|
||
return;
|
||
}
|
||
const prefix = currentConfig.prefix || '#napcat';
|
||
if (event.post_type !== EventType.MESSAGE || !event.raw_message.startsWith(prefix)) {
|
||
return;
|
||
}
|
||
|
||
try {
|
||
const versionInfo = await getVersionInfo(_ctx.actions, _ctx.adapterName, _ctx.pluginManager.config);
|
||
if (!versionInfo) return;
|
||
|
||
const message = formatVersionMessage(versionInfo);
|
||
await sendMessage(_ctx.actions, event, message, _ctx.adapterName, _ctx.pluginManager.config);
|
||
|
||
logger?.info('已回复版本信息');
|
||
} catch (error) {
|
||
logger?.error('处理消息时发生错误:', error);
|
||
}
|
||
};
|
||
|
||
async function getVersionInfo (actions: ActionMap, adapter: string, config: NetworkAdapterConfig) {
|
||
if (!actions) return null;
|
||
|
||
try {
|
||
const data = await actions.call('get_version_info', void 0, adapter, config);
|
||
return {
|
||
appName: data.app_name,
|
||
appVersion: data.app_version,
|
||
protocolVersion: data.protocol_version,
|
||
};
|
||
} catch (error) {
|
||
logger?.error('获取版本信息失败:', error);
|
||
return null;
|
||
}
|
||
}
|
||
|
||
function formatUptime (ms: number): string {
|
||
const seconds = Math.floor(ms / 1000);
|
||
const minutes = Math.floor(seconds / 60);
|
||
const hours = Math.floor(minutes / 60);
|
||
const days = Math.floor(hours / 24);
|
||
|
||
if (days > 0) {
|
||
return `${days}天 ${hours % 24}小时 ${minutes % 60}分钟`;
|
||
} else if (hours > 0) {
|
||
return `${hours}小时 ${minutes % 60}分钟`;
|
||
} else if (minutes > 0) {
|
||
return `${minutes}分钟 ${seconds % 60}秒`;
|
||
} else {
|
||
return `${seconds}秒`;
|
||
}
|
||
}
|
||
|
||
function formatVersionMessage (info: { appName: string; appVersion: string; protocolVersion: string; }) {
|
||
const uptime = Date.now() - startTime;
|
||
return `NapCat 信息\n版本: ${info.appVersion}\n平台: ${process.platform}${process.arch === 'x64' ? ' (64-bit)' : ''}\n运行时间: ${formatUptime(uptime)}`;
|
||
}
|
||
|
||
async function sendMessage (actions: ActionMap, event: OB11Message, message: string, adapter: string, config: NetworkAdapterConfig) {
|
||
const params: OB11PostSendMsg = {
|
||
message,
|
||
message_type: event.message_type,
|
||
...(event.message_type === 'group' && event.group_id ? { group_id: String(event.group_id) } : {}),
|
||
...(event.message_type === 'private' && event.user_id ? { user_id: String(event.user_id) } : {}),
|
||
};
|
||
|
||
try {
|
||
await actions.call('send_msg', params, adapter, config);
|
||
} catch (error) {
|
||
logger?.error('发送消息失败:', error);
|
||
}
|
||
}
|
||
|
||
export { plugin_init, plugin_onmessage };
|