topbit 1.0.0 → 3.0.0

package/bin/app.js

@@ -0,0 +1,17 @@
+'use strict'
+
+const Titbit = require('titbit')
+
+const app = new Titbit({
+  debug: true,
+})
+
+app.get('/', async ctx => {
+  ctx.send('success')
+})
+
+app.post('/', async ctx => {
+  ctx.send(ctx.body)
+})
+
+app.run(1234)

package/bin/loadinfo.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+if [ "$#" -eq 0 ] ; then
+    echo "usage: $0 [PATH]"
+    echo "example: $0 /tmp/loadinfo.log"
+    exit 0
+fi
+
+if [ ! -f "$1" ] ; then
+    echo "$1 is not a file"
+    exit 1
+fi
+
+while clear ; do
+    cat "$1"
+    sleep 0.35
+done
+

package/bin/new-ctl.js

@@ -0,0 +1,234 @@
+#!/usr/bin/env node
+
+'use strict'
+
+let simple_mode = false
+
+let type_context = `\n//！！注意：以下注释是为了能够在支持jsdoc的代码编辑器中提示以及方便查阅提供，不需要可以去掉。
+/**
+ * ---------------------- ctx.ext模块具备的方法 -----------------------------
+ *
+ * @typedef {object} ext
+ *   @property {function} extName(filename: string) - 解析文件扩展名。
+ *   @property {function} makeName(filename: string) - 生成唯一文件名，默认为时间字符串+随机数：2021-01-01_12-12-23_27789.jpg，filename主要用于获取扩展名。
+ *   @property {function} nrand(n, m) - 返回两个数之间的随机数。
+ *   @property {function} uuid() - 返回唯一字符串用于唯一ID，支持标准的8-4-4-4-12和短字符串8-2-2-4两种模式（传递参数为true）。
+ *   @property {function} timestr() - 默认返回年-月-日_时-分-秒，没有空格，方便保存和解析。
+ *   @property {function} sha1(text, encoding = 'hex')
+ *   @property {function} sha256(text, encoding = 'hex') 
+ *   @property {function} sha512(text, encoding = 'hex')
+ *   @property {function} sm3(text, encoding = 'hex')
+ *   @property {function} hmacsha1(text, key, encoding = 'hex')
+ *   @property {function} pipe(filename: string, reply: object)
+ *  
+ * 更多参考：{@link https://gitee.com/daoio/titbit/wikis/helper-function}
+ */
+/**
+ * --------------------------------- 请求上下文 -----------------------------------------
+ *
+ * @typedef {object} context
+ * @property {string} version - 协议版本，字符串类型，为'1.1' 或 '2' 或 '3'。
+ * @property {number} major - 协议主要版本号，1、2、3分别表示HTTP/1.1 HTTP/2 HTTP/3。
+ * @property {string} method - 请求类型，GET POST等HTTP请求类型，大写字母的字符串。
+ * @property {string} path - 具体请求的路径，比如 /x/y。
+ * @property {string} routepath - 实际执行请求的路由字符串，比如 /x/:id。
+ * @property {boolean} isUpload - 是否为上传文件请求，此时就是检测消息头content-type是否为multipart/form-data格式。
+ * @property {object} box - 默认为空对象，可以添加任何属性值，用来动态传递给下一层组件需要使用的信息。
+ * @property {object} query - url传递的参数。
+ * @property {object} param - 路由参数。
+ * @property {object} headers - 指向request.headers。
+ * @property {object} files - 上传文件保存的信息。
+ * @property {(object|string|buffer|null)} body - body请求体的数据，具体格式需要看content-type，一般为字符串或者对象，也可能是buffer。
+ * @property {object} request HTTP/1.1 - 就是http模块request事件的参数IncomingMessage对象，HTTP/2 指向stream对象。
+ * @property {object} reply - HTTP/1.1协议，指向response，HTTP/2 指向stream。
+ * @property {object} service - 用于依赖注入的对象，指向app.service。
+ * @property {function} moveFile(file: object) - 用来移动上传的文件到指定路径，file是通过getFile获取的文件对象。
+ * @property {function} getFile(name: string, index = 0) - 根据上传名获取上传的文件，如果index是-1表示获取整个数组。
+ * @property {function} sendHeader() - 发送消息头，针对http/2设计，http/1.1只是一个空函数，为了代码保持一致。
+ * @property {function} setHeader(key: string, value: string|array)
+ * @property {function} send(body: string|object|buffer) - 设置要返回的body数据。
+ * @property {function} status(code: null | number) - 设置状态码，默认为null表示返回状态码。
+ * @property {ext} ext - 指向ext模块，提供了一些助手函数，具体参考wiki。
+ * 
+ * 更多参考：{@link https://gitee.com/daoio/titbit/blob/master/README.md#%E8%AF%B7%E6%B1%82%E4%B8%8A%E4%B8%8B%E6%96%87}
+ */
+`
+
+let head_hint = `/**********************************************************************
+提示：
+  表单提交或异步请求，对应于POST或PUT请求，对应函数post和put，提交的请求体数据通过 ctx.body 获取。
+
+  路由参数通过 ctx.param 获取，示例：let id = ctx.param.id
+
+  url参数(?a=1&b=2)通过 ctx.query 获取，示例：let name = ctx.query.name
+
+  使用ctx.getFile(name)获取上传的文件，示例：let f = ctx.getFile('image')
+**********************************************************************/\n\n`
+
+function fmt_ctx_param(text) {
+  let ctx_param = `
+  /**
+   * ${text}
+   * @param {context} ctx
+   * @returns 
+   */
+`
+  return ctx_param
+}
+
+const fs = require('fs')
+
+function makeController(name) {
+  let modname = name
+  if (!(/^[A-Z].*/).test(name)) {
+    modname = name.substring(0, 1).toUpperCase() + name.substring(1)
+  }
+
+  return `'use strict'\n\n`
+        + (simple_mode ? '' : head_hint)
+        + `class ${modname} {\n\n`
+        + `  constructor() {\n`
+        + `    //param用于指定最后的路由参数，默认就是/:id\n`
+        + `    //若要改变路由，则可以设置此属性，比如设置为/:name\n`
+        + `    //this.param = '/:id'\n`
+        + `  }\n\n`
+        + `  //控制器类初始化后会执行此函数。\n`
+        + `  //service默认是app.service，此参数通过titbit-loader初始化的initArgs选项进行控制。\n`
+        + `  async init(service) {\n`
+        + `    \n`
+        + `  }\n\n`
+        + (simple_mode ? '' : `  //以下方法，若不需要，要去掉，避免无意义的路由。\n`)
+        + `${fmt_ctx_param('获取资源具体内容')}`
+        + `  async get(ctx) {\n\n`
+        + `  }\n`
+        + `${fmt_ctx_param('创建资源')}`
+        + `  async post(ctx) {\n\n`
+        + `  }\n`
+        + `${fmt_ctx_param('更新资源')}`
+        + `  async put(ctx) {\n\n`
+        + `  }\n`
+        + `${fmt_ctx_param('GET请求，用于获取资源列表')}`
+        + `  async list(ctx) {\n\n`
+        + `  }\n`
+        + `${fmt_ctx_param('删除资源')}`
+        + `  async _delete(ctx) {\n\n`
+        + `  }\n`
+        + `}\n\nmodule.exports = ${modname}\n`
+        + (simple_mode ? '' : `${type_context}`)
+
+}
+
+let limitName = [
+  'async', 'await', 'for', 'of', 'if', 'else', 'switch', 'function', 'delete', 'new', 'case', 
+  'require', 'import', 'export', 'exports', 'process', 'global', 'this', 'let', 'const', 'var',
+  'class', 'return', 'module', 'do', 'while', 'catch', 'try', 'break', 'boolean', 'instanceof',
+  'typeof', 'continue', 'fetch', 'globalThis', 'queueMicrotask'
+]
+
+let name_preg = /^[A-Za-z_][A-Za-z0-9_\-]{0,50}$/i
+
+function checkName (name) {
+  return name_preg.test(name)
+}
+
+function parseNameDir (name) {
+  let ind = name.indexOf('/')
+  let hasJS = (name.length > 3 && name.substring(name.length-3) === '.js')
+
+  if (ind > 0) {
+    let narr = name.split('/')
+    let real_name = narr[narr.length-1]
+    return {
+      dir: `/${narr[narr.length-2]}`,
+      name: hasJS ? real_name.substring(0, real_name.length-3) : real_name
+    }
+  }
+
+  return {
+    dir : '',
+    name: hasJS ? name.substring(0, name.length-3) : name
+  }
+}
+
+function filterName (name) {
+  return (limitName.indexOf(name) >= 0 ? `_${name}` : name)
+}
+
+let cdir = 'controller'
+
+let clist = []
+
+//let model_name = ''
+
+for (let i = 2; i < process.argv.length; i++) {
+  if (process.argv[i].indexOf('--cdir=') === 0) {
+
+    let t = process.argv[i].substring('--cdir='.length)
+
+    if (t.length > 0) {
+      cdir = t
+    }
+
+    continue
+  }
+
+  if (process.argv[i] === '-s' || process.argv[i] === '--pure' || process.argv[i] === '--simple')
+  {
+    simple_mode = true
+    continue
+  }
+
+  /* if (process.argv.indexOf('--model=') === 0) {
+    let mname = process.argv[i].substring('--model='.length)
+    if (mname.length > 0 && (/^[a-z0-9_][a-z\-_0-9]{0,100}$/i).test(mname)) {
+      model_name = mname
+    }
+
+    continue
+  } */
+
+  clist.push(process.argv[i])
+}
+
+try {
+  fs.accessSync(cdir) 
+} catch (err) {
+  fs.mkdirSync(cdir)
+}
+
+let nd 
+let cpath
+
+for (let c of clist) {
+  nd = parseNameDir(c)
+
+  if (!checkName(nd.name)) {
+    console.error(`${nd.name} 不符合命名要求，要求字母数字，字母开头，支持连字符和下划线(- 和 _)。(the name is illegal.)`)
+    continue
+  }
+
+  let modname = nd.name.replace(/\-+/ig, '')
+
+  if (nd.dir) {
+    try {
+      fs.accessSync(`${cdir}${nd.dir}`)
+    } catch (err) {
+      fs.mkdirSync(`${cdir}${nd.dir}`)
+    }
+  }
+
+  cpath = `${cdir}${nd.dir}/${nd.name}.js`
+
+  try {
+    fs.accessSync(cpath)
+    console.error(`${c} 已经存在。`)
+    continue
+  } catch (err) {}
+
+  try {
+    fs.writeFileSync(cpath, makeController(filterName(modname)), {encoding: 'utf8'})
+  } catch (err) {
+    console.error(err)
+  }
+
+}

