/android/export-contacts

To get this branch, use:
bzr branch http://bzr.ed.am/android/export-contacts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
/*
 * Exporter.java
 *
 * Copyright (C) 2011 to 2013 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 java.util.ArrayList;

import android.content.SharedPreferences;
import android.os.Message;


public class Exporter extends Thread
{
	public final static int ACTION_ABORT = 1;
	public final static int ACTION_ALLDONE = 2;

	public final static int RESPONSE_NEGATIVE = 0;
	public final static int RESPONSE_POSITIVE = 1;

	public final static int RESPONSEEXTRA_NONE = 0;
	public final static int RESPONSEEXTRA_ALWAYS = 1;

	private Doit _doit;
	private int _response;
	private boolean _abort = false;
	private boolean _is_finished = false;

	/**
	 * Data about a contact
	 */
	public class ContactData
	{
		public final static int TYPE_HOME = 0;
		public final static int TYPE_WORK = 1;
		public final static int TYPE_MOBILE = 2;	// only used with phones
		public final static int TYPE_FAX_HOME = 3;	// only used with phones
		public final static int TYPE_FAX_WORK = 4;	// only used with phones
		public final static int TYPE_PAGER = 5;		// only used with phones

		class OrganisationDetail
		{
			protected String _org;
			protected String _title;

			public OrganisationDetail( String org, String title )
			{
				_org = org != null && org.length() > 0? org : null;
				_title = title != null && title.length() > 0? title : null;
			}

			public String getOrganisation()
			{
				return _org;
			}

			public String getTitle()
			{
				return _title;
			}
		}

		class NumberDetail
		{
			protected int _type;
			protected String _num;

			public NumberDetail( int type, String num )
			{
				_type = type;
				_num = num != null && num.length() > 0? num : null;
			}

			public int getType()
			{
				return _type;
			}

			public String getNumber()
			{
				return _num;
			}
		}

		class EmailDetail
		{
			protected int _type;
			protected String _email;

			public EmailDetail( int type, String email )
			{
				_type = type;
				_email = email != null && email.length() > 0? email : null;
			}

			public int getType()
			{
				return _type;
			}

			public String getEmail()
			{
				return _email;
			}
		}

		class AddressDetail
		{
			protected int _type;
			protected String _addr;

			public AddressDetail( int type, String addr )
			{
				_type = type;
				_addr = addr != null && addr.length() > 0? addr : null;
			}

			public int getType()
			{
				return _type;
			}

			public String getAddress()
			{
				return _addr;
			}
		}

		protected String _name = null;
		protected ArrayList< OrganisationDetail > _organisations = null;
		protected ArrayList< NumberDetail > _numbers = null;
		protected ArrayList< EmailDetail > _emails = null;
		protected ArrayList< AddressDetail > _addresses = null;
		protected ArrayList< String > _notes = null;
		protected String _birthday = null;

		public void setName( String name )
		{
			_name = name != null && name.length() > 0? name : null;
		}

		public String getName()
		{
			return _name;
		}

		public void addOrganisation( OrganisationDetail organisation )
		{
			if( organisation.getOrganisation() == null ) return;
			if( _organisations == null )
				_organisations = new ArrayList< OrganisationDetail >();
			_organisations.add( organisation );
		}

		public ArrayList< OrganisationDetail > getOrganisations()
		{
			return _organisations;
		}

		public void addNumber( NumberDetail number )
		{
			if( number.getNumber() == null ) return;
			if( _numbers == null )
				_numbers = new ArrayList< NumberDetail >();
			_numbers.add( number );
		}

		public ArrayList< NumberDetail > getNumbers()
		{
			return _numbers;
		}

		public void addEmail( EmailDetail email )
		{
			if( email.getEmail() == null ) return;
			if( _emails == null )
				_emails = new ArrayList< EmailDetail >();
			_emails.add( email );
		}

		public ArrayList< EmailDetail > getEmails()
		{
			return _emails;
		}

		public void addAddress( AddressDetail address )
		{
			if( address.getAddress() == null ) return;
			if( _addresses == null )
				_addresses = new ArrayList< AddressDetail >();
			_addresses.add( address );
		}

		public ArrayList< AddressDetail > getAddresses()
		{
			return _addresses;
		}

		public void addNote( String note )
		{
			if( _notes == null )
				_notes = new ArrayList< String >();
			_notes.add( note );
		}

		public ArrayList< String > getNotes()
		{
			return _notes;
		}

		public void setBirthday( String birthday )
		{
			_birthday = birthday;
		}

		public String getBirthday()
		{
			return _birthday;
		}

		public String getPrimaryIdentifier()
		{
			if( _name != null )
				return _name;

			if( _organisations != null &&
				_organisations.get( 0 ).getOrganisation() != null )
				return _organisations.get( 0 ).getOrganisation();

			if( _numbers!= null &&
				_numbers.get( 0 ).getNumber() != null )
				return _numbers.get( 0 ).getNumber();

			if( _emails!= null &&
				_emails.get( 0 ).getEmail() != null )
				return _emails.get( 0 ).getEmail();

			// no primary identifier
			return null;
		}
	}

	@SuppressWarnings( "serial" )
	protected class AbortExportException extends Exception { };

	public Exporter( Doit doit )
	{
		_doit = doit;
	}

	@Override
	public void run()
	{
		try
		{
			// update UI
			setProgressMessage( R.string.doit_scanning );

			// do the export
			exportContacts();

			// done!
			finish( ACTION_ALLDONE );
		}
		catch( AbortExportException e )
		{}

		// flag as finished to prevent interrupts
		setIsFinished();
	}

	synchronized private void setIsFinished()
	{
		_is_finished = true;
	}

	protected void exportContacts() throws AbortExportException
	{
		// set up a contact reader
		Backend backend = null;
		if( Integer.parseInt( android.os.Build.VERSION.SDK ) >= 5 )
			backend = new ContactsContractBackend( _doit, this );
		else
			backend = new ContactsBackend( _doit, this );

		// check we have contacts
		int num_contacts = backend.getNumContacts();
		if( num_contacts == 0 )
			showError( R.string.error_nothingtodo );

		// count the number of contacts and set the progress bar max
		setProgress( 0 );
		setProgressMax( num_contacts );

		checkAbort();
		preExport();

		// loop through contacts
		int count = 0;
		while( true ) {
			checkAbort();
			ContactData contact = new ContactData();
			if( !backend.getNextContact( contact ) )
				break;

			// export this one
			checkAbort();
			if( exportContact( contact ) )
				_doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTWRITTEN );
			else
				_doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTSKIPPED );
			setProgress( count++ );
		}
		setProgress( num_contacts );

		postExport();
	}

	public void wake()
	{
		wake( 0 );
	}

	synchronized public void wake( int response )
	{
		_response = response;
		notify();
	}

	synchronized public boolean setAbort()
	{
		if( !_is_finished && !_abort ) {
			_abort = true;
			notify();
			return true;
		}
		return false;
	}

	protected SharedPreferences getSharedPreferences()
	{
		return _doit.getSharedPreferences();
	}

	protected void showError( int res ) throws AbortExportException
	{
		showError( _doit.getText( res ).toString() );
	}

	synchronized protected void showError( String message )
			throws AbortExportException
	{
		checkAbort();
		_doit._handler.sendMessage( Message.obtain(
			_doit._handler, Doit.MESSAGE_ERROR, message ) );
		try {
			wait();
		}
		catch( InterruptedException e ) { }

		// no need to check if an abortion happened during the wait, we are
		// about to finish anyway!
		finish( ACTION_ABORT );
	}

	protected void showContinueOrAbort( int res ) throws AbortExportException
	{
		showContinueOrAbort( _doit.getText( res ).toString() );
	}

	synchronized protected void showContinueOrAbort( String message )
			throws AbortExportException
	{
		checkAbort();
		_doit._handler.sendMessage( Message.obtain(
			_doit._handler, Doit.MESSAGE_CONTINUEORABORT, message ) );
		try {
			wait();
		}
		catch( InterruptedException e ) { }

		// if we're aborting, there's no need to check if an abortion happened
		// during the wait
		if( _response == RESPONSE_NEGATIVE )
			finish( ACTION_ABORT );
		else
			checkAbort();
	}

	protected void setProgressMessage( int res ) throws AbortExportException
	{
		checkAbort();
		_doit._handler.sendMessage( Message.obtain( _doit._handler,
			Doit.MESSAGE_SETPROGRESSMESSAGE, getText( res ) ) );
	}

	protected void setProgressMax( int max_progress )
			throws AbortExportException
	{
		checkAbort();
		_doit._handler.sendMessage( Message.obtain(
			_doit._handler, Doit.MESSAGE_SETMAXPROGRESS,
			Integer.valueOf( max_progress ) ) );
	}

	protected void setTmpProgress( int tmp_progress )
		throws AbortExportException
	{
		checkAbort();
		_doit._handler.sendMessage( Message.obtain(
			_doit._handler, Doit.MESSAGE_SETTMPPROGRESS,
			Integer.valueOf( tmp_progress ) ) );
	}

	protected void setProgress( int progress ) throws AbortExportException
	{
		checkAbort();
		_doit._handler.sendMessage( Message.obtain(
			_doit._handler, Doit.MESSAGE_SETPROGRESS,
			Integer.valueOf( progress ) ) );
	}

	protected void finish( int action ) throws AbortExportException
	{
		// update UI to reflect action
		int message;
		switch( action )
		{
		case ACTION_ALLDONE:	message = Doit.MESSAGE_ALLDONE; break;
		default:	// fall through
		case ACTION_ABORT:		message = Doit.MESSAGE_ABORT; break;
		}
		_doit._handler.sendEmptyMessage( message );

		// stop
		throw new AbortExportException();
	}

	protected CharSequence getText( int res )
	{
		return _doit.getText( res );
	}

	protected void skipContact() throws AbortExportException
	{
		checkAbort();
		_doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTSKIPPED );
	}

	synchronized protected void checkAbort() throws AbortExportException
	{
		if( _abort ) {
			// stop
			throw new AbortExportException();
		}
	}

	protected void preExport() throws AbortExportException
	{
	}

	protected boolean exportContact( ContactData contact )
		throws AbortExportException
	{
		throw new UnsupportedOperationException();
	}

	protected void postExport() throws AbortExportException
	{
	}

}