SWI-Prolog HTTP support library

This directory provides the SWI-Prolog libraries for accessing and providing HTTP services.

Client library

The main client library is library(http/http_open), which can open both HTTP and HTTPS connections and handle all request methods.

Server library

The main server libraries are

• library(http/thread_httpd) implements the server
• library(http/http_dispatch) implements binding locations predicates
• library(http/http_unix_daemon) implements integration in various Unix server managers and in general provides a suitable entry point for HTTP servers on Unix.
• library(http/html_write) implements generating HTML
• library(http/http_json) implements reading and writing JSON documents.

For simplicity, you can use library(http/http_server), which combines the typical HTTP libraries that most servers need. The idea of a common request handling system and three controlling libraries is outdated; the threaded server now being the only sensible controlling library.

Requirements

This library uses functionality from the ssl package to support HTTPS, the sgml package to read XML/HTML and the clib package for various extensions.

Prolog files

html_decl.pl  -- HTML emitter analysis and IDE support
html_head.pl  -- Automatic inclusion of CSS and scripts links
html_quasiquotations.pl  -- HTML quasi quotations
html_write.pl
html/3	Generate HTML from Content.
html_begin/3	For html_begin//1, Env is a term Env(Attributes); for html_end//1 it is the plain environment name.
html_current_option/1	True if Option is an active option for the HTML generator.
html_end/3	For html_begin//1, Env is a term Env(Attributes); for html_end//1 it is the plain environment name.
html_header_hook/1	This multifile hook is called just before the Content-type header is emitted.
html_post/4	Reposition HTML to the receiving Id.
html_quoted/3	Quote the value for normal (CDATA) text.
html_quoted_attribute/3	Quote the value according to the rules for tag-attributes included in double-quotes.
html_receive/3	Receive posted HTML tokens.
html_receive/4	This extended version of html_receive//1 causes Handler to be called to process all messages posted to the channel at the time output is generated.
html_root_attribute/4	Add an attribute to the HTML root element of the page.
html_set_options/1	Set options for the HTML output.
layout/3	Define required newlines before and after tags.
page/3	Generate a page including the HTML <!DOCTYPE> header.
page/4	Generate a page including the HTML <!DOCTYPE> header.
print_html/1	Print list of atoms and layout instructions.
print_html/2	Print list of atoms and layout instructions.
reply_html_page/2	Provide the complete reply as required by http_wrapper.pl for a page constructed from Head and Body.
reply_html_page/3	Provide the complete reply as required by http_wrapper.pl for a page constructed from Head and Body.
reply_html_partial/1	Reply with partial HTML document.
xhtml_ns/4	Demand an xmlns:id=Value in the outer html tag.
http_client.pl
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
http_dispatch.pl  -- Dispatch requests in the HTTP server
http_dyn_workers.pl  -- Dynamically schedule HTTP workers.
http_exception.pl  -- Map Prolog exceptions to HTTP errors
http_header.pl  -- Handling HTTP headers
http_hook.pl  -- HTTP library hooks
http_host.pl  -- Obtain public server location
http_log.pl  -- HTTP Logging module
http_multipart_plugin.pl  -- Multipart form-data plugin
http_open.pl
disable_encoding_filter/1	Do not use the Content-encoding as Transfer-encoding encoding for specific values of ContentType.
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.
keep_alive/4	Callback when closing the range stream used to process the content of the reply.
map_method/2	Support additional METHOD keywords.
open_hook/6	Hook implementation that makes open_any/5 support http and https URLs for Mode == read.
http_parameters.pl  -- Extract parameters (GET and POST) from HTTP requests
http_path.pl  -- Abstract specification of HTTP server locations
http_redis_plugin.pl  -- Hook session management to use Redis
http_server.pl  -- HTTP server library
http_server_files.pl  -- Serve files needed by modules from the server
http_server_health.pl  -- HTTP Server health statistics
http_session.pl
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_assert/2	Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit 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_asserta/2	Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit 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_data/2	Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit 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_retract/2	Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit HTTP session.
http_session_retractall/1	Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session.
http_session_retractall/2	Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit 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.
session_setting/2	Find setting for SessionID.
http_stream.pl
current_transfer_encoding/1	True if Encoding is supported.
encoding_filter/3	Install a filter to deal with chunked encoded messages.
cgi_discard/1	Discard content produced so far.
cgi_open/4	Process CGI output.
cgi_property/2	Inquire the status of the CGI stream.
cgi_set/2	Change one of the properties.
cgi_statistics/1	Return statistics on the CGI stream subsystem.
http_chunked_add_trailer/3	Add a trailer key/value to DataStream.
http_chunked_flush/2	Emits the next chunk flush_output/1 on DataStream, but in addition adds extension parameters to the chunk.
http_chunked_open/3	Create a stream to realise HTTP chunked encoding or decoding.
http_is_chunked/1	True if DataStream is created using http_chunked_open/3.
is_cgi_stream/1	True if Stream is a CGI stream created using cgi_open/4.
multipart_open/3	DataStream is a stream that signals end_of_file if the multipart boundary is encountered.
multipart_open_next/1	Prepare DataStream to read the next part from the multipart input data.
stream_range_open/3	DataStream is a stream whose size is defined by the option size(ContentLength).
http_unix_daemon.pl
sni_options/2	Hook to provide Server Name Indication (SNI) for TLS servers.
http_certificate_hook/3	Hook called before starting the server if the --https option is used.
http_daemon/0	Start the HTTP server as a daemon process.
http_daemon/1	Start the HTTP server as a daemon process.
http_opt_help/2	Allow reusing http option processing.
http_opt_meta/2	Allow reusing http option processing.
http_opt_type/3	Allow reusing http option processing.
http_server_hook/1	Hook that is called to start the HTTP server.
http_wrapper.pl  -- Server processing of an HTTP request
hub.pl  -- Manage a hub for websockets
js_write.pl  -- Utilities for including JavaScript
mimepack.pl  -- Create a MIME message
mime_pack/3	Pack a number of inputs into a MIME package using a specified or generated boundary.
mimetype.pl  -- Determine mime-type for a file
term_html.pl  -- Represent Prolog terms as HTML
thread_httpd.pl
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.
message_level/2	Determine the message stream used for exceptions that may occur during server_loop/5.
websocket.pl  -- WebSocket support