/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: 2010-10-17 18:43:13 UTC
  • Revision ID: edam@waxworlds.org-20101017184313-y2m6gsdzctjq5wtl
- changed case on charset and encoding warning strings (it looked bad)
- properly handle quoted-printable unencoding (including multi-line values)
- ignore blank lines in vCard
- ignore empty properties in vCard

Show diffs side-by-side

added added

removed removed

1
1
/*
2
2
 * VCFImporter.java
3
3
 *
4
 
 * Copyright (C) 2009 to 2011 Tim Marston <edam@waxworlds.org>
 
4
 * Copyright (C) 2009 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
25
25
 
26
26
import java.io.BufferedReader;
27
27
import java.io.File;
28
 
import java.io.FileInputStream;
29
28
import java.io.FileNotFoundException;
30
29
import java.io.FileReader;
31
30
import java.io.FilenameFilter;
32
31
import java.io.IOException;
33
32
import java.io.UnsupportedEncodingException;
34
 
import java.nio.ByteBuffer;
35
 
import java.util.ArrayList;
36
33
import java.util.Arrays;
37
 
import java.util.HashMap;
38
34
import java.util.HashSet;
39
 
import java.util.Iterator;
40
35
import java.util.List;
41
 
import java.util.NoSuchElementException;
42
36
import java.util.Set;
43
37
import java.util.Vector;
44
38
import java.util.regex.Matcher;
50
44
 
51
45
public class VCFImporter extends Importer
52
46
{
53
 
        private int _vcard_count = 0;
 
47
        private int _vCardCount = 0;
54
48
        private int _progress = 0;
55
49
 
56
50
        public VCFImporter( Doit doit )
71
65
                try
72
66
                {
73
67
                        // open directory
74
 
                        String path = "/sdcard" + prefs.getString( "location", "/" );
75
 
                        File file = new File( path );
76
 
                        if( !file.exists() )
 
68
                        String location = prefs.getString( "location", "" );
 
69
                        File dir = new File( location );
 
70
                        if( !dir.exists() )
77
71
                                showError( R.string.error_locationnotfound );
78
72
 
79
73
                        // directory, or file?
80
 
                        if( file.isDirectory() )
 
74
                        if( dir.isDirectory() )
81
75
                        {
82
76
                                // get files
83
77
                                class VCardFilter implements FilenameFilter {
85
79
                                                return name.toLowerCase().endsWith( ".vcf" );
86
80
                                        }
87
81
                                }
88
 
                                files = file.listFiles( new VCardFilter() );
 
82
                                files = dir.listFiles( new VCardFilter() );
89
83
                        }
90
84
                        else
91
85
                        {
92
86
                                // use just this file
93
87
                                files = new File[ 1 ];
94
 
                                files[ 0 ] = file;
 
88
                                files[ 0 ] = dir;
95
89
                        }
96
90
                }
97
91
                catch( SecurityException e ) {
110
104
                        countVCardFile( files[ i ] );
111
105
                        setTmpProgress( i );
112
106
                }
113
 
                setProgressMax( _vcard_count ); // will also update tmp progress
 
107
                setProgressMax( _vCardCount );  // will also update tmp progress
114
108
 
115
109
                // import them
116
110
                setProgress( 0 );
124
118
                {
125
119
                        // open file
126
120
                        BufferedReader reader = new BufferedReader(
127
 
                                new FileReader( file ) );
 
121
                                        new FileReader( file ) );
128
122
 
129
123
                        // read
130
124
                        String line;
131
 
                        boolean in_vcard = false;
 
125
                        boolean inVCard = false;
132
126
                        while( ( line = reader.readLine() ) != null )
133
127
                        {
134
 
                                if( !in_vcard ) {
 
128
                                if( !inVCard ) {
135
129
                                        // look for vcard beginning
136
 
                                        if( line.matches( "^BEGIN:VCARD" ) ) {
137
 
                                                in_vcard = true;
138
 
                                                _vcard_count++;
 
130
                                        if( line.matches( "^BEGIN[ \\t]*:[ \\t]*VCARD" ) ) {
 
131
                                                inVCard = true;
 
132
                                                _vCardCount++;
139
133
                                        }
140
134
                                }
141
 
                                else if( line.matches( "^END:VCARD" ) )
142
 
                                        in_vcard = false;
 
135
                                else if( line.matches( "^END[ \\t]*:[ \\t]*VCARD" ) )
 
136
                                        inVCard = false;
143
137
                        }
144
138
 
145
139
                }
154
148
 
155
149
        private void importVCardFile( File file ) throws AbortImportException
156
150
        {
157
 
                // check file is good
158
 
                if( !file.exists() )
159
 
                        showError( getText( R.string.error_filenotfound ) +
160
 
                                file.getName() );
161
 
                if( file.length() == 0 )
162
 
                        showError( getText( R.string.error_fileisempty ) +
163
 
                                file.getName() );
164
 
 
165
151
                try
166
152
                {
167
 
                        // open/read file
168
 
                        FileInputStream istream = new FileInputStream( file );
169
 
                        byte[] content = new byte[ (int)file.length() ];
170
 
                        istream.read( content );
171
 
 
172
 
                        // import
173
 
                        importVCardFileContent( content, file.getName() );
 
153
                        // open file
 
154
                        BufferedReader reader = new BufferedReader(
 
155
                                        new FileReader( file ) );
 
156
 
 
157
                        // read
 
158
                        StringBuffer content = new StringBuffer();
 
159
                        String line;
 
160
                        while( ( line = reader.readLine() ) != null )
 
161
                                content.append( line ).append( "\n" );
 
162
 
 
163
                        importVCardFileContent( content.toString(), file.getName() );
174
164
                }
175
165
                catch( FileNotFoundException e ) {
176
166
                        showError( getText( R.string.error_filenotfound ) +
181
171
                }
182
172
        }
183
173
 
184
 
        private void importVCardFileContent( byte[] content, String fileName )
185
 
                throws AbortImportException
 
174
        private void importVCardFileContent( String content, String fileName )
 
175
                        throws AbortImportException
186
176
        {
187
 
                // go through lines
188
 
                VCard vcard = null;
189
 
                ContentLineIterator cli = new ContentLineIterator( content );
190
 
                while( cli.hasNext() )
 
177
                // get lines and parse them
 
178
                String[] lines = content.split( "\n" );
 
179
                VCard vCard = null;
 
180
                for( int i = 0; i < lines.length; i++ )
191
181
                {
192
 
                        ByteBuffer buffer = cli.next();
193
 
 
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
 
                        }
204
 
 
205
 
                        if( vcard == null ) {
 
182
                        String line = lines[ i ];
 
183
 
 
184
                        if( vCard == null ) {
206
185
                                // look for vcard beginning
207
 
                                if( line.matches( "^BEGIN:VCARD" ) ) {
 
186
                                if( line.matches( "^BEGIN[ \\t]*:[ \\t]*VCARD" ) ) {
208
187
                                        setProgress( ++_progress );
209
 
                                        vcard = new VCard();
 
188
                                        vCard = new VCard();
210
189
                                }
211
190
                        }
212
191
                        else {
213
192
                                // look for vcard content or ending
214
 
                                if( line.matches( "^END:VCARD" ) )
 
193
                                if( line.matches( "^END[ \\t]*:[ \\t]*VCARD" ) )
215
194
                                {
216
195
                                        // store vcard and do away with it
217
196
                                        try {
218
 
                                                vcard.finaliseParsing();
219
 
                                                importContact( vcard );
 
197
                                                vCard.finaliseParsing();
 
198
                                                importContact( vCard );
220
199
                                        }
221
200
                                        catch( VCard.ParseException e ) {
222
201
                                                skipContact();
223
202
                                                if( !showContinue(
224
 
                                                        getText( R.string.error_vcf_parse ).toString()
225
 
                                                        + fileName + "\n" + e.getMessage() ) )
226
 
                                                {
 
203
                                                                getText( R.string.error_vcf_parse ).toString()
 
204
                                                                + fileName + "\n" + e.getMessage() ) )
227
205
                                                        finish( ACTION_ABORT );
228
 
                                                }
229
206
                                        }
230
207
                                        catch( VCard.SkipContactException e ) {
231
208
                                                skipContact();
232
209
                                                // do nothing
233
210
                                        }
234
 
                                        vcard = null;
 
211
                                        vCard = null;
235
212
                                }
236
213
                                else
237
214
                                {
238
215
                                        // try giving the line to the vcard
239
216
                                        try {
240
 
                                                vcard.parseLine( buffer, line,
241
 
                                                        cli.doesNextLineLookFolded() );
 
217
                                                vCard.parseLine( line );
242
218
                                        }
243
219
                                        catch( VCard.ParseException e ) {
244
220
                                                skipContact();
245
221
                                                if( !showContinue(
246
 
                                                        getText( R.string.error_vcf_parse ).toString()
247
 
                                                        + fileName + "\n" + e.getMessage() ) )
248
 
                                                {
 
222
                                                                getText( R.string.error_vcf_parse ).toString()
 
223
                                                                + fileName + "\n" + e.getMessage() ) )
249
224
                                                        finish( ACTION_ABORT );
250
 
                                                }
251
225
 
252
226
                                                // although we're continuing, we still need to abort
253
227
                                                // this vCard. Further lines will be ignored until we
254
228
                                                // get to another BEGIN:VCARD line.
255
 
                                                vcard = null;
 
229
                                                vCard = null;
256
230
                                        }
257
231
                                        catch( VCard.SkipContactException e ) {
258
232
                                                skipContact();
259
233
                                                // abort this vCard. Further lines will be ignored until
260
234
                                                // we get to another BEGIN:VCARD line.
261
 
                                                vcard = null;
 
235
                                                vCard = null;
262
236
                                        }
263
237
                                }
264
238
                        }
265
239
                }
266
240
        }
267
241
 
268
 
        class ContentLineIterator implements Iterator< ByteBuffer >
269
 
        {
270
 
                protected byte[] _content = null;
271
 
                protected int _pos = 0;
272
 
 
273
 
                public ContentLineIterator( byte[] content )
274
 
                {
275
 
                        _content = content;
276
 
                }
277
 
 
278
 
                @Override
279
 
                public boolean hasNext()
280
 
                {
281
 
                        return _pos < _content.length;
282
 
                }
283
 
 
284
 
                @Override
285
 
                public ByteBuffer next()
286
 
                {
287
 
                        int initial_pos = _pos;
288
 
 
289
 
                        // find newline
290
 
                        for( ; _pos < _content.length; _pos++ )
291
 
                                if( _content[ _pos ] == '\n' )
292
 
                                {
293
 
                                        // adjust for a \r preceding the \n
294
 
                                        int to = ( _pos > 0 && _content[ _pos - 1 ] == '\r' &&
295
 
                                                _pos > initial_pos )? _pos - 1 : _pos;
296
 
                                        _pos++;
297
 
                                        return ByteBuffer.wrap( _content, initial_pos,
298
 
                                                to - initial_pos );
299
 
                                }
300
 
 
301
 
                        // we didn't find one, but were there bytes left?
302
 
                        if( _pos != initial_pos ) {
303
 
                                int to = _pos;
304
 
                                _pos++;
305
 
                                return ByteBuffer.wrap( _content, initial_pos,
306
 
                                        to - initial_pos );
307
 
                        }
308
 
 
309
 
                        // no bytes left
310
 
                        throw new NoSuchElementException();
311
 
                }
312
 
 
313
 
                @Override
314
 
                public void remove()
315
 
                {
316
 
                        throw new UnsupportedOperationException();
317
 
                }
318
 
 
319
 
                /**
320
 
                 * Does the next line, if there is one, look like it should be folded
321
 
                 * onto the end of this one?
322
 
                 * @return
323
 
                 */
