Changeset 5409

Timestamp:

Sep 16, 2010, 1:32:06 PM (12 years ago)

Author:

Nicklas Nordborg

Message:

References #1510: Implement framework for externalizing strings in the gui

The framework should now be working and some items in the menu now use it. I'll continue with the menu as part of this ticket. Since the gui is very large other parts should be added as separate tickets.

Location:

trunk

Files:

• config/dist/base.config (modified) (1 diff)
• doc/src/docbook/appendix/base.config.xml (modified) (1 diff)
• src/clients/web/net/sf/basedb/clients/web/resources (added)
• src/clients/web/net/sf/basedb/clients/web/resources/Bundle.java (added)
• src/clients/web/net/sf/basedb/clients/web/resources/common.properties (added)
• src/clients/web/net/sf/basedb/clients/web/resources/menu.properties (added)
• src/core/net/sf/basedb/core/Config.java (modified) (5 diffs)
• src/core/net/sf/basedb/core/SessionControl.java (modified) (2 diffs)
• src/core/net/sf/basedb/util/resources (added)
• src/core/net/sf/basedb/util/resources/ResourceBundleFactory.java (added)
• src/core/net/sf/basedb/util/resources/ResourceBundleWrapper.java (added)
• src/core/net/sf/basedb/util/resources/Utf8PropertiesResourceBundleControl.java (added)
• www/include/menu.jsp (modified) (7 diffs)

trunk/config/dist/base.config

@@ -188 +188 @@
 # Set to 1 to disable auto-compression of uploaded files
 autocompress.disable = 0
+
+# Locale settings are used to customize gui text and labels
+# locale.language = 
+# locale.country = 
+# locacle.variant =
 
 # ===============

trunk/doc/src/docbook/appendix/base.config.xml

@@ -766 +766 @@
       </listitem>
     </varlistentry>
+    
+    <varlistentry>
+      <term><property>locale.language</property></term>
+      <term><property>locale.country</property></term>
+      <term><property>locale.variant</property></term>
+      <listitem>
+        <para>
+          Configure the server to a specific locale. The language and
+          country should be valid ISO codes as specified by the
+          <ulink url="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html"
+            >java.util.Locale</ulink> documentation. The variant
+          can be any value that is valid as part of a filename. 
+        </para>
+
+        <note>
+          <para>
+          Note that language codes are usually lower-case but country codes are
+          upper case. Eg. <code>sv</code> is the language code for swedish, and
+          <code>SE</code> is the country code.
+          </para>
+        </note>
+
+        <para>
+          This configuration can be used to provide translations to some parts of the web gui. 
+          The aim is to externalize all hard-coded gui elements from the code but
+          it's a long way before this is a reality. The default text elements of
+          the gui are shipped within the BASE jar files and doesn't have any
+          locale-specific dependency. This means that unless a more specific 
+          translation is provided the default texts are always used as a fallback.
+          Most of the default texts are found in property files in the 
+          <filename>/net/sf/basedb/clients/web/resources</filename>
+          directory inside the <filename>BASE2Webclient.jar</filename>
+          file. Translations should be located in the same relative path
+          either inside their own JAR file or in the <filename>WEB-INF/classes</filename> 
+          directory. The file names should be extended with the language, country 
+          and variant separated with an underscore. For example, files with a swedish 
+          translation should be named <filename>*_sv.properties</filename>, and files
+          with a swedish translation in Finland using the 'foo' variant should be 
+          named <filename>*_sv_FI_foo.properties</filename>.
+        </para>
+        
+        <note>
+          <para>
+            Note that it is valid to have empty values for language and/or country
+            and still specify a variant. Underscores are NOT collapsed. For
+            example, in a swedish translation using the 'foo' variant the
+            files should be named <filename>*_sv__foo.properties</filename>.
+          </para>
+        </note>
+        
+        <important>
+          <para>
+            All files should be saved in UTF-8 format.
+          </para>
+        </important>
+        
+      </listitem>
+    </varlistentry>
+    
     </variablelist>
   </simplesect>

trunk/src/core/net/sf/basedb/core/Config.java

@@ -23 +23 @@
 package net.sf.basedb.core;
 
+import java.util.Locale;
 import java.util.Properties;
 import java.io.FileNotFoundException;
@@ -56 +57 @@
   
   private static java.io.File configDir = null;
