package com.fsck.k9.mail.store; import java.io.BufferedInputStream; import java.io.BufferedOutputStream; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.io.UnsupportedEncodingException; import java.net.ConnectException; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.Socket; import java.net.SocketAddress; import java.net.SocketException; import java.net.URI; import java.net.URISyntaxException; import java.net.URLDecoder; import java.net.URLEncoder; import java.nio.ByteBuffer; import java.nio.CharBuffer; import java.nio.charset.CharacterCodingException; import java.nio.charset.Charset; import java.nio.charset.CharsetDecoder; import java.nio.charset.CodingErrorAction; import java.security.GeneralSecurityException; import java.security.SecureRandom; import java.security.Security; import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.Date; import java.util.HashMap; import java.util.HashSet; import java.util.Iterator; import java.util.LinkedHashSet; import java.util.LinkedList; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.Set; import java.util.StringTokenizer; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicInteger; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLException; import javax.net.ssl.TrustManager; import android.content.Context; import android.net.ConnectivityManager; import android.net.NetworkInfo; import android.os.PowerManager; import android.util.Log; import com.beetstra.jutf7.CharsetProvider; import com.fsck.k9.Account; import com.fsck.k9.K9; import com.fsck.k9.R; import com.fsck.k9.controller.MessageRetrievalListener; import com.fsck.k9.helper.Utility; import com.fsck.k9.helper.power.TracingPowerManager; import com.fsck.k9.helper.power.TracingPowerManager.TracingWakeLock; import com.fsck.k9.mail.Authentication; import com.fsck.k9.mail.AuthenticationFailedException; import com.fsck.k9.mail.Body; import com.fsck.k9.mail.CertificateValidationException; import com.fsck.k9.mail.ConnectionSecurity; import com.fsck.k9.mail.FetchProfile; import com.fsck.k9.mail.Flag; import com.fsck.k9.mail.Folder; import com.fsck.k9.mail.Message; import com.fsck.k9.mail.MessagingException; import com.fsck.k9.mail.Part; import com.fsck.k9.mail.PushReceiver; import com.fsck.k9.mail.Pusher; import com.fsck.k9.mail.Store; import com.fsck.k9.mail.ServerSettings; import com.fsck.k9.mail.filter.EOLConvertingOutputStream; import com.fsck.k9.mail.filter.FixedLengthInputStream; import com.fsck.k9.mail.filter.PeekableInputStream; import com.fsck.k9.mail.internet.MimeBodyPart; import com.fsck.k9.mail.internet.MimeHeader; import com.fsck.k9.mail.internet.MimeMessage; import com.fsck.k9.mail.internet.MimeMultipart; import com.fsck.k9.mail.internet.MimeUtility; import com.fsck.k9.mail.store.ImapResponseParser.ImapList; import com.fsck.k9.mail.store.ImapResponseParser.ImapResponse; import com.fsck.k9.mail.transport.imap.ImapSettings; import com.jcraft.jzlib.JZlib; import com.jcraft.jzlib.ZOutputStream; import java.util.zip.Inflater; import java.util.zip.InflaterInputStream; import org.apache.commons.io.IOUtils; /** *
 * TODO Need to start keeping track of UIDVALIDITY
 * TODO Need a default response handler for things like folder updates
 * 
*/ public class ImapStore extends Store { public static final String STORE_TYPE = "IMAP"; public static final int CONNECTION_SECURITY_NONE = 0; public static final int CONNECTION_SECURITY_TLS_OPTIONAL = 1; public static final int CONNECTION_SECURITY_TLS_REQUIRED = 2; public static final int CONNECTION_SECURITY_SSL_REQUIRED = 3; public static final int CONNECTION_SECURITY_SSL_OPTIONAL = 4; public enum AuthType { PLAIN, CRAM_MD5 } private static final int IDLE_READ_TIMEOUT_INCREMENT = 5 * 60 * 1000; private static final int IDLE_FAILURE_COUNT_LIMIT = 10; private static int MAX_DELAY_TIME = 5 * 60 * 1000; // 5 minutes private static int NORMAL_DELAY_TIME = 5000; private static int FETCH_WINDOW_SIZE = 100; private static final Flag[] PERMANENT_FLAGS = { Flag.DELETED, Flag.SEEN }; private static final String CAPABILITY_IDLE = "IDLE"; private static final String COMMAND_IDLE = "IDLE"; private static final String CAPABILITY_NAMESPACE = "NAMESPACE"; private static final String COMMAND_NAMESPACE = "NAMESPACE"; private static final String CAPABILITY_CAPABILITY = "CAPABILITY"; private static final String COMMAND_CAPABILITY = "CAPABILITY"; private static final String CAPABILITY_COMPRESS_DEFLATE = "COMPRESS=DEFLATE"; private static final String COMMAND_COMPRESS_DEFLATE = "COMPRESS DEFLATE"; private static final Message[] EMPTY_MESSAGE_ARRAY = new Message[0]; private static final String[] EMPTY_STRING_ARRAY = new String[0]; /** * Decodes an ImapStore URI. * *

Possible forms:

*
     * imap://auth:user:password@server:port CONNECTION_SECURITY_NONE
     * imap+tls://auth:user:password@server:port CONNECTION_SECURITY_TLS_OPTIONAL
     * imap+tls+://auth:user:password@server:port CONNECTION_SECURITY_TLS_REQUIRED
     * imap+ssl+://auth:user:password@server:port CONNECTION_SECURITY_SSL_REQUIRED
     * imap+ssl://auth:user:password@server:port CONNECTION_SECURITY_SSL_OPTIONAL
     * 
*/ public static ImapStoreSettings decodeUri(String uri) { String host; int port; ConnectionSecurity connectionSecurity; String authenticationType = null; String username = null; String password = null; String pathPrefix = null; boolean autoDetectNamespace = true; URI imapUri; try { imapUri = new URI(uri); } catch (URISyntaxException use) { throw new IllegalArgumentException("Invalid ImapStore URI", use); } String scheme = imapUri.getScheme(); if (scheme.equals("imap")) { connectionSecurity = ConnectionSecurity.NONE; port = 143; } else if (scheme.equals("imap+tls")) { connectionSecurity = ConnectionSecurity.STARTTLS_OPTIONAL; port = 143; } else if (scheme.equals("imap+tls+")) { connectionSecurity = ConnectionSecurity.STARTTLS_REQUIRED; port = 143; } else if (scheme.equals("imap+ssl+")) { connectionSecurity = ConnectionSecurity.SSL_TLS_REQUIRED; port = 993; } else if (scheme.equals("imap+ssl")) { connectionSecurity = ConnectionSecurity.SSL_TLS_OPTIONAL; port = 993; } else { throw new IllegalArgumentException("Unsupported protocol (" + scheme + ")"); } host = imapUri.getHost(); if (imapUri.getPort() != -1) { port = imapUri.getPort(); } if (imapUri.getUserInfo() != null) { try { String userinfo = imapUri.getUserInfo(); String[] userInfoParts = userinfo.split(":"); if (userinfo.endsWith(":")) { // Password is empty. This can only happen after an account was imported. authenticationType = AuthType.valueOf(userInfoParts[0]).name(); username = URLDecoder.decode(userInfoParts[1], "UTF-8"); } else if (userInfoParts.length == 2) { authenticationType = AuthType.PLAIN.name(); username = URLDecoder.decode(userInfoParts[0], "UTF-8"); password = URLDecoder.decode(userInfoParts[1], "UTF-8"); } else { authenticationType = AuthType.valueOf(userInfoParts[0]).name(); username = URLDecoder.decode(userInfoParts[1], "UTF-8"); password = URLDecoder.decode(userInfoParts[2], "UTF-8"); } } catch (UnsupportedEncodingException enc) { // This shouldn't happen since the encoding is hardcoded to UTF-8 throw new IllegalArgumentException("Couldn't urldecode username or password.", enc); } } String path = imapUri.getPath(); if (path != null && path.length() > 1) { // Strip off the leading "/" String cleanPath = path.substring(1); if (cleanPath.length() >= 2 && cleanPath.charAt(1) == '|') { autoDetectNamespace = cleanPath.charAt(0) == '1'; if (!autoDetectNamespace) { pathPrefix = cleanPath.substring(2); } } else { if (cleanPath.length() > 0) { pathPrefix = cleanPath; autoDetectNamespace = false; } } } return new ImapStoreSettings(host, port, connectionSecurity, authenticationType, username, password, autoDetectNamespace, pathPrefix); } /** * Creates an ImapStore URI with the supplied settings. * * @param server * The {@link ServerSettings} object that holds the server settings. * * @return An ImapStore URI that holds the same information as the {@code server} parameter. * * @see Account#getStoreUri() * @see ImapStore#decodeUri(String) */ public static String createUri(ServerSettings server) { String userEnc; String passwordEnc; try { userEnc = URLEncoder.encode(server.username, "UTF-8"); passwordEnc = (server.password != null) ? URLEncoder.encode(server.password, "UTF-8") : ""; } catch (UnsupportedEncodingException e) { throw new IllegalArgumentException("Could not encode username or password", e); } String scheme; switch (server.connectionSecurity) { case SSL_TLS_OPTIONAL: scheme = "imap+ssl"; break; case SSL_TLS_REQUIRED: scheme = "imap+ssl+"; break; case STARTTLS_OPTIONAL: scheme = "imap+tls"; break; case STARTTLS_REQUIRED: scheme = "imap+tls+"; break; default: case NONE: scheme = "imap"; break; } AuthType authType; try { authType = AuthType.valueOf(server.authenticationType); } catch (Exception e) { throw new IllegalArgumentException("Invalid authentication type: " + server.authenticationType); } String userInfo = authType.toString() + ":" + userEnc + ":" + passwordEnc; try { Map extra = server.getExtra(); String path = null; if (extra != null) { boolean autoDetectNamespace = Boolean.TRUE.toString().equals( extra.get(ImapStoreSettings.AUTODETECT_NAMESPACE_KEY)); String pathPrefix = (autoDetectNamespace) ? null : extra.get(ImapStoreSettings.PATH_PREFIX_KEY); path = "/" + (autoDetectNamespace ? "1" : "0") + "|" + ((pathPrefix == null) ? "" : pathPrefix); } else { path = "/1|"; } return new URI(scheme, userInfo, server.host, server.port, path, null, null).toString(); } catch (URISyntaxException e) { throw new IllegalArgumentException("Can't create ImapStore URI", e); } } /** * This class is used to store the decoded contents of an ImapStore URI. * * @see ImapStore#decodeUri(String) */ public static class ImapStoreSettings extends ServerSettings { public static final String AUTODETECT_NAMESPACE_KEY = "autoDetectNamespace"; public static final String PATH_PREFIX_KEY = "pathPrefix"; public final boolean autoDetectNamespace; public final String pathPrefix; protected ImapStoreSettings(String host, int port, ConnectionSecurity connectionSecurity, String authenticationType, String username, String password, boolean autodetectNamespace, String pathPrefix) { super(STORE_TYPE, host, port, connectionSecurity, authenticationType, username, password); this.autoDetectNamespace = autodetectNamespace; this.pathPrefix = pathPrefix; } @Override public Map getExtra() { Map extra = new HashMap(); extra.put(AUTODETECT_NAMESPACE_KEY, Boolean.valueOf(autoDetectNamespace).toString()); putIfNotNull(extra, PATH_PREFIX_KEY, pathPrefix); return extra; } @Override public ServerSettings newPassword(String newPassword) { return new ImapStoreSettings(host, port, connectionSecurity, authenticationType, username, newPassword, autoDetectNamespace, pathPrefix); } } private String mHost; private int mPort; private String mUsername; private String mPassword; private int mConnectionSecurity; private AuthType mAuthType; private volatile String mPathPrefix; private volatile String mCombinedPrefix = null; private volatile String mPathDelimeter = null; public class StoreImapSettings implements ImapSettings { @Override public String getHost() { return mHost; } @Override public int getPort() { return mPort; } @Override public int getConnectionSecurity() { return mConnectionSecurity; } @Override public AuthType getAuthType() { return mAuthType; } @Override public String getUsername() { return mUsername; } @Override public String getPassword() { return mPassword; } @Override public boolean useCompression(final int type) { return mAccount.useCompression(type); } @Override public String getPathPrefix() { return mPathPrefix; } @Override public void setPathPrefix(String prefix) { mPathPrefix = prefix; } @Override public String getPathDelimeter() { return mPathDelimeter; } @Override public void setPathDelimeter(String delimeter) { mPathDelimeter = delimeter; } @Override public String getCombinedPrefix() { return mCombinedPrefix; } @Override public void setCombinedPrefix(String prefix) { mCombinedPrefix = prefix; } } private static final SimpleDateFormat RFC3501_DATE = new SimpleDateFormat("dd-MMM-yyyy", Locale.US); private LinkedList mConnections = new LinkedList(); /** * Charset used for converting folder names to and from UTF-7 as defined by RFC 3501. */ private Charset mModifiedUtf7Charset; /** * Cache of ImapFolder objects. ImapFolders are attached to a given folder on the server * and as long as their associated connection remains open they are reusable between * requests. This cache lets us make sure we always reuse, if possible, for a given * folder name. */ private HashMap mFolderCache = new HashMap(); public ImapStore(Account account) throws MessagingException { super(account); ImapStoreSettings settings; try { settings = decodeUri(mAccount.getStoreUri()); } catch (IllegalArgumentException e) { throw new MessagingException("Error while decoding store URI", e); } mHost = settings.host; mPort = settings.port; switch (settings.connectionSecurity) { case NONE: mConnectionSecurity = CONNECTION_SECURITY_NONE; break; case STARTTLS_OPTIONAL: mConnectionSecurity = CONNECTION_SECURITY_TLS_OPTIONAL; break; case STARTTLS_REQUIRED: mConnectionSecurity = CONNECTION_SECURITY_TLS_REQUIRED; break; case SSL_TLS_OPTIONAL: mConnectionSecurity = CONNECTION_SECURITY_SSL_OPTIONAL; break; case SSL_TLS_REQUIRED: mConnectionSecurity = CONNECTION_SECURITY_SSL_REQUIRED; break; } mAuthType = AuthType.valueOf(settings.authenticationType); mUsername = settings.username; mPassword = settings.password; // Make extra sure mPathPrefix is null if "auto-detect namespace" is configured mPathPrefix = (settings.autoDetectNamespace) ? null : settings.pathPrefix; mModifiedUtf7Charset = new CharsetProvider().charsetForName("X-RFC-3501"); } @Override public Folder getFolder(String name) { ImapFolder folder; synchronized (mFolderCache) { folder = mFolderCache.get(name); if (folder == null) { folder = new ImapFolder(this, name); mFolderCache.put(name, folder); } } return folder; } private String getCombinedPrefix() { if (mCombinedPrefix == null) { if (mPathPrefix != null) { String tmpPrefix = mPathPrefix.trim(); String tmpDelim = (mPathDelimeter != null ? mPathDelimeter.trim() : ""); if (tmpPrefix.endsWith(tmpDelim)) { mCombinedPrefix = tmpPrefix; } else if (tmpPrefix.length() > 0) { mCombinedPrefix = tmpPrefix + tmpDelim; } else { mCombinedPrefix = ""; } } else { mCombinedPrefix = ""; } } return mCombinedPrefix; } @Override public List getPersonalNamespaces(boolean forceListAll) throws MessagingException { ImapConnection connection = getConnection(); try { List allFolders = listFolders(connection, false); if (forceListAll || !mAccount.subscribedFoldersOnly()) { return allFolders; } else { List resultFolders = new LinkedList(); HashSet subscribedFolderNames = new HashSet(); List subscribedFolders = listFolders(connection, true); for (Folder subscribedFolder : subscribedFolders) { subscribedFolderNames.add(subscribedFolder.getName()); } for (Folder folder : allFolders) { if (subscribedFolderNames.contains(folder.getName())) { resultFolders.add(folder); } } return resultFolders; } } catch (IOException ioe) { connection.close(); throw new MessagingException("Unable to get folder list.", ioe); } catch (MessagingException me) { connection.close(); throw new MessagingException("Unable to get folder list.", me); } finally { releaseConnection(connection); } } private List listFolders(ImapConnection connection, boolean LSUB) throws IOException, MessagingException { String commandResponse = LSUB ? "LSUB" : "LIST"; LinkedList folders = new LinkedList(); List responses = connection.executeSimpleCommand(String.format("%s \"\" %s", commandResponse, encodeString(getCombinedPrefix() + "*"))); for (ImapResponse response : responses) { if (ImapResponseParser.equalsIgnoreCase(response.get(0), commandResponse)) { boolean includeFolder = true; String decodedFolderName; try { decodedFolderName = decodeFolderName(response.getString(3)); } catch (CharacterCodingException e) { Log.w(K9.LOG_TAG, "Folder name not correctly encoded with the UTF-7 variant " + "as defined by RFC 3501: " + response.getString(3), e); //TODO: Use the raw name returned by the server for all commands that require // a folder name. Use the decoded name only for showing it to the user. // We currently just skip folders with malformed names. continue; } String folder = decodedFolderName; if (mPathDelimeter == null) { mPathDelimeter = response.getString(2); mCombinedPrefix = null; } if (folder.equalsIgnoreCase(mAccount.getInboxFolderName())) { continue; } else if (folder.equals(mAccount.getOutboxFolderName())) { /* * There is a folder on the server with the same name as our local * outbox. Until we have a good plan to deal with this situation * we simply ignore the folder on the server. */ continue; } else { int prefixLength = getCombinedPrefix().length(); if (prefixLength > 0) { // Strip prefix from the folder name if (folder.length() >= prefixLength) { folder = folder.substring(prefixLength); } if (!decodedFolderName.equalsIgnoreCase(getCombinedPrefix() + folder)) { includeFolder = false; } } } ImapList attributes = response.getList(1); for (int i = 0, count = attributes.size(); i < count; i++) { String attribute = attributes.getString(i); if (attribute.equalsIgnoreCase("\\NoSelect")) { includeFolder = false; } } if (includeFolder) { folders.add(getFolder(folder)); } } } folders.add(getFolder(mAccount.getInboxFolderName())); return folders; } /** * Attempt to auto-configure folders by attributes if the server advertises that capability. * * The parsing here is essentially the same as * {@link #listFolders(com.fsck.k9.mail.store.ImapStore.ImapConnection, boolean)}; we should try to consolidate * this at some point. :( * @param connection IMAP Connection * @throws IOException uh oh! * @throws MessagingException uh oh! */ private void autoconfigureFolders(final ImapConnection connection) throws IOException, MessagingException { String commandResponse = null; String commandOptions = ""; if (connection.capabilities.contains("XLIST")) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Folder auto-configuration: Using XLIST."); commandResponse = "XLIST"; } else if(connection.capabilities.contains("SPECIAL-USE")) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Folder auto-configuration: Using RFC6154/SPECIAL-USE."); commandResponse = "LIST"; commandOptions = " (SPECIAL-USE)"; } else { if (K9.DEBUG) Log.d(K9.LOG_TAG, "No detected folder auto-configuration methods."); return; } final List responses = connection.executeSimpleCommand(String.format("%s%s \"\" %s", commandResponse, commandOptions, encodeString(getCombinedPrefix() + "*"))); for (ImapResponse response : responses) { if (ImapResponseParser.equalsIgnoreCase(response.get(0), commandResponse)) { String decodedFolderName; try { decodedFolderName = decodeFolderName(response.getString(3)); } catch (CharacterCodingException e) { Log.w(K9.LOG_TAG, "Folder name not correctly encoded with the UTF-7 variant " + "as defined by RFC 3501: " + response.getString(3), e); // We currently just skip folders with malformed names. continue; } if (mPathDelimeter == null) { mPathDelimeter = response.getString(2); mCombinedPrefix = null; } ImapList attributes = response.getList(1); for (int i = 0, count = attributes.size(); i < count; i++) { String attribute = attributes.getString(i); if (attribute.equals("\\Drafts")) { mAccount.setDraftsFolderName(decodedFolderName); if (K9.DEBUG) Log.d(K9.LOG_TAG, "Folder auto-configuration detected draft folder: " + decodedFolderName); } else if (attribute.equals("\\Sent")) { mAccount.setSentFolderName(decodedFolderName); if (K9.DEBUG) Log.d(K9.LOG_TAG, "Folder auto-configuration detected sent folder: " + decodedFolderName); } else if (attribute.equals("\\Spam")) { mAccount.setSpamFolderName(decodedFolderName); if (K9.DEBUG) Log.d(K9.LOG_TAG, "Folder auto-configuration detected spam folder: " + decodedFolderName); } else if (attribute.equals("\\Trash")) { mAccount.setTrashFolderName(decodedFolderName); if (K9.DEBUG) Log.d(K9.LOG_TAG, "Folder auto-configuration detected trash folder: " + decodedFolderName); } } } } } @Override public void checkSettings() throws MessagingException { try { ImapConnection connection = new ImapConnection(new StoreImapSettings()); connection.open(); autoconfigureFolders(connection); connection.close(); } catch (IOException ioe) { throw new MessagingException(K9.app.getString(R.string.error_unable_to_connect), ioe); } } /** * Gets a connection if one is available for reuse, or creates a new one if not. * @return */ private ImapConnection getConnection() throws MessagingException { synchronized (mConnections) { ImapConnection connection = null; while ((connection = mConnections.poll()) != null) { try { connection.executeSimpleCommand("NOOP"); break; } catch (IOException ioe) { connection.close(); } } if (connection == null) { connection = new ImapConnection(new StoreImapSettings()); } return connection; } } private void releaseConnection(ImapConnection connection) { if (connection != null && connection.isOpen()) { synchronized (mConnections) { mConnections.offer(connection); } } } /** * Encode a string to be able to use it in an IMAP command. * * "A quoted string is a sequence of zero or more 7-bit characters, * excluding CR and LF, with double quote (<">) characters at each * end." - Section 4.3, RFC 3501 * * Double quotes and backslash are escaped by prepending a backslash. * * @param str * The input string (only 7-bit characters allowed). * @return * The string encoded as quoted (IMAP) string. */ private static String encodeString(String str) { return "\"" + str.replace("\\", "\\\\").replace("\"", "\\\"") + "\""; } private String encodeFolderName(String name) { try { ByteBuffer bb = mModifiedUtf7Charset.encode(name); byte[] b = new byte[bb.limit()]; bb.get(b); return new String(b, "US-ASCII"); } catch (UnsupportedEncodingException uee) { /* * The only thing that can throw this is getBytes("US-ASCII") and if US-ASCII doesn't * exist we're totally screwed. */ throw new RuntimeException("Unable to encode folder name: " + name, uee); } } private String decodeFolderName(String name) throws CharacterCodingException { /* * Convert the encoded name to US-ASCII, then pass it through the modified UTF-7 * decoder and return the Unicode String. */ try { // Make sure the decoder throws an exception if it encounters an invalid encoding. CharsetDecoder decoder = mModifiedUtf7Charset.newDecoder().onMalformedInput(CodingErrorAction.REPORT); CharBuffer cb = decoder.decode(ByteBuffer.wrap(name.getBytes("US-ASCII"))); return cb.toString(); } catch (UnsupportedEncodingException uee) { /* * The only thing that can throw this is getBytes("US-ASCII") and if US-ASCII doesn't * exist we're totally screwed. */ throw new RuntimeException("Unable to decode folder name: " + name, uee); } } @Override public boolean isMoveCapable() { return true; } @Override public boolean isCopyCapable() { return true; } @Override public boolean isPushCapable() { return true; } @Override public boolean isExpungeCapable() { return true; } class ImapFolder extends Folder { private String mName; protected volatile int mMessageCount = -1; protected volatile int uidNext = -1; protected volatile ImapConnection mConnection; private OpenMode mMode; private volatile boolean mExists; private ImapStore store = null; Map msgSeqUidMap = new ConcurrentHashMap(); public ImapFolder(ImapStore nStore, String name) { super(nStore.getAccount()); store = nStore; this.mName = name; } public String getPrefixedName() throws MessagingException { String prefixedName = ""; if (!mAccount.getInboxFolderName().equalsIgnoreCase(mName)) { ImapConnection connection = null; synchronized (this) { if (mConnection == null) { connection = getConnection(); } else { connection = mConnection; } } try { connection.open(); } catch (IOException ioe) { throw new MessagingException("Unable to get IMAP prefix", ioe); } finally { if (mConnection == null) { releaseConnection(connection); } } prefixedName = getCombinedPrefix(); } prefixedName += mName; return prefixedName; } protected List executeSimpleCommand(String command) throws MessagingException, IOException { return handleUntaggedResponses(mConnection.executeSimpleCommand(command)); } protected List executeSimpleCommand(String command, boolean sensitve, UntaggedHandler untaggedHandler) throws MessagingException, IOException { return handleUntaggedResponses(mConnection.executeSimpleCommand(command, sensitve, untaggedHandler)); } @Override public void open(OpenMode mode) throws MessagingException { internalOpen(mode); if (mMessageCount == -1) { throw new MessagingException( "Did not find message count during open"); } } public List internalOpen(OpenMode mode) throws MessagingException { if (isOpen() && mMode == mode) { // Make sure the connection is valid. If it's not we'll close it down and continue // on to get a new one. try { List responses = executeSimpleCommand("NOOP"); return responses; } catch (IOException ioe) { ioExceptionHandler(mConnection, ioe); } } releaseConnection(mConnection); synchronized (this) { mConnection = getConnection(); } // * FLAGS (\Answered \Flagged \Deleted \Seen \Draft NonJunk // $MDNSent) // * OK [PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft // NonJunk $MDNSent \*)] Flags permitted. // * 23 EXISTS // * 0 RECENT // * OK [UIDVALIDITY 1125022061] UIDs valid // * OK [UIDNEXT 57576] Predicted next UID // 2 OK [READ-WRITE] Select completed. try { msgSeqUidMap.clear(); String command = String.format("%s %s", mode == OpenMode.READ_WRITE ? "SELECT" : "EXAMINE", encodeString(encodeFolderName(getPrefixedName()))); List responses = executeSimpleCommand(command); /* * If the command succeeds we expect the folder has been opened read-write * unless we are notified otherwise in the responses. */ mMode = mode; for (ImapResponse response : responses) { if (response.mTag != null && response.size() >= 2) { Object bracketedObj = response.get(1); if (bracketedObj instanceof ImapList) { ImapList bracketed = (ImapList)bracketedObj; if (!bracketed.isEmpty()) { Object keyObj = bracketed.get(0); if (keyObj instanceof String) { String key = (String)keyObj; if ("READ-ONLY".equalsIgnoreCase(key)) { mMode = OpenMode.READ_ONLY; } else if ("READ-WRITE".equalsIgnoreCase(key)) { mMode = OpenMode.READ_WRITE; } } } } } } mExists = true; return responses; } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } catch (MessagingException me) { Log.e(K9.LOG_TAG, "Unable to open connection for " + getLogId(), me); throw me; } } @Override public boolean isOpen() { return mConnection != null; } @Override public OpenMode getMode() { return mMode; } @Override public void close() { if (mMessageCount != -1) { mMessageCount = -1; } if (!isOpen()) { return; } synchronized (this) { releaseConnection(mConnection); mConnection = null; } } @Override public String getName() { return mName; } /** * Check if a given folder exists on the server. * * @param folderName * The name of the folder encoded as quoted string. * See {@link ImapStore#encodeString} * * @return * {@code True}, if the folder exists. {@code False}, otherwise. */ private boolean exists(String folderName) throws MessagingException { try { // Since we don't care about RECENT, we'll use that for the check, because we're checking // a folder other than ourself, and don't want any untagged responses to cause a change // in our own fields mConnection.executeSimpleCommand(String.format("STATUS %s (RECENT)", folderName)); return true; } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } catch (ImapException ie) { // We got a response, but it was not "OK" return false; } } @Override public boolean exists() throws MessagingException { if (mExists) { return true; } /* * This method needs to operate in the unselected mode as well as the selected mode * so we must get the connection ourselves if it's not there. We are specifically * not calling checkOpen() since we don't care if the folder is open. */ ImapConnection connection = null; synchronized (this) { if (mConnection == null) { connection = getConnection(); } else { connection = mConnection; } } try { connection.executeSimpleCommand(String.format("STATUS %s (UIDVALIDITY)", encodeString(encodeFolderName(getPrefixedName())))); mExists = true; return true; } catch (ImapException ie) { // We got a response, but it was not "OK" return false; } catch (IOException ioe) { throw ioExceptionHandler(connection, ioe); } finally { if (mConnection == null) { releaseConnection(connection); } } } @Override public boolean create(FolderType type) throws MessagingException { /* * This method needs to operate in the unselected mode as well as the selected mode * so we must get the connection ourselves if it's not there. We are specifically * not calling checkOpen() since we don't care if the folder is open. */ ImapConnection connection = null; synchronized (this) { if (mConnection == null) { connection = getConnection(); } else { connection = mConnection; } } try { connection.executeSimpleCommand(String.format("CREATE %s", encodeString(encodeFolderName(getPrefixedName())))); return true; } catch (ImapException ie) { // We got a response, but it was not "OK" return false; } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } finally { if (mConnection == null) { releaseConnection(connection); } } } @Override public void copyMessages(Message[] messages, Folder folder) throws MessagingException { if (!(folder instanceof ImapFolder)) { throw new MessagingException("ImapFolder.copyMessages passed non-ImapFolder"); } if (messages.length == 0) return; ImapFolder iFolder = (ImapFolder)folder; checkOpen(); String[] uids = new String[messages.length]; for (int i = 0, count = messages.length; i < count; i++) { uids[i] = messages[i].getUid(); } try { String remoteDestName = encodeString(encodeFolderName(iFolder.getPrefixedName())); if (!exists(remoteDestName)) { /* * If the remote trash folder doesn't exist we try to create it. */ if (K9.DEBUG) Log.i(K9.LOG_TAG, "IMAPMessage.copyMessages: attempting to create remote '" + remoteDestName + "' folder for " + getLogId()); iFolder.create(FolderType.HOLDS_MESSAGES); } if (exists(remoteDestName)) { executeSimpleCommand(String.format("UID COPY %s %s", Utility.combine(uids, ','), remoteDestName)); } else { throw new MessagingException("IMAPMessage.copyMessages: remote destination folder " + folder.getName() + " does not exist and could not be created for " + getLogId() , true); } } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } } @Override public void moveMessages(Message[] messages, Folder folder) throws MessagingException { if (messages.length == 0) return; copyMessages(messages, folder); setFlags(messages, new Flag[] { Flag.DELETED }, true); } @Override public void delete(Message[] messages, String trashFolderName) throws MessagingException { if (messages.length == 0) return; if (trashFolderName == null || getName().equalsIgnoreCase(trashFolderName)) { setFlags(messages, new Flag[] { Flag.DELETED }, true); } else { ImapFolder remoteTrashFolder = (ImapFolder)getStore().getFolder(trashFolderName); String remoteTrashName = encodeString(encodeFolderName(remoteTrashFolder.getPrefixedName())); if (!exists(remoteTrashName)) { /* * If the remote trash folder doesn't exist we try to create it. */ if (K9.DEBUG) Log.i(K9.LOG_TAG, "IMAPMessage.delete: attempting to create remote '" + trashFolderName + "' folder for " + getLogId()); remoteTrashFolder.create(FolderType.HOLDS_MESSAGES); } if (exists(remoteTrashName)) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "IMAPMessage.delete: copying remote " + messages.length + " messages to '" + trashFolderName + "' for " + getLogId()); moveMessages(messages, remoteTrashFolder); } else { throw new MessagingException("IMAPMessage.delete: remote Trash folder " + trashFolderName + " does not exist and could not be created for " + getLogId() , true); } } } @Override public int getMessageCount() { return mMessageCount; } private int getRemoteMessageCount(String criteria) throws MessagingException { checkOpen(); try { int count = 0; int start = 1; List responses = executeSimpleCommand(String.format("SEARCH %d:* %s", start, criteria)); for (ImapResponse response : responses) { if (ImapResponseParser.equalsIgnoreCase(response.get(0), "SEARCH")) { count += response.size() - 1; } } return count; } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } } @Override public int getUnreadMessageCount() throws MessagingException { return getRemoteMessageCount("UNSEEN NOT DELETED"); } @Override public int getFlaggedMessageCount() throws MessagingException { return getRemoteMessageCount("FLAGGED NOT DELETED"); } protected int getHighestUid() { try { ImapSearcher searcher = new ImapSearcher() { public List search() throws IOException, MessagingException { return executeSimpleCommand("UID SEARCH *:*"); } }; Message[] messages = search(searcher, null); if (messages.length > 0) { return Integer.parseInt(messages[0].getUid()); } } catch (Exception e) { Log.e(K9.LOG_TAG, "Unable to find highest UID in folder " + getName(), e); } return -1; } @Override public void delete(boolean recurse) throws MessagingException { throw new Error("ImapStore.delete() not yet implemented"); } @Override public Message getMessage(String uid) throws MessagingException { return new ImapMessage(uid, this); } @Override public Message[] getMessages(int start, int end, Date earliestDate, MessageRetrievalListener listener) throws MessagingException { return getMessages(start, end, earliestDate, false, listener); } protected Message[] getMessages(final int start, final int end, Date earliestDate, final boolean includeDeleted, final MessageRetrievalListener listener) throws MessagingException { if (start < 1 || end < 1 || end < start) { throw new MessagingException( String.format("Invalid message set %d %d", start, end)); } final StringBuilder dateSearchString = new StringBuilder(); if (earliestDate != null) { dateSearchString.append(" SINCE "); synchronized (RFC3501_DATE) { dateSearchString.append(RFC3501_DATE.format(earliestDate)); } } ImapSearcher searcher = new ImapSearcher() { public List search() throws IOException, MessagingException { return executeSimpleCommand(String.format("UID SEARCH %d:%d%s%s", start, end, dateSearchString, includeDeleted ? "" : " NOT DELETED")); } }; return search(searcher, listener); } protected Message[] getMessages(final List mesgSeqs, final boolean includeDeleted, final MessageRetrievalListener listener) throws MessagingException { ImapSearcher searcher = new ImapSearcher() { public List search() throws IOException, MessagingException { return executeSimpleCommand(String.format("UID SEARCH %s%s", Utility.combine(mesgSeqs.toArray(), ','), includeDeleted ? "" : " NOT DELETED")); } }; return search(searcher, listener); } protected Message[] getMessagesFromUids(final List mesgUids, final boolean includeDeleted, final MessageRetrievalListener listener) throws MessagingException { ImapSearcher searcher = new ImapSearcher() { public List search() throws IOException, MessagingException { return executeSimpleCommand(String.format("UID SEARCH UID %s%s", Utility.combine(mesgUids.toArray(), ','), includeDeleted ? "" : " NOT DELETED")); } }; return search(searcher, listener); } private Message[] search(ImapSearcher searcher, MessageRetrievalListener listener) throws MessagingException { checkOpen(); ArrayList messages = new ArrayList(); try { ArrayList uids = new ArrayList(); List responses = searcher.search(); // for (ImapResponse response : responses) { if (response.mTag == null) { if (ImapResponseParser.equalsIgnoreCase(response.get(0), "SEARCH")) { for (int i = 1, count = response.size(); i < count; i++) { uids.add(Integer.parseInt(response.getString(i))); } } } } // Sort the uids in numerically ascending order Collections.sort(uids); for (int i = 0, count = uids.size(); i < count; i++) { if (listener != null) { listener.messageStarted("" + uids.get(i), i, count); } ImapMessage message = new ImapMessage("" + uids.get(i), this); messages.add(message); if (listener != null) { listener.messageFinished(message, i, count); } } } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } return messages.toArray(EMPTY_MESSAGE_ARRAY); } @Override public Message[] getMessages(MessageRetrievalListener listener) throws MessagingException { return getMessages(null, listener); } @Override public Message[] getMessages(String[] uids, MessageRetrievalListener listener) throws MessagingException { checkOpen(); ArrayList messages = new ArrayList(); try { if (uids == null) { List responses = executeSimpleCommand("UID SEARCH 1:* NOT DELETED"); ArrayList tempUids = new ArrayList(); for (ImapResponse response : responses) { if (ImapResponseParser.equalsIgnoreCase(response.get(0), "SEARCH")) { for (int i = 1, count = response.size(); i < count; i++) { tempUids.add(response.getString(i)); } } } uids = tempUids.toArray(EMPTY_STRING_ARRAY); } for (int i = 0, count = uids.length; i < count; i++) { if (listener != null) { listener.messageStarted(uids[i], i, count); } ImapMessage message = new ImapMessage(uids[i], this); messages.add(message); if (listener != null) { listener.messageFinished(message, i, count); } } } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } return messages.toArray(EMPTY_MESSAGE_ARRAY); } @Override public void fetch(Message[] messages, FetchProfile fp, MessageRetrievalListener listener) throws MessagingException { if (messages == null || messages.length == 0) { return; } checkOpen(); List uids = new ArrayList(messages.length); HashMap messageMap = new HashMap(); for (int i = 0, count = messages.length; i < count; i++) { String uid = messages[i].getUid(); uids.add(uid); messageMap.put(uid, messages[i]); } /* * Figure out what command we are going to run: * Flags - UID FETCH (FLAGS) * Envelope - UID FETCH ([FLAGS] INTERNALDATE UID RFC822.SIZE FLAGS BODY.PEEK[HEADER.FIELDS (date subject from content-type to cc)]) * */ LinkedHashSet fetchFields = new LinkedHashSet(); fetchFields.add("UID"); if (fp.contains(FetchProfile.Item.FLAGS)) { fetchFields.add("FLAGS"); } if (fp.contains(FetchProfile.Item.ENVELOPE)) { fetchFields.add("INTERNALDATE"); fetchFields.add("RFC822.SIZE"); fetchFields.add("BODY.PEEK[HEADER.FIELDS (date subject from content-type to cc " + "reply-to message-id " + K9.IDENTITY_HEADER + ")]"); } if (fp.contains(FetchProfile.Item.STRUCTURE)) { fetchFields.add("BODYSTRUCTURE"); } if (fp.contains(FetchProfile.Item.BODY_SANE)) { // If the user wants to download unlimited-size messages, don't go only for the truncated body if (mAccount.getMaximumAutoDownloadMessageSize() > 0) { fetchFields.add(String.format("BODY.PEEK[]<0.%d>", mAccount.getMaximumAutoDownloadMessageSize())); } else { fetchFields.add("BODY.PEEK[]"); } } if (fp.contains(FetchProfile.Item.BODY)) { fetchFields.add("BODY.PEEK[]"); } for (int windowStart = 0; windowStart < messages.length; windowStart += (FETCH_WINDOW_SIZE)) { List uidWindow = uids.subList(windowStart, Math.min((windowStart + FETCH_WINDOW_SIZE), messages.length)); try { mConnection.sendCommand(String.format("UID FETCH %s (%s)", Utility.combine(uidWindow.toArray(new String[uidWindow.size()]), ','), Utility.combine(fetchFields.toArray(new String[fetchFields.size()]), ' ') ), false); ImapResponse response; int messageNumber = 0; ImapResponseParser.IImapResponseCallback callback = null; if (fp.contains(FetchProfile.Item.BODY) || fp.contains(FetchProfile.Item.BODY_SANE)) { callback = new FetchBodyCallback(messageMap); } do { response = mConnection.readResponse(callback); if (response.mTag == null && ImapResponseParser.equalsIgnoreCase(response.get(1), "FETCH")) { ImapList fetchList = (ImapList)response.getKeyedValue("FETCH"); String uid = fetchList.getKeyedString("UID"); int msgSeq = response.getNumber(0); if (uid != null) { try { msgSeqUidMap.put(msgSeq, uid); if (K9.DEBUG) { Log.v(K9.LOG_TAG, "Stored uid '" + uid + "' for msgSeq " + msgSeq + " into map " /*+ msgSeqUidMap.toString() */); } } catch (Exception e) { Log.e(K9.LOG_TAG, "Unable to store uid '" + uid + "' for msgSeq " + msgSeq); } } Message message = messageMap.get(uid); if (message == null) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Do not have message in messageMap for UID " + uid + " for " + getLogId()); handleUntaggedResponse(response); continue; } if (listener != null) { listener.messageStarted(uid, messageNumber++, messageMap.size()); } ImapMessage imapMessage = (ImapMessage) message; Object literal = handleFetchResponse(imapMessage, fetchList); if (literal != null) { if (literal instanceof String) { String bodyString = (String)literal; InputStream bodyStream = new ByteArrayInputStream(bodyString.getBytes()); imapMessage.parse(bodyStream); } else if (literal instanceof Integer) { // All the work was done in FetchBodyCallback.foundLiteral() } else { // This shouldn't happen throw new MessagingException("Got FETCH response with bogus parameters"); } } if (listener != null) { listener.messageFinished(message, messageNumber, messageMap.size()); } } else { handleUntaggedResponse(response); } } while (response.mTag == null); } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } } } @Override public void fetchPart(Message message, Part part, MessageRetrievalListener listener) throws MessagingException { checkOpen(); String[] parts = part.getHeader(MimeHeader.HEADER_ANDROID_ATTACHMENT_STORE_DATA); if (parts == null) { return; } String fetch; String partId = parts[0]; if ("TEXT".equalsIgnoreCase(partId)) { fetch = String.format("BODY.PEEK[TEXT]<0.%d>", mAccount.getMaximumAutoDownloadMessageSize()); } else { fetch = String.format("BODY.PEEK[%s]", partId); } try { mConnection.sendCommand( String.format("UID FETCH %s (UID %s)", message.getUid(), fetch), false); ImapResponse response; int messageNumber = 0; ImapResponseParser.IImapResponseCallback callback = new FetchPartCallback(part); do { response = mConnection.readResponse(callback); if ((response.mTag == null) && (ImapResponseParser.equalsIgnoreCase(response.get(1), "FETCH"))) { ImapList fetchList = (ImapList)response.getKeyedValue("FETCH"); String uid = fetchList.getKeyedString("UID"); if (!message.getUid().equals(uid)) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Did not ask for UID " + uid + " for " + getLogId()); handleUntaggedResponse(response); continue; } if (listener != null) { listener.messageStarted(uid, messageNumber++, 1); } ImapMessage imapMessage = (ImapMessage) message; Object literal = handleFetchResponse(imapMessage, fetchList); if (literal != null) { if (literal instanceof Body) { // Most of the work was done in FetchAttchmentCallback.foundLiteral() part.setBody((Body)literal); } else if (literal instanceof String) { String bodyString = (String)literal; InputStream bodyStream = new ByteArrayInputStream(bodyString.getBytes()); String contentTransferEncoding = part.getHeader( MimeHeader.HEADER_CONTENT_TRANSFER_ENCODING)[0]; part.setBody(MimeUtility.decodeBody(bodyStream, contentTransferEncoding)); } else { // This shouldn't happen throw new MessagingException("Got FETCH response with bogus parameters"); } } if (listener != null) { listener.messageFinished(message, messageNumber, 1); } } else { handleUntaggedResponse(response); } } while (response.mTag == null); } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } } // Returns value of body field private Object handleFetchResponse(ImapMessage message, ImapList fetchList) throws MessagingException { Object result = null; if (fetchList.containsKey("FLAGS")) { ImapList flags = fetchList.getKeyedList("FLAGS"); if (flags != null) { for (int i = 0, count = flags.size(); i < count; i++) { String flag = flags.getString(i); if (flag.equalsIgnoreCase("\\Deleted")) { message.setFlagInternal(Flag.DELETED, true); } else if (flag.equalsIgnoreCase("\\Answered")) { message.setFlagInternal(Flag.ANSWERED, true); } else if (flag.equalsIgnoreCase("\\Seen")) { message.setFlagInternal(Flag.SEEN, true); } else if (flag.equalsIgnoreCase("\\Flagged")) { message.setFlagInternal(Flag.FLAGGED, true); } } } } if (fetchList.containsKey("INTERNALDATE")) { Date internalDate = fetchList.getKeyedDate("INTERNALDATE"); message.setInternalDate(internalDate); } if (fetchList.containsKey("RFC822.SIZE")) { int size = fetchList.getKeyedNumber("RFC822.SIZE"); message.setSize(size); } if (fetchList.containsKey("BODYSTRUCTURE")) { ImapList bs = fetchList.getKeyedList("BODYSTRUCTURE"); if (bs != null) { try { parseBodyStructure(bs, message, "TEXT"); } catch (MessagingException e) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Error handling message for " + getLogId(), e); message.setBody(null); } } } if (fetchList.containsKey("BODY")) { int index = fetchList.getKeyIndex("BODY") + 2; result = fetchList.getObject(index); // Check if there's an origin octet if (result instanceof String) { String originOctet = (String)result; if (originOctet.startsWith("<")) { result = fetchList.getObject(index + 1); } } } return result; } @Override public Flag[] getPermanentFlags() { return PERMANENT_FLAGS; } /** * Handle any untagged responses that the caller doesn't care to handle themselves. * @param responses */ protected List handleUntaggedResponses(List responses) { for (ImapResponse response : responses) { handleUntaggedResponse(response); } return responses; } protected void handlePossibleUidNext(ImapResponse response) { if (ImapResponseParser.equalsIgnoreCase(response.get(0), "OK") && response.size() > 1) { Object bracketedObj = response.get(1); if (bracketedObj instanceof ImapList) { ImapList bracketed = (ImapList)bracketedObj; if (bracketed.size() > 1) { Object keyObj = bracketed.get(0); if (keyObj instanceof String) { String key = (String)keyObj; if ("UIDNEXT".equalsIgnoreCase(key)) { uidNext = bracketed.getNumber(1); if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got UidNext = " + uidNext + " for " + getLogId()); } } } } } } /** * Handle an untagged response that the caller doesn't care to handle themselves. * @param response */ protected void handleUntaggedResponse(ImapResponse response) { if (response.mTag == null && response.size() > 1) { if (ImapResponseParser.equalsIgnoreCase(response.get(1), "EXISTS")) { mMessageCount = response.getNumber(0); if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got untagged EXISTS with value " + mMessageCount + " for " + getLogId()); } handlePossibleUidNext(response); if (ImapResponseParser.equalsIgnoreCase(response.get(1), "EXPUNGE") && mMessageCount > 0) { mMessageCount--; if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got untagged EXPUNGE with mMessageCount " + mMessageCount + " for " + getLogId()); } // if (response.size() > 1) { // Object bracketedObj = response.get(1); // if (bracketedObj instanceof ImapList) // { // ImapList bracketed = (ImapList)bracketedObj; // // if (!bracketed.isEmpty()) // { // Object keyObj = bracketed.get(0); // if (keyObj instanceof String) // { // String key = (String)keyObj; // if ("ALERT".equalsIgnoreCase(key)) // { // StringBuilder sb = new StringBuilder(); // for (int i = 2, count = response.size(); i < count; i++) { // sb.append(response.get(i).toString()); // sb.append(' '); // } // // Log.w(K9.LOG_TAG, "ALERT: " + sb.toString() + " for " + getLogId()); // } // } // } // // // } // } } //Log.i(K9.LOG_TAG, "mMessageCount = " + mMessageCount + " for " + getLogId()); } private void parseBodyStructure(ImapList bs, Part part, String id) throws MessagingException { if (bs.get(0) instanceof ImapList) { /* * This is a multipart/* */ MimeMultipart mp = new MimeMultipart(); for (int i = 0, count = bs.size(); i < count; i++) { if (bs.get(i) instanceof ImapList) { /* * For each part in the message we're going to add a new BodyPart and parse * into it. */ ImapBodyPart bp = new ImapBodyPart(); if (id.equalsIgnoreCase("TEXT")) { parseBodyStructure(bs.getList(i), bp, Integer.toString(i + 1)); } else { parseBodyStructure(bs.getList(i), bp, id + "." + (i + 1)); } mp.addBodyPart(bp); } else { /* * We've got to the end of the children of the part, so now we can find out * what type it is and bail out. */ String subType = bs.getString(i); mp.setSubType(subType.toLowerCase(Locale.US)); break; } } part.setBody(mp); } else { /* * This is a body. We need to add as much information as we can find out about * it to the Part. */ /* * 0| 0 body type * 1| 1 body subtype * 2| 2 body parameter parenthesized list * 3| 3 body id (unused) * 4| 4 body description (unused) * 5| 5 body encoding * 6| 6 body size * -| 7 text lines (only for type TEXT, unused) * Extensions (optional): * 7| 8 body MD5 (unused) * 8| 9 body disposition * 9|10 body language (unused) * 10|11 body location (unused) */ String type = bs.getString(0); String subType = bs.getString(1); String mimeType = (type + "/" + subType).toLowerCase(Locale.US); ImapList bodyParams = null; if (bs.get(2) instanceof ImapList) { bodyParams = bs.getList(2); } String encoding = bs.getString(5); int size = bs.getNumber(6); if (MimeUtility.mimeTypeMatches(mimeType, "message/rfc822")) { // A body type of type MESSAGE and subtype RFC822 // contains, immediately after the basic fields, the // envelope structure, body structure, and size in // text lines of the encapsulated message. // [MESSAGE, RFC822, [NAME, Fwd: [#HTR-517941]: update plans at 1am Friday - Memory allocation - displayware.eml], NIL, NIL, 7BIT, 5974, NIL, [INLINE, [FILENAME*0, Fwd: [#HTR-517941]: update plans at 1am Friday - Memory all, FILENAME*1, ocation - displayware.eml]], NIL] /* * This will be caught by fetch and handled appropriately. */ throw new MessagingException("BODYSTRUCTURE message/rfc822 not yet supported."); } /* * Set the content type with as much information as we know right now. */ StringBuilder contentType = new StringBuilder(); contentType.append(mimeType); if (bodyParams != null) { /* * If there are body params we might be able to get some more information out * of them. */ for (int i = 0, count = bodyParams.size(); i < count; i += 2) { contentType.append(String.format(";\n %s=\"%s\"", bodyParams.getString(i), bodyParams.getString(i + 1))); } } part.setHeader(MimeHeader.HEADER_CONTENT_TYPE, contentType.toString()); // Extension items ImapList bodyDisposition = null; if (("text".equalsIgnoreCase(type)) && (bs.size() > 9) && (bs.get(9) instanceof ImapList)) { bodyDisposition = bs.getList(9); } else if (!("text".equalsIgnoreCase(type)) && (bs.size() > 8) && (bs.get(8) instanceof ImapList)) { bodyDisposition = bs.getList(8); } StringBuilder contentDisposition = new StringBuilder(); if (bodyDisposition != null && !bodyDisposition.isEmpty()) { if (!"NIL".equalsIgnoreCase(bodyDisposition.getString(0))) { contentDisposition.append(bodyDisposition.getString(0).toLowerCase(Locale.US)); } if ((bodyDisposition.size() > 1) && (bodyDisposition.get(1) instanceof ImapList)) { ImapList bodyDispositionParams = bodyDisposition.getList(1); /* * If there is body disposition information we can pull some more information * about the attachment out. */ for (int i = 0, count = bodyDispositionParams.size(); i < count; i += 2) { contentDisposition.append(String.format(";\n %s=\"%s\"", bodyDispositionParams.getString(i).toLowerCase(Locale.US), bodyDispositionParams.getString(i + 1))); } } } if (MimeUtility.getHeaderParameter(contentDisposition.toString(), "size") == null) { contentDisposition.append(String.format(";\n size=%d", size)); } /* * Set the content disposition containing at least the size. Attachment * handling code will use this down the road. */ part.setHeader(MimeHeader.HEADER_CONTENT_DISPOSITION, contentDisposition.toString()); /* * Set the Content-Transfer-Encoding header. Attachment code will use this * to parse the body. */ part.setHeader(MimeHeader.HEADER_CONTENT_TRANSFER_ENCODING, encoding); if (part instanceof ImapMessage) { ((ImapMessage) part).setSize(size); } else if (part instanceof ImapBodyPart) { ((ImapBodyPart) part).setSize(size); } else { throw new MessagingException("Unknown part type " + part.toString()); } part.setHeader(MimeHeader.HEADER_ANDROID_ATTACHMENT_STORE_DATA, id); } } /** * Appends the given messages to the selected folder. This implementation also determines * the new UID of the given message on the IMAP server and sets the Message's UID to the * new server UID. */ @Override public void appendMessages(Message[] messages) throws MessagingException { checkOpen(); try { for (Message message : messages) { mConnection.sendCommand( String.format("APPEND %s (%s) {%d}", encodeString(encodeFolderName(getPrefixedName())), combineFlags(message.getFlags()), message.calculateSize()), false); ImapResponse response; do { response = mConnection.readResponse(); handleUntaggedResponse(response); if (response.mCommandContinuationRequested) { EOLConvertingOutputStream eolOut = new EOLConvertingOutputStream(mConnection.mOut); message.writeTo(eolOut); eolOut.write('\r'); eolOut.write('\n'); eolOut.flush(); } } while (response.mTag == null); String newUid = getUidFromMessageId(message); if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got UID " + newUid + " for message for " + getLogId()); if (newUid != null) { message.setUid(newUid); } } } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } } @Override public String getUidFromMessageId(Message message) throws MessagingException { try { /* * Try to find the UID of the message we just appended using the * Message-ID header. */ String[] messageIdHeader = message.getHeader("Message-ID"); if (messageIdHeader == null || messageIdHeader.length == 0) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Did not get a message-id in order to search for UID for " + getLogId()); return null; } String messageId = messageIdHeader[0]; if (K9.DEBUG) Log.d(K9.LOG_TAG, "Looking for UID for message with message-id " + messageId + " for " + getLogId()); List responses = executeSimpleCommand( String.format("UID SEARCH HEADER MESSAGE-ID %s", messageId)); for (ImapResponse response1 : responses) { if (response1.mTag == null && ImapResponseParser.equalsIgnoreCase(response1.get(0), "SEARCH") && response1.size() > 1) { return response1.getString(1); } } return null; } catch (IOException ioe) { throw new MessagingException("Could not find UID for message based on Message-ID", ioe); } } @Override public void expunge() throws MessagingException { checkOpen(); try { executeSimpleCommand("EXPUNGE"); } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } } private String combineFlags(Flag[] flags) { ArrayList flagNames = new ArrayList(); for (Flag flag : flags) { if (flag == Flag.SEEN) { flagNames.add("\\Seen"); } else if (flag == Flag.DELETED) { flagNames.add("\\Deleted"); } else if (flag == Flag.ANSWERED) { flagNames.add("\\Answered"); } else if (flag == Flag.FLAGGED) { flagNames.add("\\Flagged"); } } return Utility.combine(flagNames.toArray(new String[flagNames.size()]), ' '); } @Override public void setFlags(Flag[] flags, boolean value) throws MessagingException { checkOpen(); try { executeSimpleCommand(String.format("UID STORE 1:* %sFLAGS.SILENT (%s)", value ? "+" : "-", combineFlags(flags))); } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } } @Override public String getNewPushState(String oldPushStateS, Message message) { try { String messageUidS = message.getUid(); int messageUid = Integer.parseInt(messageUidS); ImapPushState oldPushState = ImapPushState.parse(oldPushStateS); if (messageUid >= oldPushState.uidNext) { int uidNext = messageUid + 1; ImapPushState newPushState = new ImapPushState(uidNext); return newPushState.toString(); } else { return null; } } catch (Exception e) { Log.e(K9.LOG_TAG, "Exception while updated push state for " + getLogId(), e); return null; } } @Override public void setFlags(Message[] messages, Flag[] flags, boolean value) throws MessagingException { checkOpen(); String[] uids = new String[messages.length]; for (int i = 0, count = messages.length; i < count; i++) { uids[i] = messages[i].getUid(); } try { executeSimpleCommand(String.format("UID STORE %s %sFLAGS.SILENT (%s)", Utility.combine(uids, ','), value ? "+" : "-", combineFlags(flags))); } catch (IOException ioe) { throw ioExceptionHandler(mConnection, ioe); } } private void checkOpen() throws MessagingException { if (!isOpen()) { throw new MessagingException("Folder " + getPrefixedName() + " is not open."); } } private MessagingException ioExceptionHandler(ImapConnection connection, IOException ioe) { Log.e(K9.LOG_TAG, "IOException for " + getLogId(), ioe); if (connection != null) { connection.close(); } close(); return new MessagingException("IO Error", ioe); } @Override public boolean equals(Object o) { if (o instanceof ImapFolder) { return ((ImapFolder)o).getName().equalsIgnoreCase(getName()); } return super.equals(o); } @Override public int hashCode() { return getName().hashCode(); } protected ImapStore getStore() { return store; } protected String getLogId() { String id = getAccount().getDescription() + ":" + getName() + "/" + Thread.currentThread().getName(); if (mConnection != null) { id += "/" + mConnection.getLogId(); } return id; } } /** * A cacheable class that stores the details for a single IMAP connection. */ public static class ImapConnection { protected Socket mSocket; protected PeekableInputStream mIn; protected OutputStream mOut; protected ImapResponseParser mParser; protected int mNextCommandTag; protected Set capabilities = new HashSet(); private ImapSettings mSettings; public ImapConnection(final ImapSettings settings) { this.mSettings = settings; } protected String getLogId() { return "conn" + hashCode(); } private List receiveCapabilities(List responses) { for (ImapResponse response : responses) { ImapList capabilityList = null; if (!response.isEmpty() && ImapResponseParser.equalsIgnoreCase(response.get(0), "OK")) { for (Object thisPart : response) { if (thisPart instanceof ImapList) { ImapList thisList = (ImapList)thisPart; if (ImapResponseParser.equalsIgnoreCase(thisList.get(0), CAPABILITY_CAPABILITY)) { capabilityList = thisList; break; } } } } else if (response.mTag == null) { capabilityList = response; } if (capabilityList != null) { if (!capabilityList.isEmpty() && ImapResponseParser.equalsIgnoreCase(capabilityList.get(0), CAPABILITY_CAPABILITY)) { if (K9.DEBUG) { Log.d(K9.LOG_TAG, "Saving " + capabilityList.size() + " capabilities for " + getLogId()); } for (Object capability : capabilityList) { if (capability instanceof String) { // if (K9.DEBUG) // { // Log.v(K9.LOG_TAG, "Saving capability '" + capability + "' for " + getLogId()); // } capabilities.add(((String)capability).toUpperCase(Locale.US)); } } } } } return responses; } public void open() throws IOException, MessagingException { if (isOpen()) { return; } boolean authSuccess = false; mNextCommandTag = 1; try { Security.setProperty("networkaddress.cache.ttl", "0"); } catch (Exception e) { Log.w(K9.LOG_TAG, "Could not set DNS ttl to 0 for " + getLogId(), e); } try { Security.setProperty("networkaddress.cache.negative.ttl", "0"); } catch (Exception e) { Log.w(K9.LOG_TAG, "Could not set DNS negative ttl to 0 for " + getLogId(), e); } try { int connectionSecurity = mSettings.getConnectionSecurity(); // Try all IPv4 and IPv6 addresses of the host InetAddress[] addresses = InetAddress.getAllByName(mSettings.getHost()); for (int i = 0; i < addresses.length; i++) { try { if (K9.DEBUG && K9.DEBUG_PROTOCOL_IMAP) { Log.d(K9.LOG_TAG, "Connecting to " + mSettings.getHost() + " as " + addresses[i]); } SocketAddress socketAddress = new InetSocketAddress(addresses[i], mSettings.getPort()); if (connectionSecurity == CONNECTION_SECURITY_SSL_REQUIRED || connectionSecurity == CONNECTION_SECURITY_SSL_OPTIONAL) { SSLContext sslContext = SSLContext.getInstance("TLS"); boolean secure = connectionSecurity == CONNECTION_SECURITY_SSL_REQUIRED; sslContext.init(null, new TrustManager[] { TrustManagerFactory.get(mSettings.getHost(), secure) }, new SecureRandom()); mSocket = sslContext.getSocketFactory().createSocket(); } else { mSocket = new Socket(); } mSocket.connect(socketAddress, SOCKET_CONNECT_TIMEOUT); // Successfully connected to the server; don't try any other addresses break; } catch (SocketException e) { if (i < (addresses.length - 1)) { // There are still other addresses for that host to try continue; } throw new MessagingException("Cannot connect to host", e); } } setReadTimeout(Store.SOCKET_READ_TIMEOUT); mIn = new PeekableInputStream(new BufferedInputStream(mSocket.getInputStream(), 1024)); mParser = new ImapResponseParser(mIn); mOut = mSocket.getOutputStream(); capabilities.clear(); ImapResponse nullResponse = mParser.readResponse(); if (K9.DEBUG && K9.DEBUG_PROTOCOL_IMAP) Log.v(K9.LOG_TAG, getLogId() + "<<<" + nullResponse); List nullResponses = new LinkedList(); nullResponses.add(nullResponse); receiveCapabilities(nullResponses); if (!hasCapability(CAPABILITY_CAPABILITY)) { if (K9.DEBUG) Log.i(K9.LOG_TAG, "Did not get capabilities in banner, requesting CAPABILITY for " + getLogId()); List responses = receiveCapabilities(executeSimpleCommand(COMMAND_CAPABILITY)); if (responses.size() != 2) { throw new MessagingException("Invalid CAPABILITY response received"); } } if (mSettings.getConnectionSecurity() == CONNECTION_SECURITY_TLS_OPTIONAL || mSettings.getConnectionSecurity() == CONNECTION_SECURITY_TLS_REQUIRED) { if (hasCapability("STARTTLS")) { // STARTTLS executeSimpleCommand("STARTTLS"); SSLContext sslContext = SSLContext.getInstance("TLS"); boolean secure = mSettings.getConnectionSecurity() == CONNECTION_SECURITY_TLS_REQUIRED; sslContext.init(null, new TrustManager[] { TrustManagerFactory.get(mSettings.getHost(), secure) }, new SecureRandom()); mSocket = sslContext.getSocketFactory().createSocket(mSocket, mSettings.getHost(), mSettings.getPort(), true); mSocket.setSoTimeout(Store.SOCKET_READ_TIMEOUT); mIn = new PeekableInputStream(new BufferedInputStream(mSocket .getInputStream(), 1024)); mParser = new ImapResponseParser(mIn); mOut = mSocket.getOutputStream(); } else if (mSettings.getConnectionSecurity() == CONNECTION_SECURITY_TLS_REQUIRED) { throw new MessagingException("TLS not supported but required"); } } mOut = new BufferedOutputStream(mOut, 1024); try { // Yahoo! requires a custom IMAP command to work right over a non-3G network if (mSettings.getHost().endsWith("yahoo.com")) { if (K9.DEBUG) Log.v(K9.LOG_TAG, "Found Yahoo! account. Sending proprietary commands."); executeSimpleCommand("ID (\"GUID\" \"1\")"); } if (mSettings.getAuthType() == AuthType.CRAM_MD5) { authCramMD5(); // The authCramMD5 method called on the previous line does not allow for handling updated capabilities // sent by the server. So, to make sure we update to the post-authentication capability list // we fetch the capabilities here. if (K9.DEBUG) Log.i(K9.LOG_TAG, "Updating capabilities after CRAM-MD5 authentication for " + getLogId()); List responses = receiveCapabilities(executeSimpleCommand(COMMAND_CAPABILITY)); if (responses.size() != 2) { throw new MessagingException("Invalid CAPABILITY response received"); } } else if (mSettings.getAuthType() == AuthType.PLAIN) { receiveCapabilities(executeSimpleCommand(String.format("LOGIN %s %s", ImapStore.encodeString(mSettings.getUsername()), ImapStore.encodeString(mSettings.getPassword())), true)); } authSuccess = true; } catch (ImapException ie) { throw new AuthenticationFailedException(ie.getAlertText(), ie); } catch (MessagingException me) { throw new AuthenticationFailedException(null, me); } if (K9.DEBUG) { Log.d(K9.LOG_TAG, CAPABILITY_COMPRESS_DEFLATE + " = " + hasCapability(CAPABILITY_COMPRESS_DEFLATE)); } if (hasCapability(CAPABILITY_COMPRESS_DEFLATE)) { ConnectivityManager connectivityManager = (ConnectivityManager)K9.app.getSystemService(Context.CONNECTIVITY_SERVICE); boolean useCompression = true; NetworkInfo netInfo = connectivityManager.getActiveNetworkInfo(); if (netInfo != null) { int type = netInfo.getType(); if (K9.DEBUG) Log.d(K9.LOG_TAG, "On network type " + type); useCompression = mSettings.useCompression(type); } if (K9.DEBUG) Log.d(K9.LOG_TAG, "useCompression " + useCompression); if (useCompression) { try { executeSimpleCommand(COMMAND_COMPRESS_DEFLATE); Inflater inf = new Inflater(true); InflaterInputStream zInputStream = new InflaterInputStream(mSocket.getInputStream(), inf); mIn = new PeekableInputStream(new BufferedInputStream(zInputStream, 1024)); mParser = new ImapResponseParser(mIn); ZOutputStream zOutputStream = new ZOutputStream(mSocket.getOutputStream(), JZlib.Z_BEST_SPEED, true); mOut = new BufferedOutputStream(zOutputStream, 1024); zOutputStream.setFlushMode(JZlib.Z_PARTIAL_FLUSH); if (K9.DEBUG) { Log.i(K9.LOG_TAG, "Compression enabled for " + getLogId()); } } catch (Exception e) { Log.e(K9.LOG_TAG, "Unable to negotiate compression", e); } } } if (K9.DEBUG) Log.d(K9.LOG_TAG, "NAMESPACE = " + hasCapability(CAPABILITY_NAMESPACE) + ", mPathPrefix = " + mSettings.getPathPrefix()); if (mSettings.getPathPrefix() == null) { if (hasCapability(CAPABILITY_NAMESPACE)) { if (K9.DEBUG) Log.i(K9.LOG_TAG, "mPathPrefix is unset and server has NAMESPACE capability"); List namespaceResponses = executeSimpleCommand(COMMAND_NAMESPACE); for (ImapResponse response : namespaceResponses) { if (ImapResponseParser.equalsIgnoreCase(response.get(0), COMMAND_NAMESPACE)) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got NAMESPACE response " + response + " on " + getLogId()); Object personalNamespaces = response.get(1); if (personalNamespaces != null && personalNamespaces instanceof ImapList) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got personal namespaces: " + personalNamespaces); ImapList bracketed = (ImapList)personalNamespaces; Object firstNamespace = bracketed.get(0); if (firstNamespace != null && firstNamespace instanceof ImapList) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got first personal namespaces: " + firstNamespace); bracketed = (ImapList)firstNamespace; mSettings.setPathPrefix(bracketed.getString(0)); mSettings.setPathDelimeter(bracketed.getString(1)); mSettings.setCombinedPrefix(null); if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got path '" + mSettings.getPathPrefix() + "' and separator '" + mSettings.getPathDelimeter() + "'"); } } } } } else { if (K9.DEBUG) Log.i(K9.LOG_TAG, "mPathPrefix is unset but server does not have NAMESPACE capability"); mSettings.setPathPrefix(""); } } if (mSettings.getPathDelimeter() == null) { try { List nameResponses = executeSimpleCommand(String.format("LIST \"\" \"\"")); for (ImapResponse response : nameResponses) { if (ImapResponseParser.equalsIgnoreCase(response.get(0), "LIST")) { mSettings.setPathDelimeter(response.getString(2)); mSettings.setCombinedPrefix(null); if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got path delimeter '" + mSettings.getPathDelimeter() + "' for " + getLogId()); } } } catch (Exception e) { Log.e(K9.LOG_TAG, "Unable to get path delimeter using LIST", e); } } } catch (SSLException e) { throw new CertificateValidationException(e.getMessage(), e); } catch (GeneralSecurityException gse) { throw new MessagingException( "Unable to open connection to IMAP server due to security error.", gse); } catch (ConnectException ce) { String ceMess = ce.getMessage(); String[] tokens = ceMess.split("-"); if (tokens != null && tokens.length > 1 && tokens[1] != null) { Log.e(K9.LOG_TAG, "Stripping host/port from ConnectionException for " + getLogId(), ce); throw new ConnectException(tokens[1].trim()); } else { throw ce; } } finally { if (!authSuccess) { Log.e(K9.LOG_TAG, "Failed to login, closing connection for " + getLogId()); close(); } } } protected void authCramMD5() throws AuthenticationFailedException, MessagingException { try { String tag = sendCommand("AUTHENTICATE CRAM-MD5", false); byte[] buf = new byte[1024]; int b64NonceLen = 0; for (int i = 0; i < buf.length; i++) { buf[i] = (byte)mIn.read(); if (buf[i] == 0x0a) { b64NonceLen = i; break; } } if (b64NonceLen == 0) { throw new AuthenticationFailedException("Error negotiating CRAM-MD5: nonce too long."); } byte[] b64NonceTrim = new byte[b64NonceLen - 2]; System.arraycopy(buf, 1, b64NonceTrim, 0, b64NonceLen - 2); byte[] b64CRAM = Authentication.computeCramMd5Bytes(mSettings.getUsername(), mSettings.getPassword(), b64NonceTrim); mOut.write(b64CRAM); mOut.write(new byte[] { 0x0d, 0x0a }); mOut.flush(); int respLen = 0; for (int i = 0; i < buf.length; i++) { buf[i] = (byte)mIn.read(); if (buf[i] == 0x0a) { respLen = i; break; } } String toMatch = tag + " OK"; String respStr = new String(buf, 0, respLen); if (!respStr.startsWith(toMatch)) { throw new AuthenticationFailedException("CRAM-MD5 error: " + respStr); } } catch (IOException ioe) { throw new AuthenticationFailedException("CRAM-MD5 Auth Failed.", ioe); } } protected void setReadTimeout(int millis) throws SocketException { Socket sock = mSocket; if (sock != null) { sock.setSoTimeout(millis); } } protected boolean isIdleCapable() { if (K9.DEBUG) Log.v(K9.LOG_TAG, "Connection " + getLogId() + " has " + capabilities.size() + " capabilities"); return capabilities.contains(CAPABILITY_IDLE); } protected boolean hasCapability(String capability) { return capabilities.contains(capability.toUpperCase(Locale.US)); } public boolean isOpen() { return (mIn != null && mOut != null && mSocket != null && mSocket.isConnected() && !mSocket.isClosed()); } public void close() { // if (isOpen()) { // try { // executeSimpleCommand("LOGOUT"); // } catch (Exception e) { // // } // } IOUtils.closeQuietly(mIn); IOUtils.closeQuietly(mOut); IOUtils.closeQuietly(mSocket); mIn = null; mOut = null; mSocket = null; } public ImapResponse readResponse() throws IOException, MessagingException { return readResponse(null); } public ImapResponse readResponse(ImapResponseParser.IImapResponseCallback callback) throws IOException { try { ImapResponse response = mParser.readResponse(callback); if (K9.DEBUG && K9.DEBUG_PROTOCOL_IMAP) Log.v(K9.LOG_TAG, getLogId() + "<<<" + response); return response; } catch (IOException ioe) { close(); throw ioe; } } public void sendContinuation(String continuation) throws IOException { mOut.write(continuation.getBytes()); mOut.write('\r'); mOut.write('\n'); mOut.flush(); if (K9.DEBUG && K9.DEBUG_PROTOCOL_IMAP) Log.v(K9.LOG_TAG, getLogId() + ">>> " + continuation); } public String sendCommand(String command, boolean sensitive) throws MessagingException, IOException { try { open(); String tag = Integer.toString(mNextCommandTag++); String commandToSend = tag + " " + command; mOut.write(commandToSend.getBytes()); mOut.write('\r'); mOut.write('\n'); mOut.flush(); if (K9.DEBUG && K9.DEBUG_PROTOCOL_IMAP) { if (sensitive && !K9.DEBUG_SENSITIVE) { Log.v(K9.LOG_TAG, getLogId() + ">>> " + "[Command Hidden, Enable Sensitive Debug Logging To Show]"); } else { Log.v(K9.LOG_TAG, getLogId() + ">>> " + commandToSend); } } return tag; } catch (IOException ioe) { close(); throw ioe; } catch (ImapException ie) { close(); throw ie; } catch (MessagingException me) { close(); throw me; } } public List executeSimpleCommand(String command) throws IOException, ImapException, MessagingException { return executeSimpleCommand(command, false); } public List executeSimpleCommand(String command, boolean sensitive) throws IOException, ImapException, MessagingException { return executeSimpleCommand(command, sensitive, null); } public List executeSimpleCommand(String command, boolean sensitive, UntaggedHandler untaggedHandler) throws IOException, ImapException, MessagingException { String commandToLog = command; if (sensitive && !K9.DEBUG_SENSITIVE) { commandToLog = "*sensitive*"; } //if (K9.DEBUG) // Log.v(K9.LOG_TAG, "Sending IMAP command " + commandToLog + " on connection " + getLogId()); String tag = sendCommand(command, sensitive); //if (K9.DEBUG) // Log.v(K9.LOG_TAG, "Sent IMAP command " + commandToLog + " with tag " + tag + " for " + getLogId()); ArrayList responses = new ArrayList(); ImapResponse response; do { response = mParser.readResponse(); if (K9.DEBUG && K9.DEBUG_PROTOCOL_IMAP) Log.v(K9.LOG_TAG, getLogId() + "<<<" + response); if (response.mTag != null && !response.mTag.equalsIgnoreCase(tag)) { Log.w(K9.LOG_TAG, "After sending tag " + tag + ", got tag response from previous command " + response + " for " + getLogId()); Iterator iter = responses.iterator(); while (iter.hasNext()) { ImapResponse delResponse = iter.next(); if (delResponse.mTag != null || delResponse.size() < 2 || (!ImapResponseParser.equalsIgnoreCase(delResponse.get(1), "EXISTS") && !ImapResponseParser.equalsIgnoreCase(delResponse.get(1), "EXPUNGE"))) { iter.remove(); } } response.mTag = null; continue; } if (untaggedHandler != null) { untaggedHandler.handleAsyncUntaggedResponse(response); } responses.add(response); } while (response.mTag == null); if (response.size() < 1 || !ImapResponseParser.equalsIgnoreCase(response.get(0), "OK")) { throw new ImapException("Command: " + commandToLog + "; response: " + response.toString(), response.getAlertText()); } return responses; } } static class ImapMessage extends MimeMessage { ImapMessage(String uid, Folder folder) { this.mUid = uid; this.mFolder = folder; } public void setSize(int size) { this.mSize = size; } @Override public void parse(InputStream in) throws IOException, MessagingException { super.parse(in); } public void setFlagInternal(Flag flag, boolean set) throws MessagingException { super.setFlag(flag, set); } @Override public void setFlag(Flag flag, boolean set) throws MessagingException { super.setFlag(flag, set); mFolder.setFlags(new Message[] { this }, new Flag[] { flag }, set); } @Override public void delete(String trashFolderName) throws MessagingException { getFolder().delete(new Message[] { this }, trashFolderName); } } static class ImapBodyPart extends MimeBodyPart { public ImapBodyPart() throws MessagingException { super(); } public void setSize(int size) { this.mSize = size; } } static class ImapException extends MessagingException { private static final long serialVersionUID = 3725007182205882394L; String mAlertText; public ImapException(String message, String alertText, Throwable throwable) { super(message, throwable); this.mAlertText = alertText; } public ImapException(String message, String alertText) { super(message); this.mAlertText = alertText; } public String getAlertText() { return mAlertText; } public void setAlertText(String alertText) { mAlertText = alertText; } } public class ImapFolderPusher extends ImapFolder implements UntaggedHandler { final PushReceiver receiver; Thread listeningThread = null; final AtomicBoolean stop = new AtomicBoolean(false); final AtomicBoolean idling = new AtomicBoolean(false); final AtomicBoolean doneSent = new AtomicBoolean(false); final AtomicInteger delayTime = new AtomicInteger(NORMAL_DELAY_TIME); final AtomicInteger idleFailureCount = new AtomicInteger(0); final AtomicBoolean needsPoll = new AtomicBoolean(false); List storedUntaggedResponses = new ArrayList(); TracingWakeLock wakeLock = null; public ImapFolderPusher(ImapStore store, String name, PushReceiver nReceiver) { super(store, name); receiver = nReceiver; TracingPowerManager pm = TracingPowerManager.getPowerManager(receiver.getContext()); wakeLock = pm.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, "ImapFolderPusher " + store.getAccount().getDescription() + ":" + getName()); wakeLock.setReferenceCounted(false); } public void refresh() throws IOException, MessagingException { if (idling.get()) { wakeLock.acquire(K9.PUSH_WAKE_LOCK_TIMEOUT); sendDone(); } } private void sendDone() throws IOException, MessagingException { if (doneSent.compareAndSet(false, true)) { ImapConnection conn = mConnection; if (conn != null) { conn.setReadTimeout(Store.SOCKET_READ_TIMEOUT); sendContinuation("DONE"); } } } private void sendContinuation(String continuation) throws IOException { ImapConnection conn = mConnection; if (conn != null) { conn.sendContinuation(continuation); } } public void start() { Runnable runner = new Runnable() { public void run() { wakeLock.acquire(K9.PUSH_WAKE_LOCK_TIMEOUT); if (K9.DEBUG) Log.i(K9.LOG_TAG, "Pusher starting for " + getLogId()); while (!stop.get()) { try { int oldUidNext = -1; try { String pushStateS = receiver.getPushState(getName()); ImapPushState pushState = ImapPushState.parse(pushStateS); oldUidNext = pushState.uidNext; if (K9.DEBUG) Log.i(K9.LOG_TAG, "Got oldUidNext " + oldUidNext + " for " + getLogId()); } catch (Exception e) { Log.e(K9.LOG_TAG, "Unable to get oldUidNext for " + getLogId(), e); } ImapConnection oldConnection = mConnection; internalOpen(OpenMode.READ_ONLY); ImapConnection conn = mConnection; if (conn == null) { receiver.pushError("Could not establish connection for IDLE", null); throw new MessagingException("Could not establish connection for IDLE"); } if (!conn.isIdleCapable()) { stop.set(true); receiver.pushError("IMAP server is not IDLE capable: " + conn.toString(), null); throw new MessagingException("IMAP server is not IDLE capable:" + conn.toString()); } if (!stop.get() && mAccount.isPushPollOnConnect() && (conn != oldConnection || needsPoll.getAndSet(false))) { List untaggedResponses = new ArrayList(storedUntaggedResponses); storedUntaggedResponses.clear(); processUntaggedResponses(untaggedResponses); if (mMessageCount == -1) { throw new MessagingException("Message count = -1 for idling"); } receiver.syncFolder(ImapFolderPusher.this); } if (stop.get()) { continue; } int startUid = oldUidNext; int newUidNext = uidNext; if (newUidNext == -1) { if (K9.DEBUG) { Log.d(K9.LOG_TAG, "uidNext is -1, using search to find highest UID"); } int highestUid = getHighestUid(); if (highestUid != -1) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "highest UID = " + highestUid); newUidNext = highestUid + 1; if (K9.DEBUG) Log.d(K9.LOG_TAG, "highest UID = " + highestUid + ", set newUidNext to " + newUidNext); } } if (startUid < newUidNext - mAccount.getDisplayCount()) { startUid = newUidNext - mAccount.getDisplayCount(); } if (startUid < 1) { startUid = 1; } if (newUidNext > startUid) { if (K9.DEBUG) Log.i(K9.LOG_TAG, "Needs sync from uid " + startUid + " to " + newUidNext + " for " + getLogId()); List messages = new ArrayList(); for (int uid = startUid; uid < newUidNext; uid++) { ImapMessage message = new ImapMessage("" + uid, ImapFolderPusher.this); messages.add(message); } if (!messages.isEmpty()) { pushMessages(messages, true); } } else { List untaggedResponses = null; while (!storedUntaggedResponses.isEmpty()) { if (K9.DEBUG) Log.i(K9.LOG_TAG, "Processing " + storedUntaggedResponses.size() + " untagged responses from previous commands for " + getLogId()); untaggedResponses = new ArrayList(storedUntaggedResponses); storedUntaggedResponses.clear(); processUntaggedResponses(untaggedResponses); } if (K9.DEBUG) Log.i(K9.LOG_TAG, "About to IDLE for " + getLogId()); receiver.setPushActive(getName(), true); idling.set(true); doneSent.set(false); conn.setReadTimeout((getAccount().getIdleRefreshMinutes() * 60 * 1000) + IDLE_READ_TIMEOUT_INCREMENT); untaggedResponses = executeSimpleCommand(COMMAND_IDLE, false, ImapFolderPusher.this); idling.set(false); delayTime.set(NORMAL_DELAY_TIME); idleFailureCount.set(0); } } catch (Exception e) { wakeLock.acquire(K9.PUSH_WAKE_LOCK_TIMEOUT); storedUntaggedResponses.clear(); idling.set(false); receiver.setPushActive(getName(), false); try { close(); } catch (Exception me) { Log.e(K9.LOG_TAG, "Got exception while closing for exception for " + getLogId(), me); } if (stop.get()) { Log.i(K9.LOG_TAG, "Got exception while idling, but stop is set for " + getLogId()); } else { receiver.pushError("Push error for " + getName(), e); Log.e(K9.LOG_TAG, "Got exception while idling for " + getLogId(), e); int delayTimeInt = delayTime.get(); receiver.sleep(wakeLock, delayTimeInt); delayTimeInt *= 2; if (delayTimeInt > MAX_DELAY_TIME) { delayTimeInt = MAX_DELAY_TIME; } delayTime.set(delayTimeInt); if (idleFailureCount.incrementAndGet() > IDLE_FAILURE_COUNT_LIMIT) { Log.e(K9.LOG_TAG, "Disabling pusher for " + getLogId() + " after " + idleFailureCount.get() + " consecutive errors"); receiver.pushError("Push disabled for " + getName() + " after " + idleFailureCount.get() + " consecutive errors", e); stop.set(true); } } } } receiver.setPushActive(getName(), false); try { if (K9.DEBUG) Log.i(K9.LOG_TAG, "Pusher for " + getLogId() + " is exiting"); close(); } catch (Exception me) { Log.e(K9.LOG_TAG, "Got exception while closing for " + getLogId(), me); } finally { wakeLock.release(); } } }; listeningThread = new Thread(runner); listeningThread.start(); } @Override protected void handleUntaggedResponse(ImapResponse response) { if (response.mTag == null && response.size() > 1) { Object responseType = response.get(1); if (ImapResponseParser.equalsIgnoreCase(responseType, "FETCH") || ImapResponseParser.equalsIgnoreCase(responseType, "EXPUNGE") || ImapResponseParser.equalsIgnoreCase(responseType, "EXISTS")) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Storing response " + response + " for later processing"); storedUntaggedResponses.add(response); } handlePossibleUidNext(response); } } protected void processUntaggedResponses(List responses) throws MessagingException { boolean skipSync = false; int oldMessageCount = mMessageCount; if (oldMessageCount == -1) { skipSync = true; } List flagSyncMsgSeqs = new ArrayList(); List removeMsgUids = new LinkedList(); for (ImapResponse response : responses) { oldMessageCount += processUntaggedResponse(oldMessageCount, response, flagSyncMsgSeqs, removeMsgUids); } if (!skipSync) { if (oldMessageCount < 0) { oldMessageCount = 0; } if (mMessageCount > oldMessageCount) { syncMessages(mMessageCount, true); } } if (K9.DEBUG) Log.d(K9.LOG_TAG, "UIDs for messages needing flag sync are " + flagSyncMsgSeqs + " for " + getLogId()); if (!flagSyncMsgSeqs.isEmpty()) { syncMessages(flagSyncMsgSeqs); } if (!removeMsgUids.isEmpty()) { removeMessages(removeMsgUids); } } private void syncMessages(int end, boolean newArrivals) throws MessagingException { int oldUidNext = -1; try { String pushStateS = receiver.getPushState(getName()); ImapPushState pushState = ImapPushState.parse(pushStateS); oldUidNext = pushState.uidNext; if (K9.DEBUG) Log.i(K9.LOG_TAG, "Got oldUidNext " + oldUidNext + " for " + getLogId()); } catch (Exception e) { Log.e(K9.LOG_TAG, "Unable to get oldUidNext for " + getLogId(), e); } Message[] messageArray = getMessages(end, end, null, true, null); if (messageArray != null && messageArray.length > 0) { int newUid = Integer.parseInt(messageArray[0].getUid()); if (K9.DEBUG) Log.i(K9.LOG_TAG, "Got newUid " + newUid + " for message " + end + " on " + getLogId()); int startUid = oldUidNext; if (startUid < newUid - 10) { startUid = newUid - 10; } if (startUid < 1) { startUid = 1; } if (newUid >= startUid) { if (K9.DEBUG) Log.i(K9.LOG_TAG, "Needs sync from uid " + startUid + " to " + newUid + " for " + getLogId()); List messages = new ArrayList(); for (int uid = startUid; uid <= newUid; uid++) { ImapMessage message = new ImapMessage("" + uid, ImapFolderPusher.this); messages.add(message); } if (!messages.isEmpty()) { pushMessages(messages, true); } } } } private void syncMessages(List flagSyncMsgSeqs) { try { Message[] messageArray = null; messageArray = getMessages(flagSyncMsgSeqs, true, null); List messages = new ArrayList(); messages.addAll(Arrays.asList(messageArray)); pushMessages(messages, false); } catch (Exception e) { receiver.pushError("Exception while processing Push untagged responses", e); } } private void removeMessages(List removeUids) { List messages = new ArrayList(removeUids.size()); try { Message[] existingMessages = getMessagesFromUids(removeUids, true, null); for (Message existingMessage : existingMessages) { needsPoll.set(true); msgSeqUidMap.clear(); String existingUid = existingMessage.getUid(); Log.w(K9.LOG_TAG, "Message with UID " + existingUid + " still exists on server, not expunging"); removeUids.remove(existingUid); } for (String uid : removeUids) { ImapMessage message = new ImapMessage(uid, this); try { message.setFlagInternal(Flag.DELETED, true); } catch (MessagingException me) { Log.e(K9.LOG_TAG, "Unable to set DELETED flag on message " + message.getUid()); } messages.add(message); } receiver.messagesRemoved(this, messages); } catch (Exception e) { Log.e(K9.LOG_TAG, "Cannot remove EXPUNGEd messages", e); } } protected int processUntaggedResponse(int oldMessageCount, ImapResponse response, List flagSyncMsgSeqs, List removeMsgUids) { super.handleUntaggedResponse(response); int messageCountDelta = 0; if (response.mTag == null && response.size() > 1) { try { Object responseType = response.get(1); if (ImapResponseParser.equalsIgnoreCase(responseType, "FETCH")) { Log.i(K9.LOG_TAG, "Got FETCH " + response); int msgSeq = response.getNumber(0); if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got untagged FETCH for msgseq " + msgSeq + " for " + getLogId()); if (!flagSyncMsgSeqs.contains(msgSeq)) { flagSyncMsgSeqs.add(msgSeq); } } if (ImapResponseParser.equalsIgnoreCase(responseType, "EXPUNGE")) { int msgSeq = response.getNumber(0); if (msgSeq <= oldMessageCount) { messageCountDelta = -1; } if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got untagged EXPUNGE for msgseq " + msgSeq + " for " + getLogId()); List newSeqs = new ArrayList(); Iterator flagIter = flagSyncMsgSeqs.iterator(); while (flagIter.hasNext()) { Integer flagMsg = flagIter.next(); if (flagMsg >= msgSeq) { flagIter.remove(); if (flagMsg > msgSeq) { newSeqs.add(flagMsg--); } } } flagSyncMsgSeqs.addAll(newSeqs); List msgSeqs = new ArrayList(msgSeqUidMap.keySet()); Collections.sort(msgSeqs); // Have to do comparisons in order because of msgSeq reductions for (Integer msgSeqNumI : msgSeqs) { if (K9.DEBUG) { Log.v(K9.LOG_TAG, "Comparing EXPUNGEd msgSeq " + msgSeq + " to " + msgSeqNumI); } int msgSeqNum = msgSeqNumI; if (msgSeqNum == msgSeq) { String uid = msgSeqUidMap.get(msgSeqNum); if (K9.DEBUG) { Log.d(K9.LOG_TAG, "Scheduling removal of UID " + uid + " because msgSeq " + msgSeqNum + " was expunged"); } removeMsgUids.add(uid); msgSeqUidMap.remove(msgSeqNum); } else if (msgSeqNum > msgSeq) { String uid = msgSeqUidMap.get(msgSeqNum); if (K9.DEBUG) { Log.d(K9.LOG_TAG, "Reducing msgSeq for UID " + uid + " from " + msgSeqNum + " to " + (msgSeqNum - 1)); } msgSeqUidMap.remove(msgSeqNum); msgSeqUidMap.put(msgSeqNum - 1, uid); } } } } catch (Exception e) { Log.e(K9.LOG_TAG, "Could not handle untagged FETCH for " + getLogId(), e); } } return messageCountDelta; } private void pushMessages(List messages, boolean newArrivals) { RuntimeException holdException = null; try { if (newArrivals) { receiver.messagesArrived(this, messages); } else { receiver.messagesFlagsChanged(this, messages); } } catch (RuntimeException e) { holdException = e; } if (holdException != null) { throw holdException; } } public void stop() { stop.set(true); if (listeningThread != null) { listeningThread.interrupt(); } ImapConnection conn = mConnection; if (conn != null) { if (K9.DEBUG) Log.v(K9.LOG_TAG, "Closing mConnection to stop pushing for " + getLogId()); conn.close(); } else { Log.w(K9.LOG_TAG, "Attempt to interrupt null mConnection to stop pushing on folderPusher for " + getLogId()); } } public void handleAsyncUntaggedResponse(ImapResponse response) { if (K9.DEBUG) Log.v(K9.LOG_TAG, "Got async response: " + response); if (stop.get()) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got async untagged response: " + response + ", but stop is set for " + getLogId()); try { sendDone(); } catch (Exception e) { Log.e(K9.LOG_TAG, "Exception while sending DONE for " + getLogId(), e); } } else { if (response.mTag == null) { if (response.size() > 1) { boolean started = false; Object responseType = response.get(1); if (ImapResponseParser.equalsIgnoreCase(responseType, "EXISTS") || ImapResponseParser.equalsIgnoreCase(responseType, "EXPUNGE") || ImapResponseParser.equalsIgnoreCase(responseType, "FETCH")) { if (!started) { wakeLock.acquire(K9.PUSH_WAKE_LOCK_TIMEOUT); started = true; } if (K9.DEBUG) Log.d(K9.LOG_TAG, "Got useful async untagged response: " + response + " for " + getLogId()); try { sendDone(); } catch (Exception e) { Log.e(K9.LOG_TAG, "Exception while sending DONE for " + getLogId(), e); } } } else if (response.mCommandContinuationRequested) { if (K9.DEBUG) Log.d(K9.LOG_TAG, "Idling " + getLogId()); wakeLock.release(); } } } } } @Override public Pusher getPusher(PushReceiver receiver) { return new ImapPusher(this, receiver); } public class ImapPusher implements Pusher { final ImapStore mStore; final PushReceiver mReceiver; private long lastRefresh = -1; HashMap folderPushers = new HashMap(); public ImapPusher(ImapStore store, PushReceiver receiver) { mStore = store; mReceiver = receiver; } public void start(List folderNames) { stop(); synchronized (folderPushers) { setLastRefresh(System.currentTimeMillis()); for (String folderName : folderNames) { ImapFolderPusher pusher = folderPushers.get(folderName); if (pusher == null) { pusher = new ImapFolderPusher(mStore, folderName, mReceiver); folderPushers.put(folderName, pusher); pusher.start(); } } } } public void refresh() { synchronized (folderPushers) { for (ImapFolderPusher folderPusher : folderPushers.values()) { try { folderPusher.refresh(); } catch (Exception e) { Log.e(K9.LOG_TAG, "Got exception while refreshing for " + folderPusher.getName(), e); } } } } public void stop() { if (K9.DEBUG) Log.i(K9.LOG_TAG, "Requested stop of IMAP pusher"); synchronized (folderPushers) { for (ImapFolderPusher folderPusher : folderPushers.values()) { try { if (K9.DEBUG) Log.i(K9.LOG_TAG, "Requesting stop of IMAP folderPusher " + folderPusher.getName()); folderPusher.stop(); } catch (Exception e) { Log.e(K9.LOG_TAG, "Got exception while stopping " + folderPusher.getName(), e); } } folderPushers.clear(); } } public int getRefreshInterval() { return (getAccount().getIdleRefreshMinutes() * 60 * 1000); } public long getLastRefresh() { return lastRefresh; } public void setLastRefresh(long lastRefresh) { this.lastRefresh = lastRefresh; } } private interface UntaggedHandler { void handleAsyncUntaggedResponse(ImapResponse respose); } protected static class ImapPushState { protected int uidNext; protected ImapPushState(int nUidNext) { uidNext = nUidNext; } protected static ImapPushState parse(String pushState) { int newUidNext = -1; if (pushState != null) { StringTokenizer tokenizer = new StringTokenizer(pushState, ";"); while (tokenizer.hasMoreTokens()) { StringTokenizer thisState = new StringTokenizer(tokenizer.nextToken(), "="); if (thisState.hasMoreTokens()) { String key = thisState.nextToken(); if ("uidNext".equalsIgnoreCase(key) && thisState.hasMoreTokens()) { String value = thisState.nextToken(); try { newUidNext = Integer.parseInt(value); } catch (Exception e) { Log.e(K9.LOG_TAG, "Unable to part uidNext value " + value, e); } } } } } return new ImapPushState(newUidNext); } @Override public String toString() { return "uidNext=" + uidNext; } } private interface ImapSearcher { List search() throws IOException, MessagingException; } private static class FetchBodyCallback implements ImapResponseParser.IImapResponseCallback { private HashMap mMessageMap; FetchBodyCallback(HashMap mesageMap) { mMessageMap = mesageMap; } @Override public Object foundLiteral(ImapResponse response, FixedLengthInputStream literal) throws IOException, Exception { if (response.mTag == null && ImapResponseParser.equalsIgnoreCase(response.get(1), "FETCH")) { ImapList fetchList = (ImapList)response.getKeyedValue("FETCH"); String uid = fetchList.getKeyedString("UID"); ImapMessage message = (ImapMessage) mMessageMap.get(uid); message.parse(literal); // Return placeholder object return Integer.valueOf(1); } return null; } } private static class FetchPartCallback implements ImapResponseParser.IImapResponseCallback { private Part mPart; FetchPartCallback(Part part) { mPart = part; } @Override public Object foundLiteral(ImapResponse response, FixedLengthInputStream literal) throws IOException, Exception { if (response.mTag == null && ImapResponseParser.equalsIgnoreCase(response.get(1), "FETCH")) { //TODO: check for correct UID String contentTransferEncoding = mPart.getHeader( MimeHeader.HEADER_CONTENT_TRANSFER_ENCODING)[0]; return MimeUtility.decodeBody(literal, contentTransferEncoding); } return null; } } }