324
 
                public boolean doesNextLineLookFolded()
325
 
                {
326
 
                        return _pos > 0 && _pos < _content.length &&
327
 
                                _content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
328
 
                }
329
 
        }
330
 
 
331
242
        private class VCard extends ContactData
332
243
        {
333
244
                private final static int NAMELEVEL_NONE = 0;
334
 
                private final static int NAMELEVEL_FN = 1;
335
 
                private final static int NAMELEVEL_N = 2;
336
 
 
337
 
                private final static int MULTILINE_NONE = 0;
338
 
                private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
339
 
                private final static int MULTILINE_ESCAPED = 2; // v2.1 \\CRLF
340
 
                private final static int MULTILINE_FOLDED = 3;  // v3.0 folding
 
245
                private final static int NAMELEVEL_ORG = 1;
 
246
                private final static int NAMELEVEL_FN = 2;
 
247
                private final static int NAMELEVEL_N = 3;
341
248
 
342
249
                private String _version = null;
343
 
                private Vector< ByteBuffer > _buffers = null;
 
250
                private Vector< String > _lines = null;
344
251
                private int _name_level = NAMELEVEL_NONE;
345
 
                private int _parser_multiline_state = MULTILINE_NONE;
 
252
                private boolean _parser_in_multiline = false;
346
253
                private String _parser_current_name_and_params = null;
347
254
                private String _parser_buffered_value_so_far = "";
348
 
                private String _cached_organisation = null;
349
 
                private String _cached_title = null;
350
255
 
351
256
                protected class UnencodeResult
352
257
                {
353
258
                        private boolean _another_line_required;
354
 
                        private ByteBuffer _buffer;
 
259
                        private byte[] _bytes;
 
260
                        private int _num_bytes;
355
261
 
356
 
                        public UnencodeResult( boolean another_line_required,
357
 
                                ByteBuffer buffer )
 
262
                        public UnencodeResult( boolean another_line_required, byte[] bytes,
 
263
                                int num_bytes )
358
264
                        {
359
265
                                _another_line_required = another_line_required;
360
 
                                _buffer = buffer;
 
266
                                _bytes = bytes;
 
267
                                _num_bytes = num_bytes;
361
268
                        }
362
269
 
363
270
                        public boolean isAnotherLineRequired()
365
272
                                return _another_line_required;
366
273
                        }
367
274
 
368
 
                        public ByteBuffer getBuffer()
369
 
                        {
370
 
                                return _buffer;
 
275
                        public byte[] getBytes()
 
276
                        {
 
277
                                return _bytes;
 
278
                        }
 
279
 
 
280
                        public int getNumBytes()
 
281
                        {
 
282
                                return _num_bytes;
371
283
                        }
372
284
                }
373
285
 
389
301
                @SuppressWarnings("serial")
390
302
                protected class SkipContactException extends Exception { }
391
303
 
392
 
                private String extractCollonPartFromLine( ByteBuffer buffer,
393
 
                        String line, boolean former )
394
 
                {
395
 
                        String ret = null;
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
 
 
410
 
                        // split line into name and value parts and check to make sure we
411
 
                        // only got 2 parts and that the first part is not zero in length
412
 
                        String[] parts = line.split( ":", 2 );
413
 
                        if( parts.length == 2 && parts[ 0 ].length() > 0 )
414
 
                                ret = parts[ former? 0 : 1 ];
415
 
 
416
 
                        return ret;
417
 
                }
418
 
 
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,
433
 
                        AbortImportException
434
 
                {
435
 
                        // do we have a version yet?
 
304
                public void parseLine( String line )
 
305
                                throws ParseException, SkipContactException,
 
306
                                AbortImportException
 
307
                {
 
308
                        // ignore empty lines
 
309
                        if( line.trim() == "" ) return;
 
310
 
 
311
                        // split line into name and value parts (this may turn out to be
 
312
                        // unwanted if the line is a subsequent line in a multi-line
 
313
                        // value, but we have to do this now to check for and handle VCF
 
314
                        // versions first)
 
315
                        String[] props = line.split(  ":", 2 );
 
316
                        for( int i = 0; i < props.length; i++ )
 
317
                                props[ i ] = props[ i ].trim();
 
318
 
 
319
                        // if we haven't yet got a version, we won't be paring anything!
436
320
                        if( _version == null )
437
321
                        {
438
 
                                // tentatively get name and params from line
439
 
                                String name_and_params =
440
 
                                        extractNameAndParamsFromLine( buffer, line );
441
 
 
442
 
                                // is it a version line?
443
 
                                if( name_and_params != null &&
444
 
                                        name_and_params.equals( "VERSION" ) )
 
322
                                // is this a version?
 
323
                                if( props.length == 2 && props[ 0 ].equals( "VERSION" ) )
445
324
                                {
446
 
                                        // yes, get it!
447
 
                                        String value = extractValueFromLine( buffer, line );
448
 
                                        if( !value.equals( "2.1" ) && !value.equals( "3.0" ) )
 
325
                                        // yes, check/store it
 
326
                                        if( !props[ 1 ].equals( "2.1" ) &&
 
327
                                                        !props[ 1 ].equals( "3.0" ) )
449
328
                                                throw new ParseException( R.string.error_vcf_version );
450
 
                                        _version = value;
 
329
                                        _version = props[ 1 ];
451
330
 
452
 
                                        // parse any buffers we've been accumulating while we waited
453
 
                                        // for a version
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;
 
331
                                        // parse any other lines we've accumulated so far
 
332
                                        if( _lines != null )
 
333
                                                for( int i = 0; i < _lines.size(); i++ )
 
334
                                                        parseLine( _lines.get( i ) );
 
335
                                        _lines = null;
462
336
                                }
463
337
                                else
464
338
                                {
465
 
                                        // no, so stash this line till we get a version
466
 
                                        if( _buffers == null )
467
 
                                                _buffers = new Vector< ByteBuffer >();
468
 
                                        _buffers.add( buffer );
 
339
                                        // no, so stash this line till we have a version
 
340
                                        if( _lines == null )
 
341
                                                _lines = new Vector< String >();
 
342
                                        _lines.add( line );
469
343
                                }
470
344
                        }
471
345
                        else
472
346
                        {
473
 
                                // name and params and the position in the buffer where the
474
 
                                // "value" part of the line start
475
 
                                String name_and_params;
476
 
                                int pos;
477
 
 
478
 
                                if( _parser_multiline_state != MULTILINE_NONE )
 
347
                                if( _parser_in_multiline )
479
348
                                {
480
349
                                        // if we're currently in a multi-line value, use the stored
481
350
                                        // property name and parameters
482
 
                                        name_and_params = _parser_current_name_and_params;
483
 
 
484
 
                                        // skip some initial line characters, depending on the type
485
 
                                        // of multi-line we're handling
486
 
                                        pos = buffer.position();
487
 
                                        switch( _parser_multiline_state )
488
 
                                        {
489
 
                                        case MULTILINE_FOLDED:
490
 
                                                pos++;
491
 
                                                break;
492
 
                                        case MULTILINE_ENCODED:
493
 
                                                while( pos < buffer.limit() && (
494
 
                                                        buffer.get( pos ) == ' ' ||
495
 
                                                        buffer.get( pos ) == '\t' ) )
496
 
                                                {
497
 
                                                        pos++;
498
 
                                                }
499
 
                                                break;
500
 
                                        default:
501
 
                                                // do nothing
502
 
                                        }
503
 
 
504
 
                                        // take us out of multi-line so that we can re-detect that
505
 
                                        // this line is a multi-line or not
506
 
                                        _parser_multiline_state = MULTILINE_NONE;
 
351
                                        props = new String[ 2 ];
 
352
                                        props[ 0 ] = _parser_current_name_and_params;
 
353
                                        props[ 1 ] = line.trim();
507
354
                                }
508
355
                                else
509
356
                                {
510
 
                                        // get name and params from line, and since we're not
511
 
                                        // parsing a subsequent line in a multi-line, this should
512
 
                                        // not fail, or it's an error
513
 
                                        name_and_params =
514
 
                                                extractNameAndParamsFromLine( buffer, line );
515
 
                                        if( name_and_params == null )
 
357
                                        // for normal lines, check the property name/value bits
 
358
                                        if( props.length < 2 || props[ 0 ].length() == 0 )
516
359
                                                throw new ParseException(
517
360
                                                        R.string.error_vcf_malformed );
518
361
 
519
 
                                        // calculate how many chars to skip from beginning of line
520
 
                                        // so we skip the property "name:" part
521
 
                                        pos = buffer.position() + name_and_params.length() + 1;
 
362
                                        // ignore empty properties
 
363
                                        if( props[ 1 ].length() < 1 )
 
364
                                                return;
522
365
 
523
366
                                        // reset the saved multi-line state
524
 
                                        _parser_current_name_and_params = name_and_params;
 
367
                                        _parser_current_name_and_params = props[ 0 ];
525
368
                                        _parser_buffered_value_so_far = "";
526
369
                                }
527
370
 
528
 
                                // get value from buffer, as raw bytes
529
 
                                ByteBuffer value;
530
 
                                value = ByteBuffer.wrap( buffer.array(), pos,
531
 
                                        buffer.limit() - pos );
532
 
 
533
371
                                // get parameter parts
534
 
                                String[] name_param_parts = name_and_params.split( ";", -1 );
535
 
                                for( int i = 0; i < name_param_parts.length; i++ )
536
 
                                        name_param_parts[ i ] = name_param_parts[ i ].trim();
 
372
                                String[] params = props[ 0 ].split( ";" );
 
373
                                for( int i = 0; i < params.length; i++ )
 
374
                                        params[ i ] = params[ i ].trim();
537
375
 
538
 
                                // parse encoding parameter
539
 
                                String encoding = checkParam( name_param_parts, "ENCODING" );
540
 
                                if( encoding != null ) encoding = encoding.toUpperCase();
541
 
                                if( encoding != null && !encoding.equals( "8BIT" ) &&
542
 
                                        !encoding.equals( "QUOTED-PRINTABLE" ) )
 
376
                                // parse charset and encoding parameters
 
377
                                String charset, encoding;
 
378
                                if( ( charset = checkParam( params, "CHARSET" ) ) != null &&
 
379
                                        !charset.equals( "UTF-8" ) && !charset.equals( "UTF-16" ) )
 
380
                                {
 
381
                                        throw new ParseException( R.string.error_vcf_charset );
 
382
                                }
 
383
                                if( ( encoding = checkParam( params, "ENCODING" ) ) != null &&
 
384
                                        !encoding.equals( "QUOTED-PRINTABLE" ) &&
 
385
                                        !encoding.equals( "8BIT" ) )
543
386
                                        //&& !encoding.equals( "BASE64" ) )
544
387
                                {
545
388
                                        throw new ParseException( R.string.error_vcf_encoding );
546
389
                                }
547
390
 
548
 
                                // parse charset parameter
549
 
                                String charset = checkParam( name_param_parts, "CHARSET" );
550
 
                                if( charset != null ) charset = charset.toUpperCase();
551
 
                                if( charset != null && !charset.equals( "US-ASCII" ) &&
552
 
                                        !charset.equals( "ASCII" ) &&
553
 
                                        !charset.equals( "UTF-8" ) )
554
 
                                {
555
 
                                        throw new ParseException( R.string.error_vcf_charset );
556
 
                                }
557
 
 
558
391
                                // do unencoding (or default to a fake unencoding result with
559
392
                                // the raw string)
560
 
                                UnencodeResult unencoding_result = null;
 
393
                                UnencodeResult result;
561
394
                                if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )
562
 
                                        unencoding_result = unencodeQuotedPrintable( value );
 
395
                                        result = unencodeQuotedPrintable( props[ 1 ], charset );
563
396
//                              else if( encoding != null && encoding.equals( "BASE64" ) )
564
 
//                                      unencoding_result = unencodeBase64( props[ 1 ], charset );
565
 
                                if( unencoding_result != null ) {
566
 
                                        value = unencoding_result.getBuffer();
567
 
                                        if( unencoding_result.isAnotherLineRequired() )
568
 
                                                _parser_multiline_state = MULTILINE_ENCODED;
569
 
                                }
570
 
 
571
 
                                // convert 8-bit ASCII charset to US-ASCII
572
 
                                if( charset == null || charset.equals( "ASCII" ) ) {
573
 
                                        value = transcodeAsciiToUtf8( value );
574
 
                                        charset = "UTF-8";
575
 
                                }
 
397
//                                      result = unencodeBase64( props[ 1 ], charset );
 
398
                                else
 
399
                                        result = new UnencodeResult( false, props[ 1 ].getBytes(),
 
400
                                                props[ 1 ].getBytes().length );
576
401
 
577
402
                                // process charset
578
 
                                String string_value;
579
403
                                try {
580
 
                                        string_value = new String( value.array(), value.position(),
581
 
                                                value.limit() - value.position(), charset );
 
404
                                        props[ 1 ] = new String( result.getBytes(), 0,
 
405
                                                result.getNumBytes(),
 
406
                                                charset == null? "UTF-8" : charset );
582
407
                                } catch( UnsupportedEncodingException e ) {
583
408
                                        throw new ParseException( R.string.error_vcf_charset );
584
409
                                }
585
410
 
586
 
                                // for some entries that have semicolon-separated value parts,
587
 
                                // check to see if the value ends in an escape character, which
588
 
                                // indicates that we have a multi-line value
589
 
                                if( ( name_param_parts[ 0 ].equals( "N" ) ||
590
 
                                        name_param_parts[ 0 ].equals( "ORG" ) ||
591
 
                                        name_param_parts[ 0 ].equals( "ADR" ) ) &&
592
 
                                        doesStringEndInAnEscapeChar( string_value ) )
593
 
                                {
594
 
                                        _parser_multiline_state = MULTILINE_ESCAPED;
595
 
                                        string_value = string_value.substring( 0,
596
 
                                                string_value.length() - 1 );
597
 
                                }
598
 
 
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
601
 
                                if( _parser_multiline_state == MULTILINE_NONE &&
602
 
                                        _version.equals( "3.0" ) && next_line_looks_folded )
603
 
                                {
604
 
                                        _parser_multiline_state = MULTILINE_FOLDED;
605
 
                                }
606
 
 
607
 
                                // handle multi-lines by buffering them and parsing them when we
608
 
                                // are processing the last line in a multi-line sequence
609
 
                                if( _parser_multiline_state != MULTILINE_NONE ) {
610
 
                                        _parser_buffered_value_so_far += string_value;
 
411
                                // handle multi-line requests
 
412
                                _parser_in_multiline = result.isAnotherLineRequired();
 
413
                                if( _parser_in_multiline ) {
 
414
                                        _parser_buffered_value_so_far += props[ 1 ];
611
415
                                        return;
612
416
                                }
613
 
                                String complete_value =
614
 
                                        ( _parser_buffered_value_so_far + string_value ).trim();
615
417
 
616
 
                                // ignore empty values
617
 
                                if( complete_value.length() < 1 ) return;
 
418
                                // add on buffered multi-line content
 
419
                                String value = _parser_buffered_value_so_far + props[ 1 ];
618
420
 
619
421
                                // parse some properties
620
 
                                if( name_param_parts[ 0 ].equals( "N" ) )
621
 
                                        parseN( name_param_parts, complete_value );
622
 
                                else if( name_param_parts[ 0 ].equals( "FN" ) )
623
 
                                        parseFN( name_param_parts, complete_value );
624
 
                                else if( name_param_parts[ 0 ].equals( "ORG" ) )
625
 
                                        parseORG( name_param_parts, complete_value );
626
 
                                else if( name_param_parts[ 0 ].equals( "TITLE" ) )
627
 
                                        parseTITLE( name_param_parts, complete_value );
628
 
                                else if( name_param_parts[ 0 ].equals( "TEL" ) )
629
 
                                        parseTEL( name_param_parts, complete_value );
630
 
                                else if( name_param_parts[ 0 ].equals( "EMAIL" ) )
631
 
                                        parseEMAIL( name_param_parts, complete_value );
632
 
                                else if( name_param_parts[ 0 ].equals( "ADR" ) )
633
 
                                        parseADR( name_param_parts, complete_value );
634
 
                        }
635
 
                }
636
 
 
637
 
                private boolean doesStringEndInAnEscapeChar( String string )
638
 
                {
639
 
                        // count the number of backslashes at the end of the string
640
 
                        int count = 0;
641
 
                        for( int a = string.length() - 1; a >= 0; a-- )
642
 
                                if( string.charAt( a ) == '\\' )
643
 
                                        count++;
644
 
                                else
645
 
                                        break;
646
 
 
647
 
                        // if there are an even number of backslashes then the final one
648
 
                        // doesn't count
649
 
                        return ( count & 1 ) == 1;
650
 
                }
651
 
 
652
 
                private String[] splitValueBySemicolon( String value )
653
 
                {
654
 
                        // split string in to parts by semicolon
655
 
                        ArrayList< String > parts = new ArrayList< String >(
656
 
                                Arrays.asList( value.split(  ";" ) ) );
657
 
 
658
 
                        // go through parts
659
 
                        for( int a = 0; a < parts.size(); a++ )
660
 
                        {
661
 
                                String str = parts.get( a );
662
 
 
663
 
                                // look for parts that end in an escape character, but ignore
664
 
                                // the final part. We've already detected escape chars at the
665
 
                                // end of the final part in parseLine() and handled multi-lines
666
 
                                // accordingly.
667
 
                                if( a < parts.size() - 1 &&
668
 
                                        doesStringEndInAnEscapeChar( str ) )
669
 
                                {
670
 
                                        // join the next part to this part and remove the next part
671
 
                                        parts.set( a, str.substring( 0, str.length() - 1 ) +
672
 
                                                ';' + parts.get( a + 1 ) );
673
 
                                        parts.remove( a + 1 );
674
 
 
675
 
                                        // re-visit this part
676
 
                                        a--;
677
 
                                        continue;
678
 
                                }
679
 
 
680
 
                                // trim and replace string
681
 
                                str = str.trim();
682
 
                                parts.set( a, str );
683
 
                        }
684
 
 
685
 
                        String[] ret = new String[ parts.size() ];
686
 
                        return parts.toArray( ret );
 
422
                                if( params[ 0 ].equals( "N" ) )
 
423
                                        parseN( params, value );
 
424
                                else if( params[ 0 ].equals( "FN" ) )
 
425
                                        parseFN( params, value );
 
426
                                else if( params[ 0 ].equals( "ORG" ) )
 
427
                                        parseORG( params, value );
 
428
                                else if( params[ 0 ].equals( "TEL" ) )
 
429
                                        parseTEL( params, value );
 
430
                                else if( params[ 0 ].equals( "EMAIL" ) )
 
431
                                        parseEMAIL( params, value );
 
432
                        }
687
433
                }
688
434
 
689
435
                private void parseN( String[] params, String value )
 
436
                                throws ParseException, SkipContactException,
 
437
                                AbortImportException
690
438
                {
691
439
                        // already got a better name?
692
440
                        if( _name_level >= NAMELEVEL_N ) return;
693
441
 
694
442
                        // get name parts
695
 
                        String[] name_parts = splitValueBySemicolon( value );
 
443
                        String[] nameparts = value.split( ";" );
 
444
                        for( int i = 0; i < nameparts.length; i++ )
 
445
                                nameparts[ i ] = nameparts[ i ].trim();
696
446
 
697
447
                        // build name
698
448
                        value = "";
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 ];
 
449
                        if( nameparts.length > 1 && nameparts[ 1 ].length() > 0 )
 
450
                                value += nameparts[ 1 ];
 
451
                        if( nameparts[ 0 ].length() > 0 )
 
452
                                value += ( value.length() == 0? "" : " " ) + nameparts[ 0 ];
703
453
 
704
454
                        // set name
705
455
                        setName( value );
706
456
                        _name_level = NAMELEVEL_N;
 
457
 
 
458
                        // check now to see if we need to import this contact (to avoid
 
459
                        // parsing the rest of the vCard unnecessarily)
 
460
                        if( !isImportRequired( getName() ) )
 
461
                                throw new SkipContactException();
707
462
                }
