com.sun.tools.xjc.reader.internalizer.Internalizer Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.tools.xjc.reader.internalizer;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.text.ParseException;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathExpressionException;
import com.sun.istack.SAXParseException2;
import com.sun.istack.NotNull;
import com.sun.istack.Nullable;
import com.sun.tools.xjc.ErrorReceiver;
import com.sun.tools.xjc.reader.Const;
import com.sun.tools.xjc.util.DOMUtils;
import org.glassfish.jaxb.core.v2.util.EditDistance;
import org.glassfish.jaxb.core.v2.util.XmlFactory;
import com.sun.xml.xsom.SCD;
import java.io.File;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.xml.XMLConstants;
import org.w3c.dom.Attr;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXParseException;
/**
* Internalizes external binding declarations.
*
*
* The {@link #transform(DOMForest, boolean, boolean)} method is the entry point.
*
* @author
* Kohsuke Kawaguchi ([email protected])
*/
class Internalizer {
private static final String WSDL_NS = "http://schemas.xmlsoap.org/wsdl/";
private final XPath xpath;
/**
* Internalize all {@code } customizations in the given forest.
*
* @return
* if the SCD support is enabled, the return bindings need to be applied
* after schema components are parsed.
* If disabled, the returned binding set will be empty.
* SCDs are only for XML Schema, and doesn't make any sense for other
* schema languages.
*/
static SCDBasedBindingSet transform( DOMForest forest, boolean enableSCD, boolean disableSecureProcessing ) {
return new Internalizer(forest, enableSCD, disableSecureProcessing).transform();
}
private Internalizer(DOMForest forest, boolean enableSCD, boolean disableSecureProcessing) {
this.errorHandler = forest.getErrorHandler();
this.forest = forest;
this.enableSCD = enableSCD;
xpath = XmlFactory.createXPathFactory(disableSecureProcessing).newXPath();
}
/**
* DOMForest object currently being processed.
*/
private final DOMForest forest;
/**
* All errors found during the transformation is sent to this object.
*/
private ErrorReceiver errorHandler;
/**
* If true, the SCD-based target selection is supported.
*/
private boolean enableSCD;
private SCDBasedBindingSet transform() {
// either target nodes are conventional DOM nodes (as per spec),
Map> targetNodes = new HashMap<>();
// ... or it will be schema components by means of SCD (RI extension)
SCDBasedBindingSet scd = new SCDBasedBindingSet(forest);
//
// identify target nodes for all
//
for (Element jaxbBindings : forest.outerMostBindings) {
// initially, the inherited context is itself
buildTargetNodeMap(jaxbBindings, jaxbBindings, null, targetNodes, scd);
}
//
// then move them to their respective positions.
//
for (Element jaxbBindings : forest.outerMostBindings) {
move(jaxbBindings, targetNodes);
}
return scd;
}
/**
* Determines the target node of the "bindings" element
* by using the inherited target node, then put
* the result into the "result" map and the "scd" map.
*
* @param inheritedTarget
* The current target node. This always exists, even if
* the user starts specifying targets via SCD (in that case
* this inherited target is just not going to be used.)
* @param inheritedSCD
* If the ancestor {@code } node specifies @scd to
* specify the target via SCD, then this parameter represents that context.
*/
private void buildTargetNodeMap( Element bindings, @NotNull Node inheritedTarget,
@Nullable SCDBasedBindingSet.Target inheritedSCD,
Map> result, SCDBasedBindingSet scdResult ) {
// start by the inherited target
Node target = inheritedTarget;
ArrayList targetMultiple = null;
// validate this node ?
// validate(bindings);
boolean required = true;
boolean multiple = false;
if(bindings.getAttribute("required") != null) {
String requiredAttr = bindings.getAttribute("required");
if(requiredAttr.equals("no") || requiredAttr.equals("false") || requiredAttr.equals("0"))
required = false;
}
if(bindings.getAttribute("multiple") != null) {
String requiredAttr = bindings.getAttribute("multiple");
if(requiredAttr.equals("yes") || requiredAttr.equals("true") || requiredAttr.equals("1"))
multiple = true;
}
// look for @schemaLocation
if( bindings.getAttributeNode("schemaLocation")!=null ) {
String schemaLocation = bindings.getAttribute("schemaLocation");
// enhancement - schemaLocation="*" = bind to all schemas..
if(schemaLocation.equals("*")) {
for(String systemId : forest.listSystemIDs()) {
result.computeIfAbsent(bindings, k -> new ArrayList<>());
result.get(bindings).add(forest.get(systemId).getDocumentElement());
Element[] children = DOMUtils.getChildElements(bindings, Const.JAXB_NSURI, "bindings");
for (Element value : children)
buildTargetNodeMap(value, forest.get(systemId).getDocumentElement(), inheritedSCD, result, scdResult);
}
return;
} else {
try {
// TODO: use the URI class
// TODO: honor xml:base
URL loc = new URL(
new URL(forest.getSystemId(bindings.getOwnerDocument())), schemaLocation
);
schemaLocation = loc.toExternalForm();
target = forest.get(schemaLocation);
if ((target == null) && (loc.getProtocol().startsWith("file"))) {
File f = new File(loc.getFile());
schemaLocation = new File(f.getCanonicalPath()).toURI().toString();
}
} catch( MalformedURLException e ) {
} catch( IOException e ) {
Logger.getLogger(Internalizer.class.getName()).log(Level.FINEST, e.getLocalizedMessage());
}
target = forest.get(schemaLocation);
if(target==null) {
reportError( bindings,
Messages.format(Messages.ERR_INCORRECT_SCHEMA_REFERENCE,
schemaLocation,
EditDistance.findNearest(schemaLocation,forest.listSystemIDs())));
return; // abort processing this
}
target = ((Document)target).getDocumentElement();
}
}
// look for @node
if( bindings.getAttributeNode("node")!=null ) {
String nodeXPath = bindings.getAttribute("node");
// evaluate this XPath
NodeList nlst;
try {
xpath.setNamespaceContext(new NamespaceContextImpl(bindings));
nlst = (NodeList)xpath.evaluate(nodeXPath,target,XPathConstants.NODESET);
} catch (XPathExpressionException e) {
if(required) {
reportError( bindings,
Messages.format(Messages.ERR_XPATH_EVAL,e.getMessage()), e );
}
return; // abort processing this
}
if( nlst.getLength()==0 ) {
if(required)
reportError( bindings,
Messages.format(Messages.NO_XPATH_EVAL_TO_NO_TARGET, nodeXPath) );
return; // abort
}
if( nlst.getLength()!=1 ) {
if(!multiple) {
reportError( bindings,
Messages.format(Messages.NO_XPATH_EVAL_TOO_MANY_TARGETS, nodeXPath,nlst.getLength()) );
return; // abort
} else {
if(targetMultiple == null) targetMultiple = new ArrayList<>();
for(int i = 0; i < nlst.getLength(); i++) {
targetMultiple.add(nlst.item(i));
}
}
}
// check
if(!multiple || nlst.getLength() == 1) {
Node rnode = nlst.item(0);
if (!(rnode instanceof Element)) {
reportError(bindings,
Messages.format(Messages.NO_XPATH_EVAL_TO_NON_ELEMENT, nodeXPath));
return; // abort
}
if (!forest.logic.checkIfValidTargetNode(forest, bindings, (Element) rnode)) {
reportError(bindings,
Messages.format(Messages.XPATH_EVAL_TO_NON_SCHEMA_ELEMENT,
nodeXPath, rnode.getNodeName()));
return; // abort
}
target = rnode;
} else {
for(Node rnode : targetMultiple) {
if (!(rnode instanceof Element)) {
reportError(bindings,
Messages.format(Messages.NO_XPATH_EVAL_TO_NON_ELEMENT, nodeXPath));
return; // abort
}
if (!forest.logic.checkIfValidTargetNode(forest, bindings, (Element) rnode)) {
reportError(bindings,
Messages.format(Messages.XPATH_EVAL_TO_NON_SCHEMA_ELEMENT,
nodeXPath, rnode.getNodeName()));
return; // abort
}
}
}
}
// look for @scd
if( bindings.getAttributeNode("scd")!=null ) {
String scdPath = bindings.getAttribute("scd");
if(!enableSCD) {
// SCD selector was found, but it's not activated. report an error
// but recover by handling it anyway. this also avoids repeated error messages.
reportError(bindings,
Messages.format(Messages.SCD_NOT_ENABLED));
enableSCD = true;
}
try {
inheritedSCD = scdResult.createNewTarget( inheritedSCD, bindings,
SCD.create(scdPath, new NamespaceContextImpl(bindings)) );
} catch (ParseException e) {
reportError( bindings, Messages.format(Messages.ERR_SCD_EVAL,e.getMessage()),e );
return; // abort processing this bindings
}
}
// update the result map
if (inheritedSCD != null) {
inheritedSCD.addBinidng(bindings);
} else if (!multiple || targetMultiple == null) {
result.computeIfAbsent(bindings, k -> new ArrayList<>());
result.get(bindings).add(target);
} else {
for (Node rnode : targetMultiple) {
result.computeIfAbsent(bindings, k -> new ArrayList<>());
result.get(bindings).add(rnode);
}
}
// look for child and process them recursively
Element[] children = DOMUtils.getChildElements( bindings, Const.JAXB_NSURI, "bindings" );
for (Element value : children)
if(!multiple || targetMultiple == null)
buildTargetNodeMap(value, target, inheritedSCD, result, scdResult);
else {
for(Node rnode : targetMultiple) {
buildTargetNodeMap(value, rnode, inheritedSCD, result, scdResult);
}
}
}
/**
* Moves JAXB customizations under their respective target nodes.
*/
private void move(Element bindings, Map> targetNodes) {
List nodelist = targetNodes.get(bindings);
if(nodelist == null) {
return; // abort
}
for (Node target : nodelist) {
if (target == null) // this must be the result of an error on the external binding.
// recover from the error by ignoring this node
{
return;
}
for (Element item : DOMUtils.getChildElements(bindings)) {
String localName = item.getLocalName();
if ("bindings".equals(localName)) {
// process child recursively
move(item, targetNodes);
} else if ("globalBindings".equals(localName)) {
// always go to the root of document.
Element root = forest.getOneDocument().getDocumentElement();
if (root.getNamespaceURI().equals(WSDL_NS)) {
NodeList elements = root.getElementsByTagNameNS(XMLConstants.W3C_XML_SCHEMA_NS_URI, "schema");
if ((elements == null) || (elements.getLength() < 1)) {
reportError(item, Messages.format(Messages.ORPHANED_CUSTOMIZATION, item.getNodeName()));
return;
} else {
moveUnder(item, (Element)elements.item(0));
}
} else {
moveUnder(item, root);
}
} else {
if (!(target instanceof Element)) {
reportError(item,
Messages.format(Messages.CONTEXT_NODE_IS_NOT_ELEMENT));
return; // abort
}
if (!forest.logic.checkIfValidTargetNode(forest, item, (Element) target)) {
reportError(item,
Messages.format(Messages.ORPHANED_CUSTOMIZATION, item.getNodeName()));
return; // abort
}
// move this node under the target
moveUnder(item, (Element) target);
}
}
}
}
/**
* Moves the "decl" node under the "target" node.
*
* @param decl
* A JAXB customization element (e.g., {@code })
*
* @param target
* XML Schema element under which the declaration should move.
* For example, {@code }
*/
private void moveUnder( Element decl, Element target ) {
Element realTarget = forest.logic.refineTarget(target);
declExtensionNamespace( decl, target );
// copy in-scope namespace declarations of the decl node
// to the decl node itself so that this move won't change
// the in-scope namespace bindings.
Element p = decl;
Set inscopes = new HashSet<>();
while(true) {
NamedNodeMap atts = p.getAttributes();
for( int i=0; i
* Note that this method doesn't use the default namespace
* even if it can.
*/
private String allocatePrefix( Element e, String nsUri ) {
// look for existing namespaces.
NamedNodeMap atts = e.getAttributes();
for( int i=0; i