/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-03-23 07:50:13 UTC
  • Revision ID: edam@waxworlds.org-20110323075013-qnza5odtlsjtcz0p
- updated TODO and NEWS
- handle different multiline schemes better
- import addresses
- check for escaped semi-colons and newlines in N, ADR and ORG lines
- minor optimisations

Show diffs side-by-side

added added

removed removed

1
1
/*
2
2
 * VCFImporter.java
3
3
 *
4
 
 * Copyright (C) 2009 to 2011 Tim Marston <tim@ed.am>
 
4
 * Copyright (C) 2009 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;
34
34
import java.nio.ByteBuffer;
35
35
import java.util.ArrayList;
36
36
import java.util.Arrays;
37
 
import java.util.HashMap;
38
37
import java.util.HashSet;
39
38
import java.util.Iterator;
40
39
import java.util.List;
41
 
import java.util.Locale;
42
40
import java.util.NoSuchElementException;
43
41
import java.util.Set;
44
42
import java.util.Vector;
45
43
import java.util.regex.Matcher;
46
44
import java.util.regex.Pattern;
47
45
 
48
 
import android.annotation.SuppressLint;
49
46
import android.content.SharedPreferences;
 
47
import android.provider.Contacts;
 
48
import android.provider.Contacts.PhonesColumns;
50
49
 
51
 
public class VcardImporter extends Importer
 
50
public class VCFImporter extends Importer
52
51
{
53
 
        private int _vcard_count = 0;
 
52
        private int _vCardCount = 0;
54
53
        private int _progress = 0;
55
54
 
56
 
        public VcardImporter( Doit doit )
 
55
        public VCFImporter( Doit doit )
57
56
        {
58
57
                super( doit );
59
58
        }
60
59
 
61
 
        @SuppressLint( "SdCardPath" )
62
60
        @Override
63
61
        protected void onImport() throws AbortImportException
64
62
        {
83
81
                                // get files
84
82
                                class VCardFilter implements FilenameFilter {
85
83
                                        public boolean accept( File dir, String name ) {
86
 
                                                return name.toLowerCase( Locale.US ).endsWith( ".vcf" );
 
84
                                                return name.toLowerCase().endsWith( ".vcf" );
87
85
                                        }
88
86
                                }
89
87
                                files = file.listFiles( new VCardFilter() );
111
109
                        countVCardFile( files[ i ] );
112
110
                        setTmpProgress( i );
113
111
                }
114
 
                setProgressMax( _vcard_count ); // will also update tmp progress
 
112
                setProgressMax( _vCardCount );  // will also update tmp progress
115
113
 
116
114
                // import them
117
115
                setProgress( 0 );
118
116
                for( int i = 0; i < files.length; i++ )
119
117
                        importVCardFile( files[ i ] );
120
 
                setProgress( _vcard_count );
121
118
        }
122
119
 
123
120
        private void countVCardFile( File file ) throws AbortImportException
130
127
 
131
128
                        // read
132
129
                        String line;
133
 
                        boolean in_vcard = false;
 
130
                        boolean inVCard = false;
134
131
                        while( ( line = reader.readLine() ) != null )
135
132
                        {
136
 
                                if( !in_vcard ) {
 
133
                                if( !inVCard ) {
137
134
                                        // look for vcard beginning
138
135
                                        if( line.matches( "^BEGIN:VCARD" ) ) {
139
 
                                                in_vcard = true;
140
 
                                                _vcard_count++;
 
136
                                                inVCard = true;
 
137
                                                _vCardCount++;
141
138
                                        }
142
139
                                }
143
140
                                else if( line.matches( "^END:VCARD" ) )
144
 
                                        in_vcard = false;
 
141
                                        inVCard = false;
145
142
                        }
146
143
 
147
144
                }
170
167
                        FileInputStream istream = new FileInputStream( file );
171
168
                        byte[] content = new byte[ (int)file.length() ];
172
169
                        istream.read( content );
173
 
                        istream = null;
174
170
 
175
171
                        // import
176
172
                        importVCardFileContent( content, file.getName() );
188
184
                throws AbortImportException
189
185
        {
190
186
                // go through lines
191
 
                Vcard vcard = null;
192
 
                int vcard_start_line = 0;
 
187
                VCard vCard = null;
193
188
                ContentLineIterator cli = new ContentLineIterator( content );
194
189
                while( cli.hasNext() )
195
190
                {
202
197
                                        buffer.limit() - buffer.position(), "US-ASCII" );
203
198
                        }
204
199
                        catch( UnsupportedEncodingException e ) {
205
 
                                // we know US-ASCII *is* supported, so appease the compiler...
 
200
                                // we know US-ASCII is supported, so appease the compiler...
206
201
                                line = "";
207
202
                        }
208
203
 
209
 
                        if( vcard == null ) {
 
204
                        if( vCard == null ) {
210
205
                                // look for vcard beginning
211
 
                                if( line.matches( "^BEGIN[ \t]*:[ \t]*VCARD" ) ) {
212
 
                                        setProgress( _progress++ );
213
 
                                        vcard = new Vcard();
214
 
                                        vcard_start_line = cli.getLineNumber();
 
206
                                if( line.matches( "^BEGIN:VCARD" ) ) {
 
207
                                        setProgress( ++_progress );
 
208
                                        vCard = new VCard();
215
209
                                }
216
210
                        }
217
211
                        else {
218
212
                                // look for vcard content or ending
219
 
                                if( line.matches( "^END[ \t]*:[ \t]*VCARD" ) )
 
213
                                if( line.matches( "^END:VCARD" ) )
220
214
                                {
221
 
                                        // finalise the vcard/contact
 
215
                                        // store vcard and do away with it
222
216
                                        try {
223
 
                                                vcard.finaliseVcard();
224
 
 
225
 
                                                // pass the finalised contact to the importer
226
 
                                                importContact( vcard );
227
 
                                        }
228
 
                                        catch( Vcard.ParseException e ) {
229
 
                                                if( !showContinue(
230
 
                                                        getText( R.string.error_vcf_parse ).toString()
231
 
                                                        + fileName +
232
 
                                                        getText( R.string.error_vcf_parse_line ).toString()
233
 
                                                        + cli.getLineNumber() + ":\n" + e.getMessage() ) )
234
 
                                                {
235
 
                                                        finish( ACTION_ABORT );
236
 
                                                }
237
 
                                                else
238
 
                                                        skipContact();
239
 
                                        }
240
 
                                        catch( ContactData.ContactNotIdentifiableException e ) {
241
 
                                                if( !showContinue(
242
 
                                                        getText( R.string.error_vcf_parse ).toString()
243
 
                                                        + fileName +
244
 
                                                        getText( R.string.error_vcf_parse_line ).toString()
245
 
                                                        + vcard_start_line + ":\n" + getText(
246
 
                                                                R.string.error_vcf_notenoughinfo ).toString()
247
 
                                                ) )
248
 
                                                {
249
 
                                                        finish( ACTION_ABORT );
250
 
                                                }
251
 
                                                else
252
 
                                                        skipContact();
253
 
                                        }
254
 
 
255
 
                                        // discard this vcard
256
 
                                        vcard = null;
 
217
                                                vCard.finaliseParsing();
 
218
                                                importContact( vCard );
 
219
                                        }
 
220
                                        catch( VCard.ParseException e ) {
 
221
                                                skipContact();
 
222
                                                if( !showContinue(
 
223
                                                        getText( R.string.error_vcf_parse ).toString()
 
224
                                                        + fileName + "\n" + e.getMessage() ) )
 
225
                                                {
 
226
                                                        finish( ACTION_ABORT );
 
227
                                                }
 
228
                                        }
 
229
                                        catch( VCard.SkipContactException e ) {
 
230
                                                skipContact();
 
231
                                                // do nothing
 
232
                                        }
 
233
                                        vCard = null;
257
234
                                }
258
235
                                else
259
236
                                {
260
237
                                        // try giving the line to the vcard
261
238
                                        try {
262
 
                                                vcard.parseLine( buffer, line,
 
239
                                                vCard.parseLine( buffer, line,
263
240
                                                        cli.doesNextLineLookFolded() );
264
241
                                        }
265
 
                                        catch( Vcard.ParseException e ) {
 
242
                                        catch( VCard.ParseException e ) {
266
243
                                                skipContact();
267
244
                                                if( !showContinue(
268
245
                                                        getText( R.string.error_vcf_parse ).toString()
269
 
                                                        + fileName +
270
 
                                                        getText( R.string.error_vcf_parse_line ).toString()
271
 
                                                        + cli.getLineNumber() + "\n" + e.getMessage() ) )
 
246
                                                        + fileName + "\n" + e.getMessage() ) )
272
247
                                                {
273
248
                                                        finish( ACTION_ABORT );
274
249
                                                }
276
251
                                                // although we're continuing, we still need to abort
277
252
                                                // this vCard. Further lines will be ignored until we
278
253
                                                // get to another BEGIN:VCARD line.
279
 
                                                vcard = null;
 
254
                                                vCard = null;
280
255
                                        }
281
 
                                        catch( Vcard.SkipImportException e ) {
 
256
                                        catch( VCard.SkipContactException e ) {
282
257
                                                skipContact();
283
258
                                                // abort this vCard. Further lines will be ignored until
284
259
                                                // we get to another BEGIN:VCARD line.
285
 
                                                vcard = null;
 
260
                                                vCard = null;
286
261
                                        }
287
262
                                }
288
263
                        }
293
268
        {
294
269
                protected byte[] _content = null;
295
270
                protected int _pos = 0;
296
 
                protected int _line = 0;
297
271
 
298
272
                public ContentLineIterator( byte[] content )
299
273
                {
319
293
                                        int to = ( _pos > 0 && _content[ _pos - 1 ] == '\r' &&
320
294
                                                _pos > initial_pos )? _pos - 1 : _pos;
321
295
                                        _pos++;
322
 
                                        _line++;
323
296
                                        return ByteBuffer.wrap( _content, initial_pos,
324
297
                                                to - initial_pos );
325
298
                                }
328
301
                        if( _pos != initial_pos ) {
329
302
                                int to = _pos;
330
303
                                _pos++;
331
 
                                _line++;
332
304
                                return ByteBuffer.wrap( _content, initial_pos,
333
305
                                        to - initial_pos );
334
306
                        }
351
323
                public boolean doesNextLineLookFolded()
352
324
                {
353
325
                        return _pos > 0 && _pos < _content.length &&
354
 
                                _content[ _pos - 1 ] == '\n' &&
355
 
                                ( _content[ _pos ] == ' ' || _content[ _pos ] == '\t' );
356
 
                }
357
 
 
358
 
                public int getLineNumber()
359
 
                {
360
 
                        return _line;
 
326
                                _content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
361
327
                }
362
328
        }
363
329
 
364
 
        private class Vcard extends ContactData
 
330
        private class VCard extends ContactData
365
331
        {
366
332
                private final static int NAMELEVEL_NONE = 0;
367
 
                private final static int NAMELEVEL_N = 1;
 
333
                private final static int NAMELEVEL_ORG = 1;
368
334
                private final static int NAMELEVEL_FN = 2;
 
335
                private final static int NAMELEVEL_N = 3;
369
336
 
370
337
                private final static int MULTILINE_NONE = 0;
371
338
                private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
372
339
                private final static int MULTILINE_ESCAPED = 2; // v2.1 \\CRLF
373
 
                private final static int MULTILINE_FOLDED = 3;  // MIME-DIR folding
 
340
                private final static int MULTILINE_FOLDED = 3;  // v3.0 folding
374
341
 
375
342
                private String _version = null;
376
343
                private Vector< ByteBuffer > _buffers = null;
378
345
                private int _parser_multiline_state = MULTILINE_NONE;
379
346
                private String _parser_current_name_and_params = null;
380
347
                private String _parser_buffered_value_so_far = "";
381
 
                private String _cached_organisation = null;
382
 
                private String _cached_title = null;
383
348
 
384
349
                protected class UnencodeResult
385
350
                {
415
380
 
416
381
                        public ParseException( int res )
417
382
                        {
418
 
                                super( VcardImporter.this.getText( res ).toString() );
 
383
                                super( VCFImporter.this.getText( res ).toString() );
419
384
                        }
420
385
                }
421
386
 
422
387
                @SuppressWarnings("serial")
423
 
                protected class SkipImportException extends Exception { }
 
388
                protected class SkipContactException extends Exception { }
424
389
 
425
390
                private String extractCollonPartFromLine( ByteBuffer buffer,
426
391
                        String line, boolean former )
462
427
 
463
428
                public void parseLine( ByteBuffer buffer, String line,
464
429
                        boolean next_line_looks_folded )
465
 
                        throws ParseException, SkipImportException,
 
430
                        throws ParseException, SkipContactException,
466
431
                        AbortImportException
467
432
                {
468
433
                        // do we have a version yet?
474
439
 
475
440
                                // is it a version line?
476
441
                                if( name_and_params != null &&
477
 
                                        name_and_params.equalsIgnoreCase( "VERSION" ) )
 
442
                                        name_and_params.equals( "VERSION" ) )
478
443
                                {
479
444
                                        // yes, get it!
480
445
                                        String value = extractValueFromLine( buffer, line );
504
469
                        else
505
470
                        {
506
471
                                // name and params and the position in the buffer where the
507
 
                                // "value" part of the line starts
 
472
                                // "value" part of the line start
508
473
                                String name_and_params;
509
474
                                int pos;
510
475
 
540
505
                                }
541
506
                                else
542
507
                                {
543
 
                                        // skip empty lines
544
 
                                        if( line.trim().length() == 0 ) return;
545
 
 
546
508
                                        // get name and params from line, and since we're not
547
509
                                        // parsing a subsequent line in a multi-line, this should
548
510
                                        // not fail, or it's an error
571
533
                                for( int i = 0; i < name_param_parts.length; i++ )
572
534
                                        name_param_parts[ i ] = name_param_parts[ i ].trim();
573
535
 
574
 
                                // determine whether we care about this entry
575
 
                                final HashSet< String > interesting_fields =
576
 
                                        new HashSet< String >( Arrays.asList( new String[] { "N",
577
 
                                                "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
578
 
                                ) );
579
 
                                boolean is_interesting_field =
580
 
                                        interesting_fields.contains(
581
 
                                                name_param_parts[ 0 ].toUpperCase( Locale.US ) );
582
 
 
583
536
                                // parse encoding parameter
584
537
                                String encoding = checkParam( name_param_parts, "ENCODING" );
585
 
                                if( encoding != null )
586
 
                                        encoding = encoding.toUpperCase( Locale.US );
587
 
                                if( is_interesting_field && encoding != null &&
588
 
                                        !encoding.equalsIgnoreCase( "8BIT" ) &&
589
 
                                        !encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
590
 
                                        //&& !encoding.equalsIgnoreCase( "BASE64" ) )
 
538
                                if( encoding != null ) encoding = encoding.toUpperCase();
 
539
                                if( encoding != null && !encoding.equals( "8BIT" ) &&
 
540
                                        !encoding.equals( "QUOTED-PRINTABLE" ) )
 
541
                                        //&& !encoding.equals( "BASE64" ) )
591
542
                                {
592
543
                                        throw new ParseException( R.string.error_vcf_encoding );
593
544
                                }
594
545
 
595
546
                                // parse charset parameter
596
547
                                String charset = checkParam( name_param_parts, "CHARSET" );
597
 
                                if( charset != null )
598
 
                                        charset = charset.toUpperCase( Locale.US );
599
 
                                if( charset != null &&
600
 
                                        !charset.equalsIgnoreCase( "US-ASCII" ) &&
601
 
                                        !charset.equalsIgnoreCase( "ASCII" ) &&
602
 
                                        !charset.equalsIgnoreCase( "UTF-8" ) )
 
548
                                if( charset != null ) charset = charset.toUpperCase();
 
549
                                if( charset != null && !charset.equals( "US-ASCII" ) &&
 
550
                                        !charset.equals( "ASCII" ) &&
 
551
                                        !charset.equals( "UTF-8" ) )
603
552
                                {
604
553
                                        throw new ParseException( R.string.error_vcf_charset );
605
554
                                }
607
556
                                // do unencoding (or default to a fake unencoding result with
608
557
                                // the raw string)
609
558
                                UnencodeResult unencoding_result = null;
610
 
                                if( encoding != null &&
611
 
                                        encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
612
 
                                {
 
559
                                if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
613
560
                                        unencoding_result = unencodeQuotedPrintable( value );
614
 
                                }
615
 
//                              else if( encoding != null &&
616
 
//                                      encoding.equalsIgnoreCase( "BASE64" ) )
617
 
//                              {
 
561
//                              else if( encoding != null && encoding.equals( "BASE64" ) )
618
562
//                                      unencoding_result = unencodeBase64( props[ 1 ], charset );
619
 
//                              }
620
563
                                if( unencoding_result != null ) {
621
564
                                        value = unencoding_result.getBuffer();
622
565
                                        if( unencoding_result.isAnotherLineRequired() )
623
566
                                                _parser_multiline_state = MULTILINE_ENCODED;
624
567
                                }
625
568
 
626
 
                                // convert 8-bit US-ASCII charset to UTF-8 (where no charset is
627
 
                                // specified for a v2.1 vcard entry, we assume it's US-ASCII)
628
 
                                if( ( charset == null && _version.equals( "2.1" ) ) ||
629
 
                                        ( charset != null && (
630
 
                                                charset.equalsIgnoreCase( "ASCII" ) ||
631
 
                                                charset.equalsIgnoreCase( "US-ASCII" ) ) ) )
632
 
                                {
 
569
                                // convert 8-bit ASCII charset to US-ASCII
 
570
                                if( charset == null || charset.equals( "ASCII" ) ) {
633
571
                                        value = transcodeAsciiToUtf8( value );
 
572
                                        charset = "UTF-8";
634
573
                                }
635
574
 
636
 
                                // process charset (value is now in UTF-8)
 
575
                                // process charset
637
576
                                String string_value;
638
577
                                try {
639
578
                                        string_value = new String( value.array(), value.position(),
640
 
                                                value.limit() - value.position(), "UTF-8" );
 
579
                                                value.limit() - value.position(), charset );
641
580
                                } catch( UnsupportedEncodingException e ) {
642
581
                                        throw new ParseException( R.string.error_vcf_charset );
643
582
                                }
645
584
                                // for some entries that have semicolon-separated value parts,
646
585
                                // check to see if the value ends in an escape character, which
647
586
                                // indicates that we have a multi-line value
648
 
                                if( ( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) ||
649
 
                                        name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) ||
650
 
                                        name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) ) &&
 
587
                                if( ( name_param_parts[ 0 ].equals( "N" ) ||
 
588
                                        name_param_parts[ 0 ].equals( "ORG" ) ||
 
589
                                        name_param_parts[ 0 ].equals( "ADR" ) ) &&
651
590
                                        doesStringEndInAnEscapeChar( string_value ) )
652
591
                                {
653
592
                                        _parser_multiline_state = MULTILINE_ESCAPED;
655
594
                                                string_value.length() - 1 );
656
595
                                }
657
596
 
658
 
                                // if we know we're not in an encoding-based multi-line, check
659
 
                                // to see if we're in a folded multi-line
 
597
                                // now we know whether we're in an encoding multi-line,
 
598
                                // determine if we're in a v3 folded multi-line or not
660
599
                                if( _parser_multiline_state == MULTILINE_NONE &&
661
 
                                        next_line_looks_folded )
 
600
                                        _version.equals( "3.0" ) && next_line_looks_folded )
662
601
                                {
663
602
                                        _parser_multiline_state = MULTILINE_FOLDED;
664
603
                                }
676
615
                                if( complete_value.length() < 1 ) return;
677
616
 
678
617
                                // parse some properties
679
 
                                if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
 
618
                                if( name_param_parts[ 0 ].equals( "N" ) )
680
619
                                        parseN( name_param_parts, complete_value );
681
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
 
620
                                else if( name_param_parts[ 0 ].equals( "FN" ) )
682
621
                                        parseFN( name_param_parts, complete_value );
683
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
 
622
                                else if( name_param_parts[ 0 ].equals( "ORG" ) )
684
623
                                        parseORG( name_param_parts, complete_value );
685
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
686
 
                                        parseTITLE( name_param_parts, complete_value );
687
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
 
624
                                else if( name_param_parts[ 0 ].equals( "TEL" ) )
688
625
                                        parseTEL( name_param_parts, complete_value );
689
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
 
626
                                else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
690
627
                                        parseEMAIL( name_param_parts, complete_value );
691
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
 
628
                                else if( name_param_parts[ 0 ].equals( "ADR" ) )
692
629
                                        parseADR( name_param_parts, complete_value );
693
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "LABEL" ) )
694
 
                                        parseLABEL( name_param_parts, complete_value );
695
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
696
 
                                        parseNOTE( name_param_parts, complete_value );
697
630
                        }
698
631
                }
699
632
 
712
645
                        return ( count & 1 ) == 1;
713
646
                }
714
647
 
715
 
                private String[] splitValueByCharacter( String value, char character )
 
648
                private String[] splitValueBySemicolon( String value )
716
649
                {
717
 
                        // split string in to parts by specified character
 
650
                        // split string in to parts by semicolon
718
651
                        ArrayList< String > parts = new ArrayList< String >(
719
 
                                Arrays.asList( value.split( "" + character ) ) );
 
652
                                Arrays.asList( value.split(  ";" ) ) );
720
653
 
721
654
                        // go through parts
722
655
                        for( int a = 0; a < parts.size(); a++ )
730
663
                                if( a < parts.size() - 1 &&
731
664
                                        doesStringEndInAnEscapeChar( str ) )
732
665
                                {
733
 
                                        // append the escaped character, join the next part to this
734
 
                                        // part and remove the next part
 
666
                                        // join the next part to this part and remove the next part
735
667
                                        parts.set( a, str.substring( 0, str.length() - 1 ) +
736
 
                                                character + parts.get( a + 1 ) );
 
668
                                                ';' + parts.get( a + 1 ) );
737
669
                                        parts.remove( a + 1 );
738
670
 
739
671
                                        // re-visit this part
750
682
                        return parts.toArray( ret );
751
683
                }
752
684
 
753
 
                private String unescapeValue( String value )
754
 
                {
755
 
                        StringBuilder ret = new StringBuilder( value.length() );
756
 
                        boolean in_escape = false;
757
 
                        for( int a = 0; a < value.length(); a++ )
758
 
                        {
759
 
                                int c = value.codePointAt( a );
760
 
 
761
 
                                // process a normal character
762
 
                                if( !in_escape ) {
763
 
                                        if( c == '\\' )
764
 
                                                in_escape = true;
765
 
                                        else
766
 
                                                ret.append( Character.toChars( c ) );
767
 
                                        continue;
768
 
                                }
769
 
 
770
 
                                // process an escape sequence
771
 
                                in_escape = false;
772
 
                                switch( c )
773
 
                                {
774
 
                                case 'T':
775
 
                                case 't':
776
 
                                        // add tab (invalid/non-standard, but accepted)
777
 
                                        ret.append( '\t' );
778
 
                                        break;
779
 
                                case 'N':
780
 
                                case 'n':
781
 
                                        // add newline
782
 
                                        ret.append( '\n' );
783
 
                                        break;
784
 
                                case '\\':
785
 
                                case ',':
786
 
                                case ';':
787
 
                                        // add escaped character
788
 
                                        ret.append( Character.toChars( c ) );
789
 
                                        break;
790
 
                                default:
791
 
                                        // unknown escape sequence, so add it unescaped
792
 
                                        // (invalid/non-standard, but accepted)
793
 
                                        ret.append( "\\" );
794
 
                                        ret.append( Character.toChars( c ) );
795
 
                                        break;
796
 
                                }
797
 
                        }
798
 
 
799
 
                        return ret.toString();
800
 
                }
801
 
 
802
685
                private void parseN( String[] params, String value )
 
686
                        throws ParseException, SkipContactException,
 
687
                        AbortImportException
803
688
                {
804
689
                        // already got a better name?
805
690
                        if( _name_level >= NAMELEVEL_N ) return;
806
691
 
807
692
                        // get name parts
808
 
                        String[] name_parts = splitValueByCharacter( value, ';' );
 
693
                        String[] name_parts = splitValueBySemicolon( value );
809
694
 
810
695
                        // build name
811
696
                        value = "";
812
 
                        final int[] part_order = { 3, 1, 2, 0, 4 };
813
 
                        for( int a = 0; a < part_order.length; a++ )
814
 
                                if( name_parts.length > part_order[ a ] &&
815
 
                                        name_parts[ part_order[ a ] ].length() > 0 )
816
 
                                {
817
 
                                        // split this part in to it's comma-separated bits
818
 
                                        String[] name_part_parts = splitValueByCharacter(
819
 
                                                name_parts[ part_order[ a ] ], ',' );
820
 
                                        for( int b = 0; b < name_part_parts.length; b++ )
821
 
                                                if( name_part_parts[ b ].length() > 0 )
822
 
                                                {
823
 
                                                        if( value.length() == 0 ) value += " ";
824
 
                                                        value += name_part_parts[ b ];
825
 
                                                }
826
 
                                }
 
697
                        if( name_parts.length > 1 && name_parts[ 1 ].length() > 0 )
 
698
                                value += name_parts[ 1 ];
 
699
                        if( name_parts.length > 0 && name_parts[ 0 ].length() > 0 )
 
700
                                value += ( value.length() == 0? "" : " " ) + name_parts[ 0 ];
827
701
 
828
702
                        // set name
829
 
                        setName( unescapeValue( value ) );
 
703
                        setName( value );
830
704
                        _name_level = NAMELEVEL_N;
 
705
 
 
706
                        // check now to see if we need to import this contact (to avoid
 
707
                        // parsing the rest of the vCard unnecessarily)
 
708
                        if( !isImportRequired( getName() ) )
 
709
                                throw new SkipContactException();
831
710
                }
832
711
 
833
712
                private void parseFN( String[] params, String value )
 
713
                        throws ParseException, SkipContactException
834
714
                {
835
715
                        // already got a better name?
836
716
                        if( _name_level >= NAMELEVEL_FN ) return;
837
717
 
838
718
                        // set name
839
 
                        setName( unescapeValue( value ) );
 
719
                        setName( value );
840
720
                        _name_level = NAMELEVEL_FN;
841
721
                }
842
722
 
843
723
                private void parseORG( String[] params, String value )
 
724
                        throws ParseException, SkipContactException
844
725
                {
 
726
                        // already got a better name?
 
727
                        if( _name_level >= NAMELEVEL_ORG ) return;
 
728
 
845
729
                        // get org parts
846
 
                        String[] org_parts = splitValueByCharacter( value, ';' );
847
 
                        if( org_parts == null || org_parts.length < 1 ) return;
848
 
 
849
 
                        // build organisation name
850
 
                        StringBuilder builder = new StringBuilder(
851
 
                                String.valueOf( org_parts[ 0 ] ) );
852
 
                        for( int a = 1; a < org_parts.length; a++ )
853
 
                                builder.append( ", " ).append( org_parts[ a ] );
854
 
                        String organisation = unescapeValue( builder.toString() );
855
 
 
856
 
                        // set organisation name (using a title we've previously found)
857
 
                        addOrganisation( organisation, _cached_title, true );
858
 
 
859
 
                        // if we've not previously found a title, store this organisation
860
 
                        // name (we'll need it when we find a title to update the
861
 
                        // organisation, by name), else if we *have* previously found a
862
 
                        // title, clear it (since we just used it)
863
 
                        if( _cached_title == null )
864
 
                                _cached_organisation = organisation;
865
 
                        else
866
 
                                _cached_title = null;
867
 
                }
868
 
 
869
 
                private void parseTITLE( String[] params, String value )
870
 
                {
871
 
                        value = unescapeValue( value );
872
 
 
873
 
                        // if we previously had an organisation, look it up and append this
874
 
                        // title to it
875
 
                        if( _cached_organisation != null && hasOrganisations() ) {
876
 
                                HashMap< String, ExtraDetail > datas = getOrganisations();
877
 
                                ExtraDetail detail = datas.get( _cached_organisation );
878
 
                                if( detail != null )
879
 
                                        detail.setExtra( value );
880
 
                        }
881
 
 
882
 
                        // same as when handling organisation, if we've not previously found
883
 
                        // an organisation we store this title, else we clear it (since we
884
 
                        // just appended this title to it)
885
 
                        if( _cached_organisation == null )
886
 
                                _cached_title = value;
887
 
                        else
888
 
                                _cached_organisation = null;
 
730
                        String[] org_parts = splitValueBySemicolon( value );
 
731
 
 
732
                        // build name
 
733
                        if( org_parts.length > 1 && org_parts[ 0 ].length() == 0 )
 
734
                                value = org_parts[ 1 ];
 
735
                        else if( org_parts.length > 1 && org_parts[ 1 ].length() > 0 )
 
736
                                value = org_parts[ 0 ] + ", " + org_parts[ 1 ];
 
737
                        else
 
738
                                value = org_parts[ 0 ];
 
739
 
 
740
                        // set name
 
741
                        setName( value );
 
742
                        _name_level = NAMELEVEL_ORG;
889
743
                }
890
744
 
891
745
                private void parseTEL( String[] params, String value )
 
746
                        throws ParseException
892
747
                {
893
748
                        if( value.length() == 0 ) return;
894
749
 
897
752
                                "PAGER", "BBS", "MODEM", "CAR", "ISDN", "VIDEO" ) );
898
753
 
899
754
                        // here's the logic...
900
 
                        boolean is_preferred = types.contains( "PREF" );
901
 
                        int type;
 
755
                        boolean preferred = types.contains( "PREF" );
 
756
                        int type = PhonesColumns.TYPE_MOBILE;
 
757
                        if( types.contains( "VOICE" ) )
 
758
                                if( types.contains( "WORK" ) )
 
759
                                        type = PhonesColumns.TYPE_WORK;
 
760
                                else
 
761
                                        type = PhonesColumns.TYPE_HOME;
 
762
                        else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
 
763
                                type = PhonesColumns.TYPE_MOBILE;
902
764
                        if( types.contains( "FAX" ) )
903
765
                                if( types.contains( "HOME" ) )
904
 
                                        type = TYPE_FAX_HOME;
 
766
                                        type = PhonesColumns.TYPE_FAX_HOME;
905
767
                                else
906
 
                                        type = TYPE_FAX_WORK;
907
 
                        else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
908
 
                                type = TYPE_MOBILE;
909
 
                        else if( types.contains( "PAGER" ) )
910
 
                                type = TYPE_PAGER;
911
 
                        else if( types.contains( "WORK" ) )
912
 
                                type = TYPE_WORK;
913
 
                        else
914
 
                                type = TYPE_HOME;
 
768
                                        type = PhonesColumns.TYPE_FAX_WORK;
 
769
                        if( types.contains( "PAGER" ) )
 
770
                                type = PhonesColumns.TYPE_PAGER;
915
771
 
916
772
                        // add phone number
917
 
                        addNumber( value, type, is_preferred );
 
773
                        addPhone( value, type, preferred );
918
774
                }
919
775
 
920
776
                public void parseEMAIL( String[] params, String value )
 
777
                        throws ParseException
921
778
                {
922
779
                        if( value.length() == 0 ) return;
923
780
 
925
782
                                "PREF", "WORK", "HOME", "INTERNET" ) );
926
783
 
927
784
                        // add email address
928
 
                        boolean is_preferred = types.contains( "PREF" );
929
 
                        int type;
 
785
                        boolean preferred = types.contains( "PREF" );
930
786
                        if( types.contains( "WORK" ) )
931
 
                                type = TYPE_WORK;
 
787
                                addEmail( value, Contacts.ContactMethods.TYPE_WORK, preferred );
932
788
                        else
933
 
                                type = TYPE_HOME;
934
 
 
935
 
                        addEmail( unescapeValue( value ), type, is_preferred );
 
789
                                addEmail( value, Contacts.ContactMethods.TYPE_HOME, preferred );
936
790
                }
937
791
 
938
792
                private void parseADR( String[] params, String value )
 
793
                        throws ParseException, SkipContactException
939
794
                {
940
795
                        // get address parts
941
 
                        String[] adr_parts = splitValueByCharacter( value, ';' );
 
796
                        String[] adr_parts = splitValueBySemicolon( value );
942
797
 
943
798
                        // build address
944
799
                        value = "";
945
 
                        for( int a = 0; a < adr_parts.length; a++ )
946
 
                                if( adr_parts[ a ].length() > 0 )
947
 
                                {
948
 
                                        // version 3.0 vCards allow further splitting by comma
949
 
                                        if( _version.equals( "3.0" ) )
950
 
                                        {
951
 
                                                // split this part in to it's comma-separated bits and
952
 
                                                // add them on individual lines
953
 
                                                String[] adr_part_parts =
954
 
                                                        splitValueByCharacter( adr_parts[ a ], ',' );
955
 
                                                for( int b = 0; b < adr_part_parts.length; b++ )
956
 
                                                        if( adr_part_parts[ b ].length() > 0 )
957
 
                                                        {
958
 
                                                                if( value.length() > 0 ) value += "\n";
959
 
                                                                value += adr_part_parts[ b ];
960
 
                                                        }
961
 
                                        }
962
 
                                        else
963
 
                                        {
964
 
                                                // add this part on an individual line
965
 
                                                if( value.length() > 0 ) value += "\n";
966
 
                                                value += adr_parts[ a ];
967
 
                                        }
968
 
                                }
969
 
 
970
 
                        Set< String > types = extractTypes( params, Arrays.asList(
971
 
                                "PREF", "WORK", "HOME" ) );
972
 
 
973
 
                        // add address
974
 
                        int type;
975
 
                        if( types.contains( "WORK" ) )
976
 
                                type = TYPE_WORK;
977
 
                        else
978
 
                                type = TYPE_HOME;
979
 
 
980
 
                        addAddress( unescapeValue( value ), type );
981
 
                }
982
 
 
983
 
                private void parseLABEL( String[] params, String value )
984
 
                {
985
 
                        Set< String > types = extractTypes( params, Arrays.asList(
986
 
                                "PREF", "WORK", "HOME" ) );
987
 
 
988
 
                        // add address
989
 
                        int type;
990
 
                        if( types.contains( "WORK" ) )
991
 
                                type = TYPE_WORK;
992
 
                        else
993
 
                                type = TYPE_HOME;
994
 
 
995
 
                        addAddress( unescapeValue( value ), type );
996
 
                }
997
 
 
998
 
                private void parseNOTE( String[] params, String value )
999
 
                {
1000
 
                        addNote( unescapeValue( value ) );
1001
 
                }
1002
 
 
1003
 
                public void finaliseVcard()
1004
 
                        throws ParseException, ContactNotIdentifiableException
 
800
                        for( int a = 0; a < adr_parts.length; a++ ) {
 
801
                                if( value.length() > 0 ) value += "\n";
 
802
                                value += adr_parts[ a ].trim();
 
803
                        }
 
804
 
 
805
                        Set< String > types = extractTypes( params, Arrays.asList(
 
806
                                "PREF", "WORK", "HOME", "INTERNET" ) );
 
807
 
 
808
                        // add address
 
809
                        if( types.contains( "WORK" ) )
 
810
                                addAddress( value, Contacts.ContactMethods.TYPE_WORK );
 
811
                        else
 
812
                                addAddress( value, Contacts.ContactMethods.TYPE_HOME);
 
813
                }
 
814
 
 
815
                public void finaliseParsing()
 
816
                        throws ParseException, SkipContactException,
 
817
                        AbortImportException
1005
818
                {
1006
819
                        // missing version (and data is present)
1007
820
                        if( _version == null && _buffers != null )
1008
821
                                throw new ParseException( R.string.error_vcf_malformed );
1009
822
 
1010
 
                        // finalise the parent class
1011
 
                        finalise();
 
823
                        //  missing name properties?
 
824
                        if( _name_level == NAMELEVEL_NONE )
 
825
                                throw new ParseException( R.string.error_vcf_noname );
 
826
 
 
827
                        // check if we should import this one? If we've already got an 'N'-
 
828
                        // type name, this will already have been done by parseN() so we
 
829
                        // mustn't do this here (or it could prompt twice!)
 
830
                        if( _name_level < NAMELEVEL_N && !isImportRequired( getName() ) )
 
831
                                throw new SkipContactException();
1012
832
                }
1013
833
 
1014
 
                /**
1015
 
                 * Amongst the params, find the value of the first, only, of any with
1016
 
                 * the specified name
1017
 
                 * @param params
1018
 
                 * @param name
1019
 
                 * @return a value, or null
1020
 
                 */
