Merge remote-tracking branch 'upstream/master' into add-dockerfile2

Author: wy193777

distribution/pom.xml

@@ -7,7 +7,7 @@
   <parent>
     <groupId>org.opengrok</groupId>
     <artifactId>opengrok-top</artifactId>
-    <version>1.2.7</version>
+    <version>1.2.8</version>
   </parent>
 
   <artifactId>opengrok-dist</artifactId>
@@ -24,20 +24,20 @@
     <dependency>
       <groupId>org.opengrok</groupId>
       <artifactId>opengrok</artifactId>
-      <version>1.2.7</version>
+      <version>1.2.8</version>
     </dependency>
 
     <dependency>
       <groupId>org.opengrok</groupId>
       <artifactId>opengrok-web</artifactId>
-      <version>1.2.7</version>
+      <version>1.2.8</version>
       <type>war</type>
     </dependency>
 
     <dependency>
       <groupId>org.opengrok</groupId>
       <artifactId>opengrok-tools</artifactId>
-      <version>1.2.7</version>
+      <version>1.2.8</version>
       <type>pom</type>
     </dependency>
   </dependencies>

opengrok-indexer/pom.xml

@@ -28,11 +28,11 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
     <parent>
         <groupId>org.opengrok</groupId>
         <artifactId>opengrok-top</artifactId>
-        <version>1.2.7</version>
+        <version>1.2.8</version>
     </parent>
 
     <artifactId>opengrok</artifactId>
-    <version>1.2.7</version>
+    <version>1.2.8</version>
     <packaging>jar</packaging>
 
     <name>OpenGrok Indexer</name>

opengrok-indexer/src/main/java/org/opengrok/indexer/history/GitRepository.java

@@ -590,20 +590,20 @@ boolean hasFileBasedTags() {
         return true;
     }
 
