/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 14:48:44 UTC
  • Revision ID: tim@ed.am-20121221144844-licgvkppbjq4th4m
updated copyright dates and improved an error message

Show diffs side-by-side

added added

removed removed

1
1
/*
2
2
 * VCFImporter.java
3
3
 *
4
 
 * Copyright (C) 2009 to 2013 Tim Marston <tim@ed.am>
 
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
 
 * 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;
48
49
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" )
61
62
        @Override
62
63
        protected void onImport() throws AbortImportException
63
64
        {
70
71
                File[] files = null;
71
72
                try
72
73
                {
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
 
 
81
74
                        // open directory
82
 
                        File file = new File( Environment.getExternalStorageDirectory(),
83
 
                                prefs.getString( "location", "/" ) );
 
75
                        String path = "/sdcard" + prefs.getString( "location", "/" );
 
76
                        File file = new File( path );
84
77
                        if( !file.exists() )
85
78
                                showError( R.string.error_locationnotfound );
86
79
 
140
133
                        boolean in_vcard = false;
141
134
                        while( ( line = reader.readLine() ) != null )
142
135
                        {
143
 
                                if( !in_vcard )
144
 
                                {
 
136
                                if( !in_vcard ) {
145
137
                                        // look for vcard beginning
146
 
                                        if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
 
138
                                        if( line.matches( "^BEGIN:VCARD" ) ) {
147
139
                                                in_vcard = true;
148
140
                                                _vcard_count++;
149
141
                                        }
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
 
                                        }
155
142
                                }
156
 
                                else if( line.matches( "(?i)END[ \t]*:[ \t]*VCARD.*" ) )
 
143
                                else if( line.matches( "^END:VCARD" ) )
157
144
                                        in_vcard = false;
158
145
                        }
159
 
                        reader.close();
160
146
 
161
147
                }
162
148
                catch( FileNotFoundException e ) {
184
170
                        FileInputStream istream = new FileInputStream( file );
185
171
                        byte[] content = new byte[ (int)file.length() ];
186
172
                        istream.read( content );
187
 
                        istream.close();
 
173
                        istream = null;
188
174
 
189
175
                        // import
190
176
                        importVCardFileContent( content, file.getName() );
191
177
                }
192
 
                catch( OutOfMemoryError e ) {
193
 
                        showError( R.string.error_outofmemory );
194
 
                }
195
178
                catch( FileNotFoundException e ) {
196
179
                        showError( getText( R.string.error_filenotfound ) +
197
180
                                file.getName() );
210
193
                ContentLineIterator cli = new ContentLineIterator( content );
211
194
                while( cli.hasNext() )
212
195
                {
213
 
                        ContentLine content_line = cli.next();
 
196
                        ByteBuffer buffer = cli.next();
214
197
 
215
 
                        // get a US-ASCII version of the string, for processing
216
 
                        String line = content_line.getUsAsciiLine();
 
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
                        }
217
208
 
218
209
                        if( vcard == null ) {
219
210
                                // look for vcard beginning
220
 
                                if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
 
211
                                if( line.matches( "^BEGIN[ \t]*:[ \t]*VCARD" ) ) {
221
212
                                        setProgress( _progress++ );
222
213
                                        vcard = new Vcard();
223
214
                                        vcard_start_line = cli.getLineNumber();
225
216
                        }
226
217
                        else {
227
218
                                // look for vcard content or ending
228
 
                                if( line.matches( "(?i)END[ \t]*:[ \t]*VCARD.*" ) )
 
219
                                if( line.matches( "^END[ \t]*:[ \t]*VCARD" ) )
229
220
                                {
230
221
                                        // finalise the vcard/contact
231
222
                                        try {
268
259
                                {
269
260
                                        // try giving the line to the vcard
270
261
                                        try {
271
 
                                                vcard.parseLine( content_line );
 
262
                                                vcard.parseLine( buffer, line,
 
263
                                                        cli.doesNextLineLookFolded() );
272
264
                                        }
273
265
                                        catch( Vcard.ParseException e ) {
274
266
                                                skipContact();
281
273
                                                        finish( ACTION_ABORT );
282
274
                                                }
283
275
 
284
 
                                                // Although we're continuing, we still need to abort
285
 
                                                // this vCard.  Further lines will be ignored until we
 
276
                                                // although we're continuing, we still need to abort
 
277
                                                // this vCard. Further lines will be ignored until we
286
278
                                                // get to another BEGIN:VCARD line.
287
279
                                                vcard = null;
288
280
                                        }
289
281
                                        catch( Vcard.SkipImportException e ) {
290
282
                                                skipContact();
291
 
                                                // Abort this vCard.  Further lines will be ignored until
 
283
                                                // abort this vCard. Further lines will be ignored until
292
284
                                                // we get to another BEGIN:VCARD line.
293
285
                                                vcard = null;
294
286
                                        }
297
289
                }
298
290
        }
299
291
 
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 >
 
292
        class ContentLineIterator implements Iterator< ByteBuffer >
343
293
        {
344
294
                protected byte[] _content = null;
345
295
                protected int _pos = 0;
357
307
                }
358
308
 
359
309
                @Override
360
 
                public ContentLine next()
 
310
                public ByteBuffer next()
361
311
                {
362
312
                        int initial_pos = _pos;
363
313
 
370
320
                                                _pos > initial_pos )? _pos - 1 : _pos;
371
321
                                        _pos++;
372
322
                                        _line++;
373
 
                                        return new ContentLine(
374
 
                                                ByteBuffer.wrap( _content, initial_pos,
375
 
                                                        to - initial_pos ),
376
 
                                                doesNextLineLookFolded() );
 
323
                                        return ByteBuffer.wrap( _content, initial_pos,
 
324
                                                to - initial_pos );
377
325
                                }
378
326
 
379
327
                        // we didn't find one, but were there bytes left?
381
329
                                int to = _pos;
382
330
                                _pos++;
383
331
                                _line++;
384
 
                                return new ContentLine(
385
 
                                        ByteBuffer.wrap( _content, initial_pos,
386
 
                                                to - initial_pos ),
387
 
                                        doesNextLineLookFolded() );
 
332
                                return ByteBuffer.wrap( _content, initial_pos,
 
333
                                        to - initial_pos );
388
334
                        }
389
335
 
390
336
                        // no bytes left
402
348
                 * onto the end of this one?
403
349
                 * @return
404
350
                 */
