/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-02 18:28:24 UTC
  • Revision ID: edam@waxworlds.org-20110502182824-acgdi3qfxfzqgely
- fixed logic for vcard field types (home, work, cell, etc) so it works
- updated NEWS and TODO
- rewrote most of ContactsCache, including a new ContactIdentifier class to identify contacts in the cache and new cache building code
- contacts now identified in the same way that Andoid displays them (by name, or organisation, or number, or email, in that order)
- propper handling and support for organisations and titles
- validation of imported contact now done by Importer, not VcfImporter
- separated sanitisation and normalisation (for cache lookups)
- generacised PhoneData, EmailData and AddressData classes
- ContactData is now aware of primary numbers, emails and organisations (defaults to the first prefrred one seen, or the first one seen where none is preferred)

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 Tim Marston <edam@waxworlds.org>
 
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
21
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
22
 */
23
23
 
24
 
package org.waxworlds.importcontacts;
 
24
package org.waxworlds.edam.importcontacts;
25
25
 
26
26
import java.util.HashMap;
27
 
import java.util.HashSet;
28
27
import java.util.Iterator;
29
28
import java.util.Set;
30
29
import java.util.regex.Matcher;
33
32
import android.content.ContentUris;
34
33
import android.content.ContentValues;
35
34
import android.content.SharedPreferences;
36
 
import android.database.Cursor;
37
35
import android.net.Uri;
38
36
import android.os.Message;
39
37
import android.provider.Contacts;
40
38
 
 
39
 
