JavaScript/archive/code/node_modules/form-data/lib/form_data.js at main · iu5git/JavaScript · GitHub

History

executable file

457 lines (365 loc) · 12 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

var CombinedStream = require('combined-stream');

var util = require('util');

var path = require('path');

var http = require('http');

var https = require('https');

var parseUrl = require('url').parse;

var fs = require('fs');

var mime = require('mime-types');

var asynckit = require('asynckit');

var populate = require('./populate.js');

// Public API

module.exports = FormData;

// make it a Stream

util.inherits(FormData, CombinedStream);

/**

* Create readable "multipart/form-data" streams.

* Can be used to submit forms

* and file uploads to other web applications.

* @constructor

* @param {Object} options - Properties to be added/overriden for FormData and CombinedStream

function FormData(options) {

if (!(this instanceof FormData)) {

return new FormData();

}

this._overheadLength = 0;

this._valueLength = 0;

this._valuesToMeasure = [];

CombinedStream.call(this);

options = options || {};

for (var option in options) {

this[option] = options[option];

}

FormData.LINE_BREAK = '\r\n';

FormData.DEFAULT_CONTENT_TYPE = 'application/octet-stream';

FormData.prototype.append = function(field, value, options) {

options = options || {};

// allow filename as single option

if (typeof options == 'string') {

options = {filename: options};

}

var append = CombinedStream.prototype.append.bind(this);

// all that streamy business can't handle numbers

if (typeof value == 'number') {

value = '' + value;

}

// https://github.com/felixge/node-form-data/issues/38

if (util.isArray(value)) {

// Please convert your array into string

// the way web server expects it

this._error(new Error('Arrays are not supported.'));

return;

}

var header = this._multiPartHeader(field, value, options);

var footer = this._multiPartFooter();

append(header);

append(value);

append(footer);

// pass along options.knownLength

this._trackLength(header, value, options);

};

FormData.prototype._trackLength = function(header, value, options) {

var valueLength = 0;

// used w/ getLengthSync(), when length is known.

// e.g. for streaming directly from a remote server,

// w/ a known file a size, and not wanting to wait for

// incoming file to finish to get its size.

if (options.knownLength != null) {

valueLength += +options.knownLength;

} else if (Buffer.isBuffer(value)) {

valueLength = value.length;

} else if (typeof value === 'string') {

valueLength = Buffer.byteLength(value);

}

this._valueLength += valueLength;

// @check why add CRLF? does this account for custom/multiple CRLFs?

this._overheadLength +=

Buffer.byteLength(header) +

FormData.LINE_BREAK.length;

// empty or either doesn't have path or not an http response

if (!value || ( !value.path && !(value.readable && value.hasOwnProperty('httpVersion')) )) {

return;

}

// no need to bother with the length

if (!options.knownLength) {

this._valuesToMeasure.push(value);

}

};

FormData.prototype._lengthRetriever = function(value, callback) {

if (value.hasOwnProperty('fd')) {

// take read range into a account

// `end` = Infinity –> read file till the end

// TODO: Looks like there is bug in Node fs.createReadStream

// it doesn't respect `end` options without `start` options

// Fix it when node fixes it.

// https://github.com/joyent/node/issues/7819

if (value.end != undefined && value.end != Infinity && value.start != undefined) {

// when end specified

// no need to calculate range

// inclusive, starts with 0

callback(null, value.end + 1 - (value.start ? value.start : 0));

// not that fast snoopy

} else {

// still need to fetch file size from fs

fs.stat(value.path, function(err, stat) {

var fileSize;

if (err) {

callback(err);

return;

}

// update final size based on the range options

fileSize = stat.size - (value.start ? value.start : 0);

callback(null, fileSize);

});

}

// or http response

} else if (value.hasOwnProperty('httpVersion')) {

callback(null, +value.headers['content-length']);

// or request stream http://github.com/mikeal/request

} else if (value.hasOwnProperty('httpModule')) {

// wait till response come back

value.on('response', function(response) {

value.pause();

callback(null, +response.headers['content-length']);

});

value.resume();

// something else

} else {

callback('Unknown stream');

}

};

FormData.prototype._multiPartHeader = function(field, value, options) {

// custom header specified (as string)?

// it becomes responsible for boundary

// (e.g. to handle extra CRLFs on .NET servers)

if (typeof options.header == 'string') {

return options.header;

}

var contentDisposition = this._getContentDisposition(value, options);

var contentType = this._getContentType(value, options);

var contents = '';

var headers = {

// add custom disposition as third element or keep it two elements if not

'Content-Disposition': ['form-data', 'name="' + field + '"'].concat(contentDisposition || []),

// if no content type. allow it to be empty array

'Content-Type': [].concat(contentType || [])

};

// allow custom headers.

if (typeof options.header == 'object') {

populate(headers, options.header);

}

var header;

for (var prop in headers) {

if (!headers.hasOwnProperty(prop)) continue;

header = headers[prop];

// skip nullish headers.

if (header == null) {

continue;

}

// convert all headers to arrays.

if (!Array.isArray(header)) {

header = [header];

}

// add non-empty headers.

if (header.length) {

contents += prop + ': ' + header.join('; ') + FormData.LINE_BREAK;

}

return '--' + this.getBoundary() + FormData.LINE_BREAK + contents + FormData.LINE_BREAK;

};

FormData.prototype._getContentDisposition = function(value, options) {

var filename

, contentDisposition

;

if (typeof options.filepath === 'string') {

// custom filepath for relative paths

filename = path.normalize(options.filepath).replace(/\\/g, '/');

} else if (options.filename || value.name || value.path) {

// custom filename take precedence

// formidable and the browser add a name property

// fs- and request- streams have path property

filename = path.basename(options.filename || value.name || value.path);

} else if (value.readable && value.hasOwnProperty('httpVersion')) {

// or try http response

filename = path.basename(value.client._httpMessage.path);

}

if (filename) {

contentDisposition = 'filename="' + filename + '"';

}

return contentDisposition;

};

FormData.prototype._getContentType = function(value, options) {

// use custom content-type above all

var contentType = options.contentType;

// or try `name` from formidable, browser

if (!contentType && value.name) {

contentType = mime.lookup(value.name);

}

// or try `path` from fs-, request- streams

if (!contentType && value.path) {

contentType = mime.lookup(value.path);

}

// or if it's http-reponse

if (!contentType && value.readable && value.hasOwnProperty('httpVersion')) {

contentType = value.headers['content-type'];

}

// or guess it from the filepath or filename

if (!contentType && (options.filepath || options.filename)) {

contentType = mime.lookup(options.filepath || options.filename);

}

// fallback to the default content type if `value` is not simple value

if (!contentType && typeof value == 'object') {

contentType = FormData.DEFAULT_CONTENT_TYPE;

}

return contentType;

};

FormData.prototype._multiPartFooter = function() {

return function(next) {

var footer = FormData.LINE_BREAK;

var lastPart = (this._streams.length === 0);

if (lastPart) {

footer += this._lastBoundary();

}

next(footer);

}.bind(this);

};

FormData.prototype._lastBoundary = function() {

return '--' + this.getBoundary() + '--' + FormData.LINE_BREAK;

};

FormData.prototype.getHeaders = function(userHeaders) {

var header;

var formHeaders = {

'content-type': 'multipart/form-data; boundary=' + this.getBoundary()

};

for (header in userHeaders) {

if (userHeaders.hasOwnProperty(header)) {

formHeaders[header.toLowerCase()] = userHeaders[header];

}

return formHeaders;

};

FormData.prototype.getBoundary = function() {

if (!this._boundary) {

this._generateBoundary();

}

return this._boundary;

};

FormData.prototype._generateBoundary = function() {

// This generates a 50 character boundary similar to those used by Firefox.

// They are optimized for boyer-moore parsing.

var boundary = '--------------------------';

for (var i = 0; i < 24; i++) {

boundary += Math.floor(Math.random() * 10).toString(16);

}

this._boundary = boundary;

};

// Note: getLengthSync DOESN'T calculate streams length

// As workaround one can calculate file size manually

// and add it as knownLength option

FormData.prototype.getLengthSync = function() {

var knownLength = this._overheadLength + this._valueLength;

// Don't get confused, there are 3 "internal" streams for each keyval pair

// so it basically checks if there is any value added to the form

if (this._streams.length) {

knownLength += this._lastBoundary().length;

}

// https://github.com/form-data/form-data/issues/40

if (!this.hasKnownLength()) {

// Some async length retrievers are present

// therefore synchronous length calculation is false.

// Please use getLength(callback) to get proper length

this._error(new Error('Cannot calculate proper length in synchronous way.'));

}

return knownLength;

};

// Public API to check if length of added values is known

// https://github.com/form-data/form-data/issues/196

// https://github.com/form-data/form-data/issues/262

FormData.prototype.hasKnownLength = function() {

var hasKnownLength = true;

if (this._valuesToMeasure.length) {

hasKnownLength = false;

}

return hasKnownLength;

};

FormData.prototype.getLength = function(cb) {

var knownLength = this._overheadLength + this._valueLength;

if (this._streams.length) {

knownLength += this._lastBoundary().length;

}

if (!this._valuesToMeasure.length) {

process.nextTick(cb.bind(this, null, knownLength));

return;

}

asynckit.parallel(this._valuesToMeasure, this._lengthRetriever, function(err, values) {

if (err) {

cb(err);

return;

}

values.forEach(function(length) {

knownLength += length;

});

cb(null, knownLength);

});

};

FormData.prototype.submit = function(params, cb) {

var request

, options

, defaults = {method: 'post'}

;

// parse provided url if it's string

// or treat it as options object

if (typeof params == 'string') {

params = parseUrl(params);

options = populate({

port: params.port,

path: params.pathname,

host: params.hostname,

protocol: params.protocol

}, defaults);

// use custom params

} else {

options = populate(params, defaults);

// if no port provided use default one

if (!options.port) {

options.port = options.protocol == 'https:' ? 443 : 80;

}

// put that good code in getHeaders to some use

options.headers = this.getHeaders(params.headers);

// https if specified, fallback to http in any other case

if (options.protocol == 'https:') {

request = https.request(options);

} else {

request = http.request(options);

}

// get content length and fire away

this.getLength(function(err, length) {

if (err) {

this._error(err);

return;

}

// add content length

request.setHeader('Content-Length', length);

this.pipe(request);

if (cb) {

request.on('error', cb);

request.on('response', cb.bind(this, null));

}

}.bind(this));

return request;

};

FormData.prototype._error = function(err) {

if (!this.error) {

this.error = err;

this.pause();

this.emit('error', err);

}

};

FormData.prototype.toString = function () {

return '[object FormData]';

};

JavaScript/archive/code/node_modules/form-data/lib/form_data.js at main · iu5git/JavaScript · GitHub

Expand file tree

Breadcrumbs

form_data.js

Latest commit

History

Breadcrumbs

form_data.js

File metadata and controls