/android/import-contacts

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

« back to all changes in this revision

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

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

Show diffs side-by-side

added added

removed removed

1
1
/*
2
2
 * VCFImporter.java
3
3
 *
4
 
 * Copyright (C) 2009 to 2013 Tim Marston <tim@ed.am>
 
4
 * Copyright (C) 2009 to 2011 Tim Marston <edam@waxworlds.org>
5
5
 *
6
6
 * This file is part of the Import Contacts program (hereafter referred
7
 
 * to as "this program").  For more information, see
8
 
 * http://ed.am/dev/android/import-contacts
 
7
 * to as "this program"). For more information, see
 
8
 * http://www.waxworlds.org/edam/software/android/import-contacts
9
9
 *
10
10
 * This program is free software: you can redistribute it and/or modify
11
11
 * it under the terms of the GNU General Public License as published by
21
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
22
 */
23
23
 
24
 
package am.ed.importcontacts;
 
24
package org.waxworlds.edam.importcontacts;
25
25
 
26
26
import java.io.BufferedReader;
27
27
import java.io.File;
38
38
import java.util.HashSet;
39
39
import java.util.Iterator;
40
40
import java.util.List;
41
 
import java.util.Locale;
42
41
import java.util.NoSuchElementException;
43
42
import java.util.Set;
44
43
import java.util.Vector;
45
44
import java.util.regex.Matcher;
46
45
import java.util.regex.Pattern;
47
46
 
48
 
import android.annotation.SuppressLint;
49
47
import android.content.SharedPreferences;
 
48
import android.provider.Contacts;
 
49
import android.provider.Contacts.PhonesColumns;
50
50
 
51
51
public class VcardImporter extends Importer
52
52
{
58
58
                super( doit );
59
59
        }
60
60
 
61
 
        @SuppressLint( "SdCardPath" )
62
61
        @Override
63
62
        protected void onImport() throws AbortImportException
64
63
        {
83
82
                                // get files
84
83
                                class VCardFilter implements FilenameFilter {
85
84
                                        public boolean accept( File dir, String name ) {
86
 
                                                return name.toLowerCase( Locale.US ).endsWith( ".vcf" );
 
85
                                                return name.toLowerCase().endsWith( ".vcf" );
87
86
                                        }
88
87
                                }
89
88
                                files = file.listFiles( new VCardFilter() );
133
132
                        boolean in_vcard = false;
134
133
                        while( ( line = reader.readLine() ) != null )
135
134
                        {
136
 
                                if( !in_vcard )
137
 
                                {
 
135
                                if( !in_vcard ) {
138
136
                                        // look for vcard beginning
139
 
                                        if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
 
137
                                        if( line.matches( "^BEGIN:VCARD" ) ) {
140
138
                                                in_vcard = true;
141
139
                                                _vcard_count++;
142
140
                                        }
143
 
                                        // check for vMsg files
144
 
                                        else if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VMSG.*" ) ) {
145
 
                                                showError( getText( R.string.error_vcf_vmsgfile )
146
 
                                                        + file.getName() );
147
 
                                        }
148
141
                                }
149
 
                                else if( line.matches( "(?i)END[ \t]*:[ \t]*VCARD.*" ) )
 
142
                                else if( line.matches( "^END:VCARD" ) )
150
143
                                        in_vcard = false;
151
144
                        }
152
 
                        reader.close();
153
145
 
154
146
                }
155
147
                catch( FileNotFoundException e ) {
177
169
                        FileInputStream istream = new FileInputStream( file );
178
170
                        byte[] content = new byte[ (int)file.length() ];
179
171
                        istream.read( content );
180
 
                        istream.close();
 
172
                        istream = null;
181
173
 
182
174
                        // import
183
175
                        importVCardFileContent( content, file.getName() );
184
176
                }
185
 
                catch( OutOfMemoryError e ) {
186
 
                        showError( R.string.error_outofmemory );
187
 
                }
