netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/listener/NetconfSessionPreferences.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.listener;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.MoreObjects;
  13 import com.google.common.base.Predicate;
  14 import com.google.common.base.Splitter;
  15 import com.google.common.base.Strings;
  16 import com.google.common.collect.ImmutableMap;
  17 import com.google.common.collect.Iterables;
  18 import com.google.common.collect.Maps;
  19 import java.util.Collection;
  20 import java.util.HashMap;
  21 import java.util.Map;
  22 import org.eclipse.jdt.annotation.NonNull;
  23 import org.eclipse.jdt.annotation.Nullable;
  24 import org.opendaylight.netconf.client.NetconfClientSession;
  25 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability.CapabilityOrigin;
  27 import org.opendaylight.yangtools.yang.common.QName;
  28 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 // FIXME: propagate to API with immutable semantics
  33 public record NetconfSessionPreferences(
  34         @NonNull ImmutableMap<String, CapabilityOrigin> nonModuleCaps,
  35         @NonNull ImmutableMap<QName, CapabilityOrigin> moduleBasedCaps) {
  36
  37     private static final Logger LOG = LoggerFactory.getLogger(NetconfSessionPreferences.class);
  38     private static final ParameterMatcher MODULE_PARAM = new ParameterMatcher("module=");
  39     private static final ParameterMatcher REVISION_PARAM = new ParameterMatcher("revision=");
  40     private static final ParameterMatcher BROKEN_REVISON_PARAM = new ParameterMatcher("amp;revision=");
  41     private static final Splitter AMP_SPLITTER = Splitter.on('&');
  42     private static final Predicate<String> CONTAINS_REVISION = input -> input.contains("revision=");
  43
  44     public NetconfSessionPreferences {
  45         requireNonNull(nonModuleCaps);
  46         requireNonNull(moduleBasedCaps);
  47     }
  48
  49     public @Nullable CapabilityOrigin capabilityOrigin(final QName capability) {
  50         return moduleBasedCaps.get(requireNonNull(capability));
  51     }
  52
  53     public @Nullable CapabilityOrigin capabilityOrigin(final String capability) {
  54         return nonModuleCaps.get(requireNonNull(capability));
  55     }
  56
  57     // allows partial matches - assuming parameters are in the same order
  58     public boolean containsPartialNonModuleCapability(final String capability) {
  59         for (var nonModuleCap : nonModuleCaps.keySet()) {
  60             if (nonModuleCap.startsWith(capability)) {
  61                 LOG.trace("capability {} partially matches {}", capability, nonModuleCaps);
  62                 return true;
  63             }
  64         }
  65         return false;
  66     }
  67
  68     public boolean containsNonModuleCapability(final String capability) {
  69         return nonModuleCaps.containsKey(capability);
  70     }
  71
  72     public boolean containsModuleCapability(final QName capability) {
  73         return moduleBasedCaps.containsKey(capability);
  74     }
  75
  76     @Override
  77     public String toString() {
  78         return MoreObjects.toStringHelper(this)
  79                 .add("capabilities", nonModuleCaps)
  80                 .add("moduleBasedCapabilities", moduleBasedCaps)
  81                 .add("rollback", isRollbackSupported())
  82                 .add("monitoring", isMonitoringSupported())
  83                 .add("candidate", isCandidateSupported())
  84                 .add("writableRunning", isRunningWritable())
  85                 .toString();
  86     }
  87
  88     public boolean isRollbackSupported() {
  89         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString());
  90     }
  91
  92     public boolean isCandidateSupported() {
  93         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
  94     }
  95
  96     public boolean isRunningWritable() {
  97         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_RUNNING_WRITABLE_URI.toString());
  98     }
  99
 100     public boolean isNotificationsSupported() {
 101         return containsPartialNonModuleCapability(NetconfMessageTransformUtil.NETCONF_NOTIFICATONS_URI.toString())
 102                 || containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS);
 103     }
 104
 105     public boolean isMonitoringSupported() {
 106         return containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)
 107                 || containsPartialNonModuleCapability(
 108                         NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
 109     }
 110
 111     /**
 112      * Merge module-based list of capabilities with current list of module-based capabilities.
 113      *
 114      * @param netconfSessionModuleCapabilities capabilities to merge into this
 115      * @return new instance of preferences with merged module-based capabilities
 116      */
 117     public NetconfSessionPreferences addModuleCaps(final NetconfSessionPreferences netconfSessionModuleCapabilities) {
 118         final var mergedCaps = Maps.<QName, CapabilityOrigin>newHashMapWithExpectedSize(moduleBasedCaps.size()
 119                 + netconfSessionModuleCapabilities.moduleBasedCaps.size());
 120         mergedCaps.putAll(moduleBasedCaps);
 121         mergedCaps.putAll(netconfSessionModuleCapabilities.moduleBasedCaps);
 122         return new NetconfSessionPreferences(nonModuleCaps, ImmutableMap.copyOf(mergedCaps));
 123     }
 124
 125     /**
 126      * Override current list of module-based capabilities.
 127      *
 128      * @param netconfSessionPreferences capabilities to override in this
 129      * @return new instance of preferences with replaced module-based capabilities
 130      */
 131     public NetconfSessionPreferences replaceModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
 132         return new NetconfSessionPreferences(nonModuleCaps, netconfSessionPreferences.moduleBasedCaps);
 133     }
 134
 135     public NetconfSessionPreferences replaceModuleCaps(final Map<QName, CapabilityOrigin> newModuleBasedCaps) {
 136         return new NetconfSessionPreferences(nonModuleCaps, ImmutableMap.copyOf(newModuleBasedCaps));
 137     }
 138
 139     /**
 140      * Merge list of non-module based capabilities with current list of non-module based capabilities.
 141      *
 142      * @param netconfSessionNonModuleCapabilities capabilities to merge into this
 143      * @return new instance of preferences with merged non-module based capabilities
 144      */
 145     public NetconfSessionPreferences addNonModuleCaps(
 146             final NetconfSessionPreferences netconfSessionNonModuleCapabilities) {
 147         final var mergedCaps = Maps.<String, CapabilityOrigin>newHashMapWithExpectedSize(
 148                 nonModuleCaps.size() + netconfSessionNonModuleCapabilities.nonModuleCaps.size());
 149         mergedCaps.putAll(nonModuleCaps);
 150         mergedCaps.putAll(netconfSessionNonModuleCapabilities.nonModuleCaps);
 151         return new NetconfSessionPreferences(ImmutableMap.copyOf(mergedCaps), moduleBasedCaps);
 152     }
 153
 154     /**
 155      * Override current list of non-module based capabilities.
 156      *
 157      * @param netconfSessionPreferences capabilities to override in this
 158      * @return new instance of preferences with replaced non-module based capabilities
 159      */
 160     public NetconfSessionPreferences replaceNonModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
 161         return new NetconfSessionPreferences(netconfSessionPreferences.nonModuleCaps, moduleBasedCaps);
 162     }
 163
 164     public static NetconfSessionPreferences fromNetconfSession(final NetconfClientSession session) {
 165         return fromStrings(session.getServerCapabilities());
 166     }
 167
 168     private static QName cachedQName(final String namespace, final String revision, final String moduleName) {
 169         return QName.create(namespace, revision, moduleName).intern();
 170     }
 171
 172     private static QName cachedQName(final String namespace, final String moduleName) {
 173         return QName.create(XMLNamespace.of(namespace), moduleName).withoutRevision().intern();
 174     }
 175
 176     public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities) {
 177         // we do not know origin of capabilities from only Strings, so we set it to default value
 178         return fromStrings(capabilities, CapabilityOrigin.DeviceAdvertised);
 179     }
 180
 181     public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities,
 182                                                         final CapabilityOrigin capabilityOrigin) {
 183         final var moduleBasedCaps = new HashMap<QName, CapabilityOrigin>();
 184         final var nonModuleCaps = new HashMap<String, CapabilityOrigin>();
 185
 186         for (final String capability : capabilities) {
 187             nonModuleCaps.put(capability, capabilityOrigin);
 188             final int qmark = capability.indexOf('?');
 189             if (qmark == -1) {
 190                 continue;
 191             }
 192
 193             final String namespace = capability.substring(0, qmark);
 194             final Iterable<String> queryParams = AMP_SPLITTER.split(capability.substring(qmark + 1));
 195             final String moduleName = MODULE_PARAM.from(queryParams);
 196             if (Strings.isNullOrEmpty(moduleName)) {
 197                 continue;
 198             }
 199
 200             String revision = REVISION_PARAM.from(queryParams);
 201             if (!Strings.isNullOrEmpty(revision)) {
 202                 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName),
 203                         capabilityOrigin);
 204                 continue;
 205             }
 206
 207             /*
 208              * We have seen devices which mis-escape revision, but the revision may not
 209              * even be there. First check if there is a substring that matches revision.
 210              */
 211             if (Iterables.any(queryParams, CONTAINS_REVISION)) {
 212
 213                 LOG.debug("Netconf device was not reporting revision correctly, trying to get amp;revision=");
 214                 revision = BROKEN_REVISON_PARAM.from(queryParams);
 215                 if (Strings.isNullOrEmpty(revision)) {
 216                     LOG.warn("Netconf device returned revision incorrectly escaped for {}, ignoring it", capability);
 217                     addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
 218                             cachedQName(namespace, moduleName), capabilityOrigin);
 219                 } else {
 220                     addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
 221                             cachedQName(namespace, revision, moduleName), capabilityOrigin);
 222                 }
 223                 continue;
 224             }
 225
 226             // Fallback, no revision provided for module
 227             addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
 228                     cachedQName(namespace, moduleName), capabilityOrigin);
 229         }
 230
 231         return new NetconfSessionPreferences(ImmutableMap.copyOf(nonModuleCaps), ImmutableMap.copyOf(moduleBasedCaps));
 232     }
 233
 234     private static void addModuleQName(final Map<QName, CapabilityOrigin> moduleBasedCaps,
 235                                        final Map<String, CapabilityOrigin> nonModuleCaps, final String capability,
 236                                        final QName qualifiedName, final CapabilityOrigin capabilityOrigin) {
 237         moduleBasedCaps.put(qualifiedName, capabilityOrigin);
 238         nonModuleCaps.remove(capability);
 239     }
 240
 241     private static final class ParameterMatcher {
 242         private final Predicate<String> predicate;
 243         private final int skipLength;
 244
 245         ParameterMatcher(final String name) {
 246             predicate = input -> input.startsWith(name);
 247             skipLength = name.length();
 248         }
 249
 250         String from(final Iterable<String> params) {
 251             final var found = Iterables.tryFind(params, predicate);
 252             if (!found.isPresent()) {
 253                 return null;
 254             }
 255             return found.get().substring(skipLength);
 256         }
 257     }
 258 }