org.exfio.csyncdroid.resource.LocalAddressBook.java Source code

Java tutorial

Introduction

Here is the source code for org.exfio.csyncdroid.resource.LocalAddressBook.java

Source

/*
 * Copyright (C) 2015 Gerry Healy <nickel_chrome@exfio.org> and contributors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * This program is derived from DavDroid, Copyright (C) 2014 Richard Hirner, bitfire web engineering
 * DavDroid is distributed under the terms of the GNU Public License v3.0, https://github.com/bitfireAT/davdroid
 */
package org.exfio.csyncdroid.resource;

import java.io.IOException;
import java.io.InputStream;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Locale;
import java.util.Set;

import lombok.Cleanup;
import android.accounts.Account;
import android.content.ContentProviderClient;
import android.content.ContentProviderOperation;
import android.content.ContentProviderOperation.Builder;
import android.content.ContentUris;
import android.content.res.AssetFileDescriptor;
import android.database.Cursor;
import android.database.DatabaseUtils;
import android.net.Uri;
import android.os.RemoteException;
import android.provider.ContactsContract.CommonDataKinds;
import android.provider.ContactsContract.CommonDataKinds.Email;
import android.provider.ContactsContract.CommonDataKinds.Im;
import android.provider.ContactsContract.CommonDataKinds.Nickname;
import android.provider.ContactsContract.CommonDataKinds.Note;
import android.provider.ContactsContract.CommonDataKinds.Organization;
import android.provider.ContactsContract.CommonDataKinds.Phone;
import android.provider.ContactsContract.CommonDataKinds.Photo;
import android.provider.ContactsContract.CommonDataKinds.SipAddress;
import android.provider.ContactsContract.CommonDataKinds.StructuredName;
import android.provider.ContactsContract.CommonDataKinds.StructuredPostal;
import android.provider.ContactsContract.CommonDataKinds.Website;
import android.provider.ContactsContract.Data;
import android.provider.ContactsContract.RawContacts;
import android.util.Log;

import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.WordUtils;

import ezvcard.parameter.AddressType;
import ezvcard.parameter.EmailType;
import ezvcard.parameter.ImppType;
import ezvcard.parameter.TelephoneType;
import ezvcard.property.Address;
import ezvcard.property.Anniversary;
import ezvcard.property.Birthday;
import ezvcard.property.DateOrTimeProperty;
import ezvcard.property.Impp;
import ezvcard.property.Telephone;

import org.exfio.csyncdroid.syncadapter.AccountSettings;
import org.exfio.weave.util.SQLUtils;

public class LocalAddressBook extends LocalCollection<Contact> {
    private final static String TAG = "csyncdroid.LocalABook";

    protected final static String COLUMN_UNKNOWN_PROPERTIES = RawContacts.SYNC3;

    protected String contentAuthority = "com.android.contacts";

    protected AccountSettings accountSettings;

    /* database fields */

    @Override
    protected Uri entriesURI() {
        return syncAdapterURI(RawContacts.CONTENT_URI);
    }

    protected String entryColumnAccountType() {
        return RawContacts.ACCOUNT_TYPE;
    }

    protected String entryColumnAccountName() {
        return RawContacts.ACCOUNT_NAME;
    }

    protected String entryColumnParentID() {
        return null;
        /* maybe use RawContacts.DATA_SET some day? */ }

    protected String entryColumnID() {
        return RawContacts._ID;
    }

    protected String entryColumnRemoteId() {
        return RawContacts.SOURCE_ID;
    }

    protected String entryColumnETag() {
        return RawContacts.SYNC2;
    }

    protected String entryColumnDirty() {
        return RawContacts.DIRTY;
    }

    protected String entryColumnDeleted() {
        return RawContacts.DELETED;
    }

    protected String entryColumnUID() {
        return RawContacts.SYNC1;
    }

    protected String resourceToString(Resource resource) throws LocalStorageException {
        return "Contact:\nNOT YET IMPLEMENTED";
    }

    public LocalAddressBook(Account account, ContentProviderClient providerClient,
            AccountSettings accountSettings) {
        super(account, providerClient);
        this.accountSettings = accountSettings;
    }

    /* collection operations */

    @Override
    public long getId() {
        return -1;
    }

    @Override
    public Double getModifiedTime() {
        return accountSettings.getModifiedTime(contentAuthority);
    }

    @Override
    public void setModifiedTime(Double modified) {
        accountSettings.setModifiedTime(contentAuthority, modified);
    }

    /* create/update/delete */

    public Contact newResource(long localID, String resourceName, String eTag) {
        return new Contact(localID, resourceName, eTag);
    }

