yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/list/ListStatementSupport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, 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.yangtools.yang.parser.rfc7950.stmt.list;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.ImmutableList;
  15 import com.google.common.collect.ImmutableSet;
  16 import java.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.HashSet;
  19 import java.util.List;
  20 import java.util.Optional;
  21 import java.util.Set;
  22 import org.eclipse.jdt.annotation.NonNull;
  23 import org.opendaylight.yangtools.concepts.Immutable;
  24 import org.opendaylight.yangtools.yang.common.Ordering;
  25 import org.opendaylight.yangtools.yang.common.QName;
  26 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
  27 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.Status;
  30 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  31 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  32 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  33 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  34 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  35 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
  36 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  37 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
  38 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
  39 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  40 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  41 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  42 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  43 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  44 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  45 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  46 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
  47 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx;
  48 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  49 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Parent;
  50 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Parent.EffectiveConfig;
  51 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  52 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  53 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  54 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  55 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  56 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 @Beta
  61 public final class ListStatementSupport
  62         extends AbstractSchemaTreeStatementSupport<ListStatement, ListEffectiveStatement> {
  63     private static final Logger LOG = LoggerFactory.getLogger(ListStatementSupport.class);
  64     private static final ImmutableSet<YangStmtMapping> UNINSTANTIATED_DATATREE_STATEMENTS = ImmutableSet.of(
  65         YangStmtMapping.GROUPING, YangStmtMapping.NOTIFICATION, YangStmtMapping.INPUT, YangStmtMapping.OUTPUT);
  66
  67     private static final SubstatementValidator RFC6020_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.LIST)
  68         .addAny(YangStmtMapping.ANYXML)
  69         .addAny(YangStmtMapping.CHOICE)
  70         .addOptional(YangStmtMapping.CONFIG)
  71         .addAny(YangStmtMapping.CONTAINER)
  72         .addOptional(YangStmtMapping.DESCRIPTION)
  73         .addAny(YangStmtMapping.GROUPING)
  74         .addAny(YangStmtMapping.IF_FEATURE)
  75         .addOptional(YangStmtMapping.KEY)
  76         .addAny(YangStmtMapping.LEAF)
  77         .addAny(YangStmtMapping.LEAF_LIST)
  78         .addAny(YangStmtMapping.LIST)
  79         .addOptional(YangStmtMapping.MAX_ELEMENTS)
  80         .addOptional(YangStmtMapping.MIN_ELEMENTS)
  81         .addAny(YangStmtMapping.MUST)
  82         .addOptional(YangStmtMapping.ORDERED_BY)
  83         .addOptional(YangStmtMapping.REFERENCE)
  84         .addOptional(YangStmtMapping.STATUS)
  85         .addAny(YangStmtMapping.TYPEDEF)
  86         .addAny(YangStmtMapping.UNIQUE)
  87         .addAny(YangStmtMapping.USES)
  88         .addOptional(YangStmtMapping.WHEN)
  89         .build();
  90     private static final SubstatementValidator RFC7950_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.LIST)
  91         .addAny(YangStmtMapping.ACTION)
  92         .addAny(YangStmtMapping.ANYDATA)
  93         .addAny(YangStmtMapping.ANYXML)
  94         .addAny(YangStmtMapping.CHOICE)
  95         .addOptional(YangStmtMapping.CONFIG)
  96         .addAny(YangStmtMapping.CONTAINER)
  97         .addOptional(YangStmtMapping.DESCRIPTION)
  98         .addAny(YangStmtMapping.GROUPING)
  99         .addAny(YangStmtMapping.IF_FEATURE)
 100         .addOptional(YangStmtMapping.KEY)
 101         .addAny(YangStmtMapping.LEAF)
 102         .addAny(YangStmtMapping.LEAF_LIST)
 103         .addAny(YangStmtMapping.LIST)
 104         .addOptional(YangStmtMapping.MAX_ELEMENTS)
 105         .addOptional(YangStmtMapping.MIN_ELEMENTS)
 106         .addAny(YangStmtMapping.MUST)
 107         .addAny(YangStmtMapping.NOTIFICATION)
 108         .addOptional(YangStmtMapping.ORDERED_BY)
 109         .addOptional(YangStmtMapping.REFERENCE)
 110         .addOptional(YangStmtMapping.STATUS)
 111         .addAny(YangStmtMapping.TYPEDEF)
 112         .addAny(YangStmtMapping.UNIQUE)
 113         .addAny(YangStmtMapping.USES)
 114         .addOptional(YangStmtMapping.WHEN)
 115         .build();
 116
 117     private final SubstatementValidator validator;
 118
 119     ListStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
 120         super(YangStmtMapping.LIST, instantiatedPolicy(), config);
 121         this.validator = requireNonNull(validator);
 122     }
 123
 124     public static @NonNull ListStatementSupport rfc6020Instance(final YangParserConfiguration config) {
 125         return new ListStatementSupport(config, RFC6020_VALIDATOR);
 126     }
 127
 128     public static @NonNull ListStatementSupport rfc7950Instance(final YangParserConfiguration config) {
 129         return new ListStatementSupport(config, RFC7950_VALIDATOR);
 130     }
 131
 132     @Override
 133     protected SubstatementValidator getSubstatementValidator() {
 134         return validator;
 135     }
 136
 137     @Override
 138     protected ListStatement createDeclared(final StmtContext<QName, ListStatement, ?> ctx,
 139             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 140         return DeclaredStatements.createList(ctx.getArgument(), substatements);
 141     }
 142
 143     @Override
 144     protected ListStatement attachDeclarationReference(final ListStatement stmt, final DeclarationReference reference) {
 145         return DeclaredStatementDecorators.decorateList(stmt, reference);
 146     }
 147
 148     @Override
 149     public ListEffectiveStatement copyEffective(final Current<QName, ListStatement> stmt,
 150             final ListEffectiveStatement original) {
 151         final int flags = computeFlags(stmt, original.effectiveSubstatements());
 152         if (original instanceof RegularListEffectiveStatement) {
 153             return new RegularListEffectiveStatement((RegularListEffectiveStatement) original,
 154                 stmt.original(ListSchemaNode.class), stmt.effectivePath(), flags);
 155         } else if (original instanceof EmptyListEffectiveStatement) {
 156             return new RegularListEffectiveStatement((EmptyListEffectiveStatement) original,
 157                 stmt.original(ListSchemaNode.class), stmt.effectivePath(), flags);
 158         } else {
 159             // Safe fallback
 160             return super.copyEffective(stmt, original);
 161         }
 162     }
 163
 164     @Override
 165     protected ListEffectiveStatement createEffective(final Current<QName, ListStatement> stmt,
 166             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 167         final ImmutableList<QName> keyDefinition;
 168         final KeyEffectiveStatement keyStmt = findFirstStatement(substatements, KeyEffectiveStatement.class);
 169         if (keyStmt != null) {
 170             final List<QName> keyDefinitionInit = new ArrayList<>(keyStmt.argument().size());
 171             final Set<QName> possibleLeafQNamesForKey = new HashSet<>();
 172             for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
 173                 if (effectiveStatement instanceof LeafSchemaNode) {
 174                     possibleLeafQNamesForKey.add(((LeafSchemaNode) effectiveStatement).getQName());
 175                 }
 176             }
 177             for (final QName keyQName : keyStmt.argument()) {
 178                 if (!possibleLeafQNamesForKey.contains(keyQName)) {
 179                     throw new InferenceException(stmt, "Key '%s' misses node '%s' in list '%s'",
 180                         keyStmt.getDeclared().rawArgument(), keyQName.getLocalName(), stmt.argument());
 181                 }
 182                 keyDefinitionInit.add(keyQName);
 183             }
 184
 185             keyDefinition = ImmutableList.copyOf(keyDefinitionInit);
 186         } else {
 187             keyDefinition = ImmutableList.of();
 188         }
 189
 190         final int flags = computeFlags(stmt, substatements);
 191         if (stmt.effectiveConfig() == EffectiveConfig.TRUE && keyDefinition.isEmpty() && isInstantied(stmt)) {
 192             warnConfigList(stmt);
 193         }
 194
 195         EffectiveStmtUtils.checkUniqueGroupings(stmt, substatements);
 196         EffectiveStmtUtils.checkUniqueTypedefs(stmt, substatements);
 197         EffectiveStmtUtils.checkUniqueUses(stmt, substatements);
 198
 199         final Optional<ElementCountConstraint> elementCountConstraint =
 200             EffectiveStmtUtils.createElementCountConstraint(substatements);
 201         final Immutable path = stmt.effectivePath();
 202         final ListSchemaNode original = stmt.original(ListSchemaNode.class);
 203         try {
 204             return original == null && !elementCountConstraint.isPresent()
 205                 ? new EmptyListEffectiveStatement(stmt.declared(), path, flags, substatements, keyDefinition)
 206                     : new RegularListEffectiveStatement(stmt.declared(), path, flags, substatements, keyDefinition,
 207                         elementCountConstraint.orElse(null), original);
 208         } catch (SubstatementIndexingException e) {
 209             throw new SourceException(e.getMessage(), stmt, e);
 210         }
 211     }
 212
 213     private static int computeFlags(final Current<?, ?> stmt,
 214             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 215         return new FlagsBuilder()
 216             .setHistory(stmt.history())
 217             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 218             .setConfiguration(stmt.effectiveConfig().asNullable())
 219             .setUserOrdered(findFirstArgument(substatements, OrderedByEffectiveStatement.class, Ordering.SYSTEM)
 220                 .equals(Ordering.USER))
 221             .toFlags();
 222     }
 223
 224     private static void warnConfigList(final @NonNull Current<QName, ListStatement> stmt) {
 225         final StatementSourceReference ref = stmt.sourceReference();
 226         final Boolean warned = stmt.getFromNamespace(ConfigListWarningNamespace.class, ref);
 227         // Hacky check if we have issued a warning for the original statement
 228         if (warned == null) {
 229             final StmtContext<?, ?, ?> ctx = stmt.caerbannog();
 230             verify(ctx instanceof Mutable, "Unexpected context %s", ctx);
 231             ((Mutable<?, ?, ?>) ctx).addToNs(ConfigListWarningNamespace.class, ref, Boolean.TRUE);
 232             LOG.info("Configuration list {} does not define any keys in violation of RFC7950 section 7.8.2. While "
 233                     + "this is fine with OpenDaylight, it can cause interoperability issues with other systems "
 234                     + "[defined at {}]", stmt.argument(), ref);
 235         }
 236     }
 237
 238     private static boolean isInstantied(final EffectiveStmtCtx ctx) {
 239         Parent parent = ctx.effectiveParent();
 240         while (parent != null) {
 241             final StatementDefinition parentDef = parent.publicDefinition();
 242             if (UNINSTANTIATED_DATATREE_STATEMENTS.contains(parentDef)) {
 243                 return false;
 244             }
 245
 246             final Parent grandParent = parent.effectiveParent();
 247             if (YangStmtMapping.AUGMENT == parentDef && grandParent != null) {
 248                 // If this is an augment statement and its parent is either a 'module' or 'submodule' statement, we are
 249                 // dealing with an uninstantiated context.
 250                 final StatementDefinition grandParentDef = grandParent.publicDefinition();
 251                 if (YangStmtMapping.MODULE == grandParentDef || YangStmtMapping.SUBMODULE == grandParentDef) {
 252                     return false;
 253                 }
 254             }
 255
 256             parent = grandParent;
 257         }
 258         return true;
 259     }
 260 }