197
185
throws AbortImportException
199
187
// go through lines
201
int vcard_start_line = 0;
202
189
ContentLineIterator cli = new ContentLineIterator( content );
203
190
while( cli.hasNext() )
205
ContentLine content_line = cli.next();
192
ByteBuffer buffer = cli.next();
207
// get a US-ASCII version of the string, for processing
208
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...
210
205
if( vcard == null ) {
211
206
// look for vcard beginning
212
if( line.matches( "^BEGIN[ \t]*:[ \t]*VCARD.*$" ) ) {
213
setProgress( _progress++ );
215
vcard_start_line = cli.getLineNumber();
207
if( line.matches( "^BEGIN:VCARD" ) ) {
208
setProgress( ++_progress );
219
213
// look for vcard content or ending
220
if( line.matches( "^END[ \t]*:[ \t]*VCARD.*$" ) )
214
if( line.matches( "^END:VCARD" ) )
222
// finalise the vcard/contact
216
// store vcard and do away with it
224
vcard.finaliseVcard();
226
// pass the finalised contact to the importer
218
vcard.finaliseParsing();
227
219
importContact( vcard );
229
catch( Vcard.ParseException e ) {
231
getText( R.string.error_vcf_parse ).toString()
233
getText( R.string.error_vcf_parse_line ).toString()
234
+ cli.getLineNumber() + ":\n" + e.getMessage() ) )
236
finish( ACTION_ABORT );
241
catch( ContactData.ContactNotIdentifiableException e ) {
243
getText( R.string.error_vcf_parse ).toString()
245
getText( R.string.error_vcf_parse_line ).toString()
246
+ vcard_start_line + ":\n" + getText(
247
R.string.error_vcf_notenoughinfo ).toString()
250
finish( ACTION_ABORT );
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 ) {
267
245
if( !showContinue(
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() ) )
273
249
finish( ACTION_ABORT );
394
321
* onto the end of this one?
397
private boolean doesNextLineLookFolded()
324
public boolean doesNextLineLookFolded()
399
326
return _pos > 0 && _pos < _content.length &&
400
_content[ _pos - 1 ] == '\n' &&
401
( _content[ _pos ] == ' ' || _content[ _pos ] == '\t' );
404
public int getLineNumber()
327
_content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
410
private class Vcard extends ContactData
331
private class VCard extends ContactData
412
333
private final static int NAMELEVEL_NONE = 0;
413
private final static int NAMELEVEL_N = 1;
414
private final static int NAMELEVEL_FN = 2;
334
private final static int NAMELEVEL_FN = 1;
335
private final static int NAMELEVEL_N = 2;
416
337
private final static int MULTILINE_NONE = 0;
417
338
private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
418
339
private final static int MULTILINE_ESCAPED = 2; // v2.1 \\CRLF
419
private final static int MULTILINE_FOLDED = 3; // MIME-DIR folding
340
private final static int MULTILINE_FOLDED = 3; // v3.0 folding
421
342
private String _version = null;
422
private Vector< ContentLine > _content_lines = null;
343
private Vector< ByteBuffer > _buffers = null;
423
344
private int _name_level = NAMELEVEL_NONE;
424
345
private int _parser_multiline_state = MULTILINE_NONE;
425
346
private String _parser_current_name_and_params = null;
462
383
public ParseException( int res )
464
super( VcardImporter.this.getText( res ).toString() );
385
super( VCFImporter.this.getText( res ).toString() );
468
389
@SuppressWarnings("serial")
469
protected class SkipImportException extends Exception { }
390
protected class SkipContactException extends Exception { }
471
private String extractCollonPartFromLine( ContentLine content_line,
392
private String extractCollonPartFromLine( ByteBuffer buffer,
393
String line, boolean former )
474
395
String ret = null;
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...
476
410
// split line into name and value parts and check to make sure we
477
411
// only got 2 parts and that the first part is not zero in length
478
String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
412
String[] parts = line.split( ":", 2 );
479
413
if( parts.length == 2 && parts[ 0 ].length() > 0 )
480
414
ret = parts[ former? 0 : 1 ];
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 )
496
throws ParseException, SkipImportException,
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,
497
433
AbortImportException
499
435
// do we have a version yet?
502
438
// tentatively get name and params from line
503
439
String name_and_params =
504
extractNameAndParamsFromLine( content_line );
440
extractNameAndParamsFromLine( buffer, line );
506
442
// is it a version line?
507
443
if( name_and_params != null &&
508
name_and_params.equalsIgnoreCase( "VERSION" ) )
444
name_and_params.equals( "VERSION" ) )
511
String value = extractValueFromLine( content_line ).trim();
447
String value = extractValueFromLine( buffer, line );
512
448
if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
513
449
throw new ParseException( R.string.error_vcf_version );
514
450
_version = value;
516
452
// parse any buffers we've been accumulating while we waited
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;
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() ) == ' ' );
525
465
// no, so stash this line till we get a version
526
if( _content_lines == null )
527
_content_lines = new Vector< ContentLine >();
528
_content_lines.add( content_line );
466
if( _buffers == null )
467
_buffers = new Vector< ByteBuffer >();
468
_buffers.add( buffer );
533
473
// name and params and the position in the buffer where the
534
// "value" part of the line starts
474
// "value" part of the line start
535
475
String name_and_params;
593
528
// get value from buffer, as raw bytes
594
529
ByteBuffer value;
595
value = ByteBuffer.wrap( content_line.getBuffer().array(), pos,
596
content_line.getBuffer().limit() - pos );
530
value = ByteBuffer.wrap( buffer.array(), pos,
531
buffer.limit() - pos );
598
533
// get parameter parts
599
534
String[] name_param_parts = name_and_params.split( ";", -1 );
600
535
for( int i = 0; i < name_param_parts.length; i++ )
601
536
name_param_parts[ i ] = name_param_parts[ i ].trim();
603
// determine whether we care about this entry
604
final HashSet< String > interesting_fields =
605
new HashSet< String >( Arrays.asList( new String[] { "N",
606
"FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
608
boolean is_interesting_field =
609
interesting_fields.contains(
610
name_param_parts[ 0 ].toUpperCase( Locale.US ) );
612
538
// parse encoding parameter
613
539
String encoding = checkParam( name_param_parts, "ENCODING" );
614
if( encoding != null )
615
encoding = encoding.toUpperCase( Locale.US );
616
if( is_interesting_field && encoding != null &&
617
!encoding.equalsIgnoreCase( "8BIT" ) &&
618
!encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
619
//&& !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" ) )
621
545
throw new ParseException( R.string.error_vcf_encoding );
624
548
// parse charset parameter
625
549
String charset = checkParam( name_param_parts, "CHARSET" );
626
if( charset != null )
627
charset = charset.toUpperCase( Locale.US );
628
if( charset != null &&
629
!charset.equalsIgnoreCase( "US-ASCII" ) &&
630
!charset.equalsIgnoreCase( "ASCII" ) &&
631
!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" ) )
633
555
throw new ParseException( R.string.error_vcf_charset );
636
558
// do unencoding (or default to a fake unencoding result with
637
559
// the raw string)
638
560
UnencodeResult unencoding_result = null;
639
if( encoding != null &&
640
encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
561
if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
642
562
unencoding_result = unencodeQuotedPrintable( value );
644
// else if( encoding != null &&
645
// encoding.equalsIgnoreCase( "BASE64" ) )
563
// else if( encoding != null && encoding.equals( "BASE64" ) )
647
564
// unencoding_result = unencodeBase64( props[ 1 ], charset );
649
565
if( unencoding_result != null ) {
650
566
value = unencoding_result.getBuffer();
651
567
if( unencoding_result.isAnotherLineRequired() )
652
568
_parser_multiline_state = MULTILINE_ENCODED;
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" ) ) ) )
571
// convert 8-bit ASCII charset to US-ASCII
572
if( charset == null || charset.equals( "ASCII" ) ) {
662
573
value = transcodeAsciiToUtf8( value );
665
// process charset (value is now in UTF-8)
666
578
String string_value;
668
580
string_value = new String( value.array(), value.position(),
669
value.limit() - value.position(), "UTF-8" );
581
value.limit() - value.position(), charset );
670
582
} catch( UnsupportedEncodingException e ) {
671
583
throw new ParseException( R.string.error_vcf_charset );
705
617
if( complete_value.length() < 1 ) return;
707
619
// parse some properties
708
if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
620
if( name_param_parts[ 0 ].equals( "N" ) )
709
621
parseN( name_param_parts, complete_value );
710
else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
622
else if( name_param_parts[ 0 ].equals( "FN" ) )
711
623
parseFN( name_param_parts, complete_value );
712
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
624
else if( name_param_parts[ 0 ].equals( "ORG" ) )
713
625
parseORG( name_param_parts, complete_value );
714
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
626
else if( name_param_parts[ 0 ].equals( "TITLE" ) )
715
627
parseTITLE( name_param_parts, complete_value );
716
else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
628
else if( name_param_parts[ 0 ].equals( "TEL" ) )
717
629
parseTEL( name_param_parts, complete_value );
718
else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
630
else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
719
631
parseEMAIL( name_param_parts, complete_value );
720
else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
632
else if( name_param_parts[ 0 ].equals( "ADR" ) )
721
633
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 );
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
public void finaliseVcard()
1033
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,
1035
841
// missing version (and data is present)
1036
if( _version == null && _content_lines != null )
842
if( _version == null && _buffers != null )
1037
843
throw new ParseException( R.string.error_vcf_malformed );
1039
// 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 );
1044
* Amongst the params, find the value of the first, only, of any with
1045
* the specified name
1048
* @return a value, or null
1050
855
private String checkParam( String[] params, String name )
1052
String[] res = checkParams( params, name );
1053
return res.length > 0? res[ 0 ] : null;
1057
* Amongst the params, find the values of any with the specified name
1060
* @return an array of values, or null
1062
private String[] checkParams( String[] params, String name )
1064
HashSet< String > ret = new HashSet< String >();
1066
857
Pattern p = Pattern.compile(
1067
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1068
Pattern.CASE_INSENSITIVE );
858
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1069
859
for( int i = 0; i < params.length; i++ ) {
1070
860
Matcher m = p.matcher( params[ i ] );
1071
861
if( m.matches() )
1072
ret.add( m.group( 2 ) );
1075
return (String[]) ret.toArray( new String[ ret.size() ] );
1079
* Amongst the params, return any type values present. For v2.1 vCards,
1080
* those types are just parameters. For v3.0, they are prefixed with
1081
* "TYPE=". There may also be multiple type parameters.
1082
* @param params an array of params to look for types in
1083
* @param valid_types an list of upper-case type values to look for
1084
* @return a set of present type values
1086
867
private Set< String > extractTypes( String[] params,
1087
868
List< String > valid_types )
1089
870
HashSet< String > types = new HashSet< String >();
1091
872
// get 3.0-style TYPE= param
1092
String type_params[] = checkParams( params, "TYPE" );
1093
for( int a = 0; a < type_params.length; a++ )
1095
// check for a comma-separated list of types (why? I don't think
1096
// this is in the specs!)
1097
String[] parts = type_params[ a ].split( "," );
1098
for( int i = 0; i < parts.length; i++ ) {
1099
String ucpart = parts[ i ].toUpperCase( Locale.US );
1100
if( valid_types.contains( ucpart ) )
1101
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 ] );
1105
881
// get 2.1-style type param
1106
882
if( _version.equals( "2.1" ) ) {
1107
for( int i = 1; i < params.length; i++ ) {
1108
String ucparam = params[ i ].toUpperCase( Locale.US );
1109
if( valid_types.contains( ucparam ) )
1110
types.add( ucparam );
883
for( int i = 1; i < params.length; i++ )
884
if( valid_types.contains( params[ i ] ) )
885
types.add( params[ i ] );