/android/export-contacts : contents of src/am/ed/exportcontacts/ContactsContractBackend.java at revision 21

: (revision 21)

To get this branch, use:

bzr branch
http://bzr.ed.am/android/export-contacts

/*
 * ContactsContractContactAccessor.java
 *
 * Copyright (C) 2011 to 2012 Tim Marston <tim@ed.am>
 *
 * This file is part of the Export Contacts program (hereafter referred
 * to as "this program"). For more information, see
 * http://ed.am/dev/android/export-contacts
 *
 * 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/>.
 */

package am.ed.exportcontacts;

import am.ed.exportcontacts.Exporter.ContactData;
import android.annotation.TargetApi;
import android.app.Activity;
import android.database.Cursor;
import android.provider.ContactsContract;
import android.provider.ContactsContract.CommonDataKinds;

@TargetApi(5)
public class ContactsContractBackend implements Backend
{
	Activity _activity = null;
	Exporter _exporter = null;
	Cursor _cur = null;

	public ContactsContractBackend( Activity activity,
		Exporter exporter )
	{
		_activity = activity;
		_exporter = exporter;
	}

	@Override
	public int getNumContacts()
	{
		// get number of aggregate contacts
		Cursor cursor = _activity.managedQuery(
			ContactsContract.Contacts.CONTENT_URI,
			new String[] {
				ContactsContract.Contacts._ID,
			}, null, null, null );
		return cursor.getCount();
	}

	private int convertBackendTypeToType( Class< ? > cls, int type )
	{
		if( cls == CommonDataKinds.Phone.class )
		{
			switch( type )
			{
			case CommonDataKinds.Phone.TYPE_MOBILE:
				return ContactData.TYPE_MOBILE;
			case CommonDataKinds.Phone.TYPE_FAX_HOME:
				return ContactData.TYPE_FAX_HOME;
			case CommonDataKinds.Phone.TYPE_FAX_WORK:
				return ContactData.TYPE_FAX_WORK;
			case CommonDataKinds.Phone.TYPE_PAGER:
				return ContactData.TYPE_PAGER;
			case CommonDataKinds.Phone.TYPE_WORK:
				return ContactData.TYPE_WORK;
			default:
				return ContactData.TYPE_HOME;
			}
		}
		else if( cls == CommonDataKinds.Email.class )
		{
			switch( type )
			{
			case CommonDataKinds.Email.TYPE_WORK:
				return ContactData.TYPE_WORK;
			default:
				return ContactData.TYPE_HOME;
			}
		}
		else if( cls == CommonDataKinds.StructuredPostal.class )
		{
			switch( type )
			{
			case CommonDataKinds.StructuredPostal.TYPE_WORK:
				return ContactData.TYPE_WORK;
			default:
				return ContactData.TYPE_HOME;
			}
		}

		return ContactData.TYPE_HOME;
	}

