/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-06-11 12:15:09 UTC
  • Revision ID: edam@waxworlds.org-20110611121509-7ntgiu8fm43ral19
- bump version no. to 1.2
- fix header comment
- added support for LABEL fields

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
26
import java.util.Arrays;
27
27
import java.util.HashMap;
28
28
import java.util.HashSet;
29
29
import java.util.Iterator;
30
 
import java.util.Locale;
31
30
import java.util.Set;
32
31
import java.util.regex.Matcher;
33
32
import java.util.regex.Pattern;
34
33
 
35
 
import am.ed.importcontacts.Backend.ContactCreationException;
 
34
import android.content.ContentUris;
 
35
import android.content.ContentValues;
36
36
import android.content.SharedPreferences;
 
37
import android.net.Uri;
37
38
import android.os.Message;
 
39
import android.provider.Contacts;
 
40
import android.provider.Contacts.PhonesColumns;
 
41
 
38
42
 
39
43
public class Importer extends Thread
40
44
{
55
59
        private boolean _abort = false;
56
60
        private boolean _is_finished = false;
57
61
        private ContactsCache _contacts_cache = null;
58
 
        private Backend _backend = null;
59
62
 
60
63
        /**
61
64
         * Data about a contact
62
65
         */
63
66
        public class ContactData
64
67
        {
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
68
                class TypeDetail
73
69
                {
74
70
                        protected int _type;
232
228
                                        new PreferredDetail( type, false ) );
233
229
 
234
230
                        final Set< Integer > non_voice_types = new HashSet< Integer >(
235
 
                                Arrays.asList( TYPE_FAX_HOME, TYPE_FAX_WORK, TYPE_PAGER ) );
 
231
                                Arrays.asList( PhonesColumns.TYPE_FAX_HOME,
 
232
                                        PhonesColumns.TYPE_FAX_WORK, PhonesColumns.TYPE_PAGER ) );
236
233
 
237
234
                        // if this is the first number added, or it's a preferred number
238
235
                        // and the current primary number isn't, or this number is on equal
277
274
                        email = sanitisesEmailAddress( email );
278
275
                        if( email == null )
279
276
                        {
280
 
                                // TODO: warn that an imported email address is being ignored
 
277
                                // TODO: warn that an imported email addtrss is being ignored
281
278
                                return;
282
279
                        }
283
280
 
399
396
                        Matcher m = p.matcher( email );
400
397
                        if( m.matches() ) {
401
398
                                String[] bits = email.split( "@" );
402
 
                                return bits[ 0 ] + "@" + bits[ 1 ].toLowerCase( Locale.US );
 
399
                                return bits[ 0 ] + "@" + bits[ 1 ].toLowerCase();
403
400
                        }
404
401
                        return null;
405
402
                }
424
421
                        // update UI
425
422
                        setProgressMessage( R.string.doit_caching );
426
423
 
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
 
424
                        // build a cache of existing contacts
434
425
                        _contacts_cache = new ContactsCache();
435
 
                        _backend.populateCache( _contacts_cache );
 
426
                        _contacts_cache.buildCache( _doit );
436
427
 
437
428
                        // do the import
438
429
                        onImport();
565
556
                checkAbort();
566
557
                _doit._handler.sendMessage( Message.obtain(
567
558
                        _doit._handler, Doit.MESSAGE_SETMAXPROGRESS,
568
 
                        Integer.valueOf( max_progress ) ) );
 
559
                        new Integer( max_progress ) ) );
569
560
        }
570
561
 
571
562
        protected void setTmpProgress( int tmp_progress )
574
565
                checkAbort();
575
566
                _doit._handler.sendMessage( Message.obtain(
576
567
                        _doit._handler, Doit.MESSAGE_SETTMPPROGRESS,
577
 
                        Integer.valueOf( tmp_progress ) ) );
 
568
                        new Integer( tmp_progress ) ) );
578
569
        }
579
570
 
580
571
        protected void setProgress( int progress ) throws AbortImportException
582
573
                checkAbort();
583
574
                _doit._handler.sendMessage( Message.obtain(
584
575
                        _doit._handler, Doit.MESSAGE_SETPROGRESS,
585
 
                        Integer.valueOf( progress ) ) );
 
576
                        new Integer( progress ) ) );
586
577
        }
587
578
 
