util: Add support for GraalVM Native-Image resource:-URIs and Paths

jetty-core/jetty-util/src/main/java/org/eclipse/jetty/util/URIUtil.java

@@ -49,12 +49,6 @@
 public final class URIUtil
 {
     private static final Logger LOG = LoggerFactory.getLogger(URIUtil.class);
-    private static final Index<String> KNOWN_SCHEMES = new Index.Builder<String>()
-        .caseSensitive(false)
-        .with("file:")
-        .with("jrt:")
-        .with("jar:")
-        .build();
 
     // From https://www.rfc-editor.org/rfc/rfc3986
     private static final String UNRESERVED = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~";

jetty-core/jetty-util/src/main/java/org/eclipse/jetty/util/resource/NativeImagePathResource.java

@@ -0,0 +1,80 @@
+//
+// ========================================================================
+// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+// which is available at https://www.apache.org/licenses/LICENSE-2.0.
+//
+// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+// ========================================================================
+//
+
+package org.eclipse.jetty.util.resource;
+
+import java.net.URI;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+/**
+ * GraalVM Native-Image {@link Path} Resource.
+ */
+public class NativeImagePathResource extends PathResource
+{
+    private static final String URI_BAD_RESOURCE_PREFIX = "file:///resources!";
+
+    NativeImagePathResource(Path path, URI uri, boolean bypassAllowedSchemeCheck)
+    {
+        super(path, correctResourceURI(uri), (bypassAllowedSchemeCheck || isResourceScheme(uri)));
+    }
+
+    private static final boolean isResourceScheme(URI uri)
+    {
+        return "resource".equals(uri.getScheme());
+    }
+
+    /**
+     * Corrects any bad {@code resource} based URIs, such as those starting with {@code resource:file:///resources!}.
+     * 
+     * @param uri
+     *            The URI to correct.
+     * @return the corrected URI, or the original URI.
+     * @see <a href="https://github.com/oracle/graal/issues/5720">Graal issue 5720</a>
+     */
+    static URI correctResourceURI(URI uri)
+    {
+        if (uri == null || !isResourceScheme(uri))
+            return uri;
+
+        String ssp = uri.getSchemeSpecificPart();
+        if (ssp.startsWith(URI_BAD_RESOURCE_PREFIX))
+        {
+            return URI.create("resource:" + ssp.substring(URI_BAD_RESOURCE_PREFIX.length()));
+        }
+        else
+        {
+            return uri;
+        }
+    }
+
+    @Override
+    public URI getRealURI()
+    {
+        Path realPath = getRealPath();
+        return (realPath == null) ? null : correctResourceURI(realPath.toUri());
+    }
+
+    @Override
+    protected URI toUri(Path path)
+    {
+        URI pathUri = correctResourceURI(path.toUri());
+        String rawUri = pathUri.toASCIIString();
+
+        if (Files.isDirectory(path) && !rawUri.endsWith("/"))
+        {
+            return URI.create(rawUri + '/');
+        }
+        return pathUri;
+    }
+}

jetty-core/jetty-util/src/main/java/org/eclipse/jetty/util/resource/NativeImagePathResourceFactory.java

@@ -0,0 +1,71 @@
+//
+// ========================================================================
+// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+// which is available at https://www.apache.org/licenses/LICENSE-2.0.
+//
+// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+// ========================================================================
+//
+
+package org.eclipse.jetty.util.resource;
+
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.nio.file.FileSystemNotFoundException;
+import java.nio.file.FileSystems;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Collections;
+
+/**
+ * GraalVM Native-Image {@link PathResourceFactory}.
+ */
+public class NativeImagePathResourceFactory extends PathResourceFactory
+{
+    static final boolean ENABLE_GRAALVM_RESOURCE_SCHEME = (System.getProperty("org.graalvm.nativeimage.kind") != null);
+
+    public NativeImagePathResourceFactory()
+    {
+        if (ENABLE_GRAALVM_RESOURCE_SCHEME)
+        {
+            initNativeImageResourceFileSystem();
+        }
+    }
+
+    private void initNativeImageResourceFileSystem()
+    {
+        try
+        {
+            URI uri = new URI("resource:/");
+            try
+            {
+                Path.of(uri);
+            }
+            catch (FileSystemNotFoundException e)
+            {
+                FileSystems.newFileSystem(uri, Collections.emptyMap());
+            }
+        }
+        catch (IOException | URISyntaxException | RuntimeException ignore)
+        {
+            // ignore
+        }
+    }
+
+    @Override
+    public Resource newResource(URI uri)
+    {
+        uri = NativeImagePathResource.correctResourceURI(uri.normalize());
+        Path path = Path.of(uri);
+
+        if (!Files.exists(path))
+            return null;
+
+        return new NativeImagePathResource(path, uri, false);
+    }
+}

jetty-core/jetty-util/src/main/java/org/eclipse/jetty/util/resource/PathResource.java

@@ -510,10 +510,10 @@ public void copyTo(Path destination) throws IOException
      * @param path the path to convert to URI
      * @return the appropriate URI for the path
      */
-    private static URI toUri(Path path)
+    protected URI toUri(Path path)
     {
         URI pathUri = path.toUri();
-        String rawUri = path.toUri().toASCIIString();
+        String rawUri = pathUri.toASCIIString();
 
         if (Files.isDirectory(path) && !rawUri.endsWith("/"))
         {

jetty-core/jetty-util/src/main/java/org/eclipse/jetty/util/resource/ResourceFactoryInternals.java

@@ -52,6 +52,9 @@ class ResourceFactoryInternals
         PathResourceFactory pathResourceFactory = new PathResourceFactory();
         RESOURCE_FACTORIES.put("file", pathResourceFactory);
         RESOURCE_FACTORIES.put("jrt", pathResourceFactory);
+
+        if (NativeImagePathResourceFactory.ENABLE_GRAALVM_RESOURCE_SCHEME)
+            RESOURCE_FACTORIES.put("resource", new NativeImagePathResourceFactory());
     }
 
     static ResourceFactory ROOT = new CompositeResourceFactory()