org.apache.myfaces.trinidadinternal.config.upload.UploadedFiles Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of trinidad-impl Show documentation
Show all versions of trinidad-impl Show documentation
Private implementation of the Apache MyFaces Trinidad project
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.myfaces.trinidadinternal.config.upload;
import java.io.IOException;
import java.io.InputStream;
import java.io.Serializable;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
import javax.portlet.PortletRequest;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import org.apache.myfaces.trinidad.context.RequestContext;
import org.apache.myfaces.trinidad.context.Window;
import org.apache.myfaces.trinidad.context.WindowManager;
import org.apache.myfaces.trinidad.logging.TrinidadLogger;
import org.apache.myfaces.trinidad.model.ExtendedUploadedFile;
import org.apache.myfaces.trinidad.model.UploadedFile;
import org.apache.myfaces.trinidadinternal.share.util.CaboHttpUtils;
/**
* UploadedFiles defines the set of files that have been uploaded
* to the server.
*
* @version $Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/webapp/UploadedFiles.java#0 $) $Date: 10-nov-2005.18:49:05 $
*/
final public class UploadedFiles implements Serializable
{
/**
* Returns the map of uploaded files for the current request.
*/
@SuppressWarnings("unchecked")
static public UploadedFiles getUploadedFiles(FacesContext context)
{
return getUploadedFiles(context.getExternalContext());
}
/**
* Returns the map of uploaded files for the current request.
*/
@SuppressWarnings("unchecked")
static public UploadedFiles getUploadedFiles(ExternalContext externalContext)
{
Map requestMap = externalContext.getRequestMap();
return (UploadedFiles) requestMap.get(_UPLOADED_FILES_KEY);
}
static public UploadedFiles getUploadedFiles(HttpServletRequest req)
{
return (UploadedFiles) req.getAttribute(_UPLOADED_FILES_KEY);
}
/**
* Returns the map of uploaded files for the current request.
*/
@SuppressWarnings("unchecked")
static public synchronized UploadedFiles getUploadedFilesForWindow(FacesContext context)
{
return getUploadedFilesForWindow(context.getExternalContext());
}
/**
* Returns the map of uploaded files for the current session.
*/
@SuppressWarnings("unchecked")
static public synchronized UploadedFiles getUploadedFilesForWindow(ExternalContext externalContext)
{
RequestContext requestContext = RequestContext.getCurrentInstance();
String windowId = _getCurrentWindowId(externalContext, requestContext);
UploadedFiles files = null;
if (externalContext.getRequest() instanceof HttpServletRequest)
{
HttpSession session = ((HttpServletRequest) externalContext.getRequest()).getSession();
Map uploadedFilesSessionMap =
(Map) session.getAttribute(_UPLOADED_FILES_KEY);
if (uploadedFilesSessionMap == null)
{
uploadedFilesSessionMap = __saveUploadedFilesForWindow(files, externalContext, requestContext);
}
files = uploadedFilesSessionMap.get(windowId);
}
if (files == null)
{
files = new UploadedFiles();
__saveUploadedFilesForWindow(files, externalContext, requestContext);
}
return files;
}
/**
* Store the character encoding for the current request.
*/
static public void setCharacterEncoding(
ExternalContext externalContext,
String encoding)
{
UploadedFiles files = getUploadedFiles(externalContext);
_setCharacterEncoding(files, encoding);
}
static public void setCharacterEncoding(
HttpServletRequest req,
String encoding)
{
UploadedFiles files = (UploadedFiles)
req.getAttribute(_UPLOADED_FILES_KEY);
_setCharacterEncoding(files, encoding);
}
static public void setCharacterEncoding(
PortletRequest req,
String encoding)
{
UploadedFiles files = (UploadedFiles)
req.getAttribute(_UPLOADED_FILES_KEY);
_setCharacterEncoding(files, encoding);
}
static private void _setCharacterEncoding(UploadedFiles files, String encoding)
{
if(files != null)
{
files._characterEncoding = encoding;
}
}
/**
* Returns a single uploaded file.
* @param name the name under which the file is stored. In HTML forms,
* this will be derived from the "name" set on the <input> tag.
*/
public UploadedFile getUploadedFile(String name)
{
List files = getUploadedFileList(name);
if (files == null || files.isEmpty())
return null;
for (UploadedFile file : files)
{
if (file != null)
{
return file;
}
}
return null;
}
/**
* Returns a list of uploaded files.
* @param name the name under which the files are stored. In HTML forms,
* this will be derived from the "name" set on the <input> tag.
*/
public List getUploadedFileList(String name)
{
List files = _map.get(name);
if (files == null || files.isEmpty())
return null;
return files;
}
/**
* Retrieves files uploaded during a multiple file upload and copies those
* files to the requestMap so they get processed and cleaned up as usual
* @param name the name under which the files are stored. In HTML forms,
* this will be derived from the "name" set on the <input> tag.
*/
public static void retrieveUploadedFilesForWindow(ExternalContext externalContext, String name)
{
UploadedFiles windowFiles = getUploadedFilesForWindow(externalContext);
if (windowFiles != null)
{
List windowFileList = windowFiles.getUploadedFileList(name);
if (windowFileList != null && !windowFileList.isEmpty())
{
UploadedFiles requestFiles = (UploadedFiles) externalContext.getRequestMap().get(_UPLOADED_FILES_KEY);
if (requestFiles == null)
{
requestFiles = new UploadedFiles(externalContext);
}
for (UploadedFile windowFile: windowFileList)
{
requestFiles.__put(name, windowFile);
}
// clear it in the map
windowFiles.getUploadedFileMap().remove(name);
__saveUploadedFilesForWindow(windowFiles, externalContext, RequestContext.getCurrentInstance());
}
}
}
/**
* Returns an Iterator of the names of all uploaded files.
*/
public Iterator getUploadedNames()
{
return _map.keySet().iterator();
}
/**
* Returns an Map of all of the uploaded files and names
*/
public Map> getUploadedFileMap()
{
return _map;
}
/**
* Dispose of all UploadedFiles. This will happen automatically
* when the current request ends, so clients do not need to
* call this method. However, if a developer is finished with
* processing files, this will free up resources earlier.
*/
public void dispose()
{
Iterator> iterator = _map.values().iterator();
while (iterator.hasNext())
{
List files = iterator.next();
if (files != null)
{
for (UploadedFile file: files)
{
if (file != null)
{
file.dispose();
}
}
}
}
_map.clear();
_totalMemory = 0;
_totalDiskSpace = 0;
}
UploadedFiles(HttpServletRequest req)
{
this();
req.setAttribute(_UPLOADED_FILES_KEY, this);
}
/**
* Creates an UploadedFiles.
*/
@SuppressWarnings("unchecked")
UploadedFiles(ExternalContext externalContext)
{
this();
externalContext.getRequestMap().put(_UPLOADED_FILES_KEY, this);
}
/**
* Creates an UploadedFiles.
*/
UploadedFiles()
{
_map = new HashMap>();
}
/**
* Store a single UploadedFile.
*/
void __put(String name, UploadedFile file)
{
List files = _map.get(name);
if (files == null)
{
files = new ArrayList();
}
UploadedFile fixFilename = null;
if (file instanceof ExtendedUploadedFile)
fixFilename = new FixFilenameProperties((ExtendedUploadedFile) file, _characterEncoding);
else
fixFilename = new FixFilename(file, _characterEncoding);
files.add(fixFilename);
_map.put(name, files);
}
/**
* Return the tally of total memory used.
*/
public long getTotalMemory()
{
return _totalMemory;
}
/**
* Return the tally of total disk space used.
*/
public long getTotalDiskSpace()
{
return _totalDiskSpace;
}
static synchronized Map __saveUploadedFilesForWindow(UploadedFiles files,
ExternalContext externalContext,
RequestContext requestContext)
{
Map uploadedFilesSessionMap = null;
String windowId = _getCurrentWindowId(externalContext, requestContext);
if (externalContext.getRequest() instanceof HttpServletRequest)
{
HttpSession session = ((HttpServletRequest) externalContext.getRequest()).getSession();
uploadedFilesSessionMap = (Map) session.getAttribute(_UPLOADED_FILES_KEY);
if (uploadedFilesSessionMap == null)
{
uploadedFilesSessionMap = new HashMap();
}
uploadedFilesSessionMap.put(windowId, files);
// Weblogic HA only replicates the HTTP Session if setAttribute() was called
// so we cannot call getSessionMap().put(_UPLOADED_FILES_KEY, uploadedFilesSessionMap) instead
session.setAttribute(_UPLOADED_FILES_KEY, uploadedFilesSessionMap);
}
return uploadedFilesSessionMap;
}
protected void finalize()
throws Throwable
{
try
{
dispose(); // close open files
}
finally
{
super.finalize();
}
}
private static String _getCurrentWindowId(ExternalContext externalContext, RequestContext requestContext)
{
if (requestContext != null)
{
WindowManager wm = requestContext.getWindowManager();
if (wm != null)
{
Window currWindow = wm.getCurrentWindow(externalContext);
if (currWindow != null)
{
return currWindow.getId();
}
}
}
// If there is no Window Id then return a default string
return "null";
}
private long _totalMemory;
private long _totalDiskSpace;
private String _characterEncoding;
private final Map> _map;
static private final long serialVersionUID = 3371575393458911349L;
private static final String _UPLOADED_FILES_KEY =
"org.apache.myfaces.trinidadinternal.webapp.UploadedFiles";
static public class FixFilename implements UploadedFile, Serializable
{
/**
* FixFilename provides the ability to specify an encoding for the filename
*/
private static final long serialVersionUID = -8586594511769079566L;
public FixFilename()
{
// For serialization
}
public FixFilename(UploadedFile file, String encoding)
{
_file = file;
_encoding = encoding;
}
public String getFilename()
{
if (_fixFilename == null)
{
String filename = _file.getFilename();
if (_encoding == null)
return filename;
try
{
_fixFilename = CaboHttpUtils.decodeRequestParameter(filename, _encoding, null);
}
catch (UnsupportedEncodingException uee)
{
// Should never happen, since the encoding should have
// already been vetted in UploadedRequestWrapper
assert false;
_fixFilename = filename;
}
}
return _fixFilename;
}
public String getContentType()
{
return _file.getContentType();
}
public long getLength()
{
return _file.getLength();
}
public Object getOpaqueData()
{
return _file.getOpaqueData();
}
public InputStream getInputStream() throws IOException
{
return _file.getInputStream();
}
public void dispose()
{
_file.dispose();
}
private UploadedFile _file;
private String _encoding;
private String _fixFilename = null;
}
static public class FixFilenameProperties extends ExtendedUploadedFile
{
/**
* FixFilename provides the ability to specify an encoding for the filename with properties
*/
private static final long serialVersionUID = -7477694533769079788L;
public FixFilenameProperties()
{
// For serialization
}
public FixFilenameProperties(final ExtendedUploadedFile file, final String encoding)
{
_original = file;
_file = new FixFilename(file, encoding);
}
public String getFilename()
{
return _file.getFilename();
}
public String getContentType()
{
return _file.getContentType();
}
public long getLength()
{
return _file.getLength();
}
public Object getOpaqueData()
{
return _file.getOpaqueData();
}
public InputStream getInputStream() throws IOException
{
return _file.getInputStream();
}
public Map getProperties()
{
return _original.getProperties();
}
public void dispose()
{
_file.dispose();
}
private FixFilename _file;
private ExtendedUploadedFile _original;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy