/android/import-contacts

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

« back to all changes in this revision

Viewing changes to src/am/ed/importcontacts/ContactsCache.java

  • Committer: edam
  • Date: 2012-04-24 09:56:17 UTC
  • Revision ID: tim@ed.am-20120424095617-lsfkkpkrlqk9xthn
updated all URLs, email addresses and package names to ed.am

Show diffs side-by-side

added added

removed removed

src/am/ed/importcontacts/ContactsCache.java
1
1
/*
2
2
 * ContactsCache.java
3
3
 *
4
 
 * Copyright (C) 2011 to 2013 Tim Marston <tim@ed.am>
 
4
 * Copyright (C) 2011 Tim Marston <tim@ed.am>
5
5
 *
6
6
 * This file is part of the Import Contacts program (hereafter referred
7
 
 * to as "this program").  For more information, see
 
7
 * to as "this program"). For more information, see
8
8
 * http://ed.am/dev/android/import-contacts
9
9
 *
10
10
 * This program is free software: you can redistribute it and/or modify
25
25
 
26
26
import java.util.HashMap;
27
27
import java.util.HashSet;
28
 
import java.util.Locale;
 
28
 
 
29
import am.ed.importcontacts.Importer.AbortImportException;
 
30
 
 
31
import android.app.Activity;
 
32
import android.database.Cursor;
 
33
import android.provider.Contacts;
 
34
 
29
35
 
30
36
public class ContactsCache
31
37
{
32
38
        /**
33
 
         * A thing that can be used to identify (or lookup) a contact within the
34
 
         * contacts cache.  It is not a reference to a cache entry and may not
35
 
         * identify an existing contact in the cache.
 
39
         * Information that can be used to identify a contact within the cache
36
40
         */
37
 
        public static class CacheIdentifier
 
41
        static public class CacheIdentifier
