420
468
@SuppressWarnings("serial")
421
469
protected class SkipImportException extends Exception { }
423
private String extractCollonPartFromLine( ByteBuffer buffer,
424
String line, boolean former )
471
private String extractCollonPartFromLine( ContentLine content_line,
426
474
String ret = null;
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
476
// split line into name and value parts and check to make sure we
442
477
// only got 2 parts and that the first part is not zero in length
443
String[] parts = line.split( ":", 2 );
478
String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
444
479
if( parts.length == 2 && parts[ 0 ].length() > 0 )
445
480
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 )
485
private String extractNameAndParamsFromLine( ContentLine content_line )
487
return extractCollonPartFromLine( content_line, true ).trim();
490
private String extractValueFromLine( ContentLine content_line )
492
return extractCollonPartFromLine( content_line, false );
495
public void parseLine( ContentLine content_line )
463
496
throws ParseException, SkipImportException,
464
497
AbortImportException
469
502
// tentatively get name and params from line
470
503
String name_and_params =
471
extractNameAndParamsFromLine( buffer, line );
504
extractNameAndParamsFromLine( content_line );
473
506
// is it a version line?
474
507
if( name_and_params != null &&
475
name_and_params.equals( "VERSION" ) )
508
name_and_params.equalsIgnoreCase( "VERSION" ) )
478
String value = extractValueFromLine( buffer, line );
511
String value = extractValueFromLine( content_line ).trim();
479
512
if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
480
513
throw new ParseException( R.string.error_vcf_version );
481
514
_version = value;
483
516
// 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() ) == ' ' );
518
if( _content_lines != null )
519
for( int i = 0; i < _content_lines.size(); i++ )
520
parseLine( _content_lines.get( i ) );
521
_content_lines = null;
496
525
// no, so stash this line till we get a version
497
if( _buffers == null )
498
_buffers = new Vector< ByteBuffer >();
499
_buffers.add( buffer );
526
if( _content_lines == null )
527
_content_lines = new Vector< ContentLine >();
528
_content_lines.add( content_line );
504
533
// name and params and the position in the buffer where the
505
// "value" part of the line start
534
// "value" part of the line starts
506
535
String name_and_params;
569
603
// determine whether we care about this entry
570
604
final HashSet< String > interesting_fields =
571
new HashSet< String >( Arrays.asList( new String[]
572
{ "N", "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR" }
605
new HashSet< String >( Arrays.asList( new String[] { "N",
606
"FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
574
608
boolean is_interesting_field =
575
interesting_fields.contains( name_param_parts[ 0 ] );
609
interesting_fields.contains(
610
name_param_parts[ 0 ].toUpperCase( Locale.US ) );
577
612
// parse encoding parameter
578
613
String encoding = checkParam( name_param_parts, "ENCODING" );
579
if( encoding != null ) encoding = encoding.toUpperCase();
614
if( encoding != null )
615
encoding = encoding.toUpperCase( Locale.US );
580
616
if( is_interesting_field && encoding != null &&
581
!encoding.equals( "8BIT" ) &&
582
!encoding.equals( "QUOTED-PRINTABLE" ) )
583
//&& !encoding.equals( "BASE64" ) )
617
!encoding.equalsIgnoreCase( "8BIT" ) &&
618
!encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
619
//&& !encoding.equalsIgnoreCase( "BASE64" ) )
585
621
throw new ParseException( R.string.error_vcf_encoding );
588
624
// parse charset parameter
589
625
String charset = checkParam( name_param_parts, "CHARSET" );
590
if( charset != null ) charset = charset.toUpperCase();
626
if( charset != null )
627
charset = charset.toUpperCase( Locale.US );
591
628
if( charset != null &&
592
!charset.equals( "US-ASCII" ) &&
593
!charset.equals( "ASCII" ) &&
594
!charset.equals( "UTF-8" ) )
629
!charset.equalsIgnoreCase( "US-ASCII" ) &&
630
!charset.equalsIgnoreCase( "ASCII" ) &&
631
!charset.equalsIgnoreCase( "UTF-8" ) )
596
633
throw new ParseException( R.string.error_vcf_charset );
599
636
// do unencoding (or default to a fake unencoding result with
600
637
// the raw string)
601
638
UnencodeResult unencoding_result = null;
602
if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
639
if( encoding != null &&
640
encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
603
642
unencoding_result = unencodeQuotedPrintable( value );
604
// else if( encoding != null && encoding.equals( "BASE64" ) )
644
// else if( encoding != null &&
645
// encoding.equalsIgnoreCase( "BASE64" ) )
605
647
// unencoding_result = unencodeBase64( props[ 1 ], charset );
606
649
if( unencoding_result != null ) {
607
650
value = unencoding_result.getBuffer();
608
651
if( unencoding_result.isAnotherLineRequired() )
609
652
_parser_multiline_state = MULTILINE_ENCODED;
612
// convert 8-bit ASCII charset to US-ASCII
613
if( charset == null || charset.equals( "ASCII" ) ) {
655
// convert 8-bit US-ASCII charset to UTF-8 (where no charset is
656
// specified for a v2.1 vcard entry, we assume it's US-ASCII)
657
if( ( charset == null && _version.equals( "2.1" ) ) ||
658
( charset != null && (
659
charset.equalsIgnoreCase( "ASCII" ) ||
660
charset.equalsIgnoreCase( "US-ASCII" ) ) ) )
614
662
value = transcodeAsciiToUtf8( value );
665
// process charset (value is now in UTF-8)
619
666
String string_value;
621
668
string_value = new String( value.array(), value.position(),
622
value.limit() - value.position(), charset );
669
value.limit() - value.position(), "UTF-8" );
623
670
} catch( UnsupportedEncodingException e ) {
624
671
throw new ParseException( R.string.error_vcf_charset );
658
705
if( complete_value.length() < 1 ) return;
660
707
// parse some properties
661
if( name_param_parts[ 0 ].equals( "N" ) )
708
if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
662
709
parseN( name_param_parts, complete_value );
663
else if( name_param_parts[ 0 ].equals( "FN" ) )
710
else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
664
711
parseFN( name_param_parts, complete_value );
665
else if( name_param_parts[ 0 ].equals( "ORG" ) )
712
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
666
713
parseORG( name_param_parts, complete_value );
667
else if( name_param_parts[ 0 ].equals( "TITLE" ) )
714
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
668
715
parseTITLE( name_param_parts, complete_value );
669
else if( name_param_parts[ 0 ].equals( "TEL" ) )
716
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
670
717
parseTEL( name_param_parts, complete_value );
671
else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
718
else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
672
719
parseEMAIL( name_param_parts, complete_value );
673
else if( name_param_parts[ 0 ].equals( "ADR" ) )
720
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
674
721
parseADR( name_param_parts, complete_value );
722
else if( name_param_parts[ 0 ].equalsIgnoreCase( "LABEL" ) )
723
parseLABEL( name_param_parts, complete_value );
724
else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
725
parseNOTE( name_param_parts, complete_value );
690
741
return ( count & 1 ) == 1;
693
private String[] splitValueBySemicolon( String value )
744
private String[] splitValueByCharacter( String value, char character )
695
// split string in to parts by semicolon
746
// split string in to parts by specified character
696
747
ArrayList< String > parts = new ArrayList< String >(
697
Arrays.asList( value.split( ";" ) ) );
748
Arrays.asList( value.split( "" + character ) ) );
699
750
// go through parts
700
751
for( int a = 0; a < parts.size(); a++ )
702
753
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
755
// Look for parts that end in an escape character, but ignore
756
// the final part. We've already detected escape chars at the
706
757
// end of the final part in parseLine() and handled multi-lines
708
759
if( a < parts.size() - 1 &&
709
760
doesStringEndInAnEscapeChar( str ) )
711
// join the next part to this part and remove the next part
762
// append the escaped character, join the next part to this
763
// part and remove the next part
712
764
parts.set( a, str.substring( 0, str.length() - 1 ) +
713
';' + parts.get( a + 1 ) );
765
character + parts.get( a + 1 ) );
714
766
parts.remove( a + 1 );
716
768
// re-visit this part
727
779
return parts.toArray( ret );
782
private String unescapeValue( String value )
784
StringBuilder ret = new StringBuilder( value.length() );
785
boolean in_escape = false;
786
for( int a = 0; a < value.length(); a++ )
788
int c = value.codePointAt( a );
790
// process a normal character
795
ret.append( Character.toChars( c ) );
799
// process an escape sequence
805
// add tab (invalid/non-standard, but accepted)
816
// add escaped character
817
ret.append( Character.toChars( c ) );
820
// unknown escape sequence, so add it unescaped
821
// (invalid/non-standard, but accepted)
823
ret.append( Character.toChars( c ) );
828
return ret.toString();
730
831
private void parseN( String[] params, String value )
732
833
// already got a better name?
733
834
if( _name_level >= NAMELEVEL_N ) return;
735
836
// get name parts
736
String[] name_parts = splitValueBySemicolon( value );
837
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 ];
841
final int[] part_order = { 3, 1, 2, 0, 4 };
842
for( int a = 0; a < part_order.length; a++ )
843
if( name_parts.length > part_order[ a ] &&
844
name_parts[ part_order[ a ] ].length() > 0 )
846
// split this part in to it's comma-separated bits
847
String[] name_part_parts = splitValueByCharacter(
848
name_parts[ part_order[ a ] ], ',' );
849
for( int b = 0; b < name_part_parts.length; b++ )
850
if( name_part_parts[ b ].length() > 0 )
852
if( value.length() > 0 ) value += " ";
853
value += name_part_parts[ b ];
858
setName( unescapeValue( value ) );
747
859
_name_level = NAMELEVEL_N;
843
957
boolean is_preferred = types.contains( "PREF" );
845
959
if( types.contains( "WORK" ) )
846
type = Contacts.ContactMethods.TYPE_WORK;
848
type = Contacts.ContactMethods.TYPE_HOME;
850
addEmail( value, type, is_preferred );
964
addEmail( unescapeValue( value ), type, is_preferred );
853
967
private void parseADR( String[] params, String value )
855
969
// get address parts
856
String[] adr_parts = splitValueBySemicolon( value );
970
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 );
974
for( int a = 0; a < adr_parts.length; a++ )
975
if( adr_parts[ a ].length() > 0 )
977
// version 3.0 vCards allow further splitting by comma
978
if( _version.equals( "3.0" ) )
980
// split this part in to it's comma-separated bits and
981
// add them on individual lines
982
String[] adr_part_parts =
983
splitValueByCharacter( adr_parts[ a ], ',' );
984
for( int b = 0; b < adr_part_parts.length; b++ )
985
if( adr_part_parts[ b ].length() > 0 )
987
if( value.length() > 0 ) value += "\n";
988
value += adr_part_parts[ b ];
993
// add this part on an individual line
994
if( value.length() > 0 ) value += "\n";
995
value += adr_parts[ a ];
999
Set< String > types = extractTypes( params, Arrays.asList(
1000
"PREF", "WORK", "HOME" ) );
1004
if( types.contains( "WORK" ) )
1009
addAddress( unescapeValue( value ), type );
1012
private void parseLABEL( String[] params, String value )
1014
Set< String > types = extractTypes( params, Arrays.asList(
1015
"PREF", "WORK", "HOME" ) );
1019
if( types.contains( "WORK" ) )
1024
addAddress( unescapeValue( value ), type );
1027
private void parseNOTE( String[] params, String value )
1029
addNote( unescapeValue( value ) );
878
1032
public void finaliseVcard()
879
1033
throws ParseException, ContactNotIdentifiableException
881
1035
// missing version (and data is present)
882
if( _version == null && _buffers != null )
1036
if( _version == null && _content_lines != null )
883
1037
throw new ParseException( R.string.error_vcf_malformed );
885
1039
// finalise the parent class
1044
* Amongst the params, find the value of the first, only, of any with
1045
* the specified name.
1049
* @return a value, or null
889
1051
private String checkParam( String[] params, String name )
1053
String[] res = checkParams( params, name );
1054
return res.length > 0? res[ 0 ] : null;
1058
* Amongst the params, find the values of any with the specified name.
1062
* @return an array of values, or null
1064
private String[] checkParams( String[] params, String name )
1066
HashSet< String > ret = new HashSet< String >();
891
1068
Pattern p = Pattern.compile(
892
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1069
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1070
Pattern.CASE_INSENSITIVE );
893
1071
for( int i = 0; i < params.length; i++ ) {
894
1072
Matcher m = p.matcher( params[ i ] );
895
1073
if( m.matches() )
1074
ret.add( m.group( 2 ) );
1077
return (String[]) ret.toArray( new String[ ret.size() ] );
1081
* Amongst the params, return any type values present. For v2.1 vCards,
1082
* those types are just parameters. For v3.0, they are prefixed with
1083
* "TYPE=". There may also be multiple type parameters.
1085
* @param params an array of params to look for types in
1086
* @param valid_types an list of upper-case type values to look for
1087
* @return a set of present type values
901
1089
private Set< String > extractTypes( String[] params,
902
1090
List< String > valid_types )
904
1092
HashSet< String > types = new HashSet< String >();
906
1094
// 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 ] );
1095
String type_params[] = checkParams( params, "TYPE" );
1096
for( int a = 0; a < type_params.length; a++ )
1098
// check for a comma-separated list of types (why? I don't think
1099
// this is in the specs!)
1100
String[] parts = type_params[ a ].split( "," );
1101
for( int i = 0; i < parts.length; i++ ) {
1102
String ucpart = parts[ i ].toUpperCase( Locale.US );
1103
if( valid_types.contains( ucpart ) )
1104
types.add( ucpart );
915
1108
// get 2.1-style type param
916
1109
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 ] );
1110
for( int i = 1; i < params.length; i++ ) {
1111
String ucparam = params[ i ].toUpperCase( Locale.US );
1112
if( valid_types.contains( ucparam ) )
1113
types.add( ucparam );