com.helger.web.fileupload.parse.DiskFileItemFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-web Show documentation
Java library with basic web functionality
There is a newer version: 10.1.9
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.web.fileupload.parse;

import java.io.File;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.annotation.VisibleForTesting;
import com.helger.commons.collection.impl.CommonsArrayList;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.concurrent.SimpleReadWriteLock;
import com.helger.commons.io.file.FileIOError;
import com.helger.commons.io.file.FileOperations;
import com.helger.web.fileupload.IFileItemFactory;

/**
 * 
 * The default {@link com.helger.web.fileupload.IFileItemFactory}
 * implementation. This implementation creates {@link DiskFileItem} instances
 * which keep their content either in memory, for smaller items, or in a
 * temporary file on disk, for larger items. The size threshold, above which
 * content will be stored on disk, is configurable, as is the directory in which
 * temporary files will be created.
 * 
 * 
 * If not otherwise configured, the default configuration values are as follows:
 * 
 * 
 * Size threshold is 10KB.
 * Repository is the system default temp directory, as returned by
 * System.getProperty("java.io.tmpdir").
 * 
 * 
 * Temporary files, which are created for file items, should be deleted later
 * on.
 * 
 *
 * @author Martin Cooper
 * @author Philip Helger
 */
@ThreadSafe
public class DiskFileItemFactory implements IFileItemFactory
{
  private static final Logger LOGGER = LoggerFactory.getLogger (DiskFileItemFactory.class);

  protected final SimpleReadWriteLock m_aRWLock = new SimpleReadWriteLock ();

  /**
   * The directory in which uploaded files will be stored, if stored on disk.
   */
  private File m_aRepository;

  /**
   * The threshold above which uploads will be stored on disk.
   */
  private final int m_nSizeThreshold;

  private final ICommonsList  m_aTempFiles = new CommonsArrayList <> ();

  @VisibleForTesting
  public DiskFileItemFactory (@Nonnegative final int nSizeThreshold)
  {
    this (nSizeThreshold, null);
  }

  /**
   * Constructs a preconfigured instance of this class.
   *
   * @param nSizeThreshold
   *        The threshold, in bytes, below which items will be retained in
   *        memory and above which they will be stored as a file.
   * @param aRepository
   *        The data repository, which is the directory in which files will be
   *        created, should the item size exceed the threshold.
   */
  public DiskFileItemFactory (@Nonnegative final int nSizeThreshold, @Nullable final File aRepository)
  {
    ValueEnforcer.isGT0 (nSizeThreshold, "SizeThreshold");

    m_nSizeThreshold = nSizeThreshold;
    setRepository (aRepository);
  }

  public void setRepository (@Nullable final File aRepository)
  {
    m_aRepository = aRepository;
  }

  private void _addTempFile (@Nonnull final File aFile)
  {
    m_aRWLock.writeLockedBoolean ( () -> m_aTempFiles.add (aFile));
  }

  /**
   * Create a new {@link com.helger.web.fileupload.parse.DiskFileItem} instance
   * from the supplied parameters and the local factory configuration.
   *
   * @param sFieldName
   *        The name of the form field.
   * @param sContentType
   *        The content type of the form field.
   * @param bIsFormField
   *        true if this is a plain form field; false
   *        otherwise.
   * @param sFileName
   *        The name of the uploaded file, if any, as supplied by the browser or
   *        other client.
   * @return The newly created file item.
   */
  @Nonnull
  public DiskFileItem createItem (@Nullable final String sFieldName,
                                  @Nullable final String sContentType,
                                  final boolean bIsFormField,
                                  @Nullable final String sFileName)
  {
    final DiskFileItem aFileItem = new DiskFileItem (sFieldName,
                                                     sContentType,
                                                     bIsFormField,
                                                     sFileName,
                                                     m_nSizeThreshold,
                                                     m_aRepository);
    // Add the temp file - may be non-existing if the size is below the
    // threshold
    _addTempFile (aFileItem.getTempFile ());
    return aFileItem;
  }

  @Nonnull
  @ReturnsMutableCopy
  public ICommonsList  getAllTemporaryFiles ()
  {
    return m_aRWLock.readLockedGet (m_aTempFiles::getClone);
  }

  public void deleteAllTemporaryFiles ()
  {
    final ICommonsList  aTempFiles = m_aRWLock.writeLockedGet ( () -> {
      final ICommonsList  ret = m_aTempFiles.getClone ();
      m_aTempFiles.clear ();
      return ret;
    });

    for (final File aTempFile : aTempFiles)
    {
      final FileIOError aIOError = FileOperations.deleteFileIfExisting (aTempFile);
      if (aIOError.isFailure ())
      {
        LOGGER.error ("Failed to delete temporary file " + aTempFile + " with error " + aIOError.toString ());
        _addTempFile (aTempFile);
      }
    }
  }
}