Mercurial > urweb

annotate src/settings.sig @ 856:86ec89baee01

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
cgi protocol
author Adam Chlipala <adamc@hcoop.net>
date Tue, 23 Jun 2009 17:59:23 -0400
parents 28e42b22424d
children 3d2f6cb6d54a
rev   line source
adamc@764 1 (* Copyright (c) 2008-2009, Adam Chlipala
adamc@764 2 * All rights reserved.
adamc@764 3 *
adamc@764 4 * Redistribution and use in source and binary forms, with or without
adamc@764 5 * modification, are permitted provided that the following conditions are met:
adamc@764 6 *
adamc@764 7 * - Redistributions of source code must retain the above copyright notice,
adamc@764 8 * this list of conditions and the following disclaimer.
adamc@764 9 * - Redistributions in binary form must reproduce the above copyright notice,
adamc@764 10 * this list of conditions and the following disclaimer in the documentation
adamc@764 11 * and/or other materials provided with the distribution.
adamc@764 12 * - The names of contributors may not be used to endorse or promote products
adamc@764 13 * derived from this software without specific prior written permission.
adamc@764 14 *
adamc@764 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
adamc@764 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
adamc@764 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
adamc@764 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
adamc@764 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
adamc@764 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
adamc@764 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
adamc@764 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
adamc@764 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
adamc@764 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
adamc@764 25 * POSSIBILITY OF SUCH DAMAGE.
adamc@764 26 *)
adamc@764 27
adamc@764 28 signature SETTINGS = sig
adamc@764 29
adamc@765 30 (* How do all application URLs begin? *)
adamc@764 31 val setUrlPrefix : string -> unit
adamc@764 32 val getUrlPrefix : unit -> string
adamc@764 33
adamc@765 34 (* How many seconds should the server wait before assuming a Comet client has left? *)
adamc@764 35 val setTimeout : int -> unit
adamc@764 36 val getTimeout : unit -> int
adamc@764 37
adamc@765 38 (* Which C header files are needed? *)
adamc@764 39 val setHeaders : string list -> unit
adamc@764 40 val getHeaders : unit -> string list
adamc@764 41
adamc@766 42 (* Which extra JavaScript URLs should be included? *)
adamc@766 43 val setScripts : string list -> unit
adamc@766 44 val getScripts : unit -> string list
adamc@766 45
adamc@765 46 type ffi = string * string
adamc@765 47
adamc@765 48 (* Which FFI types may be sent from clients to servers? *)
adamc@765 49 val setClientToServer : ffi list -> unit
adamc@765 50 val mayClientToServer : ffi -> bool
adamc@765 51
adamc@765 52 (* Which FFI functions have side effects? *)
adamc@765 53 val setEffectful : ffi list -> unit
adamc@765 54 val isEffectful : ffi -> bool
adamc@765 55
adamc@765 56 (* Which FFI functions may only be run in clients? *)
adamc@765 57 val setClientOnly : ffi list -> unit
adamc@765 58 val isClientOnly : ffi -> bool
adamc@765 59
adamc@765 60 (* Which FFI functions may only be run on servers? *)
adamc@765 61 val setServerOnly : ffi list -> unit
adamc@765 62 val isServerOnly : ffi -> bool
adamc@765 63
adamc@765 64 (* Which FFI functions may be run in JavaScript? (JavaScript function names included) *)
adamc@765 65 val setJsFuncs : (ffi * string) list -> unit
adamc@765 66 val jsFunc : ffi -> string option
adamc@765 67
adamc@768 68 datatype pattern_kind = Exact | Prefix
adamc@768 69 datatype action = Allow | Deny
adamc@768 70 type rule = { action : action, kind : pattern_kind, pattern : string }
adamc@768 71
adamc@768 72 datatype path_kind = Any | Url | Table | Sequence | View | Relation | Cookie | Style
adamc@768 73 type rewrite = { pkind : path_kind, kind : pattern_kind, from : string, to : string }
adamc@768 74
adamc@768 75 (* Rules for rewriting URLs from canonical forms *)
adamc@768 76 val setRewriteRules : rewrite list -> unit
adamc@768 77 val rewrite : path_kind -> string -> string
adamc@768 78
adamc@769 79 (* Validating URLs and MIME types *)
adamc@769 80 val setUrlRules : rule list -> unit
adamc@770 81 val getUrlRules : unit -> rule list
adamc@769 82 val checkUrl : string -> bool
adamc@769 83
adamc@769 84 val setMimeRules : rule list -> unit
adamc@770 85 val getMimeRules : unit -> rule list
adamc@769 86 val checkMime : string -> bool
adamc@769 87
adamc@855 88 (* Web protocols that generated programs may speak *)
adamc@855 89 type protocol = {
adamc@855 90 name : string, (* Call it this on the command line *)
adamc@855 91 link : string, (* Pass these linker arguments *)
adamc@855 92 supportsPush : bool (* Is Ur/Web message-passing supported? *)
adamc@855 93 }
adamc@855 94 val addProtocol : protocol -> unit
adamc@855 95 val getProtocol : string -> protocol option
adamc@856 96 val setProtocol : string -> unit
adamc@855 97 val currentProtocol : unit -> protocol
adamc@855 98
adamc@764 99 end