core/src/main/java/org/apache/james/mime4j/stream/MimeEntityConfig.java

/****************************************************************
 * 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.james.mime4j.stream;

import org.apache.james.mime4j.MimeException;
import org.apache.james.mime4j.parser.MaximalBodyDescriptor;
import org.apache.james.mime4j.parser.MimeStreamParser;
import org.apache.james.mime4j.parser.MimeTokenStream;

/**
 * MIME entity configuration
 */
public final class MimeEntityConfig implements Cloneable {

    private boolean maximalBodyDescriptor;
    private boolean strictParsing;
    private int maxLineLen;
    private int maxHeaderCount;
    private int maxHeaderLen;
    private long maxContentLen;
    private boolean countLineNumbers;
    private String defaultContentType;
    private boolean malformedHeaderStartsBody;
    
	public MimeEntityConfig() {
        this.maximalBodyDescriptor = false;
        this.strictParsing = false;
        this.maxLineLen = 1000;
        this.maxHeaderCount = 1000;
        this.maxHeaderLen = 10000;
        this.maxContentLen = -1;
        this.countLineNumbers = false;
        this.defaultContentType = null;
    }
    
    /**
     * @see #setMalformedHeaderStartsBody(boolean)
     * 
     * @return true if malformed header should "end" the headers and be 
     * part of the body
     */
    public boolean isMalformedHeaderStartsBody() {
		return malformedHeaderStartsBody;
	}

	/**
	 * Define the behaviour for dealing with malformed headers while in lenient
	 * mode
	 * 
	 * @param malformedHeaderStartsBody <code>true</code> to make the parser
	 *            interpret a malformed header as end of the headers and
	 *            as part of the body (as if the CRLF separator was missing).
	 *            <code>false</code> to simply ignore malformed headers and
	 *            continue parsing headers from the following line.
	 */
	public void setMalformedHeaderStartsBody(boolean malformedHeaderStartsBody) {
		this.malformedHeaderStartsBody = malformedHeaderStartsBody;
	}

    /**
     * Returns <code>true</code> if the maximum body descriptor should be
     * used, <code>false</code> for the default body descriptor.
     *
     * @see #setMaximalBodyDescriptor(boolean)
     *
     * @return value of maximum body descriptor.
     */
    public boolean isMaximalBodyDescriptor() {
        return this.maximalBodyDescriptor;
    }

    /**
     * Specified whether the parser should use an instance of
     * {@link MaximalBodyDescriptor} instead of {@link DefaultBodyDescriptor} to
     * encapsulate the values of MIME-specific header fields.
     * <p>
     * The body descriptor can be retrieved by calling
     * {@link MimeTokenStream#getBodyDescriptor()}.
     * <p>
     * Default value: <code>false</code>
     *
     * @param maximalBodyDescriptor <code>true</code> to use an instance of
     *            {@link MaximalBodyDescriptor}, <code>false</code> for an
     *            instance of {@link DefaultBodyDescriptor}.
     */
    public void setMaximalBodyDescriptor(boolean maximalBodyDescriptor) {
        this.maximalBodyDescriptor = maximalBodyDescriptor;
    }
    
    /**
     * Returns the value of the strict parsing mode
     * @see #setStrictParsing(boolean)
     * 
     * @return value of the strict parsing mode
     */
    public boolean isStrictParsing() {
        return this.strictParsing;
    }

    /**
     * Defines whether minor violations of the MIME specification should be 
     * tolerated or should result in a {@link MimeException}. If this parameter
     * is set to <code>true</code>, a strict interpretation of the MIME 
     * specification will be enforced, If this parameter is set to <code>false</code>
     * minor violations will result in a warning in the log.
     * <p>
     * Default value: <code>false</code>
     * 
     * @param strictParsing value of the strict parsing mode
     */
    public void setStrictParsing(boolean strictParsing) {
        this.strictParsing = strictParsing;
    }

    /** 
     * Returns the maximum line length limit
     * @see #setMaxLineLen(int)
     * 
     * @return value of the the maximum line length limit
     */
    public int getMaxLineLen() {
        return this.maxLineLen;
    }

    /**
     * Sets the maximum line length limit. Parsing of a MIME entity will be terminated 
     * with a {@link MimeException} if a line is encountered that exceeds the maximum
     * length limit. If this parameter is set to a non positive value the line length
     * check will be disabled.
     * <p>
     * Default value: <code>1000</code>
     * 
     * @param maxLineLen maximum line length limit
     */
    public void setMaxLineLen(int maxLineLen) {
        this.maxLineLen = maxLineLen;
    }
    
