Add possibility to include text from http_header_include file into the HTTP header

fixes #2071

Author: AlexandrSergei4

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/Configuration.java

@@ -20,6 +20,7 @@
 /*
  * Copyright (c) 2007, 2018, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017-2019, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2020, Aleksandr Kirillov <[email protected]>.
  */
 package org.opengrok.indexer.configuration;
 
@@ -1165,6 +1166,13 @@ public void setListDirsFirst(boolean flag) {
      */
     public static final String E_FORBIDDEN_INCLUDE_FILE = "error_forbidden_include";
 
+
+    /**
+     * The name of the file relative to the <var>DATA_ROOT</var>, which should
+     * be included into the HTTP header of generated web pages.
+     */
+    public static final String HTTP_HEADER_INCLUDE_FILE = "http_header_include";
+
     /**
      * @return path to the file holding compiled path descriptions for the web application
      */

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/IncludeFiles.java

@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2020, Aleksandr Kirillov <[email protected]>.
  */
 
 package org.opengrok.indexer.configuration;
@@ -36,6 +37,7 @@ public void reloadIncludeFiles() {
         getHeaderIncludeFileContent(true);
         getFooterIncludeFileContent(true);
         getForbiddenIncludeFileContent(true);
+        getHttpHeaderIncludeFileContent(true);
     }
 
     private transient String footer = null;
@@ -110,4 +112,22 @@ public String getForbiddenIncludeFileContent(boolean force) {
         }
         return eforbidden_content;
     }
+
+    private transient String http_header = null;
+
+    /**
+     * Get the contents of the HTTP header include file.
+     *
+     * @param force if true, reload even if already set
+     * @return an empty string if it could not be read successfully, the
+     * contents of the file otherwise.
+     * @see Configuration#HTTP_HEADER_INCLUDE_FILE
+     */
+    public String getHttpHeaderIncludeFileContent(boolean force) {
+        if (http_header == null || force) {
+            http_header = getFileContent(new File(RuntimeEnvironment.getInstance().getIncludeRootPath(),
+                    Configuration.HTTP_HEADER_INCLUDE_FILE));
+        }
+        return http_header;
+    }
 }

opengrok-indexer/src/test/java/org/opengrok/indexer/configuration/IncludeFilesTest.java

@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2020, Aleksandr Kirillov <[email protected]>.
  */
 package org.opengrok.indexer.configuration;
 
@@ -100,4 +101,15 @@ public void testGetForbiddenIncludeFileContent() throws IOException {
         assertEquals(CONTENT_2 + LINE_SEP,
                 env.includeFiles.getForbiddenIncludeFileContent(true));
     }
+
+    @Test
+    public void testGetHttpHeaderIncludeFileContent() throws IOException {
+        File file = new File(includeRoot.toFile(), Configuration.HTTP_HEADER_INCLUDE_FILE);
+        writeStringToFile(file, CONTENT_1);
+        assertEquals(CONTENT_1 + LINE_SEP,
+                env.includeFiles.getHttpHeaderIncludeFileContent(false));
+        writeStringToFile(file, CONTENT_2);
+        assertEquals(CONTENT_2 + LINE_SEP,
+                env.includeFiles.getHttpHeaderIncludeFileContent(true));
+    }
 }

opengrok-web/src/main/webapp/httpheader.jspf

@@ -21,6 +21,7 @@ CDDL HEADER END
 Copyright (c) 2007, 2019, Oracle and/or its affiliates. All rights reserved.
 Portions Copyright 2011 Jens Elkner.
 Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
+Portions Copyright (c) 2020, Aleksandr Kirillov <[email protected]>.
 
 --%><%--
 
@@ -98,6 +99,7 @@ if (cfg.getPrefix().equals(Prefix.HIST_L)) {
     document.domReady = [];
 /* ]]> */
 </script>
+<%= cfg.getEnv().getIncludeFiles().getHttpHeaderIncludeFileContent(false) %>
 <title><%=cfg.getTitle()%></title><%
     out.write(cfg.getHeaderData());
 %>