/android/import-contacts

To get this branch, use:
bzr branch http://bzr.ed.am/android/import-contacts

« back to all changes in this revision

Viewing changes to src/org/waxworlds/edam/importcontacts/Importer.java

  • Committer: edam
  • Date: 2011-05-30 19:20:17 UTC
  • Revision ID: edam@waxworlds.org-20110530192017-5c09k4kgpov02gja
- added checks for Doit.this == null when handling dialog buttons (I managed to abort an import as a duplicate contacts dialog was shown, but can't reproduce it now)
- added line no.s to vcard parsing errors
- update progress bar after a contact is imported, not before
- fixed bug introduced in last commit where a contacts were imported after finaliseVcard()ing failed
- don't show unknown encoding errors for vcard fields that we don't care about (which ignores base64 encoded photos, for example)

Show diffs side-by-side

added added

removed removed

src/org/waxworlds/edam/importcontacts/Importer.java
1
1
/*
2
2
 * Importer.java
3
3
 *
4
 
 * Copyright (C) 2009 to 2012 Tim Marston <tim@ed.am>
 
4
 * Copyright (C) 2009 to 2011 Tim Marston <edam@waxworlds.org>
5
5
 *
6
6
 * This file is part of the Import Contacts program (hereafter referred
7
7
 * to as "this program"). For more information, see
8
 
 * http://ed.am/dev/android/import-contacts
 
8
 * http://www.waxworlds.org/edam/software/android/import-contacts
9
9
 *
10
10
 * This program is free software: you can redistribute it and/or modify
11
11
 * it under the terms of the GNU General Public License as published by
21
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
22
 */
23
23
 
24
 
package am.ed.importcontacts;
 
24
package org.waxworlds.edam.importcontacts;
25
25
 
26
 
import java.util.Arrays;
27
26
import java.util.HashMap;
28
 
import java.util.HashSet;
29
27
import java.util.Iterator;
30
 
import java.util.Locale;
31
28
import java.util.Set;
32
29
import java.util.regex.Matcher;
33
30
import java.util.regex.Pattern;
34
31
 
35
 
import am.ed.importcontacts.Backend.ContactCreationException;
 
32
import android.content.ContentUris;
 
33
import android.content.ContentValues;
36
34
import android.content.SharedPreferences;
 
35
import android.net.Uri;
37
36
import android.os.Message;
 
37
import android.provider.Contacts;
 
38
 
38
39
 
39
40
public class Importer extends Thread
40
41
{
55
56
        private boolean _abort = false;
56
57
        private boolean _is_finished = false;
57
58
        private ContactsCache _contacts_cache = null;
58
 
        private Backend _backend = null;
59
59
 
60
60
        /**
61
61
         * Data about a contact
62
62
         */
63
63
        public class ContactData
64
64
        {
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
71
 
 
72
65
                class TypeDetail
73
66
                {
74
67
                        protected int _type;
131
124
 
132
125
                protected String _name = null;
133
126
                protected String _primary_organisation = null;
134
 
                protected boolean _primary_organisation_is_preferred;
 
127
                protected boolean _primary_organisation_is_preferred = false;
135
128
                protected String _primary_number = null;
136
 
                protected int _primary_number_type;
137
 
                protected boolean _primary_number_is_preferred;
 
129
                protected boolean _primary_number_is_preferred = false;
138
130
                protected String _primary_email = null;
139
 
                protected boolean _primary_email_is_preferred;
 
131
                protected boolean _primary_email_is_preferred = false;
140
132
                protected HashMap< String, ExtraDetail > _organisations = null;
141
133
                protected HashMap< String, PreferredDetail > _numbers = null;
142
134
                protected HashMap< String, PreferredDetail > _emails = null;
183
175
                                        new ExtraDetail( 0, false, title ) );
184
176
 
185
177
                        // if this is the first organisation added, or it's a preferred
186
 
                        // organisation and the current primary organisation isn't, then
187
 
                        // record this as the primary organisation.
 
178
                        // organisation and a previous organisation wasn't, then remember
 
179
                        // that this is the "primary organisation".
188
180
                        if( _primary_organisation == null ||
189
181
                                ( is_preferred && !_primary_organisation_is_preferred ) )
190
182
                        {
231
223
                                _numbers.put( number,
232
224
                                        new PreferredDetail( type, false ) );
233
225
 
234
 
                        final Set< Integer > non_voice_types = new HashSet< Integer >(
235
 
                                Arrays.asList( TYPE_FAX_HOME, TYPE_FAX_WORK, TYPE_PAGER ) );
236
 
 
237
226
                        // if this is the first number added, or it's a preferred number
238
 
                        // and the current primary number isn't, or this number is on equal
239
 
                        // standing with the primary number in terms of preference and it is
240
 
                        // a voice number and the primary number isn't, then record this as
241
 
                        // the primary number.
 
227
                        // and a previous number wasn't, then remember that this is the
 
228
                        // "primary number".
242
229
                        if( _primary_number == null ||
243
 
                                ( is_preferred && !_primary_number_is_preferred ) ||
244
 
                                ( is_preferred == _primary_number_is_preferred &&
245
 
                                        !non_voice_types.contains( type ) &&
246
 
                                        non_voice_types.contains( _primary_number_type ) ) )
 
230
                                ( is_preferred && !_primary_number_is_preferred ) )
247
231
                        {
248
232
                                _primary_number = number;
249
 
                                _primary_number_type = type;
250
233
                                _primary_number_is_preferred = is_preferred;
251
234
                        }
252
235
                }
277
260
                        email = sanitisesEmailAddress( email );
278
261
                        if( email == null )
279
262
                        {
280
 
                                // TODO: warn that an imported email address is being ignored
 
263
                                // TODO: warn that an imported email addtrss is being ignored
281
264
                                return;
282
265
                        }
283
266
 
288
271
                        if( !_emails.containsKey( email ) )
289
272
                                _emails.put( email, new PreferredDetail( type, false ) );
290
273
 
291
 
                        // if this is the first email added, or it's a preferred email and
292
 
                        // the current primary organisation isn't, then record this as the
293
 
                        // primary email.
 
274
                        // if this is the first email added, or it's a preferred email
 
275
                        // and a previous email wasn't, then remember that this is the
 
276
                        // "primary email".
294
277
                        if( _primary_email == null ||
295
278
                                ( is_preferred && !_primary_email_is_preferred ) )
296
279
                        {
399
382
                        Matcher m = p.matcher( email );
400
383
                        if( m.matches() ) {
401
384
                                String[] bits = email.split( "@" );
402
 
                                return bits[ 0 ] + "@" + bits[ 1 ].toLowerCase( Locale.US );
 
385
                                return bits[ 0 ] + "@" + bits[ 1 ].toLowerCase();
403
386
                        }
404
387
                        return null;
405
388
                }
424
407
                        // update UI
425
408
                        setProgressMessage( R.string.doit_caching );
426
409
 
427
 
                        // create the appropriate backend
428
 
//                      if( Integer.parseInt( android.os.Build.VERSION.SDK ) >= 5 )
429
 
//                              _backend = new ContactsContractBackend( _doit );
430
 
//                      else
431
 
                                _backend = new ContactsBackend( _doit );
432
 
 
433
 
                        // create a cache of existing contacts and populate it
 
410
                        // build a cache of existing contacts
434
411
                        _contacts_cache = new ContactsCache();
435
 
                        _backend.populateCache( _contacts_cache );
 
412
                        _contacts_cache.buildCache( _doit );
436
413
 
437
414
                        // do the import
438
415
                        onImport();
565
542
                checkAbort();
566
543
                _doit._handler.sendMessage( Message.obtain(
567
544
                        _doit._handler, Doit.MESSAGE_SETMAXPROGRESS,
568
 
                        Integer.valueOf( max_progress ) ) );
 
545
                        new Integer( max_progress ) ) );
