source: trunk/LogicMail/src/org/logicprobe/LogicMail/message/MimeMessagePartFactory.java @ 766

/*-
 * Copyright (c) 2006, Derek Konigsberg
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the project nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.logicprobe.LogicMail.message;

/**
 * Creates message parts, doing the necessary decoding.
 */
public class MimeMessagePartFactory {
    /**
     * Create a new message part
     * @param mimeType MIME type
     * @param mimeSubtype MIME subtype
     * @param name Name of the message part
     * @param encoding Encoding type (i.e. 7bit, base64)
     * @param param Type-specific parameter (i.e. charset, filename)
     * @param disposition Content disposition for the part
     * @param contentId Content ID
     * @param size Size of the content this part refers to, or -1 if not available
     * @param tag Protocol-specific tag for addressing the part
     */
    public static MimeMessagePart createMimeMessagePart(
                String mimeType,
                String mimeSubtype,
                String name,
                String encoding,
                String param,
                String disposition,
                String contentId,
                int size,
                String tag) {
        
        // Make sure we aren't creating any null fields
        if(name == null) { name = ""; }
        if(encoding == null) { encoding = ""; }
        if(param == null) { param = ""; }
        if(disposition == null) { disposition = ""; }
        if(contentId == null) { contentId = ""; }
        if(tag == null) { tag = ""; }
        
        MimeMessagePart part;
        if (mimeType.equalsIgnoreCase("multipart")) {
            part = new MultiPart(mimeSubtype, tag);
        } else if (mimeType.equalsIgnoreCase(TextPart.TYPE)) {
                part = new TextPart(mimeSubtype, name, encoding, param, disposition, contentId, size, tag);
        } else if (mimeType.equalsIgnoreCase("image")) {
                part = new ImagePart(mimeSubtype, name, encoding, disposition, contentId, size, tag);
        } else if (mimeType.equalsIgnoreCase("application")) {
                part = new ApplicationPart(mimeSubtype, name, encoding, disposition, contentId, size, tag);
        } else if (mimeType.equalsIgnoreCase("audio")) {
                part = new AudioPart(mimeSubtype, name, encoding, disposition, contentId, size, tag);
        } else if (mimeType.equalsIgnoreCase("video")) {
                part = new VideoPart(mimeSubtype, name, encoding, disposition, contentId, size, tag);
        } else if (mimeType.equalsIgnoreCase("message")) {
                part = new MessagePart(mimeSubtype, name, encoding, disposition, contentId, size, tag);
        } else {
            part = new UnsupportedPart(mimeType, mimeSubtype, tag);
        }
        return part;
    }
    
    /**
     * Create a new message part
     * @param mimeType MIME type
     * @param mimeSubtype MIME subtype
     * @param name Name of the message part
     * @param encoding Encoding type (i.e. 7bit, base64)
     * @param param Type-specific parameter (i.e. charset, filename)
     * @param disposition Content disposition for the part
     * @param contentId Content ID
     * @param size Size of the content this part refers to, or -1 if not available
     */
    public static MimeMessagePart createMimeMessagePart(
                String mimeType,
                String mimeSubtype,
                String name,
                String encoding,
                String param,
                String disposition,
                String contentId,
                int size) {
        return MimeMessagePartFactory.createMimeMessagePart(mimeType, mimeSubtype, name, encoding, param, disposition, contentId, size, "");
    }
    
    /**
     * Find out if a particular message part type is supported
     * as displayable content.  This is useful to optimize
     * downloads on protocols that support selective retrieval
     * of message parts.
     * Right now the supported subtypes are hard-coded, but they
     * should ultimately be programmatically determined upon
     * initialization of this factory.
     *
     * @param mimeType MIME type
     * @param mimeSubtype MIME subtype
     * @return True if supported, false if unsupported
     */
    public static boolean isMimeMessagePartSupported(String mimeType,
        String mimeSubtype) {
        if (mimeType.equalsIgnoreCase("multipart")) {
            return isMultiPartSupported(mimeSubtype);
        } else if (mimeType.equalsIgnoreCase(TextPart.TYPE)) {
            return isTextPartSupported(mimeSubtype);
        } else if (mimeType.equalsIgnoreCase("image")) {
            return isImagePartSupported(mimeSubtype);
        } else {
            return false;
        }
    }

    private static boolean isMultiPartSupported(String mimeSubtype) {
        return (mimeSubtype.equalsIgnoreCase(MultiPart.MIXED) ||
        mimeSubtype.equalsIgnoreCase(MultiPart.RELATED) ||
        mimeSubtype.equalsIgnoreCase(MultiPart.ALTERNATIVE) ||
        mimeSubtype.equalsIgnoreCase(MultiPart.SIGNED));
    }

    private static boolean isTextPartSupported(String mimeSubtype) {
        // TODO: Add logic to only load plain or html, not both
        return (mimeSubtype.equalsIgnoreCase(TextPart.SUBTYPE_PLAIN) ||
        mimeSubtype.equalsIgnoreCase(TextPart.SUBTYPE_HTML));
    }

    private static boolean isImagePartSupported(String mimeSubtype) {
        return (mimeSubtype.equalsIgnoreCase("gif") ||
        mimeSubtype.equalsIgnoreCase("png") ||
        mimeSubtype.equalsIgnoreCase("vnd.wap.wbmp") ||
        mimeSubtype.equalsIgnoreCase("jpeg") ||
        mimeSubtype.equalsIgnoreCase("jpg") ||
        mimeSubtype.equalsIgnoreCase("pjpeg") ||
        mimeSubtype.equalsIgnoreCase("bmp") ||
        mimeSubtype.equalsIgnoreCase("tif"));
    }
}