/android/import-contacts

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

« back to all changes in this revision

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

  • Committer: edam
  • Date: 2011-05-30 14:04:51 UTC
  • Revision ID: edam@waxworlds.org-20110530140451-d99fy3zoi6zq1jf2
- renamed VCFImporter to VcardImporter and VCard to Vcard

Show diffs side-by-side

added added

removed removed

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