1021
834
                private String checkParam( String[] params, String name )
1022
835
                {
1023
 
                        String[] res = checkParams( params, name );
1024
 
                        return res.length > 0? res[ 0 ] : null;
1025
 
                }
1026
 
 
1027
 
                /**
1028
 
                 * Amongst the params, find the values of any with the specified name
1029
 
                 * @param params
1030
 
                 * @param name
1031
 
                 * @return an array of values, or null
1032
 
                 */
1033
 
                private String[] checkParams( String[] params, String name )
1034
 
                {
1035
 
                        HashSet< String > ret = new HashSet< String >();
1036
 
 
1037
836
                        Pattern p = Pattern.compile(
1038
 
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1039
 
                                Pattern.CASE_INSENSITIVE );
 
837
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1040
838
                        for( int i = 0; i < params.length; i++ ) {
1041
839
                                Matcher m = p.matcher( params[ i ] );
1042
840
                                if( m.matches() )
1043
 
                                        ret.add( m.group( 2 ) );
 
841
                                        return m.group( 2 );
1044
842
                        }
1045
 
 
1046
 
                        return (String[]) ret.toArray( new String[ ret.size() ] );
 
843
                        return null;
1047
844
                }
1048
845
 
1049
 
                /**
1050
 
                 * Amongst the params, return any type values present. For v2.1 vCards,
1051
 
                 * those types are just parameters. For v3.0, they are prefixed with
1052
 
                 * "TYPE=". There may also be multiple type parameters.
1053
 
                 * @param params an array of params to look for types in
1054
 
                 * @param valid_types an list of upper-case type values to look for
1055
 
                 * @return a set of present type values
1056
 
                 */
