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

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 supportShow source
html_head.plShow source
html_current_resource/1True when About is a currently known resource.Source
html_insert_resource/3Actually include HTML head resources.Source
html_requires/3Include ResourceOrList and all dependencies derived from it and add them to the HTML head using html_post/2.Source
html_resource/2Register an HTML head resource.Source
mime_include/4Hook called to include a link to an HTML resource of type Mime into the HTML head.Source
html_quasiquotations.pl  -- HTML quasi quotationsShow source
html_write.pl  -- Write HTML textShow source
http_client.plShow source
http_cors.pl  -- Enable CORS: Cross-Origin Resource SharingShow source
http_dispatch.pl  -- Dispatch requests in the HTTP serverShow source
http_dyn_workers.pl  -- Dynamically schedule HTTP workers.Show source
http_exception.pl  -- Map Prolog exceptions to HTTP errorsShow source
http_header.plShow source
http_address/2HTML-rule that emits the location of the HTTP server.
mime_type_encoding/2Encoding is the (default) character encoding for MimeType.
serialize_reply/2Multifile hook to serialize the result of status_reply/3 into a term.Source
status_page/3Hook 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/3Append headers from Default to Header if they are not already part of it.Source
http_parse_header/2Header is a list of Name(Value)-terms representing the structure of the HTTP header in Text.Source
http_parse_header_value/3Translate Value in a meaningful Prolog term.Source
http_post_data/3Send data on behalf on an HTTP POST request.Source
http_read_header/2Read Name: Value lines from FD until an empty line is encountered.Source
http_read_reply_header/2Read the HTTP reply header.Source
http_read_request/2Read an HTTP request-header from FdIn and return the broken-down request fields as +Name(+Value) pairs in a list.Source
http_reply/2Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.Source
http_reply/3Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.Source
http_reply/4Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.Source
http_reply/5Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.Source
http_reply/6Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.Source
http_reply_header/3Create a reply header using reply_header//3 and send it to Stream.Source
http_status_reply/4Emit HTML non-200 status reports.Source
http_status_reply/5Emit HTML non-200 status reports.Source
http_timestamp/2Convert between a SWI-Prolog time stamp and a string in HTTP format (RFC1123).Source
http_update_connection/4Merge keep-alive information from Request and CGIHeader into Header.Source
http_update_encoding/3Allow for rewrite of the header, adjusting the encoding.Source
http_update_transfer/4Decide on the transfer encoding from the Request and the CGI header.Source
http_hook.pl  -- HTTP library hooksShow source
http_host.pl  -- Obtain public server locationShow source
http_log.pl  -- HTTP Logging moduleShow source
http_multipart_plugin.pl  -- Multipart form-data pluginShow source
http_open.pl  -- HTTP client libraryShow source
http_parameters.pl  -- Extract parameters (GET and POST) from HTTP requestsShow source
http_path.pl  -- Abstract specification of HTTP server locationsShow source
http_redis_plugin.pl  -- Hook session management to use RedisShow source
http_server.pl  -- HTTP server libraryShow source
http_server_files.pl  -- Serve files needed by modules from the serverShow source
http_server_health.plShow source
health/2Multifile extensible.Source
hide/1Multifile hook.Source
server_health/1HTTP handler that replies with the overall health of the server.Source
http_session.pl  -- HTTP Session managementShow source
http_stream.plShow source
current_transfer_encoding/1True if Encoding is supported.Source
encoding_filter/3Install a filter to deal with chunked encoded messages.Source
cgi_discard/1Discard content produced so far.Source
cgi_open/4Process CGI output.Source
cgi_property/2Inquire the status of the CGI stream.Source
cgi_set/2Change one of the properties.Source
cgi_statistics/1Return statistics on the CGI stream subsystem.Source
http_chunked_add_trailer/3Add a trailer key/value to DataStream.Source
http_chunked_flush/2Emits the next chunk flush_output/1 on DataStream, but in addition adds extension parameters to the chunk.Source
http_chunked_open/3Create a stream to realise HTTP chunked encoding or decoding.Source
http_is_chunked/1True if DataStream is created using http_chunked_open/3.Source
is_cgi_stream/1True if Stream is a CGI stream created using cgi_open/4.Source
multipart_open/3DataStream is a stream that signals end_of_file if the multipart boundary is encountered.Source
multipart_open_next/1Prepare DataStream to read the next part from the multipart input data.Source
stream_range_open/3DataStream is a stream whose size is defined by the option size(ContentLength).Source
http_unix_daemon.pl  -- Run SWI-Prolog HTTP server as a Unix system daemonShow source
http_wrapper.pl  -- Server processing of an HTTP requestShow source
hub.pl  -- Manage a hub for websocketsShow source
js_write.pl  -- Utilities for including JavaScriptShow source
mimetype.pl  -- Determine mime-type for a fileShow source
term_html.pl  -- Represent Prolog terms as HTMLShow source
thread_httpd.plShow source
websocket.pl  -- WebSocket supportShow source