/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/am/ed/importcontacts/Importer.java

  • Committer: Tim Marston
  • Date: 2014-03-02 10:59:21 UTC
  • Revision ID: tim@ed.am-20140302105921-0q7ytfva236xsv8s
removed some unused code, fixed locale warnings and made showContinueOrAbort()
abort implicitly (rather than return false)

Show diffs side-by-side

added added

removed removed

src/am/ed/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 2013 Tim Marston <tim@ed.am>
5
5
 *
6
6
 * This file is part of the Import Contacts program (hereafter referred
7
 
 * to as "this program"). For more information, see
 
7
 * to as "this program").  For more information, see
8
8
 * http://ed.am/dev/android/import-contacts
9
9
 *
10
10
 * This program is free software: you can redistribute it and/or modify
27
27
import java.util.HashMap;
28
28
import java.util.HashSet;
29
29
import java.util.Iterator;
 
30
import java.util.Locale;
30
31
import java.util.Set;
31
32
import java.util.regex.Matcher;
32
33
import java.util.regex.Pattern;
33
34
 
 
35
import am.ed.importcontacts.Backend.ContactCreationException;
34
36
import android.content.SharedPreferences;
35
37
import android.os.Message;
36
 
import android.provider.Contacts.PhonesColumns;
37
38
 
