org.primefaces.config.WebXmlParser Maven / Gradle / Ivy
/*
* Copyright 2009-2014 PrimeTek.
*
* 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 org.primefaces.config;
import java.io.IOException;
import java.io.InputStream;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.faces.context.FacesContext;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathFactory;
import org.primefaces.util.ComponentUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;
public class WebXmlParser {
private static final Logger LOG = Logger.getLogger(WebXmlParser.class.getName());
public static Map getErrorPages(FacesContext context) {
Map webXmlErrorPages = getWebXmlErrorPages(context);
Map webFragmentXmlsErrorPages = getWebFragmentXmlsErrorPages(context);
Map errorPages = webXmlErrorPages;
if (errorPages == null) {
errorPages = webFragmentXmlsErrorPages;
}
else if (webFragmentXmlsErrorPages != null) {
for (Map.Entry entry : webFragmentXmlsErrorPages.entrySet()) {
if (!errorPages.containsKey(entry.getKey())) {
errorPages.put(entry.getKey(), entry.getValue());
}
}
}
return errorPages;
}
private static Map getWebXmlErrorPages(FacesContext context) {
try {
Document webXml = toDocument(context.getExternalContext().getResource("/WEB-INF/web.xml"));
if (webXml != null) {
return parseErrorPages(webXml.getDocumentElement());
}
}
catch (Throwable e) {
LOG.log(Level.SEVERE, "Could not load or parse web.xml", e);
}
return null;
}
private static Map getWebFragmentXmlsErrorPages(FacesContext context) {
Map webFragmentXmlsErrorPages = null;
try {
Enumeration webFragments = Thread.currentThread().getContextClassLoader().getResources("META-INF/web-fragment.xml");
while (webFragments.hasMoreElements()) {
try {
URL url = webFragments.nextElement();
Document webFragmentXml = toDocument(url);
if (webFragmentXml != null) {
if (webFragmentXmlsErrorPages == null) {
webFragmentXmlsErrorPages = parseErrorPages(webFragmentXml.getDocumentElement());
}
else {
Map temp = parseErrorPages(webFragmentXml.getDocumentElement());
for (Map.Entry entry : temp.entrySet()) {
if (!webFragmentXmlsErrorPages.containsKey(entry.getKey())) {
webFragmentXmlsErrorPages.put(entry.getKey(), entry.getValue());
}
}
}
}
}
catch (Throwable e) {
LOG.log(Level.SEVERE, "Could not load or parse web-fragment.xml", e);
}
}
} catch (IOException e) {
LOG.log(Level.SEVERE, "Could not get web-fragment.xml's from ClassLoader", e);
}
return webFragmentXmlsErrorPages;
}
private static Document toDocument(URL url) throws Exception {
InputStream is = null;
try {
// web.xml is optional
if (url == null) {
return null;
}
is = url.openStream();
if (is == null) {
return null;
}
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
factory.setValidating(false);
factory.setNamespaceAware(false);
factory.setExpandEntityReferences(false);
try {
factory.setFeature("http://xml.org/sax/features/namespaces", false);
factory.setFeature("http://xml.org/sax/features/validation", false);
factory.setFeature("http://apache.org/xml/features/nonvalidating/load-dtd-grammar", false);
factory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
}
catch (Throwable e) {
LOG.warning("DocumentBuilderFactory#setFeature not implemented. Skipping...");
}
boolean absolute = false;
try {
absolute = url.toURI().isAbsolute();
}
catch (URISyntaxException e) {
// noop
}
DocumentBuilder builder = factory.newDocumentBuilder();
Document document;
if (absolute) {
InputSource source = new InputSource(url.toExternalForm());
source.setByteStream(is);
document = builder.parse(source);
}
else {
document = builder.parse(is);
}
return document;
}
finally {
if (is != null) {
try {
is.close();
}
catch (IOException e) {
// ignore
}
}
}
}
private static Map parseErrorPages(Element webXml) throws Exception {
Map errorPages = new HashMap();
XPath xpath = XPathFactory.newInstance().newXPath();
NodeList exceptionTypes = (NodeList) xpath.compile("error-page/exception-type").evaluate(webXml, XPathConstants.NODESET);
for (int i = 0; i < exceptionTypes.getLength(); i++) {
Node node = exceptionTypes.item(i);
String exceptionType = node.getTextContent().trim();
String key = Throwable.class.getName().equals(exceptionType) ? null : exceptionType;
String location = xpath.compile("location").evaluate(node.getParentNode()).trim();
if (!errorPages.containsKey(key)) {
errorPages.put(key, location);
}
}
if (!errorPages.containsKey(null)) {
String defaultLocation = xpath.compile("error-page[error-code=500]/location").evaluate(webXml).trim();
if (ComponentUtils.isValueBlank(defaultLocation)) {
defaultLocation = xpath.compile("error-page[not(error-code) and not(exception-type)]/location").evaluate(webXml).trim();
}
if (!ComponentUtils.isValueBlank(defaultLocation)) {
errorPages.put(null, defaultLocation);
}
}
return errorPages;
}
}