View Javadoc

1   /**
2    * This file Copyright (c) 2013 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.i18nsystem;
35  
36  import info.magnolia.cms.i18n.MessagesManager;
37  import info.magnolia.cms.util.ClasspathResourcesUtil;
38  import info.magnolia.i18nsystem.util.LocaleUtils;
39  import org.apache.commons.io.IOUtils;
40  import org.apache.commons.lang.StringUtils;
41  import org.slf4j.Logger;
42  import org.slf4j.LoggerFactory;
43  import java.io.IOException;
44  import java.io.InputStreamReader;
45  import java.io.Reader;
46  import java.util.HashMap;
47  import java.util.Locale;
48  import java.util.Map;
49  import java.util.Properties;
50  
51  /**
52   * Loads global message bundles from /mgnl-i18n/.
53   */
54  public class DefaultMessageBundlesLoader {
55      private static final Logger log = LoggerFactory.getLogger(DefaultMessageBundlesLoader.class);
56  
57      private final Map<Locale, Properties> messages = new HashMap<Locale, Properties>();
58  
59      public DefaultMessageBundlesLoader() {
60          loadMessages();
61      }
62  
63      Map<Locale, Properties> getMessages() {
64          return messages;
65      }
66  
67      private void loadMessages() {
68          final String[] propertiesFiles = ClasspathResourcesUtil.findResources(new ClasspathResourcesUtil.Filter() {
69              @Override
70              public boolean accept(String name) {
71                  return name.startsWith("/mgnl-i18n/") && name.endsWith(".properties");
72              }
73          });
74  
75          for (String propertiesFile : propertiesFiles) {
76              Reader inStream = null;
77              try {
78                  final String fileName = StringUtils.substringAfterLast(propertiesFile, "/");
79                  Locale locale = resolveLocale(fileName);
80  
81                  log.debug("Loading properties file at [{}] with locale [{}]...", propertiesFile, locale);
82                  inStream = new InputStreamReader(ClasspathResourcesUtil.getStream(propertiesFile), "UTF-8");
83  
84                  final Properties properties = new Properties();
85                  properties.load(inStream);
86                  Properties existingProperties = messages.get(locale);
87  
88                  if (existingProperties != null) {
89                      // this locale already exists in our bundle, add the new ones
90                      log.debug("Adding properties to already existing ones under {} locale", locale);
91                      properties.putAll(existingProperties);
92                  }
93                  messages.put(locale, properties);
94              } catch (IOException e) {
95                  log.warn("An IO error occurred while trying to read properties file at [{}]", propertiesFile, e);
96              } finally {
97                  IOUtils.closeQuietly(inStream);
98              }
99          }
100     }
101 
102     /**
103      * @see {@link info.magnolia.i18nsystem.util.LocaleUtils#parseFromFilename(String, java.util.Locale)}
104      */
105     protected Locale resolveLocale(final String fileName) {
106         return LocaleUtils.parseFromFilename(fileName, getFallbackLocale());
107     }
108 
109     // TODO - move this to a SystemLocalesManager component
110     private Locale getFallbackLocale() {
111         return MessagesManager.getInstance().getDefaultLocale();
112     }
113 }