588
579
        protected void finish( int action ) throws AbortImportException
606
597
                return _doit.getText( res );
607
598
        }
608
599
 
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
 
600
        synchronized private boolean checkForDuplicate(
 
601
                ContactsCache.CacheIdentifier cache_identifier, int merge_setting )
 
602
                throws AbortImportException
620
603
        {
621
604
                _last_merge_decision = merge_setting;
622
605
 
 
606
                // it is ok to use contact.getCacheIdentifier(). The contact has already
 
607
                // been finalised, which means a valid cache identifier will have been
 
608
                // created for it (or it would have been skipped)
 
609
 
623
610
                // handle special cases
624
611
                switch( merge_setting )
625
612
                {
626
613
                case Doit.ACTION_KEEP:
627
 
                        // if we are skipping on a duplicate, check for one
628
 
                        return exists;
 
614
                        // if we keep contacts on duplicate, we better check for one
 
615
                        return !_contacts_cache.canLookup( cache_identifier );
629
616
 
630
617
                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;
 
618
                        // if we are prompting on duplicate, we better check for one and if
 
619
                        // the contact doesn'te exist, we want to import it
 
620
                        if( !_contacts_cache.canLookup( cache_identifier ) )
 
621
                                return true;
634
622
 
635
 
                        // ok, duplicate exists, so do prompt
 
623
                        // ok, it exists, so do prompt
636
624
                        _doit._handler.sendMessage( Message.obtain( _doit._handler,
637
 
                                Doit.MESSAGE_MERGEPROMPT, contact_detail ) );
 
625
                                Doit.MESSAGE_MERGEPROMPT, cache_identifier.getDetail() ) );
638
626
                        try {
639
627
                                wait();
640
628
                        }
648
636
                                _merge_setting = _response;
649
637
 
650
638
                        // recurse, with our new merge setting
651
 
                        return shouldWeSkipContact( contact_detail, exists, _response );
 
639
                        return checkForDuplicate( cache_identifier, _response );
652
640
                }
653
641
 
654
 
                // for all other cases (either overwriting or merging) we don't skip
655
 
                return false;
 
642
                // for all other cases (either overwriting or merging) we will need the
 
643
                // imported data
 
644
                return true;
656
645
        }
657
646
 
658
647
        protected void skipContact() throws AbortImportException
659
648
        {
660
649
                checkAbort();
661
 
 
662
 
                // show that we're skipping a new contact
663
650
                _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTSKIPPED );
664
651
        }
665
652
 
674
661
                ContactsCache.CacheIdentifier cache_identifier =
675
662
                        contact.getCacheIdentifier();
676
663
 
 
664
                // check to see if this contact is a duplicate and should be skipped
 
665
                if( !checkForDuplicate( cache_identifier, _merge_setting ) ) {
 
666
                        skipContact();
 
667
                        return;
 
668
                }
 
669
 
677
670
//              if( !showContinue( "====[ IMPORTING ]====\n: " + contact._name ) )
678
671
//                      finish( ACTION_ABORT );
679
672
 
 
673
                // keep track of whether we've informed the UI of what we're doing
 
674
                boolean ui_informed = false;
 
675
 
680
676
                // attempt to lookup the id of an existing contact in the cache with
681
677
                // this contact data's cache identifier
682
678
                Long id = (Long)_contacts_cache.lookup( cache_identifier );
683
679
 
684
 
                // check to see if this contact should be skipped
685
 
                if( shouldWeSkipContact( cache_identifier.getDetail(), id != null,
686
 
                        _merge_setting ) )
 
680
                // does contact exist already?
 
681
                if( id != null )
687
682
                {
688
 
                        // show that we're skipping a contact
689
 
                        _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTSKIPPED );
690
 
                        return;
 
683
                        // should we skip this import altogether?
 
684
                        if( _last_merge_decision == Doit.ACTION_KEEP ) return;
 
685
 
 
686
                        // get contact's URI
 
687
                        Uri contact_uri = ContentUris.withAppendedId(
 
688
                                Contacts.People.CONTENT_URI, id );
 
689
 
 
690
                        // should we destroy the existing contact before importing?
 
691
                        if( _last_merge_decision == Doit.ACTION_OVERWRITE )
 
