@maiyunnet/kebab 2.0.7 → 2.0.9

package/sys/child.js

@@ -33,16 +33,24 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-5-3 23:54
+ * Last: 2020-3-31 15:01:07, 2020-4-9 22:28:50, 2022-07-22 14:19:46, 2022-9-29 22:11:07, 2023-5-1 18:26:57, 2024-1-12 13:32:00, 2024-3-4 16:49:19
+ */
 const http2 = __importStar(require("http2"));
 const tls = __importStar(require("tls"));
 const http = __importStar(require("http"));
 const crypto = __importStar(require("crypto"));
+// --- 库和定义 ---
 const fs = __importStar(require("../lib/fs"));
 const lCore = __importStar(require("../lib/core"));
 const lText = __importStar(require("../lib/text"));
 const sCtr = __importStar(require("../sys/ctr"));
 const kebab = __importStar(require("../index"));
+// --- 初始化 ---
 const sRoute = __importStar(require("../sys/route"));
+/** --- 10 秒往主线程发送一次心跳的 Timer --- */
 const hbTimer = setInterval(function () {
     if (!process.connected || !process.send) {
         return;
@@ -52,25 +60,39 @@ const hbTimer = setInterval(function () {
         pid: process.pid
     });
 }, 10_000);
+/** --- 加载的证书列表（path: { sc, cert }） --- */
 const certList = [];
+/** --- server: index --- */
 let certHostIndex = {};
+/** --- 当前的虚拟主机配置列表 - 读取于 conf/vhost/*.json --- */
 let vhosts = [];
+/** --- http 服务器 --- */
 let httpServer;
+/** --- http2 服务器 --- */
 let http2Server;
+/** --- 当前使用中的连接 --- */
 const linkCount = {};
+/**
+ * --- 最终调用执行的函数块，创建 http 服务器等 ---
+ */
 async function run() {
+    // --- 加载 全局、vhosts、sni 证书 ---
     await reload();
+    // --- 创建服务器并启动（支持 http2/https/http/websocket） ---
     http2Server = http2.createSecureServer({
+        // eslint-disable-next-line @typescript-eslint/naming-convention
         'SNICallback': (servername, cb) => {
             const i = certHostIndex[servername];
             if (i !== undefined) {
                 cb(null, certList[i].sc);
                 return;
             }
+            // --- 查找 servername ---
             for (let i = 0; i < certList.length; ++i) {
                 if (!certList[i].cert.checkHost(servername)) {
                     continue;
                 }
+                // --- 找到 ---
                 cb(null, certList[i].sc);
                 certHostIndex[servername] = i;
                 return;
@@ -213,7 +235,14 @@ async function run() {
         });
     }).listen(lCore.globalConfig.httpPort);
 }
+/**
+ * --- http / https / http2 请求的回调函数 ---
+ * @param req 请求对象
+ * @param res 响应对象
+ * @param https 是否是 ssl
+ */
 async function requestHandler(req, res, https) {
+    // --- 打开计时器 ---
     const timer = {
         'timer': {},
         'timeout': 30_000,
@@ -222,6 +251,7 @@ async function requestHandler(req, res, https) {
                 return;
             }
             if (res.headersSent) {
+                // --- 已经开始输出的，需要用户自行处理 ---
                 return;
             }
             res.setHeader('content-length', 37);
@@ -230,7 +260,9 @@ async function requestHandler(req, res, https) {
         }
     };
     timer.timer = setTimeout(timer.callback, timer.timeout);
+    // --- 设置服务器名版本 ---
     res.setHeader('Server', 'Kebab/' + kebab.VER);
+    // --- 当前 uri ---
     let host = req.headers[':authority'];
     if (host === undefined || typeof host !== 'string') {
         host = req.headers['host'];
@@ -240,25 +272,41 @@ async function requestHandler(req, res, https) {
         }
     }
     const uri = lText.parseUrl(`http${https ? 's' : ''}://${host}${req.url ?? ''}`);
+    /** --- 当前的 vhost 配置文件 --- */
     const vhost = getVhostByHostname(uri.hostname ?? '');
     if (!vhost) {
         req.socket.destroy();
         return;
+        /*
+        const text = '<h1>Kebab: No permissions</h1>host: ' + (req.headers[':authority'] as string | undefined ?? req.headers['host'] ?? '') + '<br>url: ' + (lText.htmlescape(req.url ?? ''));
+        res.setHeader('content-type', 'text/html; charset=utf-8');
+        res.setHeader('content-length', Buffer.byteLength(text));
+        res.writeHead(403);
+        res.end(text);
+        return;
+        */
     }
     const vhostRoot = vhost.root.replace(/\${example}/g, kebab.ROOT_PATH + 'www/example/');
+    /** --- 网站绝对根目录，末尾带 / --- */
     let rootPath = lText.isRealPath(vhostRoot) ? vhostRoot : kebab.WWW_CWD + vhostRoot;
     if (!rootPath.endsWith('/')) {
         rootPath += '/';
     }
+    /** --- 请求的路径部分，前导带 / 末尾不一定，用户怎么请求就是什么 --- */
     let path = uri.pathname ?? '/';
     if (path !== '/') {
+        // --- 去除 ../ ./ 之类的 ---
         path = lText.urlResolve('/', path);
     }
+    /** --- [''] / ['', 'abc', 'def'] ---  */
     const pathList = path.split('/');
+    /** --- 当前处理的路径，前导不带 / 末尾带 /，例如 abc/ --- */
     let now = '';
     for (let i = 0; i < pathList.length; ++i) {
         const item = pathList[i];
         if (item !== '') {
+            // --- 判断 item 是文件还是文件夹 ---
+            /** --- 'abc' / 'def.json' ---  */
             let stat = await fs.stats(rootPath + now + item);
             if (!stat) {
                 res.setHeader('content-type', 'text/html; charset=utf-8');
@@ -269,8 +317,10 @@ async function requestHandler(req, res, https) {
             }
             if (stat.isDirectory()) {
                 now += item + '/';
+                // --- 判断是不是动态层 ---
                 stat = await fs.stats(rootPath + now + 'kebab.json');
                 if (stat) {
+                    // --- 动态层，交给 Route 处理器 ---
                     try {
                         if (await sRoute.run({
                             'req': req,
@@ -303,16 +353,20 @@ async function requestHandler(req, res, https) {
                 }
             }
             else {
+                // --- 文件，直接输出并结束 ---
                 await fs.readToResponse(rootPath + now + item, req, res, stat);
                 return;
             }
         }
         else {
+            // --- item 为空，但是 i 不是 0，则是最后一个空，直接 break ---
             if (i > 0) {
                 break;
             }
+            // --- 本层是根，判断根是不是动态层 ---
             const stat = await fs.stats(rootPath + now + 'kebab.json');
             if (stat) {
+                // --- 动态层，交给 Route 处理器 ---
                 try {
                     if (await sRoute.run({
                         'req': req,
@@ -345,6 +399,7 @@ async function requestHandler(req, res, https) {
             }
         }
     }
+    // --- 最后一层是目录，且不是动态层，判断有没有主页，有则输出，没有则 403 出错 ---
     const indexFiles = ['index.html', 'index.htm'];
     for (const indexFile of indexFiles) {
         const stat = await fs.isFile(rootPath + now + indexFile);
@@ -358,28 +413,43 @@ async function requestHandler(req, res, https) {
     res.writeHead(403);
     res.end('<h1>403 Forbidden</h1><hr>Kebab');
 }
+/**
+ * --- WebSocket 响应 handler ---
+ * @param req 请求对象
+ * @param socket socket 对象
+ * @param https 是否是 https
+ */
 async function upgradeHandler(req, socket, https) {
     socket.removeAllListeners('error');
+    // --- 当前 uri ---
     const uri = lText.parseUrl(`ws${https ? 's' : ''}://${req.headers['host'] ?? ''}${req.url ?? ''}`);
+    /** --- 当前的 vhost 配置文件 --- */
     const vhost = getVhostByHostname(uri.hostname ?? '');
     if (!vhost) {
         socket.destroy();
         return;
     }
     const vhostRoot = vhost.root.replace(/\${example}/g, kebab.ROOT_PATH + 'www/example/');
+    /** --- 网站绝对根目录，末尾带 / --- */
     let rootPath = lText.isRealPath(vhostRoot) ? vhostRoot : kebab.WWW_CWD + vhostRoot;
     if (!rootPath.endsWith('/')) {
         rootPath += '/';
     }
+    /** --- 请求的路径部分，前导带 / 末尾不一定，用户怎么请求就是什么 --- */
     let path = uri.pathname ?? '/';
     if (path !== '/') {
+        // --- 去除 ../ ./ 之类的 ---
         path = lText.urlResolve('/', path);
     }
+    /** --- [''] / ['', 'abc', 'def'] ---  */
     const pathList = path.split('/');
+    /** --- 当前处理的路径，前导不带 / 末尾带 /，例如 abc/ --- */
     let now = '';
     for (let i = 0; i < pathList.length; ++i) {
         const item = pathList[i];
         if (item !== '') {
+            // --- 判断 item 是文件还是文件夹 ---
+            /** --- 'abc' / 'def.json' ---  */
             let stat = await fs.stats(rootPath + now + item);
             if (!stat) {
                 socket.destroy();
@@ -387,8 +457,10 @@ async function upgradeHandler(req, socket, https) {
             }
             if (stat.isDirectory()) {
                 now += item + '/';
+                // --- 判断是不是动态层 ---
                 stat = await fs.stats(rootPath + now + 'kebab.json');
                 if (stat) {
+                    // --- 动态层，交给 Route 处理器 ---
                     if (await sRoute.run({
                         'req': req,
                         'socket': socket,
@@ -402,16 +474,20 @@ async function upgradeHandler(req, socket, https) {
                 }
             }
             else {
+                // --- 文件，报错 ---
                 socket.destroy();
                 return;
             }
         }
         else {
+            // --- item 为空，但是 i 不是 0，则是最后一个空，直接 break ---
             if (i > 0) {
                 break;
             }
+            // --- 判断根是不是动态层 ---
             const stat = await fs.stats(rootPath + now + 'kebab.json');
             if (stat) {
+                // --- 动态层，交给 Route 处理器 ---
                 if (await sRoute.run({
                     'req': req,
                     'socket': socket,
@@ -425,9 +501,14 @@ async function upgradeHandler(req, socket, https) {
             }
         }
     }
+    // --- 最后一层，又不是动态层 ---
     socket.destroy();
 }
+/**
+ * --- 加载/重载 vhosts 信息、重新加载全局 config、重新加载证书。（清除动态 kebab.json 信息、data 信息、语言包信息） ---
+ */
 async function reload() {
+    // --- 清除全局 config，并重新加载全局信息 ---
     const configContent = await fs.getContent(kebab.CONF_CWD + 'config.json', 'utf8');
     if (!configContent) {
         throw `File '${kebab.CONF_CWD}config.json' not found.`;
@@ -439,6 +520,7 @@ async function reload() {
     for (const key in config) {
         lCore.globalConfig[key] = config[key];
     }
+    // --- 重新加载 VHOST 信息（/conf/vhost/） ---
     const files = await fs.readDir(kebab.VHOST_CWD);
     vhosts = [];
     for (const file of files) {
@@ -457,6 +539,7 @@ async function reload() {
             vhosts.push(item);
         }
     }
+    // --- 重新加载证书对 ---
     certList.length = 0;
     try {
         const certConfig = await fs.getContent(kebab.CONF_CWD + 'cert.json', 'utf8');
@@ -481,32 +564,41 @@ async function reload() {
         }
     }
     catch {
+        // --- NOTHING ---
     }
     certHostIndex = {};
+    // --- 其他操作 ---
     sRoute.clearKebabConfigs();
     sCtr.clearLocaleData();
 }
+// --- 接收主进程回传信号，主要用来 reload，restart ---
 process.on('message', function (msg) {
     (async function () {
         switch (msg.action) {
             case 'reload': {
                 await reload();
+                // eslint-disable-next-line no-console
                 console.log(`[child] Worker ${process.pid} reload execution succeeded.`);
                 break;
             }
             case 'stop': {
+                // --- 需要停止监听，等待已有连接全部断开，然后关闭线程 ---
                 httpServer.close();
                 http2Server.close();
                 clearInterval(hbTimer);
+                // --- 等待连接全部断开 ---
+                /** --- 当前已等待时间，等待不超过 1 小时 --- */
                 let waiting = 0;
                 while (true) {
                     if (!Object.keys(linkCount).length) {
                         break;
                     }
+                    // --- 有长连接，等待中 ---
                     const str = [];
                     for (const key in linkCount) {
                         str.push(key + ':' + linkCount[key].toString());
                     }
+                    // eslint-disable-next-line no-console
                     console.log(`[child] Worker ${process.pid} busy: ${str.join(',')}.`);
                     await lCore.log({
                         'path': '',
@@ -523,6 +615,7 @@ process.on('message', function (msg) {
                         break;
                     }
                 }
+                // --- 链接全部断开 ---
                 process.exit();
                 break;
             }
@@ -532,6 +625,7 @@ process.on('message', function (msg) {
                     break;
                 }
                 if (msg.key === '__init__') {
+                    // --- 初始化 ---
                     for (const key in msg.data) {
                         lCore.global[key] = msg.data[key];
                     }
@@ -553,20 +647,28 @@ process.on('message', function (msg) {
         }, '[child][process][message]' + lText.stringifyJson(e.stack).slice(1, -1), '-error');
     });
 });
+/**
+ * --- 获取匹配的 vhost 对象 ---
+ * --- 如果有精准匹配，以精准匹配为准，否则为 2 级泛匹配（vSub），最后全局泛匹配（vGlobal） ---
+ * @param hostname 当前的 hostname，不带端口
+ */
 function getVhostByHostname(hostname) {
     let vGlobal, vSub;
     for (const vhost of vhosts) {
         for (let domain of vhost.domains) {
             if (domain === '*') {
+                // --- 全局泛匹配 ---
                 vGlobal = vhost;
             }
             else if (domain.includes('*')) {
+                // --- 2 级泛匹配 ---
                 domain = domain.replace(/\*/, '^.+?').replace(/\./, '\\.');
                 if (new RegExp(domain + '$').test(hostname)) {
                     vSub = vhost;
                 }
             }
             else if (domain === hostname) {
+                // --- 完全匹配 ---
                 return vhost;
             }
         }
@@ -580,6 +682,8 @@ function getVhostByHostname(hostname) {
     return null;
 }
 run().catch(function (e) {
+    /* eslint-disable no-console */
     console.log('[child] ------ [Process fatal Error] ------');
     console.log(e);
+    /* eslint-enable */
 });

package/sys/cmd.js

@@ -33,6 +33,11 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2020-3-7 23:51:15
+ * Last: 2020-3-7 23:51:18, 2022-07-22 14:14:09, 2022-9-27 14:52:19, 2023-5-23 21:42:46, 2024-7-2 15:12:28
+ */
 const http = __importStar(require("http"));
 const lFs = __importStar(require("../lib/fs"));
 const lText = __importStar(require("../lib/text"));
@@ -40,7 +45,9 @@ const lTime = __importStar(require("../lib/time"));
 const lCore = __importStar(require("../lib/core"));
 const lCrypto = __importStar(require("../lib/crypto"));
 const kebab = __importStar(require("../index"));
+/** --- 解析命令 --- */
 const cmds = process.argv.slice(2);
+/** --- 批量创建目录 --- */
 async function initDir(paths) {
     for (const path of paths) {
         if (await lFs.isDir(path)) {
@@ -59,8 +66,10 @@ async function initDir(paths) {
     }
     return true;
 }
+/** --- cmd 解析 --- */
 async function run() {
     if (cmds[0] === 'init' || cmds[0] === 'update') {
+        // --- 初始化、更新 ---
         if (!await initDir([
             kebab.CERT_CWD + 'default/',
             kebab.VHOST_CWD,
@@ -73,6 +82,7 @@ async function run() {
         ])) {
             return;
         }
+        // --- /conf/cert.json ---
         if (!await lFs.isFile(kebab.CONF_CWD + 'cert.json')) {
             lCore.display('KEBAB', 'CREATE', 'FILE', kebab.CONF_CWD + 'cert.json');
             if (!await lFs.putContent(kebab.CONF_CWD + 'cert.json', lText.stringifyJson([
@@ -85,6 +95,7 @@ async function run() {
                 return;
             }
         }
+        // --- /conf/config.json ---
         let config = {};
         if (await lFs.isFile(kebab.CONF_CWD + 'config.json')) {
             config = lText.parseJson((await lFs.getContent(kebab.CONF_CWD + 'config.json'))?.toString() ?? '{}');
@@ -92,18 +103,21 @@ async function run() {
         else {
             lCore.display('KEBAB', 'CREATE', 'FILE', kebab.CONF_CWD + 'config.json');
         }
+        // --- 修复 config ---
         config.httpPort ??= 8080;
         config.httpsPort ??= 4333;
         config.rpcPort ??= 10630;
         config.rpcSecret ??= 'MUSTCHANGE';
         config.debug ??= true;
         config.max ??= 64;
+        // --- config - set ---
         config.set ??= {};
         config.set.timezone ??= 8;
         config.set.mustHttps ??= false;
         config.set.cacheTtl ??= 0;
         config.set.staticVer ??= '20200314174905';
         config.set.staticPath ??= '';
+        // --- config - db ---
         config.db ??= {};
         config.db.host ??= '127.0.0.1';
         config.db.port ??= 3306;
@@ -111,12 +125,14 @@ async function run() {
         config.db.name ??= 'maiyun';
         config.db.user ??= 'root';
         config.db.pwd ??= 'DashAdmin';
+        // --- config - jwt ---
         config.jwt ??= {};
         config.jwt.name ??= 'KE_JWT';
         config.jwt.ttl ??= 172800;
         config.jwt.ssl ??= false;
         config.jwt.secret ??= 'MUSTCHANGE';
         config.jwt.auth ??= false;
+        // --- config - dns ---
         config.dns ??= {};
         config.dns['DNSPOD'] ??= {};
         config.dns['DNSPOD'].sid ??= '';
@@ -124,6 +140,7 @@ async function run() {
         config.dns['CF'] ??= {};
         config.dns['CF'].sid ??= '';
         config.dns['CF'].skey ??= '';
+        // --- config - kv ---
         config.kv ??= {};
         config.kv.host ??= '127.0.0.1';
         config.kv.port ??= 6379;
@@ -131,12 +148,15 @@ async function run() {
         config.kv.pre ??= 'm_';
         config.kv.user ??= '';
         config.kv.pwd ??= '';
+        // --- config - session ---
         config.session ??= {};
         config.session.name ??= 'KE_SESSION';
         config.session.ttl ??= 172800;
         config.session.ssl ??= false;
+        // --- config - sql ---
         config.sql ??= {};
         config.sql.pre ??= 'm_';
+        // --- config - s3 ---
         config.s3 ??= {};
         config.s3['CF'] ??= {};
         config.s3['CF'].account = '';
@@ -149,11 +169,14 @@ async function run() {
         config.s3['TENCENT'].skey = '';
         config.s3['TENCENT'].region = '';
         config.s3['TENCENT'].bucket = '';
+        // --- 保存 config.json ---
         if (!await lFs.putContent(kebab.CONF_CWD + 'config.json', lText.stringifyJson(config, 4))) {
             lCore.display('KEBAB', 'CREATE', 'FILE', kebab.CONF_CWD + 'config.json', '[FAILED]');
             return;
         }
+        // --- 只在初始化时 ---
         if (cmds[0] === 'init') {
+            // --- /conf/vhost/default.json ---
             if (!await lFs.isFile(kebab.VHOST_CWD + 'default.json')) {
                 lCore.display('KEBAB', 'CREATE', 'FILE', kebab.VHOST_CWD + 'default.json');
                 if (!await lFs.putContent(kebab.VHOST_CWD + 'default.json', lText.stringifyJson([
@@ -178,24 +201,29 @@ async function run() {
         lCore.display('DONE');
         process.exit();
     }
+    // --- 读取配置文件 ---
     const configContent = await lFs.getContent(kebab.CONF_CWD + 'config.json', 'utf8');
     if (!configContent) {
         throw `File '${kebab.CONF_CWD}config.json' not found.`;
     }
+    /** --- 系统 config.json --- */
     const config = lText.parseJson(configContent);
     for (const key in config) {
         lCore.globalConfig[key] = config[key];
     }
     if (cmds[0] === '--ind' || cmds[0] === '-i') {
+        // --- 运行独立文件，如 node ./index --ind gps ---
         if (!await lFs.isFile(kebab.IND_CWD + cmds[1] + '/index.js')) {
             lCore.display('CMD ERROR', 'IND FILE "' + cmds[1] + '" NOT FOUND.');
             return;
         }
+        // --- 载入独立文件入口 ---
         Promise.resolve(`${'../ind/' + cmds[1] + '/index'}`).then(s => __importStar(require(s))).catch((e) => {
             lCore.display('CMD ERROR', 'E', e);
         });
     }
     else {
+        // --- 其他，如 node ./index reload 或 restart ---
         const time = lTime.stamp();
         http.request({
             'hostname': '127.0.0.1',