41
40
public class Importer extends Thread
42
41
{
43
 
        public final static int ACTION_GOBACK = 0;
44
42
        public final static int ACTION_ABORT = 1;
45
43
        public final static int ACTION_ALLDONE = 2;
46
44
 
52
50
 
53
51
        private Doit _doit;
54
52
        private int _response;
55
 
        private int _responseExtra;
56
 
        private HashMap< String, Long > _contacts;
57
 
        private HashMap< Long, HashSet< String > > _contactNumbers;
58
 
        private HashMap< Long, HashSet< String > > _contactEmails;
59
 
        private int _mergeSetting;
60
 
        private int _lastMergeDecision;
 
53
        private int _response_extra;
 
54
        private int _merge_setting;
 
55
        private int _last_merge_decision;
61
56
        private boolean _abort = false;
62
 
        private boolean _isFinished = false;
63
 
 
 
57
        private boolean _is_finished = false;
 
58
        private ContactsCache _contactsCache = null;
 
59
 
 
60
        @SuppressWarnings("serial")
 
61
        protected class ContactNeedsMoreInfoException extends Exception
 
62
        {
 
63
        }
 
64
 
 
65
        /**
 
66
         * Data about a contact
 
67
         */
64
68
        public class ContactData
65
69
        {
66
 
                class PhoneData
67
 
                {
68
 
                        public String _number;
69
 
                        public int _type;
70
 
                        public boolean _isPreferred;
71
 
 
72
 
                        public PhoneData( String number, int type, boolean isPreferred ) {
73
 
                                _number = number;
74
 
                                _type = type;
75
 
                                _isPreferred = isPreferred;
76
 
                        }
77
 
 
78
 
                        public String getNumber() {
79
 
                                return _number;
80
 
                        }
81
 
 
82
 
                        public int getType() {
83
 
                                return _type;
84
 
                        }
85
 
 
86
 
                        public boolean isPreferred() {
87
 
                                return _isPreferred;
88
 
                        }
89
 
                }
90
 
 
91
 
                class EmailData
92
 
                {
93
 
                        private String _email;
94
 
                        public int _type;
95
 
                        private boolean _isPreferred;
96
 
 
97
 
                        public EmailData( String email, int type, boolean isPreferred ) {
98
 
                                _email = email;
99
 
                                _type = type;
100
 
                                _isPreferred = isPreferred;
101
 
                        }
102
 
 
103
 
                        public String getAddress() {
104
 
                                return _email;
105
 
                        }
106
 
 
107
 
                        public int getType() {
108
 
                                return _type;
109
 
                        }
110
 
 
111
 
                        public boolean isPreferred() {
112
 
                                return _isPreferred;
113
 
                        }
114
 
                }
115
 
 
116
 
                public String _name = null;
117
 
                public HashMap< String, PhoneData > _phones = null;
118
 
                public HashMap< String, EmailData > _emails = null;
 
70
                class TypeDetail
 
71
                {
 
72
                        protected int _type;
 
73
 
 
74
                        public TypeDetail( int type )
 
75
                        {
 
76
                                _type = type;
 
77
                        }
 
78
 
 
79
                        public int getType()
 
80
                        {
 
81
                                return _type;
 
82
                        }
 
83
                }
 
84
 
 
85
                class PreferredDetail extends TypeDetail
 
86
                {
 
87
                        protected boolean _is_preferred;
 
88
 
 
89
                        public PreferredDetail( int type, boolean is_preferred )
 
90
                        {
 
91
                                super( type );
 
92
                                _is_preferred = is_preferred;
 
93
                        }
 
94
 
 
95
                        public boolean isPreferred()
 
96
                        {
 
97
                                return _is_preferred;
 
98
                        }
 
99
                }
 
100
 
 
101
                class ExtraDetail extends PreferredDetail
 
102
                {
 
103
                        protected String _extra;
 
104
 
 
105
                        public ExtraDetail( int type, boolean is_preferred, String extra )
 
106
                        {
 
107
                                super( type, is_preferred );
 
108
 
 
109
                                if( extra != null ) extra = extra.trim();
 
110
                                _extra = extra;
 
111
                        }
 
112
 
 
113
                        public String getExtra()
 
114
                        {
 
115
                                return _extra;
 
116
                        }
 
117
 
 
118
                        public void setExtra( String extra )
 
119
                        {
 
120
                                if( extra != null ) extra = extra.trim();
 
121
                                _extra = extra;
 
122
                        }
 
123
                }
 
124
 
 
125
                protected String _name = null;
 
126
                protected String _primary_organisation = null;
 
127
                protected boolean _primary_organisation_is_preferred = false;
 
128
                protected String _primary_number = null;
 
129
                protected boolean _primary_number_is_preferred = false;
 
130
                protected String _primary_email = null;
 
131
                protected boolean _primary_email_is_preferred = false;
 
132
                protected HashMap< String, ExtraDetail > _organisations = null;
 
133
                protected HashMap< String, PreferredDetail > _numbers = null;
 
134
                protected HashMap< String, PreferredDetail > _emails = null;
 
135
                protected HashMap< String, TypeDetail > _addresses = null;
119
136
 
120
137
                protected void setName( String name )
121
138
                {
122
139
                        _name = name;
123
140
                }
124
141
 
 
142
                public boolean hasName()
 
143
                {
 
144
                        return _name != null;
 
145
                }
 
146
 
125
147
                public String getName()
126
148
                {
127
149
                        return _name;
128
150
                }
129
151
 
130
 
                protected void addPhone( String number, int type, boolean isPreferred )
131
 
                {
132
 
                        if( _phones == null ) _phones = new HashMap< String, PhoneData >();
133
 
                        if( !_phones.containsKey( number ) )
134
 
                                _phones.put( number,
135
 
                                                new PhoneData( number, type, isPreferred ) );
136
 
                }
137
 
 
138
 
                protected void addEmail( String email, int type, boolean isPreferred )
139
 
                {
140
 
                        if( _emails == null ) _emails = new HashMap< String, EmailData >();
 
152
                protected void addOrganisation( String organisation, String title,
 
153
                        boolean is_preferred )
 
154
                {
 
155
                        organisation = organisation.trim();
 
156
                        if( organisation.length() <= 0 )
 
157
                        {
 
158
                                // TODO: warn that an imported organisation is being ignored
 
159
                                return;
 
160
                        }
 
161
 
 
162
                        if( title != null ) {
 
163
                                title = title.trim();
 
164
                                if( title.length() <= 0 ) title = null;
 
165
                        }
 
166
 
 
167
                        // add the organisation, as non-preferred (we prefer only one
 
168
                        // organisation in finalise() after they're all imported)
 
169
                        if( _organisations == null )
 
170
                                _organisations = new HashMap< String, ExtraDetail >();
 
171
                        if( !_organisations.containsKey( organisation ) )
 
172
                                _organisations.put( organisation,
 
173
                                        new ExtraDetail( 0, false, title ) );
 
174
 
 
175
                        // if this is the first organisation added, or it's a preferred
 
176
                        // organisation and a previous organisation wasn't, then remember
 
177
                        // that this is the "primary organisation".
 
178
                        if( _primary_organisation == null ||
 
179
                                ( is_preferred && !_primary_organisation_is_preferred ) )
 
180
                        {
 
181
                                _primary_organisation = organisation;
 
182
                                _primary_organisation_is_preferred = is_preferred;
 
183
                        }
 
184
                }
 
185
 
 
186
                public boolean hasOrganisations()
 
187
                {
 
188
                        return _organisations != null && _organisations.size() > 0;
 
189
                }
 
190
 
 
191
                public HashMap< String, ExtraDetail > getOrganisations()
 
192
                {
 
193
                        return _organisations;
 
194
                }
 
195
 
 
196
                public boolean hasPrimaryOrganisation()
 
197
                {
 
198
                        return _primary_organisation != null;
 
199
                }
 
200
 
 
201
                public String getPrimaryOrganisation()
 
202
                {
 
203
                        return _primary_organisation;
 
204
                }
 
205
 
 
206
                protected void addNumber( String number, int type,
 
207
                        boolean is_preferred )
 
208
                {
 
209
                        number = sanitisePhoneNumber( number );
 
210
                        if( number == null )
 
211
                        {
 
212
                                // TODO: warn that an imported phone number is being ignored
 
213
                                return;
 
214
                        }
 
215
 
 
216
                        // add the number, as non-preferred (we prefer only one number
 
217
                        // in finalise() after they're all imported)
 
218
                        if( _numbers == null )
 
219
                                _numbers = new HashMap< String, PreferredDetail >();
 
220
                        if( !_numbers.containsKey( number ) )
 
221
                                _numbers.put( number,
 
222
                                        new PreferredDetail( type, false ) );
 
223
 
 
224
                        // if this is the first number added, or it's a preferred number
 
225
                        // and a previous number wasn't, then remember that this is the
 
226
                        // "primary number".
 
227
                        if( _primary_number == null ||
 
228
                                ( is_preferred && !_primary_number_is_preferred ) )
 
229
                        {
 
230
                                _primary_number = number;
 
231
                                _primary_number_is_preferred = is_preferred;
 
232
                        }
 
233
                }
 
234
 
 
235
                public boolean hasNumbers()
 
236
                {
 
237
                        return _numbers != null && _numbers.size() > 0;
 
238
                }
 
239
 
 
240
                public HashMap< String, PreferredDetail > getNumbers()
 
241
                {
 
242
                        return _numbers;
 
243
                }
 
244
 
 
245
                public boolean hasPrimaryNumber()
 
246
                {
 
247
                        return _primary_number != null;
 
248
                }
 
249
 
 
250
                public String getPrimaryNumber()
 
251
                {
 
252
                        return _primary_number;
 
253
                }
 
254
 
 
255
                protected void addEmail( String email, int type, boolean is_preferred )
 
256
                {
 
257
 
 
258
                        email = sanitisesEmailAddress( email );
 
259
                        if( email == null )
 
260
                        {
 
261
                                // TODO: warn that an imported email addtrss is being ignored
 
262
                                return;
 
263
                        }
 
264
 
 
265
                        // add the email, as non-preferred (we prefer only one email in
 
266
                        // finalise() after they're all imported)
 
267
                        if( _emails == null )
 
268
                                _emails = new HashMap< String, PreferredDetail >();
141
269
                        if( !_emails.containsKey( email ) )
142
 
                                _emails.put( email, new EmailData( email, type, isPreferred ) );
 
270
                                _emails.put( email, new PreferredDetail( type, false ) );
 
271
 
 
272
                        // if this is the first email added, or it's a preferred email
 
273
                        // and a previous email wasn't, then remember that this is the
 
274
                        // "primary email".
 
275
                        if( _primary_email == null ||
 
276
                                ( is_preferred && !_primary_email_is_preferred ) )
 
277
                        {
 
278
                                _primary_email = email;
 
279
                                _primary_email_is_preferred = is_preferred;
 
280
                        }
 
281
                }
 
282
 
 
283
                public boolean hasEmails()
 
284
                {
 
285
                        return _emails != null && _emails.size() > 0;
 
286
                }
 
287
 
 
288
                public HashMap< String, PreferredDetail > getEmails()
 
289
                {
 
290
                        return _emails;
 
291
                }
 
292
 
 
293
                public boolean hasPrimaryEmail()
 
294
                {
 
295
                        return _primary_email != null;
 
296
                }
 
297
 
 
298
                public String getPrimaryEmail()
 
299
                {
 
300
                        return _primary_email;
 
301
                }
 
302
 
 
303
                protected void addAddress( String address, int type )
 
304
                {
 
305
                        address = address.trim();
 
306
                        if( address.length() <= 0 )
 
307
                        {
 
308
                                // TODO: warn that an imported address is being ignored
 
309
                                return;
 
310
                        }
 
311
 
 
312
                        if( _addresses == null ) _addresses =
 
313
                                new HashMap< String, TypeDetail >();
 
314
                        if( !_addresses.containsKey( address ) )
 
315
                                _addresses.put( address, new TypeDetail( type ) );
 
316
                }
 
317
 
 
318
                public boolean hasAddresses()
 
319
                {
 
320
                        return _addresses != null && _addresses.size() > 0;
 
321
                }
 
322
 
 
323
                public HashMap< String, TypeDetail > getAddresses()
 
324
                {
 
325
                        return _addresses;
 
326
                }
 
327
 
 
328
                protected void finalise()
 
329
                {
 
330
                        // ensure that if there is a primary number, it is preferred so
 
331
                        // that there is always one preferred number. Android will assign
 
332
                        // preference to one anyway so we might as well decide one sensibly.
 
333
                        if( _primary_number != null ) {
 
334
                                PreferredDetail data = _numbers.get( _primary_number );
 
335
                                _numbers.put( _primary_number,
 
336
                                        new PreferredDetail( data.getType(), true ) );
 
337
                        }
 
338
 
 
339
                        // do the same for the primary email
 
340
                        if( _primary_email != null ) {
 
341
                                PreferredDetail data = _emails.get( _primary_email );
 
342
                                _emails.put( _primary_email,
 
343
                                        new PreferredDetail( data.getType(), true ) );
 
344
                        }
 
345
 
 
346
                        // do the same for the primary organisation
 
347
                        if( _primary_organisation != null ) {
 
348
                                ExtraDetail data = _organisations.get( _primary_organisation );
 
349
                                _organisations.put( _primary_organisation,
 
350
                                        new ExtraDetail( 0, true, data.getExtra() ) );
 
351
                        }
 
352
                }
 
353
 
 
354
                private String sanitisePhoneNumber( String number )
 
355
                {
 
356
                        number = number.trim();
 
357
                        Pattern p = Pattern.compile( "^[-\\(\\) \\+0-9#*]+" );
 
358
                        Matcher m = p.matcher( number );
 
359
                        if( m.lookingAt() ) return m.group( 0 );
 
360
                        return null;
 
361
                }
 
362
 
 
363
                private String sanitisesEmailAddress( String email )
 
364
                {
 
365
                        email = email.trim();
 
366
                        Pattern p = Pattern.compile(
 
367
                                "^[^ @]+@[a-zA-Z]([-a-zA-Z0-9]*[a-zA-z0-9])?(\\.[a-zA-Z]([-a-zA-Z0-9]*[a-zA-z0-9])?)+$" );
 
368
                        Matcher m = p.matcher( email );
 
369
                        if( m.matches() ) {
 
370
                                String[] bits = email.split( "@" );
 
371
                                return bits[ 0 ] + "@" + bits[ 1 ].toLowerCase();
 
372
                        }
 
373
                        return null;
143
374
                }
144
375
        }
145
376
 
 
377
        @SuppressWarnings("serial")
146
378
        protected class AbortImportException extends Exception { };
147
379
 
148
380
        public Importer( Doit doit )
150
382
                _doit = doit;
151
383
 
152
384
                SharedPreferences prefs = getSharedPreferences();
153
 
                _mergeSetting = prefs.getInt( "merge_setting", Doit.ACTION_PROMPT );
 
385
                _merge_setting = prefs.getInt( "merge_setting", Doit.ACTION_PROMPT );
154
386
        }
155
387
 
156
388
        @Override
158
390
        {
159
391
                try
160
392
                {
161
 
                        // cache current contact names
162
 
                        buildContactsCache();
 
393
                        // update UI
 
394
                        setProgressMessage( R.string.doit_caching );
 
395
 
 
396
                        // build a cache of existing contacts
 
397
                        _contactsCache = new ContactsCache();
 
398
                        _contactsCache.buildCache( _doit );
163
399
 
164
400
                        // do the import
165
401
                        onImport();
176
412
 
177
413
        synchronized private void setIsFinished()
178
414
        {
179
 
                _isFinished = true;
 
415
                _is_finished = true;
180
416
        }
181
417
 
182
418
        protected void onImport() throws AbortImportException
193
429
                wake( response, RESPONSEEXTRA_NONE );
194
430
        }
195
431
 
196
 
        synchronized public void wake( int response, int responseExtra )
 
432
        synchronized public void wake( int response, int response_extra )
197
433
        {
198
434
                _response = response;
199
 
                _responseExtra = responseExtra;
 
435
                _response_extra = response_extra;
200
436
                notify();
201
437
        }
202
438
 
203
439
        synchronized public boolean setAbort()
204
440
        {
205
 
                if( !_isFinished && !_abort ) {
 
441
                if( !_is_finished && !_abort ) {
206
442
                        _abort = true;
207
443
                        notify();
208
444
                        return true;
225
461
        {
226
462
                checkAbort();
227
463
                _doit._handler.sendMessage( Message.obtain(
228
 
                                _doit._handler, Doit.MESSAGE_ERROR, message ) );
 
464
                        _doit._handler, Doit.MESSAGE_ERROR, message ) );
229
465
                try {
230
466
                        wait();
231
467
                }
232
468
                catch( InterruptedException e ) { }
 
469
 
233
470
                // no need to check if an abortion happened during the wait, we are
234
471
                // about to finish anyway!
235
472
                finish( ACTION_ABORT );
245
482
        {
246
483
                checkAbort();
247
484
                _doit._handler.sendMessage( Message.obtain(
248
 
                                _doit._handler, Doit.MESSAGE_ERROR, message ) );
 
485
                        _doit._handler, Doit.MESSAGE_ERROR, message ) );
249
486
                try {
250
487
                        wait();
251
488
                }
252
489
                catch( InterruptedException e ) { }
 
490
 
253
491
                // no need to check if an abortion happened during the wait, we are
254
492
                // about to finish anyway!
255
493
                finish( ACTION_ABORT );
265
503
        {
266
504
                checkAbort();
267
505
                _doit._handler.sendMessage( Message.obtain(
268
 
                                _doit._handler, Doit.MESSAGE_CONTINUEORABORT, message ) );
 
506
                        _doit._handler, Doit.MESSAGE_CONTINUEORABORT, message ) );
269
507
                try {
270
508
                        wait();
271
509
                }
281
519
        {
282
520
                checkAbort();
283
521
                _doit._handler.sendMessage( Message.obtain( _doit._handler,
284
 
                                Doit.MESSAGE_SETPROGRESSMESSAGE, getText( res ) ) );
 
522
                        Doit.MESSAGE_SETPROGRESSMESSAGE, getText( res ) ) );
285
523
        }