569
546
        }
570
547
 
571
548
        protected void setTmpProgress( int tmp_progress )
574
551
                checkAbort();
575
552
                _doit._handler.sendMessage( Message.obtain(
576
553
                        _doit._handler, Doit.MESSAGE_SETTMPPROGRESS,
577
 
                        Integer.valueOf( tmp_progress ) ) );
 
554
                        new Integer( tmp_progress ) ) );
578
555
        }
579
556
 
580
557
        protected void setProgress( int progress ) throws AbortImportException
582
559
                checkAbort();
583
560
                _doit._handler.sendMessage( Message.obtain(
584
561
                        _doit._handler, Doit.MESSAGE_SETPROGRESS,
585
 
                        Integer.valueOf( progress ) ) );
 
562
                        new Integer( progress ) ) );
586
563
        }
587
564
 
588
565
        protected void finish( int action ) throws AbortImportException
606
583
                return _doit.getText( res );
607
584
        }
608
585
 
609
 
        /**
610
 
         * Should we skip a contact, given whether it exists or not and the current
611
 
         * merge setting?  This routine handles throwing up a prompt, if required.
612
 
         * @param contact_detail the display name of the contact
613
 
         * @param exists true if this contact matches one in the cache
614
 
         * @param merge_setting the merge setting to use
615
 
         * @return true if the contact should be skipped outright
616
 
         * @throws AbortImportException
617
 
         */