38
39
public class Importer extends Thread
39
40
{
61
62
         */
62
63
        public class ContactData
63
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
 
64
72
                class TypeDetail
65
73
                {
66
74
                        protected int _type;
133
141
                protected HashMap< String, PreferredDetail > _numbers = null;
134
142
                protected HashMap< String, PreferredDetail > _emails = null;
135
143
                protected HashMap< String, TypeDetail > _addresses = null;
 
144
                protected HashSet< String > _notes = null;
 
145
                protected String _birthday = null;
136
146
 
137
147
                private ContactsCache.CacheIdentifier _cache_identifier = null;
138
148
 
176
186
 
177
187
                        // if this is the first organisation added, or it's a preferred
178
188
                        // organisation and the current primary organisation isn't, then
179
 
                        // record this as the primary organisation.
 
189
                        // record this as the primary organisation
180
190
                        if( _primary_organisation == null ||
181
191
                                ( is_preferred && !_primary_organisation_is_preferred ) )
182
192
                        {
224
234
                                        new PreferredDetail( type, false ) );
225
235
 
226
236
                        final Set< Integer > non_voice_types = new HashSet< Integer >(
227
 
                                Arrays.asList( PhonesColumns.TYPE_FAX_HOME,
228
 
                                        PhonesColumns.TYPE_FAX_WORK, PhonesColumns.TYPE_PAGER ) );
 
237
                                Arrays.asList( TYPE_FAX_HOME, TYPE_FAX_WORK, TYPE_PAGER ) );
229
238
 
230
239
                        // if this is the first number added, or it's a preferred number
231
240
                        // and the current primary number isn't, or this number is on equal
232
241
                        // standing with the primary number in terms of preference and it is
233
242
                        // a voice number and the primary number isn't, then record this as
234
 
                        // the primary number.
 
243
                        // the primary number
235
244
                        if( _primary_number == null ||
236
245
                                ( is_preferred && !_primary_number_is_preferred ) ||
237
246
                                ( is_preferred == _primary_number_is_preferred &&
283
292
 
284
293
                        // if this is the first email added, or it's a preferred email and
285
294
                        // the current primary organisation isn't, then record this as the
286
 
                        // primary email.
 
295
                        // primary email
287
296
                        if( _primary_email == null ||
288
297
                                ( is_preferred && !_primary_email_is_preferred ) )
289
298
                        {
337
346
                        return _addresses;
338
347
                }
339
348
 
 
349
                protected void addNote( String note )
 
350
                {
 
351
                        if( _notes == null ) _notes = new HashSet< String >();
 
352
                        if( !_notes.contains( note ) )
 
353
                                _notes.add( note );
 
354
                }
 
355
 
 
356
                public boolean hasNotes()
 
357
                {
 
358
                        return _notes != null && _notes.size() > 0;
 
359
                }
 
360
 
 
361
                public HashSet< String > getNotes()
 
362
                {
 
363
                        return _notes;
 
364
                }
 
365
 
 
366
                public void setBirthday( String birthday )
 
367
                {
 
368
                        _birthday = birthday;
 
369
                }
 
370
 
 
371
                public boolean hasBirthday()
 
372
                {
 
373
                        return _birthday != null;
 
374
                }
 
375
 
 
376
                public String getBirthday()
 
377
                {
 
378
                        return _birthday;
 
379
                }
 
380
 
340
381
                protected void finalise()
341
382
                        throws ContactNotIdentifiableException
342
383
                {
343
 
                        // ensure that if there is a primary number, it is preferred so
344
 
                        // that there is always one preferred number. Android will assign
 
384
                        // Ensure that if there is a primary number, it is preferred so
 
385
                        // that there is always one preferred number.  Android will assign
345
386
                        // preference to one anyway so we might as well decide one sensibly.
346
387
                        if( _primary_number != null ) {
347
388
                                PreferredDetail data = _numbers.get( _primary_number );
365
406
 
366
407
                        // create a cache identifier from this contact data, which can be
367
408
                        // used to look-up an existing contact
368
 
                        _cache_identifier = ContactsCache.createIdentifier( this );
 
409
                        _cache_identifier = ContactsCache.CacheIdentifier.factory( this );
369
410
                        if( _cache_identifier == null )
370
411
                                throw new ContactNotIdentifiableException();
371
412
                }
392
433
                        Matcher m = p.matcher( email );
393
434
                        if( m.matches() ) {
394
435
                                String[] bits = email.split( "@" );
395
 
                                return bits[ 0 ] + "@" + bits[ 1 ].toLowerCase();
 
436
                                return bits[ 0 ] + "@" +
 
437
                                        bits[ 1 ].toLowerCase( Locale.ENGLISH );
396
438
                        }
397
439
                        return null;
398
440
                }
418
460
                        setProgressMessage( R.string.doit_caching );
419
461
 
420
462
                        // create the appropriate backend
421
 
//                      if( Integer.parseInt( android.os.Build.VERSION.SDK ) >= 5 )
422
 
//                              _backend = new ContactsContractBackend( _doit );
423
 
//                      else
 
463
                        if( Integer.parseInt( android.os.Build.VERSION.SDK ) >= 5 )
 
464
                                _backend = new ContactsContractBackend( _doit );
 
465
                        else
424
466
                                _backend = new ContactsBackend( _doit );
425
467
 
426
468
                        // create a cache of existing contacts and populate it
502
544
                finish( ACTION_ABORT );
503
545
        }
504
546
 
505
 
        protected void showFatalError( int res ) throws AbortImportException
506
 
        {
507
 
                showFatalError( _doit.getText( res ).toString() );
508
 
        }
509
 
 
510
 
        synchronized protected void showFatalError( String message )
511
 
                        throws AbortImportException
512
 
        {
513
 
                checkAbort();
514
 
                _doit._handler.sendMessage( Message.obtain(
515
 
                        _doit._handler, Doit.MESSAGE_ERROR, message ) );
516
 
                try {
517
 
                        wait();
518
 
                }
519
 
                catch( InterruptedException e ) { }
520
 
 
521
 
                // no need to check if an abortion happened during the wait, we are
522
 
                // about to finish anyway!
523
 
                finish( ACTION_ABORT );
524
 
        }
525
 
 
526
 
        protected boolean showContinue( int res ) throws AbortImportException
527
 
        {
528
 
                return showContinue( _doit.getText( res ).toString() );
529
 
        }
530
 
 
531
 
        synchronized protected boolean showContinue( String message )
 
547
        protected void showContinueOrAbort( int res ) throws AbortImportException
 
548
        {
 
549
                showContinueOrAbort( _doit.getText( res ).toString() );
 
550
        }
 
551
 
 
552
        synchronized protected void showContinueOrAbort( String message )
532
553
                        throws AbortImportException
533
554
        {
534
555
                checkAbort();
539
560
                }
540
561
                catch( InterruptedException e ) { }
541
562
 
542
 
                // check if an abortion happened during the wait
543
 
                checkAbort();
544
 
 
545
 
                return _response == RESPONSE_POSITIVE;
 
563
                // if we're aborting, there's no need to check if an abortion happened
 
564
                // during the wait
 
565
                if( _response == RESPONSE_NEGATIVE )
 
566
                        finish( ACTION_ABORT );
 
567
                else
 
568
                        checkAbort();
546
569
        }
547
570
 
548
571
        protected void setProgressMessage( int res ) throws AbortImportException
558
581
                checkAbort();
559
582
                _doit._handler.sendMessage( Message.obtain(
560
583
                        _doit._handler, Doit.MESSAGE_SETMAXPROGRESS,
561
 
                        new Integer( max_progress ) ) );
 
584
                        Integer.valueOf( max_progress ) ) );
