jj.js 0.8.8 → 0.10.0

package/lib/pagination.js

@@ -1,183 +1,222 @@
-const {page: cfg_page} = require('./config');
-const Context = require('./context');
-
-class Pagination extends Context
-{
-    constructor(ctx) {
-        super(ctx);
-        this._page = 1;
-        this._pageSize = 10;
-        this._total = 0;
-        this._totalPage = 0;
-        this.init();
-    }
-
-    // 分页配置
-    init(options) {
-        this.options = {...cfg_page, ...options};
-        this._pageKey = this.options.page_key;
-        this._keyOrigin = this.options.key_origin;
-        this._ctxPage = this.ctx
-            && this.ctx[this._keyOrigin]
-            && this.ctx[this._keyOrigin][this._pageKey]
-            && +this.ctx[this._keyOrigin][this._pageKey];
-        this.page(this._ctxPage);
-        this.pageSize(this.options.page_size);
-        return this;
-    }
-
-    // 设置或获取当前页
-    page(page) {
-        if(typeof page != 'undefined') {
-            this._page = parseInt(page) || 1;
-            return this;
-        } else {
-            return this._page;
-        }
-    }
-
-    // 设置或获取分页大小
-    pageSize(page_size) {
-        if(page_size) {
-            this._pageSize = page_size;
-            return this;
-        } else {
-            return this._pageSize;
-        }
-    }
-
-    // 设置或获取总数
-    total(total) {
-        if(typeof total != 'undefined') {
-            this._total = parseInt(total) || 0;
-            return this;
-        } else {
-            return this._total;
-        }
-    }
-
-    // 渲染html
-    render(total, page, page_size) {
-        this.total(total);
-        this.page(page);
-        this.pageSize(page_size);
-        this._totalPage = Math.ceil(this._total / this._pageSize);
-
-        return this._initRule().options['template'].replace(/\$\{(\w+)\}/g, (...args) => {
-            return this['_' + args[1]]();
-        });
-    }
-
-    // 首页
-    _index() {
-        return !this._totalPage || this._page == 1 ? '' : this._parseTpl('index_tpl', 1);
-    }
-
-    // 末页
-    _end() {
-        return !this._totalPage || this._page == this._totalPage ? '' : this._parseTpl('end_tpl', this._totalPage);
-    }
-
-    // 上一页
-    _prev() {
-        return !this._totalPage || this._page == 1 ? '' : this._parseTpl('prev_tpl', this._page - 1);
-    }
-
-    // 下一页
-    _next() {
-        return !this._totalPage || this._page == this._totalPage ? '' : this._parseTpl('next_tpl', this._page + 1);
-    }
-
-    // 信息
-    _info() {
-        return this._parseTpl('info_tpl', this._totalPage);
-    }
-
-    // 分页
-    _list() {
-        let list = '';
-        let list_start = 1;
-        let list_end = this.options.page_length;
-        const list_left = parseInt(this.options.page_length / 2);
-
-        if(this._page >= list_end) {
-            list_start = this._page - list_left;
-            list_end = this._page + this.options.page_length - list_left - 1;
-        }
-        if(list_end > this._totalPage) {
-            list_end = this._totalPage;
-            list_start = this._totalPage - this.options.page_length + 1;
-        }
-        if(list_start < 1) {
-            list_start = 1;
-        }
-
-        for(list_start; list_start <= list_end; list_start++) {
-            list += this._parseTpl(list_start == this._page ? 'active_tpl' : 'list_tpl', list_start);
-        }
-        
-        return list;
-    }
-
-    // 解析模块
-    _parseTpl(tpl_key, num) {
-        return this.options[tpl_key].replace(/\$\{(\w+)\}/g, (...args) => {
-            return args[1] == 'url' ? this._parseUrl(num) : args[1] == 'page' ? num : args[1] == 'total' ? this._total : this._totalPage;
-        });
-    }
-
-    // 解析网址
-    _parseUrl(page) {
-        return (page == 1 ? this._urlIndex : this._urlPage).replace('${page}', page);
-    }
-
-    // 初始网址规则
-    _initRule() {
-        let url_index = this.options.url_index;
-        let url_page = this.options.url_page;
-
-        if(url_index.slice(0, 1) == ':') {
-            url_index = this.$url.ruleUrl(url_index.substr(1), {[this._pageKey]: '__page__'}).replace('__page__', '${page}');
-        }
-
-        if(url_page.slice(0, 1) == ':') {
-            url_page = this.$url.ruleUrl(url_page.substr(1), {[this._pageKey]: '__page__'}).replace('__page__', '${page}');
-        }
-
-        if(url_index == '' || url_page == '') {
-            const url = this.ctx.url;
-            const arr = url.split('?');
-            let url_rule = '';
-            if(this._ctxPage) {
-                url_rule =
-                    this._keyOrigin == 'query'
-                    ?
-                    url.replace(this._pageKey + '=' + this._page, this._pageKey + '=${page}')
-                    :
-                    arr[0].replace(/(\d+)/g, (...args) => {
-                        return args[1] == this._page ? '${page}' : args[1];
-                    }) + (arr[1] ? ('?' + arr[1]) : '');
-
-                url_index || (url_index = url_rule);
-                url_page || (url_page = url_rule);
-            } else {
-                url_index || (url_index = url);
-                url_rule =
-                    this._keyOrigin == 'query'
-                    ?
-                    url + (arr[1] ? '&' : '?') + this._pageKey + '=${page}'
-                    :
-                    arr[0].replace(/\/$/g, '') + '/${page}' + (arr[1] ? ('?' + arr[1]) : '');
-                url_index || (url_index = url);
-                url_page || (url_page = url_rule);
-            }
-        }
-
-        this._urlIndex = url_index;
-        this._urlPage = url_page;
-
-        return this;
-    }
-}
-
+const {page: cfg_page} = require('./config');
+const Context = require('./context');
+
+/**
+ * @extends Context
+ */
+class Pagination extends Context
+{
+    /**
+     * Initialize a new `Pagination`
+     * @public
+     * @param {import('../types').KoaCtx} ctx
+     */
+    constructor(ctx) {
+        super(ctx);
+        this._page = 1;
+        this._pageSize = 10;
+        this._total = 0;
+        this._totalPage = 0;
+        this.init();
+    }
+
+    /**
+     * 分页配置
+     * @public
+     * @param {import('../types').PageConfig} [options]
+     * @returns {this}
+     */
+    init(options) {
+        /**
+         * @type {import('../types').PageConfig}
+         * @private
+         */
+        this.options = {...cfg_page, ...options};
+        this._pageKey = this.options.page_key;
+        this._keyOrigin = this.options.key_origin;
+        this._ctxPage = this.ctx
+            && this.ctx[this._keyOrigin]
+            && this.ctx[this._keyOrigin][this._pageKey]
+            && +this.ctx[this._keyOrigin][this._pageKey];
+        this.page(this._ctxPage);
+        this.pageSize(this.options.page_size);
+        return this;
+    }
+
+    /**
+     * 设置或获取当前页码
+     * @public
+     * @param {number} [page]
+     * @returns {(this|number)}
+     */
+    page(page) {
+        if(typeof page != 'undefined') {
+            this._page = page || 1;
+            return this;
+        } else {
+            return this._page;
+        }
+    }
+
+    /**
+     * 设置或获取分页大小
+     * @public
+     * @param {number} [page_size]
+     * @returns {(this|number)}
+     */
+    pageSize(page_size) {
+        if(page_size) {
+            this._pageSize = page_size;
+            return this;
+        } else {
+            return this._pageSize;
+        }
+    }
+
+    /**
+     * 设置或获取总数
+     * @public
+     * @param {number} [total]
+     * @returns {(this|number)}
+     */
+    total(total) {
+        if(typeof total != 'undefined') {
+            this._total = total || 0;
+            return this;
+        } else {
+            return this._total;
+        }
+    }
+
+    /**
+     * 渲染生成分页html
+     * @public
+     * @param {number} [total] - 数据总数
+     * @param {number} [page] - 当前分页
+     * @param {number} [page_size] - 分页大小
+     * @returns {string}
+     */
+    render(total, page, page_size) {
+        this.total(total);
+        this.page(page);
+        this.pageSize(page_size);
+        this._totalPage = Math.ceil(this._total / this._pageSize);
+
+        return this._initRule().options['template'].replace(/\$\{(\w+)\}/g, (...args) => {
+            return this['_' + args[1]]();
+        });
+    }
+
+    // 首页
+    _index() {
+        return !this._totalPage || this._page == 1 ? '' : this._parseTpl('index_tpl', 1);
+    }
+
+    // 末页
+    _end() {
+        return !this._totalPage || this._page == this._totalPage ? '' : this._parseTpl('end_tpl', this._totalPage);
+    }
+
+    // 上一页
+    _prev() {
+        return !this._totalPage || this._page == 1 ? '' : this._parseTpl('prev_tpl', this._page - 1);
+    }
+
+    // 下一页
+    _next() {
+        return !this._totalPage || this._page == this._totalPage ? '' : this._parseTpl('next_tpl', this._page + 1);
+    }
+
+    // 信息
+    _info() {
+        return this._parseTpl('info_tpl', this._totalPage);
+    }
+
+    // 分页
+    _list() {
+        let list = '';
+        let list_start = 1;
+        let list_end = this.options.page_length;
+        const list_left = this.options.page_length / 2;
+
+        if(this._page >= list_end) {
+            list_start = this._page - list_left;
+            list_end = this._page + this.options.page_length - list_left - 1;
+        }
+        if(list_end > this._totalPage) {
+            list_end = this._totalPage;
+            list_start = this._totalPage - this.options.page_length + 1;
+        }
+        if(list_start < 1) {
+            list_start = 1;
+        }
+
+        for(list_start; list_start <= list_end; list_start++) {
+            list += this._parseTpl(list_start == this._page ? 'active_tpl' : 'list_tpl', list_start);
+        }
+        
+        return list;
+    }
+
+    // 解析模块
+    _parseTpl(tpl_key, num) {
+        return this.options[tpl_key].replace(/\$\{(\w+)\}/g, (...args) => {
+            return args[1] == 'url' ? this._parseUrl(num) : args[1] == 'page' ? num : args[1] == 'total' ? this._total : this._totalPage;
+        });
+    }
+
+    // 解析网址
+    _parseUrl(page) {
+        return (page == 1 ? this._urlIndex : this._urlPage).replace('${page}', page);
+    }
+
+    // 初始网址规则
+    _initRule() {
+        let url_index = this.options.url_index;
+        let url_page = this.options.url_page;
+
+        if(url_index.slice(0, 1) == ':') {
+            url_index = this.$url.ruleUrl(url_index.substr(1), {[this._pageKey]: '__page__'}).replace('__page__', '${page}');
+        }
+
+        if(url_page.slice(0, 1) == ':') {
+            url_page = this.$url.ruleUrl(url_page.substr(1), {[this._pageKey]: '__page__'}).replace('__page__', '${page}');
+        }
+
+        if(url_index == '' || url_page == '') {
+            const url = this.ctx.url;
+            const arr = url.split('?');
+            let url_rule = '';
+            if(this._ctxPage) {
+                url_rule =
+                    this._keyOrigin == 'query'
+                    ?
+                    url.replace(this._pageKey + '=' + this._page, this._pageKey + '=${page}')
+                    :
+                    arr[0].replace(/(\d+)/g, (...args) => {
+                        return args[1] == this._page ? '${page}' : args[1];
+                    }) + (arr[1] ? ('?' + arr[1]) : '');
+
+                url_index || (url_index = url_rule);
+                url_page || (url_page = url_rule);
+            } else {
+                url_index || (url_index = url);
+                url_rule =
+                    this._keyOrigin == 'query'
+                    ?
+                    url + (arr[1] ? '&' : '?') + this._pageKey + '=${page}'
+                    :
+                    arr[0].replace(/\/$/g, '') + '/${page}' + (arr[1] ? ('?' + arr[1]) : '');
+                url_index || (url_index = url);
+                url_page || (url_page = url_rule);
+            }
+        }
+
+        this._urlIndex = url_index;
+        this._urlPage = url_page;
+
+        return this;
+    }
+}
+
 module.exports = Pagination;

