/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/VCFImporter.java

  • Committer: edam
  • Date: 2011-05-05 21:49:43 UTC
  • Revision ID: edam@waxworlds.org-20110505214943-bg0cn6qz0gr49dlk
- updated TODO
- made varibale names consistent (camelCaseVariables now_use_underscores)

Show diffs side-by-side

added added

removed removed

48
48
import android.provider.Contacts;
49
49
import android.provider.Contacts.PhonesColumns;
50
50
 
51
 
public class VcardImporter extends Importer
 
51
public class VCFImporter extends Importer
52
52
{
53
53
        private int _vcard_count = 0;
54
54
        private int _progress = 0;
55
55
 
56
 
        public VcardImporter( Doit doit )
 
56
        public VCFImporter( Doit doit )
57
57
        {
58
58
                super( doit );
59
59
        }
116
116
                setProgress( 0 );
117
117
                for( int i = 0; i < files.length; i++ )
118
118
                        importVCardFile( files[ i ] );
119
 
                setProgress( _vcard_count );
120
119
        }
121
120
 
122
121
        private void countVCardFile( File file ) throws AbortImportException
169
168
                        FileInputStream istream = new FileInputStream( file );
170
169
                        byte[] content = new byte[ (int)file.length() ];
171
170
                        istream.read( content );
172
 
                        istream = null;
173
171
 
174
172
                        // import
175
173
                        importVCardFileContent( content, file.getName() );
187
185
                throws AbortImportException
