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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
|
#pike __REAL_VERSION__
//! Open and execute an HTTP query.
//!
//! @example
//! HTTP.Query o=HTTP.Query();
//!
//! void ok()
//! {
//! write("ok...\n");
//! write("%O\n", o->headers);
//! exit(0);
//! }
//!
//! void fail()
//! {
//! write("fail\n");
//! exit(0);
//! }
//!
//! int main()
//! {
//! o->set_callbacks(ok, fail);
//! o->async_request("pike.lysator.liu.se", 80, "HEAD / HTTP/1.0");
//! return -1;
//! }
#ifdef HTTP_QUERY_DEBUG
#define DBG(X ...) werror(sprintf("%q:%d: ", __FILE__, __LINE__) + X)
#else
#define DBG(X ...)
#endif
/****** variables **************************************************/
// open
//! Errno copied from the connection or simulated for async operations.
//! @note
//! In Pike 7.8 and earlier hardcoded Linux values were used in
//! async operations, 110 instead of @expr{System.ETIMEDOUT@} and
//! 113 instead of @expr{System.EHOSTUNREACH@}.
int errno;
//! Tells if the connection is successfull.
int ok;
//! Headers as a mapping. All header names are in lower case,
//! for convinience.
//!
mapping headers;
//! Protocol string, ie @expr{"HTTP/1.0"@}.
string protocol;
//! Status number and description (eg @expr{200@} and @expr{"ok"@}).
int status;
string status_desc;
int data_timeout = 120; // seconds
int timeout = 120; // seconds
// internal
#if constant(SSL.Cipher)
import SSL.Constants;
#endif
int(0..1) https = 0;
//! Connected host and port.
//!
//! Used to detect whether keep-alive can be used.
string host;
string real_host; // the hostname passed during the call to *_request()
int port;
object con;
string request;
protected string send_buffer;
string buf="",headerbuf="";
int datapos, discarded_bytes, cpos;
#if constant(thread_create)
object conthread;
#endif
local function request_ok,request_fail;
array extra_args;
void init_async_timeout()
{
call_out(async_timeout, timeout);
}
void remove_async_timeout()
{
remove_call_out(async_timeout);
}
/****** internal stuff *********************************************/
protected int ponder_answer( int|void start_position )
{
// read until we have all headers
int i = start_position, j = 0;
for(;;)
{
string s;
if (i<0) i=0;
j=search(buf, "\r\n\r\n", i);
i=search(buf, "\n\n", i);
if (`!=(-1, i, j)) {
if (i*j >= 0) i = min(i, j);
else if (i == -1) i = j;
break;
}
s=con->read(8192,1);
DBG("-> %O\n",s);
if (!s) {
errno = con->errno();
DBG ("<- (read error: %s)\n", strerror (errno));
return 0;
}
if (s=="") {
if (sizeof (buf) <= start_position) {
// Fake a connection reset by peer errno.
#if constant(System.ECONNRESET)
errno = System.ECONNRESET;
#else
errno = 104;
#endif
DBG ("<- (premature EOF)\n");
return -1;
}
i=strlen(buf);
break;
}
i=sizeof(buf)-3;
buf+=s;
}
headerbuf = buf[start_position..i-1]-"\n";
if (buf[i..i+1]=="\n\n") datapos=i+2;
else datapos=i+4;
DBG("** %d bytes of header; %d bytes left in buffer (pos=%d)\n",
sizeof(headerbuf),sizeof(buf)-datapos,datapos);
// split headers
headers=([]);
sscanf(headerbuf,"%s%*[ ]%d%*[ ]%s%*[\r]",protocol,status,status_desc);
foreach ((headerbuf/"\r")[1..],string s)
{
string n,d;
sscanf(s,"%[!-9;-~]%*[ \t]:%*[ \t]%s",n,d);
switch(n=lower_case(n))
{
case "set-cookie":
headers[n]=(headers[n]||({}))+({d});
break;
case "accept-ranges":
case "age":
case "connection":
case "content-type":
case "content-encoding":
case "date":
case "etag":
case "keep-alive":
case "last-modified":
case "location":
case "retry-after":
case "transfer-encoding":
headers[n]=d;
break;
case "allow":
case "cache-control":
case "vary":
if( headers[n] )
headers[n] += ", " +d;
else
headers[n] = d;
break;
default:
if( headers[n] )
headers[n] += "; " +d;
else
headers[n] = d;
break;
}
}
// done
ok=1;
remove_async_timeout();
if (con && con->set_timeout) {
// SSL connection.
con->set_timeout(data_timeout && (float)data_timeout);
}
if (request_ok) request_ok(this,@extra_args);
return 1;
}
protected void close_connection(int|void terminate_now)
{
object(Stdio.File)|SSL.File con = this::con;
if (!con) return;
this::con = 0;
con->set_callbacks(0, 0, 0, 0, 0); // Clear any remaining callbacks.
if (terminate_now) {
// We don't want to wait for the close() to complete...
con->set_nonblocking();
con->close();
if (!con->shutdown) return;
// Probably SSL.
//
// Force the connection to shutdown.
con = con->shutdown();
if (!con) return;
}
con->close();
}
#if constant(SSL.Cipher)
SSL.Context context;
SSL.Session ssl_session;
#endif
void start_tls(int|void blocking, int|void async)
{
DBG("start_tls(%d,%d)\n", blocking, async);
#if constant(SSL.Cipher)
if( !context )
{
context = SSL.Context();
}
object read_callback=con->query_read_callback();
object write_callback=con->query_write_callback();
object close_callback=con->query_close_callback();
SSL.File ssl = SSL.File(con, context);
if (blocking) {
ssl->set_blocking();
}
ssl->set_timeout(timeout && (float)timeout);
if (!(ssl_session = ssl->connect(real_host, ssl_session))) {
error("HTTPS connection failed.\n");
}
con=ssl;
if(!blocking) {
if (async) {
ssl->set_nonblocking(0,async_connected,async_failed);
} else {
ssl->set_read_callback(read_callback);
ssl->set_write_callback(write_callback);
ssl->set_close_callback(close_callback);
}
}
#else
error ("HTTPS not supported (Nettle support is required).\n");
#endif
}
protected void connect(string server,int port,int blocking)
{
DBG("<- (connect %O:%d)\n",server,port);
int count;
while(1) {
int success;
if(con->_fd)
success = con->connect(server, port);
else
// What is this supposed to do? /mast
// SSL.File?
success = con->connect(server, port, blocking);
if (success) {
if (count) DBG("<- (connect success)\n");
break;
}
errno = con->errno();
DBG("<- (connect error: %s)\n", strerror (errno));
count++;
if ((count > 10) || (errno != System.EADDRINUSE)) {
DBG("<- (connect fail)\n");
close_connection();
ok = 0;
return;
}
// EADDRINUSE: All tuples hostip:hport:serverip:sport are busy.
// Wait for a bit to allow the OS to recycle some ports.
sleep(0.1);
if (con->_fd) {
// Normal file. Close and reopen.
// NB: This seems to be needed on Solaris 11 as otherwise
// the connect() above instead will fail with ETIMEDOUT.
close_connection();
con = Stdio.File();
con->open_socket(-1, 0, server);
}
}
DBG("<- %O\n",request);
if(https) {
start_tls(blocking);
}
if (con->write(request) != sizeof (request)) {
errno = con->errno();
DBG ("-> (write error: %s)\n", strerror (errno));
}
else
ponder_answer();
}
protected void async_close()
{
con->set_blocking();
int res = ponder_answer();
if (res == -1) {
async_reconnect();
} else if (!res) {
async_failed();
}
}
protected void async_read(mixed dummy,string s)
{
DBG("-> %d bytes of data\n",sizeof(s));
buf+=s;
if (has_value(buf, "\r\n\r\n") || has_value(buf,"\n\n"))
{
con->set_blocking();
if (ponder_answer() == -1)
async_reconnect();
}
}
protected void async_reconnect()
{
close_connection();
dns_lookup_async(host, async_got_host, port);
}
protected void async_write()
{
DBG("<- %O\n", send_buffer);
int bytes;
if ((bytes = con->write(send_buffer)) < sizeof(send_buffer)) {
if (bytes < 0) {
errno = con->errno();
DBG ("-> (write error: %s)\n", strerror (errno));
} else {
// Note that "bytes" can be 0 here.
send_buffer = send_buffer[bytes..];
if (sizeof (send_buffer))
return;
// send_buffer is empty at this point. We'll clear the write
// callback below.
}
}
con->set_nonblocking(async_read,0,async_close);
}
protected void async_connected()
{
con->set_nonblocking(async_read,async_write,async_close);
DBG("<- %O\n","");
con->write("");
}
protected void low_async_failed(int errno)
{
DBG("** calling failed cb %O\n", request_fail);
if (errno)
this::errno = errno;
ok=0;
remove_async_timeout();
if (request_fail) request_fail(this, @extra_args);
}
protected void async_failed()
{
DBG("** Async connection failure.\n");
if (!status) {
status = 502; // HTTP_BAD_GW
status_desc = "Bad Gateway";
}
#if constant(System.EHOSTUNREACH)
low_async_failed(con?con->errno():System.EHOSTUNREACH);
#else
low_async_failed(con?con->errno():113); // EHOSTUNREACH/Linux-i386
#endif
}
protected void async_timeout()
{
DBG("** TIMEOUT\n");
if (!status) {
status = 504; // HTTP_GW_TIMEOUT
status_desc = "Gateway timeout";
}
close_connection();
#if constant(System.ETIMEDOUT)
low_async_failed(System.ETIMEDOUT);
#else
low_async_failed(110); // ETIMEDOUT/Linux-i386
#endif
}
void async_got_host(string server,int port)
{
DBG("async_got_host %s:%d\n", server, port);
if (!server)
{
async_failed();
if (this_object()) {
// we may be destructed here
close_connection();
}
return;
}
con = Stdio.File();
if( !con->async_connect(server, port,
lambda(int success)
{
if (success) {
// Connect ok.
if(https) {
start_tls(0, 1);
}
else
async_connected();
} else {
// Connect failed.
if (!con->is_open())
// Other code assumes an existing con is
// an open one.
con = 0;
async_failed();
}
}))
{
DBG("Failed to open socket: %s.\n", strerror(con->errno()));
async_failed();
}
// NOTE: In case of failure the timeout is already in place.
}
void async_fetch_read(mixed dummy,string data)
{
DBG("-> %d bytes of data\n",sizeof(data));
buf+=data;
if (has_index(headers, "content-length") &&
sizeof(buf)-datapos>=(int)headers["content-length"])
{
remove_async_timeout(); // Bug 4773
con->set_nonblocking(0,0,0);
request_ok(this_object(), @extra_args);
}
}
// This function is "liberal in what it receives" because it has no
// real way to inform the user of errors in the chunked encoding sent
// by the server. Except for calling the callback and have ->data() be
// the messenger...
void async_fetch_read_chunked(mixed dummy, string data) {
int np = -1, f;
buf+=data;
OUTER: while (sizeof(buf) > cpos) {
do {
// in here:
// break calls the callback
// return waits for more input
// continue OUTER tries to parse one more chunk from buffer
if ((f = search(buf, "\r\n", cpos)) != -1) {
if (sscanf(buf[cpos..f], "%x", np)) {
if (np) cpos = f+np+4;
else {
if (sscanf(buf[cpos..f+3], "%*x%*[^\r\n]%s", data)
== 3 && sizeof(data) == 4) break;
return;
}
continue OUTER;
}
break;
}
return;
} while(0);
remove_async_timeout();
con->set_nonblocking(0,0,0);
request_ok(this, @extra_args);
break;
}
}
void async_fetch_close()
{
DBG("-> close\n");
close_connection();
remove_async_timeout();
if (errno) {
if (request_fail) (request_fail)(this_object(), @extra_args);
} else {
if (request_ok) (request_ok)(this_object(), @extra_args);
}
}
/****** utilities **************************************************/
string headers_encode(mapping(string:array(string)|string) h)
{
constant rfc_headers = ({ "accept-charset", "accept-encoding", "accept-language",
"accept-ranges", "cache-control", "content-length",
"content-type", "if-match", "if-modified-since",
"if-none-match", "if-range", "if-unmodified-since",
"max-forwards", "proxy-authorization", "transfer-encoding",
"user-agent", "www-autenticate" });
constant replace_headers = mkmapping(replace(rfc_headers[*],"-","_"),rfc_headers);
if (!h || !sizeof(h)) return "";
String.Buffer buf = String.Buffer();
foreach(h; string name; array(string)|string value)
{
if( replace_headers[name] )
name = replace_headers[name];
if(stringp(value))
buf->add( String.capitalize(name), ": ",
value, "\r\n" );
else if(!value)
continue;
else if (intp(value))
buf->add( String.capitalize(name), ": ",
(string)value, "\r\n" );
else if (arrayp(value)) {
foreach(value, string value)
buf->add( String.capitalize(name), ": ",
value, "\r\n" );
} else {
error("Protocols.HTTP.Query()->headers_encode(): Bad header: %O:%O.\n",
name, value);
}
}
return (string)buf;
}
/****** helper methods *********************************************/
//! Set this to a global mapping if you want to use a cache,
//! prior of calling *request().
//!
mapping hostname_cache=([]);
#ifndef PROTOCOLS_HTTP_DNS_OBJECT_TIMEOUT
#define PROTOCOLS_HTTP_DNS_OBJECT_TIMEOUT 60
#endif
void dns_lookup_callback(string name,string ip,function callback,
mixed ...extra)
{
DBG("dns_lookup_callback %s = %s\n", name, ip||"NULL");
hostname_cache[name]=ip;
if (functionp(callback))
callback(ip,@extra);
}
void dns_lookup_async(string hostname,function callback,mixed ...extra)
{
string id;
if (!hostname || hostname=="")
{
call_out(callback,0,0,@extra); // can't lookup that...
return;
}
if (has_value(hostname, ":")) {
// IPv6
sscanf(hostname, "%[0-9a-fA-F:.]", id);
} else {
sscanf(hostname,"%[0-9.]",id);
}
if (hostname==id ||
(id=hostname_cache[hostname]))
{
call_out(callback,0,id,@extra);
return;
}
Protocols.DNS.async_host_to_ip(hostname, dns_lookup_callback, callback, @extra);
}
string dns_lookup(string hostname)
{
string id;
if (has_value(hostname, ":")) {
// IPv6
sscanf(hostname, "%[0-9a-fA-F:.]", id);
} else {
sscanf(hostname,"%[0-9.]",id);
}
if (hostname==id ||
(id=hostname_cache[hostname]))
return id;
array hosts = Protocols.DNS.client()->gethostbyname( hostname );
if (array ip = hosts && hosts[1])
if (sizeof(ip)) {
// Prefer IPv4 addresses
array(string) v6 = filter(ip, has_value, ":");
array(string) v4 = ip - v6;
if (sizeof(v4))
return v4[random(sizeof(v4))];
return sizeof(v6) && v6[random(sizeof(v6))];
}
return 0;
}
/****** called methods *********************************************/
//! @decl Protocols.HTTP.Query set_callbacks(function request_ok, @
//! function request_fail, @
//! mixed ... extra)
//! @decl Protocols.HTTP.Query async_request(string server, int port, @
//! string query)
//! @decl Protocols.HTTP.Query async_request(string server, int port, @
//! string query, mapping headers, @
//! string|void data)
//!
//! Setup and run an asynchronous request,
//! otherwise similar to @[thread_request()].
//!
//! @[request_ok](Protocols.HTTP.Query httpquery,...extra args)
//! will be called when connection is complete,
//! and headers are parsed.
//!
//! @[request_fail](Protocols.HTTP.Query httpquery,...extra args)
//! is called if the connection fails.
//!
//! @returns
//! Returns the called object
this_program set_callbacks(function(object,mixed...:mixed) _ok,
function(object,mixed...:mixed) _fail,
mixed ...extra)
{
extra_args=extra;
request_ok=_ok;
request_fail=_fail;
return this;
}
#if constant(thread_create)
//! @decl Protocols.HTTP.Query thread_request(string server, int port, @
//! string query)
//! @decl Protocols.HTTP.Query thread_request(string server, int port, @
//! string query, mapping headers, @
//! void|string data)
//!
//! Create a new query object and begin the query.
//!
//! The query is executed in a background thread;
//! call @[`()] in the object to wait for the request
//! to complete.
//!
//! @[query] is the first line sent to the HTTP server;
//! for instance @expr{"GET /index.html HTTP/1.1"@}.
//!
//! @[headers] will be encoded and sent after the first line,
//! and @[data] will be sent after the headers.
//!
//! @returns
//! Returns the called object.
this_program thread_request(string server, int port, string query,
void|mapping|string headers, void|string data)
{
// start open the connection
string server1=dns_lookup(server);
if (server1) server=server1; // cheaty, if host doesn't exist
con = 0;
Stdio.File new_con = Stdio.File();
if (!new_con->open_socket(-1, 0, server)) {
int errno = con->errno();
new_con = 0;
error("HTTP.Query(): can't open socket; "+strerror(errno)+"\n");
}
con = new_con;
// prepare the request
errno = ok = protocol = this::headers = status_desc = status =
discarded_bytes = datapos = 0;
buf = "";
headerbuf = "";
if (!data) data="";
if (!headers) headers="";
else if (mappingp(headers))
{
headers=mkmapping(Array.map(indices(headers),lower_case),
values(headers));
if (data) headers["content-length"]=(string)sizeof(data);
headers=headers_encode(headers);
}
request=query+"\r\n"+headers+"\r\n"+data;
conthread=thread_create(connect,server,port,1);
return this;
}
#endif
this_program sync_request(string server, int port, string query,
void|mapping|string http_headers,
void|string data)
{
int kept_alive;
this::real_host = server;
// start open the connection
if(con && con->is_open() &&
this::host == server &&
this::port == port &&
headers && headers->connection &&
lower_case( headers->connection ) != "close")
{
DBG("** Connection kept alive!\n");
kept_alive = 1;
// Remove unread data from the connection.
this::data();
}
else
{
DBG("** Starting new connection to %O:%d.\n"
" con: %O (%d)\n"
" Previously connected to %O:%d\n",
server, port, con, con && con->is_open(),
this::host, this::port);
close_connection(); // Close any old connection.
this::host = server;
this::port = port;
string ip = dns_lookup( server );
if(ip) server = ip; // cheaty, if host doesn't exist
con = 0;
Stdio.File new_con = Stdio.File();
if(!new_con->open_socket(-1, 0, server)) {
int errno = con->errno();
new_con = 0;
error("HTTP.Query(): can't open socket; "+strerror(errno)+"\n");
}
con = new_con;
}
// prepare the request
errno = ok = protocol = headers = status_desc = status =
datapos = discarded_bytes = 0;
buf = "";
headerbuf = "";
if(!stringp( http_headers )) {
if(mappingp( http_headers ))
http_headers = mkmapping(map(indices( http_headers ), lower_case),
values( http_headers ));
else
http_headers = ([]);
if(data) {
if(String.width(data)>8) {
if(!http_headers["content-type"])
error("Wide string as data and no content-type header set.\n");
array split = http_headers["content-type"]/"charset=";
if(sizeof(split)==1)
http_headers["content-type"] += "; charset=utf-8";
else {
string tail = split[1];
sscanf(tail, "%s ", tail);
http_headers["content-type"] = split[0] + "utf-8" + tail;
}
data = string_to_utf8(data);
}
http_headers["content-length"] = (string)sizeof( data );
}
http_headers = headers_encode( http_headers );
}
request = query + "\r\n" + http_headers + "\r\n" + (data||"");
if(kept_alive)
{
DBG("<- %O\n",request);
if (con->write( request ) != sizeof (request)) {
errno = con->errno;
DBG ("-> (write error: %s)\n", strerror (errno));
}
else
if (ponder_answer() == -1) {
// The keepalive connection was closed from the server end.
// Retry with a new one.
// FIXME: Proxy handling?
close_connection();
return sync_request (server, port, query, http_headers, data);
}
} else
connect(server, port,1);
return this;
}
this_program async_request(string server,int port,string query,
void|mapping|string headers,void|string data)
{
DBG("async_request %s:%d %q\n", server, port, query);
this::real_host = server;
if (con) con->set_nonblocking_keep_callbacks();
int keep_alive = con && con->is_open() && (this::host == server) &&
(this::port == port) && this::headers &&
(lower_case(this::headers->connection||"close") != "close");
// start open the connection
init_async_timeout();
// prepare the request
if (!headers) headers="";
else if (mappingp(headers))
{
headers=mkmapping(map(indices(headers),lower_case),
values(headers));
if (data) headers["content-length"]=(string)sizeof(data);
headers=headers_encode(headers);
}
send_buffer = request = query+"\r\n"+headers+"\r\n"+(data||"");
errno = ok = protocol = this::headers = status_desc = status =
discarded_bytes = datapos = 0;
buf = "";
headerbuf = "";
if (!keep_alive) {
close_connection();
this::host = server;
this::port = port;
dns_lookup_async(server,async_got_host,port);
}
else
{
async_connected();
}
return this;
}
#if constant(thread_create)
//! Wait for connection to complete.
//! @returns
//! Returns @expr{1@} on successfull connection, @expr{0@} on failure.
//!
int `()()
{
// wait for completion
if (conthread) conthread->wait();
return ok;
}
#endif
//! Gives back the data as a string.
string data(int|void max_length)
{
#if constant(thread_create)
`()();
#endif
if (buf=="") return ""; // already emptied
if (is_empty_response()) return "";
mixed timeout_co;
#if constant(thread_create) && constant(Stdio.__HAVE_CONCURRENT_CLOSE__)
if (data_timeout && (Thread.this_thread() != master()->backend_thread())) {
DBG("data timeout: %O\n", data_timeout);
timeout_co = call_out(async_timeout, data_timeout);
}
#endif
if (headers["transfer-encoding"] &&
lower_case(headers["transfer-encoding"])=="chunked")
{
string rbuf=buf[datapos..];
string lbuf="";
for (;;)
{
int len;
string s;
DBG("got %d; chunk: %O left: %d\n",strlen(lbuf),rbuf[..40],strlen(rbuf));
if (sscanf(rbuf,"%x%*[^\r\n]\r\n%s",len,s)==3)
{
if (len==0)
{
for (;;)
{
int i;
if ((i=search(rbuf,"\r\n\r\n"))==-1)
{
DBG ("<- data() read\n");
s=con->read(8192,1);
if (!s || !sizeof(s)) {
if (timeout_co) {
DBG("remove timeout.\n");
remove_call_out(timeout_co);
}
if (!s) {
errno = con->errno();
DBG ("<- (read error: %s)\n", strerror (errno));
return 0;
}
return lbuf;
}
rbuf+=s;
buf+=s;
}
else
{
// entity_headers=rbuf[..i-1];
if (timeout_co) {
DBG("remove timeout.\n");
remove_call_out(timeout_co);
}
return lbuf;
}
}
}
else
{
if (strlen(s)<len)
{
DBG ("<- data() read 2\n");
string t=con->read(len-strlen(s)+6); // + crlfx3
if (!t || !sizeof(t)) {
if (timeout_co) {
DBG("remove timeout.\n");
remove_call_out(timeout_co);
}
if (!t) {
errno = con->errno();
DBG ("<- (read error: %s)\n", strerror (errno));
return 0;
}
return lbuf+s;
}
buf+=t;
lbuf+=s+t[..len-strlen(s)-1];
rbuf=t[len-strlen(s)+2..];
}
else
{
lbuf+=s[..len-1];
rbuf=s[len+2..];
}
}
}
else
{
DBG ("<- data() read 3\n");
s=con->read(8192,1);
if (!s || !sizeof(s)) {
if (timeout_co) {
DBG("remove timeout.\n");
remove_call_out(timeout_co);
}
if (!s) {
errno = con->errno();
DBG ("<- (read error: %s)\n", strerror (errno));
return 0;
}
return lbuf;
}
buf+=s;
rbuf+=s;
}
}
}
int len=(int)headers["content-length"];
int l;
// test if len is zero to get around zero_type bug (??!?) /Mirar
if(!len && undefinedp( len ))
l=0x7fffffff;
else {
len -= discarded_bytes;
l=len-sizeof(buf)+datapos;
}
if(!undefinedp(max_length) && l>max_length-sizeof(buf)+datapos)
l = max_length-sizeof(buf)+datapos;
DBG("fetch data: %d bytes needed, got %d, %d left\n",
len,sizeof(buf)-datapos,l);
if(l>0 && con)
{
if(headers->server == "WebSTAR")
{ // Some servers reporting this name exhibit some really hideous behaviour:
DBG ("<- data() read 4\n");
string s = con->read();
if (timeout_co) {
DBG("remove timeout.\n");
remove_call_out(timeout_co);
}
if (!s) {
errno = con->errno();
DBG ("<- (read error: %s)\n", strerror (errno));
return 0;
}
buf += s; // First, they may well lie about the content-length
if(!discarded_bytes && buf[datapos..datapos+1] == "\r\n")
datapos += 2; // And, as if that wasn't enough! *mumble*
}
else
{
DBG ("<- data() read 5\n");
while ((l > 0) && con) {
string s = con->read(l);
if (!s || !sizeof(s)) {
// Error or EOF.
if (!s && (strlen(buf) <= datapos)) {
// Error and we have not received any data yet.
if (timeout_co) {
DBG("remove timeout.\n");
remove_call_out(timeout_co);
}
errno = con->errno();
DBG ("<- (read error: %s)\n", strerror (errno));
return 0;
}
break;
}
buf += s;
l -= sizeof(s);
}
}
}
if (timeout_co) {
DBG("remove timeout.\n");
remove_call_out(timeout_co);
}
if(undefinedp( len ))
len = sizeof( buf ) - datapos;
if(!undefinedp(max_length) && len>max_length)
len = max_length;
return buf[datapos..datapos+len-1];
}
protected Charset.Decoder charset_decoder;
//! Gives back data, but decoded according to the content-type
//! character set.
//! @seealso
//! @[data]
string unicode_data() {
if(!charset_decoder) {
string charset;
if(headers["content-type"])
sscanf(headers["content-type"], "%*scharset=%s", charset);
if(!charset)
charset_decoder = Charset.decoder("ascii");
else
charset_decoder = Charset.decoder(charset);
}
return charset_decoder->feed(data())->drain();
}
void discard_bytes(int n)
{
if(n > sizeof(buf) - datapos)
error("HTTP.Query: discarding more bytes than read\n");
if(n > 0) {
discarded_bytes += n;
buf = buf[..datapos-1]+buf[datapos+n..];
}
}
string incr_data(int max_length)
{
string ret = data(max_length);
discard_bytes(sizeof(ret));
return ret;
}
//! Gives back the number of downloaded bytes.
int downloaded_bytes()
{
if(datapos)
return sizeof(buf)-datapos+discarded_bytes;
else
return 0;
}
//! Gives back the size of a file if a content-length header is present
//! and parsed at the time of evaluation. Otherwise returns -1.
int total_bytes()
{
if(!headers)
return -1;
int len=(int)headers["content-length"];
if(undefinedp(len))
return -1;
else
return len;
}
//! @decl array cast("array")
//! @returns
//! @array
//! @elem mapping 0
//! Headers
//! @elem string 1
//! Data
//! @elem string 2
//! Protocol
//! @elem int 3
//! Status
//! @elem string 4
//! Status description
//! @endarray
//! @decl mapping cast("mapping")
//! @returns
//! The header mapping ORed with the following mapping.
//! @mapping
//! @member string "protocol"
//! The protocol.
//! @member int "status"
//! The status code.
//! @member string "status_desc"
//! The status description.
//! @member string "data"
//! The returned data.
//! @endmapping
//! @decl string cast("string")
//! Gives back the answer as a string.
protected array|mapping|string cast(string to)
{
switch (to)
{
case "mapping":
return headers|
(["data":data(),
"protocol":protocol,
"status":status,
"status_desc":status_desc]);
case "array":
return ({headers,data(),protocol,status,status_desc});
case "string":
data();
return buf;
}
return UNDEFINED;
}
//! Minimal simulation of a @[Stdio.File] object.
//!
//! Objects of this class are returned by @[file()] and @[datafile()].
//!
//! @note
//! Do not attempt further queries using this @[Query] object
//! before having read all data.
class PseudoFile
{
Stdio.Buffer buf;
int len;
protected void create(string _buf, int _len)
{
buf=Stdio.Buffer(_buf);
len=_len;
}
//!
string read(int n, int(0..1)|void not_all)
{
if (!len) return "";
if (n > len) n = len;
if (sizeof(buf)<n && con)
buf->input_from( con, n-sizeof(buf), not_all);
string s = buf->read(min(n,sizeof(buf)));
if (len != 0x7fffffff)
len -= strlen(s);
return s;
}
//!
void close()
{
destruct();
}
}
//! @decl Protocols.HTTP.Query.PseudoFile file()
//! @decl Protocols.HTTP.Query.PseudoFile file(mapping newheaders, @
//! void|mapping removeheaders)
//! Gives back a pseudo-file object,
//! with the methods @expr{read()@} and @expr{close()@}.
//! This could be used to copy the file to disc at
//! a proper tempo.
//!
//! @[newheaders], @[removeheaders] is applied as:
//! @expr{(oldheaders|newheaders))-removeheaders@}
//! Make sure all new and remove-header indices are lower case.
//!
//! @seealso
//! @[datafile()]
object file(void|mapping newheader,void|mapping removeheader)
{
#if constant(thread_create)
`()();
#endif
mapping h=headers;
int len;
if (newheader||removeheader)
{
h=(h|(newheader||([])))-(removeheader||([]));
string hbuf=headers_encode(h);
if (hbuf=="") hbuf="\r\n";
hbuf = protocol + " " + status + " " + status_desc + "\r\n" +
hbuf + "\r\n";
if (has_index(headers, "content-length"))
len = sizeof(hbuf)+(int)headers["content-length"];
else
len=0x7fffffff;
return PseudoFile(hbuf + buf[datapos..],len);
}
if (has_index(headers, "content-length"))
len=sizeof(headerbuf)+4+(int)h["content-length"];
else
len=0x7fffffff;
return PseudoFile(headerbuf + "\r\n\r\n" + buf[datapos..], len);
}
//! @decl Protocols.HTTP.Query.PseudoFile datafile();
//! Gives back a pseudo-file object,
//! with the methods @expr{read()@} and @expr{close()@}.
//! This could be used to copy the file to disc at
//! a proper tempo.
//!
//! @[datafile()] doesn't give the complete request,
//! just the data.
//!
//! @seealso
//! @[file()]
object datafile()
{
#if constant(thread_create)
`()();
#endif
return PseudoFile(buf[datapos..], (int)(headers["content-length"]||0x7ffffff));
}
protected void destroy()
{
catch(close_connection(1));
}
//! Close all associated file descriptors.
//!
void close()
{
close_connection();
}
private int(0..1) is_empty_response()
{
return (status >= 100 && status < 200) ||
(status == 204) || (status == 304) ||
(request && (upper_case(request[..4]) == "HEAD "));
}
private int(0..1) body_is_fetched()
{
// There is no body in these requests
// and the content-length header must be ignored
if (is_empty_response() || !con) {
return 1;
}
// the length is given by chunked encoding if the following is true
// see section 4.4 of rfc 2616
int(0..1) ignore_length =
!(headers->connection == "close" || (protocol == "HTTP/1.0" && !headers->connection)) &&
headers["transfer-encoding"] && headers["transfer-encoding"] != "identity";
if (!ignore_length && has_index(headers, "content-length")) {
if (sizeof(buf)-datapos >= (int)headers["content-length"]) {
return 1;
}
}
return 0;
}
//! Fetch all data in background.
//!
//! @seealso
//! @[timed_async_fetch()], @[async_request()], @[set_callbacks()]
void async_fetch(function callback,mixed ... extra)
{
if (body_is_fetched()) {
call_out(callback, 0, this, @extra);
return;
}
extra_args=extra;
request_ok=callback;
cpos = datapos;
if (lower_case(headers["transfer-encoding"]) != "chunked")
con->set_nonblocking(async_fetch_read,0,async_fetch_close);
else {
con->set_nonblocking(async_fetch_read_chunked,0,async_fetch_close);
async_fetch_read_chunked(0, ""); // might already be complete
// in buffer
}
}
//! Like @[async_fetch()], except with a timeout and a corresponding fail
//! callback function.
//!
//! @seealso
//! @[async_fetch()], @[async_request()], @[set_callbacks()]
void timed_async_fetch(function(object, mixed ...:void) ok_callback,
function(object, mixed ...:void) fail_callback,
mixed ... extra) {
if (body_is_fetched()) {
call_out(ok_callback, 0, this, @extra);
return;
}
extra_args = extra;
request_ok = ok_callback;
request_fail = fail_callback;
cpos = datapos;
// NB: Different timeout than init_async_timeout().
call_out(async_timeout, data_timeout);
// NB: The timeout is currently not reset on each read, so the whole
// response has to be read within data_timeout seconds. Is that
// intentional? /mast
con->set_nonblocking(async_fetch_read,0, async_fetch_close);
}
protected string _sprintf(int t)
{
return t=='O' && status && sprintf("%O(%d %s)", this_program,
status, status_desc);
}
|