/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 11:57:56 UTC
  • Revision ID: tim@ed.am-20121221115756-zm37hcmc2a3wht6x
handle empty lines in vCards properly; be less case sensitive; fixed some comment typos

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 <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
 
47
 
import org.waxworlds.edam.importcontacts.Importer.ContactData.ExtraDetail;
48
 
 
 
48
import android.annotation.SuppressLint;
49
49
import android.content.SharedPreferences;
50
 
import android.provider.Contacts;
51
 
import android.provider.Contacts.PhonesColumns;
52
50
 
53
 
public class VCFImporter extends Importer
 
51
public class VcardImporter extends Importer
54
52
{
55
 
        private int _vCardCount = 0;
 
53
        private int _vcard_count = 0;
56
54
        private int _progress = 0;
57
55
 
58
 
        public VCFImporter( Doit doit )
 
56
        public VcardImporter( Doit doit )
59
57
        {
60
58
                super( doit );
61
59
        }
62
60
 
 
61
        @SuppressLint( "SdCardPath" )
63
62
        @Override
64
63
        protected void onImport() throws AbortImportException
65
64
        {
84
83
                                // get files
85
84
                                class VCardFilter implements FilenameFilter {
86
85
                                        public boolean accept( File dir, String name ) {
87
 
                                                return name.toLowerCase().endsWith( ".vcf" );
 
86
                                                return name.toLowerCase( Locale.US ).endsWith( ".vcf" );
88
87
                                        }
89
88
                                }
90
89
                                files = file.listFiles( new VCardFilter() );
112
111
                        countVCardFile( files[ i ] );
113
112
                        setTmpProgress( i );
114
113
                }
115
 
                setProgressMax( _vCardCount );  // will also update tmp progress
 
114
                setProgressMax( _vcard_count ); // will also update tmp progress
116
115
 
117
116
                // import them
118
117
                setProgress( 0 );
119
118
                for( int i = 0; i < files.length; i++ )
120
119
                        importVCardFile( files[ i ] );
 
120
                setProgress( _vcard_count );
121
121
        }
122
122
 
123
123
        private void countVCardFile( File file ) throws AbortImportException
130
130
 
131
131
                        // read
132
132
                        String line;
133
 
                        boolean inVCard = false;
 
133
                        boolean in_vcard = false;
134
134
                        while( ( line = reader.readLine() ) != null )
135
135
                        {
136
 
                                if( !inVCard ) {
 
136
                                if( !in_vcard ) {
137
137
                                        // look for vcard beginning
138
138
                                        if( line.matches( "^BEGIN:VCARD" ) ) {
139
 
                                                inVCard = true;
140
 
                                                _vCardCount++;
 
139
                                                in_vcard = true;
 
140
                                                _vcard_count++;
141
141
                                        }
142
142
                                }
143
143
                                else if( line.matches( "^END:VCARD" ) )
144
 
                                        inVCard = false;
 
144
                                        in_vcard = false;
145
145
                        }
146
146
 
147
147
                }
170
170
                        FileInputStream istream = new FileInputStream( file );
171
171
                        byte[] content = new byte[ (int)file.length() ];
172
172
                        istream.read( content );
 
173
                        istream = null;
173
174
 
174
175
                        // import
175
176
                        importVCardFileContent( content, file.getName() );
187
188
                throws AbortImportException
188
189
        {
189
190
                // go through lines
190
 
                VCard vCard = null;
 
191
                Vcard vcard = null;
 
192
                int vcard_start_line = 0;
191
193
                ContentLineIterator cli = new ContentLineIterator( content );
192
194
                while( cli.hasNext() )
193
195
                {
200
202
                                        buffer.limit() - buffer.position(), "US-ASCII" );
201
203
                        }
202
204
                        catch( UnsupportedEncodingException e ) {
203
 
                                // we know US-ASCII is supported, so appease the compiler...
 
205
                                // we know US-ASCII *is* supported, so appease the compiler...
204
206
                                line = "";
205
207
                        }
206
208
 
