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
  
#pike __REAL_VERSION__ 
 
// Informational 
constant HTTP_CONTINUE              = 100; // RFC 2616 10.1.1: Continue 
constant HTTP_SWITCH_PROT   = 101; // RFC 2616 10.1.2: Switching protocols 
constant DAV_PROCESSING             = 102; // RFC 2518 10.1: Processing 
 
// Successful 
constant HTTP_OK            = 200; // RFC 2616 10.2.1: OK 
constant HTTP_CREATED               = 201; // RFC 2616 10.2.2: Created 
constant HTTP_ACCEPTED              = 202; // RFC 2616 10.2.3: Accepted 
constant HTTP_NONAUTHORATIVE        = 203; // RFC 2616 10.2.4: Non-Authorative Information 
constant HTTP_NO_CONTENT    = 204; // RFC 2616 10.2.5: No Content 
constant HTTP_RESET_CONTENT = 205; // RFC 2616 10.2.6: Reset Content 
constant HTTP_PARTIAL_CONTENT       = 206; // RFC 2616 10.2.7: Partial Content 
constant DAV_MULTISTATUS    = 207; // RFC 2518 10.2: Multi-Status 
constant DELTA_HTTP_IM_USED = 226; // RFC 3229 10.4.1: IM Used 
 
// Redirection 
constant HTTP_MULTIPLE              = 300; // RFC 2616 10.3.1: Multiple Choices 
constant HTTP_MOVED_PERM    = 301; // RFC 2616 10.3.2: Moved Permanently 
constant HTTP_FOUND         = 302; // RFC 2616 10.3.3: Found 
constant HTTP_SEE_OTHER             = 303; // RFC 2616 10.3.4: See Other 
constant HTTP_NOT_MODIFIED  = 304; // RFC 2616 10.3.5: Not Modified 
constant HTTP_USE_PROXY             = 305; // RFC 2616 10.3.6: Use Proxy 
// RFC 2616 10.3.7: 306 not used but reserved. 
constant HTTP_TEMP_REDIRECT = 307; // RFC 2616 10.3.8: Temporary Redirect 
 
// Client errors 
constant HTTP_BAD           = 400; // RFC 2616 10.4.1: Bad Request 
constant HTTP_UNAUTH                = 401; // RFC 2616 10.4.2: Unauthorized 
constant HTTP_PAY           = 402; // RFC 2616 10.4.3: Payment Required 
constant HTTP_FORBIDDEN             = 403; // RFC 2616 10.4.4: Forbidden 
constant HTTP_NOT_FOUND             = 404; // RFC 2616 10.4.5: Not Found 
constant HTTP_METHOD_INVALID        = 405; // RFC 2616 10.4.6: Method Not Allowed 
constant HTTP_NOT_ACCEPTABLE        = 406; // RFC 2616 10.4.7: Not Acceptable 
constant HTTP_PROXY_AUTH_REQ        = 407; // RFC 2616 10.4.8: Proxy Authentication Required 
constant HTTP_TIMEOUT               = 408; // RFC 2616 10.4.9: Request Timeout 
constant HTTP_CONFLICT              = 409; // RFC 2616 10.4.10: Conflict 
constant HTTP_GONE          = 410; // RFC 2616 10.4.11: Gone 
constant HTTP_LENGTH_REQ    = 411; // RFC 2616 10.4.12: Length Required 
constant HTTP_PRECOND_FAILED        = 412; // RFC 2616 10.4.13: Precondition Failed 
constant HTTP_REQ_TOO_LARGE = 413; // RFC 2616 10.4.14: Request Entity Too Large 
constant HTTP_URI_TOO_LONG  = 414; // RFC 2616 10.4.15: Request-URI Too Long 
constant HTTP_UNSUPP_MEDIA  = 415; // RFC 2616 10.4.16: Unsupported Media Type 
constant HTTP_BAD_RANGE             = 416; // RFC 2616 10.4.17: Requested Range Not Satisfiable 
constant HTTP_EXPECT_FAILED = 417; // RFC 2616 10.4.18: Expectation Failed 
constant HTCPCP_TEAPOT              = 418; // RFC 2324 2.3.2: I'm a teapot 
constant HTTP_MISDIRECTED_REQ       = 421; // RFC 7540 9.1.2: Misdirected Request 
constant DAV_UNPROCESSABLE  = 422; // RFC 2518 10.3: Unprocessable Entry 
constant DAV_LOCKED         = 423; // RFC 2518 10.4: Locked 
constant DAV_FAILED_DEP             = 424; // RFC 2518 10.5: Failed Dependency 
 
constant HTTP_LEGALLY_RESTRICTED= 451; // Draft: Unavailable for Legal Reasons 
 