618
 
        synchronized private boolean shouldWeSkipContact( String contact_detail,
619
 
                boolean exists, int merge_setting ) throws AbortImportException
 
586
        synchronized private boolean checkForDuplicate(
 
587
                ContactsCache.CacheIdentifier cache_identifier, int merge_setting )
 
588
                throws AbortImportException
620
589
        {
621
590
                _last_merge_decision = merge_setting;
622
591
 
 
592
                // it is ok to use contact.getCacheIdentifier(). The contact has already
 
593
                // been finalised, which means a valid cache identifier will have been
 
594
                // created for it (or it would have been skipped)
 
595
 
623
596
                // handle special cases
624
597
                switch( merge_setting )
625
598
                {
626
599
                case Doit.ACTION_KEEP:
627
 
                        // if we are skipping on a duplicate, check for one
628
 
                        return exists;
 
600
                        // if we keep contacts on duplicate, we better check for one
 
601
                        return !_contacts_cache.canLookup( cache_identifier );
629
602
 
630
603
                case Doit.ACTION_PROMPT:
631
 
                        // if we are prompting on duplicate, then we can say that we won't
632
 
                        // skip if there isn't one
633
 
                        if( !exists ) return false;
 
604
                        // if we are prompting on duplicate, we better check for one and if
 
605
                        // the contact doesn'te exist, we want to import it
 
606
                        if( !_contacts_cache.canLookup( cache_identifier ) )
 
607
                                return true;
634
608
 
635
 
                        // ok, duplicate exists, so do prompt
 
609
                        // ok, it exists, so do prompt
636
610
                        _doit._handler.sendMessage( Message.obtain( _doit._handler,
637
 
                                Doit.MESSAGE_MERGEPROMPT, contact_detail ) );
 
611
                                Doit.MESSAGE_MERGEPROMPT, cache_identifier.getDetail() ) );
638
612
                        try {
639
613
                                wait();
640
614
                        }
648
622
                                _merge_setting = _response;
649
623
 
650
624
                        // recurse, with our new merge setting
651
 
                        return shouldWeSkipContact( contact_detail, exists, _response );
 
625
                        return checkForDuplicate( cache_identifier, _response );
652
626
                }
653
627
 
654
 
                // for all other cases (either overwriting or merging) we don't skip
655
 
                return false;
 
628
                // for all other cases (either overwriting or merging) we will need the
 
629
                // imported data
 
630
                return true;
656
631
        }
657
632
 
658
633
        protected void skipContact() throws AbortImportException
659
634
        {
660
635
                checkAbort();
661
 
 
662
 
                // show that we're skipping a new contact
663
636
                _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTSKIPPED );
664
637
        }
665
638
 
674
647
                ContactsCache.CacheIdentifier cache_identifier =
675
648
                        contact.getCacheIdentifier();
676
649
 
 
650
                // check to see if this contact is a duplicate and should be skipped
 
