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