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,
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
474
// split line into name and value parts and check to make sure we
442
475
// only got 2 parts and that the first part is not zero in length
443
String[] parts = line.split( ":", 2 );
476
String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
444
477
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 )
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 )
463
494
throws ParseException, SkipImportException,
464
495
AbortImportException
469
500
// tentatively get name and params from line
470
501
String name_and_params =
471
extractNameAndParamsFromLine( buffer, line );
502
extractNameAndParamsFromLine( content_line );
473
504
// is it a version line?
474
505
if( name_and_params != null &&
475
name_and_params.equals( "VERSION" ) )
506
name_and_params.equalsIgnoreCase( "VERSION" ) )
478
String value = extractValueFromLine( buffer, line );
479
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" ) ) )
480
513
throw new ParseException( R.string.error_vcf_version );
481
515
_version = value;
483
517
// 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() ) == ' ' );
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;
496
526
// no, so stash this line till we get a version
497
if( _buffers == null )
498
_buffers = new Vector< ByteBuffer >();
499
_buffers.add( buffer );
527
if( _content_lines == null )
528
_content_lines = new Vector< ContentLine >();
529
_content_lines.add( content_line );
504
534
// name and params and the position in the buffer where the
505
// "value" part of the line start
535
// "value" part of the line starts
506
536
String name_and_params;
569
604
// determine whether we care about this entry
570
605
final HashSet< String > interesting_fields =
571
new HashSet< String >( Arrays.asList( new String[]
572
{ "N", "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR" }
606
new HashSet< String >( Arrays.asList( new String[] { "N",
607
"FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
574
609
boolean is_interesting_field =
575
interesting_fields.contains( name_param_parts[ 0 ] );
610
interesting_fields.contains(
611
name_param_parts[ 0 ].toUpperCase( Locale.US ) );
577
613
// parse encoding parameter
578
614
String encoding = checkParam( name_param_parts, "ENCODING" );
579
if( encoding != null ) encoding = encoding.toUpperCase();
615
if( encoding != null )
616
encoding = encoding.toUpperCase( Locale.US );
580
617
if( is_interesting_field && encoding != null &&
581
!encoding.equals( "8BIT" ) &&
582
!encoding.equals( "QUOTED-PRINTABLE" ) )
583
//&& !encoding.equals( "BASE64" ) )
618
!encoding.equalsIgnoreCase( "8BIT" ) &&
619
!encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
620
//&& !encoding.equalsIgnoreCase( "BASE64" ) )
585
622
throw new ParseException( R.string.error_vcf_encoding );
588
625
// parse charset parameter
589
626
String charset = checkParam( name_param_parts, "CHARSET" );
590
if( charset != null ) charset = charset.toUpperCase();
627
if( charset != null )
628
charset = charset.toUpperCase( Locale.US );
591
629
if( charset != null &&
592
!charset.equals( "US-ASCII" ) &&
593
!charset.equals( "ASCII" ) &&
594
!charset.equals( "UTF-8" ) )
630
!charset.equalsIgnoreCase( "US-ASCII" ) &&
631
!charset.equalsIgnoreCase( "ASCII" ) &&
632
!charset.equalsIgnoreCase( "UTF-8" ) )
596
634
throw new ParseException( R.string.error_vcf_charset );
599
637
// do unencoding (or default to a fake unencoding result with
600
638
// the raw string)
601
639
UnencodeResult unencoding_result = null;
602
if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
640
if( encoding != null &&
641
encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
603
643
unencoding_result = unencodeQuotedPrintable( value );
604
// else if( encoding != null && encoding.equals( "BASE64" ) )
645
// else if( encoding != null &&
646
// encoding.equalsIgnoreCase( "BASE64" ) )
605
648
// unencoding_result = unencodeBase64( props[ 1 ], charset );
606
650
if( unencoding_result != null ) {
607
651
value = unencoding_result.getBuffer();
608
652
if( unencoding_result.isAnotherLineRequired() )
609
653
_parser_multiline_state = MULTILINE_ENCODED;
612
// convert 8-bit ASCII charset to US-ASCII
613
if( charset == null || charset.equals( "ASCII" ) ) {
656
// convert 8-bit US-ASCII charset to UTF-8 (where no charset is
657
// specified for a v2.1 vcard entry, we assume it's US-ASCII)
658
if( ( charset == null && _version.equals( "2.1" ) ) ||
659
( charset != null && (
660
charset.equalsIgnoreCase( "ASCII" ) ||
661
charset.equalsIgnoreCase( "US-ASCII" ) ) ) )
614
663
value = transcodeAsciiToUtf8( value );
666
// process charset (value is now in UTF-8)
619
667
String string_value;
621
669
string_value = new String( value.array(), value.position(),
622
value.limit() - value.position(), charset );
670
value.limit() - value.position(), "UTF-8" );
623
671
} catch( UnsupportedEncodingException e ) {
624
672
throw new ParseException( R.string.error_vcf_charset );
658
706
if( complete_value.length() < 1 ) return;
660
708
// parse some properties
661
if( name_param_parts[ 0 ].equals( "N" ) )
709
if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
662
710
parseN( name_param_parts, complete_value );
663
else if( name_param_parts[ 0 ].equals( "FN" ) )
711
else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
664
712
parseFN( name_param_parts, complete_value );
665
else if( name_param_parts[ 0 ].equals( "ORG" ) )
713
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
666
714
parseORG( name_param_parts, complete_value );
667
else if( name_param_parts[ 0 ].equals( "TITLE" ) )
715
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
668
716
parseTITLE( name_param_parts, complete_value );
669
else if( name_param_parts[ 0 ].equals( "TEL" ) )
717
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
670
718
parseTEL( name_param_parts, complete_value );
671
else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
719
else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
672
720
parseEMAIL( name_param_parts, complete_value );
673
else if( name_param_parts[ 0 ].equals( "ADR" ) )
721
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
674
722
parseADR( name_param_parts, complete_value );
723
else if( name_param_parts[ 0 ].equalsIgnoreCase( "LABEL" ) )
724
parseLABEL( name_param_parts, complete_value );
725
else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
726
parseNOTE( name_param_parts, complete_value );
727
else if( name_param_parts[ 0 ].equalsIgnoreCase( "BDAY" ) )
728
parseBDAY( name_param_parts, complete_value );
690
744
return ( count & 1 ) == 1;
693
private String[] splitValueBySemicolon( String value )
747
private String[] splitValueByCharacter( String value, char character )
695
// split string in to parts by semicolon
749
// split string in to parts by specified character
696
750
ArrayList< String > parts = new ArrayList< String >(
697
Arrays.asList( value.split( ";" ) ) );
751
Arrays.asList( value.split( "" + character ) ) );
699
753
// go through parts
700
754
for( int a = 0; a < parts.size(); a++ )
702
756
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
758
// Look for parts that end in an escape character, but ignore
759
// the final part. We've already detected escape chars at the
706
760
// end of the final part in parseLine() and handled multi-lines
708
762
if( a < parts.size() - 1 &&
709
763
doesStringEndInAnEscapeChar( str ) )
711
// join the next part to this part and remove the next part
765
// append the escaped character, join the next part to this
766
// part and remove the next part
712
767
parts.set( a, str.substring( 0, str.length() - 1 ) +
713
';' + parts.get( a + 1 ) );
768
character + parts.get( a + 1 ) );
714
769
parts.remove( a + 1 );
716
771
// re-visit this part
727
782
return parts.toArray( ret );
785
private String unescapeValue( String value )
787
StringBuilder ret = new StringBuilder( value.length() );
788
boolean in_escape = false;
789
for( int a = 0; a < value.length(); a++ )
791
int c = value.codePointAt( a );
793
// process a normal character
798
ret.append( Character.toChars( c ) );
802
// process an escape sequence
808
// add tab (invalid/non-standard, but accepted)
819
// add escaped character
820
ret.append( Character.toChars( c ) );
823
// unknown escape sequence, so add it unescaped
824
// (invalid/non-standard, but accepted)
826
ret.append( Character.toChars( c ) );
831
return ret.toString();
730
834
private void parseN( String[] params, String value )
732
836
// already got a better name?
733
837
if( _name_level >= NAMELEVEL_N ) return;
735
839
// get name parts
736
String[] name_parts = splitValueBySemicolon( value );
840
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 ];
844
final int[] part_order = { 3, 1, 2, 0, 4 };
845
for( int a = 0; a < part_order.length; a++ )
846
if( name_parts.length > part_order[ a ] &&
847
name_parts[ part_order[ a ] ].length() > 0 )
849
// split this part in to it's comma-separated bits
850
String[] name_part_parts = splitValueByCharacter(
851
name_parts[ part_order[ a ] ], ',' );
852
for( int b = 0; b < name_part_parts.length; b++ )
853
if( name_part_parts[ b ].length() > 0 )
855
if( value.length() > 0 ) value += " ";
856
value += name_part_parts[ b ];
861
setName( unescapeValue( value ) );
747
862
_name_level = NAMELEVEL_N;
843
960
boolean is_preferred = types.contains( "PREF" );
845
962
if( types.contains( "WORK" ) )
846
type = Contacts.ContactMethods.TYPE_WORK;
848
type = Contacts.ContactMethods.TYPE_HOME;
850
addEmail( value, type, is_preferred );
967
addEmail( unescapeValue( value ), type, is_preferred );
853
970
private void parseADR( String[] params, String value )
855
972
// get address parts
856
String[] adr_parts = splitValueBySemicolon( value );
973
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 );
977
for( int a = 0; a < adr_parts.length; a++ )
978
if( adr_parts[ a ].length() > 0 )
980
// version 3.0 vCards allow further splitting by comma
981
if( _version.equals( "3.0" ) )
983
// split this part in to it's comma-separated bits and
984
// add them on individual lines
985
String[] adr_part_parts =
986
splitValueByCharacter( adr_parts[ a ], ',' );
987
for( int b = 0; b < adr_part_parts.length; b++ )
988
if( adr_part_parts[ b ].length() > 0 )
990
if( value.length() > 0 ) value += "\n";
991
value += adr_part_parts[ b ];
996
// add this part on an individual line
997
if( value.length() > 0 ) value += "\n";
998
value += adr_parts[ a ];
1002
Set< String > types = extractTypes( params, Arrays.asList(
1003
"PREF", "WORK", "HOME" ) );
1007
if( types.contains( "WORK" ) )
1012
addAddress( unescapeValue( value ), type );
1015
private void parseLABEL( String[] params, String value )
1017
Set< String > types = extractTypes( params, Arrays.asList(
1018
"PREF", "WORK", "HOME" ) );
1022
if( types.contains( "WORK" ) )
1027
addAddress( unescapeValue( value ), type );
1030
private void parseNOTE( String[] params, String value )
1032
addNote( unescapeValue( value ) );
1035
private void parseBDAY( String[] params, String value )
1037
setBirthday( value );
878
1040
public void finaliseVcard()
879
1041
throws ParseException, ContactNotIdentifiableException
881
1043
// missing version (and data is present)
882
if( _version == null && _buffers != null )
1044
if( _version == null && _content_lines != null )
883
1045
throw new ParseException( R.string.error_vcf_malformed );
885
1047
// finalise the parent class
1052
* Amongst the params, find the value of the first, only, of any with
1053
* the specified name.
1057
* @return a value, or null
889
1059
private String checkParam( String[] params, String name )
1061
String[] res = checkParams( params, name );
1062
return res.length > 0? res[ 0 ] : null;
1066
* Amongst the params, find the values of any with the specified name.
1070
* @return an array of values, or null
1072
private String[] checkParams( String[] params, String name )
1074
HashSet< String > ret = new HashSet< String >();
891
1076
Pattern p = Pattern.compile(
892
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1077
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1078
Pattern.CASE_INSENSITIVE );
893
1079
for( int i = 0; i < params.length; i++ ) {
894
1080
Matcher m = p.matcher( params[ i ] );
895
1081
if( m.matches() )
1082
ret.add( m.group( 2 ) );
1085
return (String[]) ret.toArray( new String[ ret.size() ] );
1089
* Amongst the params, return any type values present. For v2.1 vCards,
1090
* those types are just parameters. For v3.0, they are prefixed with
1091
* "TYPE=". There may also be multiple type parameters.
1093
* @param params an array of params to look for types in
1094
* @param valid_types an list of upper-case type values to look for
1095
* @return a set of present type values
901
1097
private Set< String > extractTypes( String[] params,
902
1098
List< String > valid_types )
904
1100
HashSet< String > types = new HashSet< String >();
906
1102
// 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 ] );
1103
String type_params[] = checkParams( params, "TYPE" );
1104
for( int a = 0; a < type_params.length; a++ )
1106
// check for a comma-separated list of types (why? I don't think
1107
// this is in the specs!)
1108
String[] parts = type_params[ a ].split( "," );
1109
for( int i = 0; i < parts.length; i++ ) {
1110
String ucpart = parts[ i ].toUpperCase( Locale.US );
1111
if( valid_types.contains( ucpart ) )
1112
types.add( ucpart );
915
1116
// get 2.1-style type param
916
1117
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 ] );
1118
for( int i = 1; i < params.length; i++ ) {
1119
String ucparam = params[ i ].toUpperCase( Locale.US );
1120
if( valid_types.contains( ucparam ) )
1121
types.add( ucparam );