netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/ops/EditConfig.java

   1 /*
   2  * Copyright (c) 2015 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
   9 package org.opendaylight.netconf.mdsal.connector.ops;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.ImmutableMap;
  14 import java.net.URI;
  15 import java.net.URISyntaxException;
  16 import java.util.List;
  17 import java.util.ListIterator;
  18 import java.util.Map;
  19 import java.util.stream.Collectors;
  20 import javax.xml.transform.dom.DOMSource;
  21 import org.opendaylight.controller.config.util.xml.DocumentedException;
  22 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorSeverity;
  23 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorTag;
  24 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorType;
  25 import org.opendaylight.controller.config.util.xml.XmlElement;
  26 import org.opendaylight.controller.config.util.xml.XmlUtil;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  29 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  30 import org.opendaylight.netconf.api.NetconfDocumentedException;
  31 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  32 import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
  33 import org.opendaylight.netconf.mdsal.connector.TransactionProvider;
  34 import org.opendaylight.netconf.mdsal.connector.ops.DataTreeChangeTracker.DataTreeChange;
  35 import org.opendaylight.netconf.util.mapping.AbstractSingletonNetconfOperation;
  36 import org.opendaylight.yangtools.yang.common.QName;
  37 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  44 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  47 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  50 import org.opendaylight.yangtools.yang.model.api.Module;
  51 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  52 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55 import org.w3c.dom.Document;
  56 import org.w3c.dom.Element;
  57 import org.w3c.dom.NodeList;
  58
  59 public class EditConfig extends AbstractSingletonNetconfOperation {
  60
  61     private static final Logger LOG = LoggerFactory.getLogger(EditConfig.class);
  62
  63     private static final String OPERATION_NAME = "edit-config";
  64     private static final String CONFIG_KEY = "config";
  65     private static final String TARGET_KEY = "target";
  66     private static final String DEFAULT_OPERATION_KEY = "default-operation";
  67     private final CurrentSchemaContext schemaContext;
  68     private final TransactionProvider transactionProvider;
  69
  70     public EditConfig(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext,
  71             final TransactionProvider transactionProvider) {
  72         super(netconfSessionIdForReporting);
  73         this.schemaContext = schemaContext;
  74         this.transactionProvider = transactionProvider;
  75     }
  76
  77     @Override
  78     protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement)
  79             throws DocumentedException {
  80         final Datastore targetDatastore = extractTargetParameter(operationElement);
  81         if (targetDatastore == Datastore.running) {
  82             throw new DocumentedException("edit-config on running datastore is not supported",
  83                     ErrorType.PROTOCOL,
  84                     ErrorTag.OPERATION_NOT_SUPPORTED,
  85                     ErrorSeverity.ERROR);
  86         }
  87
  88         final ModifyAction defaultAction = getDefaultOperation(operationElement);
  89
  90         final XmlElement configElement = getElement(operationElement, CONFIG_KEY);
  91
  92         for (final XmlElement element : configElement.getChildElements()) {
  93             final String ns = element.getNamespace();
  94             final DataSchemaNode schemaNode = getSchemaNodeFromNamespace(ns, element).get();
  95
  96             final DataTreeChangeTracker changeTracker = new DataTreeChangeTracker(defaultAction);
  97
  98             parseIntoNormalizedNode(schemaNode, element, changeTracker);
  99             executeOperations(changeTracker);
 100         }
 101
 102         return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.absent());
 103     }
 104
 105     private void executeOperations(final DataTreeChangeTracker changeTracker) throws DocumentedException {
 106         final DOMDataReadWriteTransaction rwTx = transactionProvider.getOrCreateTransaction();
 107         final List<DataTreeChange> aa = changeTracker.getDataTreeChanges();
 108         final ListIterator<DataTreeChange> iterator = aa.listIterator(aa.size());
 109
 110         while (iterator.hasPrevious()) {
 111             final DataTreeChange dtc = iterator.previous();
 112             executeChange(rwTx, dtc);
 113         }
 114     }
 115
 116     private void executeChange(final DOMDataReadWriteTransaction rwtx, final DataTreeChange change)
 117             throws DocumentedException {
 118         final YangInstanceIdentifier path = YangInstanceIdentifier.create(change.getPath());
 119         final NormalizedNode<?, ?> changeData = change.getChangeRoot();
 120         switch (change.getAction()) {
 121             case NONE:
 122                 return;
 123             case MERGE:
 124                 mergeParentMixin(rwtx, path, changeData);
 125                 rwtx.merge(LogicalDatastoreType.CONFIGURATION, path, changeData);
 126                 break;
 127             case CREATE:
 128                 try {
 129                     final Optional<NormalizedNode<?, ?>> readResult =
 130                             rwtx.read(LogicalDatastoreType.CONFIGURATION, path).checkedGet();
 131                     if (readResult.isPresent()) {
 132                         throw new DocumentedException("Data already exists, cannot execute CREATE operation",
 133                             ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS, ErrorSeverity.ERROR);
 134                     }
 135                     mergeParentMixin(rwtx, path, changeData);
 136                     rwtx.put(LogicalDatastoreType.CONFIGURATION, path, changeData);
 137                 } catch (final ReadFailedException e) {
 138                     LOG.warn("Read from datastore failed when trying to read data for create operation", change, e);
 139                 }
 140                 break;
 141             case REPLACE:
 142                 mergeParentMixin(rwtx, path, changeData);
 143                 rwtx.put(LogicalDatastoreType.CONFIGURATION, path, changeData);
 144                 break;
 145             case DELETE:
 146                 try {
 147                     final Optional<NormalizedNode<?, ?>> readResult =
 148                             rwtx.read(LogicalDatastoreType.CONFIGURATION, path).checkedGet();
 149                     if (!readResult.isPresent()) {
 150                         throw new DocumentedException("Data is missing, cannot execute DELETE operation",
 151                             ErrorType.PROTOCOL, ErrorTag.DATA_MISSING, ErrorSeverity.ERROR);
 152                     }
 153                     rwtx.delete(LogicalDatastoreType.CONFIGURATION, path);
 154                 } catch (final ReadFailedException e) {
 155                     LOG.warn("Read from datastore failed when trying to read data for delete operation", change, e);
 156                 }
 157                 break;
 158             case REMOVE:
 159                 rwtx.delete(LogicalDatastoreType.CONFIGURATION, path);
 160                 break;
 161             default:
 162                 LOG.warn("Unknown/not implemented operation, not executing");
 163         }
 164     }
 165
 166     private void mergeParentMixin(final DOMDataReadWriteTransaction rwtx, final YangInstanceIdentifier path,
 167                                 final NormalizedNode change) {
 168         final YangInstanceIdentifier parentNodeYid = path.getParent();
 169         if (change instanceof MapEntryNode) {
 170             final SchemaNode schemaNode = SchemaContextUtil.findNodeInSchemaContext(
 171                     schemaContext.getCurrentContext(),
 172                     parentNodeYid.getPathArguments().stream()
 173                             // filter out identifiers not present in the schema tree
 174                             .filter(arg -> !(arg instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates))
 175                             .filter(arg -> !(arg instanceof YangInstanceIdentifier.AugmentationIdentifier))
 176                             .map(YangInstanceIdentifier.PathArgument::getNodeType).collect(Collectors.toList()));
 177
 178             // we should have the schema node that points to the parent list now, enforce it
 179             Preconditions.checkState(schemaNode instanceof ListSchemaNode, "Schema node is not pointing to a list.");
 180
 181             //merge empty ordered or unordered map
 182             if (((ListSchemaNode) schemaNode).isUserOrdered()) {
 183                 final MapNode mixinNode = Builders.orderedMapBuilder()
 184                         .withNodeIdentifier(
 185                                 new YangInstanceIdentifier.NodeIdentifier(
 186                                         parentNodeYid.getLastPathArgument().getNodeType()))
 187                         .build();
 188                 rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, mixinNode);
 189                 return;
 190             }
 191
 192             final MapNode mixinNode = Builders.mapBuilder()
 193                     .withNodeIdentifier(
 194                             new YangInstanceIdentifier.NodeIdentifier(
 195                                         parentNodeYid.getLastPathArgument().getNodeType()))
 196                     .build();
 197             rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, mixinNode);
 198         } else if (parentNodeYid.getLastPathArgument() instanceof YangInstanceIdentifier.AugmentationIdentifier) {
 199             // merge empty augmentation node
 200             final YangInstanceIdentifier.AugmentationIdentifier augmentationYid =
 201                 (YangInstanceIdentifier.AugmentationIdentifier) parentNodeYid.getLastPathArgument();
 202             final AugmentationNode augmentationNode = Builders.augmentationBuilder()
 203                 .withNodeIdentifier(augmentationYid).build();
 204             rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, augmentationNode);
 205         }
 206     }
 207
 208     @SuppressWarnings("checkstyle:IllegalCatch")
 209     private NormalizedNode<?, ?> parseIntoNormalizedNode(final DataSchemaNode schemaNode, final XmlElement element,
 210             final DataTreeChangeTracker changeTracker) throws DocumentedException {
 211         if (!(schemaNode instanceof ContainerSchemaNode) && !(schemaNode instanceof ListSchemaNode)) {
 212             //this should never happen since edit-config on any other node type should not be possible nor makes sense
 213             LOG.debug("DataNode from module is not ContainerSchemaNode nor ListSchemaNode, aborting..");
 214             throw new UnsupportedOperationException("implement exception if parse fails");
 215         }
 216
 217         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 218         final NormalizedNodeStreamWriter writer = new EditOperationNormalizedNodeStreamWriter(resultHolder,
 219                 changeTracker);
 220         final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext.getCurrentContext(), schemaNode);
 221         try {
 222             xmlParser.traverse(new DOMSource(element.getDomElement()));
 223         } catch (final Exception ex) {
 224             throw new NetconfDocumentedException("Error parsing input: " + ex.getMessage(), ex, ErrorType.PROTOCOL,
 225                     ErrorTag.MALFORMED_MESSAGE, ErrorSeverity.ERROR);
 226         }
 227
 228         return resultHolder.getResult();
 229     }
 230
 231     private Optional<DataSchemaNode> getSchemaNodeFromNamespace(final String namespace, final XmlElement element)
 232             throws DocumentedException {
 233         Optional<DataSchemaNode> dataSchemaNode = Optional.absent();
 234         try {
 235             // returns module with newest revision since findModuleByNamespace returns a set of modules and we only
 236             // need the newest one
 237             final Module module =
 238                     schemaContext.getCurrentContext().findModuleByNamespaceAndRevision(new URI(namespace), null);
 239             if (module == null) {
 240                 // no module is present with this namespace
 241                 throw new NetconfDocumentedException("Unable to find module by namespace: " + namespace,
 242                         ErrorType.APPLICATION, ErrorTag.UNKNOWN_NAMESPACE, ErrorSeverity.ERROR);
 243             }
 244             final DataSchemaNode schemaNode =
 245                     module.getDataChildByName(QName.create(module.getQNameModule(), element.getName()));
 246             if (schemaNode != null) {
 247                 dataSchemaNode = Optional.of(schemaNode);
 248             } else {
 249                 throw new DocumentedException(
 250                         "Unable to find node with namespace: " + namespace + "in module: " + module.toString(),
 251                         ErrorType.APPLICATION,
 252                         ErrorTag.UNKNOWN_NAMESPACE,
 253                         ErrorSeverity.ERROR);
 254             }
 255         } catch (final URISyntaxException e) {
 256             LOG.debug("Unable to create URI for namespace : {}", namespace);
 257         }
 258
 259         return dataSchemaNode;
 260     }
 261
 262     private static Datastore extractTargetParameter(final XmlElement operationElement) throws DocumentedException {
 263         final NodeList elementsByTagName = operationElement.getDomElement().getElementsByTagName(TARGET_KEY);
 264         // Direct lookup instead of using XmlElement class due to performance
 265         if (elementsByTagName.getLength() == 0) {
 266             final Map<String, String> errorInfo = ImmutableMap.of("bad-attribute", TARGET_KEY, "bad-element",
 267                 OPERATION_NAME);
 268             throw new DocumentedException("Missing target element", ErrorType.PROTOCOL, ErrorTag.MISSING_ATTRIBUTE,
 269                 ErrorSeverity.ERROR, errorInfo);
 270         } else if (elementsByTagName.getLength() > 1) {
 271             throw new DocumentedException("Multiple target elements", ErrorType.RPC, ErrorTag.UNKNOWN_ATTRIBUTE,
 272                 ErrorSeverity.ERROR);
 273         } else {
 274             final XmlElement targetChildNode =
 275                     XmlElement.fromDomElement((Element) elementsByTagName.item(0)).getOnlyChildElement();
 276             return Datastore.valueOf(targetChildNode.getName());
 277         }
 278     }
 279
 280     private static ModifyAction getDefaultOperation(final XmlElement operationElement) throws DocumentedException {
 281         final NodeList elementsByTagName = operationElement.getDomElement().getElementsByTagName(DEFAULT_OPERATION_KEY);
 282         if (elementsByTagName.getLength() == 0) {
 283             return ModifyAction.MERGE;
 284         } else if (elementsByTagName.getLength() > 1) {
 285             throw new DocumentedException("Multiple " + DEFAULT_OPERATION_KEY + " elements", ErrorType.RPC,
 286                 ErrorTag.UNKNOWN_ATTRIBUTE, ErrorSeverity.ERROR);
 287         } else {
 288             return ModifyAction.fromXmlValue(elementsByTagName.item(0).getTextContent());
 289         }
 290
 291     }
 292
 293     private static XmlElement getElement(final XmlElement operationElement, final String elementName)
 294             throws DocumentedException {
 295         final Optional<XmlElement> childNode = operationElement.getOnlyChildElementOptionally(elementName);
 296         if (!childNode.isPresent()) {
 297             throw new DocumentedException(elementName + " element is missing",
 298                     ErrorType.PROTOCOL,
 299                     ErrorTag.MISSING_ELEMENT,
 300                     ErrorSeverity.ERROR);
 301         }
 302
 303         return childNode.get();
 304     }
 305
 306     @Override
 307     protected String getOperationName() {
 308         return OPERATION_NAME;
 309     }
 310
 311 }