/* 
 *  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: FileReadBinary.java 2147 2012-07-02 01:57:34Z alan $
 */

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

import java.io.BufferedInputStream;
import java.io.IOException;
import java.util.List;

import org.aw20.io.ByteArrayOutputStreamRaw;

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.cfmRunTimeException;
import com.naryx.tagfusion.cfm.file.vfs.cfVFSData;
import com.naryx.tagfusion.expression.function.functionBase;

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

  public FileReadBinary(){ min = 1; max = 1; }
  
	public String[] getParamInfo(){
		return new String[]{
			"srcFile"
		};
	}
	
	public java.util.Map getInfo(){
		return makeInfo(
				"file", 
				"Read the file at the path into memory.  For use with binary files", 
				ReturnType.BINARY );
	}
  
  
  public cfData execute( cfSession _session, List<cfData> parameters )throws cfmRunTimeException{
  	cfVFSData	fileObj = null;
  	try{
  		fileObj = new cfVFSData( parameters.get(0).getString(), "readbinary", null );
  		
	  	/* Check to make sure the file is opened in read only mode */
	  	if ( !fileObj.isReadable() ){
	  		throwException( _session, "this file object is not opened in read mode" );
	  	}
	  	
	  	/* Read the file */
	  	return new cfBinaryData( readFullFile( fileObj ) );

  	}catch(Exception e){
  		throwException( _session, "FileReadBinary caused an error (" + e.getMessage() + ")" );
  		return null;
  	}finally{
			try{ fileObj.close(); }catch(Exception ignoreE){}
  	}
  }
  
  
  private byte[] readFullFile( cfVFSData	fileObj ) throws IOException {
    @SuppressWarnings("resource")
		ByteArrayOutputStreamRaw Buffer = new ByteArrayOutputStreamRaw(32000);
		
		byte in[]	= new byte[ 2048 ];
		int c1;
		BufferedInputStream	bis = fileObj.getStreamReader(); 

		while ( (c1=bis.read(in,0,2048))!=-1 )
			Buffer.write( in, 0, c1 );
		
		fileObj.setEOF();
   	return Buffer.toByteArray();
  }
}