/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: 2010-12-12 00:16:42 UTC
  • Revision ID: edam@waxworlds.org-20101212001642-dqxbxww4ik9x7zbp
- update TODO

Show diffs side-by-side

added added

removed removed

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