deprecate local_file -> resolve_path

Author: haf

Experimental/Template.fs

@@ -107,7 +107,7 @@ open Types
 /// write the exception as a string to a 500 Internal Error response.
 let process_template (data : Map<string,Binder>) ({ request = http_request; runtime = runtime } as ctx : HttpContext) =
   try
-    let xmlReader = new XmlTextReader(Files.local_file http_request.url runtime.home_directory)
+    let xmlReader = new XmlTextReader(Files.resolve_path runtime.home_directory http_request.url)
     xmlReader.Namespaces <- false
 
     let transform = parser xmlReader (Xml [])

Suave/Http.fs

@@ -468,7 +468,7 @@ module Http =
         (Path.GetExtension)
         send_file
 
-    let local_file (file_name : string) (root_path : string) =
+    let resolve_path (root_path : string) (file_name : string) =
       let file_name =
         if Path.DirectorySeparatorChar.Equals('/') then file_name
         else file_name.Replace('/', Path.DirectorySeparatorChar)
@@ -479,9 +479,12 @@ module Http =
         else raise <| Exception("File canonalization issue.")
       else raise <| Exception("File canonalization issue.")
 
+    [<Obsolete("Use resolve_path")>]
+    let local_file file_name root_path = resolve_path root_path file_name
+
     let browse_file root_path file_name =
       fun ({request = r; runtime = q} as h) ->
-        file (local_file file_name root_path) h
+        file (resolve_path root_path file_name) h
 
     let browse_file' file_name =
       fun ({request = r; runtime = q} as h) ->
@@ -494,7 +497,7 @@ module Http =
           Log.TraceHeader.empty
           (sprintf "Files.browse trying file (local_file url:'%s' root:'%s')"
             r.url root_path)
-        file (local_file r.url root_path))
+        file (resolve_path root_path r.url))
 
     let browse' : WebPart =
       warbler (fun { runtime = q } -> browse q.home_directory)
@@ -504,7 +507,7 @@ module Http =
 
       let url = req.url
 
-      let dirname = local_file url root_path
+      let dirname = resolve_path root_path url
       let result = new StringBuilder()
 
       let filesize  (x : FileSystemInfo) =

Suave/Http.fsi

@@ -1341,6 +1341,11 @@ module Http =
     /// <remarks>
     /// The current implementation doesn't take kindly to relative paths.
     /// </remarks>
+    val resolve_path : root_path:string -> file_name:string -> string
+
+    /// Deprecated: use `resolve_path` and swap the arguments' positions. It
+    /// has been deprecated so that you can curry the root_path in your function
+    /// scope, with the root path.
     val local_file : file_name:string -> root_path:string -> string
 
     /// <summary><para>

Tests/HttpFile.fs

@@ -17,7 +17,7 @@ let ``canonicalization attacks`` =
     testCase "should throw" <| fun _ ->
       Assert.Raise("'../../passwd' is not a valid path",
         typeof<Exception>,
-        fun _ -> Files.local_file "../../passwd" current_path |> ignore)
+        fun _ -> Files.resolve_path current_path "../../passwd" |> ignore)
   ]
 
 [<Tests>]