// Server errors 
constant HTTP_INTERNAL_ERR  = 500; // RFC 2616 10.5.1: Internal Server Error 
constant HTTP_NOT_IMPL              = 501; // RFC 2616 10.5.2: Not Implemented 
constant HTTP_BAD_GW                = 502; // RFC 2616 10.5.3: Bad Gateway 
constant HTTP_UNAVAIL               = 503; // RFC 2616 10.5.4: Service Unavailable 
constant HTTP_GW_TIMEOUT    = 504; // RFC 2616 10.5.5: Gateway Timeout 
constant HTTP_UNSUPP_VERSION        = 505; // RFC 2616 10.5.6: HTTP Version Not Supported 
constant TCN_VARIANT_NEGOTIATES     = 506; // RFC 2295 8.1: Variant Also Negotiates 
constant DAV_STORAGE_FULL   = 507; // RFC 2518 10.6: Insufficient Storage 
 
constant response_codes = 
([ 
  // Informational 
  100:"100 Continue", 
  101:"101 Switching Protocols", 
  102:"102 Processing", // WebDAV 
  103:"103 Checkpoint", 
  122:"122 Request-URI too long", // a non standard IE7 error 
 
  // Successful 
  200:"200 OK", 
  201:"201 Created, URI follows", 
  202:"202 Accepted", 
  203:"203 Non-Authoritative Information", 
  204:"204 No Content", 
  205:"205 Reset Content", 
  206:"206 Partial Content", // Byte ranges 
  207:"207 Multi-Status", // WebDAV 
  226:"226 IM Used", // RFC 3229 
 
  // Redirection 
  300:"300 Moved", 
  301:"301 Permanent Relocation", 
  302:"302 Found", // a potential alligator swamp. for HTTP/1.1, use 303/307. 
  303:"303 See Other", // temporary redirect, any POST data is received, use GET. 
  304:"304 Not Modified", 
  305:"305 Use Proxy", 
  306:"306 Switch Proxy", // Deprecated 
  307:"307 Temporary Redirect", // retry request elsewhere, don't change method. 
  308:"308 Resume Incomplete", 
 
  // Client Error 
  400:"400 Bad Request", 
  401:"401 Access denied", 
  402:"402 Payment Required", 
  403:"403 Forbidden", 
  404:"404 No such file or directory.", 
  405:"405 Method not allowed", 
  406:"406 Not Acceptable", 
  407:"407 Proxy authorization needed", 
  408:"408 Request timeout", 
  409:"409 Conflict", 
  410:"410 Gone", 
  411:"411 Length Required", 
  412:"412 Precondition Failed", 
  413:"413 Request Entity Too Large", 
  414:"414 Request-URI Too Large", 
  415:"415 Unsupported Media Type", 
  416:"416 Requested range not statisfiable", 
  417:"417 Expectation Failed", 
  418:"418 I'm a teapot", // Ha ha 
  421:"421 Misdirected Request", 
  422:"422 Unprocessable Entity", // WebDAV 
  423:"423 Locked", // WebDAV 
  424:"424 Failed Dependency", // WebDAV 
  425:"425 Unordered Collection", // RFC3648 
  426:"426 Upgrade Required", // RFC2817 
  451:"451 Unavailable for Legal Reasons", // draft-tbray-http-legally-restricted-status 
 
  // Internal Server Errors 
  500:"500 Internal Server Error.", 
  501:"501 Not Implemented", 
  502:"502 Bad Gateway", 
  503:"503 Service unavailable", 
  504:"504 Gateway Timeout", 
  505:"505 HTTP Version Not Supported", 
  506:"506 Variant Also Negotiates", // RFC2295 
  507:"507 Insufficient Storage", // WebDAV / RFC4918 
  509:"509 Bandwidth Limit Exceeded", // An Apache defined extension in popular use 
  510:"510 Not Extended", // RFC2774 
  598:"598 Network read timeout error", // Informal extension used by some HTTP proxies 
  599:"599 Network connect timeout error", // Informal extension used by some HTTP proxies 
]); 
 
 
//! Makes an HTTP request through a proxy. 
//! 
//! @param proxy 
//!   URL for the proxy. 
//! 
//! @param user 
//! @param password 
//!   Proxy authentication credentials. 
//! 
//! @param method 
//! @param url 
//! @param query_variables 
//! @param request_headers 
//! @param con 
//! @param data 
//!   The remaining arguments are identical to @[do_method()]. 
//! 
//! @seealso 
//!   @[do_method()], @[do_async_proxied_method()] 
.Query do_proxied_method(string|Standards.URI proxy, 
                         string user, string password, 
                         string method, 
                         string|Standards.URI url, 
                         void|mapping(string:int|string|array(string)) query_variables, 
                         void|mapping(string:string|array(string)) request_headers, 
                         void|Protocols.HTTP.Query con, void|string data) 
{ 
  if (!proxy || (proxy == "")) { 
    return do_method(method, url, query_variables, request_headers, con, data); 
  } 
  // Make sure we don't propagate our changes to the 
  // url and proxy objects below to the caller. 
  proxy = Standards.URI(proxy); 
  url = Standards.URI(url); 
 
  mapping(string:string|array(string)) proxy_headers; 
 
  if( user || password ) 
  { 
    if( !request_headers ) 
      proxy_headers = ([]); 
    else 
      proxy_headers = request_headers + ([]); 
 
    proxy_headers["Proxy-Authorization"] = "Basic " 
      + MIME.encode_base64((user || "") + ":" + (password || ""), 1); 
  } 
 
  if (url->scheme == "http") { 
    if( query_variables ) 
      url->set_query_variables( url->get_query_variables() + 
                                query_variables ); 
    string web_url = (string)url; 
 
    // Note: url object is wrecked here 
    url->scheme = proxy->scheme; 
    url->host = proxy->host; 
    url->port = proxy->port; 
    query_variables = url->query = 0; 
    url->path = web_url; 
  } else if (url->scheme == "https") { 
#ifdef HTTP_QUERY_DEBUG 
    werror("Proxied SSL request.\n"); 
#endif 
    if (!con || (con->host != url->host) || (con->port != url->port)) { 
      // Make a CONNECT request to the proxy, 
      // and use keep-alive to stack the real request on top. 
      proxy->path = url->host + ":" + url->port; 
      if (!proxy_headers) proxy_headers = ([]); 
      proxy_headers->connection = "keep-alive"; 
      m_delete(proxy_headers, "authorization");     // Keep the proxy in the dark. 
      con = do_method("CONNECT", proxy, 0, proxy_headers); 
      con->data(0); 
      if (con->status/100 > 2) { 
        return con; 
      } 
      con->headers["connection"] = "keep-alive"; 
      con->headers["content-length"] = "0"; 
      con->host = url->host; 
      con->port = url->port; 
      con->https = 1; 
      con->start_tls(1); 
    } 
    proxy_headers = request_headers; 
  } else { 
    error("Can't handle proxying of %O.\n", url->scheme); 
  } 
 
  return do_method(method, url, query_variables, proxy_headers, con, data); 
} 
 
