From c65bda32f59601f1ea2384f64536fe4ab23c5796 Mon Sep 17 00:00:00 2001
From: mazano <addloe@gmail.com>
Date: Sat, 17 Feb 2024 08:51:48 +0200
Subject: [PATCH] Hazelcast caching with jdbc (#623)

* fix hazelcast
---
 .../hazelcast_cluster/cluster.properties      |  12 +
 build_data/hazelcast_cluster/hazelcast.xml    |  43 +++
 build_data/hazelcast_cluster/web.xml          | 262 ++++++++++++++++++
 scripts/entrypoint.sh                         |   6 +-
 scripts/functions.sh                          |  71 +++--
 5 files changed, 374 insertions(+), 20 deletions(-)
 create mode 100644 build_data/hazelcast_cluster/cluster.properties
 create mode 100644 build_data/hazelcast_cluster/hazelcast.xml
 create mode 100644 build_data/hazelcast_cluster/web.xml

diff --git a/build_data/hazelcast_cluster/cluster.properties b/build_data/hazelcast_cluster/cluster.properties
new file mode 100644
index 00000000..86f20e57
--- /dev/null
+++ b/build_data/hazelcast_cluster/cluster.properties
@@ -0,0 +1,12 @@
+enabled = true
+sync_method = event
+sync_delay = 5
+session_sharing = true
+session_sticky = false
+acktimeout = 2000
+#Disabling the hazelcast shutdown hook
+shutdown_hook_enable = false
+#Setting the hazelcast logging type to log4j
+logging_type = "log4j"
+logger.com-hazelcast.name = com.hazelcast
+logger.com-hazelcast.level = INFO
\ No newline at end of file
diff --git a/build_data/hazelcast_cluster/hazelcast.xml b/build_data/hazelcast_cluster/hazelcast.xml
new file mode 100644
index 00000000..4cd810c1
--- /dev/null
+++ b/build_data/hazelcast_cluster/hazelcast.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- 
+Configure Hazelcast for clustering GeoServer's catalog and web sessions 
+For more information, see:
+https://docs.hazelcast.com/hazelcast/5.3/configuration/configuring-declaratively
+-->
+<hazelcast xmlns="http://www.hazelcast.com/schema/config"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://www.hazelcast.com/schema/config
+                               https://hazelcast.com/schema/config/hazelcast-config-5.3.xsd">
+  <cluster-name>geoserver-cluster</cluster-name>
+  <instance-name>${INSTANCE_STRING}</instance-name>
+
+  <!--
+     Make Hazelcast use log4j2 just like GeoServer. Remember to add
+     a Logger for com.hazelcast with the appropriate logging level
+     in the geoserver logging configuration to see Hazelcast log messages
+  -->
+  <properties>
+    <property name="hazelcast.logging.type">log4j2</property>
+  </properties>
+
+  <!-- Network section, by default it enables multicast, tune it to use tcp in case
+    multicast is not allowed, and list the nodes that make up a reasonable core of the
+    cluster (e.g., machines that will never be all down at the same time) -->
+  <network>
+    <port auto-increment="true">5701</port>
+    <join>
+      <multicast enabled="true">
+        <multicast-group>224.2.2.3</multicast-group>
+        <multicast-port>54327</multicast-port>
+      </multicast>
+      <tcp-ip enabled="false">
+        <interface>127.0.0.1</interface>
+      </tcp-ip>
+      <aws enabled="false">
+        <access-key>my-access-key</access-key>
+        <secret-key>my-secret-key</secret-key>
+        <region>us-east-1</region>
+      </aws>
+    </join>
+  </network>
+</hazelcast>
diff --git a/build_data/hazelcast_cluster/web.xml b/build_data/hazelcast_cluster/web.xml
new file mode 100644
index 00000000..fcf9ef4b
--- /dev/null
+++ b/build_data/hazelcast_cluster/web.xml
@@ -0,0 +1,262 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
+<web-app>
+    <display-name>GeoServer</display-name>
+  
+      <context-param>
+    <param-name>serviceStrategy</param-name>
+    <!-- Meaning of the different values :
+         
+         PARTIAL-BUFFER2
+         - Partially buffers the first xKb to disk. Once that has buffered, the the 
+           result is streamed to the user. This will allow for most errors to be caught
+           early. 
+           
+         BUFFER
+         - stores the entire response in memory first, before sending it off to
+           the user (may run out of memory)
+
+         SPEED
+         - outputs directly to the response (and cannot recover in the case of an
+           error)
+
+         FILE
+         - outputs to the local filesystem first, before sending it off to the user
+      -->
+    <param-value>PARTIAL-BUFFER2</param-value>
+  </context-param>
+  
+  <!-- If true, enable versioning datastore as well -->
+  <context-param>
+    <param-name>enableVersioning</param-name>
+    <param-value>true</param-value>
+  </context-param>
+  
+  <context-param>
+    <!-- see comments on the PARTIAL-BUFFER strategy -->
+    <!-- this sets the size of the buffer.  default is "50" = 50kb -->
+
+    <param-name>PARTIAL_BUFFER_STRATEGY_SIZE</param-name>
+    <param-value>50</param-value>
+  </context-param>
+  
+    <!-- 
+    <context-param>
+      <param-name>PROXY_BASE_URL</param-name>
+      <param-value>http://82.58.146.45/geoserver</param-value>
+    </context-param>
+     -->
+   
+     <!--
+    <context-param>
+       <param-name>GEOSERVER_DATA_DIR</param-name>
+        <param-value>C:\eclipse\workspace\geoserver_trunk\cite\confCiteWFSPostGIS</param-value>
+    </context-param> 
+   -->
+    
+    <!-- pick up all spring application contexts -->
+    <context-param>
+        <param-name>contextConfigLocation</param-name>
+        <param-value>classpath*:/applicationContext.xml classpath*:/applicationSecurityContext.xml</param-value>
+    </context-param>
+    
+    <!-- This needs to be the first filter -->
+    <filter>
+        <filter-name>hazelcast</filter-name>
+        <filter-class>org.geoserver.cluster.hazelcast.web.HzSessionShareFilter</filter-class>
+    </filter>
+
+    <filter>
+     <filter-name>SessionDebugger</filter-name>
+     <filter-class>org.geoserver.filters.SessionDebugFilter</filter-class>
+    </filter>
+
+    <filter>
+    <filter-name>filterChainProxy</filter-name>     
+     <filter-class> org.springframework.web.filter.DelegatingFilterProxy</filter-class>
+     
+<!-- <filter-name>Spring Security Filter Chain Proxy</filter-name> 
+    <init-param>
+       <param-name>targetClass</param-name>
+       <param-value>org.springframework.security.util.FilterChainProxy</param-value>
+     </init-param>
+-->
+    </filter>
+    
+   <filter>
+    <filter-name>Set Character Encoding</filter-name>
+    <filter-class>org.vfny.geoserver.filters.SetCharacterEncodingFilter</filter-class>
+    <init-param>
+      <param-name>encoding</param-name>
+      <param-value>UTF-8</param-value>
+    </init-param>
+  </filter>
+
+   <filter>
+     <filter-name>GZIP Compression Filter</filter-name>
+     <filter-class>org.geoserver.filters.GZIPFilter</filter-class>
+     <init-param>
+         <!-- The compressed-types parameter is a comma-separated list of regular expressions.
+              If a mime type matches any of the regular expressions then it will be compressed.
+              -->
+         <param-name>compressed-types</param-name>
+         <param-value>text/.*,.*xml.*,application/json,application/x-javascript</param-value>
+     </init-param>
+   </filter>
+
+   <filter>
+     <filter-name>Request Logging Filter</filter-name>
+     <filter-class>org.geoserver.filters.LoggingFilter</filter-class>
+     <init-param>
+         <!-- The 'enabled' parameter is a boolean value, "true" (case-insensitive) for true or
+              any other value for false.  If enabled, then the logging will be performed;
+              otherwise the logging filter will have no effect.  If not specified, this 
+              parameter defaults to false.
+              -->
+         <param-name>enabled</param-name>
+         <param-value>false</param-value>
+     </init-param>
+     <init-param>
+     <!-- The 'log-request-bodies' parameter is a boolean value, "true" (case-insensitive) for
+          true or any other value for false.  If enabled, then the logging will include the body
+          of POST and PUT requests.  If not specified, this parameter defaults to false.
+          Note that this may noticeably degrade responsiveness of your geoserver since it will
+          not begin to process requests until the entire request body has been received by the 
+          server.
+          -->
+     <param-name>log-request-bodies</param-name>
+     <param-value>false</param-value>
+     </init-param>
+   </filter>
+   
+   <filter>
+     <filter-name>Advanced Dispatch Filter</filter-name>
+     <filter-class>org.geoserver.platform.AdvancedDispatchFilter</filter-class>
+     <!-- 
+     This filter allows for a single mapping to the spring dispatcher. However using /* as a mapping
+     in a servlet mapping causes the servlet path to be "/" of the request. This causes problems with
+     library like wicket and restlet. So this filter fakes the servlet path by assuming the first 
+     component of the path is the mapped path. 
+     -->
+   </filter>
+   
+   <filter>
+    <filter-name>Spring Delegating Filter</filter-name>
+    <filter-class>org.geoserver.filters.SpringDelegatingFilter</filter-class>
+    <!--
+    This filter allows for filters to be loaded via spring rather than 
+    registered here in web.xml.  One thing to note is that for such filters 
+    init() is not called. INstead any initialization is performed via spring 
+    ioc.
+    -->
+   </filter>
+   
+   <filter>
+     <filter-name>Thread locals cleanup filter</filter-name>
+     <filter-class>org.geoserver.filters.ThreadLocalsCleanupFilter</filter-class>
+     <!-- 
+     This filter cleans up thread locals Geotools is setting up for concurrency and performance
+     reasons 
+     -->
+   </filter>
+
+    <filter-mapping>
+      <filter-name>hazelcast</filter-name>
+      <url-pattern>/*</url-pattern>
+    </filter-mapping>
+
+    <filter-mapping>
+      <filter-name>SessionDebugger</filter-name>
+      <url-pattern>/*</url-pattern>
+    </filter-mapping>
+
+    <filter-mapping>
+      <filter-name>GZIP Compression Filter</filter-name>
+      <url-pattern>/*</url-pattern>
+    </filter-mapping>
+    
+    <filter-mapping>
+      <filter-name>Request Logging Filter</filter-name>
+      <url-pattern>/*</url-pattern>
+    </filter-mapping>
+   
+    <!-- 
+      If you want to use your security system comment out this one too
+    -->
+    <filter-mapping>
+      <filter-name>filterChainProxy</filter-name>
+      <url-pattern>/*</url-pattern>
+    </filter-mapping>
+    
+      <filter-mapping>
+      <filter-name>Set Character Encoding</filter-name>
+      <url-pattern>/*</url-pattern>
+    </filter-mapping>
+    
+    <filter-mapping>
+      <filter-name>Advanced Dispatch Filter</filter-name>
+      <url-pattern>/*</url-pattern>
+    </filter-mapping>
+
+    <filter-mapping>
+      <filter-name>Spring Delegating Filter</filter-name>
+      <url-pattern>/*</url-pattern>
+    </filter-mapping>
+    
+    <filter-mapping>
+      <filter-name>Thread locals cleanup filter</filter-name>
+      <url-pattern>/*</url-pattern>
+    </filter-mapping>
+
+    <!-- hazelcast session listener -->
+    <listener>
+      <listener-class>org.geoserver.cluster.hazelcast.web.HzSessionShareListener</listener-class>
+    </listener>
+    
+    <!-- general initializer, should be first thing to execute -->
+    <listener>
+      <listener-class>org.geoserver.GeoserverInitStartupListener</listener-class>
+    </listener>
+    
+    <!-- logging initializer, should execute before spring context startup -->
+    <listener>
+      <listener-class>org.geoserver.logging.LoggingStartupContextListener</listener-class>
+    </listener>
+  
+    <!--  spring context loader -->
+    <listener>
+      <listener-class>org.geoserver.platform.GeoServerContextLoaderListener</listener-class>
+    </listener>
+    
+    <!--  http session listener proxy -->
+    <listener>
+      <listener-class>org.geoserver.platform.GeoServerHttpSessionListenerProxy</listener-class>
+    </listener>
+    
+    <!-- spring dispatcher servlet, dispatches all incoming requests -->
+    <servlet>
+      <servlet-name>dispatcher</servlet-name>
+      <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
+    </servlet>
+    
+    <!-- single mapping to spring, this only works properly if the advanced dispatch filter is 
+         active -->
+    <servlet-mapping>
+        <servlet-name>dispatcher</servlet-name>
+        <url-pattern>/*</url-pattern>
+    </servlet-mapping>
+    
+    <mime-mapping>
+      <extension>xsl</extension>
+      <mime-type>text/xml</mime-type>
+    </mime-mapping>
+    <mime-mapping>
+      <extension>sld</extension>
+      <mime-type>text/xml</mime-type>
+    </mime-mapping>
+  
+    <welcome-file-list>
+        <welcome-file>index.html</welcome-file>
+    </welcome-file-list>
+    
+</web-app>
diff --git a/scripts/entrypoint.sh b/scripts/entrypoint.sh
index f5ed472e..625f2136 100644
--- a/scripts/entrypoint.sh
+++ b/scripts/entrypoint.sh
@@ -117,9 +117,13 @@ if [[ ${RUN_AS_ROOT} =~ [Ff][Aa][Ll][Ss][Ee] ]];then
     chown -R "${USER_NAME}":"${GEO_GROUP_NAME}" "${GEOSERVER_DATA_DIR}"/jdbcconfig
   fi
 
-  if [[ -d "${GEOSERVER_DATA_DIR}"/jdbcconfig ]];then
+  if [[ -d "${GEOSERVER_DATA_DIR}"/jdbcstore ]];then
     chown -R "${USER_NAME}":"${GEO_GROUP_NAME}" "${GEOSERVER_DATA_DIR}"/jdbcstore
   fi
+  # hazel cluster
+  if [[ -d "${GEOSERVER_DATA_DIR}"/cluster ]];then
+    chown -R "${USER_NAME}":"${GEO_GROUP_NAME}" "${GEOSERVER_DATA_DIR}"/cluster
+  fi
 fi
 
 
diff --git a/scripts/functions.sh b/scripts/functions.sh
index c0cb8426..62eda5f8 100644
--- a/scripts/functions.sh
+++ b/scripts/functions.sh
@@ -578,15 +578,20 @@ function setup_jdbc_db_config() {
             PGPASSWORD="${POSTGRES_PASS}"
             export PGPASSWORD
             postgres_ready_status "${HOST}" "${POSTGRES_PORT}" "${POSTGRES_USER}" "$POSTGRES_DB"
-            if [[ -d "${GEOSERVER_DATA_DIR}"/jdbcconfig ]];then
-              rm -r "${GEOSERVER_DATA_DIR}"/jdbcconfig
-            else
-              create_dir "${GEOSERVER_DATA_DIR}"/jdbcconfig
-            fi
-            cp -r /build_data/jdbcconfig/scripts/ "${GEOSERVER_DATA_DIR}"/jdbcconfig
+            create_dir "${GEOSERVER_DATA_DIR}"/jdbcconfig
+            cp -r /build_data/jdbcconfig/scripts "${GEOSERVER_DATA_DIR}"/jdbcconfig/
             postgres_ssl_setup
             export SSL_PARAMETERS=${PARAMS}
-            envsubst < /build_data/jdbcconfig/jdbcconfig.properties > "${GEOSERVER_DATA_DIR}"/jdbcconfig/jdbcconfig.properties
+            if [[ -f "${EXTRA_CONFIG_DIR}"/jdbcconfig.properties ]]; then
+              envsubst < "${EXTRA_CONFIG_DIR}"/jdbcconfig.properties > "${GEOSERVER_DATA_DIR}"/jdbcconfig/jdbcconfig.properties
+            else
+              envsubst < /build_data/jdbcconfig/jdbcconfig.properties > "${GEOSERVER_DATA_DIR}"/jdbcconfig/jdbcconfig.properties
+            fi
+            check_jdbc_config_table=$(psql -d "$POSTGRES_DB" -p "$POSTGRES_PORT" -U "$POSTGRES_USER" -h "$HOST" -tAc "SELECT EXISTS(SELECT 1 FROM information_schema.tables WHERE table_name = 'object_property')")
+            if [[  ${check_jdbc_config_table} = "t" ]]; then
+              sed -i 's/initdb=true/initdb=false/g' "${GEOSERVER_DATA_DIR}"/jdbcconfig/jdbcconfig.properties
+              sed -i 's/import=true/import=false/g' "${GEOSERVER_DATA_DIR}"/jdbcconfig/jdbcconfig.properties
+            fi
         else
             echo "skipping jdbc config and will use default settings"
         fi
@@ -600,24 +605,52 @@ function setup_jdbc_db_store() {
         export PGPASSWORD
         postgres_ready_status "${HOST}" "${POSTGRES_PORT}" "${POSTGRES_USER}" "$POSTGRES_DB"
         if [[  ${DB_BACKEND} =~ [Pp][Oo][Ss][Tt][Gg][Rr][Ee][Ss] ]]; then
-            if [[ -d "${GEOSERVER_DATA_DIR}"/jdbcstore ]];then
-              rm -r "${GEOSERVER_DATA_DIR}"/jdbcstore
+            create_dir "${GEOSERVER_DATA_DIR}"/jdbcstore
+            create_dir "${GEOSERVER_DATA_DIR}"/jdbcconfig
+            cp -r /build_data/jdbcstore/scripts "${GEOSERVER_DATA_DIR}"/jdbcstore/
+            cp -r /build_data/jdbcconfig/scripts "${GEOSERVER_DATA_DIR}"/jdbcconfig/
+            postgres_ssl_setup
+            export SSL_PARAMETERS=${PARAMS}
+            if [[ -f "${EXTRA_CONFIG_DIR}"/jdbcconfig.properties ]]; then
+              envsubst < "${EXTRA_CONFIG_DIR}"/jdbcconfig.properties > "${GEOSERVER_DATA_DIR}"/jdbcconfig/jdbcconfig.properties
             else
-              create_dir "${GEOSERVER_DATA_DIR}"/jdbcstore
+              envsubst < /build_data/jdbcconfig/jdbcconfig.properties > "${GEOSERVER_DATA_DIR}"/jdbcconfig/jdbcconfig.properties
             fi
-            if [[ -d "${GEOSERVER_DATA_DIR}"/jdbcconfig ]];then
-              rm -r "${GEOSERVER_DATA_DIR}"/jdbcconfig
+            if [[ -f "${EXTRA_CONFIG_DIR}"/jdbcstore.properties ]]; then
+              envsubst < "${EXTRA_CONFIG_DIR}"/jdbcstore.properties > "${GEOSERVER_DATA_DIR}"/jdbcstore/jdbcstore.propertiesproperties
             else
-              create_dir "${GEOSERVER_DATA_DIR}"/jdbcconfig
+              envsubst < /build_data/jdbcstore/jdbcstore.properties > "${GEOSERVER_DATA_DIR}"/jdbcstore/jdbcstore.propertiesproperties
+            fi
+
+            check_jdbc_store_table=$(psql -d "$POSTGRES_DB" -p "${POSTGRES_PORT}" -U "${POSTGRES_USER}" -h "${HOST}" -tAc "SELECT EXISTS(SELECT 1 from information_schema.tables where table_name = 'resources')")
+            if [[  ${check_jdbc_store_table} = "t" ]]; then
+              sed -i 's/initdb=true/initdb=false/g' "${GEOSERVER_DATA_DIR}"/jdbcstore/jdbcstore.properties
+              sed -i 's/import=true/import=false/g' "${GEOSERVER_DATA_DIR}"/jdbcstore/jdbcstore.properties
+            fi
+            check_jdbc_config_table=$(psql -d "$POSTGRES_DB" -p "$POSTGRES_PORT" -U "$POSTGRES_USER" -h "$HOST" -tAc "SELECT EXISTS(SELECT 1 FROM information_schema.tables WHERE table_name = 'object_property')")
+            if [[  ${check_jdbc_config_table} = "t" ]]; then
+              sed -i 's/initdb=true/initdb=false/g' "${GEOSERVER_DATA_DIR}"/jdbcconfig/jdbcconfig.properties
+              sed -i 's/import=true/import=false/g' "${GEOSERVER_DATA_DIR}"/jdbcconfig/jdbcconfig.properties
             fi
-            cp -r /build_data/jdbcstore/scripts/ "${GEOSERVER_DATA_DIR}"/jdbcstore
-            cp -r /build_data/jdbcconfig/scripts/ "${GEOSERVER_DATA_DIR}"/jdbcconfig
-            postgres_ssl_setup
-            export SSL_PARAMETERS=${PARAMS}
-            envsubst < /build_data/jdbcconfig/jdbcconfig.properties > "${GEOSERVER_DATA_DIR}"/jdbcconfig/jdbcconfig.properties
-            envsubst < /build_data/jdbcstore/jdbcstore.properties > "${GEOSERVER_DATA_DIR}"/jdbcstore/jdbcstore.properties
         else
           echo "skipping jdbc store config and will use default settings"
         fi
     fi
+}
+
+function setup_hz_cluster() {
+    # TODO Add http://og.cens.am:8081/opengeo-docs/sysadmin/clustering/setup.html#session-sharing
+    if [[ ${ext} == 'hz-cluster-plugin' ]];then
+        create_dir "${GEOSERVER_DATA_DIR}"/cluster
+        if [[ -f "${EXTRA_CONFIG_DIR}"/hazelcast_cluster.properties ]]; then
+          envsubst < "${EXTRA_CONFIG_DIR}"/hazelcast_cluster.properties > "${GEOSERVER_DATA_DIR}"/cluster/cluster.properties
+        else
+          envsubst < /build_data/hazelcast_cluster/cluster.properties > "${GEOSERVER_DATA_DIR}"/cluster/cluster.properties
+        fi
+        if [[ -f "${EXTRA_CONFIG_DIR}"/hazelcast.xml ]]; then
+          envsubst < "${EXTRA_CONFIG_DIR}"/hazelcast.xml > "${GEOSERVER_DATA_DIR}"/cluster/hazelcast.xml
+        else
+          envsubst < /build_data/hazelcast_cluster/hazelcast.xml > "${GEOSERVER_DATA_DIR}"/cluster/hazelcast.xml
+        fi
+    fi
 }
\ No newline at end of file