Examples with SyncConfig com.fsck.k9.backend.api.SyncConfig used on opensource projects

Example 11 with SyncConfig

use of com.fsck.k9.backend.api.SyncConfig in project k-9 by k9mail.

the class Pop3Sync method synchronizeMailboxSynchronous.

void synchronizeMailboxSynchronous(String folder, SyncConfig syncConfig, SyncListener listener) {
    Pop3Folder remoteFolder = null;
    Timber.i("Synchronizing folder %s:%s", accountName, folder);
    BackendFolder backendFolder = null;
    try {
        Timber.d("SYNC: About to process pending commands for account %s", accountName);
        Timber.v("SYNC: About to get local folder %s", folder);
        backendFolder = backendStorage.getFolder(folder);
        listener.syncStarted(folder);
        /*
             * Get the message list from the local store and create an index of
             * the uids within the list.
             */
        Map<String, Long> localUidMap = backendFolder.getAllMessagesAndEffectiveDates();
        Timber.v("SYNC: About to get remote folder %s", folder);
        remoteFolder = remoteStore.getFolder(folder);
        /*
             * Synchronization process:
             *
            Open the folder
            Upload any local messages that are marked as PENDING_UPLOAD (Drafts, Sent, Trash)
            Get the message count
            Get the list of the newest K9.DEFAULT_VISIBLE_LIMIT messages
            getMessages(messageCount - K9.DEFAULT_VISIBLE_LIMIT, messageCount)
            See if we have each message locally, if not fetch it's flags and envelope
            Get and update the unread count for the folder
            Update the remote flags of any messages we have locally with an internal date newer than the remote message.
            Get the current flags for any messages we have locally but did not just download
            Update local flags
            For any message we have locally but not remotely, delete the local message to keep cache clean.
            Download larger parts of any new messages.
            (Optional) Download small attachments in the background.
             */
        /*
             * Open the remote folder. This pre-loads certain metadata like message count.
             */
        Timber.v("SYNC: About to open remote folder %s", folder);
        remoteFolder.open();
        listener.syncAuthenticationSuccess();
        /*
             * Get the remote message count.
             */
        int remoteMessageCount = remoteFolder.getMessageCount();
        int visibleLimit = backendFolder.getVisibleLimit();
        if (visibleLimit < 0) {
            visibleLimit = syncConfig.getDefaultVisibleLimit();
        }
        final List<Pop3Message> remoteMessages = new ArrayList<>();
        Map<String, Pop3Message> remoteUidMap = new HashMap<>();
        Timber.v("SYNC: Remote message count for folder %s is %d", folder, remoteMessageCount);
        final Date earliestDate = syncConfig.getEarliestPollDate();
        long earliestTimestamp = earliestDate != null ? earliestDate.getTime() : 0L;
        int remoteStart = 1;
        if (remoteMessageCount > 0) {
            /* Message numbers start at 1.  */
            if (visibleLimit > 0) {
                remoteStart = Math.max(0, remoteMessageCount - visibleLimit) + 1;
            } else {
                remoteStart = 1;
            }
            Timber.v("SYNC: About to get messages %d through %d for folder %s", remoteStart, remoteMessageCount, folder);
            final AtomicInteger headerProgress = new AtomicInteger(0);
            listener.syncHeadersStarted(folder);
            List<Pop3Message> remoteMessageArray = remoteFolder.getMessages(remoteStart, remoteMessageCount, null);
            int messageCount = remoteMessageArray.size();
            for (Pop3Message thisMess : remoteMessageArray) {
                headerProgress.incrementAndGet();
                listener.syncHeadersProgress(folder, headerProgress.get(), messageCount);
                Long localMessageTimestamp = localUidMap.get(thisMess.getUid());
                if (localMessageTimestamp == null || localMessageTimestamp >= earliestTimestamp) {
                    remoteMessages.add(thisMess);
                    remoteUidMap.put(thisMess.getUid(), thisMess);
                }
            }
            Timber.v("SYNC: Got %d messages for folder %s", remoteUidMap.size(), folder);
            listener.syncHeadersFinished(folder, headerProgress.get(), remoteUidMap.size());
        } else if (remoteMessageCount < 0) {
            throw new Exception("Message count " + remoteMessageCount + " for folder " + folder);
        }
        /*
             * Remove any messages that are in the local store but no longer on the remote store or are too old
             */
        MoreMessages moreMessages = backendFolder.getMoreMessages();
        if (syncConfig.getSyncRemoteDeletions()) {
            List<String> destroyMessageUids = new ArrayList<>();
            for (String localMessageUid : localUidMap.keySet()) {
                if (remoteUidMap.get(localMessageUid) == null) {
                    destroyMessageUids.add(localMessageUid);
                }
            }
            if (!destroyMessageUids.isEmpty()) {
                moreMessages = MoreMessages.UNKNOWN;
                backendFolder.destroyMessages(destroyMessageUids);
                for (String uid : destroyMessageUids) {
                    listener.syncRemovedMessage(folder, uid);
                }
            }
        }
        // noinspection UnusedAssignment, free memory early? (better break up the method!)
        localUidMap = null;
        if (moreMessages == MoreMessages.UNKNOWN) {
            updateMoreMessages(remoteFolder, backendFolder, remoteStart);
        }
        /*
             * Now we download the actual content of messages.
             */
        int newMessages = downloadMessages(syncConfig, remoteFolder, backendFolder, remoteMessages, listener);
        listener.folderStatusChanged(folder);
        /* Notify listeners that we're finally done. */
        backendFolder.setLastChecked(System.currentTimeMillis());
        backendFolder.setStatus(null);
        Timber.d("Done synchronizing folder %s:%s @ %tc with %d new messages", accountName, folder, System.currentTimeMillis(), newMessages);
        listener.syncFinished(folder);
        Timber.i("Done synchronizing folder %s:%s", accountName, folder);
    } catch (AuthenticationFailedException e) {
        listener.syncFailed(folder, "Authentication failure", e);
    } catch (Exception e) {
        Timber.e(e, "synchronizeMailbox");
        // If we don't set the last checked, it can try too often during
        // failure conditions
        String rootMessage = ExceptionHelper.getRootCauseMessage(e);
        if (backendFolder != null) {
            try {
                backendFolder.setStatus(rootMessage);
                backendFolder.setLastChecked(System.currentTimeMillis());
            } catch (Exception e1) {
                Timber.e(e1, "Could not set last checked on folder %s:%s", accountName, folder);
            }
        }
        listener.syncFailed(folder, rootMessage, e);
        Timber.e("Failed synchronizing folder %s:%s @ %tc", accountName, folder, System.currentTimeMillis());
    } finally {
        if (remoteFolder != null) {
            remoteFolder.close();
        }
    }
}

