/android/import-contacts

To get this branch, use:
bzr branch http://bzr.ed.am/android/import-contacts

« back to all changes in this revision

Viewing changes to src/org/waxworlds/edam/importcontacts/VcardImporter.java

  • Committer: edam
  • Date: 2011-05-30 19:20:17 UTC
  • Revision ID: edam@waxworlds.org-20110530192017-5c09k4kgpov02gja
- added checks for Doit.this == null when handling dialog buttons (I managed to abort an import as a duplicate contacts dialog was shown, but can't reproduce it now)
- added line no.s to vcard parsing errors
- update progress bar after a contact is imported, not before
- fixed bug introduced in last commit where a contacts were imported after finaliseVcard()ing failed
- don't show unknown encoding errors for vcard fields that we don't care about (which ignores base64 encoded photos, for example)

Show diffs side-by-side

added added

removed removed

src/org/waxworlds/edam/importcontacts/VcardImporter.java
1
1
/*
2
2
 * VCFImporter.java
3
3
 *
4
 
 * Copyright (C) 2009 to 2011 Tim Marston <tim@ed.am>
 
4
 * Copyright (C) 2009 to 2011 Tim Marston <edam@waxworlds.org>
5
5
 *
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://ed.am/dev/android/import-contacts
 
8
 * http://www.waxworlds.org/edam/software/android/import-contacts
9
9
 *
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
21
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
22
 */
23
23
 
24
 
package am.ed.importcontacts;
 
24
package org.waxworlds.edam.importcontacts;
25
25
 
26
26
import java.io.BufferedReader;
27
27
import java.io.File;
38
38
import java.util.HashSet;
39
39
import java.util.Iterator;
40
40
import java.util.List;
41
 
import java.util.Locale;
42
41
import java.util.NoSuchElementException;
43
42
import java.util.Set;
44
43
import java.util.Vector;
45
44
import java.util.regex.Matcher;
46
45
import java.util.regex.Pattern;
47
46
 
48
 
import android.annotation.SuppressLint;
49
47
import android.content.SharedPreferences;
 
48
import android.provider.Contacts;
 
49
import android.provider.Contacts.PhonesColumns;
50
50
 
51
51
public class VcardImporter extends Importer
52
52
{
58
58
                super( doit );
59
59
        }
60
60
 
61
 
        @SuppressLint( "SdCardPath" )
62
61
        @Override
63
62
        protected void onImport() throws AbortImportException
64
63
        {
83
82
                                // get files
84
83
                                class VCardFilter implements FilenameFilter {
85
84
                                        public boolean accept( File dir, String name ) {
86
 
                                                return name.toLowerCase( Locale.US ).endsWith( ".vcf" );
 
85
                                                return name.toLowerCase().endsWith( ".vcf" );
87
86
                                        }
88
87
                                }
89
88
                                files = file.listFiles( new VCardFilter() );
363
362
        private class Vcard extends ContactData
364
363
        {
365
364
                private final static int NAMELEVEL_NONE = 0;
366
 
                private final static int NAMELEVEL_N = 1;
367
 
                private final static int NAMELEVEL_FN = 2;
 
365
                private final static int NAMELEVEL_FN = 1;
 
366
                private final static int NAMELEVEL_N = 2;
368
367
 
369
368
                private final static int MULTILINE_NONE = 0;
370
369
                private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
569
568
 
570
569
                                // determine whether we care about this entry
571
570
                                final HashSet< String > interesting_fields =
572
 
                                        new HashSet< String >( Arrays.asList( new String[] { "N",
573
 
                                                "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
 
571
                                        new HashSet< String >( Arrays.asList( new String[]
 
572
                                                { "N", "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR" }
574
573
                                ) );
575
574
                                boolean is_interesting_field =
576
575
                                        interesting_fields.contains( name_param_parts[ 0 ] );
577
576
 
578
577
                                // parse encoding parameter
579
578
                                String encoding = checkParam( name_param_parts, "ENCODING" );
580
 
                                if( encoding != null )
581
 
                                        encoding = encoding.toUpperCase( Locale.US );
 
579
                                if( encoding != null ) encoding = encoding.toUpperCase();
582
580
                                if( is_interesting_field && encoding != null &&
583
581
                                        !encoding.equals( "8BIT" ) &&
584
582
                                        !encoding.equals( "QUOTED-PRINTABLE" ) )
589
587
 
590
588
                                // parse charset parameter
591
589
                                String charset = checkParam( name_param_parts, "CHARSET" );
592
 
                                if( charset != null )
593
 
                                        charset = charset.toUpperCase( Locale.US );
 
590
                                if( charset != null ) charset = charset.toUpperCase();
594
591
                                if( charset != null &&
595
592
                                        !charset.equals( "US-ASCII" ) &&
596
593
                                        !charset.equals( "ASCII" ) &&
612
609
                                                _parser_multiline_state = MULTILINE_ENCODED;
613
610
                                }
614
611
 
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" ) ) ) )
621
 
                                {
 
612
                                // convert 8-bit ASCII charset to US-ASCII
 
613
                                if( charset == null || charset.equals( "ASCII" ) ) {
622
614
                                        value = transcodeAsciiToUtf8( value );
 
615
                                        charset = "UTF-8";
623
616
                                }
624
617
 
625
 
                                // process charset (value is now in UTF-8)
 
618
                                // process charset
626
619
                                String string_value;
627
620
                                try {
628
621
                                        string_value = new String( value.array(), value.position(),
629
 
                                                value.limit() - value.position(), "UTF-8" );
 
622
                                                value.limit() - value.position(), charset );
630
623
                                } catch( UnsupportedEncodingException e ) {
631
624
                                        throw new ParseException( R.string.error_vcf_charset );
632
625
                                }
679
672
                                        parseEMAIL( name_param_parts, complete_value );
680
673
                                else if( name_param_parts[ 0 ].equals( "ADR" ) )
681
674
                                        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 );
686
675
                        }
687
676
                }
688
677
 
701
690
                        return ( count & 1 ) == 1;
702
691
                }
703
692
 
704
 
                private String[] splitValueByCharacter( String value, char character )
 
693
                private String[] splitValueBySemicolon( String value )
705
694
                {
706
 
                        // split string in to parts by specified character
 
695
                        // split string in to parts by semicolon
707
696
                        ArrayList< String > parts = new ArrayList< String >(
708
 
                                Arrays.asList( value.split( "" + character ) ) );
 
697
                                Arrays.asList( value.split(  ";" ) ) );
709
698
 
710
699
                        // go through parts
711
700
                        for( int a = 0; a < parts.size(); a++ )
719
708
                                if( a < parts.size() - 1 &&
720
709
                                        doesStringEndInAnEscapeChar( str ) )
721
710
                                {
722
 
                                        // append the escaped character, join the next part to this
723
 
                                        // part and remove the next part
 
711
                                        // join the next part to this part and remove the next part
724
712
                                        parts.set( a, str.substring( 0, str.length() - 1 ) +
725
 
                                                character + parts.get( a + 1 ) );
 
713
                                                ';' + parts.get( a + 1 ) );
726
714
                                        parts.remove( a + 1 );
727
715
 
728
716
                                        // re-visit this part
739
727
                        return parts.toArray( ret );
740
728
                }
741
729
 
742
 
                private String unescapeValue( String value )
743
 
                {
744
 
                        StringBuilder ret = new StringBuilder( value.length() );
745
 
                        boolean in_escape = false;
746
 
                        for( int a = 0; a < value.length(); a++ )
747
 
                        {
748
 
                                int c = value.codePointAt( a );
749
 
 
750
 
                                // process a normal character
751
 
                                if( !in_escape ) {
752
 
                                        if( c == '\\' )
753
 
                                                in_escape = true;
754
 
                                        else
755
 
                                                ret.append( Character.toChars( c ) );
756
 
                                        continue;
757
 
                                }
758
 
 
759
 
                                // process an escape sequence
760
 
                                in_escape = false;
761
 
                                switch( c )
762
 
                                {
763
 
                                case 'T':
764
 
                                case 't':
765
 
                                        // add tab (invalid/non-standard, but accepted)
766
 
                                        ret.append( '\t' );
767
 
                                        break;
768
 
                                case 'N':
769
 
                                case 'n':
770
 
                                        // add newline
771
 
                                        ret.append( '\n' );
772
 
                                        break;
773
 
                                case '\\':
774
 
                                case ',':
775
 
                                case ';':
776
 
                                        // add escaped character
777
 
                                        ret.append( Character.toChars( c ) );
778
 
                                        break;
779
 
                                default:
780
 
                                        // unknown escape sequence, so add it unescaped
781
 
                                        // (invalid/non-standard, but accepted)
782
 
                                        ret.append( "\\" );
783
 
                                        ret.append( Character.toChars( c ) );
784
 
                                        break;
785
 
                                }
786
 
                        }
787
 
 
788
 
                        return ret.toString();
789
 
                }
790
 
 
791
730
                private void parseN( String[] params, String value )
792
731
                {
793
732
                        // already got a better name?
794
733
                        if( _name_level >= NAMELEVEL_N ) return;
795
734
 
796
735
                        // get name parts
797
 
                        String[] name_parts = splitValueByCharacter( value, ';' );
 
736
                        String[] name_parts = splitValueBySemicolon( value );
798
737
 
799
738
                        // build name
800
739
                        value = "";
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 )
805
 
                                {
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 )
811
 
                                                {
812
 
                                                        if( value.length() == 0 ) value += " ";
813
 
                                                        value += name_part_parts[ b ];
814
 
                                                }
815
 
                                }
 
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 ];
816
744
 
