| gvSIG desktop 1

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Gobernment (CIT)

 * 

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 * 

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

 * MA  02110-1301, USA.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2008 {DiSiD Technologies}  {New extension for installation and update of text translations}

 */

package org.gvsig.i18n.impl;

import java.io.*;

import java.util.*;

import java.util.Map.Entry;

import java.util.jar.*;

import java.util.zip.ZipEntry;

import org.gvsig.i18n.*;

import com.iver.andami.Launcher;

import com.iver.andami.PluginServices;

import com.iver.andami.config.generate.AndamiConfig;

import com.iver.utiles.StringUtilities;

import com.iver.utiles.XMLEntity;

/**

 * Implementation of the I18nManager interface.

 * 

 * @author <a href="mailto:dcervera@disid.com">David Cervera</a>

 * @author <a href="mailto:cordin@disid.com">C?sar Ordi?ana</a>

 */

public class I18nManagerImpl implements I18nManager {

    private static final String MF_LOCALE_VARIANT = "locale-variant";

    private static final String MF_LOCALE_COUNTRY = "locale-country";

    private static final String MF_LOCALE_LANGUAGE = "locale-language";

    private static final String MF_REFLOCALE_VARIANT = "reference-locale-variant";

    private static final String MF_REFLOCALE_COUNTRY = "reference-locale-country";

    private static final String MF_REFLOCALE_LANGUAGE = "reference-locale-language";

    private static final String I18N_EXTENSION = "org.gvsig.i18n";

    private static final String VARIANT = "variant";

    private static final String COUNTRY = "country";

    private static final String LANGUAGE = "language";

    private static final String REGISTERED_LOCALES_PERSISTENCE = "RegisteredLocales";

    private static final I18nManager DEFAULT = new I18nManagerImpl();

    private Set registeredLocales;

    /**

     * The list of default reference locales. The last one will be used to get

     * all the keys when translating to a new locale.

     */

    private Locale[] referenceLocales = new Locale[] { ENGLISH, SPANISH };

    private Locale[] defaultLocales = new Locale[] {

    // Default supported locales

            new Locale("ca"), // Catalan

            new Locale("cs"), // Czech

            new Locale("de"), // German

            ENGLISH, // English

            SPANISH, // Spanish

            new Locale("eu"), // Basque

            new Locale("fr"), // French

            new Locale("gl"), // Galician

            new Locale("it"), // Italian

            new Locale("pl"), // Polish

            new Locale("pt"), // Portuguese

            new Locale("ro"), // Romanian

            new Locale("zh"), // Chinese

    };

    /**

     * Returns the unique instance of the I18nManager.

     * 

     * @return the unique instance

     */

    public static I18nManager getInstance() {

        return DEFAULT;

    }

    public static String capitalize(String text) {

        // Convert the first letter to uppercase

        String capitalLetter = new String(new char[] { Character

                .toUpperCase(text.charAt(0)) });

        return capitalLetter.concat(text.substring(1));

    }

    /**

     * Empty constructor.

     */

    I18nManagerImpl() {

    }

    public Locale[] getInstalledLocales() {

        if (registeredLocales == null) {

            XMLEntity child = getRegisteredLocalesPersistence();

            // If the list of registered locales is not already persisted,

            // this should be the first time gvSIG is run with the I18nPlugin

            // so we will take the list of default locales

            if (child == null) {

                Locale[] defaultLocales = getDefaultLocales();

                registeredLocales = new HashSet(defaultLocales.length);

                for (int i = 0; i < defaultLocales.length; i++) {

                    registeredLocales.add(defaultLocales[i]);

                }

                storeInstalledLocales();

            }

            else {

                XMLEntity localesEntity = getRegisteredLocalesPersistence();

                registeredLocales = new HashSet(localesEntity

                        .getChildrenCount());

                for (int i = 0; i < localesEntity.getChildrenCount(); i++) {

                    XMLEntity localeEntity = localesEntity.getChild(i);

                    String language = localeEntity.getStringProperty(LANGUAGE);

                    String country = localeEntity.getStringProperty(COUNTRY);

                    String variant = localeEntity.getStringProperty(VARIANT);

                    Locale locale = new Locale(language, country, variant);

                    registeredLocales.add(locale);

                }

            }

        }

        return (Locale[]) registeredLocales

                .toArray(new Locale[registeredLocales.size()]);

    }

