Fix ee10 path info only (alternative) (#9934)

Fix ee10 path info only Signed-off-by: Ludovic Orban <[email protected]> Co-authored-by: Jan Bartel <[email protected]>
jetty · Jun 21, 2023 · b9ca6d2 · b9ca6d2
1 parent 5116039
commit b9ca6d2
Show file tree

Hide file tree

Showing 6 changed files with 74 additions and 22 deletions.
diff --git a/jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/ResourceService.java b/jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/ResourceService.java
@@ -440,11 +440,12 @@ private String matchesEtag(String contentETag, String requestEtag)
 
     protected void sendWelcome(HttpContent content, String pathInContext, boolean endsWithSlash, Request request, Response response, Callback callback) throws Exception
     {
+        if (!Objects.requireNonNull(content).getResource().isDirectory())
+            throw new IllegalArgumentException("content must be a directory");
+
         if (LOG.isDebugEnabled())
-        {
             LOG.debug("sendWelcome(content={}, pathInContext={}, endsWithSlash={}, req={}, resp={}, callback={})",
                 content, pathInContext, endsWithSlash, request, response, callback);
-        }
 
         // Redirect to directory
         if (!endsWithSlash)
@@ -460,7 +461,7 @@ protected void sendWelcome(HttpContent content, String pathInContext, boolean en
         }
 
         // process optional Welcome behaviors
-        if (welcome(request, response, callback))
+        if (welcome(content, request, response, callback))
             return;
 
         if (!passConditionalHeaders(request, response, content, callback))
@@ -499,9 +500,9 @@ public record WelcomeAction(String target, WelcomeMode mode)
     {
     }
 
-    private boolean welcome(Request request, Response response, Callback callback) throws Exception
+    private boolean welcome(HttpContent content, Request request, Response response, Callback callback) throws Exception
     {
-        WelcomeAction welcomeAction = processWelcome(request);
+        WelcomeAction welcomeAction = processWelcome(content, request);
         if (LOG.isDebugEnabled())
             LOG.debug("welcome(req={}, rsp={}, cbk={}) welcomeAction={}", request, response, callback, welcomeAction);
 
@@ -581,9 +582,9 @@ protected void rehandleWelcome(Request request, Response response, Callback call
         Response.writeError(request, response, callback, HttpStatus.INTERNAL_SERVER_ERROR_500);
     }
 
-    private WelcomeAction processWelcome(Request request) throws IOException
+    private WelcomeAction processWelcome(HttpContent content, Request request) throws IOException
     {
-        String welcomeTarget = getWelcomeFactory().getWelcomeTarget(request);
+        String welcomeTarget = getWelcomeFactory().getWelcomeTarget(content, request);
         if (welcomeTarget == null)
             return null;
 
@@ -892,7 +893,7 @@ public interface WelcomeFactory
          * @return The URI path of the matching welcome target in context or null
          * if no welcome target was found
          */
-        String getWelcomeTarget(Request request) throws IOException;
+        String getWelcomeTarget(HttpContent content, Request request) throws IOException;
     }
 
     private static class ContentWriterIteratingCallback extends IteratingCallback

diff --git a/jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ResourceHandler.java b/jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ResourceHandler.java
@@ -122,7 +122,7 @@ protected HttpContent.Factory newHttpContentFactory()
 
     protected ResourceService.WelcomeFactory setupWelcomeFactory()
     {
-        return request ->
+        return (content, request) ->
         {
             if (_welcomes == null)
                 return null;
@@ -131,7 +131,7 @@ protected ResourceService.WelcomeFactory setupWelcomeFactory()
             {
                 String pathInContext = Request.getPathInContext(request);
                 String welcomeInContext = URIUtil.addPaths(pathInContext, welcome);
-                Resource welcomePath = _baseResource.resolve(pathInContext).resolve(welcome);
+                Resource welcomePath = content.getResource().resolve(welcome);
                 if (Resources.isReadableFile(welcomePath))
                     return welcomeInContext;
             }

diff --git a/...-ee10/jetty-ee10-servlet/src/main/java/org/eclipse/jetty/ee10/servlet/DefaultServlet.java b/...-ee10/jetty-ee10-servlet/src/main/java/org/eclipse/jetty/ee10/servlet/DefaultServlet.java
@@ -1015,23 +1015,14 @@ private ServletResourceService(ServletContextHandler servletContextHandler)
         }
 
         @Override
-        public String getWelcomeTarget(Request coreRequest)
+        public String getWelcomeTarget(HttpContent content, Request coreRequest)
         {
             String[] welcomes = _servletContextHandler.getWelcomeFiles();
             if (welcomes == null)
                 return null;
-
-            HttpServletRequest request = getServletRequest(coreRequest);
             String pathInContext = Request.getPathInContext(coreRequest);
-            String includedServletPath = (String)request.getAttribute(RequestDispatcher.INCLUDE_SERVLET_PATH);
-            String requestTarget;
-            if (includedServletPath != null)
-                requestTarget = getIncludedPathInContext(request, includedServletPath, isPathInfoOnly());
-            else
-                requestTarget = isPathInfoOnly() ? request.getPathInfo() : pathInContext;
-
             String welcomeTarget = null;
-            Resource base = _baseResource.resolve(requestTarget);
+            Resource base = content.getResource();
             if (Resources.isReadableDirectory(base))
             {
                 for (String welcome : welcomes)
@@ -1040,13 +1031,16 @@ public String getWelcomeTarget(Request coreRequest)
 
                     // If the welcome resource is a file, it has
                     // precedence over resources served by Servlets.
-                    Resource welcomePath = base.resolve(welcome);
+                    Resource welcomePath = content.getResource().resolve(welcome);
                     if (Resources.isReadableFile(welcomePath))
                         return welcomeInContext;
 
                     // Check whether a Servlet may serve the welcome resource.
                     if (_welcomeServletMode != WelcomeServletMode.NONE && welcomeTarget == null)
                     {
+                        if (isPathInfoOnly() && !isIncluded(getServletRequest(coreRequest)))
+                            welcomeTarget = URIUtil.addPaths(getServletRequest(coreRequest).getPathInfo(), welcome);
+
                         ServletHandler.MappedServlet entry = _servletContextHandler.getServletHandler().getMappedServlet(welcomeInContext);
                         // Is there a different Servlet that may serve the welcome resource?
                         if (entry != null && entry.getServletHolder().getServletInstance() != DefaultServlet.this)

diff --git a/...0/jetty-ee10-servlet/src/test/java/org/eclipse/jetty/ee10/servlet/DefaultServletTest.java b/...0/jetty-ee10-servlet/src/test/java/org/eclipse/jetty/ee10/servlet/DefaultServletTest.java
@@ -3185,6 +3185,63 @@ public void destroy()
         }
     }
 
+    @Test
+    public void testPathInfoOnly() throws Exception
+    {
+        ServletContextHandler context = new ServletContextHandler(null, "/c1", ServletContextHandler.NO_SESSIONS);
+        context.setWelcomeFiles(new String[]{"index.y", "index.x"});
+        ServletHolder indexServlet = new ServletHolder("index-servlet", new HttpServlet()
+        {
+            @Override
+            protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException
+            {
+                resp.setContentType("text/plain");
+                resp.setCharacterEncoding("UTF-8");
+                resp.getWriter().println(req.getRequestURI());
+                resp.getWriter().println("testPathInfoOnly-OK");
+                resp.getWriter().close();
+            }
+        });
+
+        ServletMapping indexMapping = new ServletMapping();
+        indexMapping.setServletName("index-servlet");
+        indexMapping.setPathSpecs(new String[]{"*.x", "*.y"});
+        context.getServletHandler().addServlet(indexServlet);
+        context.getServletHandler().addServletMapping(indexMapping);
+
+        Path pathTest = MavenTestingUtils.getTestResourcePath("pathTest");
+
+        Path defaultDir = pathTest.resolve("default");
+        ServletHolder slashHolder = new ServletHolder("default", new DefaultServlet());
+        slashHolder.setInitParameter("redirectWelcome", "false");
+        slashHolder.setInitParameter("welcomeServlets", "true");
+        slashHolder.setInitParameter("pathInfoOnly", "false");
+        slashHolder.setInitParameter("baseResource", defaultDir.toAbsolutePath().toString());
+        context.addServlet(slashHolder, "/");
+
+        Path rDir = pathTest.resolve("rdir");
+        ServletHolder rHolder = new ServletHolder("rdefault", new DefaultServlet());
+        rHolder.setInitParameter("redirectWelcome", "false");
+        rHolder.setInitParameter("welcomeServlets", "true");
+        rHolder.setInitParameter("pathInfoOnly", "true");
+        rHolder.setInitParameter("baseResource", rDir.toAbsolutePath().toString());
+        context.addServlet(rHolder, "/r/*");
+
+        server.stop();
+        server.setHandler(context);
+        server.start();
+        String rawRequest = """
+            GET /c1/r/ HTTP/1.1\r
+            Host: localhost\r
+            Connection: close\r
+            \r
+            """;
+
+        String rawResponse = connector.getResponse(rawRequest);
+        HttpTester.Response response = HttpTester.parseResponse(rawResponse);
+        assertThat(response.getContent(), containsString("testPathInfoOnly-OK"));
+    }
+
     public static class WriterFilter implements Filter
     {
         @Override

diff --git a/jetty-ee10/jetty-ee10-servlet/src/test/resources/pathTest/default/dot b/jetty-ee10/jetty-ee10-servlet/src/test/resources/pathTest/default/dot
diff --git a/jetty-ee10/jetty-ee10-servlet/src/test/resources/pathTest/rdir/dot b/jetty-ee10/jetty-ee10-servlet/src/test/resources/pathTest/rdir/dot