plugins/netconf-client-mdsal/src/main/java/org/opendaylight/netconf/client/mdsal/LibraryModulesSchemas.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 package org.opendaylight.netconf.client.mdsal;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static java.util.Objects.requireNonNull;
  13 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_DATA_NODEID;
  14 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_GET_NODEID;
  15 import static org.opendaylight.yang.svc.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.YangModuleInfoImpl.qnameOf;
  16
  17 import com.google.common.base.Strings;
  18 import com.google.common.collect.ImmutableMap;
  19 import com.google.common.util.concurrent.FutureCallback;
  20 import com.google.common.util.concurrent.Futures;
  21 import com.google.common.util.concurrent.ListenableFuture;
  22 import com.google.common.util.concurrent.MoreExecutors;
  23 import com.google.common.util.concurrent.SettableFuture;
  24 import com.google.gson.stream.JsonReader;
  25 import java.io.IOException;
  26 import java.io.InputStream;
  27 import java.io.InputStreamReader;
  28 import java.net.HttpURLConnection;
  29 import java.net.MalformedURLException;
  30 import java.net.URL;
  31 import java.net.URLConnection;
  32 import java.nio.charset.Charset;
  33 import java.nio.charset.StandardCharsets;
  34 import java.util.Base64;
  35 import java.util.HashMap;
  36 import java.util.Map;
  37 import java.util.Map.Entry;
  38 import java.util.Optional;
  39 import java.util.regex.Pattern;
  40 import javax.xml.parsers.DocumentBuilder;
  41 import javax.xml.stream.XMLStreamException;
  42 import javax.xml.transform.dom.DOMSource;
  43 import org.eclipse.jdt.annotation.NonNull;
  44 import org.eclipse.jdt.annotation.Nullable;
  45 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
  46 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  47 import org.opendaylight.netconf.client.mdsal.api.NetconfRpcService;
  48 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceId;
  49 import org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Get;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.ModulesState;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.YangLibrary;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module;
  54 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  55 import org.opendaylight.yangtools.yang.common.ErrorSeverity;
  56 import org.opendaylight.yangtools.yang.common.OperationFailedException;
  57 import org.opendaylight.yangtools.yang.common.QName;
  58 import org.opendaylight.yangtools.yang.common.Revision;
  59 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  60 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  61 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  62 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  63 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  64 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  65 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  66 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  67 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  68 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizationResult;
  69 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  70 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
  71 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
  72 import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
  73 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  74 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  75 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
  76 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
  77 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  78 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
  79 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  80 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
  81 import org.slf4j.Logger;
  82 import org.slf4j.LoggerFactory;
  83 import org.w3c.dom.Document;
  84 import org.w3c.dom.Element;
  85 import org.w3c.dom.Node;
  86 import org.xml.sax.SAXException;
  87
  88 /**
  89  * Holds URLs with YANG schema resources for all yang modules reported in
  90  * ietf-netconf-yang-library/modules-state/modules node.
  91  */
  92 public final class LibraryModulesSchemas {
  93     private static final Logger LOG = LoggerFactory.getLogger(LibraryModulesSchemas.class);
  94     private static final Pattern DATE_PATTERN = Pattern.compile("(\\d{4}-\\d{2}-\\d{2})");
  95     private static final EffectiveModelContext LIBRARY_CONTEXT = BindingRuntimeHelpers.createEffectiveModel(
  96         YangLibrary.class);
  97     private static final Inference MODULES_STATE_INFERENCE =
  98         SchemaInferenceStack.ofDataTreePath(LIBRARY_CONTEXT, ModulesState.QNAME).toInference();
  99
 100     // FIXME: this is legacy RFC7895, add support for RFC8525 containers, too
 101     private static final NodeIdentifier MODULES_STATE_NID = NodeIdentifier.create(ModulesState.QNAME);
 102     private static final NodeIdentifier MODULE_NID = NodeIdentifier.create(Module.QNAME);
 103     private static final NodeIdentifier NAME_NID = NodeIdentifier.create(qnameOf("name"));
 104     private static final NodeIdentifier REVISION_NID = NodeIdentifier.create(qnameOf("revision"));
 105     private static final NodeIdentifier SCHEMA_NID = NodeIdentifier.create(qnameOf("schema"));
 106     private static final NodeIdentifier NAMESPACE_NID = NodeIdentifier.create(qnameOf("namespace"));
 107
 108     private static final JSONCodecFactory JSON_CODECS = JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02
 109             .getShared(LIBRARY_CONTEXT);
 110
 111     private static final YangInstanceIdentifier MODULES_STATE_MODULE_LIST =
 112             YangInstanceIdentifier.of(MODULES_STATE_NID, MODULE_NID);
 113
 114     private static final @NonNull ContainerNode GET_MODULES_STATE_MODULE_LIST_RPC = ImmutableNodes.newContainerBuilder()
 115             .withNodeIdentifier(NETCONF_GET_NODEID)
 116             .withChild(NetconfMessageTransformUtil.toFilterStructure(MODULES_STATE_MODULE_LIST, LIBRARY_CONTEXT))
 117             .build();
 118     private static final @NonNull LibraryModulesSchemas EMPTY = new LibraryModulesSchemas(ImmutableMap.of());
 119
 120     private final ImmutableMap<QName, URL> availableModels;
 121
 122     private LibraryModulesSchemas(final ImmutableMap<QName, URL> availableModels) {
 123         this.availableModels = requireNonNull(availableModels);
 124     }
 125
 126     // FIXME: this should work on NetconfRpcService
 127     public static ListenableFuture<LibraryModulesSchemas> forDevice(final NetconfRpcService deviceRpc,
 128             final RemoteDeviceId deviceId) {
 129         final var future = SettableFuture.<LibraryModulesSchemas>create();
 130         Futures.addCallback(deviceRpc.invokeNetconf(Get.QNAME, GET_MODULES_STATE_MODULE_LIST_RPC),
 131             new FutureCallback<DOMRpcResult>() {
 132                 @Override
 133                 public void onSuccess(final DOMRpcResult result) {
 134                     onGetModulesStateResult(future, deviceId, result);
 135                 }
 136
 137                 @Override
 138                 public void onFailure(final Throwable cause) {
 139                     // debug, because we expect this error to be reported by caller
 140                     LOG.debug("{}: Unable to detect available schemas", deviceId, cause);
 141                     future.setException(cause);
 142                 }
 143             }, MoreExecutors.directExecutor());
 144         return future;
 145     }
 146
 147     private static void onGetModulesStateResult(final SettableFuture<LibraryModulesSchemas> future,
 148             final RemoteDeviceId deviceId, final DOMRpcResult result) {
 149         // Two-pass error reporting: first check if there is a hard error, then log any remaining warnings
 150         final var errors = result.errors();
 151         if (errors.stream().anyMatch(error -> error.getSeverity() == ErrorSeverity.ERROR)) {
 152             // FIXME: a good exception, which can report the contents of errors?
 153             future.setException(new OperationFailedException("Failed to get modules-state", errors));
 154             return;
 155         }
 156         for (var error : errors) {
 157             LOG.info("{}: schema retrieval warning: {}", deviceId, error);
 158         }
 159
 160         final var value = result.value();
 161         if (value == null) {
 162             LOG.warn("{}: missing RPC output", deviceId);
 163             future.set(EMPTY);
 164             return;
 165         }
 166         final var data = value.childByArg(NETCONF_DATA_NODEID);
 167         if (data == null) {
 168             LOG.warn("{}: missing RPC data", deviceId);
 169             future.set(EMPTY);
 170             return;
 171         }
 172         // FIXME: right: this was never implemented correctly, as the origical code always produces CCE because it
 173         //        interpreted 'data' anyxml as a DataContainerNode!
 174         future.setException(new UnsupportedOperationException("Missing normalization logic for " + data.prettyTree()));
 175     }
 176
 177     public Map<SourceIdentifier, URL> getAvailableModels() {
 178         final var result = new HashMap<SourceIdentifier, URL>();
 179         for (var entry : availableModels.entrySet()) {
 180             final var sId = new SourceIdentifier(entry.getKey().getLocalName(),
 181                 entry.getKey().getRevision().map(Revision::toString).orElse(null));
 182             result.put(sId, entry.getValue());
 183         }
 184
 185         return result;
 186     }
 187
 188     /**
 189      * Resolves URLs with YANG schema resources from modules-state. Uses basic http authenticaiton
 190      *
 191      * @param url URL pointing to yang library
 192      * @return Resolved URLs with YANG schema resources for all yang modules from yang library
 193      */
 194     public static LibraryModulesSchemas create(final String url, final String username, final String password) {
 195         try {
 196             final URL urlConnection = new URL(requireNonNull(url));
 197             final URLConnection connection = urlConnection.openConnection();
 198
 199             if (connection instanceof HttpURLConnection) {
 200                 connection.setRequestProperty("Accept", "application/xml");
 201                 final String userpass = username + ":" + password;
 202                 connection.setRequestProperty("Authorization",
 203                     "Basic " + Base64.getEncoder().encodeToString(userpass.getBytes(StandardCharsets.UTF_8)));
 204             }
 205
 206             return createFromURLConnection(connection);
 207
 208         } catch (final IOException e) {
 209             LOG.warn("Unable to download yang library from {}", url, e);
 210             return new LibraryModulesSchemas(ImmutableMap.of());
 211         }
 212     }
 213
 214     private static LibraryModulesSchemas create(final ContainerNode modulesStateNode) {
 215         final Optional<DataContainerChild> moduleListNode = modulesStateNode.findChildByArg(MODULE_NID);
 216         checkState(moduleListNode.isPresent(), "Unable to find list: %s in %s", MODULE_NID, modulesStateNode);
 217         final var node = moduleListNode.orElseThrow();
 218         checkState(node instanceof MapNode, "Unexpected structure for container: %s in : %s. Expecting a list",
 219             MODULE_NID, modulesStateNode);
 220
 221         final var moduleList = (MapNode) node;
 222         final var builder = ImmutableMap.<QName, URL>builderWithExpectedSize(moduleList.size());
 223         for (var moduleNode : moduleList.body()) {
 224             final var entry = createFromEntry(moduleNode);
 225             if (entry != null) {
 226                 builder.put(entry);
 227             }
 228         }
 229
 230         return new LibraryModulesSchemas(builder.build());
 231     }
 232
 233     /**
 234      * Resolves URLs with YANG schema resources from modules-state.
 235      * @param url URL pointing to yang library
 236      * @return Resolved URLs with YANG schema resources for all yang modules from yang library
 237      */
 238     public static LibraryModulesSchemas create(final String url) {
 239         final URLConnection connection;
 240         try {
 241             connection = new URL(requireNonNull(url)).openConnection();
 242         } catch (final IOException e) {
 243             LOG.warn("Unable to download yang library from {}", url, e);
 244             return new LibraryModulesSchemas(ImmutableMap.of());
 245         }
 246
 247         if (connection instanceof HttpURLConnection) {
 248             connection.setRequestProperty("Accept", "application/xml");
 249         }
 250         return createFromURLConnection(connection);
 251     }
 252
 253     private static LibraryModulesSchemas createFromURLConnection(final URLConnection connection) {
 254
 255         String contentType = connection.getContentType();
 256
 257         // TODO try to guess Json also from intput stream
 258         if (guessJsonFromFileName(connection.getURL().getFile())) {
 259             contentType = "application/json";
 260         }
 261
 262         requireNonNull(contentType, "Content type unknown");
 263         checkState(contentType.equals("application/json") || contentType.equals("application/xml"),
 264                 "Only XML and JSON types are supported.");
 265
 266         Optional<NormalizedNode> optionalModulesStateNode = Optional.empty();
 267         try (InputStream in = connection.getInputStream()) {
 268             optionalModulesStateNode = contentType.equals("application/json") ? readJson(in) : readXml(in);
 269         } catch (final IOException e) {
 270             LOG.warn("Unable to download yang library from {}", connection.getURL(), e);
 271         }
 272
 273         if (optionalModulesStateNode.isEmpty()) {
 274             return new LibraryModulesSchemas(ImmutableMap.of());
 275         }
 276
 277         final NormalizedNode modulesStateNode = optionalModulesStateNode.orElseThrow();
 278         checkState(modulesStateNode instanceof ContainerNode, "Expecting container containing module list, but was %s",
 279             modulesStateNode);
 280         final ContainerNode modulesState = (ContainerNode) modulesStateNode;
 281         final NodeIdentifier nodeName = modulesState.name();
 282         checkState(MODULES_STATE_NID.equals(nodeName), "Wrong container identifier %s", nodeName);
 283
 284         return create((ContainerNode) modulesStateNode);
 285     }
 286
 287     private static boolean guessJsonFromFileName(final String fileName) {
 288         final int i = fileName.lastIndexOf('.');
 289         return i != 1 && ".json".equalsIgnoreCase(fileName.substring(i));
 290     }
 291
 292     private static Optional<NormalizedNode> readJson(final InputStream in) {
 293         final NormalizationResultHolder resultHolder = new NormalizationResultHolder();
 294         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 295
 296         final JsonParserStream jsonParser = JsonParserStream.create(writer, JSON_CODECS);
 297         final JsonReader reader = new JsonReader(new InputStreamReader(in, Charset.defaultCharset()));
 298
 299         jsonParser.parse(reader);
 300
 301         final NormalizationResult<?> result = resultHolder.result();
 302         return result == null ? Optional.empty() : Optional.of(result.data());
 303     }
 304
 305     private static Optional<NormalizedNode> readXml(final InputStream in) {
 306         try {
 307             final DocumentBuilder docBuilder = UntrustedXML.newDocumentBuilder();
 308
 309             final Document read = docBuilder.parse(in);
 310             final Document doc = docBuilder.newDocument();
 311             final Element rootElement = doc.createElementNS(ModulesState.QNAME.getNamespace().toString(),
 312                 ModulesState.QNAME.getLocalName());
 313             doc.appendChild(rootElement);
 314
 315             // FIXME: also namespace?!
 316             final var revisions = read.getElementsByTagName("revision");
 317
 318             for (int i = 0, length = revisions.getLength(); i < length; i++) {
 319                 final String revision = revisions.item(i).getTextContent();
 320                 if (DATE_PATTERN.matcher(revision).find() || revision.isEmpty()) {
 321                     final Node module = doc.importNode(read.getElementsByTagName("module").item(i), true);
 322                     rootElement.appendChild(module);
 323                 } else {
 324                     LOG.warn("Xml contains wrong revision - {} - on module {}", revision,
 325                             read.getElementsByTagName("module").item(i).getTextContent());
 326                 }
 327             }
 328
 329             final NormalizationResultHolder resultHolder = new NormalizationResultHolder();
 330             final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 331             final XmlParserStream xmlParser = XmlParserStream.create(writer, MODULES_STATE_INFERENCE);
 332             xmlParser.traverse(new DOMSource(doc.getDocumentElement()));
 333             return Optional.of(resultHolder.getResult().data());
 334         } catch (XMLStreamException | IOException | SAXException e) {
 335             LOG.warn("Unable to parse yang library xml content", e);
 336         }
 337
 338         return Optional.empty();
 339     }
 340
 341     private static @Nullable Entry<QName, URL> createFromEntry(final MapEntryNode moduleNode) {
 342         final QName moduleNodeId = moduleNode.name().getNodeType();
 343         checkArgument(moduleNodeId.equals(Module.QNAME), "Wrong QName %s", moduleNodeId);
 344
 345         final String moduleName = getSingleChildNodeValue(moduleNode, NAME_NID).orElseThrow();
 346         final Optional<String> revision = getSingleChildNodeValue(moduleNode, REVISION_NID);
 347         if (revision.isPresent()) {
 348             final var rev = revision.orElseThrow();
 349             if (!Revision.STRING_FORMAT_PATTERN.matcher(rev).matches()) {
 350                 LOG.warn("Skipping library schema for {}. Revision {} is in wrong format.", moduleNode, rev);
 351                 return null;
 352             }
 353         }
 354
 355         // FIXME leaf schema with url that represents the yang schema resource for this module is not mandatory
 356         // don't fail if schema node is not present, just skip the entry or add some default URL
 357         final Optional<String> schemaUriAsString = getSingleChildNodeValue(moduleNode, SCHEMA_NID);
 358         final String moduleNameSpace = getSingleChildNodeValue(moduleNode, NAMESPACE_NID).orElseThrow();
 359
 360         final QName moduleQName = revision.isPresent()
 361                 ? QName.create(moduleNameSpace, revision.orElseThrow(), moduleName)
 362                 : QName.create(XMLNamespace.of(moduleNameSpace), moduleName);
 363
 364         try {
 365             return Map.entry(moduleQName, new URL(schemaUriAsString.orElseThrow()));
 366         } catch (final MalformedURLException e) {
 367             LOG.warn("Skipping library schema for {}. URL {} representing yang schema resource is not valid",
 368                     moduleNode, schemaUriAsString.orElseThrow());
 369             return null;
 370         }
 371     }
 372
 373     private static Optional<String> getSingleChildNodeValue(final DataContainerNode schemaNode,
 374                                                             final NodeIdentifier childNodeId) {
 375         final Optional<DataContainerChild> node = schemaNode.findChildByArg(childNodeId);
 376         checkArgument(node.isPresent(), "Child node %s not present", childNodeId.getNodeType());
 377         return getValueOfSimpleNode(node.orElseThrow());
 378     }
 379
 380     private static Optional<String> getValueOfSimpleNode(final NormalizedNode node) {
 381         final String valueStr = node.body().toString();
 382         return Strings.isNullOrEmpty(valueStr) ? Optional.empty() : Optional.of(valueStr.trim());
 383     }
 384 }