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