4
* Copyright (C) 2009 to 2013 Tim Marston <tim@ed.am>
4
* Copyright (C) 2009 to 2011 Tim Marston <edam@waxworlds.org>
6
6
* This file is part of the Import Contacts program (hereafter referred
7
* to as "this program"). For more information, see
8
* http://ed.am/dev/android/import-contacts
7
* to as "this program"). For more information, see
8
* http://www.waxworlds.org/edam/software/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
38
38
import java.util.HashSet;
39
39
import java.util.Iterator;
40
40
import java.util.List;
41
import java.util.Locale;
42
41
import java.util.NoSuchElementException;
43
42
import java.util.Set;
44
43
import java.util.Vector;
45
44
import java.util.regex.Matcher;
46
45
import java.util.regex.Pattern;
48
import android.annotation.SuppressLint;
49
47
import android.content.SharedPreferences;
48
import android.provider.Contacts;
49
import android.provider.Contacts.PhonesColumns;
51
51
public class VcardImporter extends Importer
133
132
boolean in_vcard = false;
134
133
while( ( line = reader.readLine() ) != null )
138
136
// look for vcard beginning
139
if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
137
if( line.matches( "^BEGIN:VCARD" ) ) {
143
// check for vMsg files
144
else if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VMSG.*" ) ) {
145
showError( getText( R.string.error_vcf_vmsgfile )
149
else if( line.matches( "(?i)END[ \t]*:[ \t]*VCARD.*" ) )
142
else if( line.matches( "^END:VCARD" ) )
150
143
in_vcard = false;
155
147
catch( FileNotFoundException e ) {
177
169
FileInputStream istream = new FileInputStream( file );
178
170
byte[] content = new byte[ (int)file.length() ];
179
171
istream.read( content );
183
175
importVCardFileContent( content, file.getName() );
185
catch( OutOfMemoryError e ) {
186
showError( R.string.error_outofmemory );
188
177
catch( FileNotFoundException e ) {
189
178
showError( getText( R.string.error_filenotfound ) +
190
179
file.getName() );
203
192
ContentLineIterator cli = new ContentLineIterator( content );
204
193
while( cli.hasNext() )
206
ContentLine content_line = cli.next();
195
ByteBuffer buffer = cli.next();
208
// get a US-ASCII version of the string, for processing
209
String line = content_line.getUsAsciiLine();
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...
211
208
if( vcard == null ) {
212
209
// look for vcard beginning
213
if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
210
if( line.matches( "^BEGIN:VCARD" ) ) {
214
211
setProgress( _progress++ );
215
212
vcard = new Vcard();
216
213
vcard_start_line = cli.getLineNumber();
274
272
finish( ACTION_ABORT );
277
// Although we're continuing, we still need to abort
278
// this vCard. Further lines will be ignored until we
275
// although we're continuing, we still need to abort
276
// this vCard. Further lines will be ignored until we
279
277
// get to another BEGIN:VCARD line.
282
280
catch( Vcard.SkipImportException e ) {
284
// Abort this vCard. Further lines will be ignored until
282
// abort this vCard. Further lines will be ignored until
285
283
// we get to another BEGIN:VCARD line.
295
private ByteBuffer _buffer;
296
private boolean _folded_next;
297
private String _line;
299
public ContentLine( ByteBuffer buffer, boolean folded_next )
302
_folded_next = folded_next;
306
public ByteBuffer getBuffer()
311
public boolean doesNextLineLookFolded()
316
public String getUsAsciiLine()
318
// generated line and cache it
319
if( _line == null ) {
321
_line = new String( _buffer.array(), _buffer.position(),
322
_buffer.limit() - _buffer.position(), "US-ASCII" );
324
catch( UnsupportedEncodingException e ) {
325
// we know US-ASCII *is* supported, so appease the
330
// return cached line
335
class ContentLineIterator implements Iterator< ContentLine >
291
class ContentLineIterator implements Iterator< ByteBuffer >
337
293
protected byte[] _content = null;
338
294
protected int _pos = 0;
395
347
* onto the end of this one?
398
private boolean doesNextLineLookFolded()
350
public boolean doesNextLineLookFolded()
400
352
return _pos > 0 && _pos < _content.length &&
401
_content[ _pos - 1 ] == '\n' &&
402
( _content[ _pos ] == ' ' || _content[ _pos ] == '\t' );
353
_content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
405
356
public int getLineNumber()
417
368
private final static int MULTILINE_NONE = 0;
418
369
private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
419
370
private final static int MULTILINE_ESCAPED = 2; // v2.1 \\CRLF
420
private final static int MULTILINE_FOLDED = 3; // MIME-DIR folding
371
private final static int MULTILINE_FOLDED = 3; // v3.0 folding
422
373
private String _version = null;
423
private Vector< ContentLine > _content_lines = null;
374
private Vector< ByteBuffer > _buffers = null;
424
375
private int _name_level = NAMELEVEL_NONE;
425
376
private int _parser_multiline_state = MULTILINE_NONE;
426
377
private String _parser_current_name_and_params = null;
469
420
@SuppressWarnings("serial")
470
421
protected class SkipImportException extends Exception { }
472
private String extractCollonPartFromLine( ContentLine content_line,
423
private String extractCollonPartFromLine( ByteBuffer buffer,
424
String line, boolean former )
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...
475
441
// split line into name and value parts and check to make sure we
476
442
// only got 2 parts and that the first part is not zero in length
477
String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
443
String[] parts = line.split( ":", 2 );
478
444
if( parts.length == 2 && parts[ 0 ].length() > 0 )
479
return parts[ former? 0 : 1 ].trim();
484
private String extractNameAndParamsFromLine( ContentLine content_line )
486
return extractCollonPartFromLine( content_line, true );
489
private String extractValueFromLine( ContentLine content_line )
491
return extractCollonPartFromLine( content_line, false );
494
public void parseLine( ContentLine content_line )
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 )
495
463
throws ParseException, SkipImportException,
496
464
AbortImportException
501
469
// tentatively get name and params from line
502
470
String name_and_params =
503
extractNameAndParamsFromLine( content_line );
471
extractNameAndParamsFromLine( buffer, line );
505
473
// is it a version line?
506
474
if( name_and_params != null &&
507
name_and_params.equalsIgnoreCase( "VERSION" ) )
475
name_and_params.equals( "VERSION" ) )
510
String value = extractValueFromLine( content_line );
511
if( value == null || (
512
!value.equals( "2.1" ) && !value.equals( "3.0" ) ) )
478
String value = extractValueFromLine( buffer, line );
479
if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
514
480
throw new ParseException( R.string.error_vcf_version );
516
481
_version = value;
518
483
// parse any buffers we've been accumulating while we waited
520
if( _content_lines != null )
521
for( int i = 0; i < _content_lines.size(); i++ )
522
parseLine( _content_lines.get( i ) );
523
_content_lines = null;
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
496
// no, so stash this line till we get a version
528
if( _content_lines == null )
529
_content_lines = new Vector< ContentLine >();
530
_content_lines.add( content_line );
497
if( _buffers == null )
498
_buffers = new Vector< ByteBuffer >();
499
_buffers.add( buffer );
535
504
// name and params and the position in the buffer where the
536
// "value" part of the line starts
505
// "value" part of the line start
537
506
String name_and_params;
546
515
// skip some initial line characters, depending on the type
547
516
// of multi-line we're handling
548
pos = content_line.getBuffer().position();
517
pos = buffer.position();
549
518
switch( _parser_multiline_state )
551
520
case MULTILINE_FOLDED:
554
523
case MULTILINE_ENCODED:
555
while( pos < content_line.getBuffer().limit() && (
556
content_line.getBuffer().get( pos ) == ' ' ||
557
content_line.getBuffer().get( pos ) == '\t' ) )
524
while( pos < buffer.limit() && (
525
buffer.get( pos ) == ' ' ||
526
buffer.get( pos ) == '\t' ) )
573
if( content_line.getUsAsciiLine().trim().length() == 0 )
576
541
// get name and params from line, and since we're not
577
542
// parsing a subsequent line in a multi-line, this should
578
543
// not fail, or it's an error
579
544
name_and_params =
580
extractNameAndParamsFromLine( content_line );
545
extractNameAndParamsFromLine( buffer, line );
581
546
if( name_and_params == null )
582
547
throw new ParseException(
583
548
R.string.error_vcf_malformed );
585
550
// calculate how many chars to skip from beginning of line
586
551
// so we skip the property "name:" part
587
pos = content_line.getBuffer().position() +
588
name_and_params.length() + 1;
552
pos = buffer.position() + name_and_params.length() + 1;
590
554
// reset the saved multi-line state
591
555
_parser_current_name_and_params = name_and_params;
595
559
// get value from buffer, as raw bytes
596
560
ByteBuffer value;
597
value = ByteBuffer.wrap( content_line.getBuffer().array(), pos,
598
content_line.getBuffer().limit() - pos );
561
value = ByteBuffer.wrap( buffer.array(), pos,
562
buffer.limit() - pos );
600
564
// get parameter parts
601
565
String[] name_param_parts = name_and_params.split( ";", -1 );
605
569
// determine whether we care about this entry
606
570
final HashSet< String > interesting_fields =
607
new HashSet< String >( Arrays.asList( new String[] { "N",
608
"FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
571
new HashSet< String >( Arrays.asList( new String[]
572
{ "N", "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR" }
610
574
boolean is_interesting_field =
611
interesting_fields.contains(
612
name_param_parts[ 0 ].toUpperCase( Locale.US ) );
575
interesting_fields.contains( name_param_parts[ 0 ] );
614
577
// parse encoding parameter
615
578
String encoding = checkParam( name_param_parts, "ENCODING" );
616
if( encoding != null )
617
encoding = encoding.toUpperCase( Locale.US );
579
if( encoding != null ) encoding = encoding.toUpperCase();
618
580
if( is_interesting_field && encoding != null &&
619
!encoding.equalsIgnoreCase( "8BIT" ) &&
620
!encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
621
//&& !encoding.equalsIgnoreCase( "BASE64" ) )
581
!encoding.equals( "8BIT" ) &&
582
!encoding.equals( "QUOTED-PRINTABLE" ) )
583
//&& !encoding.equals( "BASE64" ) )
623
585
throw new ParseException( R.string.error_vcf_encoding );
626
588
// parse charset parameter
627
589
String charset = checkParam( name_param_parts, "CHARSET" );
628
if( charset != null )
629
charset = charset.toUpperCase( Locale.US );
590
if( charset != null ) charset = charset.toUpperCase();
630
591
if( charset != null &&
631
!charset.equalsIgnoreCase( "US-ASCII" ) &&
632
!charset.equalsIgnoreCase( "ASCII" ) &&
633
!charset.equalsIgnoreCase( "UTF-8" ) )
592
!charset.equals( "US-ASCII" ) &&
593
!charset.equals( "ASCII" ) &&
594
!charset.equals( "UTF-8" ) )
635
596
throw new ParseException( R.string.error_vcf_charset );
638
599
// do unencoding (or default to a fake unencoding result with
639
600
// the raw string)
640
601
UnencodeResult unencoding_result = null;
641
if( encoding != null &&
642
encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
602
if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
644
603
unencoding_result = unencodeQuotedPrintable( value );
646
// else if( encoding != null &&
647
// encoding.equalsIgnoreCase( "BASE64" ) )
604
// else if( encoding != null && encoding.equals( "BASE64" ) )
649
605
// unencoding_result = unencodeBase64( props[ 1 ], charset );
651
606
if( unencoding_result != null ) {
652
607
value = unencoding_result.getBuffer();
653
608
if( unencoding_result.isAnotherLineRequired() )
658
613
// specified for a v2.1 vcard entry, we assume it's US-ASCII)
659
614
if( ( charset == null && _version.equals( "2.1" ) ) ||
660
615
( charset != null && (
661
charset.equalsIgnoreCase( "ASCII" ) ||
662
charset.equalsIgnoreCase( "US-ASCII" ) ) ) )
616
charset.equals( "ASCII" ) ||
617
charset.equals( "US-ASCII" ) ) ) )
664
619
value = transcodeAsciiToUtf8( value );
676
631
// for some entries that have semicolon-separated value parts,
677
632
// check to see if the value ends in an escape character, which
678
633
// indicates that we have a multi-line value
679
if( ( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) ||
680
name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) ||
681
name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) ) &&
634
if( ( name_param_parts[ 0 ].equals( "N" ) ||
635
name_param_parts[ 0 ].equals( "ORG" ) ||
636
name_param_parts[ 0 ].equals( "ADR" ) ) &&
682
637
doesStringEndInAnEscapeChar( string_value ) )
684
639
_parser_multiline_state = MULTILINE_ESCAPED;
686
641
string_value.length() - 1 );
689
// if we know we're not in an encoding-based multi-line, check
690
// to see if we're in a folded multi-line
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
691
646
if( _parser_multiline_state == MULTILINE_NONE &&
692
content_line.doesNextLineLookFolded() )
647
_version.equals( "3.0" ) && next_line_looks_folded )
694
649
_parser_multiline_state = MULTILINE_FOLDED;
707
662
if( complete_value.length() < 1 ) return;
709
664
// parse some properties
710
if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
665
if( name_param_parts[ 0 ].equals( "N" ) )
711
666
parseN( name_param_parts, complete_value );
712
else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
667
else if( name_param_parts[ 0 ].equals( "FN" ) )
713
668
parseFN( name_param_parts, complete_value );
714
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
669
else if( name_param_parts[ 0 ].equals( "ORG" ) )
715
670
parseORG( name_param_parts, complete_value );
716
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
671
else if( name_param_parts[ 0 ].equals( "TITLE" ) )
717
672
parseTITLE( name_param_parts, complete_value );
718
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
673
else if( name_param_parts[ 0 ].equals( "TEL" ) )
719
674
parseTEL( name_param_parts, complete_value );
720
else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
675
else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
721
676
parseEMAIL( name_param_parts, complete_value );
722
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
677
else if( name_param_parts[ 0 ].equals( "ADR" ) )
723
678
parseADR( name_param_parts, complete_value );
724
else if( name_param_parts[ 0 ].equalsIgnoreCase( "LABEL" ) )
725
parseLABEL( name_param_parts, complete_value );
726
else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
727
parseNOTE( name_param_parts, complete_value );
728
else if( name_param_parts[ 0 ].equalsIgnoreCase( "BDAY" ) )
729
parseBDAY( name_param_parts, complete_value );
757
706
String str = parts.get( a );
759
// Look for parts that end in an escape character, but ignore
760
// the final part. We've already detected escape chars at the
708
// look for parts that end in an escape character, but ignore
709
// the final part. We've already detected escape chars at the
761
710
// end of the final part in parseLine() and handled multi-lines
763
712
if( a < parts.size() - 1 &&
935
878
if( types.contains( "FAX" ) )
936
879
if( types.contains( "HOME" ) )
937
type = TYPE_FAX_HOME;
880
type = PhonesColumns.TYPE_FAX_HOME;
939
type = TYPE_FAX_WORK;
882
type = PhonesColumns.TYPE_FAX_WORK;
940
883
else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
884
type = PhonesColumns.TYPE_MOBILE;
942
885
else if( types.contains( "PAGER" ) )
886
type = PhonesColumns.TYPE_PAGER;
944
887
else if( types.contains( "WORK" ) )
888
type = PhonesColumns.TYPE_WORK;
890
type = PhonesColumns.TYPE_HOME;
949
892
// add phone number
950
893
addNumber( value, type, is_preferred );
978
921
for( int a = 0; a < adr_parts.length; a++ )
979
922
if( adr_parts[ a ].length() > 0 )
981
// version 3.0 vCards allow further splitting by comma
982
if( _version.equals( "3.0" ) )
984
// split this part in to it's comma-separated bits and
985
// add them on individual lines
986
String[] adr_part_parts =
987
splitValueByCharacter( adr_parts[ a ], ',' );
988
for( int b = 0; b < adr_part_parts.length; b++ )
989
if( adr_part_parts[ b ].length() > 0 )
991
if( value.length() > 0 ) value += "\n";
992
value += adr_part_parts[ b ];
997
// add this part on an individual line
998
if( value.length() > 0 ) value += "\n";
999
value += adr_parts[ a ];
924
// split this part in to it's comma-separated bits
925
String[] adr_part_parts =
926
splitValueByCharacter( adr_parts[ a ], ',' );
927
for( int b = 0; b < adr_part_parts.length; b++ )
928
if( adr_part_parts[ b ].length() > 0 )
930
if( value.length() > 0 ) value += "\n";
931
value += adr_part_parts[ b ];
1003
935
Set< String > types = extractTypes( params, Arrays.asList(
1004
"PREF", "WORK", "HOME" ) );
1008
if( types.contains( "WORK" ) )
1013
addAddress( unescapeValue( value ), type );
1016
private void parseLABEL( String[] params, String value )
1018
Set< String > types = extractTypes( params, Arrays.asList(
1019
"PREF", "WORK", "HOME" ) );
1023
if( types.contains( "WORK" ) )
1028
addAddress( unescapeValue( value ), type );
1031
private void parseNOTE( String[] params, String value )
1033
addNote( unescapeValue( value ) );
1036
private void parseBDAY( String[] params, String value )
1038
setBirthday( value );
936
"PREF", "WORK", "HOME", "INTERNET" ) );
940
if( types.contains( "WORK" ) )
941
type = Contacts.ContactMethods.TYPE_WORK;
943
type = Contacts.ContactMethods.TYPE_HOME;
945
addAddress( unescapeValue( value ), type );
1041
948
public void finaliseVcard()
1042
949
throws ParseException, ContactNotIdentifiableException
1044
951
// missing version (and data is present)
1045
if( _version == null && _content_lines != null )
952
if( _version == null && _buffers != null )
1046
953
throw new ParseException( R.string.error_vcf_malformed );
1048
955
// finalise the parent class
1075
980
HashSet< String > ret = new HashSet< String >();
1077
982
Pattern p = Pattern.compile(
1078
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1079
Pattern.CASE_INSENSITIVE );
983
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1080
984
for( int i = 0; i < params.length; i++ ) {
1081
985
Matcher m = p.matcher( params[ i ] );
1082
986
if( m.matches() )
1090
* Amongst the params, return any type values present. For v2.1 vCards,
1091
* those types are just parameters. For v3.0, they are prefixed with
1092
* "TYPE=". There may also be multiple type parameters.
1094
* @param params an array of params to look for types in
1095
* @param valid_types an list of upper-case type values to look for
994
* Amongst the params, return any type values present. For v2.1 vCards,
995
* those types are just parameters. For v3.0, they are prefixed with
996
* "TYPE=". There may also be multiple type parameters.
998
* @param a list of type values to look for
1096
999
* @return a set of present type values
1098
1001
private Set< String > extractTypes( String[] params,
1104
1007
String type_params[] = checkParams( params, "TYPE" );
1105
1008
for( int a = 0; a < type_params.length; a++ )
1107
// check for a comma-separated list of types (why? I don't think
1108
// this is in the specs!)
1010
// check for a comma-separated list of types (why? this isn't in
1109
1012
String[] parts = type_params[ a ].split( "," );
1110
for( int i = 0; i < parts.length; i++ ) {
1111
String ucpart = parts[ i ].toUpperCase( Locale.US );
1112
if( valid_types.contains( ucpart ) )
1113
types.add( ucpart );
1013
for( int i = 0; i < parts.length; i++ )
1014
if( valid_types.contains( parts[ i ] ) )
1015
types.add( parts[ i ] );
1117
1018
// get 2.1-style type param
1118
1019
if( _version.equals( "2.1" ) ) {
1119
for( int i = 1; i < params.length; i++ ) {
1120
String ucparam = params[ i ].toUpperCase( Locale.US );
1121
if( valid_types.contains( ucparam ) )
1122
types.add( ucparam );
1020
for( int i = 1; i < params.length; i++ )
1021
if( valid_types.contains( params[ i ] ) )
1022
types.add( params[ i ] );