-
-
Notifications
You must be signed in to change notification settings - Fork 118
/
Curl.ts
632 lines (541 loc) · 17.2 KB
/
Curl.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
/**
* Copyright (c) Jonathan Cardoso Machado. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
import path from 'path'
import { EventEmitter } from 'events'
import { StringDecoder } from 'string_decoder'
import assert from 'assert'
// tslint:disable-next-line
import binary from 'node-pre-gyp'
import {
NodeLibcurlNativeBinding,
EasyNativeBinding,
FileInfo,
HttpPostField,
} from './types'
import { Easy } from './Easy'
import { Multi } from './Multi'
import { Share } from './Share'
import { CurlFeature } from './enum/CurlFeature'
import { CurlCode } from './enum/CurlCode'
import { mergeChunks } from './mergeChunks'
import { parseHeaders, HeaderInfo } from './parseHeaders'
import {
DataCallbackOptions,
ProgressCallbackOptions,
StringListOptions,
CurlOptionName,
SpecificOptions,
} from './generated/CurlOption'
import { CurlInfoName } from './generated/CurlInfo'
import { CurlGlobalInit } from './enum/CurlGlobalInit'
import { CurlPause } from './enum/CurlPause'
const bindingPath = binary.find(
path.resolve(path.join(__dirname, './../package.json')),
)
const bindings: NodeLibcurlNativeBinding = require(bindingPath)
// tslint:disable-next-line
const { Curl: _Curl, CurlVersionInfo } = bindings
if (
!process.env.NODE_LIBCURL_DISABLE_GLOBAL_INIT_CALL ||
process.env.NODE_LIBCURL_DISABLE_GLOBAL_INIT_CALL !== 'true'
) {
// We could just pass nothing here, CurlGlobalInitEnum.All is the default anyway.
const globalInitResult = _Curl.globalInit(CurlGlobalInit.All)
assert(globalInitResult === 0 || 'Libcurl global init failed.')
}
const decoder = new StringDecoder('utf8')
// Handle used by curl instances created by the Curl wrapper.
const multiHandle = new Multi()
const curlInstanceMap = new WeakMap<EasyNativeBinding, Curl>()
multiHandle.onMessage((error, handle, errorCode) => {
multiHandle.removeHandle(handle)
const curlInstance = curlInstanceMap.get(handle)
assert(
curlInstance,
'Could not retrieve curl instance from easy handle on onMessage callback',
)
if (error) {
curlInstance!.onError(error, errorCode)
} else {
curlInstance!.onEnd()
}
})
/**
* Wrapper class around one easy handle providing a better interface
*/
class Curl extends EventEmitter {
/**
* Calls [curl_global_init()](http://curl.haxx.se/libcurl/c/curl_global_init.html)
* For **flags** see the the enum `CurlGlobalInit`
*
* This is automatically called when the addon is loaded, to disable this, set the environment variable
* `NODE_LIBCURL_DISABLE_GLOBAL_INIT_CALL=false`
*/
static globalInit = _Curl.globalInit
/**
* Calls [curl_global_cleanup()](http://curl.haxx.se/libcurl/c/curl_global_cleanup.html)
*
* This is automatically called when the process is exiting
*/
static globalCleanup = _Curl.globalCleanup
/**
* Returns libcurl version string.
* The string shows which features are enabled,
* and the version of the libraries that libcurl was built with.
*/
static getVersion = _Curl.getVersion
/**
* Returns an object with a representation of the current libcurl version and their features/protocols.
*
* This is basically [curl_version_info()](https://curl.haxx.se/libcurl/c/curl_version_info.html)
*/
static getVersionInfo = () => CurlVersionInfo
/**
* Returns a string that looks like the one returned by
* ```
* curl -V
* ```
*/
static getVersionInfoString = () => {
const version = Curl.getVersion()
const protocols = CurlVersionInfo.protocols.join(', ')
const features = CurlVersionInfo.features.join(', ')
return [
`Version: ${version}`,
`Protocols: ${protocols}`,
`Features: ${features}`,
].join('\n')
}
/**
* Returns the number of handles currently open in the internal multi handle being used.
*/
static getCount = multiHandle.getCount
/**
* Current libcurl version
*/
static VERSION_NUM = _Curl.VERSION_NUM
/**
* Options to be used with `Easy.getInfo` or `Curl.getInfo`
*
* See the official documentation of [curl_easy_getinfo()](http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html)
* for reference.
*
* `CURLINFO_EFFECTIVE_URL` becomes `Curl.info.EFFECTIVE_URL`
*/
static info = _Curl.info
/**
* Options to be used with `Easy.setOpt` or `Curl.setOpt`
*
* See the official documentation of [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
* for reference.
*
* `CURLOPT_URL` becomes `Curl.option.URL`
*/
static option = _Curl.option
/**
* Internal Easy handle being used
*/
protected handle: EasyNativeBinding
/**
* Stores current response payload
* This will not store anything in case the NO_DATA_STORAGE flag is enabled
*/
protected chunks: Buffer[]
protected chunksLength: number
/**
* Stores current headers payload
* This will not store anything in case the NO_DATA_STORAGE flag is enabled
*/
protected headerChunks: Buffer[]
protected headerChunksLength: number
protected features: CurlFeature
/**
* Whether this instance is running or not (called perform())
*/
isRunning: boolean
constructor(cloneHandle?: EasyNativeBinding) {
super()
const handle = cloneHandle || new Easy()
this.handle = handle
// callbacks called by libcurl
handle.setOpt(
Curl.option.WRITEFUNCTION,
this.defaultWriteFunction.bind(this),
)
handle.setOpt(
Curl.option.HEADERFUNCTION,
this.defaultHeaderFunction.bind(this),
)
this.chunks = []
this.chunksLength = 0
this.headerChunks = []
this.headerChunksLength = 0
this.features = 0
this.isRunning = false
curlInstanceMap.set(handle, this)
}
protected defaultWriteFunction(chunk: Buffer, size: number, nmemb: number) {
if (!(this.features & CurlFeature.NoDataStorage)) {
this.chunks.push(chunk)
this.chunksLength += chunk.length
}
this.emit('data', chunk, this)
return size * nmemb
}
/**
* Same than {@link module:node-libcurl.Curl#_onData} but for the headers.
* @param {Buffer} chunk
* @returns {Number}
* @emits module:node-libcurl.Curl#event:header
*
* @private
*/
protected defaultHeaderFunction(chunk: Buffer, size: number, nmemb: number) {
if (!(this.features & CurlFeature.NoHeaderStorage)) {
this.headerChunks.push(chunk)
this.headerChunksLength += chunk.length
}
this.emit('header', chunk, this)
return size * nmemb
}
/**
* Event called when an error is thrown on this handle.
*/
onError(error: Error, errorCode: CurlCode) {
this.isRunning = false
this.chunks = []
this.chunksLength = 0
this.headerChunks = []
this.headerChunksLength = 0
this.emit('error', error, errorCode, this)
}
/**
* Called when this handle has finished the request.
*/
onEnd() {
const isHeaderStorageEnabled = !(
this.features & CurlFeature.NoHeaderStorage
)
const isDataStorageEnabled = !(this.features & CurlFeature.NoDataStorage)
const isHeaderParsingEnabled =
!(this.features & CurlFeature.NoHeaderParsing) && isHeaderStorageEnabled
const isDataParsingEnabled =
!(this.features & CurlFeature.NoDataParsing) && isDataStorageEnabled
this.isRunning = false
const dataRaw = isDataStorageEnabled
? mergeChunks(this.chunks, this.chunksLength)
: Buffer.alloc(0)
const headersRaw = isHeaderStorageEnabled
? mergeChunks(this.headerChunks, this.headerChunksLength)
: Buffer.alloc(0)
this.chunks = []
this.chunksLength = 0
this.headerChunks = []
this.headerChunksLength = 0
const data = isDataParsingEnabled ? decoder.write(dataRaw) : dataRaw
const headers = isHeaderParsingEnabled
? parseHeaders(decoder.write(headersRaw))
: headersRaw
const { code, data: status } = this.handle.getInfo(Curl.info.RESPONSE_CODE)
if (code !== CurlCode.CURLE_OK) {
const error = new Error('Could not get status code of request')
this.emit('error', error, code, this)
} else {
this.emit('end', status, data, headers, this)
}
}
/**
* Enables a feature, should not be used while a request is running.
* Use `Curl.feature` for predefined constants.
*/
enable(bitmask: CurlFeature) {
if (this.isRunning) {
throw new Error(
'You should not change the features while a request is running.',
)
}
this.features |= bitmask
return this
}
/**
* Disables a feature, should not be used while a request is running.
* Use `Curl.feature` for predefined constants.
*/
disable(bitmask: CurlFeature) {
if (this.isRunning) {
throw new Error(
'You should not change the features while a request is running.',
)
}
this.features &= ~bitmask
return this
}
setOpt(optionIdOrName: never, optionValue: never): this {
// we are using never as arguments here, because we want to make sure the client
// uses one of the overloaded types
// special case for WRITEFUNCTION and HEADERFUNCTION callbacks
// since if they are set back to null, we must restore the default callback.
let value = optionValue
if (
(optionIdOrName === Curl.option.WRITEFUNCTION ||
optionIdOrName === 'WRITEFUNCTION') &&
!optionValue
) {
value = this.defaultWriteFunction.bind(this) as never
} else if (
(optionIdOrName === Curl.option.HEADERFUNCTION ||
optionIdOrName === 'HEADERFUNCTION') &&
!optionValue
) {
value = this.defaultHeaderFunction.bind(this) as never
}
const code = this.handle.setOpt(optionIdOrName, value)
if (code !== CurlCode.CURLE_OK) {
throw new Error(
code === CurlCode.CURLE_UNKNOWN_OPTION
? 'Unknown option given. First argument must be the option internal id or the option name. You can use the Curl.option constants.'
: Easy.strError(code),
)
}
return this
}
/**
* Use `Curl.info` for predefined constants.
* Official libcurl documentation: [curl_easy_getinfo()](http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html)
*/
getInfo(infoNameOrId: CurlInfoName) {
const { code, data } = this.handle.getInfo(infoNameOrId)
if (code !== CurlCode.CURLE_OK) {
throw new Error(`getInfo failed. Error: ${Easy.strError(code)}`)
}
return data
}
/**
* The option XFERINFOFUNCTION was introduced in curl version 7.32.0,
* versions older than that should use PROGRESSFUNCTION.
* If you don't want to mess with version numbers you can use this method,
* instead of directly calling `Curl.setOpt`
*
* NOPROGRESS should be set to false to make this function actually get called.
*/
setProgressCallback(
cb:
| ((
dltotal: number,
dlnow: number,
ultotal: number,
ulnow: number,
) => number)
| null,
) {
if (Curl.VERSION_NUM >= 0x072000) {
this.handle.setOpt(Curl.option.XFERINFOFUNCTION, cb)
} else {
this.handle.setOpt(Curl.option.PROGRESSFUNCTION, cb)
}
return this
}
/**
* Add this instance to the processing queue.
* @throws This method should be called only one time per request,
* otherwise it will throw an exception.
*/
perform() {
if (this.isRunning) {
throw new Error('Handle already running!')
}
this.isRunning = true
multiHandle.addHandle(this.handle)
return this
}
/**
* Using this function, you can explicitly mark a running connection to get paused, and you can unpause a connection that was previously paused.
*
* The bitmask argument is a set of bits that sets the new state of the connection.
*
* Use `Curl.pause` for predefined constants.
*/
pause(bitmask: CurlPause) {
const code = this.handle.pause(bitmask)
if (code !== CurlCode.CURLE_OK) {
throw new Error(Easy.strError(code))
}
return this
}
/**
* Reset this handle options to their defaults.
*/
reset() {
this.removeAllListeners()
this.handle.reset()
// add callbacks back as reset will remove them
this.handle.setOpt(
Curl.option.WRITEFUNCTION,
this.defaultWriteFunction.bind(this),
)
this.handle.setOpt(
Curl.option.HEADERFUNCTION,
this.defaultHeaderFunction.bind(this),
)
return this
}
/**
* Duplicate this handle with all their options.
* Keep in mind that, by default, this also means all event listeners.
*
* Use the argument to change that behaviour.
*/
dupHandle(shouldCopyEventListeners: boolean = true) {
const duplicatedHandle = new Curl(this.handle.dupHandle())
const eventsToCopy = ['end', 'error', 'data', 'header']
duplicatedHandle.features = this.features
if (shouldCopyEventListeners) {
for (let i = 0; i < eventsToCopy.length; i += 1) {
const listeners = this.listeners(eventsToCopy[i])
for (let j = 0; j < listeners.length; j += 1) {
duplicatedHandle.on(eventsToCopy[i], listeners[j])
}
}
}
return duplicatedHandle
}
/**
* Close this handle.
*
* **NOTE:** After closing the handle, it should not be used anymore! Doing so will throw an exception.
*/
close() {
curlInstanceMap.delete(this.handle)
this.removeAllListeners()
if (this.handle.isInsideMultiHandle) {
multiHandle.removeHandle(this.handle)
}
this.handle.setOpt(Curl.option.WRITEFUNCTION, null)
this.handle.setOpt(Curl.option.HEADERFUNCTION, null)
this.handle.close()
}
}
interface Curl {
on(event: 'data', listener: (chunk: Buffer, curlInstance: Curl) => void): this
on(
event: 'header',
listener: (chunk: Buffer, curlInstance: Curl) => void,
): this
on(
event: 'error',
listener: (error: Error, errorCode: CurlCode, curlInstance: Curl) => void,
): this
on(
event: 'end',
listener: (
status: number,
data: string | Buffer,
headers: Buffer | HeaderInfo[],
curlInstance: Curl,
) => void,
): this
on(event: string, listener: Function): this
// START AUTOMATICALLY GENERATED CODE - DO NOT EDIT
/**
* Use `Curl.option` for predefined constants.
*
* Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
*/
setOpt(
option: DataCallbackOptions,
value: ((data: Buffer, size: number, nmemb: number) => number) | null,
): this
/**
* Use `Curl.option` for predefined constants.
*
* Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
*/
setOpt(
option: ProgressCallbackOptions,
value:
| ((
dltotal: number,
dlnow: number,
ultotal: number,
ulnow: number,
) => number)
| null,
): this
/**
* Use `Curl.option` for predefined constants.
*
* Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
*/
setOpt(option: StringListOptions, value: string[] | null): this
/**
* Use `Curl.option` for predefined constants.
*
* Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
*/
setOpt(
option: 'CHUNK_BGN_FUNCTION',
value: ((fileInfo: FileInfo, remains: number) => number) | null,
): this
/**
* Use `Curl.option` for predefined constants.
*
* Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
*/
setOpt(option: 'CHUNK_END_FUNCTION', value: (() => number) | null): this
/**
* Use `Curl.option` for predefined constants.
*
* Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
*/
setOpt(
option: 'DEBUGFUNCTION',
value: ((type: number, data: Buffer) => void) | null,
): this
/**
* Use `Curl.option` for predefined constants.
*
* Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
*/
setOpt(
option: 'FNMATCH_FUNCTION',
value: ((pattern: string, value: string) => number) | null,
): this
/**
* Use `Curl.option` for predefined constants.
*
* Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
*/
setOpt(
option: 'SEEKFUNCTION',
value: ((offset: number, origin: number) => number) | null,
): this
/**
* Use `Curl.option` for predefined constants.
*
* Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
*/
setOpt(option: 'SHARE', value: Share | null): this
/**
* Use `Curl.option` for predefined constants.
*
* Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
*/
setOpt(option: 'HTTPPOST', value: HttpPostField[] | null): this
/**
* Use `Curl.option` for predefined constants.
*
* Official libcurl documentation: [curl_easy_setopt()](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html)
*/
setOpt(
option: Exclude<CurlOptionName, SpecificOptions>,
value: string | number | boolean | null,
): this
// END AUTOMATICALLY GENERATED CODE - DO NOT EDIT
}
const curl = new Curl()
curl.on('data', () => {})
export { Curl }