708
463
 
709
464
                private void parseFN( String[] params, String value )
 
465
                                throws ParseException, SkipContactException
710
466
                {
711
467
                        // already got a better name?
712
468
                        if( _name_level >= NAMELEVEL_FN ) return;
717
473
                }
718
474
 
719
475
                private void parseORG( String[] params, String value )
 
476
                                throws ParseException, SkipContactException
720
477
                {
 
478
                        // already got a better name?
 
479
                        if( _name_level >= NAMELEVEL_ORG ) return;
 
480
 
721
481
                        // get org parts
722
 
                        String[] org_parts = splitValueBySemicolon( value );
723
 
                        if( org_parts == null || org_parts.length < 1 ) return;
724
 
 
725
 
                        // build organisation name
726
 
                        StringBuilder builder = new StringBuilder(
727
 
                                String.valueOf( org_parts[ 0 ] ) );
728
 
                        for( int a = 1; a < org_parts.length; a++ )
729
 
                                builder.append( ", " ).append( org_parts[ a ] );
730
 
                        String organisation = builder.toString();
731
 
 
732
 
                        // set organisation name (using a title we've previously found)
733
 
                        addOrganisation( organisation, _cached_title, true );
734
 
 
735
 
                        // if we've not previously found a title, store this organisation
736
 
                        // name (we'll need it when we find a title to update the
737
 
                        // organisation, by name), else if we *have* previously found a
738
 
                        // title, clear it (since we just used it)
739
 
                        if( _cached_title == null )
740
 
                                _cached_organisation = organisation;
741
 
                        else
742
 
                                _cached_title = null;
743
 
                }