-    private TagEntry buildTagEntry(File directory, String tags, boolean interactive) throws HistoryException, IOException {
+    private TagEntry buildTagEntry(File directory, String tag, boolean interactive) {
         ArrayList<String> argv = new ArrayList<>();
         ensureCommand(CMD_PROPERTY_KEY, CMD_FALLBACK);
         argv.add(RepoCommand);
         argv.add("log");
-        argv.add("--format=commit:%H" + System.getProperty("line.separator")
-                + "Date:%at");
-        argv.add("-r");
-        argv.add(tags + "^.." + tags);
+        argv.add("--format=commit:%H%nDate:%at");
+        argv.add("-n");
+        argv.add("1");
+        argv.add(tag);
 
         Executor executor = new Executor(argv, directory, interactive ?
                 RuntimeEnvironment.getInstance().getInteractiveCommandTimeout() :
                 RuntimeEnvironment.getInstance().getCommandTimeout());
-        GitTagParser parser = new GitTagParser(tags);
+        GitTagParser parser = new GitTagParser(tag);
         executor.exec(true, parser);
         return parser.getEntries().first();
     }
@@ -645,21 +645,11 @@ protected void buildTagList(File directory, boolean interactive) {
             this.tagList = null;
         }
 
-        try {
-            // Now get hash & date for each tag
-            for (String tags : tagsList) {
-                TagEntry tagEntry = buildTagEntry(directory, tags, interactive);
-                // Reverse the order of the list
-                this.tagList.add(tagEntry);
-            }
-        } catch (HistoryException e) {
-            LOGGER.log(Level.WARNING,
-                    "Failed to parse tag list: {0}", e.getMessage());
-            this.tagList = null;
-        } catch (IOException e) {
-            LOGGER.log(Level.WARNING,
-                    "Failed to read tag list: {0}", e.getMessage());
-            this.tagList = null;
+        // Now get hash & date for each tag.
+        for (String tag : tagsList) {
+            TagEntry tagEntry = buildTagEntry(directory, tag, interactive);
+            // Reverse the order of the list
+            this.tagList.add(tagEntry);
         }
     }
 

opengrok-indexer/src/main/java/org/opengrok/indexer/history/PerforceHistoryParser.java

@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2019, Chris Ross <[email protected]>.
  */
 
 package org.opengrok.indexer.history;
@@ -31,27 +32,37 @@
 import java.util.Calendar;
 import java.util.Date;
 import java.util.List;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import org.opengrok.indexer.logger.LoggerFactory;
 import org.opengrok.indexer.util.Executor;
+import static org.opengrok.indexer.history.PerforceRepository.protectPerforceFilename;
 
 /**
  * Parse source history for a Perforce Repository
  *
  * @author Emilio Monti - [email protected]
  */
 public class PerforceHistoryParser {
+    private static final Logger LOGGER = LoggerFactory.getLogger(PerforceHistoryParser.class);
+
+    History parse(File file, Repository repos) throws HistoryException {
+        return this.parse(file, null, repos);
+    }
 
     /**
      * Parse the history for the specified file.
      *
      * @param file the file to parse history for
+     * @param sinceRevision the revision before the start of desired history
      * @param repos Pointer to the {@code PerforceRepository}
      * @return object representing the file's history
      * @throws HistoryException if a problem occurs while executing p4 command
      */
-    History parse(File file, Repository repos) throws HistoryException {
+    History parse(File file, String sinceRevision, Repository repos) throws HistoryException {
         History history;
 
         if (!PerforceRepository.isInP4Depot(file, false)) {
@@ -60,9 +71,16 @@ History parse(File file, Repository repos) throws HistoryException {
 
         try {
             if (file.isDirectory()) {
+                /* TODO: Do I need to think about revisions here? */
                 history = parseDirectory(file);
             } else {
-                history = getRevisions(file, null);
+                if (sinceRevision == null || "".equals(sinceRevision)) {
+                    /* Get all revisions */
+                    history = getRevisions(file, null);
+                } else {
+                    /* Get revisions between specified and head */
+                    history = getRevisionsSince(file, sinceRevision);
+                }
             }
         } catch (IOException ioe) {
             throw new HistoryException(ioe);
@@ -82,12 +100,54 @@ private History parseDirectory(File file) throws IOException {
         return parseChanges(executor.getOutputReader());
     }
 
+    /**
+     * Retrieve the history of a given file.
+     *
+     * @param file the file to parse history for
+     * @param rev the revision at which to end history
+     * @return object representing the file's history
+     */
     public static History getRevisions(File file, String rev) throws IOException {
         ArrayList<String> cmd = new ArrayList<String>();
         cmd.add("p4");
         cmd.add("filelog");
         cmd.add("-lti");
-        cmd.add(file.getName() + PerforceRepository.getRevisionCmd(rev));
+        cmd.add(protectPerforceFilename(file.getName()) + PerforceRepository.getRevisionCmd(rev));
+        Executor executor = new Executor(cmd, file.getCanonicalFile().getParentFile());
+        executor.exec();
+
+        return parseFileLog(executor.getOutputReader());
+    }
+
+    /**
+     * Retrieve the history of a given file, beginning after the specified
+     * revision.
+     *
+     * @param file the file to parse history for
+     * @param rev the revision before the start of desired history
+     * @return object representing the file's history
+     */
+    public static History getRevisionsSince(File file, String rev) throws IOException {
+        ArrayList<String> cmd = new ArrayList<String>();
+        cmd.add("p4");
+        cmd.add("filelog");
+        cmd.add("-lti");
+        /* Okay.  This is a little cheeky.  getRevisionCmd(String,String) gives
+         * a range spec that _includes_ the first revision.  But, we don't want
+         * that in this case here.  So, presume that "rev" is always an integer
+         * for perforce, add one to it, then convert back into a string to
+         * pass into getRevisionCmd as a starting revision. */
+        try {
+            Integer irev = Integer.parseInt(rev);
+            irev += 1;
+            rev = irev.toString();
+        } catch (NumberFormatException e) {
+            LOGGER.log(Level.WARNING,
+                    "Unable to increment revision {}, NumberFormatException",
+                    new Object[]{rev});
+            /* Move along with rev unchanged... */
+        }
+        cmd.add(file.getName() + PerforceRepository.getRevisionCmd(rev, "now"));
         Executor executor = new Executor(cmd, file.getCanonicalFile().getParentFile());
         executor.exec();
 

opengrok-indexer/src/main/java/org/opengrok/indexer/history/PerforceRepository.java

@@ -20,6 +20,7 @@
 /*
  * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2018, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2019, Chris Ross <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -61,14 +62,31 @@ public PerforceRepository() {
         ignoredFiles.add(".p4config");
     }
 
+    static String protectPerforceFilename(String name) {
+        /* For each of the [four] special characters, replace them with */
+        /* the recognized escape sequence for perforce. */
+        /* NOTE: Must replace '%' first, or that translation would */
+        /* affect the output of the others. */
+        String t = name.replace("%", "%25");
+        t = t.replace("#", "%23");
+        t = t.replace("*", "%2A");
+        t = t.replace("@", "%40");
+        if (!name.equals(t)) {
+            LOGGER.log(Level.FINEST,
+                       "protectPerforceFilename: replaced ''{0}'' with ''{1}''",
+                       new Object[]{name, t});
+        }
+        return t;
+    }
+
     @Override
     public Annotation annotate(File file, String rev) throws IOException {
         ArrayList<String> cmd = new ArrayList<>();
         ensureCommand(CMD_PROPERTY_KEY, CMD_FALLBACK);
         cmd.add(RepoCommand);
         cmd.add("annotate");
         cmd.add("-qci");
-        cmd.add(file.getPath() + getRevisionCmd(rev));
+        cmd.add(protectPerforceFilename(file.getPath()) + getRevisionCmd(rev));
 
         Executor executor = new Executor(cmd, file.getParentFile(),
                 RuntimeEnvironment.getInstance().getInteractiveCommandTimeout());
@@ -87,7 +105,7 @@ boolean getHistoryGet(
         cmd.add(RepoCommand);
         cmd.add("print");
         cmd.add("-q");
-        cmd.add(basename + getRevisionCmd(rev));
+        cmd.add(protectPerforceFilename(basename) + getRevisionCmd(rev));
         Executor executor = new Executor(cmd, new File(parent));
         // TODO: properly evaluate Perforce return code
         executor.exec();
@@ -136,11 +154,11 @@ public boolean fileHasAnnotation(File file) {
      * @param interactive interactive mode flag
      * @return true if the given file is in the depot, false otherwise
      */
-    public static boolean isInP4Depot(File file, boolean interactive) {
+    static boolean isInP4Depot(File file, boolean interactive) {
         boolean status = false;
         if (testRepo.isWorking()) {
             ArrayList<String> cmd = new ArrayList<>();
-            String name = file.getName();
+            String name = protectPerforceFilename(file.getName());
             File dir = file.getParentFile();
             if (file.isDirectory()) {
                 dir = file;
@@ -201,6 +219,12 @@ History getHistory(File file) throws HistoryException {
         return new PerforceHistoryParser().parse(file, this);
     }
 
+    @Override
+    History getHistory(File file, String sinceRevision)
+            throws HistoryException {
+        return new PerforceHistoryParser().parse(file, sinceRevision, this);
+    }
+
     @Override
     String determineParent(boolean interactive) throws IOException {
         return null;
@@ -211,16 +235,40 @@ String determineBranch(boolean interactive) {
         return null;
     }
     /**
-     * Parse internal rev number and returns it in format suitable for P4 command-line.
+     * Parse internal rev number and return it in a format suitable for P4 command-line.
      * @param rev Internal rev number.
      * @return rev number formatted for P4 command-line.
      */
-    public static String getRevisionCmd(String rev) {
-        if(rev == null || "".equals(rev)) {
+    static String getRevisionCmd(String rev) {
+        if (rev == null || "".equals(rev)) {
             return "";
         }
         return "@" + rev;
     }
+    /**
+     * Parse rev numbers and return it as a range in a format suitable for P4 command-line.
+     * @param first First revision number.
+     * @param last Last revision number.
+     * @return rev number formatted for P4 command-line.
+     */
+    static String getRevisionCmd(String first, String last) {
+        if ((first == null || "".equals(first)) &&
+            ((last == null) || "".equals(last))) {
+            return "";
+        }
+        String ret = "@";
+        if (first == null || "".equals(first)) {
+            ret += "0,";
+        } else {
+            ret += first + ",";
+        }
+        if (last == null || "".equals(last)) {
+            ret += "now";
+        } else {
+            ret += last;
+        }
+        return ret;
+    }
 
     @Override
     String determineCurrentVersion(boolean interactive) throws IOException {

opengrok-indexer/src/test/java/org/opengrok/indexer/history/PerforceRepositoryTest.java

@@ -20,6 +20,7 @@
 /*
  * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2019, Chris Ross <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -35,9 +36,12 @@
 import java.io.InputStream;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.AbstractMap.SimpleImmutableEntry;
 
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertEquals;
 import org.opengrok.indexer.configuration.RuntimeEnvironment;
+import static org.opengrok.indexer.history.PerforceRepository.protectPerforceFilename;
 
 /**
  * Do basic testing of the Perforce support
@@ -105,4 +109,23 @@ public void testHistoryAndAnnotations() throws Exception {
             }
         }
     }
+
+    @Test
+    public void testProtectFilename() throws Exception {
+        ArrayList<SimpleImmutableEntry<String,String>>   testmap = new ArrayList<>();
+        testmap.add(new SimpleImmutableEntry<>("Testfile 34", "Testfile 34"));
+        testmap.add(new SimpleImmutableEntry<>("Test%52", "Test%2552"));
+        testmap.add(new SimpleImmutableEntry<>("Test*4+2", "Test%2A4+2"));
+        testmap.add(new SimpleImmutableEntry<>("Test@", "Test%40"));
+        testmap.add(new SimpleImmutableEntry<>("@seventeen", "%40seventeen"));
+        testmap.add(new SimpleImmutableEntry<>("upNdown(", "upNdown("));
+        testmap.add(new SimpleImmutableEntry<>("tst#99", "tst%2399"));
+        testmap.add(new SimpleImmutableEntry<>("#File*Three%trig", "%23File%2AThree%25trig"));
+        testmap.add(new SimpleImmutableEntry<>("Two%and5#3#4", "Two%25and5%233%234"));
+
+        for (SimpleImmutableEntry<String,String> ent : testmap) {
+            String prot = protectPerforceFilename(ent.getKey());
+            assertEquals("Improper protected filename, "+prot+" != "+ent.getValue(), ent.getValue(), prot);
+        }
+    }
 }