4
* Copyright (C) 2009 to 2011 Tim Marston <edam@waxworlds.org>
4
* Copyright (C) 2009 to 2011 Tim Marston <tim@ed.am>
6
6
* This file is part of the Import Contacts program (hereafter referred
7
7
* to as "this program"). For more information, see
8
* http://www.waxworlds.org/edam/software/android/import-contacts
8
* http://ed.am/dev/android/import-contacts
10
10
* This program is free software: you can redistribute it and/or modify
11
11
* it under the terms of the GNU General Public License as published by
38
38
import java.util.HashSet;
39
39
import java.util.Iterator;
40
40
import java.util.List;
41
import java.util.Locale;
41
42
import java.util.NoSuchElementException;
42
43
import java.util.Set;
43
44
import java.util.Vector;
44
45
import java.util.regex.Matcher;
45
46
import java.util.regex.Pattern;
48
import android.annotation.SuppressLint;
47
49
import android.content.SharedPreferences;
48
import android.provider.Contacts;
49
import android.provider.Contacts.PhonesColumns;
51
51
public class VcardImporter extends Importer
362
363
private class Vcard extends ContactData
364
365
private final static int NAMELEVEL_NONE = 0;
365
private final static int NAMELEVEL_FN = 1;
366
private final static int NAMELEVEL_N = 2;
366
private final static int NAMELEVEL_N = 1;
367
private final static int NAMELEVEL_FN = 2;
368
369
private final static int MULTILINE_NONE = 0;
369
370
private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
569
570
// determine whether we care about this entry
570
571
final HashSet< String > interesting_fields =
571
new HashSet< String >( Arrays.asList( new String[]
572
{ "N", "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR" }
572
new HashSet< String >( Arrays.asList( new String[] { "N",
573
"FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
574
575
boolean is_interesting_field =
575
576
interesting_fields.contains( name_param_parts[ 0 ] );
577
578
// parse encoding parameter
578
579
String encoding = checkParam( name_param_parts, "ENCODING" );
579
if( encoding != null ) encoding = encoding.toUpperCase();
580
if( encoding != null )
581
encoding = encoding.toUpperCase( Locale.US );
580
582
if( is_interesting_field && encoding != null &&
581
583
!encoding.equals( "8BIT" ) &&
582
584
!encoding.equals( "QUOTED-PRINTABLE" ) )
588
590
// parse charset parameter
589
591
String charset = checkParam( name_param_parts, "CHARSET" );
590
if( charset != null ) charset = charset.toUpperCase();
592
if( charset != null )
593
charset = charset.toUpperCase( Locale.US );
591
594
if( charset != null &&
592
595
!charset.equals( "US-ASCII" ) &&
593
596
!charset.equals( "ASCII" ) &&
609
612
_parser_multiline_state = MULTILINE_ENCODED;
612
// convert 8-bit ASCII charset to US-ASCII
613
if( charset == null || charset.equals( "ASCII" ) ) {
615
// convert 8-bit US-ASCII charset to UTF-8 (where no charset is
616
// specified for a v2.1 vcard entry, we assume it's US-ASCII)
617
if( ( charset == null && _version.equals( "2.1" ) ) ||
618
( charset != null && (
619
charset.equals( "ASCII" ) ||
620
charset.equals( "US-ASCII" ) ) ) )
614
622
value = transcodeAsciiToUtf8( value );
625
// process charset (value is now in UTF-8)
619
626
String string_value;
621
628
string_value = new String( value.array(), value.position(),
622
value.limit() - value.position(), charset );
629
value.limit() - value.position(), "UTF-8" );
623
630
} catch( UnsupportedEncodingException e ) {
624
631
throw new ParseException( R.string.error_vcf_charset );
672
679
parseEMAIL( name_param_parts, complete_value );
673
680
else if( name_param_parts[ 0 ].equals( "ADR" ) )
674
681
parseADR( name_param_parts, complete_value );
682
else if( name_param_parts[ 0 ].equals( "LABEL" ) )
683
parseLABEL( name_param_parts, complete_value );
684
else if( name_param_parts[ 0 ].equals( "NOTE" ) )
685
parseNOTE( name_param_parts, complete_value );
690
701
return ( count & 1 ) == 1;
693
private String[] splitValueBySemicolon( String value )
704
private String[] splitValueByCharacter( String value, char character )
695
// split string in to parts by semicolon
706
// split string in to parts by specified character
696
707
ArrayList< String > parts = new ArrayList< String >(
697
Arrays.asList( value.split( ";" ) ) );
708
Arrays.asList( value.split( "" + character ) ) );
699
710
// go through parts
700
711
for( int a = 0; a < parts.size(); a++ )
708
719
if( a < parts.size() - 1 &&
709
720
doesStringEndInAnEscapeChar( str ) )
711
// join the next part to this part and remove the next part
722
// append the escaped character, join the next part to this
723
// part and remove the next part
712
724
parts.set( a, str.substring( 0, str.length() - 1 ) +
713
';' + parts.get( a + 1 ) );
725
character + parts.get( a + 1 ) );
714
726
parts.remove( a + 1 );
716
728
// re-visit this part
727
739
return parts.toArray( ret );
742
private String unescapeValue( String value )
744
StringBuilder ret = new StringBuilder( value.length() );
745
boolean in_escape = false;
746
for( int a = 0; a < value.length(); a++ )
748
int c = value.codePointAt( a );
750
// process a normal character
755
ret.append( Character.toChars( c ) );
759
// process an escape sequence
765
// add tab (invalid/non-standard, but accepted)
776
// add escaped character
777
ret.append( Character.toChars( c ) );
780
// unknown escape sequence, so add it unescaped
781
// (invalid/non-standard, but accepted)
783
ret.append( Character.toChars( c ) );
788
return ret.toString();
730
791
private void parseN( String[] params, String value )
732
793
// already got a better name?
733
794
if( _name_level >= NAMELEVEL_N ) return;
735
796
// get name parts
736
String[] name_parts = splitValueBySemicolon( value );
797
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 ];
801
final int[] part_order = { 3, 1, 2, 0, 4 };
802
for( int a = 0; a < part_order.length; a++ )
803
if( name_parts.length > part_order[ a ] &&
804
name_parts[ part_order[ a ] ].length() > 0 )
806
// split this part in to it's comma-separated bits
807
String[] name_part_parts = splitValueByCharacter(
808
name_parts[ part_order[ a ] ], ',' );
809
for( int b = 0; b < name_part_parts.length; b++ )
810
if( name_part_parts[ b ].length() > 0 )
812
if( value.length() == 0 ) value += " ";
813
value += name_part_parts[ b ];
818
setName( unescapeValue( value ) );
747
819
_name_level = NAMELEVEL_N;
753
825
if( _name_level >= NAMELEVEL_FN ) return;
828
setName( unescapeValue( value ) );
757
829
_name_level = NAMELEVEL_FN;
760
832
private void parseORG( String[] params, String value )
763
String[] org_parts = splitValueBySemicolon( value );
835
String[] org_parts = splitValueByCharacter( value, ';' );
764
836
if( org_parts == null || org_parts.length < 1 ) return;
766
838
// build organisation name
768
840
String.valueOf( org_parts[ 0 ] ) );
769
841
for( int a = 1; a < org_parts.length; a++ )
770
842
builder.append( ", " ).append( org_parts[ a ] );
771
String organisation = builder.toString();
843
String organisation = unescapeValue( builder.toString() );
773
845
// set organisation name (using a title we've previously found)
774
846
addOrganisation( organisation, _cached_title, true );
817
891
if( types.contains( "FAX" ) )
818
892
if( types.contains( "HOME" ) )
819
type = PhonesColumns.TYPE_FAX_HOME;
893
type = TYPE_FAX_HOME;
821
type = PhonesColumns.TYPE_FAX_WORK;
895
type = TYPE_FAX_WORK;
822
896
else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
823
type = PhonesColumns.TYPE_MOBILE;
824
898
else if( types.contains( "PAGER" ) )
825
type = PhonesColumns.TYPE_PAGER;
826
900
else if( types.contains( "WORK" ) )
827
type = PhonesColumns.TYPE_WORK;
829
type = PhonesColumns.TYPE_HOME;
831
905
// add phone number
832
906
addNumber( value, type, is_preferred );
843
917
boolean is_preferred = types.contains( "PREF" );
845
919
if( types.contains( "WORK" ) )
846
type = Contacts.ContactMethods.TYPE_WORK;
848
type = Contacts.ContactMethods.TYPE_HOME;
850
addEmail( value, type, is_preferred );
924
addEmail( unescapeValue( value ), type, is_preferred );
853
927
private void parseADR( String[] params, String value )
855
929
// get address parts
856
String[] adr_parts = splitValueBySemicolon( value );
930
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 );
934
for( int a = 0; a < adr_parts.length; a++ )
935
if( adr_parts[ a ].length() > 0 )
937
// split this part in to it's comma-separated bits
938
String[] adr_part_parts =
939
splitValueByCharacter( adr_parts[ a ], ',' );
940
for( int b = 0; b < adr_part_parts.length; b++ )
941
if( adr_part_parts[ b ].length() > 0 )
943
if( value.length() > 0 ) value += "\n";
944
value += adr_part_parts[ b ];
948
Set< String > types = extractTypes( params, Arrays.asList(
949
"PREF", "WORK", "HOME" ) );
953
if( types.contains( "WORK" ) )
958
addAddress( unescapeValue( value ), type );
961
private void parseLABEL( String[] params, String value )
963
Set< String > types = extractTypes( params, Arrays.asList(
964
"PREF", "WORK", "HOME" ) );
968
if( types.contains( "WORK" ) )
973
addAddress( unescapeValue( value ), type );
976
private void parseNOTE( String[] params, String value )
978
addNote( unescapeValue( value ) );
878
981
public void finaliseVcard()
993
* Amongst the params, find the value of the first, only, of any with
997
* @return a value, or null
889
999
private String checkParam( String[] params, String name )
1001
String[] res = checkParams( params, name );
1002
return res.length > 0? res[ 0 ] : null;
1006
* Amongst the params, find the values of any with the specified name
1009
* @return an array of values, or null
1011
private String[] checkParams( String[] params, String name )
1013
HashSet< String > ret = new HashSet< String >();
891
1015
Pattern p = Pattern.compile(
892
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1016
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1017
Pattern.CASE_INSENSITIVE );
893
1018
for( int i = 0; i < params.length; i++ ) {
894
1019
Matcher m = p.matcher( params[ i ] );
895
1020
if( m.matches() )
1021
ret.add( m.group( 2 ) );
1024
return (String[]) ret.toArray( new String[ ret.size() ] );
1028
* Amongst the params, return any type values present. For v2.1 vCards,
1029
* those types are just parameters. For v3.0, they are prefixed with
1030
* "TYPE=". There may also be multiple type parameters.
1031
* @param params an array of params to look for types in
1032
* @param valid_types an list of upper-case type values to look for
1033
* @return a set of present type values
901
1035
private Set< String > extractTypes( String[] params,
902
1036
List< String > valid_types )
904
1038
HashSet< String > types = new HashSet< String >();
906
1040
// get 3.0-style TYPE= param
908
if( ( type_param = checkParam( params, "TYPE" ) ) != null ) {
909
String[] parts = type_param.split( "," );
1041
String type_params[] = checkParams( params, "TYPE" );
1042
for( int a = 0; a < type_params.length; a++ )
1044
// check for a comma-separated list of types (why? this isn't in
1046
String[] parts = type_params[ a ].split( "," );
1047
for( int i = 0; i < parts.length; i++ )
1048
parts[ i ] = parts[ i ].toUpperCase( Locale.US );
910
1049
for( int i = 0; i < parts.length; i++ )
911
1050
if( valid_types.contains( parts[ i ] ) )
912
1051
types.add( parts[ i ] );