org.exist.xquery.modules.file.DirectoryCreate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of exist-file Show documentation
eXist-db XQuery File Module
There is a newer version: 6.3.0
/*
 *  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$
 */
package org.exist.xquery.modules.file;

import java.io.IOException;
import java.nio.file.FileAlreadyExistsException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.FileAttribute;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.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.nio.file.Files#createDirectory(Path, FileAttribute[])
 * @see java.nio.file.Files#createDirectories(Path, FileAttribute[])
 *
 * @author Dannes Wessels
 *
 */
public class DirectoryCreate extends BasicFunction {

    private final static Logger logger = LogManager.getLogger(DirectoryCreate.class);
    public final static FunctionSignature signatures[] = {
        new FunctionSignature(
                new QName("mkdir", FileModule.NAMESPACE_URI, FileModule.PREFIX),
                "Create a directory.  This method is only available to the DBA role.",
                new SequenceType[]{
                    new FunctionParameterSequenceType("path", Type.ITEM, 
                            Cardinality.EXACTLY_ONE, "The full path or URI to the directory")
                },
                new FunctionReturnSequenceType(Type.BOOLEAN, 
                        Cardinality.EXACTLY_ONE, "true if successful, false otherwise")
            ),
        new FunctionSignature(
                new QName("mkdirs", FileModule.NAMESPACE_URI, FileModule.PREFIX),
                "Create a directory including any necessary but nonexistent parent directories. " +
                "This method is only available to the DBA role.",
                new SequenceType[]{
                    new FunctionParameterSequenceType("path", Type.ITEM, 
                            Cardinality.EXACTLY_ONE, "The full path or URI to the directory")
                },
                new FunctionReturnSequenceType(Type.BOOLEAN, 
                        Cardinality.EXACTLY_ONE, "true if successful, false otherwise")
            )
    };


    public DirectoryCreate(final XQueryContext context, final FunctionSignature signature) {
        super(context, signature);
    }

    @Override
    public Sequence eval(final Sequence[] args, final Sequence contextSequence) throws XPathException {
        
        if (!context.getSubject().hasDbaRole()) {
            XPathException xPathException = new XPathException(this, "Permission denied, calling user '" + context.getSubject().getName() + "' must be a DBA to call this function.");
            logger.error("Invalid user", xPathException);
            throw xPathException;
        }

        Sequence created = BooleanValue.FALSE;
        
        final String inputPath = args[0].itemAt(0).getStringValue();
        final Path file =  FileModuleHelper.getFile(inputPath);

        try {
            if (isCalledAs("mkdir") && Files.notExists(file)) {
                Files.createDirectory(file);
                created = BooleanValue.TRUE;
            } else if (isCalledAs("mkdirs")) {
                Files.createDirectories(file);
                created = BooleanValue.TRUE;
            }
        } catch (final FileAlreadyExistsException e) {
            created = BooleanValue.FALSE;
        } catch(final IOException e) {
            throw new XPathException(this, e);
        }

        return created;
    }
}