286
524
 
287
525
        protected void setProgressMax( int maxProgress )
289
527
        {
290
528
                checkAbort();
291
529
                _doit._handler.sendMessage( Message.obtain(
292
 
                                _doit._handler, Doit.MESSAGE_SETMAXPROGRESS,
293
 
                                new Integer( maxProgress ) ) );
 
530
                        _doit._handler, Doit.MESSAGE_SETMAXPROGRESS,
 
531
                        new Integer( maxProgress ) ) );
294
532
        }
295
533
 
296
534
        protected void setTmpProgress( int tmpProgress ) throws AbortImportException
297
535
        {
298
536
                checkAbort();
299
537
                _doit._handler.sendMessage( Message.obtain(
300
 
                                _doit._handler, Doit.MESSAGE_SETTMPPROGRESS,
301
 
                                new Integer( tmpProgress ) ) );
 
538
                        _doit._handler, Doit.MESSAGE_SETTMPPROGRESS,
 
539
                        new Integer( tmpProgress ) ) );
302
540
        }
303
541
 
304
542
        protected void setProgress( int progress ) throws AbortImportException
305
543
        {
306
544
                checkAbort();
307
545
                _doit._handler.sendMessage( Message.obtain(
308
 
                                _doit._handler, Doit.MESSAGE_SETPROGRESS,
309
 
                                new Integer( progress ) ) );
 
546
                        _doit._handler, Doit.MESSAGE_SETPROGRESS,
 
547
                        new Integer( progress ) ) );
