mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2012 Google Inc. |
| 3 | * Licensed to The Android Open Source Project. |
| 4 | * |
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | * you may not use this file except in compliance with the License. |
| 7 | * You may obtain a copy of the License at |
| 8 | * |
| 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | * |
| 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | * See the License for the specific language governing permissions and |
| 15 | * limitations under the License. |
| 16 | */ |
| 17 | |
| 18 | package com.android.mail.ui; |
| 19 | |
| 20 | import android.app.Activity; |
| 21 | import android.app.Fragment; |
| 22 | import android.app.LoaderManager; |
| 23 | import android.content.Context; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 24 | import android.content.Loader; |
| 25 | import android.database.Cursor; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 26 | import android.net.Uri; |
| 27 | import android.os.Bundle; |
mindyp | ff282d0 | 2012-09-17 10:33:02 -0700 | [diff] [blame] | 28 | import android.os.Handler; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 29 | import android.view.Menu; |
| 30 | import android.view.MenuInflater; |
| 31 | import android.view.MenuItem; |
| 32 | |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 33 | import com.android.mail.R; |
Andy Huang | 8f18778 | 2012-11-06 17:49:25 -0800 | [diff] [blame] | 34 | import com.android.mail.browse.ConversationAccountController; |
Andrew Sapperstein | 8812d3c | 2013-06-04 17:06:41 -0700 | [diff] [blame] | 35 | import com.android.mail.browse.ConversationMessage; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 36 | import com.android.mail.browse.ConversationViewHeader.ConversationViewHeaderCallbacks; |
Andy Huang | 9d3fd92 | 2012-09-26 22:23:58 -0700 | [diff] [blame] | 37 | import com.android.mail.browse.MessageCursor; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 38 | import com.android.mail.browse.MessageCursor.ConversationController; |
Paul Westbrook | c42ad5e | 2013-05-09 16:52:15 -0700 | [diff] [blame] | 39 | import com.android.mail.content.ObjectCursor; |
| 40 | import com.android.mail.content.ObjectCursorLoader; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 41 | import com.android.mail.providers.Account; |
| 42 | import com.android.mail.providers.AccountObserver; |
| 43 | import com.android.mail.providers.Address; |
| 44 | import com.android.mail.providers.Conversation; |
| 45 | import com.android.mail.providers.Folder; |
| 46 | import com.android.mail.providers.ListParams; |
| 47 | import com.android.mail.providers.UIProvider; |
Vikram Aggarwal | a91d00b | 2013-01-18 12:00:37 -0800 | [diff] [blame] | 48 | import com.android.mail.providers.UIProvider.CursorStatus; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 49 | import com.android.mail.utils.LogTag; |
| 50 | import com.android.mail.utils.LogUtils; |
| 51 | import com.android.mail.utils.Utils; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 52 | |
Paul Westbrook | 4d8cad5 | 2012-09-21 14:13:49 -0700 | [diff] [blame] | 53 | import java.util.Arrays; |
Andy Huang | 543e709 | 2013-04-22 11:44:56 -0700 | [diff] [blame] | 54 | import java.util.Collections; |
| 55 | import java.util.HashMap; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 56 | import java.util.Map; |
Andrew Sapperstein | 376294b | 2013-06-06 16:04:26 -0700 | [diff] [blame] | 57 | |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 58 | |
| 59 | public abstract class AbstractConversationViewFragment extends Fragment implements |
Andrew Sapperstein | 4ddda2f | 2013-06-10 11:15:38 -0700 | [diff] [blame] | 60 | ConversationController, ConversationAccountController, |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 61 | ConversationViewHeaderCallbacks { |
| 62 | |
| 63 | private static final String ARG_ACCOUNT = "account"; |
| 64 | public static final String ARG_CONVERSATION = "conversation"; |
| 65 | private static final String ARG_FOLDER = "folder"; |
| 66 | private static final String LOG_TAG = LogTag.getLogTag(); |
| 67 | protected static final int MESSAGE_LOADER = 0; |
| 68 | protected static final int CONTACT_LOADER = 1; |
| 69 | protected ControllableActivity mActivity; |
| 70 | private final MessageLoaderCallbacks mMessageLoaderCallbacks = new MessageLoaderCallbacks(); |
Andrew Sapperstein | 376294b | 2013-06-06 16:04:26 -0700 | [diff] [blame] | 71 | private ContactLoaderCallbacks mContactLoaderCallbacks; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 72 | private MenuItem mChangeFoldersMenuItem; |
| 73 | protected Conversation mConversation; |
| 74 | protected Folder mFolder; |
| 75 | protected String mBaseUri; |
| 76 | protected Account mAccount; |
Andrew Sapperstein | 376294b | 2013-06-06 16:04:26 -0700 | [diff] [blame] | 77 | |
| 78 | /** |
| 79 | * Must be instantiated in a derived class's onCreate. |
| 80 | */ |
| 81 | protected AbstractConversationWebViewClient mWebViewClient; |
Andrew Sapperstein | 4ddda2f | 2013-06-10 11:15:38 -0700 | [diff] [blame] | 82 | |
Andy Huang | 543e709 | 2013-04-22 11:44:56 -0700 | [diff] [blame] | 83 | /** |
| 84 | * Cache of email address strings to parsed Address objects. |
| 85 | * <p> |
| 86 | * Remember to synchronize on the map when reading or writing to this cache, because some |
| 87 | * instances use it off the UI thread (e.g. from WebView). |
| 88 | */ |
| 89 | protected final Map<String, Address> mAddressCache = Collections.synchronizedMap( |
| 90 | new HashMap<String, Address>()); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 91 | private MessageCursor mCursor; |
| 92 | private Context mContext; |
Andy Huang | 9d3fd92 | 2012-09-26 22:23:58 -0700 | [diff] [blame] | 93 | /** |
| 94 | * A backwards-compatible version of {{@link #getUserVisibleHint()}. Like the framework flag, |
| 95 | * this flag is saved and restored. |
| 96 | */ |
| 97 | private boolean mUserVisible; |
Andrew Sapperstein | 376294b | 2013-06-06 16:04:26 -0700 | [diff] [blame] | 98 | |
mindyp | ff282d0 | 2012-09-17 10:33:02 -0700 | [diff] [blame] | 99 | private final Handler mHandler = new Handler(); |
Vikram Aggarwal | d82a31f | 2013-02-05 15:03:00 -0800 | [diff] [blame] | 100 | /** True if we want to avoid marking the conversation as viewed and read. */ |
| 101 | private boolean mSuppressMarkingViewed; |
Paul Westbrook | 4d8cad5 | 2012-09-21 14:13:49 -0700 | [diff] [blame] | 102 | /** |
| 103 | * Parcelable state of the conversation view. Can safely be used without null checking any time |
Andy Huang | 9d3fd92 | 2012-09-26 22:23:58 -0700 | [diff] [blame] | 104 | * after {@link #onCreate(Bundle)}. |
Paul Westbrook | 4d8cad5 | 2012-09-21 14:13:49 -0700 | [diff] [blame] | 105 | */ |
| 106 | protected ConversationViewState mViewState; |
| 107 | |
Scott Kennedy | 1817678 | 2013-02-20 18:30:21 -0800 | [diff] [blame] | 108 | private boolean mIsDetached; |
| 109 | |
Andrew Sapperstein | 2fc6730 | 2013-04-29 18:24:56 -0700 | [diff] [blame] | 110 | private boolean mHasConversationBeenTransformed; |
| 111 | private boolean mHasConversationTransformBeenReverted; |
| 112 | |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 113 | private final AccountObserver mAccountObserver = new AccountObserver() { |
| 114 | @Override |
| 115 | public void onChanged(Account newAccount) { |
Andy Huang | adbf3e8 | 2012-10-13 13:30:19 -0700 | [diff] [blame] | 116 | final Account oldAccount = mAccount; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 117 | mAccount = newAccount; |
Andrew Sapperstein | 376294b | 2013-06-06 16:04:26 -0700 | [diff] [blame] | 118 | mWebViewClient.setAccount(mAccount); |
Andy Huang | adbf3e8 | 2012-10-13 13:30:19 -0700 | [diff] [blame] | 119 | onAccountChanged(newAccount, oldAccount); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 120 | } |
| 121 | }; |
| 122 | |
Andy Huang | 9d3fd92 | 2012-09-26 22:23:58 -0700 | [diff] [blame] | 123 | private static final String BUNDLE_VIEW_STATE = |
| 124 | AbstractConversationViewFragment.class.getName() + "viewstate"; |
Andy Huang | 9a8bc1e | 2012-10-23 19:48:25 -0700 | [diff] [blame] | 125 | /** |
| 126 | * We save the user visible flag so the various transitions that occur during rotation do not |
| 127 | * cause unnecessary visibility change. |
| 128 | */ |
Andy Huang | 9d3fd92 | 2012-09-26 22:23:58 -0700 | [diff] [blame] | 129 | private static final String BUNDLE_USER_VISIBLE = |
| 130 | AbstractConversationViewFragment.class.getName() + "uservisible"; |
| 131 | |
Scott Kennedy | 1817678 | 2013-02-20 18:30:21 -0800 | [diff] [blame] | 132 | private static final String BUNDLE_DETACHED = |
| 133 | AbstractConversationViewFragment.class.getName() + "detached"; |
| 134 | |
Andrew Sapperstein | 2fc6730 | 2013-04-29 18:24:56 -0700 | [diff] [blame] | 135 | private static final String BUNDLE_KEY_HAS_CONVERSATION_BEEN_TRANSFORMED = |
| 136 | AbstractConversationViewFragment.class.getName() + "conversationtransformed"; |
| 137 | private static final String BUNDLE_KEY_HAS_CONVERSATION_BEEN_REVERTED = |
| 138 | AbstractConversationViewFragment.class.getName() + "conversationreverted"; |
| 139 | |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 140 | public static Bundle makeBasicArgs(Account account, Folder folder) { |
| 141 | Bundle args = new Bundle(); |
| 142 | args.putParcelable(ARG_ACCOUNT, account); |
| 143 | args.putParcelable(ARG_FOLDER, folder); |
| 144 | return args; |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Constructor needs to be public to handle orientation changes and activity |
| 149 | * lifecycle events. |
| 150 | */ |
| 151 | public AbstractConversationViewFragment() { |
| 152 | super(); |
| 153 | } |
| 154 | |
| 155 | /** |
| 156 | * Subclasses must override, since this depends on how many messages are |
| 157 | * shown in the conversation view. |
| 158 | */ |
Vikram Aggarwal | d82a31f | 2013-02-05 15:03:00 -0800 | [diff] [blame] | 159 | protected void markUnread() { |
| 160 | // Do not automatically mark this conversation viewed and read. |
| 161 | mSuppressMarkingViewed = true; |
| 162 | } |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 163 | |
| 164 | /** |
| 165 | * Subclasses must override this, since they may want to display a single or |
| 166 | * many messages related to this conversation. |
| 167 | */ |
Paul Westbrook | c42ad5e | 2013-05-09 16:52:15 -0700 | [diff] [blame] | 168 | protected abstract void onMessageCursorLoadFinished( |
| 169 | Loader<ObjectCursor<ConversationMessage>> loader, |
Andy Huang | 014ea4c | 2012-09-25 14:50:54 -0700 | [diff] [blame] | 170 | MessageCursor newCursor, MessageCursor oldCursor); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 171 | |
| 172 | /** |
| 173 | * Subclasses must override this, since they may want to display a single or |
| 174 | * many messages related to this conversation. |
| 175 | */ |
| 176 | @Override |
| 177 | public abstract void onConversationViewHeaderHeightChange(int newHeight); |
| 178 | |
| 179 | public abstract void onUserVisibleHintChanged(); |
| 180 | |
| 181 | /** |
| 182 | * Subclasses must override this. |
| 183 | */ |
Andy Huang | adbf3e8 | 2012-10-13 13:30:19 -0700 | [diff] [blame] | 184 | protected abstract void onAccountChanged(Account newAccount, Account oldAccount); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 185 | |
| 186 | @Override |
| 187 | public void onCreate(Bundle savedState) { |
| 188 | super.onCreate(savedState); |
| 189 | |
| 190 | final Bundle args = getArguments(); |
| 191 | mAccount = args.getParcelable(ARG_ACCOUNT); |
| 192 | mConversation = args.getParcelable(ARG_CONVERSATION); |
| 193 | mFolder = args.getParcelable(ARG_FOLDER); |
Paul Westbrook | ba4cce6 | 2012-09-28 10:24:20 -0700 | [diff] [blame] | 194 | |
| 195 | // Since the uri specified in the conversation base uri may not be unique, we specify a |
| 196 | // base uri that us guaranteed to be unique for this conversation. |
| 197 | mBaseUri = "x-thread://" + mAccount.name + "/" + mConversation.id; |
| 198 | |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 199 | LogUtils.d(LOG_TAG, "onCreate in ConversationViewFragment (this=%s)", this); |
| 200 | // Not really, we just want to get a crack to store a reference to the change_folder item |
| 201 | setHasOptionsMenu(true); |
Andy Huang | 9d3fd92 | 2012-09-26 22:23:58 -0700 | [diff] [blame] | 202 | |
| 203 | if (savedState != null) { |
| 204 | mViewState = savedState.getParcelable(BUNDLE_VIEW_STATE); |
| 205 | mUserVisible = savedState.getBoolean(BUNDLE_USER_VISIBLE); |
Scott Kennedy | 1817678 | 2013-02-20 18:30:21 -0800 | [diff] [blame] | 206 | mIsDetached = savedState.getBoolean(BUNDLE_DETACHED, false); |
Andrew Sapperstein | 2fc6730 | 2013-04-29 18:24:56 -0700 | [diff] [blame] | 207 | mHasConversationBeenTransformed = |
| 208 | savedState.getBoolean(BUNDLE_KEY_HAS_CONVERSATION_BEEN_TRANSFORMED, false); |
| 209 | mHasConversationTransformBeenReverted = |
| 210 | savedState.getBoolean(BUNDLE_KEY_HAS_CONVERSATION_BEEN_REVERTED, false); |
Andy Huang | 9d3fd92 | 2012-09-26 22:23:58 -0700 | [diff] [blame] | 211 | } else { |
| 212 | mViewState = getNewViewState(); |
Andrew Sapperstein | 2fc6730 | 2013-04-29 18:24:56 -0700 | [diff] [blame] | 213 | mHasConversationBeenTransformed = false; |
| 214 | mHasConversationTransformBeenReverted = false; |
Andy Huang | 9d3fd92 | 2012-09-26 22:23:58 -0700 | [diff] [blame] | 215 | } |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 216 | } |
| 217 | |
Andy Huang | 9e4ca79 | 2013-02-28 14:33:43 -0800 | [diff] [blame] | 218 | @Override |
| 219 | public String toString() { |
| 220 | // log extra info at DEBUG level or finer |
| 221 | final String s = super.toString(); |
| 222 | if (!LogUtils.isLoggable(LOG_TAG, LogUtils.DEBUG) || mConversation == null) { |
| 223 | return s; |
| 224 | } |
| 225 | return "(" + s + " conv=" + mConversation + ")"; |
| 226 | } |
| 227 | |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 228 | @Override |
| 229 | public void onActivityCreated(Bundle savedInstanceState) { |
| 230 | super.onActivityCreated(savedInstanceState); |
Vikram Aggarwal | 8fe8ed4 | 2012-09-18 11:40:08 -0700 | [diff] [blame] | 231 | final Activity activity = getActivity(); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 232 | if (!(activity instanceof ControllableActivity)) { |
| 233 | LogUtils.wtf(LOG_TAG, "ConversationViewFragment expects only a ControllableActivity to" |
| 234 | + "create it. Cannot proceed."); |
| 235 | } |
Vikram Aggarwal | 8fe8ed4 | 2012-09-18 11:40:08 -0700 | [diff] [blame] | 236 | if (activity == null || activity.isFinishing()) { |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 237 | // Activity is finishing, just bail. |
| 238 | return; |
| 239 | } |
Vikram Aggarwal | 8fe8ed4 | 2012-09-18 11:40:08 -0700 | [diff] [blame] | 240 | mActivity = (ControllableActivity) activity; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 241 | mContext = activity.getApplicationContext(); |
Andy Huang | b622d2b | 2013-06-12 13:47:17 -0700 | [diff] [blame] | 242 | mWebViewClient.setActivity(activity); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 243 | mAccount = mAccountObserver.initialize(mActivity.getAccountController()); |
Andrew Sapperstein | 376294b | 2013-06-06 16:04:26 -0700 | [diff] [blame] | 244 | mWebViewClient.setAccount(mAccount); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 245 | } |
| 246 | |
| 247 | @Override |
| 248 | public ConversationUpdater getListController() { |
| 249 | final ControllableActivity activity = (ControllableActivity) getActivity(); |
| 250 | return activity != null ? activity.getConversationUpdater() : null; |
| 251 | } |
| 252 | |
| 253 | public Context getContext() { |
| 254 | return mContext; |
| 255 | } |
| 256 | |
Andy Huang | 02133aa | 2012-11-08 19:50:57 -0800 | [diff] [blame] | 257 | @Override |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 258 | public Conversation getConversation() { |
| 259 | return mConversation; |
| 260 | } |
| 261 | |
| 262 | @Override |
| 263 | public MessageCursor getMessageCursor() { |
| 264 | return mCursor; |
| 265 | } |
| 266 | |
mindyp | ff282d0 | 2012-09-17 10:33:02 -0700 | [diff] [blame] | 267 | public Handler getHandler() { |
| 268 | return mHandler; |
| 269 | } |
| 270 | |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 271 | public MessageLoaderCallbacks getMessageLoaderCallbacks() { |
| 272 | return mMessageLoaderCallbacks; |
| 273 | } |
| 274 | |
| 275 | public ContactLoaderCallbacks getContactInfoSource() { |
Andrew Sapperstein | 376294b | 2013-06-06 16:04:26 -0700 | [diff] [blame] | 276 | if (mContactLoaderCallbacks == null) { |
| 277 | mContactLoaderCallbacks = new ContactLoaderCallbacks(mActivity.getActivityContext()); |
| 278 | } |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 279 | return mContactLoaderCallbacks; |
| 280 | } |
| 281 | |
| 282 | @Override |
| 283 | public Account getAccount() { |
| 284 | return mAccount; |
| 285 | } |
| 286 | |
| 287 | @Override |
| 288 | public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) { |
| 289 | super.onCreateOptionsMenu(menu, inflater); |
| 290 | mChangeFoldersMenuItem = menu.findItem(R.id.change_folder); |
| 291 | } |
| 292 | |
| 293 | @Override |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 294 | public boolean onOptionsItemSelected(MenuItem item) { |
Andy Huang | bb9dd6b | 2013-02-28 17:13:54 -0800 | [diff] [blame] | 295 | if (!isUserVisible()) { |
| 296 | // Unclear how this is happening. Current theory is that this fragment was scheduled |
| 297 | // to be removed, but the remove transaction failed. When the Activity is later |
| 298 | // restored, the FragmentManager restores this fragment, but Fragment.mMenuVisible is |
| 299 | // stuck at its initial value (true), which makes this zombie fragment eligible for |
| 300 | // menu item clicks. |
| 301 | // |
| 302 | // Work around this by relying on the (properly restored) extra user visible hint. |
| 303 | LogUtils.e(LOG_TAG, |
| 304 | "ACVF ignoring onOptionsItemSelected b/c userVisibleHint is false. f=%s", this); |
| 305 | if (LogUtils.isLoggable(LOG_TAG, LogUtils.DEBUG)) { |
Scott Kennedy | b184bfe | 2013-05-25 21:29:22 -0700 | [diff] [blame] | 306 | LogUtils.e(LOG_TAG, Utils.dumpFragment(this)); // the dump has '%' chars in it... |
Andy Huang | bb9dd6b | 2013-02-28 17:13:54 -0800 | [diff] [blame] | 307 | } |
| 308 | return false; |
| 309 | } |
| 310 | |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 311 | boolean handled = false; |
| 312 | switch (item.getItemId()) { |
| 313 | case R.id.inside_conversation_unread: |
| 314 | markUnread(); |
| 315 | handled = true; |
| 316 | break; |
Andrew Sapperstein | 2fc6730 | 2013-04-29 18:24:56 -0700 | [diff] [blame] | 317 | case R.id.show_original: |
| 318 | showUntransformedConversation(); |
| 319 | handled = true; |
| 320 | break; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 321 | } |
| 322 | return handled; |
| 323 | } |
| 324 | |
Andrew Sapperstein | 2fc6730 | 2013-04-29 18:24:56 -0700 | [diff] [blame] | 325 | @Override |
| 326 | public void onPrepareOptionsMenu(Menu menu) { |
| 327 | // Only show option if we support message transforms and message has been transformed. |
| 328 | Utils.setMenuItemVisibility(menu, R.id.show_original, supportsMessageTransforms() && |
| 329 | mHasConversationBeenTransformed && !mHasConversationTransformBeenReverted); |
| 330 | } |
| 331 | |
Andrew Sapperstein | 4ddda2f | 2013-06-10 11:15:38 -0700 | [diff] [blame] | 332 | abstract boolean supportsMessageTransforms(); |
| 333 | |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 334 | // BEGIN conversation header callbacks |
| 335 | @Override |
| 336 | public void onFoldersClicked() { |
| 337 | if (mChangeFoldersMenuItem == null) { |
| 338 | LogUtils.e(LOG_TAG, "unable to open 'change folders' dialog for a conversation"); |
| 339 | return; |
| 340 | } |
| 341 | mActivity.onOptionsItemSelected(mChangeFoldersMenuItem); |
| 342 | } |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 343 | // END conversation header callbacks |
| 344 | |
| 345 | @Override |
Andy Huang | 9d3fd92 | 2012-09-26 22:23:58 -0700 | [diff] [blame] | 346 | public void onSaveInstanceState(Bundle outState) { |
| 347 | if (mViewState != null) { |
| 348 | outState.putParcelable(BUNDLE_VIEW_STATE, mViewState); |
| 349 | } |
| 350 | outState.putBoolean(BUNDLE_USER_VISIBLE, mUserVisible); |
Scott Kennedy | 1817678 | 2013-02-20 18:30:21 -0800 | [diff] [blame] | 351 | outState.putBoolean(BUNDLE_DETACHED, mIsDetached); |
Andrew Sapperstein | 2fc6730 | 2013-04-29 18:24:56 -0700 | [diff] [blame] | 352 | outState.putBoolean(BUNDLE_KEY_HAS_CONVERSATION_BEEN_TRANSFORMED, |
| 353 | mHasConversationBeenTransformed); |
| 354 | outState.putBoolean(BUNDLE_KEY_HAS_CONVERSATION_BEEN_REVERTED, |
| 355 | mHasConversationTransformBeenReverted); |
Andy Huang | 9d3fd92 | 2012-09-26 22:23:58 -0700 | [diff] [blame] | 356 | } |
| 357 | |
| 358 | @Override |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 359 | public void onDestroyView() { |
| 360 | super.onDestroyView(); |
| 361 | mAccountObserver.unregisterAndDestroy(); |
| 362 | } |
| 363 | |
| 364 | /** |
| 365 | * {@link #setUserVisibleHint(boolean)} only works on API >= 15, so implement our own for |
| 366 | * reliability on older platforms. |
| 367 | */ |
| 368 | public void setExtraUserVisibleHint(boolean isVisibleToUser) { |
| 369 | LogUtils.v(LOG_TAG, "in CVF.setHint, val=%s (%s)", isVisibleToUser, this); |
| 370 | if (mUserVisible != isVisibleToUser) { |
| 371 | mUserVisible = isVisibleToUser; |
mindyp | bc4142f | 2012-09-19 09:29:49 -0700 | [diff] [blame] | 372 | MessageCursor cursor = getMessageCursor(); |
mindyp | 0b9b48c | 2012-09-19 10:00:51 -0700 | [diff] [blame] | 373 | if (mUserVisible && (cursor != null && cursor.isLoaded() && cursor.getCount() == 0)) { |
mindyp | bc4142f | 2012-09-19 09:29:49 -0700 | [diff] [blame] | 374 | // Pop back to conversation list and show error. |
| 375 | onError(); |
| 376 | return; |
| 377 | } |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 378 | onUserVisibleHintChanged(); |
| 379 | } |
| 380 | } |
| 381 | |
Andy Huang | 9d3fd92 | 2012-09-26 22:23:58 -0700 | [diff] [blame] | 382 | public boolean isUserVisible() { |
| 383 | return mUserVisible; |
| 384 | } |
| 385 | |
Andy Huang | 243c236 | 2013-03-01 17:50:35 -0800 | [diff] [blame] | 386 | protected void timerMark(String msg) { |
| 387 | if (isUserVisible()) { |
| 388 | Utils.sConvLoadTimer.mark(msg); |
| 389 | } |
| 390 | } |
| 391 | |
Paul Westbrook | c42ad5e | 2013-05-09 16:52:15 -0700 | [diff] [blame] | 392 | private class MessageLoaderCallbacks |
| 393 | implements LoaderManager.LoaderCallbacks<ObjectCursor<ConversationMessage>> { |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 394 | |
| 395 | @Override |
Paul Westbrook | c42ad5e | 2013-05-09 16:52:15 -0700 | [diff] [blame] | 396 | public Loader<ObjectCursor<ConversationMessage>> onCreateLoader(int id, Bundle args) { |
Andy Huang | 02133aa | 2012-11-08 19:50:57 -0800 | [diff] [blame] | 397 | return new MessageLoader(mActivity.getActivityContext(), mConversation.messageListUri); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 398 | } |
| 399 | |
| 400 | @Override |
Paul Westbrook | c42ad5e | 2013-05-09 16:52:15 -0700 | [diff] [blame] | 401 | public void onLoadFinished(Loader<ObjectCursor<ConversationMessage>> loader, |
| 402 | ObjectCursor<ConversationMessage> data) { |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 403 | // ignore truly duplicate results |
| 404 | // this can happen when restoring after rotation |
| 405 | if (mCursor == data) { |
| 406 | return; |
| 407 | } else { |
Andy Huang | 6766b6e | 2012-09-28 12:43:52 -0700 | [diff] [blame] | 408 | final MessageCursor messageCursor = (MessageCursor) data; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 409 | |
Andy Huang | 02133aa | 2012-11-08 19:50:57 -0800 | [diff] [blame] | 410 | // bind the cursor to this fragment so it can access to the current list controller |
| 411 | messageCursor.setController(AbstractConversationViewFragment.this); |
| 412 | |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 413 | if (LogUtils.isLoggable(LOG_TAG, LogUtils.DEBUG)) { |
| 414 | LogUtils.d(LOG_TAG, "LOADED CONVERSATION= %s", messageCursor.getDebugDump()); |
| 415 | } |
| 416 | |
Vikram Aggarwal | a91d00b | 2013-01-18 12:00:37 -0800 | [diff] [blame] | 417 | // We have no messages: exit conversation view. |
| 418 | if (messageCursor.getCount() == 0 |
Scott Kennedy | 1817678 | 2013-02-20 18:30:21 -0800 | [diff] [blame] | 419 | && (!CursorStatus.isWaitingForResults(messageCursor.getStatus()) |
| 420 | || mIsDetached)) { |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 421 | if (mUserVisible) { |
mindyp | bc4142f | 2012-09-19 09:29:49 -0700 | [diff] [blame] | 422 | onError(); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 423 | } else { |
| 424 | // we expect that the pager adapter will remove this |
| 425 | // conversation fragment on its own due to a separate |
| 426 | // conversation cursor update (we might get here if the |
| 427 | // message list update fires first. nothing to do |
| 428 | // because we expect to be torn down soon.) |
| 429 | LogUtils.i(LOG_TAG, "CVF: offscreen conv has no messages, ignoring update" |
Paul Westbrook | c42ad5e | 2013-05-09 16:52:15 -0700 | [diff] [blame] | 430 | + " in anticipation of conv cursor update. c=%s", |
| 431 | mConversation.uri); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 432 | } |
Andy Huang | 233d435 | 2012-10-18 14:00:24 -0700 | [diff] [blame] | 433 | // existing mCursor will imminently be closed, must stop referencing it |
| 434 | // since we expect to be kicked out soon, it doesn't matter what mCursor |
| 435 | // becomes |
| 436 | mCursor = null; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 437 | return; |
| 438 | } |
| 439 | |
| 440 | // ignore cursors that are still loading results |
| 441 | if (!messageCursor.isLoaded()) { |
Andy Huang | 233d435 | 2012-10-18 14:00:24 -0700 | [diff] [blame] | 442 | // existing mCursor will imminently be closed, must stop referencing it |
| 443 | // in this case, the new cursor is also no good, and since don't expect to get |
| 444 | // here except in initial load situations, it's safest to just ensure the |
| 445 | // reference is null |
| 446 | mCursor = null; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 447 | return; |
| 448 | } |
Andy Huang | 014ea4c | 2012-09-25 14:50:54 -0700 | [diff] [blame] | 449 | final MessageCursor oldCursor = mCursor; |
Andy Huang | 6766b6e | 2012-09-28 12:43:52 -0700 | [diff] [blame] | 450 | mCursor = messageCursor; |
Andy Huang | 014ea4c | 2012-09-25 14:50:54 -0700 | [diff] [blame] | 451 | onMessageCursorLoadFinished(loader, mCursor, oldCursor); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 452 | } |
| 453 | } |
| 454 | |
| 455 | @Override |
Paul Westbrook | c42ad5e | 2013-05-09 16:52:15 -0700 | [diff] [blame] | 456 | public void onLoaderReset(Loader<ObjectCursor<ConversationMessage>> loader) { |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 457 | mCursor = null; |
| 458 | } |
| 459 | |
| 460 | } |
| 461 | |
mindyp | bc4142f | 2012-09-19 09:29:49 -0700 | [diff] [blame] | 462 | private void onError() { |
| 463 | // need to exit this view- conversation may have been |
| 464 | // deleted, or for whatever reason is now invalid (e.g. |
| 465 | // discard single draft) |
| 466 | // |
| 467 | // N.B. this may involve a fragment transaction, which |
| 468 | // FragmentManager will refuse to execute directly |
| 469 | // within onLoadFinished. Make sure the controller knows. |
| 470 | LogUtils.i(LOG_TAG, "CVF: visible conv has no messages, exiting conv mode"); |
| 471 | // TODO(mindyp): handle ERROR status by showing an error |
| 472 | // message to the user that there are no messages in |
| 473 | // this conversation |
Scott Kennedy | 1817678 | 2013-02-20 18:30:21 -0800 | [diff] [blame] | 474 | popOut(); |
| 475 | } |
mindyp | bc4142f | 2012-09-19 09:29:49 -0700 | [diff] [blame] | 476 | |
Scott Kennedy | 1817678 | 2013-02-20 18:30:21 -0800 | [diff] [blame] | 477 | private void popOut() { |
Andrew Sapperstein | 376294b | 2013-06-06 16:04:26 -0700 | [diff] [blame] | 478 | mHandler.post(new FragmentRunnable("popOut", this) { |
mindyp | bc4142f | 2012-09-19 09:29:49 -0700 | [diff] [blame] | 479 | @Override |
Andy Huang | 9a8bc1e | 2012-10-23 19:48:25 -0700 | [diff] [blame] | 480 | public void go() { |
Alice Yang | 7729a9a | 2013-05-23 18:09:09 -0700 | [diff] [blame] | 481 | if (mActivity != null) { |
| 482 | mActivity.getListHandler() |
| 483 | .onConversationSelected(null, true /* inLoaderCallbacks */); |
| 484 | } |
mindyp | bc4142f | 2012-09-19 09:29:49 -0700 | [diff] [blame] | 485 | } |
mindyp | bc4142f | 2012-09-19 09:29:49 -0700 | [diff] [blame] | 486 | }); |
| 487 | } |
| 488 | |
Paul Westbrook | 4d8cad5 | 2012-09-21 14:13:49 -0700 | [diff] [blame] | 489 | protected void onConversationSeen() { |
Scott Kennedy | 919d01a | 2013-05-07 16:13:29 -0700 | [diff] [blame] | 490 | LogUtils.d(LOG_TAG, "AbstractConversationViewFragment#onConversationSeen()"); |
| 491 | |
Paul Westbrook | 4d8cad5 | 2012-09-21 14:13:49 -0700 | [diff] [blame] | 492 | // Ignore unsafe calls made after a fragment is detached from an activity |
| 493 | final ControllableActivity activity = (ControllableActivity) getActivity(); |
| 494 | if (activity == null) { |
| 495 | LogUtils.w(LOG_TAG, "ignoring onConversationSeen for conv=%s", mConversation.id); |
| 496 | return; |
| 497 | } |
| 498 | |
| 499 | mViewState.setInfoForConversation(mConversation); |
| 500 | |
Scott Kennedy | 919d01a | 2013-05-07 16:13:29 -0700 | [diff] [blame] | 501 | LogUtils.d(LOG_TAG, "onConversationSeen() - mSuppressMarkingViewed = %b", |
| 502 | mSuppressMarkingViewed); |
Vikram Aggarwal | d82a31f | 2013-02-05 15:03:00 -0800 | [diff] [blame] | 503 | // In most circumstances we want to mark the conversation as viewed and read, since the |
| 504 | // user has read it. However, if the user has already marked the conversation unread, we |
| 505 | // do not want a later mark-read operation to undo this. So we check this variable which |
| 506 | // is set in #markUnread() which suppresses automatic mark-read. |
| 507 | if (!mSuppressMarkingViewed) { |
| 508 | // mark viewed/read if not previously marked viewed by this conversation view, |
| 509 | // or if unread messages still exist in the message list cursor |
| 510 | // we don't want to keep marking viewed on rotation or restore |
| 511 | // but we do want future re-renders to mark read (e.g. "New message from X" case) |
Paul Westbrook | 2145229 | 2013-04-15 18:51:07 -0700 | [diff] [blame] | 512 | final MessageCursor cursor = getMessageCursor(); |
Scott Kennedy | 919d01a | 2013-05-07 16:13:29 -0700 | [diff] [blame] | 513 | LogUtils.d(LOG_TAG, "onConversationSeen() - mConversation.isViewed() = %b, " |
| 514 | + "cursor null = %b, cursor.isConversationRead() = %b", |
| 515 | mConversation.isViewed(), cursor == null, |
| 516 | cursor != null && cursor.isConversationRead()); |
Vikram Aggarwal | d82a31f | 2013-02-05 15:03:00 -0800 | [diff] [blame] | 517 | if (!mConversation.isViewed() || (cursor != null && !cursor.isConversationRead())) { |
| 518 | // Mark the conversation viewed and read. |
| 519 | activity.getConversationUpdater() |
| 520 | .markConversationsRead(Arrays.asList(mConversation), true, true); |
Yu Ping Hu | 7c909c7 | 2013-01-18 11:58:01 -0800 | [diff] [blame] | 521 | |
Vikram Aggarwal | d82a31f | 2013-02-05 15:03:00 -0800 | [diff] [blame] | 522 | // and update the Message objects in the cursor so the next time a cursor update |
| 523 | // happens with these messages marked read, we know to ignore it |
Paul Westbrook | 2145229 | 2013-04-15 18:51:07 -0700 | [diff] [blame] | 524 | if (cursor != null && !cursor.isClosed()) { |
Vikram Aggarwal | d82a31f | 2013-02-05 15:03:00 -0800 | [diff] [blame] | 525 | cursor.markMessagesRead(); |
| 526 | } |
Paul Westbrook | 4d8cad5 | 2012-09-21 14:13:49 -0700 | [diff] [blame] | 527 | } |
| 528 | } |
Scott Kennedy | 3b965d7 | 2013-06-25 14:36:55 -0700 | [diff] [blame^] | 529 | activity.getListHandler().onConversationSeen(); |
Paul Westbrook | 4d8cad5 | 2012-09-21 14:13:49 -0700 | [diff] [blame] | 530 | } |
| 531 | |
Paul Westbrook | 4d8cad5 | 2012-09-21 14:13:49 -0700 | [diff] [blame] | 532 | protected ConversationViewState getNewViewState() { |
| 533 | return new ConversationViewState(); |
| 534 | } |
| 535 | |
Paul Westbrook | c42ad5e | 2013-05-09 16:52:15 -0700 | [diff] [blame] | 536 | private static class MessageLoader extends ObjectCursorLoader<ConversationMessage> { |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 537 | private boolean mDeliveredFirstResults = false; |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 538 | |
Andy Huang | 02133aa | 2012-11-08 19:50:57 -0800 | [diff] [blame] | 539 | public MessageLoader(Context c, Uri messageListUri) { |
Paul Westbrook | c42ad5e | 2013-05-09 16:52:15 -0700 | [diff] [blame] | 540 | super(c, messageListUri, UIProvider.MESSAGE_PROJECTION, ConversationMessage.FACTORY); |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 541 | } |
| 542 | |
| 543 | @Override |
Paul Westbrook | c42ad5e | 2013-05-09 16:52:15 -0700 | [diff] [blame] | 544 | public void deliverResult(ObjectCursor<ConversationMessage> result) { |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 545 | // We want to deliver these results, and then we want to make sure |
| 546 | // that any subsequent |
| 547 | // queries do not hit the network |
| 548 | super.deliverResult(result); |
| 549 | |
| 550 | if (!mDeliveredFirstResults) { |
| 551 | mDeliveredFirstResults = true; |
| 552 | Uri uri = getUri(); |
| 553 | |
| 554 | // Create a ListParams that tells the provider to not hit the |
| 555 | // network |
| 556 | final ListParams listParams = new ListParams(ListParams.NO_LIMIT, |
| 557 | false /* useNetwork */); |
| 558 | |
| 559 | // Build the new uri with this additional parameter |
| 560 | uri = uri |
| 561 | .buildUpon() |
| 562 | .appendQueryParameter(UIProvider.LIST_PARAMS_QUERY_PARAMETER, |
| 563 | listParams.serialize()).build(); |
| 564 | setUri(uri); |
| 565 | } |
| 566 | } |
Paul Westbrook | c42ad5e | 2013-05-09 16:52:15 -0700 | [diff] [blame] | 567 | |
| 568 | @Override |
| 569 | protected ObjectCursor<ConversationMessage> getObjectCursor(Cursor inner) { |
| 570 | return new MessageCursor(inner); |
| 571 | } |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 572 | } |
| 573 | |
mindyp | 26d4d2d | 2012-09-18 17:30:32 -0700 | [diff] [blame] | 574 | public abstract void onConversationUpdated(Conversation conversation); |
| 575 | |
Scott Kennedy | 1817678 | 2013-02-20 18:30:21 -0800 | [diff] [blame] | 576 | public void onDetachedModeEntered() { |
| 577 | // If we have no messages, then we have nothing to display, so leave this view. |
| 578 | // Otherwise, just set the detached flag. |
| 579 | final Cursor messageCursor = getMessageCursor(); |
| 580 | |
| 581 | if (messageCursor == null || messageCursor.getCount() == 0) { |
| 582 | popOut(); |
| 583 | } else { |
| 584 | mIsDetached = true; |
| 585 | } |
| 586 | } |
Andrew Sapperstein | 2fc6730 | 2013-04-29 18:24:56 -0700 | [diff] [blame] | 587 | |
| 588 | /** |
| 589 | * Called when the JavaScript reports that it transformed a message. |
| 590 | * Sets a flag to true and invalidates the options menu so it will |
| 591 | * include the "Revert auto-sizing" menu option. |
| 592 | */ |
| 593 | public void onConversationTransformed() { |
| 594 | mHasConversationBeenTransformed = true; |
Andrew Sapperstein | 376294b | 2013-06-06 16:04:26 -0700 | [diff] [blame] | 595 | mHandler.post(new FragmentRunnable("invalidateOptionsMenu", this) { |
Andrew Sapperstein | ae92e15 | 2013-05-03 13:55:18 -0700 | [diff] [blame] | 596 | @Override |
| 597 | public void go() { |
| 598 | mActivity.invalidateOptionsMenu(); |
| 599 | } |
| 600 | }); |
Andrew Sapperstein | 2fc6730 | 2013-04-29 18:24:56 -0700 | [diff] [blame] | 601 | } |
| 602 | |
| 603 | /** |
| 604 | * Called when the "Revert auto-sizing" option is selected. Default |
| 605 | * implementation simply sets a value on whether transforms should be |
| 606 | * applied. Derived classes should override this class and force a |
| 607 | * re-render so that the conversation renders without |
| 608 | */ |
| 609 | public void showUntransformedConversation() { |
| 610 | // must set the value to true so we don't show the options menu item again |
| 611 | mHasConversationTransformBeenReverted = true; |
| 612 | } |
| 613 | |
| 614 | /** |
| 615 | * Returns {@code true} if the conversation should be transformed. {@code false}, otherwise. |
| 616 | * @return {@code true} if the conversation should be transformed. {@code false}, otherwise. |
| 617 | */ |
| 618 | public boolean shouldApplyTransforms() { |
Alice Yang | 3617b41 | 2013-05-10 00:30:07 -0700 | [diff] [blame] | 619 | return (mAccount.enableMessageTransforms > 0) && |
| 620 | !mHasConversationTransformBeenReverted; |
Andrew Sapperstein | 2fc6730 | 2013-04-29 18:24:56 -0700 | [diff] [blame] | 621 | } |
mindyp | f4fce12 | 2012-09-14 15:55:33 -0700 | [diff] [blame] | 622 | } |