/*
 * IzPack - Copyright 2001-2005 Julien Ponge, All Rights Reserved.
 * 
 * http://www.izforge.com/izpack/
 * http://developer.berlios.de/projects/izpack/
 * 
 * Copyright 2001 Johannes Lehtinen
 * 
 * Licensed 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: PackFile.java,v 1.21 2005/05/06 20:09:09 jponge Exp $
 *  IzPack
 *  Copyright (C) 2001 Johannes Lehtinen
 *
 *  File :               Pack.java
 *  Description :        Contains informations about a pack file.
 *  Author's email :     johannes.lehtinen@iki.fi
 *  Author's Website :   http://www.iki.fi/jle/
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.izforge.izpack;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.Serializable;
import java.util.List;
import java.util.Map;

/**
 * Encloses information about a packed file. This class abstracts the way file data is stored to
 * package.
 * 
 * @author Johannes Lehtinen <johannes.lehtinen@iki.fi>
 */
public class PackFile implements Serializable
{

    static final long serialVersionUID = -834377078706854909L;

    public static final int OVERRIDE_FALSE = 0;

    public static final int OVERRIDE_TRUE = 1;

    public static final int OVERRIDE_ASK_FALSE = 2;

    public static final int OVERRIDE_ASK_TRUE = 3;

    public static final int OVERRIDE_UPDATE = 4;

    public String sourcePath = null;

    /** The full path name of the target file */
    private String targetPath = null;

    /** The target operating system constraints of this file */
    private List osConstraints = null;

    /** The length of the file in bytes */
    private long length = 0;

    /** The last-modification time of the file. */
    private long mtime = -1;

    /** True if file is a directory (length should be 0 or ignored) */
    private boolean isDirectory = false;

    /** Whether or not this file is going to override any existing ones */
    private int override = OVERRIDE_FALSE;

    /** Additional attributes or any else for customisation */
    private Map additionals = null;

    public int previousPackNumber = -1;

    public long offsetInPreviousPack = -1;

    /**
     * Constructs and initializes from a source file.
     * 
     * @param src file which this PackFile describes
     * @param target the path to install the file to
     * @param osList OS constraints
     * @param override what to do when the file already exists
     * @throws FileNotFoundException if the specified file does not exist.
     */
    public PackFile(File src, String target, List osList, int override)
            throws FileNotFoundException
    {
        if (!src.exists()) // allows cleaner client co
            throw new FileNotFoundException("No such file: " + src);

        if ('/' != File.separatorChar) target = target.replace(File.separatorChar, '/');
        if (target.endsWith("/")) target = target.substring(0, target.length() - 1);

        this.sourcePath = src.getPath();
        this.targetPath = target;
        this.osConstraints = osList;
        this.override = override;

        this.length = src.length();
        this.mtime = src.lastModified();
        this.isDirectory = src.isDirectory();
    }

    /**
     * Constructs and initializes from a source file.
     * 
     * @param src file which this PackFile describes
     * @param target the path to install the file to
     * @param osList OS constraints
     * @param override what to do when the file already exists
     * @param additionals additional attributes
     * @throws FileNotFoundException if the specified file does not exist.
     */
    public PackFile(File src, String target, List osList, int override, Map additionals)
            throws FileNotFoundException
    {
        this(src, target, osList, override);
        this.additionals = additionals;
    }

    public void setPreviousPackFileRef(int previousPackNumber, long offsetInPreviousPack)
    {
        this.previousPackNumber = previousPackNumber;
        this.offsetInPreviousPack = offsetInPreviousPack;
    }

    /** The target operating system constraints of this file */
    public final List osConstraints()
    {
        return osConstraints;
    }

    /** The length of the file in bytes */
    public final long length()
    {
        return length;
    }

    /** The last-modification time of the file. */
    public final long lastModified()
    {
        return mtime;
    }

    /** Whether or not this file is going to override any existing ones */
    public final int override()
    {
        return override;
    }

    public final boolean isDirectory()
    {
        return isDirectory;
    }

    public final boolean isBackReference()
    {
        return (previousPackNumber >= 0);
    }

    /** The full path name of the target file, using '/' as fileseparator. */
    public final String getTargetPath()
    {
        return targetPath;
    }

    /**
     * Returns the additionals map.
     * 
     * @return additionals
     */
    public Map getAdditionals()
    {
        return additionals;
    }

}