405
 
                private boolean doesNextLineLookFolded()
 
351
                public boolean doesNextLineLookFolded()
406
352
                {
407
353
                        return _pos > 0 && _pos < _content.length &&
408
354
                                _content[ _pos - 1 ] == '\n' &&
427
373
                private final static int MULTILINE_FOLDED = 3;  // MIME-DIR folding
428
374
 
429
375
                private String _version = null;
430
 
                private Vector< ContentLine > _content_lines = null;
 
376
                private Vector< ByteBuffer > _buffers = null;
431
377
                private int _name_level = NAMELEVEL_NONE;
432
378
                private int _parser_multiline_state = MULTILINE_NONE;
433
379
                private String _parser_current_name_and_params = null;
476
422
                @SuppressWarnings("serial")
477
423
                protected class SkipImportException extends Exception { }
478
424
 
479
 
                private String extractCollonPartFromLine( ContentLine content_line,
480
 
                        boolean former )
 
425
                private String extractCollonPartFromLine( ByteBuffer buffer,
 
426
                        String line, boolean former )
481
427
                {
 
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
 
482
443
                        // split line into name and value parts and check to make sure we
483
444
                        // only got 2 parts and that the first part is not zero in length
484
 
                        String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
 
445
                        String[] parts = line.split( ":", 2 );
485
446
                        if( parts.length == 2 && parts[ 0 ].length() > 0 )
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 )
 
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 )
502
465
                        throws ParseException, SkipImportException,
503
466
                        AbortImportException