//! Low level HTTP call method. 
//! 
//! @param method 
//!   The HTTP method to use, e.g. @expr{"GET"@}. 
//! @param url 
//!   The URL to perform @[method] on. Should be a complete URL, 
//!   including protocol, e.g. @expr{"https://pike.lysator.liu.se/"@}. 
//! @param query_variables 
//!   Calls @[http_encode_query] and appends the result to the URL. 
//! @param request_headers 
//!   The HTTP headers to be added to the request. By default the 
//!   headers User-agent, Host and, if needed by the url, 
//!   Authorization will be added, with generated contents. 
//!   Providing these headers will override the default. Setting 
//!   the value to 0 will remove that header from the request. 
//! @param con 
//!   Old connection object. 
//! @param data 
//!   Data payload to be transmitted in the request. 
//! 
//! @seealso 
//!   @[do_sync_method()] 
.Query do_method(string method, 
                 string|Standards.URI url, 
                 void|mapping(string:int|string|array(string)) query_variables, 
                 void|mapping(string:string|array(string)) request_headers, 
                 void|Protocols.HTTP.Query con, void|string data) 
{ 
  if(stringp(url)) 
    url=Standards.URI(url); 
 
  if( (< "httpu", "httpmu" >)[url->scheme] ) { 
    return do_udp_method(method, url, query_variables, request_headers, 
                         con, data); 
  } 
 
  if(!con) 
    con = .Query(); 
 
  if(url->scheme!="http" && url->scheme!="https") 
    error("Can't handle %O or any other protocols than HTTP or HTTPS.\n", 
          url->scheme); 
 
  con->https = (url->scheme=="https")? 1 : 0; 
 
  mapping default_headers = ([ 
    "user-agent" : "Mozilla/5.0 (compatible; MSIE 6.0; Pike HTTP client)" 
    " Pike/" + __REAL_MAJOR__ + "." + __REAL_MINOR__ + "." + __REAL_BUILD__, 
    "host" : url->host + 
    (url->port!=(url->scheme=="https"?443:80)?":"+url->port:"")]); 
 
  if(url->user || url->password) 
    default_headers->authorization = "Basic " 
                                   + MIME.encode_base64(url->user + ":" + 
                                                        (url->password || ""), 
                                                        1); 
 
  if(!request_headers) 
    request_headers = default_headers; 
  else 
    request_headers = default_headers | 
      mkmapping(lower_case(indices(request_headers)[*]), 
                values(request_headers)); 
 
  string query=url->query; 
  if(query_variables && sizeof(query_variables)) 
  { 
    if(query) 
      query+="&"+http_encode_query(query_variables); 
    else 
      query=http_encode_query(query_variables); 
  } 
 
  string path=url->path; 
  if(path=="") path="/"; 
 
  con->sync_request(url->host,url->port, 
                    method+" "+path+(query?("?"+query):"")+" HTTP/1.0", 
                    request_headers, data); 
 
  if (!con->ok) { 
    if (con->errno) 
      error ("I/O error: %s.\n", strerror (con->errno)); 
    return 0; 
  } 
  return con; 
} 
 
