ultimate-express 2.0.9 → 2.0.10

package/src/utils.js

@@ -1,372 +1,372 @@
-/*
-Copyright 2024 dimden.dev
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-const mime = require("mime-types");
-const path = require("path");
-const proxyaddr = require("proxy-addr");
-const qs = require("qs");
-const querystring = require("fast-querystring");
-const etag = require("etag");
-const { Stats } = require("fs");
-
-const EMPTY_REGEX = new RegExp(``);
-
-function fastQueryParse(query, options) {
-    const len = query.length;
-    if(len === 0){
-        return new NullObject();
-    }
-    if(len <= 128) {
-        if(!query.includes('[') && !query.includes('%5B') && !query.includes('.') && !query.includes('%2E')) {
-            // [Object: null prototype] issue
-            return {...querystring.parse(query)};
-        }
-    }
-    // [Object: null prototype] issue
-    return {...qs.parse(query, options)};
-}
-
-function removeDuplicateSlashes(path) {
-    return path.replace(/\/{2,}/g, '/');
-}
-
-function patternToRegex(pattern, isPrefix = false) {
-    if(pattern instanceof RegExp) {
-        return pattern;
-    }
-    if(isPrefix && pattern === '') {
-        return EMPTY_REGEX;
-    }
-
-    let regexPattern = pattern
-        .replaceAll('.', '\\.')
-        .replaceAll('-', '\\-')
-        .replaceAll('*', '(.*)') // Convert * to .*
-        .replace(/\/:(\w+)(\(.+?\))?\??/g, (match, param, regex) => {
-            const optional = match.endsWith('?');
-            return `\\/${optional ? '?' : ''}(?<${param}>${regex ? regex + '($|\\/)' : '[^/]+'})${optional ? '?' : ''}`;
-        }); // Convert :param to capture group
-
-    return new RegExp(`^${regexPattern}${isPrefix ? '(?=$|\/)' : '$'}`);
-}
-
-function needsConversionToRegex(pattern) {
-    if(pattern instanceof RegExp) {
-        return false;
-    }
-    if(pattern === '/*') {
-        return false;
-    }
-
-    return pattern.includes('*') ||
-        pattern.includes('?') ||
-        pattern.includes('+') ||
-        pattern.includes('(') ||
-        pattern.includes(')') ||
-        pattern.includes(':') ||
-        pattern.includes('{') ||
-        pattern.includes('}') ||
-        pattern.includes('[') ||
-        pattern.includes(']');
-}
-
-function canBeOptimized(pattern) {
-    if(pattern === '/*') {
-        return false;
-    }
-    if(pattern instanceof RegExp) {
-        return false;
-    }
-    if(
-        pattern.includes('*') ||
-        pattern.includes('?') ||
-        pattern.includes('+') ||
-        pattern.includes('(') ||
-        pattern.includes(')') ||
-        pattern.includes('{') ||
-        pattern.includes('}') ||
-        pattern.includes('[') ||
-        pattern.includes(']')
-    ) {
-        return false;
-    }
-    return true;
-}
-
-function acceptParams(str) {
-    const length = str.length;
-    const colonIndex = str.indexOf(';');
-    let index = colonIndex === -1 ? length : colonIndex;
-    const ret = { value: str.slice(0, index).trim(), quality: 1, params: {} };
-
-    while (index < length) {
-        const splitIndex = str.indexOf('=', index);
-        if (splitIndex === -1) break;
-
-        const colonIndex = str.indexOf(';', index);
-        const endIndex = colonIndex === -1 ? length : colonIndex;
-
-        if (splitIndex > endIndex) {
-            index = str.lastIndexOf(';', splitIndex - 1) + 1;
-            continue;
-        }
-
-        const key = str.slice(index, splitIndex).trim();
-        const value = str.slice(splitIndex + 1, endIndex).trim();
-
-        if (key === 'q') {
-            ret.quality = parseFloat(value);
-        } else {
-            ret.params[key] = value;
-        }
-
-        index = endIndex + 1;
-    }
-  
-    return ret;
-}
-
-function normalizeType(type) {
-    return ~type.indexOf('/') ?
-        acceptParams(type) :
-        { value: (mime.lookup(type) || 'application/octet-stream'), params: {} };
-}
-
-function stringify(value, replacer, spaces, escape) {
-    let json = replacer || spaces
-        ? JSON.stringify(value, replacer, spaces)
-        : JSON.stringify(value);
-  
-    if (escape && typeof json === 'string') {
-        json = json.replace(/[<>&]/g, function (c) {
-            switch (c.charCodeAt(0)) {
-                case 0x3c:
-                    return '\\u003c'
-                case 0x3e:
-                    return '\\u003e'
-                case 0x26:
-                    return '\\u0026'
-                default:
-                    return c
-            }
-        });
-    }
-  
-    return json;
-}
-
-const defaultSettings = {
-    'jsonp callback name': 'callback',
-    'env': () => process.env.NODE_ENV ?? 'development',
-    'etag': 'weak',
-    'etag fn': () => createETagGenerator({ weak: true }),
-    'query parser': 'extended',
-    'query parser fn': () => fastQueryParse,
-    'subdomain offset': 2,
-    'trust proxy': false,
-    'views': () => path.join(process.cwd(), 'views'),
-    'view cache': () => process.env.NODE_ENV === 'production',
-    'x-powered-by': true,
-    'case sensitive routing': true,
-    'declarative responses': true
-};
-
-function compileTrust(val) {
-    if (typeof val === 'function') return val;
-  
-    if (val === true) {
-        // Support plain true/false
-        return function(){ return true };
-    }
-  
-    if (typeof val === 'number') {
-        // Support trusting hop count
-        return function(a, i){ return i < val };
-    }
-  
-    if (typeof val === 'string') {
-        // Support comma-separated values
-        val = val.split(',')
-            .map(function (v) { return v.trim() })
-    }
-  
-    return proxyaddr.compile(val || []);
-}
-
-const shownWarnings = new Set();
-function deprecated(oldMethod, newMethod, full = false) {
-    const err = new Error();
-    const pos = full ? err.stack.split('\n').slice(1).join('\n') : err.stack.split('\n')[3].trim().split('(').slice(1).join('(').split(')').slice(0, -1).join(')');
-    if(shownWarnings.has(pos)) return;
-    shownWarnings.add(pos);
-    console.warn(`${new Date().toLocaleString('en-UK', {
-        weekday: 'short',
-        year: 'numeric',
-        month: 'short',
-        day: 'numeric',
-        hour: 'numeric',
-        minute: 'numeric',
-        second: 'numeric',
-        timeZone: 'GMT',
-        timeZoneName: 'short'
-    })} u-express deprecated ${oldMethod}: Use ${newMethod} instead at ${pos}`);
-}
-
-function findIndexStartingFrom(arr, fn, index = 0) {
-    for(let i = index, end = arr.length; i < end; i++) {
-        if(fn(arr[i], i, arr)) {
-            return i;
-        }
-    }
-    return -1;
-};
-
-function decode (path) {
-    try {
-        return decodeURIComponent(path)
-    } catch (err) {
-        return -1
-    }
-}
-
-const UP_PATH_REGEXP = /(?:^|[\\/])\.\.(?:[\\/]|$)/;
-
-function containsDotFile(parts) {
-    for(let i = 0, len = parts.length; i < len; i++) {
-        const part = parts[i];
-        if(part.length > 1 && part[0] === '.') {
-            return true;
-        }
-    }
-  
-    return false;
-}
-
-function parseTokenList(str) {
-    let end = 0;
-    const list = [];
-    let start = 0;
-  
-    // gather tokens
-    for (let i = 0, len = str.length; i < len; i++) {
-        switch(str.charCodeAt(i)) {
-            case 0x20: /*   */
-                if (start === end) {
-                    start = end = i + 1;
-                }
-                break;
-            case 0x2c: /* , */
-                if (start !== end) {
-                    list.push(str.substring(start, end));
-                }
-                start = end = i + 1;
-                break;
-            default:
-                end = i + 1;
-                break;
-        }
-    }
-  
-    // final token
-    if (start !== end) {
-        list.push(str.substring(start, end));
-    }
-  
-    return list;
-}
-
-
-function parseHttpDate(date) {
-    const timestamp = date && Date.parse(date);
-    return typeof timestamp === 'number' ? timestamp : NaN;
-}
-
-function isPreconditionFailure(req, res) {
-    const match = req.headers['if-match'];
-
-    // if-match
-    if(match) {
-        const etag = res.get('etag');
-        return !etag || (match !== '*' && parseTokenList(match).every(match => {
-            return match !== etag && match !== 'W/' + etag && 'W/' + match !== etag;
-        }));
-    }
-
-    // if-unmodified-since
-    const unmodifiedSince = parseHttpDate(req.headers['if-unmodified-since']);
-    if(!isNaN(unmodifiedSince)) {
-        const lastModified = parseHttpDate(res.get('Last-Modified'));
-        return isNaN(lastModified) || lastModified > unmodifiedSince;
-    }
-
-    return false;
-}
-
-function createETagGenerator(options) {
-    return function generateETag (body, encoding) {
-        if(body instanceof Stats) {
-            return etag(body, options);
-        }
-        const buf = !Buffer.isBuffer(body) ? Buffer.from(body, encoding) : body;
-        return etag(buf, options);
-    }
-}
-
-function isRangeFresh(req, res) {
-    const ifRange = req.headers['if-range'];
-    if(!ifRange) {
-        return true;
-    }
-
-    // if-range as etag
-    if(ifRange.indexOf('"') !== -1) {
-        const etag = res.get('etag');
-        return Boolean(etag && ifRange.indexOf(etag) !== -1);
-    }
-
-    // if-range as modified date
-    const lastModified = res.get('Last-Modified');
-    return parseHttpDate(lastModified) <= parseHttpDate(ifRange);
-}
-
-// fast null object
-const NullObject = function() {};
-NullObject.prototype = Object.create(null);
-
-module.exports = {
-    removeDuplicateSlashes,
-    patternToRegex,
-    needsConversionToRegex,
-    acceptParams,
-    normalizeType,
-    stringify,
-    defaultSettings,
-    compileTrust,
-    deprecated,
-    UP_PATH_REGEXP,
-    NullObject,
-    decode,
-    containsDotFile,
-    parseTokenList,
-    parseHttpDate,
-    isPreconditionFailure,
-    createETagGenerator,
-    isRangeFresh,
-    findIndexStartingFrom,
-    fastQueryParse,
-    canBeOptimized,
-    EMPTY_REGEX
-};
+/*
+Copyright 2024 dimden.dev
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+const mime = require("mime-types");
+const path = require("path");
+const proxyaddr = require("proxy-addr");
+const qs = require("qs");
+const querystring = require("fast-querystring");
+const etag = require("etag");
+const { Stats } = require("fs");
+
+const EMPTY_REGEX = new RegExp(``);
+
+function fastQueryParse(query, options) {
+    const len = query.length;
+    if(len === 0){
+        return new NullObject();
+    }
+    if(len <= 128) {
+        if(!query.includes('[') && !query.includes('%5B') && !query.includes('.') && !query.includes('%2E')) {
+            // [Object: null prototype] issue
+            return {...querystring.parse(query)};
+        }
+    }
+    // [Object: null prototype] issue
+    return {...qs.parse(query, options)};
+}
+
+function removeDuplicateSlashes(path) {
+    return path.replace(/\/{2,}/g, '/');
+}
+
+function patternToRegex(pattern, isPrefix = false) {
+    if(pattern instanceof RegExp) {
+        return pattern;
+    }
+    if(isPrefix && pattern === '') {
+        return EMPTY_REGEX;
+    }
+
+    let regexPattern = pattern
+        .replaceAll('.', '\\.')
+        .replaceAll('-', '\\-')
+        .replaceAll('*', '(.*)') // Convert * to .*
+        .replace(/\/:(\w+)(\(.+?\))?\??/g, (match, param, regex) => {
+            const optional = match.endsWith('?');
+            return `\\/${optional ? '?' : ''}(?<${param}>${regex ? regex + '($|\\/)' : '[^/]+'})${optional ? '?' : ''}`;
+        }); // Convert :param to capture group
+
+    return new RegExp(`^${regexPattern}${isPrefix ? '(?=$|\/)' : '$'}`);
+}
+
+function needsConversionToRegex(pattern) {
+    if(pattern instanceof RegExp) {
+        return false;
+    }
+    if(pattern === '/*') {
+        return false;
+    }
+
+    return pattern.includes('*') ||
+        pattern.includes('?') ||
+        pattern.includes('+') ||
+        pattern.includes('(') ||
+        pattern.includes(')') ||
+        pattern.includes(':') ||
+        pattern.includes('{') ||
+        pattern.includes('}') ||
+        pattern.includes('[') ||
+        pattern.includes(']');
+}
+
+function canBeOptimized(pattern) {
+    if(pattern === '/*') {
+        return false;
+    }
+    if(pattern instanceof RegExp) {
+        return false;
+    }
+    if(
+        pattern.includes('*') ||
+        pattern.includes('?') ||
+        pattern.includes('+') ||
+        pattern.includes('(') ||
+        pattern.includes(')') ||
+        pattern.includes('{') ||
+        pattern.includes('}') ||
+        pattern.includes('[') ||
+        pattern.includes(']')
+    ) {
+        return false;
+    }
+    return true;
+}
+
+function acceptParams(str) {
+    const length = str.length;
+    const colonIndex = str.indexOf(';');
+    let index = colonIndex === -1 ? length : colonIndex;
+    const ret = { value: str.slice(0, index).trim(), quality: 1, params: {} };
+
+    while (index < length) {
+        const splitIndex = str.indexOf('=', index);
+        if (splitIndex === -1) break;
+
+        const colonIndex = str.indexOf(';', index);
+        const endIndex = colonIndex === -1 ? length : colonIndex;
+
+        if (splitIndex > endIndex) {
+            index = str.lastIndexOf(';', splitIndex - 1) + 1;
+            continue;
+        }
+
+        const key = str.slice(index, splitIndex).trim();
+        const value = str.slice(splitIndex + 1, endIndex).trim();
+
+        if (key === 'q') {
+            ret.quality = parseFloat(value);
+        } else {
+            ret.params[key] = value;
+        }
+
+        index = endIndex + 1;
+    }
+  
+    return ret;
+}
+
+function normalizeType(type) {
+    return ~type.indexOf('/') ?
+        acceptParams(type) :
+        { value: (mime.lookup(type) || 'application/octet-stream'), params: {} };
+}
+
+function stringify(value, replacer, spaces, escape) {
+    let json = replacer || spaces
+        ? JSON.stringify(value, replacer, spaces)
+        : JSON.stringify(value);
+  
+    if (escape && typeof json === 'string') {
+        json = json.replace(/[<>&]/g, function (c) {
+            switch (c.charCodeAt(0)) {
+                case 0x3c:
+                    return '\\u003c'
+                case 0x3e:
+                    return '\\u003e'
+                case 0x26:
+                    return '\\u0026'
+                default:
+                    return c
+            }
+        });
+    }
+  
+    return json;
+}
+
+const defaultSettings = {
+    'jsonp callback name': 'callback',
+    'env': () => process.env.NODE_ENV ?? 'development',
+    'etag': 'weak',
+    'etag fn': () => createETagGenerator({ weak: true }),
+    'query parser': 'extended',
+    'query parser fn': () => fastQueryParse,
+    'subdomain offset': 2,
+    'trust proxy': false,
+    'views': () => path.join(process.cwd(), 'views'),
+    'view cache': () => process.env.NODE_ENV === 'production',
+    'x-powered-by': true,
+    'case sensitive routing': true,
+    'declarative responses': true
+};
+
+function compileTrust(val) {
+    if (typeof val === 'function') return val;
+  
+    if (val === true) {
+        // Support plain true/false
+        return function(){ return true };
+    }
+  
+    if (typeof val === 'number') {
+        // Support trusting hop count
+        return function(a, i){ return i < val };
+    }
+  
+    if (typeof val === 'string') {
+        // Support comma-separated values
+        val = val.split(',')
+            .map(function (v) { return v.trim() })
+    }
+  
+    return proxyaddr.compile(val || []);
+}
+
+const shownWarnings = new Set();
+function deprecated(oldMethod, newMethod, full = false) {
+    const err = new Error();
+    const pos = full ? err.stack.split('\n').slice(1).join('\n') : err.stack.split('\n')[3].trim().split('(').slice(1).join('(').split(')').slice(0, -1).join(')');
+    if(shownWarnings.has(pos)) return;
+    shownWarnings.add(pos);
+    console.warn(`${new Date().toLocaleString('en-UK', {
+        weekday: 'short',
+        year: 'numeric',
+        month: 'short',
+        day: 'numeric',
+        hour: 'numeric',
+        minute: 'numeric',
+        second: 'numeric',
+        timeZone: 'GMT',
+        timeZoneName: 'short'
+    })} u-express deprecated ${oldMethod}: Use ${newMethod} instead at ${pos}`);
+}
+
+function findIndexStartingFrom(arr, fn, index = 0) {
+    for(let i = index, end = arr.length; i < end; i++) {
+        if(fn(arr[i], i, arr)) {
+            return i;
+        }
+    }
+    return -1;
+};
+
+function decode (path) {
+    try {
+        return decodeURIComponent(path)
+    } catch (err) {
+        return -1
+    }
+}
+
+const UP_PATH_REGEXP = /(?:^|[\\/])\.\.(?:[\\/]|$)/;
+
+function containsDotFile(parts) {
+    for(let i = 0, len = parts.length; i < len; i++) {
+        const part = parts[i];
+        if(part.length > 1 && part[0] === '.') {
+            return true;
+        }
+    }
+  
+    return false;
+}
+
+function parseTokenList(str) {
+    let end = 0;
+    const list = [];
+    let start = 0;
+  
+    // gather tokens
+    for (let i = 0, len = str.length; i < len; i++) {
+        switch(str.charCodeAt(i)) {
+            case 0x20: /*   */
+                if (start === end) {
+                    start = end = i + 1;
+                }
+                break;
+            case 0x2c: /* , */
+                if (start !== end) {
+                    list.push(str.substring(start, end));
+                }
+                start = end = i + 1;
+                break;
+            default:
+                end = i + 1;
+                break;
+        }
+    }
+  
+    // final token
+    if (start !== end) {
+        list.push(str.substring(start, end));
+    }
+  
+    return list;
+}
+
+
+function parseHttpDate(date) {
+    const timestamp = date && Date.parse(date);
+    return typeof timestamp === 'number' ? timestamp : NaN;
+}
+
+function isPreconditionFailure(req, res) {
+    const match = req.headers['if-match'];
+
+    // if-match
+    if(match) {
+        const etag = res.get('etag');
+        return !etag || (match !== '*' && parseTokenList(match).every(match => {
+            return match !== etag && match !== 'W/' + etag && 'W/' + match !== etag;
+        }));
+    }
+
+    // if-unmodified-since
+    const unmodifiedSince = parseHttpDate(req.headers['if-unmodified-since']);
+    if(!isNaN(unmodifiedSince)) {
+        const lastModified = parseHttpDate(res.get('Last-Modified'));
+        return isNaN(lastModified) || lastModified > unmodifiedSince;
+    }
+
+    return false;
+}
+
+function createETagGenerator(options) {
+    return function generateETag (body, encoding) {
+        if(body instanceof Stats) {
+            return etag(body, options);
+        }
+        const buf = !Buffer.isBuffer(body) ? Buffer.from(body, encoding) : body;
+        return etag(buf, options);
+    }
+}
+
+function isRangeFresh(req, res) {
+    const ifRange = req.headers['if-range'];
+    if(!ifRange) {
+        return true;
+    }
+
+    // if-range as etag
+    if(ifRange.indexOf('"') !== -1) {
+        const etag = res.get('etag');
+        return Boolean(etag && ifRange.indexOf(etag) !== -1);
+    }
+
+    // if-range as modified date
+    const lastModified = res.get('Last-Modified');
+    return parseHttpDate(lastModified) <= parseHttpDate(ifRange);
+}
+
+// fast null object
+const NullObject = function() {};
+NullObject.prototype = Object.create(null);
+
+module.exports = {
+    removeDuplicateSlashes,
+    patternToRegex,
+    needsConversionToRegex,
+    acceptParams,
+    normalizeType,
+    stringify,
+    defaultSettings,
+    compileTrust,
+    deprecated,
+    UP_PATH_REGEXP,
+    NullObject,
+    decode,
+    containsDotFile,
+    parseTokenList,
+    parseHttpDate,
+    isPreconditionFailure,
+    createETagGenerator,
+    isRangeFresh,
+    findIndexStartingFrom,
+    fastQueryParse,
+    canBeOptimized,
+    EMPTY_REGEX
+};