Changeset 32429 for main/trunk/greenstone3/src/java/org/greenstone/util/GlobalProperties.java

Timestamp:

2018-09-06T22:32:58+12:00 (6 years ago)

Author:

ak19

Message:

solr should only be accessible locally (from localhost, specifically 127.0.0.1) which means over http. This conflicted with the previous design of the properties file for working with http and/or https. Now we have tomcat.port.https and localhost.port.http, both always set. In place of server.protocol that used to contain the default protocol, we now have server.protocols which can be set to a comma separated list of one or both of http and https. Drastic restructuring followed. I think I've tested all but https certification stuff.

File:

• main/trunk/greenstone3/src/java/org/greenstone/util/GlobalProperties.java (modified) (6 diffs)

main/trunk/greenstone3/src/java/org/greenstone/util/GlobalProperties.java

@@ -38 +38 @@
     private static String gsdl3_writablehome = null;
     private static String gsdl3_web_address = null;
-    private static String full_gsdl3_web_address = null;
-
-    private static String http_full_gsdl3_web_address = null;
-    private static String https_full_gsdl3_web_address = null;
+    private static String full_gsdl3_web_address = null; // for the default protocol
+
+    private static String http_full_gsdl3_web_address = null; // if http or both protocols supported
+    private static String https_full_gsdl3_web_address = null; // if https or both protocols supported
+
+    // The locally accessible url such as for solr is always available at http://127.0.0.1:<httpPort>
+    // regardless of whether http is listed as one of the server protocols
+    private static String localhost_http_web_address = null;
 
     /** get the value of the property 'key'. returns null if not found */
@@ -81 +85 @@
     {
         return full_gsdl3_web_address;
+    }
+
+    public static String getLocalHttpBaseAddress()
+    {
+        return localhost_http_web_address;
     }
 
@@ -155 +164 @@
             String protocolSpecifier = null, hostSpecifier = null, portSpecifier = null, contextSpecifier = null;
 
-            //protocol
+            // default protocol
             protocolSpecifier = properties.getProperty("server.protocol");
             if (protocolSpecifier == null || protocolSpecifier.equals(""))
@@ -180 +189 @@
             }
 
-            //port
+            //default port (port for the default protocol)
             portSpecifier = properties.getProperty("tomcat.port"); // support for legacy tomcat.port?
-            if(portSpecifier == null) {
-                portSpecifier = protocolSpecifier.startsWith("https") ? properties.getProperty("tomcat.port.https") : properties.getProperty("tomcat.port.http");
-            }
             if (portSpecifier == null || portSpecifier.equals("") 
                 || (protocolSpecifier.equals("http://") && portSpecifier.equals("80"))
@@ -214 +220 @@
             gsdl3_web_address = contextSpecifier;
 
+            // Set the always available internal root address that is locally accessible (http://127.0.0.1:<httpPort>)
+            // Used by solr. 
+            String httpPort = properties.getProperty("localhost.port.http");
+            localhost_http_web_address = properties.getProperty("localhost.protocol.http") + "://"
+                + properties.getProperty("localhost.server.http") // always uses 127.0.0.1 (not localhost, which can be modified and is therefore unsafe!)
+                + httpPort;
+
+
+
             // set the http and https variants of the full web address, if they're meant to be available
-            if(protocolSpecifier.startsWith("https")) { // check the default protocol, then set the address for the other protocol too
+            // First check the default protocol, then set the web address for the other protocol too
+            String supportedProtocols = properties.getProperty("server.protocols", "http");
+            String isHttpRestrictedToLocal = properties.getProperty("restrict.http.to.local", "true");
+
+            if(protocolSpecifier.startsWith("https")) {
                 https_full_gsdl3_web_address = full_gsdl3_web_address;
 
-                // and set http version, if sufficient properties are available
-                String httpPort = properties.getProperty("tomcat.port.http");
-                if(httpPort != null && !httpPort.equals("")) {
+                // and set http version of URL, if http is made public (if http is in server.protocols list)
+                if(isHttpRestrictedToLocal.equals("false")) {               
                 http_full_gsdl3_web_address = "http://" + hostSpecifier + httpPort + contextSpecifier;
                 }
@@ -226 +244 @@
                 http_full_gsdl3_web_address = full_gsdl3_web_address;
 
-                // and set https version, if sufficient properties are available
-                String httpsPort = properties.getProperty("tomcat.port.https");
-                if(httpsPort != null && !httpsPort.equals("")) {
+                // and set https version, if https enabled
+                if(supportedProtocols.contains("https")) {
+                String httpsPort = properties.getProperty("tomcat.port.https");
                 https_full_gsdl3_web_address = "https://" + hostSpecifier + httpsPort + contextSpecifier;
                 }