188
186
        {
189
187
                // go through lines
190
 
                Vcard vcard = null;
191
 
                int vcard_start_line = 0;
 
188
                VCard vcard = null;
192
189
                ContentLineIterator cli = new ContentLineIterator( content );
193
190
                while( cli.hasNext() )
194
191
                {
208
205
                        if( vcard == null ) {
209
206
                                // look for vcard beginning
210
207
                                if( line.matches( "^BEGIN:VCARD" ) ) {
211
 
                                        setProgress( _progress++ );
212
 
                                        vcard = new Vcard();
213
 
                                        vcard_start_line = cli.getLineNumber();
 
208
                                        setProgress( ++_progress );
 
209
                                        vcard = new VCard();
214
210
                                }
215
211
                        }
216
212
                        else {
217
213
                                // look for vcard content or ending
218
214
                                if( line.matches( "^END:VCARD" ) )
219
215
                                {
220
 
                                        // finalise the vcard/contact
 
216
                                        // store vcard and do away with it
221
217
                                        try {
222
 
                                                vcard.finaliseVcard();
223
 
 
224
 
                                                // pass the finalised contact to the importer
 
218
                                                vcard.finaliseParsing();
225
219
                                                importContact( vcard );
226
220
                                        }
227
 
                                        catch( Vcard.ParseException e ) {
228
 
                                                if( !showContinue(
229
 
                                                        getText( R.string.error_vcf_parse ).toString()
230
 
                                                        + fileName +
231
 
                                                        getText( R.string.error_vcf_parse_line ).toString()
232
 
                                                        + cli.getLineNumber() + ":\n" + e.getMessage() ) )
233
 
                                                {
234
 
                                                        finish( ACTION_ABORT );
235
 
                                                }
236
 
                                                else
237
 
                                                        skipContact();
238
 
                                        }
239
 
                                        catch( ContactData.ContactNotIdentifiableException e ) {
240
 
                                                if( !showContinue(
241
 
                                                        getText( R.string.error_vcf_parse ).toString()
242
 
                                                        + fileName +
243
 
                                                        getText( R.string.error_vcf_parse_line ).toString()
244
 
                                                        + vcard_start_line + ":\n" + getText(
245
 
                                                                R.string.error_vcf_notenoughinfo ).toString()
246
 
                                                ) )
247
 
                                                {
248
 
                                                        finish( ACTION_ABORT );
249
 
                                                }
250
 
                                                else
251
 
                                                        skipContact();
252
 
                                        }
253
 
 
254
 
                                        // discard this vcard
 
221
                                        catch( VCard.ParseException e ) {
 
222
                                                skipContact();
 
223
                                                if( !showContinue(
 
224
                                                        getText( R.string.error_vcf_parse ).toString()
 
225
                                                        + fileName + "\n" + e.getMessage() ) )
 
226
                                                {
 
227
                                                        finish( ACTION_ABORT );
 
228
                                                }
 
229
                                        }
 
230
                                        catch( VCard.SkipContactException e ) {
 
231
                                                skipContact();
 
232
                                                // do nothing
 
233
                                        }
255
234
                                        vcard = null;
256
235
                                }
257
236
                                else
261
240
                                                vcard.parseLine( buffer, line,
262
241
                                                        cli.doesNextLineLookFolded() );
263
242
                                        }
264
 
                                        catch( Vcard.ParseException e ) {
 
243
                                        catch( VCard.ParseException e ) {
265
244
                                                skipContact();
266
245
                                                if( !showContinue(
267
246
                                                        getText( R.string.error_vcf_parse ).toString()
268
 
                                                        + fileName +
269
 
                                                        getText( R.string.error_vcf_parse_line ).toString()
270
 
                                                        + cli.getLineNumber() + "\n" + e.getMessage() ) )
 
247
                                                        + fileName + "\n" + e.getMessage() ) )
271
248
                                                {
272
249
                                                        finish( ACTION_ABORT );
273
250
                                                }
277
254
                                                // get to another BEGIN:VCARD line.
278
255
                                                vcard = null;
279
256
                                        }
280
 
                                        catch( Vcard.SkipImportException e ) {
 
257
                                        catch( VCard.SkipContactException e ) {
281
258
                                                skipContact();
282
259
                                                // abort this vCard. Further lines will be ignored until
283
260
                                                // we get to another BEGIN:VCARD line.
292
269
        {
293
270
                protected byte[] _content = null;
294
271
                protected int _pos = 0;
295
 
                protected int _line = 0;
296
272
 
297
273
                public ContentLineIterator( byte[] content )
298
274
                {
318
294
                                        int to = ( _pos > 0 && _content[ _pos - 1 ] == '\r' &&
319
295
                                                _pos > initial_pos )? _pos - 1 : _pos;
320
296
                                        _pos++;
321
 
                                        _line++;
322
297
                                        return ByteBuffer.wrap( _content, initial_pos,
323
298
                                                to - initial_pos );
324
299
                                }
327
302
                        if( _pos != initial_pos ) {
328
303
                                int to = _pos;
329
304
                                _pos++;
330
 
                                _line++;
331
305
                                return ByteBuffer.wrap( _content, initial_pos,
332
306
                                        to - initial_pos );
333
307
                        }
352
326
                        return _pos > 0 && _pos < _content.length &&
353
327
                                _content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
354
328
                }
355
 
 
356
 
                public int getLineNumber()
357
 
                {
358
 
                        return _line;
359
 
                }
360
329
        }
361
330
 
362
 
        private class Vcard extends ContactData
 
331
        private class VCard extends ContactData
363
332
        {
364
333
                private final static int NAMELEVEL_NONE = 0;
365
 
                private final static int NAMELEVEL_N = 1;
366
 
                private final static int NAMELEVEL_FN = 2;
 
334
                private final static int NAMELEVEL_FN = 1;
 
335
                private final static int NAMELEVEL_N = 2;
367
336
 
368
337
                private final static int MULTILINE_NONE = 0;
369
338
                private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
413
382
 
414
383
                        public ParseException( int res )
415
384
                        {
416
 
                                super( VcardImporter.this.getText( res ).toString() );
 
385
                                super( VCFImporter.this.getText( res ).toString() );
417
386
                        }
418
387
                }
419
388
 
420
389
                @SuppressWarnings("serial")
421
 
                protected class SkipImportException extends Exception { }
 
390
                protected class SkipContactException extends Exception { }
422
391
 
423
392
                private String extractCollonPartFromLine( ByteBuffer buffer,
424
393
                        String line, boolean former )
460
429
 
461
430
                public void parseLine( ByteBuffer buffer, String line,
462
431
                        boolean next_line_looks_folded )
463
 
                        throws ParseException, SkipImportException,
 
432
                        throws ParseException, SkipContactException,
464
433
                        AbortImportException
465
434
                {
466
435
                        // do we have a version yet?
566
535
                                for( int i = 0; i < name_param_parts.length; i++ )
567
536
                                        name_param_parts[ i ] = name_param_parts[ i ].trim();
568
537
 
569
 
                                // determine whether we care about this entry
570
 
                                final HashSet< String > interesting_fields =
571
 
                                        new HashSet< String >( Arrays.asList( new String[]
572
 
                                                { "N", "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR" }
573
 
                                ) );
574
 
                                boolean is_interesting_field =
575
 
                                        interesting_fields.contains( name_param_parts[ 0 ] );
576
 
 
577
538
                                // parse encoding parameter
578
539
                                String encoding = checkParam( name_param_parts, "ENCODING" );
579
540
                                if( encoding != null ) encoding = encoding.toUpperCase();
580
 
                                if( is_interesting_field && encoding != null &&
581
 
                                        !encoding.equals( "8BIT" ) &&
 
541
                                if( encoding != null && !encoding.equals( "8BIT" ) &&
582
542
                                        !encoding.equals( "QUOTED-PRINTABLE" ) )
583
543
                                        //&& !encoding.equals( "BASE64" ) )
584
544
                                {
588
548
                                // parse charset parameter
589
549
                                String charset = checkParam( name_param_parts, "CHARSET" );
590
550
                                if( charset != null ) charset = charset.toUpperCase();
591
 
                                if( charset != null &&
592
 
                                        !charset.equals( "US-ASCII" ) &&
 
551
                                if( charset != null && !charset.equals( "US-ASCII" ) &&
593
552
                                        !charset.equals( "ASCII" ) &&
594
553
                                        !charset.equals( "UTF-8" ) )
595
554
                                {
609
568
                                                _parser_multiline_state = MULTILINE_ENCODED;
610
569
                                }
611
570
 
612
 
                                // convert 8-bit US-ASCII charset to UTF-8 (where no charset is
613
 
                                // specified for a v2.1 vcard entry, we assume it's US-ASCII)
614
 
                                if( ( charset == null && _version.equals( "2.1" ) ) ||
615
 
                                        ( charset != null && (
616
 
                                                charset.equals( "ASCII" ) ||
617
 
                                                charset.equals( "US-ASCII" ) ) ) )
618
 
                                {
 
571
                                // convert 8-bit ASCII charset to US-ASCII
 
572
                                if( charset == null || charset.equals( "ASCII" ) ) {
619
573
                                        value = transcodeAsciiToUtf8( value );
 
574
                                        charset = "UTF-8";
620
575
                                }
621
576
 
622
 
                                // process charset (value is now in UTF-8)
 
577
                                // process charset
623
578
                                String string_value;
624
579
                                try {
625
580
                                        string_value = new String( value.array(), value.position(),
626
 
                                                value.limit() - value.position(), "UTF-8" );
 
581
                                                value.limit() - value.position(), charset );
627
582
                                } catch( UnsupportedEncodingException e ) {
628
583
                                        throw new ParseException( R.string.error_vcf_charset );
629
584
                                }
694
649
                        return ( count & 1 ) == 1;
695
650
                }
696
651
 
697
 
                private String[] splitValueByCharacter( String value, char character )
 
652
                private String[] splitValueBySemicolon( String value )
698
653
                {
699
 
                        // split string in to parts by specified character
 
654
                        // split string in to parts by semicolon
700
655
                        ArrayList< String > parts = new ArrayList< String >(
701
 
                                Arrays.asList( value.split( "" + character ) ) );
 
656
                                Arrays.asList( value.split(  ";" ) ) );
702
657
 
703
658
                        // go through parts
704
659
                        for( int a = 0; a < parts.size(); a++ )
712
667
                                if( a < parts.size() - 1 &&
713
668
                                        doesStringEndInAnEscapeChar( str ) )
714
669
                                {
715
 
                                        // append the escaped character, join the next part to this
716
 
                                        // part and remove the next part
 
670
                                        // join the next part to this part and remove the next part
717
671
                                        parts.set( a, str.substring( 0, str.length() - 1 ) +
718
 
                                                character + parts.get( a + 1 ) );
 
672
                                                ';' + parts.get( a + 1 ) );
719
673
                                        parts.remove( a + 1 );
720
674
 
721
675
                                        // re-visit this part
732
686
                        return parts.toArray( ret );
733
687
                }
734
688
 
735
 
                private String unescapeValue( String value )
736
 
                {
737
 
                        StringBuilder ret = new StringBuilder( value.length() );
738
 
                        boolean in_escape = false;
739
 
                        for( int a = 0; a < value.length(); a++ )
740
 
                        {
741
 
                                int c = value.codePointAt( a );
742
 
 
743
 
                                // process a normal character
744
 
                                if( !in_escape ) {
745
 
                                        if( c == '\\' )
746
 
                                                in_escape = true;
747
 
                                        else
748
 
                                                ret.append( Character.toChars( c ) );
749
 
                                        continue;
750
 
                                }
751
 
 
752
 
                                // process an escape sequence
753
 
                                in_escape = false;
754
 
                                switch( c )
755
 
                                {
756
 
                                case 'N':
757
 
                                case 'n':
758
 
                                        // add newline
759
 
                                        ret.append( '\n' );
760
 
                                        break;
761
 
                                case '\\':
762
 
                                case ',':
763
 
                                case ';':
764
 
                                        // add escaped character
765
 
                                        ret.append( Character.toChars( c ) );
766
 
                                        break;
767
 
                                default:
768
 
                                        // unknown escape sequence, so add it unescaped
769
 
                                        ret.append( "\\" );
770
 
                                        ret.append( Character.toChars( c ) );
771
 
                                        break;
772
 
                                }
773
 
                        }
774
 
 
775
 
                        return ret.toString();
776
 
                }
777
 
 
778
689
                private void parseN( String[] params, String value )
779
690
                {
780
691
                        // already got a better name?
781
692
                        if( _name_level >= NAMELEVEL_N ) return;
782
693
 
783
694
                        // get name parts
784
 
                        String[] name_parts = splitValueByCharacter( value, ';' );
 
695
                        String[] name_parts = splitValueBySemicolon( value );
785
696
 
786
697
                        // build name
787
698
                        value = "";
788
 
                        final int[] part_order = { 3, 1, 2, 0, 4 };
789
 
                        for( int a = 0; a < part_order.length; a++ )
790
 
                                if( name_parts.length > part_order[ a ] &&
791
 
                                        name_parts[ part_order[ a ] ].length() > 0 )
792
 
                                {
793
 
                                        // split this part in to it's comma-separated bits
794
 
                                        String[] name_part_parts = splitValueByCharacter(
795
 
                                                name_parts[ part_order[ a ] ], ',' );
796
 
                                        for( int b = 0; b < name_part_parts.length; b++ )
797
 
                                                if( name_part_parts[ b ].length() > 0 )
798
 
                                                {
799
 
                                                        if( value.length() == 0 ) value += " ";
800
 
                                                        value += name_part_parts[ b ];
801
 
                                                }
802
 
                                }
 
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 ];
803
703
 
804
704
                        // set name
805
 
                        setName( unescapeValue( value ) );
 
705
                        setName( value );
806
706
                        _name_level = NAMELEVEL_N;
807
707
                }
808
708
 
812
712
                        if( _name_level >= NAMELEVEL_FN ) return;
813
713
 
814
714
                        // set name
815
 
                        setName( unescapeValue( value ) );
 
715
                        setName( value );
816
716
                        _name_level = NAMELEVEL_FN;
817
717
                }
818
718
 
819
719
                private void parseORG( String[] params, String value )
820
720
                {
821
721
                        // get org parts
822
 
                        String[] org_parts = splitValueByCharacter( value, ';' );
 
722
                        String[] org_parts = splitValueBySemicolon( value );
823
723
                        if( org_parts == null || org_parts.length < 1 ) return;
824
724
 
825
725
                        // build organisation name
827
727
                                String.valueOf( org_parts[ 0 ] ) );
828
728
                        for( int a = 1; a < org_parts.length; a++ )
829
729
                                builder.append( ", " ).append( org_parts[ a ] );
830
 
                        String organisation = unescapeValue( builder.toString() );
 
730
                        String organisation = builder.toString();
831
731
 
832
732
                        // set organisation name (using a title we've previously found)
833
733
                        addOrganisation( organisation, _cached_title, true );
844
744
 
845
745
                private void parseTITLE( String[] params, String value )
846
746
                {
847
 
                        value = unescapeValue( value );
848
 
 
849
747
                        // if we previously had an organisation, look it up and append this
850
748
                        // title to it
851
749
                        if( _cached_organisation != null && hasOrganisations() ) {
908
806
                        else
909
807
                                type = Contacts.ContactMethods.TYPE_HOME;
910
808
 
911
 
                        addEmail( unescapeValue( value ), type, is_preferred );
 
809
                        addEmail( value, type, is_preferred );
912
810
                }
913
811
 
914
812
                private void parseADR( String[] params, String value )
915
813
                {
916
814
                        // get address parts
917
 
                        String[] adr_parts = splitValueByCharacter( value, ';' );
 
815
                        String[] adr_parts = splitValueBySemicolon( value );
918
816
 
919
817
                        // build address
920
818
                        value = "";
921
 
                        for( int a = 0; a < adr_parts.length; a++ )
922
 
                                if( adr_parts[ a ].length() > 0 )
923
 
                                {
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
 
                                                }
933
 
                                }
 
819
                        for( int a = 0; a < adr_parts.length; a++ ) {
 
820
                                if( value.length() > 0 ) value += "\n";
 
821
                                value += adr_parts[ a ].trim();
 
822
                        }
934
823
 
935
824
                        Set< String > types = extractTypes( params, Arrays.asList(
936
825
                                "PREF", "WORK", "HOME", "INTERNET" ) );
942
831
                        else
943
832
                                type = Contacts.ContactMethods.TYPE_HOME;
944
833
 
945
 
                        addAddress( unescapeValue( value ), type );
 
834
                        addAddress( value, type );
946
835
                }
947
836
 
948
 
                public void finaliseVcard()
949
 
                        throws ParseException, ContactNotIdentifiableException
 
837
                public void finaliseParsing()
 
838
                        throws ParseException, SkipContactException,
 
839
                        AbortImportException
950
840
                {
951
841
                        // missing version (and data is present)
952
842
                        if( _version == null && _buffers != null )
953
843
                                throw new ParseException( R.string.error_vcf_malformed );
954
844
 
955
 
                        // finalise the parent class
956
 
                        finalise();
 
845
                        // check if we should import this contact
 
846
                        try {
 
847
                                if( !isImportRequired( this ) )
 
848
                                        throw new SkipContactException();
 
849
                        }
 
850
                        catch( ContactNeedsMoreInfoException e ) {
 
851
                                throw new ParseException( R.string.error_vcf_notenoughinfo );
 
852
                        }
957
853
                }
958
854
 
959
855
                private String checkParam( String[] params, String name )