/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/am/ed/importcontacts/VcardImporter.java

  • Committer: edam
  • Date: 2012-12-21 10:43:13 UTC
  • Revision ID: tim@ed.am-20121221104313-56z6pdon3oqtpllf
updated NEWS and TODO

Show diffs side-by-side

added added

removed removed

src/am/ed/importcontacts/VcardImporter.java
1
1
/*
2
2
 * VCFImporter.java
3
3
 *
4
 
 * Copyright (C) 2009 to 2011 Tim Marston <edam@waxworlds.org>
 
4
 * Copyright (C) 2009 to 2011 Tim Marston <tim@ed.am>
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://www.waxworlds.org/edam/software/android/import-contacts
 
8
 * http://ed.am/dev/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 org.waxworlds.edam.importcontacts;
 
24
package am.ed.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;
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;
46
47
 
 
48
import android.annotation.SuppressLint;
47
49
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" )
61
62
        @Override
62
63
        protected void onImport() throws AbortImportException
63
64
        {
82
83
                                // get files
83
84
                                class VCardFilter implements FilenameFilter {
84
85
                                        public boolean accept( File dir, String name ) {
85
 
                                                return name.toLowerCase().endsWith( ".vcf" );
 
86
                                                return name.toLowerCase( Locale.US ).endsWith( ".vcf" );
86
87
                                        }
87
88
                                }
88
89
                                files = file.listFiles( new VCardFilter() );
207
208
 
208
209
                        if( vcard == null ) {
209
210
                                // look for vcard beginning
210
 
                                if( line.matches( "^BEGIN:VCARD" ) ) {
 
211
                                if( line.matches( "^BEGIN[ \t]*:[ \t]*VCARD" ) ) {
211
212
                                        setProgress( _progress++ );
212
213
                                        vcard = new Vcard();
213
214
                                        vcard_start_line = cli.getLineNumber();
215
216
                        }
216
217
                        else {
217
218
                                // look for vcard content or ending
218
 
                                if( line.matches( "^END:VCARD" ) )
 
219
                                if( line.matches( "^END[ \t]*:[ \t]*VCARD" ) )
219
220
                                {
220
221
                                        // finalise the vcard/contact
221
222
                                        try {
350
351
                public boolean doesNextLineLookFolded()
351
352
                {
352
353
                        return _pos > 0 && _pos < _content.length &&
353
 
                                _content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
 
354
                                _content[ _pos - 1 ] == '\n' &&
 
355
                                ( _content[ _pos ] == ' ' || _content[ _pos ] == '\t' );
354
356
                }
355
357
 
356
358
                public int getLineNumber()
368
370
                private final static int MULTILINE_NONE = 0;
369
371
                private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
370
372
                private final static int MULTILINE_ESCAPED = 2; // v2.1 \\CRLF
371
 
                private final static int MULTILINE_FOLDED = 3;  // v3.0 folding
 
373
                private final static int MULTILINE_FOLDED = 3;  // MIME-DIR folding
372
374
 
373
375
                private String _version = null;
374
376
                private Vector< ByteBuffer > _buffers = null;
472
474
 
473
475
                                // is it a version line?
474
476
                                if( name_and_params != null &&
475
 
                                        name_and_params.equals( "VERSION" ) )
 
477
                                        name_and_params.equalsIgnoreCase( "VERSION" ) )
476
478
                                {
477
479
                                        // yes, get it!
478
480
                                        String value = extractValueFromLine( buffer, line );
568
570
 
569
571
                                // determine whether we care about this entry
570
572
                                final HashSet< String > interesting_fields =
571
 
                                        new HashSet< String >( Arrays.asList( new String[]
572
 
                                                { "N", "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR" }
 
573
                                        new HashSet< String >( Arrays.asList( new String[] { "N",
 
574
                                                "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
573
575
                                ) );
574
576
                                boolean is_interesting_field =
575
577
                                        interesting_fields.contains( name_param_parts[ 0 ] );
576
578
 
577
579
                                // parse encoding parameter
578
580
                                String encoding = checkParam( name_param_parts, "ENCODING" );
579
 
                                if( encoding != null ) encoding = encoding.toUpperCase();
 
581
                                if( encoding != null )
 
582
                                        encoding = encoding.toUpperCase( Locale.US );
580
583
                                if( is_interesting_field && encoding != null &&
581
 
                                        !encoding.equals( "8BIT" ) &&
582
 
                                        !encoding.equals( "QUOTED-PRINTABLE" ) )
583
 
                                        //&& !encoding.equals( "BASE64" ) )
 
584
                                        !encoding.equalsIgnoreCase( "8BIT" ) &&
 
585
                                        !encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
 
586
                                        //&& !encoding.equalsIgnoreCase( "BASE64" ) )
584
587
                                {
585
588
                                        throw new ParseException( R.string.error_vcf_encoding );
586
589
                                }
587
590
 
588
591
                                // parse charset parameter
589
592
                                String charset = checkParam( name_param_parts, "CHARSET" );
590
 
                                if( charset != null ) charset = charset.toUpperCase();
 
593
                                if( charset != null )
 
594
                                        charset = charset.toUpperCase( Locale.US );
591
595
                                if( charset != null &&
592
 
                                        !charset.equals( "US-ASCII" ) &&
593
 
                                        !charset.equals( "ASCII" ) &&
594
 
                                        !charset.equals( "UTF-8" ) )
 
596
                                        !charset.equalsIgnoreCase( "US-ASCII" ) &&
 
597
                                        !charset.equalsIgnoreCase( "ASCII" ) &&
 
598
                                        !charset.equalsIgnoreCase( "UTF-8" ) )
595
599
                                {
596
600
                                        throw new ParseException( R.string.error_vcf_charset );
597
601
                                }
599
603
                                // do unencoding (or default to a fake unencoding result with
600
604
                                // the raw string)
601
605
                                UnencodeResult unencoding_result = null;
602
 
                                if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
 
606
                                if( encoding != null &&
 
607
                                        encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
 
608
                                {
603
609
                                        unencoding_result = unencodeQuotedPrintable( value );
604
 
//                              else if( encoding != null && encoding.equals( "BASE64" ) )
 
610
                                }
 
611
//                              else if( encoding != null &&
 
612
//                                      encoding.equalsIgnoreCase( "BASE64" ) )
 
613
//                              {
605
614
//                                      unencoding_result = unencodeBase64( props[ 1 ], charset );
 
615
//                              }
606
616
                                if( unencoding_result != null ) {
607
617
                                        value = unencoding_result.getBuffer();
608
618
                                        if( unencoding_result.isAnotherLineRequired() )
613
623
                                // specified for a v2.1 vcard entry, we assume it's US-ASCII)
614
624
                                if( ( charset == null && _version.equals( "2.1" ) ) ||
615
625
                                        ( charset != null && (
616
 
                                                charset.equals( "ASCII" ) ||
617
 
                                                charset.equals( "US-ASCII" ) ) ) )
 
626
                                                charset.equalsIgnoreCase( "ASCII" ) ||
 
627
                                                charset.equalsIgnoreCase( "US-ASCII" ) ) ) )
618
628
                                {
619
629
                                        value = transcodeAsciiToUtf8( value );
620
630
                                }
631
641
                                // for some entries that have semicolon-separated value parts,
632
642
                                // check to see if the value ends in an escape character, which
633
643
                                // indicates that we have a multi-line value
634
 
                                if( ( name_param_parts[ 0 ].equals( "N" ) ||
635
 
                                        name_param_parts[ 0 ].equals( "ORG" ) ||
636
 
                                        name_param_parts[ 0 ].equals( "ADR" ) ) &&
 
644
                                if( ( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) ||
 
645
                                        name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) ||
 
646
                                        name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) ) &&
637
647
                                        doesStringEndInAnEscapeChar( string_value ) )
638
648
                                {
639
649
                                        _parser_multiline_state = MULTILINE_ESCAPED;
641
651
                                                string_value.length() - 1 );
642
652
                                }
643
653
 
644
 
                                // now we know whether we're in an encoding multi-line,
645
 
                                // determine if we're in a v3 folded multi-line or not
 
654
                                // if we know we're not in an encoding-based multi-line, check
 
655
                                // to see if we're in a folded multi-line
646
656
                                if( _parser_multiline_state == MULTILINE_NONE &&
647
 
                                        _version.equals( "3.0" ) && next_line_looks_folded )
 
657
                                        next_line_looks_folded )
648
658
                                {
649
659
                                        _parser_multiline_state = MULTILINE_FOLDED;
650
660
                                }
662
672
                                if( complete_value.length() < 1 ) return;
663
673
 
664
674
                                // parse some properties
665
 
                                if( name_param_parts[ 0 ].equals( "N" ) )
 
675
                                if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
666
676
                                        parseN( name_param_parts, complete_value );
667
 
                                else if( name_param_parts[ 0 ].equals( "FN" ) )
 
677
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
668
678
                                        parseFN( name_param_parts, complete_value );
669
 
                                else if( name_param_parts[ 0 ].equals( "ORG" ) )
 
679
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
670
680
                                        parseORG( name_param_parts, complete_value );
671
 
                                else if( name_param_parts[ 0 ].equals( "TITLE" ) )
 
681
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
672
682
                                        parseTITLE( name_param_parts, complete_value );
673
 
                                else if( name_param_parts[ 0 ].equals( "TEL" ) )
 
683
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
674
684
                                        parseTEL( name_param_parts, complete_value );
675
 
                                else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
 
685
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
676
686
                                        parseEMAIL( name_param_parts, complete_value );
677
 
                                else if( name_param_parts[ 0 ].equals( "ADR" ) )
 
687
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
678
688
                                        parseADR( name_param_parts, complete_value );
 
689
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "LABEL" ) )
 
690
                                        parseLABEL( name_param_parts, complete_value );
 
691
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
 
692
                                        parseNOTE( name_param_parts, complete_value );
679
693
                        }
680
694
                }
681
695
 
753
767
                                in_escape = false;
754
768
                                switch( c )
755
769
                                {
 
770
                                case 'T':
 
771
                                case 't':
 
772
                                        // add tab (invalid/non-standard, but accepted)
 
773
                                        ret.append( '\t' );
 
774
                                        break;
756
775
                                case 'N':
757
776
                                case 'n':
758
777
                                        // add newline
766
785
                                        break;
767
786
                                default:
768
787
                                        // unknown escape sequence, so add it unescaped
 
788
                                        // (invalid/non-standard, but accepted)
769
789
                                        ret.append( "\\" );
770
790
                                        ret.append( Character.toChars( c ) );
771
791
                                        break;
877
897
                        int type;
878
898
                        if( types.contains( "FAX" ) )
879
899
                                if( types.contains( "HOME" ) )
880
 
                                        type = PhonesColumns.TYPE_FAX_HOME;
 
900
                                        type = TYPE_FAX_HOME;
881
901
                                else
882
 
                                        type = PhonesColumns.TYPE_FAX_WORK;
 
902
                                        type = TYPE_FAX_WORK;
883
903
                        else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
884
 
                                type = PhonesColumns.TYPE_MOBILE;
 
904
                                type = TYPE_MOBILE;
885
905
                        else if( types.contains( "PAGER" ) )
886
 
                                type = PhonesColumns.TYPE_PAGER;
 
906
                                type = TYPE_PAGER;
887
907
                        else if( types.contains( "WORK" ) )
888
 
                                type = PhonesColumns.TYPE_WORK;
 
908
                                type = TYPE_WORK;
889
909
                        else
890
 
                                type = PhonesColumns.TYPE_HOME;
 
910
                                type = TYPE_HOME;
891
911
 
892
912
                        // add phone number
893
913
                        addNumber( value, type, is_preferred );
904
924
                        boolean is_preferred = types.contains( "PREF" );
905
925
                        int type;
906
926
                        if( types.contains( "WORK" ) )
907
 
                                type = Contacts.ContactMethods.TYPE_WORK;
 
927
                                type = TYPE_WORK;
908
928
                        else
909
 
                                type = Contacts.ContactMethods.TYPE_HOME;
 
929
                                type = TYPE_HOME;
910
930
 
911
931
                        addEmail( unescapeValue( value ), type, is_preferred );
912
932
                }
921
941
                        for( int a = 0; a < adr_parts.length; a++ )
922
942
                                if( adr_parts[ a ].length() > 0 )
923
943
                                {
924
 
                                        // split this part in to it's comma-separated bits
925
 
                                        String[] adr_part_parts =
926
 
                                                splitValueByCharacter( adr_parts[ a ], ',' );
927
 
                                        for( int b = 0; b < adr_part_parts.length; b++ )
928
 
                                                if( adr_part_parts[ b ].length() > 0 )
929
 
                                                {
930
 
                                                        if( value.length() > 0 ) value += "\n";
931
 
                                                        value += adr_part_parts[ b ];
932
 
                                                }
 
944
                                        // version 3.0 vCards allow further splitting by comma
 
945
                                        if( _version.equals( "3.0" ) )
 
946
                                        {
 
947
                                                // split this part in to it's comma-separated bits and
 
948
                                                // add them on individual lines
 
949
                                                String[] adr_part_parts =
 
950
                                                        splitValueByCharacter( adr_parts[ a ], ',' );
 
951
                                                for( int b = 0; b < adr_part_parts.length; b++ )
 
952
                                                        if( adr_part_parts[ b ].length() > 0 )
 
953
                                                        {
 
954
                                                                if( value.length() > 0 ) value += "\n";
 
955
                                                                value += adr_part_parts[ b ];
 
956
                                                        }
 
957
                                        }
 
958
                                        else
 
959
                                        {
 
960
                                                // add this part on an individual line
 
961
                                                if( value.length() > 0 ) value += "\n";
 
962
                                                value += adr_parts[ a ];
 
963
                                        }
933
964
                                }
934
965
 
935
966
                        Set< String > types = extractTypes( params, Arrays.asList(
936
 
                                "PREF", "WORK", "HOME", "INTERNET" ) );
937
 
 
938
 
                        // add address
939
 
                        int type;
940
 
                        if( types.contains( "WORK" ) )
941
 
                                type = Contacts.ContactMethods.TYPE_WORK;
942
 
                        else
943
 
                                type = Contacts.ContactMethods.TYPE_HOME;
944
 
 
945
 
                        addAddress( unescapeValue( value ), type );
 
967
                                "PREF", "WORK", "HOME" ) );
 
968
 
 
969
                        // add address
 
970
                        int type;
 
971
                        if( types.contains( "WORK" ) )
 
972
                                type = TYPE_WORK;
 
973
                        else
 
974
                                type = TYPE_HOME;
 
975
 
 
976
                        addAddress( unescapeValue( value ), type );
 
977
                }
 
978
 
 
979
                private void parseLABEL( String[] params, String value )
 
980
                {
 
981
                        Set< String > types = extractTypes( params, Arrays.asList(
 
982
                                "PREF", "WORK", "HOME" ) );
 
983
 
 
984
                        // add address
 
985
                        int type;
 
986
                        if( types.contains( "WORK" ) )
 
987
                                type = TYPE_WORK;
 
988
                        else
 
989
                                type = TYPE_HOME;
 
990
 
 
991
                        addAddress( unescapeValue( value ), type );
 
992
                }
 
993
 
 
994
                private void parseNOTE( String[] params, String value )
 
995
                {
 
996
                        addNote( unescapeValue( value ) );
946
997
                }
947
998
 
948
999
                public void finaliseVcard()
980
1031
                        HashSet< String > ret = new HashSet< String >();
981
1032
 
982
1033
                        Pattern p = Pattern.compile(
983
 
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
 
1034
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
 
1035
                                Pattern.CASE_INSENSITIVE );
984
1036
                        for( int i = 0; i < params.length; i++ ) {
985
1037
                                Matcher m = p.matcher( params[ i ] );
986
1038
                                if( m.matches() )
994
1046
                 * Amongst the params, return any type values present. For v2.1 vCards,
995
1047
                 * those types are just parameters. For v3.0, they are prefixed with
996
1048
                 * "TYPE=". There may also be multiple type parameters.
997
 
                 * @param params
998
 
                 * @param a list of type values to look for
 
1049
                 * @param params an array of params to look for types in
 
1050
                 * @param valid_types an list of upper-case type values to look for
999
1051
                 * @return a set of present type values
1000
1052
                 */
1001
1053
                private Set< String > extractTypes( String[] params,
1011
1063
                                // the specs!)
1012
1064
                                String[] parts = type_params[ a ].split( "," );
1013
1065
                                for( int i = 0; i < parts.length; i++ )
 
1066
                                        parts[ i ] = parts[ i ].toUpperCase( Locale.US );
 
1067
                                for( int i = 0; i < parts.length; i++ )
1014
1068
                                        if( valid_types.contains( parts[ i ] ) )
1015
1069
                                                types.add( parts[ i ] );
1016
1070
                        }