    /** 
     * Returns the maximum header limit
     * @see #setMaxHeaderCount(int)
     * 
     * @return value of the the maximum header limit
     */
    public int getMaxHeaderCount() {
        return this.maxHeaderCount;
    }

    /**
     * Sets the maximum header limit. Parsing of a MIME entity will be terminated 
     * with a {@link MimeException} if the number of headers exceeds the maximum
     * limit. If this parameter is set to a non positive value the header limit check 
     * will be disabled.
     * <p>
     * Default value: <code>1000</code>
     * 
     * @param maxHeaderCount maximum header limit
     */
    public void setMaxHeaderCount(int maxHeaderCount) {
        this.maxHeaderCount = maxHeaderCount;
    }

    /**
     * Returns the maximum header length limit
     * @see #setMaxHeaderLen(int)
     * 
     * @return value of the maximum header length limit
     */
    public int getMaxHeaderLen() {
        return maxHeaderLen;
    }

    /**
     * Sets the maximum header length limit. Parsing of a MIME entity will be terminated 
     * with a {@link MimeException} if the total length of a header exceeds this limit.
     * If this parameter is set to a non positive value the header length check will be
     * disabled.
     * <p>
     * A message header may be folded across multiple lines. This configuration parameter
     * is used to limit the total length of a header, i.e. the sum of the length of all
     * lines the header spans across (including line terminators).
     * <p>
     * Default value: <code>10000</code>
     * 
     * @param maxHeaderLen maximum header length limit
     */
    public void setMaxHeaderLen(int maxHeaderLen) {
        this.maxHeaderLen = maxHeaderLen;
    }

    /** 
     * Returns the maximum content length limit
     * @see #setMaxContentLen(long)
     * 
     * @return value of the the maximum content length limit
     */
    public long getMaxContentLen() {
        return maxContentLen;
    }

    /**
     * Sets the maximum content length limit. Parsing of a MIME entity will be terminated 
     * with a {@link MimeException} if a content body exceeds the maximum length limit. 
     * If this parameter is set to a non positive value the content length
     * check will be disabled.
     * <p>
     * Default value: <code>-1</code>
     * 
     * @param maxContentLen maximum content length limit
     */
    public void setMaxContentLen(long maxContentLen) {
        this.maxContentLen = maxContentLen;
    }

    /**
     * Returns the value of the line number counting mode.
     * 
     * @return value of the line number counting mode.
     */
    public boolean isCountLineNumbers() {
        return countLineNumbers;
    }

    /**
     * Defines whether the parser should count line numbers. If enabled line
     * numbers are included in the debug output.
     * <p>
     * Default value: <code>false</code>
     * 
     * @param countLineNumbers
     *            value of the line number counting mode.
     */
    public void setCountLineNumbers(boolean countLineNumbers) {
        this.countLineNumbers = countLineNumbers;
    }

    /**
     * Returns the value of the default content type. 
     * When not null, indicates that the parsing should be headless.
     * 
     * @return default content type when parsing headless,
     * null otherwise
     * @see MimeStreamParser#parse(java.io.InputStream)
     */
    public String getDefaultContentType() {
        return defaultContentType;
    }

    /**
     * Defines a default content type. 
     * When not null, indicates that the parsing should be headless.
     * <p>
     * Default value: <code>null</code>
     * 
     * @param defaultContentType
     *            value of the default content type when parsing headless,
     *            null otherwise
     * @see MimeStreamParser#parse(java.io.InputStream)
     */
    public void setDefaultContentType(String defaultContentType) {
        this.defaultContentType = defaultContentType;
    }

    @Override
    public MimeEntityConfig clone() {
        try {
            return (MimeEntityConfig) super.clone();
        } catch (CloneNotSupportedException e) {
            // this shouldn't happen, since we are Cloneable
            throw new InternalError();
        }
    }
    
    @Override
    public String toString() {
        return "[max body descriptor: " + maximalBodyDescriptor
                + ", strict parsing: " + strictParsing + ", max line length: "
                + maxLineLen + ", max header count: " + maxHeaderCount
                + ", max content length: " + maxContentLen
                + ", count line numbers: " + countLineNumbers + "]";
    }
    
}