Utils.java

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.exoplatform.portal.mop.management.binding.xml;

import static org.gatein.common.xml.stax.navigator.Exceptions.expectedElement;
import static org.gatein.common.xml.stax.navigator.StaxNavUtils.getRequiredAttribute;
import static org.gatein.common.xml.stax.navigator.StaxNavUtils.getRequiredContent;

import java.util.Locale;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import javax.xml.XMLConstants;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;

import org.exoplatform.portal.config.model.LocalizedString;
import org.exoplatform.portal.config.model.Properties;
import org.exoplatform.portal.mop.management.binding.xml.AbstractMarshaller.Attribute;
import org.gatein.common.xml.stax.navigator.StaxNavUtils;
import org.gatein.common.xml.stax.writer.StaxWriter;
import org.staxnav.Axis;
import org.staxnav.StaxNavException;
import org.staxnav.StaxNavigator;

/**
 * @author <a href="mailto:nscavell@redhat.com">Nick Scavelli</a>
 * @version $Revision$
 */
class Utils {
    private static final Pattern XMLLANG_PATTERN = Pattern.compile("^([a-zA-Z]{2})(?:-([a-zA-Z]{2}))?$");

    public static <N> void writeGateinObjectsNamespace(StaxWriter<N> writer) throws XMLStreamException {
        String gatein_object_ns = Namespace.CURRENT.getUri();
        String location = new StringBuilder().append(gatein_object_ns).append(" ").append(gatein_object_ns).toString();

        writer.writeDefaultNamespace(gatein_object_ns);
        writer.writeNamespace("xsi", XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI);
        writer.writeAttribute(new QName(XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI, "schemaLocation"), location);
    }

    public static <N> LocalizedString parseLocalizedString(StaxNavigator<N> navigator) throws StaxNavException {
        String attribute = navigator.getAttribute(new QName(XMLConstants.XML_NS_URI, "lang", XMLConstants.XML_NS_PREFIX));
        if (attribute == null) {
            attribute = navigator.getAttribute("lang");
        }

        Locale lang = null;
        if (attribute != null) {
            Matcher matcher = XMLLANG_PATTERN.matcher(attribute);
            if (matcher.matches()) {
                String langISO = matcher.group(1);
                String countryISO = matcher.group(2);
                if (countryISO == null) {
                    lang = new Locale(langISO.toLowerCase());
                } else {
                    lang = new Locale(langISO.toLowerCase(), countryISO.toLowerCase());
                }
            } else {
                throw new StaxNavException(navigator.getLocation(), "The attribute xml:lang='" + attribute
                        + "' does not represent a valid language pattern (ie: en, en-us).");
            }
        }

        String value = StaxNavUtils.getRequiredContent(navigator, false);

        return new LocalizedString(value, lang);
    }

    /**
     * Removes empty strings and {@code null} elements from the given string {@code array}. Returns the submitted instance if
     * there is no change.
     *
     * @param array the array to tidy up
     * @return A new array with empty strings and {@code null} elements removed or the instance submitted over {@code array}
     *         argument if there is no change necessary.
     */
    public static String[] tidyUp(String[] array) {
        if (array == null || array.length == 0) {
            return array;
        } else {
            int resultLength = array.length;
            for (int i = 0; i < resultLength; i++) {
                if (array[i] == null || array[i].length() == 0) {
                    /* shift the remaining elements to the left */
                    for (int j = i; j + 1 < resultLength; j++) {
                        array[j] = array[j + 1];
                    }
                    resultLength--;
                    i--;
                }
            }
            if (resultLength < array.length) {
                /* cut */
                String[] result = new String[resultLength];
                System.arraycopy(array, 0, result, 0, resultLength);
                return result;
            } else {
                /* no change */
                return array;
            }
        }
    }

    public static void marshalProperties(StaxWriter<Element> writer, Properties properties) {
        boolean propertiesStarted = false;
        if (properties != null) {
            for (String key : properties.keySet()) {
                if (!propertiesStarted) {
                    writer.writeStartElement(Element.PROPERTIES);
                    propertiesStarted = true;
                }
                String value = properties.get(key);
                if (value != null) {
                    writer.writeStartElement(Element.PROPERTIES_ENTRY);
                    writer.writeAttribute(Attribute.PROPERTIES_KEY.getLocalName(), key);
                    writer.writeContent(value).writeEndElement();
                }
            }
            if (propertiesStarted) {
                writer.writeEndElement();
            }
        }
    }

    public static Properties unmarshalProperties(StaxNavigator<Element> navigator) {
        Properties properties = new Properties();
        if (navigator.navigate(Axis.CHILD, Element.PROPERTIES_ENTRY)) {
            for (StaxNavigator<Element> fork : navigator.fork(Element.PROPERTIES_ENTRY)) {
                String key = getRequiredAttribute(fork, Attribute.PROPERTIES_KEY.getLocalName());
                String value = getRequiredContent(fork, false);
                properties.put(key, value);
            }
        } else {
            throw expectedElement(navigator, Element.PROPERTIES_ENTRY);
        }
        return properties;
    }

}