java/com/android/contacts/common/model/account/SamsungAccountType.java

/*
 * 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.contacts.common.model.account;

import android.content.ContentValues;
import android.content.Context;
import android.provider.ContactsContract.CommonDataKinds.Email;
import android.provider.ContactsContract.CommonDataKinds.Event;
import android.provider.ContactsContract.CommonDataKinds.Phone;
import android.provider.ContactsContract.CommonDataKinds.Relation;
import android.provider.ContactsContract.CommonDataKinds.StructuredPostal;
import com.android.contacts.common.model.dataitem.DataKind;
import com.android.contacts.common.util.CommonDateUtils;
import com.android.dialer.common.LogUtil;
import com.android.dialer.contacts.resources.R;
import java.util.ArrayList;
import java.util.Locale;

/**
 * A writable account type that can be used to support samsung contacts. This may not perfectly
 * match Samsung's latest intended account schema.
 *
 * <p>This is only used to partially support Samsung accounts. The DataKind labels & fields are
 * setup to support the values used by Samsung. But, not everything in the Samsung account type is
 * supported. The Samsung account type includes a "Message Type" mimetype that we have no intention
 * of showing inside the Contact editor. Similarly, we don't handle the "Ringtone" mimetype here
 * since managing ringtones is handled in a different flow.
 */
public class SamsungAccountType extends BaseAccountType {

  private static final String TAG = "KnownExternalAccountType";
  private static final String ACCOUNT_TYPE_SAMSUNG = "com.osp.app.signin";

  public SamsungAccountType(Context context, String authenticatorPackageName, String type) {
    this.accountType = type;
    this.resourcePackageName = null;
    this.syncAdapterPackageName = authenticatorPackageName;

    try {
      addDataKindStructuredName(context);
      addDataKindDisplayName(context);
      addDataKindPhoneticName(context);
      addDataKindNickname(context);
      addDataKindPhone(context);
      addDataKindEmail(context);
      addDataKindStructuredPostal(context);
      addDataKindIm(context);
      addDataKindOrganization(context);
      addDataKindPhoto(context);
      addDataKindNote(context);
      addDataKindWebsite(context);
      addDataKindGroupMembership(context);
      addDataKindRelation(context);
      addDataKindEvent(context);

      mIsInitialized = true;
    } catch (DefinitionException e) {
      LogUtil.e(TAG, "Problem building account type", e);
    }
  }

  /**
   * Returns {@code TRUE} if this is samsung's account type and Samsung hasn't bothered to define a
   * contacts.xml to provide a more accurate definition than ours.
   */
  public static boolean isSamsungAccountType(Context context, String type, String packageName) {
    return ACCOUNT_TYPE_SAMSUNG.equals(type)
        && !ExternalAccountType.hasContactsXml(context, packageName);
  }

  @Override
  protected DataKind addDataKindStructuredPostal(Context context) throws DefinitionException {
    final DataKind kind = super.addDataKindStructuredPostal(context);

    final boolean useJapaneseOrder =
        Locale.JAPANESE.getLanguage().equals(Locale.getDefault().getLanguage());
    kind.typeColumn = StructuredPostal.TYPE;
    kind.typeList = new ArrayList<>();
    kind.typeList.add(buildPostalType(StructuredPostal.TYPE_WORK).setSpecificMax(1));
    kind.typeList.add(buildPostalType(StructuredPostal.TYPE_HOME).setSpecificMax(1));
    kind.typeList.add(buildPostalType(StructuredPostal.TYPE_OTHER).setSpecificMax(1));

    kind.fieldList = new ArrayList<>();
    if (useJapaneseOrder) {
      kind.fieldList.add(
          new EditField(StructuredPostal.COUNTRY, R.string.postal_country, FLAGS_POSTAL)
              .setOptional(true));
      kind.fieldList.add(
          new EditField(StructuredPostal.POSTCODE, R.string.postal_postcode, FLAGS_POSTAL));
      kind.fieldList.add(
          new EditField(StructuredPostal.REGION, R.string.postal_region, FLAGS_POSTAL));
      kind.fieldList.add(new EditField(StructuredPostal.CITY, R.string.postal_city, FLAGS_POSTAL));
      kind.fieldList.add(
          new EditField(StructuredPostal.STREET, R.string.postal_street, FLAGS_POSTAL));
    } else {
      kind.fieldList.add(
          new EditField(StructuredPostal.STREET, R.string.postal_street, FLAGS_POSTAL));
      kind.fieldList.add(new EditField(StructuredPostal.CITY, R.string.postal_city, FLAGS_POSTAL));
      kind.fieldList.add(
          new EditField(StructuredPostal.REGION, R.string.postal_region, FLAGS_POSTAL));
      kind.fieldList.add(
          new EditField(StructuredPostal.POSTCODE, R.string.postal_postcode, FLAGS_POSTAL));
      kind.fieldList.add(
          new EditField(StructuredPostal.COUNTRY, R.string.postal_country, FLAGS_POSTAL)
              .setOptional(true));
    }

    return kind;
  }