    public void deleteAllExceptRemoteIds(String[] preserveIds) {
        String where;

        if (preserveIds.length != 0) {
            where = entryColumnRemoteId() + " NOT IN (" + SQLUtils.quoteArray(preserveIds) + ")";
        } else
            where = entryColumnRemoteId() + " IS NOT NULL";

        Builder builder = ContentProviderOperation.newDelete(entriesURI()).withSelection(where, null);
        pendingOperations.add(builder.withYieldAllowed(true).build());
    }

    public void deleteAllExceptUIDs(String[] preserveUids) {
        String where;

        if (preserveUids.length != 0) {
            where = entryColumnUID() + " NOT IN (" + SQLUtils.quoteArray(preserveUids) + ")";
        } else
            where = entryColumnUID() + " IS NOT NULL";

        Builder builder = ContentProviderOperation.newDelete(entriesURI()).withSelection(where, null);
        pendingOperations.add(builder.withYieldAllowed(true).build());
    }

    /* methods for populating the data object from the content provider */

    @Override
    public void populate(Resource res) throws LocalStorageException {
        Contact c = (Contact) res;

        try {
            @Cleanup
            Cursor cursor = providerClient.query(ContentUris.withAppendedId(entriesURI(), c.getLocalID()),
                    new String[] { entryColumnUID(), COLUMN_UNKNOWN_PROPERTIES, RawContacts.STARRED }, null, null,
                    null);
            if (cursor != null && cursor.moveToNext()) {
                c.setUid(cursor.getString(0));
                c.setUnknownProperties(cursor.getString(1));
                c.setStarred(cursor.getInt(2) != 0);
            } else
                throw new RecordNotFoundException();

            populateStructuredName(c);
            populatePhoneNumbers(c);
            populateEmailAddresses(c);
            populatePhoto(c);
            populateOrganization(c);
            populateIMPPs(c);
            populateNickname(c);
            populateNote(c);
            populatePostalAddresses(c);
            populateURLs(c);
            populateEvents(c);
            populateSipAddress(c);
        } catch (RemoteException ex) {
            throw new LocalStorageException(ex);
        }
    }