744
 
 
745
 
                private void parseTITLE( String[] params, String value )
746
 
                {
747
 
                        // if we previously had an organisation, look it up and append this
748
 
                        // title to it
749
 
                        if( _cached_organisation != null && hasOrganisations() ) {
750
 
                                HashMap< String, ExtraDetail > datas = getOrganisations();
751
 
                                ExtraDetail detail = datas.get( _cached_organisation );
752
 
                                if( detail != null )
753
 
                                        detail.setExtra( value );
754
 
                        }
755
 
 
756
 
                        // same as when handling organisation, if we've not previously found
757
 
                        // an organisation we store this title, else we clear it (since we
758
 
                        // just appended this title to it)
759
 
                        if( _cached_organisation == null )
760
 
                                _cached_title = value;
761
 
                        else
762
 
                                _cached_organisation = null;
 
482
                        String[] orgparts = value.split( ";" );
 
483
                        for( int i = 0; i < orgparts.length; i++ )
 
484
                                orgparts[ i ] = orgparts[ i ].trim();
 
485
 
 
486
                        // build name
 
487
                        if( orgparts[ 0 ].length() == 0 && orgparts.length > 1 )
 
488
                                value = orgparts[ 1 ];
 
489
                        else
 
490
                                value = orgparts[ 0 ];
 
491
 
 
492
                        // set name
 
493
                        setName( value );
 
494
                        _name_level = NAMELEVEL_ORG;
763
495
                }
