/android/import-contacts

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

« back to all changes in this revision

Viewing changes to src/org/waxworlds/importcontacts/Importer.java

  • Committer: edam
  • Date: 2009-01-10 16:14:11 UTC
  • Revision ID: edam@waxworlds.org-20090110161411-4d17l9hs9d6j277q
Initial import

Show diffs side-by-side

added added

removed removed

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