/*
 * Copyright (c) 2012, 2020 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.media.multipart.internal;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

import jakarta.ws.rs.BadRequestException;
import jakarta.ws.rs.ConstrainedTo;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.RuntimeType;
import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.Context;
import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.ext.ContextResolver;
import jakarta.ws.rs.ext.MessageBodyReader;
import jakarta.ws.rs.ext.Providers;

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

import org.glassfish.jersey.media.multipart.BodyPart;
import org.glassfish.jersey.media.multipart.BodyPartEntity;
import org.glassfish.jersey.media.multipart.FormDataBodyPart;
import org.glassfish.jersey.media.multipart.FormDataMultiPart;
import org.glassfish.jersey.media.multipart.MultiPart;
import org.glassfish.jersey.media.multipart.MultiPartProperties;
import org.glassfish.jersey.message.MessageBodyWorkers;
import org.glassfish.jersey.message.internal.MediaTypes;

import org.jvnet.mimepull.Header;
import org.jvnet.mimepull.MIMEConfig;
import org.jvnet.mimepull.MIMEMessage;
import org.jvnet.mimepull.MIMEParsingException;
import org.jvnet.mimepull.MIMEPart;

MessageBodyReader implementation for MultiPart entities.
Author:Craig McClanahan, Paul Sandoz, Michal Gajdos
/** * {@link MessageBodyReader} implementation for {@link MultiPart} entities. * * @author Craig McClanahan * @author Paul Sandoz * @author Michal Gajdos */
@Consumes("multipart/*") @Singleton @ConstrainedTo(RuntimeType.CLIENT) public class MultiPartReaderClientSide implements MessageBodyReader<MultiPart> { private static final Logger LOGGER = Logger.getLogger(MultiPartReaderClientSide.class.getName());
Injectable helper to look up appropriate MessageBodyReaders for our body parts.
/** * Injectable helper to look up appropriate {@link MessageBodyReader}s * for our body parts. */
@Inject private Provider<MessageBodyWorkers> messageBodyWorkers; private final MIMEConfig mimeConfig;
Accepts constructor injection of the configuration parameters for this application.
/** * Accepts constructor injection of the configuration parameters for this * application. */
public MultiPartReaderClientSide(@Context final Providers providers) { final ContextResolver<MultiPartProperties> contextResolver = providers.getContextResolver(MultiPartProperties.class, MediaType.WILDCARD_TYPE); MultiPartProperties properties = null; if (contextResolver != null) { properties = contextResolver.getContext(this.getClass()); } if (properties == null) { properties = new MultiPartProperties(); } mimeConfig = createMimeConfig(properties); } private MIMEConfig createMimeConfig(final MultiPartProperties properties) { final MIMEConfig mimeConfig = new MIMEConfig(); // Set values defined by user. mimeConfig.setMemoryThreshold(properties.getBufferThreshold()); final String tempDir = properties.getTempDir(); if (tempDir != null) { mimeConfig.setDir(tempDir); } if (properties.getBufferThreshold() != MultiPartProperties.BUFFER_THRESHOLD_MEMORY_ONLY) { // Validate - this checks whether it's possible to create temp files in currently set temp directory. try { //noinspection ResultOfMethodCallIgnored File.createTempFile("MIME", null, tempDir != null ? new File(tempDir) : null).delete(); } catch (final IOException ioe) { LOGGER.log(Level.WARNING, LocalizationMessages.TEMP_FILE_CANNOT_BE_CREATED(properties.getBufferThreshold()), ioe); } } return mimeConfig; } public boolean isReadable(final Class<?> type, final Type genericType, final Annotation[] annotations, final MediaType mediaType) { return MultiPart.class.isAssignableFrom(type); }
Reads the entire list of body parts from the Input stream, using the appropriate provider implementation to de-serialize each body part's entity.
Params:
  • type – the class of the object to be read (i.e. MultiPart.class).
  • genericType – the type of object to be written.
  • annotations – annotations on the resource method that returned this object.
  • mediaType – media type (multipart/*) of this entity.
  • headers – mutable map of HTTP headers for the entire response.
  • stream – output stream to which the entity should be written.
Throws:
  • IOException – if an I/O error occurs.
  • WebApplicationException – If an HTTP error response needs to be produced (only effective if the response is not committed yet) or if the Content-Disposition header of a multipart/form-data body part cannot be parsed.
/** * Reads the entire list of body parts from the Input stream, using the * appropriate provider implementation to de-serialize each body part's entity. * * @param type the class of the object to be read (i.e. {@link MultiPart}.class). * @param genericType the type of object to be written. * @param annotations annotations on the resource method that returned this object. * @param mediaType media type ({@code multipart/*}) of this entity. * @param headers mutable map of HTTP headers for the entire response. * @param stream output stream to which the entity should be written. * @throws java.io.IOException if an I/O error occurs. * @throws jakarta.ws.rs.WebApplicationException If an HTTP error response needs to be produced (only effective if the response * is not * committed yet) or if the Content-Disposition header of a {@code * multipart/form-data} body part * cannot be parsed. */
public MultiPart readFrom(final Class<MultiPart> type, final Type genericType, final Annotation[] annotations, final MediaType mediaType, final MultivaluedMap<String, String> headers, final InputStream stream) throws IOException, WebApplicationException { try { return readMultiPart(type, genericType, annotations, mediaType, headers, stream); } catch (final MIMEParsingException mpe) { if (mpe.getCause() instanceof IOException) { throw (IOException) mpe.getCause(); } else { throw new BadRequestException(mpe); } } } protected MultiPart readMultiPart(final Class<MultiPart> type, final Type genericType, final Annotation[] annotations, MediaType mediaType, final MultivaluedMap<String, String> headers, final InputStream stream) throws IOException, MIMEParsingException { mediaType = unquoteMediaTypeParameters(mediaType, "boundary"); final MIMEMessage mimeMessage = new MIMEMessage(stream, mediaType.getParameters().get("boundary"), mimeConfig); final boolean formData = MediaTypes.typeEqual(mediaType, MediaType.MULTIPART_FORM_DATA_TYPE); final MultiPart multiPart = formData ? new FormDataMultiPart() : new MultiPart(); final MessageBodyWorkers workers = messageBodyWorkers.get(); multiPart.setMessageBodyWorkers(workers); final MultivaluedMap<String, String> multiPartHeaders = multiPart.getHeaders(); for (final Map.Entry<String, List<String>> entry : headers.entrySet()) { final List<String> values = entry.getValue(); for (final String value : values) { multiPartHeaders.add(entry.getKey(), value); } } final boolean fileNameFix; if (!formData) { multiPart.setMediaType(mediaType); fileNameFix = false; } else { // see if the User-Agent header corresponds to some version of MS Internet Explorer // if so, need to set fileNameFix to true to handle issue http://java.net/jira/browse/JERSEY-759 final String userAgent = headers.getFirst(HttpHeaders.USER_AGENT); fileNameFix = userAgent != null && userAgent.contains(" MSIE "); } for (final MIMEPart mimePart : getMimeParts(mimeMessage)) { final BodyPart bodyPart = formData ? new FormDataBodyPart(fileNameFix) : new BodyPart(); // Configure providers. bodyPart.setMessageBodyWorkers(workers); // Copy headers. for (final Header header : mimePart.getAllHeaders()) { bodyPart.getHeaders().add(header.getName(), header.getValue()); } try { final String contentType = bodyPart.getHeaders().getFirst("Content-Type"); if (contentType != null) { bodyPart.setMediaType(MediaType.valueOf(contentType)); } bodyPart.getContentDisposition(); } catch (final IllegalArgumentException ex) { throw new BadRequestException(ex); } // Copy data into a BodyPartEntity structure. bodyPart.setEntity(new BodyPartEntity(mimePart)); // Add this BodyPart to our MultiPart. multiPart.getBodyParts().add(bodyPart); } return multiPart; }
Get a list of mime part attachments from given mime message. If an exception occurs during parsing the message the parsed mime parts are closed (any temporary files are deleted).
Params:
  • message – mime message to get mime parts from.
Returns:list of mime part attachments.
/** * Get a list of mime part attachments from given mime message. If an exception occurs during parsing the message the parsed * mime parts are closed (any temporary files are deleted). * * @param message mime message to get mime parts from. * @return list of mime part attachments. */
private List<MIMEPart> getMimeParts(final MIMEMessage message) { try { return message.getAttachments(); } catch (final MIMEParsingException obtainPartsError) { LOGGER.log(Level.FINE, LocalizationMessages.PARSING_ERROR(), obtainPartsError); message.close(); // Re-throw the exception. throw obtainPartsError; } } private static MediaType unquoteMediaTypeParameters(final MediaType mediaType, final String... parameters) { if (parameters == null || parameters.length == 0) { return mediaType; } final Map<String, String> unquotedParams = new HashMap<>(mediaType.getParameters()); for (final String parameter : parameters) { String value = mediaType.getParameters().get(parameter); if (value != null && value.startsWith("\"")) { value = value.substring(1, value.length() - 1); unquotedParams.put(parameter, value); } } return new MediaType(mediaType.getType(), mediaType.getSubtype(), unquotedParams); } }