38
42
        {
39
 
                public enum Type { NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }
 
43
                public enum Type {
 
44
                        NONE, NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }
40
45
 
41
46
                private Type _type;
42
47
                private String _detail;
43
48
 
44
 
                /**
45
 
                 * Obtain a cache identifier.  This routine is designed to be as robust
46
 
                 * as possible (in terms of bad or null detail values), and to return
47
 
                 * null when a cache identifier can not be created.
48
 
                 *
49
 
                 * @param type the detail type
50
 
                 * @param detail the detail
51
 
                 * @return the cache identifier, or null
52
 
                 */
53
 
                public static CacheIdentifier factory( Type type, String detail )
54
 
                {
55
 
                        switch( type )
56
 
                        {
57
 
                        case NAME: detail = normaliseName( detail ); break;
58
 
                        case ORGANISATION: detail = normaliseOrganisation( detail ); break;
59
 
                        case PRIMARY_NUMBER: detail = normalisePhoneNumber( detail ); break;
60
 
                        case PRIMARY_EMAIL: detail = normaliseEmailAddress( detail ); break;
61
 
                        default: return null;
62
 
                        }
63
 
                        if( detail == null ) return null;
64
 
                        return new CacheIdentifier( type, detail );
65
 
                }
66
 
 
67
 
                /**
68
 
                 * Obtain a cache identifier from contact data.  This routine is
69
 
                 * designed to be as robust as possible and may return null when a cache
70
 
                 * identifier can not be created.
71
 
                 *
72
 
                 * @param contact the contact data
73
 
                 * @return the cache identifier, or null
74
 
                 */
75
 
                public static CacheIdentifier factory( Importer.ContactData contact )
76
 
                {
77
 
                        CacheIdentifier identifier = null;
78
 
 
79
 
                        if( contact.hasName() )
80
 
                                identifier = factory( CacheIdentifier.Type.NAME,
81
 
                                        contact.getName() );
82
 
                        if( identifier != null ) return identifier;
83
 
 
84
 
                        if( contact.hasPrimaryOrganisation() )
85
 
                                identifier = factory( CacheIdentifier.Type.ORGANISATION,
86
 
                                        contact.getPrimaryOrganisation() );
87
 
                        if( identifier != null ) return identifier;
88
 
 
89
 
                        if( contact.hasPrimaryNumber() )
90
 
                                identifier = factory( CacheIdentifier.Type.PRIMARY_NUMBER,
91
 
                                        contact.getPrimaryNumber() );
92
 
                        if( identifier != null ) return identifier;
93
 
 
94
 
                        if( contact.hasPrimaryEmail() )
95
 
                                identifier = factory( CacheIdentifier.Type.PRIMARY_EMAIL,
96
 
                                        contact.getPrimaryEmail() );
97
 
                        if( identifier != null ) return identifier;
98
 
 
99
 
                        return null;
 
49
                protected CacheIdentifier()
 
50
                {
 
51
                        _type = Type.NONE;
100
52
                }
101
53
 
102
54
                protected CacheIdentifier( Type type, String detail )
117
69
        }
118
70
 
119
71
        // mappings of contact names, organisations and primary numbers to ids
120
 
        private HashMap< String, Long > _contactsByName
121
 
                = new HashMap< String, Long >();
122
 
        private HashMap< String, Long > _contactsByOrg
123
 
                = new HashMap< String, Long >();
124
 
        private HashMap< String, Long > _contactsByNumber
125
 
                = new HashMap< String, Long >();
126
 
        private HashMap< String, Long > _contactsByEmail
127
 
                = new HashMap< String, Long >();
 
72
        private HashMap< String, Long > _contactsByName;
 
73
        private HashMap< String, Long > _contactsByOrg;
 
74
        private HashMap< String, Long > _contactsByNumber;
 
75
        private HashMap< String, Long > _contactsByEmail;
128
76
 
129
77
        // mapping of contact ids to sets of associated data
130
 
        private HashMap< Long, HashSet< String > > _contactNumbers
131
 
                = new HashMap< Long, HashSet< String > >();
132
 
        private HashMap< Long, HashSet< String > > _contactEmails
133
 
                = new HashMap< Long, HashSet< String > >();
134
 
        private HashMap< Long, HashSet< String > > _contactAddresses
135
 
                = new HashMap< Long, HashSet< String > >();
136
 
        private HashMap< Long, HashSet< String > > _contactOrganisations
137
 
                = new HashMap< Long, HashSet< String > >();
138
 
        private HashMap< Long, HashSet< String > > _contactNotes
139
 
                = new HashMap< Long, HashSet< String > >();
140
 
        private HashMap< Long, String > _contactBirthdays
141
 
                = new HashMap< Long, String >();
 
78
        private HashMap< Long, HashSet< String > > _contactNumbers;
 
79
        private HashMap< Long, HashSet< String > > _contactEmails;
 
80
        private HashMap< Long, HashSet< String > > _contactAddresses;
 
81
        private HashMap< Long, HashSet< String > > _contactOrganisations;
 
82
 
 
83
        public static CacheIdentifier createIdentifier(
 
84
                Importer.ContactData contact )
 
85
        {
 
86
                if( contact.hasName() ) {
 
87
                        String name = normaliseName( contact.getName() );
 
88
                        if( name != null )
 
89
                                return new CacheIdentifier(
 
90
                                        CacheIdentifier.Type.NAME, name );
 
91
                }
 
92
 
 
93
                if( contact.hasPrimaryOrganisation() ) {
 
94
                        String organisation = normaliseOrganisation(
 
95
                                contact.getPrimaryOrganisation() );
 
96
                        if( organisation != null )
 
97
                                return new CacheIdentifier(
 
98
                                        CacheIdentifier.Type.ORGANISATION, organisation );
 
99
                }
 
100
 
 
101
                if( contact.hasPrimaryNumber() ) {
 
102
                        String number = normalisePhoneNumber( contact.getPrimaryNumber() );
 
103
                        if( number != null )
 
104
                        return new CacheIdentifier(
 
105
                                CacheIdentifier.Type.PRIMARY_NUMBER, number );
 
106
                }
 
107
 
 
108
                if( contact.hasPrimaryEmail() ) {
 
109
                        String email = normaliseEmailAddress( contact.getPrimaryEmail() );
 
110
                        if( email != null )
 
111
                        return new CacheIdentifier(
 
112
                                CacheIdentifier.Type.PRIMARY_EMAIL, email );
 
113
                }
 
114
 
 
115
                return null;
 
116
        }
142
117
 
143
118
        public boolean canLookup( CacheIdentifier identifier )
144
119
        {
145
120
                return lookup( identifier ) != null;
146
121
        }
147
122
 
148
 
        /**
149
 
         * Retrieve the contact id of a contact identified by the specified cache
150
 
         * identifier, if it exists.
151
 
         *
152
 
         * @param identifier the cache identifier
153
 
         * @return a contact id, or null
154
 
         */
155
123
        public Long lookup( CacheIdentifier identifier )
156
124
        {
157
125
                switch( identifier.getType() )
168
136
                return null;
169
137
        }
170
138
 
171
 
        /**
172
 
         * Remove any cache entry that is identified by the cache identifier.
173
 
         *
174
 
         * @param identifier the cache identifier
175
 
         * @return the contact id of the contact that was removed, or null
176
 
         */
177
139
        public Long removeLookup( CacheIdentifier identifier )
178
140
        {
179
141
                switch( identifier.getType() )
190
152
                return null;
191
153
        }
192
154
 
193
 
        /**
194
 
         * Add a lookup from a contact identifier to a contact id to the cache.
195
 
         *
196
 
         * @param identifier the cache identifier
197
 
         * @param id teh contact id
198
 
         */
199
155
        public void addLookup( CacheIdentifier identifier, Long id )
200
156
        {
201
157
                switch( identifier.getType() )
215
171
                }
216
172
        }
