Warning: Reason support is experimental. We are looking for beta-tester and contributors.

Module Ocsigen_extensions

module Ocsigen_extensions : sig..end

Writing extensions for Ocsigen

exception Ocsigen_http_error of (Ocsigen_cookies.cookieset * int)
exception Bad_config_tag_for_extension of string

Xml tag not recognized by an extension (usually not a real error)

exception Error_in_config_file of string

Error in a <site> tag inside the main ocsigen.conf file

exception Error_in_user_config_file of string

Option incorrect in a userconf file

val badconfig : ('a, unit, string, 'b) Pervasives.format4 -> 'a

Convenient function for raising Error_in_config_file exceptions with a sprintf-formatted argument.

type virtual_hosts = (string * Netstring_pcre.regexp * int option) list

Type of the result of parsing the field hostfiler in the configuration file. Inside the list, the first argument is the host itself (which is a glob-like pattern that can contains *), a regexp parsing this pattern, and optionnaly a port.

val hash_virtual_hosts : virtual_hosts -> int
val equal_virtual_hosts : 
  virtual_hosts ->
  virtual_hosts -> bool
val host_match : 
  virtual_hosts:virtual_hosts ->
  host:string option -> port:int -> bool
type do_not_serve = {
  do_not_serve_regexps: string list;  do_not_serve_files: string list;  do_not_serve_extensions: string list;}

Configuration to hide/forbid local files

exception IncorrectRegexpes of do_not_serve
val do_not_serve_to_regexp : do_not_serve -> Netstring_pcre.regexp

Compile a do_not_serve structure into a regexp. Raises IncorrectRegexpes if the compilation fails. The result is memoized for subsequent calls with the same argument

val join_do_not_serve : 
  do_not_serve ->
  do_not_serve -> do_not_serve
type config_info = {
  default_hostname: string;  default_httpport: int;  default_httpsport: int;  default_protocol_is_https: bool;  mime_assoc: Ocsigen_charset_mime.mime_assoc;  charset_assoc: Ocsigen_charset_mime.charset_assoc;  default_directory_index: string list;  list_directory_content: bool;  follow_symlinks: follow_symlink;  do_not_serve_404: do_not_serve;  do_not_serve_403: do_not_serve;  uploaddir: string option;  maxuploadfilesize: int64 option;}

Configuration options, passed to (and modified by) extensions

type client

A value of this type represents the client who did the request.

val client_id : client -> int

Returns the id number of the connection

val client_connection : client -> Ocsigen_http_com.connection

Returns the connection

type ifrange =  | IR_No | IR_Ifunmodsince of float | IR_ifmatch of string
type file_info = {
  tmp_filename: string;  filesize: int64;  raw_original_filename: string;  original_basename: string;  file_content_type: ((string * string) * (string * string) list) option;}
