4
* Copyright (C) 2009 to 2011 Tim Marston <tim@ed.am>
4
* Copyright (C) 2009 to 2013 Tim Marston <tim@ed.am>
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
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;
48
import android.annotation.SuppressLint;
49
48
import android.content.SharedPreferences;
49
import android.os.Environment;
51
51
public class VcardImporter extends Importer
71
70
File[] files = null;
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 ) )
78
showError( R.string.error_nosdcard );
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 );
84
91
class VCardFilter implements FilenameFilter {
85
92
public boolean accept( File dir, String name ) {
86
return name.toLowerCase( Locale.US ).endsWith( ".vcf" );
93
return name.toLowerCase( Locale.ENGLISH )
89
97
files = file.listFiles( new VCardFilter() );
133
141
boolean in_vcard = false;
134
142
while( ( line = reader.readLine() ) != null )
137
146
// look for vcard beginning
138
if( line.matches( "^BEGIN:VCARD" ) ) {
147
if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
151
// check for vMsg files
152
else if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VMSG.*" ) ) {
153
showError( getText( R.string.error_vcf_vmsgfile )
143
else if( line.matches( "^END:VCARD" ) )
157
else if( line.matches( "(?i)END[ \t]*:[ \t]*VCARD.*" ) )
144
158
in_vcard = false;
148
163
catch( FileNotFoundException e ) {
170
185
FileInputStream istream = new FileInputStream( file );
171
186
byte[] content = new byte[ (int)file.length() ];
172
187
istream.read( content );
176
191
importVCardFileContent( content, file.getName() );
193
catch( OutOfMemoryError e ) {
194
showError( R.string.error_outofmemory );
178
196
catch( FileNotFoundException e ) {
179
197
showError( getText( R.string.error_filenotfound ) +
180
198
file.getName() );
193
211
ContentLineIterator cli = new ContentLineIterator( content );
194
212
while( cli.hasNext() )
196
ByteBuffer buffer = cli.next();
214
ContentLine content_line = cli.next();
198
// get a US-ASCII version of the line for processing
201
line = new String( buffer.array(), buffer.position(),
202
buffer.limit() - buffer.position(), "US-ASCII" );
204
catch( UnsupportedEncodingException e ) {
205
// we know US-ASCII is supported, so appease the compiler...
216
// get a US-ASCII version of the string, for processing
217
String line = content_line.getUsAsciiLine();
209
219
if( vcard == null ) {
210
220
// look for vcard beginning
211
if( line.matches( "^BEGIN[ \t]*:[ \t]*VCARD" ) ) {
221
if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
212
222
setProgress( _progress++ );
213
223
vcard = new Vcard();
214
224
vcard_start_line = cli.getLineNumber();
226
236
importContact( vcard );
228
238
catch( Vcard.ParseException e ) {
230
240
getText( R.string.error_vcf_parse ).toString()
232
242
getText( R.string.error_vcf_parse_line ).toString()
233
+ cli.getLineNumber() + ":\n" + e.getMessage() ) )
235
finish( ACTION_ABORT );
243
+ cli.getLineNumber() + ":\n" + e.getMessage() );
240
246
catch( ContactData.ContactNotIdentifiableException e ) {
242
248
getText( R.string.error_vcf_parse ).toString()
244
250
getText( R.string.error_vcf_parse_line ).toString()
245
251
+ vcard_start_line + ":\n" + getText(
246
R.string.error_vcf_notenoughinfo ).toString()
249
finish( ACTION_ABORT );
252
R.string.error_vcf_notenoughinfo ).toString() );
255
catch( Vcard.SkipImportException e ) {
255
259
// discard this vcard
260
264
// try giving the line to the vcard
262
vcard.parseLine( buffer, line,
263
cli.doesNextLineLookFolded() );
266
vcard.parseLine( content_line );
265
268
catch( Vcard.ParseException e ) {
268
271
getText( R.string.error_vcf_parse ).toString()
270
273
getText( R.string.error_vcf_parse_line ).toString()
271
+ cli.getLineNumber() + "\n" + e.getMessage() ) )
273
finish( ACTION_ABORT );
274
+ cli.getLineNumber() + "\n" + e.getMessage() );
276
// although we're continuing, we still need to abort
277
// 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
278
278
// get to another BEGIN:VCARD line.
281
281
catch( Vcard.SkipImportException e ) {
283
// abort this vCard. Further lines will be ignored until
283
// Abort this vCard. Further lines will be ignored until
284
284
// we get to another BEGIN:VCARD line.
292
class ContentLineIterator implements Iterator< ByteBuffer >
294
private ByteBuffer _buffer;
295
private boolean _folded_next;
296
private String _line;
298
public ContentLine( ByteBuffer buffer, boolean folded_next )
301
_folded_next = folded_next;
305
public ByteBuffer getBuffer()
310
public boolean doesNextLineLookFolded()
315
public String getUsAsciiLine()
317
// generated line and cache it
318
if( _line == null ) {
320
_line = new String( _buffer.array(), _buffer.position(),
321
_buffer.limit() - _buffer.position(), "US-ASCII" );
323
catch( UnsupportedEncodingException e ) {
324
// we know US-ASCII *is* supported, so appease the
329
// return cached line
334
class ContentLineIterator implements Iterator< ContentLine >
294
336
protected byte[] _content = null;
295
337
protected int _pos = 0;
320
362
_pos > initial_pos )? _pos - 1 : _pos;
323
return ByteBuffer.wrap( _content, initial_pos,
365
return new ContentLine(
366
ByteBuffer.wrap( _content, initial_pos,
368
doesNextLineLookFolded() );
327
371
// we didn't find one, but were there bytes left?
332
return ByteBuffer.wrap( _content, initial_pos,
376
return new ContentLine(
377
ByteBuffer.wrap( _content, initial_pos,
379
doesNextLineLookFolded() );
348
394
* onto the end of this one?
351
public boolean doesNextLineLookFolded()
397
private boolean doesNextLineLookFolded()
353
399
return _pos > 0 && _pos < _content.length &&
354
400
_content[ _pos - 1 ] == '\n' &&
373
419
private final static int MULTILINE_FOLDED = 3; // MIME-DIR folding
375
421
private String _version = null;
376
private Vector< ByteBuffer > _buffers = null;
422
private Vector< ContentLine > _content_lines = null;
377
423
private int _name_level = NAMELEVEL_NONE;
378
424
private int _parser_multiline_state = MULTILINE_NONE;
379
425
private String _parser_current_name_and_params = null;
422
468
@SuppressWarnings("serial")
423
469
protected class SkipImportException extends Exception { }
425
private String extractCollonPartFromLine( ByteBuffer buffer,
426
String line, boolean former )
471
private String extractCollonPartFromLine( ContentLine content_line,
430
// get a US-ASCII version of the line for processing, unless we were
434
line = new String( buffer.array(), buffer.position(),
435
buffer.limit() - buffer.position(), "US-ASCII" );
437
catch( UnsupportedEncodingException e ) {
438
// we know US-ASCII is supported, so appease the compiler...
443
474
// split line into name and value parts and check to make sure we
444
475
// only got 2 parts and that the first part is not zero in length
445
String[] parts = line.split( ":", 2 );
476
String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
446
477
if( parts.length == 2 && parts[ 0 ].length() > 0 )
447
ret = parts[ former? 0 : 1 ];
452
private String extractNameAndParamsFromLine( ByteBuffer buffer,
455
return extractCollonPartFromLine( buffer, line, true );
458
private String extractValueFromLine( ByteBuffer buffer, String line )
460
return extractCollonPartFromLine( buffer, line, false );
463
public void parseLine( ByteBuffer buffer, String line,
464
boolean next_line_looks_folded )
478
return parts[ former? 0 : 1 ].trim();
483
private String extractNameAndParamsFromLine( ContentLine content_line )
485
return extractCollonPartFromLine( content_line, true );
488
private String extractValueFromLine( ContentLine content_line )
490
return extractCollonPartFromLine( content_line, false );
493
public void parseLine( ContentLine content_line )
465
494
throws ParseException, SkipImportException,
466
495
AbortImportException
471
500
// tentatively get name and params from line
472
501
String name_and_params =
473
extractNameAndParamsFromLine( buffer, line );
502
extractNameAndParamsFromLine( content_line );
475
504
// is it a version line?
476
505
if( name_and_params != null &&
477
506
name_and_params.equalsIgnoreCase( "VERSION" ) )
480
String value = extractValueFromLine( buffer, line );
481
if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
509
String value = extractValueFromLine( content_line );
510
if( value == null || (
511
!value.equals( "2.1" ) && !value.equals( "3.0" ) ) )
482
513
throw new ParseException( R.string.error_vcf_version );
483
515
_version = value;
485
517
// parse any buffers we've been accumulating while we waited
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() ) == ' ' );
519
if( _content_lines != null )
520
for( int i = 0; i < _content_lines.size(); i++ )
521
parseLine( _content_lines.get( i ) );
522
_content_lines = null;
498
526
// no, so stash this line till we get a version
499
if( _buffers == null )
500
_buffers = new Vector< ByteBuffer >();
501
_buffers.add( buffer );
527
if( _content_lines == null )
528
_content_lines = new Vector< ContentLine >();
529
_content_lines.add( content_line );
506
534
// name and params and the position in the buffer where the
507
// "value" part of the line start
535
// "value" part of the line starts
508
536
String name_and_params;
517
545
// skip some initial line characters, depending on the type
518
546
// of multi-line we're handling
519
pos = buffer.position();
547
pos = content_line.getBuffer().position();
520
548
switch( _parser_multiline_state )
522
550
case MULTILINE_FOLDED:
525
553
case MULTILINE_ENCODED:
526
while( pos < buffer.limit() && (
527
buffer.get( pos ) == ' ' ||
528
buffer.get( pos ) == '\t' ) )
554
while( pos < content_line.getBuffer().limit() && (
555
content_line.getBuffer().get( pos ) == ' ' ||
556
content_line.getBuffer().get( pos ) == '\t' ) )
572
if( content_line.getUsAsciiLine().trim().length() == 0 )
543
575
// get name and params from line, and since we're not
544
576
// parsing a subsequent line in a multi-line, this should
545
577
// not fail, or it's an error
546
578
name_and_params =
547
extractNameAndParamsFromLine( buffer, line );
579
extractNameAndParamsFromLine( content_line );
548
580
if( name_and_params == null )
549
581
throw new ParseException(
550
582
R.string.error_vcf_malformed );
552
584
// calculate how many chars to skip from beginning of line
553
585
// so we skip the property "name:" part
554
pos = buffer.position() + name_and_params.length() + 1;
586
pos = content_line.getBuffer().position() +
587
name_and_params.length() + 1;
556
589
// reset the saved multi-line state
557
590
_parser_current_name_and_params = name_and_params;
561
594
// get value from buffer, as raw bytes
562
595
ByteBuffer value;
563
value = ByteBuffer.wrap( buffer.array(), pos,
564
buffer.limit() - pos );
596
value = ByteBuffer.wrap( content_line.getBuffer().array(), pos,
597
content_line.getBuffer().limit() - pos );
566
599
// get parameter parts
567
600
String[] name_param_parts = name_and_params.split( ";", -1 );
574
607
"FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
576
609
boolean is_interesting_field =
577
interesting_fields.contains( name_param_parts[ 0 ] );
610
interesting_fields.contains(
611
name_param_parts[ 0 ].toUpperCase( Locale.ENGLISH ) );
579
613
// parse encoding parameter
580
614
String encoding = checkParam( name_param_parts, "ENCODING" );
581
615
if( encoding != null )
582
encoding = encoding.toUpperCase( Locale.US );
616
encoding = encoding.toUpperCase( Locale.ENGLISH );
583
617
if( is_interesting_field && encoding != null &&
584
618
!encoding.equalsIgnoreCase( "8BIT" ) &&
585
619
!encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
591
625
// parse charset parameter
592
626
String charset = checkParam( name_param_parts, "CHARSET" );
593
627
if( charset != null )
594
charset = charset.toUpperCase( Locale.US );
628
charset = charset.toUpperCase( Locale.ENGLISH );
595
629
if( charset != null &&
596
630
!charset.equalsIgnoreCase( "US-ASCII" ) &&
597
631
!charset.equalsIgnoreCase( "ASCII" ) &&
654
688
// if we know we're not in an encoding-based multi-line, check
655
689
// to see if we're in a folded multi-line
656
690
if( _parser_multiline_state == MULTILINE_NONE &&
657
next_line_looks_folded )
691
content_line.doesNextLineLookFolded() )
659
693
_parser_multiline_state = MULTILINE_FOLDED;
690
724
parseLABEL( name_param_parts, complete_value );
691
725
else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
692
726
parseNOTE( name_param_parts, complete_value );
727
else if( name_param_parts[ 0 ].equalsIgnoreCase( "BDAY" ) )
728
parseBDAY( name_param_parts, complete_value );
720
756
String str = parts.get( a );
722
// look for parts that end in an escape character, but ignore
723
// the final part. We've already detected escape chars at the
758
// Look for parts that end in an escape character, but ignore
759
// the final part. We've already detected escape chars at the
724
760
// end of the final part in parseLine() and handled multi-lines
726
762
if( a < parts.size() - 1 &&
816
852
for( int b = 0; b < name_part_parts.length; b++ )
817
853
if( name_part_parts[ b ].length() > 0 )
819
if( value.length() == 0 ) value += " ";
855
if( value.length() > 0 ) value += " ";
820
856
value += name_part_parts[ b ];
996
1032
addNote( unescapeValue( value ) );
1035
private void parseBDAY( String[] params, String value )
1037
setBirthday( value );
999
1040
public void finaliseVcard()
1000
throws ParseException, ContactNotIdentifiableException
1041
throws ParseException, ContactNotIdentifiableException,
1042
SkipImportException, AbortImportException
1002
// missing version (and data is present)
1003
if( _version == null && _buffers != null )
1004
throw new ParseException( R.string.error_vcf_malformed );
1044
// if there was content present, but no version line, then it must
1045
// be a version 2.1 vCard; process that content now
1046
if( _version == null && _content_lines != null ) {
1048
for( int i = 0; i < _content_lines.size(); i++ )
1049
parseLine( _content_lines.get( i ) );
1050
_content_lines = null;
1006
1053
// finalise the parent class
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.
1095
* Amongst the params, return any type values present. For v2.1 vCards,
1096
* those types are just parameters. For v3.0, they are prefixed with
1097
* "TYPE=". There may also be multiple type parameters.
1049
1099
* @param params an array of params to look for types in
1050
1100
* @param valid_types an list of upper-case type values to look for
1051
1101
* @return a set of present type values
1059
1109
String type_params[] = checkParams( params, "TYPE" );
1060
1110
for( int a = 0; a < type_params.length; a++ )
1062
// check for a comma-separated list of types (why? this isn't in
1112
// check for a comma-separated list of types (why? I don't think
1113
// this is in the specs!)
1064
1114
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 ] );
1115
for( int i = 0; i < parts.length; i++ ) {
1116
String ucpart = parts[ i ].toUpperCase( Locale.ENGLISH );
1117
if( valid_types.contains( ucpart ) )
1118
types.add( ucpart );
1072
1122
// get 2.1-style type param
1073
1123
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 ] );
1124
for( int i = 1; i < params.length; i++ ) {
1125
String ucparam = params[ i ].toUpperCase( Locale.ENGLISH );
1126
if( valid_types.contains( ucparam ) )
1127
types.add( ucparam );
1101
1153
else if( ch == '=' && i == in.limit() - 1 )
1103
1155
// we found a '=' at the end of a line signifying a multi-
1104
// line string, so we don't add it.
1156
// line string, so we don't add it
1105
1157
another = true;