/*
    * Copyright 2007 the original author or authors.
    *
    * Licensed 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 org.goetz.domino.log4j;
  
  import java.util.Date;
  import java.util.Vector;
  
  import org.apache.log4j.helpers.LogLog;
  
  /***
   * This class provides a container for log documents in a Domino application. 
   * 
   * @author Bernd G?tz
   */
  public class LogDocument {
  	
      /***
       * The number of LoggingEvents to log in a singel Domino document.
       */
      protected static final int DEFAULT_MAX_LINES = 1000;
      
      /***
       * Default form name.
       */
      protected static final String DEFAULT_FORM_NAME = "frmEvents";
      
      /***
       * The upper limit in bytes where to stop writing to a document.
       */
      protected static final int UPPER_SIZE_LIMIT = 1024*28;
      
      /***
       * The maximum to write to a document is 32kB.
       */
      protected static final int MAX_DOCUMENT_SIZE = 1024*31;
  
      /***
       * The Domino serverName to log events to, or "" for local.
       */
      private String serverName = "";
  	
      /***
       * The databaseName path to log events to.
       * If set to null, the current databaseName is used as log databaseName.
       */
      private String databaseName;
      
  	private String formName;
  	
  	private String applicationName;
  	
  	private String applicationPath;
  	
      /***
       * The pattern converter layout including %u for the current agent user.
       */
      private  String message = null;
      
      /***
       * True if the message contains the variable "%u".
       */
      private boolean msgContainsUserVariable = false;
      
  	private Date startTime;
  	
  	private Date finishTime;
  	
  	private Vector events = new Vector();
  	
  	private int currentSize = 0;
  	
  	/***
  	 * Current number of lines.
  	 */
  	private int currentLines = 0;
  	
  	/***
  	 * Current notes document id with which this document is connected to.
  	 */
  	private String currentDocId;
  	
  	/***
  	 * The maximum number of LoggingEvents per document.
  	 */
  	private int maxLines = DEFAULT_MAX_LINES;
 
 	private boolean isFull = false; 
 	
 	private boolean dirty = false; 
 	
     public LogDocument() {
 		super();
 		startTime = new Date();
 	}
 	
 	public LogDocument(String name, String path, String name2, String name3, 
 		Date time) {
 		super();
 		applicationName = name;
 		applicationPath = path;
 		formName = name2;
 		serverName = name3;
 		startTime = time;
 	}
 
 	/***
 	 * Resets the current log document.
 	 * 
 	 * @param startTime
 	 */
 	public void reset(Date startTime) {
 		LogLog.debug("Resetting log document instance");
 		events.clear();
 		currentSize = 0;
 		currentLines = 0;
 		isFull = false;
 		dirty = false;
 		this.startTime = startTime;
 		this.finishTime = null;
 	}
 
 	public String getApplicationName() {
 		return applicationName;
 	}
 
 	public String getApplicationPath() {
 		return applicationPath;
 	}
 
 	public Date getFinishTime() {
 		return finishTime;
 	}
 
 	public void setFinishTime(Date finishTime) {
 		this.finishTime = finishTime;
 	}
 
 	public String getFormName() {
 		if (formName == null) {
 			return DEFAULT_FORM_NAME;
 		} else {
 			return formName;
 		}
 	}
 
 	public String getServerName() {
 		return serverName;
 	}
 
 	public Date getStartTime() {
 		return startTime;
 	}
 
 	public Vector getEvents() {
 		return events;
 	}
 	
 	/***
 	 * Adds a single line to the document.
 	 * 
 	 * @param s
 	 */
 	public void add(String s) {
 		if ((currentSize + s.length()) >= MAX_DOCUMENT_SIZE) {
 			int l = MAX_DOCUMENT_SIZE - currentSize - 1;
 			LogLog.debug("Cutting log entry to " + l + " characters");
 			s = "Document full, partial information: ".concat(s).
 				substring(l);
 		}
 		events.add(s);
 		currentSize += s.length();
 		currentLines++;
 		dirty = true;
         isFull = (currentSize >= UPPER_SIZE_LIMIT) || 
         	(currentLines >= maxLines);
         if (isFull) {
             setFinishTime(new Date());
         }
 	}
 	
 	public int getCurrentSize() {
 		return currentSize;
 	}
 	
 	public int getCurrentLines() {
 		return currentLines;
 	}
 	
 	public void setApplicationName(String applicationName) {
 		this.applicationName = applicationName;
 	}
 
 	public void setApplicationPath(String applicationPath) {
 		this.applicationPath = applicationPath;
 	}
 
 	public void setFormName(String formName) {
 		this.formName = formName;
 	}
 
 	public void setServerName(String serverName) {
 		this.serverName = serverName;
 	}
 
 	public void setStartTime(Date startTime) {
 		this.startTime = startTime;
 	}
 
 	public String getDatabaseName() {
 		return databaseName;
 	}
 
 	public void setDatabaseName(String databaseName) {
 		this.databaseName = databaseName;
 	}
 
 	public String getMessage() {
 		return message;
 	}
 
 	/***
 	 * Sets the message string and the 
 	 * 
 	 * @param message
 	 */
 	public void setMessage(String message) {
 		this.message = message;
     	this.msgContainsUserVariable = (message.indexOf("%u") >= 0);
 	}
 	
 	/***
 	 * Returns true if the current message contains the variable "%u".
 	 * 
 	 * The current value is determined by calling the method <code>setMessage()
 	 * </code>.
 	 * 
 	 * @return true if message contains the variable "%u" 
 	 */
 	public boolean messageContainsUserVariable() {
 		return msgContainsUserVariable;
 	}
 
 	public int getMaxLines() {
 		return maxLines;
 	}
 
 	public void setMaxLines(int lines) {
 		this.maxLines = lines;
 	}
 
 	public boolean isFull() {
 		return isFull;
 	}
 
 	public String getCurrentDocId() {
 		return currentDocId;
 	}
 
 	public void setCurrentDocId(String currentDocId) {
 		this.currentDocId = currentDocId;
 	}
 
 	public boolean isDirty() {
 		return dirty;
 	}
 
 }