package org.codehaus.mojo.rpm;

/*
 * 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.
 */
import java.util.List;

/**
 * A description of a file or directory to be installed.  It includes the
 * properties to be assigned and the location(s) where the file(s) can be
 * found for packaging.
 * @version $Id: Mapping.java 6588 2008-03-28 12:22:57Z bentmann $
 */
public class Mapping {

    // // //  Properties
    /** Destination directory name. */
    private String directory;
    /** Include directory in RPM? Default is yes. */
    private boolean includeDirectory = true;
    /** <code>true</code> if the files are configuration. */
    private boolean configuration;
    /** <code>true</code> if the files are documentation. */
    private boolean documentation;
    /** File mode (octal string) to assign to files when installed. */
    private String filemode;
    /** User name for files when installed. */
    private String username;
    /** Group name for files when installed. */
    private String groupname;
    /** Mapping information for source directories. */
    private List sources;
    /** Mapping information for artifacts. */
    private ArtifactMap artifact;
    /** Mapping information for dependencies. */
    private Dependency dependency;

    // // //  Bean methods
    /**
     * Retrieve the destination during package installation.
     * @return The destination during package installation.
     */
    public String getDirectory() {
        return directory;
    }

    /**
     * Set the destination during package installation.
     * @param dir The new destination during package installation.
     */
    public void setDirectory(String dir) {
        directory = dir;
    }

    /**
     * Include directory in package?  If false, directory must exist already.
     */
    public boolean isIncludeDirectory() {
        return includeDirectory;
    }

    /**
     * Set whether or not to include the directory in the package.
     */
    public void setIncludeDirectory(boolean includeDirectory) {
        this.includeDirectory = includeDirectory;
    }

    /**
     * Retrieve the configuration status.  This value is <code>true</code> if
     * the file(s) in this mapping are configuration files.
     * @return The configuration status.
     */
    public boolean isConfiguration() {
        return configuration;
    }

    /**
     * Set the configuration status.  This value is <code>true</code> if
     * the file(s) in this mapping are configuration files.
     * @param isCfg The new configuration status.
     */
    public void setConfiguration(boolean isCfg) {
        configuration = isCfg;
    }

    /**
     * Retrieve the documentation status.  This value is <code>true</code> if
     * the file(s) in this mapping are documentation files.
     * @return The documentation status.
     */
    public boolean isDocumentation() {
        return documentation;
    }

    /**
     * Set the documentation status.  This value is <code>true</code> if
     * the file(s) in this mapping are documentation files.
     * @param isDoc The new documentation status.
     */
    public void setDocumentation(boolean isDoc) {
        documentation = isDoc;
    }

    /**
     * Retrieve the UNIX file permissions.  This is a three-digit octal number
     * which specifies the permissions to be applied to each file in the
     * mapping when it is installed.
     * @return The UNIX file permissions.
     */
    public String getFilemode() {
        return filemode;
    }

    /**
     * Set the UNIX file permissions.  This is a three-digit octal number
     * which specifies the permissions to be applied to each file in the
     * mapping when it is installed.
     * @param fmode The new UNIX file permissions.
     */
    public void setFilemode(String fmode) {
        filemode = fmode;
    }

    /**
     * Retrieve the UNIX user name to own the installed files.  Note that this
     * must be a name, not a numeric user ID.
     * @return The UNIX user name to own the installed files.
     */
    public String getUsername() {
        return username;
    }

    /**
     * Set the UNIX user name to own the installed files.  Note that this
     * must be a name, not a numeric user ID.
     * @param uname The new UNIX user name to own the installed files.
     */
    public void setUsername(String uname) {
        username = uname;
    }

    /**
     * Retrieve the UNIX group name to own the installed files.  Note that this
     * must be a name, not a numeric group ID.
     * @return The UNIX group name to own the installed files.
     */
    public String getGroupname() {
        return groupname;
    }

    /**
     * Set the UNIX group name to own the installed files.  Note that this
     * must be a name, not a numeric group ID.
     * @param grpname The new UNIX group name to own the installed files.
     */
    public void setGroupname(String grpname) {
        groupname = grpname;
    }

    /**
     * Retrieve the list of source file specifications.
     * @return The list of source file specifications.
     */
    public List getSources() {
        return sources;
    }

    /**
     * Set the list of source file specifications.
     * @param srclist The new list of source file specifications.
     */
    public void setSources(List srclist) {
        sources = srclist;
    }

    /**
     * Retrieve the artifact specification.
     * @return The artifact specification.
     */
    public ArtifactMap getArtifact() {
        return artifact;
    }

    /**
     * Set the artifact specification.
     * @param am The new artifact specification.
     */
    public void setArtifact(ArtifactMap am) {
        artifact = am;
    }

    /**
     * Retrieve the dependency specification.
     * @return The dependency specification.
     */
    public Dependency getDependency() {
        return dependency;
    }

    /**
     * Set the dependency specification.
     * @param am The new dependency specification.
     */
    public void setDependency(Dependency am) {
        dependency = am;
    }

    // // //  Public methods
    /**
     * Assemble the RPM SPEC file attributes for a mapping.
     * @return The attribute string for the SPEC file.
     */
    public String getAttrString() {
        StringBuffer sb = new StringBuffer();

        if (configuration) {
            sb.append("%config ");
        }

        if (documentation) {
            sb.append("%doc ");
        }

        if (((sources == null) || (sources.size() == 0)) && (dependency == null) && (artifact == null)) {
            sb.append("%dir ");
        }

        if (filemode != null) {
            sb.append("%attr(" + filemode + ",");
        } else {
            sb.append("%attr(-,");
        }

        if (username != null) {
            sb.append(username + ",");
        } else {
            sb.append("-,");
        }

        if (groupname != null) {
            sb.append(groupname + ")");
        } else {
            sb.append("-)");
        }

        return sb.toString();
    }

    /**
     * Return the destination directory name.
     * @return The name of the destination directory.
     */
    public String getDestination() {
        if (directory == null) {
            return "nowhere";
        } else {
            return directory;
        }
    }

    /**
     * Return directory-only status.
     * @return <code>true</code> if no sources were specified in the mapping
     */
    public boolean isDirOnly() {
        if ((sources != null) && (!sources.isEmpty())) {
            return false;
        }

        if (artifact != null) {
            return false;
        }

        if (dependency != null) {
            return false;
        }

        return true;
    }

    /** {@inheritDoc} */
    public String toString() {
        boolean sourceShown = false;
        StringBuffer sb = new StringBuffer();

        sb.append("[\"" + getDestination() + "\" ");
        sb.append("{" + getAttrString() + "}");

        if (isDirOnly()) {
            sb.append(" (dir only)]");
        } else {
            sb.append(" from ");
            if (sources != null) {
                sb.append(sources.toString());
                sourceShown = true;
            }
            if (artifact != null) {
                if (sourceShown) {
                    sb.append(", ");
                }
                sb.append(artifact.toString());
                sourceShown = true;
            }
            if (dependency != null) {
                if (sourceShown) {
                    sb.append(", ");
                }
                sb.append(dependency.toString());
                sourceShown = true;
            }
            sb.append("]");
        }

        return sb.toString();
    }
}