package/lib/response.js

@@ -2,61 +2,115 @@ const {tpl: cfg_tpl} = require('./config');
 const {parseError} = require('./utils/error');
 const Context = require('./context');
 
+/**
+ * @extends Context
+ */
 class Response extends Context
 {
+    /**
+     * Initialize a new `Response`
+     * @public
+     * @param {import('../types').KoaCtx} ctx
+     */
     constructor(ctx) {
         super(ctx);
-        this.tpl_jump = cfg_tpl.jump;
-        this.wait = 3;
-        this.tpl_exception = cfg_tpl.exception;
+        this._tpl_jump = cfg_tpl.jump;
+        this._wait = 3;
+        this._tpl_exception = cfg_tpl.exception;
     }
 
+    /**
+     * 直接输出内容
+     * @public
+     * @param {*} data
+     */
     show(data) {
         this.ctx.body = data;
     }
 
+    /**
+     * 跳转重定向
+     * @public
+     * @param {*} url
+     * @param {number} status
+     */
     redirect(url, status=302) {
         this.ctx.status = status;
         this.ctx.redirect(this.$url.build(url));
     }
 
+    /**
+     * 输出成功提示（html|json）
+     * @public
+     * @param {(string|object)} [msg]
+     * @param {(string|object)} [url]
+     */
     success(msg='操作成功！', url) {
         typeof msg == 'object' && ([msg, url] = ['操作成功！', msg]);
         url = typeof url == 'string' ? this.$url.build(url) : (url || this.ctx.header.referer);
         this.jump(msg, url, 1);
     }
 
+    /**
+     * 输出错误提示（html|json）
+     * @public
+     * @param {(string|object)} [msg]
+     * @param {(string|object)} [url]
+     */
     error(msg='操作失败！', url) {
         typeof msg == 'object' && ([msg, url] = ['操作失败！', msg]);
         url = typeof url == 'string' ? this.$url.build(url) : (url || 'javascript:history.back(-1);');
         this.jump(msg, url, 0);
     }
 
+    /**
+     * jump
+     * @api protected
+     * @param {(string|object)} msg
+     * @param {(string|object)} url
+     * @param {number} state 
+     */
     jump(msg, url, state=1) {
-        const tplData = {state, msg, url, wait: this.wait};
-        this.ctx.body = this.isAjax() ? {state, msg, data: url} : this.tpl_jump.replace(/\{\$(\w+)\}/g, (...args) => {
+        const tplData = {state, msg, url, wait: this._wait};
+        this.ctx.body = this.isAjax() ? {state, msg, data: url} : this._tpl_jump.replace(/\{\$(\w+)\}/g, (...args) => {
             return tplData[args[1]];
         });
     }
 
+    /**
+     * 设置跳转等待时间
+     * @public
+     * @param {number} time - 单位秒
+     * @returns {this}
+     */
     wait(time) {
-        this.wait = time;
+        this._wait = time;
         return this;
     }
 
+    /**
+     * 输出异常信息（html|json）
+     * @public
+     * @param {Error} err
+     */
     exception(err) {
         const escapeHtml = require('escape-html');
         const tplData = parseError(err);
         tplData.msg = escapeHtml(tplData.msg);
         tplData.code = '<span class="line">' + tplData.code.map(str => escapeHtml(str)).join('</span><span class="line">') + '</span>';
         tplData.stack = tplData.stack.map(str => escapeHtml(str)).join('<br>');
-        this.ctx.body = this.isAjax() ? {state: 0, msg: tplData.msg} : this.tpl_exception.replace(/\{\$(\w+)\}/g, (...args) => {
+        this.ctx.body = this.isAjax() ? {state: 0, msg: tplData.msg} : this._tpl_exception.replace(/\{\$(\w+)\}/g, (...args) => {
             return tplData[args[1]];
         });
     }
 
+    /**
+     * 判断是否ajax请求
+     * @public
+     * @returns {boolean}
+     */
     isAjax() {
-        return this.ctx.headers['x-requested-with'] && this.ctx.headers['x-requested-with'].toLowerCase() == 'xmlhttprequest'
+        return this.ctx.headers['x-requested-with'] && String(this.ctx.headers['x-requested-with']).toLowerCase() == 'xmlhttprequest'
             || this.ctx.request.type.toLowerCase() == 'application/json'
             || this.ctx.query.is_ajax
             || this.ctx.request.body && this.ctx.request.body.is_ajax

package/lib/router.js

@@ -1,4 +1,4 @@
-const router = require('@koa/router')();
+const router = new (require('@koa/router'));
 const {app: cfg_app, routes: cfg_routes} = require('./config');
 const {toLine} = require('./utils/str');
 const run = require('./run');
@@ -11,7 +11,7 @@ if (cfg_routes) {
         if(!~methods.indexOf(item.method)) {
             throw new Error(`RouteError: 未知路由方法：${item.method}`);
         }
-        if(typeof item.path === 'function'){
+        if(typeof item.path === 'function') {
             router[item.method](item.url, item.path);
             continue;
         }
@@ -39,7 +39,7 @@ router.all(cfg_app.app_multi ? '/:APP?/:CONTROLLER?/:ACTION?' : '/:CONTROLLER?/:
     delete ctx.params.APP;
     delete ctx.params.CONTROLLER;
     delete ctx.params.ACTION;
-    await run(ctx, next);
+    ctx.APP != 'favicon.ico' && ctx.CONTROLLER != 'favicon.ico' && await run(ctx, next);
 });
 
 module.exports = router;

package/lib/run.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const loader = require('./loader');
-const {readFile} = require('./utils/fs');
+const {readFile} = require('fs').promises;
 const {toHump} = require('./utils/str');
 const {app: cfg_app, view: cfg_view, db, page, log, cache, cookie, tpl} = require('./config');
 const compose = require('koa-compose');
@@ -8,11 +8,11 @@ const Logger = require('./logger');
 
 async function run(ctx, next, control_type=cfg_app.controller_folder) {
     if(cfg_app.app_debug) {
-        Logger.debug(ctx.request);
-        Logger.debug(`Router(${control_type}): {APP: '${ctx.APP}', CONTROLLER: '${ctx.CONTROLLER}', ACTION: '${ctx.ACTION}'}`);
-        Object.keys(ctx.params).length && Logger.debug({Params: ctx.params});
-        Object.keys(ctx.query).length && Logger.debug({Get: ctx.query});
-        Object.keys(ctx.request.body || {}).length && Logger.debug({Post: ctx.request.body});
+        Logger.http('Request:', ctx.request);
+        Logger.http(`Router(${control_type}): {APP: '${ctx.APP}', CONTROLLER: '${ctx.CONTROLLER}', ACTION: '${ctx.ACTION}'}`);
+        Object.keys(ctx.params).length && Logger.http('Params:', ctx.params);
+        Object.keys(ctx.query).length && Logger.http('Get:', ctx.query);
+        Object.keys(ctx.request.body || {}).length && Logger.http('Post:', ctx.request.body);
     }
     
     // 设置根加载器