562
585
        }
563
586
 
564
587
        protected void setTmpProgress( int tmp_progress )
567
590
                checkAbort();
568
591
                _doit._handler.sendMessage( Message.obtain(
569
592
                        _doit._handler, Doit.MESSAGE_SETTMPPROGRESS,
570
 
                        new Integer( tmp_progress ) ) );
 
593
                        Integer.valueOf( tmp_progress ) ) );
571
594
        }
572
595
 
573
596
        protected void setProgress( int progress ) throws AbortImportException
575
598
                checkAbort();
576
599
                _doit._handler.sendMessage( Message.obtain(
577
600
                        _doit._handler, Doit.MESSAGE_SETPROGRESS,
578
 
                        new Integer( progress ) ) );
 
601
                        Integer.valueOf( progress ) ) );
579
602
        }
580
603
 
581
604
        protected void finish( int action ) throws AbortImportException
599
622
                return _doit.getText( res );
600
623
        }
601
624
 
602
 
        synchronized private boolean checkForDuplicate(
603
 
                ContactsCache.CacheIdentifier cache_identifier, int merge_setting )
604
 
                throws AbortImportException
 
625
        /**
 
626
         * Should we skip a contact, given whether it exists or not and the current
 
627
         * merge setting?  This routine handles throwing up a prompt, if required.
 
628
         *
 
629
         * @param contact_detail the display name of the contact
 
630
         * @param exists true if this contact matches one in the cache
 
631
         * @param merge_setting the merge setting to use
 
632
         * @return true if the contact should be skipped outright
 
633
         * @throws AbortImportException
 
634
         */
 
635
        synchronized private boolean shouldWeSkipContact( String contact_detail,
 
636
                boolean exists, int merge_setting ) throws AbortImportException
605
637
        {
606
638
                _last_merge_decision = merge_setting;
607
639
 
608
 
                // it is ok to use contact.getCacheIdentifier(). The contact has already
609
 
                // been finalised, which means a valid cache identifier will have been
610
 
                // created for it (or it would have been skipped)
611
 
 
612
640
                // handle special cases
613
641
                switch( merge_setting )
614
642
                {
615
643
                case Doit.ACTION_KEEP:
616
 
                        // if we keep contacts on duplicate, we better check for one
617
 
                        return !_contacts_cache.canLookup( cache_identifier );
 
644
                        // if we are skipping on a duplicate, check for one
 
645
                        return exists;
618
646
 
619
647
                case Doit.ACTION_PROMPT:
620
 
                        // if we are prompting on duplicate, we better check for one and if
621
 
                        // the contact doesn'te exist, we want to import it
622
 
                        if( !_contacts_cache.canLookup( cache_identifier ) )
623
 
                                return true;
 
648
                        // if we are prompting on duplicate, then we can say that we won't
 
649
                        // skip if there isn't one
 
650
                        if( !exists ) return false;
624
651
 
625
 
                        // ok, it exists, so do prompt
 
652
                        // ok, duplicate exists, so do prompt
626
653
                        _doit._handler.sendMessage( Message.obtain( _doit._handler,
627
 
                                Doit.MESSAGE_MERGEPROMPT, cache_identifier.getDetail() ) );
 
654
                                Doit.MESSAGE_MERGEPROMPT, contact_detail ) );
