Throw and handle ForbiddenSymlinkException from a few more public APIs

This quiets the noisy exceptions for repos that
heavily use symlinks -- e.g., Homebrew/brew.

Author: idodeclare

src/org/opensolaris/opengrok/analysis/AnalyzerGuru.java

@@ -106,6 +106,7 @@
 import org.opensolaris.opengrok.history.HistoryReader;
 import org.opensolaris.opengrok.logger.LoggerFactory;
 import org.opensolaris.opengrok.search.QueryBuilder;
+import org.opensolaris.opengrok.util.ForbiddenSymlinkException;
 import org.opensolaris.opengrok.util.IOUtils;
 import org.opensolaris.opengrok.web.Util;
 
@@ -394,10 +395,12 @@ public static FileAnalyzer getAnalyzer(InputStream in, String file) throws IOExc
      * @param xrefOut Where to write the xref (possibly {@code null})
      * @throws IOException If an exception occurs while collecting the data
      * @throws InterruptedException if a timeout occurs
+     * @throws ForbiddenSymlinkException if symbolic-link checking encounters
+     * an ineligible link
      */
     public void populateDocument(Document doc, File file, String path,
         FileAnalyzer fa, Writer xrefOut) throws IOException,
-            InterruptedException {
+            InterruptedException, ForbiddenSymlinkException {
 
         String date = DateTools.timeToString(file.lastModified(),
                 DateTools.Resolution.MILLISECOND);

src/org/opensolaris/opengrok/history/FileHistoryCache.java

@@ -191,7 +191,8 @@ public boolean supportsRepository(Repository repository) {
      * @param file the file to find the cache for
      * @return file that might contain cached history for <code>file</code>
      */
-    private static File getCachedFile(File file) throws HistoryException {
+    private static File getCachedFile(File file) throws HistoryException,
+            ForbiddenSymlinkException {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
 
         StringBuilder sb = new StringBuilder();
@@ -210,7 +211,7 @@ private static File getCachedFile(File file) throws HistoryException {
                 sb.append(DIRECTORY_FILE_PREFIX);
             }
             sb.append(".gz");
-        } catch (IOException|ForbiddenSymlinkException e) {
+        } catch (IOException e) {
             throw new HistoryException("Failed to get path relative to " +
                     "source root for " + file, e);
         }
@@ -343,7 +344,13 @@ private History mergeOldAndNewHistory(File cacheFile, History histNew, Repositor
     private void storeFile(History histNew, File file, Repository repo,
             boolean mergeHistory) throws HistoryException {
 
-        File cacheFile = getCachedFile(file);
+        File cacheFile;
+        try {
+            cacheFile = getCachedFile(file);
+        } catch (ForbiddenSymlinkException e) {
+            LOGGER.log(Level.FINER, e.getMessage());
+            return;
+        }
         History history = histNew;
 
         File dir = cacheFile.getParentFile();
@@ -504,7 +511,13 @@ public void store(History history, Repository repository)
         // mkdirs() if there are multiple renamed files from single directory
         // handled in parallel.
         for (final String file : renamed_map.keySet()) {
-            File cache = getCachedFile(new File(env.getSourceRootPath() + file));
+            File cache;
+            try {
+                cache = getCachedFile(new File(env.getSourceRootPath() + file));
+            } catch (ForbiddenSymlinkException ex) {
+                LOGGER.log(Level.FINER, ex.getMessage());
+                continue;
+            }
             File dir = cache.getParentFile();
 
             if (!dir.isDirectory() && !dir.mkdirs()) {
@@ -546,7 +559,7 @@ public void run() {
 
     @Override
     public History get(File file, Repository repository, boolean withFiles)
-            throws HistoryException {
+            throws HistoryException, ForbiddenSymlinkException {
         File cache = getCachedFile(file);
         if (isUpToDate(file, cache)) {
             try {
@@ -640,7 +653,12 @@ public boolean hasCacheForDirectory(File directory, Repository repository)
 
     @Override
     public boolean hasCacheForFile(File file) throws HistoryException {
-        return getCachedFile(file).exists();
+        try {
+            return getCachedFile(file).exists();
+        } catch (ForbiddenSymlinkException ex) {
+            LOGGER.log(Level.FINER, ex.getMessage());
+            return false;
+        }
     }
 
     public String getRepositoryHistDataDirname(Repository repository) {
@@ -767,6 +785,9 @@ public void clearFile(String path) {
         File historyFile;
         try {
             historyFile = getCachedFile(new File(env.getSourceRootPath() + path));
+        } catch (ForbiddenSymlinkException ex) {
+            LOGGER.log(Level.FINER, ex.getMessage());
+            return;
         } catch (HistoryException ex) {
             LOGGER.log(Level.WARNING, "cannot get history file for file " + path, ex);
             return;

src/org/opensolaris/opengrok/history/HistoryCache.java

@@ -25,6 +25,7 @@
 import java.io.File;
 import java.util.Date;
 import java.util.Map;
+import org.opensolaris.opengrok.util.ForbiddenSymlinkException;
 
 interface HistoryCache {
     /**
@@ -58,9 +59,11 @@ interface HistoryCache {
      * the implementation is allowed to skip the file list, but it doesn't
      * have to.
      * @throws HistoryException if the history cannot be fetched
+     * @throws ForbiddenSymlinkException if symbolic-link checking encounters
+     * an ineligible link
      */
     History get(File file, Repository repository, boolean withFiles)
-            throws HistoryException;
+            throws HistoryException, ForbiddenSymlinkException;
 
     /**
      * Store the history for a repository.

src/org/opensolaris/opengrok/history/HistoryGuru.java

@@ -50,6 +50,7 @@
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
 import org.opensolaris.opengrok.index.IgnoredNames;
 import org.opensolaris.opengrok.logger.LoggerFactory;
+import org.opensolaris.opengrok.util.ForbiddenSymlinkException;
 import org.opensolaris.opengrok.util.PathUtils;
 import org.opensolaris.opengrok.util.Statistics;
 
@@ -244,7 +245,6 @@ public History getHistory(File file, boolean withFiles, boolean ui)
         final File dir = file.isDirectory() ? file : file.getParentFile();
         final Repository repo = getRepository(dir);
 
-        History history = null;
         RemoteSCM rscm = RuntimeEnvironment.getInstance().getRemoteScmSupported();
         boolean doRemote = (ui && (rscm == RemoteSCM.UIONLY))
                 || (rscm == RemoteSCM.ON)
@@ -254,13 +254,17 @@ public History getHistory(File file, boolean withFiles, boolean ui)
                 && (!repo.isRemote() || doRemote)) {
 
             if (useCache() && historyCache.supportsRepository(repo)) {
-                history = historyCache.get(file, repo, withFiles);
-            } else {
-                history = repo.getHistory(file);
+                try {
+                    return historyCache.get(file, repo, withFiles);
+                } catch (ForbiddenSymlinkException ex) {
+                    LOGGER.log(Level.FINER, ex.getMessage());
+                    return null;
+                }
             }
+            return repo.getHistory(file);
         }
 
-        return history;
+        return null;
     }
 
     /**

src/org/opensolaris/opengrok/index/IndexDatabase.java

@@ -696,6 +696,10 @@ private void addFile(File file, String path, Ctags ctags)
                 new Object[]{path, e.getMessage()});
             cleanupResources(doc);
             throw e;
+        } catch (ForbiddenSymlinkException e) {
+            LOGGER.log(Level.FINER, e.getMessage());
+            cleanupResources(doc);
+            return;
         } catch (Exception e) {
             LOGGER.log(Level.INFO,
                     "Skipped file ''{0}'' because the analyzer didn''t "