817
745
                        // set name
818
 
                        setName( unescapeValue( value ) );
 
746
                        setName( value );
819
747
                        _name_level = NAMELEVEL_N;
820
748
                }
821
749
 
825
753
                        if( _name_level >= NAMELEVEL_FN ) return;
826
754
 
827
755
                        // set name
828
 
                        setName( unescapeValue( value ) );
 
756
                        setName( value );
829
757
                        _name_level = NAMELEVEL_FN;
830
758
                }
831
759
 
832
760
                private void parseORG( String[] params, String value )
833
761
                {
834
762
                        // get org parts
835
 
                        String[] org_parts = splitValueByCharacter( value, ';' );
 
763
                        String[] org_parts = splitValueBySemicolon( value );
836
764
                        if( org_parts == null || org_parts.length < 1 ) return;
837
765
 
838
766
                        // build organisation name
840
768
                                String.valueOf( org_parts[ 0 ] ) );
841
769
                        for( int a = 1; a < org_parts.length; a++ )
842
770
                                builder.append( ", " ).append( org_parts[ a ] );
843
 
                        String organisation = unescapeValue( builder.toString() );
 
771
                        String organisation = builder.toString();
844
772
 
845
773
                        // set organisation name (using a title we've previously found)
846
774
                        addOrganisation( organisation, _cached_title, true );
