app/calllog/CallLogListItemHelper.java

/*
 * 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.dialer.app.calllog;

import android.content.res.Resources;
import android.provider.CallLog.Calls;
import android.support.annotation.WorkerThread;
import android.text.SpannableStringBuilder;
import android.text.TextUtils;
import com.android.dialer.app.R;
import com.android.dialer.app.calllog.calllogcache.CallLogCache;
import com.android.dialer.calllogutils.PhoneCallDetails;
import com.android.dialer.common.Assert;
import com.android.dialer.common.LogUtil;
import com.android.dialer.compat.AppCompatConstants;

/** Helper class to fill in the views of a call log entry. */
/* package */ class CallLogListItemHelper {

  /** Helper for populating the details of a phone call. */
  private final PhoneCallDetailsHelper mPhoneCallDetailsHelper;
  /** Resources to look up strings. */
  private final Resources mResources;

  private final CallLogCache mCallLogCache;

  /**
   * Creates a new helper instance.
   *
   * @param phoneCallDetailsHelper used to set the details of a phone call
   * @param resources The object from which resources can be retrieved
   * @param callLogCache A cache for values retrieved from telecom/telephony
   */
  public CallLogListItemHelper(
      PhoneCallDetailsHelper phoneCallDetailsHelper,
      Resources resources,
      CallLogCache callLogCache) {
    mPhoneCallDetailsHelper = phoneCallDetailsHelper;
    mResources = resources;
    mCallLogCache = callLogCache;
  }

  /**
   * Update phone call details. This is called before any drawing to avoid expensive operation on UI
   * thread.
   *
   * @param details
   */
  @WorkerThread
  public void updatePhoneCallDetails(PhoneCallDetails details) {
    Assert.isWorkerThread();
    details.callLocationAndDate = mPhoneCallDetailsHelper.getCallLocationAndDate(details);
    details.callDescription = getCallDescription(details);
  }

  /**
   * Sets the name, label, and number for a contact.
   *
   * @param views the views to populate
   * @param details the details of a phone call needed to fill in the data
   */
  public void setPhoneCallDetails(CallLogListItemViewHolder views, PhoneCallDetails details) {
    mPhoneCallDetailsHelper.setPhoneCallDetails(views.phoneCallDetailsViews, details);

    // Set the accessibility text for the contact badge
    views.quickContactView.setContentDescription(getContactBadgeDescription(details));

    // Set the primary action accessibility description
    views.primaryActionView.setContentDescription(details.callDescription);

    // Cache name or number of caller.  Used when setting the content descriptions of buttons
    // when the actions ViewStub is inflated.
    views.nameOrNumber = getNameOrNumber(details);

    // The call type or Location associated with the call. Use when setting text for a
    // voicemail log's call button
    views.callTypeOrLocation = mPhoneCallDetailsHelper.getCallTypeOrLocation(details);

    // Cache country iso. Used for number filtering.
    views.countryIso = details.countryIso;

    views.updatePhoto();
  }

  /**
   * Sets the accessibility descriptions for the action buttons in the action button ViewStub.
   *
   * @param views The views associated with the current call log entry.
   */
  public void setActionContentDescriptions(CallLogListItemViewHolder views) {
    if (views.nameOrNumber == null) {
      LogUtil.e(
          "CallLogListItemHelper.setActionContentDescriptions",
          "setActionContentDescriptions; name or number is null.");
    }

    // Calling expandTemplate with a null parameter will cause a NullPointerException.
    // Although we don't expect a null name or number, it is best to protect against it.
    CharSequence nameOrNumber = views.nameOrNumber == null ? "" : views.nameOrNumber;

    views.videoCallButtonView.setContentDescription(
        TextUtils.expandTemplate(
            mResources.getString(R.string.description_video_call_action), nameOrNumber));

    views.createNewContactButtonView.setContentDescription(
        TextUtils.expandTemplate(
            mResources.getString(R.string.description_create_new_contact_action), nameOrNumber));

    views.addToExistingContactButtonView.setContentDescription(
        TextUtils.expandTemplate(
            mResources.getString(R.string.description_add_to_existing_contact_action),
            nameOrNumber));

    views.detailsButtonView.setContentDescription(
        TextUtils.expandTemplate(
            mResources.getString(R.string.description_details_action), nameOrNumber));
  }

  /**
   * Returns the accessibility description for the contact badge for a call log entry.
   *
   * @param details Details of call.
   * @return Accessibility description.
   */
  private CharSequence getContactBadgeDescription(PhoneCallDetails details) {
    if (details.isSpam) {
      return mResources.getString(
          R.string.description_spam_contact_details, getNameOrNumber(details));
    }
    return mResources.getString(R.string.description_contact_details, getNameOrNumber(details));
  }

  /**
   * Returns the accessibility description of the "return call/call" action for a call log entry.
   * Accessibility text is a combination of: {Voicemail Prefix}. {Number of Calls}. {Caller
   * information} {Phone Account}. If most recent call is a voicemail, {Voicemail Prefix} is "New
   * Voicemail.", otherwise "".
   *
   * <p>If more than one call for the caller, {Number of Calls} is: "{number of calls} calls.",
   * otherwise "".
   *
   * <p>The {Caller Information} references the most recent call associated with the caller. For
   * incoming calls: If missed call: Missed call from {Name/Number} {Call Type} {Call Time}. If
   * answered call: Answered call from {Name/Number} {Call Type} {Call Time}.
   *
   * <p>For outgoing calls: If outgoing: Call to {Name/Number] {Call Type} {Call Time}.
   *
   * <p>Where: {Name/Number} is the name or number of the caller (as shown in call log). {Call type}
   * is the contact phone number type (eg mobile) or location. {Call Time} is the time since the
   * last call for the contact occurred.
   *
   * <p>The {Phone Account} refers to the account/SIM through which the call was placed or received
   * in multi-SIM devices.
   *
   * <p>Examples: 3 calls. New Voicemail. Missed call from Joe Smith mobile 2 hours ago on SIM 1.
   *
   * <p>2 calls. Answered call from John Doe mobile 1 hour ago.
   *
   * @param details Details of call.
   * @return Return call action description.
   */
  public CharSequence getCallDescription(PhoneCallDetails details) {
    // Get the name or number of the caller.
    final CharSequence nameOrNumber = getNameOrNumber(details);

    // Get the call type or location of the caller; null if not applicable
    final CharSequence typeOrLocation = mPhoneCallDetailsHelper.getCallTypeOrLocation(details);

    // Get the time/date of the call
    final CharSequence timeOfCall = mPhoneCallDetailsHelper.getCallDate(details);

    SpannableStringBuilder callDescription = new SpannableStringBuilder();

    // Add number of calls if more than one.
    if (details.callTypes.length > 1) {
      callDescription.append(
          mResources.getString(R.string.description_num_calls, details.callTypes.length));
    }

    // If call had video capabilities, add the "Video Call" string.
    if ((details.features & Calls.FEATURES_VIDEO) == Calls.FEATURES_VIDEO) {
      callDescription.append(mResources.getString(R.string.description_video_call));
    }

    String accountLabel = mCallLogCache.getAccountLabel(details.accountHandle);
    CharSequence onAccountLabel =
        PhoneCallDetails.createAccountLabelDescription(mResources, details.viaNumber, accountLabel);

    int stringID = getCallDescriptionStringID(details.callTypes, details.isRead);
    callDescription.append(
        TextUtils.expandTemplate(
            mResources.getString(stringID),
            nameOrNumber,
            typeOrLocation == null ? "" : typeOrLocation,
            timeOfCall,
            onAccountLabel));

    return callDescription;
  }

  /**
   * Determine the appropriate string ID to describe a call for accessibility purposes.
   *
   * @param callTypes The type of call corresponding to this entry or multiple if this entry
   *     represents multiple calls grouped together.
   * @param isRead If the entry is a voicemail, {@code true} if the voicemail is read.
   * @return String resource ID to use.
   */
  public int getCallDescriptionStringID(int[] callTypes, boolean isRead) {
    int lastCallType = getLastCallType(callTypes);
    int stringID;

    if (lastCallType == AppCompatConstants.CALLS_MISSED_TYPE) {
      //Message: Missed call from <NameOrNumber>, <TypeOrLocation>, <TimeOfCall>,
      //<PhoneAccount>.
      stringID = R.string.description_incoming_missed_call;
    } else if (lastCallType == AppCompatConstants.CALLS_INCOMING_TYPE) {
      //Message: Answered call from <NameOrNumber>, <TypeOrLocation>, <TimeOfCall>,
      //<PhoneAccount>.
      stringID = R.string.description_incoming_answered_call;
    } else if (lastCallType == AppCompatConstants.CALLS_VOICEMAIL_TYPE) {
      //Message: (Unread) [V/v]oicemail from <NameOrNumber>, <TypeOrLocation>, <TimeOfCall>,
      //<PhoneAccount>.
      stringID =
          isRead ? R.string.description_read_voicemail : R.string.description_unread_voicemail;
    } else {
      //Message: Call to <NameOrNumber>, <TypeOrLocation>, <TimeOfCall>, <PhoneAccount>.
      stringID = R.string.description_outgoing_call;
    }
    return stringID;
  }

  /**
   * Determine the call type for the most recent call.
   *
   * @param callTypes Call types to check.
   * @return Call type.
   */
  private int getLastCallType(int[] callTypes) {
    if (callTypes.length > 0) {
      return callTypes[0];
    } else {
      return Calls.MISSED_TYPE;
    }
  }

  /**
   * Return the name or number of the caller specified by the details.
   *
   * @param details Call details
   * @return the name (if known) of the caller, otherwise the formatted number.
   */
  private CharSequence getNameOrNumber(PhoneCallDetails details) {
    final CharSequence recipient;
    if (!TextUtils.isEmpty(details.getPreferredName())) {
      recipient = details.getPreferredName();
    } else {
      recipient = details.displayNumber;
    }
    return recipient;
  }
}