628
655
                        try {
629
656
                                wait();
630
657
                        }
638
665
                                _merge_setting = _response;
639
666
 
640
667
                        // recurse, with our new merge setting
641
 
                        return checkForDuplicate( cache_identifier, _response );
 
668
                        return shouldWeSkipContact( contact_detail, exists, _response );
642
669
                }
643
670
 
644
 
                // for all other cases (either overwriting or merging) we will need the
645
 
                // imported data
646
 
                return true;
 
671
                // for all other cases (either overwriting or merging) we don't skip
 
672
                return false;
647
673
        }
648
674
 
649
675
        protected void skipContact() throws AbortImportException
650
676
        {
651
677
                checkAbort();
 
678
 
 
679
                // show that we're skipping a new contact
652
680
                _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTSKIPPED );
653
681
        }
654
682
 
657
685
        {
658
686
                checkAbort();
659
687
 
660
 
                // It is expected that we use contact.getCacheIdentifier() here. The
 
688
                // It is expected that we use contact.getCacheIdentifier() here.  The
661
689
                // contact we are passed should have been successfully finalise()d,
662
690
                // which includes generating a valid cache identifier.
663
691
                ContactsCache.CacheIdentifier cache_identifier =
664
692
                        contact.getCacheIdentifier();
665
693
 
666
 
                // check to see if this contact is a duplicate and should be skipped
667
 
                if( !checkForDuplicate( cache_identifier, _merge_setting ) ) {
668
 
                        skipContact();
669
 
                        return;
670
 
                }
671
 
 
672
694
//              if( !showContinue( "====[ IMPORTING ]====\n: " + contact._name ) )
673
695
//                      finish( ACTION_ABORT );
674
696
 
675
 
                // keep track of whether we've informed the UI of what we're doing
676
 
                boolean ui_informed = false;
677
 
 
678
697
                // attempt to lookup the id of an existing contact in the cache with
679
698
                // this contact data's cache identifier
680
699
                Long id = (Long)_contacts_cache.lookup( cache_identifier );
681
700
 
682
 
                // does contact exist already?
683
 
                if( id != null )
684
 
                {
685
 
                        // should we skip this import altogether?
686
 
                        if( _last_merge_decision == Doit.ACTION_KEEP ) return;
687
 
 
688
 
                        // should we destroy the existing contact before importing?
689
 
                        if( _last_merge_decision == Doit.ACTION_OVERWRITE )
 
701
                // check to see if this contact should be skipped
 
702
                if( shouldWeSkipContact( cache_identifier.getDetail(), id != null,
 
703
                        _merge_setting ) )
 
704
                {
 
705
                        // show that we're skipping a contact
 
706
                        _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTSKIPPED );
 
707
                        return;
 
708
                }
 
709
 
 
710
                // if a contact exists, and we're overwriting, destroy the existing
 
711
                // contact before importing
 
712
                boolean contact_deleted = false;
 
713
                if( id != null && _last_merge_decision == Doit.ACTION_OVERWRITE )
 
714
                {
 
715
                        contact_deleted = true;
 
716
 
 
717
                        // remove from device
 
718
                        _backend.deleteContact( id );
 
719
 
 
720
                        // update cache
 
721
                        _contacts_cache.removeLookup( cache_identifier );
 
722
                        _contacts_cache.removeAssociatedData( id );
 
723
 
 
724
                        // show that we're overwriting a contact
 
725
                        _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTOVERWRITTEN );
 
726
 
 
727
                        // discard the contact id
 
728
                        id = null;
 
729
                }
 