protected .Query do_udp_method(string method, Standards.URI url, 
                            void|mapping(string:int|string|array(string)) query_variables, 
                            void|mapping(string:string|array(string)) 
                            request_headers, void|Protocols.HTTP.Query con, 
                            void|string data) 
{ 
  if(!request_headers) 
    request_headers = ([]); 
 
  string path = url->path; 
  if(path=="") { 
    if(url->method=="httpmu") 
      path = "*"; 
    else 
      path = "/"; 
  } 
  string msg = method + " " + path + " HTTP/1.1\r\n"; 
 
  Stdio.UDP udp = Stdio.UDP(); 
  int port = 10000 + random(1000); 
  int i; 
  while(1) { 
    if( !catch( udp->bind(port++, 0, 1) ) ) break; 
    if( i++ > 1000 ) error("Could not open a UDP port.\n"); 
  } 
  if(url->method=="httpmu") { 
    mapping ifs = Stdio.gethostip(); 
    if(!sizeof(ifs)) error("No Internet interface found.\n"); 
    foreach(ifs; string i; mapping data) 
      if(sizeof(data->ips)) { 
        udp->enable_multicast(data->ips[0]); 
        break; 
      } 
    udp->add_membership(url->host, 0, 0); 
  } 
  udp->set_multicast_ttl(4); 
  udp->send(url->host, url->port, msg); 
  if (!con) { 
    con = .Query(); 
  } 
  con->con = udp; 
  return con; 
} 
 
//! Low level asynchronous HTTP call method. 
//! 
//! @param method 
//!   The HTTP method to use, e.g. @expr{"GET"@}. 
//! @param url 
//!   The URL to perform @[method] on. Should be a complete URL, 
//!   including protocol, e.g. @expr{"https://pike.lysator.liu.se/"@}. 
//! @param query_variables 
//!   Calls @[http_encode_query] and appends the result to the URL. 
//! @param request_headers 
//!   The HTTP headers to be added to the request. By default the 
//!   headers User-agent, Host and, if needed by the url, 
//!   Authorization will be added, with generated contents. 
//!   Providing these headers will override the default. Setting 
//!   the value to 0 will remove that header from the request. 
//! @param con 
//!   Previously initialized connection object. 
//!   In particular the callbacks must have been set 
//!   (@[Query.set_callbacks()]). 
//! @param data 
//!   Data payload to be transmitted in the request. 
//! 
//! @seealso 
//!   @[do_method()], @[Query.set_callbacks()] 
void do_async_method(string method, 
                     string|Standards.URI url, 
                     void|mapping(string:int|string|array(string)) query_variables, 
                     void|mapping(string:string|array(string)) request_headers, 
                     Protocols.HTTP.Query con, void|string data) 
{ 
  if(stringp(url)) 
    url=Standards.URI(url); 
 
  if( (< "httpu", "httpmu" >)[url->scheme] ) { 
    error("Asynchronous httpu or httpmu not yet supported.\n"); 
  } 
 
  if(url->scheme!="http" && url->scheme!="https") 
    error("Can't handle %O or any other protocols than HTTP or HTTPS.\n", 
          url->scheme); 
 
  con->https = (url->scheme=="https")? 1 : 0; 
 
  if(!request_headers) 
    request_headers = ([]); 
  mapping default_headers = ([ 
    "user-agent" : "Mozilla/5.0 (compatible; MSIE 6.0; Pike HTTP client)" 
    " Pike/" + __REAL_MAJOR__ + "." + __REAL_MINOR__ + "." + __REAL_BUILD__, 
    "host" : url->host + 
    (url->port!=(url->scheme=="https"?443:80)?":"+url->port:"")]); 
 
  if(url->user || url->password) 
    default_headers->authorization = "Basic " 
                                   + MIME.encode_base64(url->user + ":" + 
                                                        (url->password || ""), 
                                                        1); 
  request_headers = default_headers | request_headers; 
 
  string query=url->query; 
  if(query_variables && sizeof(query_variables)) 
  { 
    if(query) 
      query+="&"+http_encode_query(query_variables); 
    else 
      query=http_encode_query(query_variables); 
  } 
 
  string path=url->path; 
  if(path=="") path="/"; 
 
  con->async_request(url->host, url->port, 
                     method+" "+path+(query?("?"+query):"")+" HTTP/1.0", 
                     request_headers, data); 
} 
 
protected void https_proxy_connect_fail(Protocols.HTTP.Query con, 
                                        array(mixed) orig_cb_info, 
                                        Standards.URI url, string method, 
                                        mapping(string:string) query_variables, 
                                        mapping(string:string) request_headers, 
                                        string data) 
{ 
  con->set_callbacks(@orig_cb_info); 
  con->request_fail(con, @con->extra_args); 
} 
 
