InputFileInfo.java

/*
 * (C) Copyright 2006-2007 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * 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.
 *
 * Contributors:
 *     <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
 *
 * $Id: InputFileInfo.java 28476 2008-01-04 09:52:52Z sfermigier $
 */

package org.nuxeo.ecm.platform.ui.web.component.file;

import java.io.IOException;
import java.io.InputStream;
import java.io.Serializable;

import javax.faces.convert.ConverterException;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nuxeo.ecm.core.api.Blob;
import org.nuxeo.ecm.platform.ui.web.util.files.FileUtils;

/**
 * File information used to manage a file adding/removal.
 *
 * @author <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
 */
public class InputFileInfo implements Serializable {

    private static final long serialVersionUID = 1L;

    private static final Log log = LogFactory.getLog(InputFileInfo.class);

    public static final String EMPTY_FILE_MESSAGE = "error.inputFile.emptyFile";

    public static final String INVALID_FILE_MESSAGE = "error.inputFile.invalidFile";

    public static final String INVALID_WITH_AJAX_MESSAGE = "error.inputFile.ajax";

    protected Object choice;

    protected Blob blob;

    protected Object filename;

    protected Object mimeType;

    // empty constructor needed by JSF restore method
    public InputFileInfo() {
        super();
    }

    public InputFileInfo(Object choice, Blob blob, Object filename, Object mimeType) {
        this.choice = choice;
        this.blob = blob;
        this.filename = filename;
        this.mimeType = mimeType;
    }

    public Blob getBlob() {
        return blob;
    }

    public void setBlob(Blob blob) {
        this.blob = blob;
    }

    public Object getMimeType() {
        return mimeType;
    }

    public void setMimeType(Object mimeType) {
        this.mimeType = mimeType;
    }

    public String getConvertedMimeType() throws ConverterException {
        if (mimeType instanceof String) {
            return (String) mimeType;
        } else if (mimeType != null) {
            log.error("Invalid mimetype detected: " + mimeType);
        }
        return null;
    }

    public Blob getConvertedBlob() throws ConverterException {
        Blob convertedBlob = null;
        if (blob instanceof Blob) {
            convertedBlob = (Blob) blob;
        } else if (blob instanceof InputStream) {
            InputStream upFile = (InputStream) blob;
            try {
                if (upFile.available() == 0) {
                    throw new ConverterException(INVALID_FILE_MESSAGE);
                }
                convertedBlob = FileUtils.createSerializableBlob(upFile, getConvertedFilename(), getConvertedMimeType());
            } catch (ConverterException e) {
                throw e;
            } catch (IOException e) {
                throw new ConverterException(INVALID_FILE_MESSAGE);
            }
        } else if (blob != null) {
            throw new ConverterException(INVALID_FILE_MESSAGE);
        }
        return convertedBlob;
    }

    public Object getChoice() {
        return choice;
    }

    public void setChoice(Object choice) {
        this.choice = choice;
    }

    public String getConvertedChoice() throws ConverterException {
        if (choice == null || choice instanceof String) {
            return (String) choice;
        } else {
            throw new ConverterException("error.inputFile.invalidChoice");
        }
    }

    public Object getFilename() {
        return filename;
    }

    public void setFilename(Object filename) {
        this.filename = filename;
    }

    public String getConvertedFilename() throws ConverterException {
        String convertedFilename = null;
        if (filename instanceof String) {
            convertedFilename = FileUtils.getCleanFileName((String) filename);
        } else if (filename != null) {
            throw new ConverterException("error.inputFile.invalidFilename");
        }
        return convertedFilename;
    }

    protected static boolean equalValues(Object first, Object second) {
        if (first == null) {
            return second == null;
        } else {
            return first.equals(second);
        }
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof InputFileInfo)) {
            return false;
        }
        InputFileInfo other = (InputFileInfo) obj;
        if (!equalValues(choice, other.choice)) {
            return false;
        }
        if (!equalValues(filename, other.filename)) {
            return false;
        }
        if (!equalValues(blob, other.blob)) {
            return false;
        }
        if (!equalValues(mimeType, other.mimeType)) {
            return false;
        }
        return true;
    }

}