Merge pull request #2123 from idodeclare/feature/die_w

Fix #431 : option -w should die

Author: tarzanek

OpenGrok

@@ -133,10 +133,6 @@ Supported Environment Variables for configuring the default setup:
                                   (by default 3 directories from SRC_ROOT)
   - OPENGROK_WEBAPP_CFGADDR     Web app address to send configuration to
                                   (use "none" to avoid sending it to web app)
-  - OPENGROK_WEBAPP_CONTEXT     Context URL of the OpenGrok webapp
-                                  (by default /source). FULL reindex is needed
-                                  once this is used (old already indexed files
-                                  won't be refreshed)
   - OPENGROK_WPREFIX            Disable wildcard prefix search query support (*)
   - OPENGROK_TAG                Enable parsing of revision tags into the History
                                   view
@@ -388,13 +384,6 @@ DefaultInstanceConfiguration()
         WEBAPP_CONFIG="-U ${WEBAPP_CONFIG_ADDRESS}"
     fi
 
-    # OPTIONAL: Context URL of the OpenGrok webapp
-    #           (default is /source)
-    WEBAPP_CONTEXT=""
-    if [ -n "${OPENGROK_WEBAPP_CONTEXT}" ]; then
-        WEBAPP_CONTEXT="-w ${OPENGROK_WEBAPP_CONTEXT}"
-    fi
-
     # OPTIONAL: JVM Options
     JAVA_OPTS="${JAVA_OPTS:--Xmx2048m}"
 
@@ -912,7 +901,6 @@ CommonInvocation()
         ${ASSIGNMENTS}							\
         ${READ_XML_CONF}                                        	\
         ${WEBAPP_CONFIG}						\
-        ${WEBAPP_CONTEXT}						\
         ${OPENGROK_PROFILER:+--profiler}				\
         "${@}"
 }

build.xml

@@ -371,6 +371,9 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
         <property name="gen.context.dir" value="/org/opensolaris/opengrok/search/context"/>
         <run-jflex dir="${gen.context.dir}" name="HistoryLineTokenizer"/>
         <run-jflex dir="${gen.context.dir}" name="PlainLineTokenizer"/>
+
+        <property name="gen.web.dir" value="/org/opensolaris/opengrok/web"/>
+        <run-jflex dir="${gen.web.dir}" name="XrefSourceTransformer"/>
     </target>
 
     <property name="git" value="git"/>

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

@@ -25,6 +25,7 @@
 
 import java.io.BufferedReader;
 import java.io.File;
+import java.io.FileWriter;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
@@ -631,6 +632,35 @@ public static void writeXref(FileAnalyzerFactory factory, Reader in,
         analyzer.writeXref(args);
     }
 