protected void https_proxy_connect_ok(Protocols.HTTP.Query con, 
                                      array(mixed) orig_cb_info, 
                                      Standards.URI url, string method, 
                                      mapping(string:string) query_variables, 
                                      mapping(string:string) request_headers, 
                                      string data) 
{ 
  con->set_callbacks(@orig_cb_info); 
 
  // Install the timeout handler for the interval until 
  // the TLS connection is up. 
  con->init_async_timeout(); 
  con->con->set_nonblocking(0, 
                            lambda() { 
                              // Remove the timeout handler; it will be 
                              // reinstated by do_async_method() below. 
                              con->remove_async_timeout(); 
                              do_async_method(method, url, query_variables, 
                                              request_headers, con, data); 
                            }, con->async_failed); 
 
  con->headers["connection"] = "keep-alive"; 
  con->headers["content-length"] = "0"; 
  con->host = url->host; 
  con->port = url->port; 
  con->https = 1; 
  con->start_tls(0); 
} 
 
//! Low level asynchronous proxied HTTP call method. 
//! 
//! Makes an HTTP request through a proxy. 
//! 
//! @param proxy 
//!   URL for the proxy. 
//! 
//! @param user 
//! @param password 
//!   Proxy authentication credentials. 
//! 
//! @param method 
//!   The HTTP method to use, e.g. @expr{"GET"@}. 
//! @param url 
//!   The URL to perform @[method] on. Should be a complete URL, 
//!   including protocol, e.g. @expr{"https://pike.lysator.liu.se/"@}. 
//! @param query_variables 
//!   Calls @[http_encode_query] and appends the result to the URL. 
//! @param request_headers 
//!   The HTTP headers to be added to the request. By default the 
//!   headers User-agent, Host and, if needed by the url, 
//!   Authorization will be added, with generated contents. 
//!   Providing these headers will override the default. Setting 
//!   the value to 0 will remove that header from the request. 
//! @param con 
//!   Previously initialized connection object. 
//!   In particular the callbacks must have been set 
//!   (@[Query.set_callbacks()]). 
//! @param data 
//!   Data payload to be transmitted in the request. 
//! 
//! @seealso 
//!   @[do_async_method()], @[do_proxied_method()], @[Query.set_callbacks()] 
void do_async_proxied_method(string|Standards.URI proxy, 
                             string user, string password, 
                             string method, 
                             string|Standards.URI url, 
                             void|mapping(string:int|string|array(string)) query_variables, 
                             void|mapping(string:string|array(string)) request_headers, 
                             Protocols.HTTP.Query con, void|string data) 
{ 
  if (!proxy || (proxy == "")) { 
    do_async_method(method, url, query_variables, request_headers, con, data); 
    return; 
  } 
  // Make sure we don't propagate our changes to the 
  // url and proxy objects below to the caller. 
  proxy = Standards.URI(proxy); 
  url = Standards.URI(url); 
 
  if( (< "httpu", "httpmu" >)[url->scheme] ) { 
    error("Asynchronous httpu or httpmu not yet supported.\n"); 
  } 
 
  mapping(string:string|array(string)) proxy_headers; 
 
  if( user || password ) 
  { 
    if( !request_headers ) 
      proxy_headers = ([]); 
    else 
      proxy_headers = request_headers + ([]); 
 
    proxy_headers["Proxy-Authorization"] = "Basic " 
      + MIME.encode_base64((user || "") + ":" + (password || ""), 1); 
  } 
 
  if (url->scheme == "http") { 
    if( query_variables ) 
      url->set_query_variables( url->get_query_variables() + 
                                query_variables ); 
    string web_url = (string)url; 
 
    // Note: url object is wrecked here 
    url->scheme = proxy->scheme; 
    url->host = proxy->host; 
    url->port = proxy->port; 
    query_variables = url->query = 0; 
    url->path = web_url; 
  } else if(url->scheme == "https") { 
#ifdef HTTP_QUERY_DEBUG 
    werror("Proxied SSL request.\n"); 
#endif 
    if (!con || (con->host != url->host) || (con->port != url->port)) { 
      // Make a CONNECT request to the proxy, 
      // and use keep-alive to stack the real request on top. 
      proxy->path = url->host + ":" + url->port; 
      if (!proxy_headers) proxy_headers = ([]); 
      proxy_headers->connection = "keep-alive"; 
      m_delete(proxy_headers, "authorization");     // Keep the proxy in the dark. 
 
      array(mixed) orig_cb_info = ({ 
        con->request_ok, 
        con->request_fail, 
        @con->extra_args, 
      }); 
      con->set_callbacks(https_proxy_connect_ok, 
                         https_proxy_connect_fail, 
                         orig_cb_info, 
                         url, method, 
                         query_variables, 
                         request_headers && request_headers + ([]), 
                         data); 
      method = "CONNECT"; 
      url = proxy; 
      data = 0; 
    } else { 
      proxy_headers = request_headers; 
    } 
  } else { 
    error("Can't handle proxying of %O.\n", url->scheme); 
  } 
 
  do_async_method(method, url, query_variables, proxy_headers, con, data); 
} 
 