217
173
 
218
 
        /**
219
 
         * Remove any data that is associated with an contact id.
220
 
         *
221
 
         * @param id
222
 
         */
223
174
        public void removeAssociatedData( Long id )
224
175
        {
225
176
                _contactNumbers.remove( id );
226
177
                _contactEmails.remove( id );
227
178
                _contactAddresses.remove( id );
228
179
                _contactOrganisations.remove( id );
229
 
                _contactNotes.remove( id );
230
180
        }
231
181
 
232
182
        public boolean hasAssociatedNumber( Long id, String number )
248
198
                        set = new HashSet< String >();
249
199
                        _contactNumbers.put( id, set );
250
200
                }
251
 
                set.add( number );
 
201
                set.add( normalisePhoneNumber( number ) );
252
202
        }
253
203
 
254
204
        public boolean hasAssociatedEmail( Long id, String email )
257
207
                if( email == null ) return false;
258
208
 
259
209
                HashSet< String > set = _contactEmails.get( id );
260
 
                return set != null && set.contains( email );
 
210
                return set != null && set.contains( normaliseEmailAddress( email ) );
261
211
        }
262
212
 
263
213
        public void addAssociatedEmail( Long id, String email )
270
220
                        set = new HashSet< String >();
271
221
                        _contactEmails.put( id, set );
272
222
                }
273
 
                set.add( email );
 
223
                set.add( normaliseEmailAddress( email ) );
274
224
        }
275
225
 
276
226
        public boolean hasAssociatedAddress( Long id, String address )
279
229
                if( address == null ) return false;
280
230
 
281
231
                HashSet< String > set = _contactAddresses.get( id );
282
 
                return set != null && set.contains( address );
 
232
                return set != null && set.contains( normaliseAddress( address ) );
283
233
        }
284
234
 
285
235
        public void addAssociatedAddress( Long id, String address )