188
177
                catch( FileNotFoundException e ) {
189
178
                        showError( getText( R.string.error_filenotfound ) +
190
179
                                file.getName() );
203
192
                ContentLineIterator cli = new ContentLineIterator( content );
204
193
                while( cli.hasNext() )
205
194
                {
206
 
                        ContentLine content_line = cli.next();
 
195
                        ByteBuffer buffer = cli.next();
207
196
 
208
 
                        // get a US-ASCII version of the string, for processing
209
 
                        String line = content_line.getUsAsciiLine();
 
197
                        // get a US-ASCII version of the line for processing
 
198
                        String line;
 
199
                        try {
 
200
                                line = new String( buffer.array(), buffer.position(),
 
201
                                        buffer.limit() - buffer.position(), "US-ASCII" );
 
202
                        }
 
203
                        catch( UnsupportedEncodingException e ) {
 
204
                                // we know US-ASCII is supported, so appease the compiler...
 
205
                                line = "";
 
206
                        }
210
207
 
211
208
                        if( vcard == null ) {
212
209
                                // look for vcard beginning
213
 
                                if( line.matches( "(?i)BEGIN[ \t]*:[ \t]*VCARD.*" ) ) {
 
210
                                if( line.matches( "^BEGIN:VCARD" ) ) {
214
211
                                        setProgress( _progress++ );
215
212
                                        vcard = new Vcard();
216
213
                                        vcard_start_line = cli.getLineNumber();
218
215
                        }
219
216
                        else {
220
217
                                // look for vcard content or ending
221
 
                                if( line.matches( "(?i)END[ \t]*:[ \t]*VCARD.*" ) )
 
218
                                if( line.matches( "^END:VCARD" ) )
222
219
                                {
223
220
                                        // finalise the vcard/contact
224
221
                                        try {
261
258
                                {
262
259
                                        // try giving the line to the vcard
263
260
                                        try {
264
 
                                                vcard.parseLine( content_line );
 
261
                                                vcard.parseLine( buffer, line,
 
262
                                                        cli.doesNextLineLookFolded() );
265
263
                                        }
266
264
                                        catch( Vcard.ParseException e ) {
267
265
                                                skipContact();
274
272
                                                        finish( ACTION_ABORT );
275
273
                                                }
276
274
 
277
 
                                                // Although we're continuing, we still need to abort
278
 
                                                // this vCard.  Further lines will be ignored until we
 
275
                                                // although we're continuing, we still need to abort
 
276
                                                // this vCard. Further lines will be ignored until we
279
277
                                                // get to another BEGIN:VCARD line.
280
278
                                                vcard = null;
281
279
                                        }
282
280
                                        catch( Vcard.SkipImportException e ) {
283
281
                                                skipContact();
284
 
                                                // Abort this vCard.  Further lines will be ignored until
 
282
                                                // abort this vCard. Further lines will be ignored until
285
283
                                                // we get to another BEGIN:VCARD line.
286
284
                                                vcard = null;
287
285
                                        }
290
288
                }
291
289
        }
292
290
 
293
 
        class ContentLine
294
 
        {
295
 
                private ByteBuffer _buffer;
296
 
                private boolean _folded_next;
297
 
                private String _line;
298
 
 
299
 
                public ContentLine( ByteBuffer buffer, boolean folded_next )
300
 
                {
301
 
                        _buffer = buffer;
302
 
                        _folded_next = folded_next;
303
 
                        _line = null;
304
 
                }
305
 
 
306
 
                public ByteBuffer getBuffer()
307
 
                {
308
 
                        return _buffer;
309
 
                }
310
 
 
311
 
                public boolean doesNextLineLookFolded()
312
 
                {
313
 
                        return _folded_next;
314
 
                }
315
 
 
316
 
                public String getUsAsciiLine()
317
 
                {
318
 
                        // generated line and cache it
319
 
                        if( _line == null ) {
320
 
                                try {
321
 
                                        _line = new String( _buffer.array(), _buffer.position(),
322
 
                                                _buffer.limit() - _buffer.position(), "US-ASCII" );
323
 
                                }
324
 
                                catch( UnsupportedEncodingException e ) {
325
 
                                        // we know US-ASCII *is* supported, so appease the
326
 
                                        // compiler...
327
 
                                }
328
 
                        }
329
 
 
330
 
                        // return cached line
331
 
                        return _line;
332
 
                }
333
 
        }
334
 
 
335
 
        class ContentLineIterator implements Iterator< ContentLine >
 
291
        class ContentLineIterator implements Iterator< ByteBuffer >
336
292
        {
337
293
                protected byte[] _content = null;
338
294
                protected int _pos = 0;
350
306
                }
351
307
 
352
308
                @Override
353
 
                public ContentLine next()
 
309
                public ByteBuffer next()
354
310
                {
355
311
                        int initial_pos = _pos;
356
312
 
363
319
                                                _pos > initial_pos )? _pos - 1 : _pos;
364
320
                                        _pos++;
365
321
                                        _line++;
366
 
                                        return new ContentLine(
367
 
                                                ByteBuffer.wrap( _content, initial_pos,
368
 
                                                        to - initial_pos ),
369
 
                                                doesNextLineLookFolded() );
 
322
                                        return ByteBuffer.wrap( _content, initial_pos,
 
323
                                                to - initial_pos );
370
324
                                }
371
325
 
372
326
                        // we didn't find one, but were there bytes left?
374
328
                                int to = _pos;
375
329
                                _pos++;
376
330
                                _line++;
377
 
                                return new ContentLine(
378
 
                                        ByteBuffer.wrap( _content, initial_pos,
379
 
                                                to - initial_pos ),
380
 
                                        doesNextLineLookFolded() );
 
331
                                return ByteBuffer.wrap( _content, initial_pos,
 
332
                                        to - initial_pos );
381
333
                        }
382
334
 
383
335
                        // no bytes left
395
347
                 * onto the end of this one?
396
348
                 * @return
397
349
                 */
398
 
                private boolean doesNextLineLookFolded()
 
350
                public boolean doesNextLineLookFolded()
399
351
                {
400
352
                        return _pos > 0 && _pos < _content.length &&
401
 
                                _content[ _pos - 1 ] == '\n' &&
402
 
                                ( _content[ _pos ] == ' ' || _content[ _pos ] == '\t' );
 
353
                                _content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
403
354
                }
404
355
 
405
356
                public int getLineNumber()
411
362
        private class Vcard extends ContactData
412
363
        {
413
364
                private final static int NAMELEVEL_NONE = 0;
414
 
                private final static int NAMELEVEL_N = 1;
415
 
                private final static int NAMELEVEL_FN = 2;
 
365
                private final static int NAMELEVEL_FN = 1;
 
366
                private final static int NAMELEVEL_N = 2;
416
367
 
417
368
                private final static int MULTILINE_NONE = 0;
418
369
                private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
419
370
                private final static int MULTILINE_ESCAPED = 2; // v2.1 \\CRLF
420
 
                private final static int MULTILINE_FOLDED = 3;  // MIME-DIR folding
 
371
                private final static int MULTILINE_FOLDED = 3;  // v3.0 folding
421
372
 
422
373
                private String _version = null;
423
 
                private Vector< ContentLine > _content_lines = null;
 
374
                private Vector< ByteBuffer > _buffers = null;
424
375
                private int _name_level = NAMELEVEL_NONE;
425
376
                private int _parser_multiline_state = MULTILINE_NONE;
426
377
                private String _parser_current_name_and_params = null;
469
420
                @SuppressWarnings("serial")
470
421
                protected class SkipImportException extends Exception { }
471
422
 
472
 
                private String extractCollonPartFromLine( ContentLine content_line,
473
 
                        boolean former )
 
423
                private String extractCollonPartFromLine( ByteBuffer buffer,
 
424
                        String line, boolean former )
474
425
                {
 
426
                        String ret = null;
 
427
 
 
428
                        // get a US-ASCII version of the line for processing, unless we were
 
429
                        // supplied with one
 
430
                        if( line == null ) {
 
431
                                try {
 
432
                                        line = new String( buffer.array(), buffer.position(),
 
433
                                                buffer.limit() - buffer.position(), "US-ASCII" );
 
434
                                }
 
435
                                catch( UnsupportedEncodingException e ) {
 
436
                                        // we know US-ASCII is supported, so appease the compiler...
 
437
                                        line = "";
 
438
                                }
 
439
                        }
 
440
 
475
441
                        // split line into name and value parts and check to make sure we
476
442
                        // only got 2 parts and that the first part is not zero in length
477
 
                        String[] parts = content_line.getUsAsciiLine().split( ":", 2 );
 
443
                        String[] parts = line.split( ":", 2 );
478
444
                        if( parts.length == 2 && parts[ 0 ].length() > 0 )
479
 
                                return parts[ former? 0 : 1 ].trim();
480
 
 
481
 
                        return null;
482
 
                }
483
 
 
484
 
                private String extractNameAndParamsFromLine( ContentLine content_line )
485
 
                {
486
 
                        return extractCollonPartFromLine( content_line, true );
487
 
                }
488
 
 
489
 
                private String extractValueFromLine( ContentLine content_line )
490
 
                {
491
 
                        return extractCollonPartFromLine( content_line, false );
492
 
                }
493
 
 
494
 
                public void parseLine( ContentLine content_line )
 
445
                                ret = parts[ former? 0 : 1 ];
 
446
 
 
447
                        return ret;
 
448
                }
 
449
 
 
450
                private String extractNameAndParamsFromLine( ByteBuffer buffer,
 
451
                        String line )
 
452
                {
 
453
                        return extractCollonPartFromLine( buffer, line, true );
 
454
                }
 
455
 
 
456
                private String extractValueFromLine( ByteBuffer buffer, String line )
 
457
                {
 
458
                        return extractCollonPartFromLine( buffer, line, false );
 
459
                }
 
460
 
 
461
                public void parseLine( ByteBuffer buffer, String line,
 
462
                        boolean next_line_looks_folded )
495
463
                        throws ParseException, SkipImportException,
496
464
                        AbortImportException
497
465
                {
500
468
                        {
501
469
                                // tentatively get name and params from line
502
470
                                String name_and_params =
503
 
                                        extractNameAndParamsFromLine( content_line );
 
471
                                        extractNameAndParamsFromLine( buffer, line );
504
472
 
505
473
                                // is it a version line?
506
474
                                if( name_and_params != null &&
507
 
                                        name_and_params.equalsIgnoreCase( "VERSION" ) )
 
475
                                        name_and_params.equals( "VERSION" ) )
508
476
                                {
509
477
                                        // yes, get it!
510
 
                                        String value = extractValueFromLine( content_line );
511
 
                                        if( value == null || (
512
 
                                                !value.equals( "2.1" ) && !value.equals( "3.0" ) ) )
513
 
                                        {
 
478
                                        String value = extractValueFromLine( buffer, line );
 
479
                                        if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
514
480
                                                throw new ParseException( R.string.error_vcf_version );
515
 
                                        }
516
481
                                        _version = value;
517
482
 
518
483
                                        // parse any buffers we've been accumulating while we waited
519
484
                                        // for a version
520
 
                                        if( _content_lines != null )
521
 
                                                for( int i = 0; i < _content_lines.size(); i++ )
522
 
                                                        parseLine( _content_lines.get( i ) );
523
 
                                        _content_lines = null;
 
485
                                        if( _buffers != null )
 
486
                                                for( int i = 0; i < _buffers.size(); i++ )
 
487
                                                        parseLine( _buffers.get( i ), null,
 
488
                                                                i + 1 < _buffers.size() &&
 
489
                                                                _buffers.get( i + 1 ).hasRemaining() &&
 
490
                                                                _buffers.get( i + 1 ).get(
 
491
                                                                        _buffers.get( i + 1 ).position() ) == ' ' );
 
492
                                        _buffers = null;
524
493
                                }
525
494
                                else
526
495
                                {
527
496
                                        // no, so stash this line till we get a version
528
 
                                        if( _content_lines == null )
529
 
                                                _content_lines = new Vector< ContentLine >();
530
 
                                        _content_lines.add( content_line );
 
497
                                        if( _buffers == null )
 
498
                                                _buffers = new Vector< ByteBuffer >();
 
499
                                        _buffers.add( buffer );
531
500
                                }
532
501
                        }
533
502
                        else
534
503
                        {
535
504
                                // name and params and the position in the buffer where the
536
 
                                // "value" part of the line starts
 
505
                                // "value" part of the line start
537
506
                                String name_and_params;
538
507
                                int pos;
539
508
 
545
514
 
546
515
                                        // skip some initial line characters, depending on the type
547
516
                                        // of multi-line we're handling
548
 
                                        pos = content_line.getBuffer().position();
 
517
                                        pos = buffer.position();
549
518
                                        switch( _parser_multiline_state )
550
519
                                        {
551
520
                                        case MULTILINE_FOLDED:
552
521
                                                pos++;
553
522
                                                break;
554
523
                                        case MULTILINE_ENCODED:
555
 
                                                while( pos < content_line.getBuffer().limit() && (
556
 
                                                        content_line.getBuffer().get( pos ) == ' ' ||
557
 
                                                        content_line.getBuffer().get( pos ) == '\t' ) )
 
524
                                                while( pos < buffer.limit() && (
 
525
                                                        buffer.get( pos ) == ' ' ||
 
526
                                                        buffer.get( pos ) == '\t' ) )
558
527
                                                {
559
528
                                                        pos++;
560
529
                                                }
569
538
                                }
570
539
                                else
571
540
                                {
572
 
                                        // skip empty lines
573
 
                                        if( content_line.getUsAsciiLine().trim().length() == 0 )
574
 
                                                return;
575
 
 
576
541
                                        // get name and params from line, and since we're not
577
542
                                        // parsing a subsequent line in a multi-line, this should
578
543
                                        // not fail, or it's an error
579
544
                                        name_and_params =
580
 
                                                extractNameAndParamsFromLine( content_line );
 
545
                                                extractNameAndParamsFromLine( buffer, line );
581
546
                                        if( name_and_params == null )
582
547
                                                throw new ParseException(
583
548
                                                        R.string.error_vcf_malformed );
584
549
 
585
550
                                        // calculate how many chars to skip from beginning of line
586
551
                                        // so we skip the property "name:" part
587
 
                                        pos = content_line.getBuffer().position() +
588
 
                                                name_and_params.length() + 1;
 
552
                                        pos = buffer.position() + name_and_params.length() + 1;
589
553
 
590
554
                                        // reset the saved multi-line state
591
555
                                        _parser_current_name_and_params = name_and_params;
594
558
 
595
559
                                // get value from buffer, as raw bytes
596
560
                                ByteBuffer value;
597
 
                                value = ByteBuffer.wrap( content_line.getBuffer().array(), pos,
598
 
                                        content_line.getBuffer().limit() - pos );
 
561
                                value = ByteBuffer.wrap( buffer.array(), pos,
 
562
                                        buffer.limit() - pos );
599
563
 
600
564
                                // get parameter parts
601
565
                                String[] name_param_parts = name_and_params.split( ";", -1 );
604
568
 
605
569
                                // determine whether we care about this entry
606
570
                                final HashSet< String > interesting_fields =
607
 
                                        new HashSet< String >( Arrays.asList( new String[] { "N",
608
 
                                                "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
 
571
                                        new HashSet< String >( Arrays.asList( new String[]
 
572
                                                { "N", "FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR" }
609
573
                                ) );
610
574
                                boolean is_interesting_field =
611
 
                                        interesting_fields.contains(
612
 
                                                name_param_parts[ 0 ].toUpperCase( Locale.US ) );
 
575
                                        interesting_fields.contains( name_param_parts[ 0 ] );
613
576
 
614
577
                                // parse encoding parameter
615
578
                                String encoding = checkParam( name_param_parts, "ENCODING" );
616
 
                                if( encoding != null )
617
 
                                        encoding = encoding.toUpperCase( Locale.US );
 
579
                                if( encoding != null ) encoding = encoding.toUpperCase();
618
580
                                if( is_interesting_field && encoding != null &&
619
 
                                        !encoding.equalsIgnoreCase( "8BIT" ) &&
620
 
                                        !encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
621
 
                                        //&& !encoding.equalsIgnoreCase( "BASE64" ) )
 
581
                                        !encoding.equals( "8BIT" ) &&
 
582
                                        !encoding.equals( "QUOTED-PRINTABLE" ) )
 
583
                                        //&& !encoding.equals( "BASE64" ) )
622
584
                                {
623
585
                                        throw new ParseException( R.string.error_vcf_encoding );
624
586
                                }
625
587
 
626
588
                                // parse charset parameter
627
589
                                String charset = checkParam( name_param_parts, "CHARSET" );
628
 
                                if( charset != null )
629
 
                                        charset = charset.toUpperCase( Locale.US );
 
590
                                if( charset != null ) charset = charset.toUpperCase();
630
591
                                if( charset != null &&
631
 
                                        !charset.equalsIgnoreCase( "US-ASCII" ) &&
632
 
                                        !charset.equalsIgnoreCase( "ASCII" ) &&
633
 
                                        !charset.equalsIgnoreCase( "UTF-8" ) )
 
592
                                        !charset.equals( "US-ASCII" ) &&
 
593
                                        !charset.equals( "ASCII" ) &&
 
594
                                        !charset.equals( "UTF-8" ) )
634
595
                                {
635
596
                                        throw new ParseException( R.string.error_vcf_charset );
636
597
                                }
638
599
                                // do unencoding (or default to a fake unencoding result with
639
600
                                // the raw string)
640
601
                                UnencodeResult unencoding_result = null;
641
 
                                if( encoding != null &&
642
 
                                        encoding.equalsIgnoreCase( "QUOTED-PRINTABLE" ) )
643
 
                                {
 
602
                                if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
644
603
                                        unencoding_result = unencodeQuotedPrintable( value );
645
 
                                }
646
 
//                              else if( encoding != null &&
647
 
//                                      encoding.equalsIgnoreCase( "BASE64" ) )
648
 
//                              {
 
604
//                              else if( encoding != null && encoding.equals( "BASE64" ) )
649
605
//                                      unencoding_result = unencodeBase64( props[ 1 ], charset );
650
 
//                              }
651
606
                                if( unencoding_result != null ) {
652
607
                                        value = unencoding_result.getBuffer();
653
608
                                        if( unencoding_result.isAnotherLineRequired() )
654
609
                                                _parser_multiline_state = MULTILINE_ENCODED;
655
610
                                }
656
611
 
657
 
                                // convert 8-bit US-ASCII charset to UTF-8 (where no charset is
658
 
                                // specified for a v2.1 vcard entry, we assume it's US-ASCII)
659
 
                                if( ( charset == null && _version.equals( "2.1" ) ) ||
660
 
                                        ( charset != null && (
661
 
                                                charset.equalsIgnoreCase( "ASCII" ) ||
662
 
                                                charset.equalsIgnoreCase( "US-ASCII" ) ) ) )
663
 
                                {
 
612
                                // convert 8-bit ASCII charset to US-ASCII
 
613
                                if( charset == null || charset.equals( "ASCII" ) ) {
664
614
                                        value = transcodeAsciiToUtf8( value );
 
615
                                        charset = "UTF-8";
665
616
                                }
666
617
 
667
 
                                // process charset (value is now in UTF-8)
 
618
                                // process charset
668
619
                                String string_value;
669
620
                                try {
670
621
                                        string_value = new String( value.array(), value.position(),
671
 
                                                value.limit() - value.position(), "UTF-8" );
 
622
                                                value.limit() - value.position(), charset );
672
623
                                } catch( UnsupportedEncodingException e ) {
673
624
                                        throw new ParseException( R.string.error_vcf_charset );
674
625
                                }
676
627
                                // for some entries that have semicolon-separated value parts,
677
628
                                // check to see if the value ends in an escape character, which
678
629
                                // indicates that we have a multi-line value
679
 
                                if( ( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) ||
680
 
                                        name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) ||
681
 
                                        name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) ) &&
 
630
                                if( ( name_param_parts[ 0 ].equals( "N" ) ||
 
631
                                        name_param_parts[ 0 ].equals( "ORG" ) ||
 
632
                                        name_param_parts[ 0 ].equals( "ADR" ) ) &&
682
633
                                        doesStringEndInAnEscapeChar( string_value ) )
683
634
                                {
684
635
                                        _parser_multiline_state = MULTILINE_ESCAPED;
686
637
                                                string_value.length() - 1 );
687
638
                                }
688
639
 
689
 
                                // if we know we're not in an encoding-based multi-line, check
690
 
                                // to see if we're in a folded multi-line
 
640
                                // now we know whether we're in an encoding multi-line,
 
641
                                // determine if we're in a v3 folded multi-line or not
691
642
                                if( _parser_multiline_state == MULTILINE_NONE &&
692
 
                                        content_line.doesNextLineLookFolded() )
 
643
                                        _version.equals( "3.0" ) && next_line_looks_folded )
693
644
                                {
694
645
                                        _parser_multiline_state = MULTILINE_FOLDED;
695
646
                                }
707
658
                                if( complete_value.length() < 1 ) return;
708
659
 
709
660
                                // parse some properties
710
 
                                if( name_param_parts[ 0 ].equalsIgnoreCase( "N" ) )
 
661
                                if( name_param_parts[ 0 ].equals( "N" ) )
711
662
                                        parseN( name_param_parts, complete_value );
712
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "FN" ) )
 
663
                                else if( name_param_parts[ 0 ].equals( "FN" ) )
713
664
                                        parseFN( name_param_parts, complete_value );
714
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "ORG" ) )
 
