(root)/android/import-contacts
» Revision
43
(compared to revision 68)
: src/org/waxworlds/edam/importcontacts/VcardImporter.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/VcardImporter.java
- browse files at revision 43
- compare with another revision
- download diff
- download tarball
- view history from revision 43
- Committer: edam
- Date: 2011-05-30 15:33:01 UTC
- Revision ID: edam@waxworlds.org-20110530153301-oor6ci9b3hf9clul
- refactored some code to do with how contacts are imported
- Vcards (and ContactData) instances now generate a CacheIdentifier when they are finalised so that ContactData instances that do not have enough information to identify them can be discovered then
- importContact() now calls the private method checkForDuplicate(), renamed from isImportRequired(), and return if it is not
- importContact() and checkForDuplicate() now use the ContactData's generated CacheIdentifier
- Vcards (and ContactData) instances now generate a CacheIdentifier when they are finalised so that ContactData instances that do not have enough information to identify them can be discovered then
- importContact() now calls the private method checkForDuplicate(), renamed from isImportRequired(), and return if it is not
- importContact() and checkForDuplicate() now use the ContactData's generated CacheIdentifier
- files added:
- default.properties
- 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/
- files modified:
- .classpath
added
removed
src/org/waxworlds/edam/importcontacts/VcardImporter.java
1
1
/*
2
2
* VCFImporter.java
3
3
*
4
* Copyright (C) 2009 to 2011 Tim Marston <tim@ed.am>
4
* Copyright (C) 2009 to 2011 Tim Marston <edam@waxworlds.org>
5
5
*
6
6
* This file is part of the Import Contacts program (hereafter referred
7
7
* to as "this program"). For more information, see
8
* http://ed.am/dev/android/import-contacts
8
* http://www.waxworlds.org/edam/software/android/import-contacts
9
9
*
10
10
* This program is free software: you can redistribute it and/or modify
11
11
* it under the terms of the GNU General Public License as published by
21
21
* along with this program. If not, see <http://www.gnu.org/licenses/>.
22
22
*/
23
23
24
package am.ed.importcontacts;
24
package org.waxworlds.edam.importcontacts;
25
25
26
26
import java.io.BufferedReader;
27
27
import java.io.File;
38
38
import java.util.HashSet;
39
39
import java.util.Iterator;
40
40
import java.util.List;
41
import java.util.Locale;
42
41
import java.util.NoSuchElementException;
43
42
import java.util.Set;
44
43
import java.util.Vector;
45
44
import java.util.regex.Matcher;
46
45
import java.util.regex.Pattern;
47
46
48
import android.annotation.SuppressLint;
49
47
import android.content.SharedPreferences;
48
import android.provider.Contacts;
49
import android.provider.Contacts.PhonesColumns;
50
50
51
51
public class VcardImporter extends Importer
52
52
{
58
58
super( doit );
59
59
}
60
60
61
@SuppressLint( "SdCardPath" )
62
61
@Override
63
62
protected void onImport() throws AbortImportException
64
63
{
83
82
// get files
84
83
class VCardFilter implements FilenameFilter {
85
84
public boolean accept( File dir, String name ) {
86
return name.toLowerCase( Locale.US ).endsWith( ".vcf" );
85
return name.toLowerCase().endsWith( ".vcf" );
87
86
}
88
87
}
89
88
files = file.listFiles( new VCardFilter() );
117
116
setProgress( 0 );
118
117
for( int i = 0; i < files.length; i++ )
119
118
importVCardFile( files[ i ] );
120
setProgress( _vcard_count );
121
119
}
122
120
123
121
private void countVCardFile( File file ) throws AbortImportException
170
168
FileInputStream istream = new FileInputStream( file );
171
169
byte[] content = new byte[ (int)file.length() ];
172
170
istream.read( content );
173
istream = null;
174
171
175
172
// import
176
173
importVCardFileContent( content, file.getName() );
189
186
{
190
187
// go through lines
191
188
Vcard vcard = null;
192
int vcard_start_line = 0;
193
189
ContentLineIterator cli = new ContentLineIterator( content );
194
190
while( cli.hasNext() )
195
191
{
209
205
if( vcard == null ) {
210
206
// look for vcard beginning
211
207
if( line.matches( "^BEGIN:VCARD" ) ) {
212
setProgress( _progress++ );
208
setProgress( ++_progress );
213
209
vcard = new Vcard();
214
vcard_start_line = cli.getLineNumber();
215
210
}
216
211
}
217
212
else {
221
216
// finalise the vcard/contact
222
217
try {
223
218
vcard.finaliseVcard();
224
225
// pass the finalised contact to the importer
226
importContact( vcard );
227
219
}
228
220
catch( Vcard.ParseException e ) {
229
if( !showContinue(
230
getText( R.string.error_vcf_parse ).toString()
231
+ fileName +
232
getText( R.string.error_vcf_parse_line ).toString()
233
+ cli.getLineNumber() + ":\n" + e.getMessage() ) )
234
{
235
finish( ACTION_ABORT );
236
}
237
else
238
skipContact();
239
}
240
catch( ContactData.ContactNotIdentifiableException e ) {
241
if( !showContinue(
242
getText( R.string.error_vcf_parse ).toString()
243
+ fileName +
244
getText( R.string.error_vcf_parse_line ).toString()
245
+ vcard_start_line + ":\n" + getText(
246
R.string.error_vcf_notenoughinfo ).toString()
247
) )
248
{
249
finish( ACTION_ABORT );
250
}
251
else
252
skipContact();
253
}
254
255
// discard this vcard
221
skipContact();
222
if( !showContinue(
223
getText( R.string.error_vcf_parse ).toString()
224
+ fileName + "\n" + e.getMessage() ) )
225
{
226
finish( ACTION_ABORT );
227
}
228
}
229
230
// pass the finalised contact to the importer
231
importContact( vcard );
232
233
// and discard it
256
234
vcard = null;
257
235
}
258
236
else
266
244
skipContact();
267
245
if( !showContinue(
268
246
getText( R.string.error_vcf_parse ).toString()
269
+ fileName +
270
getText( R.string.error_vcf_parse_line ).toString()
271
+ cli.getLineNumber() + "\n" + e.getMessage() ) )
247
+ fileName + "\n" + e.getMessage() ) )
272
248
{
273
249
finish( ACTION_ABORT );
274
250
}
293
269
{
294
270
protected byte[] _content = null;
295
271
protected int _pos = 0;
296
protected int _line = 0;
297
272
298
273
public ContentLineIterator( byte[] content )
299
274
{
319
294
int to = ( _pos > 0 && _content[ _pos - 1 ] == '\r' &&
320
295
_pos > initial_pos )? _pos - 1 : _pos;
321
296
_pos++;
322
_line++;
323
297
return ByteBuffer.wrap( _content, initial_pos,
324
298
to - initial_pos );
325
299
}
328
302
if( _pos != initial_pos ) {
329
303
int to = _pos;
330
304
_pos++;
331
_line++;
332
305
return ByteBuffer.wrap( _content, initial_pos,
333
306
to - initial_pos );
334
307
}
353
326
return _pos > 0 && _pos < _content.length &&
354
327
_content[ _pos - 1 ] == '\n' && _content[ _pos ] == ' ';
355
328
}
356
357
public int getLineNumber()
358
{
359
return _line;
360
}
361
329
}
362
330
363
331
private class Vcard extends ContactData
364
332
{
365
333
private final static int NAMELEVEL_NONE = 0;
366
private final static int NAMELEVEL_N = 1;
367
private final static int NAMELEVEL_FN = 2;
334
private final static int NAMELEVEL_FN = 1;
335
private final static int NAMELEVEL_N = 2;
368
336
369
337
private final static int MULTILINE_NONE = 0;
370
338
private final static int MULTILINE_ENCODED = 1; // v2.1 quoted-printable
567
535
for( int i = 0; i < name_param_parts.length; i++ )
568
536
name_param_parts[ i ] = name_param_parts[ i ].trim();
569
537
570
// determine whether we care about this entry
571
final HashSet< String > interesting_fields =
572
new HashSet< String >( Arrays.asList( new String[] { "N",
573
"FN", "ORG", "TITLE", "TEL", "EMAIL", "ADR", "LABEL" }
574
) );
575
boolean is_interesting_field =
576
interesting_fields.contains( name_param_parts[ 0 ] );
577
578
538
// parse encoding parameter
579
539
String encoding = checkParam( name_param_parts, "ENCODING" );
580
if( encoding != null )
581
encoding = encoding.toUpperCase( Locale.US );
582
if( is_interesting_field && encoding != null &&
583
!encoding.equals( "8BIT" ) &&
540
if( encoding != null ) encoding = encoding.toUpperCase();
541
if( encoding != null && !encoding.equals( "8BIT" ) &&
584
542
!encoding.equals( "QUOTED-PRINTABLE" ) )
585
543
//&& !encoding.equals( "BASE64" ) )
586
544
{
589
547
590
548
// parse charset parameter
591
549
String charset = checkParam( name_param_parts, "CHARSET" );
592
if( charset != null )
593
charset = charset.toUpperCase( Locale.US );
594
if( charset != null &&
595
!charset.equals( "US-ASCII" ) &&
550
if( charset != null ) charset = charset.toUpperCase();
551
if( charset != null && !charset.equals( "US-ASCII" ) &&
596
552
!charset.equals( "ASCII" ) &&
597
553
!charset.equals( "UTF-8" ) )
598
554
{
612
568
_parser_multiline_state = MULTILINE_ENCODED;
613
569
}
614
570
615
// convert 8-bit US-ASCII charset to UTF-8 (where no charset is
616
// specified for a v2.1 vcard entry, we assume it's US-ASCII)
617
if( ( charset == null && _version.equals( "2.1" ) ) ||
618
( charset != null && (
619
charset.equals( "ASCII" ) ||
620
charset.equals( "US-ASCII" ) ) ) )
621
{
571
// convert 8-bit ASCII charset to US-ASCII
572
if( charset == null || charset.equals( "ASCII" ) ) {
622
573
value = transcodeAsciiToUtf8( value );
574
charset = "UTF-8";
623
575
}
624
576
625
// process charset (value is now in UTF-8)
577
// process charset
626
578
String string_value;
627
579
try {
628
580
string_value = new String( value.array(), value.position(),
629
value.limit() - value.position(), "UTF-8" );
581
value.limit() - value.position(), charset );
630
582
} catch( UnsupportedEncodingException e ) {
631
583
throw new ParseException( R.string.error_vcf_charset );
632
584
}
679
631
parseEMAIL( name_param_parts, complete_value );
680
632
else if( name_param_parts[ 0 ].equals( "ADR" ) )
681
633
parseADR( name_param_parts, complete_value );
682
else if( name_param_parts[ 0 ].equals( "LABEL" ) )
683
parseLABEL( name_param_parts, complete_value );
684
else if( name_param_parts[ 0 ].equals( "NOTE" ) )
685
parseNOTE( name_param_parts, complete_value );
686
634
}
687
635
}
688
636
701
649
return ( count & 1 ) == 1;
702
650
}
703
651
704
private String[] splitValueByCharacter( String value, char character )
652
private String[] splitValueBySemicolon( String value )
705
653
{
706
// split string in to parts by specified character
654
// split string in to parts by semicolon
707
655
ArrayList< String > parts = new ArrayList< String >(
708
Arrays.asList( value.split( "" + character ) ) );
656
Arrays.asList( value.split( ";" ) ) );
709
657
710
658
// go through parts
711
659
for( int a = 0; a < parts.size(); a++ )
719
667
if( a < parts.size() - 1 &&
720
668
doesStringEndInAnEscapeChar( str ) )
721
669
{
722
// append the escaped character, join the next part to this
723
// part and remove the next part
670
// join the next part to this part and remove the next part
724
671
parts.set( a, str.substring( 0, str.length() - 1 ) +
725
character + parts.get( a + 1 ) );
672
';' + parts.get( a + 1 ) );
726
673
parts.remove( a + 1 );
727
674
728
675
// re-visit this part
739
686
return parts.toArray( ret );
740
687
}
741
688
742
private String unescapeValue( String value )
743
{
744
StringBuilder ret = new StringBuilder( value.length() );
745
boolean in_escape = false;
746
for( int a = 0; a < value.length(); a++ )
747
{
748
int c = value.codePointAt( a );
749
750
// process a normal character
751
if( !in_escape ) {
752
if( c == '\\' )
753
in_escape = true;
754
else
755
ret.append( Character.toChars( c ) );
756
continue;
757
}
758
759
// process an escape sequence
760
in_escape = false;
761
switch( c )
762
{
763
case 'T':
764
case 't':
765
// add tab (invalid/non-standard, but accepted)
766
ret.append( '\t' );
767
break;
768
case 'N':
769
case 'n':
770
// add newline
771
ret.append( '\n' );
772
break;
773
case '\\':
774
case ',':
775
case ';':
776
// add escaped character
777
ret.append( Character.toChars( c ) );
778
break;
779
default:
780
// unknown escape sequence, so add it unescaped
781
// (invalid/non-standard, but accepted)
782
ret.append( "\\" );
783
ret.append( Character.toChars( c ) );
784
break;
785
}
786
}
787
788
return ret.toString();
789
}
790
791
689
private void parseN( String[] params, String value )
792
690
{
793
691
// already got a better name?
794
692
if( _name_level >= NAMELEVEL_N ) return;
795
693
796
694
// get name parts
797
String[] name_parts = splitValueByCharacter( value, ';' );
695
String[] name_parts = splitValueBySemicolon( value );
798
696
799
697
// build name
800
698
value = "";
801
final int[] part_order = { 3, 1, 2, 0, 4 };
802
for( int a = 0; a < part_order.length; a++ )
803
if( name_parts.length > part_order[ a ] &&
804
name_parts[ part_order[ a ] ].length() > 0 )
805
{
806
// split this part in to it's comma-separated bits
807
String[] name_part_parts = splitValueByCharacter(
808
name_parts[ part_order[ a ] ], ',' );
809
for( int b = 0; b < name_part_parts.length; b++ )
810
if( name_part_parts[ b ].length() > 0 )
811
{
812
if( value.length() == 0 ) value += " ";
813
value += name_part_parts[ b ];
814
}
815
}
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 ];
816
703
817
704
// set name
818
setName( unescapeValue( value ) );
705
setName( value );
819
706
_name_level = NAMELEVEL_N;
820
707
}
821
708
825
712
if( _name_level >= NAMELEVEL_FN ) return;
826
713
827
714
// set name
828
setName( unescapeValue( value ) );
715
setName( value );
829
716
_name_level = NAMELEVEL_FN;
830
717
}
831
718
832
719
private void parseORG( String[] params, String value )
833
720
{
834
721
// get org parts
835
String[] org_parts = splitValueByCharacter( value, ';' );
722
String[] org_parts = splitValueBySemicolon( value );
836
723
if( org_parts == null || org_parts.length < 1 ) return;
837
724
838
725
// build organisation name
840
727
String.valueOf( org_parts[ 0 ] ) );
841
728
for( int a = 1; a < org_parts.length; a++ )
842
729
builder.append( ", " ).append( org_parts[ a ] );
843
String organisation = unescapeValue( builder.toString() );
730
String organisation = builder.toString();
844
731
845
732
// set organisation name (using a title we've previously found)
846
733
addOrganisation( organisation, _cached_title, true );
857
744
858
745
private void parseTITLE( String[] params, String value )
859
746
{
860
value = unescapeValue( value );
861
862
747
// if we previously had an organisation, look it up and append this
863
748
// title to it
864
749
if( _cached_organisation != null && hasOrganisations() ) {
890
775
int type;
891
776
if( types.contains( "FAX" ) )
892
777
if( types.contains( "HOME" ) )
893
type = TYPE_FAX_HOME;
778
type = PhonesColumns.TYPE_FAX_HOME;
894
779
else
895
type = TYPE_FAX_WORK;
780
type = PhonesColumns.TYPE_FAX_WORK;
896
781
else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )
897
type = TYPE_MOBILE;
782
type = PhonesColumns.TYPE_MOBILE;
898
783
else if( types.contains( "PAGER" ) )
899
type = TYPE_PAGER;
784
type = PhonesColumns.TYPE_PAGER;
900
785
else if( types.contains( "WORK" ) )
901
type = TYPE_WORK;
786
type = PhonesColumns.TYPE_WORK;
902
787
else
903
type = TYPE_HOME;
788
type = PhonesColumns.TYPE_HOME;
904
789
905
790
// add phone number
906
791
addNumber( value, type, is_preferred );
917
802
boolean is_preferred = types.contains( "PREF" );
918
803
int type;
919
804
if( types.contains( "WORK" ) )
920
type = TYPE_WORK;
805
type = Contacts.ContactMethods.TYPE_WORK;
921
806
else
922
type = TYPE_HOME;
807
type = Contacts.ContactMethods.TYPE_HOME;
923
808
924
addEmail( unescapeValue( value ), type, is_preferred );
809
addEmail( value, type, is_preferred );
925
810
}
926
811
927
812
private void parseADR( String[] params, String value )
928
813
{
929
814
// get address parts
930
String[] adr_parts = splitValueByCharacter( value, ';' );
815
String[] adr_parts = splitValueBySemicolon( value );
931
816
932
817
// build address
933
818
value = "";
934
for( int a = 0; a < adr_parts.length; a++ )
935
if( adr_parts[ a ].length() > 0 )
936
{
937
// split this part in to it's comma-separated bits
938
String[] adr_part_parts =
939
splitValueByCharacter( adr_parts[ a ], ',' );
940
for( int b = 0; b < adr_part_parts.length; b++ )
941
if( adr_part_parts[ b ].length() > 0 )
942
{
943
if( value.length() > 0 ) value += "\n";
944
value += adr_part_parts[ b ];
945
}
946
}
947
948
Set< String > types = extractTypes( params, Arrays.asList(
949
"PREF", "WORK", "HOME" ) );
950
951
// add address
952
int type;
953
if( types.contains( "WORK" ) )
954
type = TYPE_WORK;
955
else
956
type = TYPE_HOME;
957
958
addAddress( unescapeValue( value ), type );
959
}
960
961
private void parseLABEL( String[] params, String value )
962
{
963
Set< String > types = extractTypes( params, Arrays.asList(
964
"PREF", "WORK", "HOME" ) );
965
966
// add address
967
int type;
968
if( types.contains( "WORK" ) )
969
type = TYPE_WORK;
970
else
971
type = TYPE_HOME;
972
973
addAddress( unescapeValue( value ), type );
974
}
975
976
private void parseNOTE( String[] params, String value )
977
{
978
addNote( unescapeValue( 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 );
979
835
}
980
836
981
837
public void finaliseVcard()
982
throws ParseException, ContactNotIdentifiableException
838
throws ParseException
983
839
{
984
840
// missing version (and data is present)
985
841
if( _version == null && _buffers != null )
986
842
throw new ParseException( R.string.error_vcf_malformed );
987
843
988
844
// finalise the parent class
989
finalise();
845
try {
846
finalise();
847
}
848
catch( ContactNotIdentifiableException e ) {
849
throw new ParseException( R.string.error_vcf_notenoughinfo );
850
}
990
851
}
991
852
992
/**
993
* Amongst the params, find the value of the first, only, of any with
994
* the specified name
995
* @param params
996
* @param name
997
* @return a value, or null
998
*/
999
853
private String checkParam( String[] params, String name )
1000
854
{
1001
String[] res = checkParams( params, name );
1002
return res.length > 0? res[ 0 ] : null;
1003
}
1004
1005
/**
1006
* Amongst the params, find the values of any with the specified name
1007
* @param params
1008
* @param name
1009
* @return an array of values, or null
1010
*/
1011
private String[] checkParams( String[] params, String name )
1012
{
1013
HashSet< String > ret = new HashSet< String >();
1014
1015
855
Pattern p = Pattern.compile(
1016
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$",
1017
Pattern.CASE_INSENSITIVE );
856
"^" + name + "[ \\t]*=[ \\t]*(\"?)(.*)\\1$" );
1018
857
for( int i = 0; i < params.length; i++ ) {
1019
858
Matcher m = p.matcher( params[ i ] );
1020
859
if( m.matches() )
1021
ret.add( m.group( 2 ) );
860
return m.group( 2 );
1022
861
}
1023
1024
return (String[]) ret.toArray( new String[ ret.size() ] );
862
return null;
1025
863
}
1026
864
1027
/**
1028
* Amongst the params, return any type values present. For v2.1 vCards,
1029
* those types are just parameters. For v3.0, they are prefixed with
1030
* "TYPE=". There may also be multiple type parameters.
1031
* @param params an array of params to look for types in
1032
* @param valid_types an list of upper-case type values to look for
1033
* @return a set of present type values
1034
*/
1035
865
private Set< String > extractTypes( String[] params,
1036
866
List< String > valid_types )
1037
867
{
1038
868
HashSet< String > types = new HashSet< String >();
1039
869
1040
870
// get 3.0-style TYPE= param
1041
String type_params[] = checkParams( params, "TYPE" );
1042
for( int a = 0; a < type_params.length; a++ )
1043
{
1044
// check for a comma-separated list of types (why? this isn't in
1045
// the specs!)
1046
String[] parts = type_params[ a ].split( "," );
1047
for( int i = 0; i < parts.length; i++ )
1048
parts[ i ] = parts[ i ].toUpperCase( Locale.US );
871
String type_param;
872
if( ( type_param = checkParam( params, "TYPE" ) ) != null ) {
873
String[] parts = type_param.split( "," );
1049
874
for( int i = 0; i < parts.length; i++ )
1050
875
if( valid_types.contains( parts[ i ] ) )
1051
876
types.add( parts[ i ] );
Loggerhead is a web-based interface for Bazaar branches
Version: 1.18.2, Revision: 480