/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements.  See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership.  The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License.  You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied.  See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package info.ineighborhood.cardme.util;

/**
 * Copyright (c) 2004, Neighborhood Technologies
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of Neighborhood Technologies nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * 
 * @author George El-Haddad
 * <br/>
 * Aug 23, 2006
 * 
 */
public final class Base64Wrapper {
	
	/**
	 * @author George El-Haddad
	 * <br/>
	 * Feb 10, 2010
	 * 
	 * <p>Base64 options.</p>
	 */
	public enum OPTIONS {
		/**
		 * <p>Compress the bytes to GZIP compression before encoding them
		 * to base64. This significantly reduces the size of the base64.
		 * Other applications that will decode must be aware that the encoding
		 * is compressed.</p>
		 */
		GZIP_COMPRESSION,
		
		/**
		 * <p>Do not compress the bytes before encoding to base64. This is
		 * the default unless compression option is explicitly stated.</p>
		 */
		NO_COMPRESSION;
	}
	
	private Base64Wrapper() {

	}

	/**
	 * <p>Encodes the specified bytes into a base64 String
	 * without using GZIP compression as the default.</p>
	 *
	 * @see Base64
	 * @see OPTIONS
	 * 
	 * @param bytes
	 * @return {@link String}
	 */
	public static String encode(byte[] bytes)
	{
		return encode(bytes, OPTIONS.NO_COMPRESSION);
	}
	
	/**
	 * <p>Encodes the specified bytes into a base64 String with the given
	 * options to use GZIP compression or not.</p>
	 *
	 * @see Base64
	 * @see OPTIONS
	 * 
	 * @param bytes
	 * @param options
	 * @return {@link String}
	 */
	public static String encode(byte[] bytes, OPTIONS options)
	{
		switch(options)
		{
			case GZIP_COMPRESSION:
			{
				return Base64.encodeBytes(bytes, Base64.GZIP | Base64.DONT_BREAK_LINES);
			}

			case NO_COMPRESSION:
			{
				return Base64.encodeBytes(bytes, Base64.DONT_BREAK_LINES);
			}

			default:
			{
				return Base64.encodeBytes(bytes, Base64.DONT_BREAK_LINES);
			}
		}
	}
	
	/**
	 * <p>Decodes a base64 String into an array of bytes. GZIP compression
	 * is automatically detected and decompressed.</p>
	 *
	 * @see Base64
	 * 
	 * @param base64String
	 * @return byte[]
	 */
	public static byte[] decode(String base64String)
	{
		return Base64.decode(base64String);
	}

//	/**
//	 * 
//	 * @param base64string
//	 * @return String
//	 */
//	private static String unfoldBase64String(String base64string)
//	{
//		base64string = base64string.replaceAll(VCardUtils.LF, "");
//		base64string = base64string.replaceAll(VCardUtils.CR, "");		
//		return base64string;
//	}
//	
//	public static void main(String ...args) {
//		
//		try {
//			File file = new File(Base64Wrapper.class.getResource("tux.png").toURI());
//			BufferedReader br = new BufferedReader(new FileReader(file));
//			int b = -1;
//			int i = 0;
//			byte[] bytes = new byte[(int)file.length()];
//			while((b = br.read()) != -1) {
//				bytes[i] = (byte)b;
//				i++;
//			}
//			
//			System.out.println(Base64Wrapper.encode(bytes));
//		}
//		catch(Exception ex) {
//			ex.printStackTrace();
//		}
//	}
}