FormParamValueParamProvider.java

/*
 * Copyright (c) 2010, 2023 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.jersey.server.internal.inject;

import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.lang.annotation.Annotation;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.security.AccessController;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.BiFunction;
import java.util.function.Function;

import jakarta.ws.rs.Encoded;
import jakarta.ws.rs.FormParam;
import jakarta.ws.rs.ProcessingException;
import jakarta.ws.rs.core.EntityPart;
import jakarta.ws.rs.core.Form;
import jakarta.ws.rs.core.GenericType;
import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;

import jakarta.inject.Provider;
import jakarta.inject.Singleton;

import org.glassfish.jersey.internal.inject.ExtractorException;
import org.glassfish.jersey.internal.inject.InjectionManager;
import org.glassfish.jersey.internal.inject.Providers;
import org.glassfish.jersey.internal.util.ReflectionHelper;
import org.glassfish.jersey.internal.util.collection.LazyValue;
import org.glassfish.jersey.internal.util.collection.NullableMultivaluedHashMap;
import org.glassfish.jersey.internal.util.collection.Value;
import org.glassfish.jersey.internal.util.collection.Values;
import org.glassfish.jersey.message.internal.MediaTypes;
import org.glassfish.jersey.message.internal.ReaderWriter;
import org.glassfish.jersey.server.ContainerRequest;
import org.glassfish.jersey.server.ParamException;
import org.glassfish.jersey.server.internal.InternalServerProperties;
import org.glassfish.jersey.server.internal.LocalizationMessages;
import org.glassfish.jersey.server.model.Parameter;
import org.glassfish.jersey.server.spi.internal.ValueParamProvider;

/**
 * Value factory provider supporting the {@link FormParam} injection annotation.
 *
 * @author Paul Sandoz
 * @author Marek Potociar
 */
@Singleton
final class FormParamValueParamProvider extends AbstractValueParamProvider {

    private final MultipartFormParamValueProvider multipartProvider;
    /**
     * Injection constructor.
     *
     * @param mpep extractor provider.
     * @param injectionManager
     */
    public FormParamValueParamProvider(Provider<MultivaluedParameterExtractorProvider> mpep,
                                       InjectionManager injectionManager) {
        super(mpep, Parameter.Source.FORM);
        this.multipartProvider = new MultipartFormParamValueProvider(injectionManager);
    }

    @Override
    public Function<ContainerRequest, ?> createValueProvider(Parameter parameter) {
        String parameterName = parameter.getSourceName();

        if (parameterName == null || parameterName.isEmpty()) {
            // Invalid query parameter name
            return null;
        }

        if (EntityPart.class == parameter.getType()) {
            return new Function<ContainerRequest, Object>() {
                @Override
                public Object apply(ContainerRequest containerRequest) {
                    return multipartProvider.getEntityPart(containerRequest, parameter);
                }
            };
        }

        MultivaluedParameterExtractor e = get(parameter);
        if (e == null) {
            return null;
        }
        return new FormParamValueProvider(e, multipartProvider, !parameter.isEncoded(), parameter);
    }

    private static final class FormParamValueProvider implements Function<ContainerRequest, Object> {

        private static final Annotation encodedAnnotation = getEncodedAnnotation();
        private final MultivaluedParameterExtractor<?> extractor;
        private final MultipartFormParamValueProvider multipartProvider;
        private final boolean decode;
        private final Parameter parameter;

        FormParamValueProvider(MultivaluedParameterExtractor<?> extractor,
                               MultipartFormParamValueProvider multipartProvider,
                               boolean decode, Parameter parameter) {
            this.extractor = extractor;
            this.multipartProvider = multipartProvider;
            this.decode = decode;
            this.parameter = parameter;
        }

        private static Form getCachedForm(final ContainerRequest request, boolean decode) {
            return (Form) request.getProperty(decode ? InternalServerProperties
                    .FORM_DECODED_PROPERTY : InternalServerProperties.FORM_PROPERTY);
        }

        private static ContainerRequest ensureValidRequest(final ContainerRequest request) throws IllegalStateException {
            if (request.getMethod().equals("GET")) {
                throw new IllegalStateException(
                        LocalizationMessages.FORM_PARAM_METHOD_ERROR());
            }

            if (!MediaTypes.typeEqual(MediaType.APPLICATION_FORM_URLENCODED_TYPE, request.getMediaType())) {
                throw new IllegalStateException(
                        LocalizationMessages.FORM_PARAM_CONTENT_TYPE_ERROR());
            }
            return request;
        }

        private static Annotation getEncodedAnnotation() {
            /**
             * Encoded-annotated class.
             */
            @Encoded
            final class EncodedAnnotationTemp {
            }
            return EncodedAnnotationTemp.class.getAnnotation(Encoded.class);
        }

        @Override
        public Object apply(ContainerRequest request) {
            if (MediaTypes.typeEqual(MediaType.MULTIPART_FORM_DATA_TYPE, request.getMediaType())) {
                return multipartProvider.apply(request, parameter);
            } else {
                Form form = getCachedForm(request, decode);

                if (form == null) {
                    Form otherForm = getCachedForm(request, !decode);
                    if (otherForm != null) {
                        form = switchUrlEncoding(request, otherForm);
                    } else {
                        form = getForm(request);
                    }
                    cacheForm(request, form);
                }

                try {
                    return extractor.extract(form.asMap());
                } catch (ExtractorException e) {
                    throw new ParamException.FormParamException(e.getCause(),
                            extractor.getName(), extractor.getDefaultValueString());
                }
            }
        }

