ocsigenserver 3.0.0 · OCaml Package

exception Unknown_command

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

val get_command_function : 
  unit ->
  ?prefix:string ->
  string ->
  string list ->
  unit Lwt.t

exception Ocsigen_http_error of Ocsigen_cookie_map.t * Cohttp.Code.status

exception Bad_config_tag_for_extension of string

exception Error_in_config_file of string

exception Error_in_user_config_file of string

type file_info = Ocsigen_multipart.file_info = {

tmp_filename : string;
filesize : int64;
raw_original_filename : string;
file_content_type : ((string * string) * (string * string) list) option;

}

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

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

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;

}

val serve_everything : do_not_serve

exception IncorrectRegexpes of do_not_serve

val do_not_serve_to_regexp : do_not_serve -> Pcre.regexp

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 : [ `Always | `No | `Owner_match ];
do_not_serve_404 : do_not_serve;
do_not_serve_403 : do_not_serve;
uploaddir : string option;
maxuploadfilesize : int64 option;

}

val default_config_info : unit -> config_info

type request = {

request_info : Ocsigen_request.t;
request_config : config_info;

}

exception Ocsigen_is_dir of Ocsigen_request.t -> Uri.t

type answer =

| Ext_do_nothing
| Ext_found of unit -> Ocsigen_response.t Lwt.t
| Ext_found_stop of unit -> Ocsigen_response.t Lwt.t
| Ext_next of Cohttp.Code.status
| Ext_stop_site of Ocsigen_cookie_map.t * Cohttp.Code.status
| Ext_stop_host of Ocsigen_cookie_map.t * Cohttp.Code.status
| Ext_stop_all of Ocsigen_cookie_map.t * Cohttp.Code.status
| Ext_continue_with of request * Ocsigen_cookie_map.t * Cohttp.Code.status
| Ext_retry_with of request * Ocsigen_cookie_map.t
| Ext_sub_result of extension_composite
| Ext_found_continue_with of unit -> (Ocsigen_response.t * request) Lwt.t
| Ext_found_continue_with' of Ocsigen_response.t * request

and request_state =

| Req_not_found of Cohttp.Code.status * request
| Req_found of request * Ocsigen_response.t

and extension_composite =
  Ocsigen_cookie_map.t ->
  request_state ->
  (answer * Ocsigen_cookie_map.t) Lwt.t

type extension = request_state -> answer Lwt.t

type parse_fun = Xml.xml list -> extension_composite

type parse_host

type userconf_info = {

localfiles_root : string;

}

type parse_config =
  userconf_info option ->
  virtual_hosts ->
  config_info ->
  parse_config_aux

and parse_config_aux =
  Ocsigen_lib.Url.path ->
  parse_host ->
  parse_fun ->
  Xml.xml ->
  extension

val register : 
  name:string ->
  ?fun_site:parse_config ->
  ?end_init:(unit -> unit) ->
  ?init_fun:(Xml.xml list -> unit) ->
  ?exn_handler:(exn -> string) ->
  ?respect_pipeline:bool ->
  unit ->
  unit

module Configuration : sig ... end

val get_hostname : request -> string

val get_port : request -> int

val new_url_of_directory_request : request -> Ocsigen_request.t -> Uri.t

exception NoSuchUser

type ud_string

val parse_user_dir : string -> ud_string

val replace_user_dir : Pcre.regexp -> ud_string -> string -> string

exception Not_concerned

val find_redirection : 
  Pcre.regexp ->
  bool ->
  string ->
  Ocsigen_request.t ->
  string

val preprocess_site_path : Ocsigen_lib.Url.path -> Ocsigen_lib.Url.path

val compose : extension list -> extension_composite

val make_parse_config : Ocsigen_lib.Url.path -> parse_config_aux -> parse_fun

val parse_config_item : parse_config

val site_ext : 
  extension_composite ->
  Ocsigen_charset_mime.charset option ->
  Ocsigen_lib.Url.path ->
  extension

val set_hosts : 
  (virtual_hosts * config_info * extension_composite) list ->
  unit

val get_hosts : 
  unit ->
  (virtual_hosts * config_info * extension_composite) list

val compute_result : 
  ?previous_cookies:Ocsigen_cookie_map.t ->
  Ocsigen_request.t ->
  Ocsigen_response.t Lwt.t

val get_number_of_connected : unit -> int

val during_initialisation : unit -> bool

val start_initialisation : unit -> unit

val end_initialisation : unit -> unit

val get_numberofreloads : unit -> int

val get_init_exn_handler : unit -> exn -> string

val set_config : Xml.xml list -> unit

package ocsigenserver