    public void uninstallLocale(Locale locale) throws I18nException {

        if (getCurrentLocale().equals(locale) || isReferenceLocale(locale)) {

            throw new UninstallLocaleException(locale);

        }

        if (registeredLocales.remove(locale)) {

            // Remove from the configured locale list

            storeInstalledLocales();

            // Remove the resource bundle file

            File bundleFile = new File(getResourcesFolder(),

                    getResourceFileName(locale));

            if (bundleFile.exists()) {

                bundleFile.delete();

            }

        }

    }

    public String getDisplayName(Locale locale) {

        return getDisplayName(locale, locale);

    }

    public String getDisplayName(Locale locale, Locale displayLocale) {

        StringBuffer name = new StringBuffer(getLanguageDisplayName(locale,

                displayLocale));

        boolean close = false;

        if (!isEmpty(locale.getCountry())) {

            name.append(" (");

            name.append(locale.getDisplayCountry(displayLocale));

            close = true;

        }

        if (!isEmpty(locale.getVariant())) {

            if (close) {

                name.append(" - ");

            }

            else {

                name.append(" (");

                close = true;

            }

            name.append(locale.getDisplayVariant(displayLocale));

        }

        if (close) {

            name.append(')');

        }

        return name.toString();

    }

    private boolean isEmpty(String text) {

        return text == null || text.trim().length() == 0;

    }

    public String getLanguageDisplayName(Locale locale) {

        return getLanguageDisplayName(locale, locale);

    }

    public String getLanguageDisplayName(Locale locale, Locale displayLocale) {

        String displayName;

        // Correction for the Basque language display name,

        // show it in Basque, not in Spanish

        if ("eu".equals(locale.getLanguage())

                && "vascuence".equals(locale.getDisplayLanguage())) {

            displayName = "Euskera";

        }

        // Patch for Valencian/Catalan

        else if ("ca".equals(locale.getLanguage())) {

            displayName = Messages.getText("__catalan");

        }

        else {

            displayName = locale.getDisplayLanguage(displayLocale);

        }

        return capitalize(displayName);

    }

    public Locale getCurrentLocale() {

        return Locale.getDefault();

    }

    public void setCurrentLocale(Locale locale) {

        AndamiConfig config = Launcher.getAndamiConfig();

        config.setLocaleLanguage(locale.getLanguage());

        config.setLocaleCountry(locale.getCountry());

        config.setLocaleVariant(locale.getVariant());

    }

    public Locale[] installLocales(File importFile) throws I18nException {

        List importLocales = new ArrayList();

        try {

            FileInputStream fis = new FileInputStream(importFile);

            JarInputStream jaris = new JarInputStream(fis);

            JarEntry entry;

            while ((entry = jaris.getNextJarEntry()) != null) {

                Attributes attributes = entry.getAttributes();

                if (attributes != null) {

                    // Extract the language only if it is not a reference

                    // language

                    String language = attributes.getValue(MF_LOCALE_LANGUAGE);

                    if (language != null) {

                        String country = attributes.getValue(MF_LOCALE_COUNTRY);

                        country = country == null ? "" : country;

                        String variant = attributes.getValue(MF_LOCALE_VARIANT);

                        variant = variant == null ? "" : variant;

                        Locale locale = new Locale(language, country, variant);

                        importLocales.add(locale);

                        // Add the locale to the list of installed ones, if it

                        // is

                        // new, otherwise, update the texts.

                        if (!registeredLocales.contains(locale)) {

                            registeredLocales.add(locale);

                            storeInstalledLocales();

                        }

                        // Replace the old bundle with the new one

                        File bundleFile = getResourceFile(locale);

                        FileOutputStream fos = new FileOutputStream(bundleFile);

                        BufferedOutputStream bos = new BufferedOutputStream(fos);

                        int len = 0;

                        byte[] buffer = new byte[2048];

                        while ((len = jaris.read(buffer)) > 0) {

                            bos.write(buffer, 0, len);

                        }

                        bos.flush();

                        bos.close();

                        fos.close();

                    }

                }

            }

        } catch (Exception ex) {

            throw new InstallLocalesException(importFile, ex);

        }

        return (Locale[]) importLocales

                .toArray(new Locale[importLocales.size()]);

    }

