class type cgi_environment =object..end
The environment of a request consists of the information available besides the data sent by the user (as key-value pairs).
The following properties are standardised by CGI. The methods
return "" (or None in the case of the port number) when the
property is not available.
method cgi_gateway_interface : string
method cgi_server_name : string
method cgi_server_port : int option
method cgi_server_protocol : string
method cgi_server_software : string
method cgi_request_method : stringWe recommend you to use the method Netcgi.cgi.request_method
which is more type-safe and informative.
method cgi_script_name : string
method cgi_path_info : string
method cgi_path_translated : string
method cgi_auth_type : string
method cgi_remote_addr : string
method cgi_remote_host : string
method cgi_remote_user : string
method cgi_remote_ident : string
method cgi_query_string : stringThis is the row query string. The Netcgi.cgi class gives
you an easy access to the arguments through the #arg...
methods.
method protocol : Nethttp.protocolThe server protocol in a decoded form. It can be either
`Http((major,minor),attributes) or`Other.method cgi_property : ?default:string -> string -> stringReturns a (possibly non-standard) CGI environment property.
If the property is not set, Not_found is be raised unless
the default argument is passed. The default argument
determines the result of the function in this case.
The method takes the case-sensitive name and returns the value of the property. Usually, these properties have uppercase names.
For example, cgi_gateway_interface returns the same as
cgi_property ~default:"" "GATEWAY_INTERFACE" You cannot access the fields coming from the HTTP header. Use
the method input_header_field instead.
method cgi_properties : (string * string) listReturn all properties as an associative list.
method cgi_https : boolA well-known extension is the HTTPS property. It indicates whether a secure connection is used (SSL/TLS). This method interprets this property and returns true if the connection is secure. This method fails if there is a HTTPS property with an unknown value.
method input_header : Netmime.mime_headerThe whole HTTP header.
method input_header_field : ?default:string -> string -> string#input_header_field ?default f returns the value of a field
f of the HTTP request header. The field name f is
case-insensitive; if the name is a compound name, the parts
are separated by "-", e.g. "content-length". If there are
several fields with the same name only the first field will be
returned.
Not_found if the field does not exist, unless the
default argument is passed. The default argument is the
result of the function in this case.method multiple_input_header_field : string -> string listReturns the values of all fields with the passed name of the request header.
method input_header_fields : (string * string) listReturns the input header as (name,value) pairs. The names may consist of lowercase or uppercase letters.
: string -> Cookie.t#cookie cn returns the cookie with name cn.
Not_found if such a cookie does not exists. : Cookie.t listReturns the list of valid cookies found in the request header. Here "valid" means that the decode function does not raise an exception.
method user_agent : stringThis is a convenience method that returns the "User-agent"
field of the HTTP request header.
method input_content_length : intReturns the "Content-length" request header field.
Not_found if it is not set.method input_content_type_string : stringReturns the "Content-type" request header field as a plain
string or "" if it is not set.
method input_content_type : unit -> string * (string * Netmime_string.s_param) listReturns the parsed "Content-type" request header field.
Not_found if it is not set.
See also Netmime_string.scan_mime_type_ep.method output_header : Netmime.mime_headerThe whole HTTP response header
method output_header_field : ?default:string -> string -> stringReturns the value of a field of the response header. If the
field does not exist, Not_found will be raised unless the
default argument is passed. The default argument determines
the result of the function in this case.
If there are several fields with the same name only the first field will be returned.
The anonymous string is the name of the field. The name is
case-insensitive, and it does not matter whether it consists
of lowercase or uppercase letters. If the name is a compound
name, the parts are separated by "-", e.g. "content-length".
method multiple_output_header_field : string -> string listReturns the values of all fields with the passed name of the repsonse header.
method output_header_fields : (string * string) listReturns the output header as (name,value) pairs. The names may consist of lowercase or uppercase letters.
method set_output_header_field : string -> string -> unitSets the value of a field of the response header. The previous value, if any, is overwritten. If there have been multiple values, all values will be removed and replaced by the single new value.
method set_multiple_output_header_field : string -> string list -> unitSets multiple values of a field of the response header. Any previous values are removed and replaced by the new values.
method set_output_header_fields : (string * string) list -> unitSets the complete response header at once.
method set_status : Nethttp.http_status -> unitSets the response status. This is by definition the same as
setting the Status output header field.
method send_output_header : unit -> unitThis method will encode and send the output header to the
output channel. Note that of the output_channel is
`Transactionnal (as opposed to `Direct), no output will
actually take place before you issue #commit_work() -- thus
a #rollback_work() will also rollback the headers as
expected.
method output_ch : Netchannels.out_obj_channel#out_channel instead.method out_channel : Netchannels.out_obj_channelThe "raw" output channel. In general you should use instead
Netcgi.cgi#out_channnel which supports transactions (if you
choose to). Access to the "raw" channel is useful however,
for example for sending images or download of files (for which
transactions are not interesting but merely more work).
method log_error : string -> unit#log_error msg appends msg to the webserver log.
method config : configThe configuration of the request.