package/bin/newapp.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+'use strict'
+
+//process.chdir(__dirname)
+
+const fs = require('fs')
+
+let fname = 'app.js'
+
+if (process.argv.length > 2) {
+  fname = process.argv[2]
+}
+
+//let curdir = __dirname + '/../../'
+let appfile = __dirname + '/app.js'
+
+try {
+  fs.accessSync(fname)
+  console.log('文件已存在')
+} catch (err) {
+  fs.writeFileSync(fname, fs.readFileSync(appfile))
+}

package/demo/allow.js

@@ -0,0 +1,98 @@
+'use strict';
+
+const titbit = require('../src/topbit.js');
+
+const app = new titbit({
+    debug : true,
+    allow : new Set(['127.0.0.1']),
+    maxIPRequest: 2,
+    unitTime: 10,
+    useLimit: true,
+    maxConn: 2000,
+    //http2: true,
+    showLoadInfo: true,
+    loadInfoType : 'text',
+    globalLog : true,
+    logType: 'stdio',
+    loadInfoFile : '/tmp/loadinfo.log'
+});
+
+app.use(async (c, next) => {
+  console.log('pre middleware start');
+  console.log(c.group, c.name, c.method, c.path);
+  await next(c);
+  console.log('pre middleware end');
+}, {pre : true});
+
+app.use(async (c, next) => {
+    console.log('middleware 1');
+    await next(c);
+    console.log('middleware 1 end');
+}, 'home');
+
+app.use(async (c, next) => {
+    console.log('middleware 2');
+    c.body.say = '你好';
+    await next(c);
+    console.log('middleware 2 end');
+}, {group: 'test', method: 'POST'});
+
+app.use(async (c, next) => {
+    console.log('middleware 3');
+    if (c.query.say == 'hey') {
+        c.to('你好，test 接口 GET请求结束。');
+    } else {
+        await next(c);
+    }
+    console.log('middleware 3 end');
+}, {group: 'test', method : 'GET'});
+
+app.use(async (c, next) => {
+    console.log('set body size');
+    c.maxBody = 24;
+    await next(c);
+}, {name: 'test-post', pre: true});
+
+app.use(async (c, next) => {
+    console.log('middleware 4');
+    c.body.x = 12;
+    await next(c);
+    console.log('middleware 4 end');
+}, 'test-post');
+
+app.get('/', async c => {
+    c.to('ok');
+}, 'home');
+
+app.get('/test', async c => {
+    c.to(c.name);
+}, {group: 'test', name : 'test'});
+
+app.post('/test', async c => {
+    c.to(c.body);
+}, {group: 'test', name : 'test-post'});
+
+app.post('/transmit', async c => {
+    c.to('ok');
+}, 'transmit');
+
+app.use(async (c, next) => {
+    let total = 0;
+    
+    c.box.dataHandle = (data) => {
+        total += data.length;
+        if (total > 32) {
+            c.response.statusCode = 413;
+            c.response.end('太多了，限制32字节以内');
+            return ;
+        }
+    };
+
+    await next(c);
+
+    console.log(total, 'bytes');
+
+}, {pre: true, method: 'POST', name: 'transmit'});
+
+
+app.daemon(2034, 2);