764
496
 
765
497
                private void parseTEL( String[] params, String value )
 
498
                                throws ParseException
766
499
                {
767
500
                        if( value.length() == 0 ) return;
768
501
 
769
502
                        Set< String > types = extractTypes( params, Arrays.asList(
770
 
                                "PREF", "HOME", "WORK", "VOICE", "FAX", "MSG", "CELL",
771
 
                                "PAGER", "BBS", "MODEM", "CAR", "ISDN", "VIDEO" ) );
 
503
                                        "PREF", "HOME", "WORK", "VOICE", "FAX", "MSG", "CELL",
 
504
                                        "PAGER", "BBS", "MODEM", "CAR", "ISDN", "VIDEO" ) );
772
505
 
773
506
                        // here's the logic...
774
 
                        boolean is_preferred = types.contains( "PREF" );
775
 
                        int type;
 
507
                        boolean preferred = types.contains( "PREF" );
 
508
                        if( types.contains( "VOICE" ) )
 
509
                                if( types.contains( "WORK" ) )
 
510
                                        addPhone( value, PhonesColumns.TYPE_WORK, preferred );
 
511
                                else
 
512
                                        addPhone( value, PhonesColumns.TYPE_HOME, preferred );
 
513
                        else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
 
514
                                addPhone( value, PhonesColumns.TYPE_MOBILE, preferred );
