/* 
 *  Copyright (C) 2000 - 2013 TagServlet Ltd
 *
 *  This file is part of Open BlueDragon (OpenBD) CFML Server Engine.
 *  
 *  OpenBD is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  Free Software Foundation,version 3.
 *  
 *  OpenBD 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 OpenBD.  If not, see http://www.gnu.org/licenses/
 *  
 *  Additional permission under GNU GPL version 3 section 7
 *  
 *  If you modify this Program, or any covered work, by linking or combining 
 *  it with any of the JARS listed in the README.txt (or a modified version of 
 *  (that library), containing parts covered by the terms of that JAR, the 
 *  licensors of this Program grant you additional permission to convey the 
 *  resulting work. 
 *  README.txt @ http://www.openbluedragon.org/license/README.txt
 *  
 *  http://openbd.org/
 *  $Id: toString.java 2417 2013-11-13 04:00:38Z alan $
 */

package com.naryx.tagfusion.expression.function;

import java.io.UnsupportedEncodingException;

import com.nary.util.Localization;
import com.naryx.tagfusion.cfm.engine.cfArgStructData;
import com.naryx.tagfusion.cfm.engine.cfBinaryData;
import com.naryx.tagfusion.cfm.engine.cfData;
import com.naryx.tagfusion.cfm.engine.cfSession;
import com.naryx.tagfusion.cfm.engine.cfStringData;
import com.naryx.tagfusion.cfm.engine.cfmRunTimeException;

public class toString extends functionBase {

	private static final long	serialVersionUID	= 1L;

	public toString() {
		min = 1;
		max = 2;
		setNamedParams( new String[] { "object", "encoding" } );
	}



	public boolean isEscapeSingleQuotes() {
		return false;
	}



	public String[] getParamInfo() {
		return new String[] { "object", "encoding" };
	}



	public java.util.Map getInfo() {
		return makeInfo( "conversion", "For the given object, return back the string representation of the it", ReturnType.STRING );
	}



	public cfData execute( cfSession _session, cfArgStructData argStruct ) throws cfmRunTimeException {

		String encoding = getNamedStringParam( argStruct, "encoding", null );
		cfData data = getNamedParam( argStruct, "object" );

		_session.setEscapeSingleQuotes( false );

		if ( encoding != null ) {
			
			if ( data.getDataType() == cfData.CFBINARYDATA ) {
				encoding = Localization.convertCharSetToCharEncoding( encoding );
				try {
					return new cfStringData( new String( ( ( cfBinaryData )data ).getByteArray(), encoding ) );
				} catch ( UnsupportedEncodingException uee ) {
					throwException( _session, "Unsupported encoding specified [" + encoding + "]." );
				}
			} else {
				throwException( _session, "Invalid use of function. The encoding argument can only be used in conjunction with binary data." );
			}
			
		} else if ( data.getDataType() == cfData.CFBINARYDATA ) {
			
			try { // create a string from the binary data using the encoding of the current page response
				encoding = Localization.convertCharSetToCharEncoding( _session.getEncoding() );
				return new cfStringData( new String( ( ( cfBinaryData )data ).getByteArray(), encoding ) );
			} catch ( UnsupportedEncodingException i ) { // highly unlikely
				throwException( _session, "Failed to create string from binary data using default encoding [" + _session.getEncoding() + "]." );
			}
			
		} else {
			return new cfStringData( data.getString() );
		}

		return null; // keeps compiler happy
	}
}