/android/import-contacts

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

« back to all changes in this revision

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

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

Show diffs side-by-side

added added

removed removed

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