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