/*
 * Copyright (C) 2006-2008 Alfresco Software Limited.
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */

package org.alfresco.jlan.debug;

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintStream;

import org.springframework.extensions.config.ConfigElement;

/**
 * Log File Debug Class.
 *
 * <p>Output the debug information to a log file.
 *
 * @author gkspencer
 */
public class LogFileDebug extends DebugInterfaceBase {

	//	Output file stream

	private PrintStream m_out;

	/**
	 * Default constructor
	 */
	public LogFileDebug() {
	}
	
	/**
	 * Create a log file debug object using the specified file name. Append to an existing file
	 * if the append flag is true, else truncate the existing file.
	 *
	 * @param fname String
	 * @param append boolean
	 */
	public LogFileDebug(String fname, boolean append) throws IOException {

	  //  Open the file

		open(fname, append);
	}

	/**
	 * Open the output file stream
	 * 
	 * @param fname String
	 * @param append boolean
	 * @exception IOException
	 */
	protected final void open(String fname, boolean append)
		throws IOException {

		//	Open the output file and also redirect the standard output stream to it
				
		FileOutputStream fout = new FileOutputStream( fname, append);
		m_out = new PrintStream ( fout);
		System.setOut(m_out);
	}
	
	/**
	 * Close the debug output.
	 */
	public void close() {

	  //  Close the debug file, if open

	  if ( m_out != null) {
        m_out.close();
        m_out = null;
	  }
	}

	/**
	 * Output a debug string with a specific logging level
	 * 
	 * @param str String
	 * @param level int
	 */
	public void debugPrint(String str, int level) {
	  if ( level <= getLogLevel())
		m_out.print(str);
	}
	
	/**
	 * Output a debug string, and a newline, with a specific logging level
	 *
	 * @param str String
	 */
	public void debugPrintln(String str, int level) {
	  if ( level <= getLogLevel() && m_out != null) {
        m_out.println(str);
        m_out.flush();
	  }
	}

	/**
	 * Initialize the debug interface using the specified parameters.
	 *
	 * @param params ConfigElement
	 */
	public void initialize(ConfigElement params)
		throws Exception {

		// Call the base class
		
		super.initialize( params);
		
		//	Get the output file name and append flag settings

		ConfigElement logFile = params.getChild( "logFile");
		boolean append = params.getChild( "append") != null ? true : false;
		
		//	Check if the log file has been specified
		
		if ( logFile.getValue() == null || logFile.getValue().length() == 0)
			throw new Exception("logFile parameter not specified");
		
		//  Open the file

		open(logFile.getValue(), append);
	}
}