trunk/src/modules-legacy/task/java/src/org/apache/lenya/cms/task/AntTask.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You 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.
 *
 */

/* $Id$  */

package org.apache.lenya.cms.task;

import java.io.File;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.GregorianCalendar;
import java.util.Iterator;
import java.util.Map;

import org.apache.avalon.framework.parameters.ParameterException;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.lenya.cms.ant.LenyaProject;
import org.apache.lenya.cms.publishing.PublishingEnvironment;
import org.apache.lenya.util.NamespaceMap;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.ProjectHelper;
import org.apache.tools.ant.XmlLogger;

/**
 * An object of this class is used to execute Ant tasks. The task parameters are:
 * 
 * <ul>
 * <li><code><strong>publication-id</strong></code>: the publication ID</li>
 * <li><code><strong>buildfile</strong> (optional)</code>: the location of the build file
 * relative to the publication directory. If this parameter is not provided, the file is loaded from
 * {@link #DEFAULT_BUILDFILE}.</li>
 * <li><code><strong>target</strong> (optional)</code>: the build target. If this parameter is
 * not provided, the default target is executed.</li>
 * <li><code><strong>ant.*</strong></code>: the command-line parameters for Ant <strong>(not
 * implemented yet!) </strong></li>
 * <li><code><strong>properties.*</strong></code>: the project properties</li>
 * </ul>
 * @deprecated Use the usecase framework instead.
 */
public class AntTask extends AbstractTask {
    
    /**
     * Executes an Ant target.
     * 
     * @param buildFile The build XML file.
     * @param target The name of the target to execute.
     * @param arguments A map mapping the command-line arguments to their values.
     * @param properties A map mapping the project properties to their values.
     * @param servletContextPath The context-path of the servlet
     * @param contextPrefix The context-prefix of the servlet
     * @param publicationId The publication-id
     * @param publicationDirectory The directory of the publication
     * @param logFile The file where the log should go to
     * 
     * @throws ExecutionException if the execution failed
     */
    public void executeAntTarget(String servletContextPath, String contextPrefix,
            String publicationId, File publicationDirectory, File buildFile, String target,
            Map arguments, Map properties, File logFile) throws ExecutionException {
        Project project = new LenyaProject(getServiceManager());
        project.setCoreLoader(getClass().getClassLoader());

        Throwable error = null;

        try {
            // create task log directory if it doesn't exist
            File logDirectory = logFile.getParentFile();

            if (!logDirectory.exists()) {
                logDirectory.mkdirs();
            }

            project.setUserProperty("XmlLogger.file", logFile.getAbsolutePath());

            XmlLogger logger = new XmlLogger();
            project.addBuildListener(logger);
            project.fireBuildStarted();

            project.init();
            project.setBaseDir(publicationDirectory);

            ProjectHelper helper = ProjectHelper.getProjectHelper();
            helper.parse(project, buildFile);

            project.setUserProperty(PUBLICATION_DIRECTORY, publicationDirectory.getAbsolutePath());
            project.setUserProperty(PUBLICATION_ID, publicationId);
            project.setUserProperty(SERVLET_CONTEXT_PATH, servletContextPath);
            project.setUserProperty(CONTEXT_PREFIX, contextPrefix);

            String key;
            String value;
            Map.Entry entry;

            for (Iterator iter = properties.entrySet().iterator(); iter.hasNext();) {
                entry = (Map.Entry) iter.next();
                key = (String) entry.getKey();
                value = (String) entry.getValue();
                project.setUserProperty(key, value);
            }

            if (target == null) {
                target = project.getDefaultTarget();
            }

            project.executeTarget(target);
        } catch (BuildException e) {
            error = e;
            throw new ExecutionException(e);
        } finally {
            project.fireBuildFinished(error);
        }
    }

