Java tutorial
/**************************************************************** * 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.core; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.io.LineNumberReader; import java.io.OutputStream; import java.io.SequenceInputStream; import java.util.Enumeration; import java.util.UUID; import javax.activation.DataHandler; import javax.mail.MessagingException; import javax.mail.Session; import javax.mail.internet.InternetHeaders; import javax.mail.internet.MimeMessage; import javax.mail.util.SharedByteArrayInputStream; import org.apache.commons.io.IOUtils; import org.apache.james.lifecycle.api.Disposable; import org.apache.james.lifecycle.api.LifecycleUtil; /** * This object wraps a MimeMessage, only loading the underlying MimeMessage * object when needed. Also tracks if changes were made to reduce unnecessary * saves. */ public class MimeMessageWrapper extends MimeMessage implements Disposable { /** * System property which tells JAMES if it should copy a message in memory * or via a temporary file. Default is the file */ public final static String USE_MEMORY_COPY = "james.message.usememorycopy"; /** * Can provide an input stream to the data */ protected MimeMessageSource source = null; /** * This is false until we parse the message */ protected boolean messageParsed = false; /** * This is false until we parse the message */ protected boolean headersModified = false; /** * This is false until we parse the message */ protected boolean bodyModified = false; /** * Keep a reference to the sourceIn so we can close it only when we dispose * the message. */ private InputStream sourceIn; private long initialHeaderSize; private MimeMessageWrapper(Session session) { super(session); this.headers = null; this.modified = false; this.headersModified = false; this.bodyModified = false; } /** * A constructor that instantiates a MimeMessageWrapper based on a * MimeMessageSource * * @param source * the MimeMessageSource * @throws MessagingException */ public MimeMessageWrapper(Session session, MimeMessageSource source) { this(session); this.source = source; } /** * A constructor that instantiates a MimeMessageWrapper based on a * MimeMessageSource * * @param source * the MimeMessageSource * @throws MessagingException * @throws MessagingException */ public MimeMessageWrapper(MimeMessageSource source) { this(Session.getDefaultInstance(System.getProperties()), source); } public MimeMessageWrapper(MimeMessage original) throws MessagingException { this(Session.getDefaultInstance(System.getProperties())); flags = original.getFlags(); if (source == null) { InputStream in; boolean useMemoryCopy = false; String memoryCopy = System.getProperty(USE_MEMORY_COPY); if (memoryCopy != null) { useMemoryCopy = Boolean.valueOf(memoryCopy); } try { if (useMemoryCopy) { ByteArrayOutputStream bos; int size = original.getSize(); if (size > 0) { bos = new ByteArrayOutputStream(size); } else { bos = new ByteArrayOutputStream(); } original.writeTo(bos); bos.close(); in = new SharedByteArrayInputStream(bos.toByteArray()); parse(in); in.close(); saved = true; } else { MimeMessageInputStreamSource src = new MimeMessageInputStreamSource( "MailCopy-" + UUID.randomUUID().toString()); OutputStream out = src.getWritableOutputStream(); original.writeTo(out); out.close(); source = src; } } catch (IOException ex) { // should never happen, but just in case... throw new MessagingException("IOException while copying message", ex); } } } /** * Overrides default javamail behaviour by not altering the Message-ID by * default, see <a href="https://issues.apache.org/jira/browse/JAMES-875">JAMES-875</a> and * <a href="https://issues.apache.org/jira/browse/JAMES-1010">JAMES-1010</a> * * @see javax.mail.internet.MimeMessage#updateMessageID() */ @Override protected void updateMessageID() throws MessagingException { if (getMessageID() == null) super.updateMessageID(); } /** * Returns the source ID of the MimeMessageSource that is supplying this * with data. * * @see MimeMessageSource */ public synchronized String getSourceId() { return source != null ? source.getSourceId() : null; } /** * Load the message headers from the internal source. * * @throws MessagingException * if an error is encountered while loading the headers */ protected synchronized void loadHeaders() throws MessagingException { if (headers != null) { // Another thread has already loaded these headers } else if (source != null) { try { InputStream in = source.getInputStream(); try { headers = createInternetHeaders(in); } finally { IOUtils.closeQuietly(in); } } catch (IOException ioe) { throw new MessagingException("Unable to parse headers from stream: " + ioe.getMessage(), ioe); } } else { throw new MessagingException( "loadHeaders called for a message with no source, contentStream or stream"); } } /** * Load the complete MimeMessage from the internal source. * * @throws MessagingException * if an error is encountered while loading the message */ public synchronized void loadMessage() throws MessagingException { if (messageParsed) { // Another thread has already loaded this message } else if (source != null) { sourceIn = null; try { sourceIn = source.getInputStream(); parse(sourceIn); // TODO is it ok? saved = true; } catch (IOException ioe) { IOUtils.closeQuietly(sourceIn); sourceIn = null; throw new MessagingException("Unable to parse stream: " + ioe.getMessage(), ioe); } } else { throw new MessagingException("loadHeaders called for an unparsed message with no source"); } } /** * Get whether the message has been modified. * * @return whether the message has been modified */ public synchronized boolean isModified() { return headersModified || bodyModified || modified; } /** * Get whether the body of the message has been modified * * @return bodyModified */ public synchronized boolean isBodyModified() { return bodyModified; } /** * Get whether the header of the message has been modified * * @return headersModified */ public synchronized boolean isHeaderModified() { return headersModified; } /** * Rewritten for optimization purposes */ @Override public void writeTo(OutputStream os) throws IOException, MessagingException { writeTo(os, os); } /** * Rewritten for optimization purposes */ @Override public void writeTo(OutputStream os, String[] ignoreList) throws IOException, MessagingException { writeTo(os, os, ignoreList); } /** * Write */ public void writeTo(OutputStream headerOs, OutputStream bodyOs) throws IOException, MessagingException { writeTo(headerOs, bodyOs, new String[0]); } public void writeTo(OutputStream headerOs, OutputStream bodyOs, String[] ignoreList) throws IOException, MessagingException { writeTo(headerOs, bodyOs, ignoreList, false); } public synchronized void writeTo(OutputStream headerOs, OutputStream bodyOs, String[] ignoreList, boolean preLoad) throws IOException, MessagingException { if (!preLoad && source != null && !isBodyModified()) { // We do not want to instantiate the message... just read from // source // and write to this outputstream // First handle the headers InputStream in = source.getInputStream(); try { InternetHeaders myHeaders; MailHeaders parsedHeaders = new MailHeaders(in); // check if we should use the parsed headers or not if (!isHeaderModified()) { myHeaders = parsedHeaders; } else { // The headers was modified so we need to call saveChanges() just to be sure // See JAMES-1320 if (!saved) saveChanges(); myHeaders = headers; } @SuppressWarnings("unchecked") Enumeration<String> filteredHeaders = myHeaders.getNonMatchingHeaderLines(ignoreList); IOUtils.copy(new InternetHeadersInputStream(filteredHeaders), headerOs); IOUtils.copy(in, bodyOs); } finally { IOUtils.closeQuietly(in); } } else { // save the changes as the message was modified // See JAMES-1320 if (!saved) saveChanges(); // MimeMessageUtil.writeToInternal(this, headerOs, bodyOs, // ignoreList); if (headers == null) { loadHeaders(); } @SuppressWarnings("unchecked") Enumeration<String> filteredHeaders = headers.getNonMatchingHeaderLines(ignoreList); IOUtils.copy(new InternetHeadersInputStream(filteredHeaders), headerOs); if (preLoad && !messageParsed) { loadMessage(); } MimeMessageUtil.writeMessageBodyTo(this, bodyOs); } } /** * This is the MimeMessage implementation - this should return ONLY the * body, not the entire message (should not count headers). This size will * never change on {@link #saveChanges()} */ @Override public synchronized int getSize() throws MessagingException { if (source != null) { try { long fullSize = source.getMessageSize(); if (headers == null) { loadHeaders(); } // 2 == CRLF return (int) (fullSize - initialHeaderSize - 2); } catch (IOException e) { throw new MessagingException("Unable to calculate message size"); } } else { if (!messageParsed) { loadMessage(); } return super.getSize(); } } /** * Corrects JavaMail 1.1 version which always returns -1. Only corrected for * content less than 5000 bytes, to avoid memory hogging. */ @Override public int getLineCount() throws MessagingException { InputStream in; try { in = getContentStream(); } catch (Exception e) { return -1; } if (in == null) { return -1; } // Wrap input stream in LineNumberReader // Not sure what encoding to use really... InputStreamReader isr = null; LineNumberReader counter = null; try { if (getEncoding() != null) { isr = new InputStreamReader(in, getEncoding()); counter = new LineNumberReader(isr); } else { isr = new InputStreamReader(in); counter = new LineNumberReader(isr); } // Read through all the data char[] block = new char[4096]; while (counter.read(block) > -1) { // Just keep reading } return counter.getLineNumber(); } catch (IOException ioe) { return -1; } finally { IOUtils.closeQuietly(counter); IOUtils.closeQuietly(isr); IOUtils.closeQuietly(in); } } /** * Returns size of message, ie headers and content */ public long getMessageSize() throws MessagingException { if (source != null && !isModified()) { try { return source.getMessageSize(); } catch (IOException ioe) { throw new MessagingException("Error retrieving message size", ioe); } } else { return MimeMessageUtil.calculateMessageSize(this); } } /** * We override all the "headers" access methods to be sure that we loaded * the headers */ @Override public String[] getHeader(String name) throws MessagingException { if (headers == null) { loadHeaders(); } return headers.getHeader(name); } @Override public String getHeader(String name, String delimiter) throws MessagingException { if (headers == null) { loadHeaders(); } return headers.getHeader(name, delimiter); } @SuppressWarnings("unchecked") @Override public Enumeration<String> getAllHeaders() throws MessagingException { if (headers == null) { loadHeaders(); } return headers.getAllHeaders(); } @SuppressWarnings("unchecked") @Override public Enumeration<String> getMatchingHeaders(String[] names) throws MessagingException { if (headers == null) { loadHeaders(); } return headers.getMatchingHeaders(names); } @SuppressWarnings("unchecked") @Override public Enumeration<String> getNonMatchingHeaders(String[] names) throws MessagingException { if (headers == null) { loadHeaders(); } return headers.getNonMatchingHeaders(names); } @SuppressWarnings("unchecked") @Override public Enumeration<String> getAllHeaderLines() throws MessagingException { if (headers == null) { loadHeaders(); } return headers.getAllHeaderLines(); } @SuppressWarnings("unchecked") @Override public Enumeration<String> getMatchingHeaderLines(String[] names) throws MessagingException { if (headers == null) { loadHeaders(); } return headers.getMatchingHeaderLines(names); } @SuppressWarnings("unchecked") @Override public Enumeration<String> getNonMatchingHeaderLines(String[] names) throws MessagingException { if (headers == null) { loadHeaders(); } return headers.getNonMatchingHeaderLines(names); } private synchronized void checkModifyHeaders() throws MessagingException { // Disable only-header loading optimizations for JAMES-559 /* * if (!messageParsed) { loadMessage(); } */ // End JAMES-559 if (headers == null) { loadHeaders(); } modified = true; saved = false; headersModified = true; } @Override public void setHeader(String name, String value) throws MessagingException { checkModifyHeaders(); super.setHeader(name, value); } @Override public void addHeader(String name, String value) throws MessagingException { checkModifyHeaders(); super.addHeader(name, value); } @Override public void removeHeader(String name) throws MessagingException { checkModifyHeaders(); super.removeHeader(name); } @Override public void addHeaderLine(String line) throws MessagingException { checkModifyHeaders(); super.addHeaderLine(line); } /** * The message is changed when working with headers and when altering the * content. Every method that alter the content will fallback to this one. * * @see javax.mail.Part#setDataHandler(javax.activation.DataHandler) */ @Override public synchronized void setDataHandler(DataHandler arg0) throws MessagingException { modified = true; saved = false; bodyModified = true; super.setDataHandler(arg0); } @Override public void dispose() { if (sourceIn != null) { IOUtils.closeQuietly(sourceIn); } if (source != null) { LifecycleUtil.dispose(source); } } /** * @see javax.mail.internet.MimeMessage#parse(java.io.InputStream) */ @Override protected synchronized void parse(InputStream is) throws MessagingException { // the super implementation calls // headers = createInternetHeaders(is); super.parse(is); messageParsed = true; } /** * If we already parsed the headers then we simply return the updated ones. * Otherwise we parse * * @see javax.mail.internet.MimeMessage#createInternetHeaders(java.io.InputStream) */ @Override protected synchronized InternetHeaders createInternetHeaders(InputStream is) throws MessagingException { /* * This code is no more needed: see JAMES-570 and new tests * * InternetHeaders can be a bit awkward to work with due to its own * internal handling of header order. This hack may not always be * necessary, but for now we are trying to ensure that there is a * Return-Path header, even if just a placeholder, so that later, e.g., * in LocalDelivery, when we call setHeader, it will remove any other * Return-Path headers, and ensure that ours is on the top. addHeader * handles header order, but not setHeader. This may change in future * JavaMail. But if there are other Return-Path header values, let's * drop our placeholder. * * MailHeaders newHeaders = new MailHeaders(new * ByteArrayInputStream((f.RETURN_PATH + ": placeholder").getBytes())); * newHeaders.setHeader(RFC2822Headers.RETURN_PATH, null); * newHeaders.load(is); String[] returnPathHeaders = * newHeaders.getHeader(RFC2822Headers.RETURN_PATH); if * (returnPathHeaders.length > 1) * newHeaders.setHeader(RFC2822Headers.RETURN_PATH, * returnPathHeaders[1]); */ // Keep this: skip the headers from the stream // we could put that code in the else and simple write an "header" // skipping // reader for the others. MailHeaders newHeaders = new MailHeaders(is); if (headers != null) { return headers; } else { initialHeaderSize = newHeaders.getSize(); return newHeaders; } } /** * @see javax.mail.internet.MimeMessage#getContentStream() */ @Override protected InputStream getContentStream() throws MessagingException { if (!messageParsed) { loadMessage(); } return super.getContentStream(); } /** * @see javax.mail.internet.MimeMessage#getRawInputStream() */ @Override public synchronized InputStream getRawInputStream() throws MessagingException { if (!messageParsed && !isModified() && source != null) { InputStream is; try { is = source.getInputStream(); // skip the headers. new MailHeaders(is); return is; } catch (IOException e) { throw new MessagingException("Unable to read the stream: " + e.getMessage(), e); } } else { return super.getRawInputStream(); } } /** * Return an {@link InputStream} which holds the full content of the * message. This method tries to optimize this call as far as possible. This * stream contains the updated {@link MimeMessage} content if something was * changed * * @return messageInputStream * @throws MessagingException */ public synchronized InputStream getMessageInputStream() throws MessagingException { if (!messageParsed && !isModified() && source != null) { try { return source.getInputStream(); } catch (IOException e) { throw new MessagingException("Unable to get inputstream", e); } } else { try { // Try to optimize if possible to prevent OOM on big mails. // See JAMES-1252 for an example if (!bodyModified && source != null) { // ok only the headers were modified so we don't need to // copy the whole message content into memory InputStream in = source.getInputStream(); // skip over headers from original stream we want to use the // in memory ones new MailHeaders(in); // now construct the new stream using the in memory headers // and the body from the original source return new SequenceInputStream(new InternetHeadersInputStream(getAllHeaderLines()), in); } else { // the body was changed so we have no other solution to copy // it into memory first :( ByteArrayOutputStream out = new ByteArrayOutputStream(); writeTo(out); return new ByteArrayInputStream(out.toByteArray()); } } catch (IOException e) { throw new MessagingException("Unable to get inputstream", e); } } } }