package/demo/cert/localhost-cert.pem

@@ -0,0 +1,19 @@
+-----BEGIN CERTIFICATE-----
+MIIC/jCCAeagAwIBAgIJAM7LJO+3smgrMA0GCSqGSIb3DQEBCwUAMBQxEjAQBgNV
+BAMMCWxvY2FsaG9zdDAeFw0xOTAzMTMxNDI1NDVaFw0xOTA0MTIxNDI1NDVaMBQx
+EjAQBgNVBAMMCWxvY2FsaG9zdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
+ggEBANlxw2tilmgttCHtzCkQRlbLicxSRjXEY/5JXSUZdKNGlBFLovclK/OrpixO
+c9ijw6z6TPT3yvYkF2r1GKWYZWZeSdIfnd3M8UCJr06Jh8DAFZ14YUjyPcEo0Kfi
+rJ/wecxRKsO1MehXo5YfgQ+IruuYYxyEhZOV8cmvXb7gi7hsKTnJ+2Xogef8sxlF
+bHC+ySqHsODA2W1kX03jWUq2jo3j0D1yJ+8B103e2CMeiqjuIhvAzP700IOLNF2G
+fPZ6RMLRWOTMpRMy5DtDKs/mX6Ohm7oVbpqhvC4QqP84+RyU30+/ThnU36K40rCH
+13VBi/4IThvXjjMCK06famj4bA0CAwEAAaNTMFEwHQYDVR0OBBYEFGpeaaG9leYI
+W9rfUeTlgU7F0FP7MB8GA1UdIwQYMBaAFGpeaaG9leYIW9rfUeTlgU7F0FP7MA8G
+A1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBALtt9KQO1erWzNZGFN7h
+NIsxMAg0DifUUR4HzOwVsOSjlxdkzkOylF7yYROptUIluuF90pC7RQ1EztwlPqTI
+XrpLhU/JJcAx80Z+9XJJa3hS+mctaJ+Uv0lLY5uQgrYJCsK+qJ9XMOBjA8Uziyu/
+mFgvfW/5Ts0mwTRn0MKLf2vRIH4F3syeiVLTxDJ0s6fKfrCryNSo8LGYAOfr0rCg
+4BbTyDt1UB+nTY6xM12zybJ/OtIZtfRG5JZHHsB1kbsOw+WzWrcKbsqncrivGt8m
+XgNCpvSLE4v+giPocOkX6ySq+RCTFvdlhv1bCsHlOW5vMpSur0SQLcnSUnRfk41W
+BuI=
+-----END CERTIFICATE-----