//! Sends a HTTP GET request to the server in the URL and returns the 
//! created and initialized @[Query] object. @expr{0@} is returned 
//! upon failure. If a query object having 
//! @expr{request_headers->Connection=="Keep-Alive"@} from a previous 
//! request is provided and the already established server connection 
//! can be used for the next request, you may gain some performance. 
//! 
.Query get_url(string|Standards.URI url, 
               void|mapping(string:int|string|array(string)) query_variables, 
               void|mapping(string:string|array(string)) request_headers, 
               void|Protocols.HTTP.Query con) 
{ 
  return do_method("GET", url, query_variables, request_headers, con); 
} 
 
//! Sends a HTTP PUT request to the server in the URL and returns the 
//! created and initialized @[Query] object. @expr{0@} is returned upon 
//! failure. If a query object having 
//! @expr{request_headers->Connection=="Keep-Alive"@} from a previous 
//! request is provided and the already established server connection 
//! can be used for the next request, you may gain some performance. 
//! 
.Query put_url(string|Standards.URI url, 
               void|string file, 
               void|mapping(string:int|string|array(string)) query_variables, 
               void|mapping(string:string|array(string)) request_headers, 
               void|Protocols.HTTP.Query con) 
{ 
  return do_method("PUT", url, query_variables, request_headers, con, file); 
} 
 
//! Sends a HTTP DELETE request to the server in the URL and returns 
//! the created and initialized @[Query] object. @expr{0@} is returned 
//! upon failure. If a query object having 
//! @expr{request_headers->Connection=="Keep-Alive"@} from a previous 
//! request is provided and the already established server connection 
//! can be used for the next request, you may gain some performance. 
//! 
.Query delete_url(string|Standards.URI url, 
                  void|mapping(string:int|string|array(string)) query_variables, 
                  void|mapping(string:string|array(string)) request_headers, 
                  void|Protocols.HTTP.Query con) 
{ 
  return do_method("DELETE", url, query_variables, request_headers, con); 
} 
 
//! Returns an array of @expr{({content_type, data})@} after calling 
//! the requested server for the information. @expr{0@} is returned 
//! upon failure. Redirects (HTTP 302) are automatically followed. 
//! 
array(string) get_url_nice(string|Standards.URI url, 
                           void|mapping(string:int|string|array(string)) query_variables, 
                           void|mapping(string:string|array(string)) request_headers, 
                           void|Protocols.HTTP.Query con) 
{ 
  .Query c; 
  multiset seen = (<>); 
  do { 
    if(!url) return 0; 
    if(seen[url] || sizeof(seen)>1000) return 0; 
    seen[url]=1; 
    c = get_url(url, query_variables, request_headers, con); 
    if(!c) return 0; 
    if(c->status==302) 
      url = Standards.URI(c->headers->location, url); 
  } while( c->status!=200 ); 
  return ({ c->headers["content-type"], c->data() }); 
} 
 
//! Returns the returned data after calling the requested server for 
//! information through HTTP GET. @expr{0@} is returned upon failure. 
//! Redirects (HTTP 302) are automatically followed. 
//! 
string get_url_data(string|Standards.URI url, 
                    void|mapping(string:int|string|array(string)) query_variables, 
                    void|mapping(string:string|array(string)) request_headers, 
                    void|Protocols.HTTP.Query con) 
{ 
  array(string) z = get_url_nice(url, query_variables, request_headers, con); 
  return z && z[1]; 
} 
 
//! Similar to @[get_url], except that query variables is sent as a 
//! POST request instead of a GET request.  If query_variables is a 
//! simple string, it is assumed to contain the verbatim 
//! body of the POST request; Content-Type must be properly specified 
//! manually, in this case. 
.Query post_url(string|Standards.URI url, 
        mapping(string:int|string|array(string))|string query_variables, 
                void|mapping(string:string|array(string)) request_headers, 
                void|Protocols.HTTP.Query con) 
{ 
  return do_method("POST", url, 0, stringp(query_variables) ? request_headers 
                   : (request_headers||([]))| 
                   (["content-type": 
                     "application/x-www-form-urlencoded"]), 
                   con, 
                   stringp(query_variables) ? query_variables 
                    : http_encode_query(query_variables)); 
} 
 
//! Similar to @[get_url_nice], except that query variables is sent as 
//! a POST request instead of a GET request. 
array(string) post_url_nice(string|Standards.URI url, 
                            mapping(string:int|string|array(string))|string query_variables, 
                            void|mapping(string:string|array(string)) request_headers, 
                            void|Protocols.HTTP.Query con) 
{ 
  .Query c = post_url(url, query_variables, request_headers, con); 
  return c && ({ c->headers["content-type"], c->data() }); 
} 
 