310
548
        }
311
549
 
312
550
        protected void finish( int action ) throws AbortImportException
315
553
                int message;
316
554
                switch( action )
317
555
                {
318
 
                case ACTION_GOBACK:             message = Doit.MESSAGE_FINISHED_GOBACK; break;
319
 
                case ACTION_ALLDONE:    message = Doit.MESSAGE_FINISHED_ALLDONE; break;
 
556
                case ACTION_ALLDONE:    message = Doit.MESSAGE_ALLDONE; break;
320
557
                default:        // fall through
321
 
                case ACTION_ABORT:              message = Doit.MESSAGE_FINISHED; break;
 
558
                case ACTION_ABORT:              message = Doit.MESSAGE_ABORT; break;
322
559
                }
323
560
                _doit._handler.sendEmptyMessage( message );
324
561
 
331
568
                return _doit.getText( res );
332
569
        }
333
570
 
334
 
        protected boolean isImportRequired( String name )
335
 
                        throws AbortImportException
 
571
        protected boolean isImportRequired( ContactData contact )
 
572
                        throws AbortImportException, ContactNeedsMoreInfoException
336
573
        {
337
574
                checkAbort();
338
 
                return isImportRequired( name, _mergeSetting );
 
575
                return isImportRequired( contact, _merge_setting );
339
576
        }
340
577
 
341
 
        synchronized private boolean isImportRequired( String name,
342
 
                        int mergeSetting ) throws AbortImportException
 
578
        synchronized private boolean isImportRequired(
 
579
                ContactData contact, int merge_setting )
 
580
                throws AbortImportException, ContactNeedsMoreInfoException
