/android/import-contacts

/*

 * VCFImporter.java

 *

 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>

 *

 * This file is part of the Import Contacts program (hereafter referred

 * to as "this program"). For more information, see

 * http://www.waxworlds.org/edam/software/android/import-contacts

 *

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation, either version 3 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program.  If not, see <http://www.gnu.org/licenses/>.

 */

package org.waxworlds.edam.importcontacts;

import java.io.BufferedReader;

import java.io.File;

import java.io.FileNotFoundException;

import java.io.FileReader;

import java.io.FilenameFilter;

import java.io.IOException;

import java.io.UnsupportedEncodingException;

import java.util.Arrays;

import java.util.HashSet;

import java.util.List;

import java.util.Set;

import java.util.Vector;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

import android.content.SharedPreferences;

import android.provider.Contacts;

import android.provider.Contacts.PhonesColumns;

public class VCFImporter extends Importer

{

	private int _vCardCount = 0;

	private int _progress = 0;

	public VCFImporter( Doit doit )

	{

		super( doit );

	}

	@Override

	protected void onImport() throws AbortImportException

	{

		SharedPreferences prefs = getSharedPreferences();

		// update UI

		setProgressMessage( R.string.doit_scanning );

		// get a list of vcf files

		File[] files = null;

		try

		{

			// open directory

			String path = "/sdcard" + prefs.getString( "location", "/" );

			File file = new File( path );

			if( !file.exists() )

				showError( R.string.error_locationnotfound );

			// directory, or file?

			if( file.isDirectory() )

			{

				// get files

				class VCardFilter implements FilenameFilter {

					public boolean accept( File dir, String name ) {

						return name.toLowerCase().endsWith( ".vcf" );

					}

				}

				files = file.listFiles( new VCardFilter() );

			}

			else

			{

				// use just this file

				files = new File[ 1 ];

				files[ 0 ] = file;

			}

		}

		catch( SecurityException e ) {

			showError( R.string.error_locationpermissions );

		}

		// check num files and set progress max

		if( files != null && files.length > 0 )

			setProgressMax( files.length );

		else

			showError( R.string.error_locationnofiles );

		// scan through the files

		setTmpProgress( 0 );

		for( int i = 0; i < files.length; i++ ) {

			countVCardFile( files[ i ] );

			setTmpProgress( i );

		}

		setProgressMax( _vCardCount );	// will also update tmp progress

		// import them

		setProgress( 0 );

		for( int i = 0; i < files.length; i++ )

			importVCardFile( files[ i ] );

	}

	private void countVCardFile( File file ) throws AbortImportException

	{

		try

		{

			// open file

			BufferedReader reader = new BufferedReader(

					new FileReader( file ) );

			// read

			String line;

			boolean inVCard = false;

			while( ( line = reader.readLine() ) != null )

			{

				if( !inVCard ) {

					// look for vcard beginning

					if( line.matches( "^BEGIN[ \\t]*:[ \\t]*VCARD" ) ) {

						inVCard = true;

						_vCardCount++;

					}

				}

				else if( line.matches( "^END[ \\t]*:[ \\t]*VCARD" ) )

					inVCard = false;

			}

		}

		catch( FileNotFoundException e ) {

			showError( getText( R.string.error_filenotfound ) +

				file.getName() );

		}

		catch( IOException e ) {

			showError( getText( R.string.error_ioerror ) + file.getName() );

		}

	}

	private void importVCardFile( File file ) throws AbortImportException

	{

		try

		{

			// open file

			BufferedReader reader = new BufferedReader(

					new FileReader( file ) );

			// read

			StringBuffer content = new StringBuffer();

			String line;

			while( ( line = reader.readLine() ) != null )

				content.append( line ).append( "\n" );

			importVCardFileContent( content.toString(), file.getName() );

		}

		catch( FileNotFoundException e ) {

			showError( getText( R.string.error_filenotfound ) +

				file.getName() );

		}

		catch( IOException e ) {

			showError( getText( R.string.error_ioerror ) + file.getName() );

		}

	}

	private void importVCardFileContent( String content, String fileName )

			throws AbortImportException

