com.izforge.izpack.util.file.ResourceUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of izpack-util Show documentation
There is a newer version: 5.2.3
/*
 * Copyright  2003-2004 The Apache Software Foundation
 *
 *  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.
 *
 */

package com.izforge.izpack.util.file;

import java.io.File;
import java.util.Vector;
import java.util.logging.Logger;

import com.izforge.izpack.util.file.types.Resource;
import com.izforge.izpack.util.file.types.ResourceFactory;
import com.izforge.izpack.util.file.types.selectors.SelectorUtils;

/**
 * this class provides utility methods to process resources
 */
public class ResourceUtils
{
    private static final Logger logger = Logger.getLogger(ResourceUtils.class.getName());

    /**
     * tells which source files should be reprocessed based on the
     * last modification date of target files
     *
     * @param logTo   where to send (more or less) interesting output
     * @param source  array of resources bearing relative path and last
     *                modification date
     * @param mapper  filename mapper indicating how to find the target
     *                files
     * @param targets object able to map as a resource a relative path
     *                at destination
     * @return array containing the source files which need to be
     *         copied or processed, because the targets are out of date or do
     *         not exist
     */
    public static Resource[] selectOutOfDateSources(Resource[] source,
                                                    FileNameMapper mapper,
                                                    ResourceFactory targets)
            throws Exception
    {
        return selectOutOfDateSources(source, mapper, targets,
                FileUtils.getFileUtils()
                        .getFileTimestampGranularity());
    }

    /**
     * tells which source files should be reprocessed based on the
     * last modification date of target files
     *
     * @param logTo       where to send (more or less) interesting output
     * @param resources   array of resources bearing relative path and last
     *                    modification date
     * @param mapper      filename mapper indicating how to find the target
     *                    files
     * @param targets     object able to map as a resource a relative path
     *                    at destination
     * @param granularity The number of milliseconds leeway to give
     *                    before deciding a target is out of date.
     * @return array containing the source files which need to be
     *         copied or processed, because the targets are out of date or do
     *         not exist
     */
    public static Resource[] selectOutOfDateSources(Resource[] resources,
                                                    FileNameMapper mapper,
                                                    ResourceFactory targets,
                                                    long granularity)
            throws Exception
    {
        long now = (new java.util.Date()).getTime() + granularity;

        Vector vresult = new Vector();
        for (Resource resource : resources)
        {
            if (resource.getLastModified() > now)
            {
                logger.warning(resource.getName() + " modified in the future.");
            }

            String[] targetnames =
                    mapper.mapFileName(resource.getName()
                            .replace('/', File.separatorChar));
            if (targetnames != null)
            {
                boolean added = false;
                StringBuffer targetList = new StringBuffer();
                for (int ctarget = 0; !added && ctarget < targetnames.length;
                     ctarget++)
                {
                    Resource atarget =
                            targets.getResource(targetnames[ctarget]
                                    .replace(File.separatorChar, '/'));
                    // if the target does not exist, or exists and
                    // is older than the source, then we want to
                    // add the resource to what needs to be copied
                    if (!atarget.isExists())
                    {
                        logger.warning(resource.getName() + " added as "
                                + atarget.getName()
                                + " doesn\'t exist.");
                        vresult.addElement(resource);
                        added = true;
                    }
                    else if (!atarget.isDirectory()
                            && SelectorUtils.isOutOfDate(resource,
                            atarget,
                            (int) granularity))
                    {
                        logger.warning(resource.getName() + " added as "
                                + atarget.getName()
                                + " is outdated.");
                        vresult.addElement(resource);
                        added = true;
                    }
                    else
                    {
                        if (targetList.length() > 0)
                        {
                            targetList.append(", ");
                        }
                        targetList.append(atarget.getName());
                    }
                }

                if (!added)
                {
                    logger.fine(resource.getName()
                            + " omitted as " + targetList.toString()
                            + (targetnames.length == 1 ? " is" : " are ")
                            + " up to date.");
                }
            }
            else
            {
                logger.warning(resource.getName()
                        + " skipped - don\'t know how to handle it");
            }
        }
        Resource[] result = new Resource[vresult.size()];
        vresult.copyInto(result);
        return result;
    }
}