/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/VcardImporter.java

  • Committer: edam
  • Date: 2012-12-21 20:57:34 UTC
  • Revision ID: tim@ed.am-20121221205734-pmsth53ril4bm1ej
make app verion *code* higher for major release (so that I could do 1.1.1 releases, etc)

Show diffs side-by-side

added added

removed removed

1
1
/*
2
2
 * VCFImporter.java
3
3
 *
4
 
 * Copyright (C) 2009 to 2011 Tim Marston <edam@waxworlds.org>
 
4
 * Copyright (C) 2009 to 2011 Tim Marston <tim@ed.am>
5
5
 *
6
6
 * This file is part of the Import Contacts program (hereafter referred
7
7
 * to as "this program"). For more information, see
8
 
 * http://www.waxworlds.org/edam/software/android/import-contacts
 
8
 * http://ed.am/dev/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 org.waxworlds.edam.importcontacts;
 
24
package am.ed.importcontacts;
25
25
 
26
26
import java.io.BufferedReader;
27
27
import java.io.File;
38
38
import java.util.HashSet;
39
39
import java.util.Iterator;
40
40
import java.util.List;
 
41
import java.util.Locale;
41
42
import java.util.NoSuchElementException;
42
43
import java.util.Set;
43
44
import java.util.Vector;
44
45
import java.util.regex.Matcher;
45
46
import java.util.regex.Pattern;
46
47
 
47
 
import org.waxworlds.edam.importcontacts.Importer.ContactData.ExtraDetail;
48
 
 
 
48
import android.annotation.SuppressLint;
49
49
import android.content.SharedPreferences;
50
 
import android.provider.Contacts;
51
 
import android.provider.Contacts.PhonesColumns;
52
50
 
53
 
public class VCFImporter extends Importer
 
51
public class VcardImporter extends Importer
54
52
{
55
 
        private int _vCardCount = 0;
 
53
        private int _vcard_count = 0;
56
54
        private int _progress = 0;
57
55
 
58
 
        public VCFImporter( Doit doit )
 
56
        public VcardImporter( Doit doit )
59
57
        {
60
58
                super( doit );
61
59
        }
62
60
 
 
61
        @SuppressLint( "SdCardPath" )
63
62
        @Override
64
63
        protected void onImport() throws AbortImportException
65
64
        {
84
83
                                // get files
85
84
                                class VCardFilter implements FilenameFilter {
86
85
                                        public boolean accept( File dir, String name ) {
87
 
                                                return name.toLowerCase().endsWith( ".vcf" );
 
86
                                                return name.toLowerCase( Locale.US ).endsWith( ".vcf" );
88
87
                                        }
89
88
                                }
90
89
                                files = file.listFiles( new VCardFilter() );
112
111
                        countVCardFile( files[ i ] );
113
112
                        setTmpProgress( i );
114
113
                }
115
 
                setProgressMax( _vCardCount );  // will also update tmp progress
 
114
                setProgressMax( _vcard_count ); // will also update tmp progress
116
115
 
117
116
                // import them
118
117
                setProgress( 0 );
119
118
                for( int i = 0; i < files.length; i++ )
120
119
                        importVCardFile( files[ i ] );
 
120
                setProgress( _vcard_count );
121
121
        }
122
122
 
123
123
        private void countVCardFile( File file ) throws AbortImportException
130
130
 
131
131
                        // read
132
132
                        String line;
133
 
                        boolean inVCard = false;
 
133
                        boolean in_vcard = false;
134
134
                        while( ( line = reader.readLine() ) != null )
135
135
                        {
136
 
                                if( !inVCard ) {
 
136
                                if( !in_vcard ) {
137
137
                                        // look for vcard beginning
138
138
                                        if( line.matches( "^BEGIN:VCARD" ) ) {
139
 
                                                inVCard = true;
140
 
                                                _vCardCount++;
 
139
                                                in_vcard = true;
 
140
                                                _vcard_count++;
141
141
                                        }
142
142
                                }
143
143
                                else if( line.matches( "^END:VCARD" ) )
144
 
                                        inVCard = false;
 
144
                                        in_vcard = false;
145
145
                        }
146
146
 
147
147
                }
170
170
                        FileInputStream istream = new FileInputStream( file );
171
171
                        byte[] content = new byte[ (int)file.length() ];
172
172
                        istream.read( content );
 
173
                        istream = null;
173
174
 
174
175
                        // import
175
176
                        importVCardFileContent( content, file.getName() );
176
177
                }
 
178
                catch( OutOfMemoryError e ) {
 
179
                        showError( R.string.error_outofmemory );
 
180
                }
177
181
                catch( FileNotFoundException e ) {
178
182
                        showError( getText( R.string.error_filenotfound ) +
179
183
                                file.getName() );
187
191
                throws AbortImportException
188
192
        {
189
193
                // go through lines
190
 
                VCard vCard = null;
 
194
                Vcard vcard = null;
 
195
                int vcard_start_line = 0;
191
196
                ContentLineIterator cli = new ContentLineIterator( content );
192
197
                while( cli.hasNext() )
193
198
                {
194
 
                        ByteBuffer buffer = cli.next();
195
 
 
196
 
                        // get a US-ASCII version of the line for processing
197
 
                        String line;
198
 
                        try {
199
 
                                line = new String( buffer.array(), buffer.position(),
200
 
                                        buffer.limit() - buffer.position(), "US-ASCII" );
201
 
                        }
202
 
                        catch( UnsupportedEncodingException e ) {
203
 
                                // we know US-ASCII is supported, so appease the compiler...
204
 
                                line = "";
205
 
                        }
206
 
 
207
 
                        if( vCard == null ) {
 
199
                        ContentLine content_line = cli.next();
 
200
 
 
201
                        // get a US-ASCII version of the string, for processing
 
202
                        String line = content_line.getUsAsciiLine();
 
203
 
 
204
                        if( vcard == null ) {
208
205
                                // look for vcard beginning
209
 
                                if( line.matches( "^BEGIN:VCARD" ) ) {
210
 
                                        setProgress( ++_progress );
211
 
                                        vCard = new VCard();
 
206
                                if( line.matches( "^BEGIN[ \t]*:[ \t]*VCARD" ) ) {
 
207
                                        setProgress( _progress++ );
 
208
                                        vcard = new Vcard();
 
209
                                        vcard_start_line = cli.getLineNumber();
212
210
                                }
213
211
                        }
214
212
                        else {
215
213
                                // look for vcard content or ending
216
 
                                if( line.matches( "^END:VCARD" ) )
 
214
                                if( line.matches( "^END[ \t]*:[ \t]*VCARD" ) )
217
215
                                {
218
 
                                        // store vcard and do away with it
 
216
                                        // finalise the vcard/contact
219
217
                                        try {
220
 
                                                vCard.finaliseParsing();
221
 
                                                importContact( vCard );
222
 
                                        }
223
 
                                        catch( VCard.ParseException e ) {
224
 
                                                skipContact();
225
 
                                                if( !showContinue(
226
 
                                                        getText( R.string.error_vcf_parse ).toString()
227
 
                                                        + fileName + "\n" + e.getMessage() ) )
228
 
                                                {
229
 
                                                        finish( ACTION_ABORT );
230
 
                                                }
231
 
                                        }
232
 
                                        catch( VCard.SkipContactException e ) {
233
 
                                                skipContact();
234
 
                                                // do nothing
235
 
                                        }
236
 
                                        vCard = null;
 
218
                                                vcard.finaliseVcard();
 
219
 
 
220
                                                // pass the finalised contact to the importer
 
221
                                                importContact( vcard );
 
222
                                        }
 
223
                                        catch( Vcard.ParseException e ) {
 
224
                                                if( !showContinue(
 
225
                                                        getText( R.string.error_vcf_parse ).toString()
 
226
                                                        + fileName +
 
227
                                                        getText( R.string.error_vcf_parse_line ).toString()
 
228
                                                        + cli.getLineNumber() + ":\n" + e.getMessage() ) )
 
229
                                                {
 
230
                                                        finish( ACTION_ABORT );
 
231
                                                }
 
232
                                                else
 
233
                                                        skipContact();
 
234
                                        }
 
235
                                        catch( ContactData.ContactNotIdentifiableException e ) {
 
236
                                                if( !showContinue(
 
237
                                                        getText( R.string.error_vcf_parse ).toString()
 
238
                                                        + fileName +
 
239
                                                        getText( R.string.error_vcf_parse_line ).toString()
 
240
                                                        + vcard_start_line + ":\n" + getText(
 
241
                                                                R.string.error_vcf_notenoughinfo ).toString()
 
242
                                                ) )
 
243
                                                {
 
244
                                                        finish( ACTION_ABORT );
 
245
                                                }
 
246
                                                else
 
247
                                                        skipContact();
 
248
                                        }
 
249
 
 
250
                                        // discard this vcard
 
251
                                        vcard = null;
237
252
                                }
238
253
                                else
239
254
                                {
240
255
                                        // try giving the line to the vcard
241
256
                                        try {
242
 
                                                vCard.parseLine( buffer, line,
243
 
                                                        cli.doesNextLineLookFolded() );
 
257
                                                vcard.parseLine( content_line );
244
258
                                        }
245
 
                                        catch( VCard.ParseException e ) {
 
259
                                        catch( Vcard.ParseException e ) {
246
260
                                                skipContact();
247
261
                                                if( !showContinue(
248
262
                                                        getText( R.string.error_vcf_parse ).toString()
249
 
                                                        + fileName + "\n" + e.getMessage() ) )
 
263
                                                        + fileName +
 
264
                                                        getText( R.string.error_vcf_parse_line ).toString()
 
265
                                                        + cli.getLineNumber() + "\n" + e.getMessage() ) )
250
266
                                                {
251
267
                                                        finish( ACTION_ABORT );
252
268
                                                }
254
270
                                                // although we're continuing, we still need to abort
255
271
                                                // this vCard. Further lines will be ignored until we
256
272
                                                // get to another BEGIN:VCARD line.
257
 
                                                vCard = null;
 
273
                                                vcard = null;
258
274
                                        }
259
 
                                        catch( VCard.SkipContactException e ) {
 
275
                                        catch( Vcard.SkipImportException e ) {
260
276
                                                skipContact();
261
277
                                                // abort this vCard. Further lines will be ignored until
262
278
                                                // we get to another BEGIN:VCARD line.
263
 
                                                vCard = null;
 
279
                                                vcard = null;
264
280
                                        }
265
281
                                }
266
282
                        }
267
283
                }
268
284
        }
269
285
 
270
 
        class ContentLineIterator implements Iterator< ByteBuffer >
 
286
        class ContentLine
 
287
        {
 
288
                private ByteBuffer _buffer;
 
289
                private boolean _folded_next;
 
290
                private String _line;
 
291
 
 
292
                public ContentLine( ByteBuffer buffer, boolean folded_next )
 
293
                {
 
294
                        _buffer = buffer;
 
295
                        _folded_next = folded_next;
 
296
                        _line = null;
 
297
                }
 
298
 
 
299
                public ByteBuffer getBuffer()
 
300
                {
 
301
                        return _buffer;
 
302
                }
 
303
 
 
304
                public boolean doesNextLineLookFolded()
 
305
                {
 
306
                        return _folded_next;
 
307
                }
 
308
 
 
309
                public String getUsAsciiLine()
 
310
                {
 
311
                        // generated line and cache it
 
312
                        if( _line == null ) {
 
313
                                try {
 
314
                                        _line = new String( _buffer.array(), _buffer.position(),
 
315
                                                _buffer.limit() - _buffer.position(), "US-ASCII" );
 
316
                                }
 
317
                                catch( UnsupportedEncodingException e ) {
 
318
                                        // we know US-ASCII *is* supported, so appease the
 
319
                                        // compiler...
 
320
                                }
 
321
                        }
 
322
 
 
323
                        // return cached line
 
324
                        return _line;
 
325
                }
 
326
        }
 
327
 
 
328
        class ContentLineIterator implements Iterator< ContentLine >
271
329
        {
272
330
                protected byte[] _content = null;
273
331
                protected int _pos = 0;
 
332
                protected int _line = 0;
274
333
 
275
334
                public ContentLineIterator( byte[] content )
276
335
                {
284
343
                }
285
344
 
286
345
                @Override
287
 
                public ByteBuffer next()
 
346
                public ContentLine next()
288
347
                {
289
348
                        int initial_pos = _pos;
290
349
 
296
355
                                        int to = ( _pos > 0 && _content[ _pos - 1 ] == '\r' &&
297
356
                                                _pos > initial_pos )? _pos - 1 : _pos;
298
357
                                        _pos++;
299
 
                                        return ByteBuffer.wrap( _content, initial_pos,
300
 
                                                to - initial_pos );
 
358
                                        _line++;
 
359
                                        return new ContentLine(
 
360
                                                ByteBuffer.wrap( _content, initial_pos,
 
361
                                                        to - initial_pos ),
 
362
                                                doesNextLineLookFolded() );
301
363
                                }
302
364
 
303
365
                        // we didn't find one, but were there bytes left?
304
366
                        if( _pos != initial_pos ) {
305
367
                                int to = _pos;
306
368
                                _pos++;
307
 
                                return ByteBuffer.wrap( _content, initial_pos,
308
 
                                        to - initial_pos );
 
369
                                _line++;
 
370
                                return new ContentLine(
 
371
                                        ByteBuffer.wrap( _content, initial_pos,
 
372
                                                to - initial_pos ),
 
373
                                        doesNextLineLookFolded() );
309
374
                        }
310
375
 
311
376
                        // no bytes left
323
388
                 * onto the end of this one?
324
389
                 * @return
325
390
                 */