292
242
                        set = new HashSet< String >();
293
243
                        _contactAddresses.put( id, set );
294
244
                }
295
 
                set.add( address );
 
245
                set.add( normaliseAddress( address ) );
296
246
        }
297
247
 
298
248
        public boolean hasAssociatedOrganisation( Long id, String organisation )
301
251
                if( organisation == null ) return false;
302
252
 
303
253
                HashSet< String > set = _contactOrganisations.get( id );
304
 
                return set != null && set.contains( organisation );
 
254
                return set != null && set.contains(
 
255
                        normaliseOrganisation( organisation ) );
305
256
        }
306
257
 
307
258
        public void addAssociatedOrganisation( Long id, String organisation )
314
265
                        set = new HashSet< String >();
315
266
                        _contactOrganisations.put( id, set );
316
267
                }
317
 
                set.add( organisation );
318
 
        }
319
 
 
320
 
        public boolean hasAssociatedNote( Long id, String note )
321
 
        {
322
 
                note = normaliseNote( note );
323
 
                if( note == null ) return false;
324
 
 
325
 
                HashSet< String > set = _contactNotes.get( id );
326
 
                return set != null && set.contains( note );
327
 
        }
328
 
 
329
 
        public void addAssociatedNote( Long id, String note )
330
 
        {
331
 
                note = normaliseNote( note );
332
 
                if( note == null ) return;
333
 
 
334
 
                HashSet< String > set = _contactNotes.get( id );
335
 
                if( set == null ) {
336
 
                        set = new HashSet< String >();
337
 
                        _contactNotes.put( id, set );
338
 
                }
339
 
                set.add( note );
340
 
        }
341
 
 
342
 
        public boolean hasAssociatedBirthday( Long id, String birthday )
343
 
        {
344
 
                birthday = normaliseBirthday( birthday );
345
 
                if( birthday == null ) return false;
346
 
 
347
 
                String found = _contactBirthdays.get( id );
348
 
                return found != null && found.equalsIgnoreCase( birthday );
349
 
        }
350
 
 
351
 
        public void addAssociatedBirthday( Long id, String birthday )
352
 
        {
353
 
                birthday = normaliseBirthday( birthday );
354
 
                if( birthday == null ) return;
355
 
 
356
 
                _contactBirthdays.put( id, birthday );
357
 
        }
358
 
 
359
 
        static public String normaliseName( String name )
 
268
                set.add( normaliseOrganisation( organisation ) );
 
269
        }
 
270
 
 
271
        public void buildCache( Activity activity )
 
272
                throws AbortImportException
 