343
581
        {
344
 
                _lastMergeDecision = mergeSetting;
 
582
                _last_merge_decision = merge_setting;
 
583
 
 
584
                // create a cache identifier which we can use to detect if this contact
 
585
                // is valid for importing
 
586
                ContactsCache.CacheIdentifier identifier =
 
587
                        ContactsCache.createIdentifier( contact );
 
588
                if( identifier == null )
 
589
                        throw new ContactNeedsMoreInfoException();
345
590
 
346
591
                // handle special cases
347
 
                switch( mergeSetting )
 
592
                switch( merge_setting )
348
593
                {
349
594
                case Doit.ACTION_KEEP:
350
595
                        // if we keep contacts on duplicate, we better check for one
351
 
                        return !_contacts.containsKey( name );
 
596
                        return !_contactsCache.canLookup( identifier );
352
597
 
353
598
                case Doit.ACTION_PROMPT:
354
 
                        // if we are prompting on duplicate, we better check for one
355
 
                        if( !_contacts.containsKey( name ) )
 
599
                        // if we are prompting on duplicate, we better check for one and if
 
600
                        // the contact doesn'te exist, we want to import it
 
601
                        if( !_contactsCache.canLookup( identifier ) )
356
602
                                return true;
357
603
 
358
604
                        // ok, it exists, so do prompt
359
 
                        _doit._handler.sendMessage( Message.obtain(
360
 
                                        _doit._handler, Doit.MESSAGE_MERGEPROMPT, name ) );
 
605
                        _doit._handler.sendMessage( Message.obtain( _doit._handler,
 
606
                                Doit.MESSAGE_MERGEPROMPT, identifier.getDetail() ) );
361
607
                        try {
362
608
                                wait();
363
609
                        }
366
612
                        // check if an abortion happened during the wait
367
613
                        checkAbort();
368
614
 
369
 
                        // if "always" was selected, make choice permenant
370
 
                        if( _responseExtra == RESPONSEEXTRA_ALWAYS )
371
 
                                _mergeSetting = _response;
 
615
                        // if "always" was selected, make choice permanent
 
616
                        if( _response_extra == RESPONSEEXTRA_ALWAYS )
 
617
                                _merge_setting = _response;
372
618
 
373
 
                        // recurse, with out new merge setting
374
 
                        return isImportRequired( name, _response );
 
619
                        // recurse, with our new merge setting
 
620
                        return isImportRequired( contact, _response );
375
621
                }
376
622
 
377
623
                // for all other cases (either overwriting or merging) we will need the
395
641
 
396
642
                ContentValues values = new ContentValues();
397
643
                boolean uiInformed = false;
 
644
                Long id = null;
 
645
 
 
646
                // give the contact a chance to finalise it's data
 
647
                contact.finalise();
 
648
 
 
649
                // create something, from the contact data, that we can use to identify
 
650
                // a cache entry and attempt to lookup the id of an existing contact in
 
651
                // the cache with it
 
652
                ContactsCache.CacheIdentifier identifier =
 
653
                        ContactsCache.createIdentifier( contact );
 
654
                if( identifier != null ) id = (Long)_contactsCache.lookup( identifier );
398
655
 
399
656
                // does contact exist already?
400
 
                Uri contactUri = null;
401
 
                Long id;
402
 
                if( ( id = (Long)_contacts.get( contact._name ) ) != null )
 
657
                if( id != null )
403
658
                {
404
659
                        // should we skip this import altogether?
405
 
                        if( _lastMergeDecision == Doit.ACTION_KEEP ) return;
 
660
                        if( _last_merge_decision == Doit.ACTION_KEEP ) return;
406
661
 
407
662
                        // get contact's URI
408
 
                        contactUri = ContentUris.withAppendedId(
409
 
                                        Contacts.People.CONTENT_URI, id );
 
663
                        Uri contactUri = ContentUris.withAppendedId(
 
664
                                Contacts.People.CONTENT_URI, id );
410
665
 
411
666
                        // should we destroy the existing contact before importing?
412
 
                        if( _lastMergeDecision == Doit.ACTION_OVERWRITE ) {
 
667
                        if( _last_merge_decision == Doit.ACTION_OVERWRITE )
 
668
                        {
 
669
                                // remove from device
413
670
                                _doit.getContentResolver().delete( contactUri, null, null );
414
 
                                contactUri = null;
415
 
 
416
 
                                // upate the UI
417
 
                                _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTOVERWRITTEN );
418
 
                                uiInformed = true;
419
671
 
420
672
                                // update cache
421
 
                                _contacts.remove( contact._name );
 
673
                                _contactsCache.removeLookup( identifier );
 
674
                                _contactsCache.removeAssociatedData( id );
 
675
 
 
676
                                // show that we're overwriting a contact
 
677
                                _doit._handler.sendEmptyMessage(
 
678
                                                Doit.MESSAGE_CONTACTOVERWRITTEN );
 
679
                                uiInformed = true;
 
680
 
 
681
                                // discard the contact id
 
682
                                id = null;
422
683
                        }
423
684
                }
424
685
 
425
 
                // if we don't have a contact URI it is because the contact never
426
 
                // existed or because we deleted it
427
 
                if( contactUri == null )
 
686
                // if we don't have a contact id yet (or if we did, but we destroyed it
 
687
                // when we deleted the contact), we'll have to create a new contact
 
688
                if( id == null )
428
689
                {
429
690
                        // create a new contact
430
691
                        values.put( Contacts.People.NAME, contact._name );
431
 
                        contactUri = _doit.getContentResolver().insert(
432
 
                                        Contacts.People.CONTENT_URI, values );
 
692
                        Uri contactUri = _doit.getContentResolver().insert(
 
693
                                Contacts.People.CONTENT_URI, values );
433
694
                        id = ContentUris.parseId( contactUri );
434
 
                        if( id <= 0 ) return;   // shouldn't happen!
 
695
                        if( id == null || id <= 0 )
 
696
                                showError( R.string.error_unabletoaddcontact );
435
697
 
436
 
                        // add them to the "My Contacts" group
437
 
                        Contacts.People.addToMyContactsGroup(
 
698
                        // try to add them to the "My Contacts" group
 
699
                        try {
 
700
                                Contacts.People.addToMyContactsGroup(
438
701
                                        _doit.getContentResolver(), id );
 
702
                        }
 
703
                        catch( IllegalStateException e ) {
 
704
                                // ignore any failure
 
705
                        }
439
706
 
440
707
                        // update cache
441
 
                        _contacts.put( contact._name, id );
 
708
                        _contactsCache.addLookup(
 
709
                                ContactsCache.createIdentifier( contact ), id );
442
710
 
443
 
                        // update UI
 
711
                        // if we haven't already shown that we're overwriting a contact,
 
712
                        // show that we're creating a new contact
444
713
                        if( !uiInformed ) {
445
714
                                _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTCREATED );
446
715
                                uiInformed = true;
447
716
                        }
448
717
                }
449
718
 
450
 
                // update UI
 
719
                // if we haven't already shown that we're overwriting or creating a
 
720
                // contact show that we're merging a contact
451
721
                if( !uiInformed )
452
722
                        _doit._handler.sendEmptyMessage( Doit.MESSAGE_CONTACTMERGED );
453
723
 
454
724
                // import contact parts
455
 
                if( contact._phones != null )
456
 
                        importContactPhones( contactUri, contact._phones );
457
 
                if( contact._emails != null )
458
 
                        importContactEmails( contactUri, contact._emails );
 
725
                if( contact.hasNumbers() )
 
726
                        importContactPhones( id, contact.getNumbers() );
 
727
                if( contact.hasEmails() )
 
728
                        importContactEmails( id, contact.getEmails() );
 
729
                if( contact.hasAddresses() )
 
730
                        importContactAddresses( id, contact.getAddresses() );
 
731
                if( contact.hasOrganisations() )
 
732
                        importContactOrganisations( id, contact.getOrganisations() );
459
733
        }