326
 
                public boolean doesNextLineLookFolded()
 
391
                private boolean doesNextLineLookFolded()
327
392
                {
328
393
                        return _pos > 0 && _pos < _content.length &&
329
 
                                _content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
 
394
                                _content[ _pos - 1 ] == '\n' &&
 
395
                                ( _content[ _pos ] == ' ' || _content[ _pos ] == '\t' );
 
396
                }
 
397
 
 
398
                public int getLineNumber()
 
399
                {
 
400
                        return _line;
330
401
                }
331
402
        }
332
403
 
333
 
        private class VCard extends ContactData
 
404
        private class Vcard extends ContactData
334
405
        {
335
406
                private final static int NAMELEVEL_NONE = 0;
336
 
                private final static int NAMELEVEL_FN = 1;
337
 
                private final static int NAMELEVEL_N = 2;
 
407
                private final static int NAMELEVEL_N = 1;
 
408
                private final static int NAMELEVEL_FN = 2;
338
409
 
339
410
                private final static int MULTILINE_NONE = 0;
340
411
                private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
341
412
                private final static int MULTILINE_ESCAPED = 2; // v2.1 \\CRLF
342
 
                private final static int MULTILINE_FOLDED = 3;  // v3.0 folding
 
413
                private final static int MULTILINE_FOLDED = 3;  // MIME-DIR folding
343
414
 
344
415
                private String _version = null;
345
 
                private Vector< ByteBuffer > _buffers = null;
 
416
                private Vector< ContentLine > _content_lines = null;
346
417
                private int _name_level = NAMELEVEL_NONE;
347
418
                private int _parser_multiline_state = MULTILINE_NONE;
348
419
                private String _parser_current_name_and_params = null;
384
455
 
385
456
                        public ParseException( int res )
386
457
                        {
387
 
                                super( VCFImporter.this.getText( res ).toString() );
 
458
                                super( VcardImporter.this.getText( res ).toString() );
388
459
                        }
389
460
                }