857
785
 
858
786
                private void parseTITLE( String[] params, String value )
859
787
                {
860
 
                        value = unescapeValue( value );
861
 
 
862
788
                        // if we previously had an organisation, look it up and append this
863
789
                        // title to it
864
790
                        if( _cached_organisation != null && hasOrganisations() ) {
890
816
                        int type;
891
817
                        if( types.contains( "FAX" ) )
892
818
                                if( types.contains( "HOME" ) )
893
 
                                        type = TYPE_FAX_HOME;
 
819
                                        type = PhonesColumns.TYPE_FAX_HOME;
894
820
                                else
895
 
                                        type = TYPE_FAX_WORK;
 
821
                                        type = PhonesColumns.TYPE_FAX_WORK;
896
822
                        else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
897
 
                                type = TYPE_MOBILE;
 
823
                                type = PhonesColumns.TYPE_MOBILE;
898
824
                        else if( types.contains( "PAGER" ) )
899
 
                                type = TYPE_PAGER;
 
825
                                type = PhonesColumns.TYPE_PAGER;
900
826
                        else if( types.contains( "WORK" ) )
901
 
                                type = TYPE_WORK;
 
827
                                type = PhonesColumns.TYPE_WORK;
902
828
                        else
903
 
                                type = TYPE_HOME;
 
829
                                type = PhonesColumns.TYPE_HOME;
904
830
 
905
831
                        // add phone number
906
832
                        addNumber( value, type, is_preferred );
917
843
                        boolean is_preferred = types.contains( "PREF" );
918
844
                        int type;
919
845
                        if( types.contains( "WORK" ) )
920
 
                                type = TYPE_WORK;
 
846
                                type = Contacts.ContactMethods.TYPE_WORK;
921
847
                        else
922
 
                                type = TYPE_HOME;
 
848
                                type = Contacts.ContactMethods.TYPE_HOME;
923
849
 
924
 
                        addEmail( unescapeValue( value ), type, is_preferred );
 
850
                        addEmail( value, type, is_preferred );
925
851
                }
926
852
 
927
853
                private void parseADR( String[] params, String value )
928
854
                {
929
855
                        // get address parts
930
 
                        String[] adr_parts = splitValueByCharacter( value, ';' );
 
856
                        String[] adr_parts = splitValueBySemicolon( value );
931
857
 
932
858
                        // build address
933
859
                        value = "";
934
 
                        for( int a = 0; a < adr_parts.length; a++ )
935
 
                                if( adr_parts[ a ].length() > 0 )
936
 
                                {
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 )
942
 
                                                {
943
 
                                                        if( value.length() > 0 ) value += "\n";
944
 
                                                        value += adr_part_parts[ b ];
945
 
                                                }
946
 
                                }
947
 
 
948
 
                        Set< String > types = extractTypes( params, Arrays.asList(
949
 
                                "PREF", "WORK", "HOME" ) );
950
 
 
951
 
                        // add address
952
 
                        int type;
953
 
                        if( types.contains( "WORK" ) )
954
 
                                type = TYPE_WORK;
955
 
                        else
956
 
                                type = TYPE_HOME;
957
 
 
958
 
                        addAddress( unescapeValue( value ), type );
959
 
                }