460
734
 
461
 
        private void importContactPhones( Uri contactUri,
462
 
                        HashMap< String, ContactData.PhoneData > phones )
 
735
        private void importContactPhones( Long id,
 
736
                        HashMap< String, ContactData.PreferredDetail > datas )
463
737
        {
464
 
                Long contactId = ContentUris.parseId( contactUri );
465
 
                Uri contactPhonesUri = Uri.withAppendedPath( contactUri,
466
 
                                Contacts.People.Phones.CONTENT_DIRECTORY );
467
 
                Set phonesKeys = phones.keySet();
 
738
                // get URI to contact's phones
 
739
                Uri contactPhonesUri = Uri.withAppendedPath(
 
740
                        ContentUris.withAppendedId( Contacts.People.CONTENT_URI, id ),
 
741
                        Contacts.People.Phones.CONTENT_DIRECTORY );
 
742
                Set< String > datasKeys = datas.keySet();
468
743
 
469
744
                // add phone numbers
470
 
                Iterator i = phonesKeys.iterator();
 
745
                Iterator< String > i = datasKeys.iterator();
471
746
                while( i.hasNext() ) {
472
 
                        ContactData.PhoneData phone = phones.get( i.next() );
 
747
                        String number = i.next();
 
748
                        ContactData.PreferredDetail data = datas.get( number );
473
749
 
474
750
                        // we don't want to add this number if it's crap, or it already
475
751
                        // exists (which would cause a duplicate to be created). We don't
478
754
                        // if the number exists at all, it doesn't need importing. Because
479
755
                        // of this, we also can't update the cache (which we don't need to
480
756
                        // anyway, so it's not a problem).
481
 
                        String number = sanitisePhoneNumber( phone._number );
482
 
                        if( number == null ) continue;
483
 
                        HashSet< String > numbers = _contactNumbers.get( contactId );
484
 
                        if( numbers != null && numbers.contains( number ) ) continue;
 
757
                        if( _contactsCache.hasAssociatedNumber( id, number ) )
 
758
                                continue;
485
759
 
486
760
                        // add phone number
487
761
                        ContentValues values = new ContentValues();
488
 
                        values.put( Contacts.Phones.TYPE, phone._type );
489
 
                        values.put( Contacts.Phones.NUMBER, phone._number );
490
 
                        if( phone._isPreferred ) values.put( Contacts.Phones.ISPRIMARY, 1 );
 
762
                        values.put( Contacts.Phones.TYPE, data.getType() );
 
763
                        values.put( Contacts.Phones.NUMBER, number );
 
764
                        if( data.isPreferred() )
 
765
                                values.put( Contacts.Phones.ISPRIMARY, 1 );
491
766
                        _doit.getContentResolver().insert( contactPhonesUri, values );
492
 
                }
493
 
 
494
 
                // now add those phone numbers to the cache to prevent the addition of
495
 
                // duplicate data from another file
496
 
                i = phonesKeys.iterator();
497
 
                while( i.hasNext() ) {
498
 
                        ContactData.PhoneData phone = phones.get( i.next() );
499
 
 
500
 
                        String number = sanitisePhoneNumber( phone._number );
501
 
                        if( number != null ) {
502
 
                                HashSet< String > numbers = _contactNumbers.get( contactId );
503
 
                                if( numbers == null ) {
504
 
                                        _contactNumbers.put( contactId, new HashSet< String >() );
505
 
                                        numbers = _contactNumbers.get( contactId );
506
 
                                }
507
 
                                numbers.add( number );
508
 
                        }
 
767
 
 
768
                        // and add this address to the cache to prevent a addition of
 
769
                        // duplicate date from another file
 
770
                        _contactsCache.addAssociatedNumber( id, number );
509
771
                }
510
772
        }
511
773
 
512
 
        private void importContactEmails( Uri contactUri,
513
 
                        HashMap< String, ContactData.EmailData > emails )
 
774
        private void importContactEmails( Long id,
 
775
                        HashMap< String, ContactData.PreferredDetail > datas )
