001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.enforcer.rules.files;
020
021import javax.inject.Named;
022
023import java.io.File;
024import java.io.IOException;
025
026/**
027 * The Class RequireFilesExist.
028 */
029@Named("requireFilesExist")
030public final class RequireFilesExist extends AbstractRequireFiles {
031    @Override
032    boolean checkFile(File file) {
033        // if we get here and the handle is null, treat it as a success
034        return file == null ? true : file.exists() && osIndependentNameMatch(file, true);
035    }
036
037    @Override
038    String getErrorMsg() {
039        return "Some required files are missing:" + System.lineSeparator();
040    }
041
042    /**
043     * OSes like Windows are case insensitive, so this method will compare the file path with the actual path. A simple
044     * {@link File#exists()} is not enough for such OS.
045     *
046     * @param file the file to verify
047     * @param defaultValue value to return in case an IO exception occurs, should never happen as the file already
048     *            exists
049     * @return
050     */
051    private boolean osIndependentNameMatch(File file, boolean defaultValue) {
052        try {
053            File absFile;
054            if (!file.isAbsolute()) {
055                absFile = new File(new File(".").getCanonicalFile(), file.getPath());
056            } else {
057                absFile = file;
058            }
059
060            return absFile.toURI().equals(absFile.getCanonicalFile().toURI());
061        } catch (IOException e) {
062            return defaultValue;
063        }
064    }
065}