420
469
@SuppressWarnings("serial")
421
470
protected class SkipImportException extends Exception { }
423
private String extractCollonPartFromLine( ByteBuffer buffer,
424
String line, boolean former )
472
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
475
// split line into name and value parts and check to make sure we
442
476
// only got 2 parts and that the first part is not zero in length
443
String[] parts = line.split( ":", 2 );
477
String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
444
478
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 )
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 )
463
495
throws ParseException, SkipImportException,
464
496
AbortImportException
469
501
// tentatively get name and params from line
470
502
String name_and_params =
471
extractNameAndParamsFromLine( buffer, line );
503
extractNameAndParamsFromLine( content_line );
473
505
// is it a version line?
474
506
if( name_and_params != null &&
475
name_and_params.equals( "VERSION" ) )
507
name_and_params.equalsIgnoreCase( "VERSION" ) )
478
String value = extractValueFromLine( buffer, line );
479
if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
510
String value = extractValueFromLine( content_line );
511
if( value == null || (
512
!value.equals( "2.1" ) && !value.equals( "3.0" ) ) )
480
514
throw new ParseException( R.string.error_vcf_version );
481
516
_version = value;
483
518
// 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() ) == ' ' );
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;
496
527
// no, so stash this line till we get a version
497
if( _buffers == null )
498
_buffers = new Vector< ByteBuffer >();
499
_buffers.add( buffer );
528
if( _content_lines == null )
529
_content_lines = new Vector< ContentLine >();
530
_content_lines.add( content_line );
504
535
// name and params and the position in the buffer where the
505
// "value" part of the line start
536
// "value" part of the line starts
506
537
String name_and_params;
569
605
// determine whether we care about this entry
570
606
final HashSet< String > interesting_fields =
571
new HashSet< String >( Arrays.asList( new String[]
572
{ "N", "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR" }
607
new HashSet< String >( Arrays.asList( new String[] { "N",
608
"FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
574
610
boolean is_interesting_field =
575
interesting_fields.contains( name_param_parts[ 0 ] );
611
interesting_fields.contains(
612
name_param_parts[ 0 ].toUpperCase( Locale.US ) );
577
614
// parse encoding parameter
578
615
String encoding = checkParam( name_param_parts, "ENCODING" );
579
if( encoding != null ) encoding = encoding.toUpperCase();
616
if( encoding != null )
617
encoding = encoding.toUpperCase( Locale.US );
580
618
if( is_interesting_field && encoding != null &&
581
!encoding.equals( "8BIT" ) &&
582
!encoding.equals( "QUOTED-PRINTABLE" ) )
583
//&& !encoding.equals( "BASE64" ) )
619
!encoding.equalsIgnoreCase( "8BIT" ) &&
620
!encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
621
//&& !encoding.equalsIgnoreCase( "BASE64" ) )
585
623
throw new ParseException( R.string.error_vcf_encoding );
588
626
// parse charset parameter
589
627
String charset = checkParam( name_param_parts, "CHARSET" );
590
if( charset != null ) charset = charset.toUpperCase();
628
if( charset != null )
629
charset = charset.toUpperCase( Locale.US );
591
630
if( charset != null &&
592
!charset.equals( "US-ASCII" ) &&
593
!charset.equals( "ASCII" ) &&
594
!charset.equals( "UTF-8" ) )
631
!charset.equalsIgnoreCase( "US-ASCII" ) &&
632
!charset.equalsIgnoreCase( "ASCII" ) &&
633
!charset.equalsIgnoreCase( "UTF-8" ) )
596
635
throw new ParseException( R.string.error_vcf_charset );
599
638
// do unencoding (or default to a fake unencoding result with
600
639
// the raw string)
601
640
UnencodeResult unencoding_result = null;
602
if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
641
if( encoding != null &&
642
encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
603
644
unencoding_result = unencodeQuotedPrintable( value );
604
// else if( encoding != null && encoding.equals( "BASE64" ) )
646
// else if( encoding != null &&
647
// encoding.equalsIgnoreCase( "BASE64" ) )
605
649
// unencoding_result = unencodeBase64( props[ 1 ], charset );
606
651
if( unencoding_result != null ) {
607
652
value = unencoding_result.getBuffer();
608
653
if( unencoding_result.isAnotherLineRequired() )
609
654
_parser_multiline_state = MULTILINE_ENCODED;
612
// convert 8-bit ASCII charset to US-ASCII
613
if( charset == null || charset.equals( "ASCII" ) ) {
657
// convert 8-bit US-ASCII charset to UTF-8 (where no charset is
658
// specified for a v2.1 vcard entry, we assume it's US-ASCII)
659
if( ( charset == null && _version.equals( "2.1" ) ) ||
660
( charset != null && (
661
charset.equalsIgnoreCase( "ASCII" ) ||
662
charset.equalsIgnoreCase( "US-ASCII" ) ) ) )
614
664
value = transcodeAsciiToUtf8( value );
667
// process charset (value is now in UTF-8)
619
668
String string_value;
621
670
string_value = new String( value.array(), value.position(),
622
value.limit() - value.position(), charset );
671
value.limit() - value.position(), "UTF-8" );
623
672
} catch( UnsupportedEncodingException e ) {
624
673
throw new ParseException( R.string.error_vcf_charset );
658
707
if( complete_value.length() < 1 ) return;
660
709
// parse some properties
661
if( name_param_parts[ 0 ].equals( "N" ) )
710
if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
662
711
parseN( name_param_parts, complete_value );
663
else if( name_param_parts[ 0 ].equals( "FN" ) )
712
else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
664
713
parseFN( name_param_parts, complete_value );
665
else if( name_param_parts[ 0 ].equals( "ORG" ) )
714
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
666
715
parseORG( name_param_parts, complete_value );
667
else if( name_param_parts[ 0 ].equals( "TITLE" ) )
716
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
668
717
parseTITLE( name_param_parts, complete_value );
669
else if( name_param_parts[ 0 ].equals( "TEL" ) )
718
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
670
719
parseTEL( name_param_parts, complete_value );
671
else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
720
else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
672
721
parseEMAIL( name_param_parts, complete_value );
673
else if( name_param_parts[ 0 ].equals( "ADR" ) )
722
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
674
723
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 );
690
745
return ( count & 1 ) == 1;
693
private String[] splitValueBySemicolon( String value )
748
private String[] splitValueByCharacter( String value, char character )
695
// split string in to parts by semicolon
750
// split string in to parts by specified character
696
751
ArrayList< String > parts = new ArrayList< String >(
697
Arrays.asList( value.split( ";" ) ) );
752
Arrays.asList( value.split( "" + character ) ) );
699
754
// go through parts
700
755
for( int a = 0; a < parts.size(); a++ )
702
757
String str = parts.get( a );
704
// look for parts that end in an escape character, but ignore
705
// the final part. We've already detected escape chars at the
759
// Look for parts that end in an escape character, but ignore
760
// the final part. We've already detected escape chars at the
706
761
// end of the final part in parseLine() and handled multi-lines
708
763
if( a < parts.size() - 1 &&
709
764
doesStringEndInAnEscapeChar( str ) )
711
// join the next part to this part and remove the next part
766
// append the escaped character, join the next part to this
767
// part and remove the next part
712
768
parts.set( a, str.substring( 0, str.length() - 1 ) +
713
';' + parts.get( a + 1 ) );
769
character + parts.get( a + 1 ) );
714
770
parts.remove( a + 1 );
716
772
// re-visit this part
727
783
return parts.toArray( ret );
786
private String unescapeValue( String value )
788
StringBuilder ret = new StringBuilder( value.length() );
789
boolean in_escape = false;
790
for( int a = 0; a < value.length(); a++ )
792
int c = value.codePointAt( a );
794
// process a normal character
799
ret.append( Character.toChars( c ) );
803
// process an escape sequence
809
// add tab (invalid/non-standard, but accepted)
820
// add escaped character
821
ret.append( Character.toChars( c ) );
824
// unknown escape sequence, so add it unescaped
825
// (invalid/non-standard, but accepted)
827
ret.append( Character.toChars( c ) );
832
return ret.toString();
730
835
private void parseN( String[] params, String value )
732
837
// already got a better name?
733
838
if( _name_level >= NAMELEVEL_N ) return;
735
840
// get name parts
736
String[] name_parts = splitValueBySemicolon( value );
841
String[] name_parts = splitValueByCharacter( value, ';' );
740
if( name_parts.length > 1 && name_parts[ 1 ].length() > 0 )
741
value += name_parts[ 1 ];
742
if( name_parts.length > 0 && name_parts[ 0 ].length() > 0 )
743
value += ( value.length() == 0? "" : " " ) + name_parts[ 0 ];
845
final int[] part_order = { 3, 1, 2, 0, 4 };
846
for( int a = 0; a < part_order.length; a++ )
847
if( name_parts.length > part_order[ a ] &&
848
name_parts[ part_order[ a ] ].length() > 0 )
850
// split this part in to it's comma-separated bits
851
String[] name_part_parts = splitValueByCharacter(
852
name_parts[ part_order[ a ] ], ',' );
853
for( int b = 0; b < name_part_parts.length; b++ )
854
if( name_part_parts[ b ].length() > 0 )
856
if( value.length() > 0 ) value += " ";
857
value += name_part_parts[ b ];
862
setName( unescapeValue( value ) );
747
863
_name_level = NAMELEVEL_N;
843
961
boolean is_preferred = types.contains( "PREF" );
845
963
if( types.contains( "WORK" ) )
846
type = Contacts.ContactMethods.TYPE_WORK;
848
type = Contacts.ContactMethods.TYPE_HOME;
850
addEmail( value, type, is_preferred );
968
addEmail( unescapeValue( value ), type, is_preferred );
853
971
private void parseADR( String[] params, String value )
855
973
// get address parts
856
String[] adr_parts = splitValueBySemicolon( value );
974
String[] adr_parts = splitValueByCharacter( value, ';' );
860
for( int a = 0; a < adr_parts.length; a++ ) {
861
if( value.length() > 0 ) value += "\n";
862
value += adr_parts[ a ].trim();
865
Set< String > types = extractTypes( params, Arrays.asList(
866
"PREF", "WORK", "HOME", "INTERNET" ) );
870
if( types.contains( "WORK" ) )
871
type = Contacts.ContactMethods.TYPE_WORK;
873
type = Contacts.ContactMethods.TYPE_HOME;
875
addAddress( value, type );
978
for( int a = 0; a < adr_parts.length; a++ )
979
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 ];
1003
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 );
878
1041
public void finaliseVcard()
879
1042
throws ParseException, ContactNotIdentifiableException
881
1044
// missing version (and data is present)
882
if( _version == null && _buffers != null )
1045
if( _version == null && _content_lines != null )
883
1046
throw new ParseException( R.string.error_vcf_malformed );
885
1048
// finalise the parent class
1053
* Amongst the params, find the value of the first, only, of any with
1054
* the specified name.
1058
* @return a value, or null
889
1060
private String checkParam( String[] params, String name )
1062
String[] res = checkParams( params, name );
1063
return res.length > 0? res[ 0 ] : null;
1067
* Amongst the params, find the values of any with the specified name.
1071
* @return an array of values, or null
1073
private String[] checkParams( String[] params, String name )
1075
HashSet< String > ret = new HashSet< String >();
891
1077
Pattern p = Pattern.compile(
892
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1078
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1079
Pattern.CASE_INSENSITIVE );
893
1080
for( int i = 0; i < params.length; i++ ) {
894
1081
Matcher m = p.matcher( params[ i ] );
895
1082
if( m.matches() )
1083
ret.add( m.group( 2 ) );
1086
return (String[]) ret.toArray( new String[ ret.size() ] );
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
1096
* @return a set of present type values
901
1098
private Set< String > extractTypes( String[] params,
902
1099
List< String > valid_types )
904
1101
HashSet< String > types = new HashSet< String >();
906
1103
// get 3.0-style TYPE= param
908
if( ( type_param = checkParam( params, "TYPE" ) ) != null ) {
909
String[] parts = type_param.split( "," );
910
for( int i = 0; i < parts.length; i++ )
911
if( valid_types.contains( parts[ i ] ) )
912
types.add( parts[ i ] );
1104
String type_params[] = checkParams( params, "TYPE" );
1105
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!)
1109
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 );
915
1117
// get 2.1-style type param
916
1118
if( _version.equals( "2.1" ) ) {
917
for( int i = 1; i < params.length; i++ )
918
if( valid_types.contains( params[ i ] ) )
919
types.add( params[ i ] );
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 );