yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/UsesStatementImpl.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.yangtools.yang.parser.stmt.rfc6020;
   9
  10 import com.google.common.collect.ImmutableSet;
  11 import java.util.ArrayList;
  12 import java.util.Collection;
  13 import java.util.Set;
  14 import javax.annotation.Nonnull;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.common.QNameModule;
  17 import org.opendaylight.yangtools.yang.common.YangVersion;
  18 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
  30 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  43 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  44 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  45 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  46 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  47 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  48 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  49 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.UsesEffectiveStatementImpl;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52
  53 public class UsesStatementImpl extends AbstractDeclaredStatement<QName> implements UsesStatement {
  54     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
  55             .USES)
  56             .addAny(YangStmtMapping.AUGMENT)
  57             .addOptional(YangStmtMapping.DESCRIPTION)
  58             .addAny(YangStmtMapping.IF_FEATURE)
  59             .addAny(YangStmtMapping.REFINE)
  60             .addOptional(YangStmtMapping.REFERENCE)
  61             .addOptional(YangStmtMapping.STATUS)
  62             .addOptional(YangStmtMapping.WHEN)
  63             .build();
  64
  65     private static final Logger LOG = LoggerFactory.getLogger(UsesStatementImpl.class);
  66
  67     protected UsesStatementImpl(final StmtContext<QName, UsesStatement, ?> context) {
  68         super(context);
  69     }
  70
  71     public static class Definition extends
  72             AbstractQNameStatementSupport<UsesStatement, EffectiveStatement<QName, UsesStatement>> {
  73
  74         public Definition() {
  75             super(YangStmtMapping.USES);
  76         }
  77
  78         @Override
  79         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  80             return StmtContextUtils.qnameFromArgument(ctx, value);
  81         }
  82
  83         @Override
  84         public void onFullDefinitionDeclared(
  85                 final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
  86             if (!usesNode.isSupportedByFeatures()) {
  87                 return;
  88             }
  89             super.onFullDefinitionDeclared(usesNode);
  90
  91             final ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
  92             final QName groupingName = usesNode.getStatementArgument();
  93
  94             final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
  95                     GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
  96             final Prerequisite<? extends StmtContext.Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
  97                     usesNode.getParentContext());
  98
  99             usesAction.apply(new InferenceAction() {
 100
 101                 @Override
 102                 public void apply(final InferenceContext ctx) {
 103                     final StatementContextBase<?, ?, ?> targetNodeStmtCtx =
 104                             (StatementContextBase<?, ?, ?>) targetNodePre.resolve(ctx);
 105                     final StatementContextBase<?, ?, ?> sourceGrpStmtCtx =
 106                             (StatementContextBase<?, ?, ?>) sourceGroupingPre.resolve(ctx);
 107
 108                     try {
 109                         copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
 110                         resolveUsesNode(usesNode, targetNodeStmtCtx);
 111                         StmtContextUtils.validateIfFeatureAndWhenOnListKeys(usesNode);
 112                     } catch (final SourceException e) {
 113                         LOG.warn(e.getMessage(), e);
 114                         throw e;
 115                     }
 116                 }
 117
 118                 @Override
 119                 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 120                     InferenceException.throwIf(failed.contains(sourceGroupingPre),
 121                             usesNode.getStatementSourceReference(), "Grouping '%s' was not resolved.", groupingName);
 122                     throw new InferenceException("Unknown error occurred.", usesNode.getStatementSourceReference());
 123                 }
 124             });
 125         }
 126
 127         @Override
 128         public UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx) {
 129             return new UsesStatementImpl(ctx);
 130         }
 131
 132         @Override
 133         public EffectiveStatement<QName, UsesStatement> createEffective(
 134                 final StmtContext<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> ctx) {
 135             return new UsesEffectiveStatementImpl(ctx);
 136         }
 137
 138         @Override
 139         protected SubstatementValidator getSubstatementValidator() {
 140             return SUBSTATEMENT_VALIDATOR;
 141         }
 142
 143     }
 144
 145     @Nonnull
 146     @Override
 147     public QName getName() {
 148         return argument();
 149     }
 150
 151     @Override
 152     public WhenStatement getWhenStatement() {
 153         return firstDeclared(WhenStatement.class);
 154     }
 155
 156     @Nonnull
 157     @Override
 158     public Collection<? extends IfFeatureStatement> getIfFeatures() {
 159         return allDeclared(IfFeatureStatement.class);
 160     }
 161
 162     @Override
 163     public StatusStatement getStatus() {
 164         return firstDeclared(StatusStatement.class);
 165     }
 166
 167     @Override
 168     public DescriptionStatement getDescription() {
 169         return firstDeclared(DescriptionStatement.class);
 170     }
 171
 172     @Override
 173     public ReferenceStatement getReference() {
 174         return firstDeclared(ReferenceStatement.class);
 175     }
 176
 177     @Nonnull
 178     @Override
 179     public Collection<? extends AugmentStatement> getAugments() {
 180         return allDeclared(AugmentStatement.class);
 181     }
 182
 183     @Nonnull
 184     @Override
 185     public Collection<? extends RefineStatement> getRefines() {
 186         return allDeclared(RefineStatement.class);
 187     }
 188
 189     /**
 190      * Copy statements from a grouping to a target node.
 191      *
 192      * @param sourceGrpStmtCtx
 193      *            source grouping statement context
 194      * @param targetCtx
 195      *            target context
 196      * @param usesNode
 197      *            uses node
 198      * @throws SourceException
 199      *             instance of SourceException
 200      */
 201     static void copyFromSourceToTarget(final Mutable<?, ?, ?> sourceGrpStmtCtx,
 202             final StatementContextBase<?, ?, ?> targetCtx,
 203             final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
 204         final Collection<? extends Mutable<?, ?, ?>> declared = sourceGrpStmtCtx.mutableDeclaredSubstatements();
 205         final Collection<? extends Mutable<?, ?, ?>> effective = sourceGrpStmtCtx.mutableEffectiveSubstatements();
 206         final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
 207         final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
 208
 209         for (final Mutable<?, ?, ?> original : declared) {
 210             if (original.isSupportedByFeatures()) {
 211                 copyStatement(original, targetCtx, newQNameModule, buffer);
 212             }
 213         }
 214
 215         for (final Mutable<?, ?, ?> original : effective) {
 216             copyStatement(original, targetCtx, newQNameModule, buffer);
 217         }
 218
 219         targetCtx.addEffectiveSubstatements(buffer);
 220         usesNode.addAsEffectOfStatement(buffer);
 221     }
 222
 223     private static void copyStatement(final Mutable<?, ?, ?> original,
 224             final StatementContextBase<?, ?, ?> targetCtx, final QNameModule targetModule,
 225             final Collection<Mutable<?, ?, ?>> buffer) {
 226         if (needToCopyByUses(original)) {
 227             final Mutable<?, ?, ?> copy = targetCtx.childCopyOf(original, CopyType.ADDED_BY_USES, targetModule);
 228             buffer.add(copy);
 229         } else if (isReusedByUsesOnTop(original)) {
 230             buffer.add(original);
 231         }
 232     }
 233
 234     private static final Set<YangStmtMapping> TOP_REUSED_DEF_SET = ImmutableSet.of(
 235         YangStmtMapping.TYPE,
 236         YangStmtMapping.TYPEDEF);
 237
 238     private static boolean isReusedByUsesOnTop(final StmtContext<?, ?, ?> stmtContext) {
 239         return TOP_REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
 240     }
 241
 242     private static final Set<YangStmtMapping> NOCOPY_FROM_GROUPING_SET = ImmutableSet.of(
 243         YangStmtMapping.DESCRIPTION,
 244         YangStmtMapping.REFERENCE,
 245         YangStmtMapping.STATUS);
 246     private static final Set<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(
 247         YangStmtMapping.TYPE,
 248         YangStmtMapping.TYPEDEF,
 249         YangStmtMapping.USES);
 250
 251     public static boolean needToCopyByUses(final StmtContext<?, ?, ?> stmtContext) {
 252         final StatementDefinition def = stmtContext.getPublicDefinition();
 253         if (REUSED_DEF_SET.contains(def)) {
 254             LOG.debug("Will reuse {} statement {}", def, stmtContext);
 255             return false;
 256         }
 257         if (NOCOPY_FROM_GROUPING_SET.contains(def)) {
 258             return !YangStmtMapping.GROUPING.equals(stmtContext.getParentContext().getPublicDefinition());
 259         }
 260
 261         LOG.debug("Will copy {} statement {}", def, stmtContext);
 262         return true;
 263     }
 264
 265     public static void resolveUsesNode(
 266             final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode,
 267             final StmtContext<?, ?, ?> targetNodeStmtCtx) {
 268         for (final Mutable<?, ?, ?> subStmtCtx : usesNode.mutableDeclaredSubstatements()) {
 269             if (StmtContextUtils.producesDeclared(subStmtCtx, RefineStatement.class)
 270                     && areFeaturesSupported(subStmtCtx)) {
 271                 performRefine(subStmtCtx, targetNodeStmtCtx);
 272             }
 273         }
 274     }
 275
 276     private static boolean areFeaturesSupported(final StmtContext<?, ?, ?> subStmtCtx) {
 277         /*
 278          * In case of Yang 1.1, checks whether features are supported.
 279          */
 280         return !YangVersion.VERSION_1_1.equals(subStmtCtx.getRootVersion()) || subStmtCtx.isSupportedByFeatures();
 281     }
 282
 283     private static void performRefine(final Mutable<?, ?, ?> subStmtCtx, final StmtContext<?, ?, ?> usesParentCtx) {
 284
 285         final Object refineArgument = subStmtCtx.getStatementArgument();
 286         InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier),
 287             subStmtCtx.getStatementSourceReference(),
 288             "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier.", refineArgument);
 289
 290         final SchemaNodeIdentifier refineTargetNodeIdentifier = (SchemaNodeIdentifier) refineArgument;
 291         final StatementContextBase<?, ?, ?> refineTargetNodeCtx = Utils.findNode(usesParentCtx,
 292                 refineTargetNodeIdentifier);
 293
 294         InferenceException.throwIfNull(refineTargetNodeCtx, subStmtCtx.getStatementSourceReference(),
 295             "Refine target node %s not found.", refineTargetNodeIdentifier);
 296
 297         if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
 298             LOG.debug("Refine node '{}' in uses '{}' has target node unknown statement '{}'. "
 299                 + "Refine has been skipped. At line: {}", subStmtCtx.getStatementArgument(),
 300                 subStmtCtx.getParentContext().getStatementArgument(),
 301                 refineTargetNodeCtx.getStatementArgument(), subStmtCtx.getStatementSourceReference());
 302             subStmtCtx.addAsEffectOfStatement(refineTargetNodeCtx);
 303             return;
 304         }
 305
 306         addOrReplaceNodes(subStmtCtx, refineTargetNodeCtx);
 307         subStmtCtx.addAsEffectOfStatement(refineTargetNodeCtx);
 308     }
 309
 310     private static void addOrReplaceNodes(final Mutable<?, ?, ?> subStmtCtx,
 311             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 312         for (final Mutable<?, ?, ?> refineSubstatementCtx : subStmtCtx.mutableDeclaredSubstatements()) {
 313             if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
 314                 addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
 315             }
 316         }
 317     }
 318
 319     private static void addOrReplaceNode(final Mutable<?, ?, ?> refineSubstatementCtx,
 320             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 321
 322         final StatementDefinition refineSubstatementDef = refineSubstatementCtx.getPublicDefinition();
 323
 324         SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
 325                 refineSubstatementCtx.getStatementSourceReference(),
 326                 "Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
 327                 refineSubstatementCtx.getRoot().getStatementArgument(), refineSubstatementCtx.getParentContext()
 328                         .getStatementArgument(), refineSubstatementCtx.getPublicDefinition(), refineTargetNodeCtx
 329                         .getPublicDefinition());
 330
 331         if (isAllowedToAddByRefine(refineSubstatementDef)) {
 332             refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
 333         } else {
 334             refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
 335             refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
 336         }
 337     }
 338
 339     private static final Set<YangStmtMapping> ALLOWED_TO_ADD_BY_REFINE_DEF_SET = ImmutableSet.of(YangStmtMapping.MUST);
 340
 341     private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
 342         return ALLOWED_TO_ADD_BY_REFINE_DEF_SET.contains(publicDefinition);
 343     }
 344
 345     private static boolean isSupportedRefineSubstatement(final StmtContext<?, ?, ?> refineSubstatementCtx) {
 346         final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
 347                 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
 348
 349         return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
 350                 || supportedRefineSubstatements.contains(refineSubstatementCtx.getPublicDefinition())
 351                 || StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
 352     }
 353
 354     private static boolean isSupportedRefineTarget(final StmtContext<?, ?, ?> refineSubstatementCtx,
 355             final StmtContext<?, ?, ?> refineTargetNodeCtx) {
 356         final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS
 357                 .get(refineSubstatementCtx.getPublicDefinition());
 358
 359         return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
 360                 || supportedRefineTargets.contains(refineTargetNodeCtx.getPublicDefinition());
 361     }
 362
 363
 364     private static QNameModule getNewQNameModule(final StmtContext<?, ?, ?> targetCtx,
 365             final StmtContext<?, ?, ?> stmtContext) {
 366         if (targetCtx.getParentContext() == null) {
 367             return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
 368         }
 369         if (targetCtx.getPublicDefinition() == YangStmtMapping.AUGMENT) {
 370             return StmtContextUtils.getRootModuleQName(targetCtx);
 371         }
 372
 373         final Object targetStmtArgument = targetCtx.getStatementArgument();
 374         final Object sourceStmtArgument = stmtContext.getStatementArgument();
 375         if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
 376             return ((QName) targetStmtArgument).getModule();
 377         }
 378
 379         return null;
 380     }
 381 }