SWI-Prolog HTTP support library

This directory provides the SWI-Prolog libraries for accessing and providing HTTP services. The client libraries come in two forms:

• The lightweight http_open.pl opens an HTTP location as a stream
• The more full-blown http_client.pl performs arbitrary HTTP requests and, depending on loaded plugins, transforms the data in a Prolog-friendly format.

The primary server-library is thread_httpd.pl, providing full-blown scalable embedded HTTP server.

Further reading

• ../../packages/http.pdf
• ../../packages/examples/http contains some demos.
• http://www.swi-prolog.org/pldoc/package/http.html

Prolog files

ax.pl  -- Attribute Exchange library
html_head.pl  -- Automatic inclusion of CSS and scripts links
html_current_resource/1	True when About is a currently known resource.
html_requires/3	Include ResourceOrList and all dependencies derived from it and add them to the HTML head using html_post/2.
html_resource/2	Register an HTML head resource.
mime_include/4	Hook called to include a link to an HTML resource of type Mime into the HTML head.
html_quasiquotations.pl
html/4	The predicate html/4 implements HTML quasi quotations.
html_write.pl  -- Write HTML text
http_authenticate.pl  -- Authenticate HTTP connections using 401 headers
http_authenticate/3	True if Request contains the information to continue according to Type.
http_authorization_data/2	Decode the HTTP Authorization header.
http_current_user/3	True when User is present in the htpasswd file File and Fields provides the additional fields.
http_read_passwd_file/2	Read a password file.
http_write_passwd_file/2	Write password data Data to File.
authenticate/3	Plugin for library(http_dispatch) to perform basic HTTP authentication.
http_client.pl  -- HTTP client library
post_data_hook/3	Hook to extend the datatypes supported by the post(Data) option of http_open/3.
http_convert_data/4	Multi-file hook to convert a HTTP payload according to the Content-Type header.
http_delete/3	Execute a DELETE method on the server.
http_disconnect/1	Close down some connections.
http_get/3	Get data from a URL server and convert it to a suitable Prolog representation based on the Content-Type header and plugins.
http_patch/4	Issue an HTTP PATCH request.
http_post/4	Issue an HTTP POST request.
http_put/4	Issue an HTTP PUT request.
http_read_data/3	Read data from an HTTP connection and convert it according to the supplied to(Format) option or based on the Content-type in the Request.
http_cors.pl  -- Enable CORS: Cross-Origin Resource Sharing
cors_enable/0	Emit the HTTP header Access-Control-Allow-Origin using domains from the setting http:cors.
cors_enable/2	CORS reply to a Preflight OPTIONS request.
http_dirindex.pl  -- HTTP directory listings
http_dispatch.pl  -- Dispatch requests in the HTTP server
http_exception.pl  -- Map Prolog exceptions to HTTP errors
http_header.pl  -- Handling HTTP headers
http_address/2	HTML-rule that emits the location of the HTTP server.
mime_type_encoding/2	Encoding is the (default) character encoding for MimeType.
status_page/3	Hook called by http_status_reply/4 and http_status_reply/5 that allows for emitting custom error pages for the following HTTP page types:.
http_join_headers/3	Append headers from Default to Header if they are not already part of it.
http_parse_header/2	Header is a list of Name(Value)-terms representing the structure of the HTTP header in Text.
http_parse_header_value/3	Translate Value in a meaningful Prolog term.
http_post_data/3	Send data on behalf on an HTTP POST request.
http_read_header/2	Read Name: Value lines from FD until an empty line is encountered.
http_read_reply_header/2	Read the HTTP reply header.
http_read_request/2	Read an HTTP request-header from FdIn and return the broken-down request fields as +Name(+Value) pairs in a list.
http_reply/2	Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.
http_reply/3	Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.
http_reply/4	Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.
http_reply/5	Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.
http_reply/6	Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.
http_reply_header/3	Create a reply header using reply_header//3 and send it to Stream.
http_status_reply/4	Emit HTML non-200 status reports.
http_status_reply/5	Emit HTML non-200 status reports.
http_timestamp/2	Generate a description of a Time in HTTP format (RFC1123).
http_update_connection/4	Merge keep-alive information from Request and CGIHeader into Header.
http_update_encoding/3	Allow for rewrite of the header, adjusting the encoding.
http_update_transfer/4	Decide on the transfer encoding from the Request and the CGI header.
http_hook.pl  -- HTTP library hooks
convert_parameter/3	Hook to execute a step in the HTTP parameter conversion process.
http_connection_over_proxy/6	Try to connect to the host Endpoint via Proxy for the purposes of retrieving the resource identified by URLParts.
http_host.pl  -- Obtain public server location
http_current_host/4
http_public_host/4	Current global host and port of the HTTP server.
http_public_host_url/2	True when URL is the public URL at which this server can be contacted.
http_public_url/2	True when URL is an absolute URL for the current request.
http_json.pl  -- HTTP JSON Plugin module
post_data_hook/3	Hook implementation that allows http_post_data/3 posting JSON objects using one of the forms below.
http_convert_data/4	Hook implementation that supports reading JSON documents.
http_read_json/2	Extract JSON data posted to this HTTP request.
http_read_json/3	Extract JSON data posted to this HTTP request.
http_read_json_dict/2	Similar to http_read_json/2,3, but by default uses the version 7 extended datatypes.
http_read_json_dict/3	Similar to http_read_json/2,3, but by default uses the version 7 extended datatypes.
json_type/1	True if MediaType is a JSON media type.
reply_json/1	Formulate a JSON HTTP reply.
reply_json/2	Formulate a JSON HTTP reply.
reply_json_dict/1	As reply_json/1 and reply_json/2, but assumes the new dict based data representation.
reply_json_dict/2	As reply_json/1 and reply_json/2, but assumes the new dict based data representation.
http_multipart_plugin.pl  -- Multipart form-data plugin
http_open.pl  -- HTTP client library
disable_encoding_filter/1	Do not use the Content-encoding as Transfer-encoding encoding for specific values of ContentType.
open_options/2	This hook is used by the HTTP client library to define default options based on the the broken-down request-URL.
update_cookies/3	Update the cookie database.
write_cookies/3	Emit a Cookie: header for the current connection.
http_close_keep_alive/1	Close all keep-alive connections matching Address.
http_open/3	Open the data at the HTTP server as a Prolog stream.
http_set_authorization/2	Set user/password to supply with URLs that have URL as prefix.
open_hook/6	Hook implementation that makes open_any/5 support http and https URLs for Mode == read.
http_openid.pl  -- OpenID consumer and server library
http_parameters.pl  -- Extract parameters (GET and POST) from HTTP requests
http_convert_parameter/4	Conversion of an HTTP form value.
http_convert_parameters/2	Implements the parameter translation of http_parameters/2 or http_parameters/3.
http_convert_parameters/3	Implements the parameter translation of http_parameters/2 or http_parameters/3.
http_parameters/2	Get HTTP GET or POST form-data, applying type validation, default values, etc.
http_parameters/3	Get HTTP GET or POST form-data, applying type validation, default values, etc.
http_path.pl  -- Abstract specification of HTTP server locations
http_server_files.pl  -- Serve files needed by modules from the server
serve_files_in_directory/2	Serve files from the directory Alias from the path-info from Request.
http_session.pl  -- HTTP Session management
http_close_session/1	Closes an HTTP session.
http_current_session/2	Enumerate the current sessions and associated data.
http_in_session/1	True if SessionId is an identifier for the current session.
http_open_session/2	Establish a new session.
http_session_assert/1	Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session.
http_session_asserta/1	Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session.
http_session_cookie/1	Generate a random cookie that can be used by a browser to identify the current session.
http_session_data/1	True if Data is associated using http_session_assert/1 to the current HTTP session.
http_session_id/1	True if SessionId is an identifier for the current session.
http_session_option/1	True if Option is a current option of the session system.
http_session_retract/1	Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session.
http_session_retractall/1	Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session.
http_set_session/1	Overrule a setting for the current or specified session.
http_set_session/2	Overrule a setting for the current or specified session.
http_set_session_options/1	Set options for the session library.
http_ssl_plugin.pl  -- SSL plugin for HTTP libraries
http_connection_over_proxy/6	Facilitate an HTTPS connection via a proxy using HTTP CONNECT.
http_protocol_hook/5	Hook for http_open/3 to connect to an HTTPS (SSL-based HTTP) server.
open_options/2	Implementation of the multifile hook http:open_options/2 used by library(http/http_open).
ssl_server_create_hook/3	Extensible predicate that is called once after creating an HTTPS server.
ssl_server_open_client_hook/3	Extensible predicate that is called before each connection that the server negotiates with a client.
accept_hook/2	Implement the accept for HTTPS connections.
make_socket_hook/3	Hook into http_server/2 to create an SSL server if the option ssl(SSLOptions) is provided.
http_stream.pl  -- HTTP Streams
http_unix_daemon.pl  -- Run SWI-Prolog HTTP server as a Unix system daemon
http_wrapper.pl  -- Server processing of an HTTP request
jquery.pl  -- Provide JQuery
js_grammar.pl  -- JavaScript grammar
js_token/3	Matches and classifies the next JavaScript token.
js_write.pl  -- Utilities for including JavaScript
json.pl  -- Reading and writing JSON serialization
json_convert.pl  -- Convert between JSON terms and Prolog application terms
mimepack.pl  -- Create a MIME message
mimetype.pl  -- Determine mime-type for a file
mime_extension/2	Hook that is called by file_mime_type/2 before the default table is examined.
file_mime_type/2	True when MimeType is the mime-type to be used for sending FileName.
term_html.pl  -- Represent Prolog terms as HTML
thread_httpd.pl  -- Threaded HTTP server
schedule_workers/1	Hook called if a new connection or a keep-alive connection cannot be scheduled immediately to a worker.
http_add_worker/2	Add a new worker to the HTTP server for port Port.
http_close_connection/1	Close connection associated to Request.
http_current_server/2	True if Goal is the goal of a server at Port.
http_current_worker/2	True if ThreadID is the identifier of a Prolog thread serving Port.
http_enough_workers/3	Check that we have enough workers in our queue.
http_requeue/1	Re-queue a connection to the worker pool.
http_server/2	Create a server at Port that calls Goal for each parsed request.
http_server_property/2	True if Property is a property of the HTTP server running at Port.
http_spawn/2	Continue this connection on a new thread.
http_stop_server/2	Stop the indicated HTTP server gracefully.
http_workers/2	Query or set the number of workers for the server at this port.
yadis.pl  -- Yadis discovery
xrds_dom/2	True when XRDS_DOM is a parsed XML document for the given resource.
xrds_location/2	Discover the location of the XRDS document from the given Id.
xrds_specified_location/2	Hook that allows for specifying locations of XRDS documents.