Did you know ... Search Documentation:
Title for pldoc(dir_index)

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

  • 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

ax.pl  -- Attribute Exchange libraryShow source
graphql.pl  -- GraphQL interfaceShow 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
html/3Generate HTML from Content.Source
html_begin/3For html_begin//1, Env is a term Env(Attributes); for html_end//1 it is the plain environment name.Source
html_current_option/1True if Option is an active option for the HTML generator.Source
html_end/3For html_begin//1, Env is a term Env(Attributes); for html_end//1 it is the plain environment name.Source
html_header_hook/1This multifile hook is called just before the Content-type header is emitted.Source
html_meta/1This directive can be used to declare that an HTML rendering rule takes HTML content as argument.Source
html_post/4Reposition HTML to the receiving Id.Source
html_print_length/2Determine the content length of a token list produced using html//1.Source
html_quoted/3Quote the value for normal (CDATA) text.Source
html_quoted_attribute/3Quote the value according to the rules for tag-attributes included in double-quotes.Source
html_receive/3Receive posted HTML tokens.Source
html_receive/4This extended version of html_receive//1 causes Handler to be called to process all messages posted to the channal at the time output is generated.Source
html_root_attribute/4Add an attribute to the HTML root element of the page.Source
html_set_options/1Set options for the HTML output.Source
layout/3Define required newlines before and after tags.Source
page/3Generate a page including the HTML <!DOCTYPE> header.Source
page/4Generate a page including the HTML <!DOCTYPE> header.Source
print_html/1Print list of atoms and layout instructions.Source
print_html/2Print list of atoms and layout instructions.Source
reply_html_page/2Provide the complete reply as required by http_wrapper.pl for a page constructed from Head and Body.Source
reply_html_page/3Provide the complete reply as required by http_wrapper.pl for a page constructed from Head and Body.Source
reply_html_partial/1Reply with partial HTML document.Source
xhtml_ns/4Demand an xmlns:id=Value in the outer html tag.Source
htmx.pl  -- Support htmx.orgShow source
http_authenticate.pl  -- Authenticate HTTP connections using 401 headersShow source
http_client.pl  -- HTTP client libraryShow source
http_cookie.pl  -- HTTP client cookie handlingShow source
http_cors.pl  -- Enable CORS: Cross-Origin Resource SharingShow source
cors_enable/0Emit the HTTP header Access-Control-Allow-Origin using domains from the setting http:cors.Source
cors_enable/2CORS reply to a Preflight OPTIONS request.Source
http_digest.pl  -- HTTP Digest authenticationShow 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/2True when Location represents the HTTP path to which the handler with identifier ID is bound.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_request_expansion/2Register Goal for expanding the HTTP request handler.Source
http_safe_file/2True if FileSpec is considered safe.Source
http_switch_protocol/2Send an "HTTP 101 Switching Protocols" reply.Source
http_dyn_workers.pl  -- Dynamically schedule HTTP workers.Show source
http_error.pl  -- Decorate uncaught HTTP exceptions with stack-traceShow source
http_exception.pl  -- Map Prolog exceptions to HTTP errorsShow source
http_files.pl  -- Serve plain files from a hierarchyShow source
http_reply_from_files/3HTTP handler that serves files from the directory Dir.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
http_load.pl  -- Load Prolog code from a web serverShow source
http_log.plShow source
http_log/2Write message from Format and Args to log-stream.Source
http_log_close/1If there is a currently open HTTP logfile, close it after adding a term server(Reason, Time).Source
http_log_stream/1True when Stream is a stream to the opened HTTP log file.Source
http_logrotate/1Rotate the available log files.Source
http_schedule_logrotate/2Schedule log rotation based on maintenance broadcasts.Source
nolog/1Multifile predicate that can be defined to hide request parameters from the request logfile.Source
nolog_post_content_type/1Multifile hook called with the Content-type header.Source
password_field/1Multifile predicate that can be defined to hide passwords from the logfile.Source
post_data_encoded/2Encode the POST body for inclusion into the HTTP log file.Source
http_multipart_plugin.pl  -- Multipart form-data pluginShow source
http_open.pl  -- HTTP client libraryShow source
http_openid.pl  -- OpenID consumer and server libraryShow source
openid_associate/3Calls openid_associate/4 as.Source
openid_associate/4Associate with an open-id server.Source
openid_authenticate/4Succeeds if Request comes from the OpenID server and confirms that User is a verified OpenID user.Source
openid_current_host/3Find current location of the server.Source
openid_current_url/2Find the public URL for Request that we can make available to our identity provider.Source
openid_grant/1Handle the reply from checkid_setup_server/3.Source
openid_hook/1Call hook on the OpenID management library.Source
openid_logged_in/1True if session is associated with OpenID.Source
openid_login/1Associate the current HTTP session with OpenID.Source
openid_login_form/4Create the OpenID form.Source
openid_logout/1Remove the association of the current session with any OpenID.Source
openid_server/2Realise the OpenID server.Source
openid_server/3True if OpenIDLogin is the typed id for OpenID verified by Server.Source
openid_user/3True if OpenID is a validated OpenID associated with the current session.Source
openid_verify/2Handle the initial login form presented to the user by the relying party (consumer).Source
ssl_verify/5Accept all certificates.Source
http_parameters.pl  -- Extract parameters (GET and POST) from HTTP requestsShow source
http_convert_parameter/4Conversion of an HTTP form value.Source
http_convert_parameters/2Implements the parameter translation of http_parameters/2 or http_parameters/3.Source
http_convert_parameters/3Implements the parameter translation of http_parameters/2 or http_parameters/3.Source
http_parameters/2Get HTTP GET or POST form-data, applying type validation, default values, etc.Source
http_parameters/3Get HTTP GET or POST form-data, applying type validation, default values, etc.Source
http_path.pl  -- Abstract specification of HTTP server locationsShow source
http_proxy.pl  -- Use HTTP network proxiesShow source
http_pwp.pl  -- Serve PWP pages through the HTTP serverShow source
pwp_handler/2Handle PWP files.Source
reply_pwp_page/3Reply a PWP file.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.pl  -- HTTP Server health statisticsShow 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_sgml_plugin.pl  -- Parse of HTML and XML documents for the HTTP client libsShow source
http_stream.pl  -- HTTP StreamsShow source
http_unix_daemon.pl  -- Run SWI-Prolog HTTP server as a Unix system daemonShow source
sni_options/2Hook to provide Server Name Indication (SNI) for TLS servers.
http_certificate_hook/3Hook called before starting the server if the --https option is used.Source
http_daemon/0Start the HTTP server as a daemon process.Source
http_daemon/1Start the HTTP server as a daemon process.Source
http_opt_help/2Allow reusing http option processing.Source
http_opt_meta/2Allow reusing http option processing.Source
http_opt_type/3Allow reusing http option processing.Source
http_server_hook/1Hook that is called to start the HTTP server.Source
http_wrapper.pl  -- Server processing of an HTTP requestShow source
hub.pl  -- Manage a hub for websocketsShow source
js_grammar.pl  -- JavaScript grammarShow source
js_write.pl  -- Utilities for including JavaScriptShow source
json.pl  -- Reading and writing JSON serializationShow source
json_convert.pl  -- Convert between JSON terms and Prolog application termsShow source
mimepack.pl  -- Create a MIME messageShow source
mimetype.pl  -- Determine mime-type for a fileShow source
term_html.pl  -- Represent Prolog terms as HTMLShow source
thread_httpd.pl  -- Threaded HTTP serverShow 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
yadis.pl  -- Yadis discoveryShow source