/*
 * Copyright (C) 2015 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.calllogcache;

import android.content.Context;
import android.support.annotation.Nullable;
import android.telecom.PhoneAccountHandle;
import com.android.dialer.app.calllog.CallLogAdapter;
import com.android.dialer.util.CallUtil;

/**
 * This is the base class for the CallLogCaches.
 *
 * <p>Keeps a cache of recently made queries to the Telecom/Telephony processes. The aim of this
 * cache is to reduce the number of cross-process requests to TelecomManager, which can negatively
 * affect performance.
 *
 * <p>This is designed with the specific use case of the {@link CallLogAdapter} in mind.
 */
public abstract class CallLogCache {
  // TODO: Dialer should be fixed so as not to check isVoicemail() so often but at the time of
  // this writing, that was a much larger undertaking than creating this cache.

  protected final Context mContext;

  private boolean mHasCheckedForVideoAvailability;
  private int mVideoAvailability;

  public CallLogCache(Context context) {
    mContext = context;
  }

  /** Return the most compatible version of the TelecomCallLogCache. */
  public static CallLogCache getCallLogCache(Context context) {
    return new CallLogCacheLollipopMr1(context);
  }

  public void reset() {
    mHasCheckedForVideoAvailability = false;
    mVideoAvailability = 0;
  }

  /**
   * Returns true if the given number is the number of the configured voicemail. To be able to
   * mock-out this, it is not a static method.
   */
  public abstract boolean isVoicemailNumber(
      PhoneAccountHandle accountHandle, @Nullable CharSequence number);

  /**
   * Returns {@code true} when the current sim supports checking video calling capabilities via the
   * {@link android.provider.ContactsContract.CommonDataKinds.Phone#CARRIER_PRESENCE} column.
   */
  public boolean canRelyOnVideoPresence() {
    if (!mHasCheckedForVideoAvailability) {
      mVideoAvailability = CallUtil.getVideoCallingAvailability(mContext);
      mHasCheckedForVideoAvailability = true;
    }
    return (mVideoAvailability & CallUtil.VIDEO_CALLING_PRESENCE) != 0;
  }

  /** Extract account label from PhoneAccount object. */
  public abstract String getAccountLabel(PhoneAccountHandle accountHandle);

  /** Extract account color from PhoneAccount object. */
  public abstract int getAccountColor(PhoneAccountHandle accountHandle);

  /**
   * Determines if the PhoneAccount supports specifying a call subject (i.e. calling with a note)
   * for outgoing calls.
   *
   * @param accountHandle The PhoneAccount handle.
   * @return {@code true} if calling with a note is supported, {@code false} otherwise.
   */
  public abstract boolean doesAccountSupportCallSubject(PhoneAccountHandle accountHandle);
}