  @Override
  protected DataKind addDataKindPhone(Context context) throws DefinitionException {
    final DataKind kind = super.addDataKindPhone(context);

    kind.typeColumn = Phone.TYPE;
    kind.typeList = new ArrayList<>();
    kind.typeList.add(buildPhoneType(Phone.TYPE_MOBILE));
    kind.typeList.add(buildPhoneType(Phone.TYPE_HOME));
    kind.typeList.add(buildPhoneType(Phone.TYPE_WORK));
    kind.typeList.add(buildPhoneType(Phone.TYPE_MAIN));
    kind.typeList.add(buildPhoneType(Phone.TYPE_FAX_WORK).setSecondary(true));
    kind.typeList.add(buildPhoneType(Phone.TYPE_FAX_HOME).setSecondary(true));
    kind.typeList.add(buildPhoneType(Phone.TYPE_PAGER).setSecondary(true));
    kind.typeList.add(buildPhoneType(Phone.TYPE_RADIO).setSecondary(true));
    kind.typeList.add(buildPhoneType(Phone.TYPE_OTHER));
    kind.typeList.add(
        buildPhoneType(Phone.TYPE_CUSTOM).setSecondary(true).setCustomColumn(Phone.LABEL));

    kind.fieldList = new ArrayList<>();
    kind.fieldList.add(new EditField(Phone.NUMBER, R.string.phoneLabelsGroup, FLAGS_PHONE));

    return kind;
  }

  @Override
  protected DataKind addDataKindEmail(Context context) throws DefinitionException {
    final DataKind kind = super.addDataKindEmail(context);

    kind.typeColumn = Email.TYPE;
    kind.typeList = new ArrayList<>();
    kind.typeList.add(buildEmailType(Email.TYPE_HOME));
    kind.typeList.add(buildEmailType(Email.TYPE_WORK));
    kind.typeList.add(buildEmailType(Email.TYPE_OTHER));
    kind.typeList.add(
        buildEmailType(Email.TYPE_CUSTOM).setSecondary(true).setCustomColumn(Email.LABEL));

    kind.fieldList = new ArrayList<>();
    kind.fieldList.add(new EditField(Email.DATA, R.string.emailLabelsGroup, FLAGS_EMAIL));

    return kind;
  }

  private DataKind addDataKindRelation(Context context) throws DefinitionException {
    DataKind kind =
        addKind(new DataKind(Relation.CONTENT_ITEM_TYPE, R.string.relationLabelsGroup, 160, true));
    kind.actionHeader = new RelationActionInflater();
    kind.actionBody = new SimpleInflater(Relation.NAME);

    kind.typeColumn = Relation.TYPE;
    kind.typeList = new ArrayList<>();
    kind.typeList.add(buildRelationType(Relation.TYPE_ASSISTANT));
    kind.typeList.add(buildRelationType(Relation.TYPE_BROTHER));
    kind.typeList.add(buildRelationType(Relation.TYPE_CHILD));
    kind.typeList.add(buildRelationType(Relation.TYPE_DOMESTIC_PARTNER));
    kind.typeList.add(buildRelationType(Relation.TYPE_FATHER));
    kind.typeList.add(buildRelationType(Relation.TYPE_FRIEND));
    kind.typeList.add(buildRelationType(Relation.TYPE_MANAGER));
    kind.typeList.add(buildRelationType(Relation.TYPE_MOTHER));
    kind.typeList.add(buildRelationType(Relation.TYPE_PARENT));
    kind.typeList.add(buildRelationType(Relation.TYPE_PARTNER));
    kind.typeList.add(buildRelationType(Relation.TYPE_REFERRED_BY));
    kind.typeList.add(buildRelationType(Relation.TYPE_RELATIVE));
    kind.typeList.add(buildRelationType(Relation.TYPE_SISTER));
    kind.typeList.add(buildRelationType(Relation.TYPE_SPOUSE));
    kind.typeList.add(
        buildRelationType(Relation.TYPE_CUSTOM).setSecondary(true).setCustomColumn(Relation.LABEL));

    kind.defaultValues = new ContentValues();
    kind.defaultValues.put(Relation.TYPE, Relation.TYPE_SPOUSE);

    kind.fieldList = new ArrayList<>();
    kind.fieldList.add(new EditField(Relation.DATA, R.string.relationLabelsGroup, FLAGS_RELATION));

    return kind;
  }

  private DataKind addDataKindEvent(Context context) throws DefinitionException {
    DataKind kind =
        addKind(new DataKind(Event.CONTENT_ITEM_TYPE, R.string.eventLabelsGroup, 150, true));
    kind.actionHeader = new EventActionInflater();
    kind.actionBody = new SimpleInflater(Event.START_DATE);

    kind.typeColumn = Event.TYPE;
    kind.typeList = new ArrayList<>();
    kind.dateFormatWithoutYear = CommonDateUtils.NO_YEAR_DATE_FORMAT;
    kind.dateFormatWithYear = CommonDateUtils.FULL_DATE_FORMAT;
    kind.typeList.add(buildEventType(Event.TYPE_BIRTHDAY, true).setSpecificMax(1));
    kind.typeList.add(buildEventType(Event.TYPE_ANNIVERSARY, false));
    kind.typeList.add(buildEventType(Event.TYPE_OTHER, false));
    kind.typeList.add(
        buildEventType(Event.TYPE_CUSTOM, false).setSecondary(true).setCustomColumn(Event.LABEL));

    kind.defaultValues = new ContentValues();
    kind.defaultValues.put(Event.TYPE, Event.TYPE_BIRTHDAY);

    kind.fieldList = new ArrayList<>();
    kind.fieldList.add(new EditField(Event.DATA, R.string.eventLabelsGroup, FLAGS_EVENT));

    return kind;
  }

  @Override
  public boolean isGroupMembershipEditable() {
    return true;
  }

  @Override
  public boolean areContactsWritable() {
    return true;
  }
}