alfresco-community-repo/source/java/org/alfresco/web/scripts/FormData.java

/*
 * Copyright (C) 2005-2007 Alfresco Software Limited.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */
package org.alfresco.web.scripts;

import java.io.IOException;
import java.io.Serializable;
import java.io.UnsupportedEncodingException;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.repo.jscript.Scopeable;
import org.alfresco.repo.jscript.ScriptNode;
import org.alfresco.repo.jscript.ScriptNode.ScriptContent;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileItemFactory;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
import org.apache.commons.io.FilenameUtils;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.Scriptable;


/**
 * Form Data
 * 
 * @author davidc
 */
public class FormData implements Serializable, Scopeable
{
    private static final long serialVersionUID = 1832644544828452385L;

    private Scriptable scope;
    private HttpServletRequest req;
    private ServletFileUpload upload;
    private Map<String, FormField> fields = null;
    private Map<String, String> parameters = null;
    private Map<String, ScriptContent> files = null;
    private String encoding = null;
   
    /**
     * Construct
     * 
     * @param req
     */
    public FormData(HttpServletRequest req)
    {
        this.req = req;
    }

    /* (non-Javadoc)
     * @see org.alfresco.repo.jscript.Scopeable#setScope(org.mozilla.javascript.Scriptable)
     */
    public void setScope(Scriptable scope)
    {
        this.scope = scope;
    }

    /**
     * Determine if multi-part form data has been provided
     * 
     * @return  true => multi-part
     */
    public boolean getIsMultiPart()
    {
        return upload.isMultipartContent(req);
    }

    /**
     * Determine if form data has specified field
     * 
     * @param name  field to look for
     * @return  true => form data contains field
     */
    public boolean hasField(String name)
    {
        Map<String, FormField> fields = getFieldsMap();
        return fields.containsKey(name);
    }

    /**
     * Gets the Form fields
     * 
     * @return  array of FormField
     */
    public Scriptable getFields()
    {
        Map<String, FormField> fieldsMap = getFieldsMap();
        Object[] fields = new Object[fieldsMap.values().size()];
        fieldsMap.values().toArray(fields);
        return Context.getCurrentContext().newArray(this.scope, fields);        
    }

    /**
     * Gets parameters encoded in the form data
     * 
     * @return  map (name, value) of parameters
     */
    /*package*/ Map<String, String> getParameters()
    {
        return getParametersMap();
    }
    
    /**
     * Gets files encoded in form data
     * 
     * @return  map (name, ScriptContent) of files
     */
    /*package*/ Map<String, ScriptContent> getFiles()
    {
        return getFilesMap();
    }
    
    /**
     * Helper to parse servlet request form data
     * 
     * @return  map of all form fields
     */
    private Map<String, FormField> getFieldsMap()
    {
        // NOTE: This class is not thread safe - it is expected to be constructed on each thread.
        if (fields == null)
        {
            FileItemFactory factory = new DiskFileItemFactory();
            upload = new ServletFileUpload(factory);
            encoding = req.getCharacterEncoding();
            upload.setHeaderEncoding(encoding);
            try
            {
                List<FileItem> fileItems = upload.parseRequest(req);
                fields = new HashMap<String, FormField>();
                for (FileItem fileItem : fileItems)
                {
                    FormField formField = new FormField(fileItem);
                    fields.put(fileItem.getFieldName(), formField);
                }
            }
            catch(FileUploadException e)
            {
                // NOTE: assume no files can be located
                fields = Collections.emptyMap();
            }
        }
        return fields;
    }
 
    /**
     * Helper to parse servlet request form data
     * 
     * @return  map of all form parameters
     */
    private Map<String, String> getParametersMap()
    {
        if (parameters == null)
        {
            Map<String, FormField> fields = getFieldsMap();
            parameters = new HashMap<String, String>();
            for (Map.Entry<String, FormField> entry : fields.entrySet())
            {
                FormField field = entry.getValue();
                if (!field.getIsFile())
                {
                    parameters.put(entry.getKey(), field.getValue());
                }
            }
        }
        return parameters;
    }
    
    /**
     * Helper to parse servlet request form data
     * 
     * @return  map of all form files
     */
    private Map<String, ScriptContent> getFilesMap()
    {
        if (files == null)
        {
            Map<String, FormField> fields = getFieldsMap();
            files = new HashMap<String, ScriptContent>();
            for (Map.Entry<String, FormField> entry : fields.entrySet())
            {
                FormField field = entry.getValue();
                if (field.getIsFile())
                {
                    files.put(entry.getKey(), field.getContent());
                }
            }           
        }
        return files;
    }
    

    /**
     * Form Field
     * 
     * @author davidc
     */
    public class FormField implements Serializable
    {
        private FileItem file;

        /**
         * Construct
         * 
         * @param file
         */
        public FormField(FileItem file)
        {
            this.file = file;
        }
        
        /**
         * @return  field name
         */
        public String getName()
        {
            return file.getFieldName();
        }
        
        public String jsGet_name()
        {
            return getName();
        }
        
        /**
         * @return  true => field represents a file
         */
        public boolean getIsFile()
        {
            return !file.isFormField();
        }
        
        public boolean jsGet_isFile()
        {
            return getIsFile();
        }

        /**
         * @return  field value (for file, attempts conversion to string)
         */
        public String getValue()
        {
            try
            {
                return (file.isFormField() && encoding != null) ? file.getString(encoding) : file.getString();
            }
            catch (UnsupportedEncodingException e)
            {
                throw new AlfrescoRuntimeException("Unable to decode form field", e);
            }
	    }
        
        public String jsGet_value()
        {
            return getValue();
        }

        /**
         * @return  field as content
         */
        public ScriptContent getContent()
        {
            try
            {
                return new ScriptNode.ScriptContentStream(file.getInputStream(), getMimetype(), null);
            }
            catch(IOException e)
            {
                return null;
            }
        }

        public ScriptContent jsGet_content()
        {
            return getContent();
        }

        /**
         * @return  mimetype
         */
        public String getMimetype()
        {
            return file.getContentType();
        }

        public String jsGet_mimetype()
        {
            return getMimetype();
        }

        /**
         * @return  filename (only for file fields, otherwise null)
         */
        public String getFilename()
        {
            // workaround a bug in IE where the full path is returned
            return FilenameUtils.getName(file.getName());
        }
        
        public String jsGet_filename()
        {
            return getFilename();
        }
    }
}