Merge pull request #235 from jdev-org/issue-230-button-provider-img

#230 - Use static path to find provider button's img

Author: Gaetanbrl

gateway/src/main/java/org/georchestra/gateway/app/LoginLogoutController.java

@@ -18,7 +18,6 @@
  */
 package org.georchestra.gateway.app;
 
-import java.nio.file.Path;
 import java.util.*;
 
 import org.apache.commons.lang3.tuple.Pair;
@@ -27,7 +26,8 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.autoconfigure.security.oauth2.client.OAuth2ClientProperties;
-import org.springframework.core.io.ClassPathResource;
+import org.springframework.boot.autoconfigure.web.WebProperties;
+import org.springframework.core.env.Environment;
 import org.springframework.stereotype.Controller;
 import org.springframework.ui.Model;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -59,6 +59,10 @@
 @Controller
 public class LoginLogoutController {
 
+    private @Autowired(required = false) WebProperties webProperties;
+
+    private @Autowired(required = false) Environment environment;
+
     /** Configuration properties for gateway security, including LDAP settings. */
     private @Autowired(required = false) GeorchestraGatewaySecurityConfigProperties georchestraGatewaySecurityConfigProperties;
 
@@ -149,9 +153,21 @@ public String loginPage(@RequestParam Map<String, String> allRequestParams, Mode
         if (oauth2ClientConfig != null) {
             oauth2ClientConfig.getRegistration().forEach((key, value) -> {
                 String clientName = Optional.ofNullable(value.getClientName()).orElse(key);
-                String providerPath = Path.of("login/img/", key + ".png").toString();
-                String logo = new ClassPathResource("static/" + providerPath).exists() ? providerPath
-                        : "login/img/default.png";
+                String[] locations = webProperties.getResources().getStaticLocations();
+                String staticPath = StaticResourcesUtils.computeStaticResourceWebPrefix(environment);
+                // default logo
+                String logo = "login/img/default.png";
+                // provider logo
+                String providerPath = "login/img/" + key + ".png";
+                // loop over static locations
+                for (String location : locations) {
+                    String base = location.endsWith("/") ? location : location + "/";
+                    if (StaticResourcesUtils.resourceExists(base + providerPath)) {
+                        // use logo if exists or use default
+                        logo = staticPath + providerPath;
+                        break;
+                    }
+                }
                 oauth2LoginLinks.put("/oauth2/authorization/" + key, Pair.of(clientName, logo));
             });
         }

gateway/src/main/java/org/georchestra/gateway/app/StaticResourcesUtils.java

@@ -0,0 +1,89 @@
+package org.georchestra.gateway.app;
+
+import org.springframework.core.env.Environment;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.core.io.FileSystemResource;
+import org.springframework.core.io.Resource;
+import org.springframework.util.StringUtils;
+
+/**
+ * Utility methods for resolving and checking static resources, and for
+ * computing the web prefix used to serve static content.
+ */
+public class StaticResourcesUtils {
+    /**
+     * Resolves a resource path into a Spring {@link Resource} instance.
+     * <p>
+     * Supported prefixes:
+     * <ul>
+     * <li><b>classpath:</b> resolved as a {@link ClassPathResource}</li>
+     * <li><b>file:</b> resolved as a {@link FileSystemResource}</li>
+     * <li>otherwise</li>
+     * </ul>
+     * If no prefix is provided, the path is interpreted as a filesystem path.
+     *
+     * @param path fully qualified resource path
+     * @return the resolved {@link Resource}
+     */
+    public static Resource resolveResource(String path) {
+        if (path.startsWith("classpath:")) {
+            return new ClassPathResource(path.substring(10));
+        }
+        if (path.startsWith("file:")) {
+            return new FileSystemResource(path.substring(5));
+        }
+        return new FileSystemResource(path);
+    }
+
+    /**
+     * Checks whether a resource exists and is readable.
+     * <p>
+     * Resolution is delegated to {@link #resolveResource(String)}.
+     *
+     * @param path fully qualified resource path
+     * @return {@code true} if the resource exists and can be read
+     */
+    public static boolean resourceExists(String path) {
+        return resolveResource(path).isReadable();
+    }
+
+    /**
+     * Computes the web prefix used for serving static resources, based on Spring
+     * MVC or WebFlux configuration.
+     * <p>
+     * Reads:
+     * <ul>
+     * <li>{@code spring.webflux.static-path-pattern}</li>
+     * <li>{@code spring.mvc.static-path-pattern}</li>
+     * </ul>
+     * If no pattern is defined, "/" is returned. The resulting prefix is normalized
+     * to start and end with a slash, and the terminal "/**" pattern is removed if
+     * present.
+     *
+     * @param environment the Spring {@link Environment}
+     * @return the normalized static web prefix (for example "/static/")
+     */
+    public static String computeStaticResourceWebPrefix(Environment environment) {
+        String pattern = environment.getProperty("spring.webflux.static-path-pattern");
+        if (!StringUtils.hasText(pattern)) {
+            pattern = environment.getProperty("spring.mvc.static-path-pattern");
+        }
+        if (!StringUtils.hasText(pattern)) {
+            return "/";
+        }
+        pattern = pattern.trim();
+        if (!pattern.startsWith("/")) {
+            pattern = "/" + pattern;
+        }
+        if (pattern.endsWith("/**")) {
+            pattern = pattern.substring(0, pattern.length() - 2);
+        }
+        if (pattern.isEmpty() || "/".equals(pattern)) {
+            return "/";
+        }
+        if (!pattern.endsWith("/")) {
+            pattern = pattern + "/";
+        }
+        return pattern;
+    }
+}