/android/export-contacts

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

« back to all changes in this revision

Viewing changes to src/am/ed/exportcontacts/VcardExporter.java

  • Committer: edam
  • Date: 2010-07-04 14:54:18 UTC
  • Revision ID: edam@waxworlds.org-20100704145418-vcpya2sxsop0dlrq
- initial checkin
- copied intro and basic vcf-configure activities from import-contacts
- copied WizzardActivity class from import-contacts

Show diffs side-by-side

added added

removed removed

1
 
/*
2
 
 * Exporter.java
3
 
 *
4
 
 * Copyright (C) 2011 to 2013 Tim Marston <tim@ed.am>
5
 
 *
6
 
 * This file is part of the Export Contacts program (hereafter referred
7
 
 * to as "this program").  For more information, see
8
 
 * http://ed.am/dev/android/export-contacts
9
 
 *
10
 
 * This program is free software: you can redistribute it and/or modify
11
 
 * it under the terms of the GNU General Public License as published by
12
 
 * the Free Software Foundation, either version 3 of the License, or
13
 
 * (at your option) any later version.
14
 
 *
15
 
 * This program is distributed in the hope that it will be useful,
16
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 
 * GNU General Public License for more details.
19
 
 *
20
 
 * You should have received a copy of the GNU General Public License
21
 
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
 
 */
23
 
 
24
 
package am.ed.exportcontacts;
25
 
 
26
 
import java.io.File;
27
 
import java.io.FileNotFoundException;
28
 
import java.io.FileOutputStream;
29
 
import java.io.IOException;
30
 
import java.util.AbstractCollection;
31
 
import java.util.ArrayList;
32
 
import java.util.Iterator;
33
 
 
34
 
import android.content.SharedPreferences;
35
 
 
36
 
public class VcardExporter extends Exporter
37
 
