yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/XMLStreamNormalizedNodeStreamWriter.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.data.codec.xml;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.base.Strings;
  14 import java.io.IOException;
  15 import java.io.StringWriter;
  16 import java.net.URI;
  17 import java.util.Map;
  18 import java.util.Map.Entry;
  19 import java.util.Set;
  20 import java.util.concurrent.ConcurrentHashMap;
  21 import javax.annotation.Nonnull;
  22 import javax.annotation.Nullable;
  23 import javax.xml.XMLConstants;
  24 import javax.xml.namespace.NamespaceContext;
  25 import javax.xml.stream.XMLStreamException;
  26 import javax.xml.stream.XMLStreamWriter;
  27 import javax.xml.transform.OutputKeys;
  28 import javax.xml.transform.Transformer;
  29 import javax.xml.transform.TransformerException;
  30 import javax.xml.transform.TransformerFactory;
  31 import javax.xml.transform.TransformerFactoryConfigurationError;
  32 import javax.xml.transform.dom.DOMSource;
  33 import javax.xml.transform.stax.StAXResult;
  34 import javax.xml.transform.stream.StreamResult;
  35 import org.opendaylight.yangtools.yang.common.QName;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  39 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamAttributeWriter;
  40 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  41 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  42 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45 import org.w3c.dom.Element;
  46
  47 /**
  48  * A {@link NormalizedNodeStreamWriter} which translates the events into an {@link XMLStreamWriter},
  49  * resulting in a RFC 6020 XML encoding. There are 2 versions of this class, one that takes a
  50  * SchemaContext and encodes values appropriately according to the yang schema. The other is
  51  * schema-less and merely outputs values using toString. The latter is intended for debugging
  52  * where doesn't have a SchemaContext available and isn't meant for production use.
  53  */
  54 public abstract class XMLStreamNormalizedNodeStreamWriter<T> implements NormalizedNodeStreamAttributeWriter {
  55     private static final Logger LOG = LoggerFactory.getLogger(XMLStreamNormalizedNodeStreamWriter.class);
  56     private static final String COM_SUN_TRANSFORMER =
  57         "com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl";
  58
  59     private static final TransformerFactory TRANSFORMER_FACTORY;
  60
  61     static {
  62         TransformerFactory fa = TransformerFactory.newInstance();
  63         if (!fa.getFeature(StAXResult.FEATURE)) {
  64             LOG.warn("Platform-default TransformerFactory {} does not support StAXResult, attempting fallback to {}",
  65                     fa, COM_SUN_TRANSFORMER);
  66             fa = TransformerFactory.newInstance(COM_SUN_TRANSFORMER, null);
  67             if (!fa.getFeature(StAXResult.FEATURE)) {
  68                 throw new TransformerFactoryConfigurationError("No TransformerFactory supporting StAXResult found.");
  69             }
  70         }
  71
  72         TRANSFORMER_FACTORY = fa;
  73     }
  74
  75     private static final Set<String> BROKEN_NAMESPACES = ConcurrentHashMap.newKeySet();
  76
  77     private final RandomPrefix prefixes;
  78     final XMLStreamWriter writer;
  79
  80     XMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer) {
  81         this.writer = requireNonNull(writer);
  82         this.prefixes = new RandomPrefix(writer.getNamespaceContext());
  83     }
  84
  85     /**
  86      * Create a new writer with the specified context as its root.
  87      *
  88      * @param writer Output {@link XMLStreamWriter}
  89      * @param context Associated {@link SchemaContext}.
  90      * @return A new {@link NormalizedNodeStreamWriter}
  91      */
  92     public static NormalizedNodeStreamWriter create(final XMLStreamWriter writer, final SchemaContext context) {
  93         return create(writer, context, SchemaPath.ROOT);
  94     }
  95
  96     /**
  97      * Create a new writer with the specified context and rooted in the specified schema path.
  98      *
  99      * @param writer Output {@link XMLStreamWriter}
 100      * @param context Associated {@link SchemaContext}.
 101      * @param path path
 102      *
 103      * @return A new {@link NormalizedNodeStreamWriter}
 104      */
 105     public static NormalizedNodeStreamWriter create(final XMLStreamWriter writer, final SchemaContext context,
 106             final SchemaPath path) {
 107         return SchemaAwareXMLStreamNormalizedNodeStreamWriter.newInstance(writer, context, path);
 108     }
 109
 110     /**
 111      * Create a new schema-less writer. Note that this version is intended for debugging
 112      * where doesn't have a SchemaContext available and isn't meant for production use.
 113      *
 114      * @param writer Output {@link XMLStreamWriter}
 115      *
 116      * @return A new {@link NormalizedNodeStreamWriter}
 117      */
 118     public static NormalizedNodeStreamWriter createSchemaless(final XMLStreamWriter writer) {
 119         return SchemalessXMLStreamNormalizedNodeStreamWriter.newInstance(writer);
 120     }
 121
 122     abstract void writeValue(XMLStreamWriter xmlWriter, QName qname, @Nonnull Object value, T context)
 123             throws IOException, XMLStreamException;
 124
 125     abstract void startList(NodeIdentifier name);
 126
 127     abstract void startListItem(PathArgument name) throws IOException;
 128
 129     private void writeAttributes(@Nonnull final Map<QName, String> attributes) throws IOException {
 130         for (final Entry<QName, String> entry : attributes.entrySet()) {
 131             try {
 132                 final QName qname = entry.getKey();
 133                 final String namespace = qname.getNamespace().toString();
 134
 135                 if (!Strings.isNullOrEmpty(namespace)) {
 136                     final String prefix = getPrefix(qname.getNamespace(), namespace);
 137                     writer.writeAttribute(prefix, namespace, qname.getLocalName(), entry.getValue());
 138                 } else {
 139                     writer.writeAttribute(qname.getLocalName(), entry.getValue());
 140                 }
 141             } catch (final XMLStreamException e) {
 142                 throw new IOException("Unable to emit attribute " + entry, e);
 143             }
 144         }
 145     }
 146
 147     private String getPrefix(final URI uri, final String str) throws XMLStreamException {
 148         final String prefix = writer.getPrefix(str);
 149         if (prefix != null) {
 150             return prefix;
 151         }
 152
 153         // This is needed to recover from attributes emitted while the namespace was not declared. Ordinarily
 154         // attribute namespaces would be bound in the writer, so the resulting XML is efficient, but we cannot rely
 155         // on that having been done.
 156         if (BROKEN_NAMESPACES.add(str)) {
 157             LOG.info("Namespace {} was not bound, please fix the caller", str, new Throwable());
 158         }
 159
 160         return prefixes.encodePrefix(uri);
 161     }
 162
 163     private void writeStartElement(final QName qname) throws XMLStreamException {
 164         String ns = qname.getNamespace().toString();
 165         writer.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, qname.getLocalName(), ns);
 166         if (writer.getNamespaceContext() != null) {
 167             String parentNs = writer.getNamespaceContext().getNamespaceURI(XMLConstants.DEFAULT_NS_PREFIX);
 168             if (!ns.equals(parentNs)) {
 169                 writer.writeDefaultNamespace(ns);
 170             }
 171         }
 172     }
 173
 174     void writeElement(final QName qname, final Object value, @Nullable final Map<QName, String> attributes,
 175             final T context) throws IOException {
 176         try {
 177             writeStartElement(qname);
 178
 179             writeAttributes(attributes);
 180             if (value != null) {
 181                 writeValue(writer, qname, value, context);
 182             }
 183             writer.writeEndElement();
 184         } catch (XMLStreamException e) {
 185             throw new IOException("Failed to emit element", e);
 186         }
 187     }
 188
 189     void startElement(final QName qname) throws IOException {
 190         try {
 191             writeStartElement(qname);
 192         } catch (XMLStreamException e) {
 193             throw new IOException("Failed to start element", e);
 194         }
 195     }
 196
 197     void anyxmlNode(final QName qname, final Object value) throws IOException {
 198         if (value != null) {
 199             checkArgument(value instanceof DOMSource, "AnyXML value must be DOMSource, not %s", value);
 200             final DOMSource domSource = (DOMSource) value;
 201             requireNonNull(domSource.getNode());
 202             checkArgument(domSource.getNode().getNodeName().equals(qname.getLocalName()));
 203             checkArgument(domSource.getNode().getNamespaceURI().equals(qname.getNamespace().toString()));
 204             try {
 205                 // TODO can the transformer be a constant ? is it thread safe ?
 206                 final Transformer transformer = TRANSFORMER_FACTORY.newTransformer();
 207                 // Writer has to be wrapped in a wrapper that ignores endDocument event
 208                 // EndDocument event forbids any other modification to the writer so a nested anyXml breaks
 209                 // serialization
 210                 transformer.transform(domSource, new StAXResult(new DelegateWriterNoEndDoc(writer)));
 211             } catch (final TransformerException e) {
 212                 throw new IOException("Unable to transform anyXml(" + qname + ") value: " + value, e);
 213             }
 214         }
 215     }
 216
 217     @Override
 218     public final void startContainerNode(final NodeIdentifier name, final int childSizeHint,
 219                                          final Map<QName, String> attributes) throws IOException {
 220         startContainerNode(name, childSizeHint);
 221         writeAttributes(attributes);
 222     }
 223
 224     @Override
 225     public final void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint,
 226                                                  final Map<QName, String> attributes) throws IOException {
 227         startYangModeledAnyXmlNode(name, childSizeHint);
 228         writeAttributes(attributes);
 229     }
 230
 231     @Override
 232     public final void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint,
 233                                            final Map<QName, String> attributes) throws IOException {
 234         startUnkeyedListItem(name, childSizeHint);
 235         writeAttributes(attributes);
 236     }
 237
 238     @Override
 239     public final void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException {
 240         startListItem(name);
 241     }
 242
 243     @Override
 244     public final void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint,
 245                                         final Map<QName, String> attributes) throws IOException {
 246         startMapEntryNode(identifier, childSizeHint);
 247         writeAttributes(attributes);
 248     }
 249
 250     @Override
 251     public final void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint)
 252             throws IOException {
 253         startListItem(identifier);
 254     }
 255
 256     @Override
 257     public final void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) {
 258         startList(name);
 259     }
 260
 261     @Override
 262     public final void startMapNode(final NodeIdentifier name, final int childSizeHint) {
 263         startList(name);
 264     }
 265
 266     @Override
 267     public final void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) {
 268         startList(name);
 269     }
 270
 271     public static String toString(final Element xml) {
 272         try {
 273             final Transformer transformer = TRANSFORMER_FACTORY.newTransformer();
 274             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 275
 276             final StreamResult result = new StreamResult(new StringWriter());
 277             final DOMSource source = new DOMSource(xml);
 278             transformer.transform(source, result);
 279
 280             return result.getWriter().toString();
 281         } catch (IllegalArgumentException | TransformerException e) {
 282             throw new IllegalStateException("Unable to serialize xml element " + xml, e);
 283         }
 284     }
 285
 286     abstract void endNode(XMLStreamWriter xmlWriter) throws IOException, XMLStreamException;
 287
 288     @Override
 289     public final void endNode() throws IOException {
 290         try {
 291             endNode(writer);
 292         } catch (XMLStreamException e) {
 293             throw new IOException("Failed to end element", e);
 294         }
 295     }
 296
 297     @Override
 298     public final void close() throws IOException {
 299         try {
 300             writer.close();
 301         } catch (XMLStreamException e) {
 302             throw new IOException("Failed to close writer", e);
 303         }
 304     }
 305
 306     @Override
 307     public final void flush() throws IOException {
 308         try {
 309             writer.flush();
 310         } catch (XMLStreamException e) {
 311             throw new IOException("Failed to flush writer", e);
 312         }
 313     }
 314
 315     /**
 316      * Delegate writer that ignores writeEndDocument event. Used for AnyXml serialization.
 317      */
 318     private static final class DelegateWriterNoEndDoc implements XMLStreamWriter {
 319         private final XMLStreamWriter writer;
 320
 321         DelegateWriterNoEndDoc(final XMLStreamWriter writer) {
 322             this.writer = writer;
 323         }
 324
 325         @Override
 326         public void writeStartElement(final String localName) throws XMLStreamException {
 327             writer.writeStartElement(localName);
 328         }
 329
 330         @Override
 331         public void writeStartElement(final String namespaceURI, final String localName) throws XMLStreamException {
 332             writer.writeStartElement(namespaceURI, localName);
 333         }
 334
 335         @Override
 336         public void writeStartElement(final String prefix, final String localName, final String namespaceURI)
 337                 throws XMLStreamException {
 338             writer.writeStartElement(prefix, localName, namespaceURI);
 339         }
 340
 341         @Override
 342         public void writeEmptyElement(final String namespaceURI, final String localName) throws XMLStreamException {
 343             writer.writeEmptyElement(namespaceURI, localName);
 344         }
 345
 346         @Override
 347         public void writeEmptyElement(final String prefix, final String localName, final String namespaceURI)
 348                 throws XMLStreamException {
 349             writer.writeEmptyElement(prefix, localName, namespaceURI);
 350         }
 351
 352         @Override
 353         public void writeEmptyElement(final String localName) throws XMLStreamException {
 354             writer.writeEmptyElement(localName);
 355         }
 356
 357         @Override
 358         public void writeEndElement() throws XMLStreamException {
 359             writer.writeEndElement();
 360
 361         }
 362
 363         @Override
 364         public void writeEndDocument() throws XMLStreamException {
 365             // End document is disabled
 366         }
 367
 368         @Override
 369         public void close() throws XMLStreamException {
 370             writer.close();
 371         }
 372
 373         @Override
 374         public void flush() throws XMLStreamException {
 375             writer.flush();
 376         }
 377
 378         @Override
 379         public void writeAttribute(final String localName, final String value) throws XMLStreamException {
 380             writer.writeAttribute(localName, value);
 381         }
 382
 383         @Override
 384         public void writeAttribute(final String prefix, final String namespaceURI, final String localName,
 385                                    final String value) throws XMLStreamException {
 386             writer.writeAttribute(prefix, namespaceURI, localName, value);
 387         }
 388
 389         @Override
 390         public void writeAttribute(final String namespaceURI, final String localName, final String value)
 391                 throws XMLStreamException {
 392             writer.writeAttribute(namespaceURI, localName, value);
 393         }
 394
 395         @Override
 396         public void writeNamespace(final String prefix, final String namespaceURI) throws XMLStreamException {
 397             // Workaround for default namespace
 398             // If a namespace is not prefixed, it is is still treated as prefix namespace.
 399             // This results in the NamespaceSupport class ignoring the namespace since xmlns is not a valid prefix
 400             // Write the namespace at least as an attribute
 401             // TODO this is a hotfix, the transformer itself should write namespaces passing the namespace
 402             // in writeStartElement method
 403             if (prefix.equals("xml") || prefix.equals("xmlns")) {
 404                 writer.writeAttribute(prefix, namespaceURI);
 405             } else {
 406                 writer.writeNamespace(prefix, namespaceURI);
 407             }
 408         }
 409
 410         @Override
 411         public void writeDefaultNamespace(final String namespaceURI) throws XMLStreamException {
 412             writer.writeDefaultNamespace(namespaceURI);
 413         }
 414
 415         @Override
 416         public void writeComment(final String data) throws XMLStreamException {
 417             writer.writeComment(data);
 418         }
 419
 420         @Override
 421         public void writeProcessingInstruction(final String target) throws XMLStreamException {
 422             writer.writeProcessingInstruction(target);
 423         }
 424
 425         @Override
 426         public void writeProcessingInstruction(final String target, final String data) throws XMLStreamException {
 427             writer.writeProcessingInstruction(target, data);
 428         }
 429
 430         @Override
 431         public void writeCData(final String data) throws XMLStreamException {
 432             writer.writeCData(data);
 433         }
 434
 435         @Override
 436         public void writeDTD(final String dtd) throws XMLStreamException {
 437             writer.writeDTD(dtd);
 438         }
 439
 440         @Override
 441         public void writeEntityRef(final String name) throws XMLStreamException {
 442             writer.writeEntityRef(name);
 443         }
 444
 445         @Override
 446         public void writeStartDocument() throws XMLStreamException {
 447         }
 448
 449         @Override
 450         public void writeStartDocument(final String version) throws XMLStreamException {
 451         }
 452
 453         @Override
 454         public void writeStartDocument(final String encoding, final String version) throws XMLStreamException {
 455         }
 456
 457         @Override
 458         public void writeCharacters(final String text) throws XMLStreamException {
 459             writer.writeCharacters(text);
 460         }
 461
 462         @Override
 463         public void writeCharacters(final char[] text, final int start, final int len) throws XMLStreamException {
 464             writer.writeCharacters(text, start, len);
 465         }
 466
 467         @Override
 468         public String getPrefix(final String uri) throws XMLStreamException {
 469             return writer.getPrefix(uri);
 470         }
 471
 472         @Override
 473         public void setPrefix(final String prefix, final String uri) throws XMLStreamException {
 474             // Disabled since it causes exceptions in the underlying writer
 475         }
 476
 477         @Override
 478         public void setDefaultNamespace(final String uri) throws XMLStreamException {
 479             writer.setDefaultNamespace(uri);
 480         }
 481
 482         @Override
 483         public void setNamespaceContext(final NamespaceContext context) throws XMLStreamException {
 484             writer.setNamespaceContext(context);
 485         }
 486
 487         @Override
 488         public NamespaceContext getNamespaceContext() {
 489             return writer.getNamespaceContext();
 490         }
 491
 492         @Override
 493         public Object getProperty(final String name) {
 494             return writer.getProperty(name);
 495         }
 496     }
 497 }