1057
846
                private Set< String > extractTypes( String[] params,
1058
847
                        List< String > valid_types )
1059
848
                {
1060
849
                        HashSet< String > types = new HashSet< String >();
1061
850
 
1062
851
                        // get 3.0-style TYPE= param
1063
 
                        String type_params[] = checkParams( params, "TYPE" );
1064
 
                        for( int a = 0; a < type_params.length; a++ )
1065
 
                        {
1066
 
                                // check for a comma-separated list of types (why? I don't think
1067
 
                                // this is in the specs!)
1068
 
                                String[] parts = type_params[ a ].split( "," );
1069
 
                                for( int i = 0; i < parts.length; i++ ) {
1070
 
                                        String ucpart = parts[ i ].toUpperCase( Locale.US );
1071
 
                                        if( valid_types.contains( ucpart ) )
1072
 
                                                types.add( ucpart );
1073
 
                                }
 
852
                        String type_param;
 
853
                        if( ( type_param = checkParam( params, "TYPE" ) ) != null ) {
 
854
                                String[] parts = type_param.split( "," );
 
855
                                for( int i = 0; i < parts.length; i++ )
 
856
                                        if( valid_types.contains( parts[ i ] ) )
 
857
                                                types.add( parts[ i ] );
1074
858
                        }
1075
859
 
1076
860
                        // get 2.1-style type param
1077
861
                        if( _version.equals( "2.1" ) ) {
1078
 
                                for( int i = 1; i < params.length; i++ ) {
1079
 
                                        String ucparam = params[ i ].toUpperCase( Locale.US );
1080
 
                                        if( valid_types.contains( ucparam ) )
1081
 
                                                types.add( ucparam );
1082
 
                                }
 
862
                                for( int i = 1; i < params.length; i++ )
 
863
                                        if( valid_types.contains( params[ i ] ) )
 
864
                                                types.add( params[ i ] );
1083
865
                        }
1084
866
 
1085
867
                        return types;