776
515
                        if( types.contains( "FAX" ) )
777
516
                                if( types.contains( "HOME" ) )
778
 
                                        type = PhonesColumns.TYPE_FAX_HOME;
 
517
                                        addPhone( value, PhonesColumns.TYPE_FAX_HOME, preferred );
779
518
                                else
780
 
                                        type = PhonesColumns.TYPE_FAX_WORK;
781
 
                        else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
782
 
                                type = PhonesColumns.TYPE_MOBILE;
783
 
                        else if( types.contains( "PAGER" ) )
784
 
                                type = PhonesColumns.TYPE_PAGER;
785
 
                        else if( types.contains( "WORK" ) )
786
 
                                type = PhonesColumns.TYPE_WORK;
787
 
                        else
788
 
                                type = PhonesColumns.TYPE_HOME;
789
 
 
790
 
                        // add phone number
791
 
                        addNumber( value, type, is_preferred );
 
519
                                        addPhone( value, PhonesColumns.TYPE_FAX_WORK, preferred );
 
520
                        if( types.contains( "PAGER" ) )
 
521
                                addPhone( value, PhonesColumns.TYPE_PAGER, preferred );
792
522
                }
793
523
 
794
524
                public void parseEMAIL( String[] params, String value )
 
525
                                throws ParseException
