yanglib/mdsal-yanglib-rfc8525/src/main/java/org/opendaylight/mdsal/yanglib/rfc8525/MountPointContextFactoryImpl.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech s.r.o. 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.mdsal.yanglib.rfc8525;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import java.net.MalformedURLException;
  15 import java.net.URL;
  16 import java.util.ArrayList;
  17 import java.util.HashSet;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Optional;
  21 import java.util.Set;
  22 import org.eclipse.jdt.annotation.NonNull;
  23 import org.eclipse.jdt.annotation.Nullable;
  24 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
  25 import org.opendaylight.mdsal.binding.dom.codec.api.BindingIdentityCodec;
  26 import org.opendaylight.mdsal.yanglib.api.SchemaContextResolver;
  27 import org.opendaylight.mdsal.yanglib.api.SourceReference;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.datastores.rev180214.Operational;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.LegacyRevisionUtils;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.ModulesState;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.RevisionIdentifier;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.RevisionUtils;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.YangLibrary;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.CommonLeafs;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module.ConformanceType;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.yang.library.parameters.Datastore;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.yang.library.parameters.DatastoreKey;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.yang.library.parameters.ModuleSet;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.yang.library.parameters.SchemaKey;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.YangIdentifier;
  42 import org.opendaylight.yangtools.rfc8528.data.api.MountPointContextFactory;
  43 import org.opendaylight.yangtools.rfc8528.data.api.MountPointIdentifier;
  44 import org.opendaylight.yangtools.rfc8528.data.api.YangLibraryConstants.ContainerName;
  45 import org.opendaylight.yangtools.rfc8528.data.util.AbstractMountPointContextFactory;
  46 import org.opendaylight.yangtools.yang.common.QName;
  47 import org.opendaylight.yangtools.yang.common.Revision;
  48 import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
  49 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  50 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  51 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  52 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  53 import org.opendaylight.yangtools.yang.parser.api.YangParserException;
  54 import org.slf4j.Logger;
  55 import org.slf4j.LoggerFactory;
  56
  57 final class MountPointContextFactoryImpl extends AbstractMountPointContextFactory {
  58     private static final Logger LOG = LoggerFactory.getLogger(MountPointContextFactoryImpl.class);
  59
  60     @SuppressWarnings("deprecation")
  61     private final BindingDataObjectCodecTreeNode<ModulesState> legacyCodec;
  62     private final BindingDataObjectCodecTreeNode<YangLibrary> codec;
  63     private final BindingIdentityCodec identityCodec;
  64     private final EffectiveModelContext yangLibContext;
  65     private final SchemaContextResolver resolver;
  66
  67     MountPointContextFactoryImpl(final MountPointIdentifier mountId, final SchemaContextResolver resolver,
  68             final EffectiveModelContext yangLibContext,
  69             final BindingIdentityCodec identityCodec,
  70             final BindingDataObjectCodecTreeNode<YangLibrary> codec,
  71             @SuppressWarnings("deprecation")
  72             final BindingDataObjectCodecTreeNode<ModulesState> legacyCodec) {
  73         super(mountId);
  74         this.resolver = requireNonNull(resolver);
  75         this.identityCodec = requireNonNull(identityCodec);
  76         this.yangLibContext = requireNonNull(yangLibContext);
  77         this.codec = requireNonNull(codec);
  78         this.legacyCodec = requireNonNull(legacyCodec);
  79     }
  80
  81     @Override
  82     protected MountPointContextFactory createContextFactory(final MountPointDefinition mountPoint) {
  83         return new MountPointContextFactoryImpl(mountPoint.getIdentifier(), resolver, yangLibContext, identityCodec,
  84             codec, legacyCodec);
  85     }
  86
  87     @Override
  88     protected Optional<EffectiveModelContext> findSchemaForLibrary(final ContainerName containerName) {
  89         return switch (containerName) {
  90             case RFC7895, RFC8525 -> Optional.of(yangLibContext);
  91         };
  92     }
  93
  94     @Override
  95     protected EffectiveModelContext bindLibrary(final ContainerName containerName, final ContainerNode libData)
  96             throws YangParserException {
  97         return switch (containerName) {
  98             case RFC7895 -> bindLibrary(verifyNotNull(legacyCodec.deserialize(libData)));
  99             case RFC8525 -> bindLibrary(verifyNotNull(codec.deserialize(libData)));
 100         };
 101     }
 102
 103     private @NonNull EffectiveModelContext bindLibrary(final @NonNull YangLibrary yangLib) throws YangParserException {
 104         final var datastores = yangLib.nonnullDatastore();
 105         checkArgument(!datastores.isEmpty(), "No datastore defined");
 106
 107         final var requiredSources = new ArrayList<SourceReference>();
 108         final var librarySources = new ArrayList<SourceReference>();
 109         final var supportedFeatures = new HashSet<QName>();
 110         final var moduleSet = findModuleSet(yangLib, findSchemaName(datastores, Operational.QNAME));
 111         for (var modSet : yangLib.nonnullModuleSet().values()) {
 112             if (moduleSet.remove(modSet.getName())) {
 113                 fillModules(librarySources, requiredSources, supportedFeatures, modSet);
 114             }
 115         }
 116         checkArgument(moduleSet.isEmpty(), "Failed to resolve module sets %s", moduleSet);
 117
 118         return resolver.resolveSchemaContext(librarySources, requiredSources, supportedFeatures);
 119     }
 120
 121     @SuppressWarnings("deprecation")
 122     private @NonNull EffectiveModelContext bindLibrary(final @NonNull ModulesState modState)
 123             throws YangParserException {
 124         final var requiredSources = new ArrayList<SourceReference>();
 125         final var librarySources = new ArrayList<SourceReference>();
 126         final var supportedFeatures = new HashSet<QName>();
 127
 128         for (var module : modState.nonnullModule().values()) {
 129             final var modRef = sourceRefFor(module, module.getSchema());
 130
 131             final var namespace = XMLNamespace.of(module.requireNamespace().getValue());
 132             for (var feature : module.requireFeature()) {
 133                 supportedFeatures.add(QName.create(namespace, feature.getValue()).intern());
 134             }
 135
 136             // TODO: take deviations into account
 137
 138             if (ConformanceType.Import == module.getConformanceType()) {
 139                 librarySources.add(modRef);
 140             } else {
 141                 requiredSources.add(modRef);
 142             }
 143
 144             for (var submodule : module.nonnullSubmodule().values()) {
 145                 // Submodules go to library, as they are pulled in as needed
 146                 librarySources.add(sourceRefFor(submodule, submodule.getSchema()));
 147             }
 148         }
 149
 150         return resolver.resolveSchemaContext(librarySources, requiredSources, supportedFeatures);
 151     }
 152
 153     private String findSchemaName(final Map<DatastoreKey, Datastore> datastores, final QName qname) {
 154         final var it = datastores.values().iterator();
 155         final var ds = it.next();
 156
 157         // FIXME: This is ugly, but it is the most compatible thing we can do without knowing the exact requested
 158         //        datastore
 159         if (it.hasNext() && !qname.equals(identityCodec.fromBinding(ds.getName()))) {
 160             do {
 161                 final Datastore next = it.next();
 162                 if (qname.equals(identityCodec.fromBinding(ds.getName()))) {
 163                     return next.getSchema();
 164                 }
 165             } while (it.hasNext());
 166         }
 167
 168         return ds.getSchema();
 169     }
 170
 171     @SuppressWarnings("deprecation")
 172     private static SourceReference sourceRefFor(final CommonLeafs obj, final Uri uri) {
 173         final var sourceId = new SourceIdentifier(Unqualified.of(obj.getName().getValue()),
 174             LegacyRevisionUtils.toYangCommon(obj.getRevision()).orElse(null));
 175         if (uri != null) {
 176             try {
 177                 return SourceReference.of(sourceId, new URL(uri.getValue()));
 178             } catch (MalformedURLException e) {
 179                 LOG.debug("Ignoring invalid schema location {}", uri, e);
 180             }
 181         }
 182
 183         return SourceReference.of(sourceId);
 184     }
 185
 186     private static HashSet<String> findModuleSet(final YangLibrary yangLib, final String schemaName) {
 187         final var schema = yangLib.nonnullSchema().get(new SchemaKey(schemaName));
 188         if (schema == null) {
 189             throw new IllegalArgumentException("Failed to find moduleSet for " + schemaName);
 190         }
 191         return new HashSet<>(schema.getModuleSet());
 192     }
 193
 194     private static void fillModules(final List<SourceReference> librarySources,
 195             final List<SourceReference> requiredSources, final Set<QName> supportedFeatures, final ModuleSet modSet) {
 196         // TODO: take deviations/features into account
 197
 198         for (var mod : modSet.nonnullImportOnlyModule().values()) {
 199             fillSource(librarySources, mod.getName(), RevisionUtils.toYangCommon(mod.getRevision()),
 200                 mod.getLocation());
 201             mod.nonnullSubmodule().values().forEach(sub -> {
 202                 fillSource(librarySources, sub.getName(), toYangCommon(sub.getRevision()), sub.getLocation());
 203             });
 204         }
 205         for (var mod : modSet.nonnullModule().values()) {
 206             fillSource(requiredSources, mod.getName(), toYangCommon(mod.getRevision()), mod.getLocation());
 207             final var namespace = XMLNamespace.of(mod.requireNamespace().getValue());
 208             mod.requireFeature().forEach(feature -> supportedFeatures.add(QName.create(namespace, feature.getValue())));
 209             mod.nonnullSubmodule().values().forEach(sub -> {
 210                 fillSource(librarySources, sub.getName(), toYangCommon(sub.getRevision()), sub.getLocation());
 211             });
 212         }
 213     }
 214
 215     private static void fillSource(final List<SourceReference> sources, final YangIdentifier sourceName,
 216             final Optional<Revision> revision, final Set<Uri> uris) {
 217         final var sourceId = new SourceIdentifier(Unqualified.of(sourceName.getValue()), revision.orElse(null));
 218         final SourceReference sourceRef;
 219         if (uris != null && uris.isEmpty()) {
 220             final var locations = new ArrayList<URL>();
 221             for (Uri uri : uris) {
 222                 try {
 223                     locations.add(new URL(uri.getValue()));
 224                 } catch (MalformedURLException e) {
 225                     LOG.debug("Ignoring invalid schema location {}", uri, e);
 226                 }
 227             }
 228             sourceRef = SourceReference.of(sourceId, locations);
 229         } else {
 230             sourceRef = SourceReference.of(sourceId);
 231         }
 232
 233         sources.add(sourceRef);
 234     }
 235
 236     private static Optional<Revision> toYangCommon(final @Nullable RevisionIdentifier revisionIdentifier) {
 237         return revisionIdentifier == null ? Optional.empty() : Optional.of(Revision.of(revisionIdentifier.getValue()));
 238     }
 239 }