191
187
throws AbortImportException
193
189
// go through lines
195
int vcard_start_line = 0;
196
191
ContentLineIterator cli = new ContentLineIterator( content );
197
192
while( cli.hasNext() )
199
ContentLine content_line = cli.next();
201
// get a US-ASCII version of the string, for processing
202
String line = content_line.getUsAsciiLine();
204
if( vcard == null ) {
194
ByteBuffer buffer = cli.next();
196
// get a US-ASCII version of the line for processing
199
line = new String( buffer.array(), buffer.position(),
200
buffer.limit() - buffer.position(), "US-ASCII" );
202
catch( UnsupportedEncodingException e ) {
203
// we know US-ASCII is supported, so appease the compiler...
207
if( vCard == null ) {
205
208
// look for vcard beginning
206
if( line.matches( "^BEGIN[ \t]*:[ \t]*VCARD" ) ) {
207
setProgress( _progress++ );
209
vcard_start_line = cli.getLineNumber();
209
if( line.matches( "^BEGIN:VCARD" ) ) {
210
setProgress( ++_progress );
213
215
// look for vcard content or ending
214
if( line.matches( "^END[ \t]*:[ \t]*VCARD" ) )
216
if( line.matches( "^END:VCARD" ) )
216
// finalise the vcard/contact
218
// store vcard and do away with it
218
vcard.finaliseVcard();
220
// pass the finalised contact to the importer
221
importContact( vcard );
223
catch( Vcard.ParseException e ) {
225
getText( R.string.error_vcf_parse ).toString()
227
getText( R.string.error_vcf_parse_line ).toString()
228
+ cli.getLineNumber() + ":\n" + e.getMessage() ) )
230
finish( ACTION_ABORT );
235
catch( ContactData.ContactNotIdentifiableException e ) {
237
getText( R.string.error_vcf_parse ).toString()
239
getText( R.string.error_vcf_parse_line ).toString()
240
+ vcard_start_line + ":\n" + getText(
241
R.string.error_vcf_notenoughinfo ).toString()
244
finish( ACTION_ABORT );
250
// discard this vcard
220
vCard.finaliseParsing();
221
importContact( vCard );
223
catch( VCard.ParseException e ) {
226
getText( R.string.error_vcf_parse ).toString()
227
+ fileName + "\n" + e.getMessage() ) )
229
finish( ACTION_ABORT );
232
catch( VCard.SkipContactException e ) {
255
240
// try giving the line to the vcard
257
vcard.parseLine( content_line );
242
vCard.parseLine( buffer, line,
243
cli.doesNextLineLookFolded() );
259
catch( Vcard.ParseException e ) {
245
catch( VCard.ParseException e ) {
261
247
if( !showContinue(
262
248
getText( R.string.error_vcf_parse ).toString()
264
getText( R.string.error_vcf_parse_line ).toString()
265
+ cli.getLineNumber() + "\n" + e.getMessage() ) )
249
+ fileName + "\n" + e.getMessage() ) )
267
251
finish( ACTION_ABORT );
270
254
// although we're continuing, we still need to abort
271
255
// this vCard. Further lines will be ignored until we
272
256
// get to another BEGIN:VCARD line.
275
catch( Vcard.SkipImportException e ) {
259
catch( VCard.SkipContactException e ) {
277
261
// abort this vCard. Further lines will be ignored until
278
262
// we get to another BEGIN:VCARD line.
288
private ByteBuffer _buffer;
289
private boolean _folded_next;
290
private String _line;
292
public ContentLine( ByteBuffer buffer, boolean folded_next )
295
_folded_next = folded_next;
299
public ByteBuffer getBuffer()
304
public boolean doesNextLineLookFolded()
309
public String getUsAsciiLine()
311
// generated line and cache it
312
if( _line == null ) {
314
_line = new String( _buffer.array(), _buffer.position(),
315
_buffer.limit() - _buffer.position(), "US-ASCII" );
317
catch( UnsupportedEncodingException e ) {
318
// we know US-ASCII *is* supported, so appease the
323
// return cached line
328
class ContentLineIterator implements Iterator< ContentLine >
270
class ContentLineIterator implements Iterator< ByteBuffer >
330
272
protected byte[] _content = null;
331
273
protected int _pos = 0;
332
protected int _line = 0;
334
275
public ContentLineIterator( byte[] content )
388
323
* onto the end of this one?
391
private boolean doesNextLineLookFolded()
326
public boolean doesNextLineLookFolded()
393
328
return _pos > 0 && _pos < _content.length &&
394
_content[ _pos - 1 ] == '\n' &&
395
( _content[ _pos ] == ' ' || _content[ _pos ] == '\t' );
398
public int getLineNumber()
329
_content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
404
private class Vcard extends ContactData
333
private class VCard extends ContactData
406
335
private final static int NAMELEVEL_NONE = 0;
407
private final static int NAMELEVEL_N = 1;
408
private final static int NAMELEVEL_FN = 2;
336
private final static int NAMELEVEL_FN = 1;
337
private final static int NAMELEVEL_N = 2;
410
339
private final static int MULTILINE_NONE = 0;
411
340
private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
412
341
private final static int MULTILINE_ESCAPED = 2; // v2.1 \\CRLF
413
private final static int MULTILINE_FOLDED = 3; // MIME-DIR folding
342
private final static int MULTILINE_FOLDED = 3; // v3.0 folding
415
344
private String _version = null;
416
private Vector< ContentLine > _content_lines = null;
345
private Vector< ByteBuffer > _buffers = null;
417
346
private int _name_level = NAMELEVEL_NONE;
418
347
private int _parser_multiline_state = MULTILINE_NONE;
419
348
private String _parser_current_name_and_params = null;
456
385
public ParseException( int res )
458
super( VcardImporter.this.getText( res ).toString() );
387
super( VCFImporter.this.getText( res ).toString() );
462
391
@SuppressWarnings("serial")
463
protected class SkipImportException extends Exception { }
392
protected class SkipContactException extends Exception { }
465
private String extractCollonPartFromLine( ContentLine content_line,
394
private String extractCollonPartFromLine( ByteBuffer buffer,
395
String line, boolean former )
468
397
String ret = null;
399
// get a US-ASCII version of the line for processing, unless we were
403
line = new String( buffer.array(), buffer.position(),
404
buffer.limit() - buffer.position(), "US-ASCII" );
406
catch( UnsupportedEncodingException e ) {
407
// we know US-ASCII is supported, so appease the compiler...
470
412
// split line into name and value parts and check to make sure we
471
413
// only got 2 parts and that the first part is not zero in length
472
String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
414
String[] parts = line.split( ":", 2 );
473
415
if( parts.length == 2 && parts[ 0 ].length() > 0 )
474
416
ret = parts[ former? 0 : 1 ];
479
private String extractNameAndParamsFromLine( ContentLine content_line )
481
return extractCollonPartFromLine( content_line, true );
484
private String extractValueFromLine( ContentLine content_line )
486
return extractCollonPartFromLine( content_line, false );
489
public void parseLine( ContentLine content_line )
490
throws ParseException, SkipImportException,
421
private String extractNameAndParamsFromLine( ByteBuffer buffer,
424
return extractCollonPartFromLine( buffer, line, true );
427
private String extractValueFromLine( ByteBuffer buffer, String line )
429
return extractCollonPartFromLine( buffer, line, false );
432
public void parseLine( ByteBuffer buffer, String line,
433
boolean next_line_looks_folded )
434
throws ParseException, SkipContactException,
491
435
AbortImportException
493
437
// do we have a version yet?
496
440
// tentatively get name and params from line
497
441
String name_and_params =
498
extractNameAndParamsFromLine( content_line );
442
extractNameAndParamsFromLine( buffer, line );
500
444
// is it a version line?
501
445
if( name_and_params != null &&
502
name_and_params.equalsIgnoreCase( "VERSION" ) )
446
name_and_params.equals( "VERSION" ) )
505
String value = extractValueFromLine( content_line );
449
String value = extractValueFromLine( buffer, line );
506
450
if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
507
451
throw new ParseException( R.string.error_vcf_version );
508
452
_version = value;
510
454
// parse any buffers we've been accumulating while we waited
512
if( _content_lines != null )
513
for( int i = 0; i < _content_lines.size(); i++ )
514
parseLine( _content_lines.get( i ) );
515
_content_lines = null;
456
if( _buffers != null )
457
for( int i = 0; i < _buffers.size(); i++ )
458
parseLine( _buffers.get( i ), null,
459
i + 1 < _buffers.size() &&
460
_buffers.get( i + 1 ).hasRemaining() &&
461
_buffers.get( i + 1 ).get(
462
_buffers.get( i + 1 ).position() ) == ' ' );
519
467
// no, so stash this line till we get a version
520
if( _content_lines == null )
521
_content_lines = new Vector< ContentLine >();
522
_content_lines.add( content_line );
468
if( _buffers == null )
469
_buffers = new Vector< ByteBuffer >();
470
_buffers.add( buffer );
527
475
// name and params and the position in the buffer where the
528
// "value" part of the line starts
476
// "value" part of the line start
529
477
String name_and_params;
587
530
// get value from buffer, as raw bytes
588
531
ByteBuffer value;
589
value = ByteBuffer.wrap( content_line.getBuffer().array(), pos,
590
content_line.getBuffer().limit() - pos );
532
value = ByteBuffer.wrap( buffer.array(), pos,
533
buffer.limit() - pos );
592
535
// get parameter parts
593
536
String[] name_param_parts = name_and_params.split( ";", -1 );
594
537
for( int i = 0; i < name_param_parts.length; i++ )
595
538
name_param_parts[ i ] = name_param_parts[ i ].trim();
597
// determine whether we care about this entry
598
final HashSet< String > interesting_fields =
599
new HashSet< String >( Arrays.asList( new String[] { "N",
600
"FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
602
boolean is_interesting_field =
603
interesting_fields.contains(
604
name_param_parts[ 0 ].toUpperCase( Locale.US ) );
606
540
// parse encoding parameter
607
541
String encoding = checkParam( name_param_parts, "ENCODING" );
608
if( encoding != null )
609
encoding = encoding.toUpperCase( Locale.US );
610
if( is_interesting_field && encoding != null &&
611
!encoding.equalsIgnoreCase( "8BIT" ) &&
612
!encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
613
//&& !encoding.equalsIgnoreCase( "BASE64" ) )
542
if( encoding != null ) encoding = encoding.toUpperCase();
543
if( encoding != null && !encoding.equals( "8BIT" ) &&
544
!encoding.equals( "QUOTED-PRINTABLE" ) )
545
//&& !encoding.equals( "BASE64" ) )
615
547
throw new ParseException( R.string.error_vcf_encoding );
618
550
// parse charset parameter
619
551
String charset = checkParam( name_param_parts, "CHARSET" );
620
if( charset != null )
621
charset = charset.toUpperCase( Locale.US );
622
if( charset != null &&
623
!charset.equalsIgnoreCase( "US-ASCII" ) &&
624
!charset.equalsIgnoreCase( "ASCII" ) &&
625
!charset.equalsIgnoreCase( "UTF-8" ) )
552
if( charset != null ) charset = charset.toUpperCase();
553
if( charset != null && !charset.equals( "US-ASCII" ) &&
554
!charset.equals( "ASCII" ) &&
555
!charset.equals( "UTF-8" ) )
627
557
throw new ParseException( R.string.error_vcf_charset );
630
560
// do unencoding (or default to a fake unencoding result with
631
561
// the raw string)
632
562
UnencodeResult unencoding_result = null;
633
if( encoding != null &&
634
encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
563
if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
636
564
unencoding_result = unencodeQuotedPrintable( value );
638
// else if( encoding != null &&
639
// encoding.equalsIgnoreCase( "BASE64" ) )
565
// else if( encoding != null && encoding.equals( "BASE64" ) )
641
566
// unencoding_result = unencodeBase64( props[ 1 ], charset );
643
567
if( unencoding_result != null ) {
644
568
value = unencoding_result.getBuffer();
645
569
if( unencoding_result.isAnotherLineRequired() )
646
570
_parser_multiline_state = MULTILINE_ENCODED;
649
// convert 8-bit US-ASCII charset to UTF-8 (where no charset is
650
// specified for a v2.1 vcard entry, we assume it's US-ASCII)
651
if( ( charset == null && _version.equals( "2.1" ) ) ||
652
( charset != null && (
653
charset.equalsIgnoreCase( "ASCII" ) ||
654
charset.equalsIgnoreCase( "US-ASCII" ) ) ) )
573
// convert 8-bit ASCII charset to US-ASCII
574
if( charset == null || charset.equals( "ASCII" ) ) {
656
575
value = transcodeAsciiToUtf8( value );
659
// process charset (value is now in UTF-8)
660
580
String string_value;
662
582
string_value = new String( value.array(), value.position(),
663
value.limit() - value.position(), "UTF-8" );
583
value.limit() - value.position(), charset );
664
584
} catch( UnsupportedEncodingException e ) {
665
585
throw new ParseException( R.string.error_vcf_charset );
699
619
if( complete_value.length() < 1 ) return;
701
621
// parse some properties
702
if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
622
if( name_param_parts[ 0 ].equals( "N" ) )
703
623
parseN( name_param_parts, complete_value );
704
else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
624
else if( name_param_parts[ 0 ].equals( "FN" ) )
705
625
parseFN( name_param_parts, complete_value );
706
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
626
else if( name_param_parts[ 0 ].equals( "ORG" ) )
707
627
parseORG( name_param_parts, complete_value );
708
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
628
else if( name_param_parts[ 0 ].equals( "TITLE" ) )
709
629
parseTITLE( name_param_parts, complete_value );
710
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
630
else if( name_param_parts[ 0 ].equals( "TEL" ) )
711
631
parseTEL( name_param_parts, complete_value );
712
else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
632
else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
713
633
parseEMAIL( name_param_parts, complete_value );
714
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
634
else if( name_param_parts[ 0 ].equals( "ADR" ) )
715
635
parseADR( name_param_parts, complete_value );
716
else if( name_param_parts[ 0 ].equalsIgnoreCase( "LABEL" ) )
717
parseLABEL( name_param_parts, complete_value );
718
else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
719
parseNOTE( name_param_parts, complete_value );
773
688
return parts.toArray( ret );
776
private String unescapeValue( String value )
778
StringBuilder ret = new StringBuilder( value.length() );
779
boolean in_escape = false;
780
for( int a = 0; a < value.length(); a++ )
782
int c = value.codePointAt( a );
784
// process a normal character
789
ret.append( Character.toChars( c ) );
793
// process an escape sequence
799
// add tab (invalid/non-standard, but accepted)
810
// add escaped character
811
ret.append( Character.toChars( c ) );
814
// unknown escape sequence, so add it unescaped
815
// (invalid/non-standard, but accepted)
817
ret.append( Character.toChars( c ) );
822
return ret.toString();
825
691
private void parseN( String[] params, String value )
827
693
// already got a better name?
828
694
if( _name_level >= NAMELEVEL_N ) return;
830
696
// get name parts
831
String[] name_parts = splitValueByCharacter( value, ';' );
697
String[] name_parts = splitValueBySemicolon( value );
835
final int[] part_order = { 3, 1, 2, 0, 4 };
836
for( int a = 0; a < part_order.length; a++ )
837
if( name_parts.length > part_order[ a ] &&
838
name_parts[ part_order[ a ] ].length() > 0 )
840
// split this part in to it's comma-separated bits
841
String[] name_part_parts = splitValueByCharacter(
842
name_parts[ part_order[ a ] ], ',' );
843
for( int b = 0; b < name_part_parts.length; b++ )
844
if( name_part_parts[ b ].length() > 0 )
846
if( value.length() == 0 ) value += " ";
847
value += name_part_parts[ b ];
701
if( name_parts.length > 1 && name_parts[ 1 ].length() > 0 )
702
value += name_parts[ 1 ];
703
if( name_parts.length > 0 && name_parts[ 0 ].length() > 0 )
704
value += ( value.length() == 0? "" : " " ) + name_parts[ 0 ];
852
setName( unescapeValue( value ) );
853
708
_name_level = NAMELEVEL_N;
948
801
"PREF", "WORK", "HOME", "INTERNET" ) );
950
803
// add email address
951
boolean is_preferred = types.contains( "PREF" );
804
boolean preferred = types.contains( "PREF" );
953
806
if( types.contains( "WORK" ) )
807
type = Contacts.ContactMethods.TYPE_WORK;
809
type = Contacts.ContactMethods.TYPE_HOME;
958
addEmail( unescapeValue( value ), type, is_preferred );
811
addEmail( value, type, preferred );
961
814
private void parseADR( String[] params, String value )
963
816
// get address parts
964
String[] adr_parts = splitValueByCharacter( value, ';' );
817
String[] adr_parts = splitValueBySemicolon( value );
968
for( int a = 0; a < adr_parts.length; a++ )
969
if( adr_parts[ a ].length() > 0 )
971
// version 3.0 vCards allow further splitting by comma
972
if( _version.equals( "3.0" ) )
974
// split this part in to it's comma-separated bits and
975
// add them on individual lines
976
String[] adr_part_parts =
977
splitValueByCharacter( adr_parts[ a ], ',' );
978
for( int b = 0; b < adr_part_parts.length; b++ )
979
if( adr_part_parts[ b ].length() > 0 )
981
if( value.length() > 0 ) value += "\n";
982
value += adr_part_parts[ b ];
987
// add this part on an individual line
988
if( value.length() > 0 ) value += "\n";
989
value += adr_parts[ a ];
993
Set< String > types = extractTypes( params, Arrays.asList(
994
"PREF", "WORK", "HOME" ) );
998
if( types.contains( "WORK" ) )
1003
addAddress( unescapeValue( value ), type );
1006
private void parseLABEL( String[] params, String value )
1008
Set< String > types = extractTypes( params, Arrays.asList(
1009
"PREF", "WORK", "HOME" ) );
1013
if( types.contains( "WORK" ) )
1018
addAddress( unescapeValue( value ), type );
1021
private void parseNOTE( String[] params, String value )
1023
addNote( unescapeValue( value ) );
1026
public void finaliseVcard()
1027
throws ParseException, ContactNotIdentifiableException
821
for( int a = 0; a < adr_parts.length; a++ ) {
822
if( value.length() > 0 ) value += "\n";
823
value += adr_parts[ a ].trim();
826
Set< String > types = extractTypes( params, Arrays.asList(
827
"PREF", "WORK", "HOME", "INTERNET" ) );
831
if( types.contains( "WORK" ) )
832
type = Contacts.ContactMethods.TYPE_WORK;
834
type = Contacts.ContactMethods.TYPE_HOME;
836
addAddress( value, type );
839
public void finaliseParsing()
840
throws ParseException, SkipContactException,
1029
843
// missing version (and data is present)
1030
if( _version == null && _content_lines != null )
844
if( _version == null && _buffers != null )
1031
845
throw new ParseException( R.string.error_vcf_malformed );
1033
// finalise the parent class
847
// check if we should import this contact
849
if( !isImportRequired( this ) )
850
throw new SkipContactException();
852
catch( ContactNeedsMoreInfoException e ) {
853
throw new ParseException( R.string.error_vcf_notenoughinfo );
1038
* Amongst the params, find the value of the first, only, of any with
1039
* the specified name
1042
* @return a value, or null
1044
857
private String checkParam( String[] params, String name )
1046
String[] res = checkParams( params, name );
1047
return res.length > 0? res[ 0 ] : null;
1051
* Amongst the params, find the values of any with the specified name
1054
* @return an array of values, or null
1056
private String[] checkParams( String[] params, String name )
1058
HashSet< String > ret = new HashSet< String >();
1060
859
Pattern p = Pattern.compile(
1061
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1062
Pattern.CASE_INSENSITIVE );
860
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1063
861
for( int i = 0; i < params.length; i++ ) {
1064
862
Matcher m = p.matcher( params[ i ] );
1065
863
if( m.matches() )
1066
ret.add( m.group( 2 ) );
1069
return (String[]) ret.toArray( new String[ ret.size() ] );
1073
* Amongst the params, return any type values present. For v2.1 vCards,
1074
* those types are just parameters. For v3.0, they are prefixed with
1075
* "TYPE=". There may also be multiple type parameters.
1076
* @param params an array of params to look for types in
1077
* @param valid_types an list of upper-case type values to look for
1078
* @return a set of present type values
1080
869
private Set< String > extractTypes( String[] params,
1081
870
List< String > valid_types )
1083
872
HashSet< String > types = new HashSet< String >();
1085
874
// get 3.0-style TYPE= param
1086
String type_params[] = checkParams( params, "TYPE" );
1087
for( int a = 0; a < type_params.length; a++ )
1089
// check for a comma-separated list of types (why? I don't think
1090
// this is in the specs!)
1091
String[] parts = type_params[ a ].split( "," );
1092
for( int i = 0; i < parts.length; i++ ) {
1093
String ucpart = parts[ i ].toUpperCase( Locale.US );
1094
if( valid_types.contains( ucpart ) )
1095
types.add( ucpart );
876
if( ( type_param = checkParam( params, "TYPE" ) ) != null ) {
877
String[] parts = type_param.split( "," );
878
for( int i = 0; i < parts.length; i++ )
879
if( valid_types.contains( parts[ i ] ) )
880
types.add( parts[ i ] );
1099
883
// get 2.1-style type param
1100
884
if( _version.equals( "2.1" ) ) {
1101
for( int i = 1; i < params.length; i++ ) {
1102
String ucparam = params[ i ].toUpperCase( Locale.US );
1103
if( valid_types.contains( ucparam ) )
1104
types.add( ucparam );
885
for( int i = 1; i < params.length; i++ )
886
if( valid_types.contains( params[ i ] ) )
887
types.add( params[ i ] );