    private void populateStructuredName(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(),
                new String[] { /* 0 */ StructuredName.DISPLAY_NAME, StructuredName.PREFIX,
                        StructuredName.GIVEN_NAME, /* 3 */ StructuredName.MIDDLE_NAME, StructuredName.FAMILY_NAME,
                        StructuredName.SUFFIX, /* 6 */ StructuredName.PHONETIC_GIVEN_NAME,
                        StructuredName.PHONETIC_MIDDLE_NAME, StructuredName.PHONETIC_FAMILY_NAME },
                StructuredName.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), StructuredName.CONTENT_ITEM_TYPE }, null);

        if (cursor != null && cursor.moveToNext()) {
            c.setDisplayName(cursor.getString(0));

            c.setPrefix(cursor.getString(1));
            c.setGivenName(cursor.getString(2));
            c.setMiddleName(cursor.getString(3));
            c.setFamilyName(cursor.getString(4));
            c.setSuffix(cursor.getString(5));

            c.setPhoneticGivenName(cursor.getString(6));
            c.setPhoneticMiddleName(cursor.getString(7));
            c.setPhoneticFamilyName(cursor.getString(8));
        }
    }

    protected void populatePhoneNumbers(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(),
                new String[] { Phone.TYPE, Phone.LABEL, Phone.NUMBER, Phone.IS_SUPER_PRIMARY },
                Phone.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), Phone.CONTENT_ITEM_TYPE }, null);
        while (cursor != null && cursor.moveToNext()) {
            ezvcard.property.Telephone number = new ezvcard.property.Telephone(cursor.getString(2));
            switch (cursor.getInt(0)) {
            case Phone.TYPE_HOME:
                number.addType(TelephoneType.HOME);
                break;
            case Phone.TYPE_MOBILE:
                number.addType(TelephoneType.CELL);
                break;
            case Phone.TYPE_WORK:
                number.addType(TelephoneType.WORK);
                break;
            case Phone.TYPE_FAX_WORK:
                number.addType(TelephoneType.FAX);
                number.addType(TelephoneType.WORK);
                break;
            case Phone.TYPE_FAX_HOME:
                number.addType(TelephoneType.FAX);
                number.addType(TelephoneType.HOME);
                break;
            case Phone.TYPE_PAGER:
                number.addType(TelephoneType.PAGER);
                break;
            case Phone.TYPE_CALLBACK:
                number.addType(Contact.PHONE_TYPE_CALLBACK);
                break;
            case Phone.TYPE_CAR:
                number.addType(TelephoneType.CAR);
                break;
            case Phone.TYPE_COMPANY_MAIN:
                number.addType(Contact.PHONE_TYPE_COMPANY_MAIN);
                break;
            case Phone.TYPE_ISDN:
                number.addType(TelephoneType.ISDN);
                break;
            case Phone.TYPE_MAIN:
                number.addType(TelephoneType.PREF);
                break;
            case Phone.TYPE_OTHER_FAX:
                number.addType(TelephoneType.FAX);
                break;
            case Phone.TYPE_RADIO:
                number.addType(Contact.PHONE_TYPE_RADIO);
                break;
            case Phone.TYPE_TELEX:
                number.addType(TelephoneType.TEXTPHONE);
                break;
            case Phone.TYPE_TTY_TDD:
                number.addType(TelephoneType.TEXT);
                break;
            case Phone.TYPE_WORK_MOBILE:
                number.addType(TelephoneType.CELL);
                number.addType(TelephoneType.WORK);
                break;
            case Phone.TYPE_WORK_PAGER:
                number.addType(TelephoneType.PAGER);
                number.addType(TelephoneType.WORK);
                break;
            case Phone.TYPE_ASSISTANT:
                number.addType(Contact.PHONE_TYPE_ASSISTANT);
                break;
            case Phone.TYPE_MMS:
                number.addType(Contact.PHONE_TYPE_MMS);
                break;
            case Phone.TYPE_CUSTOM:
                String customType = cursor.getString(1);
                if (!StringUtils.isEmpty(customType))
                    number.addType(TelephoneType.get(labelToXName(customType)));
            }
            if (cursor.getInt(3) != 0) // IS_PRIMARY
                number.addType(TelephoneType.PREF);
            c.getPhoneNumbers().add(number);
        }
    }

    protected void populateEmailAddresses(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(),
                new String[] { Email.TYPE, Email.ADDRESS, Email.LABEL, Email.IS_SUPER_PRIMARY },
                Email.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), Email.CONTENT_ITEM_TYPE }, null);
        while (cursor != null && cursor.moveToNext()) {
            ezvcard.property.Email email = new ezvcard.property.Email(cursor.getString(1));
            switch (cursor.getInt(0)) {
            case Email.TYPE_HOME:
                email.addType(EmailType.HOME);
                break;
            case Email.TYPE_WORK:
                email.addType(EmailType.WORK);
                break;
            case Email.TYPE_MOBILE:
                email.addType(Contact.EMAIL_TYPE_MOBILE);
                break;
            case Email.TYPE_CUSTOM:
                String customType = cursor.getString(2);
                if (!StringUtils.isEmpty(customType))
                    email.addType(EmailType.get(labelToXName(customType)));
            }
            if (cursor.getInt(3) != 0) // IS_PRIMARY
                email.addType(EmailType.PREF);
            c.getEmails().add(email);
        }
    }

    protected void populatePhoto(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(), new String[] { Photo.PHOTO_FILE_ID, Photo.PHOTO },
                Photo.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), Photo.CONTENT_ITEM_TYPE }, null);
        if (cursor != null && cursor.moveToNext()) {
            if (!cursor.isNull(0)) {
                Uri photoUri = Uri.withAppendedPath(
                        ContentUris.withAppendedId(RawContacts.CONTENT_URI, c.getLocalID()),
                        RawContacts.DisplayPhoto.CONTENT_DIRECTORY);
                try {
                    @Cleanup
                    AssetFileDescriptor fd = providerClient.openAssetFile(photoUri, "r");
                    @Cleanup
                    InputStream is = fd.createInputStream();
                    c.setPhoto(IOUtils.toByteArray(is));
                } catch (IOException ex) {
                    Log.w(TAG, "Couldn't read high-res contact photo", ex);
                }
            } else
                c.setPhoto(cursor.getBlob(1));
        }
    }

    protected void populateOrganization(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(),
                new String[] { Organization.COMPANY, Organization.DEPARTMENT, Organization.TITLE,
                        Organization.JOB_DESCRIPTION },
                Organization.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), Organization.CONTENT_ITEM_TYPE }, null);
        if (cursor != null && cursor.moveToNext()) {
            String company = cursor.getString(0), department = cursor.getString(1), title = cursor.getString(2),
                    role = cursor.getString(3);
            if (!StringUtils.isEmpty(company) || !StringUtils.isEmpty(department)) {
                ezvcard.property.Organization org = new ezvcard.property.Organization();
                if (!StringUtils.isEmpty(company))
                    org.addValue(company);
                if (!StringUtils.isEmpty(department))
                    org.addValue(department);
                c.setOrganization(org);
            }
            if (!StringUtils.isEmpty(title))
                c.setJobTitle(title);
            if (!StringUtils.isEmpty(role))
                c.setJobDescription(role);
        }
    }

    protected void populateIMPPs(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(),
                new String[] { Im.DATA, Im.TYPE, Im.LABEL, Im.PROTOCOL, Im.CUSTOM_PROTOCOL },
                Im.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), Im.CONTENT_ITEM_TYPE }, null);
        while (cursor != null && cursor.moveToNext()) {
            String handle = cursor.getString(0);

            Impp impp = null;
            switch (cursor.getInt(3)) {
            case Im.PROTOCOL_AIM:
                impp = Impp.aim(handle);
                break;
            case Im.PROTOCOL_MSN:
                impp = Impp.msn(handle);
                break;
            case Im.PROTOCOL_YAHOO:
                impp = Impp.yahoo(handle);
                break;
            case Im.PROTOCOL_SKYPE:
                impp = Impp.skype(handle);
                break;
            case Im.PROTOCOL_QQ:
                impp = new Impp("qq", handle);
                break;
            case Im.PROTOCOL_GOOGLE_TALK:
                impp = new Impp("google-talk", handle);
                break;
            case Im.PROTOCOL_ICQ:
                impp = Impp.icq(handle);
                break;
            case Im.PROTOCOL_JABBER:
                impp = Impp.xmpp(handle);
                break;
            case Im.PROTOCOL_NETMEETING:
                impp = new Impp("netmeeting", handle);
                break;
            case Im.PROTOCOL_CUSTOM:
                impp = new Impp(cursor.getString(4), handle);
            }

            if (impp != null) {
                switch (cursor.getInt(1)) {
                case Im.TYPE_HOME:
                    impp.addType(ImppType.HOME);
                    break;
                case Im.TYPE_WORK:
                    impp.addType(ImppType.WORK);
                    break;
                case Im.TYPE_CUSTOM:
                    String customType = cursor.getString(2);
                    if (!StringUtils.isEmpty(customType))
                        impp.addType(ImppType.get(labelToXName(customType)));
                }
                c.getImpps().add(impp);
            }
        }
    }

    protected void populateNickname(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(), new String[] { Nickname.NAME },
                Nickname.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), Nickname.CONTENT_ITEM_TYPE }, null);
        if (cursor != null && cursor.moveToNext())
            c.setNickName(cursor.getString(0));
    }

    protected void populateNote(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(), new String[] { Note.NOTE },
                Note.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), Note.CONTENT_ITEM_TYPE }, null);
        if (cursor != null && cursor.moveToNext())
            c.setNote(cursor.getString(0));
    }

    protected void populatePostalAddresses(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(),
                new String[] { /* 0 */ StructuredPostal.FORMATTED_ADDRESS, StructuredPostal.TYPE,
                        StructuredPostal.LABEL, /* 3 */ StructuredPostal.STREET, StructuredPostal.POBOX,
                        StructuredPostal.NEIGHBORHOOD, /* 6 */ StructuredPostal.CITY, StructuredPostal.REGION,
                        StructuredPostal.POSTCODE, /* 9 */ StructuredPostal.COUNTRY },
                StructuredPostal.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), StructuredPostal.CONTENT_ITEM_TYPE }, null);
        while (cursor != null && cursor.moveToNext()) {
            Address address = new Address();

            address.setLabel(cursor.getString(0));
            switch (cursor.getInt(1)) {
            case StructuredPostal.TYPE_HOME:
                address.addType(AddressType.HOME);
                break;
            case StructuredPostal.TYPE_WORK:
                address.addType(AddressType.WORK);
                break;
            case StructuredPostal.TYPE_CUSTOM:
                String customType = cursor.getString(2);
                if (!StringUtils.isEmpty(customType))
                    address.addType(AddressType.get(labelToXName(customType)));
                break;
            }
            address.setStreetAddress(cursor.getString(3));
            address.setPoBox(cursor.getString(4));
            address.setExtendedAddress(cursor.getString(5));
            address.setLocality(cursor.getString(6));
            address.setRegion(cursor.getString(7));
            address.setPostalCode(cursor.getString(8));
            address.setCountry(cursor.getString(9));
            c.getAddresses().add(address);
        }
    }

    protected void populateURLs(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(), new String[] { Website.URL },
                Website.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), Website.CONTENT_ITEM_TYPE }, null);
        while (cursor != null && cursor.moveToNext())
            c.getURLs().add(cursor.getString(0));
    }

    protected void populateEvents(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(),
                new String[] { CommonDataKinds.Event.TYPE, CommonDataKinds.Event.START_DATE },
                Photo.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), CommonDataKinds.Event.CONTENT_ITEM_TYPE }, null);
        while (cursor != null && cursor.moveToNext()) {
            SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd", Locale.US);
            try {
                Date date = formatter.parse(cursor.getString(1));
                switch (cursor.getInt(0)) {
                case CommonDataKinds.Event.TYPE_ANNIVERSARY:
                    c.setAnniversary(new Anniversary(date));
                    break;
                case CommonDataKinds.Event.TYPE_BIRTHDAY:
                    c.setBirthDay(new Birthday(date));
                    break;
                }
            } catch (ParseException e) {
                Log.w(TAG, "Couldn't parse local birthday/anniversary date", e);
            }
        }
    }

    protected void populateSipAddress(Contact c) throws RemoteException {
        @Cleanup
        Cursor cursor = providerClient.query(dataURI(),
                new String[] { SipAddress.SIP_ADDRESS, SipAddress.TYPE, SipAddress.LABEL },
                SipAddress.RAW_CONTACT_ID + "=? AND " + Data.MIMETYPE + "=?",
                new String[] { String.valueOf(c.getLocalID()), SipAddress.CONTENT_ITEM_TYPE }, null);
        if (cursor != null && cursor.moveToNext()) {
            Impp impp = new Impp("sip:" + cursor.getString(0));
            switch (cursor.getInt(1)) {
            case SipAddress.TYPE_HOME:
                impp.addType(ImppType.HOME);
                break;
            case SipAddress.TYPE_WORK:
                impp.addType(ImppType.WORK);
                break;
            case SipAddress.TYPE_CUSTOM:
                String customType = cursor.getString(2);
                if (!StringUtils.isEmpty(customType))
                    impp.addType(ImppType.get(labelToXName(customType)));
            }
            c.getImpps().add(impp);
        }
    }

    /* content builder methods */

    @Override
    protected Builder buildEntry(Builder builder, Resource resource) {
        Contact contact = (Contact) resource;

        return builder.withValue(RawContacts.ACCOUNT_NAME, account.name)
                .withValue(RawContacts.ACCOUNT_TYPE, account.type).withValue(entryColumnRemoteId(), contact.getId())
                .withValue(entryColumnUID(), contact.getUid()).withValue(entryColumnETag(), contact.getETag())
                .withValue(COLUMN_UNKNOWN_PROPERTIES, contact.getUnknownProperties())
                .withValue(RawContacts.STARRED, contact.isStarred());
    }

    @Override
    protected void addDataRows(Resource resource, long localID, int backrefIdx) {
        Contact contact = (Contact) resource;

        queueOperation(buildStructuredName(newDataInsertBuilder(localID, backrefIdx), contact));

        for (Telephone number : contact.getPhoneNumbers())
            queueOperation(buildPhoneNumber(newDataInsertBuilder(localID, backrefIdx), number));

        for (ezvcard.property.Email email : contact.getEmails())
            queueOperation(buildEmail(newDataInsertBuilder(localID, backrefIdx), email));

        if (contact.getPhoto() != null)
            queueOperation(buildPhoto(newDataInsertBuilder(localID, backrefIdx), contact.getPhoto()));

        queueOperation(buildOrganization(newDataInsertBuilder(localID, backrefIdx), contact));

        for (Impp impp : contact.getImpps())
            queueOperation(buildIMPP(newDataInsertBuilder(localID, backrefIdx), impp));

        if (contact.getNickName() != null)
            queueOperation(buildNickName(newDataInsertBuilder(localID, backrefIdx), contact.getNickName()));

        if (contact.getNote() != null)
            queueOperation(buildNote(newDataInsertBuilder(localID, backrefIdx), contact.getNote()));

        for (Address address : contact.getAddresses())
            queueOperation(buildAddress(newDataInsertBuilder(localID, backrefIdx), address));

        // TODO group membership

        for (String url : contact.getURLs())
            queueOperation(buildURL(newDataInsertBuilder(localID, backrefIdx), url));

        // events
        if (contact.getAnniversary() != null)
            queueOperation(buildEvent(newDataInsertBuilder(localID, backrefIdx), contact.getAnniversary(),
                    CommonDataKinds.Event.TYPE_ANNIVERSARY));
        if (contact.getBirthDay() != null)
            queueOperation(buildEvent(newDataInsertBuilder(localID, backrefIdx), contact.getBirthDay(),
                    CommonDataKinds.Event.TYPE_BIRTHDAY));

        // TODO relations

        // SIP addresses are built by buildIMPP
    }

    @Override
    protected void removeDataRows(Resource resource) {
        pendingOperations.add(ContentProviderOperation.newDelete(dataURI())
                .withSelection(Data.RAW_CONTACT_ID + "=?", new String[] { String.valueOf(resource.getLocalID()) })
                .build());
    }

    protected Builder buildStructuredName(Builder builder, Contact contact) {
        return builder.withValue(Data.MIMETYPE, StructuredName.CONTENT_ITEM_TYPE)
                .withValue(StructuredName.PREFIX, contact.getPrefix())
                .withValue(StructuredName.DISPLAY_NAME, contact.getDisplayName())
                .withValue(StructuredName.GIVEN_NAME, contact.getGivenName())
                .withValue(StructuredName.MIDDLE_NAME, contact.getMiddleName())
                .withValue(StructuredName.FAMILY_NAME, contact.getFamilyName())
                .withValue(StructuredName.SUFFIX, contact.getSuffix())
                .withValue(StructuredName.PHONETIC_GIVEN_NAME, contact.getPhoneticGivenName())
                .withValue(StructuredName.PHONETIC_MIDDLE_NAME, contact.getPhoneticMiddleName())
                .withValue(StructuredName.PHONETIC_FAMILY_NAME, contact.getPhoneticFamilyName());
    }

    protected Builder buildPhoneNumber(Builder builder, Telephone number) {
        int typeCode = Phone.TYPE_OTHER;
        String typeLabel = null;
        boolean is_primary = false;

        Set<TelephoneType> types = number.getTypes();
        // preferred number?
        if (types.contains(TelephoneType.PREF))
            is_primary = true;

        // 1 Android type <-> 2 VCard types: fax, cell, pager
        if (types.contains(TelephoneType.FAX)) {
            if (types.contains(TelephoneType.HOME))
                typeCode = Phone.TYPE_FAX_HOME;
            else if (types.contains(TelephoneType.WORK))
                typeCode = Phone.TYPE_FAX_WORK;
            else
                typeCode = Phone.TYPE_OTHER_FAX;
        } else if (types.contains(TelephoneType.CELL)) {
            if (types.contains(TelephoneType.WORK))
                typeCode = Phone.TYPE_WORK_MOBILE;
            else
                typeCode = Phone.TYPE_MOBILE;
        } else if (types.contains(TelephoneType.PAGER)) {
            if (types.contains(TelephoneType.WORK))
                typeCode = Phone.TYPE_WORK_PAGER;
            else
                typeCode = Phone.TYPE_PAGER;
            // types with 1:1 translation
        } else if (types.contains(TelephoneType.HOME)) {
            typeCode = Phone.TYPE_HOME;
        } else if (types.contains(TelephoneType.WORK)) {
            typeCode = Phone.TYPE_WORK;
        } else if (types.contains(Contact.PHONE_TYPE_CALLBACK)) {
            typeCode = Phone.TYPE_CALLBACK;
        } else if (types.contains(TelephoneType.CAR)) {
            typeCode = Phone.TYPE_CAR;
        } else if (types.contains(Contact.PHONE_TYPE_COMPANY_MAIN)) {
            typeCode = Phone.TYPE_COMPANY_MAIN;
        } else if (types.contains(TelephoneType.ISDN)) {
            typeCode = Phone.TYPE_ISDN;
        } else if (types.contains(TelephoneType.PREF)) {
            typeCode = Phone.TYPE_MAIN;
        } else if (types.contains(Contact.PHONE_TYPE_RADIO)) {
            typeCode = Phone.TYPE_RADIO;
        } else if (types.contains(TelephoneType.TEXTPHONE)) {
            typeCode = Phone.TYPE_TELEX;
        } else if (types.contains(TelephoneType.TEXT)) {
            typeCode = Phone.TYPE_TTY_TDD;
        } else if (types.contains(Contact.PHONE_TYPE_ASSISTANT)) {
            typeCode = Phone.TYPE_ASSISTANT;
        } else if (types.contains(Contact.PHONE_TYPE_MMS)) {
            typeCode = Phone.TYPE_MMS;
        } else if (!types.isEmpty()) {
            TelephoneType type = types.iterator().next();
            typeCode = Phone.TYPE_CUSTOM;
            typeLabel = xNameToLabel(type.getValue());
        }

        builder = builder.withValue(Data.MIMETYPE, Phone.CONTENT_ITEM_TYPE)
                .withValue(Phone.NUMBER, number.getText()).withValue(Phone.TYPE, typeCode)
                .withValue(Phone.IS_PRIMARY, is_primary ? 1 : 0)
                .withValue(Phone.IS_SUPER_PRIMARY, is_primary ? 1 : 0);
        if (typeLabel != null)
            builder = builder.withValue(Phone.LABEL, typeLabel);
        return builder;
    }

    protected Builder buildEmail(Builder builder, ezvcard.property.Email email) {
        int typeCode = 0;
        String typeLabel = null;
        boolean is_primary = false;

        for (EmailType type : email.getTypes())
            if (type == EmailType.PREF)
                is_primary = true;
            else if (type == EmailType.HOME)
                typeCode = Email.TYPE_HOME;
            else if (type == EmailType.WORK)
                typeCode = Email.TYPE_WORK;
            else if (type == Contact.EMAIL_TYPE_MOBILE)
                typeCode = Email.TYPE_MOBILE;
        if (typeCode == 0) {
            if (email.getTypes().isEmpty())
                typeCode = Email.TYPE_OTHER;
            else {
                typeCode = Email.TYPE_CUSTOM;
                typeLabel = xNameToLabel(email.getTypes().iterator().next().getValue());
            }
        }

        builder = builder.withValue(Data.MIMETYPE, Email.CONTENT_ITEM_TYPE)
                .withValue(Email.ADDRESS, email.getValue()).withValue(Email.TYPE, typeCode)
                .withValue(Email.IS_PRIMARY, is_primary ? 1 : 0)
                .withValue(Phone.IS_SUPER_PRIMARY, is_primary ? 1 : 0);
        ;
        if (typeLabel != null)
            builder = builder.withValue(Email.LABEL, typeLabel);
        return builder;
    }

    protected Builder buildPhoto(Builder builder, byte[] photo) {
        return builder.withValue(Data.MIMETYPE, Photo.CONTENT_ITEM_TYPE).withValue(Photo.PHOTO, photo);
    }

    protected Builder buildOrganization(Builder builder, Contact contact) {
        if (contact.getOrganization() == null && contact.getJobTitle() == null
                && contact.getJobDescription() == null)
            return null;

        ezvcard.property.Organization organization = contact.getOrganization();
        String company = null, department = null;
        if (organization != null) {
            Iterator<String> org = organization.getValues().iterator();
            if (org.hasNext())
                company = org.next();
            if (org.hasNext())
                department = org.next();
        }

        return builder.withValue(Data.MIMETYPE, Organization.CONTENT_ITEM_TYPE)
                .withValue(Organization.COMPANY, company).withValue(Organization.DEPARTMENT, department)
                .withValue(Organization.TITLE, contact.getJobTitle())
                .withValue(Organization.JOB_DESCRIPTION, contact.getJobDescription());
    }

    protected Builder buildIMPP(Builder builder, Impp impp) {
        int typeCode = 0;
        String typeLabel = null;
        for (ImppType type : impp.getTypes())
            if (type == ImppType.HOME)
                typeCode = Im.TYPE_HOME;
            else if (type == ImppType.WORK || type == ImppType.BUSINESS)
                typeCode = Im.TYPE_WORK;
        if (typeCode == 0)
            if (impp.getTypes().isEmpty())
                typeCode = Im.TYPE_OTHER;
            else {
                typeCode = Im.TYPE_CUSTOM;
                typeLabel = xNameToLabel(impp.getTypes().iterator().next().getValue());
            }

        int protocolCode = 0;
        String protocolLabel = null;

        String protocol = impp.getProtocol();
        if (protocol == null) {
            Log.w(TAG, "Ignoring IMPP address without protocol");
            return null;
        }

        // SIP addresses are IMPP entries in the VCard but locally stored in SipAddress rather than Im
        boolean sipAddress = false;

        if (impp.isAim())
            protocolCode = Im.PROTOCOL_AIM;
        else if (impp.isMsn())
            protocolCode = Im.PROTOCOL_MSN;
        else if (impp.isYahoo())
            protocolCode = Im.PROTOCOL_YAHOO;
        else if (impp.isSkype())
            protocolCode = Im.PROTOCOL_SKYPE;
        else if (protocol.equalsIgnoreCase("qq"))
            protocolCode = Im.PROTOCOL_QQ;
        else if (protocol.equalsIgnoreCase("google-talk"))
            protocolCode = Im.PROTOCOL_GOOGLE_TALK;
        else if (impp.isIcq())
            protocolCode = Im.PROTOCOL_ICQ;
        else if (impp.isXmpp() || protocol.equalsIgnoreCase("jabber"))
            protocolCode = Im.PROTOCOL_JABBER;
        else if (protocol.equalsIgnoreCase("netmeeting"))
            protocolCode = Im.PROTOCOL_NETMEETING;
        else if (protocol.equalsIgnoreCase("sip"))
            sipAddress = true;
        else {
            protocolCode = Im.PROTOCOL_CUSTOM;
            protocolLabel = protocol;
        }

        if (sipAddress)
            // save as SIP address
            builder = builder.withValue(Data.MIMETYPE, SipAddress.CONTENT_ITEM_TYPE)
                    .withValue(Im.DATA, impp.getHandle()).withValue(Im.TYPE, typeCode);
        else {
            // save as IM address
            builder = builder.withValue(Data.MIMETYPE, Im.CONTENT_ITEM_TYPE).withValue(Im.DATA, impp.getHandle())
                    .withValue(Im.TYPE, typeCode).withValue(Im.PROTOCOL, protocolCode);
            if (protocolLabel != null)
                builder = builder.withValue(Im.CUSTOM_PROTOCOL, protocolLabel);
        }
        if (typeLabel != null)
            builder = builder.withValue(Im.LABEL, typeLabel);
        return builder;
    }

    protected Builder buildNickName(Builder builder, String nickName) {
        return builder.withValue(Data.MIMETYPE, Nickname.CONTENT_ITEM_TYPE).withValue(Nickname.NAME, nickName);
    }

    protected Builder buildNote(Builder builder, String note) {
        return builder.withValue(Data.MIMETYPE, Note.CONTENT_ITEM_TYPE).withValue(Note.NOTE, note);
    }

    protected Builder buildAddress(Builder builder, Address address) {
        /*   street po.box (extended)
         *   region
         *   postal code city
         *   country
         */
        String formattedAddress = address.getLabel();
        if (StringUtils.isEmpty(formattedAddress)) {
            String lineStreet = StringUtils.join(
                    new String[] { address.getStreetAddress(), address.getPoBox(), address.getExtendedAddress() },
                    " "),
                    lineLocality = StringUtils.join(new String[] { address.getPostalCode(), address.getLocality() },
                            " ");

            List<String> lines = new LinkedList<String>();
            if (lineStreet != null)
                lines.add(lineStreet);
            if (address.getRegion() != null && !address.getRegion().isEmpty())
                lines.add(address.getRegion());
            if (lineLocality != null)
                lines.add(lineLocality);

            formattedAddress = StringUtils.join(lines, "\n");
        }

        int typeCode = 0;
        String typeLabel = null;
        for (AddressType type : address.getTypes())
            if (type == AddressType.HOME)
                typeCode = StructuredPostal.TYPE_HOME;
            else if (type == AddressType.WORK)
                typeCode = StructuredPostal.TYPE_WORK;
        if (typeCode == 0)
            if (address.getTypes().isEmpty())
                typeCode = StructuredPostal.TYPE_OTHER;
            else {
                typeCode = StructuredPostal.TYPE_CUSTOM;
                typeLabel = xNameToLabel(address.getTypes().iterator().next().getValue());
            }

        builder = builder.withValue(Data.MIMETYPE, StructuredPostal.CONTENT_ITEM_TYPE)
                .withValue(StructuredPostal.FORMATTED_ADDRESS, formattedAddress)
                .withValue(StructuredPostal.TYPE, typeCode)
                .withValue(StructuredPostal.STREET, address.getStreetAddress())
                .withValue(StructuredPostal.POBOX, address.getPoBox())
                .withValue(StructuredPostal.NEIGHBORHOOD, address.getExtendedAddress())
                .withValue(StructuredPostal.CITY, address.getLocality())
                .withValue(StructuredPostal.REGION, address.getRegion())
                .withValue(StructuredPostal.POSTCODE, address.getPostalCode())
                .withValue(StructuredPostal.COUNTRY, address.getCountry());
        if (typeLabel != null)
            builder = builder.withValue(StructuredPostal.LABEL, typeLabel);
        return builder;
    }

    protected Builder buildURL(Builder builder, String url) {
        return builder.withValue(Data.MIMETYPE, Website.CONTENT_ITEM_TYPE).withValue(Website.URL, url);
    }

    protected Builder buildEvent(Builder builder, DateOrTimeProperty date, int type) {
        SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd", Locale.US);
        if (date.getDate() == null) {
            Log.i(TAG, "Ignoring contact event without date");
            return null;
        }
        return builder.withValue(Data.MIMETYPE, CommonDataKinds.Event.CONTENT_ITEM_TYPE)
                .withValue(CommonDataKinds.Event.TYPE, type)
                .withValue(CommonDataKinds.Event.START_DATE, formatter.format(date.getDate()));
    }

    /* helper methods */

    protected Uri dataURI() {
        return syncAdapterURI(Data.CONTENT_URI);
    }

    protected static String labelToXName(String label) {
        return "X-" + label.replaceAll(" ", "_").replaceAll("[^\\p{L}\\p{Nd}\\-_]", "").toUpperCase(Locale.US);
    }

    private Builder newDataInsertBuilder(long raw_contact_id, Integer backrefIdx) {
        return newDataInsertBuilder(dataURI(), Data.RAW_CONTACT_ID, raw_contact_id, backrefIdx);
    }

    protected static String xNameToLabel(String xname) {
        // "X-MY_PROPERTY"
        // 1. ensure lower case -> "x-my_property"
        // 2. remove x- from beginning -> "my_property"
        // 3. replace "_" by " " -> "my property"
        // 4. capitalize -> "My Property"
        String lowerCase = StringUtils.lowerCase(xname, Locale.US),
                withoutPrefix = StringUtils.removeStart(lowerCase, "x-"),
                withSpaces = StringUtils.replace(withoutPrefix, "_", " ");
        return WordUtils.capitalize(withSpaces);
    }
}