390
461
 
391
462
                @SuppressWarnings("serial")
392
 
                protected class SkipContactException extends Exception { }
 
463
                protected class SkipImportException extends Exception { }
393
464
 
394
 
                private String extractCollonPartFromLine( ByteBuffer buffer,
395
 
                        String line, boolean former )
 
465
                private String extractCollonPartFromLine( ContentLine content_line,
 
466
                        boolean former )
396
467
                {
397
468
                        String ret = null;
398
469
 
399
 
                        // get a US-ASCII version of the line for processing, unless we were
400
 
                        // supplied with one
401
 
                        if( line == null ) {
402
 
                                try {
403
 
                                        line = new String( buffer.array(), buffer.position(),
404
 
                                                buffer.limit() - buffer.position(), "US-ASCII" );
405
 
                                }
406
 
                                catch( UnsupportedEncodingException e ) {
407
 
                                        // we know US-ASCII is supported, so appease the compiler...
408
 
                                        line = "";
409
 
                                }
410
 
                        }
411
 
 
412
470
                        // split line into name and value parts and check to make sure we
413
471
                        // only got 2 parts and that the first part is not zero in length
414
 
                        String[] parts = line.split( ":", 2 );
 
472
                        String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
415
473
                        if( parts.length == 2 && parts[ 0 ].length() > 0 )
416
474
                                ret = parts[ former? 0 : 1 ];
417
475
 
418
476
                        return ret;
419
477
                }
420
478
 
421
 
                private String extractNameAndParamsFromLine( ByteBuffer buffer,
422
 
                        String line )
423
 
                {
424
 
                        return extractCollonPartFromLine( buffer, line, true );
425
 
                }
426
 
 
427
 
                private String extractValueFromLine( ByteBuffer buffer, String line )
428
 
                {
429
 
                        return extractCollonPartFromLine( buffer, line, false );
430
 
                }
431
 
 
432
 
                public void parseLine( ByteBuffer buffer, String line,
433
 
                        boolean next_line_looks_folded )
434
 
                        throws ParseException, SkipContactException,
 
479
                private String extractNameAndParamsFromLine( ContentLine content_line )
 
