/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: Tim Marston
  • Date: 2014-03-01 17:40:48 UTC
  • Revision ID: tim@ed.am-20140301174048-mtcwds7t2afubvft
updated NEWS

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 <tim@ed.am>
 
4
 * Copyright (C) 2009 to 2013 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
45
45
import java.util.regex.Matcher;
46
46
import java.util.regex.Pattern;
47
47
 
48
 
import android.annotation.SuppressLint;
49
48
import android.content.SharedPreferences;
 
49
import android.os.Environment;
50
50
 
51
51
public class VcardImporter extends Importer
52
52
{
58
58
                super( doit );
59
59
        }
60
60
 
61
 
        @SuppressLint( "SdCardPath" )
62
61
        @Override
63
62
        protected void onImport() throws AbortImportException
64
63
        {
71
70
                File[] files = null;
72
71
                try
73
72
                {
 
73
                        // check SD card is mounted
 
74
                        String state = Environment.getExternalStorageState();
 
75
                        if( !Environment.MEDIA_MOUNTED.equals( state ) &&
 
76
                                !Environment.MEDIA_MOUNTED_READ_ONLY.equals( state ) )
 
77
                        {
 
78
                                showError( R.string.error_nosdcard );
 
79
                        }
 
80
 
74
81
                        // open directory
75
 
                        String path = "/sdcard" + prefs.getString( "location", "/" );
76
 
                        File file = new File( path );
 
82
                        File file = new File( Environment.getExternalStorageDirectory(),
 
83
                                prefs.getString( "location", "/" ) );
77
84
                        if( !file.exists() )
78
85
                                showError( R.string.error_locationnotfound );
79
86
 
133
140
                        boolean in_vcard = false;
134
141
                        while( ( line = reader.readLine() ) != null )
135
142
                        {
136
 
                                if( !in_vcard ) {
 
143
                                if( !in_vcard )
 
144
                                {
137
145
                                        // look for vcard beginning
138
 
                                        if( line.matches( "^BEGIN:VCARD" ) ) {
 
146
                                        if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
139
147
                                                in_vcard = true;
140
148
                                                _vcard_count++;
141
149
                                        }
 
150
                                        // check for vMsg files
 
151
                                        else if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VMSG.*" ) ) {
 
152
                                                showError( getText( R.string.error_vcf_vmsgfile )
 
153
                                                        + file.getName() );
 
154
                                        }
142
155
                                }
143
 
                                else if( line.matches( "^END:VCARD" ) )
 
156
                                else if( line.matches( "(?i)END[ \t]*:[ \t]*VCARD.*" ) )
144
157
                                        in_vcard = false;
145
158
                        }
 
159
                        reader.close();
146
160
 
147
161
                }
148
162
                catch( FileNotFoundException e ) {
170
184
                        FileInputStream istream = new FileInputStream( file );
171
185
                        byte[] content = new byte[ (int)file.length() ];
172
186
                        istream.read( content );
173
 
                        istream = null;
 
187
                        istream.close();
174
188
 
175
189
                        // import
176
190
                        importVCardFileContent( content, file.getName() );
177
191
                }
 
192
                catch( OutOfMemoryError e ) {
 
193
                        showError( R.string.error_outofmemory );
 
194
                }
178
195
                catch( FileNotFoundException e ) {
179
196
                        showError( getText( R.string.error_filenotfound ) +
180
197
                                file.getName() );
193
210
                ContentLineIterator cli = new ContentLineIterator( content );
194
211
                while( cli.hasNext() )
195
212
                {
196
 
                        ByteBuffer buffer = cli.next();
 
213
                        ContentLine content_line = cli.next();
197
214
 
198
 
                        // get a US-ASCII version of the line for processing
199
 
                        String line;
200
 
                        try {
201
 
                                line = new String( buffer.array(), buffer.position(),
202
 
                                        buffer.limit() - buffer.position(), "US-ASCII" );
203
 
                        }
204
 
                        catch( UnsupportedEncodingException e ) {
205
 
                                // we know US-ASCII is supported, so appease the compiler...
206
 
                                line = "";
207
 
                        }
 
215
                        // get a US-ASCII version of the string, for processing
 
216
                        String line = content_line.getUsAsciiLine();
208
217
 
209
218
                        if( vcard == null ) {
210
219
                                // look for vcard beginning
211
 
                                if( line.matches( "^BEGIN[ \t]*:[ \t]*VCARD" ) ) {
 
220
                                if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
212
221
                                        setProgress( _progress++ );
213
222
                                        vcard = new Vcard();
214
223
                                        vcard_start_line = cli.getLineNumber();
216
225
                        }
217
226
                        else {
218
227
                                // look for vcard content or ending
219
 
                                if( line.matches( "^END[ \t]*:[ \t]*VCARD" ) )
 
228
                                if( line.matches( "(?i)END[ \t]*:[ \t]*VCARD.*" ) )
220
229
                                {
221
230
                                        // finalise the vcard/contact
222
231
                                        try {
259
268
                                {
260
269
                                        // try giving the line to the vcard
261
270
                                        try {
262
 
                                                vcard.parseLine( buffer, line,
263
 
                                                        cli.doesNextLineLookFolded() );
 
271
                                                vcard.parseLine( content_line );
264
272
                                        }
265
273
                                        catch( Vcard.ParseException e ) {
266
274
                                                skipContact();
273
281
                                                        finish( ACTION_ABORT );
274
282
                                                }
275
283
 
276
 
                                                // although we're continuing, we still need to abort
277
 
                                                // this vCard. Further lines will be ignored until we
 
284
                                                // Although we're continuing, we still need to abort
 
285
                                                // this vCard.  Further lines will be ignored until we
278
286
                                                // get to another BEGIN:VCARD line.
279
287
                                                vcard = null;
280
288
                                        }
281
289
                                        catch( Vcard.SkipImportException e ) {
282
290
                                                skipContact();
283
 
                                                // abort this vCard. Further lines will be ignored until
 
291
                                                // Abort this vCard.  Further lines will be ignored until
284
292
                                                // we get to another BEGIN:VCARD line.
285
293
                                                vcard = null;
286
294
                                        }
289
297
                }
290
298
        }
291
299
 
292
 
        class ContentLineIterator implements Iterator< ByteBuffer >
 
300
        class ContentLine
 
301
        {
 
302
                private ByteBuffer _buffer;
 
303
                private boolean _folded_next;
 
304
                private String _line;
 
305
 
 
306
                public ContentLine( ByteBuffer buffer, boolean folded_next )
 
307
                {
 
308
                        _buffer = buffer;
 
309
                        _folded_next = folded_next;
 
310
                        _line = null;
 
311
                }
 
312
 
 
313
                public ByteBuffer getBuffer()
 
314
                {
 
315
                        return _buffer;
 
316
                }
 
317
 
 
318
                public boolean doesNextLineLookFolded()
 
319
                {
 
320
                        return _folded_next;
 
321
                }
 
322
 
 
323
                public String getUsAsciiLine()
 
324
                {
 
325
                        // generated line and cache it
 
326
                        if( _line == null ) {
 
327
                                try {
 
328
                                        _line = new String( _buffer.array(), _buffer.position(),
 
329
                                                _buffer.limit() - _buffer.position(), "US-ASCII" );
 
330
                                }
 
331
                                catch( UnsupportedEncodingException e ) {
 
332
                                        // we know US-ASCII *is* supported, so appease the
 
333
                                        // compiler...
 
334
                                }
 
335
                        }
 
336
 
 
337
                        // return cached line
 
338
                        return _line;
 
339
                }
 
340
        }
 
341
 
 
342
        class ContentLineIterator implements Iterator< ContentLine >
293
343
        {
294
344
                protected byte[] _content = null;
295
345
                protected int _pos = 0;
307
357
                }
308
358
 
309
359
                @Override
310
 
                public ByteBuffer next()
 
360
                public ContentLine next()
311
361
                {
312
362
                        int initial_pos = _pos;
313
363
 
320
370
                                                _pos > initial_pos )? _pos - 1 : _pos;
321
371
                                        _pos++;
322
372
                                        _line++;
323
 
                                        return ByteBuffer.wrap( _content, initial_pos,
324
 
                                                to - initial_pos );
 
373
                                        return new ContentLine(
 
374
                                                ByteBuffer.wrap( _content, initial_pos,
 
375
                                                        to - initial_pos ),
 
376
                                                doesNextLineLookFolded() );
325
377
                                }
326
378
 
327
379
                        // we didn't find one, but were there bytes left?
329
381
                                int to = _pos;
330
382
                                _pos++;
331
383
                                _line++;
332
 
                                return ByteBuffer.wrap( _content, initial_pos,
333
 
                                        to - initial_pos );
 
384
                                return new ContentLine(
 
385
                                        ByteBuffer.wrap( _content, initial_pos,
 
386
                                                to - initial_pos ),
 
387
                                        doesNextLineLookFolded() );
334
388
                        }
335
389
 
336
390
                        // no bytes left
348
402
                 * onto the end of this one?
349
403
                 * @return
350
404
                 */
351
 
                public boolean doesNextLineLookFolded()
 
405
                private boolean doesNextLineLookFolded()
352
406
                {
353
407
                        return _pos > 0 && _pos < _content.length &&
354
408
                                _content[ _pos - 1 ] == '\n' &&
373
427
                private final static int MULTILINE_FOLDED = 3;  // MIME-DIR folding
374
428
 
375
429
                private String _version = null;
376
 
                private Vector< ByteBuffer > _buffers = null;
 
430
                private Vector< ContentLine > _content_lines = null;
377
431
                private int _name_level = NAMELEVEL_NONE;
378
432
                private int _parser_multiline_state = MULTILINE_NONE;
379
433
                private String _parser_current_name_and_params = null;
422
476
                @SuppressWarnings("serial")
423
477
                protected class SkipImportException extends Exception { }
424
478
 
425
 
                private String extractCollonPartFromLine( ByteBuffer buffer,
426
 
                        String line, boolean former )
 
479
                private String extractCollonPartFromLine( ContentLine content_line,
 
480
                        boolean former )
427
481
                {
428
 
                        String ret = null;
429
 
 
430
 
                        // get a US-ASCII version of the line for processing, unless we were
431
 
                        // supplied with one
432
 
                        if( line == null ) {
433
 
                                try {
434
 
                                        line = new String( buffer.array(), buffer.position(),
435
 
                                                buffer.limit() - buffer.position(), "US-ASCII" );
436
 
                                }
437
 
                                catch( UnsupportedEncodingException e ) {
438
 
                                        // we know US-ASCII is supported, so appease the compiler...
439
 
                                        line = "";
440
 
                                }
441
 
                        }
442
 
 
443
482
                        // split line into name and value parts and check to make sure we
444
483
                        // only got 2 parts and that the first part is not zero in length
445
 
                        String[] parts = line.split( ":", 2 );
 
484
                        String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
446
485
                        if( parts.length == 2 && parts[ 0 ].length() > 0 )
447
 
                                ret = parts[ former? 0 : 1 ];
448
 
 
449
 
                        return ret;
450
 
                }
451
 
 
452
 
                private String extractNameAndParamsFromLine( ByteBuffer buffer,
453
 
                        String line )
454
 
                {
455
 
                        return extractCollonPartFromLine( buffer, line, true );
456
 
                }
457
 
 
458
 
                private String extractValueFromLine( ByteBuffer buffer, String line )
459
 
                {
460
 
                        return extractCollonPartFromLine( buffer, line, false );
461
 
                }
462
 
 
463
 
                public void parseLine( ByteBuffer buffer, String line,
464
 
                        boolean next_line_looks_folded )
 
486
                                return parts[ former? 0 : 1 ].trim();
 
487
 
 
488
                        return null;
 
489
                }
 
490
 
 
491
                private String extractNameAndParamsFromLine( ContentLine content_line )
 
492
                {
 
493
                        return extractCollonPartFromLine( content_line, true );
 
494
                }
 
495
 
 
496
                private String extractValueFromLine( ContentLine content_line )
 
497
                {
 
498
                        return extractCollonPartFromLine( content_line, false );
 
499
                }
 
500
 
 
501
                public void parseLine( ContentLine content_line )
465
502
                        throws ParseException, SkipImportException,
466
503
                        AbortImportException
467
504
                {
470
507
                        {
471
508
                                // tentatively get name and params from line
472
509
                                String name_and_params =
473
 
                                        extractNameAndParamsFromLine( buffer, line );
 
510
                                        extractNameAndParamsFromLine( content_line );
474
511
 
475
512
                                // is it a version line?
476
513
                                if( name_and_params != null &&
477
514
                                        name_and_params.equalsIgnoreCase( "VERSION" ) )
478
515
                                {
479
516
                                        // yes, get it!
480
 
                                        String value = extractValueFromLine( buffer, line );
481
 
                                        if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
 
517
                                        String value = extractValueFromLine( content_line );
 
518
                                        if( value == null || (
 
519
                                                !value.equals( "2.1" ) && !value.equals( "3.0" ) ) )
 
520
                                        {
482
521
                                                throw new ParseException( R.string.error_vcf_version );
 
522
                                        }
483
523
                                        _version = value;
484
524
 
485
525
                                        // parse any buffers we've been accumulating while we waited
486
526
                                        // for a version
487
 
                                        if( _buffers != null )
488
 
                                                for( int i = 0; i < _buffers.size(); i++ )
489
 
                                                        parseLine( _buffers.get( i ), null,
490
 
                                                                i + 1 < _buffers.size() &&
491
 
                                                                _buffers.get( i + 1 ).hasRemaining() &&
492
 
                                                                _buffers.get( i + 1 ).get(
493
 
                                                                        _buffers.get( i + 1 ).position() ) == ' ' );
494
 
                                        _buffers = null;
 
527
                                        if( _content_lines != null )
 
528
                                                for( int i = 0; i < _content_lines.size(); i++ )
 
529
                                                        parseLine( _content_lines.get( i ) );
 
530
                                        _content_lines = null;
495
531
                                }
496
532
                                else
497
533
                                {
498
534
                                        // no, so stash this line till we get a version
499
 
                                        if( _buffers == null )
500
 
                                                _buffers = new Vector< ByteBuffer >();
501
 
                                        _buffers.add( buffer );
 
535
                                        if( _content_lines == null )
 
536
                                                _content_lines = new Vector< ContentLine >();
 
537
                                        _content_lines.add( content_line );
502
538
                                }
503
539
                        }
504
540
                        else
505
541
                        {
506
542
                                // name and params and the position in the buffer where the
507
 
                                // "value" part of the line start
 
543
                                // "value" part of the line starts
508
544
                                String name_and_params;
509
545
                                int pos;
510
546
 
516
552
 
517
553
                                        // skip some initial line characters, depending on the type
518
554
                                        // of multi-line we're handling
519
 
                                        pos = buffer.position();
 
555
                                        pos = content_line.getBuffer().position();
520
556
                                        switch( _parser_multiline_state )
521
557
                                        {
522
558
                                        case MULTILINE_FOLDED:
523
559
                                                pos++;
524
560
                                                break;
525
561
                                        case MULTILINE_ENCODED:
526
 
                                                while( pos < buffer.limit() && (
527
 
                                                        buffer.get( pos ) == ' ' ||
528
 
                                                        buffer.get( pos ) == '\t' ) )
 
562
                                                while( pos < content_line.getBuffer().limit() && (
 
563
                                                        content_line.getBuffer().get( pos ) == ' ' ||
 
564
                                                        content_line.getBuffer().get( pos ) == '\t' ) )
529
565
                                                {
530
566
                                                        pos++;
531
567
                                                }
540
576
                                }
541
577
                                else
542
578
                                {
 
579
                                        // skip empty lines
 
580
                                        if( content_line.getUsAsciiLine().trim().length() == 0 )
 
581
                                                return;
 
582
 
543
583
                                        // get name and params from line, and since we're not
544
584
                                        // parsing a subsequent line in a multi-line, this should
545
585
                                        // not fail, or it's an error
546
586
                                        name_and_params =
547
 
                                                extractNameAndParamsFromLine( buffer, line );
 
587
                                                extractNameAndParamsFromLine( content_line );
548
588
                                        if( name_and_params == null )
549
589
                                                throw new ParseException(
550
590
                                                        R.string.error_vcf_malformed );
551
591
 
552
592
                                        // calculate how many chars to skip from beginning of line
553
593
                                        // so we skip the property "name:" part
554
 
                                        pos = buffer.position() + name_and_params.length() + 1;
 
594
                                        pos = content_line.getBuffer().position() +
 
595
                                                name_and_params.length() + 1;
555
596
 
556
597
                                        // reset the saved multi-line state
557
598
                                        _parser_current_name_and_params = name_and_params;
560
601
 
561
602
                                // get value from buffer, as raw bytes
562
603
                                ByteBuffer value;
563
 
                                value = ByteBuffer.wrap( buffer.array(), pos,
564
 
                                        buffer.limit() - pos );
 
604
                                value = ByteBuffer.wrap( content_line.getBuffer().array(), pos,
 
605
                                        content_line.getBuffer().limit() - pos );
565
606
 
566
607
                                // get parameter parts
567
608
                                String[] name_param_parts = name_and_params.split( ";", -1 );
574
615
                                                "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
575
616
                                ) );
576
617
                                boolean is_interesting_field =
577
 
                                        interesting_fields.contains( name_param_parts[ 0 ] );
 
618
                                        interesting_fields.contains(
 
619
                                                name_param_parts[ 0 ].toUpperCase( Locale.US ) );
578
620
 
579
621
                                // parse encoding parameter
580
622
                                String encoding = checkParam( name_param_parts, "ENCODING" );
654
696
                                // if we know we're not in an encoding-based multi-line, check
655
697
                                // to see if we're in a folded multi-line
656
698
                                if( _parser_multiline_state == MULTILINE_NONE &&
657
 
                                        next_line_looks_folded )
 
699
                                        content_line.doesNextLineLookFolded() )
658
700
                                {
659
701
                                        _parser_multiline_state = MULTILINE_FOLDED;
660
702
                                }
690
732
                                        parseLABEL( name_param_parts, complete_value );
691
733
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
692
734
                                        parseNOTE( name_param_parts, complete_value );
 
735
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "BDAY" ) )
 
736
                                        parseBDAY( name_param_parts, complete_value );
693
737
                        }