795
526
                {
796
527
                        if( value.length() == 0 ) return;
797
528
 
798
529
                        Set< String > types = extractTypes( params, Arrays.asList(
799
 
                                "PREF", "WORK", "HOME", "INTERNET" ) );
800
 
 
801
 
                        // add email address
802
 
                        boolean is_preferred = types.contains( "PREF" );
803
 
                        int type;
804
 
                        if( types.contains( "WORK" ) )
805
 
                                type = Contacts.ContactMethods.TYPE_WORK;
806
 
                        else
807
 
                                type = Contacts.ContactMethods.TYPE_HOME;
808
 
 
809
 
                        addEmail( value, type, is_preferred );
810
 
                }
811
 
 
812
 
                private void parseADR( String[] params, String value )
813
 
                {
814
 
                        // get address parts
815
 
                        String[] adr_parts = splitValueBySemicolon( value );
816
 
 
817
 
                        // build address
818
 
                        value = "";
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 );
 
530
                                        "PREF", "WORK", "HOME", "INTERNET" ) );
 
531
 
 
532
                        // here's the logic...
 
533
                        boolean preferred = types.contains( "PREF" );
 
534
                        if( types.contains( "WORK" ) )
 
535
                                addEmail( value, Contacts.ContactMethods.TYPE_WORK, preferred );
 
536
                        else
 
537
                                addEmail( value, Contacts.ContactMethods.TYPE_HOME, preferred );
835
538
                }
836
539
 
837
540
                public void finaliseParsing()
838
 
                        throws ParseException, SkipContactException,
839
 
                        AbortImportException
 
541
                                throws ParseException, SkipContactException,
 
542
                                AbortImportException
840
543
                {
841
544
                        // missing version (and data is present)
842
 
                        if( _version == null && _buffers != null )
 
545
                        if( _version == null && _lines != null )
843
546
                                throw new ParseException( R.string.error_vcf_malformed );
844
547
 
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
 
                        }
 
548
                        //  missing name properties?
 
549
                        if( _name_level == NAMELEVEL_NONE )
 