514
776
        {
515
 
                Long contactId = ContentUris.parseId( contactUri );
516
 
                Uri contactContactMethodsUri = Uri.withAppendedPath( contactUri,
517
 
                                Contacts.People.ContactMethods.CONTENT_DIRECTORY );
518
 
                Set emailsKeys = emails.keySet();
 
777
                // get URI to contact's contact methods
 
778
                Uri contactContactMethodsUri = Uri.withAppendedPath(
 
779
                        ContentUris.withAppendedId( Contacts.People.CONTENT_URI, id ),
 
780
                        Contacts.People.ContactMethods.CONTENT_DIRECTORY );
 
781
                Set< String > datasKeys = datas.keySet();
519
782
 
520
783
                // add email addresses
521
 
                Iterator i = emailsKeys.iterator();
 
784
                Iterator< String > i = datasKeys.iterator();
522
785
                while( i.hasNext() ) {
523
 
                        ContactData.EmailData email = emails.get( i.next() );
 
786
                        String email = i.next();
 
787
                        ContactData.PreferredDetail data = datas.get( email );
524
788
 
525
 
                        // like with phone numbers, we don't want to add this email address
526
 
                        // if it exists already or we would introduce duplicates.
527
 
                        String address = sanitiseEmailAddress( email.getAddress() );
528
 
                        if( address == null ) continue;
529
 
                        HashSet< String > addresses = _contactEmails.get( contactId );
530
 
                        if( addresses != null && addresses.contains( address ) ) continue;
 
789
                        // we don't want to add this email address if it exists already or
 
790
                        // we would introduce duplicates.
 
791
                        if( _contactsCache.hasAssociatedEmail( id, email ) )
 
792
                                continue;
531
793
 
532
794
                        // add phone number
533
795
                        ContentValues values = new ContentValues();
534
796
                        values.put( Contacts.ContactMethods.KIND, Contacts.KIND_EMAIL );
535
 
                        values.put( Contacts.ContactMethods.DATA, email.getAddress() );
536
 
                        values.put( Contacts.ContactMethods.TYPE, email.getType() );
537
 
                        if( email.isPreferred() )
 
797
                        values.put( Contacts.ContactMethods.DATA, email );
 
798
                        values.put( Contacts.ContactMethods.TYPE, data.getType() );
 
799
                        if( data.isPreferred() )
538
800
                                values.put( Contacts.ContactMethods.ISPRIMARY, 1 );
539
801
                        _doit.getContentResolver().insert( contactContactMethodsUri,
540
 
                                        values );
541
 
                }
542
 
 
543
 
                // now add those email addresses to the cache to prevent the addition of
544
 
                // duplicate data from another file
545
 
                i = emailsKeys.iterator();
546
 
                while( i.hasNext() ) {
547
 
                        ContactData.EmailData email = emails.get( i.next() );
548
 
 
549
 
                        String address = sanitiseEmailAddress( email.getAddress() );
550
 
                        if( address != null ) {
551
 
                                HashSet< String > addresses = _contactEmails.get( contactId );
552
 
                                if( addresses == null ) {
553
 
                                        _contactEmails.put( contactId, new HashSet< String >() );
554
 
                                        addresses = _contactEmails.get( contactId );
555
 
                                }
556
 
                                addresses.add( address );
557
 
                        }
 
802
                                values );
 
803
 
 
804
                        // and add this address to the cache to prevent a addition of
 
805
                        // duplicate date from another file
 
806
                        _contactsCache.addAssociatedEmail( id, email );
 
807
                }
 
808
        }
 
809
 
 
810
        private void importContactAddresses( Long id,
 
811
                HashMap< String, ContactData.TypeDetail > datas )
 
812
        {
 
813
                // get URI to contact's contact methods
 
814
                Uri contactContactMethodsUri = Uri.withAppendedPath(
 
815
                        ContentUris.withAppendedId( Contacts.People.CONTENT_URI, id ),
 
816
                        Contacts.People.ContactMethods.CONTENT_DIRECTORY );
 
817
 
 
818
                // add addresses
 
819
                Set< String > datasKeys = datas.keySet();
 
820
                Iterator< String > i = datasKeys.iterator();
 
821
                while( i.hasNext() ) {
 
822
                        String address = i.next();
 
823
                        ContactData.TypeDetail data = datas.get( address );
 
824
 
 
825
                        // we don't want to add this address if it exists already or we
 
826
                        // would introduce duplicates
 
827
                        if( _contactsCache.hasAssociatedAddress( id, address ) )
 
828
                                continue;
 
829
 
 
830
                        // add postal address
 
831
                        ContentValues values = new ContentValues();
 
832
                        values.put( Contacts.ContactMethods.KIND, Contacts.KIND_POSTAL );
 
833
                        values.put( Contacts.ContactMethods.DATA, address );
 
834
                        values.put( Contacts.ContactMethods.TYPE, data.getType() );
 
835
                        _doit.getContentResolver().insert( contactContactMethodsUri,
 
836
                                values );
 
837
 
 
838
                        // and add this address to the cache to prevent a addition of
 
839
                        // duplicate date from another file
 
840
                        _contactsCache.addAssociatedAddress( id, address );
 
841
                }
 
842
        }
 
843
 
 
844
        private void importContactOrganisations( Long id,
 
845
                HashMap< String, ContactData.ExtraDetail > datas )
 
