src/com/android/mail/ui/ConversationPositionTracker.java

/*******************************************************************************
 *      Copyright (C) 2012 Google Inc.
 *      Licensed to The Android Open Source Project.
 *
 *      Licensed under the Apache License, Version 2.0 (the "License");
 *      you may not use this file except in compliance with the License.
 *      You may obtain a copy of the License at
 *
 *           http://www.apache.org/licenses/LICENSE-2.0
 *
 *      Unless required by applicable law or agreed to in writing, software
 *      distributed under the License is distributed on an "AS IS" BASIS,
 *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *      See the License for the specific language governing permissions and
 *      limitations under the License.
 *******************************************************************************/

package com.android.mail.ui;

import com.android.mail.browse.ConversationCursor;
import com.android.mail.providers.Conversation;
import com.android.mail.providers.Settings;
import com.android.mail.providers.UIProvider.AutoAdvance;
import com.android.mail.utils.LogTag;
import com.android.mail.utils.LogUtils;
import java.util.Collection;

/**
 * An iterator over a conversation list that keeps track of the position of a conversation, and
 * updates the position accordingly when the underlying list data changes and the conversation
 * is in a different position.
 */
public class ConversationPositionTracker {
    protected static final String LOG_TAG = LogTag.getLogTag();


    public interface Callbacks {
        ConversationCursor getConversationListCursor();
    }


    /** Did we recalculate positions after updating the cursor? */
    private boolean mCursorDirty = false;
    /** The currently selected conversation */
    private Conversation mConversation;

    private final Callbacks mCallbacks;

    /**
     * Constructs a position tracker that doesn't point to any specific conversation.
     */
    public ConversationPositionTracker(Callbacks callbacks) {
        mCallbacks = callbacks;
    }

    /** Move cursor to a specific position and return the conversation there */
    private Conversation conversationAtPosition(int position){
        final ConversationCursor cursor = mCallbacks.getConversationListCursor();
        cursor.moveToPosition(position);
        final Conversation conv = cursor.getConversation();
        conv.position = position;
        return conv;
    }

    /**
     * @return the total number of conversations in the list.
     */
    private int getCount() {
        final ConversationCursor cursor = mCallbacks.getConversationListCursor();
        if (isDataLoaded(cursor)) {
            return cursor.getCount();
        } else {
            return 0;
        }
    }

    /**
     * @return the {@link Conversation} of the newer conversation by one position. If no such
     * conversation exists, this method returns null.
     */
    private Conversation getNewer(Collection<Conversation> victims) {
        int pos = calculatePosition();
        if (!isDataLoaded() || pos < 0) {
            return null;
        }
        // Walk backward from the existing position, trying to find a conversation that is not a
        // victim.
        pos--;
        while (pos >= 0) {
            final Conversation candidate = conversationAtPosition(pos);
            if (!Conversation.contains(victims, candidate)) {
                return candidate;
            }
            pos--;
        }
        return null;
    }

    /**
     * @return the {@link Conversation} of the older conversation by one spot. If no such
     * conversation exists, this method returns null.
     */
    private Conversation getOlder(Collection<Conversation> victims) {
        int pos = calculatePosition();
        if (!isDataLoaded() || pos < 0) {
            return null;
        }
        // Walk forward from the existing position, trying to find a conversation that is not a
        // victim.
        pos++;
        while (pos < getCount()) {
            final Conversation candidate = conversationAtPosition(pos);
            if (!Conversation.contains(victims, candidate)) {
                return candidate;
            }
            pos++;
        }
        return null;
    }

    /**
     * Initializes the tracker with initial conversation id and initial position. This invalidates
     * the positions in the tracker. We need a valid cursor before we can bless the position as
     * valid. This requires a call to
     * {@link #onCursorUpdated()}.
     * TODO(viki): Get rid of this method and the mConversation field entirely.
     */
    public void initialize(Conversation conversation) {
        mConversation = conversation;
        mCursorDirty = true;
        calculatePosition(); // Return value discarded. Running for side effects.
    }

