/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-11 13:00:52 UTC
  • Revision ID: edam@waxworlds.org-20090111130052-q9bh0zz4ey47egbv
- updated todo list

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