692
                        {
 
693
                                // remove from device
 
694
                                _doit.getContentResolver().delete( contact_uri, null, null );
 
695
 
 
696
                                // update cache
 
697
                                _contacts_cache.removeLookup( contact.getCacheIdentifier() );
 
698
                                _contacts_cache.removeAssociatedData( id );
 
699
 
 
700
                                // show that we're overwriting a contact
 
701
                                _doit._handler.sendEmptyMessage(
 
702
                                                Doit.MESSAGE_CONTACTOVERWRITTEN );
 
703
                                ui_informed = true;
 
704
 
 
705
                                // discard the contact id
 
706
                                id = null;
 
707
                        }
691
708
                }
692
709
 
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 )
 
710
                // if we don't have a contact id yet (or if we did, but we destroyed it
 
711
                // when we deleted the contact), we'll have to create a new contact
 
712
                if( id == null )
697
713
                {
698
 
                        contact_deleted = true;
 
714
                        // create a new contact
 
715
                        ContentValues values = new ContentValues();
 
716
                        values.put( Contacts.People.NAME, contact._name );
 
717
                        Uri contact_uri = _doit.getContentResolver().insert(
 
718
                                Contacts.People.CONTENT_URI, values );
 
719
                        id = ContentUris.parseId( contact_uri );
 
720
                        if( id == null || id <= 0 )
 
721
                                showError( R.string.error_unabletoaddcontact );
699
722
 
700
 
                        // remove from device
701
 
                        _backend.deleteContact( id );
 
723
                        // try to add them to the "My Contacts" group
 
724
                        try {
 
725
                                Contacts.People.addToMyContactsGroup(
 
726
                                        _doit.getContentResolver(), id );
 
727
                        }
 
728
                        catch( IllegalStateException e ) {
 
729
                                // ignore any failure
 
730
                        }
702
731
 
703
732
                        // 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 );
 
733
                        _contacts_cache.addLookup(
 
734
                                ContactsCache.createIdentifier( contact ), id );
 
735
 
 
736
                        // if we haven't already shown that we're overwriting a contact,
 
737
                        // show that we're creating a new contact
 
738
                        if( !ui_informed ) {
 
739
                                _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTCREATED );
 
740
                                ui_informed = true;
730
741
                        }
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
 
                }
 
742
                }
 
743
 
 
744
                // if we haven't already shown that we're overwriting or creating a
 
745
                // contact, show that we're merging a contact
 
746
                if( !ui_informed )
 
747
                        _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTMERGED );
 
748
 
 
749
                // import contact parts
 
750
                if( contact.hasNumbers() )
 
751
                        importContactPhones( id, contact.getNumbers() );
 
752
                if( contact.hasEmails() )
 
753
                        importContactEmails( id, contact.getEmails() );
 
754
                if( contact.hasAddresses() )
 
755
                        importContactAddresses( id, contact.getAddresses() );
 
756
                if( contact.hasOrganisations() )
 
757
                        importContactOrganisations( id, contact.getOrganisations() );
749
758
        }
750
759
 
751
760
        private void importContactPhones( Long id,
752
 
                HashMap< String, ContactData.PreferredDetail > datas )
753
 
                throws ContactCreationException
 
761
                        HashMap< String, ContactData.PreferredDetail > datas )
754
762
        {
 
763
                // get URI to contact's phones
 
764
                Uri contact_phones_uri = Uri.withAppendedPath(
 
765
                        ContentUris.withAppendedId( Contacts.People.CONTENT_URI, id ),
 
766
                        Contacts.People.Phones.CONTENT_DIRECTORY );
 
767
                Set< String > datas_keys = datas.keySet();
 
768
 
755
769
                // add phone numbers
756
 
                Set< String > datas_keys = datas.keySet();
757
770
                Iterator< String > i = datas_keys.iterator();
758
771
                while( i.hasNext() ) {
759
772
                        String number = i.next();
770
783
                                continue;
771
784
 
772
785
                        // add phone number
773
 
                        _backend.addContactPhone( id, number, data );
 
786
                        ContentValues values = new ContentValues();
 
787
                        values.put( Contacts.Phones.TYPE, data.getType() );
 
788
                        values.put( Contacts.Phones.NUMBER, number );
 
789
                        if( data.isPreferred() )
 
790
                                values.put( Contacts.Phones.ISPRIMARY, 1 );
 
791
                        _doit.getContentResolver().insert( contact_phones_uri, values );
774
792
 
775
793
                        // and add this address to the cache to prevent a addition of
776
794
                        // duplicate date from another file
779
797
        }
780
798
 
781
799
        private void importContactEmails( Long id,
782
 
                HashMap< String, ContactData.PreferredDetail > datas )
783
 
                throws ContactCreationException
 
800
                        HashMap< String, ContactData.PreferredDetail > datas )
