Merge pull request #80 from prime-framework/degroff/file_manager_mainline

merge / copy over changes from 4.x maintenance

Author: robotdan

build.savant

@@ -19,7 +19,7 @@ dropWizardVersion = "3.2.6"
 easyMockVersion = "5.2.0"
 freemarkerVersion = "2.3.32"
 fusionAuthJWTVersion = "5.3.2"
-javaHTTPVersion = "1.0.0"
+javaHTTPVersion = "1.1.0"
 jsonPatchVersion = "1.13.0"
 guavaVersion = "32.1.2-jre"
 guiceVersion = "6.0.0"
@@ -29,7 +29,7 @@ logbackVersion = "1.4.14"
 slf4jVersion = "2.0.13"
 testngVersion = "7.8.0"
 
-project(group: "org.primeframework", name: "prime-mvc", version: "5.0.0", licenses: ["ApacheV2_0"]) {
+project(group: "org.primeframework", name: "prime-mvc", version: "5.1.0", licenses: ["ApacheV2_0"]) {
   workflow {
     fetch {
       // Dependency resolution order:

pom.xml

@@ -5,7 +5,7 @@
 
   <groupId>org.primeframework</groupId>
   <artifactId>prime-mvc</artifactId>
-  <version>5.0.0</version>
+  <version>5.1.0</version>
   <packaging>jar</packaging>
 
   <name>FusionAuth App</name>
@@ -109,7 +109,7 @@
     <dependency>
       <groupId>io.fusionauth</groupId>
       <artifactId>java-http</artifactId>
-      <version>1.0.0</version>
+      <version>1.1.0</version>
       <type>jar</type>
       <scope>compile</scope>
       <optional>false</optional>

prime-mvc.iml

@@ -126,11 +126,11 @@
     <orderEntry type="module-library">
       <library>
         <CLASSES>
-          <root url="jar://$MODULE_DIR$/.savant/cache/io/fusionauth/java-http/1.0.0/java-http-1.0.0.jar!/" />
+          <root url="jar://$MODULE_DIR$/.savant/cache/io/fusionauth/java-http/1.1.0/java-http-1.1.0.jar!/" />
         </CLASSES>
         <JAVADOC />
         <SOURCES>
-          <root url="jar://$MODULE_DIR$/.savant/cache/io/fusionauth/java-http/1.0.0/java-http-1.0.0-src.jar!/" />
+          <root url="jar://$MODULE_DIR$/.savant/cache/io/fusionauth/java-http/1.1.0/java-http-1.1.0-src.jar!/" />
         </SOURCES>
       </library>
     </orderEntry>

src/main/java/org/primeframework/mvc/BasePrimeMain.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021-2023, Inversoft Inc., All Rights Reserved
+ * Copyright (c) 2021-2025, Inversoft Inc., All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@
 import com.google.inject.Module;
 import io.fusionauth.http.server.HTTPServer;
 import io.fusionauth.http.server.HTTPServerConfiguration;
+import org.primeframework.mvc.config.MVCConfiguration;
 import org.primeframework.mvc.guice.GuiceBootstrap;
 import org.primeframework.mvc.log.SLF4JLoggerFactoryAdapter;
 
@@ -107,6 +108,19 @@ public void start() {
       // Set the logger factory for the server.
       configureLoggerFactory(config);
 
+      // prime and the HTTP server both have a configuration for max file size on an upload request.
+      // - Ensure they are compatible.
+      // Note that the prime-mvc check must wait for the file to be written to disk, so it does not keep the file from being written.
+      //   It waits until the file is written by the HTTP server and then fails nicely to let the end user know it is too big.
+      // Note that the java-http check will be performed during upload, so if it fails, the prime-mvc request handler may or may not complete. This
+      //   will depend upon when the request body is read which is up to the request handler.
+      MVCConfiguration mvcConfiguration = injector.getInstance(MVCConfiguration.class);
+      long mvcMaxFileSize = mvcConfiguration.fileUploadMaxSize();
+      long httpMaxFileSize = config.getMultipartConfiguration().getMaxFileSize();
+      if (mvcMaxFileSize < httpMaxFileSize) {
+        throw new IllegalStateException("MVCConfiguration.fileUploadMaxSize must be greater than or equal to the HTTP server configuration. Prime MVC configuration [" + mvcMaxFileSize + "] HTTP server configuration [" + httpMaxFileSize + "]");
+      }
+
       // Create the server
       var server = new HTTPServer().withConfiguration(config)
                                    .withHandler(requestHandler)

src/main/java/org/primeframework/mvc/action/ActionMapper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001-2007, Inversoft Inc., All Rights Reserved
+ * Copyright (c) 2001-2025, Inversoft Inc., All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,11 +26,9 @@ public interface ActionMapper {
   /**
    * Maps the given URI to an action invocation.
    *
-   * @param httpMethod    The HTTP method being invoked.
-   * @param uri           The URI.
-   * @param executeResult This flag is set into the ActionInvocation to control whether or not the result is executed or
-   *                      not.
+   * @param httpMethod The HTTP method being invoked.
+   * @param uri        The URI.
    * @return The action invocation and never null. This invocation might be a redirect for index handling.
    */
-  ActionInvocation map(HTTPMethod httpMethod, String uri, boolean executeResult);
-}
+  ActionInvocation map(HTTPMethod httpMethod, String uri);
+}

src/main/java/org/primeframework/mvc/action/DefaultActionMapper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001-2020, Inversoft Inc., All Rights Reserved
+ * Copyright (c) 2001-2025, Inversoft Inc., All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -43,7 +43,7 @@ public DefaultActionMapper(ActionConfigurationProvider actionConfigurationProvid
   /**
    * {@inheritDoc}
    */
-  public ActionInvocation map(HTTPMethod httpMethod, String uri, boolean executeResult) {
+  public ActionInvocation map(HTTPMethod httpMethod, String uri) {
     ActionInvocation invocation = actionConfigurationProvider.lookup(uri);
     if (invocation.configuration == null && !uri.endsWith("/")) {
       // Do an index check but if it doesn't return a valid invocation, then return the original one from above.
@@ -70,4 +70,4 @@ public ActionInvocation map(HTTPMethod httpMethod, String uri, boolean executeRe
 
     return invocation;
   }
-}
+}

src/main/java/org/primeframework/mvc/action/DefaultActionMappingWorkflow.java

@@ -22,12 +22,14 @@
 import com.codahale.metrics.Timer;
 import com.google.inject.Inject;
 import io.fusionauth.http.HTTPMethod;
+import io.fusionauth.http.io.MultipartConfiguration;
+import io.fusionauth.http.io.MultipartFileUploadPolicy;
 import io.fusionauth.http.server.HTTPRequest;
 import io.fusionauth.http.server.HTTPResponse;
 import org.primeframework.mvc.NotAllowedException;
 import org.primeframework.mvc.http.HTTPTools;
 import org.primeframework.mvc.http.Status;
-import org.primeframework.mvc.parameter.InternalParameters;
+import org.primeframework.mvc.parameter.fileupload.annotation.FileUpload;
 import org.primeframework.mvc.workflow.WorkflowChain;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -74,8 +76,7 @@ public void perform(WorkflowChain chain) throws IOException {
     }
 
     HTTPMethod method = request.getMethod();
-    boolean executeResult = InternalParameters.is(request, InternalParameters.EXECUTE_RESULT);
-    ActionInvocation actionInvocation = actionMapper.map(method, uri, executeResult);
+    ActionInvocation actionInvocation = actionMapper.map(method, uri);
 
     // This case is a redirect because the URI maps to something new and there isn't an action associated with it. For
     // example, this is how the index handling works.
@@ -95,6 +96,9 @@ public void perform(WorkflowChain chain) throws IOException {
       throw new NotAllowedException();
     }
 
+    // Handle multipart file configuration
+    handleMultiPartConfiguration(actionInvocation);
+
     // Start the timers and grab some meters for errors
     Timer.Context perPathTimer = null;
     Timer.Context aggregateTimer = null;
@@ -147,4 +151,45 @@ private String determineURI() {
 
     return uri;
   }
+
+  private void handleMultiPartConfiguration(ActionInvocation actionInvocation) {
+    if (actionInvocation.configuration == null) {
+      return;
+    }
+
+    // Note that multipart file handling is disabled by default. Enable it if the action has indicated it is expecting a file upload.
+    // - It is possible the default has been changed. This is ok, if the action invocation is not expecting any files, keep the default as configured
+    //   by the implementation.
+    boolean expectingFileUploads = !actionInvocation.configuration.fileUploadMembers.isEmpty();
+    if (!expectingFileUploads) {
+      return;
+    }
+
+    MultipartConfiguration multipartConfiguration = request.getMultiPartStreamProcessor().getMultiPartConfiguration();
+    multipartConfiguration.withFileUploadPolicy(MultipartFileUploadPolicy.Allow);
+
+    // Take the largest configured file size, or if none have specified a max file size, use the configured default.
+    long configuredMaxFileSize = multipartConfiguration.getMaxFileSize();
+    var fileUploadMembers = actionInvocation.configuration.fileUploadMembers;
+    long maxFileSize = fileUploadMembers.values().stream()
+                                        .map(FileUpload::maxSize)
+                                        .filter(m -> m != -1)
+                                        .max(Long::compareTo)
+                                        .orElse(configuredMaxFileSize);
+    multipartConfiguration.withMaxFileSize(maxFileSize);
+
+    // If each file specifies a max size, then this will be the sum. It may also be 0 if no FileUpload members specified a max size.
+    long expectedFileSizes = fileUploadMembers.values().stream()
+                                              .map(FileUpload::maxSize)
+                                              .filter(m -> m != -1)
+                                              .count();
+    long calculatedExpectedFileSize = maxFileSize * fileUploadMembers.size();
+
+    // Take the larger of the two and add 1MB
+    // - The 1MB is just a guess, and provides some overhead for anything else in the request body such as form-data.
+    long adjustedMaxRequestSize = Math.max(expectedFileSizes, calculatedExpectedFileSize) + (1024 * 1024);
+    if (Math.max(expectedFileSizes, calculatedExpectedFileSize) > multipartConfiguration.getMaxRequestSize()) {
+      multipartConfiguration.withMaxRequestSize(adjustedMaxRequestSize);
+    }
+  }
 }

src/main/java/org/primeframework/mvc/action/guice/ActionModule.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, Inversoft Inc., All Rights Reserved
+ * Copyright (c) 2012-2025, Inversoft Inc., All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@
 
 import com.google.inject.AbstractModule;
 import com.google.inject.Singleton;
+import com.google.inject.multibindings.MapBinder;
 import org.primeframework.mvc.action.ActionInvocationStore;
 import org.primeframework.mvc.action.ActionInvocationWorkflow;
 import org.primeframework.mvc.action.ActionMapper;
@@ -30,11 +31,13 @@
 import org.primeframework.mvc.action.config.ActionConfigurationProvider;
 import org.primeframework.mvc.action.config.DefaultActionConfigurationBuilder;
 import org.primeframework.mvc.action.config.DefaultActionConfigurationProvider;
+import org.primeframework.mvc.action.result.ActionResultDefinition;
 import org.primeframework.mvc.action.result.DefaultResourceLocator;
 import org.primeframework.mvc.action.result.DefaultResultInvocationWorkflow;
 import org.primeframework.mvc.action.result.ResourceLocator;
 import org.primeframework.mvc.action.result.ResultInvocationWorkflow;
 import org.primeframework.mvc.action.result.ResultStore;
+import org.primeframework.mvc.action.result.StatusActionResultDefinition;
 import org.primeframework.mvc.action.result.ThreadLocalResultStore;
 
 /**
@@ -51,6 +54,14 @@ protected void bindConfigurationProvider() {
     bind(ActionConfigurationProvider.class).to(DefaultActionConfigurationProvider.class).in(Singleton.class);
   }
 
+  protected void bindDefaultResultMappings() {
+    MapBinder<String, ActionResultDefinition> defaultResultMappings = MapBinder.newMapBinder(binder(), String.class, ActionResultDefinition.class);
+    defaultResultMappings.addBinding("not-allowed").toInstance(new StatusActionResultDefinition(405));
+    defaultResultMappings.addBinding("content-too-large").toInstance(new StatusActionResultDefinition(413));
+    defaultResultMappings.addBinding("unprocessable-content").toInstance(new StatusActionResultDefinition(422));
+    defaultResultMappings.addBinding("not-implemented").toInstance(new StatusActionResultDefinition(501));
+  }
+
   protected void bindMapper() {
     bind(ActionMapper.class).to(DefaultActionMapper.class);
   }
@@ -87,6 +98,9 @@ protected void configure() {
     bindConfigurationBuilder();
     bindConfigurationProvider();
 
+    // Default result mappings
+    bindDefaultResultMappings();
+
     // Invocation
     bindStore();
     bindWorkflow();

src/main/java/org/primeframework/mvc/action/result/AbstractForwardResult.java

@@ -153,7 +153,7 @@ private String buildFullyQualifiedPath(ActionInvocation actionInvocation, U forw
   private String locateDefault(ActionInvocation actionInvocation, U forward) {
     String page = resourceLocator.locate(configuration.templateDirectory());
     if (page == null) {
-      throw new PrimeException("Missing result for action class [" + actionInvocation.configuration.actionClass + "] URI [" +
+      throw new PrimeException("Missing result for action class [" + actionInvocation.configuration.actionClass.getName() + "] URI [" +
                                actionInvocation.uri() + "] and result code [" + getCode(forward) + "]");
     }
     return page;

src/main/java/org/primeframework/mvc/action/result/ActionResultDefinition.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2025, Inversoft Inc., All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+package org.primeframework.mvc.action.result;
+
+import java.lang.annotation.Annotation;
+
+/**
+ * An interface to define an action result definition. This can be bound and replace having to add a result annotation to each action.
+ *
+ * @author Daniel DeGroff
+ */
+public interface ActionResultDefinition {
+  /**
+   * @param resultCode the result code to use for the mapping
+   * @return the constructed annotation.
+   */
+  Annotation getAnnotation(String resultCode);
+
+  /**
+   * @return the status code for the HTTP response
+   */
+  int getStatus();
+}