per project renamed file handling (#2134)

Author: Vladimir Kotal

opengrok-web-nbproject/nbproject/project.properties

@@ -36,7 +36,7 @@ bcel.version=6.2
 bcel.jar=bcel-${bcel.version}.jar
 file.reference.bcel.jar=../lib/${bcel.jar}
 file.reference.json-simple-1.1.1.jar=../lib/json-simple-1.1.1.jar
-j2ee.platform.classpath=${j2ee.server.home}/lib/annotations-api.jar:${j2ee.server.home}/lib/catalina-ant.jar:${j2ee.server.home}/lib/catalina-ha.jar:${j2ee.server.home}/lib/catalina-storeconfig.jar:${j2ee.server.home}/lib/catalina-tribes.jar:${j2ee.server.home}/lib/catalina.jar:${j2ee.server.home}/lib/ecj-4.6.3.jar:${j2ee.server.home}/lib/el-api.jar:${j2ee.server.home}/lib/jasper-el.jar:${j2ee.server.home}/lib/jasper.jar:${j2ee.server.home}/lib/jaspic-api.jar:${j2ee.server.home}/lib/jsp-api.jar:${j2ee.server.home}/lib/servlet-api.jar:${j2ee.server.home}/lib/tomcat-api.jar:${j2ee.server.home}/lib/tomcat-coyote.jar:${j2ee.server.home}/lib/tomcat-dbcp.jar:${j2ee.server.home}/lib/tomcat-i18n-es.jar:${j2ee.server.home}/lib/tomcat-i18n-fr.jar:${j2ee.server.home}/lib/tomcat-i18n-ja.jar:${j2ee.server.home}/lib/tomcat-jdbc.jar:${j2ee.server.home}/lib/tomcat-jni.jar:${j2ee.server.home}/lib/tomcat-util-scan.jar:${j2ee.server.home}/lib/tomcat-util.jar:${j2ee.server.home}/lib/tomcat-websocket.jar:${j2ee.server.home}/lib/websocket-api.jar
+j2ee.platform.classpath=${j2ee.server.home}/lib/annotations-api.jar:${j2ee.server.home}/lib/catalina-ant.jar:${j2ee.server.home}/lib/catalina-ha.jar:${j2ee.server.home}/lib/catalina-storeconfig.jar:${j2ee.server.home}/lib/catalina-tribes.jar:${j2ee.server.home}/lib/catalina.jar:${j2ee.server.home}/lib/ecj-4.4.2.jar:${j2ee.server.home}/lib/el-api.jar:${j2ee.server.home}/lib/jasper-el.jar:${j2ee.server.home}/lib/jasper.jar:${j2ee.server.home}/lib/jsp-api.jar:${j2ee.server.home}/lib/servlet-api.jar:${j2ee.server.home}/lib/tomcat-api.jar:${j2ee.server.home}/lib/tomcat-coyote.jar:${j2ee.server.home}/lib/tomcat-dbcp.jar:${j2ee.server.home}/lib/tomcat-i18n-es.jar:${j2ee.server.home}/lib/tomcat-i18n-fr.jar:${j2ee.server.home}/lib/tomcat-i18n-ja.jar:${j2ee.server.home}/lib/tomcat-jdbc.jar:${j2ee.server.home}/lib/tomcat-jni.jar:${j2ee.server.home}/lib/tomcat-util-scan.jar:${j2ee.server.home}/lib/tomcat-util.jar:${j2ee.server.home}/lib/tomcat-websocket.jar:${j2ee.server.home}/lib/websocket-api.jar
 lucene.version=7.3.1
 lucene-core.jar=lucene-core-${lucene.version}.jar
 lucene-analyzers-common.jar=lucene-analyzers-common-${lucene.version}.jar

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

@@ -18,8 +18,8 @@
  */
 
  /*
-  * Copyright (c) 2006, 2017, Oracle and/or its affiliates. All rights reserved.
- */
+  * Copyright (c) 2006, 2018, Oracle and/or its affiliates. All rights reserved.
+  */
 package org.opensolaris.opengrok.configuration;
 
 import java.io.File;
@@ -68,6 +68,11 @@ public class Project implements Comparable<Project>, Nameable, Serializable {
      */
     private boolean navigateWindowEnabled = false;
 
+    /**
+     * This flag sets per-project handling of renamed files.
+     */
+    private Boolean handleRenamedFiles = null;
+    
     /**
      * This marks the project as (not)ready before initial index is done. this
      * is to avoid all/multi-project searches referencing this project from
@@ -229,6 +234,20 @@ public void setNavigateWindowEnabled(boolean navigateWindowEnabled) {
         this.navigateWindowEnabled = navigateWindowEnabled;
     }
 
+    /**
+     * @return true if this project handles renamed files.
+     */
+    public boolean isHandleRenamedFiles() {
+        return handleRenamedFiles != null && handleRenamedFiles;
+    }
+    
+    /**
+     * @param flag true if project should handle renamed files, false otherwise.
+     */
+    public void setHandleRenamedFiles(boolean flag) {
+        this.handleRenamedFiles = flag;
+    }
+    
     /**
      * Return groups where this project belongs
      *
@@ -263,7 +282,7 @@ public void addGroup(Group group) {
     final public void completeWithDefaults(Configuration cfg) {
         Configuration defaultCfg = new Configuration();
         /**
-         * Choosing strategy for properties (tabSize here):
+         * Choosing strategy for properties (tabSize used as example here):
          * <pre>
          * this       cfg        defaultCfg   chosen value
          * ===============================================
@@ -278,6 +297,11 @@ final public void completeWithDefaults(Configuration cfg) {
         if (getTabSize() == defaultCfg.getTabSize()) {
             setTabSize(cfg.getTabSize());
         }
+        
+        // Allow project to override global setting of renamed file handling.
+        if (handleRenamedFiles == null) {
+            setHandleRenamedFiles(cfg.isHandleHistoryOfRenamedFiles());
+        }
     }
 
     /**

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

@@ -1237,6 +1237,18 @@ public boolean isHandleHistoryOfRenamedFiles() {
         return threadConfig.get().isHandleHistoryOfRenamedFiles();
     }
 
+    public boolean isHandleHistoryOfRenamedFilesForProject(Project project) {
+        if (hasProjects() && project != null) {
+            return project.isHandleRenamedFiles();
+        } else {
+            return isHandleHistoryOfRenamedFiles();
+        }
+    }
+    
+    public boolean isHandleHistoryOfRenamedFilesFor(String path) {
+        return isHandleHistoryOfRenamedFilesForProject(Project.getProject(path));
+    }
+    
     public void setRevisionMessageCollapseThreshold(int threshold) {
         threadConfig.get().setRevisionMessageCollapseThreshold(threshold);
     }

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2018, Chris Fraire <[email protected]>.
  */
 
@@ -54,6 +54,7 @@
 import java.util.logging.Logger;
 import java.util.zip.GZIPInputStream;
 import java.util.zip.GZIPOutputStream;
+import org.opensolaris.opengrok.configuration.Project;
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
 import org.opensolaris.opengrok.logger.LoggerFactory;
 import org.opensolaris.opengrok.util.ForbiddenSymlinkException;
@@ -406,6 +407,7 @@ private void finishStore(Repository repository, String latestRev) {
     public void store(History history, Repository repository)
             throws HistoryException {
         final RuntimeEnvironment env = RuntimeEnvironment.getInstance();
+        final boolean handleRenamedFiles = repository.isHandleRenamedFiles();
 
         String latestRev = null;
 
@@ -475,7 +477,7 @@ public void store(History history, Repository repository)
         int fileHistoryCount = 0;
         for (Map.Entry<String, List<HistoryEntry>> map_entry : map.entrySet()) {
             try {
-                if (env.isHandleHistoryOfRenamedFiles() &&
+                if (handleRenamedFiles &&
                     isRenamedFile(map_entry.getKey(), env, repository, history)) {
                         continue;
                 }
@@ -491,7 +493,7 @@ public void store(History history, Repository repository)
 
         LOGGER.log(Level.FINE, "Stored history for {0} files", fileHistoryCount);
 
-        if (!env.isHandleHistoryOfRenamedFiles()) {
+        if (!handleRenamedFiles) {
             finishStore(repository, latestRev);
             return;
         }

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2007, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2018, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.history;
@@ -59,6 +59,12 @@ private enum ParseState {
     private GitRepository repository = new GitRepository();
     private List<HistoryEntry> entries = new ArrayList<>();
 
+    private final boolean handleRenamedFiles;
+    
+    GitHistoryParser(boolean flag) {
+        handleRenamedFiles = flag;
+    }
+    
     /**
      * Process the output from the log command and insert the HistoryEntries
      * into the history field.
@@ -177,7 +183,7 @@ History parse(File file, Repository repos, String sinceRevision) throws HistoryE
                                 status));
             }
 
-            if (RuntimeEnvironment.getInstance().isHandleHistoryOfRenamedFiles()) {
+            if (handleRenamedFiles) {
                 executor = repository.getRenamedFilesExecutor(file, sinceRevision);
                 status = executor.exec(true, parser);
 

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

@@ -122,8 +122,8 @@ Executor getHistoryLogExecutor(final File file, String sinceRevision)
         cmd.add("--name-only");
         cmd.add("--pretty=fuller");
         cmd.add(GIT_DATE_OPT);
-
-        if (file.isFile() && RuntimeEnvironment.getInstance().isHandleHistoryOfRenamedFiles()) {
+        
+        if (file.isFile() && isHandleRenamedFiles()) {
             cmd.add("--follow");
         }
 
@@ -481,7 +481,7 @@ History getHistory(File file) throws HistoryException {
     History getHistory(File file, String sinceRevision)
             throws HistoryException {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        History result = new GitHistoryParser().parse(file, this, sinceRevision);
+        History result = new GitHistoryParser(isHandleRenamedFiles()).parse(file, this, sinceRevision);
         // Assign tags to changesets they represent
         // We don't need to check if this repository supports tags,
         // because we know it :-)

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2006, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2006, 2018, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.history;
@@ -93,7 +93,7 @@ public class MercurialRepository extends Repository {
             + END_OF_ENTRY + "\\n";
 
     /**
-     * Template for formatting hg log output for directories.
+     * Template for formatting {@code hg log} output for directories.
      */
     private static final String DIR_TEMPLATE_RENAMED
             = TEMPLATE_STUB + FILE_LIST
@@ -104,7 +104,7 @@ public class MercurialRepository extends Repository {
 
     private static final Pattern LOG_COPIES_PATTERN
             = Pattern.compile("^(\\d+):(.*)");
-
+    
     public MercurialRepository() {
         type = "Mercurial";
         datePatterns = new String[]{
@@ -188,7 +188,7 @@ Executor getHistoryLogExecutor(File file, String sinceRevision)
 
         cmd.add("--template");
         if (file.isDirectory()) {
-            cmd.add(env.isHandleHistoryOfRenamedFiles() ? DIR_TEMPLATE_RENAMED : DIR_TEMPLATE);
+            cmd.add(this.isHandleRenamedFiles() ? DIR_TEMPLATE_RENAMED : DIR_TEMPLATE);
         } else {
             cmd.add(FILE_TEMPLATE);
         }

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

@@ -66,6 +66,8 @@ public class RepositoryInfo implements Serializable {
     protected String branch;
     protected String currentVersion;
 
+    private boolean handleRenamedFiles;
+    
     /**
      * format used for printing the date in {@code currentVersion}
      */
@@ -89,6 +91,13 @@ public RepositoryInfo(RepositoryInfo orig) {
         this.currentVersion = orig.currentVersion;
     }
 
+    /**
+     * @return true if the repository handles renamed files, false otherwise.
+     */
+    public boolean isHandleRenamedFiles() {
+        return this.handleRenamedFiles;
+    }
+    
     /**
      * @return relative path to source root
      */
@@ -102,6 +111,9 @@ public String getDirectoryNameRelative() {
      */
     public void setDirectoryNameRelative(String dir) {
         this.directoryNameRelative = dir;
+        
+        handleRenamedFiles = RuntimeEnvironment.getInstance().
+                isHandleHistoryOfRenamedFilesFor(dir);
     }
 
     /**
@@ -117,8 +129,7 @@ public String getDirectoryName() {
     /**
      * Specify the name of the root directory for this repository.
      *
-     * @param dir the new name of the root directory. Can be absolute
-     * path or relative to source root.
+     * @param dir the new root directory
      */
     public void setDirectoryName(File dir) {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
@@ -141,9 +152,9 @@ public void setDirectoryName(File dir) {
         }
 
         if (path.startsWith(rootPath)) {
-            this.directoryNameRelative = path.substring(rootPath.length());
+            setDirectoryNameRelative(path.substring(rootPath.length()));
         } else {
-            this.directoryNameRelative = path;
+            setDirectoryNameRelative(path);
         }
     }
 

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

@@ -884,6 +884,40 @@ public void prepareIndexer(RuntimeEnvironment env,
             throw new IndexerException("Internal error, zapCache shouldn't be null");
         }
 
+        if (addProjects) {
+            File files[] = env.getSourceRootFile().listFiles();
+            Map<String,Project> projects = env.getProjects();
+
+            // Keep a copy of the old project list so that we can preserve
+            // the customization of existing projects.
+            Map<String, Project> oldProjects = new HashMap<>();
+            for (Project p : projects.values()) {
+                oldProjects.put(p.getName(), p);
+            }
+
+            projects.clear();
+
+            // Add a project for each top-level directory in source root.
+            for (File file : files) {
+                String name = file.getName();
+                String path = "/" + name;
+                if (oldProjects.containsKey(name)) {
+                    // This is an existing object. Reuse the old project,
+                    // possibly with customizations, instead of creating a
+                    // new with default values.
+                    Project p = oldProjects.get(name);
+                    p.setPath(path);
+                    p.setName(name);
+                    p.completeWithDefaults(env.getConfiguration());
+                    projects.put(name, p);
+                } else if (!name.startsWith(".") && file.isDirectory()) {
+                    // Found a new directory with no matching project, so
+                    // create a new project with default properties.
+                    projects.put(name, new Project(name, path, env.getConfiguration()));
+                }
+            }
+        }
+        
         if (searchRepositories || listRepoPaths || !zapCache.isEmpty()) {
             LOGGER.log(Level.INFO, "Scanning for repositories...");
             long start = System.currentTimeMillis();
@@ -937,40 +971,6 @@ public void prepareIndexer(RuntimeEnvironment env,
             }
         }
 
-        if (addProjects) {
-            File files[] = env.getSourceRootFile().listFiles();
-            Map<String,Project> projects = env.getProjects();
-
-            // Keep a copy of the old project list so that we can preserve
-            // the customization of existing projects.
-            Map<String, Project> oldProjects = new HashMap<>();
-            for (Project p : projects.values()) {
-                oldProjects.put(p.getName(), p);
-            }
-
-            projects.clear();
-
-            // Add a project for each top-level directory in source root.
-            for (File file : files) {
-                String name = file.getName();
-                String path = "/" + name;
-                if (oldProjects.containsKey(name)) {
-                    // This is an existing object. Reuse the old project,
-                    // possibly with customizations, instead of creating a
-                    // new with default values.
-                    Project p = oldProjects.get(name);
-                    p.setPath(path);
-                    p.setName(name);
-                    p.completeWithDefaults(env.getConfiguration());
-                    projects.put(name, p);
-                } else if (!name.startsWith(".") && file.isDirectory()) {
-                    // Found a new directory with no matching project, so
-                    // create a new project with default properties.
-                    projects.put(name, new Project(name, path, env.getConfiguration()));
-                }
-            }
-        }
-
         if (defaultProjects != null && !defaultProjects.isEmpty()) {
             Set<Project> projects = new TreeSet<>();
             for (String projectPath : defaultProjects) {

test/org/opensolaris/opengrok/configuration/ProjectTest.java

@@ -17,8 +17,8 @@
  * CDDL HEADER END
  */
 
- /*
- * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
+/*
+ * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opensolaris.opengrok.configuration;
 
@@ -142,12 +142,10 @@ public void testMergeProjects1() {
         cfg.setTabSize(new Configuration().getTabSize() + 3731);
 
         Project p1 = new Project();
-        p1.setNavigateWindowEnabled(true);
-
+        
         p1.completeWithDefaults(cfg);
 
         assertNotNull(p1);
-        assertTrue("Navigate window should be turned on", p1.isNavigateWindowEnabled());
         assertEquals(new Configuration().getTabSize() + 3731, p1.getTabSize());
     }
 
@@ -161,10 +159,14 @@ public void testMergeProjects2() {
 
         Project p1 = new Project();
         p1.setTabSize(new Project().getTabSize() + 9737);
+        p1.setNavigateWindowEnabled(true);
+        p1.setHandleRenamedFiles(true);
 
         p1.completeWithDefaults(cfg);
 
         assertNotNull(p1);
+        assertTrue("Navigate window should be turned on", p1.isNavigateWindowEnabled());
+        assertTrue("Renamed file handling should be true", p1.isHandleRenamedFiles());
         assertEquals(new Project().getTabSize() + 9737, p1.getTabSize());
     }