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 libraris 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_head.pl  -- Automatic inclusion of CSS and scripts linksShow source
html_quasiquotations.pl  -- HTML quasi quotationsShow source
html/4The predicate html/4 implements HTML quasi quotations.Source
html_write.pl  -- Write HTML textShow 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_dyn_workers.pl  -- Dynamically schedule HTTP workers.Show source
http_exception.pl  -- Map Prolog exceptions to HTTP errorsShow source
bad_request_error/2If an exception of the term error(Formal, context(Stack, Context)) is caught and subsumes_term(ContextTemplate, Context) is true, translate the exception into an HTTP 400 exception.
in_or_exclude_backtrace/2Remove the stacktrace from the exception, unless setting http:client_backtrace is true.Source
map_exception_to_http_status/4Map certain exceptions to HTTP status codes.Source
http_files.pl  -- Serve plain files from a hierarchyShow 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_json.pl  -- HTTP JSON Plugin moduleShow source
post_data_hook/3Hook implementation that allows http_post_data/3 posting JSON objects using one of the forms below.Source
http_convert_data/4Hook implementation that supports reading JSON documents.Source
http_read_json/2Extract JSON data posted to this HTTP request.Source
http_read_json/3Extract JSON data posted to this HTTP request.Source
http_read_json_dict/2Similar to http_read_json/2,3, but by default uses the version 7 extended datatypes.Source
http_read_json_dict/3Similar to http_read_json/2,3, but by default uses the version 7 extended datatypes.Source
is_json_content_type/1True if ContentType is a header value (either parsed or as atom/string) that denotes a JSON value.Source
json_type/1True if MediaType is a JSON media type.Source
reply_json/1Formulate a JSON HTTP reply.Source
reply_json/2Formulate a JSON HTTP reply.Source
reply_json_dict/1As reply_json/1 and reply_json/2, but assumes the new dict based data representation.Source
reply_json_dict/2As reply_json/1 and reply_json/2, but assumes the new dict based data representation.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
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
map_method/2Support additional METHOD keywords.Source
open_hook/6Hook implementation that makes open_any/5 support http and https URLs for Mode == read.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
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_write.pl  -- Utilities for including JavaScriptShow source
javascript/4Quasi quotation parser for JavaScript that allows for embedding Prolog variables to substitude identifiers in the JavaScript snippet.Source
js_arg/3Same as js_expression//1, but fails if Expression is invalid, where js_expression//1 raises an error.Source
js_arg_list/3Write javascript (function) arguments.Source
js_call/3Emit a call to a Javascript function.Source
js_expression/3Emit a single JSON argument.Source
js_new/4Emit a call to a Javascript object declaration.Source
js_script/3Generate a JavaScript script element with the given content.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_dict_pairs/2This hook may be used to order the keys of an object.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_write_hook/4Hook that can be used to emit a JSON representation for Term to Stream.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_bool_to_json/2JSON is the JSON boolean for Prolog.Source
prolog_to_json/2Translate a Prolog application Term into a JSON object term.Source
mimetype.pl  -- Determine mime-type for a fileShow source
term_html.pl  -- Represent Prolog terms as HTMLShow source
term/4Render a Prolog term as a structured HTML tree.Source
thread_httpd.plShow source
schedule_workers/1Hook called if a new connection or a keep-alive connection cannot be scheduled immediately to a worker.Source
http_add_worker/2Add a new worker to the HTTP server for port Port.Source
http_close_connection/1Close connection associated to Request.Source
http_current_server/2True if Goal is the goal of a server at Port.Source
http_current_worker/2True if ThreadID is the identifier of a Prolog thread serving Port.Source
http_enough_workers/3Check that we have enough workers in our queue.Source
http_requeue/1Re-queue a connection to the worker pool.Source
http_server/2Create a server at Port that calls Goal for each parsed request.Source
http_server_property/2True if Property is a property of the HTTP server running at Port.Source
http_spawn/2Continue this connection on a new thread.Source
http_stop_server/2Stop the indicated HTTP server gracefully.Source
http_workers/2Query or set the number of workers for the server at this port.Source
message_level/2Determine the message stream used for exceptions that may occur during server_loop/5.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_mask/1Produce a good random number of the mask of a client message.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