480
                {
 
481
                        return extractCollonPartFromLine( content_line, true );
 
482
                }
 
483
 
 
484
                private String extractValueFromLine( ContentLine content_line )
 
485
                {
 
486
                        return extractCollonPartFromLine( content_line, false );
 
487
                }
 
488
 
 
489
                public void parseLine( ContentLine content_line )
 
490
                        throws ParseException, SkipImportException,
435
491
                        AbortImportException
436
492
                {
437
493
                        // do we have a version yet?
439
495
                        {
440
496
                                // tentatively get name and params from line
441
497
                                String name_and_params =
442
 
                                        extractNameAndParamsFromLine( buffer, line );
 
498
                                        extractNameAndParamsFromLine( content_line );
443
499
 
444
500
                                // is it a version line?
445
501
                                if( name_and_params != null &&
446
 
                                        name_and_params.equals( "VERSION" ) )
 
502
                                        name_and_params.equalsIgnoreCase( "VERSION" ) )
447
503
                                {
448
504
                                        // yes, get it!
449
 
                                        String value = extractValueFromLine( buffer, line );
 
505
                                        String value = extractValueFromLine( content_line );
450
506
                                        if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
451
507
                                                throw new ParseException( R.string.error_vcf_version );
452
508
                                        _version = value;
453
509
 
454
510
                                        // parse any buffers we've been accumulating while we waited
455
511
                                        // for a version
456
 
                                        if( _buffers != null )
457
 
                                                for( int i = 0; i < _buffers.size(); i++ )
458
 
                                                        parseLine( _buffers.get( i ), null,
459
 
                                                                i + 1 < _buffers.size() &&
460
 
                                                                _buffers.get( i + 1 ).hasRemaining() &&
461
 
                                                                _buffers.get( i + 1 ).get(
462
 
                                                                        _buffers.get( i + 1 ).position() ) == ' ' );
463
 
                                        _buffers = null;
 
512
                                        if( _content_lines != null )
 
513
                                                for( int i = 0; i < _content_lines.size(); i++ )
 
514
                                                        parseLine( _content_lines.get( i ) );
 
515
                                        _content_lines = null;
464
516
                                }
465
517
                                else
466
518
                                {
467
519
                                        // no, so stash this line till we get a version
468
 
                                        if( _buffers == null )
469
 
                                                _buffers = new Vector< ByteBuffer >();
470
 
                                        _buffers.add( buffer );
 
520
                                        if( _content_lines == null )
 
521
                                                _content_lines = new Vector< ContentLine >();
 
522
                                        _content_lines.add( content_line );
471
523
                                }
472
524
                        }
473
525
                        else