Example 12 with SyncConfig

use of com.fsck.k9.backend.api.SyncConfig in project k-9 by k9mail.

the class WebDavSync method downloadSaneBody.

private void downloadSaneBody(SyncConfig syncConfig, WebDavFolder remoteFolder, BackendFolder backendFolder, WebDavMessage message) throws MessagingException {
    /*
         * The provider was unable to get the structure of the message, so
         * we'll download a reasonable portion of the messge and mark it as
         * incomplete so the entire thing can be downloaded later if the user
         * wishes to download it.
         */
    FetchProfile fp = new FetchProfile();
    fp.add(FetchProfile.Item.BODY_SANE);
    /*
         *  TODO a good optimization here would be to make sure that all Stores set
         *  the proper size after this fetch and compare the before and after size. If
         *  they equal we can mark this SYNCHRONIZED instead of PARTIALLY_SYNCHRONIZED
         */
    int maxDownloadSize = syncConfig.getMaximumAutoDownloadMessageSize();
    remoteFolder.fetch(Collections.singletonList(message), fp, null, maxDownloadSize);
    boolean completeMessage = false;
    // Certain (POP3) servers give you the whole message even when you ask for only the first x Kb
    if (!message.isSet(Flag.X_DOWNLOADED_FULL)) {
        /*
             * Mark the message as fully downloaded if the message size is smaller than
             * the account's autodownload size limit, otherwise mark as only a partial
             * download.  This will prevent the system from downloading the same message
             * twice.
             *
             * If there is no limit on autodownload size, that's the same as the message
             * being smaller than the max size
             */
        if (syncConfig.getMaximumAutoDownloadMessageSize() == 0 || message.getSize() < syncConfig.getMaximumAutoDownloadMessageSize()) {
            completeMessage = true;
        }
    }
    // Store the updated message locally
    if (completeMessage) {
        backendFolder.saveMessage(message, MessageDownloadState.FULL);
    } else {
        backendFolder.saveMessage(message, MessageDownloadState.PARTIAL);
    }
}

Example 13 with SyncConfig

use of com.fsck.k9.backend.api.SyncConfig in project k-9 by k9mail.

the class WebDavSync method downloadMessages.

