4
* Copyright (C) 2009 to 2011 Tim Marston <edam@waxworlds.org>
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
8
* http://www.waxworlds.org/edam/software/android/import-contacts
7
* to as "this program"). For more information, see
8
* http://ed.am/dev/android/import-contacts
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
45
46
import java.util.regex.Pattern;
47
48
import android.content.SharedPreferences;
48
import android.provider.Contacts;
49
import android.provider.Contacts.PhonesColumns;
49
import android.os.Environment;
51
51
public class VcardImporter extends Importer
70
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 );
74
String path = "/sdcard" + prefs.getString( "location", "/" );
75
File file = new File( path );
82
File file = new File( Environment.getExternalStorageDirectory(),
83
prefs.getString( "location", "/" ) );
76
84
if( !file.exists() )
77
85
showError( R.string.error_locationnotfound );
83
91
class VCardFilter implements FilenameFilter {
84
92
public boolean accept( File dir, String name ) {
85
return name.toLowerCase().endsWith( ".vcf" );
93
return name.toLowerCase( Locale.US ).endsWith( ".vcf" );
88
96
files = file.listFiles( new VCardFilter() );
132
140
boolean in_vcard = false;
133
141
while( ( line = reader.readLine() ) != null )
136
145
// look for vcard beginning
137
if( line.matches( "^BEGIN:VCARD" ) ) {
146
if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
150
// check for vMsg files
151
else if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VMSG.*" ) ) {
152
showError( getText( R.string.error_vcf_vmsgfile )
142
else if( line.matches( "^END:VCARD" ) )
156
else if( line.matches( "(?i)END[ \t]*:[ \t]*VCARD.*" ) )
143
157
in_vcard = false;
147
162
catch( FileNotFoundException e ) {
169
184
FileInputStream istream = new FileInputStream( file );
170
185
byte[] content = new byte[ (int)file.length() ];
171
186
istream.read( content );
175
190
importVCardFileContent( content, file.getName() );
192
catch( OutOfMemoryError e ) {
193
showError( R.string.error_outofmemory );
177
195
catch( FileNotFoundException e ) {
178
196
showError( getText( R.string.error_filenotfound ) +
179
197
file.getName() );
192
210
ContentLineIterator cli = new ContentLineIterator( content );
193
211
while( cli.hasNext() )
195
ByteBuffer buffer = cli.next();
213
ContentLine content_line = cli.next();
197
// get a US-ASCII version of the line for processing
200
line = new String( buffer.array(), buffer.position(),
201
buffer.limit() - buffer.position(), "US-ASCII" );
203
catch( UnsupportedEncodingException e ) {
204
// we know US-ASCII is supported, so appease the compiler...
215
// get a US-ASCII version of the string, for processing
216
String line = content_line.getUsAsciiLine();
208
218
if( vcard == null ) {
209
219
// look for vcard beginning
210
if( line.matches( "^BEGIN:VCARD" ) ) {
220
if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
211
221
setProgress( _progress++ );
212
222
vcard = new Vcard();
213
223
vcard_start_line = cli.getLineNumber();
259
269
// try giving the line to the vcard
261
vcard.parseLine( buffer, line,
262
cli.doesNextLineLookFolded() );
271
vcard.parseLine( content_line );
264
273
catch( Vcard.ParseException e ) {
272
281
finish( ACTION_ABORT );
275
// although we're continuing, we still need to abort
276
// 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
277
286
// get to another BEGIN:VCARD line.
280
289
catch( Vcard.SkipImportException e ) {
282
// abort this vCard. Further lines will be ignored until
291
// Abort this vCard. Further lines will be ignored until
283
292
// we get to another BEGIN:VCARD line.
291
class ContentLineIterator implements Iterator< ByteBuffer >
302
private ByteBuffer _buffer;
303
private boolean _folded_next;
304
private String _line;
306
public ContentLine( ByteBuffer buffer, boolean folded_next )
309
_folded_next = folded_next;
313
public ByteBuffer getBuffer()
318
public boolean doesNextLineLookFolded()
323
public String getUsAsciiLine()
325
// generated line and cache it
326
if( _line == null ) {
328
_line = new String( _buffer.array(), _buffer.position(),
329
_buffer.limit() - _buffer.position(), "US-ASCII" );
331
catch( UnsupportedEncodingException e ) {
332
// we know US-ASCII *is* supported, so appease the
337
// return cached line
342
class ContentLineIterator implements Iterator< ContentLine >
293
344
protected byte[] _content = null;
294
345
protected int _pos = 0;
319
370
_pos > initial_pos )? _pos - 1 : _pos;
322
return ByteBuffer.wrap( _content, initial_pos,
373
return new ContentLine(
374
ByteBuffer.wrap( _content, initial_pos,
376
doesNextLineLookFolded() );
326
379
// we didn't find one, but were there bytes left?
331
return ByteBuffer.wrap( _content, initial_pos,
384
return new ContentLine(
385
ByteBuffer.wrap( _content, initial_pos,
387
doesNextLineLookFolded() );
347
402
* onto the end of this one?
350
public boolean doesNextLineLookFolded()
405
private boolean doesNextLineLookFolded()
352
407
return _pos > 0 && _pos < _content.length &&
353
_content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
408
_content[ _pos - 1 ] == '\n' &&
409
( _content[ _pos ] == ' ' || _content[ _pos ] == '\t' );
356
412
public int getLineNumber()
368
424
private final static int MULTILINE_NONE = 0;
369
425
private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
370
426
private final static int MULTILINE_ESCAPED = 2; // v2.1 \\CRLF
371
private final static int MULTILINE_FOLDED = 3; // v3.0 folding
427
private final static int MULTILINE_FOLDED = 3; // MIME-DIR folding
373
429
private String _version = null;
374
private Vector< ByteBuffer > _buffers = null;
430
private Vector< ContentLine > _content_lines = null;
375
431
private int _name_level = NAMELEVEL_NONE;
376
432
private int _parser_multiline_state = MULTILINE_NONE;
377
433
private String _parser_current_name_and_params = null;
420
476
@SuppressWarnings("serial")
421
477
protected class SkipImportException extends Exception { }
423
private String extractCollonPartFromLine( ByteBuffer buffer,
424
String line, boolean former )
479
private String extractCollonPartFromLine( ContentLine content_line,
428
// get a US-ASCII version of the line for processing, unless we were
432
line = new String( buffer.array(), buffer.position(),
433
buffer.limit() - buffer.position(), "US-ASCII" );
435
catch( UnsupportedEncodingException e ) {
436
// we know US-ASCII is supported, so appease the compiler...
441
482
// split line into name and value parts and check to make sure we
442
483
// only got 2 parts and that the first part is not zero in length
443
String[] parts = line.split( ":", 2 );
484
String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
444
485
if( parts.length == 2 && parts[ 0 ].length() > 0 )
445
ret = parts[ former? 0 : 1 ];
450
private String extractNameAndParamsFromLine( ByteBuffer buffer,
453
return extractCollonPartFromLine( buffer, line, true );
456
private String extractValueFromLine( ByteBuffer buffer, String line )
458
return extractCollonPartFromLine( buffer, line, false );
461
public void parseLine( ByteBuffer buffer, String line,
462
boolean next_line_looks_folded )
486
return parts[ former? 0 : 1 ].trim();
491
private String extractNameAndParamsFromLine( ContentLine content_line )
493
return extractCollonPartFromLine( content_line, true );
496
private String extractValueFromLine( ContentLine content_line )
498
return extractCollonPartFromLine( content_line, false );
501
public void parseLine( ContentLine content_line )
463
502
throws ParseException, SkipImportException,
464
503
AbortImportException
469
508
// tentatively get name and params from line
470
509
String name_and_params =
471
extractNameAndParamsFromLine( buffer, line );
510
extractNameAndParamsFromLine( content_line );
473
512
// is it a version line?
474
513
if( name_and_params != null &&
475
name_and_params.equals( "VERSION" ) )
514
name_and_params.equalsIgnoreCase( "VERSION" ) )
478
String value = extractValueFromLine( buffer, line );
479
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" ) ) )
480
521
throw new ParseException( R.string.error_vcf_version );
481
523
_version = value;
483
525
// parse any buffers we've been accumulating while we waited
485
if( _buffers != null )
486
for( int i = 0; i < _buffers.size(); i++ )
487
parseLine( _buffers.get( i ), null,
488
i + 1 < _buffers.size() &&
489
_buffers.get( i + 1 ).hasRemaining() &&
490
_buffers.get( i + 1 ).get(
491
_buffers.get( i + 1 ).position() ) == ' ' );
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;
496
534
// no, so stash this line till we get a version
497
if( _buffers == null )
498
_buffers = new Vector< ByteBuffer >();
499
_buffers.add( buffer );
535
if( _content_lines == null )
536
_content_lines = new Vector< ContentLine >();
537
_content_lines.add( content_line );
504
542
// name and params and the position in the buffer where the
505
// "value" part of the line start
543
// "value" part of the line starts
506
544
String name_and_params;
515
553
// skip some initial line characters, depending on the type
516
554
// of multi-line we're handling
517
pos = buffer.position();
555
pos = content_line.getBuffer().position();
518
556
switch( _parser_multiline_state )
520
558
case MULTILINE_FOLDED:
523
561
case MULTILINE_ENCODED:
524
while( pos < buffer.limit() && (
525
buffer.get( pos ) == ' ' ||
526
buffer.get( pos ) == '\t' ) )
562
while( pos < content_line.getBuffer().limit() && (
563
content_line.getBuffer().get( pos ) == ' ' ||
564
content_line.getBuffer().get( pos ) == '\t' ) )
580
if( content_line.getUsAsciiLine().trim().length() == 0 )
541
583
// get name and params from line, and since we're not
542
584
// parsing a subsequent line in a multi-line, this should
543
585
// not fail, or it's an error
544
586
name_and_params =
545
extractNameAndParamsFromLine( buffer, line );
587
extractNameAndParamsFromLine( content_line );
546
588
if( name_and_params == null )
547
589
throw new ParseException(
548
590
R.string.error_vcf_malformed );
550
592
// calculate how many chars to skip from beginning of line
551
593
// so we skip the property "name:" part
552
pos = buffer.position() + name_and_params.length() + 1;
594
pos = content_line.getBuffer().position() +
595
name_and_params.length() + 1;
554
597
// reset the saved multi-line state
555
598
_parser_current_name_and_params = name_and_params;
559
602
// get value from buffer, as raw bytes
560
603
ByteBuffer value;
561
value = ByteBuffer.wrap( buffer.array(), pos,
562
buffer.limit() - pos );
604
value = ByteBuffer.wrap( content_line.getBuffer().array(), pos,
605
content_line.getBuffer().limit() - pos );
564
607
// get parameter parts
565
608
String[] name_param_parts = name_and_params.split( ";", -1 );
572
615
"FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
574
617
boolean is_interesting_field =
575
interesting_fields.contains( name_param_parts[ 0 ] );
618
interesting_fields.contains(
619
name_param_parts[ 0 ].toUpperCase( Locale.US ) );
577
621
// parse encoding parameter
578
622
String encoding = checkParam( name_param_parts, "ENCODING" );
579
if( encoding != null ) encoding = encoding.toUpperCase();
623
if( encoding != null )
624
encoding = encoding.toUpperCase( Locale.US );
580
625
if( is_interesting_field && encoding != null &&
581
!encoding.equals( "8BIT" ) &&
582
!encoding.equals( "QUOTED-PRINTABLE" ) )
583
//&& !encoding.equals( "BASE64" ) )
626
!encoding.equalsIgnoreCase( "8BIT" ) &&
627
!encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
628
//&& !encoding.equalsIgnoreCase( "BASE64" ) )
585
630
throw new ParseException( R.string.error_vcf_encoding );
588
633
// parse charset parameter
589
634
String charset = checkParam( name_param_parts, "CHARSET" );
590
if( charset != null ) charset = charset.toUpperCase();
635
if( charset != null )
636
charset = charset.toUpperCase( Locale.US );
591
637
if( charset != null &&
592
!charset.equals( "US-ASCII" ) &&
593
!charset.equals( "ASCII" ) &&
594
!charset.equals( "UTF-8" ) )
638
!charset.equalsIgnoreCase( "US-ASCII" ) &&
639
!charset.equalsIgnoreCase( "ASCII" ) &&
640
!charset.equalsIgnoreCase( "UTF-8" ) )
596
642
throw new ParseException( R.string.error_vcf_charset );
599
645
// do unencoding (or default to a fake unencoding result with
600
646
// the raw string)
601
647
UnencodeResult unencoding_result = null;
602
if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
648
if( encoding != null &&
649
encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
603
651
unencoding_result = unencodeQuotedPrintable( value );
604
// else if( encoding != null && encoding.equals( "BASE64" ) )
653
// else if( encoding != null &&
654
// encoding.equalsIgnoreCase( "BASE64" ) )
605
656
// unencoding_result = unencodeBase64( props[ 1 ], charset );
606
658
if( unencoding_result != null ) {
607
659
value = unencoding_result.getBuffer();
608
660
if( unencoding_result.isAnotherLineRequired() )
613
665
// specified for a v2.1 vcard entry, we assume it's US-ASCII)
614
666
if( ( charset == null && _version.equals( "2.1" ) ) ||
615
667
( charset != null && (
616
charset.equals( "ASCII" ) ||
617
charset.equals( "US-ASCII" ) ) ) )
668
charset.equalsIgnoreCase( "ASCII" ) ||
669
charset.equalsIgnoreCase( "US-ASCII" ) ) ) )
619
671
value = transcodeAsciiToUtf8( value );
631
683
// for some entries that have semicolon-separated value parts,
632
684
// check to see if the value ends in an escape character, which
633
685
// indicates that we have a multi-line value
634
if( ( name_param_parts[ 0 ].equals( "N" ) ||
635
name_param_parts[ 0 ].equals( "ORG" ) ||
636
name_param_parts[ 0 ].equals( "ADR" ) ) &&
686
if( ( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) ||
687
name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) ||
688
name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) ) &&
637
689
doesStringEndInAnEscapeChar( string_value ) )
639
691
_parser_multiline_state = MULTILINE_ESCAPED;
641
693
string_value.length() - 1 );
644
// now we know whether we're in an encoding multi-line,
645
// determine if we're in a v3 folded multi-line or not
696
// if we know we're not in an encoding-based multi-line, check
697
// to see if we're in a folded multi-line
646
698
if( _parser_multiline_state == MULTILINE_NONE &&
647
_version.equals( "3.0" ) && next_line_looks_folded )
699
content_line.doesNextLineLookFolded() )
649
701
_parser_multiline_state = MULTILINE_FOLDED;
662
714
if( complete_value.length() < 1 ) return;
664
716
// parse some properties
665
if( name_param_parts[ 0 ].equals( "N" ) )
717
if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
666
718
parseN( name_param_parts, complete_value );
667
else if( name_param_parts[ 0 ].equals( "FN" ) )
719
else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
668
720
parseFN( name_param_parts, complete_value );
669
else if( name_param_parts[ 0 ].equals( "ORG" ) )
721
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
670
722
parseORG( name_param_parts, complete_value );
671
else if( name_param_parts[ 0 ].equals( "TITLE" ) )
723
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
672
724
parseTITLE( name_param_parts, complete_value );
673
else if( name_param_parts[ 0 ].equals( "TEL" ) )
725
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
674
726
parseTEL( name_param_parts, complete_value );
675
else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
727
else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
676
728
parseEMAIL( name_param_parts, complete_value );
677
else if( name_param_parts[ 0 ].equals( "ADR" ) )
729
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
678
730
parseADR( name_param_parts, complete_value );
679
else if( name_param_parts[ 0 ].equals( "LABEL" ) )
731
else if( name_param_parts[ 0 ].equalsIgnoreCase( "LABEL" ) )
680
732
parseLABEL( name_param_parts, complete_value );
733
else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
734
parseNOTE( name_param_parts, complete_value );
735
else if( name_param_parts[ 0 ].equalsIgnoreCase( "BDAY" ) )
736
parseBDAY( name_param_parts, complete_value );
708
764
String str = parts.get( a );
710
// look for parts that end in an escape character, but ignore
711
// 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
712
768
// end of the final part in parseLine() and handled multi-lines
714
770
if( a < parts.size() - 1 &&
798
860
for( int b = 0; b < name_part_parts.length; b++ )
799
861
if( name_part_parts[ b ].length() > 0 )
801
if( value.length() == 0 ) value += " ";
863
if( value.length() > 0 ) value += " ";
802
864
value += name_part_parts[ b ];
880
942
if( types.contains( "FAX" ) )
881
943
if( types.contains( "HOME" ) )
882
type = PhonesColumns.TYPE_FAX_HOME;
944
type = TYPE_FAX_HOME;
884
type = PhonesColumns.TYPE_FAX_WORK;
946
type = TYPE_FAX_WORK;
885
947
else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
886
type = PhonesColumns.TYPE_MOBILE;
887
949
else if( types.contains( "PAGER" ) )
888
type = PhonesColumns.TYPE_PAGER;
889
951
else if( types.contains( "WORK" ) )
890
type = PhonesColumns.TYPE_WORK;
892
type = PhonesColumns.TYPE_HOME;
894
956
// add phone number
895
957
addNumber( value, type, is_preferred );
906
968
boolean is_preferred = types.contains( "PREF" );
908
970
if( types.contains( "WORK" ) )
909
type = Contacts.ContactMethods.TYPE_WORK;
911
type = Contacts.ContactMethods.TYPE_HOME;
913
975
addEmail( unescapeValue( value ), type, is_preferred );
923
985
for( int a = 0; a < adr_parts.length; a++ )
924
986
if( adr_parts[ a ].length() > 0 )
926
// split this part in to it's comma-separated bits
927
String[] adr_part_parts =
928
splitValueByCharacter( adr_parts[ a ], ',' );
929
for( int b = 0; b < adr_part_parts.length; b++ )
930
if( adr_part_parts[ b ].length() > 0 )
932
if( value.length() > 0 ) value += "\n";
933
value += adr_part_parts[ b ];
988
// version 3.0 vCards allow further splitting by comma
989
if( _version.equals( "3.0" ) )
991
// split this part in to it's comma-separated bits and
992
// add them on individual lines
993
String[] adr_part_parts =
994
splitValueByCharacter( adr_parts[ a ], ',' );
995
for( int b = 0; b < adr_part_parts.length; b++ )
996
if( adr_part_parts[ b ].length() > 0 )
998
if( value.length() > 0 ) value += "\n";
999
value += adr_part_parts[ b ];
1004
// add this part on an individual line
1005
if( value.length() > 0 ) value += "\n";
1006
value += adr_parts[ a ];
937
1010
Set< String > types = extractTypes( params, Arrays.asList(
957
1030
if( types.contains( "WORK" ) )
958
type = Contacts.ContactMethods.TYPE_WORK;
960
type = Contacts.ContactMethods.TYPE_HOME;
962
1035
addAddress( unescapeValue( value ), type );
1038
private void parseNOTE( String[] params, String value )
1040
addNote( unescapeValue( value ) );
1043
private void parseBDAY( String[] params, String value )
1045
setBirthday( value );
965
1048
public void finaliseVcard()
966
1049
throws ParseException, ContactNotIdentifiableException
968
1051
// missing version (and data is present)
969
if( _version == null && _buffers != null )
1052
if( _version == null && _content_lines != null )
970
1053
throw new ParseException( R.string.error_vcf_malformed );
972
1055
// finalise the parent class
997
1082
HashSet< String > ret = new HashSet< String >();
999
1084
Pattern p = Pattern.compile(
1000
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1085
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1086
Pattern.CASE_INSENSITIVE );
1001
1087
for( int i = 0; i < params.length; i++ ) {
1002
1088
Matcher m = p.matcher( params[ i ] );
1003
1089
if( m.matches() )
1011
* Amongst the params, return any type values present. For v2.1 vCards,
1012
* those types are just parameters. For v3.0, they are prefixed with
1013
* "TYPE=". There may also be multiple type parameters.
1015
* @param a list of type values to look for
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.
1101
* @param params an array of params to look for types in
1102
* @param valid_types an list of upper-case type values to look for
1016
1103
* @return a set of present type values
1018
1105
private Set< String > extractTypes( String[] params,
1024
1111
String type_params[] = checkParams( params, "TYPE" );
1025
1112
for( int a = 0; a < type_params.length; a++ )
1027
// check for a comma-separated list of types (why? this isn't in
1114
// check for a comma-separated list of types (why? I don't think
1115
// this is in the specs!)
1029
1116
String[] parts = type_params[ a ].split( "," );
1030
for( int i = 0; i < parts.length; i++ )
1031
if( valid_types.contains( parts[ i ] ) )
1032
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 );
1035
1124
// get 2.1-style type param
1036
1125
if( _version.equals( "2.1" ) ) {
1037
for( int i = 1; i < params.length; i++ )
1038
if( valid_types.contains( params[ i ] ) )
1039
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 );
1064
1155
else if( ch == '=' && i == in.limit() - 1 )
1066
1157
// we found a '=' at the end of a line signifying a multi-
1067
// line string, so we don't add it.
1158
// line string, so we don't add it
1068
1159
another = true;