Merge pull request #1342 from vladak/body_include

make index_body.html an include like {header,footer}_include

Author: Vladimir Kotal

README.txt

@@ -420,14 +420,16 @@ web.xml of source.war file and change them (see note1) appropriately.
     * DATA_ROOT: absolute path of the directory where OpenGrok data
                  files are stored
 
-  - Header file 'header_include' can be created under DATA_ROOT.
-    The contents of this file file will be appended to the header of each
+  - File 'header_include' can be created under DATA_ROOT.
+    The contents of this file will be appended to the header of each
     web page after the OpenGrok logo element.
-  - Footer file 'footer_include' can be created under DATA_ROOT.
-    The contents of this file file will be appended to the footer of each
+  - File 'footer_include' can be created under DATA_ROOT.
+    The contents of this file will be appended to the footer of each
     web page after the information about last index update.
-  - The body of the home page can be changed by updating index_body.html
-    under the webapp directory.
+  - The file 'body_include' can be created under DATA_ROOT.
+    The contents of this file will be inserted above the footer of the web
+    application's "Home" page.
+
 
 5.4.3 - Path Descriptions (optional)
 ------------------------------------

build.xml

@@ -958,7 +958,6 @@ Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
             <fileset dir="${web.src.dir}">
                 <include name="**/*.jsp"/>
                 <include name="**/*.jspf"/>
-                <include name="**/index_body.html"/>
             </fileset>
         </copy>
         <jasper validateXml="false"

doc/EXAMPLE.txt

@@ -34,16 +34,15 @@ SRC_ROOT=/opengrok/source
 DATA_ROOT=/opengrok/data
 EXUB_CTAGS=/absolute/path/to/Exubrant/Ctags
 
-The last thing we need to do is to configure the web application. To do so, 
+The last thing we need to do is to configure the web application. To do so,
 please execute the following commands:
 $ mkdir /opengrok/web/source
 $ cd /opengrok/web/source
 $ unzip /path/to/opengrok-release/source.war
 
 edit WEB-INF/web.xml and specify SRC_ROOT and DATA_ROOT.
 
-You may also want to modify the file index_body.html before you re-create
-the war-file with the following commands:
+re-create the war-file with the following commands:
 
 $ cd /opengrok/web/source
 $ zip -r /opengrok/web/source.war

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

@@ -17,8 +17,8 @@
  * CDDL HEADER END
  */
 
- /*
- * Copyright (c) 2007, 2016, Oracle and/or its affiliates. All rights reserved.
+/*
+ * Copyright (c) 2007, 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opensolaris.opengrok.configuration;
 
@@ -826,6 +826,7 @@ private static String getFileContent(File file) {
      *
      * @return an empty string if it could not be read successfully, the
      * contents of the file otherwise.
+     * @see #FOOTER_INCLUDE_FILE
      */
     public String getFooterIncludeFileContent() {
         if (footer == null) {
@@ -847,6 +848,7 @@ public String getFooterIncludeFileContent() {
      *
      * @return an empty string if it could not be read successfully, the
      * contents of the file otherwise.
+     * @see #HEADER_INCLUDE_FILE
      */
     public String getHeaderIncludeFileContent() {
         if (header == null) {
@@ -855,6 +857,27 @@ public String getHeaderIncludeFileContent() {
         return header;
     }
 
+    /**
+     * The name of the file relative to the <var>DATA_ROOT</var>, which should
+     * be included into the body of web app's "Home" page.
+     */
+    public static final String BODY_INCLUDE_FILE = "body_include";
+
+    private transient String body = null;
+
+    /**
+     * Get the contents of the body include file.
+     * @return an empty string if it could not be read successfully, the
+     *  contents of the file otherwise.
+     *  @see Configuration#BODY_INCLUDE_FILE
+     */
+    public String getBodyIncludeFileContent() {
+        if (body == null) {
+            body = getFileContent(new File(getDataRoot(), BODY_INCLUDE_FILE));
+        }
+        return body;
+    }
+
     /**
      * Get the eftar file, which contains definition tags.
      *

web/index.jsp

@@ -47,11 +47,9 @@ include file="menu.jspf"
 
             %></div>
         </div>
-        <div id="results"><%@
-
-include file="index_body.html"
-
-        %>
+        <div id="results">
+        <%= cfg.getEnv().getConfiguration().getBodyIncludeFileContent() %>
+        </div>
         <%@
 
 include file="repos.jspf"