/* 
 *  Copyright (C) 2000 - 2011 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: FileWrite.java 1690 2011-09-26 09:38:42Z alan $
 */


package com.naryx.tagfusion.expression.function.file;

import java.util.List;

import com.naryx.tagfusion.cfm.engine.cfBinaryData;
import com.naryx.tagfusion.cfm.engine.cfBooleanData;
import com.naryx.tagfusion.cfm.engine.cfData;
import com.naryx.tagfusion.cfm.engine.cfSession;
import com.naryx.tagfusion.cfm.engine.cfmRunTimeException;
import com.naryx.tagfusion.cfm.file.vfs.cfVFSData;
import com.naryx.tagfusion.expression.function.functionBase;

public class FileWrite extends functionBase {
  private static final long serialVersionUID = 1L;

  public FileWrite(){ min = 2; max = 3; }
  
	public String[] getParamInfo(){
		return new String[]{
			"srcFile / file object",
			"datatowrite",
			"charset"
		};
	}
	
	public java.util.Map getInfo(){
		return makeInfo(
				"file", 
				"If a file object is passed in, will write the object given.  If a path to a file name will write the full data and close the file.  For writing binary and test based files.  Will append to an existing file.", 
				ReturnType.STRING );
	}
  
  
  public cfData execute( cfSession _session, List<cfData> parameters )throws cfmRunTimeException{
  	
  	cfVFSData	fileObj = null;
  	cfData dataToWrite = null;
  	boolean bWriteFullFile = false;
  	
  	try{
  	
  		/* Setup the file */
	  	if ( parameters.size() == 2 ){
	  		
	  		if ( parameters.get(1) instanceof cfVFSData ){
	  			fileObj 		= (cfVFSData)parameters.get(1);
	  		}else{
	  			fileObj	= new cfVFSData( parameters.get(1).getString(), "append", null );
	  			bWriteFullFile	= true;
	  		}
	  		
	  		dataToWrite	= parameters.get(0);
	  		
	  	}else{
	  		
	  		if ( parameters.get(2) instanceof cfVFSData )
	  			throwException( _session, "you can use this version of FileWrite with a fileObj" );
	  			
	  		fileObj	= new cfVFSData( parameters.get(2).getString(), "append", parameters.get(0).getString() );
	  		dataToWrite	= parameters.get(1);
	  		bWriteFullFile	= true;
	  	}

	  	
	  	/* Check to make sure the file is opened in read only mode */
	  	if ( !fileObj.isWriteable() ){
	  		throwException( _session, "this file object is not opened in write mode" );
	  	}

	  	
	  	/* Read the file */
  		if ( dataToWrite instanceof cfBinaryData ){
  			cfBinaryData binData = (cfBinaryData)dataToWrite;
  			
  			fileObj.write( binData.getByteArray() );
  			fileObj.flushWrite();
  		}else{
  			fileObj.write( dataToWrite.getString() );
  			fileObj.flushWrite();
  		}

	  	return cfBooleanData.TRUE;
	  	
  	}catch(Exception e){
  		throwException( _session, "FileWrite caused an error (" + e.getMessage() + ")" );
  		return null;
  	}finally{
  		if ( bWriteFullFile ){
  			try{ fileObj.close(); }catch(Exception ee){throwException( _session, "FileWrite caused an error (" + ee.getMessage() + ")" );}
  		}
  	}
  }

}