784
801
        {
 
802
                // get URI to contact's contact methods
 
803
                Uri contact_contact_methods_uri = Uri.withAppendedPath(
 
804
                        ContentUris.withAppendedId( Contacts.People.CONTENT_URI, id ),
 
805
                        Contacts.People.ContactMethods.CONTENT_DIRECTORY );
 
806
                Set< String > datas_keys = datas.keySet();
 
807
 
785
808
                // add email addresses
786
 
                Set< String > datas_keys = datas.keySet();
787
809
                Iterator< String > i = datas_keys.iterator();
788
810
                while( i.hasNext() ) {
789
811
                        String email = i.next();
795
817
                                continue;
796
818
 
797
819
                        // add phone number
798
 
                        _backend.addContactEmail( id, email, data );
 
820
                        ContentValues values = new ContentValues();
 
821
                        values.put( Contacts.ContactMethods.KIND, Contacts.KIND_EMAIL );
 
822
                        values.put( Contacts.ContactMethods.DATA, email );
 
823
                        values.put( Contacts.ContactMethods.TYPE, data.getType() );
 
824
                        if( data.isPreferred() )
 
825
                                values.put( Contacts.ContactMethods.ISPRIMARY, 1 );
 
826
                        _doit.getContentResolver().insert( contact_contact_methods_uri,
 
827
                                values );
799
828
 
800
829
                        // and add this address to the cache to prevent a addition of
801
830
                        // duplicate date from another file
805
834
 
806
835
        private void importContactAddresses( Long id,
807
836
                HashMap< String, ContactData.TypeDetail > datas )
808
 
                throws ContactCreationException
809
837
        {
 
838
                // get URI to contact's contact methods
 
839
                Uri contact_contact_methods_uri = Uri.withAppendedPath(
 
840
                        ContentUris.withAppendedId( Contacts.People.CONTENT_URI, id ),
 
841
                        Contacts.People.ContactMethods.CONTENT_DIRECTORY );
 
842
 
810
843
                // add addresses
811
844
                Set< String > datas_keys = datas.keySet();
812
845
                Iterator< String > i = datas_keys.iterator();
820
853
                                continue;
821
854
 
822
855
                        // add postal address
823
 
                        _backend.addContactAddresses( id, address, data );
 
856
                        ContentValues values = new ContentValues();
 
857
                        values.put( Contacts.ContactMethods.KIND, Contacts.KIND_POSTAL );
 
858
                        values.put( Contacts.ContactMethods.DATA, address );
 
859
                        values.put( Contacts.ContactMethods.TYPE, data.getType() );
 
860
                        _doit.getContentResolver().insert( contact_contact_methods_uri,
 
861
                                values );
824
862
 
825
863
                        // and add this address to the cache to prevent a addition of
826
864
                        // duplicate date from another file
830
868
 
831
869
        private void importContactOrganisations( Long id,
832
870
                HashMap< String, ContactData.ExtraDetail > datas )
833
 
                throws ContactCreationException
834
871
        {
835
872
                // add addresses
836
873
                Set< String > datas_keys = datas.keySet();
845
882
                                continue;
846
883
 
847
884
                        // add organisation address
848
 
                        _backend.addContactOrganisation( id, organisation, data );
 
885
                        ContentValues values = new ContentValues();
 
886
                        values.put( Contacts.Organizations.PERSON_ID, id );
 
887
                        values.put( Contacts.Organizations.COMPANY, organisation );
 
888
                        values.put( Contacts.ContactMethods.TYPE,
 
889
                                Contacts.OrganizationColumns.TYPE_WORK );
 
890
                        if( data.getExtra() != null )
 
891
                                values.put( Contacts.Organizations.TITLE, data.getExtra() );
 
892
                        _doit.getContentResolver().insert(
 
893
                                Contacts.Organizations.CONTENT_URI, values );
849
894
 
850
895
                        // and add this address to the cache to prevent a addition of
851
896
                        // duplicate date from another file