{
38
 
        protected FileOutputStream _ostream = null;
39
 
        protected boolean _first_contact = true;
40
 
 
41
 
        public VcardExporter( Doit doit )
42
 
        {
43
 
                super( doit );
44
 
        }
45
 
 
46
 
        @Override
47
 
        protected void preExport() throws AbortExportException
48
 
        {
49
 
                SharedPreferences prefs = getSharedPreferences();
50
 
 
51
 
                // create output filename
52
 
                File file = new File( ConfigureVCF.getSdCardPathPrefix() +
53
 
                        prefs.getString( "path", "/" ) +
54
 
                        prefs.getString( "filename", "android-contacts.vcf" ) );
55
 
 
56
 
                // check if the output file already exists
57
 
                if( file.exists() && file.length() > 0 )
58
 
                        showContinueOrAbort( R.string.error_vcf_exists );
59
 
 
60
 
                // open file
61
 
                try {
62
 
                        _ostream = new FileOutputStream( file );
63
 
                }
64
 
                catch( FileNotFoundException e ) {
65
 
                        showError( getText( R.string.error_filenotfound ) +
66
 
                                file.getPath() );
67
 
                }
68
 
        }
69
 
 
70
 
        /**
71
 
         * Do line folding at 75 chars
72
 
         * @param raw string
73
 
         * @return folded string
74
 
         */
75
 
        private String fold( String line )
76
 
        {
77
 
                StringBuilder ret = new StringBuilder( line.length() );
78
 
 
79
 
                // keep pulling off the first line's worth of chars, while the string is
80
 
                // still longer than a line should be
81
 
                while( line.length() > 75 )
82
 
                {
83
 
                        // length of the line we'll be pulling off
84
 
                        int len = 75;
85
 
 
86
 
                        // if splitting at this length would break apart a codepoint, use
87
 
                        // one less char
88
 
                        if( Character.isHighSurrogate( line.charAt( len - 1 ) ) )
89
 
                                len--;
90
 
 
91
 
                        // count how many backslashes would be at the end of the line we're
92
 
                        // pulling off
93
 
                        int count = 0;
94
 
                        for( int a = len - 1; a >= 0; a-- )
95
 
                                if( line.charAt( a ) == '\\' )
96
 
                                        count++;
97
 
                                else
98
 
                                        break;
99
 
 
100
 
                        // if there would be an odd number of slashes at the end of the line
101
 
                        // then pull off one fewer characters so that we don't break apart
102
 
                        // escape sequences
103
 
                        if( count % 2 == 1 )
104
 
                                len--;
105
 
 
106
 
                        // pull off the line and add it to the output, folded
107
 
                        ret.append( line.substring( 0, len ) + "\n " );
108
 
                        line = line.substring( len );
109
 
                }
110
 
 
111
 
                // add any remaining data
112
 
                ret.append( line );
113
 
 
114
 
                return ret.toString();
115
 
        }
116
 
 
117
 
        /**
118
 
         * Do unsafe character escaping
119
 
         * @param raw string
120
 
         * @return escaped string
121
 
         */
122
 
        private String escape( String str )
123
 
        {
124
 
                StringBuilder ret = new StringBuilder( str.length() );
125
 
                for( int a = 0; a < str.length(); a++ )
126
 
                {
127
 
                        int c = str.codePointAt( a );
128
 
                        switch( c )
129
 
                        {
130
 
                        case '\n':
131
 
                                // append escaped newline
132
 
                                ret.append( "\\n" );
133
 
                                break;
134
 
                        case ',':
135
 
                        case ';':
136
 
                        case '\\':
137
 
                                // append return character
138
 
                                ret.append( '\\' );
139
 
                                // fall through
140
 
                        default:
141
 
                                // append character
142
 
                                ret.append( Character.toChars( c ) );
143
 
                        }
144
 
                }
145
 
 
146
 
                return ret.toString();
147
 
        }
148
 
 
149
 
        /**
150
 
         * join
151
 
         */
152
 
        @SuppressWarnings( "rawtypes" )
153
 
        public static String join( AbstractCollection s, String delimiter)
154
 
        {
155
 
                StringBuffer buffer = new StringBuffer();
156
 
                Iterator iter = s.iterator();
157
 
                if( iter.hasNext() ) {
158
 
                        buffer.append( iter.next() );
159
 
                        while( iter.hasNext() ) {
160
 
                                buffer.append( delimiter );
161
 
                                buffer.append( iter.next() );
162
 
                        }
163
 
                }
164
 
                return buffer.toString();
165
 
        }
166
 
 
167
 
        /**
168
 
         * Is the provided value a valid date-and-or-time, as per the spec?
169
 
         *
170
 
         * @param value the value
171
 
         * @return true if it is
172
 
         */
173
 
        protected boolean isValidDateAndOrTime( String value )
174
 
        {
175
 
                // ISO 8601:2004 4.1.2 date with 4.1.2.3 a) and b) reduced accuracy
176
 
                String date =
177
 
                        "[0-9]{4}(?:-?[0-9]{2}(?:-?[0-9]{2})?)?";
178
 
 
179
 
                // ISO 8601:2000 5.2.1.3 d), e) and f) truncated date representation
180
 
                String date_trunc =
181
 
                        "--(?:[0-9]{2}(?:-?[0-9]{2})?|-[0-9]{2})";
182
 
 
183
 
                // ISO 8601:2004 4.2.2 time with 4.2.2.3 reduced accuracy, 4.2.4 UTC and
184
 
                // 4.2.5 zone offset, no 4.2.2.4 decimal fraction and no 4.2.3 24:00
185
 
                // midnight
186
 
                String time =
187
 
                        "(?:[0-1][0-9]|2[0-3])(?::?[0-5][0-9](?::?(?:60|[0-5][0-9]))?)?" +
188
 
                        "(?:Z|[-+](?:[0-1][0-9]|2[0-3])(?::?[0-5][0-9])?)?";
189
 
 
190
 
                // ISO 8601:2000 5.3.1.4 a), b) and c) truncated time representation
191
 
                String time_trunc =
192
 
                        "-(?:[0-5][0-9](?::?(?:60|[0-5][0-9]))?|-(?:60|[0-5][0-9]))";
193
 
 
194
 
                // RFC6350 (vCard 3.0) date-and-or-time with mandatory time designator
195
 
                String date_and_or_time =
196
 
                        "(?:" + date + "|" + date_trunc + ")?" +
197
 
                        "(?:T(?:" + time + "|" + time_trunc + "))?";
198
 
 
199
 
                return value.matches( date_and_or_time );
200
 
        }
201
 
 
202
 
        protected void writeToFile( byte data[], String identifier )
203
 
                throws AbortExportException
204
 
        {
205
 
                // write to file
206
 
                try {
207
 
                        _ostream.write( data );
208
 
                        _ostream.flush();
209
 
                }
210
 
                catch( IOException e ) {
211
 
                        showError( R.string.error_ioerror );
212
 
                }
213
 
        }
214
 
 
215
 
        @Override
216
 
        protected boolean exportContact( ContactData contact )
217
 
                throws AbortExportException
218
 
        {
219
 
                StringBuilder out = new StringBuilder();
220
 
 
221
 
                // skip if the contact has no identifiable features
222
 
                if( contact.getPrimaryIdentifier() == null )
223
 
                        return false;
224
 
 
225
 
                // append newline
226
 
                if( _first_contact )
227
 
                        _first_contact = false;
228
 
                else
229
 
                        out.append( "\n" );
230
 
 
231
 
                // append header
232
 
                out.append( "BEGIN:VCARD\n" );
233
 
                out.append( "VERSION:3.0\n" );
234
 
 
235
 
                // append formatted name
236
 
                String identifier = contact.getPrimaryIdentifier();
237
 
                if( identifier != null ) identifier = identifier.trim();
238
 
                if( identifier == null || identifier.length() == 0 ) {
239
 
                        showContinueOrAbort( R.string.error_vcf_noname );
240
 
                        return false;
241
 
                }
242
 
                out.append( fold( "FN:" + escape( identifier ) ) + "\n" );
243
 
 
244
 
                // append name
245
 
                String name = contact.getName();
246
 
                if( name == null ) name = "";
247
 
                String[] bits = name.split( " +" );
248
 
                StringBuilder tmp = new StringBuilder();
249
 
                for( int a = 1; a < bits.length - 1; a++ ) {
250
 
                        if( a > 1 ) tmp.append( " " );
251
 
                        tmp.append( escape( bits[ a ] ) );
252
 
                }
253
 
                String value = escape( bits[ bits.length - 1 ] ) + ";" +
254
 
                        ( bits.length > 1? escape( bits[ 0 ] ) : "" ) + ";" +
255
 
                        tmp.toString() + ";;";
256
 
                out.append( fold( "N:" + value ) + "\n" );
257
 
 
258
 
                // append organisations and titles
259
 
                ArrayList< Exporter.ContactData.OrganisationDetail > organisations =
260
 
                        contact.getOrganisations();
261
 
                if( organisations != null ) {
262
 
                        for( int a = 0; a < organisations.size(); a++ ) {
263
 
                                if( organisations.get( a ).getOrganisation() != null )
264
 
                                        out.append( fold( "ORG:" + escape(
265
 
                                                organisations.get( a ).getOrganisation() ) ) + "\n" );
266
 
                                if( organisations.get( a ).getTitle() != null )
267
 
                                        out.append( fold( "TITLE:" + escape(
268
 
                                                organisations.get( a ).getTitle() ) ) + "\n" );
269
 
                        }
270
 
                }
271
 
 
272
 
                // append phone numbers
273
 
                ArrayList< Exporter.ContactData.NumberDetail > numbers =
274
 
                        contact.getNumbers();
275
 
                if( numbers != null ) {
276
 
                        for( int a = 0; a < numbers.size(); a++ ) {
277
 
                                ArrayList< String > types = new ArrayList< String >();
278
 
                                switch( numbers.get( a ).getType() ) {
279
 
                                case ContactData.TYPE_HOME:
280
 
                                        types.add( "VOICE" ); types.add( "HOME" ); break;
281
 
                                case ContactData.TYPE_WORK:
282
 
                                        types.add( "VOICE" ); types.add( "WORK" ); break;
283
 
                                case ContactData.TYPE_FAX_HOME:
284
 
                                        types.add( "FAX" ); types.add( "HOME" ); break;
285
 
                                case ContactData.TYPE_FAX_WORK:
286
 
                                        types.add( "FAX" ); types.add( "WORK" ); break;
287
 
                                case ContactData.TYPE_PAGER:
288
 
                                        types.add( "PAGER" ); break;
289
 
                                case ContactData.TYPE_MOBILE:
290
 
                                        types.add( "VOICE" ); types.add( "CELL" ); break;
291
 
                                }
292
 
                                if( a == 0 ) types.add( "PREF" );
293
 
                                out.append( fold( "TEL" +
294
 
                                        ( types.size() > 0? ";TYPE=" + join( types, "," ) : "" ) +
295
 
                                        ":" + escape( numbers.get( a ).getNumber() ) ) + "\n" );
296
 
                        }
297
 
                }
298
 
 
299
 
                // append email addresses
300
 
                ArrayList< Exporter.ContactData.EmailDetail > emails =
301
 
                        contact.getEmails();
302
 
                if( emails != null ) {
303
 
                        for( int a = 0; a < emails.size(); a++ ) {
304
 
                                ArrayList< String > types = new ArrayList< String >();
305
 
                                types.add( "INTERNET" );
306
 
                                switch( emails.get( a ).getType() ) {
307
 
                                case ContactData.TYPE_HOME:
308
 
                                        types.add( "HOME" ); break;
309
 
                                case ContactData.TYPE_WORK:
310
 
                                        types.add( "WORK" ); break;
311
 
                                }
312
 
                                out.append( fold( "EMAIL" +
313
 
                                        ( types.size() > 0? ";TYPE=" + join( types, "," ) : "" ) +
314
 
                                        ":" + escape( emails.get( a ).getEmail() ) ) + "\n" );
315
 
                        }
316
 
                }
317
 
 
318
 
                // append addresses
319
 
                ArrayList< Exporter.ContactData.AddressDetail > addresses =
320
 
                        contact.getAddresses();
321
 
                if( addresses != null ) {
322
 
                        for( int a = 0; a < addresses.size(); a++ ) {
323
 
                                ArrayList< String > types = new ArrayList< String >();
324
 
                                types.add( "POSTAL" );
325
 
                                switch( addresses.get( a ).getType() ) {
326
 
                                case ContactData.TYPE_HOME:
327
 
                                        types.add( "HOME" ); break;
328
 
                                case ContactData.TYPE_WORK:
329
 
                                        types.add( "WORK" ); break;
330
 
                                }
331
 
                                // we use LABEL because is accepts formatted text (whereas ADR
332
 
                                // expects semicolon-delimited fields with specific purposes)
333
 
                                out.append( fold( "LABEL" +
334
 
                                        ( types.size() > 0? ";TYPE=" + join( types, "," ) : "" ) +
335
 
                                        ":" + escape( addresses.get( a ).getAddress() ) ) + "\n" );
336
 
                        }
337
 
                }
338
 
 
339
 
                // append notes
340
 
                ArrayList< String > notes = contact.getNotes();
341
 
                if( notes != null )
342
 
                        for( int a = 0; a < notes.size(); a++ )
343
 
                                out.append( fold( "NOTE:" + escape( notes.get( a ) ) ) + "\n" );
344
 
 
345
 
                // append birthday
346
 
                String birthday = contact.getBirthday();
347
 
                if( birthday != null ) {
348
 
                        birthday.trim();
349
 
                        if( isValidDateAndOrTime( birthday ) )
350
 
                                out.append( fold( "BDAY:" + escape( birthday ) ) + "\n" );
351
 
                        else
352
 
                                out.append(
353
 
                                        fold( "BDAY;VALUE=text:" + escape( birthday ) ) + "\n" );
354
 
                }
355
 
 
356
 
                // append footer
357
 
                out.append( "END:VCARD\n" );
358
 
 
359
 
                // replace '\n' with "\r\n" (spec requires CRLF)
360
 
                int pos = 0;
361
 
                while( true ) {
362
 
                        pos = out.indexOf( "\n", pos );
363
 
                        if( pos == -1 ) break;
364
 
                        out.replace( pos, pos + 1, "\r\n" );
365
 
 
366
 
                        // skip our inserted string
367
 
                        pos += 2;
368
 
                }
369
 
 
370
 
                // write to file
371
 
                writeToFile( out.toString().getBytes(), identifier );
372
 
 
373
 
                return true;
374
 
        }
375
 
 
376
 
}