504
467
                {
507
470
                        {
508
471
                                // tentatively get name and params from line
509
472
                                String name_and_params =
510
 
                                        extractNameAndParamsFromLine( content_line );
 
473
                                        extractNameAndParamsFromLine( buffer, line );
511
474
 
512
475
                                // is it a version line?
513
476
                                if( name_and_params != null &&
514
477
                                        name_and_params.equalsIgnoreCase( "VERSION" ) )
515
478
                                {
516
479
                                        // yes, get it!
517
 
                                        String value = extractValueFromLine( content_line );
518
 
                                        if( value == null || (
519
 
                                                !value.equals( "2.1" ) && !value.equals( "3.0" ) ) )
520
 
                                        {
 
480
                                        String value = extractValueFromLine( buffer, line );
 
481
                                        if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
521
482
                                                throw new ParseException( R.string.error_vcf_version );
522
 
                                        }
523
483
                                        _version = value;
524
484
 
525
485
                                        // parse any buffers we've been accumulating while we waited
526
486
                                        // for a version
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;
 
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;
531
495
                                }
532
496
                                else
533
497
                                {
534
498
                                        // no, so stash this line till we get a version
535
 
                                        if( _content_lines == null )
536
 
                                                _content_lines = new Vector< ContentLine >();
537
 
                                        _content_lines.add( content_line );
 
499
                                        if( _buffers == null )
 
500
                                                _buffers = new Vector< ByteBuffer >();
 
501
                                        _buffers.add( buffer );
538
502
                                }
539
503
                        }
540
504
                        else
552
516
 
553
517
                                        // skip some initial line characters, depending on the type
554
518
                                        // of multi-line we're handling
555
 
                                        pos = content_line.getBuffer().position();
 
519
                                        pos = buffer.position();
556
520
                                        switch( _parser_multiline_state )
557
521
                                        {
558
522
                                        case MULTILINE_FOLDED:
559
523
                                                pos++;
560
524
                                                break;
561
525
                                        case MULTILINE_ENCODED:
562
 
                                                while( pos < content_line.getBuffer().limit() && (
563
 
                                                        content_line.getBuffer().get( pos ) == ' ' ||
564
 
                                                        content_line.getBuffer().get( pos ) == '\t' ) )
 
526
                                                while( pos < buffer.limit() && (
 
527
                                                        buffer.get( pos ) == ' ' ||
 
528
                                                        buffer.get( pos ) == '\t' ) )
565
529
                                                {
566
530
                                                        pos++;
567
531
                                                }
577
541
                                else
578
542
                                {
579
543
                                        // skip empty lines
580
 
                                        if( content_line.getUsAsciiLine().trim().length() == 0 )
581
 
                                                return;
 
544
                                        if( line.trim().length() == 0 ) return;
582
545
 
583
546
                                        // get name and params from line, and since we're not
584
547
                                        // parsing a subsequent line in a multi-line, this should
585
548
                                        // not fail, or it's an error
586
549
                                        name_and_params =
587
 
                                                extractNameAndParamsFromLine( content_line );
 
550
                                                extractNameAndParamsFromLine( buffer, line );
588
551
                                        if( name_and_params == null )
589
552
                                                throw new ParseException(
590
553
                                                        R.string.error_vcf_malformed );
591
554
 
592
555
                                        // calculate how many chars to skip from beginning of line
593
556
                                        // so we skip the property "name:" part
594
 
                                        pos = content_line.getBuffer().position() +
595
 
                                                name_and_params.length() + 1;
 
557
                                        pos = buffer.position() + name_and_params.length() + 1;
596
558
 
597
559
                                        // reset the saved multi-line state
598
560
                                        _parser_current_name_and_params = name_and_params;
601
563
 
602
564
                                // get value from buffer, as raw bytes
603
565
                                ByteBuffer value;
604
 
                                value = ByteBuffer.wrap( content_line.getBuffer().array(), pos,
605
 
                                        content_line.getBuffer().limit() - pos );
 
566
                                value = ByteBuffer.wrap( buffer.array(), pos,
 
567
                                        buffer.limit() - pos );
606
568
 
607
569
                                // get parameter parts
608
570
                                String[] name_param_parts = name_and_params.split( ";", -1 );
696
658
                                // if we know we're not in an encoding-based multi-line, check
697
659
                                // to see if we're in a folded multi-line
698
660
                                if( _parser_multiline_state == MULTILINE_NONE &&
699
 
                                        content_line.doesNextLineLookFolded() )
 
661
                                        next_line_looks_folded )
700
662
                                {
701
663
                                        _parser_multiline_state = MULTILINE_FOLDED;
702
664
                                }
732
694
                                        parseLABEL( name_param_parts, complete_value );
733
695
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
734
696
                                        parseNOTE( name_param_parts, complete_value );
735
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "BDAY" ) )
736
 
                                        parseBDAY( name_param_parts, complete_value );
