50
51
private Doit _doit;
51
52
private int _response;
52
private int _response_extra;
53
private int _merge_setting;
54
private int _last_merge_decision;
53
private int _responseExtra;
54
private int _mergeSetting;
55
private int _lastMergeDecision;
55
56
private boolean _abort = false;
56
private boolean _is_finished = false;
57
private ContactsCache _contacts_cache = null;
58
private Backend _backend = null;
57
private boolean _isFinished = false;
58
private ContactsCache _contactsCache = null;
61
* Data about a contact
63
60
public class ContactData
65
public final static int TYPE_HOME = 0;
66
public final static int TYPE_WORK = 1;
67
public final static int TYPE_MOBILE = 2; // only used with phones
68
public final static int TYPE_FAX_HOME = 3; // only used with phones
69
public final static int TYPE_FAX_WORK = 4; // only used with phones
70
public final static int TYPE_PAGER = 5; // only used with phones
76
public TypeDetail( int type )
87
class PreferredDetail extends TypeDetail
89
protected boolean _is_preferred;
91
public PreferredDetail( int type, boolean is_preferred )
94
_is_preferred = is_preferred;
97
public boolean isPreferred()
103
class ExtraDetail extends PreferredDetail
105
protected String _extra;
107
public ExtraDetail( int type, boolean is_preferred, String extra )
109
super( type, is_preferred );
111
if( extra != null ) extra = extra.trim();
115
public String getExtra()
120
public void setExtra( String extra )
122
if( extra != null ) extra = extra.trim();
127
@SuppressWarnings("serial")
128
protected class ContactNotIdentifiableException extends Exception
132
protected String _name = null;
133
protected String _primary_organisation = null;
134
protected boolean _primary_organisation_is_preferred;
135
protected String _primary_number = null;
136
protected int _primary_number_type;
137
protected boolean _primary_number_is_preferred;
138
protected String _primary_email = null;
139
protected boolean _primary_email_is_preferred;
140
protected HashMap< String, ExtraDetail > _organisations = null;
141
protected HashMap< String, PreferredDetail > _numbers = null;
142
protected HashMap< String, PreferredDetail > _emails = null;
143
protected HashMap< String, TypeDetail > _addresses = null;
144
protected HashSet< String > _notes = null;
146
private ContactsCache.CacheIdentifier _cache_identifier = null;
64
public String _number;
66
public boolean _isPreferred;
68
public PhoneData( String number, int type, boolean isPreferred ) {
71
_isPreferred = isPreferred;
74
public String getNumber() {
78
public int getType() {
82
public boolean isPreferred() {
89
private String _email;
91
private boolean _isPreferred;
93
public EmailData( String email, int type, boolean isPreferred ) {
96
_isPreferred = isPreferred;
99
public String getAddress() {
103
public int getType() {
107
public boolean isPreferred() {
114
private String _address;
117
public AddressData( String address, int type ) {
122
public String getAddress() {
126
public int getType() {
131
public String _name = null;
132
public HashMap< String, PhoneData > _phones = null;
133
public HashMap< String, EmailData > _emails = null;
134
public HashMap< String, AddressData > _addresses = null;
148
136
protected void setName( String name )
153
public boolean hasName()
155
return _name != null;
158
141
public String getName()
163
protected void addOrganisation( String organisation, String title,
164
boolean is_preferred )
166
organisation = organisation.trim();
167
if( organisation.length() <= 0 )
169
// TODO: warn that an imported organisation is being ignored
173
if( title != null ) {
174
title = title.trim();
175
if( title.length() <= 0 ) title = null;
178
// add the organisation, as non-preferred (we prefer only one
179
// organisation in finalise() after they're all imported)
180
if( _organisations == null )
181
_organisations = new HashMap< String, ExtraDetail >();
182
if( !_organisations.containsKey( organisation ) )
183
_organisations.put( organisation,
184
new ExtraDetail( 0, false, title ) );
186
// if this is the first organisation added, or it's a preferred
187
// organisation and the current primary organisation isn't, then
188
// record this as the primary organisation
189
if( _primary_organisation == null ||
190
( is_preferred && !_primary_organisation_is_preferred ) )
192
_primary_organisation = organisation;
193
_primary_organisation_is_preferred = is_preferred;
197
public boolean hasOrganisations()
199
return _organisations != null && _organisations.size() > 0;
202
public HashMap< String, ExtraDetail > getOrganisations()
204
return _organisations;
207
public boolean hasPrimaryOrganisation()
209
return _primary_organisation != null;
212
public String getPrimaryOrganisation()
214
return _primary_organisation;
217
protected void addNumber( String number, int type,
218
boolean is_preferred )
220
number = sanitisePhoneNumber( number );
223
// TODO: warn that an imported phone number is being ignored
227
// add the number, as non-preferred (we prefer only one number
228
// in finalise() after they're all imported)
229
if( _numbers == null )
230
_numbers = new HashMap< String, PreferredDetail >();
231
if( !_numbers.containsKey( number ) )
232
_numbers.put( number,
233
new PreferredDetail( type, false ) );
235
final Set< Integer > non_voice_types = new HashSet< Integer >(
236
Arrays.asList( TYPE_FAX_HOME, TYPE_FAX_WORK, TYPE_PAGER ) );
238
// if this is the first number added, or it's a preferred number
239
// and the current primary number isn't, or this number is on equal
240
// standing with the primary number in terms of preference and it is
241
// a voice number and the primary number isn't, then record this as
242
// the primary number
243
if( _primary_number == null ||
244
( is_preferred && !_primary_number_is_preferred ) ||
245
( is_preferred == _primary_number_is_preferred &&
246
!non_voice_types.contains( type ) &&
247
non_voice_types.contains( _primary_number_type ) ) )
249
_primary_number = number;
250
_primary_number_type = type;
251
_primary_number_is_preferred = is_preferred;
255
public boolean hasNumbers()
257
return _numbers != null && _numbers.size() > 0;
260
public HashMap< String, PreferredDetail > getNumbers()
265
public boolean hasPrimaryNumber()
267
return _primary_number != null;
270
public String getPrimaryNumber()
272
return _primary_number;
275
protected void addEmail( String email, int type, boolean is_preferred )
278
email = sanitisesEmailAddress( email );
281
// TODO: warn that an imported email address is being ignored
285
// add the email, as non-preferred (we prefer only one email in
286
// finalise() after they're all imported)
287
if( _emails == null )
288
_emails = new HashMap< String, PreferredDetail >();
146
protected void addPhone( String number, int type, boolean isPreferred )
148
if( _phones == null ) _phones = new HashMap< String, PhoneData >();
149
if( !_phones.containsKey( number ) )
151
new PhoneData( number, type, isPreferred ) );
154
protected void addEmail( String email, int type, boolean isPreferred )
156
if( _emails == null ) _emails = new HashMap< String, EmailData >();
289
157
if( !_emails.containsKey( email ) )
290
_emails.put( email, new PreferredDetail( type, false ) );
292
// if this is the first email added, or it's a preferred email and
293
// the current primary organisation isn't, then record this as the
295
if( _primary_email == null ||
296
( is_preferred && !_primary_email_is_preferred ) )
298
_primary_email = email;
299
_primary_email_is_preferred = is_preferred;
303
public boolean hasEmails()
305
return _emails != null && _emails.size() > 0;
308
public HashMap< String, PreferredDetail > getEmails()
313
public boolean hasPrimaryEmail()
315
return _primary_email != null;
318
public String getPrimaryEmail()
320
return _primary_email;
158
_emails.put( email, new EmailData( email, type, isPreferred ) );
323
161
protected void addAddress( String address, int type )
325
address = address.trim();
326
if( address.length() <= 0 )
328
// TODO: warn that an imported address is being ignored
332
163
if( _addresses == null ) _addresses =
333
new HashMap< String, TypeDetail >();
164
new HashMap< String, AddressData >();
334
165
if( !_addresses.containsKey( address ) )
335
_addresses.put( address, new TypeDetail( type ) );
338
public boolean hasAddresses()
340
return _addresses != null && _addresses.size() > 0;
343
public HashMap< String, TypeDetail > getAddresses()
348
protected void addNote( String note )
350
if( _notes == null ) _notes = new HashSet< String >();
351
if( !_notes.contains( note ) )
355
public boolean hasNotes()
357
return _notes != null && _notes.size() > 0;
360
public HashSet< String > getNotes()
365
protected void finalise()
366
throws ContactNotIdentifiableException
368
// Ensure that if there is a primary number, it is preferred so
369
// that there is always one preferred number. Android will assign
370
// preference to one anyway so we might as well decide one sensibly.
371
if( _primary_number != null ) {
372
PreferredDetail data = _numbers.get( _primary_number );
373
_numbers.put( _primary_number,
374
new PreferredDetail( data.getType(), true ) );
377
// do the same for the primary email
378
if( _primary_email != null ) {
379
PreferredDetail data = _emails.get( _primary_email );
380
_emails.put( _primary_email,
381
new PreferredDetail( data.getType(), true ) );
384
// do the same for the primary organisation
385
if( _primary_organisation != null ) {
386
ExtraDetail data = _organisations.get( _primary_organisation );
387
_organisations.put( _primary_organisation,
388
new ExtraDetail( 0, true, data.getExtra() ) );
391
// create a cache identifier from this contact data, which can be
392
// used to look-up an existing contact
393
_cache_identifier = ContactsCache.CacheIdentifier.factory( this );
394
if( _cache_identifier == null )
395
throw new ContactNotIdentifiableException();
398
public ContactsCache.CacheIdentifier getCacheIdentifier()
400
return _cache_identifier;
403
private String sanitisePhoneNumber( String number )
405
number = number.trim();
406
Pattern p = Pattern.compile( "^[-\\(\\) \\+0-9#*]+" );
407
Matcher m = p.matcher( number );
408
if( m.lookingAt() ) return m.group( 0 );
412
private String sanitisesEmailAddress( String email )
414
email = email.trim();
415
Pattern p = Pattern.compile(
416
"^[^ @]+@[a-zA-Z]([-a-zA-Z0-9]*[a-zA-z0-9])?(\\.[a-zA-Z]([-a-zA-Z0-9]*[a-zA-z0-9])?)+$" );
417
Matcher m = p.matcher( email );
419
String[] bits = email.split( "@" );
420
return bits[ 0 ] + "@" + bits[ 1 ].toLowerCase( Locale.US );
166
_addresses.put( address, new AddressData( address, type ) );
690
// It is expected that we use contact.getCacheIdentifier() here. The
691
// contact we are passed should have been successfully finalise()d,
692
// which includes generating a valid cache identifier.
693
ContactsCache.CacheIdentifier cache_identifier =
694
contact.getCacheIdentifier();
696
423
// if( !showContinue( "====[ IMPORTING ]====\n: " + contact._name ) )
697
424
// finish( ACTION_ABORT );
699
// attempt to lookup the id of an existing contact in the cache with
700
// this contact data's cache identifier
701
Long id = (Long)_contacts_cache.lookup( cache_identifier );
426
ContentValues values = new ContentValues();
427
boolean uiInformed = false;
703
// check to see if this contact should be skipped
704
if( shouldWeSkipContact( cache_identifier.getDetail(), id != null,
429
// does contact exist already?
430
Uri contactUri = null;
432
if( ( id = (Long)_contactsCache.getId( contact._name ) ) != null )
707
// show that we're skipping a contact
708
_doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTSKIPPED );
434
// should we skip this import altogether?
435
if( _lastMergeDecision == Doit.ACTION_KEEP ) return;
438
contactUri = ContentUris.withAppendedId(
439
Contacts.People.CONTENT_URI, id );
441
// should we destroy the existing contact before importing?
442
if( _lastMergeDecision == Doit.ACTION_OVERWRITE ) {
443
_doit.getContentResolver().delete( contactUri, null, null );
447
_doit._handler.sendEmptyMessage(
448
Doit.MESSAGE_CONTACTOVERWRITTEN );
452
_contactsCache.remove( contact._name );
712
// if a contact exists, and we're overwriting, destroy the existing
713
// contact before importing
714
boolean contact_deleted = false;
715
if( id != null && _last_merge_decision == Doit.ACTION_OVERWRITE )
456
// if we don't have a contact URI it is because the contact never
457
// existed or because we deleted it
458
if( contactUri == null )
717
contact_deleted = true;
460
// create a new contact
461
values.put( Contacts.People.NAME, contact._name );
462
contactUri = _doit.getContentResolver().insert(
463
Contacts.People.CONTENT_URI, values );
464
id = ContentUris.parseId( contactUri );
465
if( id <= 0 ) return; // shouldn't happen!
719
// remove from device
720
_backend.deleteContact( id );
467
// try to add them to the "My Contacts" group
469
Contacts.People.addToMyContactsGroup(
470
_doit.getContentResolver(), id );
472
catch( IllegalStateException e ) {
473
// ignore any failure
723
_contacts_cache.removeLookup( cache_identifier );
724
_contacts_cache.removeAssociatedData( id );
726
// show that we're overwriting a contact
727
_doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTOVERWRITTEN );
729
// discard the contact id
734
// if we don't have a contact id yet (or we did, but we destroyed it
735
// when we deleted the contact), we'll have to create a new contact
738
// create a new contact
739
id = _backend.addContact( contact._name );
742
_contacts_cache.addLookup( cache_identifier, id );
744
// if we haven't already shown that we're overwriting a contact,
745
// show that we're creating a new contact
746
if( !contact_deleted )
747
_doit._handler.sendEmptyMessage(
748
Doit.MESSAGE_CONTACTCREATED );
477
_contactsCache.put( id, contact._name );
481
_doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTCREATED );
751
// show that we're merging with an existing contact
752
_doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTMERGED );
754
// import contact parts
755
if( contact.hasNumbers() )
756
importContactPhones( id, contact.getNumbers() );
757
if( contact.hasEmails() )
758
importContactEmails( id, contact.getEmails() );
759
if( contact.hasAddresses() )
760
importContactAddresses( id, contact.getAddresses() );
761
if( contact.hasOrganisations() )
762
importContactOrganisations( id, contact.getOrganisations() );
763
if( contact.hasNotes() )
764
importContactNotes( id, contact.getNotes() );
766
catch( Backend.ContactCreationException e )
768
showError( R.string.error_unabletoaddcontact );
488
_doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTMERGED );
490
// import contact parts
491
if( contact._phones != null )
492
importContactPhones( contactUri, contact._phones );
493
if( contact._emails != null )
494
importContactEmails( contactUri, contact._emails );
495
if( contact._addresses != null )
496
importContactAddresses( contactUri, contact._addresses );
772
private void importContactPhones( Long id,
773
HashMap< String, ContactData.PreferredDetail > datas )
774
throws ContactCreationException
499
private void importContactPhones( Uri contactUri,
500
HashMap< String, ContactData.PhoneData > phones )
502
Long contactId = ContentUris.parseId( contactUri );
503
Uri contactPhonesUri = Uri.withAppendedPath( contactUri,
504
Contacts.People.Phones.CONTENT_DIRECTORY );
505
Set< String > phonesKeys = phones.keySet();
776
507
// add phone numbers
777
Set< String > datas_keys = datas.keySet();
778
Iterator< String > i = datas_keys.iterator();
508
Iterator< String > i = phonesKeys.iterator();
779
509
while( i.hasNext() ) {
780
String number = i.next();
781
ContactData.PreferredDetail data = datas.get( number );
510
ContactData.PhoneData phone = phones.get( i.next() );
783
// We don't want to add this number if it's crap, or it already
784
// exists (which would cause a duplicate to be created). We don't
785
// take in to account the type when checking for duplicates. This
786
// is intentional: types aren't really very reliable. We assume
787
// that if the number exists at all, it doesn't need importing.
788
// Because of this, we also can't update the cache (which we don't
789
// need to anyway, so it's not a problem).
790
if( _contacts_cache.hasAssociatedNumber( id, number ) )
512
// we don't want to add this number if it's crap, or it already
513
// exists (which would cause a duplicate to be created). We don't
514
// take in to account the type when checking for duplicates. This is
515
// intentional: types aren't really very reliable. We assume that
516
// if the number exists at all, it doesn't need importing. Because
517
// of this, we also can't update the cache (which we don't need to
518
// anyway, so it's not a problem).
519
String number = sanitisePhoneNumber( phone._number );
520
if( number == null ) continue;
521
if( _contactsCache.hasNumber( contactId, number ) ) continue;
793
523
// add phone number
794
_backend.addContactPhone( id, number, data );
524
ContentValues values = new ContentValues();
525
values.put( Contacts.Phones.TYPE, phone._type );
526
values.put( Contacts.Phones.NUMBER, phone._number );
527
if( phone._isPreferred ) values.put( Contacts.Phones.ISPRIMARY, 1 );
528
_doit.getContentResolver().insert( contactPhonesUri, values );
796
530
// and add this address to the cache to prevent a addition of
797
531
// duplicate date from another file
798
_contacts_cache.addAssociatedNumber( id, number );
532
_contactsCache.addNumber( contactId, number );
802
private void importContactEmails( Long id,
803
HashMap< String, ContactData.PreferredDetail > datas )
804
throws ContactCreationException
536
private void importContactEmails( Uri contactUri,
537
HashMap< String, ContactData.EmailData > emails )
539
Long contactId = ContentUris.parseId( contactUri );
540
Uri contactContactMethodsUri = Uri.withAppendedPath( contactUri,
541
Contacts.People.ContactMethods.CONTENT_DIRECTORY );
542
Set< String > emailsKeys = emails.keySet();
806
544
// add email addresses
807
Set< String > datas_keys = datas.keySet();
808
Iterator< String > i = datas_keys.iterator();
545
Iterator< String > i = emailsKeys.iterator();
809
546
while( i.hasNext() ) {
810
String email = i.next();
811
ContactData.PreferredDetail data = datas.get( email );
547
ContactData.EmailData email = emails.get( i.next() );
813
549
// we don't want to add this email address if it exists already or
814
// we would introduce duplicates
815
if( _contacts_cache.hasAssociatedEmail( id, email ) )
550
// we would introduce duplicates.
551
String address = sanitiseEmailAddress( email.getAddress() );
552
if( address == null ) continue;
553
if( _contactsCache.hasEmail( contactId, address ) ) continue;
818
555
// add phone number
819
_backend.addContactEmail( id, email, data );
556
ContentValues values = new ContentValues();
557
values.put( Contacts.ContactMethods.KIND, Contacts.KIND_EMAIL );
558
values.put( Contacts.ContactMethods.DATA, email.getAddress() );
559
values.put( Contacts.ContactMethods.TYPE, email.getType() );
560
if( email.isPreferred() )
561
values.put( Contacts.ContactMethods.ISPRIMARY, 1 );
562
_doit.getContentResolver().insert( contactContactMethodsUri,
821
565
// and add this address to the cache to prevent a addition of
822
566
// duplicate date from another file
823
_contacts_cache.addAssociatedEmail( id, email );
567
_contactsCache.addEmail( contactId, address );
827
private void importContactAddresses( Long id,
828
HashMap< String, ContactData.TypeDetail > datas )
829
throws ContactCreationException
571
private void importContactAddresses( Uri contactUri,
572
HashMap< String, ContactData.AddressData > addresses )
574
Long contactId = ContentUris.parseId( contactUri );
575
Uri contactContactMethodsUri = Uri.withAppendedPath( contactUri,
576
Contacts.People.ContactMethods.CONTENT_DIRECTORY );
577
Set< String > addressesKeys = addresses.keySet();
832
Set< String > datas_keys = datas.keySet();
833
Iterator< String > i = datas_keys.iterator();
580
Iterator< String > i = addressesKeys.iterator();
834
581
while( i.hasNext() ) {
835
String address = i.next();
836
ContactData.TypeDetail data = datas.get( address );
582
ContactData.AddressData address = addresses.get( i.next() );
838
584
// we don't want to add this address if it exists already or we
839
585
// would introduce duplicates
840
if( _contacts_cache.hasAssociatedAddress( id, address ) )
586
if( address == null ) continue;
587
if( _contactsCache.hasAddress( contactId, address.getAddress() ) )
843
590
// add postal address
844
_backend.addContactAddresses( id, address, data );
846
// and add this address to the cache to prevent a addition of
847
// duplicate date from another file
848
_contacts_cache.addAssociatedAddress( id, address );
852
private void importContactOrganisations( Long id,
853
HashMap< String, ContactData.ExtraDetail > datas )
854
throws ContactCreationException
857
Set< String > datas_keys = datas.keySet();
858
Iterator< String > i = datas_keys.iterator();
859
while( i.hasNext() ) {
860
String organisation = i.next();
861
ContactData.ExtraDetail data = datas.get( organisation );
863
// we don't want to add this address if it exists already or we
864
// would introduce duplicates
865
if( _contacts_cache.hasAssociatedOrganisation( id, organisation ) )
868
// add organisation address
869
_backend.addContactOrganisation( id, organisation, data );
871
// and add this address to the cache to prevent a addition of
872
// duplicate date from another file
873
_contacts_cache.addAssociatedOrganisation( id, organisation );
877
private void importContactNotes( Long id,
878
HashSet< String > datas )
879
throws ContactCreationException
882
Iterator< String > i = datas.iterator();
883
while( i.hasNext() ) {
884
String note = i.next();
886
// we don't want to add this note if it exists already or we would
887
// introduce duplicates
888
if( _contacts_cache.hasAssociatedNote( id, note ) )
892
_backend.addContactNote( id, note );
894
// and add this note to the cache to prevent a addition of duplicate
895
// date from another file
896
_contacts_cache.addAssociatedNote( id, note );
591
ContentValues values = new ContentValues();
592
values.put( Contacts.ContactMethods.KIND, Contacts.KIND_POSTAL );
593
values.put( Contacts.ContactMethods.DATA, address.getAddress() );
594
values.put( Contacts.ContactMethods.TYPE, address.getType() );
595
_doit.getContentResolver().insert( contactContactMethodsUri,
598
// and add this address to the cache to prevent a addition of
599
// duplicate date from another file
600
_contactsCache.addAddress( contactId, address.getAddress() );
901
604
synchronized protected void checkAbort() throws AbortImportException