+    /**
+     * Writes a browse-able version of the file transformed for immediate
+     * serving to a web client.
+     * @param contextPath the web context path for
+     * {@link Util#dumpXref(java.io.Writer, java.io.Reader, java.lang.String)}
+     * @param factory the analyzer factory for this file type
+     * @param in the input stream containing the data
+     * @param out a defined instance to write
+     * @param defs definitions for the source file, if available
+     * @param annotation annotation information for the file
+     * @param project project the file belongs to
+     * @throws java.io.IOException if an error occurs while creating the output
+     */
+    public static void writeDumpedXref(String contextPath,
+            FileAnalyzerFactory factory, Reader in, Writer out,
+            Definitions defs, Annotation annotation, Project project)
+            throws IOException {
+
+        File xrefTemp = File.createTempFile("ogxref", ".html");
+        try {
+            try (FileWriter tmpout = new FileWriter(xrefTemp)) {
+                writeXref(factory, in, tmpout, defs, annotation, project);
+            }
+            Util.dumpXref(out, xrefTemp, false, contextPath);
+        } finally {
+            xrefTemp.delete();
+        }
+    }
+
     /**
      * Get the genre of a file
      *

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

@@ -144,6 +144,14 @@ public final class Configuration {
     private String sourceRoot;
     private String dataRoot;
     private List<RepositoryInfo> repositories;
+    /**
+     * @deprecated This is kept around so not to break object deserialization
+     * but it is ignored and cannot be truly set. This should mean that the
+     * configuration is written leaving out this deprecated property; so after
+     * some time it can be retired with the expectation that zero or a
+     * miniscule number of production configurations still have this deprecated
+     * property.
+     */
     private String urlPrefix;
     private boolean generateHtml;
     /**
@@ -461,8 +469,7 @@ public Configuration() {
         setStatisticsFilePath(null);
         //setTabSize(4);
         setTagsEnabled(false);
-        setUrlPrefix("/source/s?");
-        //setUrlPrefix("../s?"); // TODO generate relative search paths, get rid of -w <webapp> option to indexer !
+        //urlPrefix's constant value is moved to RuntimeEnvironment.
         //setUserPage("http://www.myserver.org/viewProfile.jspa?username=");
         // Set to empty string so we can append it to the URL
         // unconditionally later.
@@ -812,15 +819,16 @@ public String getUrlPrefix() {
     }
 
     /**
-     * Set the URL prefix to be used by the {@link
-     * org.opensolaris.opengrok.analysis.executables.JavaClassAnalyzer} as well
-     * as lexers (see {@link org.opensolaris.opengrok.analysis.JFlexXref}) when
-     * they create output with html links.
-     *
-     * @param urlPrefix prefix to use.
+     * Formerly this allowed setting the URL prefix to be used for the Java
+     * class analyzer and for language cross-referencing (xref) when they
+     * created HTML links. Now, a static value is used and transformed as
+     * necessary to the servlet {@code contextPath} so that users can deploy
+     * OpenGrok as they like.
+     * @param urlPrefix ignored
      */
