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