474
526
                        {
475
527
                                // name and params and the position in the buffer where the
476
 
                                // "value" part of the line start
 
528
                                // "value" part of the line starts
477
529
                                String name_and_params;
478
530
                                int pos;
479
531
 
485
537
 
486
538
                                        // skip some initial line characters, depending on the type
487
539
                                        // of multi-line we're handling
488
 
                                        pos = buffer.position();
 
540
                                        pos = content_line.getBuffer().position();
489
541
                                        switch( _parser_multiline_state )
490
542
                                        {
491
543
                                        case MULTILINE_FOLDED:
492
544
                                                pos++;
493
545
                                                break;
494
546
                                        case MULTILINE_ENCODED:
495
 
                                                while( pos < buffer.limit() && (
496
 
                                                        buffer.get( pos ) == ' ' ||
497
 
                                                        buffer.get( pos ) == '\t' ) )
 
547
                                                while( pos < content_line.getBuffer().limit() && (
 
548
                                                        content_line.getBuffer().get( pos ) == ' ' ||
 
549
                                                        content_line.getBuffer().get( pos ) == '\t' ) )
498
550
                                                {
499
551
                                                        pos++;
500
552
                                                }
509
561
                                }
510
562
                                else
511
563
                                {
 
564
                                        // skip empty lines
 
565
                                        if( content_line.getUsAsciiLine().trim().length() == 0 )
 
566
                                                return;
 
567
 
512
568
                                        // get name and params from line, and since we're not
513
569
                                        // parsing a subsequent line in a multi-line, this should
514
570
                                        // not fail, or it's an error
515
571
                                        name_and_params =
516
 
                                                extractNameAndParamsFromLine( buffer, line );
 
572
                                                extractNameAndParamsFromLine( content_line );
517
573
                                        if( name_and_params == null )
518
574
                                                throw new ParseException(
519
575
                                                        R.string.error_vcf_malformed );
520
576
 
521
577
                                        // calculate how many chars to skip from beginning of line
522
578
                                        // so we skip the property "name:" part
523
 
                                        pos = buffer.position() + name_and_params.length() + 1;
 
579
                                        pos = content_line.getBuffer().position() +
 
580
                                                name_and_params.length() + 1;
524
581
 
525
582
                                        // reset the saved multi-line state
526
583
                                        _parser_current_name_and_params = name_and_params;
529
586
 
530
587
                                // get value from buffer, as raw bytes
531
588
                                ByteBuffer value;
532
 
                                value = ByteBuffer.wrap( buffer.array(), pos,
533
 
                                        buffer.limit() - pos );
 
589
                                value = ByteBuffer.wrap( content_line.getBuffer().array(), pos,
 
590
                                        content_line.getBuffer().limit() - pos );
534
591
 
535
592
                                // get parameter parts
536
593
                                String[] name_param_parts = name_and_params.split( ";", -1 );
537
594
                                for( int i = 0; i < name_param_parts.length; i++ )
538
595
                                        name_param_parts[ i ] = name_param_parts[ i ].trim();
539
596
 
 
597
                                // determine whether we care about this entry
 
598
                                final HashSet< String > interesting_fields =
 
599
                                        new HashSet< String >( Arrays.asList( new String[] { "N",
 
600
                                                "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
 
601
                                ) );
 
602
                                boolean is_interesting_field =
 
603
                                        interesting_fields.contains(
 
604
                                                name_param_parts[ 0 ].toUpperCase( Locale.US ) );
 
605
 
540
606
                                // parse encoding parameter
541
607
                                String encoding = checkParam( name_param_parts, "ENCODING" );
542
 
                                if( encoding != null ) encoding = encoding.toUpperCase();
543
 
                                if( encoding != null && !encoding.equals( "8BIT" ) &&
544
 
                                        !encoding.equals( "QUOTED-PRINTABLE" ) )
545
 
                                        //&& !encoding.equals( "BASE64" ) )
 
608
                                if( encoding != null )
 
609
                                        encoding = encoding.toUpperCase( Locale.US );
 
610
                                if( is_interesting_field && encoding != null &&
 
611
                                        !encoding.equalsIgnoreCase( "8BIT" ) &&
 
612
                                        !encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
 
613
                                        //&& !encoding.equalsIgnoreCase( "BASE64" ) )
546
614
                                {
547
615
                                        throw new ParseException( R.string.error_vcf_encoding );
548
616
                                }
549
617
 
550
618
                                // parse charset parameter
551
619
                                String charset = checkParam( name_param_parts, "CHARSET" );
552
 
                                if( charset != null ) charset = charset.toUpperCase();
553
 
                                if( charset != null && !charset.equals( "US-ASCII" ) &&
554
 
                                        !charset.equals( "ASCII" ) &&
555
 
                                        !charset.equals( "UTF-8" ) )
 
620
                                if( charset != null )
 
621
                                        charset = charset.toUpperCase( Locale.US );
 
622
                                if( charset != null &&
 
623
                                        !charset.equalsIgnoreCase( "US-ASCII" ) &&
 
624
                                        !charset.equalsIgnoreCase( "ASCII" ) &&
 
625
                                        !charset.equalsIgnoreCase( "UTF-8" ) )
556
626
                                {
557
627
                                        throw new ParseException( R.string.error_vcf_charset );
558
628
                                }
560
630
                                // do unencoding (or default to a fake unencoding result with
561
631
                                // the raw string)
562
632
                                UnencodeResult unencoding_result = null;
563
 
                                if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
 
633
                                if( encoding != null &&
 
634
                                        encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
 
635
                                {
564
636
                                        unencoding_result = unencodeQuotedPrintable( value );
565
 
//                              else if( encoding != null && encoding.equals( "BASE64" ) )
 
637
                                }
 
638
//                              else if( encoding != null &&
 
639
//                                      encoding.equalsIgnoreCase( "BASE64" ) )
 
640
//                              {
566
641
//                                      unencoding_result = unencodeBase64( props[ 1 ], charset );
 
642
//                              }
567
643
                                if( unencoding_result != null ) {
568
644
                                        value = unencoding_result.getBuffer();
569
645
                                        if( unencoding_result.isAnotherLineRequired() )
570
646
                                                _parser_multiline_state = MULTILINE_ENCODED;
571
647
                                }
572
648
 
573
 
                                // convert 8-bit ASCII charset to US-ASCII
574
 
                                if( charset == null || charset.equals( "ASCII" ) ) {
 
649
                                // convert 8-bit US-ASCII charset to UTF-8 (where no charset is
 
650
                                // specified for a v2.1 vcard entry, we assume it's US-ASCII)
 
651
                                if( ( charset == null && _version.equals( "2.1" ) ) ||
 
652
                                        ( charset != null && (
 
653
                                                charset.equalsIgnoreCase( "ASCII" ) ||
 
654
                                                charset.equalsIgnoreCase( "US-ASCII" ) ) ) )
 
655
                                {
575
656
                                        value = transcodeAsciiToUtf8( value );
576
 
                                        charset = "UTF-8";
577
657
                                }
578
658
 
579
 
                                // process charset
 
659
                                // process charset (value is now in UTF-8)
580
660
                                String string_value;
581
661
                                try {
582
662
                                        string_value = new String( value.array(), value.position(),
583
 
                                                value.limit() - value.position(), charset );
 
663
                                                value.limit() - value.position(), "UTF-8" );
584
664
                                } catch( UnsupportedEncodingException e ) {
585
665
                                        throw new ParseException( R.string.error_vcf_charset );
586
666
                                }
588
668
                                // for some entries that have semicolon-separated value parts,
589
669
                                // check to see if the value ends in an escape character, which
590
670
                                // indicates that we have a multi-line value
591
 
                                if( ( name_param_parts[ 0 ].equals( "N" ) ||
592
 
                                        name_param_parts[ 0 ].equals( "ORG" ) ||
593
 
                                        name_param_parts[ 0 ].equals( "ADR" ) ) &&
 
671
                                if( ( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) ||
 
672
                                        name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) ||
 
673
                                        name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) ) &&
594
674
                                        doesStringEndInAnEscapeChar( string_value ) )
595
675
                                {
596
676
                                        _parser_multiline_state = MULTILINE_ESCAPED;
598
678
                                                string_value.length() - 1 );
599
679
                                }
600
680
 
601
 
                                // now we know whether we're in an encoding multi-line,
602
 
                                // determine if we're in a v3 folded multi-line or not
 
681
                                // if we know we're not in an encoding-based multi-line, check
 
682
                                // to see if we're in a folded multi-line
603
683
                                if( _parser_multiline_state == MULTILINE_NONE &&
604
 
                                        _version.equals( "3.0" ) && next_line_looks_folded )
 
684
                                        content_line.doesNextLineLookFolded() )
605
685
                                {
606
686
                                        _parser_multiline_state = MULTILINE_FOLDED;
607
687
                                }
619
699
                                if( complete_value.length() < 1 ) return;
620
700
 
621
701
                                // parse some properties
622
 
                                if( name_param_parts[ 0 ].equals( "N" ) )
 
702
                                if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
623
703
                                        parseN( name_param_parts, complete_value );
624
 
                                else if( name_param_parts[ 0 ].equals( "FN" ) )
 
704
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
625
705
                                        parseFN( name_param_parts, complete_value );
626
 
                                else if( name_param_parts[ 0 ].equals( "ORG" ) )
 
706
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
627
707
                                        parseORG( name_param_parts, complete_value );
628
 
                                else if( name_param_parts[ 0 ].equals( "TITLE" ) )
 
708
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
629
709
                                        parseTITLE( name_param_parts, complete_value );
630
 
                                else if( name_param_parts[ 0 ].equals( "TEL" ) )
 
710
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
631
711
                                        parseTEL( name_param_parts, complete_value );
632
 
                                else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
 
712
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
633
713
                                        parseEMAIL( name_param_parts, complete_value );
634
 
                                else if( name_param_parts[ 0 ].equals( "ADR" ) )
 
714
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
635
715
                                        parseADR( name_param_parts, complete_value );
 
716
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "LABEL" ) )
 