	@Override
	public boolean getNextContact( Exporter.ContactData contact )
	{
		// set up cursor
		if( _cur == null )
		{
			// get all aggregate contacts
			_cur = _activity.managedQuery(
				ContactsContract.Contacts.CONTENT_URI,
				new String[] {
					ContactsContract.Contacts._ID,
					ContactsContract.Contacts.DISPLAY_NAME,
				}, null, null, null );
		}

		// if there are no more aggregate contacts, abort
		if( _cur == null || !_cur.moveToNext() ) {
			_cur = null;
			return false;
		}

		// get this aggregate contact's id
		Long id = _cur.getLong( _cur.getColumnIndex(
			ContactsContract.Contacts._ID ) );

		// create contact
		contact.setName( _cur.getString( _cur.getColumnIndex(
			ContactsContract.Contacts.DISPLAY_NAME ) ) );

		// get all contact data pertaining to the aggregate contact
		Cursor cur = _activity.getContentResolver().query(
			ContactsContract.Data.CONTENT_URI,
			new String[]{
				ContactsContract.Data.MIMETYPE,
				ContactsContract.Data.IS_PRIMARY,
				ContactsContract.Data.DATA1,
				ContactsContract.Data.DATA2,
				ContactsContract.Data.DATA4,
			},
			ContactsContract.Data.CONTACT_ID + " = ? AND " +
				ContactsContract.Data.DELETED + " = 0 AND " +
				ContactsContract.Data.MIMETYPE + " IN ( ?, ?, ?, ?, ? )",
			new String[] {
				String.valueOf( id ),
				CommonDataKinds.Phone.CONTENT_ITEM_TYPE,
				CommonDataKinds.Email.CONTENT_ITEM_TYPE,
				CommonDataKinds.Organization.CONTENT_ITEM_TYPE,
				CommonDataKinds.StructuredPostal.CONTENT_ITEM_TYPE,
				CommonDataKinds.Note.CONTENT_ITEM_TYPE,
			},
			ContactsContract.Data.IS_SUPER_PRIMARY + " DESC, " +
				ContactsContract.Data.RAW_CONTACT_ID + ", " +
				ContactsContract.Data.IS_PRIMARY + " DESC" );
		while( cur.moveToNext() )
		{
			String type = cur.getString( cur.getColumnIndex(
				ContactsContract.Data.MIMETYPE ) );

			// add phone numbers
			if( type.equals( CommonDataKinds.Phone.CONTENT_ITEM_TYPE ) )
				contact.addNumber( contact.new NumberDetail(
					convertBackendTypeToType( CommonDataKinds.Phone.class,
						cur.getInt( cur.getColumnIndex(
							CommonDataKinds.Phone.TYPE ) ) ),
					cur.getString( cur.getColumnIndex(
						CommonDataKinds.Phone.NUMBER ) ) ) );

			// add email addresses
			else if( type.equals( CommonDataKinds.Email.CONTENT_ITEM_TYPE ) )
				contact.addEmail( contact.new EmailDetail(
					convertBackendTypeToType( CommonDataKinds.Phone.class,
						cur.getInt( cur.getColumnIndex(
							CommonDataKinds.Email.TYPE ) ) ),
					cur.getString( cur.getColumnIndex(
						CommonDataKinds.Email.DATA ) ) ) );

			// add postal addresses
			else if( type.equals( CommonDataKinds.StructuredPostal.CONTENT_ITEM_TYPE ) )
				contact.addAddress( contact.new AddressDetail(
					convertBackendTypeToType( CommonDataKinds.Phone.class,
						cur.getInt( cur.getColumnIndex(
							CommonDataKinds.StructuredPostal.TYPE ) ) ),
					cur.getString( cur.getColumnIndex(
						CommonDataKinds.StructuredPostal.FORMATTED_ADDRESS ) ) ) );

			// add organisations/titles
			else if( type.equals( CommonDataKinds.Organization.CONTENT_ITEM_TYPE ) )
				contact.addOrganisation( contact.new OrganisationDetail(
					cur.getString( cur.getColumnIndex(
						CommonDataKinds.Organization.COMPANY ) ),
					cur.getString( cur.getColumnIndex(
						CommonDataKinds.Organization.TITLE ) ) ) );

			// add notes
			else if( type.equals( CommonDataKinds.Note.CONTENT_ITEM_TYPE ) )
				contact.addNote( cur.getString( cur.getColumnIndex(
					CommonDataKinds.Note.NOTE ) ) );
		}
		cur.close();

		return true;
	}
}

