Replace FileUpload 1.5 with FileUpload 2.0.0-M1

The Apache Commons FileUpload library has released 2.0.0-M1, the first
milestone release of 2.0.0. In this version, the core package of the
library no longer has a dependency on the Servlet API, which means we
can eliminate this problematic dependency from Ring core, once there
is a full release of FileUpload 2.0.0.

Author: weavejester

ring-core/project.clj

@@ -7,14 +7,12 @@
   :dependencies [[org.clojure/clojure "1.7.0"]
                  [ring/ring-codec "1.2.0"]
                  [commons-io "2.13.0"]
-                 [commons-fileupload "1.5"]
+                 [org.apache.commons/commons-fileupload2-core "2.0.0-M1"]
                  [crypto-random "1.2.1"]
                  [crypto-equality "1.0.1"]]
   :aliases {"test-all" ["with-profile" "default:+1.8:+1.9:+1.10:+1.11" "test"]}
   :profiles
-  {:provided {:dependencies [[javax.servlet/servlet-api "2.5"]]}
-   :dev  {:dependencies [[clj-time "0.15.2"]
-                         [javax.servlet/servlet-api "2.5"]]}
+  {:dev  {:dependencies [[clj-time "0.15.2"]]}
    :1.8  {:dependencies [[org.clojure/clojure "1.8.0"]]}
    :1.9  {:dependencies [[org.clojure/clojure "1.9.0"]]}
    :1.10 {:dependencies [[org.clojure/clojure "1.10.3"]]}

ring-core/src/ring/middleware/multipart_params.clj

@@ -11,11 +11,11 @@
             [ring.util.codec :refer [assoc-conj]]
             [ring.util.request :as req]
             [ring.util.parsing :as parsing])
-  (:import [org.apache.commons.fileupload
-            UploadContext
-            FileItemStream
-            FileUpload
-            FileUploadBase$FileUploadIOException
+  (:import [org.apache.commons.fileupload2.core
+            AbstractFileUpload
+            RequestContext
+            FileItemInput
+            FileUploadException
             ProgressListener]
            [org.apache.commons.io IOUtils]))
 
@@ -24,46 +24,47 @@
     (update [_ bytes-read content-length item-count]
       (progress-fn request bytes-read content-length item-count))))
 
-(defn- set-progress-listener [^FileUpload upload request progress-fn]
+(defn- set-progress-listener [^AbstractFileUpload upload request progress-fn]
   (when progress-fn
     (.setProgressListener upload (progress-listener request progress-fn))))
 
 (defn- file-upload [request {:keys [progress-fn max-file-size]}]
-  (doto (FileUpload.)
-    (.setFileSizeMax (or max-file-size -1))
+  (doto (proxy [AbstractFileUpload] [])
+    ;; There seems to be an off-by-one bug in FileUpload 2.0.0-M1 that requires
+    ;; us to increment the max-file-size option to get it to work correctly.
+    (.setFileSizeMax (if max-file-size (inc max-file-size) -1))
     (set-progress-listener request progress-fn)))
 
 (defn- multipart-form? [request]
   (= (req/content-type request) "multipart/form-data"))
 
-(defn- request-context ^UploadContext [request encoding]
-  (reify UploadContext
+(defn- request-context ^RequestContext [request encoding]
+  (reify RequestContext
     (getContentType [_]       (get-in request [:headers "content-type"]))
     (getContentLength [_]     (or (req/content-length request) -1))
-    (contentLength [_]        (or (req/content-length request) -1))
     (getCharacterEncoding [_] encoding)
     (getInputStream [_]       (:body request))))
 
-(defn- file-item-iterable [^FileUpload upload context]
+(defn- file-item-iterable [^AbstractFileUpload upload ^RequestContext context]
   (reify Iterable
     (iterator [_]
       (let [it (.getItemIterator upload context)]
         (reify java.util.Iterator
           (hasNext [_] (.hasNext it))
           (next [_] (.next it)))))))
 
-(defn- parse-content-type-charset [^FileItemStream item]
+(defn- parse-content-type-charset [^FileItemInput item]
   (some->> (.getContentType item) parsing/find-content-type-charset))
 
-(defn- parse-file-item [^FileItemStream item store]
+(defn- parse-file-item [^FileItemInput item store]
   {:field? (.isFormField item)
    :name   (.getFieldName item)
    :value  (if (.isFormField item)
-             {:bytes    (IOUtils/toByteArray (.openStream item))
+             {:bytes    (IOUtils/toByteArray (.getInputStream item))
               :encoding (parse-content-type-charset item)}
              (store {:filename     (.getName item)
                      :content-type (.getContentType item)
-                     :stream       (.openStream item)}))})
+                     :stream       (.getInputStream item)}))})
 
 (defn- find-param [params name]
   (first (filter #(= name (:name %)) params)))
@@ -133,7 +134,7 @@
   ((try
      (let [request (requestf)]
        #(handlef request))
-     (catch FileUploadBase$FileUploadIOException _
+     (catch FileUploadException _
        errorf)
      (catch clojure.lang.ExceptionInfo _
        errorf))))

ring-core/test/ring/middleware/test/multipart_params.clj

@@ -192,7 +192,7 @@
         handler       (constantly {:status 200, :headers {}, :body "OK"})
         handler-async (fn [_ respond _]
                         (respond {:status 200, :headers {}, :body "OK"}))]
-    (is (thrown? org.apache.commons.fileupload.FileUploadBase$FileUploadIOException
+    (is (thrown? org.apache.commons.fileupload2.core.FileUploadException
                  (multipart-params-request
                   {:headers headers, :body (string-input-stream form-body)}
                   {:max-file-size 6})))