/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: 2012-12-18 13:00:43 UTC
  • Revision ID: tim@ed.am-20121218130043-4zhj1cdeaqko3c4b
cleanup; fixed some typos; updated TODO

Show diffs side-by-side

added added

removed removed

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