Merge branch 'master' of github.com:OpenGrok/OpenGrok

Author: vladak

opengrok-web-nbproject/nbproject/project.properties

@@ -25,7 +25,7 @@ dist.javadoc.dir=${dist.dir}/javadoc
 dist.war=${dist.dir}/${war.name}
 endorsed.classpath=
 excludes=
-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-tribes.jar:${j2ee.server.home}/lib/catalina.jar:${j2ee.server.home}/lib/ecj-4.2.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-util.jar:${j2ee.server.home}/lib/tomcat7-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-tribes.jar:${j2ee.server.home}/lib/catalina.jar:${j2ee.server.home}/lib/ecj-4.2.1.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-util.jar
 lucene.version=4.6.0
 lucene-core.jar=lucene-core-${lucene.version}.jar
 lucene-analyzers-common.jar=lucene-analyzers-common-${lucene.version}.jar

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

@@ -657,7 +657,7 @@ public String getHeaderIncludeFileContent() {
      * contains definition tags.
      */
     public static final String EFTAR_DTAGS_FILE = "index/dtags.eftar";
-    private transient String dtagsEftar = null;
+    private transient File dtagsEftar = null;
 
     /**
      * Get the eftar file, which contains definition tags.
@@ -668,12 +668,10 @@ public File getDtagsEftar() {
         if (dtagsEftar == null) {
             File tmp = new File(getDataRoot() + "/" + EFTAR_DTAGS_FILE);
             if (tmp.canRead()) {
-                dtagsEftar = tmp.getName();
-            } else {
-                dtagsEftar = "";
+                dtagsEftar = tmp;
             }
         }
-        return dtagsEftar.isEmpty() ? null : new File(dtagsEftar);
+        return dtagsEftar;
     }
 
     public String getDatabaseDriver() {

src/org/opensolaris/opengrok/search/Results.java

@@ -143,8 +143,6 @@ public static void prettyPrint(Writer out, SearchHelper sh, int start,
         String xrefPrefix = sh.contextPath + Prefix.XREF_P;
         String morePrefix = sh.contextPath + Prefix.MORE_P;
         String xrefPrefixE = ctxE + Prefix.XREF_P;
-        String histPrefixE = ctxE + Prefix.HIST_L;
-        String rawPrefixE = ctxE + Prefix.RAW_P;
         File xrefDataDir = new File(sh.dataRoot, Prefix.XREF_P.toString());
 
         for (Map.Entry<String, ArrayList<Document>> entry :
@@ -165,17 +163,8 @@ public static void prettyPrint(Writer out, SearchHelper sh, int start,
             for (Document doc : entry.getValue()) {
                 String rpath = doc.get("path");
                 String rpathE = Util.URIEncodePath(rpath);
-                out.write("<tr><td class=\"q\"><a href=\"");
-                out.write(histPrefixE);
-                out.write(rpathE);
-                out.write("\" title=\"History\">H</a> <a href=\"");
-                out.write(xrefPrefixE);
-                out.write(rpathE);
-                out.write("?a=true\" title=\"Annotate\">A</a> <a href=\"");
-                out.write(rawPrefixE);
-                out.write(rpathE);
-                out.write("\" title=\"Download\">D</a>");
-                out.write("</td>");
+                out.write("<tr>");
+                Util.writeHAD(out, sh.contextPath, rpathE, false);
                 out.write("<td class=\"f\"><a href=\"");
                 out.write(xrefPrefixE);
                 out.write(rpathE);

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

@@ -90,6 +90,7 @@ private void PrintDateSize(Writer out, File child, Date modTime,
     /**
      * Write a htmlized listing of the given directory to the given destination.
      *
+     * @param contextPath path used for link prefixes
      * @param dir the directory to list
      * @param out write destination
      * @param path virtual path of the directory (usually the path name of
@@ -103,7 +104,7 @@ private void PrintDateSize(Writer out, File child, Date modTime,
      * @throws NullPointerException if a parameter except <var>files</var>
      *  is {@code null}
      */
-    public List<String> listTo(File dir, Writer out, String path, List<String> files)
+    public List<String> listTo(String contextPath, File dir, Writer out, String path, List<String> files)
             throws HistoryException, IOException {
         // TODO this belongs to a jsp, not here
         ArrayList<String> readMes = new ArrayList<String>();
@@ -117,7 +118,7 @@ public List<String> listTo(File dir, Writer out, String path, List<String> files
         }
 
         out.write("<table id=\"dirlist\">\n");
-        out.write("<thead>\n<tr><th/><th>Name</th><th>Date</th><th>Size</th>");
+        out.write("<thead>\n<tr><th/><th>Name</th><th></th><th>Date</th><th>Size</th>");
         if (offset > 0) {
             out.write("<th><tt>Description</tt></th>");
         }
@@ -129,7 +130,7 @@ public List<String> listTo(File dir, Writer out, String path, List<String> files
         // print the '..' entry even for empty directories
         if (path.length() != 0) {
             out.write("<tr><td><p class=\"'r'\"/></td><td>");
-            out.write("<b><a href=\"..\">..</a></b></td>");
+            out.write("<b><a href=\"..\">..</a></b></td><td></td>");
             PrintDateSize(out, dir.getParentFile(), null, dateFormatter);
             out.write("</tr>\n");
         }
@@ -152,9 +153,11 @@ public List<String> listTo(File dir, Writer out, String path, List<String> files
                     readMes.add(file);
                 }
                 boolean isDir = child.isDirectory();
-                out.write("<tr><td><p class=\"");
+                out.write("<tr><td>");
+                out.write("<p class=\"");
                 out.write(isDir ? 'r' : 'p');
-                out.write("\"/></td><td><a href=\"");
+                out.write("\"/>");
+                out.write("</td><td><a href=\"");
                 out.write(Util.URIEncodePath(file));
                 if (isDir) {
                     out.write("/\"><b>");
@@ -166,6 +169,7 @@ public List<String> listTo(File dir, Writer out, String path, List<String> files
                     out.write("</a>");
                 }
                 out.write("</td>");
+                Util.writeHAD(out, contextPath, path + file, isDir);
                 PrintDateSize(out, child, modTimes.get(file), dateFormatter);
                 if (offset > 0) {
                     String briefDesc = desc.getChildTag(parentFNode, file);

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

@@ -44,6 +44,7 @@
 import java.util.regex.Pattern;
 import javax.servlet.http.Cookie;
 import javax.servlet.http.HttpServletRequest;
+import javax.servlet.ServletRequest;
 import org.apache.commons.jrcs.diff.Diff;
 import org.apache.commons.jrcs.diff.DifferentiationFailedException;
 import org.opensolaris.opengrok.analysis.AnalyzerGuru;
@@ -58,10 +59,10 @@
 import org.opensolaris.opengrok.util.IOUtils;
 
 /**
- * A simple container to lazy initialize common vars wrt. a single request. It
- * MUST NOT be shared between several requests and {@link #cleanup()} should be
- * called before the page context gets destroyed (e.g. by overwriting
- * {@code jspDestroy()} or when leaving the {@code service} method. <p> Purpose
+ * A simple container to lazy initialize common vars wrt. a single request.
+ * It MUST NOT be shared between several requests and
+ * {@link #cleanup(ServletRequest)} should be called before the page context 
+ * gets destroyed (e.g.when leaving the {@code service} method). <p> Purpose
  * is to decouple implementation details from web design, so that the JSP
  * developer does not need to know every implementation detail and normally has
  * to deal with this class/wrapper, only (so some people may like to call this
@@ -311,8 +312,9 @@ public String canProcess() {
                         && !getRequestedRevision().isEmpty() && !hasHistory()) {
                     return null;
                 }
-            } else if (getPrefix() == Prefix.RAW_P) {
-                return null;
+            } else if ((getPrefix() == Prefix.RAW_P) ||
+                (getPrefix() == Prefix.DOWNLOAD_P)) {
+                    return null;
             }
         }
         return redir == null ? "" : redir;
@@ -1201,6 +1203,7 @@ public static PageConfig get(HttpServletRequest request) {
         request.setAttribute(ATTR_NAME, pcfg);
         return pcfg;
     }
+    
     private static final String ATTR_NAME = PageConfig.class.getCanonicalName();
     private HttpServletRequest req;
 
@@ -1209,17 +1212,24 @@ private PageConfig(HttpServletRequest req) {
     }
 
     /**
-     * Cleanup all allocated resources. Should always be called right before
-     * leaving the _jspService / service.
+     * Cleanup all allocated resources (if any) from the instance attached to 
+     * the given request.
+     * @param sr request to check, cleanup. Ignored if {@code null}.
+     * @see PageConfig#get(HttpServletRequest)
+     * 
      */
-    public void cleanup() {
-        if (req != null) {
-            req.removeAttribute(ATTR_NAME);
-            req = null;
+    public static void cleanup(ServletRequest sr) {
+        if (sr == null) {
+            return;
         }
-        env = null;
-        if (eftarReader != null) {
-            eftarReader.close();
+        PageConfig cfg = (PageConfig) sr.getAttribute(ATTR_NAME);
+        if (cfg == null) {
+            return;
+        }        
+        sr.removeAttribute(ATTR_NAME);
+        cfg.env = null;
+        if (cfg.eftarReader != null) {
+            cfg.eftarReader.close();
         }
     }
 }

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

@@ -60,6 +60,8 @@ public enum Prefix {
     /** RSS XML Feed of latest changes (link prefix) */
     RSS_P("/rss"),
     /** Download file (link prefix) */
+    DOWNLOAD_P("/download"),
+    /** Raw file display (link prefix) */
     RAW_P("/raw"),
     /** full blown search from main page or top bar (link prefix) */
     SEARCH_P("/search"),

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

@@ -55,12 +55,17 @@
  * Class for useful functions.
  */
 public final class Util {
+    private static final Charset UTF8 = Charset.forName("UTF-8");
+
+    private static final String SPAN_D = "<span class=\"d\">";
+    private static final String SPAN_A = "<span class=\"a\">";
+    private static final String SPAN_E = "</span>";
+    private static final int SPAN_LEN = SPAN_D.length() + SPAN_E.length();
+
     private Util() {
         // singleton
     }
 
-    private static final Charset UTF8 = Charset.forName("UTF-8");
-
     /**
      * Return a string which represents a <code>CharSequence</code> in HTML.
      *
@@ -567,6 +572,42 @@ public static String uid2url(String uid) {
         return url.substring(0, url.lastIndexOf('/')); // remove date from end
     }
 
+    /**
+     * Write the 'H A D' links. This is used for search results and directory
+     * listings.
+     *
+     * @param out   writer for producing output
+     * @param ctxE  URI encoded prefix
+     * @param entry file/directory name to write
+     * @param is_dir is directory
+     * @throws IOException depends on the destination (<var>out</var>).
+     */
+    public static void writeHAD(Writer out, String ctxE, String entry,
+        boolean is_dir) throws IOException {
+
+        String histPrefixE = ctxE + Prefix.HIST_L;
+        String downloadPrefixE = ctxE + Prefix.DOWNLOAD_P;
+        String xrefPrefixE = ctxE + Prefix.XREF_P;
+
+        out.write("<td class=\"q\"><a href=\"");
+        out.write(histPrefixE);
+        out.write(entry);
+        out.write("\" title=\"History\">H</a>");
+
+        if (!is_dir) {
+            out.write(" <a href=\"");
+            out.write(xrefPrefixE);
+            out.write(entry);
+            out.write("?a=true\" title=\"Annotate\">A</a> ");
+            out.write("<a href=\"");
+            out.write(downloadPrefixE);
+            out.write(entry);
+            out.write("\" title=\"Download\">D</a>");
+        }
+
+        out.write("</td>");
+    }
+
     /**
      * wrapper arround UTF-8 URL encoding of a string
      *
@@ -675,11 +716,6 @@ public static String formQuoteEscape(String q) {
         return sb.toString();
     }
 
-    private static final String SPAN_D = "<span class=\"d\">";
-    private static final String SPAN_A = "<span class=\"a\">";
-    private static final String SPAN_E = "</span>";
-    private static final int SPAN_LEN = SPAN_D.length() + SPAN_E.length();
-
     /**
      * Tag changes in the given <var>line1</var> and <var>line2</var>
      * for highlighting. Removed parts are tagged with CSS class {@code d},

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

@@ -32,6 +32,8 @@
 import javax.servlet.ServletContext;
 import javax.servlet.ServletContextEvent;
 import javax.servlet.ServletContextListener;
+import javax.servlet.ServletRequestEvent;
+import javax.servlet.ServletRequestListener;
 import org.opensolaris.opengrok.OpenGrokLogger;
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
 
@@ -40,7 +42,8 @@
  *
  * @author Trond Norbye
  */
-public final class WebappListener implements ServletContextListener {
+public final class WebappListener
+    implements ServletContextListener, ServletRequestListener {
 
     @Override
     public void contextInitialized(final ServletContextEvent servletContextEvent) {
@@ -86,4 +89,20 @@ public void contextInitialized(final ServletContextEvent servletContextEvent) {
     public void contextDestroyed(final ServletContextEvent servletContextEvent) {
         RuntimeEnvironment.getInstance().stopConfigurationListenerThread();
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void requestDestroyed(ServletRequestEvent e) {
+        PageConfig.cleanup(e.getServletRequest());
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void requestInitialized(ServletRequestEvent e) {
+        // pass through
+    }
 }

test/org/opensolaris/opengrok/web/DirectoryListingTest.java

@@ -200,15 +200,15 @@ private void validateEntry(Element element) throws Exception {
         FileEntry entry = new FileEntry();
         NodeList nl = element.getElementsByTagName("td");
         int len = nl.getLength();
-        if (len < 4) {
+        if (len < 5) {
             return;
         }
-        assertEquals(4, len);
+        assertEquals(5, len);
 
         // item(0) is a decoration placeholder, i.e. no content
         entry.name = getFilename(nl.item(1));
-        entry.lastModified = getLastModified(nl.item(2));
-        entry.size = getSize(nl.item(3));
+        entry.lastModified = getLastModified(nl.item(3));
+        entry.size = getSize(nl.item(4));
 
         // Try to look it up in the list of files
         for (int ii = 0; ii < entries.length; ++ii) {
@@ -232,7 +232,7 @@ public void directoryListing() throws Exception {
         out.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<start>\n");
 
         DirectoryListing instance = new DirectoryListing();
-        instance.listTo(directory, out, directory.getPath(),
+        instance.listTo("ctx", directory, out, directory.getPath(),
                         Arrays.asList(directory.list()));
 
         DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();