846
        {
 
847
                // add addresses
 
848
                Set< String > datasKeys = datas.keySet();
 
849
                Iterator< String > i = datasKeys.iterator();
 
850
                while( i.hasNext() ) {
 
851
                        String organisation = i.next();
 
852
                        ContactData.ExtraDetail data = datas.get( organisation );
 
853
 
 
854
                        // we don't want to add this address if it exists already or we
 
855
                        // would introduce duplicates
 
856
                        if( _contactsCache.hasAssociatedOrganisation( id, organisation ) )
 
857
                                continue;
 
858
 
 
859
                        // add organisation address
 
860
                        ContentValues values = new ContentValues();
 
861
                        values.put( Contacts.Organizations.PERSON_ID, id );
 
862
                        values.put( Contacts.Organizations.COMPANY, organisation );
 
863
                        values.put( Contacts.ContactMethods.TYPE,
 
864
                                Contacts.OrganizationColumns.TYPE_WORK );
 
865
                        if( data.getExtra() != null )
 
866
                                values.put( Contacts.Organizations.TITLE, data.getExtra() );
 
867
                        _doit.getContentResolver().insert(
 
868
                                Contacts.Organizations.CONTENT_URI, values );
 
869
 
 
870
                        // and add this address to the cache to prevent a addition of
 
871
                        // duplicate date from another file
 
872
                        _contactsCache.addAssociatedOrganisation( id, organisation );
558
873
                }
559
874
        }
560
875
 
565
880
                        throw new AbortImportException();
566
881
                }
567
882
        }
568
 
 
569
 
        private void buildContactsCache() throws AbortImportException
570
 
        {
571
 
                // update UI
572
 
                setProgressMessage( R.string.doit_caching );
573
 
 
574
 
                String[] cols;
575
 
                Cursor cur;
576
 
 
577
 
                // init contacts caches
578
 
                _contacts = new HashMap< String, Long >();
579
 
                _contactNumbers = new HashMap< Long, HashSet< String > >();
580
 
                _contactEmails = new HashMap< Long, HashSet< String > >();
581
 
 
582
 
                // query and store map of contact names to ids
583
 
                cols = new String[] { Contacts.People._ID, Contacts.People.NAME };
584
 
                cur = _doit.managedQuery( Contacts.People.CONTENT_URI,
585
 
                                cols, null, null, null);
586
 
                if( cur.moveToFirst() ) {
587
 
                        int idCol = cur.getColumnIndex( Contacts.People._ID );
588
 
                        int nameCol = cur.getColumnIndex( Contacts.People.NAME );
589
 
                        do {
590
 
                                _contacts.put( cur.getString( nameCol ), cur.getLong( idCol ) );
591
 
                        } while( cur.moveToNext() );
592
 
                }
593
 
 
594
 
                // query and store map of contact ids to sets of phone numbers
595
 
                cols = new String[] { Contacts.Phones.PERSON_ID,
596
 
                                Contacts.Phones.NUMBER };
597
 
                cur = _doit.managedQuery( Contacts.Phones.CONTENT_URI,
598
 
                                cols, null, null, null);
599
 
                if( cur.moveToFirst() ) {
600
 
                        int personIdCol = cur.getColumnIndex( Contacts.Phones.PERSON_ID );
601
 
                        int numberCol = cur.getColumnIndex( Contacts.Phones.NUMBER );
602
 
                        do {
603
 
                                Long id = cur.getLong( personIdCol );
604
 
                                String number = sanitisePhoneNumber(
605
 
                                                cur.getString( numberCol ) );
606
 
                                if( number != null ) {
607
 
                                        HashSet< String > numbers = _contactNumbers.get( id );
608
 
                                        if( numbers == null ) {
609
 
                                                _contactNumbers.put( id, new HashSet< String >() );
610
 
                                                numbers = _contactNumbers.get( id );
611
 
                                        }
612
 
                                        numbers.add( number );
613
 
                                }
614
 
                        } while( cur.moveToNext() );
615
 
                }
616
 
 
617
 
                // query and store map of contact ids to sets of email addresses
618
 
                cols = new String[] { Contacts.ContactMethods.PERSON_ID,
619
 
                                Contacts.ContactMethods.DATA };
620
 
                cur = _doit.managedQuery( Contacts.ContactMethods.CONTENT_URI,
621
 
                                cols, Contacts.ContactMethods.KIND + " = ?",
622
 
                                new String[] { "" + Contacts.KIND_EMAIL }, null );
623
 
                if( cur.moveToFirst() ) {
624
 
                        int personIdCol = cur.getColumnIndex(
625
 
                                        Contacts.ContactMethods.PERSON_ID );
626
 
                        int addressCol = cur.getColumnIndex(
627
 
                                        Contacts.ContactMethods.DATA );
628
 
                        do {
629
 
                                Long id = cur.getLong( personIdCol );
630
 
                                String address = sanitiseEmailAddress(
631
 
                                                cur.getString( addressCol ) );
632
 
                                if( address != null ) {
633
 
                                        HashSet< String > addresses = _contactEmails.get( id );
634
 
                                        if( addresses == null ) {
635
 
                                                _contactEmails.put( id, new HashSet< String >() );
636
 
                                                addresses = _contactEmails.get( id );
637
 
                                        }
638
 
                                        addresses.add( address );
639
 
                                }
640
 
                        } while( cur.moveToNext() );
641
 
                }
642
 
        }
643
 
 
644
 
        private String sanitisePhoneNumber( String number )
645
 
        {
646
 
                number = number.replaceAll( "[-\\(\\) ]", "" );
647
 
                Pattern p = Pattern.compile( "^\\+?[0-9]+" );
648
 
                Matcher m = p.matcher( number );
649
 
                if( m.lookingAt() ) return m.group( 0 );
650
 
                return null;
651
 
        }
652
 
 
653
 
        private String sanitiseEmailAddress( String address )
654
 
        {
655
 
                address = address.trim();
656
 
                Pattern p = Pattern.compile(
657
 
                                "^[^ @]+@[a-zA-Z]([-a-zA-Z0-9]*[a-zA-z0-9])?(\\.[a-zA-Z]([-a-zA-Z0-9]*[a-zA-z0-9])?)+$" );
658
 
                Matcher m = p.matcher( address );
659
 
                if( m.matches() ) {
660
 
                        String[] bits = address.split( "@" );
661
 
                        return bits[ 0 ] + "@" + bits[ 1 ].toLowerCase();
662
 
                }
663
 
                return null;
664
 
        }
665
883
}