/*
* Copyright (C) 2010 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.app.Activity;
import android.content.res.Resources;
import android.graphics.drawable.Drawable;
import android.os.Bundle;
import android.view.LayoutInflater;
import android.view.Menu;
import android.view.MenuInflater;
import android.view.MenuItem;
import android.view.View;
import android.view.ViewGroup;
import android.view.accessibility.AccessibilityEvent;
import android.widget.ImageView;
import android.widget.PopupMenu;
import android.widget.PopupMenu.OnMenuItemClickListener;
import com.android.email.Email;
import com.android.email.Preferences;
import com.android.email.R;
import com.android.emailcommon.mail.MeetingInfo;
import com.android.emailcommon.mail.PackedString;
import com.android.emailcommon.provider.Account;
import com.android.emailcommon.provider.EmailContent.Message;
import com.android.emailcommon.provider.Mailbox;
import com.android.emailcommon.service.EmailServiceConstants;
import com.android.emailcommon.utility.Utility;
/**
* A {@link MessageViewFragmentBase} subclass for regular email messages. (regular as in "not eml
* files").
*/
public class MessageViewFragment extends MessageViewFragmentBase
implements MoveMessageToDialog.Callback, OnMenuItemClickListener {
/** Argument name(s) */
private static final String ARG_MESSAGE_ID = "messageId";
private ImageView mFavoriteIcon;
private View mReplyButton;
private View mReplyAllButton;
/* Nullable - not available on phone portrait. */
private View mForwardButton;
private View mMoreButton;
// calendar meeting invite answers
private View mMeetingYes;
private View mMeetingMaybe;
private View mMeetingNo;
private Drawable mFavoriteIconOn;
private Drawable mFavoriteIconOff;
/** Default to ReplyAll if true. Otherwise Reply. */
boolean mDefaultReplyAll;
/** Whether or not to enable Reply/ReplyAll and Forward buttons */
boolean mEnableReplyForwardButtons;
/** Whether or not the message can be moved from the mailbox it's in. */
private boolean mSupportsMove;
private int mPreviousMeetingResponse = EmailServiceConstants.MEETING_REQUEST_NOT_RESPONDED;
/**
* This class has more call backs than {@link MessageViewFragmentBase}.
*
* - EML files can't be "mark unread".
* - EML files can't have the invite buttons or the view in calender link.
* Note EML files can have ICS (calendar invitation) files, but we don't treat them as
* invites. (Only exchange provider sets the FLAG_INCOMING_MEETING_INVITE
* flag.)
* It'd be weird to respond to an invitation in an EML that might not be addressed to you...
*/
public interface Callback extends MessageViewFragmentBase.Callback {
/** Called when the "view in calendar" link is clicked. */
public void onCalendarLinkClicked(long epochEventStartTime);
/**
* Called when a calender response button is clicked.
*
* @param response one of {@link EmailServiceConstants#MEETING_REQUEST_ACCEPTED},
* {@link EmailServiceConstants#MEETING_REQUEST_DECLINED}, or
* {@link EmailServiceConstants#MEETING_REQUEST_TENTATIVE}.
*/
public void onRespondedToInvite(int response);
/** Called when the current message is set unread. */
public void onMessageSetUnread();
/**
* Called right before the current message will be deleted or moved to another mailbox.
*
* Callees will usually close the fragment.
*/
public void onBeforeMessageGone();
/** Called when the forward button is pressed. */
public void onForward();
/** Called when the reply button is pressed. */
public void onReply();
/** Called when the reply-all button is pressed. */
public void onReplyAll();
}
public static final class EmptyCallback extends MessageViewFragmentBase.EmptyCallback
implements Callback {
@SuppressWarnings("hiding")
public static final Callback INSTANCE = new EmptyCallback();
@Override public void onCalendarLinkClicked(long epochEventStartTime) { }
@Override public void onMessageSetUnread() { }
@Override public void onRespondedToInvite(int response) { }
@Override public void onBeforeMessageGone() { }
@Override public void onForward() { }
@Override public void onReply() { }
@Override public void onReplyAll() { }
}
private Callback mCallback = EmptyCallback.INSTANCE;
/**
* Create a new instance with initialization parameters.
*
* This fragment should be created only with this method. (Arguments should always be set.)
*
* @param messageId ID of the message to open
*/
public static MessageViewFragment newInstance(long messageId) {
if (messageId == Message.NO_MESSAGE) {
throw new IllegalArgumentException();
}
final MessageViewFragment instance = new MessageViewFragment();
final Bundle args = new Bundle();
args.putLong(ARG_MESSAGE_ID, messageId);
instance.setArguments(args);
return instance;
}
/**
* We will display the message for this ID. This must never be a special message ID such as
* {@link Message#NO_MESSAGE}. Do NOT use directly; instead, use {@link #getMessageId()}.
* <p><em>NOTE:</em> Although we cannot force these to be immutable using Java language
* constructs, this <em>must</em> be considered immutable.
*/
private Long mImmutableMessageId;
private void initializeArgCache() {
if (mImmutableMessageId != null) return;
mImmutableMessageId = getArguments().getLong(ARG_MESSAGE_ID);
}
/**
* @return the message ID passed to {@link #newInstance}. Safe to call even before onCreate.
*/
public long getMessageId() {
initializeArgCache();
return mImmutableMessageId;
}
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setHasOptionsMenu(true);
final Resources res = getActivity().getResources();
mFavoriteIconOn = res.getDrawable(R.drawable.btn_star_on_convo_holo_light);
mFavoriteIconOff = res.getDrawable(R.drawable.btn_star_off_convo_holo_light);
}
@Override
public void onResume() {
super.onResume();
if (mMoreButton != null) {
mDefaultReplyAll = Preferences.getSharedPreferences(mContext).getBoolean(
Preferences.REPLY_ALL, Preferences.REPLY_ALL_DEFAULT);
int replyVisibility = View.GONE;
int replyAllVisibility = View.GONE;
if (mEnableReplyForwardButtons) {
replyVisibility = mDefaultReplyAll ? View.GONE : View.VISIBLE;
replyAllVisibility = mDefaultReplyAll ? View.VISIBLE : View.GONE;
}
mReplyButton.setVisibility(replyVisibility);
mReplyAllButton.setVisibility(replyAllVisibility);
}
}
@Override
public View onCreateView(
LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
final View view = super.onCreateView(inflater, container, savedInstanceState);
mFavoriteIcon = (ImageView) UiUtilities.getView(view, R.id.favorite);
mReplyButton = UiUtilities.getView(view, R.id.reply);
mReplyAllButton = UiUtilities.getView(view, R.id.reply_all);
mForwardButton = UiUtilities.getViewOrNull(view, R.id.forward);
mMeetingYes = UiUtilities.getView(view, R.id.accept);
mMeetingMaybe = UiUtilities.getView(view, R.id.maybe);
mMeetingNo = UiUtilities.getView(view, R.id.decline);
mMoreButton = UiUtilities.getViewOrNull(view, R.id.more);
mFavoriteIcon.setOnClickListener(this);
mReplyButton.setOnClickListener(this);
mReplyAllButton.setOnClickListener(this);
if (mMoreButton != null) {
mMoreButton.setOnClickListener(this);
}
if (mForwardButton != null) {
mForwardButton.setOnClickListener(this);
}
mMeetingYes.setOnClickListener(this);
mMeetingMaybe.setOnClickListener(this);
mMeetingNo.setOnClickListener(this);
UiUtilities.getView(view, R.id.invite_link).setOnClickListener(this);
enableReplyForwardButtons(false);
return view;
}
@Override
public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
inflater.inflate(R.menu.message_view_fragment_option, menu);
}
@Override
public void onPrepareOptionsMenu(Menu menu) {
menu.findItem(R.id.move).setVisible(mSupportsMove);
}
private void enableReplyForwardButtons(boolean enabled) {
mEnableReplyForwardButtons = enabled;
// We don't have disabled button assets, so let's hide them for now
final int visibility = enabled ? View.VISIBLE : View.GONE;
// Modify Reply All button only if there's no overflow OR there is
// overflow but default is to show the Reply All button
if (mMoreButton == null || mDefaultReplyAll) {
UiUtilities.setVisibilitySafe(mReplyAllButton, visibility);
}
// Modify Reply button only if there's no overflow OR there is
// overflow but default is to show the Reply button
if (mMoreButton == null || !mDefaultReplyAll) {
UiUtilities.setVisibilitySafe(mReplyButton, visibility);
}
if (mForwardButton != null) {
mForwardButton.setVisibility(visibility);
}
if (mMoreButton != null) {
mMoreButton.setVisibility(visibility);
}
}
public void setCallback(Callback callback) {
mCallback = (callback == null) ? EmptyCallback.INSTANCE : callback;
super.setCallback(mCallback);
}
@Override
protected void resetView() {
super.resetView();
mPreviousMeetingResponse = EmailServiceConstants.MEETING_REQUEST_NOT_RESPONDED;
}
/**
* NOTE See the comment on the super method. It's called on a worker thread.
*/
@Override
protected Message openMessageSync(Activity activity) {
return Message.restoreMessageWithId(activity, getMessageId());
}
@Override
protected void onMessageShown(long messageId, Mailbox mailbox) {
super.onMessageShown(messageId, mailbox);
Account account = Account.restoreAccountWithId(mContext, getAccountId());
boolean supportsMove = account.supportsMoveMessages(mContext)
&& mailbox.canHaveMessagesMoved();
if (mSupportsMove != supportsMove) {
mSupportsMove = supportsMove;
Activity host = getActivity();
if (host != null) {
host.invalidateOptionsMenu();
}
}
// Disable forward/reply buttons as necessary.
enableReplyForwardButtons(Mailbox.isMailboxTypeReplyAndForwardable(mailbox.mType));
}
/**
* Sets the content description for the star icon based on whether it's currently starred.
*/
private void setStarContentDescription(boolean isFavorite) {
if (isFavorite) {
mFavoriteIcon.setContentDescription(
mContext.getResources().getString(R.string.remove_star_action));
} else {
mFavoriteIcon.setContentDescription(
mContext.getResources().getString(R.string.set_star_action));
}
}
/**
* Toggle favorite status and write back to provider
*/
private void onClickFavorite() {
if (!isMessageOpen()) return;
Message message = getMessage();
// Update UI
boolean newFavorite = ! message.mFlagFavorite;
mFavoriteIcon.setImageDrawable(newFavorite ? mFavoriteIconOn : mFavoriteIconOff);
// Handle accessibility event
setStarContentDescription(newFavorite);
mFavoriteIcon.sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
// Update provider
message.mFlagFavorite = newFavorite;
getController().setMessageFavorite(message.mId, newFavorite);
}
/**
* Set message read/unread.
*/
public void onMarkMessageAsRead(boolean isRead) {
if (!isMessageOpen()) return;
Message message = getMessage();
if (message.mFlagRead != isRead) {
message.mFlagRead = isRead;
getController().setMessageRead(message.mId, isRead);
if (!isRead) { // Became unread. We need to close the message.
mCallback.onMessageSetUnread();
}
}
}
/**
* Send a service message indicating that a meeting invite button has been clicked.
*/
private void onRespondToInvite(int response, int toastResId) {
if (!isMessageOpen()) return;
Message message = getMessage();
// do not send twice in a row the same response
if (mPreviousMeetingResponse != response) {
getController().sendMeetingResponse(message.mId, response);
mPreviousMeetingResponse = response;
}
Utility.showToast(getActivity(), toastResId);
mCallback.onRespondedToInvite(response);
}
private void onInviteLinkClicked() {
if (!isMessageOpen()) return;
Message message = getMessage();
String startTime = new PackedString(message.mMeetingInfo).get(MeetingInfo.MEETING_DTSTART);
if (startTime != null) {
long epochTimeMillis = Utility.parseEmailDateTimeToMillis(startTime);
mCallback.onCalendarLinkClicked(epochTimeMillis);
} else {
Email.log("meetingInfo without DTSTART " + message.mMeetingInfo);
}
}
@Override
public void onClick(View view) {
if (!isMessageOpen()) {
return; // Ignore.
}
switch (view.getId()) {
case R.id.reply:
mCallback.onReply();
return;
case R.id.reply_all:
mCallback.onReplyAll();
return;
case R.id.forward:
mCallback.onForward();
return;
case R.id.favorite:
onClickFavorite();
return;
case R.id.invite_link:
onInviteLinkClicked();
return;
case R.id.accept:
onRespondToInvite(EmailServiceConstants.MEETING_REQUEST_ACCEPTED,
R.string.message_view_invite_toast_yes);
return;
case R.id.maybe:
onRespondToInvite(EmailServiceConstants.MEETING_REQUEST_TENTATIVE,
R.string.message_view_invite_toast_maybe);
return;
case R.id.decline:
onRespondToInvite(EmailServiceConstants.MEETING_REQUEST_DECLINED,
R.string.message_view_invite_toast_no);
return;
case R.id.more: {
PopupMenu popup = new PopupMenu(getActivity(), mMoreButton);
Menu menu = popup.getMenu();
popup.getMenuInflater().inflate(R.menu.message_header_overflow_menu,
menu);
// Remove Reply if ReplyAll icon is visible or vice versa
menu.removeItem(mDefaultReplyAll ? R.id.reply_all : R.id.reply);
popup.setOnMenuItemClickListener(this);
popup.show();
break;
}
}
super.onClick(view);
}
@Override
public boolean onMenuItemClick(MenuItem item) {
if (isMessageOpen()) {
switch (item.getItemId()) {
case R.id.reply:
mCallback.onReply();
return true;
case R.id.reply_all:
mCallback.onReplyAll();
return true;
case R.id.forward:
mCallback.onForward();
return true;
}
}
return false;
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
case R.id.move:
onMove();
return true;
case R.id.delete:
onDelete();
return true;
case R.id.mark_as_unread:
onMarkAsUnread();
return true;
}
return super.onOptionsItemSelected(item);
}
private void onMove() {
MoveMessageToDialog dialog = MoveMessageToDialog.newInstance(new long[] {getMessageId()},
this);
dialog.show(getFragmentManager(), "dialog");
}
// MoveMessageToDialog$Callback
@Override
public void onMoveToMailboxSelected(long newMailboxId, long[] messageIds) {
mCallback.onBeforeMessageGone();
ActivityHelper.moveMessages(mContext, newMailboxId, messageIds);
}
private void onDelete() {
mCallback.onBeforeMessageGone();
ActivityHelper.deleteMessage(mContext, getMessageId());
}
private void onMarkAsUnread() {
onMarkMessageAsRead(false);
}
/**
* {@inheritDoc}
*
* Mark the current as unread.
*/
@Override
protected void onPostLoadBody() {
onMarkMessageAsRead(true);
// Initialize star content description for accessibility
Message message = getMessage();
setStarContentDescription(message.mFlagFavorite);
}
@Override
protected void updateHeaderView(Message message) {
super.updateHeaderView(message);
mFavoriteIcon.setImageDrawable(message.mFlagFavorite ? mFavoriteIconOn : mFavoriteIconOff);
// Enable the invite tab if necessary
if ((message.mFlags & Message.FLAG_INCOMING_MEETING_INVITE) != 0) {
addTabFlags(TAB_FLAGS_HAS_INVITE);
}
}
}