package/demo/cert/localhost-privkey.pem

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQDZccNrYpZoLbQh
+7cwpEEZWy4nMUkY1xGP+SV0lGXSjRpQRS6L3JSvzq6YsTnPYo8Os+kz098r2JBdq
+9RilmGVmXknSH53dzPFAia9OiYfAwBWdeGFI8j3BKNCn4qyf8HnMUSrDtTHoV6OW
+H4EPiK7rmGMchIWTlfHJr12+4Iu4bCk5yftl6IHn/LMZRWxwvskqh7DgwNltZF9N
+41lKto6N49A9cifvAddN3tgjHoqo7iIbwMz+9NCDizRdhnz2ekTC0VjkzKUTMuQ7
+QyrP5l+joZu6FW6aobwuEKj/OPkclN9Pv04Z1N+iuNKwh9d1QYv+CE4b144zAitO
+n2po+GwNAgMBAAECggEAZN35+dlszfzNf6Owvie3iVG3pVlRCmYEwJPFqo0JZyg5
+TWCZwy2yGsG4PvtRj+A/yAEAK+66br3FQy9Y9JAiEX+RnPBfqeEE1JxJ/xObLpWs
+MTUDY/RDI1RMnmRvEW5bAaVxQgHOmen1j5EjrFIKWm2BJFxxHkpDM/yubvn4tl5T
+JxQk+CSNsLFZ57jd8JyIugOOql7HQNyY21Si3c9Q2HXDbXvIv/s0Bw1PB1xGXBbI
+/58wz/dSajNIuYbJB3Q85PRLo12Xkb+3L5GUJDoOqrOG3aZn9OM0uNpvUNaByPyT
+wL86vlyLQAlLreAL0GDCiZAMalp1JKmNNSGqMa33oQKBgQD0Qo3m4+EW0uvijF8S
+dWdHeKT4lmoowpTCQiZpcZmJ1iWkpxAovjMwZf48j+giLIg7cYpxQHGTmryBb3F+
+bV3Vcc4QSD1r8tAgnI+WLA2rn698syuxsAG9UUpzzQgjLRY8298OIJJS3kypfCse
+hjoLwUt6kbopNn/kKXSQ2krc6QKBgQDj5UMi5Yhq5Rvof5r2j+Wr9mlYdEMOV8zc
+u5fmkrSpo/li16z7XHX/e1Srq4EAcbX7XBdZc9G5injVOrtmpeZC0+/8lU6nN4Po
+q0Ab5Wra5Ws5WU7bog2poHac+tWGItds6R5bfwes0f4AtSS3623FnynB9kOPycST
+ZeHSdtIPhQKBgAGtW1AUjH0doaUClbyItdbVyzwxvDTfcSoMTjs3HnjF0ahZxVCi
+TbOtX5uG2W8yoxTVaL/yU1VSIK062KqnkZdfmqyd8l4FYsx2hr3fO5DMHeZbTJeB
+v+FO55X3+HBVZOuyDswICTkscZZQVfN1tHxULXKAAak6yJIGfthnx0/RAoGAJLwb
+6lAdgT2VFhEbpYrkdqetq3hyJqm4eAw1HBGh1YZ8+JXTaGErFBeJOnLWxH+P2giq
+Kt0kfUf42kYxVwZ+617GXGyk1Qd519Ni7hw48Tfx5LikoXqpwSIAfKViLdEH8KJT
+JmR/lDf1PZ/1X0Av3Z8eWAmeMltPuIK/t/E3QxECgYAl76olBcjS+0LjOp10BnnZ
+M4VM4JyqjXH21OQ7YcckhugHcF12A8Y1gUsZIL/NoIEECFeor4spF2AD74AFzyPw
++WUR2BETzvsQxEp0F096LXkRT0H8IlT3ZwUbdP0//NQ4KdLyn3o+8NsDXiXqeVpp
+4Ouzs+qyLyxI2/17yodFRA==
+-----END PRIVATE KEY-----

