一大波更新

v2
yutent 2023-10-26 19:02:46 +08:00
parent 6b3a44d387
commit 94a997bb8a
8 changed files with 360 additions and 462 deletions

220
index.js
View File

@ -8,15 +8,15 @@ import 'es.shim'
import Parser from './lib/index.js'
import { parseCookie } from './lib/cookie.js'
import fs from 'iofs'
import URL from 'url'
import QS from 'querystring'
import PATH from 'path'
import { fileURLToPath, parse } from 'node:url'
import QS from 'node:querystring'
import { dirname, resolve } from 'node:path'
const DEFAULT_FORM_TYPE = 'application/x-www-form-urlencoded'
const __dirname = PATH.dirname(URL.fileURLToPath(import.meta.url))
const __dirname = dirname(fileURLToPath(import.meta.url))
const tmpdir = PATH.resolve(__dirname, '.tmp/')
const tmpdir = resolve(__dirname, '.tmp/')
const encode = encodeURIComponent
const decode = decodeURIComponent
@ -36,33 +36,46 @@ function hideProperty(host, name, value) {
}
export default class Request {
#req = null
#res = null
#query = null
#body = null
#cookies = Object.create(null)
method = 'GET'
path = []
url = ''
host = '127.0.0.1'
constructor(req, res) {
this.method = req.method.toUpperCase()
this.params = {}
hideProperty(this, 'origin', { req, res })
hideProperty(this, '__GET__', null)
hideProperty(this, '__POST__', null)
hideProperty(this, '__COOKIE__', parseCookie(this.header('cookie') || ''))
this.__fixUrl()
this.#req = req
this.#res = res
this.host = req.headers['host']
this.#cookies = parseCookie(this.headers['cookie'] || '')
this.#init()
}
// 修正请求的url
__fixUrl() {
let _url = URL.parse(this.origin.req.url)
#init() {
let _url = parse(this.#req.url)
.pathname.slice(1)
.replace(/[\/]+$/, '')
let app = '' // 将作为主控制器(即apps目录下的应用)
let pathArr = []
let tmpArr = []
// URL上不允许有非法字符
if (/[^\w-/.@~!$&:+'=]/.test(decode(_url))) {
this.origin.res.rendered = true
this.origin.res.writeHead(400, {
if (/[^\w-/.,@~!$&:+'"=]/.test(decode(_url))) {
this.#res.rendered = true
this.#res.writeHead(400, {
'X-debug': `url [/${encode(_url)}] contains invalid characters`
})
return this.origin.res.end(`Invalid characters: /${_url}`)
return this.#res.end(`Invalid characters: /${_url}`)
}
// 修正url中可能出现的"多斜杠"
@ -85,88 +98,28 @@ export default class Request {
pathArr.shift()
// 将path第3段之后的部分, 每2个一组转为key-val数据对象, 存入params中
tmpArr = pathArr.slice(1).concat()
while (tmpArr.length) {
this.params[tmpArr.shift()] = tmpArr.shift() || null
}
tmpArr = undefined
for (let i in this.params) {
if (!this.params[i]) {
continue
}
// 修正数字类型,把符合条件的数字字符串转为数字(也许会误转, 但总的来说是利大弊)
this.params[i] = Number.parse(this.params[i])
}
this.app = app
this.url = _url
this.path = pathArr
}
/**
* [get 同php的$_GET]
*/
get(key = '', xss = true) {
xss = !!xss
if (!this.__GET__) {
let para = URL.parse(this.origin.req.url).query
para = Object.assign({}, QS.parse(para))
if (xss) {
for (let i in para) {
if (!para[i]) {
continue
}
if (Array.isArray(para[i])) {
para[i] = para[i].map(it => {
it = Number.parse(it.trim().xss())
return it
})
} else {
para[i] = Number.parse(para[i].trim().xss())
}
}
}
this.__GET__ = para
}
return key
? this.__GET__.hasOwnProperty(key)
? this.__GET__[key]
: null
: this.__GET__
}
/**
* [post 接收post, 需要 await ]
* [解析请求体, 需要 await ]
* @param {Str} key [字段]
*/
post(key = '', xss = true) {
let para = {}
#parseBody() {
let out = Promise.defer()
let form, contentType
xss = !!xss
//如果之前已经缓存过,则直接从缓存读取
if (this.__POST__) {
if (key) {
return this.__POST__.hasOwnProperty(key) ? this.__POST__[key] : null
} else {
return this.__POST__
}
}
this.#body = {}
contentType = this.header('content-type') || DEFAULT_FORM_TYPE
form = new Parser()
form.uploadDir = tmpdir
form.parse(this.origin.req)
form = new Parser(this.#req, { uploadDir: tmpdir })
form.on('field', (name, value) => {
form
.on('field', (name, value) => {
if (name === false) {
para = value
this.#body = value
return
}
if (~contentType.indexOf('urlencoded')) {
@ -178,14 +131,10 @@ export default class Request {
if (value.slice(0, 1) === '=') value = '=' + value
return Object.assign(para, JSON.parse(name + value))
return Object.assign(this.#body, JSON.parse(name + value))
}
}
if (typeof value === 'string') {
value = xss ? value.xss() : value
}
if (name.slice(-2) === '[]') {
name = name.slice(0, -2)
if (typeof value === 'string') {
@ -200,61 +149,54 @@ export default class Request {
let pkey = name.slice(name.lastIndexOf('[') + 1, -1)
name = name.slice(0, name.lastIndexOf('['))
if (!para.hasOwnProperty(name)) {
para[name] = {}
if (!this.#body.hasOwnProperty(name)) {
this.#body[name] = {}
}
if (!para[name].hasOwnProperty(pkey)) {
para[name][pkey] = {}
if (!this.#body[name].hasOwnProperty(pkey)) {
this.#body[name][pkey] = {}
}
para[name][pkey][key] = value
this.#body[name][pkey][key] = value
} else {
if (!para.hasOwnProperty(name)) {
para[name] = {}
if (!this.#body.hasOwnProperty(name)) {
this.#body[name] = {}
}
para[name][key] = value
this.#body[name][key] = value
}
return
}
para[name] = value
this.#body[name] = value
})
form.on('file', (name, file) => {
.on('file', (name, file) => {
if (name.slice(-2) === '[]') {
name = name.slice(0, -2)
}
if (!para.hasOwnProperty(name)) {
para[name] = file
if (!this.#body.hasOwnProperty(name)) {
this.#body[name] = file
} else {
if (!Array.isArray(para[name])) {
para[name] = [para[name]]
if (!Array.isArray(this.#body[name])) {
this.#body[name] = [this.#body[name]]
}
para[name].push(file)
this.#body[name].push(file)
}
})
form.on('error', out.reject)
form.on('end', err => {
.on('error', out.reject)
.on('end', err => {
if (~contentType.indexOf('urlencoded')) {
for (let i in para) {
if (typeof para[i] === 'string') {
if (!para[i]) {
for (let i in this.#body) {
if (typeof this.#body[i] === 'string') {
if (!this.#body[i]) {
continue
}
para[i] = Number.parse(para[i])
this.#body[i] = Number.parse(this.#body[i])
}
}
}
this._postParam = para
if (key) {
return out.resolve(para.hasOwnProperty(key) ? para[key] : null)
} else {
return out.resolve(para)
}
out.resolve(this.#body)
})
return out.promise
}
@ -262,23 +204,47 @@ export default class Request {
//获取响应头
header(key = '') {
key = key ? (key + '').toLowerCase() : null
return !!key ? this.origin.req.headers[key] : this.origin.req.headers
return !!key ? this.#req.headers[key] : this.#req.headers
}
// 读取cookie
cookie(key) {
if (key) {
return this.__COOKIE__[key]
return this.#cookies[key]
}
return this.__COOKIE__
return this.#cookies
}
get query() {
if (!this.#query) {
let para = parse(this.#req.url).query
this.#query = {}
para = Object.assign(this.#query, QS.parse(para))
}
return this.#query
}
get body() {
if (this.#body) {
return this.#body
}
return this.#parseBody()
}
get cookies() {
return this.#cookies
}
get headers() {
return this.#req.headers
}
//获取客户端IP
ip() {
get ip() {
return (
this.header('x-real-ip') ||
this.header('x-forwarded-for') ||
this.origin.req.connection.remoteAddress.replace('::ffff:', '')
this.headers['x-real-ip'] ||
this.headers['x-forwarded-for'] ||
this.#req.connection.remoteAddress.replace('::ffff:', '')
)
}
}

View File

@ -1,9 +1,7 @@
import { WriteStream } from 'node:fs'
import { EventEmitter } from 'node:events'
export default class File extends EventEmitter {
#stream = null
size = 0
@ -12,7 +10,7 @@ export default class File extends EventEmitter {
type = null
lastModifiedDate = null
constructor(props = {}){
constructor(props = {}) {
super()
for (var key in props) {
@ -38,9 +36,7 @@ export default class File extends EventEmitter {
}
write(buffer, cb) {
this.#stream.write(buffer, _ =>{
this.#stream.write(buffer, _ => {
this.lastModifiedDate = new Date()
this.size += buffer.length
this.emit('progress', this.size)
@ -49,13 +45,9 @@ export default class File extends EventEmitter {
}
end(cb) {
this.#stream.end(() => {
this.emit('end')
cb()
})
}
}

View File

@ -1,21 +1,19 @@
import crypto from 'node:crypto'
import fs from 'node:fs'
import util from 'node:util'
import path from 'node:path'
import File from './file.js'
import { EventEmitter } from 'node:events'
import { Stream } from 'node:stream'
import { StringDecoder } from 'node:string_decoder'
import File from './file.js'
import { MultipartParser } from './multipart_parser.js'
import { QuerystringParser } from './querystring_parser.js'
import { OctetParser } from './octet_parser.js'
import { JSONParser } from './json_parser.js'
function dummyParser(self) {
return {
end: function() {
end: function () {
self.ended = true
self._maybeEnd()
return null
@ -23,130 +21,64 @@ function dummyParser(self) {
}
}
export default class IncomingForm{
export default class IncomingForm extends EventEmitter {
#req = null
constructor(opts = {}) {
error = null
ended = false
headers = null
type = null
this.error = null
this.ended = false
bytesReceived = null
bytesExpected = null
_parser = null
_flushing = 0
_fieldsSize = 0
openedFiles = []
constructor(req, opts = {}) {
super()
this.#req = req
this.maxFields = opts.maxFields || 1000
this.maxFieldsSize = opts.maxFieldsSize || 2 * 1024 * 1024
this.keepExtensions = opts.keepExtensions || false
this.uploadDir = opts.uploadDir
this.encoding = opts.encoding || 'utf-8'
this.headers = null
this.type = null
this.hash = opts.hash || false
this.multiples = opts.multiples || false
this.bytesReceived = null
this.bytesExpected = null
this._parser = null
this._flushing = 0
this._fieldsSize = 0
this.openedFiles = []
}
parse(req, cb) {
this.pause = function() {
try {
req.pause()
} catch (err) {
// the stream was destroyed
if (!this.ended) {
// before it was completed, crash & burn
this._error(err)
}
return false
}
return true
}
this.resume = function() {
try {
req.resume()
} catch (err) {
// the stream was destroyed
if (!this.ended) {
// before it was completed, crash & burn
this._error(err)
}
return false
}
return true
}
// Setup callback first, so we don't miss anything from data events emitted
// immediately.
if (cb) {
var fields = {},
files = {}
this.on('field', function(name, value) {
fields[name] = value
})
.on('file', function(name, file) {
if (this.multiples) {
if (files[name]) {
if (!Array.isArray(files[name])) {
files[name] = [files[name]]
}
files[name].push(file)
} else {
files[name] = file
}
} else {
files[name] = file
}
})
.on('error', function(err) {
cb(err, fields, files)
})
.on('end', function() {
cb(null, fields, files)
})
}
// Parse headers and setup the parser, ready to start listening for data.
this.writeHeaders(req.headers)
// Start listening for data.
var self = this
req
.on('error', function(err) {
self._error(err)
.on('error', err => {
this._error(err)
})
.on('aborted', function() {
self.emit('aborted')
self._error(new Error('Request aborted'))
.on('aborted', () => {
this.emit('aborted')
this._error(new Error('Request aborted'))
})
.on('data', function(buffer) {
self.write(buffer)
.on('data', buffer => {
this.write(buffer)
})
.on('end', function() {
if (self.error) {
.on('end', () => {
if (this.error) {
return
}
var err = self._parser.end()
var err = this._parser.end()
if (err) {
self._error(err)
this._error(err)
}
})
return this
}
writeHeaders(headers) {
this.headers = headers
this._parseContentLength()
this._parseContentType()
this.#parseContentLength()
this.#parseContentType()
}
write(buffer) {
@ -178,15 +110,34 @@ export default class IncomingForm{
}
pause() {
// this does nothing, unless overwritten in IncomingForm.parse
try {
this.#req.pause()
} catch (err) {
// the stream was destroyed
if (!this.ended) {
// before it was completed, crash & burn
this._error(err)
}
return false
}
return true
}
resume() {
// this does nothing, unless overwritten in IncomingForm.parse
try {
this.#req.resume()
} catch (err) {
// the stream was destroyed
if (!this.ended) {
// before it was completed, crash & burn
this._error(err)
}
return false
}
return true
}
onPart(part) {
// this method can be overwritten by the user
this.handlePart(part)
@ -199,7 +150,7 @@ export default class IncomingForm{
var value = '',
decoder = new StringDecoder(this.encoding)
part.on('data', function(buffer) {
part.on('data', function (buffer) {
self._fieldsSize += buffer.length
if (self._fieldsSize > self.maxFieldsSize) {
self._error(
@ -214,7 +165,7 @@ export default class IncomingForm{
value += decoder.write(buffer)
})
part.on('end', function() {
part.on('end', function () {
self.emit('field', part.name, value)
})
return
@ -234,18 +185,18 @@ export default class IncomingForm{
file.open()
this.openedFiles.push(file)
part.on('data', function(buffer) {
part.on('data', function (buffer) {
if (buffer.length == 0) {
return
}
self.pause()
file.write(buffer, function() {
file.write(buffer, function () {
self.resume()
})
})
part.on('end', function() {
file.end(function() {
part.on('end', function () {
file.end(function () {
self._flushing--
self.emit('file', part.name, file)
self._maybeEnd()
@ -253,8 +204,7 @@ export default class IncomingForm{
})
}
_parseContentType() {
#parseContentType() {
if (this.bytesExpected === 0) {
this._parser = dummyParser(this)
return
@ -309,17 +259,17 @@ export default class IncomingForm{
this.emit('error', err)
if (Array.isArray(this.openedFiles)) {
this.openedFiles.forEach(function(file) {
this.openedFiles.forEach(function (file) {
file._writeStream.destroy()
setTimeout(fs.unlink, 0, file.path, function(error) {})
setTimeout(fs.unlink, 0, file.path, function (error) {})
})
}
}
_parseContentLength() {
#parseContentLength() {
this.bytesReceived = 0
if (this.headers['content-length']) {
this.bytesExpected = parseInt(this.headers['content-length'], 10)
this.bytesExpected = +this.headers['content-length']
} else if (this.headers['transfer-encoding'] === undefined) {
this.bytesExpected = 0
}
@ -344,7 +294,7 @@ export default class IncomingForm{
parser.initWithBoundary(boundary)
parser.onPartBegin = function() {
parser.onPartBegin = function () {
part = new Stream()
part.readable = true
part.headers = {}
@ -359,15 +309,15 @@ export default class IncomingForm{
headerValue = ''
}
parser.onHeaderField = function(b, start, end) {
parser.onHeaderField = function (b, start, end) {
headerField += b.toString(self.encoding, start, end)
}
parser.onHeaderValue = function(b, start, end) {
parser.onHeaderValue = function (b, start, end) {
headerValue += b.toString(self.encoding, start, end)
}
parser.onHeaderEnd = function() {
parser.onHeaderEnd = function () {
headerField = headerField.toLowerCase()
part.headers[headerField] = headerValue
@ -388,22 +338,22 @@ export default class IncomingForm{
headerValue = ''
}
parser.onHeadersEnd = function() {
parser.onHeadersEnd = function () {
switch (part.transferEncoding) {
case 'binary':
case '7bit':
case '8bit':
parser.onPartData = function(b, start, end) {
parser.onPartData = function (b, start, end) {
part.emit('data', b.slice(start, end))
}
parser.onPartEnd = function() {
parser.onPartEnd = function () {
part.emit('end')
}
break
case 'base64':
parser.onPartData = function(b, start, end) {
parser.onPartData = function (b, start, end) {
part.transferBuffer += b.slice(start, end).toString('ascii')
/*
@ -420,7 +370,7 @@ export default class IncomingForm{
part.transferBuffer = part.transferBuffer.substring(offset)
}
parser.onPartEnd = function() {
parser.onPartEnd = function () {
part.emit('data', Buffer.from(part.transferBuffer, 'base64'))
part.emit('end')
}
@ -433,7 +383,7 @@ export default class IncomingForm{
self.onPart(part)
}
parser.onEnd = function() {
parser.onEnd = function () {
self.ended = true
self._maybeEnd()
}
@ -447,7 +397,7 @@ export default class IncomingForm{
var filename = m[1].substr(m[1].lastIndexOf('\\') + 1)
filename = filename.replace(/%22/g, '"')
filename = filename.replace(/&#([\d]{4});/g, function(m, code) {
filename = filename.replace(/&#([\d]{4});/g, function (m, code) {
return String.fromCharCode(code)
})
return filename
@ -493,11 +443,11 @@ export default class IncomingForm{
//Keep track of writes that haven't finished so we don't emit the file before it's done being written
var outstandingWrites = 0
self._parser.on('data', function(buffer) {
self._parser.on('data', function (buffer) {
self.pause()
outstandingWrites++
file.write(buffer, function() {
file.write(buffer, function () {
outstandingWrites--
self.resume()
@ -507,12 +457,12 @@ export default class IncomingForm{
})
})
self._parser.on('end', function() {
self._parser.on('end', function () {
self._flushing--
self.ended = true
var done = function() {
file.end(function() {
var done = function () {
file.end(function () {
self.emit('file', 'file', file)
self._maybeEnd()
})
@ -536,11 +486,11 @@ export default class IncomingForm{
parser.initWithLength(this.bytesExpected)
}
parser.onField = function(key, val) {
parser.onField = function (key, val) {
self.emit('field', key, val)
}
parser.onEnd = function() {
parser.onEnd = function () {
self.ended = true
self._maybeEnd()
}
@ -572,6 +522,4 @@ export default class IncomingForm{
this.emit('end')
}
}

View File

@ -1,5 +1,4 @@
export class JSONParser {
data = Buffer.from('')
bytesWritten = 0
@ -31,6 +30,4 @@ export class JSONParser {
this.onEnd()
}
}

View File

@ -26,7 +26,7 @@ var s = 0,
COLON = 58,
A = 97,
Z = 122,
lower = function(c) {
lower = function (c) {
return c | 0x20
}
@ -39,7 +39,6 @@ export class MultipartParser {
index = null
flags = 0
static stateToString(stateNumber) {
for (var state in S) {
var number = S[state]
@ -47,7 +46,6 @@ export class MultipartParser {
}
}
initWithBoundary(str) {
this.boundary = Buffer.alloc(str.length + 4)
this.boundary.write('\r\n--', 0)
@ -77,13 +75,13 @@ export class MultipartParser {
bufferLength = buffer.length,
c,
cl,
mark = function(name) {
mark = function (name) {
self[name + 'Mark'] = i
},
clear = function(name) {
clear = function (name) {
delete self[name + 'Mark']
},
callback = function(name, buffer, start, end) {
callback = function (name, buffer, start, end) {
if (start !== undefined && start === end) {
return
}
@ -94,7 +92,7 @@ export class MultipartParser {
self[callbackSymbol](buffer, start, end)
}
},
dataCallback = function(name, clear) {
dataCallback = function (name, clear) {
var markSymbol = name + 'Mark'
if (!(markSymbol in self)) {
return
@ -304,8 +302,9 @@ export class MultipartParser {
}
end() {
var callback = function(self, name) {
var callbackSymbol = 'on' + name.substr(0, 1).toUpperCase() + name.substr(1)
var callback = function (self, name) {
var callbackSymbol =
'on' + name.substr(0, 1).toUpperCase() + name.substr(1)
if (callbackSymbol in self) {
self[callbackSymbol]()
}
@ -327,5 +326,3 @@ export class MultipartParser {
return 'state = ' + MultipartParser.stateToString(this.state)
}
}

View File

@ -1,15 +1,12 @@
import { EventEmitter } from 'events'
export class OctetParser extends EventEmitter {
write(buffer) {
write(buffer) {
this.emit('data', buffer)
return buffer.length
}
}
end () {
end() {
this.emit('end')
}
}
}

View File

@ -1,6 +1,6 @@
// This is a buffering parser, not quite as nice as the multipart one.
// If I find time I'll rewrite this to be fully streaming as well
import {parse} from 'node:querystring'
import { parse } from 'node:querystring'
export class QuerystringParser {
constructor(maxKeys) {

View File

@ -1,13 +1,14 @@
{
"name": "@gm5/request",
"version": "1.2.8",
"description": "对Http的request进一步封装, 提供常用的API",
"version": "2.0.0",
"description": "对Http的Request进一步封装, 提供常用的API",
"main": "index.js",
"author": "yutent",
"type": "module",
"keywords": [
"five",
"node-five",
"gmf",
"gm5",
"five.js",
"fivejs",
"request",