737
697
                        }
738
698
                }
739
699
 
763
723
                        {
764
724
                                String str = parts.get( a );
765
725
 
766
 
                                // Look for parts that end in an escape character, but ignore
767
 
                                // the final part.  We've already detected escape chars at the
 
726
                                // look for parts that end in an escape character, but ignore
 
727
                                // the final part. We've already detected escape chars at the
768
728
                                // end of the final part in parseLine() and handled multi-lines
769
729
                                // accordingly.
770
730
                                if( a < parts.size() - 1 &&
860
820
                                        for( int b = 0; b < name_part_parts.length; b++ )
861
821
                                                if( name_part_parts[ b ].length() > 0 )
862
822
                                                {
863
 
                                                        if( value.length() > 0 ) value += " ";
 
823
                                                        if( value.length() == 0 ) value += " ";
864
824
                                                        value += name_part_parts[ b ];
865
825
                                                }
866
826
                                }
1040
1000
                        addNote( unescapeValue( value ) );
1041
1001
                }
1042
1002
 
1043
 
                private void parseBDAY( String[] params, String value )
1044
 
                {
1045
 
                        setBirthday( value );
1046
 
                }
1047
 
 
1048
1003
                public void finaliseVcard()
1049
1004
                        throws ParseException, ContactNotIdentifiableException
1050
1005
                {
1051
1006
                        // missing version (and data is present)
1052
 
                        if( _version == null && _content_lines != null )
 
1007
                        if( _version == null && _buffers != null )
1053
1008
                                throw new ParseException( R.string.error_vcf_malformed );
1054
1009
 
1055
1010
                        // finalise the parent class
1058
1013
 
1059
1014
                /**
1060
1015
                 * Amongst the params, find the value of the first, only, of any with
1061
 
                 * the specified name.
1062
 
                 *
 
1016
                 * the specified name
1063
1017
                 * @param params
1064
1018
                 * @param name
1065
1019
                 * @return a value, or null
1071
1025
                }
1072
1026
 
1073
1027
                /**
1074
 
                 * Amongst the params, find the values of any with the specified name.
1075
 
                 *
 
1028
                 * Amongst the params, find the values of any with the specified name
1076
1029
                 * @param params
1077
1030
                 * @param name
1078
1031
                 * @return an array of values, or null
1094
1047
                }
1095
1048
 
1096
1049
                /**
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
 
                 *
 
1050
                 * Amongst the params, return any type values present. For v2.1 vCards,
 
1051
                 * those types are just parameters. For v3.0, they are prefixed with
 
1052
                 * "TYPE=". There may also be multiple type parameters.
1101
1053
                 * @param params an array of params to look for types in
1102
1054
                 * @param valid_types an list of upper-case type values to look for
1103
1055
                 * @return a set of present type values
1155
1107
                                else if( ch == '=' && i == in.limit() - 1 )
1156
1108
                                {
1157
1109
                                        // we found a '=' at the end of a line signifying a multi-
1158
 
                                        // line string, so we don't add it
 
1110
                                        // line string, so we don't add it.
1159
1111
                                        another = true;
1160
1112
                                        continue;
1161
1113
                                }