651
                if( !checkForDuplicate( cache_identifier, _merge_setting ) ) {
 
652
                        skipContact();
 
653
                        return;
 
654
                }
 
655
 
677
656
//              if( !showContinue( "====[ IMPORTING ]====\n: " + contact._name ) )
678
657
//                      finish( ACTION_ABORT );
679
658
 
 
659
                // keep track of whether we've informed the UI of what we're doing
 
660
                boolean ui_informed = false;
 
661
 
680
662
                // attempt to lookup the id of an existing contact in the cache with
681
663
                // this contact data's cache identifier
682
664
                Long id = (Long)_contacts_cache.lookup( cache_identifier );
683
665
 
684
 
                // check to see if this contact should be skipped
685
 
                if( shouldWeSkipContact( cache_identifier.getDetail(), id != null,
686
 
                        _merge_setting ) )
 
666
                // does contact exist already?
 
667
                if( id != null )
687
668
                {
688
 
                        // show that we're skipping a contact
689
 
                        _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTSKIPPED );
690
 
                        return;
 
669
                        // should we skip this import altogether?
 
670
                        if( _last_merge_decision == Doit.ACTION_KEEP ) return;
 
671
 
 
672
                        // get contact's URI
 
673
                        Uri contact_uri = ContentUris.withAppendedId(
 
674
                                Contacts.People.CONTENT_URI, id );
 
675
 
 
676
                        // should we destroy the existing contact before importing?
 
677
                        if( _last_merge_decision == Doit.ACTION_OVERWRITE )
 
678
                        {
 
679
                                // remove from device
 
680
                                _doit.getContentResolver().delete( contact_uri, null, null );
 
681
 
 
682
                                // update cache
 
683
                                _contacts_cache.removeLookup( contact.getCacheIdentifier() );
 
684
                                _contacts_cache.removeAssociatedData( id );
 
685
 
 
686
                                // show that we're overwriting a contact
 
687
                                _doit._handler.sendEmptyMessage(
 
688
                                                Doit.MESSAGE_CONTACTOVERWRITTEN );
 
689
                                ui_informed = true;
 
690
 
 
691
                                // discard the contact id
 
692
                                id = null;
 
693
                        }
691
694
                }
692
695
 
693
 
                // if a contact exists, and we're overwriting, destroy the existing
694
 
                // contact before importing
695
 
                boolean contact_deleted = false;
696
 
                if( id != null && _last_merge_decision == Doit.ACTION_OVERWRITE )
 
696
                // if we don't have a contact id yet (or if we did, but we destroyed it
 
697
                // when we deleted the contact), we'll have to create a new contact
 
698
                if( id == null )
697
699
                {
698
 
                        contact_deleted = true;
 
700
                        // create a new contact
 
701
                        ContentValues values = new ContentValues();
 
702
                        values.put( Contacts.People.NAME, contact._name );
 
703
                        Uri contact_uri = _doit.getContentResolver().insert(
 
704
                                Contacts.People.CONTENT_URI, values );
 
705
                        id = ContentUris.parseId( contact_uri );
 
706
                        if( id == null || id <= 0 )
 
707
                                showError( R.string.error_unabletoaddcontact );
699
708
 
700
 
                        // remove from device
701
 
                        _backend.deleteContact( id );
 
709
                        // try to add them to the "My Contacts" group
 
710
                        try {
 
711
                                Contacts.People.addToMyContactsGroup(
 
712
                                        _doit.getContentResolver(), id );
 
713
                        }
 
714
                        catch( IllegalStateException e ) {
 
715
                                // ignore any failure
 
716
                        }
702
717
 
703
718
                        // update cache
704
 
                        _contacts_cache.removeLookup( cache_identifier );
705
 
                        _contacts_cache.removeAssociatedData( id );
706
 
 
707
 
                        // show that we're overwriting a contact
708
 
                        _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTOVERWRITTEN );
709
 
 
710
 
                        // discard the contact id
711
 
                        id = null;
712
 
                }