    public void exportLocaleForUpdate(Locale locale, Locale referenceLocale,

            File exportFile) throws I18nException {

        Manifest manifest = new Manifest();

        // First, add an entry for the locale to update

        addLocaleToManifest(locale, manifest, false);

        // Next, another entry for the reference locale, if not a default one

        if (!isReferenceLocale(referenceLocale)) {

            addLocaleToManifest(referenceLocale, manifest, true);

        }

        // Finally, an entry per default reference locale, if not the locale to

        // update

        for (int i = 0; i < referenceLocales.length; i++) {

            if (!locale.equals(referenceLocales[i])) {

                addLocaleToManifest(referenceLocales[i], manifest, true);

            }

        }

        try {

            FileOutputStream fos = new FileOutputStream(exportFile);

            JarOutputStream jaros = new JarOutputStream(fos, manifest);

            // BufferedOutputStream bos = new BufferedOutputStream(jaros);

            // PrintStream ps = new PrintStream(bos);

            PrintStream ps = new PrintStream(jaros);

            Map texts = null;

            // First, export the locale to update

            texts = getAllTexts(locale);

            putResourceInJar(jaros, ps, texts, getResourceFileName(locale));

            // Next, export the locale selected as reference (if not in the

            // default reference locales list)

            if (!isReferenceLocale(referenceLocale)) {

                texts = getAllTexts(referenceLocale);

                putResourceInJar(jaros, ps, texts,

                        getResourceFileName(referenceLocale));

            }

            // Finally, export the default reference locales

            for (int i = 0; i < referenceLocales.length; i++) {

                if (!locale.equals(referenceLocales[i])) {

                    texts = getAllTexts(referenceLocales[i]);

                    putResourceInJar(jaros, ps, texts,

                            getResourceFileName(referenceLocales[i]));

                }

            }

            ps.flush();

            ps.close();

            jaros.close();

            fos.close();

        } catch (IOException ex) {

            throw new ExportLocaleException(locale, ex);

        }

    }

    public void exportLocaleForTranslation(Locale locale,

            Locale referenceLocale, File exportFile) throws I18nException {

        Manifest manifest = new Manifest();

        // First, add an entry for the locale to update

        addLocaleToManifest(locale, manifest, false);

        // Next, another entry for the reference locale, if not a default one

        if (!isReferenceLocale(referenceLocale)) {

            addLocaleToManifest(referenceLocale, manifest, true);

        }

        // Finally, an entry per default reference locale

        for (int i = 0; i < referenceLocales.length; i++) {

            addLocaleToManifest(referenceLocales[i], manifest, true);

        }

        try {

            FileOutputStream fos = new FileOutputStream(exportFile);

            JarOutputStream jaros = new JarOutputStream(fos, manifest);

            // BufferedOutputStream bos = new BufferedOutputStream(jaros);

            // PrintStream ps = new PrintStream(bos);

            PrintStream ps = new PrintStream(jaros);

            Map texts = null;

            // First, export the reference locale translations

            for (int i = 0; i < referenceLocales.length; i++) {

                texts = getAllTexts(referenceLocales[i]);

                putResourceInJar(jaros, ps, texts,

                        getResourceFileName(referenceLocales[i]));

            }

            // Next, export the locale selected as reference (if not in the

            // default reference locales list)

            if (!isReferenceLocale(referenceLocale)) {

                texts = getAllTexts(referenceLocale);

                putResourceInJar(jaros, ps, texts,

                        getResourceFileName(referenceLocale));

            }

            // Finally, the new locale translations, taking the keys from

            // the reference locale, but without values

            // We will use the keys of the last reference locale

            putResourceInJar(jaros, ps, texts, getResourceFileName(locale),

                    false);

            ps.close();

            // bos.close();

            jaros.close();

            fos.close();

        } catch (IOException ex) {

            throw new ExportLocaleException(locale, ex);

        }

    }