	{

		// get lines and parse them

		String[] lines = content.split( "\n" );

		VCard vCard = null;

		for( int i = 0; i < lines.length; i++ )

		{

			String line = lines[ i ];

			if( vCard == null ) {

				// look for vcard beginning

				if( line.matches( "^BEGIN[ \\t]*:[ \\t]*VCARD" ) ) {

					setProgress( ++_progress );

					vCard = new VCard();

				}

			}

			else {

				// look for vcard content or ending

				if( line.matches( "^END[ \\t]*:[ \\t]*VCARD" ) )

				{

					// store vcard and do away with it

					try {

						vCard.finaliseParsing();

						importContact( vCard );

					}

					catch( VCard.ParseException e ) {

						skipContact();

						if( !showContinue(

								getText( R.string.error_vcf_parse ).toString()

								+ fileName + "\n" + e.getMessage() ) )

							finish( ACTION_ABORT );

					}

					catch( VCard.SkipContactException e ) {

						skipContact();

						// do nothing

					}

					vCard = null;

				}

				else

				{

					// try giving the line to the vcard

					try {

						vCard.parseLine( line );

					}

					catch( VCard.ParseException e ) {

						skipContact();

						if( !showContinue(

								getText( R.string.error_vcf_parse ).toString()

								+ fileName + "\n" + e.getMessage() ) )

							finish( ACTION_ABORT );

						// although we're continuing, we still need to abort

						// this vCard. Further lines will be ignored until we

						// get to another BEGIN:VCARD line.

						vCard = null;

					}

					catch( VCard.SkipContactException e ) {

						skipContact();

						// abort this vCard. Further lines will be ignored until

						// we get to another BEGIN:VCARD line.

						vCard = null;

					}

				}

			}

		}

	}

	private class VCard extends ContactData

	{

		private final static int NAMELEVEL_NONE = 0;

		private final static int NAMELEVEL_ORG = 1;

		private final static int NAMELEVEL_FN = 2;

		private final static int NAMELEVEL_N = 3;

		private String _version = null;

		private Vector< String > _lines = null;

		private int _name_level = NAMELEVEL_NONE;

		private boolean _parser_in_multiline = false;

		private String _parser_current_name_and_params = null;

		private String _parser_buffered_value_so_far = "";

		protected class UnencodeResult

		{

			private boolean _another_line_required;

			private byte[] _bytes;

			private int _num_bytes;

			public UnencodeResult( boolean another_line_required, byte[] bytes,

				int num_bytes )

			{

				_another_line_required = another_line_required;

				_bytes = bytes;

				_num_bytes = num_bytes;

			}

			public boolean isAnotherLineRequired()

			{

				return _another_line_required;

			}

			public byte[] getBytes()

			{

				return _bytes;

			}

			public int getNumBytes()

			{

				return _num_bytes;

			}

		}

		@SuppressWarnings("serial")

		protected class ParseException extends Exception

		{

			@SuppressWarnings("unused")

			public ParseException( String error )

			{

				super( error );

			}

			public ParseException( int res )

			{

				super( VCFImporter.this.getText( res ).toString() );

			}

		}

		@SuppressWarnings("serial")

		protected class SkipContactException extends Exception { }

		public void parseLine( String line )

				throws ParseException, SkipContactException,

				AbortImportException