273
        {
 
274
                Cursor cur;
 
275
 
 
276
                // init id lookups
 
277
                _contactsByName = new HashMap< String, Long >();
 
278
                _contactsByOrg = new HashMap< String, Long >();
 
279
                _contactsByNumber = new HashMap< String, Long >();
 
280
                _contactsByEmail = new HashMap< String, Long >();
 
281
 
 
282
                // init associated data cache
 
283
                _contactNumbers = new HashMap< Long, HashSet< String > >();
 
284
                _contactEmails = new HashMap< Long, HashSet< String > >();
 
285
                _contactAddresses = new HashMap< Long, HashSet< String > >();
 
286
                _contactOrganisations = new HashMap< Long, HashSet< String > >();
 
287
 
 
288
                // set of contact ids that we have not yet added
 
289
                HashSet< Long > unadded = new HashSet< Long >();
 
290
 
 
291
                // get all contacts
 
292
                cur = activity.managedQuery( Contacts.People.CONTENT_URI,
 
293
                        new String[] {
 
294
                                Contacts.People._ID,
 
295
                                Contacts.People.NAME,
 
296
                        }, null, null, null );
 
297
                while( cur.moveToNext() ) {
 
298
                        Long id = cur.getLong(
 
299
                                cur.getColumnIndex( Contacts.People._ID ) );
 
300
                        String name = normaliseName( cur.getString(
 
301
                                cur.getColumnIndex( Contacts.People.NAME ) ) );
 
302
                        if( name != null )
 
303
                        {
 
304
                                // if we can, add a lookup for the contact id by name
 
305
                                if( name.length() > 0 ) {
 
306
                                        addLookup( new CacheIdentifier(
 
307
                                                CacheIdentifier.Type.NAME, name ), id );
 
308
                                        continue;
 
309
                                }
 
310
                        }
 
311
 
 
312
                        // record that a lookup for this contact's id still needs to be
 
313
                        // added by some other means
 
314
                        unadded.add( id );
 
315
                }
 
316
 
 
317
                // get contact organisations, primary ones first
 
318
                cur = activity.managedQuery( Contacts.Organizations.CONTENT_URI,
 
319
                        new String[] {
 
320
                                Contacts.Phones.PERSON_ID,
 
321
                                Contacts.Organizations.COMPANY,
 
322
                        }, null, null, Contacts.Organizations.ISPRIMARY + " DESC" );
 
323
                while( cur.moveToNext() ) {
 
324
                        Long id = cur.getLong( cur.getColumnIndex(
 
325
                                Contacts.Organizations.PERSON_ID ) );
 
326
                        String organisation = normaliseOrganisation( cur.getString(
 
327
                                cur.getColumnIndex( Contacts.Organizations.COMPANY ) ) );
 
328
                        if( organisation != null )
 
329
                        {
 
330
                                // if this is an organisation name for a contact for whom we
 
331
                                // have not added a lookup, add a lookup for the contact id
 
332
                                // by organisation
 
333
                                if( unadded.contains( id ) ) {
 
334
                                        addLookup( new CacheIdentifier(
 
335
                                                CacheIdentifier.Type.ORGANISATION, organisation ), id );
 
336
                                        unadded.remove( id );
 
337
                                }
 
338
 
 
339
                                // add associated data
 
340
                                addAssociatedOrganisation( id, organisation );
 
341
                        }
 
342
                }
 
343
 
 
344
                // get all phone numbers, primary ones first
 
345
                cur = activity.managedQuery( Contacts.Phones.CONTENT_URI,
 
346
                        new String[] {
 
347
                                Contacts.Phones.PERSON_ID,
 
348
                                Contacts.Phones.NUMBER,
 
349
                        }, null, null, Contacts.Phones.ISPRIMARY + " DESC" );
 
350
                while( cur.moveToNext() ) {
 
351
                        Long id = cur.getLong(
 
352
                                cur.getColumnIndex( Contacts.Phones.PERSON_ID ) );
 
353
                        String number = normalisePhoneNumber( cur.getString(
 
354
                                cur.getColumnIndex( Contacts.Phones.NUMBER ) ) );
 
355
                        if( number != null )
 
356
                        {
 
357
                                // if this is a number for a contact for whom we have not
 
358
                                // added a lookup, add a lookup for the contact id by phone
 
359
                                // number
 
360
                                if( unadded.contains( id ) ) {
 
361
                                        addLookup( new CacheIdentifier(
 
362
                                                CacheIdentifier.Type.PRIMARY_NUMBER, number ), id );
 
363
                                        unadded.remove( id );
 
364
                                }
 
365
 
 
366
                                // add associated data
 
367
                                addAssociatedNumber( id, number );
 
368
                        }
 
369
                }
 
370
 
 
371
                // now get all email addresses, primary ones first, and postal addresses
 
372
                cur = activity.managedQuery( Contacts.ContactMethods.CONTENT_URI,
 
373
                        new String[] {
 
374
                                Contacts.ContactMethods.PERSON_ID,
 
375
                                Contacts.ContactMethods.DATA,
 
376
                                Contacts.ContactMethods.KIND,
 
377
                        }, Contacts.ContactMethods.KIND + " IN( ?, ? )", new String[] {
 
378
                                "" + Contacts.KIND_EMAIL,
 
379
                                "" + Contacts.KIND_POSTAL,
 
380
                        }, Contacts.ContactMethods.ISPRIMARY + " DESC" );
 
381
                while( cur.moveToNext() ) {
 
382
                        Long id = cur.getLong(
 
383
                                cur.getColumnIndex( Contacts.ContactMethods.PERSON_ID ) );
 
384
                        int kind = cur.getInt(
 
385
                                cur.getColumnIndex( Contacts.ContactMethods.KIND ) );
 
386
                        if( kind == Contacts.KIND_EMAIL )
 
387
                        {
 
388
                                String email = normaliseEmailAddress( cur.getString(
 
389
                                        cur.getColumnIndex( Contacts.ContactMethods.DATA ) ) );
 
390
                                if( email != null )
 
391
                                {
 
392
                                        // if this is an email address for a contact for whom we
 
393
                                        // have not added a lookup, add a lookup for the contact
 
394
                                        // id by email address
 
395
                                        if( unadded.contains( id ) ) {
 
396
                                                addLookup( new CacheIdentifier(
 
397
                                                        CacheIdentifier.Type.PRIMARY_EMAIL, email ), id );
 
398
                                                unadded.remove( id );
 
399
                                        }
 
400
 
 
401
                                        // add associated data
 
402
                                        addAssociatedEmail( id, email );
 
403
                                }
 
404
                        }
 
405
                        else if( kind == Contacts.KIND_POSTAL )
 
406
                        {
 
407
                                String address = normaliseAddress( cur.getString(
 
408
                                        cur.getColumnIndex( Contacts.ContactMethods.DATA ) ) );
 
409
                                if( address != null )
 
410
                                {
 
411
                                        // add associated data
 
412
                                        addAssociatedAddress( id, address );
 
413
                                }
 
414
                        }
 
415
                }
 
416
        }
 