665
                                else if( name_param_parts[ 0 ].equals( "ORG" ) )
715
666
                                        parseORG( name_param_parts, complete_value );
716
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "TITLE" ) )
 
667
                                else if( name_param_parts[ 0 ].equals( "TITLE" ) )
717
668
                                        parseTITLE( name_param_parts, complete_value );
718
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "TEL" ) )
 
669
                                else if( name_param_parts[ 0 ].equals( "TEL" ) )
719
670
                                        parseTEL( name_param_parts, complete_value );
720
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "EMAIL" ) )
 
671
                                else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
721
672
                                        parseEMAIL( name_param_parts, complete_value );
722
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "ADR" ) )
 
673
                                else if( name_param_parts[ 0 ].equals( "ADR" ) )
723
674
                                        parseADR( name_param_parts, complete_value );
724
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "LABEL" ) )
725
 
                                        parseLABEL( name_param_parts, complete_value );
726
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "NOTE" ) )
727
 
                                        parseNOTE( name_param_parts, complete_value );
728
 
                                else if( name_param_parts[ 0 ].equalsIgnoreCase( "BDAY" ) )
729
 
                                        parseBDAY( name_param_parts, complete_value );
730
675
                        }
731
676
                }
732
677
 
745
690
                        return ( count & 1 ) == 1;
