001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.rest.server.vars;
018
019import static org.apache.juneau.commons.utils.Shorts.*;
020import static org.apache.juneau.commons.utils.StringUtils.*;
021
022import java.util.*;
023
024import org.apache.juneau.bean.swagger.*;
025import org.apache.juneau.bean.swagger.Swagger;
026import org.apache.juneau.commons.svl.*;
027import org.apache.juneau.commons.utils.*;
028import org.apache.juneau.http.response.*;
029import org.apache.juneau.marshall.marshaller.*;
030import org.apache.juneau.rest.server.*;
031
032/**
033 * Rest info variable resolver.
034 *
035 * <p>
036 * The format for this var is <js>"$RS{key1[,key2...]}"</js>.
037 *
038 * <p>
039 * Used to resolve values returned by {@link RestRequest#getSwagger()}.
040 * <br>When multiple keys are used, returns the first non-null/empty value.
041 *
042 * <p>
043 * The possible values are:
044 * <ul>
045 *    <li><js>"contact"</js> - Value returned by {@link Info#getContact()}
046 *    <li><js>"description"</js> - Value returned by {@link Info#getDescription()}
047 *    <li><js>"externalDocs"</js> - Value returned by {@link Swagger#getExternalDocs()}
048 *    <li><js>"license"</js> - Value returned by {@link Info#getLicense()}
049 *    <li><js>"operationDescription"</js> - Value returned by {@link Operation#getDescription()}
050 *    <li><js>"operationSummary"</js> - Value returned by {@link Operation#getSummary()}
051 *    <li><js>"siteName"</js> - Value returned by {@link Info#getSiteName()}
052 *    <li><js>"tags"</js> - Value returned by {@link Swagger#getTags()}
053 *    <li><js>"termsOfService"</js> - Value returned by {@link Info#getTermsOfService()}
054 *    <li><js>"title"</js> - See {@link Info#getTitle()}
055 *    <li><js>"version"</js> - See {@link Info#getVersion()}
056 * </ul>
057 *
058 * <h5 class='section'>Example:</h5>
059 * <p class='bjava'>
060 *    String <jv>title</jv> = <jv>restRequest</jv>.getVarResolver().resolve(<js>"$RS{title}"</js>);
061 *    String <jv>titleOrDescription</jv> = <jv>restRequest</jv>.getVarResolver().resolve(<js>"$RS{title,description}"</js>);
062 * </p>
063 *
064 * <h5 class='section'>Notes:</h5><ul>
065 *    <li class='note'>
066 *       This variable resolver requires that a {@link RestRequest} bean be available in the session bean store.
067 *    <li class='note'>
068 *       For security reasons, nested and recursive variables are not resolved.
069 * </ul>
070 *
071 * <h5 class='section'>See Also:</h5><ul>
072 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/RestServerSvlVariables">REST Server SVL Variables</a>
073 * </ul>
074 */
075public class RequestSwaggerVar extends MultipartResolvingVar {
076
077   /** The name of this variable. */
078   public static final String NAME = "RS";
079
080   /**
081    * Constructor.
082    */
083   public RequestSwaggerVar() {
084      super(NAME);
085   }
086
087   @Override /* Overridden from Var */
088   public boolean canResolve(VarResolverSession session) {
089      return session.getBean(RestRequest.class).isPresent();
090   }
091
092   @Override /* Overridden from Var */
093   @SuppressWarnings({
094      "java:S3776" // Cognitive complexity acceptable for Swagger variable resolution
095   })
096   public String resolve(VarResolverSession session, String key) throws BasicHttpException, InternalServerError {
097      try {
098         RestRequest req = session.getBean(RestRequest.class).orElseThrow(InternalServerError::new);
099         Optional<Swagger> swagger = req.getSwagger();
100         Optional<Operation> methodSwagger = req.getOperationSwagger();
101         char c = charAt(key, 0);
102         if (c == 'c') {
103            if (eq(key, "contact"))
104               return swagger.map(Swagger::getInfo).map(Info::getContact).map(Shorts::s).orElse(null);
105         } else if (c == 'd') {
106            if (eq(key, "description"))
107               return swagger.map(Swagger::getInfo).map(Info::getDescription).orElse(null);
108         } else if (c == 'e') {
109            if (eq(key, "externalDocs"))
110               return swagger.map(Swagger::getExternalDocs).map(ExternalDocumentation::toString).orElse(null);
111         } else if (c == 'l') {
112            if (eq(key, "license"))
113               return swagger.map(Swagger::getInfo).map(Info::getLicense).map(Shorts::s).orElse(null);
114         } else if (c == 'o') {
115            if (eq(key, "operationDescription"))
116               return methodSwagger.map(Operation::getDescription).orElse(null);
117            if (eq(key, "operationSummary"))
118               return methodSwagger.map(Operation::getSummary).orElse(null);
119         } else if (c == 's') {
120            if (eq(key, "siteName"))
121               return swagger.map(Swagger::getInfo).map(Info::getSiteName).orElse(null);
122         } else if (c == 't') {
123            if (eq(key, "tags"))
124               return swagger.map(Swagger::getTags).map(Json5::of).orElse(null);
125            if (eq(key, "termsOfService"))
126               return swagger.map(Swagger::getInfo).map(Info::getTermsOfService).orElse(null);
127            if (eq(key, "title"))
128               return swagger.map(Swagger::getInfo).map(Info::getTitle).orElse(null);
129         } else if (c == 'v' && eq(key, "version"))
130            return swagger.map(Swagger::getInfo).map(Info::getVersion).orElse(null);
131         return null;
132      } catch (Exception e) {
133         throw new InternalServerError(e);
134      }
135   }
136
137   @Override /* Overridden from Var */
138   protected boolean allowNested() {
139      return false;
140   }
141
142   @Override /* Overridden from Var */
143   protected boolean allowRecurse() {
144      return false;
145   }
146}