417
 
 
418
        static private String normaliseName( String name )
360
419
        {
361
420
                if( name == null ) return null;
362
421
                name = name.trim();
363
422
                return name.length() > 0? name : null;
364
423
        }
365
424
 
366
 
        static public String normalisePhoneNumber( String number )
 
425
        static private String normalisePhoneNumber( String number )
367
426
        {
368
427
                if( number == null ) return null;
369
428
                number = number.trim().replaceAll( "[-\\(\\) ]", "" );
370
429
                return number.length() > 0? number : null;
371
430
        }
372
431
 
373
 
        static public String normaliseEmailAddress( String email )
 
432
        static private String normaliseEmailAddress( String email )
374
433
        {
375
434
                if( email == null ) return null;
376
 
                email = email.trim().toLowerCase( Locale.US );
 
435
                email = email.trim().toLowerCase();
377
436
                return email.length() > 0? email : null;
378
437
        }
379
438
 
380
 
        static public String normaliseOrganisation( String organisation )
 
439
        static private String normaliseOrganisation( String organisation )
381
440
        {
382
441
                if( organisation == null ) return null;
383
442
                organisation = organisation.trim();
384
443
                return organisation.length() > 0? organisation : null;
385
444
        }
386
445
 
387
 
        static public String normaliseAddress( String address )
 
446
        static private String normaliseAddress( String address )
388
447
        {
389
448
                if( address == null ) return null;
390
449
                address = address.trim();
391
450
                return address.length() > 0? address : null;
392
451
        }
393
 
 
394
 
        static public String normaliseNote( String note )
395
 
        {
396
 
                if( note == null ) return null;
397
 
                note = note.trim();
398
 
                return note.length() > 0? note : null;
399
 
        }
400
 
 
401
 
        static public String normaliseBirthday( String birthday )
402
 
        {
403
 
                if( birthday == null ) return null;
404
 
                birthday = birthday.trim();
405
 
                return birthday.length() > 0? birthday : null;
406
 
        }
407
452
}