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
  16 import com.google.common.base.Strings;
  17 import com.google.common.collect.ImmutableMap;
  18 import com.google.gson.stream.JsonReader;
  19 import java.io.IOException;
  20 import java.io.InputStream;
  21 import java.io.InputStreamReader;
  22 import java.net.HttpURLConnection;
  23 import java.net.MalformedURLException;
  24 import java.net.URL;
  25 import java.net.URLConnection;
  26 import java.nio.charset.Charset;
  27 import java.nio.charset.StandardCharsets;
  28 import java.util.Base64;
  29 import java.util.Collection;
  30 import java.util.HashMap;
  31 import java.util.Map;
  32 import java.util.Map.Entry;
  33 import java.util.Optional;
  34 import java.util.Set;
  35 import java.util.concurrent.ExecutionException;
  36 import java.util.regex.Pattern;
  37 import javax.xml.parsers.DocumentBuilder;
  38 import javax.xml.stream.XMLStreamException;
  39 import javax.xml.transform.dom.DOMSource;
  40 import org.eclipse.jdt.annotation.NonNull;
  41 import org.eclipse.jdt.annotation.Nullable;
  42 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
  43 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  44 import org.opendaylight.netconf.client.mdsal.api.NetconfDeviceSchemas;
  45 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceId;
  46 import org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil;
  47 import org.opendaylight.netconf.client.mdsal.spi.NetconfDeviceRpc;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Get;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.ModulesState;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.YangLibrary;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module;
  52 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  53 import org.opendaylight.yangtools.yang.common.QName;
  54 import org.opendaylight.yangtools.yang.common.Revision;
  55 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  56 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  58 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  59 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  60 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  61 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  62 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  63 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  64 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizationResult;
  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.NormalizationResultHolder;
  73 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  74 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  75 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  76 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
  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     private static final Inference MODULES_STATE_INFERENCE =
  95         SchemaInferenceStack.ofDataTreePath(LIBRARY_CONTEXT, ModulesState.QNAME).toInference();
  96
  97     // FIXME: this is legacy RFC7895, add support for RFC8525 containers, too
  98     private static final NodeIdentifier MODULES_STATE_NID = NodeIdentifier.create(ModulesState.QNAME);
  99     private static final NodeIdentifier MODULE_NID = NodeIdentifier.create(Module.QNAME);
 100     private static final NodeIdentifier NAME_NID = NodeIdentifier.create(QName.create(Module.QNAME, "name").intern());
 101     private static final NodeIdentifier REVISION_NID = NodeIdentifier.create(
 102         QName.create(Module.QNAME, "revision").intern());
 103     private static final NodeIdentifier SCHEMA_NID = NodeIdentifier.create(
 104         QName.create(Module.QNAME, "schema").intern());
 105     private static final NodeIdentifier NAMESPACE_NID = NodeIdentifier.create(
 106         QName.create(Module.QNAME, "namespace").intern());
 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 = Builders.containerBuilder()
 115             .withNodeIdentifier(NETCONF_GET_NODEID)
 116             .withChild(NetconfMessageTransformUtil.toFilterStructure(MODULES_STATE_MODULE_LIST, LIBRARY_CONTEXT))
 117             .build();
 118
 119     private final ImmutableMap<QName, URL> availableModels;
 120
 121     private LibraryModulesSchemas(final ImmutableMap<QName, URL> availableModels) {
 122         this.availableModels = requireNonNull(availableModels);
 123     }
 124
 125     public Map<SourceIdentifier, URL> getAvailableModels() {
 126         final Map<SourceIdentifier, URL> result = new HashMap<>();
 127         for (final Entry<QName, URL> entry : availableModels.entrySet()) {
 128             final SourceIdentifier sId = new SourceIdentifier(entry.getKey().getLocalName(),
 129                 entry.getKey().getRevision().map(Revision::toString).orElse(null));
 130             result.put(sId, entry.getValue());
 131         }
 132
 133         return result;
 134     }
 135
 136     /**
 137      * Resolves URLs with YANG schema resources from modules-state. Uses basic http authenticaiton
 138      *
 139      * @param url URL pointing to yang library
 140      * @return Resolved URLs with YANG schema resources for all yang modules from yang library
 141      */
 142     public static LibraryModulesSchemas create(final String url, final String username, final String password) {
 143         try {
 144             final URL urlConnection = new URL(requireNonNull(url));
 145             final URLConnection connection = urlConnection.openConnection();
 146
 147             if (connection instanceof HttpURLConnection) {
 148                 connection.setRequestProperty("Accept", "application/xml");
 149                 final String userpass = username + ":" + password;
 150                 connection.setRequestProperty("Authorization",
 151                     "Basic " + Base64.getEncoder().encodeToString(userpass.getBytes(StandardCharsets.UTF_8)));
 152             }
 153
 154             return createFromURLConnection(connection);
 155
 156         } catch (final IOException e) {
 157             LOG.warn("Unable to download yang library from {}", url, e);
 158             return new LibraryModulesSchemas(ImmutableMap.of());
 159         }
 160     }
 161
 162
 163     public static LibraryModulesSchemas create(final NetconfDeviceRpc deviceRpc, final RemoteDeviceId deviceId) {
 164         final DOMRpcResult moduleListNodeResult;
 165         try {
 166             moduleListNodeResult = deviceRpc.invokeRpc(Get.QNAME, GET_MODULES_STATE_MODULE_LIST_RPC).get();
 167         } catch (final InterruptedException e) {
 168             Thread.currentThread().interrupt();
 169             throw new IllegalStateException(deviceId + ": Interrupted while waiting for response to "
 170                     + MODULES_STATE_MODULE_LIST, e);
 171         } catch (final ExecutionException e) {
 172             LOG.warn("{}: Unable to detect available schemas, get to {} failed", deviceId,
 173                     MODULES_STATE_MODULE_LIST, e);
 174             return new LibraryModulesSchemas(ImmutableMap.of());
 175         }
 176
 177         if (!moduleListNodeResult.errors().isEmpty()) {
 178             LOG.warn("{}: Unable to detect available schemas, get to {} failed, {}",
 179                     deviceId, MODULES_STATE_MODULE_LIST, moduleListNodeResult.errors());
 180             return new LibraryModulesSchemas(ImmutableMap.of());
 181         }
 182
 183         final Optional<DataContainerChild> modulesStateNode =
 184                 findModulesStateNode(moduleListNodeResult.value());
 185         if (modulesStateNode.isPresent()) {
 186             final DataContainerChild node = modulesStateNode.orElseThrow();
 187             checkState(node instanceof ContainerNode, "Expecting container containing schemas, but was %s", node);
 188             return create((ContainerNode) node);
 189         }
 190
 191         LOG.warn("{}: Unable to detect available schemas, get to {} was empty", deviceId, MODULES_STATE_NID);
 192         return new LibraryModulesSchemas(ImmutableMap.of());
 193     }
 194
 195     private static LibraryModulesSchemas create(final ContainerNode modulesStateNode) {
 196         final Optional<DataContainerChild> moduleListNode = modulesStateNode.findChildByArg(MODULE_NID);
 197         checkState(moduleListNode.isPresent(), "Unable to find list: %s in %s", MODULE_NID, modulesStateNode);
 198         final DataContainerChild node = moduleListNode.orElseThrow();
 199         checkState(node instanceof MapNode, "Unexpected structure for container: %s in : %s. Expecting a list",
 200             MODULE_NID, modulesStateNode);
 201
 202         final MapNode moduleList = (MapNode) node;
 203         final Collection<MapEntryNode> modules = moduleList.body();
 204         final ImmutableMap.Builder<QName, URL> schemasMapping = ImmutableMap.builderWithExpectedSize(modules.size());
 205         for (final MapEntryNode moduleNode : modules) {
 206             final Entry<QName, URL> entry = createFromEntry(moduleNode);
 207             if (entry != null) {
 208                 schemasMapping.put(entry);
 209             }
 210         }
 211
 212         return new LibraryModulesSchemas(schemasMapping.build());
 213     }
 214
 215     /**
 216      * Resolves URLs with YANG schema resources from modules-state.
 217      * @param url URL pointing to yang library
 218      * @return Resolved URLs with YANG schema resources for all yang modules from yang library
 219      */
 220     public static LibraryModulesSchemas create(final String url) {
 221         final URLConnection connection;
 222         try {
 223             connection = new URL(requireNonNull(url)).openConnection();
 224         } catch (final IOException e) {
 225             LOG.warn("Unable to download yang library from {}", url, e);
 226             return new LibraryModulesSchemas(ImmutableMap.of());
 227         }
 228
 229         if (connection instanceof HttpURLConnection) {
 230             connection.setRequestProperty("Accept", "application/xml");
 231         }
 232         return createFromURLConnection(connection);
 233     }
 234
 235     private static Optional<DataContainerChild> findModulesStateNode(final NormalizedNode result) {
 236         if (result == null) {
 237             return Optional.empty();
 238         }
 239         final Optional<DataContainerChild> dataNode = ((DataContainerNode) result).findChildByArg(NETCONF_DATA_NODEID);
 240         if (dataNode.isEmpty()) {
 241             return Optional.empty();
 242         }
 243
 244         return ((DataContainerNode) dataNode.orElseThrow()).findChildByArg(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.orElseThrow();
 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.name();
 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 NormalizationResultHolder resultHolder = new NormalizationResultHolder();
 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         final NormalizationResult result = resultHolder.result();
 296         return result == null ? Optional.empty() : Optional.of(result.data());
 297     }
 298
 299     private static Optional<NormalizedNode> readXml(final InputStream in) {
 300         try {
 301             final DocumentBuilder docBuilder = UntrustedXML.newDocumentBuilder();
 302
 303             final Document read = docBuilder.parse(in);
 304             final Document doc = docBuilder.newDocument();
 305             final Element rootElement = doc.createElementNS(ModulesState.QNAME.getNamespace().toString(),
 306                 ModulesState.QNAME.getLocalName());
 307             doc.appendChild(rootElement);
 308
 309             // FIXME: also namespace?!
 310             final var revisions = read.getElementsByTagName("revision");
 311
 312             for (int i = 0, length = revisions.getLength(); i < length; i++) {
 313                 final String revision = revisions.item(i).getTextContent();
 314                 if (DATE_PATTERN.matcher(revision).find() || revision.isEmpty()) {
 315                     final Node module = doc.importNode(read.getElementsByTagName("module").item(i), true);
 316                     rootElement.appendChild(module);
 317                 } else {
 318                     LOG.warn("Xml contains wrong revision - {} - on module {}", revision,
 319                             read.getElementsByTagName("module").item(i).getTextContent());
 320                 }
 321             }
 322
 323             final NormalizationResultHolder resultHolder = new NormalizationResultHolder();
 324             final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 325             final XmlParserStream xmlParser = XmlParserStream.create(writer, MODULES_STATE_INFERENCE);
 326             xmlParser.traverse(new DOMSource(doc.getDocumentElement()));
 327             return Optional.of(resultHolder.getResult().data());
 328         } catch (XMLStreamException | IOException | SAXException e) {
 329             LOG.warn("Unable to parse yang library xml content", e);
 330         }
 331
 332         return Optional.empty();
 333     }
 334
 335     private static @Nullable Entry<QName, URL> createFromEntry(final MapEntryNode moduleNode) {
 336         final QName moduleNodeId = moduleNode.name().getNodeType();
 337         checkArgument(moduleNodeId.equals(Module.QNAME), "Wrong QName %s", moduleNodeId);
 338
 339         final String moduleName = getSingleChildNodeValue(moduleNode, NAME_NID).orElseThrow();
 340         final Optional<String> revision = getSingleChildNodeValue(moduleNode, REVISION_NID);
 341         if (revision.isPresent()) {
 342             final var rev = revision.orElseThrow();
 343             if (!Revision.STRING_FORMAT_PATTERN.matcher(rev).matches()) {
 344                 LOG.warn("Skipping library schema for {}. Revision {} is in wrong format.", moduleNode, rev);
 345                 return null;
 346             }
 347         }
 348
 349         // FIXME leaf schema with url that represents the yang schema resource for this module is not mandatory
 350         // don't fail if schema node is not present, just skip the entry or add some default URL
 351         final Optional<String> schemaUriAsString = getSingleChildNodeValue(moduleNode, SCHEMA_NID);
 352         final String moduleNameSpace = getSingleChildNodeValue(moduleNode, NAMESPACE_NID).orElseThrow();
 353
 354         final QName moduleQName = revision.isPresent()
 355                 ? QName.create(moduleNameSpace, revision.orElseThrow(), moduleName)
 356                 : QName.create(XMLNamespace.of(moduleNameSpace), moduleName);
 357
 358         try {
 359             return Map.entry(moduleQName, new URL(schemaUriAsString.orElseThrow()));
 360         } catch (final MalformedURLException e) {
 361             LOG.warn("Skipping library schema for {}. URL {} representing yang schema resource is not valid",
 362                     moduleNode, schemaUriAsString.orElseThrow());
 363             return null;
 364         }
 365     }
 366
 367     private static Optional<String> getSingleChildNodeValue(final DataContainerNode schemaNode,
 368                                                             final NodeIdentifier childNodeId) {
 369         final Optional<DataContainerChild> node = schemaNode.findChildByArg(childNodeId);
 370         checkArgument(node.isPresent(), "Child node %s not present", childNodeId.getNodeType());
 371         return getValueOfSimpleNode(node.orElseThrow());
 372     }
 373
 374     private static Optional<String> getValueOfSimpleNode(final NormalizedNode node) {
 375         final String valueStr = node.body().toString();
 376         return Strings.isNullOrEmpty(valueStr) ? Optional.empty() : Optional.of(valueStr.trim());
 377     }
 378
 379     @Override
 380     public Set<QName> getAvailableYangSchemasQNames() {
 381         return null;
 382     }
 383 }