netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/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.sal.connect.netconf;
   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.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DATA_NODEID;
  14 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_NODEID;
  15 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
  16
  17 import com.google.common.base.Strings;
  18 import com.google.common.collect.ImmutableMap;
  19 import com.google.gson.stream.JsonReader;
  20 import java.io.IOException;
  21 import java.io.InputStream;
  22 import java.io.InputStreamReader;
  23 import java.net.HttpURLConnection;
  24 import java.net.MalformedURLException;
  25 import java.net.URISyntaxException;
  26 import java.net.URL;
  27 import java.net.URLConnection;
  28 import java.nio.charset.Charset;
  29 import java.nio.charset.StandardCharsets;
  30 import java.util.AbstractMap.SimpleImmutableEntry;
  31 import java.util.Base64;
  32 import java.util.Collection;
  33 import java.util.HashMap;
  34 import java.util.Map;
  35 import java.util.Map.Entry;
  36 import java.util.Optional;
  37 import java.util.Set;
  38 import java.util.concurrent.ExecutionException;
  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.sal.connect.api.NetconfDeviceSchemas;
  48 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfDeviceRpc;
  49 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  50 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  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.QName;
  56 import org.opendaylight.yangtools.yang.common.Revision;
  57 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  58 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  59 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  60 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  61 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  62 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  63 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  64 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  65 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  66 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  67 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
  68 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
  69 import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
  70 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  71 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  72 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  73 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  74 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  75 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  76 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  77 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  78 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
  79 import org.slf4j.Logger;
  80 import org.slf4j.LoggerFactory;
  81 import org.w3c.dom.Document;
  82 import org.w3c.dom.Element;
  83 import org.w3c.dom.Node;
  84 import org.xml.sax.SAXException;
  85
  86 /**
  87  * Holds URLs with YANG schema resources for all yang modules reported in
  88  * ietf-netconf-yang-library/modules-state/modules node.
  89  */
  90 public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
  91
  92     private static final Logger LOG = LoggerFactory.getLogger(LibraryModulesSchemas.class);
  93     private static final Pattern DATE_PATTERN = Pattern.compile("(\\d{4}-\\d{2}-\\d{2})");
  94     private static final EffectiveModelContext LIBRARY_CONTEXT = BindingRuntimeHelpers.createEffectiveModel(
  95         YangLibrary.class);
  96     private static final Inference MODULES_STATE_INFERENCE =
  97         SchemaInferenceStack.ofDataTreePath(LIBRARY_CONTEXT, ModulesState.QNAME).toInference();
  98
  99     // FIXME: this is legacy RFC7895, add support for RFC8525 containers, too
 100     private static final NodeIdentifier MODULES_STATE_NID = NodeIdentifier.create(ModulesState.QNAME);
 101     private static final NodeIdentifier MODULE_NID = NodeIdentifier.create(Module.QNAME);
 102     private static final NodeIdentifier NAME_NID = NodeIdentifier.create(QName.create(Module.QNAME, "name").intern());
 103     private static final NodeIdentifier REVISION_NID = NodeIdentifier.create(
 104         QName.create(Module.QNAME, "revision").intern());
 105     private static final NodeIdentifier SCHEMA_NID = NodeIdentifier.create(
 106         QName.create(Module.QNAME, "schema").intern());
 107     private static final NodeIdentifier NAMESPACE_NID = NodeIdentifier.create(
 108         QName.create(Module.QNAME, "namespace").intern());
 109
 110     private static final JSONCodecFactory JSON_CODECS = JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02
 111             .getShared(LIBRARY_CONTEXT);
 112
 113     private static final YangInstanceIdentifier MODULES_STATE_MODULE_LIST =
 114             YangInstanceIdentifier.create(MODULES_STATE_NID, MODULE_NID);
 115
 116     private static final @NonNull ContainerNode GET_MODULES_STATE_MODULE_LIST_RPC = Builders.containerBuilder()
 117             .withNodeIdentifier(NETCONF_GET_NODEID)
 118             .withChild(NetconfMessageTransformUtil.toFilterStructure(MODULES_STATE_MODULE_LIST, LIBRARY_CONTEXT))
 119             .build();
 120
 121     private final ImmutableMap<QName, URL> availableModels;
 122
 123     private LibraryModulesSchemas(final ImmutableMap<QName, URL> availableModels) {
 124         this.availableModels = requireNonNull(availableModels);
 125     }
 126
 127     public Map<SourceIdentifier, URL> getAvailableModels() {
 128         final Map<SourceIdentifier, URL> result = new HashMap<>();
 129         for (final Entry<QName, URL> entry : availableModels.entrySet()) {
 130             final SourceIdentifier sId = RevisionSourceIdentifier.create(entry.getKey().getLocalName(),
 131                 entry.getKey().getRevision());
 132             result.put(sId, entry.getValue());
 133         }
 134
 135         return result;
 136     }
 137
 138     /**
 139      * Resolves URLs with YANG schema resources from modules-state. Uses basic http authenticaiton
 140      *
 141      * @param url URL pointing to yang library
 142      * @return Resolved URLs with YANG schema resources for all yang modules from yang library
 143      */
 144     public static LibraryModulesSchemas create(final String url, final String username, final String password) {
 145         try {
 146             final URL urlConnection = new URL(requireNonNull(url));
 147             final URLConnection connection = urlConnection.openConnection();
 148
 149             if (connection instanceof HttpURLConnection) {
 150                 connection.setRequestProperty("Accept", "application/xml");
 151                 final String userpass = username + ":" + password;
 152                 connection.setRequestProperty("Authorization",
 153                     "Basic " + Base64.getEncoder().encodeToString(userpass.getBytes(StandardCharsets.UTF_8)));
 154             }
 155
 156             return createFromURLConnection(connection);
 157
 158         } catch (final IOException e) {
 159             LOG.warn("Unable to download yang library from {}", url, e);
 160             return new LibraryModulesSchemas(ImmutableMap.of());
 161         }
 162     }
 163
 164
 165     public static LibraryModulesSchemas create(final NetconfDeviceRpc deviceRpc, final RemoteDeviceId deviceId) {
 166         final DOMRpcResult moduleListNodeResult;
 167         try {
 168             moduleListNodeResult =
 169                     deviceRpc.invokeRpc(NETCONF_GET_QNAME, GET_MODULES_STATE_MODULE_LIST_RPC).get();
 170         } catch (final InterruptedException e) {
 171             Thread.currentThread().interrupt();
 172             throw new RuntimeException(deviceId + ": Interrupted while waiting for response to "
 173                     + MODULES_STATE_MODULE_LIST, e);
 174         } catch (final ExecutionException e) {
 175             LOG.warn("{}: Unable to detect available schemas, get to {} failed", deviceId,
 176                     MODULES_STATE_MODULE_LIST, e);
 177             return new LibraryModulesSchemas(ImmutableMap.of());
 178         }
 179
 180         if (moduleListNodeResult.getErrors().isEmpty() == false) {
 181             LOG.warn("{}: Unable to detect available schemas, get to {} failed, {}",
 182                     deviceId, MODULES_STATE_MODULE_LIST, moduleListNodeResult.getErrors());
 183             return new LibraryModulesSchemas(ImmutableMap.of());
 184         }
 185
 186         final Optional<DataContainerChild> modulesStateNode =
 187                 findModulesStateNode(moduleListNodeResult.getResult());
 188         if (modulesStateNode.isPresent()) {
 189             final DataContainerChild node = modulesStateNode.get();
 190             checkState(node instanceof ContainerNode, "Expecting container containing schemas, but was %s", node);
 191             return create((ContainerNode) node);
 192         }
 193
 194         LOG.warn("{}: Unable to detect available schemas, get to {} was empty", deviceId, MODULES_STATE_NID);
 195         return new LibraryModulesSchemas(ImmutableMap.of());
 196     }
 197
 198     private static LibraryModulesSchemas create(final ContainerNode modulesStateNode) {
 199         final Optional<DataContainerChild> moduleListNode = modulesStateNode.findChildByArg(MODULE_NID);
 200         checkState(moduleListNode.isPresent(), "Unable to find list: %s in %s", MODULE_NID, modulesStateNode);
 201         final DataContainerChild node = moduleListNode.get();
 202         checkState(node instanceof MapNode, "Unexpected structure for container: %s in : %s. Expecting a list",
 203             MODULE_NID, modulesStateNode);
 204
 205         final MapNode moduleList = (MapNode) node;
 206         final Collection<MapEntryNode> modules = moduleList.body();
 207         final ImmutableMap.Builder<QName, URL> schemasMapping = ImmutableMap.builderWithExpectedSize(modules.size());
 208         for (final MapEntryNode moduleNode : modules) {
 209             final Entry<QName, URL> entry = createFromEntry(moduleNode);
 210             if (entry != null) {
 211                 schemasMapping.put(entry);
 212             }
 213         }
 214
 215         return new LibraryModulesSchemas(schemasMapping.build());
 216     }
 217
 218     /**
 219      * Resolves URLs with YANG schema resources from modules-state.
 220      * @param url URL pointing to yang library
 221      * @return Resolved URLs with YANG schema resources for all yang modules from yang library
 222      */
 223     public static LibraryModulesSchemas create(final String url) {
 224         final URLConnection connection;
 225         try {
 226             connection = new URL(requireNonNull(url)).openConnection();
 227         } catch (final IOException e) {
 228             LOG.warn("Unable to download yang library from {}", url, e);
 229             return new LibraryModulesSchemas(ImmutableMap.of());
 230         }
 231
 232         if (connection instanceof HttpURLConnection) {
 233             connection.setRequestProperty("Accept", "application/xml");
 234         }
 235         return createFromURLConnection(connection);
 236     }
 237
 238     private static Optional<DataContainerChild> findModulesStateNode(final NormalizedNode result) {
 239         if (result == null) {
 240             return Optional.empty();
 241         }
 242         final Optional<DataContainerChild> dataNode = ((DataContainerNode) result).findChildByArg(NETCONF_DATA_NODEID);
 243         if (dataNode.isEmpty()) {
 244             return Optional.empty();
 245         }
 246
 247         return ((DataContainerNode) dataNode.get()).findChildByArg(MODULES_STATE_NID);
 248     }
 249
 250     private static LibraryModulesSchemas createFromURLConnection(final URLConnection connection) {
 251
 252         String contentType = connection.getContentType();
 253
 254         // TODO try to guess Json also from intput stream
 255         if (guessJsonFromFileName(connection.getURL().getFile())) {
 256             contentType = "application/json";
 257         }
 258
 259         requireNonNull(contentType, "Content type unknown");
 260         checkState(contentType.equals("application/json") || contentType.equals("application/xml"),
 261                 "Only XML and JSON types are supported.");
 262
 263         Optional<NormalizedNode> optionalModulesStateNode = Optional.empty();
 264         try (InputStream in = connection.getInputStream()) {
 265             optionalModulesStateNode = contentType.equals("application/json") ? readJson(in) : readXml(in);
 266         } catch (final IOException e) {
 267             LOG.warn("Unable to download yang library from {}", connection.getURL(), e);
 268         }
 269
 270         if (optionalModulesStateNode.isEmpty()) {
 271             return new LibraryModulesSchemas(ImmutableMap.of());
 272         }
 273
 274         final NormalizedNode modulesStateNode = optionalModulesStateNode.get();
 275         checkState(modulesStateNode instanceof ContainerNode, "Expecting container containing module list, but was %s",
 276             modulesStateNode);
 277         final ContainerNode modulesState = (ContainerNode) modulesStateNode;
 278         final NodeIdentifier nodeName = modulesState.getIdentifier();
 279         checkState(MODULES_STATE_NID.equals(nodeName), "Wrong container identifier %s", nodeName);
 280
 281         return create((ContainerNode) modulesStateNode);
 282     }
 283
 284     private static boolean guessJsonFromFileName(final String fileName) {
 285         final int i = fileName.lastIndexOf('.');
 286         return i != 1 && ".json".equalsIgnoreCase(fileName.substring(i));
 287     }
 288
 289     private static Optional<NormalizedNode> readJson(final InputStream in) {
 290         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 291         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 292
 293         final JsonParserStream jsonParser = JsonParserStream.create(writer, JSON_CODECS);
 294         final JsonReader reader = new JsonReader(new InputStreamReader(in, Charset.defaultCharset()));
 295
 296         jsonParser.parse(reader);
 297
 298         return resultHolder.isFinished() ? Optional.of(resultHolder.getResult()) : Optional.empty();
 299     }
 300
 301     private static Optional<NormalizedNode> readXml(final InputStream in) {
 302         try {
 303             final DocumentBuilder docBuilder = UntrustedXML.newDocumentBuilder();
 304
 305             final Document read = docBuilder.parse(in);
 306             final Document doc = docBuilder.newDocument();
 307             final Element rootElement = doc.createElementNS("urn:ietf:params:xml:ns:yang:ietf-yang-library",
 308                     "modules");
 309             doc.appendChild(rootElement);
 310
 311             for (int i = 0; i < read.getElementsByTagName("revision").getLength(); i++) {
 312                 final String revision = read.getElementsByTagName("revision").item(i).getTextContent();
 313                 if (DATE_PATTERN.matcher(revision).find() || revision.isEmpty()) {
 314                     final Node module = doc.importNode(read.getElementsByTagName("module").item(i), true);
 315                     rootElement.appendChild(module);
 316                 } else {
 317                     LOG.warn("Xml contains wrong revision - {} - on module {}", revision,
 318                             read.getElementsByTagName("module").item(i).getTextContent());
 319                 }
 320             }
 321
 322             final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 323             final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 324             final XmlParserStream xmlParser = XmlParserStream.create(writer, MODULES_STATE_INFERENCE);
 325             xmlParser.traverse(new DOMSource(doc.getDocumentElement()));
 326             return Optional.of(resultHolder.getResult());
 327         } catch (XMLStreamException | URISyntaxException | IOException | SAXException e) {
 328             LOG.warn("Unable to parse yang library xml content", e);
 329         }
 330
 331         return Optional.empty();
 332     }
 333
 334     private static @Nullable Entry<QName, URL> createFromEntry(final MapEntryNode moduleNode) {
 335         final QName moduleNodeId = moduleNode.getIdentifier().getNodeType();
 336         checkArgument(moduleNodeId.equals(Module.QNAME), "Wrong QName %s", moduleNodeId);
 337
 338         final String moduleName = getSingleChildNodeValue(moduleNode, NAME_NID).get();
 339         final Optional<String> revision = getSingleChildNodeValue(moduleNode, REVISION_NID);
 340         if (revision.isPresent()) {
 341             if (!Revision.STRING_FORMAT_PATTERN.matcher(revision.get()).matches()) {
 342                 LOG.warn("Skipping library schema for {}. Revision {} is in wrong format.", moduleNode, revision.get());
 343                 return null;
 344             }
 345         }
 346
 347         // FIXME leaf schema with url that represents the yang schema resource for this module is not mandatory
 348         // don't fail if schema node is not present, just skip the entry or add some default URL
 349         final Optional<String> schemaUriAsString = getSingleChildNodeValue(moduleNode, SCHEMA_NID);
 350         final String moduleNameSpace = getSingleChildNodeValue(moduleNode, NAMESPACE_NID).get();
 351
 352         final QName moduleQName = revision.isPresent()
 353                 ? QName.create(moduleNameSpace, revision.get(), moduleName)
 354                 : QName.create(XMLNamespace.of(moduleNameSpace), moduleName);
 355
 356         try {
 357             return new SimpleImmutableEntry<>(moduleQName, new URL(schemaUriAsString.get()));
 358         } catch (final MalformedURLException e) {
 359             LOG.warn("Skipping library schema for {}. URL {} representing yang schema resource is not valid",
 360                     moduleNode, schemaUriAsString.get());
 361             return null;
 362         }
 363     }
 364
 365     private static Optional<String> getSingleChildNodeValue(final DataContainerNode schemaNode,
 366                                                             final NodeIdentifier childNodeId) {
 367         final Optional<DataContainerChild> node = schemaNode.findChildByArg(childNodeId);
 368         checkArgument(node.isPresent(), "Child node %s not present", childNodeId.getNodeType());
 369         return getValueOfSimpleNode(node.get());
 370     }
 371
 372     private static Optional<String> getValueOfSimpleNode(final NormalizedNode node) {
 373         final String valueStr = node.body().toString();
 374         return Strings.isNullOrEmpty(valueStr) ? Optional.empty() : Optional.of(valueStr.trim());
 375     }
 376
 377     @Override
 378     public Set<QName> getAvailableYangSchemasQNames() {
 379         return null;
 380     }
 381 }