/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.tools.ant.taskdefs.optional.weblogic51;

import java.io.*;
import java.util.*;
import java.util.zip.*;
import java.util.jar.*;

import org.apache.tools.ant.*;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.taskdefs.MatchingTask;
import org.apache.tools.ant.taskdefs.Jar;
import org.apache.tools.ant.taskdefs.Copyfile;

/**
 * Task that can be used to set the weblogic.ejb.deploy setting in the
 * weblogic.properties file. It will include the EJB jar files of the
 * ejbLibDir in this setting. Since this task extends the CopyFile
 * task it can also be used to set other properties in the weblogic.properties
 * file by defining filers in the build XML file feeded to Ant 
 * <TABLE BORDER=1>
 * <TR><TD>ejbLibDir</TD>
 *     <TD>The directory where the ejb jar files are stored.</TD>
 *     <TD>Mandatory</TD><TR>
 * </TABLE>
 *
 * NOTE: This task extends the CopyFile task. Therefore you must als specify the "src" and "dest"
 *       attributes to this task. "src" must be a template of the weblogic.properties file and "dest"
 *       will be the generated weblogic.properties file. 
 *
 * @author Gero Vermaas <a href="mailto:Gero.Vermaas@sun.com">Gero.Vermaas@sun.com</a>
 */
public class Properties extends Copyfile {

  /**
   * Contains the director in which the EJB JAR files are stored
   */
  private String ejbLibDir;
  /**
   * Contains the directory to which the EJB JAR files will be deployed. This is used to prepend
   * the correct path the in weblogic.properties files in the weblogic.ejb.deploy setting
   */
  private String deployEjbLibDir;

  /**
   * Helper constant
   */
  private final static String ANT = "ANT";
  /**
   * Constant to identify the weblogic.ejb.deploy setting
   */
  private final static String WL_EJB_DEPLOY = "weblogic.ejb.deploy";
  /**
   * Constant to be used to separate lines
   */
  private final static String CTN_NEXT_LINE = ",\\\r\n";
  
  /**
   * The method executing the task
   */
  public void execute() throws BuildException {

    log("Creating weblogic.properties file", Project.MSG_VERBOSE);
    try {
        ejbDeployProperty();  		
    } catch (Exception e) {
        e.printStackTrace();
        throw new BuildException();
    }
    super.execute();
  }

  /**
   * Adds a filter for the "@weblogic.ejb.deploy@" tag. This filter contains all
   * ejb jar files found in the ejbLibDir.
   */
  void ejbDeployProperty() throws IOException {
      DirectoryScanner ds = new DirectoryScanner();
      ds.setBasedir(new File(ejbLibDir));
      String[] includes = {"**\\*.jar"};
      ds.setIncludes(includes);
      ds.scan();
      String[] files = ds.getIncludedFiles();
      String strEjbDeploy = "";
      for (int i = 0; i < files.length; i++) {
          strEjbDeploy += "\t" + deployEjbLibDir + "/" + files[i].replace('\\', '/');
          strEjbDeploy += CTN_NEXT_LINE;
      }	  
      if (strEjbDeploy.length() > 0) {
        strEjbDeploy = strEjbDeploy.substring(0, strEjbDeploy.length() - CTN_NEXT_LINE.length());		
      }
      getProject().addFilter(WL_EJB_DEPLOY, strEjbDeploy);
  }
  
  /**
   * Setter for the EJB lib directory
   */
  public void setEjblibdir(String dir) {
    ejbLibDir = dir;
  }  
  
  /**
   * Setter for the EJB deployment lib directory
   */
  public void setDeployejblibdir(String dir) {
    deployEjbLibDir = dir;
  }  
}