Add option to disable index files served on paths that are not directories

Signed-off-by: Loukas Agorgianitis <loukas@agorgianitis.com>

doc/ring/static.md

@@ -55,13 +55,14 @@ This way, they are only served if none of the actual routes have matched.
 `reitit.ring/create-file-handler` and `reitit.ring/create-resource-handler` take optionally an options map to configure how the files are being served.
 
 | key                 | description |
-| -------------------|-------------|
+| --------------------|-------------|
 | :parameter          | optional name of the wildcard parameter, defaults to unnamed keyword `:`
 | :root               | optional resource root, defaults to `\"public\"`
 | :path               | path to mount the handler to. Required when mounted outside of a router, does not work inside a router.
 | :loader             | optional class loader to resolve the resources
 | :index-files        | optional vector of index-files to look in a resource directory, defaults to `[\"index.html\"]`
 | :index-redirect?    | optional boolean: if true (default), redirect to index file, if false serve it directly
+| :canonicalize-uris? | optional boolean: if true (default), try to serve index files for non directory paths (paths that end with slash)
 | :not-found-handler  | optional handler function to use if the requested resource is missing (404 Not Found)
 
 

modules/reitit-ring/src/reitit/ring.cljc

@@ -227,11 +227,12 @@
    ;; TODO: ring.middleware.head/wrap-head
    ;; TODO: handle etags
    (defn -create-file-or-resource-handler
-     [response-fn {:keys [parameter root path loader allow-symlinks? index-files index-redirect? paths not-found-handler]
+     [response-fn {:keys [parameter root path loader allow-symlinks? index-files index-redirect? canonicalize-uris? paths not-found-handler]
                    :or {parameter (keyword "")
                         root "public"
                         index-files ["index.html"]
                         index-redirect? true
+                        canonicalize-uris? true
                         paths (constantly nil)}}]
      (let [options {:root root
                     :loader loader
@@ -254,13 +255,14 @@
                         (response/content-type response (mime-type/ext-mime-type path))))
            path-or-index-response (fn [path uri]
                                     (or (response path)
+                                        (when (or canonicalize-uris? (str/ends-with? uri "/"))
                                           (loop [[file & files] index-files]
                                             (if file
                                               (if-let [resp (response (join-paths path file))]
                                                 (if index-redirect?
                                                   (response/redirect (join-paths uri file))
                                                   resp)
-                                              (recur files))))))
+                                                (recur files)))))))
            handler (if path
                      (fn [request]
                        (let [uri (impl/url-decode (:uri request))]
@@ -279,13 +281,14 @@
      "A ring handler for serving classpath resources, configured via options:
 
      | key                 | description |
-     | -------------------|-------------|
+     | --------------------|-------------|
      | :parameter          | optional name of the wildcard parameter, defaults to unnamed keyword `:`
      | :root               | optional resource root, defaults to `\"public\"`
      | :path               | path to mount the handler to. Required when mounted outside of a router, does not work inside a router.
      | :loader             | optional class loader to resolve the resources
      | :index-files        | optional vector of index-files to look in a resource directory, defaults to `[\"index.html\"]`
      | :index-redirect?    | optional boolean: if true (default), redirect to index file, if false serve it directly
+     | :canonicalize-uris? | optional boolean: if true (default), try to serve index files for non directory paths (paths that end with slash)
      | :not-found-handler  | optional handler function to use if the requested resource is missing (404 Not Found)"
      ([]
       (create-resource-handler nil))
@@ -297,13 +300,14 @@
      "A ring handler for serving file resources, configured via options:
 
      | key                 | description |
-     | -------------------|-------------|
+     | --------------------|-------------|
      | :parameter          | optional name of the wildcard parameter, defaults to unnamed keyword `:`
      | :root               | optional resource root, defaults to `\"public\"`
      | :path               | path to mount the handler to. Required when mounted outside of a router, does not work inside a router.
      | :loader             | optional class loader to resolve the resources
      | :index-files        | optional vector of index-files to look in a resource directory, defaults to `[\"index.html\"]`
      | :index-redirect?    | optional boolean: if true (default), redirect to index file, if false serve it directly
+     | :canonicalize-uris? | optional boolean: if true (default), try to serve index files for non directory paths (paths that end with slash)
      | :not-found-handler  | optional handler function to use if the requested resource is missing (404 Not Found)"
      ([]
       (create-file-handler nil))

test/cljc/reitit/ring_test.cljc

@@ -697,7 +697,31 @@
                    (is (= "<h1>hello</h1>\n" (slurp (:body response)))))
                  (let [response (app (request "/docs/"))]
                    (is (= 200 (:status response)))
-                   (is (= "<h1>hello</h1>\n" (slurp (:body response)))))))))))))
+                   (is (= "<h1>hello</h1>\n" (slurp (:body response))))))))
+
+           (testing "with canonicalize-uris"
+             (let [app (ring/ring-handler
+                        (ring/router
+                         ["/*" (create {:canonicalize-uris? true})])
+                        (ring/create-default-handler))]
+
+               (testing "index-files"
+                 (let [response (app (request "/docs"))]
+                   (is (= (redirect "/docs/index.html") response)))
+                 (let [response (app (request "/docs/"))]
+                   (is (= (redirect "/docs/index.html") response))))))
+
+           (testing "without canonicalize-uris"
+             (let [app (ring/ring-handler
+                        (ring/router
+                         ["/*" (create {:canonicalize-uris? false})])
+                        (ring/create-default-handler))]
+
+               (testing "index-files"
+                 (let [response (app (request "/docs"))]
+                   (is (= 404 (:status response))))
+                 (let [response (app (request "/docs/"))]
+                   (is (= (redirect "/docs/index.html") response)))))))))))
 
 #?(:clj
    (deftest file-resource-handler-not-found-test