18 by edam added ContactsContract backend; removed references to Contacts types (conversion to/from backend types now done in backends); added support for exporting NOTEs	1	/*
	2	* ContactsContractContactAccessor.java
	3	*
19 by edam updated some copyright dates	4	* Copyright (C) 2011 to 2012 Tim Marston <tim@ed.am>
18 by edam added ContactsContract backend; removed references to Contacts types (conversion to/from backend types now done in backends); added support for exporting NOTEs	5	*
	6	* This file is part of the Export Contacts program (hereafter referred
	7	* to as "this program"). For more information, see
	8	* http://ed.am/dev/android/export-contacts
	9	*
	10	* This program is free software: you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation, either version 3 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	22	*/
	23
	24	package am.ed.exportcontacts;
	25
	26	import am.ed.exportcontacts.Exporter.ContactData;
	27	import android.annotation.TargetApi;
	28	import android.app.Activity;
	29	import android.database.Cursor;
	30	import android.provider.ContactsContract;
	31	import android.provider.ContactsContract.CommonDataKinds;
	32
	33	@TargetApi(5)
	34	public class ContactsContractBackend implements Backend
	35	{
	36	Activity _activity = null;
	37	Exporter _exporter = null;
	38	Cursor _cur = null;
	39
	40	public ContactsContractBackend( Activity activity,
	41	Exporter exporter )
	42	{
	43	_activity = activity;
	44	_exporter = exporter;
	45	}
	46
	47	@Override
	48	public int getNumContacts()
	49	{
	50	// get number of aggregate contacts
	51	Cursor cursor = _activity.managedQuery(
	52	ContactsContract.Contacts.CONTENT_URI,
	53	new String[] {
	54	ContactsContract.Contacts._ID,
	55	}, null, null, null );
	56	return cursor.getCount();
	57	}
	58
	59	private int convertBackendTypeToType( Class< ? > cls, int type )
	60	{
	61	if( cls == CommonDataKinds.Phone.class )
	62	{
	63	switch( type )
	64	{
	65	case CommonDataKinds.Phone.TYPE_MOBILE:
	66	return ContactData.TYPE_MOBILE;
	67	case CommonDataKinds.Phone.TYPE_FAX_HOME:
	68	return ContactData.TYPE_FAX_HOME;
69	case CommonDataKinds.Phone.TYPE_FAX_WORK:
70	return ContactData.TYPE_FAX_WORK;
71	case CommonDataKinds.Phone.TYPE_PAGER:
72	return ContactData.TYPE_PAGER;
73	case CommonDataKinds.Phone.TYPE_WORK:
74	return ContactData.TYPE_WORK;
75	default:
76	return ContactData.TYPE_HOME;
77	}
78	}
79	else if( cls == CommonDataKinds.Email.class )
80	{
81	switch( type )
82	{
83	case CommonDataKinds.Email.TYPE_WORK:
84	return ContactData.TYPE_WORK;
85	default:
86	return ContactData.TYPE_HOME;
87	}
88	}
89	else if( cls == CommonDataKinds.StructuredPostal.class )
90	{
91	switch( type )
92	{
93	case CommonDataKinds.StructuredPostal.TYPE_WORK:
94	return ContactData.TYPE_WORK;
95	default:
96	return ContactData.TYPE_HOME;
97	}
98	}
99
100	return ContactData.TYPE_HOME;
101	}
102
103	@Override
104	public boolean getNextContact( Exporter.ContactData contact )
105	{
106	// set up cursor
107	if( _cur == null )
108	{
109	// get all aggregate contacts
110	_cur = _activity.managedQuery(
111	ContactsContract.Contacts.CONTENT_URI,
112	new String[] {
113	ContactsContract.Contacts._ID,
114	ContactsContract.Contacts.DISPLAY_NAME,
115	}, null, null, null );
116	}
117
118	// if there are no more aggregate contacts, abort
119	if( _cur == null \|\| !_cur.moveToNext() ) {
120	_cur = null;
121	return false;
122	}
123
124	// get this aggregate contact's id
125	Long id = _cur.getLong( _cur.getColumnIndex(
126	ContactsContract.Contacts._ID ) );
127
128	// create contact
129	contact.setName( _cur.getString( _cur.getColumnIndex(
130	ContactsContract.Contacts.DISPLAY_NAME ) ) );
131
132	// get all contact data pertaining to the aggregate contact
133	Cursor cur = _activity.getContentResolver().query(
134	ContactsContract.Data.CONTENT_URI,
135	new String[]{
136	ContactsContract.Data.MIMETYPE,
137	ContactsContract.Data.IS_PRIMARY,
138	ContactsContract.Data.DATA1,
139	ContactsContract.Data.DATA2,
140	ContactsContract.Data.DATA4,
141	},
142	ContactsContract.Data.CONTACT_ID + " = ? AND " +
143	ContactsContract.Data.DELETED + " = 0 AND " +
144	ContactsContract.Data.MIMETYPE + " IN ( ?, ?, ?, ?, ? )",
145	new String[] {
146	String.valueOf( id ),
147	CommonDataKinds.Phone.CONTENT_ITEM_TYPE,
148	CommonDataKinds.Email.CONTENT_ITEM_TYPE,
149	CommonDataKinds.Organization.CONTENT_ITEM_TYPE,
150	CommonDataKinds.StructuredPostal.CONTENT_ITEM_TYPE,
151	CommonDataKinds.Note.CONTENT_ITEM_TYPE,
152	},
153	ContactsContract.Data.IS_SUPER_PRIMARY + " DESC, " +
154	ContactsContract.Data.RAW_CONTACT_ID + ", " +
155	ContactsContract.Data.IS_PRIMARY + " DESC" );
156	while( cur.moveToNext() )
157	{
158	String type = cur.getString( cur.getColumnIndex(
159	ContactsContract.Data.MIMETYPE ) );
160
161	// add phone numbers
162	if( type.equals( CommonDataKinds.Phone.CONTENT_ITEM_TYPE ) )
163	contact.addNumber( contact.new NumberDetail(
164	convertBackendTypeToType( CommonDataKinds.Phone.class,
165	cur.getInt( cur.getColumnIndex(
166	CommonDataKinds.Phone.TYPE ) ) ),
167	cur.getString( cur.getColumnIndex(
168	CommonDataKinds.Phone.NUMBER ) ) ) );
169
170	// add email addresses
171	else if( type.equals( CommonDataKinds.Email.CONTENT_ITEM_TYPE ) )
172	contact.addEmail( contact.new EmailDetail(
173	convertBackendTypeToType( CommonDataKinds.Phone.class,
174	cur.getInt( cur.getColumnIndex(
175	CommonDataKinds.Email.TYPE ) ) ),
176	cur.getString( cur.getColumnIndex(
177	CommonDataKinds.Email.DATA ) ) ) );
178
179	// add postal addresses
180	else if( type.equals( CommonDataKinds.StructuredPostal.CONTENT_ITEM_TYPE ) )
181	contact.addAddress( contact.new AddressDetail(
182	convertBackendTypeToType( CommonDataKinds.Phone.class,
183	cur.getInt( cur.getColumnIndex(
184	CommonDataKinds.StructuredPostal.TYPE ) ) ),
185	cur.getString( cur.getColumnIndex(
186	CommonDataKinds.StructuredPostal.FORMATTED_ADDRESS ) ) ) );
187
188	// add organisations/titles
189	else if( type.equals( CommonDataKinds.Organization.CONTENT_ITEM_TYPE ) )
190	contact.addOrganisation( contact.new OrganisationDetail(
191	cur.getString( cur.getColumnIndex(
192	CommonDataKinds.Organization.COMPANY ) ),
193	cur.getString( cur.getColumnIndex(
194	CommonDataKinds.Organization.TITLE ) ) ) );
195
196	// add notes
197	else if( type.equals( CommonDataKinds.Note.CONTENT_ITEM_TYPE ) )
198	contact.addNote( cur.getString( cur.getColumnIndex(
199	CommonDataKinds.Note.NOTE ) ) );
200	}
21 by edam fixed column values in Contacts backend; don't write-out empty notes; remember to close my queries; switched from wrappers to static valueOf() functions; fix line-endings (should be \r\n)	201	cur.close();
18 by edam added ContactsContract backend; removed references to Contacts types (conversion to/from backend types now done in backends); added support for exporting NOTEs	202
	203	return true;
	204	}
	205	}