View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.enforcer.rules.files;
20  
21  import javax.inject.Named;
22  
23  import java.io.File;
24  import java.io.IOException;
25  
26  /**
27   * The Class RequireFilesExist.
28   */
29  @Named("requireFilesExist")
30  public final class RequireFilesExist extends AbstractRequireFiles {
31      @Override
32      boolean checkFile(File file) {
33          // if we get here and the handle is null, treat it as a success
34          return file == null || (file.exists() && osIndependentNameMatch(file));
35      }
36  
37      @Override
38      String getErrorMsg() {
39          return "Some required files are missing:" + System.lineSeparator();
40      }
41  
42      /**
43       * OSes like Windows are case-insensitive, so this method will compare the file path with the actual path. A simple
44       * {@link File#exists()} is not enough for such OS.
45       *
46       * @param file the file to verify
47       */
48      private boolean osIndependentNameMatch(File file) {
49          try {
50              File absFile;
51              if (!file.isAbsolute()) {
52                  absFile = new File(new File(".").getCanonicalFile(), file.getPath());
53              } else {
54                  absFile = file;
55              }
56  
57              return absFile.toURI().equals(absFile.getCanonicalFile().toURI());
58          } catch (IOException e) {
59              return true;
60          }
61      }
62  }