		{

			// ignore empty lines

			if( line.trim() == "" ) return;

			// split line into name and value parts (this may turn out to be

			// unwanted if the line is a subsequent line in a multi-line

			// value, but we have to do this now to check for and handle VCF

			// versions first)

			String[] props = line.split(  ":", 2 );

			for( int i = 0; i < props.length; i++ )

				props[ i ] = props[ i ].trim();

			// if we haven't yet got a version, we won't be paring anything!

			if( _version == null )

			{

				// is this a version?

				if( props.length == 2 && props[ 0 ].equals( "VERSION" ) )

				{

					// yes, check/store it

					if( !props[ 1 ].equals( "2.1" ) &&

							!props[ 1 ].equals( "3.0" ) )

						throw new ParseException( R.string.error_vcf_version );

					_version = props[ 1 ];

					// parse any other lines we've accumulated so far

					if( _lines != null )

						for( int i = 0; i < _lines.size(); i++ )

							parseLine( _lines.get( i ) );

					_lines = null;

				}

				else

				{

					// no, so stash this line till we have a version

					if( _lines == null )

						_lines = new Vector< String >();

					_lines.add( line );

				}

			}

			else

			{

				if( _parser_in_multiline )

				{

					// if we're currently in a multi-line value, use the stored

					// property name and parameters

					props = new String[ 2 ];

					props[ 0 ] = _parser_current_name_and_params;

					props[ 1 ] = line.trim();

				}

				else

				{

					// for normal lines, check the property name/value bits

					if( props.length < 2 || props[ 0 ].length() == 0 )

						throw new ParseException(

							R.string.error_vcf_malformed );

					// ignore empty properties

					if( props[ 1 ].length() < 1 )

						return;

					// reset the saved multi-line state

					_parser_current_name_and_params = props[ 0 ];

					_parser_buffered_value_so_far = "";

				}

				// get parameter parts

				String[] params = props[ 0 ].split( ";" );

				for( int i = 0; i < params.length; i++ )

					params[ i ] = params[ i ].trim();

				// parse charset and encoding parameters

				String charset, encoding;

				if( ( charset = checkParam( params, "CHARSET" ) ) != null &&

					!charset.equals( "UTF-8" ) && !charset.equals( "UTF-16" ) )

				{

					throw new ParseException( R.string.error_vcf_charset );

				}

				if( ( encoding = checkParam( params, "ENCODING" ) ) != null &&

					!encoding.equals( "QUOTED-PRINTABLE" ) &&

					!encoding.equals( "8BIT" ) )

					//&& !encoding.equals( "BASE64" ) )

				{

					throw new ParseException( R.string.error_vcf_encoding );

				}

				// do unencoding (or default to a fake unencoding result with

				// the raw string)

				UnencodeResult result;

				if( encoding != null && encoding.equals( "QUOTED-PRINTABLE" ) )

					result = unencodeQuotedPrintable( props[ 1 ], charset );

//				else if( encoding != null && encoding.equals( "BASE64" ) )

//					result = unencodeBase64( props[ 1 ], charset );

				else

					result = new UnencodeResult( false, props[ 1 ].getBytes(),

						props[ 1 ].getBytes().length );

				// process charset

				try {

					props[ 1 ] = new String( result.getBytes(), 0,

						result.getNumBytes(),

						charset == null? "UTF-8" : charset );

				} catch( UnsupportedEncodingException e ) {

					throw new ParseException( R.string.error_vcf_charset );

				}

				// handle multi-line requests

				_parser_in_multiline = result.isAnotherLineRequired();

				if( _parser_in_multiline ) {

					_parser_buffered_value_so_far += props[ 1 ];

					return;

				}

				// add on buffered multi-line content

				String value = _parser_buffered_value_so_far + props[ 1 ];

				// parse some properties

				if( params[ 0 ].equals( "N" ) )

					parseN( params, value );

				else if( params[ 0 ].equals( "FN" ) )

					parseFN( params, value );

				else if( params[ 0 ].equals( "ORG" ) )

					parseORG( params, value );

				else if( params[ 0 ].equals( "TEL" ) )

					parseTEL( params, value );

				else if( params[ 0 ].equals( "EMAIL" ) )

					parseEMAIL( params, value );

			}

		}

		private void parseN( String[] params, String value )

				throws ParseException, SkipContactException,

				AbortImportException

		{

			// already got a better name?

			if( _name_level >= NAMELEVEL_N ) return;

			// get name parts

			String[] nameparts = value.split( ";" );

			for( int i = 0; i < nameparts.length; i++ )

				nameparts[ i ] = nameparts[ i ].trim();

			// build name

			value = "";

			if( nameparts.length > 1 && nameparts[ 1 ].length() > 0 )

				value += nameparts[ 1 ];

			if( nameparts[ 0 ].length() > 0 )

				value += ( value.length() == 0? "" : " " ) + nameparts[ 0 ];

			// set name

			setName( value );

			_name_level = NAMELEVEL_N;

			// check now to see if we need to import this contact (to avoid

			// parsing the rest of the vCard unnecessarily)

			if( !isImportRequired( getName() ) )

				throw new SkipContactException();

		}

		private void parseFN( String[] params, String value )

				throws ParseException, SkipContactException

		{

			// already got a better name?

			if( _name_level >= NAMELEVEL_FN ) return;

			// set name

			setName( value );

			_name_level = NAMELEVEL_FN;

		}

		private void parseORG( String[] params, String value )

				throws ParseException, SkipContactException

		{

			// already got a better name?

			if( _name_level >= NAMELEVEL_ORG ) return;

			// get org parts

			String[] orgparts = value.split( ";" );

			for( int i = 0; i < orgparts.length; i++ )

				orgparts[ i ] = orgparts[ i ].trim();

			// build name

			if( orgparts[ 0 ].length() == 0 && orgparts.length > 1 )

				value = orgparts[ 1 ];

			else

				value = orgparts[ 0 ];

			// set name

			setName( value );

			_name_level = NAMELEVEL_ORG;

		}

		private void parseTEL( String[] params, String value )

				throws ParseException

