206
185
throws AbortImportException
208
187
// go through lines
210
int vcard_start_line = 0;
211
189
ContentLineIterator cli = new ContentLineIterator( content );
212
190
while( cli.hasNext() )
214
ContentLine content_line = cli.next();
192
ByteBuffer buffer = cli.next();
216
// get a US-ASCII version of the string, for processing
217
String line = content_line.getUsAsciiLine();
194
// get a US-ASCII version of the line for processing
197
line = new String( buffer.array(), buffer.position(),
198
buffer.limit() - buffer.position(), "US-ASCII" );
200
catch( UnsupportedEncodingException e ) {
201
// we know US-ASCII is supported, so appease the compiler...
219
205
if( vcard == null ) {
220
206
// look for vcard beginning
221
if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
222
setProgress( _progress++ );
224
vcard_start_line = cli.getLineNumber();
207
if( line.matches( "^BEGIN:VCARD" ) ) {
208
setProgress( ++_progress );
228
213
// look for vcard content or ending
229
if( line.matches( "(?i)END[ \t]*:[ \t]*VCARD.*" ) )
214
if( line.matches( "^END:VCARD" ) )
231
// finalise the vcard/contact
216
// store vcard and do away with it
233
vcard.finaliseVcard();
235
// pass the finalised contact to the importer
218
vcard.finaliseParsing();
236
219
importContact( vcard );
238
catch( Vcard.ParseException e ) {
240
getText( R.string.error_vcf_parse ).toString()
242
getText( R.string.error_vcf_parse_line ).toString()
243
+ cli.getLineNumber() + ":\n" + e.getMessage() );
246
catch( ContactData.ContactNotIdentifiableException e ) {
248
getText( R.string.error_vcf_parse ).toString()
250
getText( R.string.error_vcf_parse_line ).toString()
251
+ vcard_start_line + ":\n" + getText(
252
R.string.error_vcf_notenoughinfo ).toString() );
256
// discard this vcard
221
catch( VCard.ParseException e ) {
224
getText( R.string.error_vcf_parse ).toString()
225
+ fileName + "\n" + e.getMessage() ) )
227
finish( ACTION_ABORT );
230
catch( VCard.SkipContactException e ) {
261
238
// try giving the line to the vcard
263
vcard.parseLine( content_line );
240
vcard.parseLine( buffer, line,
241
cli.doesNextLineLookFolded() );
265
catch( Vcard.ParseException e ) {
243
catch( VCard.ParseException e ) {
268
246
getText( R.string.error_vcf_parse ).toString()
270
getText( R.string.error_vcf_parse_line ).toString()
271
+ cli.getLineNumber() + "\n" + e.getMessage() );
247
+ fileName + "\n" + e.getMessage() ) )
249
finish( ACTION_ABORT );
273
// Although we're continuing, we still need to abort
274
// this vCard. Further lines will be ignored until we
252
// although we're continuing, we still need to abort
253
// this vCard. Further lines will be ignored until we
275
254
// get to another BEGIN:VCARD line.
278
catch( Vcard.SkipImportException e ) {
257
catch( VCard.SkipContactException e ) {
280
// Abort this vCard. Further lines will be ignored until
259
// abort this vCard. Further lines will be ignored until
281
260
// we get to another BEGIN:VCARD line.
391
321
* onto the end of this one?
394
private boolean doesNextLineLookFolded()
324
public boolean doesNextLineLookFolded()
396
326
return _pos > 0 && _pos < _content.length &&
397
_content[ _pos - 1 ] == '\n' &&
398
( _content[ _pos ] == ' ' || _content[ _pos ] == '\t' );
401
public int getLineNumber()
327
_content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
407
private class Vcard extends ContactData
331
private class VCard extends ContactData
409
333
private final static int NAMELEVEL_NONE = 0;
410
private final static int NAMELEVEL_N = 1;
411
private final static int NAMELEVEL_FN = 2;
334
private final static int NAMELEVEL_FN = 1;
335
private final static int NAMELEVEL_N = 2;
413
337
private final static int MULTILINE_NONE = 0;
414
338
private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
415
339
private final static int MULTILINE_ESCAPED = 2; // v2.1 \\CRLF
416
private final static int MULTILINE_FOLDED = 3; // MIME-DIR folding
340
private final static int MULTILINE_FOLDED = 3; // v3.0 folding
418
342
private String _version = null;
419
private Vector< ContentLine > _content_lines = null;
343
private Vector< ByteBuffer > _buffers = null;
420
344
private int _name_level = NAMELEVEL_NONE;
421
345
private int _parser_multiline_state = MULTILINE_NONE;
422
346
private String _parser_current_name_and_params = null;
459
383
public ParseException( int res )
461
super( VcardImporter.this.getText( res ).toString() );
385
super( VCFImporter.this.getText( res ).toString() );
465
389
@SuppressWarnings("serial")
466
protected class SkipImportException extends Exception { }
390
protected class SkipContactException extends Exception { }
468
private String extractCollonPartFromLine( ContentLine content_line,
392
private String extractCollonPartFromLine( ByteBuffer buffer,
393
String line, boolean former )
397
// get a US-ASCII version of the line for processing, unless we were
401
line = new String( buffer.array(), buffer.position(),
402
buffer.limit() - buffer.position(), "US-ASCII" );
404
catch( UnsupportedEncodingException e ) {
405
// we know US-ASCII is supported, so appease the compiler...
471
410
// split line into name and value parts and check to make sure we
472
411
// only got 2 parts and that the first part is not zero in length
473
String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
412
String[] parts = line.split( ":", 2 );
474
413
if( parts.length == 2 && parts[ 0 ].length() > 0 )
475
return parts[ former? 0 : 1 ].trim();
480
private String extractNameAndParamsFromLine( ContentLine content_line )
482
return extractCollonPartFromLine( content_line, true );
485
private String extractValueFromLine( ContentLine content_line )
487
return extractCollonPartFromLine( content_line, false );
490
public void parseLine( ContentLine content_line )
491
throws ParseException, SkipImportException,
414
ret = parts[ former? 0 : 1 ];
419
private String extractNameAndParamsFromLine( ByteBuffer buffer,
422
return extractCollonPartFromLine( buffer, line, true );
425
private String extractValueFromLine( ByteBuffer buffer, String line )
427
return extractCollonPartFromLine( buffer, line, false );
430
public void parseLine( ByteBuffer buffer, String line,
431
boolean next_line_looks_folded )
432
throws ParseException, SkipContactException,
492
433
AbortImportException
494
435
// do we have a version yet?
497
438
// tentatively get name and params from line
498
439
String name_and_params =
499
extractNameAndParamsFromLine( content_line );
440
extractNameAndParamsFromLine( buffer, line );
501
442
// is it a version line?
502
443
if( name_and_params != null &&
503
name_and_params.equalsIgnoreCase( "VERSION" ) )
444
name_and_params.equals( "VERSION" ) )
506
String value = extractValueFromLine( content_line );
507
if( value == null || (
508
!value.equals( "2.1" ) && !value.equals( "3.0" ) ) )
447
String value = extractValueFromLine( buffer, line );
448
if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
510
449
throw new ParseException( R.string.error_vcf_version );
512
450
_version = value;
514
452
// parse any buffers we've been accumulating while we waited
516
if( _content_lines != null )
517
for( int i = 0; i < _content_lines.size(); i++ )
518
parseLine( _content_lines.get( i ) );
519
_content_lines = null;
454
if( _buffers != null )
455
for( int i = 0; i < _buffers.size(); i++ )
456
parseLine( _buffers.get( i ), null,
457
i + 1 < _buffers.size() &&
458
_buffers.get( i + 1 ).hasRemaining() &&
459
_buffers.get( i + 1 ).get(
460
_buffers.get( i + 1 ).position() ) == ' ' );
523
465
// no, so stash this line till we get a version
524
if( _content_lines == null )
525
_content_lines = new Vector< ContentLine >();
526
_content_lines.add( content_line );
466
if( _buffers == null )
467
_buffers = new Vector< ByteBuffer >();
468
_buffers.add( buffer );
531
473
// name and params and the position in the buffer where the
532
// "value" part of the line starts
474
// "value" part of the line start
533
475
String name_and_params;
591
528
// get value from buffer, as raw bytes
592
529
ByteBuffer value;
593
value = ByteBuffer.wrap( content_line.getBuffer().array(), pos,
594
content_line.getBuffer().limit() - pos );
530
value = ByteBuffer.wrap( buffer.array(), pos,
531
buffer.limit() - pos );
596
533
// get parameter parts
597
534
String[] name_param_parts = name_and_params.split( ";", -1 );
598
535
for( int i = 0; i < name_param_parts.length; i++ )
599
536
name_param_parts[ i ] = name_param_parts[ i ].trim();
601
// determine whether we care about this entry
602
final HashSet< String > interesting_fields =
603
new HashSet< String >( Arrays.asList( new String[] { "N",
604
"FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
606
boolean is_interesting_field =
607
interesting_fields.contains(
608
name_param_parts[ 0 ].toUpperCase( Locale.ENGLISH ) );
610
538
// parse encoding parameter
611
539
String encoding = checkParam( name_param_parts, "ENCODING" );
612
if( encoding != null )
613
encoding = encoding.toUpperCase( Locale.ENGLISH );
614
if( is_interesting_field && encoding != null &&
615
!encoding.equalsIgnoreCase( "8BIT" ) &&
616
!encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
617
//&& !encoding.equalsIgnoreCase( "BASE64" ) )
540
if( encoding != null ) encoding = encoding.toUpperCase();
541
if( encoding != null && !encoding.equals( "8BIT" ) &&
542
!encoding.equals( "QUOTED-PRINTABLE" ) )
543
//&& !encoding.equals( "BASE64" ) )
619
545
throw new ParseException( R.string.error_vcf_encoding );
622
548
// parse charset parameter
623
549
String charset = checkParam( name_param_parts, "CHARSET" );
624
if( charset != null )
625
charset = charset.toUpperCase( Locale.ENGLISH );
626
if( charset != null &&
627
!charset.equalsIgnoreCase( "US-ASCII" ) &&
628
!charset.equalsIgnoreCase( "ASCII" ) &&
629
!charset.equalsIgnoreCase( "UTF-8" ) )
550
if( charset != null ) charset = charset.toUpperCase();
551
if( charset != null && !charset.equals( "US-ASCII" ) &&
552
!charset.equals( "ASCII" ) &&
553
!charset.equals( "UTF-8" ) )
631
555
throw new ParseException( R.string.error_vcf_charset );
634
558
// do unencoding (or default to a fake unencoding result with
635
559
// the raw string)
636
560
UnencodeResult unencoding_result = null;
637
if( encoding != null &&
638
encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
561
if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
640
562
unencoding_result = unencodeQuotedPrintable( value );
642
// else if( encoding != null &&
643
// encoding.equalsIgnoreCase( "BASE64" ) )
563
// else if( encoding != null && encoding.equals( "BASE64" ) )
645
564
// unencoding_result = unencodeBase64( props[ 1 ], charset );
647
565
if( unencoding_result != null ) {
648
566
value = unencoding_result.getBuffer();
649
567
if( unencoding_result.isAnotherLineRequired() )
650
568
_parser_multiline_state = MULTILINE_ENCODED;
653
// convert 8-bit US-ASCII charset to UTF-8 (where no charset is
654
// specified for a v2.1 vcard entry, we assume it's US-ASCII)
655
if( ( charset == null && _version.equals( "2.1" ) ) ||
656
( charset != null && (
657
charset.equalsIgnoreCase( "ASCII" ) ||
658
charset.equalsIgnoreCase( "US-ASCII" ) ) ) )
571
// convert 8-bit ASCII charset to US-ASCII
572
if( charset == null || charset.equals( "ASCII" ) ) {
660
573
value = transcodeAsciiToUtf8( value );
663
// process charset (value is now in UTF-8)
664
578
String string_value;
666
580
string_value = new String( value.array(), value.position(),
667
value.limit() - value.position(), "UTF-8" );
581
value.limit() - value.position(), charset );
668
582
} catch( UnsupportedEncodingException e ) {
669
583
throw new ParseException( R.string.error_vcf_charset );
703
617
if( complete_value.length() < 1 ) return;
705
619
// parse some properties
706
if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
620
if( name_param_parts[ 0 ].equals( "N" ) )
707
621
parseN( name_param_parts, complete_value );
708
else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
622
else if( name_param_parts[ 0 ].equals( "FN" ) )
709
623
parseFN( name_param_parts, complete_value );
710
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
624
else if( name_param_parts[ 0 ].equals( "ORG" ) )
711
625
parseORG( name_param_parts, complete_value );
712
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
626
else if( name_param_parts[ 0 ].equals( "TITLE" ) )
713
627
parseTITLE( name_param_parts, complete_value );
714
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
628
else if( name_param_parts[ 0 ].equals( "TEL" ) )
715
629
parseTEL( name_param_parts, complete_value );
716
else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
630
else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
717
631
parseEMAIL( name_param_parts, complete_value );
718
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
632
else if( name_param_parts[ 0 ].equals( "ADR" ) )
719
633
parseADR( name_param_parts, complete_value );
720
else if( name_param_parts[ 0 ].equalsIgnoreCase( "LABEL" ) )
721
parseLABEL( name_param_parts, complete_value );
722
else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
723
parseNOTE( name_param_parts, complete_value );
724
else if( name_param_parts[ 0 ].equalsIgnoreCase( "BDAY" ) )
725
parseBDAY( name_param_parts, complete_value );
741
649
return ( count & 1 ) == 1;
744
private String[] splitValueByCharacter( String value, char character )
652
private String[] splitValueBySemicolon( String value )
746
// split string in to parts by specified character
654
// split string in to parts by semicolon
747
655
ArrayList< String > parts = new ArrayList< String >(
748
Arrays.asList( value.split( "" + character ) ) );
656
Arrays.asList( value.split( ";" ) ) );
750
658
// go through parts
751
659
for( int a = 0; a < parts.size(); a++ )
753
661
String str = parts.get( a );
755
// Look for parts that end in an escape character, but ignore
756
// the final part. We've already detected escape chars at the
663
// look for parts that end in an escape character, but ignore
664
// the final part. We've already detected escape chars at the
757
665
// end of the final part in parseLine() and handled multi-lines
759
667
if( a < parts.size() - 1 &&
760
668
doesStringEndInAnEscapeChar( str ) )
762
// append the escaped character, join the next part to this
763
// part and remove the next part
670
// join the next part to this part and remove the next part
764
671
parts.set( a, str.substring( 0, str.length() - 1 ) +
765
character + parts.get( a + 1 ) );
672
';' + parts.get( a + 1 ) );
766
673
parts.remove( a + 1 );
768
675
// re-visit this part
779
686
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();
831
689
private void parseN( String[] params, String value )
833
691
// already got a better name?
834
692
if( _name_level >= NAMELEVEL_N ) return;
836
694
// get name parts
837
String[] name_parts = splitValueByCharacter( value, ';' );
695
String[] name_parts = splitValueBySemicolon( value );
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 ];
699
if( name_parts.length > 1 && name_parts[ 1 ].length() > 0 )
700
value += name_parts[ 1 ];
701
if( name_parts.length > 0 && name_parts[ 0 ].length() > 0 )
702
value += ( value.length() == 0? "" : " " ) + name_parts[ 0 ];
858
setName( unescapeValue( value ) );
859
706
_name_level = NAMELEVEL_N;
957
802
boolean is_preferred = types.contains( "PREF" );
959
804
if( types.contains( "WORK" ) )
805
type = Contacts.ContactMethods.TYPE_WORK;
807
type = Contacts.ContactMethods.TYPE_HOME;
964
addEmail( unescapeValue( value ), type, is_preferred );
809
addEmail( value, type, is_preferred );
967
812
private void parseADR( String[] params, String value )
969
814
// get address parts
970
String[] adr_parts = splitValueByCharacter( value, ';' );
815
String[] adr_parts = splitValueBySemicolon( value );
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 ) );
1032
private void parseBDAY( String[] params, String value )
1034
setBirthday( value );
1037
public void finaliseVcard()
1038
throws ParseException, ContactNotIdentifiableException
819
for( int a = 0; a < adr_parts.length; a++ ) {
820
if( value.length() > 0 ) value += "\n";
821
value += adr_parts[ a ].trim();
824
Set< String > types = extractTypes( params, Arrays.asList(
825
"PREF", "WORK", "HOME", "INTERNET" ) );
829
if( types.contains( "WORK" ) )
830
type = Contacts.ContactMethods.TYPE_WORK;
832
type = Contacts.ContactMethods.TYPE_HOME;
834
addAddress( value, type );
837
public void finaliseParsing()
838
throws ParseException, SkipContactException,
1040
841
// missing version (and data is present)
1041
if( _version == null && _content_lines != null )
842
if( _version == null && _buffers != null )
1042
843
throw new ParseException( R.string.error_vcf_malformed );
1044
// finalise the parent class
845
// check if we should import this contact
847
if( !isImportRequired( this ) )
848
throw new SkipContactException();
850
catch( ContactNeedsMoreInfoException e ) {
851
throw new ParseException( R.string.error_vcf_notenoughinfo );
1049
* Amongst the params, find the value of the first, only, of any with
1050
* the specified name.
1054
* @return a value, or null
1056
855
private String checkParam( String[] params, String name )
1058
String[] res = checkParams( params, name );
1059
return res.length > 0? res[ 0 ] : null;
1063
* Amongst the params, find the values of any with the specified name.
1067
* @return an array of values, or null
1069
private String[] checkParams( String[] params, String name )
1071
HashSet< String > ret = new HashSet< String >();
1073
857
Pattern p = Pattern.compile(
1074
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1075
Pattern.CASE_INSENSITIVE );
858
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1076
859
for( int i = 0; i < params.length; i++ ) {
1077
860
Matcher m = p.matcher( params[ i ] );
1078
861
if( m.matches() )
1079
ret.add( m.group( 2 ) );
1082
return (String[]) ret.toArray( new String[ ret.size() ] );
1086
* Amongst the params, return any type values present. For v2.1 vCards,
1087
* those types are just parameters. For v3.0, they are prefixed with
1088
* "TYPE=". There may also be multiple type parameters.
1090
* @param params an array of params to look for types in
1091
* @param valid_types an list of upper-case type values to look for
1092
* @return a set of present type values
1094
867
private Set< String > extractTypes( String[] params,
1095
868
List< String > valid_types )
1097
870
HashSet< String > types = new HashSet< String >();
1099
872
// get 3.0-style TYPE= param
1100
String type_params[] = checkParams( params, "TYPE" );
1101
for( int a = 0; a < type_params.length; a++ )
1103
// check for a comma-separated list of types (why? I don't think
1104
// this is in the specs!)
1105
String[] parts = type_params[ a ].split( "," );
1106
for( int i = 0; i < parts.length; i++ ) {
1107
String ucpart = parts[ i ].toUpperCase( Locale.ENGLISH );
1108
if( valid_types.contains( ucpart ) )
1109
types.add( ucpart );
874
if( ( type_param = checkParam( params, "TYPE" ) ) != null ) {
875
String[] parts = type_param.split( "," );
876
for( int i = 0; i < parts.length; i++ )
877
if( valid_types.contains( parts[ i ] ) )
878
types.add( parts[ i ] );
1113
881
// get 2.1-style type param
1114
882
if( _version.equals( "2.1" ) ) {
1115
for( int i = 1; i < params.length; i++ ) {
1116
String ucparam = params[ i ].toUpperCase( Locale.ENGLISH );
1117
if( valid_types.contains( ucparam ) )
1118
types.add( ucparam );
883
for( int i = 1; i < params.length; i++ )
884
if( valid_types.contains( params[ i ] ) )
885
types.add( params[ i ] );