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 serverlibrary(http/http_dispatch)implements binding locations predicateslibrary(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 HTMLlibrary(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 library | ||
|---|---|---|
| ax_alias/2 | True when Alias is an alias name for the AX schema URL. | |
| ax_form_attributes/2 | True if Values is a list Alias(Value) for each exchanged attribute. | |
| http_ax_attributes/2 | True when HTTPAttributes is a list of Name=Value pairs that can be used with an HTTP request to query for the attributes Spec. | |
| html_head.pl -- Automatic inclusion of CSS and scripts links | ||
| html_quasiquotations.pl -- HTML quasi quotations | ||
| html_write.pl -- Write HTML text | ||
| 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_meta/1 | This directive can be used to declare that an HTML rendering rule takes HTML content as argument. | |
| html_post/4 | Reposition HTML to the receiving Id. | |
| html_print_length/2 | Determine the content length of a token list produced using html//1. | |
| 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 channal 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. | |
| xhtml_ns/4 | Demand an xmlns:id=Value in the outer html tag. | |
| http_authenticate.pl -- Authenticate HTTP connections using 401 headers | ||
| http_client.pl -- HTTP client library | ||
| 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_dirindex.pl -- HTTP directory listings | ||
| 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_json.pl -- HTTP JSON Plugin module | ||
| http_log.pl -- HTTP Logging module | ||
| http_multipart_plugin.pl -- Multipart form-data plugin | ||
| http_open.pl -- HTTP client library | ||
| http_openid.pl -- OpenID consumer and server library | ||
| http_parameters.pl -- Extract parameters (GET and POST) from HTTP requests | ||
| http_path.pl -- Abstract specification of HTTP server locations | ||
| http_server_files.pl -- Serve files needed by modules from the server | ||
| http_session.pl -- HTTP Session management | ||
| http_ssl_plugin.pl -- SSL plugin for HTTP libraries | ||
| http_stream.pl -- HTTP Streams | ||
| http_unix_daemon.pl -- Run SWI-Prolog HTTP server as a Unix system daemon | ||
| http_wrapper.pl -- Server processing of an HTTP request | ||
| http_current_request/1 | Returns the HTTP request currently being processed. | |
| http_peer/2 | True when PeerIP is the IP address of the connection peer. | |
| http_relative_path/2 | Convert an absolute path (without host, fragment or search) into a path relative to the current page. | |
| http_send_header/1 | This API provides an alternative for writing the header field as a CGI header. | |
| http_spawned/1 | Internal use only. | |
| http_wrap_spawned/3 | Internal use only. | |
| http_wrapper/5 | Simple wrapper to read and decode an HTTP header from `In', call :Goal while watching for exceptions and send the result to the stream `Out'. | |
| hub.pl -- Manage a hub for websockets | ||
| current_hub/2 | True when there exists a hub Hub with Name. | |
| hub_add/3 | Add a WebSocket to the hub. | |
| hub_broadcast/2 | Send Message to all websockets associated with Hub for which call(Condition, Id) succeeds. | |
| hub_broadcast/3 | Send Message to all websockets associated with Hub for which call(Condition, Id) succeeds. | |
| hub_create/3 | Create a new hub. | |
| hub_member/2 | True when Id is a member of the hub HubName. | |
| hub_send/2 | Send message to the indicated ClientId. | |
| jquery.pl -- Provide JQuery | ||
| js_grammar.pl -- JavaScript grammar | ||
| js_write.pl -- Utilities for including JavaScript | ||
| json.pl -- Reading and writing JSON serialization | ||
| json_convert.pl -- Convert between JSON terms and Prolog application terms | ||
| mimepack.pl -- Create a MIME message | ||
| mimetype.pl -- Determine mime-type for a file | ||
| term_html.pl -- Represent Prolog terms as HTML | ||
| term/4 | Render a Prolog term as a structured HTML tree. | |
| thread_httpd.pl -- Threaded HTTP server | ||
| 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 | ||
| http_open_websocket/3 | Establish a client websocket connection. | |
| http_upgrade_to_websocket/3 | Create a websocket connection running call(Goal, WebSocket), where WebSocket is a socket-pair. | |
| ws_close/3 | Close a WebSocket connection by sending a close message if this was not already sent and wait for the close reply. | |
| ws_open/3 | Turn a raw TCP/IP (or any other binary stream) into a websocket stream. | |
| ws_property/2 | True if Property is a property WebSocket. | |
| ws_receive/2 | Receive the next message from WebSocket. | |
| ws_receive/3 | Receive the next message from WebSocket. | |
| ws_send/2 | Send a message over a websocket. | |
| yadis.pl -- Yadis discovery | ||
| xrds_dom/2 | True when XRDS_DOM is a parsed XML document for the given resource. | |
| xrds_location/2 | Discover the location of the XRDS document from the given Id. | |