207
 
                        if( vCard == null ) {
 
209
                        if( vcard == null ) {
208
210
                                // look for vcard beginning
209
 
                                if( line.matches( "^BEGIN:VCARD" ) ) {
210
 
                                        setProgress( ++_progress );
211
 
                                        vCard = new VCard();
 
211
                                if( line.matches( "^BEGIN[ \t]*:[ \t]*VCARD" ) ) {
 
212
                                        setProgress( _progress++ );
 
213
                                        vcard = new Vcard();
 
214
                                        vcard_start_line = cli.getLineNumber();
212
215
                                }
213
216
                        }
214
217
                        else {
215
218
                                // look for vcard content or ending
216
 
                                if( line.matches( "^END:VCARD" ) )
 
219
                                if( line.matches( "^END[ \t]*:[ \t]*VCARD" ) )
217
220
                                {
218
 
                                        // store vcard and do away with it
 
221
                                        // finalise the vcard/contact
219
222
                                        try {
220
 
                                                vCard.finaliseParsing();
221
 
                                                importContact( vCard );
222
 
                                        }
223
 
                                        catch( VCard.ParseException e ) {
224
 
                                                skipContact();
225
 
                                                if( !showContinue(
226
 
                                                        getText( R.string.error_vcf_parse ).toString()
227
 
                                                        + fileName + "\n" + e.getMessage() ) )
228
 
                                                {
229
 
                                                        finish( ACTION_ABORT );
230
 
                                                }
231
 
                                        }
232
 
                                        catch( VCard.SkipContactException e ) {
233
 
                                                skipContact();
234
 
                                                // do nothing
235
 
                                        }
236
 
                                        vCard = null;
 
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;
237
257
                                }
238
258
                                else
239
259
                                {
240
260
                                        // try giving the line to the vcard
241
261
                                        try {
242
 
                                                vCard.parseLine( buffer, line,
 
262
                                                vcard.parseLine( buffer, line,
243
263
                                                        cli.doesNextLineLookFolded() );
244
264
                                        }
245
 
                                        catch( VCard.ParseException e ) {
 
265
                                        catch( Vcard.ParseException e ) {
246
266
                                                skipContact();
247
267
                                                if( !showContinue(
248
268
                                                        getText( R.string.error_vcf_parse ).toString()
249
 
                                                        + fileName + "\n" + e.getMessage() ) )
 
269
                                                        + fileName +
 
270
                                                        getText( R.string.error_vcf_parse_line ).toString()
 
271
                                                        + cli.getLineNumber() + "\n" + e.getMessage() ) )
250
272
                                                {
251
273
                                                        finish( ACTION_ABORT );
252
274
                                                }
254
276
                                                // although we're continuing, we still need to abort
255
277
                                                // this vCard. Further lines will be ignored until we
256
278
                                                // get to another BEGIN:VCARD line.
257
 
                                                vCard = null;
 
279
                                                vcard = null;
258
280
                                        }
259
 
                                        catch( VCard.SkipContactException e ) {
 
281
                                        catch( Vcard.SkipImportException e ) {
260
282
                                                skipContact();
261
283
                                                // abort this vCard. Further lines will be ignored until
262
284
                                                // we get to another BEGIN:VCARD line.
263
 
                                                vCard = null;
 
285
                                                vcard = null;
264
286
                                        }
265
287
                                }
266
288
                        }
271
293
        {
272
294
                protected byte[] _content = null;
273
295
                protected int _pos = 0;
 
296
                protected int _line = 0;
274
297
 
275
298
                public ContentLineIterator( byte[] content )
276
299
                {
296
319
                                        int to = ( _pos > 0 && _content[ _pos - 1 ] == '\r' &&
297
320
                                                _pos > initial_pos )? _pos - 1 : _pos;
298
321
                                        _pos++;
 
322
                                        _line++;
299
323
                                        return ByteBuffer.wrap( _content, initial_pos,
300
324
                                                to - initial_pos );
301
325
                                }
304
328
                        if( _pos != initial_pos ) {
305
329
                                int to = _pos;
306
330
                                _pos++;
 
331
                                _line++;
307
332
                                return ByteBuffer.wrap( _content, initial_pos,
308
333
                                        to - initial_pos );
309
334
                        }
326
351
                public boolean doesNextLineLookFolded()
327
352
                {
328
353
                        return _pos > 0 && _pos < _content.length &&
329
 
                                _content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
 
354
                                _content[ _pos - 1 ] == '\n' &&
 
355
                                ( _content[ _pos ] == ' ' || _content[ _pos ] == '\t' );
 
356
                }
 
357
 
 
358
                public int getLineNumber()
 
359
                {
 
360
                        return _line;
330
361
                }
331
362
        }
332
363
 
333
 
        private class VCard extends ContactData
 
364
        private class Vcard extends ContactData
334
365
        {
335
366
                private final static int NAMELEVEL_NONE = 0;
336
 
                private final static int NAMELEVEL_FN = 1;
337
 
                private final static int NAMELEVEL_N = 2;
 
367
                private final static int NAMELEVEL_N = 1;
 
368
                private final static int NAMELEVEL_FN = 2;
338
369
 
339
370
                private final static int MULTILINE_NONE = 0;
340
371
                private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
341
372
                private final static int MULTILINE_ESCAPED = 2; // v2.1 \\CRLF
342
 
                private final static int MULTILINE_FOLDED = 3;  // v3.0 folding
 
373
                private final static int MULTILINE_FOLDED = 3;  // MIME-DIR folding
343
374
 
344
375
                private String _version = null;
345
376
                private Vector< ByteBuffer > _buffers = null;
384
415
 
385
416
                        public ParseException( int res )
386
417
                        {
387
 
                                super( VCFImporter.this.getText( res ).toString() );
 
418
                                super( VcardImporter.this.getText( res ).toString() );
388
419
                        }
389
420
                }
390
421
 
391
422
                @SuppressWarnings("serial")
392
 
                protected class SkipContactException extends Exception { }
 
423
                protected class SkipImportException extends Exception { }
393
424
 
394
425
                private String extractCollonPartFromLine( ByteBuffer buffer,
395
426
                        String line, boolean former )
431
462
 
432
463
                public void parseLine( ByteBuffer buffer, String line,
433
464
                        boolean next_line_looks_folded )
434
 
                        throws ParseException, SkipContactException,
 
465
                        throws ParseException, SkipImportException,
435
466
                        AbortImportException
436
467
                {
437
468
                        // do we have a version yet?
443
474
 
444
475
                                // is it a version line?
445
476
                                if( name_and_params != null &&
446
 
                                        name_and_params.equals( "VERSION" ) )
 
477
                                        name_and_params.equalsIgnoreCase( "VERSION" ) )
447
478
                                {
448
479
                                        // yes, get it!
449
480
                                        String value = extractValueFromLine( buffer, line );
473
504
                        else
474
505
                        {
475
506
                                // name and params and the position in the buffer where the
476
 
                                // "value" part of the line start
 
507
                                // "value" part of the line starts
477
508
                                String name_and_params;
478
509
                                int pos;
479
510
 
509
540
                                }
510
541
                                else
511
542
                                {
 
543
                                        // skip empty lines
 
544
                                        if( line.trim().length() == 0 ) return;
 
545
 
512
546
                                        // get name and params from line, and since we're not
513
547
                                        // parsing a subsequent line in a multi-line, this should
514
548
                                        // not fail, or it's an error
537
571
                                for( int i = 0; i < name_param_parts.length; i++ )
538
572
                                        name_param_parts[ i ] = name_param_parts[ i ].trim();
539
573
 
 
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
 
540
583
                                // parse encoding parameter
541
584
                                String encoding = checkParam( name_param_parts, "ENCODING" );
542
 
                                if( encoding != null ) encoding = encoding.toUpperCase();
543
 
                                if( encoding != null && !encoding.equals( "8BIT" ) &&
544
 
                                        !encoding.equals( "QUOTED-PRINTABLE" ) )
545
 
                                        //&& !encoding.equals( "BASE64" ) )
 
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" ) )
546
591
                                {
547
592
                                        throw new ParseException( R.string.error_vcf_encoding );
548
593
                                }
549
594
 
550
595
                                // parse charset parameter
551
596
                                String charset = checkParam( name_param_parts, "CHARSET" );
552
 
                                if( charset != null ) charset = charset.toUpperCase();
553
 
                                if( charset != null && !charset.equals( "US-ASCII" ) &&
554
 
                                        !charset.equals( "ASCII" ) &&
555
 
                                        !charset.equals( "UTF-8" ) )
 
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" ) )
556
603
                                {
557
604
                                        throw new ParseException( R.string.error_vcf_charset );
558
605
                                }
560
607
                                // do unencoding (or default to a fake unencoding result with
561
608
                                // the raw string)
562
609
                                UnencodeResult unencoding_result = null;
563
 
                                if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
 
610
                                if( encoding != null &&
 
611
                                        encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
 
612
                                {
564
613
                                        unencoding_result = unencodeQuotedPrintable( value );
565
 
//                              else if( encoding != null && encoding.equals( "BASE64" ) )
 
614
                                }
 
615
//                              else if( encoding != null &&
 
616
//                                      encoding.equalsIgnoreCase( "BASE64" ) )
 
617
//                              {
566
618
//                                      unencoding_result = unencodeBase64( props[ 1 ], charset );
 
619
//                              }
567
620
                                if( unencoding_result != null ) {
568
621
                                        value = unencoding_result.getBuffer();
569
622
                                        if( unencoding_result.isAnotherLineRequired() )
570
623
                                                _parser_multiline_state = MULTILINE_ENCODED;
571
624
                                }
572
625
 
573
 
                                // convert 8-bit ASCII charset to US-ASCII
574
 
                                if( charset == null || charset.equals( "ASCII" ) ) {
 
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
                                {
575
633
                                        value = transcodeAsciiToUtf8( value );
576
 
                                        charset = "UTF-8";
577
634
                                }
578
635
 
579
 
                                // process charset
 
636
                                // process charset (value is now in UTF-8)
580
637
                                String string_value;
581
638
                                try {
582
639
                                        string_value = new String( value.array(), value.position(),
583
 
                                                value.limit() - value.position(), charset );
 
640
                                                value.limit() - value.position(), "UTF-8" );
584
641
                                } catch( UnsupportedEncodingException e ) {
585
642
                                        throw new ParseException( R.string.error_vcf_charset );
586
643
                                }
588
645
                                // for some entries that have semicolon-separated value parts,
589
646
                                // check to see if the value ends in an escape character, which
590
647
                                // indicates that we have a multi-line value
591
 
                                if( ( name_param_parts[ 0 ].equals( "N" ) ||
592
 
                                        name_param_parts[ 0 ].equals( "ORG" ) ||
593
 
                                        name_param_parts[ 0 ].equals( "ADR" ) ) &&
 
648
                                if( ( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) ||
 
649
                                        name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) ||
 
650
                                        name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) ) &&
594
651
                                        doesStringEndInAnEscapeChar( string_value ) )
595
652
                                {
596
653
                                        _parser_multiline_state = MULTILINE_ESCAPED;
598
655
                                                string_value.length() - 1 );
599
656
                                }
600
657
 
601
 
                                // now we know whether we're in an encoding multi-line,
602
 
                                // determine if we're in a v3 folded multi-line or not
 
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
603
660
                                if( _parser_multiline_state == MULTILINE_NONE &&
604
 
                                        _version.equals( "3.0" ) && next_line_looks_folded )
 
661
                                        next_line_looks_folded )
605
662
                                {
606
663
                                        _parser_multiline_state = MULTILINE_FOLDED;
607
664
                                }
619
676
                                if( complete_value.length() < 1 ) return;
620
677
 
621
678
                                // parse some properties
622
 
                                if( name_param_parts[ 0 ].equals( "N" ) )
 
679
                                if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
623
680
                                        parseN( name_param_parts, complete_value );
624
 
                                else if( name_param_parts[ 0 ].equals( "FN" ) )
 
681
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
625
682
                                        parseFN( name_param_parts, complete_value );
626
 
                                else if( name_param_parts[ 0 ].equals( "ORG" ) )
 
683
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
627
684
                                        parseORG( name_param_parts, complete_value );
628
 
                                else if( name_param_parts[ 0 ].equals( "TITLE" ) )
 
685
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
629
686
                                        parseTITLE( name_param_parts, complete_value );
630
 
                                else if( name_param_parts[ 0 ].equals( "TEL" ) )
 
687
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
631
688
                                        parseTEL( name_param_parts, complete_value );
632
 
                                else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
 
689
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
633
690
                                        parseEMAIL( name_param_parts, complete_value );
634
 
                                else if( name_param_parts[ 0 ].equals( "ADR" ) )
 
691
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
635
692
                                        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 );
636
697
                        }
