From f04c832f23b14aa26bf584eb9a82f9bc06279524 Mon Sep 17 00:00:00 2001 From: Todd Kennedy Date: Fri, 3 Jun 2011 16:54:52 -0700 Subject: [PATCH] Add ability to track mailbox recency Change-Id: I1bcc7928ea7065a5daa262b7cea7ee3e21981675 --- proguard.flags | 6 + .../email/activity/RecentMailboxManager.java | 112 ++++++++++++ .../activity/RecentMailboxManagerTest.java | 168 ++++++++++++++++++ 3 files changed, 286 insertions(+) create mode 100644 src/com/android/email/activity/RecentMailboxManager.java create mode 100644 tests/src/com/android/email/activity/RecentMailboxManagerTest.java diff --git a/proguard.flags b/proguard.flags index d60389d3b..23878e985 100644 --- a/proguard.flags +++ b/proguard.flags @@ -34,6 +34,12 @@ *** *Anim(...); } +-keepclasseswithmembers class com.android.email.activity.RecentMailboxManager { + *** touch(long); + *** getInstance(android.content.Context); + *** getMostRecent(long, boolean); +} + -keepclasseswithmembers class com.android.email.activity.setup.AccountSetupAccountType { *** checkAccountInstanceLimit(com.android.email.mail.Store$StoreInfo); } diff --git a/src/com/android/email/activity/RecentMailboxManager.java b/src/com/android/email/activity/RecentMailboxManager.java new file mode 100644 index 000000000..c3dd43736 --- /dev/null +++ b/src/com/android/email/activity/RecentMailboxManager.java @@ -0,0 +1,112 @@ +/* + * Copyright (C) 2011 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.email.activity; + +import com.google.common.annotations.VisibleForTesting; + +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; + +import com.android.email.Clock; +import com.android.emailcommon.provider.EmailContent; +import com.android.emailcommon.provider.Mailbox; +import com.android.emailcommon.provider.EmailContent.MailboxColumns; +import com.android.emailcommon.utility.EmailAsyncTask; + +import java.util.ArrayList; + +/** + * Manages recent data for mailboxes. + */ +public class RecentMailboxManager { + @VisibleForTesting + static Clock sClock = Clock.INSTANCE; + + /** The maximum number of results to retrieve */ + private static final int LIMIT_RESULTS = 5; + /** Query to find the top most recent mailboxes */ + private static final String RECENT_SELECTION = + MailboxColumns.ID + " IN " + + "( SELECT " + MailboxColumns.ID + + " FROM " + Mailbox.TABLE_NAME + + " WHERE ( " + MailboxColumns.ACCOUNT_KEY + "=? " + + " AND " + MailboxColumns.LAST_TOUCHED_TIME + ">0 )" + + " ORDER BY " + MailboxColumns.LAST_TOUCHED_TIME + " DESC" + + " LIMIT ? )"; + /** Similar query to {@link #RECENT_SELECTION}, except, exclude all but user mailboxes */ + private static final String RECENT_SELECTION_WITH_EXCLUSIONS = + RECENT_SELECTION + " AND " + MailboxColumns.TYPE + "=" + Mailbox.TYPE_MAIL; + private final Context mContext; + private static RecentMailboxManager sInstance; + + public static synchronized RecentMailboxManager getInstance(Context context) { + if (sInstance == null) { + sInstance = new RecentMailboxManager(context); + } + return sInstance; + } + + /** Hide constructor */ + private RecentMailboxManager(Context context) { + mContext = context; + } + + /** Updates the specified mailbox's touch time. Returns an async task for test only. */ + public EmailAsyncTask touch(long mailboxId) { + return fireAndForget(mailboxId, sClock.getTime()); + } + + /** + * Gets the most recently touched mailboxes for the specified account. + *

WARNING: This method blocks on the database. + * @param accountId The ID of the account to load the recent list. + * @param withExclusions If {@code false}, all mailboxes are eligible for the recent list. + * Otherwise, only user defined mailboxes are eligible for the recent list. + */ + public ArrayList getMostRecent(long accountId, boolean withExclusions) { + String selection = withExclusions ? RECENT_SELECTION_WITH_EXCLUSIONS : RECENT_SELECTION; + ArrayList returnList = new ArrayList(); + Cursor cursor = mContext.getContentResolver().query(Mailbox.CONTENT_URI, + EmailContent.ID_PROJECTION, + selection, + new String[] { Long.toString(accountId), Integer.toString(LIMIT_RESULTS) }, + MailboxColumns.DISPLAY_NAME); + try { + while (cursor.moveToNext()) { + returnList.add(cursor.getLong(EmailContent.ID_PROJECTION_COLUMN)); + } + } finally { + cursor.close(); + } + return returnList; + } + + /** Updates the last touched time for the mailbox in the background */ + private EmailAsyncTask fireAndForget(final long mailboxId, final long time) { + return EmailAsyncTask.runAsyncParallel(new Runnable() { + @Override + public void run() { + ContentValues values = new ContentValues(); + values.put(MailboxColumns.LAST_TOUCHED_TIME, time); + mContext.getContentResolver().update(Mailbox.CONTENT_URI, values, + EmailContent.ID_SELECTION, + new String[] { Long.toString(mailboxId) }); + } + }); + } +} diff --git a/tests/src/com/android/email/activity/RecentMailboxManagerTest.java b/tests/src/com/android/email/activity/RecentMailboxManagerTest.java new file mode 100644 index 000000000..9788c3edd --- /dev/null +++ b/tests/src/com/android/email/activity/RecentMailboxManagerTest.java @@ -0,0 +1,168 @@ +/* + * Copyright (C) 2011 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.email.activity; + +import android.content.Context; +import android.test.ProviderTestCase2; + +import com.android.email.MockClock; +import com.android.email.provider.ContentCache; +import com.android.email.provider.EmailProvider; +import com.android.email.provider.ProviderTestUtils; +import com.android.emailcommon.provider.EmailContent; +import com.android.emailcommon.provider.Mailbox; + +import java.util.ArrayList; + +/** + * Tests for the recent mailbox manager. + * + * You can run this entire test case with: + * runtest -c com.android.email.activity.RecentMailboxManagerTest email + */ +public class RecentMailboxManagerTest extends ProviderTestCase2 { + + private Context mMockContext; + private MockClock mMockClock; + private RecentMailboxManager mManager; + private Mailbox[] mMailboxArray; + public RecentMailboxManagerTest() { + super(EmailProvider.class, EmailContent.AUTHORITY); + } + + @Override + public void setUp() throws Exception { + super.setUp(); + mMockContext = getMockContext(); + mMockClock = new MockClock(); + RecentMailboxManager.sClock = mMockClock; + mManager = RecentMailboxManager.getInstance(mMockContext); + mMailboxArray = new Mailbox[] { + ProviderTestUtils.setupMailbox("inbox", 1L, true, mMockContext, Mailbox.TYPE_INBOX), + ProviderTestUtils.setupMailbox("drafts", 1L, true, mMockContext, Mailbox.TYPE_DRAFTS), + ProviderTestUtils.setupMailbox("outbox", 1L, true, mMockContext, Mailbox.TYPE_OUTBOX), + ProviderTestUtils.setupMailbox("sent", 1L, true, mMockContext, Mailbox.TYPE_SENT), + ProviderTestUtils.setupMailbox("trash", 1L, true, mMockContext, Mailbox.TYPE_TRASH), + ProviderTestUtils.setupMailbox("junk", 1L, true, mMockContext, Mailbox.TYPE_JUNK), + ProviderTestUtils.setupMailbox("abbott", 1L, true, mMockContext, Mailbox.TYPE_MAIL), + ProviderTestUtils.setupMailbox("costello", 1L, true, mMockContext, Mailbox.TYPE_MAIL), + ProviderTestUtils.setupMailbox("bud_lou", 1L, true, mMockContext, Mailbox.TYPE_MAIL), + }; + // Invalidate all caches, since we reset the database for each test + ContentCache.invalidateAllCachesForTest(); + } + + public void testTouch() throws Exception { + // Ensure all accounts can be touched + for (Mailbox mailbox : mMailboxArray) { + // Safety ... default touch time + Mailbox untouchedMailbox = Mailbox.restoreMailboxWithId(mMockContext, mailbox.mId); + assertEquals(0L, untouchedMailbox.mLastTouchedTime); + + // Touch the mailbox + mManager.touch(mailbox.mId).get(); + + // Touch time is actually set + Mailbox touchedMailbox = Mailbox.restoreMailboxWithId(mMockContext, mailbox.mId); + assertEquals(mMockClock.getTime(), touchedMailbox.mLastTouchedTime); + + mMockClock.advance(1000L); + } + // Now ensure touching one didn't affect the others + long touchTime = MockClock.DEFAULT_TIME; + for (Mailbox mailbox : mMailboxArray) { + // Touch time is actually set + Mailbox touchedMailbox = Mailbox.restoreMailboxWithId(mMockContext, mailbox.mId); + assertEquals(touchTime, touchedMailbox.mLastTouchedTime); + touchTime += 1000L; + } + } + + public void testGetMostRecent() throws Exception { + ArrayList testList; + + // test default list + testList = mManager.getMostRecent(1L, false); + assertEquals(0, testList.size()); + testList = mManager.getMostRecent(1L, true); + assertEquals(0, testList.size()); + + // touch some mailboxes + mManager.touch(mMailboxArray[0].mId); // inbox + mMockClock.advance(1000L); + mManager.touch(mMailboxArray[3].mId); // sent + mMockClock.advance(1000L); + // need to wait for the last one to ensure getMostRecent() has something to work on + mManager.touch(mMailboxArray[7].mId).get(); // user mailbox #2 + mMockClock.advance(1000L); + + // test recent list not full + testList = mManager.getMostRecent(1L, false); + assertEquals(3, testList.size()); + assertEquals(mMailboxArray[7].mId, (long) testList.get(0)); + assertEquals(mMailboxArray[0].mId, (long) testList.get(1)); + assertEquals(mMailboxArray[3].mId, (long) testList.get(2)); + testList = mManager.getMostRecent(1L, true); + assertEquals(1, testList.size()); + assertEquals(mMailboxArray[7].mId, (long) testList.get(0)); + + // touch some more mailboxes + mManager.touch(mMailboxArray[4].mId); // trash + mMockClock.advance(1000L); + mManager.touch(mMailboxArray[2].mId); // outbox + mMockClock.advance(1000L); + mManager.touch(mMailboxArray[8].mId); // user mailbox #3 + mMockClock.advance(1000L); + mManager.touch(mMailboxArray[7].mId).get(); // user mailbox #2 + mMockClock.advance(1000L); + + // test full recent list + testList = mManager.getMostRecent(1L, false); + assertEquals(5, testList.size()); + assertEquals(mMailboxArray[8].mId, (long) testList.get(0)); + assertEquals(mMailboxArray[7].mId, (long) testList.get(1)); + assertEquals(mMailboxArray[2].mId, (long) testList.get(2)); + assertEquals(mMailboxArray[3].mId, (long) testList.get(3)); + assertEquals(mMailboxArray[4].mId, (long) testList.get(4)); + testList = mManager.getMostRecent(1L, true); + assertEquals(2, testList.size()); + assertEquals(mMailboxArray[8].mId, (long) testList.get(0)); + assertEquals(mMailboxArray[7].mId, (long) testList.get(1)); + + mManager.touch(mMailboxArray[0].mId); // inbox + mMockClock.advance(1000L); + mManager.touch(mMailboxArray[1].mId); // drafts + mMockClock.advance(1000L); + mManager.touch(mMailboxArray[2].mId); // outbox + mMockClock.advance(1000L); + mManager.touch(mMailboxArray[3].mId); // sent + mMockClock.advance(1000L); + mManager.touch(mMailboxArray[4].mId).get(); // trash + mMockClock.advance(1000L); + + // nothing but system mailboxes + testList = mManager.getMostRecent(1L, false); + assertEquals(5, testList.size()); + assertEquals(mMailboxArray[1].mId, (long) testList.get(0)); + assertEquals(mMailboxArray[0].mId, (long) testList.get(1)); + assertEquals(mMailboxArray[2].mId, (long) testList.get(2)); + assertEquals(mMailboxArray[3].mId, (long) testList.get(3)); + assertEquals(mMailboxArray[4].mId, (long) testList.get(4)); + testList = mManager.getMostRecent(1L, true); + assertEquals(0, testList.size()); + } +}