Add support for image content as URL and MetaFile

It was supported as resource path string only.
Now, returned image can be a resource path string, a URL string or a MetaFile.

Author: pdo-axelor

axelor-web/src/main/java/com/axelor/web/service/InfoResource.java

@@ -21,21 +21,24 @@
 import com.axelor.auth.AuthUtils;
 import com.axelor.auth.db.User;
 import com.axelor.common.MimeTypesUtils;
+import com.axelor.common.ObjectUtils;
 import com.axelor.common.StringUtils;
 import com.axelor.inject.Beans;
+import com.axelor.meta.MetaFiles;
+import com.axelor.meta.db.MetaFile;
 import com.axelor.meta.db.MetaTheme;
 import com.axelor.meta.theme.MetaThemeService;
 import com.google.inject.servlet.RequestScoped;
 import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
-import java.io.IOException;
+import java.io.File;
+import java.io.FileInputStream;
 import java.io.InputStream;
-import java.io.UncheckedIOException;
+import java.net.URI;
 import java.util.Map;
 import java.util.Optional;
 import javax.inject.Inject;
-import javax.servlet.ServletContext;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import javax.ws.rs.Consumes;
@@ -46,6 +49,8 @@
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 @RequestScoped
 @Consumes(MediaType.APPLICATION_JSON)
@@ -58,6 +63,8 @@ public class InfoResource {
 
   private final InfoService infoService;
 
+  private static Logger log = LoggerFactory.getLogger(InfoResource.class);
+
   @Inject
   public InfoResource(InfoService infoService) {
     this.infoService = infoService;
@@ -110,18 +117,28 @@ public Response getIconContent() {
     return getImageContent(infoService.getIcon());
   }
 
-  private Response getImageContent(String pathString) {
-    if (StringUtils.notEmpty(pathString)) {
-      final ServletContext context = request.getServletContext();
-      try (final InputStream inputStream = context.getResourceAsStream(pathString)) {
-        if (inputStream != null) {
-          final byte[] imageData = inputStream.readAllBytes();
-          final String mediaType = MimeTypesUtils.getContentType(pathString);
-          return Response.ok(imageData).type(mediaType).build();
+  private Response getImageContent(Object image) {
+    try {
+      if (image instanceof MetaFile) {
+        final MetaFile metaFile = (MetaFile) image;
+        final String filePath = metaFile.getFilePath();
+        final File inputFile = MetaFiles.getPath(filePath).toFile();
+
+        return Response.ok(new FileInputStream(inputFile))
+            .type(MimeTypesUtils.getContentType(inputFile))
+            .build();
+      } else if (ObjectUtils.notEmpty(image)) {
+        final String path = image.toString();
+        final InputStream inputStream = request.getServletContext().getResourceAsStream(path);
+
+        if (inputStream == null) {
+          return Response.seeOther(new URI(path)).build();
         }
-      } catch (IOException e) {
-        throw new UncheckedIOException(e);
+
+        return Response.ok(inputStream).type(MimeTypesUtils.getContentType(path)).build();
       }
+    } catch (Exception e) {
+      log.error("Unable to get image content for {}: {}", image, e.getMessage());
     }
 
     return Response.status(Response.Status.NOT_FOUND).build();

axelor-web/src/main/java/com/axelor/web/service/InfoService.java

@@ -95,8 +95,8 @@ private Map<String, Object> appInfo() {
         SETTINGS.format(
             I18n.get(SETTINGS.getProperties().get(AvailableAppSettings.APPLICATION_COPYRIGHT))));
     map.put("theme", SETTINGS.get(AvailableAppSettings.APPLICATION_THEME, null));
-    map.put("logo", getLogo());
-    map.put("icon", getIcon());
+    map.put("logo", getLogoLink());
+    map.put("icon", getIconLink());
     map.put("lang", AppFilter.getLocale().toLanguageTag());
 
     final Map<String, Object> signIn = signInInfo();
@@ -224,7 +224,7 @@ private Map<String, Object> userInfo() {
     map.put("lang", AppFilter.getLocale().toLanguageTag());
 
     if (user.getImage() != null) {
-      map.put("image", getLink(user, null));
+      map.put("image", getLink(user));
     }
 
     map.put("action", user.getHomeAction());
@@ -316,45 +316,64 @@ private Object featuresInfo() {
   /**
    * Gets user specific application logo, or falls back to default application logo.
    *
-   * @return user specific logo link
+   * <p>The returned image can be a resource path string, a URL string or a MetaFile
+   *
+   * @return user specific logo
    */
-  public String getLogo() {
+  public Object getLogo() {
     final String logo = SETTINGS.get(AvailableAppSettings.APPLICATION_LOGO, "img/axelor.png");
     if (SETTINGS.get(AvailableAppSettings.CONTEXT_APP_LOGO) != null) {
       final ScriptBindings bindings = new ScriptBindings(new HashMap<>());
       final ScriptHelper helper = new CompositeScriptHelper(bindings);
       try {
-        return getLink(helper.eval("__config__.appLogo"), logo);
+        return Optional.ofNullable(helper.eval("__config__.appLogo")).orElse(logo);
       } catch (Exception e) {
         // Ignore
       }
     }
     return logo;
   }
 
+  /**
+   * Gets user specific application logo link, or falls back to default application logo.
+   *
+   * @return user specific logo link
+   */
+  public String getLogoLink() {
+    return getLink(getLogo());
+  }
+
   /**
    * Gets user specific application icon, or falls back to default application icon.
    *
+   * <p>The returned image can be a resource path string, a URL string or a MetaFile
+   *
    * @return user specific application icon
    */
-  public String getIcon() {
+  public Object getIcon() {
     final String icon = SETTINGS.get(AvailableAppSettings.APPLICATION_ICON, "ico/favicon.ico");
     if (SETTINGS.get(AvailableAppSettings.CONTEXT_APP_ICON) != null) {
       final ScriptBindings bindings = new ScriptBindings(new HashMap<>());
       final ScriptHelper helper = new CompositeScriptHelper(bindings);
       try {
-        return getLink(helper.eval("__config__.appIcon"), icon);
+        return Optional.ofNullable(helper.eval("__config__.appIcon")).orElse(icon);
       } catch (Exception e) {
         // Ignore
       }
     }
     return icon;
   }
 
-  public String getLink(Object value, String defaultValue) {
-    if (value == null) {
-      return defaultValue;
-    }
+  /**
+   * Gets user specific application icon link, or falls back to default application icon.
+   *
+   * @return user specific application icon link
+   */
+  public String getIconLink() {
+    return getLink(getIcon());
+  }
+
+  public String getLink(Object value) {
     if (value instanceof String) {
       return (String) value;
     }
@@ -374,6 +393,6 @@ public String getLink(Object value, String defaultValue) {
           + "/image/download?image=true&v="
           + ((User) value).getVersion();
     }
-    return defaultValue;
+    return null;
   }
 }