717
                                        parseLABEL( name_param_parts, complete_value );
 
718
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
 
719
                                        parseNOTE( name_param_parts, complete_value );
636
720
                        }
637
721
                }
638
722
 
651
735
                        return ( count & 1 ) == 1;
652
736
                }
653
737
 
654
 
                private String[] splitValueBySemicolon( String value )
 
738
                private String[] splitValueByCharacter( String value, char character )
655
739
                {
656
 
                        // split string in to parts by semicolon
 
740
                        // split string in to parts by specified character
657
741
                        ArrayList< String > parts = new ArrayList< String >(
658
 
                                Arrays.asList( value.split(  ";" ) ) );
 
742
                                Arrays.asList( value.split( "" + character ) ) );
659
743
 
660
744
                        // go through parts
661
745
                        for( int a = 0; a < parts.size(); a++ )
669
753
                                if( a < parts.size() - 1 &&
670
754
                                        doesStringEndInAnEscapeChar( str ) )
671
755
                                {
672
 
                                        // join the next part to this part and remove the next part
 
756
                                        // append the escaped character, join the next part to this
 
757
                                        // part and remove the next part
673
758
                                        parts.set( a, str.substring( 0, str.length() - 1 ) +
674
 
                                                ';' + parts.get( a + 1 ) );
 
759
                                                character + parts.get( a + 1 ) );
675
760
                                        parts.remove( a + 1 );
676
761
 
677
762
                                        // re-visit this part
688
773
                        return parts.toArray( ret );
689
774
                }
690
775
 
 
776
                private String unescapeValue( String value )
 
777
                {
 
778
                        StringBuilder ret = new StringBuilder( value.length() );
 
779
                        boolean in_escape = false;
 
780
                        for( int a = 0; a < value.length(); a++ )
 
781
                        {
 
782
                                int c = value.codePointAt( a );
 
783
 
 
784
                                // process a normal character
 
785
                                if( !in_escape ) {
 
786
                                        if( c == '\\' )
 
787
                                                in_escape = true;
 
788
                                        else
 
789
                                                ret.append( Character.toChars( c ) );
 
790
                                        continue;
 
791
                                }
 
792
 
 
793
                                // process an escape sequence
 
794
                                in_escape = false;
 
795
                                switch( c )
 
796
                                {
 
797
                                case 'T':
 
798
                                case 't':
 
799
                                        // add tab (invalid/non-standard, but accepted)
 
800
                                        ret.append( '\t' );
 
801
                                        break;
 
802
                                case 'N':
 
803
                                case 'n':
 
804
                                        // add newline
 
805
                                        ret.append( '\n' );
 
806
                                        break;
 
807
                                case '\\':
 
808
                                case ',':
 
809
                                case ';':
 
810
                                        // add escaped character
 
811
                                        ret.append( Character.toChars( c ) );
 
812
                                        break;
 
813
                                default:
 
814
                                        // unknown escape sequence, so add it unescaped
 
815
                                        // (invalid/non-standard, but accepted)
 
816
                                        ret.append( "\\" );
 
817
                                        ret.append( Character.toChars( c ) );
 
818
                                        break;
 
819
                                }
 
820
                        }
 
821
 
 
822
                        return ret.toString();
 
823
                }
 
824
 
691
825
                private void parseN( String[] params, String value )
692
826
                {
693
827
                        // already got a better name?
694
828
                        if( _name_level >= NAMELEVEL_N ) return;
695
829
 
696
830
                        // get name parts
697
 
                        String[] name_parts = splitValueBySemicolon( value );
 
831
                        String[] name_parts = splitValueByCharacter( value, ';' );
698
832
 
699
833
                        // build name
700
834
                        value = "";
701
 
                        if( name_parts.length > 1 && name_parts[ 1 ].length() > 0 )
702
 
                                value += name_parts[ 1 ];
703
 
                        if( name_parts.length > 0 && name_parts[ 0 ].length() > 0 )
704
 
                                value += ( value.length() == 0? "" : " " ) + name_parts[ 0 ];
 
835
                        final int[] part_order = { 3, 1, 2, 0, 4 };
 
836
                        for( int a = 0; a < part_order.length; a++ )
 
837
                                if( name_parts.length > part_order[ a ] &&
 
838
                                        name_parts[ part_order[ a ] ].length() > 0 )
 
839
                                {
 
840
                                        // split this part in to it's comma-separated bits
 
841
                                        String[] name_part_parts = splitValueByCharacter(
 
842
                                                name_parts[ part_order[ a ] ], ',' );
 
843
                                        for( int b = 0; b < name_part_parts.length; b++ )
 
844
                                                if( name_part_parts[ b ].length() > 0 )
 
845
                                                {
 
846
                                                        if( value.length() > 0 ) value += " ";
 
847
                                                        value += name_part_parts[ b ];
 
848
                                                }
 
849
                                }
705
850
 
706
851
                        // set name
707
 
                        setName( value );
 
852
                        setName( unescapeValue( value ) );
708
853
                        _name_level = NAMELEVEL_N;
709
854
                }
710
855
 
714
859
                        if( _name_level >= NAMELEVEL_FN ) return;
715
860
 
716
861
                        // set name