637
698
                }
638
699
 
651
712
                        return ( count & 1 ) == 1;
652
713
                }
653
714
 
654
 
                private String[] splitValueBySemicolon( String value )
 
715
                private String[] splitValueByCharacter( String value, char character )
655
716
                {
656
 
                        // split string in to parts by semicolon
 
717
                        // split string in to parts by specified character
657
718
                        ArrayList< String > parts = new ArrayList< String >(
658
 
                                Arrays.asList( value.split(  ";" ) ) );
 
719
                                Arrays.asList( value.split( "" + character ) ) );
659
720
 
660
721
                        // go through parts
661
722
                        for( int a = 0; a < parts.size(); a++ )
669
730
                                if( a < parts.size() - 1 &&
670
731
                                        doesStringEndInAnEscapeChar( str ) )
671
732
                                {
672
 
                                        // join the next part to this part and remove the next part
 
733
                                        // append the escaped character, join the next part to this
 
734
                                        // part and remove the next part
673
735
                                        parts.set( a, str.substring( 0, str.length() - 1 ) +
674
 
                                                ';' + parts.get( a + 1 ) );
 
736
                                                character + parts.get( a + 1 ) );
675
737
                                        parts.remove( a + 1 );
676
738
 
677
739
                                        // re-visit this part
688
750
                        return parts.toArray( ret );
