Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Backport 2.23.x] [GEOS-11074] GeoFence may not load property file at boot #7084

Merged
merged 1 commit into from
Aug 18, 2023
Merged

[Backport 2.23.x] [GEOS-11074] GeoFence may not load property file at boot #7084

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
167 changes: 136 additions & 31 deletions ...ce/geofence/src/main/java/org/geoserver/geofence/config/GeoFenceConfigurationManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,18 @@
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.apache.commons.lang3.BooleanUtils;
import org.geoserver.geofence.GeofenceAccessManager;
import org.geoserver.geofence.cache.CacheConfiguration;
import org.geoserver.platform.resource.Resource;
import org.geotools.util.logging.Logging;
import org.springframework.beans.factory.InitializingBean;

/** @author ETj (etj at geo-solutions.it) */
public class GeoFenceConfigurationManager {
public class GeoFenceConfigurationManager implements InitializingBean {

private static final Logger LOGGER = Logging.getLogger(GeofenceAccessManager.class);

Expand All @@ -26,19 +29,44 @@ public class GeoFenceConfigurationManager {

private CacheConfiguration cacheConfiguration;

private static final String PROP_INSTANCE_NAME = "instanceName";
private static final String PROP_SERVICES_URL = "servicesUrl";
private static final String PROP_ALLOW_REMOTE = "allowRemoteAndInlineLayers";
private static final String PROP_GRANT_WRITE = "grantWriteToWorkspacesToAuthenticatedUsers";
private static final String PROP_USE_ROLES = "useRolesToFilter";
private static final String PROP_ACCEPTED_ROLES = "acceptedRoles";
private static final String PROP_GWCCONTEXTSUFFIX = "gwc.context.suffix";
private static final String PROP_ORGGEOSERVERREST =
"org.geoserver.rest.DefaultUserGroupServiceName";
private static final String PROP_CACHE_EXPIRE = "cacheExpire";
private static final String PROP_CACHE_REFRESH = "cacheRefresh";
private static final String PROP_CACHE_SIZE = "cacheSize";

private static final String[] ALL_GEOFENCE_PROPS = {
PROP_INSTANCE_NAME,
PROP_SERVICES_URL,
PROP_ALLOW_REMOTE,
PROP_GRANT_WRITE,
PROP_USE_ROLES,
PROP_ACCEPTED_ROLES,
PROP_GWCCONTEXTSUFFIX,
PROP_ORGGEOSERVERREST,
};
private static final String[] ALL_CACHE_PROPS = {
PROP_CACHE_SIZE, PROP_CACHE_REFRESH, PROP_CACHE_EXPIRE,
};

public GeoFenceConfiguration getConfiguration() {
return geofenceConfiguration;
}

/** Updates the configuration. */
public void setConfiguration(GeoFenceConfiguration configuration) {
public void setConfiguration(GeoFenceConfiguration cfg) {

this.geofenceConfiguration = configuration;
this.geofenceConfiguration = cfg;

LOGGER.log(
Level.INFO,
"GeoFence configuration: instance name is {0}",
configuration.getInstanceName());
Level.INFO, "GeoFence configuration: instance name is {0}", cfg.getInstanceName());
}

public CacheConfiguration getCacheConfiguration() {
Expand Down Expand Up @@ -66,43 +94,120 @@ public void storeConfiguration() throws IOException {
}

/** Saves current configuration to disk. */
protected void saveConfiguration(Writer writer, GeoFenceConfiguration configuration)
throws IOException {
protected void saveConfiguration(Writer writer, GeoFenceConfiguration cfg) throws IOException {

writer.write("### GeoFence main configuration\n\n");
Properties props = configAsProperties(cfg);
for (String propname : ALL_GEOFENCE_PROPS) {
saveConfig(writer, propname, props.getProperty(propname));
}
}

public void saveConfiguration(Writer writer, CacheConfiguration cfg) throws IOException {

saveConfig(writer, "instanceName", configuration.getInstanceName());
saveConfig(writer, "servicesUrl", configuration.getServicesUrl());
saveConfig(
writer, "allowRemoteAndInlineLayers", configuration.isAllowRemoteAndInlineLayers());
saveConfig(
writer,
"grantWriteToWorkspacesToAuthenticatedUsers",
configuration.isGrantWriteToWorkspacesToAuthenticatedUsers());
saveConfig(writer, "useRolesToFilter", configuration.isUseRolesToFilter());
saveConfig(writer, "acceptedRoles", configuration.getAcceptedRoles());
saveConfig(writer, "gwc.context.suffix", configuration.getGwcContextSuffix());
saveConfig(
writer,
"org.geoserver.rest.DefaultUserGroupServiceName",
configuration.getDefaultUserGroupServiceName());
writer.write("\n\n### Cache configuration\n\n");
Properties props = configAsProperties(cfg);
for (String propname : ALL_CACHE_PROPS) {
saveConfig(writer, propname, props.getProperty(propname));
}
}

protected void saveConfig(Writer writer, String name, Object value) throws IOException {
writer.write(name + "=" + String.valueOf(value) + "\n");
}

public void saveConfiguration(Writer writer, CacheConfiguration params) throws IOException {
/** Returns a copy of the configuration. */
public void setConfigurer(GeoFencePropertyPlaceholderConfigurer configurer) {
this.configurer = configurer;
}

/**
* The PropertyPlaceholderConfigurer may have race conditions sometimes, so we're going to read
* the props from the file and assign them to the GeoFenceConfiguration
*/
@Override
public void afterPropertiesSet() throws Exception {
LOGGER.log(
Level.INFO,
"GeoFence configuration: force setting properties from {0}",
configurer.getConfigFile().path());

if (loadConfiguration())
LOGGER.log(
Level.INFO,
"GeoFence configuration: instance name is {0}",
geofenceConfiguration.getInstanceName());
}

writer.write("\n\n### Cache configuration\n\n");
public boolean loadConfiguration() throws IOException {
Resource configurationFile = configurer.getConfigFile();

Properties defaults = configAsProperties(geofenceConfiguration);
defaults.putAll(configAsProperties(cacheConfiguration));

saveConfig(writer, "cacheSize", params.getSize());
saveConfig(writer, "cacheRefresh", params.getRefreshMilliSec());
saveConfig(writer, "cacheExpire", params.getExpireMilliSec());
Properties props = new Properties(defaults);

try {
props.load(configurationFile.in());
} catch (IllegalStateException e) {

LOGGER.log(
Level.INFO,
"GeoFence configuration: could not open property file {0}",
configurer.getConfigFile().path());
return false;
}

loadConfiguration(props, geofenceConfiguration);
loadConfiguration(props, cacheConfiguration);
return true;
}

/** Returns a copy of the configuration. */
public void setConfigurer(GeoFencePropertyPlaceholderConfigurer configurer) {
this.configurer = configurer;
private void loadConfiguration(Properties props, GeoFenceConfiguration cfg) {
cfg.setInstanceName(props.getProperty(PROP_INSTANCE_NAME));
cfg.setServicesUrl(props.getProperty(PROP_SERVICES_URL));
cfg.setAllowRemoteAndInlineLayers(
BooleanUtils.toBoolean(props.getProperty(PROP_ALLOW_REMOTE)));
cfg.setGrantWriteToWorkspacesToAuthenticatedUsers(
BooleanUtils.toBoolean(props.getProperty(PROP_GRANT_WRITE)));
cfg.setUseRolesToFilter(BooleanUtils.toBoolean(props.getProperty(PROP_USE_ROLES)));
cfg.setAcceptedRoles(props.getProperty(PROP_ACCEPTED_ROLES));
cfg.setGwcContextSuffix(props.getProperty(PROP_GWCCONTEXTSUFFIX));
}

private void loadConfiguration(Properties props, CacheConfiguration cfg) {
cfg.setSize(Long.parseLong(props.getProperty(PROP_CACHE_SIZE)));
cfg.setRefreshMilliSec(Long.parseLong(props.getProperty(PROP_CACHE_REFRESH)));
cfg.setExpireMilliSec(Long.parseLong(props.getProperty(PROP_CACHE_EXPIRE)));
}

public Properties configAsProperties(GeoFenceConfiguration cfg) {
Properties props = new Properties(10);
props.setProperty(PROP_INSTANCE_NAME, cfg.getInstanceName());
props.setProperty(PROP_SERVICES_URL, cfg.getServicesUrl());
props.setProperty(PROP_ALLOW_REMOTE, format_prop(cfg.isAllowRemoteAndInlineLayers()));
props.setProperty(
PROP_GRANT_WRITE, format_prop(cfg.isGrantWriteToWorkspacesToAuthenticatedUsers()));
props.setProperty(PROP_USE_ROLES, format_prop(cfg.isUseRolesToFilter()));
props.setProperty(PROP_ACCEPTED_ROLES, format_prop(cfg.getAcceptedRoles()));
props.setProperty(PROP_GWCCONTEXTSUFFIX, format_prop(cfg.getGwcContextSuffix()));
props.setProperty(PROP_ORGGEOSERVERREST, format_prop(cfg.getDefaultUserGroupServiceName()));
return props;
}

public Properties configAsProperties(CacheConfiguration cfg) {
Properties props = new Properties(3);
props.setProperty(PROP_CACHE_SIZE, String.valueOf(cfg.getSize()));
props.setProperty(PROP_CACHE_REFRESH, String.valueOf(cfg.getRefreshMilliSec()));
props.setProperty(PROP_CACHE_EXPIRE, String.valueOf(cfg.getExpireMilliSec()));
return props;
}

static String format_prop(String s) {
return s != null ? s : "";
}

static String format_prop(boolean b) {
return String.valueOf(b);
}
}
Loading