ns_conn - Find information about the current HTTP connection
This command is used to retrieve various pieces of information about a connection.
The subcommands of ns_conn are (in alphabetical order):
Returns the compression formats accepted by the client.
Returns the authorization header content as an ns_set. For Basic authentication there are reserved keys: Username and Password, these are the keys returned by ns_conn authuser and ns_conn authpassword.
For digest authentication, all the fields provided in the ns_set are returned. For bearer authentication, the base64 encoded token is returned in the ns_set.
This ns_set can be updated.
For other authorization schemes, the Authorization header field can be handled like any other request header field:
set auth_header [ns_set get -nocase [ns_conn headers] Authorization ""]
Returns the decoded user password from the authorization data.
Returns the decoded username from the authorization data.
Returns the Tcl channel name for the current connection.
Query or set the client data for the current connection. The client data is provided by the application and is potentially passed to different threads and can be used to establish the context with the connection thread. For example, the writer thread outputs the client data when listing running connections (e.g. to determine which user initiated the delivery, etc.).
Closes the connection so that the script (or ADP) can do any time-consuming processing without keeping the client waiting. When using ns_conn close in an ADP, streaming should be turned on before the connection is closed (i.e. <SCRIPT RUNAT=SERVER STREAM=ON>) or nothing will ve sent out at all.
Either set or query the compression level for the current connection. Use ns_conn compress 0 to indicate that compression should be deactivated
Returns the content of the HTTP request body, optionally a substring of that content starting at offset and extending length characters. If the option -binary is used, the content is returned raw. Otherwise, a conversion to the encoding of the connection is performed. Note that the client response might be returned as string content (as retrieved by this command) or as file (see ns_conn contentfile ).
Returns name of the temporary file which holds contents of the request. Whether of not a content files is returned depends on the configuration settings.
Returns the number of bytes in the content passed in.
Returns or sets the specified number of bytes in the content to be sent.
Copies number of bytes from the current connection string data to a Tcl channel. The arguments offset and length denote an offset in this string and the length to be copied. If no string data is provided, an exception is raised.
This operation is primarily suited for special operations, since it is only useful, since it gets the raw data of the received content, which is only available, when the received data is not spooled to a file. For general purpose applications, ns_getcontent might be the better choice.
This operation is primarily designed for specialized use cases, as it retrieves the raw data of the received content. However, this raw data is accessible only when the received content is not spooled to a file. For general-purpose applications, using ns_getcontent is likely a more suitable choice.
Returns the local IP address (IPv4 or IPv6) of the current connection (the destination IP address of the current socket).
Returns the local port of the current connection (the destination port of the current socket).
Returns a dict with driver specific details concerning the current connection. For all requests, the dict includes the current IP address, its type, whether it is public and configured to be trusted, and whether the connection comes via a reverse proxy (proxied). For HTTPS connections, the result includes the negotiated protocol sslversion, cipher, and the servername (as provided via SNI).
Returns the name of the module (nssock or nsssl) that is acting as the communications driver for this connection.
Query or set the encoding for the current connection.
Return the ns_set with header information for the uploaded file with the specified name (returned via [ns_conn files]). If the file was uploaded with the HTML5 multiple attribute a list of ns_sets is returned.
Return the length of the uploaded file with the specified name (returned via [ns_conn files]). If the file was uploaded with the HTML5 multiple attribute a list of file lengths is returned.
Return the offset of the uploaded file with the specified name (returned via [ns_conn files]). If the file was uploaded with the HTML5 multiple attribute a list of offsets is returned.
Return files uploaded with the current form.
Return the internal flags of the current connection. Use with care, the flags might change over versions.
Returns any submitted form data as an ns_set. This form data may have been submitted with a POST or appended to the URL in a GET request.
The option -fallbackcharset can be used to specify an alternative character set in cases, the decoding the form-data leads to invalid UTF-8. Instead of raising an exception, a second attempt of decoding the data is made with the fallback charset. Note that the fallback charset can be provided as well via the configuration parameter formfallbackcharset. For more details, see ns_getform.
Note: ns_conn form is not suitable for multipart formdata file upload. Use ns_getform instead.
Returns the length of the header. Together with ns_conn contentlength this can be used to determine the uncompressed request size, (not counting chunked overhead).
Returns all the HTTP request header fields as an ns_set. The keys of the ns_set represent the field names. The case of the returned field names depends on the "HeaderCase" configuration parameter. By default, HeaderCase is "Preserve", which means case is preserved.
Returns the host part of the URL in the HTTP request line. This is only set, when the NaviServer is used as a proxy server.
Returns the unique identifier of the current connection.
Returns 1 if you're in a connection thread, and you are therefore allowed to make calls to ns_conn. It returns 0 if you're not in a connection thread (such as when you're in a schedule procedure) and you are not allowed to make calls to ns_conn.
Query or set the keepalive for the current connection.
Returns the location string for this virtual server in the form: protocol://hostname[:port]. The location is determined via the following means:
if ns_locationproc is configured, its result is returned.
if virtual hosting is enabled, and the "Host:" header field is provided and valid, it returns its content.
If everything above fails, it is determined by virtual hosts mapping table (as defined in the "ns/module/nssock/servers" or "ns/module/nsssl/servers" section in the configuration file).
If everything above fails, and a connection is open, it is determined by the current socket address.
If everything above fails, it is determined by configuration values of the driver.
Returns the HTTP method, e.g. GET.
Returns an ns_set containing the HTTP response header fields, i.e. the fields that will be sent out when a result is returned to the client. This ns_set can be manipulated like any other ns_set. You can also use this command to extend/update/clear to the set of HTTP response header fields.
For example:
ns_set put [ns_conn outputheaders] "Content-Disposition" "attachment;filename=export.xotcl"
Returns the IP address of the client, i.e., the "other side" of the current HTTP connection. An IPv4 address is returned in the form of a string separated with periods (e.g., 155.164.59.75), an IPv6 address is returned in the form of a string separated with colons (e.g., 2001:628:404:74::31). In reverse proxy mode the IP address is determined by the value forwarded by the reverse proxy server (via the x-fowarded-for header field).
The result can be influenced by the -source to return the result as configured by the reverse proxy mode (default), or to return always the direct or forwarded IP address.
Returns the port of the client, i.e., the "other side" of the current HTTP connection.
Returns the current connection pool from the currently connected server.
Return the port as specified in the host header field or the default value for this protocol. When NaviServer is used as a proxy server, it returns the port specified explicitly in the URL of the HTTP request or 0 (backwards portability).
Returns the protocol of the current connection. When NaviServer is used as a proxy server, it contains the URL in the HTTP request line.
Returns the query parameters of the HTTP request (transmitted after question mark via URL).
Returns detailed timing information about the current requests. The result is a dict containing the keys "accepttime" (the time between the accept of a socket and its adding to the queue; not always easy to interpret), "queuetime" (time in the queue), "filtertime" (time spent during running of filters) and "runtime" (time spent so far during the main request).
Query or set rate limit for the current connection. The value is provided in KB/s (kilobytes per second). A value of 0 means unlimited. Default values can be provided per connection pool (parameter ratelimit) or on the driver level (parameter writerratelimit). The limit is only enforced on connections using writer threads.
Returns the HTTP request line as presented by the client, e.g. GET / HTTP/1.1.
Returns the name of the server handling the request.
Returns the socket id (integer fd) of current connection.
Returns the time the connection request started in "sec:usec" (aka ns_time) format.
Query or set the HTTP status code for the current connection.
Returns the URI target from the start line of the request. The result might contain query variables.
Returns absolute time value beyond which conn should not wait on resources, such as condition variables.
Returns the URL of the HTTP request. This is the portion of the request after the hostname, for example [ns_conn url] on returns /index.adp.
Returns the number of elements (delimited by `/') in the URL of the HTTP request.
Query or set the url encoding for the current connection.
Returns a list containing the pieces of the URL delimited by `/'. When idx is provided, return the nth element of the URL vector.
Returns the version of the HTTP request. This is usually 1.0 or 1.1.
Returns 0 or 1 depending on whether or not the client accepts a zip encoded response.
if { [string match /page/* [ns_conn url]] } {
ns_returnnotfound
}