/android/import-contacts

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

« back to all changes in this revision

Viewing changes to src/am/ed/importcontacts/Importer.java

  • Committer: Tim Marston
  • Date: 2016-03-28 18:13:50 UTC
  • Revision ID: tim@ed.am-20160328181350-ytxvox60fxj1tevm
fixed typo in strings

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