713
 
 
714
 
                try {
715
 
                        // if we don't have a contact id yet (or we did, but we destroyed it
716
 
                        // when we deleted the contact), we'll have to create a new contact
717
 
                        if( id == null )
718
 
                        {
719
 
                                // create a new contact
720
 
                                id = _backend.addContact( contact._name );
721
 
 
722
 
                                // update cache
723
 
                                _contacts_cache.addLookup( cache_identifier, id );
724
 
 
725
 
                                // if we haven't already shown that we're overwriting a contact,
726
 
                                // show that we're creating a new contact
727
 
                                if( !contact_deleted )
728
 
                                        _doit._handler.sendEmptyMessage(
729
 
                                                Doit.MESSAGE_CONTACTCREATED );
 
719
                        _contacts_cache.addLookup(
 
720
                                ContactsCache.createIdentifier( contact ), id );
 
721
 
 
722
                        // if we haven't already shown that we're overwriting a contact,
 
723
                        // show that we're creating a new contact
 
724
                        if( !ui_informed ) {
 
725
                                _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTCREATED );
 
726
                                ui_informed = true;
730
727
                        }
731
 
                        else
732
 
                                // show that we're merging with an existing contact
733
 
                                _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTMERGED );
734
 
 
735
 
                        // import contact parts
736
 
                        if( contact.hasNumbers() )
737
 
                                importContactPhones( id, contact.getNumbers() );
738
 
                        if( contact.hasEmails() )
739
 
                                importContactEmails( id, contact.getEmails() );
740
 
                        if( contact.hasAddresses() )
741
 
                                importContactAddresses( id, contact.getAddresses() );
742
 
                        if( contact.hasOrganisations() )
743
 
                                importContactOrganisations( id, contact.getOrganisations() );
744
 
                }
745
 
                catch( Backend.ContactCreationException e )
746
 
                {
747
 
                        showError( R.string.error_unabletoaddcontact );
748
 
                }
 
728
                }
 
729
 
 
730
                // if we haven't already shown that we're overwriting or creating a
 
731
                // contact, show that we're merging a contact
 
732
                if( !ui_informed )
 
733
                        _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTMERGED );
 
734
 
 
735
                // import contact parts
 
736
                if( contact.hasNumbers() )
 
737
                        importContactPhones( id, contact.getNumbers() );
 
738
                if( contact.hasEmails() )
 
739
                        importContactEmails( id, contact.getEmails() );
 
740
                if( contact.hasAddresses() )
 
741
                        importContactAddresses( id, contact.getAddresses() );
 
742
                if( contact.hasOrganisations() )
 
743
                        importContactOrganisations( id, contact.getOrganisations() );
749
744
        }
750
745
 
751
746
        private void importContactPhones( Long id,
752
 
                HashMap< String, ContactData.PreferredDetail > datas )
753
 
                throws ContactCreationException
 
747
                        HashMap< String, ContactData.PreferredDetail > datas )
754
748
        {
 
749
                // get URI to contact's phones
 
750
                Uri contact_phones_uri = Uri.withAppendedPath(
 
751
                        ContentUris.withAppendedId( Contacts.People.CONTENT_URI, id ),
 
752
                        Contacts.People.Phones.CONTENT_DIRECTORY );
 
753
                Set< String > datas_keys = datas.keySet();
 
754
 
755
755
                // add phone numbers
756
 
                Set< String > datas_keys = datas.keySet();
757
756
                Iterator< String > i = datas_keys.iterator();
758
757
                while( i.hasNext() ) {
759
758
                        String number = i.next();
770
769
                                continue;
771
770
 
772
771
                        // add phone number
773
 
                        _backend.addContactPhone( id, number, data );
 
772
                        ContentValues values = new ContentValues();
 
773
                        values.put( Contacts.Phones.TYPE, data.getType() );
 
774
                        values.put( Contacts.Phones.NUMBER, number );
 
775
                        if( data.isPreferred() )
 
776
                                values.put( Contacts.Phones.ISPRIMARY, 1 );
 
777
                        _doit.getContentResolver().insert( contact_phones_uri, values );
774
778
 
775
779
                        // and add this address to the cache to prevent a addition of
776
780
                        // duplicate date from another file
779
783
        }
780
784
 
781
785
        private void importContactEmails( Long id,
782
 
                HashMap< String, ContactData.PreferredDetail > datas )
783
 
                throws ContactCreationException
 
786
                        HashMap< String, ContactData.PreferredDetail > datas )