730
 
 
731
                try {
 
732
                        // if we don't have a contact id yet (or we did, but we destroyed it
 
733
                        // when we deleted the contact), we'll have to create a new contact
 
734
                        if( id == null )
690
735
                        {
691
 
                                // remove from device
692
 
                                _backend.deleteContact( id );
 
736
                                // create a new contact
 
737
                                id = _backend.addContact( contact._name );
693
738
 
694
739
                                // update cache
695
 
                                _contacts_cache.removeLookup( contact.getCacheIdentifier() );
696
 
                                _contacts_cache.removeAssociatedData( id );
697
 
 
698
 
                                // show that we're overwriting a contact
699
 
                                _doit._handler.sendEmptyMessage(
700
 
                                                Doit.MESSAGE_CONTACTOVERWRITTEN );
701
 
                                ui_informed = true;
702
 
 
703
 
                                // discard the contact id
704
 
                                id = null;
 
740
                                _contacts_cache.addLookup( cache_identifier, id );
 
741
 
 
742
                                // if we haven't already shown that we're overwriting a contact,
 
743
                                // show that we're creating a new contact
 
744
                                if( !contact_deleted )
 
745
                                        _doit._handler.sendEmptyMessage(
 
746
                                                Doit.MESSAGE_CONTACTCREATED );
705
747
                        }
 
748
                        else
 
749
                                // show that we're merging with an existing contact
 
750
                                _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTMERGED );
 
751
 
 
752
                        // import contact parts
 
753
                        if( contact.hasNumbers() )
 
754
                                importContactPhones( id, contact.getNumbers() );
 
755
                        if( contact.hasEmails() )
 
756
                                importContactEmails( id, contact.getEmails() );
 
757
                        if( contact.hasAddresses() )
 
758
                                importContactAddresses( id, contact.getAddresses() );
 
759
                        if( contact.hasOrganisations() )
 
760
                                importContactOrganisations( id, contact.getOrganisations() );
 
761
                        if( contact.hasNotes() )
 
762
                                importContactNotes( id, contact.getNotes() );
 
763
                        if( contact.hasBirthday() )
 
764
                                importContactBirthday( id, contact.getBirthday() );
706
765
                }
707
 
 
708
 
                // if we don't have a contact id yet (or we did, but we destroyed it
709
 
                // when we deleted the contact), we'll have to create a new contact
710
 
                if( id == null )
 
766
                catch( Backend.ContactCreationException e )
711
767
                {
712
 
                        // create a new contact
713
 
                        id = _backend.addContact( contact._name );
714
 
                        if( id == null )
715
 
                                showError( R.string.error_unabletoaddcontact );
716
 
 
717
 
                        // update cache
718
 
                        _contacts_cache.addLookup(
719
 
                                ContactsCache.createIdentifier( contact ), id );
720
 
 
721
 
                        // if we haven't already shown that we're overwriting a contact,
722
 
                        // show that we're creating a new contact
723
 
                        if( !ui_informed ) {
724
 
                                _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTCREATED );
725
 
                                ui_informed = true;
726
 
                        }
 
768
                        showError( R.string.error_unabletoaddcontact );
727
769
                }
728
 
 
729
 
                // if we haven't already shown that we're overwriting or creating a
730
 
                // contact, show that we're merging a contact
731
 
                if( !ui_informed )
732
 
                        _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTMERGED );
733
 
 
734
 
                // import contact parts
735
 
                if( contact.hasNumbers() )
736
 
                        importContactPhones( id, contact.getNumbers() );
737
 
                if( contact.hasEmails() )
738
 
                        importContactEmails( id, contact.getEmails() );
739
 
                if( contact.hasAddresses() )
740
 
                        importContactAddresses( id, contact.getAddresses() );
741
 
                if( contact.hasOrganisations() )
742
 
                        importContactOrganisations( id, contact.getOrganisations() );