//! Similar to @[get_url_data], except that query variables is sent as 
//! a POST request instead of a GET request. 
string post_url_data(string|Standards.URI url, 
                     mapping(string:int|string|array(string))|string query_variables, 
                     void|mapping(string:string|array(string)) request_headers, 
                     void|Protocols.HTTP.Query con) 
{ 
  .Query z = post_url(url, query_variables, request_headers, con); 
  return z && z->data(); 
} 
 
//!   Encodes a query mapping to a string; 
//!   this protects odd - in http perspective - characters 
//!   like '&' and '#' and control characters, 
//!   and packs the result together in a HTTP query string. 
//! 
//!   Example: 
//!   @pre{ 
//!   > Protocols.HTTP.http_encode_query( (["anna":"eva","lilith":"blue"]) ); 
//!     Result: "lilith=blue&anna=eva" 
//!     > Protocols.HTTP.http_encode_query( (["&amp;":"&","'=\"":"\0\0\0\u0434"]) ); 
//!     Result: "%27%3D%22=%00%00%00%D0%B4&%26amp%3B=%26" 
//!   @} 
string http_encode_query(mapping(string:int|string|array(string)) variables) 
{ 
   return map((array)variables, 
              lambda(array(string|int|array(string)) v) 
              { 
                if (intp(v[1])) 
                  return uri_encode(v[0]); 
                if (arrayp(v[1])) 
                  return map(v[1], lambda (string val) { 
                                     return 
                                       uri_encode(v[0])+"="+ 
                                       uri_encode(val); 
                                   })*"&"; 
                return uri_encode(v[0])+"="+ uri_encode(v[1]); 
              })*"&"; 
} 
 
protected local constant gen_delims = ":/?#[]@" // RFC 3986, section 2.2 
  // % is not part of the gen-delims set, but it effectively must be 
  // treated as a reserved character wrt encoding and decoding. 
  "%"; 
 
protected local constant sub_delims = "!$&'()*+,;="; // RFC 3986, section 2.2 
 
// US-ASCII chars that are neither reserved nor unreserved in RFC 3986. 
protected local constant other_chars = 
  (string) enumerate (0x20) + "\x7f" // Control chars 
  " \"<>\\^`{|}"; 
 
protected local constant eight_bit_chars = (string) enumerate (0x80, 1, 0x80); 
 
string percent_encode (string s) 
//! Encodes the given string using @tt{%XX@} encoding, except that URI 
//! unreserved chars are not encoded. The unreserved chars are 
//! @tt{A-Z@}, @tt{a-z@}, @tt{0-9@}, @tt{-@}, @tt{.@}, @tt{_@}, and 
//! @tt{~@} (see @rfc{2396:2.3@}). 
//! 
//! 8-bit chars are encoded straight, and wider chars are not allowed. 
//! That means this encoding is applicable if @[s] is a binary octet 
//! string. If it is a character string then @[uri_encode] should be 
//! used instead. 
//! 
//! It is also slightly faster than @[uri_encode] if @[s] is known to 
//! contain only US-ASCII. 
{ 
  constant replace_chars = (gen_delims + sub_delims + 
                            other_chars + eight_bit_chars); 
  return replace (s, 
                  // The [*] syntax is hideous, but lambdas currently 
                  // don't work in constant expressions. :P 
                  sprintf ("%c", ((array(int)) replace_chars)[*]), 
                  // RFC 3986, 2.1: "For consistency, URI producers 
                  // and normalizers should use uppercase hexadecimal 
                  // digits for all percent- encodings." 
                  sprintf ("%%%02X", ((array(int)) replace_chars)[*])); 
} 
 
string percent_decode (string s) 
//! Decodes URI-style @tt{%XX@} encoded chars in the given string. 
//! 
//! @seealso 
//! @[percent_encode], @[uri_decode] 
//! 
//! @bugs 
//! This function currently does not accept wide string input, which 
//! is necessary to work as the reverse of @[iri_encode]. 
{ 
  return _Roxen.http_decode_string (s); 
} 
 
string uri_encode (string s) 
//! Encodes the given string using @tt{%XX@} encoding to be used as a 
//! component part in a URI. This means that all URI reserved and 
//! excluded characters are encoded, i.e. everything except @tt{A-Z@}, 
//! @tt{a-z@}, @tt{0-9@}, @tt{-@}, @tt{.@}, @tt{_@}, and @tt{~@} (see 
//! @rfc{2396:2.3@}). 
//! 
//! 8-bit chars and wider are encoded using UTF-8 followed by 
//! percent-encoding. This follows @rfc{3986:2.5@}, the IRI-to-URI 
//! conversion method in the IRI standard (@rfc{3987@}) and appendix 
//! B.2 in the HTML 4.01 standard. It should work regardless of the 
//! charset used in the XML document the URI might be inserted into. 
//! 
//! @seealso 
//! @[uri_decode], @[uri_encode_invalids], @[iri_encode] 
{ 
  return percent_encode (string_to_utf8 (s)); 
} 
 