784
787
        {
 
788
                // get URI to contact's contact methods
 
789
                Uri contact_contact_methods_uri = Uri.withAppendedPath(
 
790
                        ContentUris.withAppendedId( Contacts.People.CONTENT_URI, id ),
 
791
                        Contacts.People.ContactMethods.CONTENT_DIRECTORY );
 
792
                Set< String > datas_keys = datas.keySet();
 
793
 
785
794
                // add email addresses
786
 
                Set< String > datas_keys = datas.keySet();
787
795
                Iterator< String > i = datas_keys.iterator();
788
796
                while( i.hasNext() ) {
789
797
                        String email = i.next();
795
803
                                continue;
796
804
 
797
805
                        // add phone number
798
 
                        _backend.addContactEmail( id, email, data );
 
806
                        ContentValues values = new ContentValues();
 
807
                        values.put( Contacts.ContactMethods.KIND, Contacts.KIND_EMAIL );
 
808
                        values.put( Contacts.ContactMethods.DATA, email );
 
809
                        values.put( Contacts.ContactMethods.TYPE, data.getType() );
 
810
                        if( data.isPreferred() )
 
811
                                values.put( Contacts.ContactMethods.ISPRIMARY, 1 );
 
812
                        _doit.getContentResolver().insert( contact_contact_methods_uri,
 
813
                                values );
799
814
 
800
815
                        // and add this address to the cache to prevent a addition of
801
816
                        // duplicate date from another file
805
820
 
806
821
        private void importContactAddresses( Long id,
807
822
                HashMap< String, ContactData.TypeDetail > datas )
808
 
                throws ContactCreationException
809
823
        {
 
824
                // get URI to contact's contact methods
 
825
                Uri contact_contact_methods_uri = Uri.withAppendedPath(
 
826
                        ContentUris.withAppendedId( Contacts.People.CONTENT_URI, id ),
 
827
                        Contacts.People.ContactMethods.CONTENT_DIRECTORY );
 
828
 
810
829
                // add addresses
811
830
                Set< String > datas_keys = datas.keySet();
812
831
                Iterator< String > i = datas_keys.iterator();
820
839
                                continue;
821
840
 
822
841
                        // add postal address
823
 
                        _backend.addContactAddresses( id, address, data );
 
842
                        ContentValues values = new ContentValues();
 
843
                        values.put( Contacts.ContactMethods.KIND, Contacts.KIND_POSTAL );
 
844
                        values.put( Contacts.ContactMethods.DATA, address );
 
845
                        values.put( Contacts.ContactMethods.TYPE, data.getType() );
 
846
                        _doit.getContentResolver().insert( contact_contact_methods_uri,
 
847
                                values );
824
848
 
825
849
                        // and add this address to the cache to prevent a addition of
826
850
                        // duplicate date from another file
830
854
 
831
855
        private void importContactOrganisations( Long id,
832
856
                HashMap< String, ContactData.ExtraDetail > datas )
833
 
                throws ContactCreationException
834
857
        {
835
858
                // add addresses
836
859
                Set< String > datas_keys = datas.keySet();
845
868
                                continue;
846
869
 
847
870
                        // add organisation address
848
 
                        _backend.addContactOrganisation( id, organisation, data );
 
871
                        ContentValues values = new ContentValues();
 
872
                        values.put( Contacts.Organizations.PERSON_ID, id );
 
873
                        values.put( Contacts.Organizations.COMPANY, organisation );
 
874
                        values.put( Contacts.ContactMethods.TYPE,
 
875
                                Contacts.OrganizationColumns.TYPE_WORK );
 
876
                        if( data.getExtra() != null )
 
877
                                values.put( Contacts.Organizations.TITLE, data.getExtra() );
 
878
                        _doit.getContentResolver().insert(
 
879
                                Contacts.Organizations.CONTENT_URI, values );
849
880
 
850
881
                        // and add this address to the cache to prevent a addition of
851
882
                        // duplicate date from another file