    public Locale[] getReferenceLocales() {

        return referenceLocales;

    }

    public void setReferenceLocales(Locale[] referenceLocales) {

        this.referenceLocales = referenceLocales;

    }

    public void setDefaultLocales(Locale[] defaultLocales) {

        this.defaultLocales = defaultLocales;

    }

    /**

     * Returns all the localized texts and its keys for a locale.

     */

    private Map getAllTexts(Locale locale) {

        return Messages.getAllTexts(locale);

    }

    /**

     * Returns if a locale is one of the default reference ones.

     */

    private boolean isReferenceLocale(Locale locale) {

        for (int i = 0; i < referenceLocales.length; i++) {

            if (referenceLocales[i].equals(locale)) {

                return true;

            }

        }

        return false;

    }

    /**

     * Puts a new resource file into a Jar file.

     */

    private void putResourceInJar(JarOutputStream jaros, PrintStream ps,

            Map texts, String resourceFileName) throws IOException {

        putResourceInJar(jaros, ps, texts, resourceFileName, true);

    }

    /**

     * Puts a new resource file into a Jar file.

     */

    private void putResourceInJar(JarOutputStream jaros, PrintStream ps,

            Map texts, String resourceFileName, boolean withValue)

            throws IOException {

        // Add ZIP entry for the resource bundle file

        jaros.putNextEntry(new ZipEntry(resourceFileName));

        for (Iterator iterator = texts.entrySet().iterator(); iterator

                .hasNext();) {

            Entry entry = (Entry) iterator.next();

            String keyEncoded = escape((String) entry.getKey(), true);

            ps.print(keyEncoded);

            ps.print("=");

            if (withValue) {

                String valueEncoded = escape((String) entry.getValue(), false);

                ps.println(valueEncoded);

            }

            else {

                ps.println();

            }

        }

        ps.flush();

        // Close the ZIP entry, the file is complete

        jaros.closeEntry();

    }

    /**

     * Adds an entry to a MANIFEST.MF file with the name of a locale resource

     * bundle properties file, adding labels with the id of the locale, and if

     * it is a reference or the locale to translate or update.

     */

    private String addLocaleToManifest(Locale locale, Manifest manifest,

            boolean isReference) {

        final String languageKey = isReference ? MF_REFLOCALE_LANGUAGE

                : MF_LOCALE_LANGUAGE;

        final String countryKey = isReference ? MF_REFLOCALE_COUNTRY

                : MF_LOCALE_COUNTRY;

        final String variantKey = isReference ? MF_REFLOCALE_VARIANT

                : MF_LOCALE_VARIANT;

        String resourceFileName = getResourceFileName(locale);

        Attributes localeAttributes = new Attributes(4);

        localeAttributes.putValue(languageKey, locale.getLanguage());

        String country = locale.getCountry();

        if (country != null && country.length() > 0) {

            localeAttributes.putValue(countryKey, country);

        }

        String variant = locale.getVariant();

        if (variant != null && variant.length() > 0) {

            localeAttributes.putValue(variantKey, variant);

        }

        manifest.getEntries().put(resourceFileName, localeAttributes);

        return resourceFileName;

    }

    /**

     * Returns the file which contains the translations for a locale.

     */

    private File getResourceFile(Locale locale) {

        return new File(getResourcesFolder(), getResourceFileName(locale));

    }

    /**

     * Returns the name of the file which contains the translations for a

     * locale.

     */

    private String getResourceFileName(Locale locale) {

        StringBuffer fileName = new StringBuffer("text");

        // Spanish without country is the default locale

        if (!(isEmpty(locale.getCountry()) && "es".equals(locale.getLanguage()))) {

            fileName.append('_').append(locale.getLanguage());

        }

        // Add the locale country

        if (!isEmpty(locale.getCountry())) {

            fileName.append('_').append(locale.getCountry());

        }

        // Add the locale variant

        if (!isEmpty(locale.getVariant())) {

            fileName.append('_').append(locale.getVariant());

        }

        fileName.append(".properties");

        return fileName.toString();

    }