string uri_encode_invalids (string s) 
//! Encodes all "dangerous" chars in the given string using @tt{%XX@} 
//! encoding, so that it can be included as a URI in an HTTP message 
//! or header field. This includes control chars, space and various 
//! delimiter chars except those in the URI @tt{reserved@} set 
//! (@rfc{2396:2.2@}). 
//! 
//! Since this function doesn't touch the URI @tt{reserved@} chars nor 
//! the escape char @tt{%@}, it can be used on a complete formatted 
//! URI or IRI. 
//! 
//! 8-bit chars and wider are encoded using UTF-8 followed by 
//! percent-encoding. This follows @rfc{3986:2.5@}, the IRI standard 
//! (@rfc{3987@}) and appendix B.2 in the HTML 4.01 standard. 
//! 
//! @note 
//! The characters in the URI @tt{reserved@} set are: @tt{:@}, 
//! @tt{/@}, @tt{?@}, @tt{#@}, @tt{[@}, @tt{]@}, @tt{@@@}, @tt{!@}, 
//! @tt{$@}, @tt{&@}, @tt{'@}, @tt{(@}, @tt{)@}, @tt{*@}, @tt{+@}, 
//! @tt{,@}, @tt{;@}, @tt{=@}. In addition, this function doesn't 
//! touch the escape char @tt{%@}. 
//! 
//! @seealso 
//! @[uri_decode], @[uri_encode] 
{ 
  constant replace_chars = other_chars + eight_bit_chars; 
  return replace (string_to_utf8 (s), 
                  sprintf ("%c", ((array(int)) replace_chars)[*]), 
                  sprintf ("%%%02X", ((array(int)) replace_chars)[*])); 
} 
 
string uri_decode (string s) 
//! Decodes URI-style @tt{%XX@} encoded chars in the given string, and 
//! then UTF-8 decodes the result. This is the reverse of 
//! @[uri_encode] and @[uri_encode_invalids]. 
//! 
//! @seealso 
//! @[uri_encode], @[uri_encode_invalids] 
{ 
  // Note: This currently does not quite work for URI-to-IRI 
  // conversion according to RFC 3987 section 3.2. Most importantly 
  // any invalid utf8-sequences should be left percent-encoded in the 
  // result. 
  return utf8_to_string (_Roxen.http_decode_string (s)); 
} 
 
string iri_encode (string s) 
//! Encodes the given string using @tt{%XX@} encoding to be used as a 
//! component part in an IRI (Internationalized Resource Identifier, 
//! see @rfc{3987@}). This means that all chars outside the IRI 
//! @tt{iunreserved@} set are encoded, i.e. this function encodes 
//! equivalently to @[uri_encode] except that all 8-bit and wider 
//! characters are left as-is. 
//! 
//! @bugs 
//! This function currently does not encode chars in the Unicode 
//! private ranges, although that is strictly speaking required in 
//! some but not all IRI components. That could change if it turns out 
//! to be a problem. 
//! 
//! @seealso 
//! @[percent_decode], @[uri_encode] 
{ 
  constant replace_chars = gen_delims + sub_delims + other_chars; 
  return replace (s, 
                  sprintf ("%c", ((array(int)) replace_chars)[*]), 
                  sprintf ("%%%02X", ((array(int)) replace_chars)[*])); 
} 
 
string quoted_string_encode (string s) 
//! Encodes the given string quoted to be used as content inside a 
//! @tt{quoted-string@} according to @rfc{2616:2.2@}. The returned 
//! string does not include the surrounding @tt{"@} chars. 
//! 
//! @note 
//! The @tt{quoted-string@} quoting rules in @rfc{2616@} have several 
//! problems: 
//! 
//! @ul 
//! @item 
//!   Quoting is inconsistent since @tt{"@} is quoted as @tt{\"@}, but 
//!   @tt{\@} does not need to be quoted. This is resolved in the HTTP 
//!   bis update to mandate quoting of @tt{\@} too, which this 
//!   function performs. 
//! 
//! @item 
//!   Many characters are not quoted sufficiently to make the result 
//!   safe to use in an HTTP header, so this quoting is not enough if 
//!   @[s] contains NUL, CR, LF, or any 8-bit or wider character. 
//! @endul 
//! 
//! @seealso 
//! @[quoted_string_decode] 
{ 
  return replace (s, (["\"": "\\\"", "\\": "\\\\"])); 
} 
 
string quoted_string_decode (string s) 
//! Decodes the given string which has been encoded as a 
//! @tt{quoted-string@} according to @rfc{2616:2.2@}. @[s] is assumed 
//! to not include the surrounding @tt{"@} chars. 
//! 
//! @seealso 
//! @[quoted_string_encode] 
{ 
  return map (s / "\\\\", replace, "\\", "") * "\\"; 
}