/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: edam
  • Date: 2013-01-06 18:12:50 UTC
  • Revision ID: tim@ed.am-20130106181250-ymz5p33p1q7o06c4
bump version no. and update NEWS

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