001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.oscal.lib.metapath.function.library;
028
029import gov.nist.secauto.metaschema.model.common.metapath.DynamicContext;
030import gov.nist.secauto.metaschema.model.common.metapath.ISequence;
031import gov.nist.secauto.metaschema.model.common.metapath.MetapathException;
032import gov.nist.secauto.metaschema.model.common.metapath.function.FunctionUtils;
033import gov.nist.secauto.metaschema.model.common.metapath.function.IArgument;
034import gov.nist.secauto.metaschema.model.common.metapath.function.IFunction;
035import gov.nist.secauto.metaschema.model.common.metapath.item.IDocumentNodeItem;
036import gov.nist.secauto.metaschema.model.common.metapath.item.IItem;
037import gov.nist.secauto.metaschema.model.common.metapath.item.INodeItem;
038import gov.nist.secauto.metaschema.model.common.util.ObjectUtils;
039import gov.nist.secauto.oscal.lib.model.Catalog;
040import gov.nist.secauto.oscal.lib.profile.resolver.ProfileResolutionException;
041import gov.nist.secauto.oscal.lib.profile.resolver.ProfileResolver;
042
043import java.io.IOException;
044import java.util.List;
045
046import edu.umd.cs.findbugs.annotations.NonNull;
047
048public final class ResolveProfile {
049
050  @NonNull
051  static final IFunction SIGNATURE_NO_ARG = IFunction.builder()
052      .name("resolve-profile")
053      .returnType(INodeItem.class)
054      .focusDependent()
055      .contextDependent()
056      .deterministic()
057      .returnOne()
058      .functionHandler(ResolveProfile::executeNoArg)
059      .build();
060
061  @NonNull
062  static final IFunction SIGNATURE_ONE_ARG = IFunction.builder()
063      .name("resolve-profile")
064      .argument(IArgument.newBuilder()
065          .name("profile")
066          .type(INodeItem.class)
067          .zeroOrOne()
068          .build())
069      .focusDependent()
070      .contextDependent()
071      .deterministic()
072      .returnType(INodeItem.class)
073      .returnOne()
074      .functionHandler(ResolveProfile::executeOneArg)
075      .build();
076
077  private ResolveProfile() {
078    // disable construction
079  }
080
081  @SuppressWarnings({ "unused",
082      "PMD.OnlyOneReturn" // readability
083  })
084  @NonNull
085  public static ISequence<?> executeNoArg(
086      @NonNull IFunction function,
087      @NonNull List<ISequence<?>> arguments,
088      @NonNull DynamicContext dynamicContext,
089      INodeItem focus) {
090
091    INodeItem item = focus;
092    if (item == null) {
093      return ISequence.empty();
094    }
095    return ISequence.of(resolveProfile(FunctionUtils.asType(item), dynamicContext));
096  }
097
098  @SuppressWarnings({ "unused",
099      "PMD.OnlyOneReturn" // readability
100  })
101  @NonNull
102  public static ISequence<?> executeOneArg(
103      @NonNull IFunction function,
104      @NonNull List<ISequence<?>> arguments,
105      @NonNull DynamicContext dynamicContext,
106      INodeItem focus) {
107    ISequence<? extends IDocumentNodeItem> arg = FunctionUtils.asType(
108        ObjectUtils.notNull(arguments.get(0)));
109
110    IItem item = FunctionUtils.getFirstItem(arg, true);
111    if (item == null) {
112      return ISequence.empty();
113    }
114
115    return ISequence.of(resolveProfile(FunctionUtils.asType(item), dynamicContext));
116  }
117
118  @NonNull
119  public static IDocumentNodeItem resolveProfile(@NonNull IDocumentNodeItem profile,
120      @NonNull DynamicContext dynamicContext) {
121    Object profileObject = profile.getValue();
122
123    IDocumentNodeItem retval;
124    if (profileObject instanceof Catalog) {
125      retval = profile;
126    } else {
127      // this is a profile
128      ProfileResolver resolver = new ProfileResolver();
129      resolver.setDynamicContext(dynamicContext);
130      try {
131        retval = resolver.resolve(profile);
132      } catch (IOException | ProfileResolutionException ex) {
133        throw new MetapathException(String.format("Unable to resolve profile '%s'", profile.getBaseUri()), ex);
134      }
135    }
136    return retval;
137  }
138}