694
738
                }
695
739
 
719
763
                        {
720
764
                                String str = parts.get( a );
721
765
 
722
 
                                // look for parts that end in an escape character, but ignore
723
 
                                // the final part. We've already detected escape chars at the
 
766
                                // Look for parts that end in an escape character, but ignore
 
767
                                // the final part.  We've already detected escape chars at the
724
768
                                // end of the final part in parseLine() and handled multi-lines
725
769
                                // accordingly.
726
770
                                if( a < parts.size() - 1 &&
816
860
                                        for( int b = 0; b < name_part_parts.length; b++ )
817
861
                                                if( name_part_parts[ b ].length() > 0 )
818
862
                                                {
819
 
                                                        if( value.length() == 0 ) value += " ";
 
863
                                                        if( value.length() > 0 ) value += " ";
820
864
                                                        value += name_part_parts[ b ];
821
865
                                                }
822
866
                                }
996
1040
                        addNote( unescapeValue( value ) );
997
1041
                }
998
1042
 
 
1043
                private void parseBDAY( String[] params, String value )
 
1044
                {
 
1045
                        setBirthday( value );
 
1046
                }
 
1047
 
999
1048
                public void finaliseVcard()
1000
1049
                        throws ParseException, ContactNotIdentifiableException
1001
1050
                {
1002
1051
                        // missing version (and data is present)
1003
 
                        if( _version == null && _buffers != null )
 
1052
                        if( _version == null && _content_lines != null )
1004
1053
                                throw new ParseException( R.string.error_vcf_malformed );
1005
1054
 
1006
1055
                        // finalise the parent class
1009
1058
 
1010
1059
                /**
1011
1060
                 * Amongst the params, find the value of the first, only, of any with
1012
 
                 * the specified name
 
1061
                 * the specified name.
 
1062
                 *
1013
1063
                 * @param params
1014
1064
                 * @param name
1015
1065
                 * @return a value, or null
1021
1071
                }
1022
1072
 
1023
1073
                /**
1024
 
                 * Amongst the params, find the values of any with the specified name
 
1074
                 * Amongst the params, find the values of any with the specified name.
 
1075
                 *
1025
1076
                 * @param params
1026
1077
                 * @param name
1027
1078
                 * @return an array of values, or null
1043
1094
                }
1044
1095
 
1045
1096
                /**
1046
 
                 * Amongst the params, return any type values present. For v2.1 vCards,
1047
 
                 * those types are just parameters. For v3.0, they are prefixed with
1048
 
                 * "TYPE=". There may also be multiple type parameters.
 
1097
                 * Amongst the params, return any type values present.  For v2.1 vCards,
 
1098
                 * those types are just parameters.  For v3.0, they are prefixed with
 
1099
                 * "TYPE=".  There may also be multiple type parameters.
 
1100
                 *
1049
1101
                 * @param params an array of params to look for types in
1050
1102
                 * @param valid_types an list of upper-case type values to look for
1051
1103
                 * @return a set of present type values
1059
1111
                        String type_params[] = checkParams( params, "TYPE" );
1060
1112
                        for( int a = 0; a < type_params.length; a++ )
1061
1113
                        {
1062
 
                                // check for a comma-separated list of types (why? this isn't in
1063
 
                                // the specs!)
 
1114
                                // check for a comma-separated list of types (why? I don't think
 
1115
                                // this is in the specs!)
1064
1116
                                String[] parts = type_params[ a ].split( "," );
1065
 
                                for( int i = 0; i < parts.length; i++ )
1066
 
                                        parts[ i ] = parts[ i ].toUpperCase( Locale.US );
1067
 
                                for( int i = 0; i < parts.length; i++ )
1068
 
                                        if( valid_types.contains( parts[ i ] ) )
1069
 
                                                types.add( parts[ i ] );
 
1117
                                for( int i = 0; i < parts.length; i++ ) {
 
1118
                                        String ucpart = parts[ i ].toUpperCase( Locale.US );
 
1119
                                        if( valid_types.contains( ucpart ) )
 
1120
                                                types.add( ucpart );
 
1121
                                }
1070
1122
                        }
1071
1123
 
1072
1124
                        // get 2.1-style type param
1073
1125
                        if( _version.equals( "2.1" ) ) {
1074
 
                                for( int i = 1; i < params.length; i++ )
1075
 
                                        if( valid_types.contains( params[ i ] ) )
1076
 
                                                types.add( params[ i ] );
 
1126
                                for( int i = 1; i < params.length; i++ ) {
 
1127
                                        String ucparam = params[ i ].toUpperCase( Locale.US );
 
1128
                                        if( valid_types.contains( ucparam ) )
 
1129
                                                types.add( ucparam );
 
1130
                                }
1077
1131
                        }
1078
1132
 
1079
1133
                        return types;
1101
1155
                                else if( ch == '=' && i == in.limit() - 1 )
1102
1156
                                {
1103
1157
                                        // we found a '=' at the end of a line signifying a multi-
1104
 
                                        // line string, so we don't add it.
 
1158
                                        // line string, so we don't add it
1105
1159
                                        another = true;
1106
1160
                                        continue;
1107
1161
                                }