Add --disableRepository handling

idodeclare · Vladimir Kotal · commit 29816c3b8c3d · 2019-12-06T17:05:56.000+01:00
diff --git a/opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/Configuration.java b/opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/Configuration.java
@@ -68,8 +68,10 @@
  * nature of the web application, each thread will use the same instance of the
  * configuration object for each page request. Class and methods should have
  * package scope, but that didn't work with the XMLDecoder/XMLEncoder.
- *
- * This should be as close to POJO (https://en.wikipedia.org/wiki/Plain_old_Java_object) as possible.
+ * <p>
+ * This should be as close to a
+ * <a href="https://en.wikipedia.org/wiki/Plain_old_Java_object">POJO</a> as
+ * possible.
  */
 public final class Configuration {
 
@@ -187,6 +189,7 @@ public final class Configuration {
     private String webappLAF;
     private RemoteSCM remoteScmSupported;
     private boolean optimizeDatabase;
+    private boolean quickContextScan;
 
     private LuceneLockName luceneLocking = LuceneLockName.OFF;
     private boolean compressXref;
@@ -296,6 +299,8 @@ public final class Configuration {
 
     private SuggesterConfig suggesterConfig = new SuggesterConfig();
 
+    private Set<String> disabledRepositories;
+
     /*
      * types of handling history for remote SCM repositories:
      *  ON - index history and display it in webapp
@@ -485,6 +490,7 @@ public Configuration() {
         setPluginDirectory(null);
         setPluginStack(new AuthorizationStack(AuthControlFlag.REQUIRED, "default stack"));
         setPrintProgress(false);
+        setDisabledRepositories(new HashSet<>());
         setProjects(new ConcurrentHashMap<>());
         setQuickContextScan(true);
         //below can cause an outofmemory error, since it is defaulting to NO LIMIT
@@ -910,8 +916,6 @@ public boolean isAllowLeadingWildcard() {
         return allowLeadingWildcard;
     }
 
-    private boolean quickContextScan;
-
     public boolean isQuickContextScan() {
         return quickContextScan;
     }
@@ -1259,6 +1263,14 @@ public void setSuggesterConfig(final SuggesterConfig config) {
         this.suggesterConfig = config;
     }
 
+    public Set<String> getDisabledRepositories() {
+        return disabledRepositories;
+    }
+
+    public void setDisabledRepositories(Set<String> disabledRepositories) {
+        this.disabledRepositories = disabledRepositories;
+    }
+
     /**
      * Write the current configuration to a file.
      *
diff --git a/opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/RuntimeEnvironment.java b/opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/RuntimeEnvironment.java
@@ -1017,6 +1017,16 @@ public String setRepoCmd(String clazzName, String cmd) {
         return cmd;
     }
 
+    public void setRepoCmds(Map<String, String> cmds) {
+        Lock writeLock = configLock.writeLock();
+        writeLock.lock();
+        try {
+            configuration.setCmds(cmds);
+        } finally {
+            writeLock.unlock();
+        }
+    }
+
     /**
      * Sets the user page for the history listing.
      *
@@ -1417,6 +1427,15 @@ public short getContextSurround() {
         return (short) getConfigurationValue("contextSurround");
     }
 
+    @SuppressWarnings("unchecked")
+    public Set<String> getDisabledRepositories() {
+        return (Set<String>) getConfigurationValue("disabledRepositories");
+    }
+
+    public void setDisabledRepositories(Set<String> disabledRepositories) {
+        setConfigurationValue("disabledRepositories", disabledRepositories);
+    }
+
     /**
      * Read an configuration file and set it as the current configuration.
      *
diff --git a/opengrok-indexer/src/main/java/org/opengrok/indexer/history/RepositoryFactory.java b/opengrok-indexer/src/main/java/org/opengrok/indexer/history/RepositoryFactory.java
@@ -27,11 +27,17 @@
 import java.io.IOException;
 import java.lang.reflect.InvocationTargetException;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import org.opengrok.indexer.configuration.Configuration;
 import org.opengrok.indexer.configuration.RuntimeEnvironment;
+import org.opengrok.indexer.index.IgnoredNames;
 import org.opengrok.indexer.logger.LoggerFactory;
 import org.opengrok.indexer.util.ForbiddenSymlinkException;
 
@@ -62,20 +68,43 @@ public final class RepositoryFactory {
         new SSCMRepository()
     };
 
+    private static final Map<String, Class<? extends Repository>> byName = new HashMap<>();
+
+    static {
+        final String REPOSITORY = "Repository";
+        for (Repository repository : repositories) {
+            Class<? extends Repository> clazz = repository.getClass();
+            String repoName = clazz.getSimpleName();
+            byName.put(repoName, clazz);
+            byName.put(repoName.toLowerCase(Locale.ROOT), clazz);
+            if (repoName.endsWith(REPOSITORY)) {
+                String shortName = repoName.substring(0, repoName.length() - REPOSITORY.length());
+                if (shortName.length() > 0) {
+                    byName.put(shortName, clazz);
+                    byName.put(shortName.toLowerCase(Locale.ROOT), clazz);
+                }
+            }
+        }
+    }
+
+    /** Private to enforce static. */
     private RepositoryFactory() {
-        // Factory class, should not be constructed
     }
 
     /**
      * Get a list of all available repository handlers.
      *
-     * @return a list which contains none-{@code null} values, only.
+     * @return a list that contains non-{@code null} values only
      */
     public static List<Class<? extends Repository>> getRepositoryClasses() {
-        ArrayList<Class<? extends Repository>> list
-                = new ArrayList<>(repositories.length);
+        RuntimeEnvironment env = RuntimeEnvironment.getInstance();
+
+        ArrayList<Class<? extends Repository>> list = new ArrayList<>(repositories.length);
         for (int i = repositories.length - 1; i >= 0; i--) {
-            list.add(repositories[i].getClass());
+            Class<? extends Repository> clazz = repositories[i].getClass();
+            if (isEnabled(clazz, env)) {
+                list.add(clazz);
+            }
         }
         
         return list;
@@ -128,15 +157,18 @@ public static Repository getRepository(File file, boolean interactive, boolean i
         String relFile = env.getPathRelativeToSourceRoot(file);
 
         Repository repo = null;
-        for (Repository rep : repositories) {
-            if ((!isNested || rep.isNestable()) && rep.isRepositoryFor(file, interactive)) {
-                repo = rep.getClass().getDeclaredConstructor().newInstance();
+        for (Repository referenceRepo : repositories) {
+            Class<? extends Repository> clazz = referenceRepo.getClass();
+
+            if ((!isNested || referenceRepo.isNestable()) && isEnabled(clazz, env) &&
+                    referenceRepo.isRepositoryFor(file, interactive)) {
+                repo = clazz.getDeclaredConstructor().newInstance();
 
                 if (env.isProjectsEnabled() && relFile.equals(File.separator)) {
                     LOGGER.log(Level.WARNING, "{0} was detected as {1} repository however with directory " +
                             "matching source root. This is invalid because projects are enabled. Ignoring this " +
                             "repository.",
-                            new Object[]{file, rep.getType()});
+                            new Object[]{file, repo.getType()});
                     return null;
                 }
                 repo.setDirectoryName(file);
@@ -220,22 +252,46 @@ public static Repository getRepository(RepositoryInfo info, boolean interactive)
     }
 
     /**
-     * Go through all repository types and add items to lists of ignored
-     * files/directories. This way per-repository ignored entries are set
-     * inside repository classes rather than globally in IgnoredFiles/Dirs.
-     * Should be called after {@code setConfiguration()}.
-     * 
-     * @param env runtime environment
+     * Go through all supported repository types, and add their ignored items to
+     * the environment's lists of ignored files/directories -- but skip any
+     * repository types which are named in
+     * {@link RuntimeEnvironment#getDisabledRepositories()} ()}. This way
+     * per-repository ignored entries are set inside repository classes rather
+     * than globally in IgnoredFiles/Dirs.
+     * <p>
+     * (Should be called after
+     * {@link RuntimeEnvironment#setConfiguration(Configuration)}.)
      */
     public static void initializeIgnoredNames(RuntimeEnvironment env) {
+        IgnoredNames ignoredNames = env.getIgnoredNames();
         for (Repository repo : repositories) {
-            for (String file : repo.getIgnoredFiles()) {
-                env.getIgnoredNames().add("f:" + file);
+            if (isEnabled(repo.getClass(), env)) {
+                for (String file : repo.getIgnoredFiles()) {
+                    ignoredNames.add("f:" + file);
+                }
+                for (String dir : repo.getIgnoredDirs()) {
+                    ignoredNames.add("d:" + dir);
+                }
             }
+        }
+    }
 
-            for (String dir : repo.getIgnoredDirs()) {
-                env.getIgnoredNames().add("d:" + dir);
-            }
+    /**
+     * Tries to match a supported repositories by name or nickname -- e.g.
+     * {@code "CVSRepository"} or {@code "CVS"} or {@code "cvs"}.
+     * @return a defined, class simple name (e.g. {@code "CVSRepository"} when
+     * {@code "cvs"} is passed); or {@code null} if no match found
+     */
+    public static String matchRepositoryByName(String name) {
+        Class<? extends Repository> clazz = byName.get(name);
+        if (clazz != null) {
+            return clazz.getSimpleName();
         }
+        return null;
+    }
+
+    private static boolean isEnabled(Class<? extends Repository> clazz, RuntimeEnvironment env) {
+        Set<String> disabledRepos = env.getDisabledRepositories();
+        return disabledRepos == null || !disabledRepos.contains(clazz.getSimpleName());
     }
 }
diff --git a/opengrok-indexer/src/main/java/org/opengrok/indexer/index/Indexer.java b/opengrok-indexer/src/main/java/org/opengrok/indexer/index/Indexer.java
@@ -121,6 +121,7 @@ public final class Indexer {
     private static final HashSet<String> allowedSymlinks = new HashSet<>();
     private static final HashSet<String> canonicalRoots = new HashSet<>();
     private static final Set<String> defaultProjects = new TreeSet<>();
+    private static final HashSet<String> disabledRepositories = new HashSet<>();
     private static RuntimeEnvironment env = null;
     private static String webappURI = null;
 
@@ -168,6 +169,9 @@ public static void main(String[] argv) {
                 pauseToAwaitProfiler();
             }
 
+            disabledRepositories.addAll(cfg.getDisabledRepositories());
+            cfg.setDisabledRepositories(disabledRepositories);
+
             env = RuntimeEnvironment.getInstance();
 
             // Complete the configuration of repository types.
@@ -416,8 +420,8 @@ public static WebAddress parseWebAddress(String webAddr) {
      * @throws ParseException if parsing failed
      */
     public static String[] parseOptions(String[] argv) throws ParseException {
-        String[] usage = {HELP_OPT_1};
-        String program = "opengrok.jar";
+        final String[] usage = {HELP_OPT_1};
+        final String program = "opengrok.jar";
         final String[] ON_OFF = {ON, OFF};
         final String[] REMOTE_REPO_CHOICES = {ON, OFF, DIRBASED, UIONLY};
         final String[] LUCENE_LOCKS = {ON, OFF, "simple", "native"};
@@ -465,10 +469,10 @@ public static String[] parseOptions(String[] argv) throws ParseException {
 
             parser.on(
                 "-A (.ext|prefix.):(-|analyzer)", "--analyzer", "/(\\.\\w+|\\w+\\.):(-|[a-zA-Z_0-9.]+)/",
-                    "Files with the named prefix/extension should be analyzed",
-                    "with the given analyzer, where 'analyzer' may be specified",
-                    "using a simple class name (RubyAnalyzer) or language name (C)",
-                    "(Note, analyzer specification is case-sensitive)",
+                    "Files with the named prefix/extension should be analyzed with the given",
+                    "analyzer, where 'analyzer' may be specified using a simple class name",
+                    "(e.g. RubyAnalyzer) or language name (e.g. C) and is case-sensitive.",
+                    "Option may be repeated.",
                     "  Ex: -A .foo:CAnalyzer",
                     "      will use the C analyzer for all files ending with .FOO",
                     "  Ex: -A bar.:Perl",
@@ -532,6 +536,22 @@ public static String[] parseOptions(String[] argv) throws ParseException {
                 cfg.setScanningDepth((Integer) depth);
             });
 
+            parser.on("--disableRepository", "=type_name",
+                    "Disables operation of an OpenGrok-supported repository. Option may be",
+                    "repeated.",
+                    "  Ex: --disableRepository git",
+                    "      will disable the GitRepository",
+                    "  Ex: --disableRepository MercurialRepository").Do(v -> {
+                String repoType = (String) v;
+                String repoSimpleType = RepositoryFactory.matchRepositoryByName(repoType);
+                if (repoSimpleType == null) {
+                    System.err.println(String.format(
+                            "'--disableRepository %s' does not match a type and is ignored", v));
+                } else {
+                    disabledRepositories.add(repoSimpleType);
+                }
+            });
+
             parser.on("-e", "--economical",
                     "To consume less disk space, OpenGrok will not generate and save",
                     "hypertext cross-reference files but will generate on demand, which could",
diff --git a/opengrok-indexer/src/test/java/org/opengrok/indexer/history/RepositoryFactoryTest.java b/opengrok-indexer/src/test/java/org/opengrok/indexer/history/RepositoryFactoryTest.java
