forked from githoniel/forge
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhttp.js
1364 lines (1259 loc) · 38.5 KB
/
http.js
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
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* HTTP client-side implementation that uses forge.net sockets.
*
* @author Dave Longley
*
* Copyright (c) 2010-2014 Digital Bazaar, Inc. All rights reserved.
*/
var forge = require('./forge');
require('./debug');
require('./tls');
require('./util');
// define http namespace
var http = module.exports = forge.http = forge.http || {};
// logging category
var cat = 'forge.http';
// add array of clients to debug storage
if(forge.debug) {
forge.debug.set('forge.http', 'clients', []);
}
// normalizes an http header field name
var _normalize = function(name) {
return name.toLowerCase().replace(/(^.)|(-.)/g,
function(a) {return a.toUpperCase();});
};
/**
* Gets the local storage ID for the given client.
*
* @param client the client to get the local storage ID for.
*
* @return the local storage ID to use.
*/
var _getStorageId = function(client) {
// TODO: include browser in ID to avoid sharing cookies between
// browsers (if this is undesirable)
// navigator.userAgent
return 'forge.http.' +
client.url.scheme + '.' +
client.url.host + '.' +
client.url.port;
};
/**
* Loads persistent cookies from disk for the given client.
*
* @param client the client.
*/
var _loadCookies = function(client) {
if(client.persistCookies) {
try {
var cookies = forge.util.getItem(
client.socketPool.flashApi,
_getStorageId(client), 'cookies');
client.cookies = cookies || {};
} catch(ex) {
// no flash storage available, just silently fail
// TODO: i assume we want this logged somewhere or
// should it actually generate an error
//forge.log.error(cat, ex);
}
}
};
/**
* Saves persistent cookies on disk for the given client.
*
* @param client the client.
*/
var _saveCookies = function(client) {
if(client.persistCookies) {
try {
forge.util.setItem(
client.socketPool.flashApi,
_getStorageId(client), 'cookies', client.cookies);
} catch(ex) {
// no flash storage available, just silently fail
// TODO: i assume we want this logged somewhere or
// should it actually generate an error
//forge.log.error(cat, ex);
}
}
// FIXME: remove me
_loadCookies(client);
};
/**
* Clears persistent cookies on disk for the given client.
*
* @param client the client.
*/
var _clearCookies = function(client) {
if(client.persistCookies) {
try {
// only thing stored is 'cookies', so clear whole storage
forge.util.clearItems(
client.socketPool.flashApi,
_getStorageId(client));
} catch(ex) {
// no flash storage available, just silently fail
// TODO: i assume we want this logged somewhere or
// should it actually generate an error
//forge.log.error(cat, ex);
}
}
};
/**
* Connects and sends a request.
*
* @param client the http client.
* @param socket the socket to use.
*/
var _doRequest = function(client, socket) {
if(socket.isConnected()) {
// already connected
socket.options.request.connectTime = +new Date();
socket.connected({
type: 'connect',
id: socket.id
});
} else {
// connect
socket.options.request.connectTime = +new Date();
socket.connect({
host: client.url.host,
port: client.url.port,
policyPort: client.policyPort,
policyUrl: client.policyUrl
});
}
};
/**
* Handles the next request or marks a socket as idle.
*
* @param client the http client.
* @param socket the socket.
*/
var _handleNextRequest = function(client, socket) {
// clear buffer
socket.buffer.clear();
// get pending request
var pending = null;
while(pending === null && client.requests.length > 0) {
pending = client.requests.shift();
if(pending.request.aborted) {
pending = null;
}
}
// mark socket idle if no pending requests
if(pending === null) {
if(socket.options !== null) {
socket.options = null;
}
client.idle.push(socket);
} else {
// handle pending request, allow 1 retry
socket.retries = 1;
socket.options = pending;
_doRequest(client, socket);
}
};
/**
* Sets up a socket for use with an http client.
*
* @param client the parent http client.
* @param socket the socket to set up.
* @param tlsOptions if the socket must use TLS, the TLS options.
*/
var _initSocket = function(client, socket, tlsOptions) {
// no socket options yet
socket.options = null;
// set up handlers
socket.connected = function(e) {
// socket primed by caching TLS session, handle next request
if(socket.options === null) {
_handleNextRequest(client, socket);
} else {
// socket in use
var request = socket.options.request;
request.connectTime = +new Date() - request.connectTime;
e.socket = socket;
socket.options.connected(e);
if(request.aborted) {
socket.close();
} else {
var out = request.toString();
if(request.body) {
out += request.body;
}
request.time = +new Date();
socket.send(out);
request.time = +new Date() - request.time;
socket.options.response.time = +new Date();
socket.sending = true;
}
}
};
socket.closed = function(e) {
if(socket.sending) {
socket.sending = false;
if(socket.retries > 0) {
--socket.retries;
_doRequest(client, socket);
} else {
// error, closed during send
socket.error({
id: socket.id,
type: 'ioError',
message: 'Connection closed during send. Broken pipe.',
bytesAvailable: 0
});
}
} else {
// handle unspecified content-length transfer
var response = socket.options.response;
if(response.readBodyUntilClose) {
response.time = +new Date() - response.time;
response.bodyReceived = true;
socket.options.bodyReady({
request: socket.options.request,
response: response,
socket: socket
});
}
socket.options.closed(e);
_handleNextRequest(client, socket);
}
};
socket.data = function(e) {
socket.sending = false;
var request = socket.options.request;
if(request.aborted) {
socket.close();
} else {
// receive all bytes available
var response = socket.options.response;
var bytes = socket.receive(e.bytesAvailable);
if(bytes !== null) {
// receive header and then body
socket.buffer.putBytes(bytes);
if(!response.headerReceived) {
response.readHeader(socket.buffer);
if(response.headerReceived) {
socket.options.headerReady({
request: socket.options.request,
response: response,
socket: socket
});
}
}
if(response.headerReceived && !response.bodyReceived) {
response.readBody(socket.buffer);
}
if(response.bodyReceived) {
socket.options.bodyReady({
request: socket.options.request,
response: response,
socket: socket
});
// close connection if requested or by default on http/1.0
var value = response.getField('Connection') || '';
if(value.indexOf('close') != -1 ||
(response.version === 'HTTP/1.0' &&
response.getField('Keep-Alive') === null)) {
socket.close();
} else {
_handleNextRequest(client, socket);
}
}
}
}
};
socket.error = function(e) {
// do error callback, include request
socket.options.error({
type: e.type,
message: e.message,
request: socket.options.request,
response: socket.options.response,
socket: socket
});
socket.close();
};
// wrap socket for TLS
if(tlsOptions) {
socket = forge.tls.wrapSocket({
sessionId: null,
sessionCache: {},
caStore: tlsOptions.caStore,
cipherSuites: tlsOptions.cipherSuites,
socket: socket,
virtualHost: tlsOptions.virtualHost,
verify: tlsOptions.verify,
getCertificate: tlsOptions.getCertificate,
getPrivateKey: tlsOptions.getPrivateKey,
getSignature: tlsOptions.getSignature,
deflate: tlsOptions.deflate || null,
inflate: tlsOptions.inflate || null
});
socket.options = null;
socket.buffer = forge.util.createBuffer();
client.sockets.push(socket);
if(tlsOptions.prime) {
// prime socket by connecting and caching TLS session, will do
// next request from there
socket.connect({
host: client.url.host,
port: client.url.port,
policyPort: client.policyPort,
policyUrl: client.policyUrl
});
} else {
// do not prime socket, just add as idle
client.idle.push(socket);
}
} else {
// no need to prime non-TLS sockets
socket.buffer = forge.util.createBuffer();
client.sockets.push(socket);
client.idle.push(socket);
}
};
/**
* Checks to see if the given cookie has expired. If the cookie's max-age
* plus its created time is less than the time now, it has expired, unless
* its max-age is set to -1 which indicates it will never expire.
*
* @param cookie the cookie to check.
*
* @return true if it has expired, false if not.
*/
var _hasCookieExpired = function(cookie) {
var rval = false;
if(cookie.maxAge !== -1) {
var now = _getUtcTime(new Date());
var expires = cookie.created + cookie.maxAge;
if(expires <= now) {
rval = true;
}
}
return rval;
};
/**
* Adds cookies in the given client to the given request.
*
* @param client the client.
* @param request the request.
*/
var _writeCookies = function(client, request) {
var expired = [];
var url = client.url;
var cookies = client.cookies;
for(var name in cookies) {
// get cookie paths
var paths = cookies[name];
for(var p in paths) {
var cookie = paths[p];
if(_hasCookieExpired(cookie)) {
// store for clean up
expired.push(cookie);
} else if(request.path.indexOf(cookie.path) === 0) {
// path or path's ancestor must match cookie.path
request.addCookie(cookie);
}
}
}
// clean up expired cookies
for(var i = 0; i < expired.length; ++i) {
var cookie = expired[i];
client.removeCookie(cookie.name, cookie.path);
}
};
/**
* Gets cookies from the given response and adds the to the given client.
*
* @param client the client.
* @param response the response.
*/
var _readCookies = function(client, response) {
var cookies = response.getCookies();
for(var i = 0; i < cookies.length; ++i) {
try {
client.setCookie(cookies[i]);
} catch(ex) {
// ignore failure to add other-domain, etc. cookies
}
}
};
/**
* Creates an http client that uses forge.net sockets as a backend and
* forge.tls for security.
*
* @param options:
* url: the url to connect to (scheme://host:port).
* socketPool: the flash socket pool to use.
* policyPort: the flash policy port to use (if other than the
* socket pool default), use 0 for flash default.
* policyUrl: the flash policy file URL to use (if provided will
* be used instead of a policy port).
* connections: number of connections to use to handle requests.
* caCerts: an array of certificates to trust for TLS, certs may
* be PEM-formatted or cert objects produced via forge.pki.
* cipherSuites: an optional array of cipher suites to use,
* see forge.tls.CipherSuites.
* virtualHost: the virtual server name to use in a TLS SNI
* extension, if not provided the url host will be used.
* verify: a custom TLS certificate verify callback to use.
* getCertificate: an optional callback used to get a client-side
* certificate (see forge.tls for details).
* getPrivateKey: an optional callback used to get a client-side
* private key (see forge.tls for details).
* getSignature: an optional callback used to get a client-side
* signature (see forge.tls for details).
* persistCookies: true to use persistent cookies via flash local
* storage, false to only keep cookies in javascript.
* primeTlsSockets: true to immediately connect TLS sockets on
* their creation so that they will cache TLS sessions for reuse.
*
* @return the client.
*/
http.createClient = function(options) {
// create CA store to share with all TLS connections
var caStore = null;
if(options.caCerts) {
caStore = forge.pki.createCaStore(options.caCerts);
}
// get scheme, host, and port from url
options.url = (options.url ||
window.location.protocol + '//' + window.location.host);
var url = http.parseUrl(options.url);
if(!url) {
var error = new Error('Invalid url.');
error.details = {url: options.url};
throw error;
}
// default to 1 connection
options.connections = options.connections || 1;
// create client
var sp = options.socketPool;
var client = {
// url
url: url,
// socket pool
socketPool: sp,
// the policy port to use
policyPort: options.policyPort,
// policy url to use
policyUrl: options.policyUrl,
// queue of requests to service
requests: [],
// all sockets
sockets: [],
// idle sockets
idle: [],
// whether or not the connections are secure
secure: (url.scheme === 'https'),
// cookie jar (key'd off of name and then path, there is only 1 domain
// and one setting for secure per client so name+path is unique)
cookies: {},
// default to flash storage of cookies
persistCookies: (typeof(options.persistCookies) === 'undefined') ?
true : options.persistCookies
};
// add client to debug storage
if(forge.debug) {
forge.debug.get('forge.http', 'clients').push(client);
}
// load cookies from disk
_loadCookies(client);
/**
* A default certificate verify function that checks a certificate common
* name against the client's URL host.
*
* @param c the TLS connection.
* @param verified true if cert is verified, otherwise alert number.
* @param depth the chain depth.
* @param certs the cert chain.
*
* @return true if verified and the common name matches the host, error
* otherwise.
*/
var _defaultCertificateVerify = function(c, verified, depth, certs) {
if(depth === 0 && verified === true) {
// compare common name to url host
var cn = certs[depth].subject.getField('CN');
if(cn === null || client.url.host !== cn.value) {
verified = {
message: 'Certificate common name does not match url host.'
};
}
}
return verified;
};
// determine if TLS is used
var tlsOptions = null;
if(client.secure) {
tlsOptions = {
caStore: caStore,
cipherSuites: options.cipherSuites || null,
virtualHost: options.virtualHost || url.host,
verify: options.verify || _defaultCertificateVerify,
getCertificate: options.getCertificate || null,
getPrivateKey: options.getPrivateKey || null,
getSignature: options.getSignature || null,
prime: options.primeTlsSockets || false
};
// if socket pool uses a flash api, then add deflate support to TLS
if(sp.flashApi !== null) {
tlsOptions.deflate = function(bytes) {
// strip 2 byte zlib header and 4 byte trailer
return forge.util.deflate(sp.flashApi, bytes, true);
};
tlsOptions.inflate = function(bytes) {
return forge.util.inflate(sp.flashApi, bytes, true);
};
}
}
// create and initialize sockets
for(var i = 0; i < options.connections; ++i) {
_initSocket(client, sp.createSocket(), tlsOptions);
}
/**
* Sends a request. A method 'abort' will be set on the request that
* can be called to attempt to abort the request.
*
* @param options:
* request: the request to send.
* connected: a callback for when the connection is open.
* closed: a callback for when the connection is closed.
* headerReady: a callback for when the response header arrives.
* bodyReady: a callback for when the response body arrives.
* error: a callback for if an error occurs.
*/
client.send = function(options) {
// add host header if not set
if(options.request.getField('Host') === null) {
options.request.setField('Host', client.url.fullHost);
}
// set default dummy handlers
var opts = {};
opts.request = options.request;
opts.connected = options.connected || function() {};
opts.closed = options.close || function() {};
opts.headerReady = function(e) {
// read cookies
_readCookies(client, e.response);
if(options.headerReady) {
options.headerReady(e);
}
};
opts.bodyReady = options.bodyReady || function() {};
opts.error = options.error || function() {};
// create response
opts.response = http.createResponse();
opts.response.time = 0;
opts.response.flashApi = client.socketPool.flashApi;
opts.request.flashApi = client.socketPool.flashApi;
// create abort function
opts.request.abort = function() {
// set aborted, clear handlers
opts.request.aborted = true;
opts.connected = function() {};
opts.closed = function() {};
opts.headerReady = function() {};
opts.bodyReady = function() {};
opts.error = function() {};
};
// add cookies to request
_writeCookies(client, opts.request);
// queue request options if there are no idle sockets
if(client.idle.length === 0) {
client.requests.push(opts);
} else {
// use an idle socket, prefer an idle *connected* socket first
var socket = null;
var len = client.idle.length;
for(var i = 0; socket === null && i < len; ++i) {
socket = client.idle[i];
if(socket.isConnected()) {
client.idle.splice(i, 1);
} else {
socket = null;
}
}
// no connected socket available, get unconnected socket
if(socket === null) {
socket = client.idle.pop();
}
socket.options = opts;
_doRequest(client, socket);
}
};
/**
* Destroys this client.
*/
client.destroy = function() {
// clear pending requests, close and destroy sockets
client.requests = [];
for(var i = 0; i < client.sockets.length; ++i) {
client.sockets[i].close();
client.sockets[i].destroy();
}
client.socketPool = null;
client.sockets = [];
client.idle = [];
};
/**
* Sets a cookie for use with all connections made by this client. Any
* cookie with the same name will be replaced. If the cookie's value
* is undefined, null, or the blank string, the cookie will be removed.
*
* If the cookie's domain doesn't match this client's url host or the
* cookie's secure flag doesn't match this client's url scheme, then
* setting the cookie will fail with an exception.
*
* @param cookie the cookie with parameters:
* name: the name of the cookie.
* value: the value of the cookie.
* comment: an optional comment string.
* maxAge: the age of the cookie in seconds relative to created time.
* secure: true if the cookie must be sent over a secure protocol.
* httpOnly: true to restrict access to the cookie from javascript
* (inaffective since the cookies are stored in javascript).
* path: the path for the cookie.
* domain: optional domain the cookie belongs to (must start with dot).
* version: optional version of the cookie.
* created: creation time, in UTC seconds, of the cookie.
*/
client.setCookie = function(cookie) {
var rval;
if(typeof(cookie.name) !== 'undefined') {
if(cookie.value === null || typeof(cookie.value) === 'undefined' ||
cookie.value === '') {
// remove cookie
rval = client.removeCookie(cookie.name, cookie.path);
} else {
// set cookie defaults
cookie.comment = cookie.comment || '';
cookie.maxAge = cookie.maxAge || 0;
cookie.secure = (typeof(cookie.secure) === 'undefined') ?
true : cookie.secure;
cookie.httpOnly = cookie.httpOnly || true;
cookie.path = cookie.path || '/';
cookie.domain = cookie.domain || null;
cookie.version = cookie.version || null;
cookie.created = _getUtcTime(new Date());
// do secure check
if(cookie.secure !== client.secure) {
var error = new Error('Http client url scheme is incompatible ' +
'with cookie secure flag.');
error.url = client.url;
error.cookie = cookie;
throw error;
}
// make sure url host is within cookie.domain
if(!http.withinCookieDomain(client.url, cookie)) {
var error = new Error('Http client url scheme is incompatible ' +
'with cookie secure flag.');
error.url = client.url;
error.cookie = cookie;
throw error;
}
// add new cookie
if(!(cookie.name in client.cookies)) {
client.cookies[cookie.name] = {};
}
client.cookies[cookie.name][cookie.path] = cookie;
rval = true;
// save cookies
_saveCookies(client);
}
}
return rval;
};
/**
* Gets a cookie by its name.
*
* @param name the name of the cookie to retrieve.
* @param path an optional path for the cookie (if there are multiple
* cookies with the same name but different paths).
*
* @return the cookie or null if not found.
*/
client.getCookie = function(name, path) {
var rval = null;
if(name in client.cookies) {
var paths = client.cookies[name];
// get path-specific cookie
if(path) {
if(path in paths) {
rval = paths[path];
}
} else {
// get first cookie
for(var p in paths) {
rval = paths[p];
break;
}
}
}
return rval;
};
/**
* Removes a cookie.
*
* @param name the name of the cookie to remove.
* @param path an optional path for the cookie (if there are multiple
* cookies with the same name but different paths).
*
* @return true if a cookie was removed, false if not.
*/
client.removeCookie = function(name, path) {
var rval = false;
if(name in client.cookies) {
// delete the specific path
if(path) {
var paths = client.cookies[name];
if(path in paths) {
rval = true;
delete client.cookies[name][path];
// clean up entry if empty
var empty = true;
for(var i in client.cookies[name]) {
empty = false;
break;
}
if(empty) {
delete client.cookies[name];
}
}
} else {
// delete all cookies with the given name
rval = true;
delete client.cookies[name];
}
}
if(rval) {
// save cookies
_saveCookies(client);
}
return rval;
};
/**
* Clears all cookies stored in this client.
*/
client.clearCookies = function() {
client.cookies = {};
_clearCookies(client);
};
if(forge.log) {
forge.log.debug('forge.http', 'created client', options);
}
return client;
};
/**
* Trims the whitespace off of the beginning and end of a string.
*
* @param str the string to trim.
*
* @return the trimmed string.
*/
var _trimString = function(str) {
return str.replace(/^\s*/, '').replace(/\s*$/, '');
};
/**
* Creates an http header object.
*
* @return the http header object.
*/
var _createHeader = function() {
var header = {
fields: {},
setField: function(name, value) {
// normalize field name, trim value
header.fields[_normalize(name)] = [_trimString('' + value)];
},
appendField: function(name, value) {
name = _normalize(name);
if(!(name in header.fields)) {
header.fields[name] = [];
}
header.fields[name].push(_trimString('' + value));
},
getField: function(name, index) {
var rval = null;
name = _normalize(name);
if(name in header.fields) {
index = index || 0;
rval = header.fields[name][index];
}
return rval;
}
};
return header;
};
/**
* Gets the time in utc seconds given a date.
*
* @param d the date to use.
*
* @return the time in utc seconds.
*/
var _getUtcTime = function(d) {
var utc = +d + d.getTimezoneOffset() * 60000;
return Math.floor(+new Date() / 1000);
};
/**
* Creates an http request.
*
* @param options:
* version: the version.
* method: the method.
* path: the path.
* body: the body.
* headers: custom header fields to add,
* eg: [{'Content-Length': 0}].
*
* @return the http request.
*/
http.createRequest = function(options) {
options = options || {};
var request = _createHeader();
request.version = options.version || 'HTTP/1.1';
request.method = options.method || null;
request.path = options.path || null;
request.body = options.body || null;
request.bodyDeflated = false;
request.flashApi = null;
// add custom headers
var headers = options.headers || [];
if(!forge.util.isArray(headers)) {
headers = [headers];
}
for(var i = 0; i < headers.length; ++i) {
for(var name in headers[i]) {
request.appendField(name, headers[i][name]);
}
}
/**
* Adds a cookie to the request 'Cookie' header.
*
* @param cookie a cookie to add.
*/
request.addCookie = function(cookie) {
var value = '';
var field = request.getField('Cookie');
if(field !== null) {
// separate cookies by semi-colons
value = field + '; ';
}
// get current time in utc seconds
var now = _getUtcTime(new Date());
// output cookie name and value
value += cookie.name + '=' + cookie.value;
request.setField('Cookie', value);
};
/**
* Converts an http request into a string that can be sent as an
* HTTP request. Does not include any data.
*
* @return the string representation of the request.
*/
request.toString = function() {
/* Sample request header:
GET /some/path/?query HTTP/1.1
Host: www.someurl.com
Connection: close
Accept-Encoding: deflate
Accept: image/gif, text/html
User-Agent: Mozilla 4.0
*/
// set default headers
if(request.getField('User-Agent') === null) {
request.setField('User-Agent', 'forge.http 1.0');
}
if(request.getField('Accept') === null) {
request.setField('Accept', '*/*');
}
if(request.getField('Connection') === null) {
request.setField('Connection', 'keep-alive');
request.setField('Keep-Alive', '115');
}
// add Accept-Encoding if not specified
if(request.flashApi !== null &&
request.getField('Accept-Encoding') === null) {
request.setField('Accept-Encoding', 'deflate');
}
// if the body isn't null, deflate it if its larger than 100 bytes
if(request.flashApi !== null && request.body !== null &&
request.getField('Content-Encoding') === null &&
!request.bodyDeflated && request.body.length > 100) {
// use flash to compress data
request.body = forge.util.deflate(request.flashApi, request.body);
request.bodyDeflated = true;
request.setField('Content-Encoding', 'deflate');
request.setField('Content-Length', request.body.length);
} else if(request.body !== null) {
// set content length for body
request.setField('Content-Length', request.body.length);
}
// build start line
var rval =
request.method.toUpperCase() + ' ' + request.path + ' ' +
request.version + '\r\n';
// add each header
for(var name in request.fields) {
var fields = request.fields[name];
for(var i = 0; i < fields.length; ++i) {
rval += name + ': ' + fields[i] + '\r\n';
}
}
// final terminating CRLF
rval += '\r\n';
return rval;
};
return request;
};
/**
* Creates an empty http response header.
*
* @return the empty http response header.
*/
http.createResponse = function() {
// private vars
var _first = true;
var _chunkSize = 0;
var _chunksFinished = false;
// create response
var response = _createHeader();
response.version = null;
response.code = 0;
response.message = null;
response.body = null;
response.headerReceived = false;
response.bodyReceived = false;
response.flashApi = null;