746
691
                }
747
692
 
748
 
                private String[] splitValueByCharacter( String value, char character )
 
693
                private String[] splitValueBySemicolon( String value )
749
694
                {
750
 
                        // split string in to parts by specified character
 
695
                        // split string in to parts by semicolon
751
696
                        ArrayList< String > parts = new ArrayList< String >(
752
 
                                Arrays.asList( value.split( "" + character ) ) );
 
697
                                Arrays.asList( value.split(  ";" ) ) );
753
698
 
754
699
                        // go through parts
755
700
                        for( int a = 0; a < parts.size(); a++ )
756
701
                        {
757
702
                                String str = parts.get( a );
758
703
 
759
 
                                // Look for parts that end in an escape character, but ignore
760
 
                                // the final part.  We've already detected escape chars at the
 
704
                                // look for parts that end in an escape character, but ignore
 
705
                                // the final part. We've already detected escape chars at the
761
706
                                // end of the final part in parseLine() and handled multi-lines
762
707
                                // accordingly.
763
708
                                if( a < parts.size() - 1 &&
764
709
                                        doesStringEndInAnEscapeChar( str ) )
765
710
                                {
766
 
                                        // append the escaped character, join the next part to this
767
 
                                        // part and remove the next part
 
711
                                        // join the next part to this part and remove the next part
768
712
                                        parts.set( a, str.substring( 0, str.length() - 1 ) +
769
 
                                                character + parts.get( a + 1 ) );
 
713
                                                ';' + parts.get( a + 1 ) );
770
714
                                        parts.remove( a + 1 );
771
715
 
772
716
                                        // re-visit this part
783
727
                        return parts.toArray( ret );
784
728
                }
