Add backend dark logo/icon support

logo/icon removed from ws/public/app/info

Author: pdo-axelor

axelor-core/src/main/java/com/axelor/app/AvailableAppSettings.java

@@ -33,7 +33,9 @@ public interface AvailableAppSettings {
   String APPLICATION_HELP = "application.help";
   String APPLICATION_COPYRIGHT = "application.copyright";
   String APPLICATION_LOGO = "application.logo";
+  String APPLICATION_LOGO_DARK = "application.logo-dark";
   String APPLICATION_ICON = "application.icon";
+  String APPLICATION_ICON_DARK = "application.icon-dark";
   String APPLICATION_MODE = "application.mode";
   String APPLICATION_BASE_URL = "application.base-url";
   String APPLICATION_CONFIG_PROVIDER = "application.config-provider";

axelor-tools/src/main/java/com/axelor/tools/code/entity/model/Entity.java

@@ -478,7 +478,9 @@ public void setSuperClass(String superClass) {
   }
 
   public String computeSuperClassName() {
-    if (isModelClass()) { return null; }
+    if (isModelClass()) {
+      return null;
+    }
     if (isBlank(superClass)) {
       return notFalse(isAuditable) ? "com.axelor.auth.db.AuditableModel" : "com.axelor.db.Model";
     }

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

@@ -18,11 +18,13 @@
  */
 package com.axelor.web.service;
 
+import com.axelor.app.AppSettings;
 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.common.UriBuilder;
 import com.axelor.inject.Beans;
 import com.axelor.meta.MetaFiles;
 import com.axelor.meta.db.MetaFile;
@@ -32,10 +34,9 @@
 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.File;
-import java.io.FileInputStream;
 import java.io.InputStream;
 import java.net.URI;
+import java.nio.file.Files;
 import java.util.Map;
 import java.util.Optional;
 import javax.inject.Inject;
@@ -106,36 +107,46 @@ public Response getTheme(@QueryParam("name") String name) {
   @GET
   @Path("logo")
   @Hidden
-  public Response getLogoContent() {
-    return getImageContent(infoService.getLogo());
+  public Response getLogoContent(@QueryParam("mode") String mode) {
+    return getImageContent(infoService.getLogo(mode));
   }
 
   @GET
   @Path("icon")
   @Hidden
-  public Response getIconContent() {
-    return getImageContent(infoService.getIcon());
+  public Response getIconContent(@QueryParam("mode") String mode) {
+    return getImageContent(infoService.getIcon(mode));
   }
 
   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();
+        final java.nio.file.Path inputPath = MetaFiles.getPath(filePath);
 
-        return Response.ok(new FileInputStream(inputFile))
-            .type(MimeTypesUtils.getContentType(inputFile))
-            .build();
+        if (Files.exists(inputPath)) {
+          return Response.ok(Files.newInputStream(inputPath))
+              .type(MimeTypesUtils.getContentType(inputPath))
+              .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();
+        if (inputStream != null) {
+          return Response.ok(inputStream).type(MimeTypesUtils.getContentType(path)).build();
+        }
+
+        URI uri = new URI(path);
+        if (!uri.isAbsolute()) {
+          uri =
+              UriBuilder.from(AppSettings.get().getBaseURL())
+                  .addPath(path.startsWith("/") ? path : "/" + path)
+                  .toUri();
         }
 
-        return Response.ok(inputStream).type(MimeTypesUtils.getContentType(path)).build();
+        return Response.seeOther(uri).build();
       }
     } catch (Exception e) {
       log.error("Unable to get image content for {}: {}", image, e.getMessage());

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

@@ -42,12 +42,14 @@
 import com.axelor.script.CompositeScriptHelper;
 import com.axelor.script.ScriptBindings;
 import com.axelor.script.ScriptHelper;
+import java.lang.reflect.Method;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
+import java.util.function.Supplier;
 import java.util.stream.Collectors;
 import javax.inject.Inject;
 import javax.servlet.http.HttpServletRequest;
@@ -95,8 +97,6 @@ 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", getLogoLink());
-    map.put("icon", getIconLink());
     map.put("lang", AppFilter.getLocale().toLanguageTag());
 
     final Map<String, Object> signIn = signInInfo();
@@ -318,59 +318,96 @@ private Object featuresInfo() {
    *
    * <p>The returned image can be a resource path string, a URL string or a MetaFile
    *
+   * @param mode light or dark
    * @return user specific logo
    */
-  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 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());
+  public Object getLogo(String mode) {
+    return getImage(
+        SETTINGS.get(AvailableAppSettings.CONTEXT_APP_LOGO),
+        mode,
+        "appLogo",
+        () ->
+            isDark(mode)
+                ? SETTINGS.get(
+                    AvailableAppSettings.APPLICATION_LOGO_DARK,
+                    SETTINGS.get(AvailableAppSettings.APPLICATION_LOGO, "img/axelor-dark.png"))
+                : SETTINGS.get(AvailableAppSettings.APPLICATION_LOGO, "img/axelor.png"));
   }
 
   /**
    * 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
    *
+   * @param mode light or dark
    * @return user specific application icon
    */
-  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 Optional.ofNullable(helper.eval("__config__.appIcon")).orElse(icon);
-      } catch (Exception e) {
-        // Ignore
+  public Object getIcon(String mode) {
+    return getImage(
+        SETTINGS.get(AvailableAppSettings.CONTEXT_APP_ICON),
+        mode,
+        "appIcon",
+        () ->
+            isDark(mode)
+                ? SETTINGS.get(
+                    AvailableAppSettings.APPLICATION_ICON_DARK,
+                    SETTINGS.get(AvailableAppSettings.APPLICATION_ICON, "ico/favicon.ico"))
+                : SETTINGS.get(AvailableAppSettings.APPLICATION_ICON, "ico/favicon.ico"));
+  }
+
+  private Object getImage(
+      String contextImage, String mode, String config, Supplier<String> defaultValue) {
+    Object result;
+
+    try {
+      result = getImage(contextImage, mode);
+      if (ObjectUtils.notEmpty(result)) {
+        return result;
       }
+      return defaultValue.get();
+    } catch (Exception e) {
+      // Ignore
     }
-    return icon;
+
+    try {
+      result = getConfigImage(config);
+      if (ObjectUtils.notEmpty(result)) {
+        return result;
+      }
+    } catch (Exception e) {
+      // Ignore
+    }
+
+    return defaultValue.get();
   }
 
-  /**
-   * 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());
+  private Object getImage(String imageCall, String mode) throws Exception {
+    final String[] parts = imageCall.split("\\:", 2);
+
+    if (parts.length != 2) {
+      return null;
+    }
+
+    final String className = parts[0];
+    final String methodName = parts[1];
+
+    final Class<?> klass = Class.forName(className);
+    final Method method = klass.getMethod(methodName, String.class);
+    final Object bean = Beans.get(klass);
+
+    return method.invoke(bean, mode);
+  }
+
+  // Legacy way to retrieve context image without passing mode
+  @Deprecated(forRemoval = true)
+  private Object getConfigImage(String name) {
+    final ScriptBindings bindings = new ScriptBindings(new HashMap<>());
+    final ScriptHelper scriptHelper = new CompositeScriptHelper(bindings);
+    return scriptHelper.eval("__config__." + name);
+  }
+
+  private boolean isDark(String mode) {
+    return "dark".equalsIgnoreCase(mode);
   }
 
   public String getLink(Object value) {

changelogs/unreleased/feature-app-logo-icon-dark.yml

@@ -0,0 +1,7 @@
+---
+title: Support application settings application.logo-dark and application.icon-dark
+type: feature
+description: |
+  `ws/public/app/logo` and `ws/public/app/logo` accept `mode` query parameter (`light` or `dark`).
+  Application configuration `context.appLogo` and `context.appIcon` accept `String mode` parameter.
+  Removed logo and icon from `ws/public/app/info`.

documentation/modules/dev-guide/examples/axelor-config.properties

@@ -10,9 +10,15 @@ application.copyright = Copyright (c) {year} Axelor. All Rights Reserved.
 # Header logo. Should be 40px in height with transparent background.
 application.logo = img/axelor-logo.png
 
+# Header logo for dark mode theme. Should be 40px in height with transparent background.
+#application.logo-dark =
+
 # Website icon. Must be a multiple of 48px square for favicon compatibility.
 application.icon = "ico/favicon.ico"
 
+# Website icon for dark mode theme. Must be a multiple of 48px square for favicon compatibility.
+#application.icon-dark =
+
 # Home website. Home page link in user dropdown menu
 application.home = https://www.axelor.com
 
@@ -91,6 +97,9 @@ application.mode = dev
 # Sign-in logo, default to `application.logo`
 #application.sign-in.logo =
 
+# Sign-in logo for dark theme mode, default to `application.logo-dark`
+#application.sign-in.logo-dark =
+
 # Sign-in title
 #application.sign-in.title =
 

documentation/modules/dev-guide/pages/application/config.adoc

@@ -203,7 +203,9 @@ db.default.password = secret
 | `application.author` | application author |
 | `application.copyright` | application copyright |
 | `application.logo` | header logo. Should be 40px in height with transparent background | img/axelor.png
+| `application.logo-dark` | (optional) dark header logo. Should be 40px in height with transparent background | `application.logo` or img/axelor-dark.png
 | `application.icon` | website icon. Must be a multiple of 48px square for favicon compatibility | ico/favicon.ico
+| `application.icon-dark` | (optional) dark website icon. Must be a multiple of 48px square for favicon compatibility | `application.icon` or ico/favicon.ico
 | `application.home` | home website. Link to be used as home page link in user dropdown menu |
 | `application.help` | online help. Link to be used in About page |
 | `application.mode` | application deployment mode. Can be `prod` or `dev` | dev
@@ -471,7 +473,8 @@ context.appLogo = com.axelor.custom.AppService:getLogo
 context.appIcon = com.axelor.custom.AppService:getIcon
 ----
 
-The `appLogo`/`appIcon` methods should return either:
+The `appLogo`/`appIcon` methods can optionally accept a `String mode` parameter : either `light` or `dark` or if null,
+assuming default `light` is used. Methods should return either:
 
 * a string, link to logo/icon file (eg. `img/my-logo.png`, `ico/my-icon.ico`)
 * an instance of `MetaFile` pointing to the logo/icon file
@@ -482,18 +485,17 @@ Here is an example in case it returns a `MetaFile`:
 ----
 public class AppService {
 
-  public MetaFile getLogo() {
-    final User user = AuthUtils.getUser();
-    if(user == null || user.getActiveCompany() == null) {
-        return null;
-    }
-    return user.getActiveCompany().getLogo();
+  public MetaFile getLogo(String mode) {
+    return Optional.ofNullable(AuthUtils.getUser())
+            .map(User::getActiveCompany)
+            .map(company -> "dark".equals(mode) ? company.getDarkLogo() : company.getLogo())
+            .orElse(null); // Returning null will show default application logo.
   }
 }
 ----
 
 If return value is null, it will show default logo/icon specified
-with `application.logo` and `application.icon` in configuration file.
+with `application.logo`/`application.logo-dark` and `application.icon`/`application.icon-dark` in configuration file.
 
 [#custom-login-page]
 == Custom Login Page