package/demo/controller/api.js

@@ -0,0 +1,15 @@
+'use strict'
+
+class Api {
+  constructor() {
+
+  }
+
+  async get(ctx) {
+    ctx.ok([
+      ctx.method, ctx.path, ctx.routepath, ctx.param
+    ])
+  }
+}
+
+module.exports = Api

package/demo/extends.js

@@ -0,0 +1,5 @@
+'use strict'
+
+let toolkit = require('../src/topbit.js').extensions
+
+console.log(toolkit)

package/demo/group-api.js

@@ -0,0 +1,161 @@
+'use strict'
+
+const titbit = require('../lib/titbit.js')
+
+const app = new titbit({
+  debug: true,
+  loadInfoFile: '--mem',
+  http2: true,
+  allowHTTP1: true,
+  key: __dirname + '/../cache/rsa/localhost-privkey.pem',
+  cert: __dirname + '/../cache/rsa/localhost-cert.pem'
+})
+
+/* 
+app.midware.addFinal = () => {
+  return async (c, next) => {
+    return c.reply.end('ok')
+  }
+}
+
+app.pre(async (c, next) => {
+  return c.reply.end('ok')
+})
+ */
+
+app.get('/home', async c => {
+  c.setHeader('x-key', Math.random()).sendHeader().send('home page')
+}, '@home')
+
+app.get('/', async c => {
+  for (let i = 0; i < 10; i++) {
+    c.write(`${i} ${Math.random()}\n`)
+    await c.ext.delay()
+  }
+  c.send('home page')
+}, '@home')
+
+app.use(async (ctx, next) => {
+  console.log('group', ctx.group, ctx.path)
+  await next()
+  console.log('group', ctx.group, ctx.path, 'end')
+}, '@home')
+
+let mid_timing = async (c, next) => {
+  console.log('time start')
+  console.time('request')
+  await next()
+  console.timeEnd('request')
+}
+
+app.trace('/o', async c => {})
+
+app.use(async (c, next) => {
+  console.log('global request')
+  await next()
+  console.log('global request end\n')
+
+}, {pre: true})
+
+app.use(async (c, next) => {
+  console.log('global pre')
+  await next()
+  console.log('global pre end')
+
+}, {pre: true})
+
+app.router.group('/api', (route) => {
+  route.get('/test', async c => {
+    c.send('api test')
+  })
+
+  route.get('/stream', async c => {
+    for (let i = 0; i < 10; i++) {
+      await c.ext.delay(30)
+      c.write(`${i} ${Math.random()} ${Date.now()}\n`)
+    }
+  })
+
+  route.get('/:name', async c => {
+    c.send(c.param)
+  }, 'name')
+
+  route.use(async (ctx, next) => {
+    console.log('name test')
+    await next()
+    console.log('name test end')
+  }, 'name')
+
+  route.trace('/o', async c => {})
+})
+.use(async (c, next) => {
+  console.log(c.group, c.path, c.routepath)
+  await next()
+})
+.pre(async (c, next) => {
+  console.log('pre', c.method, c.headers)
+  await next()
+})
+
+app.middleware([mid_timing,], {pre: true}).group('验证', route => {
+  route.use(async (ctx, next) => {
+    console.log('    new route use test')
+    await next()
+    console.log('    new route use end')
+  })
+
+  route.get('/c/:o/:p', async c => {
+    console.log(c.group, c.name)
+    c.send(c.param)
+  })
+
+  route.middleware([
+    async (c, next) => {
+      console.log('  group sub test')
+      await next()
+      console.log('  group sub test end')
+    },
+    
+    [
+      async (c, next) => {
+        console.log('    group sub test 2')
+        await next()
+        console.log('    group sub test 2 end')
+      },
+      {pre: false}
+    ]
+  ], {pre: true, tag: 'sub'}).group('sub', r => {
+
+    r.get('/oo', async c => {
+      c.send(c.group)
+    })
+
+    r.middleware(async (c, next) => {
+      console.log('sub sub test')
+      await next()
+    }).group('/sub', subr => {
+      subr.get('/ok', async c => {
+        c.send(c.group)
+      })
+    })
+
+  })
+
+})
+
+app.group('测试', route => {
+  route.get('/test', async c => {
+    console.log(c.group, c.name)
+    c.send('test ok')
+  }, 'test')
+})
+.use(async (c, next) => {
+  console.log('测试组')
+  await next()
+})
+
+app.daemon({port: 1234}, 2)
+
+//app.run(1234)
+
+//app.isWorker && console.log(app.midware.midGroup)