    /**

     * Returns the folder where to store the resource bundle files.

     */

    private File getResourcesFolder() {

        return PluginServices.getPluginServices("com.iver.cit.gvsig")

                .getPluginDirectory();

    }

    /**

     * Returns the child XMLEntity with the RegisteredLocales.

     */

    private XMLEntity getRegisteredLocalesPersistence() {

        XMLEntity entity = getI18nPersistence();

        XMLEntity child = null;

        for (int i = entity.getChildrenCount() - 1; i >= 0; i--) {

            XMLEntity tmpchild = entity.getChild(i);

            if (tmpchild.getName().equals(REGISTERED_LOCALES_PERSISTENCE)) {

                child = tmpchild;

                break;

            }

        }

        return child;

    }

    /**

     * Returns the I18n Plugin persistence.

     */

    private XMLEntity getI18nPersistence() {

        XMLEntity entity = PluginServices.getPluginServices(I18N_EXTENSION)

                .getPersistentXML();

        return entity;

    }

    /**

     * Returns the list of default locales bundled with gvSIG.

     */

    private Locale[] getDefaultLocales() {

        return defaultLocales;

    }

    /**

     * Stores the list of installed locales into the plugin persistence.

     */

    private void storeInstalledLocales() {

        XMLEntity localesEntity = getRegisteredLocalesPersistence();

        // Remove the previous list of registered languages

        if (localesEntity != null) {

            XMLEntity i18nPersistence = getI18nPersistence();

            for (int i = i18nPersistence.getChildrenCount() - 1; i >= 0; i--) {

                XMLEntity child = i18nPersistence.getChild(i);

                if (child.getName().equals(REGISTERED_LOCALES_PERSISTENCE)) {

                    i18nPersistence.removeChild(i);

                    break;

                }

            }

        }

        // Create the new persistence for the registered languages

        localesEntity = new XMLEntity();

        localesEntity.setName(REGISTERED_LOCALES_PERSISTENCE);

        for (Iterator iterator = registeredLocales.iterator(); iterator

                .hasNext();) {

            Locale locale = (Locale) iterator.next();

            XMLEntity localeEntity = new XMLEntity();

            localeEntity.setName(locale.getDisplayName());

            localeEntity.putProperty(LANGUAGE, locale.getLanguage());

            localeEntity.putProperty(COUNTRY, locale.getCountry());

            localeEntity.putProperty(VARIANT, locale.getVariant());

            localesEntity.addChild(localeEntity);

        }

        getI18nPersistence().addChild(localesEntity);

    }

    private String escape(String value, boolean replaceBlanks) {

        // First replace non printable characters

        if (replaceBlanks) {

            value = StringUtilities.replace(value, " ", "\\ ");

        }

        value = StringUtilities.replace(value, ":", "\\:");

        value = StringUtilities.replace(value, "\n", "\\n");

        value = StringUtilities.replace(value, "\t", "\\t");

        value = StringUtilities.replace(value, "\b", "\\b");

        value = StringUtilities.replace(value, "\f", "\\f");

        value = StringUtilities.replace(value, "\r", "\\r");

        // value = StringUtilities.replace(value, "\\", "\\\\");

        // value = StringUtilities.replace(value, "\'", "\\\'");

        // value = StringUtilities.replace(value, "\"", "\\\"");

        // Next, encode in raw-unicode-escape

        return toRawUnicodeEncoded(value);

    }

    private String toRawUnicodeEncoded(String value) {

        StringBuffer sb = new StringBuffer();

        for (int i = 0; i < value.length(); i++) {

            char c = value.charAt(i);

            if (c <= 0x80) {

                sb.append(c);

            }

            else {

                sb.append("\\u");

                String hexValue = Integer.toHexString((int) c);

                // Append 0 if the hex value has less than 4 digits

                for (int j = hexValue.length(); j < 4; j++) {

                    sb.append('0');

                }

                sb.append(hexValue);

            }

        }

        return sb.toString();

    }

}