+  
+  private static Locale locale = Locale.getDefault();
   
   /**
@@ -79 +82 @@
       config.load(is);
       if (overridden != null) config.putAll(overridden);
+      
     }
     catch (Exception ex)
@@ -90 +94 @@
     }
     isInitialised = true;
+    
+    // Load locale
+    String language = getString("locale.language", "");
+    String country = getString("locale.country", "");
+    String variant = getString("locale.variant", "");
+    if (language.length() > 0 || country.length() > 0 || variant.length() > 0)
+    {
+      locale = new Locale(language, country, variant);
+    }
+    else
+    {
+      locale = Locale.getDefault();
+    }
   }
 
@@ -256 +273 @@
   }
 
+  /**
+    Get the default locale configured for the server.
+    @since 2.16
+  */
+  public static Locale getLocale()
+  {
+    return locale;
+  }
 
 }

trunk/src/core/net/sf/basedb/core/SessionControl.java

@@ -51 +51 @@
 import java.util.Date;
 import java.util.Iterator;
+import java.util.Locale;
 import java.util.Set;
 import java.util.Map;
@@ -1824 +1825 @@
   
   /**
+    Get the locale that is curently assigned to this session control. 
+    @return A Locale object
+    @since 2.16
+  */
+  public Locale getLocale()
+  {
+    return Config.getLocale();
+  }
+  
+  /**
     Get the value of a session setting with the specified name.
     @param name The name of the setting

trunk/www/include/menu.jsp

@@ -2 +2 @@
   ------------------------------------------------------------------
   Copyright (C) 2005 Nicklas Nordborg, Gregory Vincic
-  Copyright (C) 2006 Jari Häkkinen, Nicklas Nordborg, Martin Svensson, Gregory Vincic
+  Copyright (C) 2006 Jari H�kkinen, Nicklas Nordborg, Martin Svensson, Gregory Vincic
   Copyright (C) 2007 Nicklas Nordborg
 
@@ -56 +56 @@
   import="net.sf.basedb.clients.web.Base"
   import="net.sf.basedb.clients.web.util.HTML"
+  import="net.sf.basedb.clients.web.resources.Bundle"
   import="net.sf.basedb.util.Values"
+  import="net.sf.basedb.util.resources.ResourceBundleWrapper"
+  import="net.sf.basedb.util.resources.ResourceBundleFactory"
   import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
   import="net.sf.basedb.clients.web.extensions.JspContext"
@@ -78 +81 @@
 final String root = request.getContextPath()+"/";
 if ("exception".equals(name) && sc != null && sc.isLoggedIn()) name = "standard";
+
+final ResourceBundleWrapper common = ResourceBundleFactory.getResourceBundle(Bundle.COMMON, sc);
+final ResourceBundleWrapper menu = ResourceBundleFactory.getResourceBundle(Bundle.MENU, sc);
 
 if ("login".equals(name))
@@ -407 +413 @@
       >
       <m:menuitem
-        title="Home" 
+        title="<%=menu.getString("home.title")%>"
+        tooltip="<%=menu.getString("home.tooltip")%>" 
         onclick="<%="Menu.openUrl('"+root+"my_base/index.jsp?ID="+ID+"')"%>" 
       />
       <m:menuitem
-        title="All items"
-        tooltip="View all items that you are the owner of"
+        title="<%=menu.getString("allitems.title")%>"
+        tooltip="<%=menu.getString("allitems.tooltip")%>"
         onclick="<%="Menu.openUrl('"+root+"views/items/index.jsp?ID="+ID+"')"%>"
       />
       <m:menuitem
-        title="Trashcan"
-        tooltip="View all items that have been marked for deletion"
+        title="<%=menu.getString("trashcan.title")%>"
+        tooltip="<%=menu.getString("trashcan.tooltip")%>"
         onclick="<%="Menu.openUrl('"+root+"views/trashcan/index.jsp?ID="+ID+"')"%>"
       />
       <m:menuseparator />
       <m:menuitem 
-        title="Files" 
+        title="<%=common.getString("item.files")%>" 
         onclick="<%="Menu.openUrl('"+root+"filemanager/index.jsp?ID="+ID+"')"%>" 
-        tooltip="<%=hasFiles ? "Manage files" : "You do not have permission to manage files"%>" 
+        tooltip="<%=menu.getString("files.tooltip", hasFiles)%>" 
         enabled="<%=hasFiles%>"
       />
       <m:menuitem 
-        title="File servers" 
+        title="<%=common.getString("item.fileservers")%>" 
         onclick="<%="Menu.openUrl('"+root+"filemanager/fileservers/index.jsp?ID="+ID+"')"%>" 
-        tooltip="<%=hasFileServers ? "Manage file servers" : "You do not have permission to manage file servers"%>" 
+        tooltip="<%=menu.getString("fileservers.tooltip", hasFileServers)%>" 
         enabled="<%=hasFileServers%>"
       />
       <m:menuitem
-        title="Projects"
+        title="<%=common.getString("item.projects")%>"
         onclick="<%="Menu.openUrl('"+root+"my_base/projects/index.jsp?ID="+ID+"')"%>"
-        tooltip="Manage projects"
+        tooltip="<%=menu.getString("projects.tooltip", hasProjects)%>"
         enabled="<%=hasProjects%>"
       />
       <m:menuitem
-        title="Permission templates"
+        title="<%=common.getString("item.permissiontemplates")%>"
         onclick="<%="Menu.openUrl('"+root+"views/permissiontemplates/index.jsp?ID="+ID+"')"%>"
-        tooltip="Manage permission templates"
+        tooltip="<%=menu.getString("permissiontemplates.tooltip", hasPermissionTemplates)%>"
         enabled="<%=hasPermissionTemplates%>"
       />
       <m:menuitem 
-        title="Messages" 
+        title="<%=common.getString("item.messages")%>" 
         onclick="<%="Menu.openUrl('"+root+"my_base/messages/index.jsp?ID="+ID+"')"%>" 
-        tooltip="<%=hasMessages ? "Read your messages" : "You do not have permission to read messages"%>" 
+        tooltip="<%=menu.getString("messages.tooltip", hasMessages)%>"
         enabled="<%=hasMessages%>"
       />
       <m:menuitem 
-        title="Jobs" 
+        title="<%=common.getString("item.jobs")%>" 
         onclick="<%="Menu.openUrl('"+root+"views/jobs/index.jsp?ID="+ID+"')"%>" 
-        tooltip="<%=hasJobs ? "Check the status of your jobs" : "You do not have permission to access jobs"%>" 
+        tooltip="<%=menu.getString("jobs.tooltip", hasJobs)%>"
         enabled="<%=hasJobs%>"
       />
       <m:menuitem 
-        title="Sessions" 
+        title="<%=common.getString("item.sessions")%>" 
         onclick="<%="Menu.openUrl('"+root+"views/sessions/index.jsp?ID="+ID+"')"%>" 
-        tooltip="<%=hasSessions ? "Check you login sessions" : "You do not have permission to access sessions"%>" 
+        tooltip="<%=menu.getString("sessions.tooltip", hasSessions)%>"
         enabled="<%=hasSessions%>"
       />
       <m:menuseparator />
       <m:menuitem
-        title="Hybridizations"
+        title="<%=common.getString("item.hybridizations")%>"
         onclick="<%="Menu.openUrl('"+root+"views/hybridizations/index.jsp?ID="+ID+"')"%>"
-        tooltip="<%=hasHybridizations ? "Manage hybridizations" : "You do not have permission to manage hybridizations"%>"
+        tooltip="<%=menu.getString("hybridizations.tooltip", hasHybridizations)%>"
         enabled="<%=hasHybridizations%>"
       />
       <m:menuitem
-        title="Scans"
+        title="<%=common.getString("item.scans")%>"
         onclick="<%="Menu.openUrl('"+root+"views/scans/index.jsp?ID="+ID+"')"%>"
-        tooltip="<%=hasScans ? "Manage scans" : "You do not have permission to manage scans"%>"
+        tooltip="<%=menu.getString("scans.tooltip", hasScans)%>"
         enabled="<%=hasScans%>"
       />
       <m:menuitem
-        title="Raw bioassays"
+        title="<%=common.getString("item.rawbioassays")%>"
         onclick="<%="Menu.openUrl('"+root+"views/rawbioassays/index.jsp?ID="+ID+"')"%>"
-        tooltip="<%=hasRawBioAssays ? "Manage raw bioassays" : "You do not have permission to manage raw bioassays"%>"
+        tooltip="<%=menu.getString("rawbioassays.tooltip", hasRawBioAssays)%>"
         enabled="<%=hasRawBioAssays%>"
       />
       <m:menuitem
-        title="Experiments"
+        title="<%=common.getString("item.experiments")%>"
         onclick="<%="Menu.openUrl('"+root+"views/experiments/index.jsp?ID="+ID+"')"%>"
-        tooltip="<%=hasExperiments ? "Manage experiments" : "You do not have permission to manage experiments"%>"
+        tooltip="<%=menu.getString("experiments.tooltip", hasExperiments)%>"
         enabled="<%=hasExperiments%>"
       />
       <m:menuitem
-        title="Formulas"
+        title="<%=common.getString("item.formulas")%>"
         onclick="<%="Menu.openUrl('"+root+"views/formulas/index.jsp?ID="+ID+"')"%>"
-        tooltip="<%=hasFormulas ? "Manage formulas" : "You do not have permission to manage formulas"%>"
+        tooltip="<%=menu.getString("formulas.tooltip", hasFormulas)%>"
         enabled="<%=hasFormulas%>"
       />
       <m:menuseparator />
       <m:menuitem
-        title="Reporters"
+        title="<%=common.getString("item.reporters")%>"
         onclick="<%="Menu.openUrl('"+root+"views/reporters/index.jsp?ID="+ID+"')"%>"
-        tooltip="<%=hasReporters ? "Manage reporters" : "You do not have permission to manage reporters"%>"
+        tooltip="<%=menu.getString("reporters.tooltip", hasReporters)%>"
         enabled="<%=hasReporters%>"
       />
       <m:menuitem
-        title="Reporter lists"
+        title="<%=common.getString("item.reporterlists")%>"
         onclick="<%="Menu.openUrl('"+root+"views/reporterlists/index.jsp?ID="+ID+"')"%>"
-        tooltip="<%=hasReporterLists ? "Manage reporter lists" : "You do not have permission to manage reporter lists"%>"
+        tooltip="<%=menu.getString("reporterlists.tooltip", hasReporterLists)%>"
         enabled="<%=hasReporterLists%>"
       />
@@ -1023 +1030 @@
       <m:menuitem
         visible="<%=HTML.isValidUrl(helplink)%>"
-        title="Help&hellip;"
+        title="<%=menu.getString("menu.help") + "…"%>"
         onclick="<%="window.open('"+helplink+"','Help')"%>"
       />
       <m:menuitem
         visible="<%=HTML.isValidUrl(faqlink)%>"
-        title="FAQ&hellip;"
+        title="<%=menu.getString("faq.title") + "…"%>"
         onclick="<%="window.open('"+faqlink+"','FAQ')"%>"
+        tooltip="<%=menu.getString("faq.tooltip") %>"
       />
       <m:menuseparator />
 
       <m:menuitem
-        title="About&hellip;"
+        title="<%=menu.getString("about.title") + "…"%>"
         onclick="<%="Main.openPopup('"+root+"info/about.jsp?ID="+ID+"&page=about', 'About', 500, 350)"%>"
       />
 
       <m:menuitem
-        title="License&hellip;"
+        title="<%=menu.getString("license.title") + "…"%>"
         onclick="<%="Main.openPopup('"+root+"info/about.jsp?ID="+ID+"&page=license', 'About', 500, 350)"%>"
-
       />
       <m:menuitem
         visible="<%=HTML.isValidUrl(reportbuglink)%>"
-        title="Report a bug&hellip;"
+        title="<%=menu.getString("bugreport.title") + "…"%>"
         onclick="<%="window.open('"+reportbuglink+"','Reportbug')"%>"
+        tooltip="<%=menu.getString("bugreport.tooltip")%>"
       />
       <m:menuseparator />
       <m:menuitem
-        title="Base project site" onclick="<%="Menu.openUrl('http://base.thep.lu.se', 'basesite')"%>"
+        title="<%=menu.getString("basesite.title") + "…"%>" 
+        onclick="<%="Menu.openUrl('http://base.thep.lu.se', 'basesite')"%>"
+        tooltip="<%=menu.getString("basesite.tooltip")%>"
       />
     </m:menu>
@@ -1193 +1203 @@
       <m:submenu
         subid="base"
-        title="BASE"
+        title="<%=menu.getString("menu.base")%>"
       />
       <m:submenu
         subid="view"
-        title="View"
+        title="<%=menu.getString("menu.view")%>"
       />
       <m:submenu 
         subid="biolims"
-        title="Biomaterial LIMS"
+        title="<%=menu.getString("menu.biolims")%>"
       />
       <m:submenu
         subid="lims"
-        title="Array LIMS"
+        title="<%=menu.getString("menu.arraylims")%>"
       />
       <m:submenu
         subid="administrate"
-        title="Administrate"
+        title="<%=menu.getString("menu.administrate")%>"
         visible="<%=hasAdministrate%>"
       />
       <m:submenu
         subid="extensions"
-        title="Extensions"
+        title="<%=menu.getString("menu.extensions")%>"
       />
       <m:submenu
         subid="help"
-        title="Help"
+        title="<%=menu.getString("menu.help")%>"
       />
     </m:menu></div>
@@ -1233 +1243 @@
 
 
-