various repository methods should use interactive timeout (#2108)

fixes #2094

Author: Vladimir Kotal

src/org/opensolaris/opengrok/configuration/Configuration.java

@@ -204,6 +204,7 @@ public final class Configuration {
     private final Map<String, String> cmds;  // repository type -> command
     private int tabSize;
     private int commandTimeout; // in seconds
+    private int interactiveCommandTimeout; // in seconds
     private boolean scopesEnabled;
     private boolean projectsEnabled;
     private boolean foldingEnabled;
@@ -348,6 +349,24 @@ public void setCommandTimeout(int commandTimeout) throws IllegalArgumentExceptio
         this.commandTimeout = commandTimeout;
     }
 
+    public int getInteractiveCommandTimeout() {
+        return interactiveCommandTimeout;
+    }
+
+    /**
+     * Set the interactive command timeout to a new value.
+     *
+     * @param commandTimeout the new value
+     * @throws IllegalArgumentException when the timeout is negative
+     */
+    public void setInteractiveCommandTimeout(int commandTimeout) throws IllegalArgumentException {
+        if (commandTimeout < 0) {
+            throw new IllegalArgumentException(
+                    String.format(NEGATIVE_NUMBER_ERROR, "interactiveCommandTimeout", commandTimeout));
+        }
+        this.interactiveCommandTimeout = commandTimeout;
+    }
+    
     public String getStatisticsFilePath() {
         return statisticsFilePath;
     }
@@ -397,6 +416,7 @@ public Configuration() {
         setBugPattern("\\b([12456789][0-9]{6})\\b");
         setCachePages(5);
         setCommandTimeout(600); // 10 minutes
+        setInteractiveCommandTimeout(30);
         setCompressXref(true);
         setContextLimit((short)10);
         //contextSurround is default(short)

src/org/opensolaris/opengrok/configuration/RuntimeEnvironment.java

@@ -311,6 +311,14 @@ public void setCommandTimeout(int timeout) {
         threadConfig.get().setCommandTimeout(timeout);
     }
 
+    public int getInteractiveCommandTimeout() {
+        return threadConfig.get().getInteractiveCommandTimeout();
+    }
+
+    public void setInteractiveCommandTimeout(int timeout) {
+        threadConfig.get().setInteractiveCommandTimeout(timeout);
+    }
+    
     public Statistics getStatistics() {
         return statistics;
     }
@@ -1372,6 +1380,16 @@ public void readConfiguration(File file) throws IOException {
         setConfiguration(Configuration.read(file));
     }
 
+    /**
+     * Read configuration from a file and put it into effect.
+     * @param file the file to read
+     * @param interactive true if run in interactive mode
+     * @throws IOException 
+     */
+    public void readConfiguration(File file, boolean interactive) throws IOException {
+        setConfiguration(Configuration.read(file), null, interactive);
+    }
+    
     /**
      * Write the current configuration to a file
      *
@@ -1493,10 +1511,10 @@ public void populateGroups(Set<Group> groups, Set<Project> projects) {
      * @param configuration what configuration to use
      */
     public void setConfiguration(Configuration configuration) {
-        setConfiguration(configuration, null);
+        setConfiguration(configuration, null, false);
     }
 
-    public void setConfiguration(Configuration configuration, List<String> subFileList) {
+    public void setConfiguration(Configuration configuration, List<String> subFileList, boolean interactive) {
         this.configuration = configuration;
         // HistoryGuru constructor uses environment properties so register()
         // needs to be called first.
@@ -1516,10 +1534,10 @@ public void setConfiguration(Configuration configuration, List<String> subFileLi
         // Set the working repositories in HistoryGuru.
         if (subFileList != null) {
             histGuru.invalidateRepositories(
-                configuration.getRepositories(), subFileList);
+                configuration.getRepositories(), subFileList, interactive);
         } else {
-            histGuru.invalidateRepositories(
-                configuration.getRepositories());
+            histGuru.invalidateRepositories(configuration.getRepositories(),
+                    interactive);
         }
         // The invalidation of repositories above might have excluded some
         // repositories in HistoryGuru so the configuration needs to reflect that.

src/org/opensolaris/opengrok/configuration/messages/ProjectMessage.java

@@ -226,7 +226,7 @@ protected byte[] applyMessage(RuntimeEnvironment env) throws Exception {
                         List<RepositoryInfo> riList = env.getProjectRepositoriesMap().get(project);
                         if (riList != null) {
                             for (RepositoryInfo ri : riList) {
-                                Repository repo = getRepository(ri);
+                                Repository repo = getRepository(ri, false);
 
                                 if (repo != null && repo.getCurrentVersion() != null &&
                                     repo.getCurrentVersion().length() > 0) {

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

@@ -0,0 +1,99 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").
+ * You may not use this file except in compliance with the License.
+ *
+ * See LICENSE.txt included in this distribution for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at LICENSE.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+
+/*
+ * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
+ */
+package org.opensolaris.opengrok.history;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import org.opensolaris.opengrok.logger.LoggerFactory;
+import org.opensolaris.opengrok.util.Executor;
+
+/**
+ * handles parsing the output of the {@code accurev annotate} command
+ * into an annotation object.
+ */
+public class AccuRevAnnotationParser implements Executor.StreamHandler {
+    
+    private static final Logger LOGGER = LoggerFactory.getLogger(AccuRevAnnotationParser.class);
+    
+    private static final Pattern ANNOTATION_PATTERN
+            = Pattern.compile("^\\s+(\\d+.\\d+)\\s+(\\w+)");   // version, user
+    
+    /**
+     * Store annotation created by processStream.
+     */
+    private final Annotation annotation;
+
+    /**
+     * @param fileName the name of the file being annotated
+     */
+    public AccuRevAnnotationParser(String fileName) {
+        annotation = new Annotation(fileName);
+    }
+    
+    /**
+     * Returns the annotation that has been created.
+     *
+     * @return annotation an annotation object
+     */
+    public Annotation getAnnotation() {
+        return annotation;
+    }
+    
+    @Override
+    public void processStream(InputStream input) throws IOException {
+        try (BufferedReader reader
+                = new BufferedReader(new InputStreamReader(input))) {
+            String line;
+            int lineno = 0;
+            try {
+                while ((line = reader.readLine()) != null) {
+                    ++lineno;
+                    Matcher matcher = ANNOTATION_PATTERN.matcher(line);
+
+                    if (matcher.find()) {
+                        // On Windows machines version shows up as
+                        // <number>\<number>. To get search annotation
+                        // to work properly, need to flip '\' to '/'.
+                        // This is a noop on Unix boxes.
+                        String version = matcher.group(1).replace('\\', '/');
+                        String author  = matcher.group(2);
+                        annotation.addLine(version, author, true);
+                    } else {
+                        LOGGER.log(Level.SEVERE,
+                                "Did not find annotation in line {0}: [{1}]",
+                                new Object[]{lineno, line});
+                    }
+                }
+            } catch (IOException e) {
+                LOGGER.log(Level.SEVERE,
+                        "Could not read annotations for " + annotation.getFilename(), e);
+            }
+        }
+    }
+}

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

@@ -79,14 +79,14 @@ public class AccuRevRepository extends Repository {
      * The command to use to access the repository if none was given explicitly
      */
     public static final String CMD_FALLBACK = "accurev";
-    private static final Pattern annotationPattern
-            = Pattern.compile("^\\s+(\\d+.\\d+)\\s+(\\w+)");   // version, user
-    private static final Pattern depotPattern
+    
+    private static final Pattern DEPOT_PATTERN
             = Pattern.compile("^Depot:\\s+(\\w+)");
-    private static final Pattern parentPattern
+    private static final Pattern PARENT_PATTERN
             = Pattern.compile("^Basis:\\s+(\\w+)");
-    private static final Pattern workspaceRootPattern
+    private static final Pattern WORKSPACE_ROOT_PATTERN
             = Pattern.compile("Top:\\s+(.+)$");
+    
     private static final RuntimeEnvironment env = RuntimeEnvironment.getInstance();
 
     private String depotName = null;
@@ -111,8 +111,6 @@ public AccuRevRepository() {
     @Override
     public Annotation annotate(File file, String rev) throws IOException {
 
-        Annotation a = new Annotation(file.getName());
-
         ArrayList<String> cmd = new ArrayList<>();
 
         // Do not use absolute paths because symbolic links will cause havoc.
@@ -129,38 +127,12 @@ public Annotation annotate(File file, String rev) throws IOException {
 
         cmd.add(path);
 
-        Executor executor = new Executor(cmd, file.getParentFile());
-        executor.exec();
-        try (BufferedReader reader
-                = new BufferedReader(executor.getOutputReader())) {
-            String line;
-            int lineno = 0;
-            try {
-                while ((line = reader.readLine()) != null) {
-                    ++lineno;
-                    Matcher matcher = annotationPattern.matcher(line);
-
-                    if (matcher.find()) {
-                        // On Windows machines version shows up as
-                        // <number>\<number>. To get search annotation
-                        // to work properly, need to flip '\' to '/'.
-                        // This is a noop on Unix boxes.
-                        String version = matcher.group(1).replace('\\', '/');
-                        String author  = matcher.group(2);
-                        a.addLine(version, author, true);
-                    } else {
-                        LOGGER.log(Level.SEVERE,
-                                "Did not find annotation in line {0}: [{1}]",
-                                new Object[]{lineno, line});
-                    }
-                }
-            } catch (IOException e) {
-                LOGGER.log(Level.SEVERE,
-                        "Could not read annotations for " + file, e);
-            }
-        }
-
-        return a;
+        Executor executor = new Executor(cmd, file.getParentFile(),
+                RuntimeEnvironment.getInstance().getInteractiveCommandTimeout());
+        AccuRevAnnotationParser parser = new AccuRevAnnotationParser(file.getName());
+        executor.exec(true, parser);
+        
+        return parser.getAnnotation();
     }
 
     /**
@@ -299,7 +271,7 @@ public boolean fileHasAnnotation(File file) {
      *   below 'Server time' will be missing when current working directory
      *   is not within a known AccuRev workspace/repository.
      */
-    private boolean getAccuRevInfo( File wsPath ) {
+    private boolean getAccuRevInfo(File wsPath, boolean interactive) {
 
         ArrayList<String> cmd = new ArrayList<>();
         boolean status  = false;
@@ -320,7 +292,8 @@ private boolean getAccuRevInfo( File wsPath ) {
         cmd.add(RepoCommand);
         cmd.add("info");
 
-        Executor executor = new Executor(cmd, realWsPath.toFile());
+        Executor executor = new Executor(cmd, realWsPath.toFile(), interactive ?
+                env.getInteractiveCommandTimeout() : env.getCommandTimeout());
         executor.exec();
 
         try (BufferedReader info = new BufferedReader(executor.getOutputReader())) {
@@ -334,22 +307,22 @@ private boolean getAccuRevInfo( File wsPath ) {
                 }
 
                 if (line.startsWith("Depot")) {
-                    Matcher depotMatch  = depotPattern.matcher(line);
+                    Matcher depotMatch  = DEPOT_PATTERN.matcher(line);
                     if (depotMatch.find()) {
                         depotName = depotMatch.group(1);
                         status = true;
                     }
                 }
 
                 else if (line.startsWith("Basis")) {
-                    Matcher parentMatch = parentPattern.matcher(line);
+                    Matcher parentMatch = PARENT_PATTERN.matcher(line);
                     if (parentMatch.find()) {
                         parent = parentMatch.group(1);
                     }
                 }
 
                 else if (line.startsWith("Top")) {
-                    Matcher workspaceRoot = workspaceRootPattern.matcher(line);
+                    Matcher workspaceRoot = WORKSPACE_ROOT_PATTERN.matcher(line);
                     if (workspaceRoot.find()) {
                         wsRoot = workspaceRoot.group(1);
                         // Normally, the source root path and the workspace root
@@ -417,13 +390,13 @@ else if (line.startsWith("Top")) {
      * @param wsPath The presumed path to an AccuRev workspace directory.
      * @return true if the given path is in the depot, false otherwise
      */
-    private boolean isInAccuRevDepot(File wsPath) {
+    private boolean isInAccuRevDepot(File wsPath, boolean interactive) {
 
         // Once depot name is determined, always assume inside depot.
         boolean status = (depotName != null);
 
         if (! status && isWorking()) {
-            status = getAccuRevInfo( wsPath );
+            status = getAccuRevInfo(wsPath, interactive);
         }
 
         return status;
@@ -474,10 +447,10 @@ public String getDepotRelativePath(File file) {
     }
 
     @Override
-    boolean isRepositoryFor(File sourceHome) {
+    boolean isRepositoryFor(File sourceHome, boolean interactive) {
 
         if (sourceHome.isDirectory()) {
-            return isInAccuRevDepot(sourceHome);
+            return isInAccuRevDepot(sourceHome, interactive);
         }
 
         return false;
@@ -505,13 +478,18 @@ History getHistory(File file) throws HistoryException {
     }
 
     @Override
-    String determineParent() throws IOException {
-        getAccuRevInfo(new File(getDirectoryName()));
+    String determineParent(boolean interactive) throws IOException {
+        getAccuRevInfo(new File(getDirectoryName()), interactive);
         return parent;
     }
 
     @Override
-    String determineBranch() {
+    String determineBranch(boolean interactive) {
+        return null;
+    }
+
+    @Override
+    String determineCurrentVersion(boolean interactive) throws IOException {
         return null;
     }
 }

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

@@ -49,9 +49,9 @@ public class Annotation {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(Annotation.class);
 
-    private final List<Line> lines = new ArrayList<Line>();
-    private final Map<String, String> desc = new HashMap<String, String>();
-    private final Map<String, Integer> fileVersions = new HashMap<String, Integer>(); //maps revision to file version
+    private final List<Line> lines = new ArrayList<>();
+    private final Map<String, String> desc = new HashMap<>();
+    private final Map<String, Integer> fileVersions = new HashMap<>(); // maps revision to file version
     private int widestRevision;
     private int widestAuthor;
     private final String filename;