785
729
 
786
 
                private String unescapeValue( String value )
787
 
                {
788
 
                        StringBuilder ret = new StringBuilder( value.length() );
789
 
                        boolean in_escape = false;
790
 
                        for( int a = 0; a < value.length(); a++ )
791
 
                        {
792
 
                                int c = value.codePointAt( a );
793
 
 
794
 
                                // process a normal character
795
 
                                if( !in_escape ) {
796
 
                                        if( c == '\\' )
797
 
                                                in_escape = true;
798
 
                                        else
799
 
                                                ret.append( Character.toChars( c ) );
800
 
                                        continue;
801
 
                                }
802
 
 
803
 
                                // process an escape sequence
804
 
                                in_escape = false;
805
 
                                switch( c )
806
 
                                {
807
 
                                case 'T':
808
 
                                case 't':
809
 
                                        // add tab (invalid/non-standard, but accepted)
810
 
                                        ret.append( '\t' );
811
 
                                        break;
812
 
                                case 'N':
813
 
                                case 'n':
814
 
                                        // add newline
815
 
                                        ret.append( '\n' );
816
 
                                        break;
817
 
                                case '\\':
818
 
                                case ',':
819
 
                                case ';':
820
 
                                        // add escaped character
821
 
                                        ret.append( Character.toChars( c ) );
822
 
                                        break;
823
 
                                default:
824
 
                                        // unknown escape sequence, so add it unescaped
825
 
                                        // (invalid/non-standard, but accepted)
826
 
                                        ret.append( "\\" );
827
 
                                        ret.append( Character.toChars( c ) );
828
 
                                        break;
829
 
                                }
830
 
                        }
831
 
 
832
 
                        return ret.toString();
833
 
                }
