annotate src/settings.sml @ 1183:9d3ccb8b39ac

safeGet
author Adam Chlipala <adamc@hcoop.net>
date Tue, 09 Mar 2010 18:28:44 -0500
parents 7a2a7a8f9cab
children 134da5110bf7
rev   line source
adamc@1114 1 (* Copyright (c) 2008-2010, 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 structure Settings :> SETTINGS = struct
adamc@764 29
adamc@764 30 val urlPrefix = ref "/"
adamc@764 31 val timeout = ref 0
adamc@764 32 val headers = ref ([] : string list)
adamc@766 33 val scripts = ref ([] : string list)
adamc@764 34
adamc@764 35 fun getUrlPrefix () = !urlPrefix
adamc@764 36 fun setUrlPrefix p =
adamc@764 37 urlPrefix := (if p = "" then
adamc@764 38 "/"
adamc@764 39 else if String.sub (p, size p - 1) <> #"/" then
adamc@764 40 p ^ "/"
adamc@764 41 else
adamc@764 42 p)
adamc@764 43
adamc@764 44 fun getTimeout () = !timeout
adamc@764 45 fun setTimeout n = timeout := n
adamc@764 46
adamc@764 47 fun getHeaders () = !headers
adamc@764 48 fun setHeaders ls = headers := ls
adamc@764 49
adamc@766 50 fun getScripts () = !scripts
adamc@766 51 fun setScripts ls = scripts := ls
adamc@766 52
adamc@765 53 type ffi = string * string
adamc@765 54
adamc@765 55 structure K = struct
adamc@765 56 type ord_key = ffi
adamc@765 57 fun compare ((m1, x1), (m2, x2)) =
adamc@765 58 Order.join (String.compare (m1, m2),
adamc@765 59 fn () => String.compare (x1, x2))
adamc@764 60 end
adamc@765 61
adamc@765 62 structure S = BinarySetFn(K)
adamc@765 63 structure M = BinaryMapFn(K)
adamc@765 64
adamc@765 65 fun basis x = S.addList (S.empty, map (fn x : string => ("Basis", x)) x)
adamc@765 66
adamc@765 67 val clientToServerBase = basis ["int",
adamc@765 68 "float",
adamc@765 69 "string",
adamc@765 70 "time",
adamc@765 71 "file",
adamc@765 72 "unit",
adamc@765 73 "option",
adamc@765 74 "list",
adamc@765 75 "bool"]
adamc@765 76 val clientToServer = ref clientToServerBase
adamc@765 77 fun setClientToServer ls = clientToServer := S.addList (clientToServerBase, ls)
adamc@765 78 fun mayClientToServer x = S.member (!clientToServer, x)
adamc@765 79
adamc@779 80 val effectfulBase = basis ["dml",
adamc@779 81 "nextval",
adamc@1073 82 "setval",
adamc@779 83 "set_cookie",
adamc@1050 84 "clear_cookie",
adamc@765 85 "new_channel",
adamc@1171 86 "send"]
adamc@765 87
adamc@765 88 val effectful = ref effectfulBase
adamc@765 89 fun setEffectful ls = effectful := S.addList (effectfulBase, ls)
adamc@765 90 fun isEffectful x = S.member (!effectful, x)
adamc@765 91
adamc@1171 92 val benignBase = basis ["get_cookie",
adamc@1171 93 "new_client_source",
adamc@1171 94 "get_client_source",
adamc@1171 95 "set_client_source",
adamc@1171 96 "current",
adamc@1171 97 "alert",
adamc@1171 98 "onError",
adamc@1171 99 "onFail",
adamc@1171 100 "onConnectFail",
adamc@1171 101 "onDisconnect",
adamc@1171 102 "onServerError",
adamc@1171 103 "kc",
adamc@1171 104 "debug"]
adamc@1171 105
adamc@1171 106 val benign = ref benignBase
adamc@1171 107 fun setBenignEffectful ls = benign := S.addList (benignBase, ls)
adamc@1171 108 fun isBenignEffectful x = S.member (!benign, x)
adamc@1171 109
adamc@765 110 val clientBase = basis ["get",
adamc@765 111 "set",
adamc@841 112 "current",
adamc@765 113 "alert",
adamc@765 114 "recv",
adamc@765 115 "sleep",
adamc@765 116 "spawn",
adamc@765 117 "onError",
adamc@765 118 "onFail",
adamc@765 119 "onConnectFail",
adamc@765 120 "onDisconnect",
adamc@895 121 "onServerError",
adamc@895 122 "kc"]
adamc@765 123 val client = ref clientBase
adamc@765 124 fun setClientOnly ls = client := S.addList (clientBase, ls)
adamc@765 125 fun isClientOnly x = S.member (!client, x)
adamc@765 126
adamc@765 127 val serverBase = basis ["requestHeader",
adamc@765 128 "query",
adamc@765 129 "dml",
adamc@765 130 "nextval",
adamc@1073 131 "setval",
adamc@765 132 "channel",
adamc@765 133 "send"]
adamc@765 134 val server = ref serverBase
adamc@765 135 fun setServerOnly ls = server := S.addList (serverBase, ls)
adamc@765 136 fun isServerOnly x = S.member (!server, x)
adamc@765 137
adamc@765 138 val basisM = foldl (fn ((k, v : string), m) => M.insert (m, ("Basis", k), v)) M.empty
adamc@765 139
adamc@765 140 val jsFuncsBase = basisM [("alert", "alert"),
adamc@765 141 ("get_client_source", "sg"),
adamc@841 142 ("current", "scur"),
adamc@765 143 ("htmlifyBool", "bs"),
adamc@765 144 ("htmlifyFloat", "ts"),
adamc@765 145 ("htmlifyInt", "ts"),
adamc@765 146 ("htmlifyString", "eh"),
adamc@765 147 ("new_client_source", "sc"),
adamc@765 148 ("set_client_source", "sv"),
adamc@838 149 ("stringToFloat", "pflo"),
adamc@838 150 ("stringToInt", "pio"),
adamc@765 151 ("stringToFloat_error", "pfl"),
adamc@765 152 ("stringToInt_error", "pi"),
adamc@765 153 ("urlifyInt", "ts"),
adamc@765 154 ("urlifyFloat", "ts"),
adamc@765 155 ("urlifyString", "uf"),
adamc@912 156 ("urlifyBool", "ub"),
adamc@765 157 ("recv", "rv"),
adamc@765 158 ("strcat", "cat"),
adamc@765 159 ("intToString", "ts"),
adamc@765 160 ("floatToString", "ts"),
adamc@821 161 ("charToString", "ts"),
adamc@765 162 ("onError", "onError"),
adamc@765 163 ("onFail", "onFail"),
adamc@765 164 ("onConnectFail", "onConnectFail"),
adamc@765 165 ("onDisconnect", "onDisconnect"),
adamc@798 166 ("onServerError", "onServerError"),
adamc@1108 167 ("attrifyString", "atr"),
adamc@798 168 ("attrifyInt", "ts"),
adamc@798 169 ("attrifyFloat", "ts"),
adamc@820 170 ("attrifyBool", "bs"),
adamc@821 171 ("boolToString", "ts"),
adamc@1057 172 ("str1", "id"),
adamc@821 173 ("strsub", "sub"),
adamc@828 174 ("strsuffix", "suf"),
adamc@829 175 ("strlen", "slen"),
adamc@829 176 ("strindex", "sidx"),
adamc@829 177 ("strchr", "schr"),
adamc@831 178 ("substring", "ssub"),
adamc@895 179 ("strcspn", "sspn"),
adamc@1061 180 ("kc", "kc"),
adamc@1061 181
adamc@1061 182 ("islower", "isLower"),
adamc@1061 183 ("isupper", "isUpper"),
adamc@1061 184 ("isalpha", "isAlpha"),
adamc@1061 185 ("isdigit", "isDigit"),
adamc@1061 186 ("isalnum", "isAlnum"),
adamc@1061 187 ("isblank", "isBlank"),
adamc@1061 188 ("isspace", "isSpace"),
adamc@1061 189 ("isxdigit", "isXdigit"),
adamc@1061 190 ("tolower", "toLower"),
adamc@1061 191 ("toupper", "toUpper")]
adamc@765 192 val jsFuncs = ref jsFuncsBase
adamc@765 193 fun setJsFuncs ls = jsFuncs := foldl (fn ((k, v), m) => M.insert (m, k, v)) jsFuncsBase ls
adamc@765 194 fun jsFunc x = M.find (!jsFuncs, x)
adamc@765 195
adamc@768 196 datatype pattern_kind = Exact | Prefix
adamc@768 197 datatype action = Allow | Deny
adamc@768 198 type rule = { action : action, kind : pattern_kind, pattern : string }
adamc@768 199
adamc@768 200 datatype path_kind = Any | Url | Table | Sequence | View | Relation | Cookie | Style
adamc@768 201 type rewrite = { pkind : path_kind, kind : pattern_kind, from : string, to : string }
adamc@768 202
adamc@768 203 val rewrites = ref ([] : rewrite list)
adamc@768 204
adamc@768 205 fun subsume (pk1, pk2) =
adamc@768 206 pk1 = pk2
adamc@768 207 orelse pk2 = Any
adamc@768 208 orelse pk2 = Relation andalso (pk1 = Table orelse pk1 = Sequence orelse pk1 = View)
adamc@768 209
adamc@768 210 fun setRewriteRules ls = rewrites := ls
adamc@768 211 fun rewrite pk s =
adamc@768 212 let
adamc@768 213 fun rew (ls : rewrite list) =
adamc@768 214 case ls of
adamc@768 215 [] => s
adamc@768 216 | rewr :: ls =>
adamc@768 217 let
adamc@768 218 fun match () =
adamc@768 219 case #kind rewr of
adamc@768 220 Exact => if #from rewr = s then
adamc@768 221 SOME (size s)
adamc@768 222 else
adamc@768 223 NONE
adamc@768 224 | Prefix => if String.isPrefix (#from rewr) s then
adamc@768 225 SOME (size (#from rewr))
adamc@768 226 else
adamc@768 227 NONE
adamc@768 228 in
adamc@768 229 if subsume (pk, #pkind rewr) then
adamc@768 230 case match () of
adamc@768 231 NONE => rew ls
adamc@768 232 | SOME suffixStart => #to rewr ^ String.extract (s, suffixStart, NONE)
adamc@768 233 else
adamc@768 234 rew ls
adamc@768 235 end
adamc@768 236 in
adamc@768 237 rew (!rewrites)
adamc@768 238 end
adamc@768 239
adamc@769 240 val url = ref ([] : rule list)
adamc@769 241 val mime = ref ([] : rule list)
adamc@769 242
adamc@769 243 fun setUrlRules ls = url := ls
adamc@769 244 fun setMimeRules ls = mime := ls
adamc@769 245
adamc@770 246 fun getUrlRules () = !url
adamc@770 247 fun getMimeRules () = !mime
adamc@770 248
adamc@769 249 fun check f rules s =
adamc@769 250 let
adamc@769 251 fun chk (ls : rule list) =
adamc@769 252 case ls of
adamc@769 253 [] => false
adamc@769 254 | rule :: ls =>
adamc@769 255 let
adamc@769 256 val matches =
adamc@769 257 case #kind rule of
adamc@769 258 Exact => #pattern rule = s
adamc@769 259 | Prefix => String.isPrefix (#pattern rule) s
adamc@769 260 in
adamc@769 261 if matches then
adamc@769 262 case #action rule of
adamc@769 263 Allow => true
adamc@769 264 | Deny => false
adamc@769 265 else
adamc@769 266 chk ls
adamc@769 267 end
adamc@769 268 in
adamc@769 269 f s andalso chk (!rules)
adamc@769 270 end
adamc@769 271
adamc@769 272 val checkUrl = check (fn _ => true) url
adamc@769 273 val checkMime = check
adamc@769 274 (CharVector.all (fn ch => Char.isAlphaNum ch orelse ch = #"/" orelse ch = #"-" orelse ch = #"."))
adamc@769 275 mime
adamc@769 276
adamc@855 277
adamc@855 278 type protocol = {
adamc@855 279 name : string,
adamc@1096 280 compile : string,
adamc@1095 281 linkStatic : string,
adamc@1095 282 linkDynamic : string,
adamc@1164 283 persistent : bool,
adamc@1164 284 code : unit -> Print.PD.pp_desc
adamc@855 285 }
adamc@855 286 val protocols = ref ([] : protocol list)
adamc@855 287 fun addProtocol p = protocols := p :: !protocols
adamc@855 288 fun getProtocol s = List.find (fn p => #name p = s) (!protocols)
adamc@855 289
adamc@855 290 fun clibFile s = OS.Path.joinDirFile {dir = Config.libC,
adamc@855 291 file = s}
adamc@855 292
adamc@865 293 val curProto = ref {name = "",
adamc@1096 294 compile = "",
adamc@1095 295 linkStatic = "",
adamc@1095 296 linkDynamic = "",
adamc@1164 297 persistent = false,
adamc@1164 298 code = fn () => Print.box []}
adamc@856 299 fun setProtocol name =
adamc@856 300 case getProtocol name of
adamc@856 301 NONE => raise Fail ("Unknown protocol " ^ name)
adamc@856 302 | SOME p => curProto := p
adamc@855 303 fun currentProtocol () = !curProto
adamc@855 304
adamc@857 305 val debug = ref false
adamc@857 306 fun setDebug b = debug := b
adamc@857 307 fun getDebug () = !debug
adamc@857 308
adamc@867 309 datatype sql_type =
adamc@867 310 Int
adamc@867 311 | Float
adamc@867 312 | String
adamc@1011 313 | Char
adamc@867 314 | Bool
adamc@867 315 | Time
adamc@867 316 | Blob
adamc@867 317 | Channel
adamc@867 318 | Client
adamc@867 319 | Nullable of sql_type
adamc@867 320
adamc@873 321 fun p_sql_ctype t =
adamc@867 322 let
adamc@867 323 open Print.PD
adamc@867 324 open Print
adamc@867 325 in
adamc@867 326 case t of
adamc@870 327 Int => "uw_Basis_int"
adamc@870 328 | Float => "uw_Basis_float"
adamc@870 329 | String => "uw_Basis_string"
adamc@1011 330 | Char => "uw_Basis_char"
adamc@870 331 | Bool => "uw_Basis_bool"
adamc@870 332 | Time => "uw_Basis_time"
adamc@870 333 | Blob => "uw_Basis_blob"
adamc@870 334 | Channel => "uw_Basis_channel"
adamc@870 335 | Client => "uw_Basis_client"
adamc@870 336 | Nullable String => "uw_Basis_string"
adamc@873 337 | Nullable t => p_sql_ctype t ^ "*"
adamc@867 338 end
adamc@867 339
adamc@867 340 fun isBlob Blob = true
adamc@867 341 | isBlob (Nullable t) = isBlob t
adamc@867 342 | isBlob _ = false
adamc@867 343
adamc@870 344 fun isNotNull (Nullable _) = false
adamc@870 345 | isNotNull _ = true
adamc@870 346
adamc@866 347 type dbms = {
adamc@866 348 name : string,
adamc@866 349 header : string,
adamc@866 350 link : string,
adamc@873 351 p_sql_type : sql_type -> string,
adamc@870 352 init : {dbstring : string,
adamc@870 353 prepared : (string * int) list,
adamc@870 354 tables : (string * (string * sql_type) list) list,
adamc@872 355 views : (string * (string * sql_type) list) list,
adamc@870 356 sequences : string list} -> Print.PD.pp_desc,
adamc@873 357 query : {loc : ErrorMsg.span, cols : sql_type list,
adamc@880 358 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int, typ : sql_type} -> Print.PD.pp_desc)
adamc@867 359 -> Print.PD.pp_desc}
adamc@867 360 -> Print.PD.pp_desc,
adamc@867 361 queryPrepared : {loc : ErrorMsg.span, id : int, query : string,
adamc@873 362 inputs : sql_type list, cols : sql_type list,
adamc@880 363 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int,
adamc@880 364 typ : sql_type} -> Print.PD.pp_desc)
adamc@879 365 -> Print.PD.pp_desc,
adamc@879 366 nested : bool}
adamc@868 367 -> Print.PD.pp_desc,
adamc@868 368 dml : ErrorMsg.span -> Print.PD.pp_desc,
adamc@868 369 dmlPrepared : {loc : ErrorMsg.span, id : int, dml : string,
adamc@869 370 inputs : sql_type list} -> Print.PD.pp_desc,
adamc@878 371 nextval : {loc : ErrorMsg.span, seqName : string option, seqE : Print.PD.pp_desc} -> Print.PD.pp_desc,
adamc@874 372 nextvalPrepared : {loc : ErrorMsg.span, id : int, query : string} -> Print.PD.pp_desc,
adamc@1073 373 setval : {loc : ErrorMsg.span, seqE : Print.PD.pp_desc, count : Print.PD.pp_desc} -> Print.PD.pp_desc,
adamc@874 374 sqlifyString : string -> string,
adamc@874 375 p_cast : string * sql_type -> string,
adamc@874 376 p_blank : int * sql_type -> string,
adamc@877 377 supportsDeleteAs : bool,
adamc@886 378 supportsUpdateAs : bool,
adamc@877 379 createSequence : string -> string,
adamc@878 380 textKeysNeedLengths : bool,
adamc@879 381 supportsNextval : bool,
adamc@882 382 supportsNestedPrepared : bool,
adamc@890 383 sqlPrefix : string,
adamc@1014 384 supportsOctetLength : bool,
adamc@1014 385 trueString : string,
adamc@1014 386 falseString : string
adamc@866 387 }
adamc@866 388
adamc@866 389 val dbmses = ref ([] : dbms list)
adamc@866 390 val curDb = ref ({name = "",
adamc@866 391 header = "",
adamc@866 392 link = "",
adamc@873 393 p_sql_type = fn _ => "",
adamc@867 394 init = fn _ => Print.box [],
adamc@867 395 query = fn _ => Print.box [],
adamc@868 396 queryPrepared = fn _ => Print.box [],
adamc@868 397 dml = fn _ => Print.box [],
adamc@869 398 dmlPrepared = fn _ => Print.box [],
adamc@869 399 nextval = fn _ => Print.box [],
adamc@874 400 nextvalPrepared = fn _ => Print.box [],
adamc@1073 401 setval = fn _ => Print.box [],
adamc@874 402 sqlifyString = fn s => s,
adamc@874 403 p_cast = fn _ => "",
adamc@874 404 p_blank = fn _ => "",
adamc@877 405 supportsDeleteAs = false,
adamc@886 406 supportsUpdateAs = false,
adamc@877 407 createSequence = fn _ => "",
adamc@878 408 textKeysNeedLengths = false,
adamc@879 409 supportsNextval = false,
adamc@882 410 supportsNestedPrepared = false,
adamc@890 411 sqlPrefix = "",
adamc@1014 412 supportsOctetLength = false,
adamc@1014 413 trueString = "",
adamc@1014 414 falseString = ""} : dbms)
adamc@866 415
adamc@866 416 fun addDbms v = dbmses := v :: !dbmses
adamc@866 417 fun setDbms s =
adamc@866 418 case List.find (fn db => #name db = s) (!dbmses) of
adamc@866 419 NONE => raise Fail ("Unknown DBMS " ^ s)
adamc@866 420 | SOME db => curDb := db
adamc@866 421 fun currentDbms () = !curDb
adamc@866 422
adamc@891 423 val dbstring = ref (NONE : string option)
adamc@891 424 fun setDbstring so = dbstring := so
adamc@891 425 fun getDbstring () = !dbstring
adamc@891 426
adamc@891 427 val exe = ref (NONE : string option)
adamc@891 428 fun setExe so = exe := so
adamc@891 429 fun getExe () = !exe
adamc@891 430
adamc@891 431 val sql = ref (NONE : string option)
adamc@891 432 fun setSql so = sql := so
adamc@891 433 fun getSql () = !sql
adamc@891 434
adamc@1016 435 val coreInline = ref 20
adamc@1016 436 fun setCoreInline n = coreInline := n
adamc@1016 437 fun getCoreInline () = !coreInline
adamc@1016 438
adamc@1016 439 val monoInline = ref 20
adamc@1016 440 fun setMonoInline n = monoInline := n
adamc@1016 441 fun getMonoInline () = !monoInline
adamc@1016 442
adamc@1095 443 val staticLinking = ref false
adamc@1095 444 fun setStaticLinking b = staticLinking := b
adamc@1095 445 fun getStaticLinking () = !staticLinking
adamc@1095 446
adamc@1114 447 val deadlines = ref false
adamc@1114 448 fun setDeadlines b = deadlines := b
adamc@1114 449 fun getDeadlines () = !deadlines
adamc@1114 450
adamc@1164 451 val sigFile = ref (NONE : string option)
adamc@1164 452 fun setSigFile v = sigFile := v
adamc@1164 453 fun getSigFile () = !sigFile
adamc@1164 454
adamc@1183 455 structure SS = BinarySetFn(struct
adamc@1183 456 type ord_key = string
adamc@1183 457 val compare = String.compare
adamc@1183 458 end)
adamc@1183 459
adamc@1183 460 val safeGet = ref SS.empty
adamc@1183 461 fun setSafeGets ls = safeGet := SS.addList (SS.empty, ls)
adamc@1183 462 fun isSafeGet x = SS.member (!safeGet, x)
adamc@1183 463
adamc@765 464 end