743
770
        }
744
771
 
745
772
        private void importContactPhones( Long id,
746
 
                        HashMap< String, ContactData.PreferredDetail > datas )
 
773
                HashMap< String, ContactData.PreferredDetail > datas )
 
774
                throws ContactCreationException
747
775
        {
748
776
                // add phone numbers
749
777
                Set< String > datas_keys = datas.keySet();
752
780
                        String number = i.next();
753
781
                        ContactData.PreferredDetail data = datas.get( number );
754
782
 
755
 
                        // we don't want to add this number if it's crap, or it already
756
 
                        // exists (which would cause a duplicate to be created). We don't
757
 
                        // take in to account the type when checking for duplicates. This is
758
 
                        // intentional: types aren't really very reliable. We assume that
759
 
                        // if the number exists at all, it doesn't need importing. Because
760
 
                        // of this, we also can't update the cache (which we don't need to
761
 
                        // anyway, so it's not a problem).
 
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).
762
790
                        if( _contacts_cache.hasAssociatedNumber( id, number ) )
763
791
                                continue;
764
792
 
772
800
        }
773
801
 
774
802
        private void importContactEmails( Long id,
775
 
                        HashMap< String, ContactData.PreferredDetail > datas )
 
803
                HashMap< String, ContactData.PreferredDetail > datas )
 
804
                throws ContactCreationException
776
805
        {
777
806
                // add email addresses
778
807
                Set< String > datas_keys = datas.keySet();
782
811
                        ContactData.PreferredDetail data = datas.get( email );
783
812
 
784
813
                        // we don't want to add this email address if it exists already or
785
 
                        // we would introduce duplicates.
 
814
                        // we would introduce duplicates
786
815
                        if( _contacts_cache.hasAssociatedEmail( id, email ) )
787
816
                                continue;
788
817
 
797
826
 
798
827
        private void importContactAddresses( Long id,
799
828
                HashMap< String, ContactData.TypeDetail > datas )
 
829
                throws ContactCreationException
800
830
        {
801
831
                // add addresses
802
832
                Set< String > datas_keys = datas.keySet();
821
851
 
822
852
        private void importContactOrganisations( Long id,
823
853
                HashMap< String, ContactData.ExtraDetail > datas )
 
854
                throws ContactCreationException
824
855
        {
825
856
                // add addresses
826
857
                Set< String > datas_keys = datas.keySet();
843
874
                }
844
875
        }
845
876
 
 
877
        private void importContactNotes( Long id, HashSet< String > datas )
 
878
                throws ContactCreationException
 
879
        {
 
880
                // add notes
 
881
                Iterator< String > i = datas.iterator();
 
882
                while( i.hasNext() ) {
 
883
                        String note = i.next();
 
884
 
 
885
                        // we don't want to add this note if it exists already or we would
 
886
                        // introduce duplicates
 
887
                        if( _contacts_cache.hasAssociatedNote( id, note ) )
 
888
                                continue;
 
889
 
 
890
                        // add note
 
891
                        _backend.addContactNote( id, note );
 
892
 
 
893
                        // and add this note to the cache to prevent a addition of duplicate
 
894
                        // date from another file
 
895
                        _contacts_cache.addAssociatedNote( id, note );
 
896
                }
 
897
        }
 
898
 
 
899
        private void importContactBirthday( Long id, String birthday )
 
900
                throws ContactCreationException
 
901
        {
 
902
                // we don't want to import this birthday if it already exists
 
903
                if( _contacts_cache.hasAssociatedBirthday( id, birthday ) )
 
904
                        return;
 
905
 
 
906
                // add birthday
 
907
                _backend.addContactBirthday( id, birthday );
 
908
 
 
909
                // and update the cache
 
910
                _contacts_cache.addAssociatedBirthday( id, birthday );
 
911
        }
 
912
 
846
913
        synchronized protected void checkAbort() throws AbortImportException
847
914
        {
848
915
                if( _abort ) {