689
751
                }
690
752
 
 
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
 
691
802
                private void parseN( String[] params, String value )
692
803
                {
693
804
                        // already got a better name?
694
805
                        if( _name_level >= NAMELEVEL_N ) return;
695
806
 
696
807
                        // get name parts
697
 
                        String[] name_parts = splitValueBySemicolon( value );
 
808
                        String[] name_parts = splitValueByCharacter( value, ';' );
698
809
 
699
810
                        // build name
700
811
                        value = "";
701
 
                        if( name_parts.length > 1 && name_parts[ 1 ].length() > 0 )
702
 
                                value += name_parts[ 1 ];
703
 
                        if( name_parts.length > 0 && name_parts[ 0 ].length() > 0 )
704
 
                                value += ( value.length() == 0? "" : " " ) + name_parts[ 0 ];
 
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
                                }
705
827
 
706
828
                        // set name
707
 
                        setName( value );
 
829
                        setName( unescapeValue( value ) );
708
830
                        _name_level = NAMELEVEL_N;
709
831
                }
710
832
 
714
836
                        if( _name_level >= NAMELEVEL_FN ) return;
715
837
 
716
838
                        // set name
717
 
                        setName( value );
 
839
                        setName( unescapeValue( value ) );
718
840
                        _name_level = NAMELEVEL_FN;