        private Form switchUrlEncoding(final ContainerRequest request, final Form otherForm) {
            final Set<Map.Entry<String, List<String>>> entries = otherForm.asMap().entrySet();

            MultivaluedMap<String, String> formMap = new NullableMultivaluedHashMap<>();
            for (Map.Entry<String, List<String>> entry : entries) {
                final String charsetName = ReaderWriter.getCharset(MediaType.valueOf(
                        request.getHeaderString(HttpHeaders.CONTENT_TYPE))).name();

                String key;
                try {
                    key = decode ? URLDecoder.decode(entry.getKey(), charsetName) : URLEncoder.encode(entry.getKey(),
                            charsetName);

                    for (String value : entry.getValue()) {
                        if (value != null) {
                            formMap.add(key,
                                    decode ? URLDecoder.decode(value, charsetName) : URLEncoder.encode(value, charsetName));
                        } else {
                            formMap.add(key, null);
                        }
                    }

                } catch (UnsupportedEncodingException uee) {
                    throw new ProcessingException(LocalizationMessages.ERROR_UNSUPPORTED_ENCODING(charsetName,
                            extractor.getName()), uee);
                }
            }
            return new Form(formMap);
        }

        private void cacheForm(final ContainerRequest request, final Form form) {
            request.setProperty(decode ? InternalServerProperties
                    .FORM_DECODED_PROPERTY : InternalServerProperties.FORM_PROPERTY, form);
        }

        private Form getForm(final ContainerRequest request) {
            return getFormParameters(ensureValidRequest(request));
        }

        private Form getFormParameters(ContainerRequest request) {
            if (MediaTypes.typeEqual(MediaType.APPLICATION_FORM_URLENCODED_TYPE, request.getMediaType())) {
                request.bufferEntity();
                Form form;
                if (decode) {
                    form = request.readEntity(Form.class);
                } else {
                    Annotation[] annotations = new Annotation[1];
                    annotations[0] = encodedAnnotation;
                    form = request.readEntity(Form.class, annotations);
                }

                return (form == null ? new Form() : form);
            } else {
                return new Form();
            }
        }
    }

    @Singleton
    private static class MultipartFormParamValueProvider implements BiFunction<ContainerRequest, Parameter, Object> {
        private static final class FormParamHolder {
            @FormParam("name")
            public static final Void dummy = null; // field to get an instance of FormParam annotation
        }
        private static Parameter entityPartParameter =
                Parameter.create(
                        EntityPart.class, EntityPart.class, false, EntityPart.class, EntityPart.class,
                        AccessController.doPrivileged(ReflectionHelper.getDeclaredFieldsPA(FormParamHolder.class))[0]
                            .getAnnotations()
                );

        private final InjectionManager injectionManager;
        private final LazyValue<ValueParamProvider> entityPartProvider;

        private MultipartFormParamValueProvider(InjectionManager injectionManager) {
            this.injectionManager = injectionManager;

            //Get the provider from jersey-media-multipart
            entityPartProvider = Values.lazy((Value<ValueParamProvider>) () -> {
                Set<ValueParamProvider> providers = Providers.getProviders(injectionManager, ValueParamProvider.class);
                for (ValueParamProvider vfp : providers) {
                    Function<ContainerRequest, ?> paramValueSupplier = vfp.getValueProvider(entityPartParameter);
                    if (paramValueSupplier != null && !FormParamValueParamProvider.class.isInstance(vfp)) {
                        return vfp;
                    }
                }
                return null;
            });
        }

        @Override
        public Object apply(ContainerRequest containerRequest, Parameter parameter) {
            Object entity = null;
            final EntityPart entityPart = getEntityPart(containerRequest, parameter);
            if (entityPart != null) { // else jersey-multipart module is missing
                try {
                    entity = parameter.getType() != parameter.getRawType()
                            ? entityPart.getContent(genericType(parameter.getRawType(), parameter.getType()))
                            : entityPart.getContent(parameter.getRawType());
                } catch (IOException e) {
                    throw new ProcessingException(e);
                }
            }

            return entity;
        }

        private EntityPart getEntityPart(ContainerRequest containerRequest, Parameter parameter) {
            final ValueParamProvider valueParamProvider = entityPartProvider.get();
            if (valueParamProvider != null) { // else jersey-multipart module is missing
                final Function<ContainerRequest, ?> valueSupplier = valueParamProvider.getValueProvider(
                        new WrappingFormParamParameter(entityPartParameter, parameter));
                return (EntityPart) valueSupplier.apply(containerRequest);
            }
            return null;
        }

        private GenericType genericType(Type rawType, Type genericType) {
            return new GenericType(new ParameterizedType() {
                @Override
                public Type[] getActualTypeArguments() {
                    return new Type[]{genericType};
                }

                @Override
                public Type getRawType() {
                    return rawType;
                }

                @Override
                public Type getOwnerType() {
                    return null;
                }
            });
        }

        private static class WrappingFormParamParameter extends Parameter {
            protected WrappingFormParamParameter(Parameter entityPartDataParam, Parameter realDataParam) {
                super(realDataParam.getAnnotations(),
                        realDataParam.getSourceAnnotation(),
                        realDataParam.getSource(),
                        realDataParam.getSourceName(),
                        entityPartDataParam.getRawType(),
                        entityPartDataParam.getType(),
                        realDataParam.isEncoded(),
                        realDataParam.getDefaultValue());
            }
        }
    }
}