    /**
     * Returns the filename of the logfile to write.
     * @param publicationDirectory for which publication the filename of the logfile is requested
     * @return the file path for the log file
     */
    protected File getDefaultLogFile(File publicationDirectory) {
        Calendar now = new GregorianCalendar();

        return new File(publicationDirectory, LOG_PATH + dateFormat.format(now.getTime()) + ".xml");
    }

    /**
     * <code>dateFormat</code> The date format
     */
    public static final DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd-HH-mm-ss-SSS");
    /**
     * <code>PUBLICATION_DIRECTORY</code> The publication directory
     */
    public static final String PUBLICATION_DIRECTORY = "pub.dir";
    /**
     * <code>PUBLICATION_ID</code> The publication id
     */
    public static final String PUBLICATION_ID = "pub.id";
    /**
     * <code>SERVLET_CONTEXT_PATH</code> The servlet context path
     */
    public static final String SERVLET_CONTEXT_PATH = "servlet.context";
    /**
     * <code>CONTEXT_PREFIX</code> The context prefix
     */
    public static final String CONTEXT_PREFIX = "context.prefix";
    /**
     * <code>BUILDFILE</code> The build file
     */
    public static final String BUILDFILE = "buildfile";
    /**
     * <code>TARGET</code> The target
     */
    public static final String TARGET = "target";
    /**
     * <code>ANT_PREFIX</code> The ant prefix
     */
    public static final String ANT_PREFIX = "ant";
    /**
     * <code>PROPERTIES_PREFIX</code> The properties prefix
     */
    public static final String PROPERTIES_PREFIX = "properties";
    /**
     * <code>DEFAULT_BUILDFILE</code> The default build file
     */
    public static final String DEFAULT_BUILDFILE = "config/tasks/targets.xml";
    /**
     * <code>LOG_PATH</code> The log path
     */
    public static final String LOG_PATH = "logs/tasks/".replace('/', File.separatorChar);
    /**
     * <code>PARAMETER_LOGFILE</code> The log file parameter
     */
    public static final String PARAMETER_LOGFILE = "logfile";

    /**
     * Execute the task. All parameters must have been set with parameterize().
     * @param servletContextPath The servlet context path.
     * @throws ExecutionException when the execution of the task failed.
     */
    public void execute(String servletContextPath) throws ExecutionException {
        String publicationId;
        File publicationDirectory;
        String contextPrefix;
        File buildFile;
        String target;
        Map arguments;
        Map properties;
        File logFile;

        try {
            String buildFileName = getParameters().getParameter("buildfile", DEFAULT_BUILDFILE)
                    .replace('/', File.separatorChar);

            publicationId = getParameters().getParameter(PARAMETER_PUBLICATION_ID);
            contextPrefix = getParameters().getParameter(PARAMETER_CONTEXT_PREFIX);

            if (publicationId.equals("")) {
                publicationDirectory = new File(".");
                buildFile = new File(buildFileName);
            } else {
                PublishingEnvironment environment = new PublishingEnvironment(servletContextPath,
                        publicationId);
                publicationDirectory = environment.getPublicationDirectory();
                buildFile = new File(publicationDirectory, buildFileName);
            }

            target = getParameters().getParameter(TARGET, null);

            Map parametersMap = Parameters.toProperties(getParameters());

            NamespaceMap antMap = new NamespaceMap(parametersMap, ANT_PREFIX);
            arguments = antMap.getMap();

            NamespaceMap propertiesMap = new NamespaceMap(parametersMap, PROPERTIES_PREFIX);
            properties = propertiesMap.getMap();

            // set logfile
            String logFilename = getParameters().getParameter(PARAMETER_LOGFILE,
                    getDefaultLogFile(publicationDirectory).getAbsolutePath());
            logFile = new File(logFilename);
        } catch (ParameterException e) {
            throw new ExecutionException(e);
        }

        executeAntTarget(servletContextPath,
                contextPrefix,
                publicationId,
                publicationDirectory,
                buildFile,
                target,
                arguments,
                properties,
                logFile);
    }
}