private int downloadMessages(final SyncConfig syncConfig, final WebDavFolder remoteFolder, final BackendFolder backendFolder, List<WebDavMessage> inputMessages, final SyncListener listener) throws MessagingException {
    final Date earliestDate = syncConfig.getEarliestPollDate();
    // now
    Date downloadStarted = new Date();
    if (earliestDate != null) {
        Timber.d("Only syncing messages after %s", earliestDate);
    }
    final String folder = remoteFolder.getServerId();
    List<WebDavMessage> syncFlagMessages = new ArrayList<>();
    List<WebDavMessage> unsyncedMessages = new ArrayList<>();
    final AtomicInteger newMessages = new AtomicInteger(0);
    List<WebDavMessage> messages = new ArrayList<>(inputMessages);
    for (WebDavMessage message : messages) {
        evaluateMessageForDownload(message, folder, backendFolder, unsyncedMessages, syncFlagMessages, listener);
    }
    final AtomicInteger progress = new AtomicInteger(0);
    final int todo = unsyncedMessages.size() + syncFlagMessages.size();
    listener.syncProgress(folder, progress.get(), todo);
    Timber.d("SYNC: Have %d unsynced messages", unsyncedMessages.size());
    messages.clear();
    final List<WebDavMessage> largeMessages = new ArrayList<>();
    final List<WebDavMessage> smallMessages = new ArrayList<>();
    if (!unsyncedMessages.isEmpty()) {
        int visibleLimit = backendFolder.getVisibleLimit();
        int listSize = unsyncedMessages.size();
        if ((visibleLimit > 0) && (listSize > visibleLimit)) {
            unsyncedMessages = unsyncedMessages.subList(0, visibleLimit);
        }
        FetchProfile fp = new FetchProfile();
        fp.add(FetchProfile.Item.FLAGS);
        fp.add(FetchProfile.Item.ENVELOPE);
        Timber.d("SYNC: About to fetch %d unsynced messages for folder %s", unsyncedMessages.size(), folder);
        fetchUnsyncedMessages(syncConfig, remoteFolder, unsyncedMessages, smallMessages, largeMessages, progress, todo, fp, listener);
        Timber.d("SYNC: Synced unsynced messages for folder %s", folder);
    }
    Timber.d("SYNC: Have %d large messages and %d small messages out of %d unsynced messages", largeMessages.size(), smallMessages.size(), unsyncedMessages.size());
    unsyncedMessages.clear();
    /*
         * Grab the content of the small messages first. This is going to
         * be very fast and at very worst will be a single up of a few bytes and a single
         * download of 625k.
         */
    FetchProfile fp = new FetchProfile();
    // TODO: Only fetch small and large messages if we have some
    fp.add(FetchProfile.Item.BODY);
    // fp.add(FetchProfile.Item.FLAGS);
    // fp.add(FetchProfile.Item.ENVELOPE);
    downloadSmallMessages(remoteFolder, backendFolder, smallMessages, progress, newMessages, todo, fp, listener);
    smallMessages.clear();
    /*
         * Now do the large messages that require more round trips.
         */
    fp = new FetchProfile();
    fp.add(FetchProfile.Item.STRUCTURE);
    downloadLargeMessages(syncConfig, remoteFolder, backendFolder, largeMessages, progress, newMessages, todo, fp, listener);
    largeMessages.clear();
    /*
         * Refresh the flags for any messages in the local store that we didn't just
         * download.
         */
    refreshLocalMessageFlags(syncConfig, remoteFolder, backendFolder, syncFlagMessages, progress, todo, listener);
    Timber.d("SYNC: Synced remote messages for folder %s, %d new messages", folder, newMessages.get());
    return newMessages.get();
}

Example 14 with SyncConfig

use of com.fsck.k9.backend.api.SyncConfig in project k-9 by k9mail.

the class WebDavSync method fetchUnsyncedMessages.

private void fetchUnsyncedMessages(final SyncConfig syncConfig, final WebDavFolder remoteFolder, List<WebDavMessage> unsyncedMessages, final List<WebDavMessage> smallMessages, final List<WebDavMessage> largeMessages, final AtomicInteger progress, final int todo, FetchProfile fp, final SyncListener listener) throws MessagingException {
    final String folder = remoteFolder.getServerId();
    final Date earliestDate = syncConfig.getEarliestPollDate();
    remoteFolder.fetch(unsyncedMessages, fp, new MessageRetrievalListener<WebDavMessage>() {

        @Override
        public void messageFinished(WebDavMessage message, int number, int ofTotal) {
            try {
                if (message.isSet(Flag.DELETED) || message.olderThan(earliestDate)) {
                    if (message.isSet(Flag.DELETED)) {
                        Timber.v("Newly downloaded message %s:%s:%s was marked deleted on server, " + "skipping", accountName, folder, message.getUid());
                    } else {
                        Timber.d("Newly downloaded message %s is older than %s, skipping", message.getUid(), earliestDate);
                    }
                    progress.incrementAndGet();
                    // TODO: This might be the source of poll count errors in the UI. Is todo always the same as ofTotal
                    listener.syncProgress(folder, progress.get(), todo);
                    return;
                }
                if (syncConfig.getMaximumAutoDownloadMessageSize() > 0 && message.getSize() > syncConfig.getMaximumAutoDownloadMessageSize()) {
                    largeMessages.add(message);
                } else {
                    smallMessages.add(message);
                }
            } catch (Exception e) {
                Timber.e(e, "Error while storing downloaded message.");
            }
        }

        @Override
        public void messageStarted(String uid, int number, int ofTotal) {
        }

        @Override
        public void messagesFinished(int total) {
        // FIXME this method is almost never invoked by various Stores! Don't rely on it unless fixed!!
        }
    }, syncConfig.getMaximumAutoDownloadMessageSize());
}