feat: add programatic access to labels in Agama (#10313)

* docs: add FAQ entry for labels lookup from Java #10254 Signed-off-by: jgomer2001 <[email protected]> * feat: allow access to i18n labels from code #10254 Signed-off-by: jgomer2001 <[email protected]> --------- Signed-off-by: jgomer2001 <[email protected]> Co-authored-by: YuriyZ <[email protected]>
JanssenProject · Dec 3, 2024 · 1e91d9b · 1e91d9b
1 parent ccb376c
commit 1e91d9b
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 11 deletions.
diff --git a/docs/janssen-server/developer/agama/faq.md b/docs/janssen-server/developer/agama/faq.md
@@ -99,7 +99,7 @@ More advanced bean lookup capabilities are provided by method `instance` of [thi
 
 ### How to implement localization?
 
-This topic is covered [here](./advanced-usages.md#localization).
+This topic is covered [here](./advanced-usages.md#localization-and-internationalization).
 
 ### How to modify the built-in error pages?
 
@@ -178,6 +178,20 @@ See the examples in the Looping section of the [language reference](../../../aga
 
 You can assign this value to a variable at the top of your loop declaration. See the examples in the Looping section of the [language reference](../../../agama/language-reference.md#looping).
 
+### How to access localization labels from Java code?
+
+In Freemarker, [localization](./advanced-usages.md#localization-and-internationalization) labels are accessed using the `${labels(key, ...)}` notation. The following would be a Java equivalent:
+
+```
+import io.jans.agama.engine.service.LabelsService;
+...
+
+lbls = io.jans.service.cdi.util.CdiUtil.bean(LabelsService.class);
+String label = lbls.get("<label key>", ... optional extra params);
+```
+
+Note the localization context (language, country, etc.) used in such a call is based on the HTTP request that is taking place when the code is invoked.
+
 ### Can Agama code be called from Java?
 
 No. These two languages are supposed to play roles that should not be mixed, check [here](./agama-best-practices.md#about-flow-design).
diff --git a/jans-auth-server/agama/engine/src/main/java/io/jans/agama/engine/service/LabelsService.java b/jans-auth-server/agama/engine/src/main/java/io/jans/agama/engine/service/LabelsService.java
@@ -29,14 +29,26 @@ public class LabelsService implements TemplateMethodModelEx {
     //letters, digits, hypens, or sharp signs. Finally right bracket optionally followed by horizontal space
     //A string matching the regex is used mark the beginning of a specific-locale section in a labels file  
     private static final Pattern SECTION_PATT = Pattern.compile("^\\[[ \\t]*([\\w-#]+)[ \\t]*\\][ \\t]*$");
-    
+
     @Inject
     private Logger logger;
 
     @Inject
     private EngineConfig econf;
 
     private Map<String, Map<String, Properties>> labelsMap;     //Map<path id, Map<locale id, ....
+
+    public String get(String key, Object... args) {
+
+        Pair<String, Locale> p = getLocalizedLabel(key, CdiUtil.bean(WebContext.class).getLocale());
+        String label = p.getFirst();
+
+        if (label != null && args.length > 0) {
+            label = formatMessage(label, p.getSecond(), args);
+        }        
+        return Objects.toString(label);
+
+    }
 
     public Object exec(List args) throws TemplateModelException {
 
@@ -77,14 +89,7 @@ public Object exec(List args) throws TemplateModelException {
                     subArgs[i] = arg;
                 }               
             }
-            try {
-                MessageFormat mf = new MessageFormat(label);
-                Optional.ofNullable(p.getSecond()).ifPresent(mf::setLocale);                    
-                label = mf.format(subArgs, new StringBuffer(), null).toString();
-            } catch (Exception e) {
-                logger.error(e.getMessage(), e);
-                label = "error!";
-            }
+            label = formatMessage(label, p.getSecond(), subArgs);
         }
 
         return new SimpleScalar(Objects.toString(label));   //return "null" to avoid template render crash
@@ -172,6 +177,19 @@ private Pair<String, Locale> getLocalizedLabel(String key, Locale locale) {
 
     }
 
+    private String formatMessage(String pattern, Locale locale, Object[] args) {
+
+        try {
+            MessageFormat mf = new MessageFormat(pattern);
+            Optional.ofNullable(locale).ifPresent(mf::setLocale);                    
+            return mf.format(args, new StringBuffer(), null).toString();
+        } catch (Exception e) {
+            logger.error(e.getMessage(), e);
+            return "error!";
+        }
+
+    }
+
     private Properties propertiesFromSection(List<String> section) {
 
         String cat = section.stream().reduce("", (a, b) -> a + "\n" + b );

diff --git a/jans-casa/plugins/email_2fa/pom.xml b/jans-casa/plugins/email_2fa/pom.xml
@@ -43,7 +43,7 @@
                             <Plugin-Provider>Gluu Inc.</Plugin-Provider>
                             <Plugin-Class>io.jans.casa.plugins.emailotp.EmailOtpPlugin</Plugin-Class>
                             <Plugin-Description>
-                                A plugin to enroll e-mail as a 2FA Credential
+                                A plugin that registers a new authentication method so OTP via e-mail can be used as a 2FA credential
                             </Plugin-Description>
                             <Plugin-License>Apache 2</Plugin-License>
                             <Logger-Name>io.jans.casa.plugins</Logger-Name>