    /** @return whether or not we have a valid cursor to check the position of. */
    private static boolean isDataLoaded(ConversationCursor cursor) {
        return cursor != null && !cursor.isClosed();
    }

    private boolean isDataLoaded() {
        final ConversationCursor cursor = mCallbacks.getConversationListCursor();
        return isDataLoaded(cursor);
    }

    /**
     * Called when the conversation list changes.
     */
    public void onCursorUpdated() {
        mCursorDirty = true;
    }

    /**
     * Recalculate the current position based on the cursor. This needs to be done once for
     * each (Conversation, Cursor) pair. We could do this on every change of conversation or
     * cursor, but that would be wasteful, since the recalculation of position is only required
     * when transitioning to the next conversation. Transitions don't happen frequently, but
     * changes in conversation and cursor do. So we defer this till it is actually needed.
     *
     * This method could change the current conversation if it cannot find the current conversation
     * in the cursor. When this happens, this method sets the current conversation to some safe
     * value and logs the reasons why it couldn't find the conversation.
     *
     * Calling this method repeatedly is safe: it returns early if it detects it has already been
     * called.
     * @return the position of the current conversation in the cursor.
     */
    private int calculatePosition() {
        final int invalidPosition = -1;
        final ConversationCursor cursor = mCallbacks.getConversationListCursor();
        // If we have a valid position and nothing has changed, return that right away
        if (!mCursorDirty) {
            return mConversation.position;
        }
        // Ensure valid input data
        if (cursor == null || mConversation == null) {
            return invalidPosition;
        }
        mCursorDirty = false;
        final int listSize = cursor.getCount();
        if (!isDataLoaded(cursor) || listSize == 0) {
            return invalidPosition;
        }

        final int foundPosition = cursor.getConversationPosition(mConversation.id);
        if (foundPosition >= 0) {
            mConversation.position = foundPosition;
            // Pre-emptively try to load the next cursor position so that the cursor window
            // can be filled. The odd behavior of the ConversationCursor requires us to do
            // this to ensure the adjacent conversation information is loaded for calls to
            // hasNext.
            cursor.moveToPosition(foundPosition + 1);
            return foundPosition;
        }

        // If the conversation is no longer found in the list, try to save the same position if
        // it is still a valid position. Otherwise, go back to a valid position until we can
        // find a valid one.
        final int newPosition;
        if (foundPosition >= listSize) {
            // Go to the last position since our expected position is past this somewhere.
            newPosition = listSize - 1;
        } else {
            newPosition = foundPosition;
        }

        // Did not keep the current conversation, so let's try to load the conversation from the
        // new position.
        if (isDataLoaded(cursor) && newPosition >= 0){
            LogUtils.d(LOG_TAG, "ConversationPositionTracker: Could not find conversation %s" +
                    " in the cursor. Moving to position %d ", mConversation.toString(),
                    newPosition);
            cursor.moveToPosition(newPosition);
            mConversation = new Conversation(cursor);
            mConversation.position = newPosition;
        }
        return newPosition;
    }

    /**
     * Get the next conversation according to the AutoAdvance settings and the list of
     * conversations available in the folder. If no next conversation can be found, this method
     * returns null.
     * @param autoAdvance the auto advance preference for the user as an
     * {@link Settings#getAutoAdvanceSetting()} value.
     * @param mTarget conversations to overlook while finding the next conversation. (These are
     * usually the conversations to be deleted.)
     * @return the next conversation to be shown, or null if no next conversation exists.
     */
    public Conversation getNextConversation(int autoAdvance, Collection<Conversation> mTarget) {
        final boolean getNewer = autoAdvance == AutoAdvance.NEWER;
        final boolean getOlder = autoAdvance == AutoAdvance.OLDER;
        final Conversation next = getNewer ? getNewer(mTarget) :
            (getOlder ? getOlder(mTarget) : null);
        LogUtils.d(LOG_TAG, "ConversationPositionTracker.getNextConversation: " +
                "getNewer = %b, getOlder = %b, Next conversation is %s",
                getNewer, getOlder, next);
        return next;
    }

}