type request_info = {
  ri_url_string: string;(* full URL *)  ri_method: Ocsigen_http_frame.Http_header.http_method;(* GET, POST, HEAD... *)  ri_protocol: Ocsigen_http_frame.Http_header.proto;(* HTTP protocol used by client *)  ri_ssl: bool;(* true if HTTPS, false if HTTP *)  ri_full_path_string: string;(* full path of the URL *)  ri_full_path: string list;(* full path of the URL *)  ri_original_full_path_string: string;(* full path of the URL, as first sent by the client. Should not be changed by extensions, even rewritemod. It is used to create relative links. *)  ri_original_full_path: string list;(* full path of the URL, as first sent by the client. See below. *)  ri_sub_path: string list;(* path of the URL (only part concerning the site) *)  ri_sub_path_string: string;(* path of the URL (only part concerning the site) *)  ri_get_params_string: string option;(* string containing GET parameters *)  ri_host: string option;(* Host field of the request (if any), without port *)  ri_port_from_host_field: int option;(* Port in the host field of the request (if any) *)  ri_get_params: (string * string) list Lazy.t;(* Association list of get parameters *)  ri_initial_get_params: (string * string) list Lazy.t;(* Association list of get parameters, as sent by the browser (must not be modified by extensions) *)  ri_post_params: 
    (config_info -> (string * string) list Lwt.t)
(* Association list of post parameters, if urlencoded form parameters or multipart data. None if other content type or no content. *)
    (config_info ->
     (string * file_info) list Lwt.t)
(* Files sent in the request (multipart data). None if other content type or no content. *)
  ri_remote_inet_addr: Unix.inet_addr;(* IP of the client *)  ri_remote_ip: string;(* IP of the client *)  ri_remote_ip_parsed: Ocsigen_lib.Ip_address.t Lazy.t;(* IP of the client, parsed *)  ri_remote_port: int;(* Port used by the client *)  ri_forward_ip: string list;(* IPs of gateways the request went throught *)  ri_server_port: int;(* Port of the request (server) *)  ri_user_agent: string;(* User_agent of the browser *)  ri_cookies_string: string option Lazy.t;(* Cookies sent by the browser *)  ri_cookies: string Ocsigen_cookies.CookiesTable.t Lazy.t;(* Cookies sent by the browser *)  ri_ifmodifiedsince: float option;(* if-modified-since field *)  ri_ifunmodifiedsince: float option;(* if-unmodified-since field *)  ri_ifnonematch: string list option;(* if-none-match field ( * and weak entity tags not implemented) *)  ri_ifmatch: string list option;(* if-match field ( * not implemented) *)  ri_content_type: ((string * string) * (string * string) list) option;(* Content-Type HTTP header *)  ri_content_type_string: string option;(* Content-Type HTTP header *)  ri_content_length: int64 option;(* Content-Length HTTP header *)  ri_referer: string option Lazy.t;(* Referer HTTP header *)  ri_origin: string option Lazy.t;(* Where the cross-origin request or preflight request originates from. http://www.w3.org/TR/cors/#origin-request-header *)  ri_access_control_request_method: string option Lazy.t;(* which method will be used in the actual request as part of the preflight request. http://www.w3.org/TR/cors/#access-control-request-method-request-he *)  ri_access_control_request_headers: string list option Lazy.t;(* Which headers will be used in the actual request as part of the preflight request. http://www.w3.org/TR/cors/#access-control-request-headers-request-h *)  ri_accept:
    ((string option * string option) * float option *
     (string * string) list)
    list Lazy.t
(* Accept HTTP header. For example (Some "text", None) means "text/*". The float is the "quality" value, if any. The last association list is for other extensions. *)
  ri_accept_charset: (string option * float option) list Lazy.t;(* Accept-Charset HTTP header. None for the first value means "*". The float is the "quality" value, if any. *)  ri_accept_encoding: (string option * float option) list Lazy.t;(* Accept-Encoding HTTP header. None for the first value means "*". The float is the "quality" value, if any. *)  ri_accept_language: (string * float option) list Lazy.t;(* Accept-Language HTTP header. The float is the "quality" value, if any. *)  ri_http_frame: Ocsigen_http_frame.t;(* The full http_frame *)  mutable ri_request_cache: Polytables.t;(* Use this to put anything you want, for example, information for subsequent extensions *)  ri_client: client;(* The request connection *)  ri_range:
    ((int64 * int64) list * int64 option * ifrange)
    option Lazy.t
(* Range HTTP header. None means all the document. List of intervals + possibly from an index to the end of the document. *)
  ri_timeofday: float;(* An Unix timestamp computed at the beginning of the request *)  mutable ri_nb_tries: int;(* For internal use: used to prevent loops of requests *)  ri_connection_closed: unit Lwt.t;(* a thread waking up when the connection is closed *)

The request

If you force ri_files or ri_post_params, the request is fully read, so it is not possible any more to read it from ri_http_frame (and vice versa).

type request = {
  request_info: request_info;  request_config: config_info;}
exception Ocsigen_Is_a_directory of request
type answer =  | Ext_do_nothing(* I don't want to do anything *) | Ext_found of (unit -> Ocsigen_http_frame.result Lwt.t)(* "OK stop! I will take the page.
You can start the following request of the same pipelined connection.
Here is the function to generate the page".
The extension must return Ext_found as soon as possible
when it is sure it is safe to start next request.
Usually as soon as you know that the result will be Ext_found.
But in some case, for example proxies, you don't want the request of
one connection to be handled in different order.
In that case, wait to be sure that the new request will not
overtake this one. *) | Ext_found_stop of (unit -> Ocsigen_http_frame.result Lwt.t)(* Found but do not try next extensions *) | Ext_next of int(* Page not found. Try next extension.
The integer is the HTTP error code.
It is usally 404, but may be for ex 403 (forbidden)
if you want another extension to try after a 403.
Same as Ext_continue_with but does not change
the request. *) | Ext_stop_site of (Ocsigen_cookies.cookieset * int)(* Error. Do not try next extension, but
try next site.
The integer is the HTTP error code, usally 403. *) | Ext_stop_host of (Ocsigen_cookies.cookieset * int)(* Error. Do not try next extension,
do not try next site,
but try next host.
The integer is the HTTP error code, usally 403. *) | Ext_stop_all of (Ocsigen_cookies.cookieset * int)(* Error. Do not try next extension (even filters),
do not try next site,
do not try next host,
do not .
The integer is the HTTP error code, usally 403. *) | Ext_continue_with of (request * Ocsigen_cookies.cookieset * int)(* Used to modify the request before giving it to next extension.
The extension returns the request_info (possibly modified)
and a set of cookies if it wants to set or cookies
(!Ocsigen_cookies.Cookies.empty for no cookies).
You must add these cookies yourself in request_info if you
want them to be seen by subsequent extensions,
for example using Ocsigen_http_frame.compute_new_ri_cookies.
The integer is usually equal to the error code received
from preceding extension (but you may want to modify it). *) | Ext_retry_with of request * Ocsigen_cookies.cookieset(* Used to retry all the extensions with a new request_info.
The extension returns the request_info (possibly modified)
and a set of cookies if it wants to set or cookies
(!Ocsigen_cookies.Cookies.empty for no cookies).
You must add these cookies yourself in request_info if you
want them to be seen by subsequent extensions,
for example using Ocsigen_http_frame.compute_new_ri_cookies. *) | Ext_sub_result of extension2(* Used if your extension want to define option that may contain
other options from other extensions.
In that case, while parsing the configuration file, call
the parsing function (of type parse_fun),
that will return something of type extension2. *) | Ext_found_continue_with of 
    (unit ->
     (Ocsigen_http_frame.result * request) Lwt.t)
(* Same as Ext_found but may modify the request. *)
 | Ext_found_continue_with' of (Ocsigen_http_frame.result * request)(* Same as Ext_found_continue_with but does not allow to delay the computation of the page. You should probably not use it, but for output filters. *)
type request_state =  | Req_not_found of (int * request) | Req_found of (request * Ocsigen_http_frame.result)
type extension2 = 
  (unit -> unit) ->
  Ocsigen_cookies.cookieset ->
  request_state ->
  (answer * Ocsigen_cookies.cookieset) Lwt.t
type extension = request_state -> answer Lwt.t

For each <site> tag in the configuration file, you can set the extensions you want. Each extension is implemented as a function, taking the charset found in configuration file, the current state of the request, and returning an answer. If no page has been generated so far (Req_not_found), it receive the error code given by the previous extension (default 404), and the request information. If a page has been generated by previous extensions (case Req_found), the extension may want to modify the result (filters).

type parse_fun = Simplexmlparser.xml list -> extension2
type parse_host

Type of the functions parsing the content of a <host> tag

type userconf_info = {
  localfiles_root: string;}

Information received by extensions accepting userconf files.

The parameter localfiles_root is an absolute path to the directory that the user is allowed to serve. This is used by staticmod, to disallow the user from allowing access to outside of this directory

type parse_config = 
  virtual_hosts ->
  config_info -> parse_config_aux

parse_config is the type of the functions parsing a <site> tag (and returning an extension). Those are functions taking

  • the name of the virtual <host>

that will be called for each <host>, and that will generate a function taking:

  • the path attribute of a <site> tag

that will be called for each <site>, and that will generate a function taking:

  • an item of the config file

that will be called on each tag inside <site> and:

  • raise Bad_config_tag_for_extension if it does not recognize that tag
  • return something of type extension (filter or page generator)

parse_config_user is the type of functions parsing a site tag inside an userconf file. They take one more parameter, of type userconf_info

type parse_config_user = userconf_info -> parse_config
type parse_config_aux = 
  Ocsigen_lib.Url.path ->
  parse_host ->
  parse_fun ->
  Simplexmlparser.xml -> extension
val register_extension : 
  name:string ->
  ?fun_site:parse_config ->
  ?user_fun_site:parse_config_user ->
  ?begin_init:(unit -> unit) ->
  ?end_init:(unit -> unit) ->
  ?init_fun:(Simplexmlparser.xml list -> unit) ->
  ?exn_handler:(exn -> string) -> ?respect_pipeline:bool -> unit -> unit

For each extension generating pages, we register its name and six functions:

  • a function fun_site of type parse_config. This function will be responsible for handling the options of the configuration files that are recognized by the extension, and potentially generating a page.
  • a function user_fun_site of type parse_user_config which has the same role as fun_site, but inside userconf files. Specify nothing if your extension is disallowed in userconf files. Otherwise, compared to fun_site, you can selectively disallow some options, as user_fun_site must define only safe options (for example it is not safe to allow such options to load a cmo specified by a user, or to execute a program, as this program will be executed by ocsigen's user). Note that user_fun_site will be called for every request, whereas the fun_site is called only when starting or reloading the server.
  • a function begin_init that will be called at the beginning of the initialisation phase of each site, and each time the config file is reloaded.
  • a function end_init that will be called at the end of the initialisation phase of each site
  • a function init_fun that will be called just before registering the extension, taking as parameter the configuration options between <extension> and </extension>. This allows to give configuration options to extensions. If no function is supplied, the extension is supposed to accept no option (and loading will fail if an option is supplied) See <<a_api module="Ocsigen_extensions.Configuration" | val process_elements >> for the easy construction of such a function.
  • a function exn_handler that will create an error message from the exceptions that may be raised during the initialisation phase, and raise again all other exceptions

Moreover, if the optional parameter ?respect_pipeline is true, the extension will ask the server to respect the order of the pipeline. That means that it will wait to be sure that the previous request from the same connection has been taken by an extension before giving a request to an extension. Use this to write proxies extensions, when you want to be able to pipeline the requests you to another server. It is false by default.

module Configuration : sig..end

This modules contains types and constructor for the description of XML configurations and the accordingly parsing.

val get_hostname : request -> string

Returns the hostname to be used for absolute links or redirections. It is either the Host header or the hostname set in the configuration file.

val get_port : request -> int

Returns the port to be used for absolute links or redirections. It is either the port the server is listening at or the default port set in the configuration file.

val ri_of_url : 
  ?full_rewrite:bool ->
  string ->
  request_info -> request_info

Parsing URLs. This allows to modify the URL in the request_info. (to be used for example with Ext_retry_with or Ext_continue_with)

User directories

Exception raised when an non-existing user is found

exception NoSuchUser
type ud_string

The type for string that may contain a $u(...)

val parse_user_dir : string -> ud_string
val replace_user_dir : 
  Netstring_pcre.regexp ->
  ud_string -> string -> string

raises Not_found is the directory does not exist

exception Not_concerned

Regular expressions for redirections

val find_redirection : 
  Netstring_pcre.regexp ->
  bool ->
  string ->
  bool ->
  string option -> int -> string option -> string -> string -> string
exception Unknown_command

Extending server commands

val register_command_function : 
  ?prefix:string -> (string -> string list -> unit Lwt.t) -> unit

Use a prefix for all your commands when you want to create extension-specific commands. For example if the prefix is "myextension" and the commande "blah", the actual command to be written by the user is "myextension:blah". Give as parameter the function that will parse the command and do an action. Its first parameter is the full command as a string. The second one is the command without prefix, split by word. It must raise ocsigen_extensions.Unknown_command if it does not recognize the command.