717
 
                        setName( value );
 
862
                        setName( unescapeValue( value ) );
718
863
                        _name_level = NAMELEVEL_FN;
719
864
                }
720
865
 
721
866
                private void parseORG( String[] params, String value )
722
867
                {
723
868
                        // get org parts
724
 
                        String[] org_parts = splitValueBySemicolon( value );
 
869
                        String[] org_parts = splitValueByCharacter( value, ';' );
725
870
                        if( org_parts == null || org_parts.length < 1 ) return;
726
871
 
727
872
                        // build organisation name
729
874
                                String.valueOf( org_parts[ 0 ] ) );
730
875
                        for( int a = 1; a < org_parts.length; a++ )
731
876
                                builder.append( ", " ).append( org_parts[ a ] );
732
 
                        String organisation = builder.toString();
 
877
                        String organisation = unescapeValue( builder.toString() );
733
878
 
734
879
                        // set organisation name (using a title we've previously found)
735
880
                        addOrganisation( organisation, _cached_title, true );
746
891
 
747
892
                private void parseTITLE( String[] params, String value )
748
893
                {
 
894
                        value = unescapeValue( value );
 
895
 
749
896
                        // if we previously had an organisation, look it up and append this
750
897
                        // title to it
751
898
                        if( _cached_organisation != null && hasOrganisations() ) {
773
920
                                "PAGER", "BBS", "MODEM", "CAR", "ISDN", "VIDEO" ) );
774
921
 
775
922
                        // here's the logic...
776
 
                        boolean preferred = types.contains( "PREF" );
 
923
                        boolean is_preferred = types.contains( "PREF" );
777
924
                        int type;
778
925
                        if( types.contains( "FAX" ) )
779
926
                                if( types.contains( "HOME" ) )
780
 
                                        type = PhonesColumns.TYPE_FAX_HOME;
 
927
                                        type = TYPE_FAX_HOME;
781
928
                                else
782
 
                                        type = PhonesColumns.TYPE_FAX_WORK;
 
929
                                        type = TYPE_FAX_WORK;
783
930
                        else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
784
 
                                type = PhonesColumns.TYPE_MOBILE;
 
931
                                type = TYPE_MOBILE;
785
932
                        else if( types.contains( "PAGER" ) )
786
 
                                type = PhonesColumns.TYPE_PAGER;
 
933
                                type = TYPE_PAGER;
787
934
                        else if( types.contains( "WORK" ) )
788
 
                                type = PhonesColumns.TYPE_WORK;
 
935
                                type = TYPE_WORK;
789
936
                        else
790
 
                                type = PhonesColumns.TYPE_HOME;
 
937
                                type = TYPE_HOME;
791
938
 
792
939
                        // add phone number
793
 
                        addNumber( value, type, preferred );
 
940
                        addNumber( value, type, is_preferred );
794
941
                }
795
942
 
796
943
                public void parseEMAIL( String[] params, String value )
801
948
                                "PREF", "WORK", "HOME", "INTERNET" ) );
802
949
 
803
950
                        // add email address
804
 
                        boolean preferred = types.contains( "PREF" );
 
951
                        boolean is_preferred = types.contains( "PREF" );
805
952
                        int type;
806
953
                        if( types.contains( "WORK" ) )
807
 
                                type = Contacts.ContactMethods.TYPE_WORK;
 
954
                                type = TYPE_WORK;
808
955
                        else
809
 
                                type = Contacts.ContactMethods.TYPE_HOME;
 
956
                                type = TYPE_HOME;
810
957
 
811
 
                        addEmail( value, type, preferred );
 
958
                        addEmail( unescapeValue( value ), type, is_preferred );
812
959
                }
813
960
 
814
961
                private void parseADR( String[] params, String value )
815
962
                {
816
963
                        // get address parts
817
 
                        String[] adr_parts = splitValueBySemicolon( value );
 
964
                        String[] adr_parts = splitValueByCharacter( value, ';' );
818
965
 
819
966
                        // build address
820
967
                        value = "";
821
 
                        for( int a = 0; a < adr_parts.length; a++ ) {
822
 
                                if( value.length() > 0 ) value += "\n";
823
 
                                value += adr_parts[ a ].trim();
824
 
                        }
825
 
 
826
 
                        Set< String > types = extractTypes( params, Arrays.asList(
827
 
                                "PREF", "WORK", "HOME", "INTERNET" ) );
828
 
 
829
 
                        // add address
830
 
                        int type;
831
 
                        if( types.contains( "WORK" ) )
832
 
                                type = Contacts.ContactMethods.TYPE_WORK;
833
 
                        else
834
 
                                type = Contacts.ContactMethods.TYPE_HOME;
835
 
 
836
 
                        addAddress( value, type );
837
 
                }
838
 
 
839
 
                public void finaliseParsing()
840
 
                        throws ParseException, SkipContactException,
841
 
                        AbortImportException
 
968
                        for( int a = 0; a < adr_parts.length; a++ )
 
969
                                if( adr_parts[ a ].length() > 0 )
 
970
                                {
 
971
                                        // version 3.0 vCards allow further splitting by comma
 
972
                                        if( _version.equals( "3.0" ) )
 
973
                                        {
 
974
                                                // split this part in to it's comma-separated bits and
 
975
                                                // add them on individual lines
 
976
                                                String[] adr_part_parts =
 
977
                                                        splitValueByCharacter( adr_parts[ a ], ',' );
 
978
                                                for( int b = 0; b < adr_part_parts.length; b++ )
 
979
                                                        if( adr_part_parts[ b ].length() > 0 )
 
980
                                                        {
 
981
                                                                if( value.length() > 0 ) value += "\n";
 
982
                                                                value += adr_part_parts[ b ];
 
983
                                                        }
 
984
                                        }
 
985
                                        else
 
986
                                        {
 
987
                                                // add this part on an individual line
 
988
                                                if( value.length() > 0 ) value += "\n";
 
989
                                                value += adr_parts[ a ];
 
990
                                        }
 
991
                                }
 
