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 primary server-library is thread_httpd.pl, providing full-blown scalable embedded HTTP server.

Further reading

Prolog files

ax.pl  -- Attribute Exchange libraryShow source
html_head.pl  -- Automatic inclusion of CSS and scripts linksShow source
html_quasiquotations.pl  -- HTML quasi quotationsShow source
html_write.pl  -- Write HTML textShow source
http_authenticate.pl  -- Authenticate HTTP connections using 401 headersShow source
http_client.pl  -- HTTP client libraryShow source
post_data_hook/3Hook to extend the datatypes supported by the post(Data) option of http_open/3.Source
http_convert_data/4Multi-file hook to convert a HTTP payload according to the Content-Type header.Source
http_delete/3Execute a DELETE method on the server.Source
http_disconnect/1Close down some connections.Source
http_get/3Get data from a URL server and convert it to a suitable Prolog representation based on the Content-Type header and plugins.Source
http_patch/4Issue an HTTP PATCH request.Source
http_post/4Issue an HTTP POST request.Source
http_put/4Issue an HTTP PUT request.Source
http_read_data/3Read data from an HTTP connection and convert it according to the supplied to(Format) option or based on the Content-type in the Request.Source
http_cors.pl  -- Enable CORS: Cross-Origin Resource SharingShow source
http_dirindex.pl  -- HTTP directory listingsShow source
http_dispatch.pl  -- Dispatch requests in the HTTP serverShow source
http_404/2Reply using an "HTTP 404 not found" page.Source
http_current_handler/2True if Location is handled by Closure.Source
http_current_handler/3Resolve the current handler and options to execute it.Source
http_delete_handler/1Delete handler for Spec.Source
http_dispatch/1Dispatch a Request using http_handler/3 registrations.Source
http_handler/3Register Closure as a handler for HTTP requests.Source
http_link_to_id/3HREF is a link on the local server to a handler with given ID, passing the given Parameters.Source
http_location_by_id/2Find the HTTP Location of handler with ID.Source
http_redirect/3Redirect to a new location.Source
http_reload_with_parameters/3Create a request on the current handler with replaced search parameters.Source
http_reply_file/3Options is a list of.Source
http_safe_file/2True if FileSpec is considered safe.Source
http_switch_protocol/2Send an "HTTP 101 Switching Protocols" reply.Source
http_error.pl  -- Decorate uncaught HTTP exceptions with stack-traceShow source
http_exception.pl  -- Map Prolog exceptions to HTTP errorsShow source
http_header.pl  -- Handling HTTP headersShow source
http_hook.pl  -- HTTP library hooksShow source
convert_parameter/3Hook to execute a step in the HTTP parameter conversion process.
http_connection_over_proxy/6Try to connect to the host Endpoint via Proxy for the purposes of retrieving the resource identified by URLParts.Source
http_host.pl  -- Obtain public server locationShow source
http_current_host/4Source
http_public_host/4Current global host and port of the HTTP server.Source
http_public_host_url/2True when URL is the public URL at which this server can be contacted.Source
http_public_url/2True when URL is an absolute URL for the current request.Source
http_json.pl  -- HTTP JSON Plugin moduleShow source
http_log.pl  -- HTTP Logging moduleShow source
http_multipart_plugin.pl  -- Multipart form-data pluginShow source
http_open.pl  -- HTTP client libraryShow source
disable_encoding_filter/1Do not use the Content-encoding as Transfer-encoding encoding for specific values of ContentType.Source
open_options/2This hook is used by the HTTP client library to define default options based on the the broken-down request-URL.Source
update_cookies/3Update the cookie database.Source
write_cookies/3Emit a Cookie: header for the current connection.Source
http_close_keep_alive/1Close all keep-alive connections matching Address.Source
http_open/3Open the data at the HTTP server as a Prolog stream.Source
http_set_authorization/2Set user/password to supply with URLs that have URL as prefix.Source
open_hook/6Hook implementation that makes open_any/5 support http and https URLs for Mode == read.Source
http_openid.pl  -- OpenID consumer and server 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_server_files.pl  -- Serve files needed by modules from the serverShow source
http_session.pl  -- HTTP Session managementShow source
http_ssl_plugin.pl  -- SSL plugin for HTTP librariesShow source
http_stream.pl  -- HTTP StreamsShow 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 sofar.Source
cgi_open/4Process CGI output.Source
cgi_property/2Inquire the status of the CGI stream.Source
cgi_set/2Change one of the properies.Source
cgi_statistics/1Return statistics on the CGI stream subsystem.Source
http_chunked_open/3Create a stream to realise HTTP chunked encoding or decoding.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
jquery.pl  -- Provide JQueryShow source
js_grammar.pl  -- JavaScript grammarShow source
js_token/3Matches and classifies the next JavaScript token.Source
js_write.pl  -- Utilities for including JavaScriptShow source
json.pl  -- Reading and writing JSON serializationShow source
atom_json_dict/3Convert between textual representation and a JSON term represented as a dict.Source
atom_json_term/3Convert between textual representation and a JSON term.Source
is_json_term/1True if Term is a json term.Source
is_json_term/2True if Term is a json term.Source
json_read/2Read next JSON value from Stream into a Prolog term.Source
json_read/3Read next JSON value from Stream into a Prolog term.Source
json_read_dict/2Read a JSON object, returning objects as a dicts.Source
json_read_dict/3Read a JSON object, returning objects as a dicts.Source
json_write/2Write a JSON term to Stream.Source
json_write/3Write a JSON term to Stream.Source
json_write_dict/2Write a JSON term, represented using dicts.Source
json_write_dict/3Write a JSON term, represented using dicts.Source
json_convert.pl  -- Convert between JSON terms and Prolog application termsShow source
current_json_object/3Multifile predicate computed from the json_object/1 declarations.Source
json_object/1Declare a JSON object.Source
json_to_prolog/2Translate a JSON term into an application term.Source
prolog_to_json/2Translate a Prolog application Term into a JSON object term.Source
mimepack.pl  -- Create a MIME messageShow source
mimetype.pl  -- Determine mime-type for a fileShow source
mime_extension/2Hook that is called by file_mime_type/2 before the default table is examined.Source
file_mime_type/2True when MimeType is the mime-type to be used for sending FileName.Source
term_html.pl  -- Represent Prolog terms as HTMLShow source
thread_httpd.pl  -- Threaded HTTP serverShow source
websocket.pl  -- WebSocket supportShow source
http_open_websocket/3Establish a client websocket connection.Source
http_upgrade_to_websocket/3Create a websocket connection running call(Goal, WebSocket), where WebSocket is a socket-pair.Source
ws_close/3Close a WebSocket connection by sending a close message if this was not already sent and wait for the close reply.Source
ws_open/3Turn a raw TCP/IP (or any other binary stream) into a websocket stream.Source
ws_property/2True if Property is a property WebSocket.Source
ws_receive/2Receive the next message from WebSocket.Source
ws_receive/3Receive the next message from WebSocket.Source
ws_send/2Send a message over a websocket.Source
yadis.pl  -- Yadis discoveryShow source