/*
 *  eXist Open Source Native XML Database
 *  Copyright (C) 2010 The eXist Project
 *  http://exist-db.org
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *  $Id: FileMove.java 15423 2011-09-30 20:50:11Z dizzzz $
 */
package org.exist.xquery.modules.file;

import java.io.File;

import org.apache.log4j.Logger;

import org.exist.dom.QName;
import org.exist.xquery.BasicFunction;
import org.exist.xquery.Cardinality;
import org.exist.xquery.FunctionSignature;
import org.exist.xquery.XPathException;
import org.exist.xquery.XQueryContext;
import org.exist.xquery.value.BooleanValue;
import org.exist.xquery.value.FunctionParameterSequenceType;
import org.exist.xquery.value.FunctionReturnSequenceType;
import org.exist.xquery.value.Sequence;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.Type;

/**
 * @see java.io.File#renameTo(java.io.File)
 * 
 * @author Dannes Wessels
 *
 */
public class FileMove extends BasicFunction {
	
	private final static Logger logger = Logger.getLogger(FileMove.class);
	
	public final static FunctionSignature signatures[] = {
		new FunctionSignature(
			new QName( "move", FileModule.NAMESPACE_URI, FileModule.PREFIX ),
			"Move (rename) a file or directory. Exact operation is platform dependent. This " +
            "method is only available to the DBA role.",
			new SequenceType[] {				
				new FunctionParameterSequenceType( "original", Type.ITEM, 
                        Cardinality.EXACTLY_ONE, "The full path or URI to the file" ),
				new FunctionParameterSequenceType( "destination", Type.ITEM, 
                        Cardinality.EXACTLY_ONE, "The full path or URI to the file" )
				},				
			new FunctionReturnSequenceType( Type.BOOLEAN, 
                    Cardinality.EXACTLY_ONE, "true if successful, false otherwise" ) )
		};
	

	public FileMove( XQueryContext context, FunctionSignature signature )
	{
		super( context, signature );
	}
	
	/* (non-Javadoc)
	 * @see org.exist.xquery.BasicFunction#eval(org.exist.xquery.value.Sequence[], org.exist.xquery.value.Sequence)
	 */
	public Sequence eval( Sequence[] args, Sequence contextSequence ) throws XPathException 
	{
		if (!context.getUser().hasDbaRole()) {
			XPathException xPathException = new XPathException(this, "Permission denied, calling user '" + context.getUser().getName() + "' must be a DBA to call this function.");
			logger.error("Invalid user", xPathException);
			throw xPathException;
		}

		Sequence moved 	= BooleanValue.FALSE;

		String inputPath1 = args[0].getStringValue();
        File original = FileModuleHelper.getFile(inputPath1);

		String inputPath2 = args[1].getStringValue();
        File destination = FileModuleHelper.getFile(inputPath2);
		
		if( original.renameTo(destination) ) {
			moved = BooleanValue.TRUE;
		}
		
		return( moved );
	}
}