719
841
                }
720
842
 
721
843
                private void parseORG( String[] params, String value )
722
844
                {
723
845
                        // get org parts
724
 
                        String[] org_parts = splitValueBySemicolon( value );
 
846
                        String[] org_parts = splitValueByCharacter( value, ';' );
725
847
                        if( org_parts == null || org_parts.length < 1 ) return;
726
848
 
727
849
                        // build organisation name
729
851
                                String.valueOf( org_parts[ 0 ] ) );
730
852
                        for( int a = 1; a < org_parts.length; a++ )
731
853
                                builder.append( ", " ).append( org_parts[ a ] );
732
 
                        String organisation = builder.toString();
 
854
                        String organisation = unescapeValue( builder.toString() );
733
855
 
734
856
                        // set organisation name (using a title we've previously found)
735
857
                        addOrganisation( organisation, _cached_title, true );
746
868
 
747
869
                private void parseTITLE( String[] params, String value )
748
870
                {
 
871
                        value = unescapeValue( value );
 
872
 
749
873
                        // if we previously had an organisation, look it up and append this
750
874
                        // title to it
751
875
                        if( _cached_organisation != null && hasOrganisations() ) {
773
897
                                "PAGER", "BBS", "MODEM", "CAR", "ISDN", "VIDEO" ) );
774
898
 
775
899
                        // here's the logic...
776
 
                        boolean preferred = types.contains( "PREF" );
 
900
                        boolean is_preferred = types.contains( "PREF" );
777
901
                        int type;
778
902
                        if( types.contains( "FAX" ) )
779
903
                                if( types.contains( "HOME" ) )
780
 
                                        type = PhonesColumns.TYPE_FAX_HOME;
 
904
                                        type = TYPE_FAX_HOME;
781
905
                                else
782
 
                                        type = PhonesColumns.TYPE_FAX_WORK;
 
906
                                        type = TYPE_FAX_WORK;
783
907
                        else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
784
 
                                type = PhonesColumns.TYPE_MOBILE;
 
908
                                type = TYPE_MOBILE;
785
909
                        else if( types.contains( "PAGER" ) )
786
 
                                type = PhonesColumns.TYPE_PAGER;
 
910
                                type = TYPE_PAGER;
787
911
                        else if( types.contains( "WORK" ) )
788
 
                                type = PhonesColumns.TYPE_WORK;
 
912
                                type = TYPE_WORK;
789
913
                        else
790
 
                                type = PhonesColumns.TYPE_HOME;
 
914
                                type = TYPE_HOME;
791
915
 
792
916
                        // add phone number
793
 
                        addNumber( value, type, preferred );
 
917
                        addNumber( value, type, is_preferred );
794
918
                }
795
919
 
796
920
                public void parseEMAIL( String[] params, String value )
