Do log all handled ForbiddenSymlinkException at same FINER level

idodeclare · idodeclare · commit b2db0b72b343 · 2018-01-25T10:47:07.000-06:00
Also, restore accidentally removed block comment.
diff --git a/src/org/opensolaris/opengrok/configuration/Project.java b/src/org/opensolaris/opengrok/configuration/Project.java
@@ -29,6 +29,9 @@
 import java.util.Locale;
 import java.util.Set;
 import java.util.TreeSet;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import org.opensolaris.opengrok.logger.LoggerFactory;
 import org.opensolaris.opengrok.util.ClassUtil;
 import org.opensolaris.opengrok.util.ForbiddenSymlinkException;
 
@@ -39,6 +42,8 @@ public class Project implements Comparable<Project>, Nameable, Serializable {
 
     private static final long serialVersionUID = 1L;
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(Project.class);
+
     static {
         ClassUtil.remarkTransientFields(Project.class);
     }
@@ -317,7 +322,10 @@ public static Project getProject(File file) {
             ret = getProject(RuntimeEnvironment.getInstance().getPathRelativeToSourceRoot(file));
         } catch (FileNotFoundException e) { // NOPMD
             // ignore if not under source root
-        } catch (IOException|ForbiddenSymlinkException e) { // NOPMD
+        } catch (ForbiddenSymlinkException e) {
+            LOGGER.log(Level.FINER, e.getMessage());
+            // ignore
+        } catch (IOException e) { // NOPMD
             // problem has already been logged, just return null
         }
         return ret;
diff --git a/src/org/opensolaris/opengrok/configuration/RuntimeEnvironment.java b/src/org/opensolaris/opengrok/configuration/RuntimeEnvironment.java
@@ -1335,6 +1335,7 @@ private void generateProjectRepositoriesMap() throws IOException {
                 repoPath = getPathRelativeToSourceRoot(
                     new File(r.getDirectoryName()), 0);
             } catch (ForbiddenSymlinkException e) {
+                LOGGER.log(Level.FINER, e.getMessage());
                 continue;
             }
 
diff --git a/src/org/opensolaris/opengrok/configuration/messages/ProjectMessage.java b/src/org/opensolaris/opengrok/configuration/messages/ProjectMessage.java
@@ -201,9 +201,12 @@ protected byte[] applyMessage(RuntimeEnvironment env) throws Exception {
                                 return env.getPathRelativeToSourceRoot(
                                         new File((x).getDirectoryName())
                                 );
-                            } catch (IOException|ForbiddenSymlinkException e) {
+                            } catch (ForbiddenSymlinkException e) {
+                                LOGGER.log(Level.FINER, e.getMessage());
+                                return "";
+                            } catch (IOException e) {
                                 LOGGER.log(Level.INFO,
-                                    "cannot remove files for repository " +
+                                    "cannot remove files for repository {0}",
                                     x.getDirectoryName());
                                 // Empty output should not cause any harm
                                 // since {@code getReposFromString()} inside
diff --git a/src/org/opensolaris/opengrok/history/BazaarHistoryParser.java b/src/org/opensolaris/opengrok/history/BazaarHistoryParser.java
@@ -173,7 +173,8 @@ public void processStream(InputStream input) throws IOException {
                             String name = env.getPathRelativeToSourceRoot(f);
                             entry.addFile(name.intern());
                         } catch (ForbiddenSymlinkException e) {
-                            // ignored (and already logged by PathUtils)
+                            LOGGER.log(Level.FINER, e.getMessage());
+                            // ignored
                         }
                     }
                     break;
diff --git a/src/org/opensolaris/opengrok/history/FileHistoryCache.java b/src/org/opensolaris/opengrok/history/FileHistoryCache.java
@@ -152,7 +152,7 @@ private boolean isRenamedFile(String filename,
             repodir = env.getPathRelativeToSourceRoot(
                 new File(repository.getDirectoryName()));
         } catch (ForbiddenSymlinkException e) {
-            // already logged by PathUtils
+            LOGGER.log(Level.FINER, e.getMessage());
             return false;
         }
         String shortestfile = filename.substring(repodir.length() + 1);
@@ -380,6 +380,9 @@ private void storeFile(History histNew, File file, Repository repo)
     private void finishStore(Repository repository, String latestRev) {
         String histDir = getRepositoryHistDataDirname(repository);
         if (histDir == null || !(new File(histDir)).isDirectory()) {
+            // If the history was not created for some reason (e.g. temporary
+            // failure), do not create the CachedRevision file as this would
+            // create confusion (once it starts working again).
             LOGGER.log(Level.WARNING,
                 "Could not store history for repo {0}",
                 repository.getDirectoryName());
@@ -644,7 +647,10 @@ public boolean hasCacheForDirectory(File directory, Repository repository)
         try {
             dir = new File(dir, env.getPathRelativeToSourceRoot(
                 new File(repos.getDirectoryName())));
-        } catch (IOException|ForbiddenSymlinkException e) {
+        } catch (ForbiddenSymlinkException e) {
+            LOGGER.log(Level.FINER, e.getMessage());
+            return false;
+        } catch (IOException e) {
             throw new HistoryException("Could not resolve " +
                     repos.getDirectoryName()+" relative to source root", e);
         }
@@ -673,7 +679,7 @@ public String getRepositoryHistDataDirname(Repository repository) {
                 repository.getDirectoryName()+" relative to source root", ex);
             return null;
         } catch (ForbiddenSymlinkException ex) {
-            LOGGER.log(Level.FINE, "forbidden symbolic link", ex);
+            LOGGER.log(Level.FINER, ex.getMessage());
             return null;
         }
 
diff --git a/src/org/opensolaris/opengrok/history/GitHistoryParser.java b/src/org/opensolaris/opengrok/history/GitHistoryParser.java
@@ -34,6 +34,7 @@
 import java.text.ParseException;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.regex.Pattern;
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
@@ -132,8 +133,10 @@ private void process(BufferedReader in) throws IOException {
                         File f = new File(myDir, s);
                         String path = env.getPathRelativeToSourceRoot(f);
                         entry.addFile(path.intern());
-                    } catch (FileNotFoundException|
-                        ForbiddenSymlinkException e) { //NOPMD
+                    } catch (ForbiddenSymlinkException e) {
+                        LOGGER.log(Level.FINER, e.getMessage());
+                        // ignore
+                    } catch (FileNotFoundException e) { //NOPMD
                         // If the file is not located under the source root,
                         // ignore it (bug #11664).
                     }
diff --git a/src/org/opensolaris/opengrok/history/MercurialHistoryParser.java b/src/org/opensolaris/opengrok/history/MercurialHistoryParser.java
@@ -144,8 +144,10 @@ public void processStream(InputStream input) throws IOException {
                         try {
                             String path = env.getPathRelativeToSourceRoot(f);
                             entry.addFile(path.intern());
-                        } catch (FileNotFoundException|
-                            ForbiddenSymlinkException e) { // NOPMD
+                        } catch (ForbiddenSymlinkException e) {
+                            LOGGER.log(Level.FINER, e.getMessage());
+                            // ignore
+                        } catch (FileNotFoundException e) { // NOPMD
                             // If the file is not located under the source root,
                             // ignore it (bug #11664).
                         }
diff --git a/src/org/opensolaris/opengrok/history/MonotoneHistoryParser.java b/src/org/opensolaris/opengrok/history/MonotoneHistoryParser.java
@@ -169,8 +169,10 @@ public void processStream(InputStream input) throws IOException {
                                 String path = env.getPathRelativeToSourceRoot(
                                     file);
                                 entry.addFile(path.intern());
-                            } catch (FileNotFoundException|
-                                ForbiddenSymlinkException e) { // NOPMD
+                            } catch (ForbiddenSymlinkException e) {
+                                LOGGER.log(Level.FINER, e.getMessage());
+                                // ignore
+                            } catch (FileNotFoundException e) { // NOPMD
                                 // If the file is not located under the source root, ignore it
                             }
                         }
diff --git a/src/org/opensolaris/opengrok/index/IndexDatabase.java b/src/org/opensolaris/opengrok/index/IndexDatabase.java
@@ -1330,7 +1330,7 @@ public static Definitions getDefinitions(File file)
         try {
             path = env.getPathRelativeToSourceRoot(file);
         } catch (ForbiddenSymlinkException e) {
-            // (already logged by PathUtils)
+            LOGGER.log(Level.FINER, e.getMessage());
             return null;
         }
         //sanitize windows path delimiters
diff --git a/src/org/opensolaris/opengrok/util/ForbiddenSymlinkException.java b/src/org/opensolaris/opengrok/util/ForbiddenSymlinkException.java
@@ -17,7 +17,7 @@
  * CDDL HEADER END
  */
 
- /*
+/*
  * Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
  */
 
diff --git a/src/org/opensolaris/opengrok/util/PathUtils.java b/src/org/opensolaris/opengrok/util/PathUtils.java
@@ -172,7 +172,7 @@ private static boolean isAllowedSymlink(String canonicalFile,
         return false;
     }
 
-    /** private to enforce singleton */
+    /** private to enforce static */
     private PathUtils() {
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1335,6 +1335,7 @@ private void generateProjectRepositoriesMap() throws IOException {`
`1335`	`1335`	`repoPath = getPathRelativeToSourceRoot(`
`1336`	`1336`	`new File(r.getDirectoryName()), 0);`
`1337`	`1337`	`} catch (ForbiddenSymlinkException e) {`
	`1338`	`+ LOGGER.log(Level.FINER, e.getMessage());`
`1338`	`1339`	`continue;`
`1339`	`1340`	`}`
`1340`	`1341`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,8 @@ public void processStream(InputStream input) throws IOException {`
`173`	`173`	`String name = env.getPathRelativeToSourceRoot(f);`
`174`	`174`	`entry.addFile(name.intern());`
`175`	`175`	`} catch (ForbiddenSymlinkException e) {`
`176`		`- // ignored (and already logged by PathUtils)`
	`176`	`+ LOGGER.log(Level.FINER, e.getMessage());`
	`177`	`+ // ignored`
`177`	`178`	`}`
`178`	`179`	`}`
`179`	`180`	`break;`
Original file line number	Diff line number	Diff line change
`@@ -169,8 +169,10 @@ public void processStream(InputStream input) throws IOException {`
`169`	`169`	`String path = env.getPathRelativeToSourceRoot(`
`170`	`170`	`file);`
`171`	`171`	`entry.addFile(path.intern());`
`172`		`- } catch (FileNotFoundException\|`
`173`		`- ForbiddenSymlinkException e) { // NOPMD`
	`172`	`+ } catch (ForbiddenSymlinkException e) {`
	`173`	`+ LOGGER.log(Level.FINER, e.getMessage());`
	`174`	`+ // ignore`
	`175`	`+ } catch (FileNotFoundException e) { // NOPMD`
`174`	`176`	`// If the file is not located under the source root, ignore it`
`175`	`177`	`}`
`176`	`178`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1330,7 +1330,7 @@ public static Definitions getDefinitions(File file)`
`1330`	`1330`	`try {`
`1331`	`1331`	`path = env.getPathRelativeToSourceRoot(file);`
`1332`	`1332`	`} catch (ForbiddenSymlinkException e) {`
`1333`		`- // (already logged by PathUtils)`
	`1333`	`+ LOGGER.log(Level.FINER, e.getMessage());`
`1334`	`1334`	`return null;`
`1335`	`1335`	`}`
`1336`	`1336`	`//sanitize windows path delimiters`
-Original file line number
+Diff line change
  * CDDL HEADER END
  */
 - /*
 +/*
  * Copyright (c) 2017, Chris Fraire <[email protected]>.
  */