992
 
 
993
                        Set< String > types = extractTypes( params, Arrays.asList(
 
994
                                "PREF", "WORK", "HOME" ) );
 
995
 
 
996
                        // add address
 
997
                        int type;
 
998
                        if( types.contains( "WORK" ) )
 
999
                                type = TYPE_WORK;
 
1000
                        else
 
1001
                                type = TYPE_HOME;
 
1002
 
 
1003
                        addAddress( unescapeValue( value ), type );
 
1004
                }
 
1005
 
 
1006
                private void parseLABEL( String[] params, String value )
 
1007
                {
 
1008
                        Set< String > types = extractTypes( params, Arrays.asList(
 
1009
                                "PREF", "WORK", "HOME" ) );
 
1010
 
 
1011
                        // add address
 
1012
                        int type;
 
1013
                        if( types.contains( "WORK" ) )
 
1014
                                type = TYPE_WORK;
 
1015
                        else
 
1016
                                type = TYPE_HOME;
 
1017
 
 
1018
                        addAddress( unescapeValue( value ), type );
 
1019
                }
 
1020
 
 
1021
                private void parseNOTE( String[] params, String value )
 
1022
                {
 
1023
                        addNote( unescapeValue( value ) );
 
1024
                }
 
1025
 
 
1026
                public void finaliseVcard()
 
1027
                        throws ParseException, ContactNotIdentifiableException
842
1028
                {
843
1029
                        // missing version (and data is present)
844
 
                        if( _version == null && _buffers != null )
 
1030
                        if( _version == null && _content_lines != null )
845
1031
                                throw new ParseException( R.string.error_vcf_malformed );
846
1032
 
847
 
                        // check if we should import this contact
848
 
                        try {
849
 
                                if( !isImportRequired( this ) )
850
 
                                        throw new SkipContactException();
851
 
                        }
852
 
                        catch( ContactNeedsMoreInfoException e ) {
853
 
                                throw new ParseException( R.string.error_vcf_notenoughinfo );
854
 
                        }
 
1033
                        // finalise the parent class
 
1034
                        finalise();
855
1035
                }
856
1036
 
 
1037
                /**
 
1038
                 * Amongst the params, find the value of the first, only, of any with
 
1039
                 * the specified name
 
1040
                 * @param params
 
1041
                 * @param name
 
1042
                 * @return a value, or null
 
1043
                 */
857
1044
                private String checkParam( String[] params, String name )
858
1045
                {
 
1046
                        String[] res = checkParams( params, name );
 
1047
                        return res.length > 0? res[ 0 ] : null;
 
1048
                }
 
1049
 
 
1050
                /**
 
1051
                 * Amongst the params, find the values of any with the specified name
 
1052
                 * @param params
 
1053
                 * @param name
 
1054
                 * @return an array of values, or null
 
1055
                 */
 
1056
                private String[] checkParams( String[] params, String name )
 
1057
                {
 
1058
                        HashSet< String > ret = new HashSet< String >();
 
1059
 
859
1060
                        Pattern p = Pattern.compile(
860
 
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
 
1061
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
 
1062
                                Pattern.CASE_INSENSITIVE );
861
1063
                        for( int i = 0; i < params.length; i++ ) {
862
1064
                                Matcher m = p.matcher( params[ i ] );
863
1065
                                if( m.matches() )
864
 
                                        return m.group( 2 );
 
1066
                                        ret.add( m.group( 2 ) );
865
1067
                        }
866
 
                        return null;
 
1068
 
 
1069
                        return (String[]) ret.toArray( new String[ ret.size() ] );
867
1070
                }
868
1071
 
 
1072
                /**
 
1073
                 * Amongst the params, return any type values present. For v2.1 vCards,
 
1074
                 * those types are just parameters. For v3.0, they are prefixed with
 
1075
                 * "TYPE=". There may also be multiple type parameters.
 
1076
                 * @param params an array of params to look for types in
 
1077
                 * @param valid_types an list of upper-case type values to look for
 
1078
                 * @return a set of present type values
 
1079
                 */
869
1080
                private Set< String > extractTypes( String[] params,
870
1081
                        List< String > valid_types )
871
1082
                {
872
1083
                        HashSet< String > types = new HashSet< String >();
873
1084
 
874
1085
                        // get 3.0-style TYPE= param
875
 
                        String type_param;
876
 
                        if( ( type_param = checkParam( params, "TYPE" ) ) != null ) {
877
 
                                String[] parts = type_param.split( "," );
878
 
                                for( int i = 0; i < parts.length; i++ )
879
 
                                        if( valid_types.contains( parts[ i ] ) )
880
 
                                                types.add( parts[ i ] );
 
1086
                        String type_params[] = checkParams( params, "TYPE" );
 
1087
                        for( int a = 0; a < type_params.length; a++ )
 
1088
                        {
 
1089
                                // check for a comma-separated list of types (why? I don't think
 
1090
                                // this is in the specs!)
 
1091
                                String[] parts = type_params[ a ].split( "," );
 
1092
                                for( int i = 0; i < parts.length; i++ ) {
 
1093
                                        String ucpart = parts[ i ].toUpperCase( Locale.US );
 
1094
                                        if( valid_types.contains( ucpart ) )
 
1095
                                                types.add( ucpart );
 
1096
                                }
881
1097
                        }
882
1098
 
883
1099
                        // get 2.1-style type param
884
1100
                        if( _version.equals( "2.1" ) ) {
885
 
                                for( int i = 1; i < params.length; i++ )
886
 
                                        if( valid_types.contains( params[ i ] ) )
887
 
                                                types.add( params[ i ] );
 
1101
                                for( int i = 1; i < params.length; i++ ) {
 
1102
                                        String ucparam = params[ i ].toUpperCase( Locale.US );
 
1103
                                        if( valid_types.contains( ucparam ) )
 
1104
                                                types.add( ucparam );
 
1105
                                }
888
1106
                        }
889
1107
 
890
1108
                        return types;