801
925
                                "PREF", "WORK", "HOME", "INTERNET" ) );
802
926
 
803
927
                        // add email address
804
 
                        boolean preferred = types.contains( "PREF" );
 
928
                        boolean is_preferred = types.contains( "PREF" );
805
929
                        int type;
806
930
                        if( types.contains( "WORK" ) )
807
 
                                type = Contacts.ContactMethods.TYPE_WORK;
 
931
                                type = TYPE_WORK;
808
932
                        else
809
 
                                type = Contacts.ContactMethods.TYPE_HOME;
 
933
                                type = TYPE_HOME;
810
934
 
811
 
                        addEmail( value, type, preferred );
 
935
                        addEmail( unescapeValue( value ), type, is_preferred );
812
936
                }
813
937
 
814
938
                private void parseADR( String[] params, String value )
815
939
                {
816
940
                        // get address parts
817
 
                        String[] adr_parts = splitValueBySemicolon( value );
 
941
                        String[] adr_parts = splitValueByCharacter( value, ';' );
818
942
 
819
943
                        // build address
820
944
                        value = "";
821
 
                        for( int a = 0; a < adr_parts.length; a++ ) {
822
 
                                if( value.length() > 0 ) value += "\n";
823
 
                                value += adr_parts[ a ].trim();
824
 
                        }
825
 
 
826
 
                        Set< String > types = extractTypes( params, Arrays.asList(
827
 
                                "PREF", "WORK", "HOME", "INTERNET" ) );
828
 
 
829
 
                        // add address
830
 
                        int type;
831
 
                        if( types.contains( "WORK" ) )
832
 
                                type = Contacts.ContactMethods.TYPE_WORK;
833
 
                        else
834
 
                                type = Contacts.ContactMethods.TYPE_HOME;
835
 
 
836
 
                        addAddress( value, type );
837
 
                }
838
 
 
839
 
                public void finaliseParsing()
840
 
                        throws ParseException, SkipContactException,
841
 
                        AbortImportException
 
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
842
1005
                {
843
1006
                        // missing version (and data is present)
844
1007
                        if( _version == null && _buffers != null )
845
1008
                                throw new ParseException( R.string.error_vcf_malformed );
846
1009
 
847
 
                        // check if we should import this contact
848
 
                        try {
849
 
                                if( !isImportRequired( this ) )
850
 
                                        throw new SkipContactException();
851
 
                        }
852
 
                        catch( ContactNeedsMoreInfoException e ) {
853
 
                                throw new ParseException( R.string.error_vcf_notenoughinfo );
854
 
                        }
 
1010
                        // finalise the parent class
 
1011
                        finalise();
855
1012
                }
856
1013
 
 
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
                 */
857
1021
                private String checkParam( String[] params, String name )
858
1022
                {
 
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
 
859
1037
                        Pattern p = Pattern.compile(
860
 
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
 
1038
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
 
1039
                                Pattern.CASE_INSENSITIVE );
861
1040
                        for( int i = 0; i < params.length; i++ ) {
862
1041
                                Matcher m = p.matcher( params[ i ] );
863
1042
                                if( m.matches() )
864
 
                                        return m.group( 2 );
 
1043
                                        ret.add( m.group( 2 ) );
865
1044
                        }
866
 
                        return null;
 
1045
 
 
1046
                        return (String[]) ret.toArray( new String[ ret.size() ] );
867
1047
                }
868
1048
 
 
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
                 */
869
1057
                private Set< String > extractTypes( String[] params,
870
1058
                        List< String > valid_types )
871
1059
                {
872
1060
                        HashSet< String > types = new HashSet< String >();
873
1061
 
874
1062
                        // get 3.0-style TYPE= param
875
 
                        String type_param;
876
 
                        if( ( type_param = checkParam( params, "TYPE" ) ) != null ) {
877
 
                                String[] parts = type_param.split( "," );
878
 
                                for( int i = 0; i < parts.length; i++ )
879
 
                                        if( valid_types.contains( parts[ i ] ) )
880
 
                                                types.add( parts[ i ] );
 
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
                                }
881
1074
                        }
882
1075
 
883
1076
                        // get 2.1-style type param
884
1077
                        if( _version.equals( "2.1" ) ) {
885
 
                                for( int i = 1; i < params.length; i++ )
886
 
                                        if( valid_types.contains( params[ i ] ) )
887
 
                                                types.add( params[ i ] );
 
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
                                }
888
1083
                        }
889
1084
 
890
1085
                        return types;