834
 
 
835
730
                private void parseN( String[] params, String value )
836
731
                {
837
732
                        // already got a better name?
838
733
                        if( _name_level >= NAMELEVEL_N ) return;
839
734
 
840
735
                        // get name parts
841
 
                        String[] name_parts = splitValueByCharacter( value, ';' );
 
736
                        String[] name_parts = splitValueBySemicolon( value );
842
737
 
843
738
                        // build name
844
739
                        value = "";
845
 
                        final int[] part_order = { 3, 1, 2, 0, 4 };
846
 
                        for( int a = 0; a < part_order.length; a++ )
847
 
                                if( name_parts.length > part_order[ a ] &&
848
 
                                        name_parts[ part_order[ a ] ].length() > 0 )
849
 
                                {
850
 
                                        // split this part in to it's comma-separated bits
851
 
                                        String[] name_part_parts = splitValueByCharacter(
852
 
                                                name_parts[ part_order[ a ] ], ',' );
853
 
                                        for( int b = 0; b < name_part_parts.length; b++ )
854
 
                                                if( name_part_parts[ b ].length() > 0 )
855
 
                                                {
856
 
                                                        if( value.length() > 0 ) value += " ";
857
 
                                                        value += name_part_parts[ b ];
858
 
                                                }
859
 
                                }
 
740
                        if( name_parts.length > 1 && name_parts[ 1 ].length() > 0 )
 
741
                                value += name_parts[ 1 ];
 
742
                        if( name_parts.length > 0 && name_parts[ 0 ].length() > 0 )
 
743
                                value += ( value.length() == 0? "" : " " ) + name_parts[ 0 ];
860
744
 
861
745
                        // set name
862
 
                        setName( unescapeValue( value ) );
 
746
                        setName( value );
863
747
                        _name_level = NAMELEVEL_N;
864
748
                }
865
749
 
869
753
                        if( _name_level >= NAMELEVEL_FN ) return;
870
754
 
871
755
                        // set name
872
 
                        setName( unescapeValue( value ) );
 
756
                        setName( value );
873
757
                        _name_level = NAMELEVEL_FN;
874
758
                }
875
759
 
876
760
                private void parseORG( String[] params, String value )
877
761
                {
878
762
                        // get org parts
879
 
                        String[] org_parts = splitValueByCharacter( value, ';' );
 
763
                        String[] org_parts = splitValueBySemicolon( value );
880
764
                        if( org_parts == null || org_parts.length < 1 ) return;
881
765
 
882
766
                        // build organisation name
884
768
                                String.valueOf( org_parts[ 0 ] ) );