		{

			if( value.length() == 0 ) return;

			Set< String > types = extractTypes( params, Arrays.asList(

					"PREF", "HOME", "WORK", "VOICE", "FAX", "MSG", "CELL",

					"PAGER", "BBS", "MODEM", "CAR", "ISDN", "VIDEO" ) );

			// here's the logic...

			boolean preferred = types.contains( "PREF" );

			if( types.contains( "VOICE" ) )

				if( types.contains( "WORK" ) )

					addPhone( value, PhonesColumns.TYPE_WORK, preferred );

				else

					addPhone( value, PhonesColumns.TYPE_HOME, preferred );

			else if( types.contains( "CELL" ) || types.contains( "VIDEO" ) )

				addPhone( value, PhonesColumns.TYPE_MOBILE, preferred );

			if( types.contains( "FAX" ) )

				if( types.contains( "HOME" ) )

					addPhone( value, PhonesColumns.TYPE_FAX_HOME, preferred );

				else

					addPhone( value, PhonesColumns.TYPE_FAX_WORK, preferred );

			if( types.contains( "PAGER" ) )

				addPhone( value, PhonesColumns.TYPE_PAGER, preferred );

		}

		public void parseEMAIL( String[] params, String value )

				throws ParseException

		{

			if( value.length() == 0 ) return;

			Set< String > types = extractTypes( params, Arrays.asList(

					"PREF", "WORK", "HOME", "INTERNET" ) );

			// here's the logic...

			boolean preferred = types.contains( "PREF" );

			if( types.contains( "WORK" ) )

				addEmail( value, Contacts.ContactMethods.TYPE_WORK, preferred );

			else

				addEmail( value, Contacts.ContactMethods.TYPE_HOME, preferred );

		}

		public void finaliseParsing()

				throws ParseException, SkipContactException,

				AbortImportException

		{

			// missing version (and data is present)

			if( _version == null && _lines != null )

				throw new ParseException( R.string.error_vcf_malformed );

			//  missing name properties?

			if( _name_level == NAMELEVEL_NONE )

				throw new ParseException( R.string.error_vcf_noname );

			// check if we should import this one? If we've already got an 'N'-

			// type name, this will already have been done by parseN() so we

			// mustn't do this here (or it could prompt twice!)

			if( _name_level < NAMELEVEL_N && !isImportRequired( getName() ) )

				throw new SkipContactException();

		}

		private String checkParam( String[] params, String name )

		{

			Pattern p = Pattern.compile( "^" + name + "[ \\t]*=[ \\t]*(.*)$" );

			for( int i = 0; i < params.length; i++ ) {

				Matcher m = p.matcher( params[ i ] );

				if( m.matches() )

					return m.group( 1 );

			}

			return null;

		}

		private Set< String > extractTypes( String[] params,

				List< String > validTypes )

		{

			HashSet< String > types = new HashSet< String >();

			// get 3.0-style TYPE= param

			String typeParam;

			if( ( typeParam = checkParam( params, "TYPE" ) ) != null ) {

				String[] bits = typeParam.split( "," );

				for( int i = 0; i < bits.length; i++ )

					if( validTypes.contains( bits[ i ] ) )

						types.add( bits[ i ] );

			}

			// get 2.1-style type param

			if( _version.equals( "2.1" ) ) {

				for( int i = 1; i < params.length; i++ )

					if( validTypes.contains( params[ i ] ) )

						types.add( params[ i ] );

			}

			return types;

		}

		private UnencodeResult unencodeQuotedPrintable( String str, String charset )

		{

			boolean another = false;

			// default encoding scheme

			if( charset == null ) charset = "UTF-8";

			// unencode quoted-pritable encoding, as per RFC1521 section 5.1

			byte[] bytes = new byte[ str.length() ];

			int j = 0;

			for( int i = 0; i < str.length(); i++ )

			{

				// get next char and process...

				char ch = str.charAt( i );

				if( ch == '=' && i < str.length() - 2 )

				{

					// we found a =XX format byte, add it

					bytes[ j ] = (byte)(

							Character.digit( str.charAt( i + 1 ), 16 ) * 16 +

							Character.digit( str.charAt( i + 2 ), 16 ) );

					i += 2;

				}

				else if( ch == '=' && i == str.length() - 1 )

				{

					// we found a '=' at the end of a line signifying a multi-

					// line string, so we don't add it.

					another = true;

					continue;

				}

				else

					// just a normal char...

					bytes[ j ] = (byte)ch;

				j++;

			}

			return new UnencodeResult( another, bytes, j );

		}

	}

}