+    @Deprecated
     public void setUrlPrefix(String urlPrefix) {
-        this.urlPrefix = urlPrefix;
+        // ignore the value
     }
 
     public void setGenerateHtml(boolean generateHtml) {

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

@@ -103,6 +103,7 @@
 import static org.opensolaris.opengrok.configuration.Configuration.makeXMLStringAsConfiguration;
 import org.opensolaris.opengrok.util.ForbiddenSymlinkException;
 import org.opensolaris.opengrok.util.PathUtils;
+import org.opensolaris.opengrok.web.Prefix;
 
 /**
  * The RuntimeEnvironment class is used as a placeholder for the current
@@ -112,6 +113,9 @@ public final class RuntimeEnvironment {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(RuntimeEnvironment.class);
 
+    /** {@code "/source"} + {@link Prefix#SEARCH_R} + {@code "?"} */
+    private static final String URL_PREFIX = "/source" + Prefix.SEARCH_R + "?";
+
     private Configuration configuration;
     private final ThreadLocal<Configuration> threadConfig;
     private static final RuntimeEnvironment instance = new RuntimeEnvironment();
@@ -556,21 +560,12 @@ public Map<Project, List<RepositoryInfo>> getProjectRepositoriesMap() {
     }
 
     /**
-     * Get the context name of the web application
-     *
-     * @return the web applications context name
+     * Gets a static placeholder for the web application context name that is
+     * translated to the true servlet {@code contextPath} on demand.
+     * @return {@code "/source"} + {@link Prefix#SEARCH_R} + {@code "?"}
      */
     public String getUrlPrefix() {
-        return threadConfig.get().getUrlPrefix();
-    }
-
-    /**
-     * Set the web context name
-     *
-     * @param urlPrefix the web applications context name
-     */
-    public void setUrlPrefix(String urlPrefix) {
-        threadConfig.get().setUrlPrefix(urlPrefix);
+        return URL_PREFIX;
     }
 
     /**

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

@@ -771,22 +771,6 @@ public static String[] parseOptions(String[] argv) throws ParseException {
                 "(so that the web application can use the same configuration)").Do( configFile -> {
                 configFilename = (String)configFile;
             });
-
-            parser.on("-w", "--web", "=webapp-context",
-                "Context of webapp. Default is /source. If you specify a different",
-                "name, make sure to rename source.war to that name. Also FULL reindex",
-                "is needed if this is changed.").
-                Do( webContext -> {
-                    String webapp = (String)webContext;
-                    if (webapp.charAt(0) != '/' && !webapp.startsWith("http")) {
-                        webapp = "/" + webapp;
-                    }
-                    if (!webapp.endsWith("/")) {
-                        webapp += "/";
-                    }
-                    cfg.setUrlPrefix(webapp + "s?");
-                }
-            );
         });
 
         // Need to read the configuration file first

src/org/opensolaris/opengrok/web/Util.java

@@ -25,10 +25,11 @@
 
 package org.opensolaris.opengrok.web;
 
+import java.io.BufferedInputStream;
 import java.io.File;
 import java.io.FileInputStream;
-import java.io.FileReader;
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.Reader;
 import java.io.UnsupportedEncodingException;
@@ -1169,10 +1170,10 @@ public static boolean dump(Writer out, File file, boolean compressed) {
          * For backward compatibility, read the OpenGrok-produced document
          * using the system default charset.
          */
-        try (Reader in = compressed
-                ? new InputStreamReader(new GZIPInputStream(
-                        new FileInputStream(file)))
-                : new FileReader(file)) {
+        try (InputStream iss = new BufferedInputStream(
+                new FileInputStream(file))) {
+            Reader in = compressed ? new InputStreamReader(new GZIPInputStream(
+                iss)) : new InputStreamReader(iss);
             dump(out, in);
             return true;
         } catch (IOException e) {
@@ -1182,6 +1183,61 @@ public static boolean dump(Writer out, File file, boolean compressed) {
         return false;
     }
 
+    /**
+     * Silently dump an xref file to the given destination. All
+     * {@link IOException}s get caught and logged, but not re-thrown.
+     * @param out dump destination
+     * @param file file to dump
+     * @param compressed if {@code true} the denoted file is assumed to be
+     * gzipped
+     * @param contextPath an optional override of "/source/" as the context path
+     * @return {@code true} on success (everything read and written)
+     * @throws NullPointerException if a parameter is {@code null}.
+     */
+    public static boolean dumpXref(Writer out, File file, boolean compressed,
+            String contextPath) {
+        if (!file.exists()) {
+            return false;
+        }
+        /**
+         * For backward compatibility, read the OpenGrok-produced document
+         * using the system default charset.
+         */
+        try (InputStream iss = new BufferedInputStream(
+                new FileInputStream(file))) {
+            Reader in = compressed ? new InputStreamReader(new GZIPInputStream(
+                iss)) : new InputStreamReader(iss);
+            dumpXref(out, in, contextPath);
+            return true;
+        } catch (IOException e) {
+            LOGGER.log(Level.WARNING, "An error occured while piping file " +
+                    file, e);
+        }
+        return false;
+    }
+
+    /**
+     * Silently dump an xref file to the given destination. All
+     * {@link IOException}s get caught and logged, but not re-thrown.
+     * @param out dump destination
+     * @param in source to read
+     * @param contextPath an optional override of "/source/" as the context path
+     * @throws IOException as defined by the given reader/writer
+     * @throws NullPointerException if a parameter is {@code null}.
+     */
+    public static void dumpXref(Writer out, Reader in, String contextPath)
+            throws IOException {
+        if (in == null || out == null) {
+            return;
+        }
+        XrefSourceTransformer xform = new XrefSourceTransformer(in);
+        xform.setWriter(out);
+        xform.setContextPath(contextPath);
+        while (xform.yylex()) {
+            // Nothing else to do.
+        }
+    }
+
     /**
      * Print list of messages into output
      *