a580e12000-09-27Fredrik Hübinette (Hubbe) #pike __REAL_VERSION__
f4b01a1999-04-09Mirar (Pontus Hagland) 
9e80572004-03-02Martin Stjernholm // 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
88095d2015-09-08Henrik Grubbström (Grubba) constant HTTP_MISDIRECTED_REQ = 421; // RFC 7540 9.1.2: Misdirected Request
9e80572004-03-02Martin Stjernholm 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
0cc1a52012-06-12Henrik Grubbström (Grubba) constant HTTP_LEGALLY_RESTRICTED= 451; // Draft: Unavailable for Legal Reasons
9e80572004-03-02Martin Stjernholm // 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
72e1f82004-03-02Martin Stjernholm constant TCN_VARIANT_NEGOTIATES = 506; // RFC 2295 8.1: Variant Also Negotiates
9e80572004-03-02Martin Stjernholm constant DAV_STORAGE_FULL = 507; // RFC 2518 10.6: Insufficient Storage
da11cf2011-11-05Bill Welliver 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
88095d2015-09-08Henrik Grubbström (Grubba)  421:"421 Misdirected Request",
da11cf2011-11-05Bill Welliver  422:"422 Unprocessable Entity", // WebDAV 423:"423 Locked", // WebDAV 424:"424 Failed Dependency", // WebDAV 425:"425 Unordered Collection", // RFC3648 426:"426 Upgrade Required", // RFC2817
0cc1a52012-06-12Henrik Grubbström (Grubba)  451:"451 Unavailable for Legal Reasons", // draft-tbray-http-legally-restricted-status
da11cf2011-11-05Bill Welliver  // 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 ]);
14ab9a2010-08-31Martin Nilsson //! Makes an HTTP request through a proxy.
8630e82011-04-20Henrik Grubbström (Grubba) //! //! @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()]
14ab9a2010-08-31Martin Nilsson .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) {
fd5f322011-04-27Henrik Grubbström (Grubba)  if (!proxy || (proxy == "")) { return do_method(method, url, query_variables, request_headers, con, data); }
0c808b2011-04-20Henrik Grubbström (Grubba)  // 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);
14ab9a2010-08-31Martin Nilsson 
2b036a2019-09-25Henrik Grubbström (Grubba)  mapping(string:string|array(string)) proxy_headers = ([]);
14ab9a2010-08-31Martin Nilsson  if( user || password ) {
0c808b2011-04-20Henrik Grubbström (Grubba)  proxy_headers["Proxy-Authorization"] = "Basic "
4180e42018-04-12Stefan Gluszek  + MIME.encode_base64((user || "") + ":" + (password || ""), 1);
2b036a2019-09-25Henrik Grubbström (Grubba)  } if (has_value(proxy->host, ":")) { proxy_headers["host"] = "[" + proxy->host + "]:" + proxy->port; } else { proxy_headers["host"] = proxy->host + ":" + proxy->port;
14ab9a2010-08-31Martin Nilsson  }
0c808b2011-04-20Henrik Grubbström (Grubba)  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
be09442017-02-21Henrik Grubbström (Grubba)  url->scheme = proxy->scheme;
0c808b2011-04-20Henrik Grubbström (Grubba)  url->host = proxy->host; url->port = proxy->port; query_variables = url->query = 0; url->path = web_url;
2b036a2019-09-25Henrik Grubbström (Grubba)  if (request_headers) { proxy_headers = request_headers + proxy_headers; }
0c808b2011-04-20Henrik Grubbström (Grubba)  } 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; proxy_headers->connection = "keep-alive"; con = do_method("CONNECT", proxy, 0, proxy_headers); con->data(0);
f75ba42019-08-07Henrik Grubbström (Grubba)  if (con->status >= 300) { // Proxy did not like us or failed to connect to the remote.
0c808b2011-04-20Henrik Grubbström (Grubba)  return con; }
3c2f572011-04-28Henrik Grubbström (Grubba)  con->headers["connection"] = "keep-alive";
0c808b2011-04-20Henrik Grubbström (Grubba)  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);
14ab9a2010-08-31Martin Nilsson }
10b8b12004-03-08Martin Nilsson //! Low level HTTP call method.
f1b2f32004-03-31Martin Nilsson //! //! @param method //! The HTTP method to use, e.g. @expr{"GET"@}. //! @param url //! The URL to perform @[method] on. Should be a complete URL,
3032b42011-03-06Henrik Grubbström (Grubba) //! including protocol, e.g. @expr{"https://pike.lysator.liu.se/"@}.
f1b2f32004-03-31Martin Nilsson //! @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.
9924f42005-08-30Henrik Grubbström (Grubba) //! //! @seealso //! @[do_sync_method()]
f1b2f32004-03-31Martin Nilsson .Query do_method(string method,
b648852001-01-11Johan Schön  string|Standards.URI url,
32f1ba2009-01-29Martin Nilsson  void|mapping(string:int|string|array(string)) query_variables,
f1b2f32004-03-31Martin Nilsson  void|mapping(string:string|array(string)) request_headers,
b648852001-01-11Johan Schön  void|Protocols.HTTP.Query con, void|string data) { if(stringp(url)) url=Standards.URI(url);
30dd0d2004-09-06Martin Nilsson 
6a4fe12005-01-16Martin Nilsson  if( (< "httpu", "httpmu" >)[url->scheme] ) {
9924f42005-08-30Henrik Grubbström (Grubba)  return do_udp_method(method, url, query_variables, request_headers, con, data);
6a4fe12005-01-16Martin Nilsson  } if(!con) con = .Query();
15c1182001-04-18Pär Svensson  if(url->scheme!="http" && url->scheme!="https")
f1b2f32004-03-31Martin Nilsson  error("Can't handle %O or any other protocols than HTTP or HTTPS.\n",
15c1182001-04-18Pär Svensson  url->scheme);
30dd0d2004-09-06Martin Nilsson 
f1b2f32004-03-31Martin Nilsson  con->https = (url->scheme=="https")? 1 : 0;
b648852001-01-11Johan Schön 
85f9042001-01-31Johan Sundström  mapping default_headers = ([
6bbe932003-01-19Martin Nilsson  "user-agent" : "Mozilla/5.0 (compatible; MSIE 6.0; Pike HTTP client)" " Pike/" + __REAL_MAJOR__ + "." + __REAL_MINOR__ + "." + __REAL_BUILD__,
3524712015-05-26Martin Nilsson  "host" : url->host +
14ec7d2003-12-04Mirar (Pontus Hagland)  (url->port!=(url->scheme=="https"?443:80)?":"+url->port:"")]);
78d9e82001-04-02Johan Sundström 
5728e92013-01-25Martin Nilsson  if(url->user || url->password)
85f9042001-01-31Johan Sundström  default_headers->authorization = "Basic " + MIME.encode_base64(url->user + ":" +
4180e42018-04-12Stefan Gluszek  (url->password || ""), 1);
5728e92013-01-25Martin Nilsson  if(!request_headers) request_headers = default_headers; else request_headers = default_headers | mkmapping(lower_case(indices(request_headers)[*]), values(request_headers));
85f9042001-01-31Johan Sundström 
b648852001-01-11Johan Schön  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",
85f9042001-01-31Johan Sundström  request_headers, data);
30dd0d2004-09-06Martin Nilsson 
8312122004-11-30Martin Stjernholm  if (!con->ok) { if (con->errno)
51f1ce2015-09-06Martin Nilsson  error ("I/O error: %s.\n", strerror (con->errno));
8312122004-11-30Martin Stjernholm  return 0; }
b648852001-01-11Johan Schön  return con; }
9eaf1d2008-06-28Martin Nilsson protected .Query do_udp_method(string method, Standards.URI url,
32f1ba2009-01-29Martin Nilsson  void|mapping(string:int|string|array(string)) query_variables,
9924f42005-08-30Henrik Grubbström (Grubba)  void|mapping(string:string|array(string)) request_headers, void|Protocols.HTTP.Query con, void|string data)
6a4fe12005-01-16Martin Nilsson { 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";
9924f42005-08-30Henrik Grubbström (Grubba)  Stdio.UDP udp = Stdio.UDP(); int port = 10000 + random(1000); int i; while(1) {
f5dc042013-09-03Tobias S. Josefowitz  if( !catch( udp->bind(port++, 0, 1) ) ) break;
9924f42005-08-30Henrik Grubbström (Grubba)  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);
6a4fe12005-01-16Martin Nilsson  }
9924f42005-08-30Henrik Grubbström (Grubba)  udp->set_multicast_ttl(4);
6a4fe12005-01-16Martin Nilsson  udp->send(url->host, url->port, msg);
9924f42005-08-30Henrik Grubbström (Grubba)  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,
3032b42011-03-06Henrik Grubbström (Grubba) //! including protocol, e.g. @expr{"https://pike.lysator.liu.se/"@}.
9924f42005-08-30Henrik Grubbström (Grubba) //! @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,
32f1ba2009-01-29Martin Nilsson  void|mapping(string:int|string|array(string)) query_variables,
9924f42005-08-30Henrik Grubbström (Grubba)  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__,
3524712015-05-26Martin Nilsson  "host" : url->host +
9924f42005-08-30Henrik Grubbström (Grubba)  (url->port!=(url->scheme=="https"?443:80)?":"+url->port:"")]);
3b479c2015-02-18Aleksandra Berjak  if(url->user || url->password)
9924f42005-08-30Henrik Grubbström (Grubba)  default_headers->authorization = "Basic " + MIME.encode_base64(url->user + ":" +
4180e42018-04-12Stefan Gluszek  (url->password || ""), 1);
9924f42005-08-30Henrik Grubbström (Grubba)  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="/";
94dfb12005-12-29Henrik Grubbström (Grubba)  con->async_request(url->host, url->port, method+" "+path+(query?("?"+query):"")+" HTTP/1.0", request_headers, data);
6a4fe12005-01-16Martin Nilsson }
0c808b2011-04-20Henrik Grubbström (Grubba) 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) {
1a1e5b2019-08-09Henrik Grubbström (Grubba)  con->set_callbacks(@orig_cb_info);
f75ba42019-08-07Henrik Grubbström (Grubba)  if (con->status >= 300) { // Proxy did not like us or failed to connect to the remote.
1a1e5b2019-08-09Henrik Grubbström (Grubba)  // Return the failure message. if (con->request_ok) { con->request_ok(con, @con->extra_args); }
f75ba42019-08-07Henrik Grubbström (Grubba)  return; }
0c808b2011-04-20Henrik Grubbström (Grubba) 
9666ec2017-02-22Henrik Grubbström (Grubba)  // Install the timeout handler for the interval until // the TLS connection is up. con->init_async_timeout();
201ceb2019-09-20Henrik Grubbström (Grubba)  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);
d472e52011-04-20Henrik Grubbström (Grubba)  con->con->set_nonblocking(0, lambda() {
9666ec2017-02-22Henrik Grubbström (Grubba)  // Remove the timeout handler; it will be // reinstated by do_async_method() below. con->remove_async_timeout();
d472e52011-04-20Henrik Grubbström (Grubba)  do_async_method(method, url, query_variables, request_headers, con, data); }, con->async_failed);
0c808b2011-04-20Henrik Grubbström (Grubba) }
8937f32011-04-20Henrik Grubbström (Grubba) //! 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) {
fd5f322011-04-27Henrik Grubbström (Grubba)  if (!proxy || (proxy == "")) { do_async_method(method, url, query_variables, request_headers, con, data); return; }
8937f32011-04-20Henrik Grubbström (Grubba)  // 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"); }
2b036a2019-09-25Henrik Grubbström (Grubba)  mapping(string:string|array(string)) proxy_headers = ([]);
8937f32011-04-20Henrik Grubbström (Grubba)  if( user || password ) { proxy_headers["Proxy-Authorization"] = "Basic "
4180e42018-04-12Stefan Gluszek  + MIME.encode_base64((user || "") + ":" + (password || ""), 1);
2b036a2019-09-25Henrik Grubbström (Grubba)  } if (has_value(proxy->host, ":")) { proxy_headers["host"] = "[" + proxy->host + "]:" + proxy->port; } else { proxy_headers["host"] = proxy->host + ":" + proxy->port;
8937f32011-04-20Henrik Grubbström (Grubba)  } 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
be09442017-02-21Henrik Grubbström (Grubba)  url->scheme = proxy->scheme;
8937f32011-04-20Henrik Grubbström (Grubba)  url->host = proxy->host; url->port = proxy->port; query_variables = url->query = 0; url->path = web_url;
2b036a2019-09-25Henrik Grubbström (Grubba)  if (request_headers) { proxy_headers = request_headers + proxy_headers; }
0c808b2011-04-20Henrik Grubbström (Grubba)  } 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"; 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,
2b036a2019-09-25Henrik Grubbström (Grubba)  request_headers,
0c808b2011-04-20Henrik Grubbström (Grubba)  data); method = "CONNECT"; url = proxy; data = 0; } else { proxy_headers = request_headers; }
8937f32011-04-20Henrik Grubbström (Grubba)  } else { error("Can't handle proxying of %O.\n", url->scheme); } do_async_method(method, url, query_variables, proxy_headers, con, data); }
f1b2f32004-03-31Martin Nilsson //! 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.
7dc3162001-04-27Henrik Grubbström (Grubba) //!
f1b2f32004-03-31Martin Nilsson .Query get_url(string|Standards.URI url,
32f1ba2009-01-29Martin Nilsson  void|mapping(string:int|string|array(string)) query_variables,
f1b2f32004-03-31Martin Nilsson  void|mapping(string:string|array(string)) request_headers,
fdfa092000-11-26Johan Sundström  void|Protocols.HTTP.Query con)
f4b01a1999-04-09Mirar (Pontus Hagland) {
b648852001-01-11Johan Schön  return do_method("GET", url, query_variables, request_headers, con);
f4b01a1999-04-09Mirar (Pontus Hagland) }
f1b2f32004-03-31Martin Nilsson //! 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.
7dc3162001-04-27Henrik Grubbström (Grubba) //!
f1b2f32004-03-31Martin Nilsson .Query put_url(string|Standards.URI url,
3f3b4e2000-08-04Johan Sundström  void|string file,
32f1ba2009-01-29Martin Nilsson  void|mapping(string:int|string|array(string)) query_variables,
f1b2f32004-03-31Martin Nilsson  void|mapping(string:string|array(string)) request_headers,
fdfa092000-11-26Johan Sundström  void|Protocols.HTTP.Query con)
2ba20a2000-02-24Fredrik Noring {
4ff48d2002-11-08Anders Johansson  return do_method("PUT", url, query_variables, request_headers, con, file);
2ba20a2000-02-24Fredrik Noring }
f1b2f32004-03-31Martin Nilsson //! 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.
7dc3162001-04-27Henrik Grubbström (Grubba) //!
f1b2f32004-03-31Martin Nilsson .Query delete_url(string|Standards.URI url,
32f1ba2009-01-29Martin Nilsson  void|mapping(string:int|string|array(string)) query_variables,
f1b2f32004-03-31Martin Nilsson  void|mapping(string:string|array(string)) request_headers,
fdfa092000-11-26Johan Sundström  void|Protocols.HTTP.Query con)
2ba20a2000-02-24Fredrik Noring {
b648852001-01-11Johan Schön  return do_method("DELETE", url, query_variables, request_headers, con);
2ba20a2000-02-24Fredrik Noring }
f1b2f32004-03-31Martin Nilsson //! 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.
7dc3162001-04-27Henrik Grubbström (Grubba) //!
b648852001-01-11Johan Schön array(string) get_url_nice(string|Standards.URI url,
32f1ba2009-01-29Martin Nilsson  void|mapping(string:int|string|array(string)) query_variables,
f1b2f32004-03-31Martin Nilsson  void|mapping(string:string|array(string)) request_headers,
fdfa092000-11-26Johan Sundström  void|Protocols.HTTP.Query con)
9a46751999-05-29Mirar (Pontus Hagland) {
9eb4872003-11-25Martin Nilsson  .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;
c72a292012-05-17Martin Nilsson  if(c->status==302) url = Standards.URI(c->headers->location, url);
9eb4872003-11-25Martin Nilsson  } while( c->status!=200 ); return ({ c->headers["content-type"], c->data() });
9a46751999-05-29Mirar (Pontus Hagland) }
f1b2f32004-03-31Martin Nilsson //! 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. //!
b648852001-01-11Johan Schön string get_url_data(string|Standards.URI url,
32f1ba2009-01-29Martin Nilsson  void|mapping(string:int|string|array(string)) query_variables,
f1b2f32004-03-31Martin Nilsson  void|mapping(string:string|array(string)) request_headers,
fdfa092000-11-26Johan Sundström  void|Protocols.HTTP.Query con)
9a46751999-05-29Mirar (Pontus Hagland) {
9eb4872003-11-25Martin Nilsson  array(string) z = get_url_nice(url, query_variables, request_headers, con); return z && z[1];
9a46751999-05-29Mirar (Pontus Hagland) }
f1b2f32004-03-31Martin Nilsson //! Similar to @[get_url], except that query variables is sent as a
d175f62010-03-07Stephen R. van den Berg //! 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.
f1b2f32004-03-31Martin Nilsson .Query post_url(string|Standards.URI url,
d175f62010-03-07Stephen R. van den Berg  mapping(string:int|string|array(string))|string query_variables,
f1b2f32004-03-31Martin Nilsson  void|mapping(string:string|array(string)) request_headers,
fdfa092000-11-26Johan Sundström  void|Protocols.HTTP.Query con)
9a46751999-05-29Mirar (Pontus Hagland) {
d175f62010-03-07Stephen R. van den Berg  return do_method("POST", url, 0, stringp(query_variables) ? request_headers : (request_headers||([]))|
b648852001-01-11Johan Schön  (["content-type": "application/x-www-form-urlencoded"]), con,
d175f62010-03-07Stephen R. van den Berg  stringp(query_variables) ? query_variables : http_encode_query(query_variables));
9a46751999-05-29Mirar (Pontus Hagland) }
f1b2f32004-03-31Martin Nilsson //! Similar to @[get_url_nice], except that query variables is sent as //! a POST request instead of a GET request.
b648852001-01-11Johan Schön array(string) post_url_nice(string|Standards.URI url,
d175f62010-03-07Stephen R. van den Berg  mapping(string:int|string|array(string))|string query_variables,
f1b2f32004-03-31Martin Nilsson  void|mapping(string:string|array(string)) request_headers,
fdfa092000-11-26Johan Sundström  void|Protocols.HTTP.Query con)
f4b01a1999-04-09Mirar (Pontus Hagland) {
f1b2f32004-03-31Martin Nilsson  .Query c = post_url(url, query_variables, request_headers, con);
fdfa092000-11-26Johan Sundström  return c && ({ c->headers["content-type"], c->data() });
f4b01a1999-04-09Mirar (Pontus Hagland) }
9a46751999-05-29Mirar (Pontus Hagland) 
f1b2f32004-03-31Martin Nilsson //! Similar to @[get_url_data], except that query variables is sent as //! a POST request instead of a GET request.
b648852001-01-11Johan Schön string post_url_data(string|Standards.URI url,
d175f62010-03-07Stephen R. van den Berg  mapping(string:int|string|array(string))|string query_variables,
f1b2f32004-03-31Martin Nilsson  void|mapping(string:string|array(string)) request_headers,
fdfa092000-11-26Johan Sundström  void|Protocols.HTTP.Query con)
9a46751999-05-29Mirar (Pontus Hagland) {
f1b2f32004-03-31Martin Nilsson  .Query z = post_url(url, query_variables, request_headers, con);
fdfa092000-11-26Johan Sundström  return z && z->data();
9a46751999-05-29Mirar (Pontus Hagland) }
9fc89e2000-04-15Mirar (Pontus Hagland) //! 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:
d0d3ec2001-07-17Martin Nilsson //! @pre{
3524712015-05-26Martin Nilsson //! > Protocols.HTTP.http_encode_query( (["anna":"eva","lilith":"blue"]) );
9fc89e2000-04-15Mirar (Pontus Hagland) //! Result: "lilith=blue&anna=eva"
3524712015-05-26Martin Nilsson //! > Protocols.HTTP.http_encode_query( (["&amp;":"&","'=\"":"\0\0\0\u0434"]) );
956a9d2015-05-06Chris Angelico //! Result: "%27%3D%22=%00%00%00%D0%B4&%26amp%3B=%26"
7dc3162001-04-27Henrik Grubbström (Grubba) //! @}
d905ec2008-07-25Martin Stjernholm string http_encode_query(mapping(string:int|string|array(string)) variables)
9a46751999-05-29Mirar (Pontus Hagland) {
b07dc62015-12-14Per Hedbor  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]); })*"&";
9a46751999-05-29Mirar (Pontus Hagland) }
d905ec2008-07-25Martin Stjernholm 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
0c4ea52015-08-22Martin Nilsson //! @tt{~@} (see @rfc{2396:2.3@}).
d905ec2008-07-25Martin Stjernholm //! //! 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.
9a46751999-05-29Mirar (Pontus Hagland) {
d905ec2008-07-25Martin Stjernholm  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
0c4ea52015-08-22Martin Nilsson //! @rfc{2396:2.3@}).
d905ec2008-07-25Martin Stjernholm //! //! 8-bit chars and wider are encoded using UTF-8 followed by
0c4ea52015-08-22Martin Nilsson //! 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.
d905ec2008-07-25Martin Stjernholm //! //! @seealso //! @[uri_decode], @[uri_encode_invalids], @[iri_encode] { return percent_encode (string_to_utf8 (s));
9a46751999-05-29Mirar (Pontus Hagland) }
d905ec2008-07-25Martin Stjernholm 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
dc93732015-08-22Martin Nilsson //! delimiter chars except those in the URI @tt{reserved@} set
0c4ea52015-08-22Martin Nilsson //! (@rfc{2396:2.2@}).
d905ec2008-07-25Martin Stjernholm //! //! 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
0c4ea52015-08-22Martin Nilsson //! percent-encoding. This follows @rfc{3986:2.5@}, the IRI standard //! (@rfc{3987@}) and appendix B.2 in the HTML 4.01 standard.
d905ec2008-07-25Martin Stjernholm //! //! @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.
abbd402019-07-05Martin Nilsson  s = _Roxen.http_decode_string (s); catch { s = utf8_to_string (s); }; return s;
d905ec2008-07-25Martin Stjernholm } 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,
dc93732015-08-22Martin Nilsson //! see @rfc{3987@}). This means that all chars outside the IRI
d905ec2008-07-25Martin Stjernholm //! @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
0c4ea52015-08-22Martin Nilsson //! @tt{quoted-string@} according to @rfc{2616:2.2@}. The returned //! string does not include the surrounding @tt{"@} chars.
d905ec2008-07-25Martin Stjernholm //! //! @note
dc93732015-08-22Martin Nilsson //! The @tt{quoted-string@} quoting rules in @rfc{2616@} have several
d905ec2008-07-25Martin Stjernholm //! 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
0c4ea52015-08-22Martin Nilsson //! @tt{quoted-string@} according to @rfc{2616:2.2@}. @[s] is assumed //! to not include the surrounding @tt{"@} chars.
d905ec2008-07-25Martin Stjernholm //! //! @seealso //! @[quoted_string_encode] { return map (s / "\\\\", replace, "\\", "") * "\\"; }
233a9e2020-05-24Stephen R. van den Berg  #define ST_KEY 1 #define ST_VALUE 2 #define ST_QUOTEDVALUE 3 #define ST_ESCAPEVALUE 4 array(ADT.OrderedMapping) params_decode (string s) //! Decodes the given string as a parameter-value cascade //! according to e.g. @rfc{7239:4@}. //! //! @note //! This function will decode all conforming inputs, but it will also //! be forgiving when presented with non-conforming inputs. //! //! @seealso //! @[params_encode] { array(mapping(string:string)|ADT.OrderedMapping) totres = ({}); ADT.OrderedMapping mapres = ADT.OrderedMapping(); String.Buffer word = String.Buffer(); int(ST_KEY..ST_ESCAPEVALUE) state = ST_KEY; string key; int i; for (i = 0;; i++) { int c; if (i < sizeof(s)) c = s[i]; else if (i == sizeof(s)) { // Fake a terminating ',' c = ','; // to ensure proper post-processing if (state > ST_VALUE) state = ST_VALUE; // EOL cannot be escaped } else break; if (state >= ST_QUOTEDVALUE) { if (state == ST_ESCAPEVALUE) state = ST_QUOTEDVALUE; else switch (c) { case '"': state = ST_VALUE; continue; case '\\': state = ST_ESCAPEVALUE; continue; } word->putchar(c); } else { switch (c) { case '=': key = word->get(); state = ST_VALUE; continue; case '"': state = ST_QUOTEDVALUE; continue; case ',': case ';': if (state == ST_KEY) { if (!sizeof(word)) break; key = word->get(); } mapres[key] = state >= ST_VALUE && word->get(); state = ST_KEY; break; default: word->putchar(c); case ' ': case '\t': case '\n': case '\r': case '\f': case '\v': continue; } if (c == ',' && sizeof(mapres)) // Skip empty sets totres += ({ mapres }), mapres = ADT.OrderedMapping(); } } return totres; } Regexp toescape = Regexp("[;,\" \t\n\r\f\v]"); string params_encode (array(mapping(string:string)|ADT.OrderedMapping) params) //! Encodes the given parameters as a string //! according to e.g. @rfc{7239:4@}. //! //! @seealso //! @[params_decode] { String.Buffer res = String.Buffer(); string sep = ""; foreach (params; ; mapping(string:string)|ADT.OrderedMapping m) { foreach (m; string key; string value) { res->add(sep, key); if (value) res->add("=", toescape->match(value) ? "\"" + quoted_string_encode(value) + "\"" : value); sep = ";"; } sep = ","; } return res->get(); }