package org.apache.maven.release;

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 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 acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache Maven" 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",
 *    "Apache Maven", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * 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/>.
 *
 * ====================================================================
 */

import org.dom4j.Document;
import org.dom4j.io.SAXReader;
import org.jaxen.XPath;
import org.jaxen.dom4j.Dom4jXPath;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

/**
 * This is a simple POM manipulator that doesn't take into account any sort of
 * POM inheritance. When the interpolation and inheritance is cleaned up in the
 * Maven we will be able to serialize a POM directly with greater ease. But we
 * may stick with this Jaxen solution anyway because it's so easy. Just turn the
 * POM in memory into a Dom4j document and perform the same operation as we are
 * here.
 */
public class PomNodeSelector
{
    /**
     * POM document
     */
    private File pom;

    /**
     * Xpath expression.
     */
    private String xpathExpression;

    /**
     * Snapshot dependencies found.
     */
    private List nodes;

    /**
     * Constructor.
     */
    public PomNodeSelector()
    {
        nodes = new ArrayList();
    }

    // -------------------------------------------------------------------------
    // Accessors
    // -------------------------------------------------------------------------

    public void setXpathExpression( String xpathExpression )
    {
        this.xpathExpression = xpathExpression;
    }

    public String getXpathExpression()
    {
        return xpathExpression;
    }

    /**
     * Sets the nodes attribute of the PomManipulator object
     */
    public void setNodes( List nodes )
    {
        this.nodes = nodes;
    }

    /**
     * Gets the nodes attribute of the PomManipulator object
     */
    public List getNodes()
    {
        return nodes;
    }

    public void setPom( File pom )
    {
        this.pom = pom;
    }

    public File getPom()
    {
        return pom;
    }

    /**
     * Update the snapshot version identifiers with actual timestamp versions
     * and write out the POM in its updated form.
     *
     * @throws Exception
     */
    public void execute()
        throws Exception
    {
        SAXReader reader = new SAXReader();
        Document doc = reader.read( getPom() );

        // The selecting nodes with the xpath expression will give us a list
        // of dependencies elements where the version element is equal to 'SNAPSHOT'.
        // So we can get any information we need, and alter anything we need to before writing
        // the dom4j document back out.
        XPath xpath = new Dom4jXPath( getXpathExpression() );
        setNodes( xpath.selectNodes( doc ) );
    }
}
