WebConfigParserImpl.java

/**
 * Copyright (c) 2000-2017 Liferay, Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.liferay.faces.util.config.internal;

import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.xml.parsers.SAXParser;

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;

import com.liferay.faces.util.config.ConfiguredServlet;
import com.liferay.faces.util.config.ConfiguredServletMapping;
import com.liferay.faces.util.config.MultiPartConfig;
import com.liferay.faces.util.config.WebConfig;
import com.liferay.faces.util.helper.LongHelper;
import com.liferay.faces.util.logging.Logger;
import com.liferay.faces.util.logging.LoggerFactory;
import com.liferay.faces.util.xml.internal.SAXHandlerBase;


/**
 * @author  Neil Griffin
 */
public class WebConfigParserImpl extends SAXHandlerBase implements WebConfigParser {

	// Logger
	private static final Logger logger = LoggerFactory.getLogger(WebConfigParserImpl.class);

	// Private Constants
	private static final String LOCATION = "location";
	private static final String MAX_FILE_SIZE = "max-file-size";
	private static final String MULTIPART_CONFIG = "multipart-config";
	private static final String SERVLET = "servlet";
	private static final String SERVLET_CLASS = "servlet-class";
	private static final String SERVLET_MAPPING = "servlet-mapping";
	private static final String SERVLET_NAME = "servlet-name";
	private static final String URL_PATTERN = "url-pattern";

	// Private Data Members
	private Map<String, String> configuredContextParams;
	private List<ConfiguredServlet> configuredServlets;
	private List<ConfiguredServletMapping> configuredServletMappings;
	private String location;
	private long maxFileSize;
	private MultiPartConfig multiPartConfig;
	private boolean parsingLocation;
	private boolean parsingMaxFileSize;
	private boolean parsingMultiPartConfig;
	private boolean parsingServlet;
	private boolean parsingServletClass;
	private boolean parsingServletMapping;
	private boolean parsingServletName;
	private boolean parsingUrlPattern;
	private SAXParser saxParser;
	private String servletClass;
	private String servletName;

	public WebConfigParserImpl(SAXParser saxParser, boolean resolveEntities) {
		super(resolveEntities);
		this.saxParser = saxParser;
	}

	@Override
	public void endElement(String uri, String localName, String qName) throws SAXException {

		if (parsingServlet) {

			if (parsingServletClass) {
				servletClass = content.toString().trim();
				parsingServletClass = false;
			}
			else if (parsingServletName) {
				servletName = content.toString().trim();
				parsingServletName = false;
			}
			else if (parsingMultiPartConfig) {

				if (parsingLocation) {
					location = content.toString().trim();
					parsingLocation = false;
				}
				else if (parsingMaxFileSize) {
					maxFileSize = LongHelper.toLong(content.toString().trim(), -1L);
					parsingMaxFileSize = false;
				}

				if (MULTIPART_CONFIG.equals(qName)) {
					multiPartConfig = new MultiPartConfigImpl(location, maxFileSize);
					parsingMultiPartConfig = false;
				}
			}

			if (SERVLET.equals(qName)) {
				ConfiguredServlet configuredServlet = new ConfiguredServletImpl(servletName, servletClass,
						multiPartConfig);
				configuredServlets.add(configuredServlet);
				parsingServlet = false;
			}
		}
		else if (parsingServletMapping) {

			if (parsingServletName) {
				servletName = content.toString().trim();
				parsingServletName = false;
			}
			else if (parsingUrlPattern) {

				String urlPattern = content.toString().trim();
				ConfiguredServletMapping configuredServletMapping = new ConfiguredServletMappingImpl(servletName,
						urlPattern, false);
				configuredServletMappings.add(configuredServletMapping);
				logger.trace("Added servletName=[{0}] urlPattern=[{1}] to configuredServletMappings", servletName,
					urlPattern);
				parsingUrlPattern = false;
			}

			if (SERVLET_MAPPING.equals(qName)) {
				parsingServletMapping = false;
			}
		}

		content = null;
	}

	public WebConfig parse(InputStream inputStream, WebConfig webConfig) throws IOException {

		Map<String, String> configuredContextParams = webConfig.getConfiguredContextParams();
		this.configuredContextParams = new HashMap<String, String>(configuredContextParams);

		List<ConfiguredServlet> configuredServlets = webConfig.getConfiguredServlets();
		this.configuredServlets = new ArrayList<ConfiguredServlet>(configuredServlets);

		List<ConfiguredServletMapping> configuredServletMappings = webConfig.getConfiguredServletMappings();
		this.configuredServletMappings = new ArrayList<ConfiguredServletMapping>(configuredServletMappings);

		try {
			saxParser.parse(inputStream, this);
			webConfig = new WebConfigImpl(this.configuredContextParams, this.configuredServlets,
					this.configuredServletMappings);
			saxParser.reset();

			return webConfig;
		}
		catch (SAXException e) {
			logger.error(e);
			throw new IOException(e.getMessage());
		}
	}

	@Override
	public void startElement(String uri, String localName, String elementName, Attributes attributes)
		throws SAXException {

		logger.trace("localName=[{0}]", localName);

		content = new StringBuilder();

		if (localName.equals(SERVLET)) {
			parsingServlet = true;
		}
		else if (localName.equals(SERVLET_CLASS)) {
			parsingServletClass = true;
		}
		else if (localName.equals(SERVLET_MAPPING)) {
			parsingServletMapping = true;
		}
		else if (localName.equals(SERVLET_NAME)) {
			parsingServletName = true;
		}
		else if (localName.equals(URL_PATTERN)) {
			parsingUrlPattern = true;
		}
		else if (localName.equals(MULTIPART_CONFIG)) {
			parsingMultiPartConfig = true;
		}
		else if (localName.equals(LOCATION)) {
			parsingLocation = true;
		}
		else if (localName.equals(MAX_FILE_SIZE)) {
			parsingMaxFileSize = true;
		}
	}
}