960
 
 
961
 
                private void parseLABEL( String[] params, String value )
962
 
                {
963
 
                        Set< String > types = extractTypes( params, Arrays.asList(
964
 
                                "PREF", "WORK", "HOME" ) );
965
 
 
966
 
                        // add address
967
 
                        int type;
968
 
                        if( types.contains( "WORK" ) )
969
 
                                type = TYPE_WORK;
970
 
                        else
971
 
                                type = TYPE_HOME;
972
 
 
973
 
                        addAddress( unescapeValue( value ), type );
974
 
                }
975
 
 
976
 
                private void parseNOTE( String[] params, String value )
977
 
                {
978
 
                        addNote( unescapeValue( value ) );
 
860
                        for( int a = 0; a < adr_parts.length; a++ ) {
 
861
                                if( value.length() > 0 ) value += "\n";
 
862
                                value += adr_parts[ a ].trim();
 
863
                        }
 
864
 
 
865
                        Set< String > types = extractTypes( params, Arrays.asList(
 
866
                                "PREF", "WORK", "HOME", "INTERNET" ) );
 
867
 
 
868
                        // add address
 
869
                        int type;
 
870
                        if( types.contains( "WORK" ) )
 
871
                                type = Contacts.ContactMethods.TYPE_WORK;
 
872
                        else
 
873
                                type = Contacts.ContactMethods.TYPE_HOME;
 
874
 
 
875
                        addAddress( value, type );
979
876
                }
980
877
 
981
878
                public void finaliseVcard()
989
886
                        finalise();
990
887
                }
991
888
 
992
 
                /**
993
 
                 * Amongst the params, find the value of the first, only, of any with
994
 
                 * the specified name
995
 
                 * @param params
996
 
                 * @param name
997
 
                 * @return a value, or null
998
 
                 */
999
889
                private String checkParam( String[] params, String name )
1000
890
                {
1001
 
                        String[] res = checkParams( params, name );
1002
 
                        return res.length > 0? res[ 0 ] : null;
1003
 
                }
1004
 
 
1005
 
                /**
1006
 
                 * Amongst the params, find the values of any with the specified name
1007
 
                 * @param params
1008
 
                 * @param name
1009
 
                 * @return an array of values, or null
1010
 
                 */
1011
 
                private String[] checkParams( String[] params, String name )
1012
 
                {
1013
 
                        HashSet< String > ret = new HashSet< String >();
1014
 
 
1015
891
                        Pattern p = Pattern.compile(
1016
 
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1017
 
                                Pattern.CASE_INSENSITIVE );
 
892
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1018
893
                        for( int i = 0; i < params.length; i++ ) {
1019
894
                                Matcher m = p.matcher( params[ i ] );
1020
895
                                if( m.matches() )
1021
 
                                        ret.add( m.group( 2 ) );
 
896
                                        return m.group( 2 );
1022
897
                        }
1023
 
 
1024
 
                        return (String[]) ret.toArray( new String[ ret.size() ] );
 
898
                        return null;
1025
899
                }
1026
900
 
1027
 
                /**
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
1034
 
                 */
1035
901
                private Set< String > extractTypes( String[] params,
1036
902
                        List< String > valid_types )
1037
903
                {
1038
904
                        HashSet< String > types = new HashSet< String >();
1039
905
 
1040
906
                        // get 3.0-style TYPE= param
1041
 
                        String type_params[] = checkParams( params, "TYPE" );
1042
 
                        for( int a = 0; a < type_params.length; a++ )
1043
 
                        {
1044
 
                                // check for a comma-separated list of types (why? this isn't in
1045
 
                                // the specs!)
1046
 
                                String[] parts = type_params[ a ].split( "," );
1047
 
                                for( int i = 0; i < parts.length; i++ )
1048
 
                                        parts[ i ] = parts[ i ].toUpperCase( Locale.US );
 
907
                        String type_param;
 
908
                        if( ( type_param = checkParam( params, "TYPE" ) ) != null ) {
 
909
                                String[] parts = type_param.split( "," );
1049
910
                                for( int i = 0; i < parts.length; i++ )
1050
911
                                        if( valid_types.contains( parts[ i ] ) )
1051
912
                                                types.add( parts[ i ] );