550
                                throw new ParseException( R.string.error_vcf_noname );
 
551
 
 
552
                        // check if we should import this one? If we've already got an 'N'-
 
553
                        // type name, this will already have been done by parseN() so we
 
554
                        // mustn't do this here (or it could prompt twice!)
 
555
                        if( _name_level < NAMELEVEL_N && !isImportRequired( getName() ) )
 
556
                                throw new SkipContactException();
853
557
                }
854
558
 
855
559
                private String checkParam( String[] params, String name )
856
560
                {
857
 
                        Pattern p = Pattern.compile(
858
 
                                "^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
 
561
                        Pattern p = Pattern.compile( "^" + name + "[ \\t]*=[ \\t]*(.*)$" );
859
562
                        for( int i = 0; i < params.length; i++ ) {
860
563
                                Matcher m = p.matcher( params[ i ] );
861
564
                                if( m.matches() )
862
 
                                        return m.group( 2 );
 
565
                                        return m.group( 1 );
863
566
                        }
864
567
                        return null;
865
568
                }
866
569
 
867
570
                private Set< String > extractTypes( String[] params,
868
 
                        List< String > valid_types )
 
571
                                List< String > validTypes )
869
572
                {
870
573
                        HashSet< String > types = new HashSet< String >();
871
574
 
872
575
                        // get 3.0-style TYPE= param
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 ] );
 
576
                        String typeParam;
 
577
                        if( ( typeParam = checkParam( params, "TYPE" ) ) != null ) {
 
578
                                String[] bits = typeParam.split( "," );
 
579
                                for( int i = 0; i < bits.length; i++ )
 
580
                                        if( validTypes.contains( bits[ i ] ) )
 
581
                                                types.add( bits[ i ] );
879
582
                        }
880
583
 
881
584
                        // get 2.1-style type param
882
585
                        if( _version.equals( "2.1" ) ) {
883
586
                                for( int i = 1; i < params.length; i++ )
884
 
                                        if( valid_types.contains( params[ i ] ) )
 
587
                                        if( validTypes.contains( params[ i ] ) )
885
588
                                                types.add( params[ i ] );
886
589
                        }
887
590
 
888
591
                        return types;
889
592
                }
890
593
 
891
 
                private UnencodeResult unencodeQuotedPrintable( ByteBuffer in )
 
594
                private UnencodeResult unencodeQuotedPrintable( String str, String charset )
892
595
                {
893
596
                        boolean another = false;
894
597
 
895
 
                        // unencode quoted-printable encoding, as per RFC1521 section 5.1
896
 
                        byte[] out = new byte[ in.limit() - in.position() ];
 
598
                        // default encoding scheme
 
599
                        if( charset == null ) charset = "UTF-8";
 
600
 
 
601
                        // unencode quoted-pritable encoding, as per RFC1521 section 5.1
 
602
                        byte[] bytes = new byte[ str.length() ];
897
603
                        int j = 0;
898
 
                        for( int i = in.position(); i < in.limit(); i++ )
 
604
                        for( int i = 0; i < str.length(); i++ )
899
605
                        {
900
606
                                // get next char and process...
901
 
                                byte ch = in.array()[ i ];
902
 
                                if( ch == '=' && i < in.limit() - 2 )
 
607
                                char ch = str.charAt( i );
 
608
                                if( ch == '=' && i < str.length() - 2 )
903
609
                                {
904
610
                                        // we found a =XX format byte, add it
905
 
                                        out[ j ] = (byte)(
906
 
                                                        Character.digit( in.array()[ i + 1 ], 16 ) * 16 +
907
 
                                                        Character.digit( in.array()[ i + 2 ], 16 ) );
 
611
                                        bytes[ j ] = (byte)(
 
612
                                                        Character.digit( str.charAt( i + 1 ), 16 ) * 16 +
 
613
                                                        Character.digit( str.charAt( i + 2 ), 16 ) );
908
614
                                        i += 2;
909
615
                                }
910
 
                                else if( ch == '=' && i == in.limit() - 1 )
 
616
                                else if( ch == '=' && i == str.length() - 1 )
911
617
                                {
912
618
                                        // we found a '=' at the end of a line signifying a multi-
913
619
                                        // line string, so we don't add it.
916
622
                                }
917
623
                                else
918
624
                                        // just a normal char...
919
 
                                        out[ j ] = (byte)ch;
 
625
                                        bytes[ j ] = (byte)ch;
920
626
                                j++;
921
627
                        }
922
628
 
923
 
                        return new UnencodeResult( another, ByteBuffer.wrap( out, 0, j ) );
924
 
                }
925
 
 
926
 
                private ByteBuffer transcodeAsciiToUtf8( ByteBuffer in )
927
 
                {
928
 
                        // transcode
929
 
                        byte[] out = new byte[ ( in.limit() - in.position() ) * 2 ];
930
 
                        int j = 0;
931
 
                        for( int a = in.position(); a < in.limit(); a++ )
932
 
                        {
933
 
                                // if char is < 127, keep it as-is
934
 
                                if( in.array()[ a ] >= 0 )
935
 
                                        out[ j++ ] = in.array()[ a ];
936
 
 
937
 
                                // else, convert it to UTF-8
938
 
                                else {
939
 
                                        int b = 0xff & (int)in.array()[ a ];
940
 
                                        out[ j++ ] = (byte)( 0xc0 | ( b >> 6 ) );
941
 
                                        out[ j++ ] = (byte)( 0x80 | ( b & 0x3f ) );
942
 
                                }
943
 
                        }
944
 
 
945
 
                        return ByteBuffer.wrap( out, 0, j );
 
629
                        return new UnencodeResult( another, bytes, j );
946
630
                }
947
631
        }
948
632
}