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