885
769
                        for( int a = 1; a < org_parts.length; a++ )
886
770
                                builder.append( ", " ).append( org_parts[ a ] );
887
 
                        String organisation = unescapeValue( builder.toString() );
 
771
                        String organisation = builder.toString();
888
772
 
889
773
                        // set organisation name (using a title we've previously found)
890
774
                        addOrganisation( organisation, _cached_title, true );
901
785
 
902
786
                private void parseTITLE( String[] params, String value )
903
787
                {
904
 
                        value = unescapeValue( value );
905
 
 
906
788
                        // if we previously had an organisation, look it up and append this
907
789
                        // title to it
908
790
                        if( _cached_organisation != null && hasOrganisations() ) {
934
816
                        int type;
935
817
                        if( types.contains( "FAX" ) )
936
818
                                if( types.contains( "HOME" ) )
937
 
                                        type = TYPE_FAX_HOME;
 
819
                                        type = PhonesColumns.TYPE_FAX_HOME;
938
820
                                else
939
 
                                        type = TYPE_FAX_WORK;
 
821
                                        type = PhonesColumns.TYPE_FAX_WORK;
940
822
                        else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
941
 
                                type = TYPE_MOBILE;
 
823
                                type = PhonesColumns.TYPE_MOBILE;
942
824
                        else if( types.contains( "PAGER" ) )
943
 
                                type = TYPE_PAGER;
 
825
                                type = PhonesColumns.TYPE_PAGER;
944
826
                        else if( types.contains( "WORK" ) )
945
 
                                type = TYPE_WORK;
 
827
                                type = PhonesColumns.TYPE_WORK;
946
828
                        else
947
 
                                type = TYPE_HOME;
 
829
                                type = PhonesColumns.TYPE_HOME;
948
830
 
949
831
                        // add phone number
950
832
                        addNumber( value, type, is_preferred );
961
843
                        boolean is_preferred = types.contains( "PREF" );
962
844
                        int type;
963
845
                        if( types.contains( "WORK" ) )
964
 
                                type = TYPE_WORK;
 
846
                                type = Contacts.ContactMethods.TYPE_WORK;
965
847
                        else
966
 
                                type = TYPE_HOME;
 
848
                                type = Contacts.ContactMethods.TYPE_HOME;
967
849
 
968
 
                        addEmail( unescapeValue( value ), type, is_preferred );
 
850
                        addEmail( value, type, is_preferred );
969
851
                }
970
852
 
971
853
                private void parseADR( String[] params, String value )
972
854
                {
973
855
                        // get address parts
974
 
                        String[] adr_parts = splitValueByCharacter( value, ';' );
 
856
                        String[] adr_parts = splitValueBySemicolon( value );
975
857
 
976
858
                        // build address
977
859
                        value = "";
978
 
                        for( int a = 0; a < adr_parts.length; a++ )
979
 
                                if( adr_parts[ a ].length() > 0 )
980
 
                                {
981
 
                                        // version 3.0 vCards allow further splitting by comma
982
 
                                        if( _version.equals( "3.0" ) )
983
 
                                        {
984
 
                                                // split this part in to it's comma-separated bits and
985
 
                                                // add them on individual lines
986
 
                                                String[] adr_part_parts =
987
 
                                                        splitValueByCharacter( adr_parts[ a ], ',' );
988
 
                                                for( int b = 0; b < adr_part_parts.length; b++ )
989
 
                                                        if( adr_part_parts[ b ].length() > 0 )
990
 
                                                        {
991
 
                                                                if( value.length() > 0 ) value += "\n";
992
 
                                                                value += adr_part_parts[ b ];
993
 
                                                        }
994
 
                                        }
995
 
                                        else
996
 
                                        {
997
 
                                                // add this part on an individual line
998
 
                                                if( value.length() > 0 ) value += "\n";
999
 
                                                value += adr_parts[ a ];
1000
 
                                        }
1001
 
                                }
1002
 
 
1003
 
                        Set< String > types = extractTypes( params, Arrays.asList(
1004
 
                                "PREF", "WORK", "HOME" ) );
1005
 
 
1006
 
                        // add address
1007
 
                        int type;
1008
 
                        if( types.contains( "WORK" ) )
1009
 
                                type = TYPE_WORK;
1010
 
                        else
1011
 
                                type = TYPE_HOME;
1012
 
 
1013
 
                        addAddress( unescapeValue( value ), type );
1014
 
                }
1015
 
 
1016
 
                private void parseLABEL( String[] params, String value )
1017
 
                {
1018
 
                        Set< String > types = extractTypes( params, Arrays.asList(
1019
 
                                "PREF", "WORK", "HOME" ) );
1020
 
 
1021
 
                        // add address
1022
 
                        int type;
1023
 
                        if( types.contains( "WORK" ) )
1024
 
                                type = TYPE_WORK;
1025
 
                        else
1026
 
                                type = TYPE_HOME;
1027
 
 
1028
 
                        addAddress( unescapeValue( value ), type );
1029
 
                }
1030
 
 
1031
 
                private void parseNOTE( String[] params, String value )
1032
 
                {
1033
 
                        addNote( unescapeValue( value ) );
1034
 
                }
1035
 
 
1036
 
                private void parseBDAY( String[] params, String value )
1037
 
                {
1038
 
                        setBirthday( value );
 
860
                        for( int a = 0; a < adr_parts.length; a++ ) {
 
861
                                if( value.length() > 0 ) value += "\n";
 
862
                                value += adr_parts[ a ].trim();
 
863
                        }
 
864
 
 
865
                        Set< String > types = extractTypes( params, Arrays.asList(
 
866
                                "PREF", "WORK", "HOME", "INTERNET" ) );
 
867
 
 
868
                        // add address
 
869
                        int type;
 
870
                        if( types.contains( "WORK" ) )
 
871
                                type = Contacts.ContactMethods.TYPE_WORK;
 
872
                        else
 
873
                                type = Contacts.ContactMethods.TYPE_HOME;
 
874
 
 
875
                        addAddress( value, type );
1039
876
                }
1040
877
 
1041
878
                public void finaliseVcard()
1042
879
                        throws ParseException, ContactNotIdentifiableException
1043
880
                {
1044
881
                        // missing version (and data is present)
1045
 
                        if( _version == null && _content_lines != null )
 
882
                        if( _version == null && _buffers != null )
1046
883
                                throw new ParseException( R.string.error_vcf_malformed );
1047
884
 
1048
885
                        // finalise the parent class
1049
886
                        finalise();
1050
887
                }
1051
888
 
1052
 
                /**
1053
 
                 * Amongst the params, find the value of the first, only, of any with
1054
 
                 * the specified name.
1055
 
                 *
1056
 
                 * @param params
1057
 
                 * @param name
1058
 
                 * @return a value, or null
1059
 
                 */
1060
889
                private String checkParam( String[] params, String name )
1061
890
                {
1062
 
                        String[] res = checkParams( params, name );
1063
 
                        return res.length > 0? res[ 0 ] : null;
1064
 
                }
1065
 
 
1066
 
                /**
1067
 
                 * Amongst the params, find the values of any with the specified name.
1068
 
                 *
1069
 
                 * @param params
1070
 
                 * @param name
1071
 
                 * @return an array of values, or null
1072
 
                 */
1073
 
                private String[] checkParams( String[] params, String name )
1074
 
                {
1075
 
                        HashSet< String > ret = new HashSet< String >();
1076
 
 
1077
891
                        Pattern p = Pattern.compile(
1078
 
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1079
 
                                Pattern.CASE_INSENSITIVE );
 
892
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1080
893
                        for( int i = 0; i < params.length; i++ ) {
1081
894
                                Matcher m = p.matcher( params[ i ] );
1082
895
                                if( m.matches() )
1083
 
                                        ret.add( m.group( 2 ) );
 
896
                                        return m.group( 2 );
1084
897
                        }
1085
 
 
1086
 
                        return (String[]) ret.toArray( new String[ ret.size() ] );
 
898
                        return null;
1087
899
                }
1088
900
 
1089
 
                /**
1090
 
                 * Amongst the params, return any type values present.  For v2.1 vCards,
1091
 
                 * those types are just parameters.  For v3.0, they are prefixed with
1092
 
                 * "TYPE=".  There may also be multiple type parameters.
1093
 
                 *
1094
 
                 * @param params an array of params to look for types in
1095
 
                 * @param valid_types an list of upper-case type values to look for
1096
 
                 * @return a set of present type values
1097
 
                 */
1098
901
                private Set< String > extractTypes( String[] params,
1099
902
                        List< String > valid_types )
1100
903
                {
1101
904
                        HashSet< String > types = new HashSet< String >();
1102
905
 
1103
906
                        // get 3.0-style TYPE= param
1104
 
                        String type_params[] = checkParams( params, "TYPE" );
1105
 
                        for( int a = 0; a < type_params.length; a++ )
1106
 
                        {
1107
 
                                // check for a comma-separated list of types (why? I don't think
1108
 
                                // this is in the specs!)
1109
 
                                String[] parts = type_params[ a ].split( "," );
1110
 
                                for( int i = 0; i < parts.length; i++ ) {
1111
 
                                        String ucpart = parts[ i ].toUpperCase( Locale.US );
1112
 
                                        if( valid_types.contains( ucpart ) )
1113
 
                                                types.add( ucpart );
1114
 
                                }
 
907
                        String type_param;
 
908
                        if( ( type_param = checkParam( params, "TYPE" ) ) != null ) {
 
909
                                String[] parts = type_param.split( "," );
 
910
                                for( int i = 0; i < parts.length; i++ )
 
911
                                        if( valid_types.contains( parts[ i ] ) )
 
912
                                                types.add( parts[ i ] );
1115
913
                        }
1116
914
 
1117
915
                        // get 2.1-style type param
1118
916
                        if( _version.equals( "2.1" ) ) {
1119
 
                                for( int i = 1; i < params.length; i++ ) {
1120
 
                                        String ucparam = params[ i ].toUpperCase( Locale.US );
1121
 
                                        if( valid_types.contains( ucparam ) )
1122
 
                                                types.add( ucparam );
1123
 
                                }
 
917
                                for( int i = 1; i < params.length; i++ )
 
918
                                        if( valid_types.contains( params[ i ] ) )
 
919
                                                types.add( params[ i ] );
1124
920
                        }
1125
921
 
1126
922
                        return types;
1148
944
                                else if( ch == '=' && i == in.limit() - 1 )
1149
945
                                {
1150
946
                                        // we found a '=' at the end of a line signifying a multi-
1151
 
                                        // line string, so we don't add it
 
947
                                        // line string, so we don't add it.
1152
948
                                        another = true;
1153
949
                                        continue;
1154
950
                                }