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@866
|
30 val setDebug : bool -> unit
|
adamc@866
|
31 val getDebug : unit -> bool
|
adamc@866
|
32
|
adamc@866
|
33 val clibFile : string -> string
|
adamc@866
|
34
|
adamc@765
|
35 (* How do all application URLs begin? *)
|
adamc@764
|
36 val setUrlPrefix : string -> unit
|
adamc@764
|
37 val getUrlPrefix : unit -> string
|
adamc@764
|
38
|
adamc@765
|
39 (* How many seconds should the server wait before assuming a Comet client has left? *)
|
adamc@764
|
40 val setTimeout : int -> unit
|
adamc@764
|
41 val getTimeout : unit -> int
|
adamc@764
|
42
|
adamc@765
|
43 (* Which C header files are needed? *)
|
adamc@764
|
44 val setHeaders : string list -> unit
|
adamc@764
|
45 val getHeaders : unit -> string list
|
adamc@764
|
46
|
adamc@766
|
47 (* Which extra JavaScript URLs should be included? *)
|
adamc@766
|
48 val setScripts : string list -> unit
|
adamc@766
|
49 val getScripts : unit -> string list
|
adamc@766
|
50
|
adamc@765
|
51 type ffi = string * string
|
adamc@765
|
52
|
adamc@765
|
53 (* Which FFI types may be sent from clients to servers? *)
|
adamc@765
|
54 val setClientToServer : ffi list -> unit
|
adamc@765
|
55 val mayClientToServer : ffi -> bool
|
adamc@765
|
56
|
adamc@765
|
57 (* Which FFI functions have side effects? *)
|
adamc@765
|
58 val setEffectful : ffi list -> unit
|
adamc@765
|
59 val isEffectful : ffi -> bool
|
adamc@765
|
60
|
adamc@765
|
61 (* Which FFI functions may only be run in clients? *)
|
adamc@765
|
62 val setClientOnly : ffi list -> unit
|
adamc@765
|
63 val isClientOnly : ffi -> bool
|
adamc@765
|
64
|
adamc@765
|
65 (* Which FFI functions may only be run on servers? *)
|
adamc@765
|
66 val setServerOnly : ffi list -> unit
|
adamc@765
|
67 val isServerOnly : ffi -> bool
|
adamc@765
|
68
|
adamc@765
|
69 (* Which FFI functions may be run in JavaScript? (JavaScript function names included) *)
|
adamc@765
|
70 val setJsFuncs : (ffi * string) list -> unit
|
adamc@765
|
71 val jsFunc : ffi -> string option
|
adamc@765
|
72
|
adamc@768
|
73 datatype pattern_kind = Exact | Prefix
|
adamc@768
|
74 datatype action = Allow | Deny
|
adamc@768
|
75 type rule = { action : action, kind : pattern_kind, pattern : string }
|
adamc@768
|
76
|
adamc@768
|
77 datatype path_kind = Any | Url | Table | Sequence | View | Relation | Cookie | Style
|
adamc@768
|
78 type rewrite = { pkind : path_kind, kind : pattern_kind, from : string, to : string }
|
adamc@768
|
79
|
adamc@768
|
80 (* Rules for rewriting URLs from canonical forms *)
|
adamc@768
|
81 val setRewriteRules : rewrite list -> unit
|
adamc@768
|
82 val rewrite : path_kind -> string -> string
|
adamc@768
|
83
|
adamc@769
|
84 (* Validating URLs and MIME types *)
|
adamc@769
|
85 val setUrlRules : rule list -> unit
|
adamc@770
|
86 val getUrlRules : unit -> rule list
|
adamc@769
|
87 val checkUrl : string -> bool
|
adamc@769
|
88
|
adamc@769
|
89 val setMimeRules : rule list -> unit
|
adamc@770
|
90 val getMimeRules : unit -> rule list
|
adamc@769
|
91 val checkMime : string -> bool
|
adamc@769
|
92
|
adamc@855
|
93 (* Web protocols that generated programs may speak *)
|
adamc@855
|
94 type protocol = {
|
adamc@855
|
95 name : string, (* Call it this on the command line *)
|
adamc@855
|
96 link : string, (* Pass these linker arguments *)
|
adamc@858
|
97 persistent : bool (* Multiple requests per process? *)
|
adamc@855
|
98 }
|
adamc@855
|
99 val addProtocol : protocol -> unit
|
adamc@856
|
100 val setProtocol : string -> unit
|
adamc@855
|
101 val currentProtocol : unit -> protocol
|
adamc@855
|
102
|
adamc@866
|
103 (* Different DBMSes *)
|
adamc@867
|
104 datatype sql_type =
|
adamc@867
|
105 Int
|
adamc@867
|
106 | Float
|
adamc@867
|
107 | String
|
adamc@867
|
108 | Bool
|
adamc@867
|
109 | Time
|
adamc@867
|
110 | Blob
|
adamc@867
|
111 | Channel
|
adamc@867
|
112 | Client
|
adamc@867
|
113 | Nullable of sql_type
|
adamc@867
|
114
|
adamc@873
|
115 val p_sql_ctype : sql_type -> string
|
adamc@867
|
116 val isBlob : sql_type -> bool
|
adamc@870
|
117 val isNotNull : sql_type -> bool
|
adamc@867
|
118
|
adamc@866
|
119 type dbms = {
|
adamc@866
|
120 name : string,
|
adamc@866
|
121 (* Call it this on the command line *)
|
adamc@866
|
122 header : string,
|
adamc@866
|
123 (* Include this C header file *)
|
adamc@866
|
124 link : string,
|
adamc@866
|
125 (* Pass these linker arguments *)
|
adamc@873
|
126 p_sql_type : sql_type -> string,
|
adamc@870
|
127 init : {dbstring : string,
|
adamc@870
|
128 prepared : (string * int) list,
|
adamc@870
|
129 tables : (string * (string * sql_type) list) list,
|
adamc@872
|
130 views : (string * (string * sql_type) list) list,
|
adamc@870
|
131 sequences : string list} -> Print.PD.pp_desc,
|
adamc@874
|
132 (* Define uw_client_init(), uw_db_init(), uw_db_close(), uw_db_begin(), uw_db_commit(), and uw_db_rollback() *)
|
adamc@873
|
133 query : {loc : ErrorMsg.span, cols : sql_type list,
|
adamc@880
|
134 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int, typ : sql_type} -> Print.PD.pp_desc)
|
adamc@867
|
135 -> Print.PD.pp_desc}
|
adamc@867
|
136 -> Print.PD.pp_desc,
|
adamc@867
|
137 queryPrepared : {loc : ErrorMsg.span, id : int, query : string,
|
adamc@873
|
138 inputs : sql_type list, cols : sql_type list,
|
adamc@880
|
139 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int,
|
adamc@880
|
140 typ : sql_type} -> Print.PD.pp_desc)
|
adamc@879
|
141 -> Print.PD.pp_desc,
|
adamc@879
|
142 nested : bool}
|
adamc@868
|
143 -> Print.PD.pp_desc,
|
adamc@868
|
144 dml : ErrorMsg.span -> Print.PD.pp_desc,
|
adamc@868
|
145 dmlPrepared : {loc : ErrorMsg.span, id : int, dml : string,
|
adamc@869
|
146 inputs : sql_type list} -> Print.PD.pp_desc,
|
adamc@878
|
147 nextval : {loc : ErrorMsg.span, seqE : Print.PD.pp_desc, seqName : string option} -> Print.PD.pp_desc,
|
adamc@874
|
148 nextvalPrepared : {loc : ErrorMsg.span, id : int, query : string} -> Print.PD.pp_desc,
|
adamc@874
|
149 sqlifyString : string -> string,
|
adamc@874
|
150 p_cast : string * sql_type -> string,
|
adamc@874
|
151 p_blank : int * sql_type -> string (* Prepared statement input *),
|
adamc@877
|
152 supportsDeleteAs : bool,
|
adamc@886
|
153 supportsUpdateAs : bool,
|
adamc@877
|
154 createSequence : string -> string,
|
adamc@878
|
155 textKeysNeedLengths : bool,
|
adamc@879
|
156 supportsNextval : bool,
|
adamc@882
|
157 supportsNestedPrepared : bool,
|
adamc@890
|
158 sqlPrefix : string,
|
adamc@890
|
159 supportsOctetLength : bool
|
adamc@866
|
160 }
|
adamc@857
|
161
|
adamc@866
|
162 val addDbms : dbms -> unit
|
adamc@866
|
163 val setDbms : string -> unit
|
adamc@866
|
164 val currentDbms : unit -> dbms
|
adamc@858
|
165
|
adamc@891
|
166 val setDbstring : string option -> unit
|
adamc@891
|
167 val getDbstring : unit -> string option
|
adamc@891
|
168
|
adamc@891
|
169 val setExe : string option -> unit
|
adamc@891
|
170 val getExe : unit -> string option
|
adamc@891
|
171
|
adamc@891
|
172 val setSql : string option -> unit
|
adamc@891
|
173 val getSql : unit -> string option
|
adamc@891
|
174
|
adamc@764
|
175 end
|