From 970e35322aa8308f90889ac72b6c0449301b58a2 Mon Sep 17 00:00:00 2001 From: Jody Garnett Date: Mon, 22 Nov 2021 14:52:34 +0100 Subject: [PATCH] [FP] ServiceContext fixes: - Keep service context independent to address user session null pointer exceptions (#5507) - Review and document use of ServiceContext (#5540) --- .../jeeves/interfaces/ApplicationHandler.java | 15 +- .../java/jeeves/monitor/MonitorManager.java | 59 +- .../main/java/jeeves/server/JeevesEngine.java | 39 +- .../jeeves/server/context/BasicContext.java | 5 +- .../jeeves/server/context/ServiceContext.java | 522 ++++++++++++- .../server/dispatchers/ServiceManager.java | 242 +++++- .../jeeves/server/sources/ServiceRequest.java | 24 +- .../java/org/fao/geonet/ContextContainer.java | 40 +- .../java/org/fao/geonet/GeonetContext.java | 6 +- .../records/attachments/AbstractStore.java | 72 +- .../org/fao/geonet/kernel/AccessManager.java | 18 +- .../org/fao/geonet/kernel/DataManager.java | 43 +- .../fao/geonet/kernel/IndexMetadataTask.java | 41 +- .../org/fao/geonet/kernel/SvnManager.java | 20 +- .../fao/geonet/kernel/ThesaurusManager.java | 27 +- .../kernel/backup/ArchiveAllMetadataJob.java | 29 +- .../kernel/datamanager/IMetadataIndexer.java | 22 +- .../kernel/datamanager/IMetadataManager.java | 14 +- .../kernel/datamanager/IMetadataUtils.java | 19 +- .../datamanager/base/BaseMetadataIndexer.java | 67 +- .../datamanager/base/BaseMetadataManager.java | 18 +- .../datamanager/base/BaseMetadataUtils.java | 16 +- .../draft/DraftMetadataIndexer.java | 9 +- .../draft/DraftMetadataManager.java | 6 +- .../datamanager/draft/DraftMetadataUtils.java | 21 +- .../kernel/metadata/DefaultStatusActions.java | 45 +- .../geonet/kernel/metadata/StatusActions.java | 32 +- .../kernel/metadata/StatusActionsFactory.java | 30 +- .../kernel/search/index/IndexingTask.java | 17 +- .../kernel/thumbnail/ThumbnailMaker.java | 7 +- .../main/java/org/fao/geonet/lib/NetLib.java | 13 +- .../org/fao/geonet/resources/Resources.java | 20 +- .../util/z3950/provider/GN/GNResultSet.java | 19 +- .../util/z3950/provider/GN/GNSearchable.java | 4 +- .../geonet/AbstractCoreIntegrationTest.java | 11 +- .../org/fao/geonet/GeonetTestFixture.java | 24 +- ...orksWithoutTransactionIntegrationTest.java | 47 +- .../LocalXLinksInMetadataIntegrationTest.java | 83 +- .../kernel/LocalXLinksUpdateDeleteTest.java | 24 + .../kernel/mef/MEFLibIntegrationTest.java | 5 +- ...actLanguageSearchOrderIntegrationTest.java | 3 +- .../geonet/kernel/url/UrlAnalyzerTest.java | 24 + .../java/org/fao/geonet/domain/Profile.java | 12 +- .../org/fao/geonet/domain/StatusValue.java | 11 +- .../component/harvester/csw/Harvest.java | 5 +- .../geonet/kernel/harvest/HarvestManager.java | 19 +- .../kernel/harvest/HarvestManagerImpl.java | 113 ++- .../harvest/harvester/AbstractHarvester.java | 84 +- .../harvest/harvester/AbstractParams.java | 6 +- .../kernel/harvest/harvester/csw/Aligner.java | 3 +- .../harvest/harvester/csw/Harvester.java | 3 +- .../harvester/fragment/FragmentHarvester.java | 1 + .../harvest/harvester/geoPREST/Aligner.java | 3 +- .../harvest/harvester/geoPREST/Harvester.java | 1 + .../harvest/harvester/geonet/Aligner.java | 3 +- .../harvest/harvester/geonet/Harvester.java | 3 +- .../harvest/harvester/geonet20/Aligner.java | 3 +- .../LocalFilesystemHarvester.java | 4 +- .../harvest/harvester/oaipmh/Harvester.java | 3 +- .../harvest/harvester/ogcwxs/Harvester.java | 5 +- .../harvest/harvester/thredds/Harvester.java | 11 +- .../harvest/harvester/webdav/Harvester.java | 3 +- .../harvester/webdav/WebDavRetriever.java | 3 +- .../harvester/wfsfeatures/Harvester.java | 9 +- .../fao/geonet/services/harvesting/Util.java | 34 +- .../AbstractHarvesterIntegrationTest.java | 5 +- .../harvester/geoPREST/HarvesterTest.java | 10 +- .../inspireatom/AtomPredefinedFeed.java | 167 ++-- .../metadata/draft/ApproveRecord.java | 21 +- .../listener/metadata/draft/DraftCleanup.java | 9 +- .../listener/metadata/draft/DraftCreated.java | 9 +- .../listener/metadata/draft/DraftRemoved.java | 9 +- .../metadata/draft/DraftUtilities.java | 29 + .../metadata/draft/UpdateOperations.java | 66 +- .../java/org/fao/geonet/api/ApiUtils.java | 243 +++++- .../org/fao/geonet/api/es/EsHTTPProxy.java | 13 +- .../org/fao/geonet/api/groups/GroupsApi.java | 79 +- .../geonet/api/harvesting/HarvestersApi.java | 21 +- .../geonet/api/languages/LanguagesApi.java | 16 +- .../org/fao/geonet/api/links/LinksApi.java | 95 +-- .../geonet/api/mapservers/MapServersApi.java | 79 +- .../MInspireEtfValidateProcess.java | 54 +- .../fao/geonet/api/processing/ProcessApi.java | 7 +- .../geonet/api/processing/ValidateApi.java | 9 +- .../geonet/api/processing/XslProcessApi.java | 32 +- .../fao/geonet/api/records/CatalogApi.java | 329 ++++---- .../org/fao/geonet/api/records/DoiApi.java | 31 +- .../api/records/InspireValidationApi.java | 62 +- .../records/InspireValidationRunnable.java | 98 ++- .../fao/geonet/api/records/MetadataApi.java | 357 ++++----- .../geonet/api/records/MetadataIndexApi.java | 51 +- .../api/records/MetadataInsertDeleteApi.java | 725 +++++++++--------- .../api/records/MetadataProcessApi.java | 102 +-- .../geonet/api/records/MetadataSampleApi.java | 293 +++---- .../api/records/MetadataSavedQueryApi.java | 33 +- .../api/records/MetadataSharingApi.java | 322 ++++---- .../geonet/api/records/MetadataSocialApi.java | 61 +- .../geonet/api/records/MetadataTagApi.java | 119 +-- .../api/records/MetadataValidateApi.java | 184 ++--- .../api/records/MetadataVersionningApi.java | 20 +- .../api/records/MetadataWorkflowApi.java | 362 ++++----- .../attachments/AttachmentsActionsApi.java | 18 +- .../records/attachments/AttachmentsApi.java | 98 +-- .../api/records/backup/BackupArchiveApi.java | 56 +- .../api/records/editing/AjaxEditUtils.java | 7 +- .../api/records/editing/BatchEditsApi.java | 185 ++--- .../geonet/api/records/editing/EditUtils.java | 8 +- .../records/editing/MetadataEditingApi.java | 497 ++++++------ .../api/records/extent/MetadataExtentApi.java | 153 ++-- .../api/records/formatters/FormatterApi.java | 237 +++--- .../fao/geonet/api/regions/RegionsApi.java | 153 ++-- .../geonet/api/regions/ThesaurusRequest.java | 5 +- .../geonet/api/registries/DirectoryApi.java | 171 +++-- .../api/registries/DirectoryEntriesApi.java | 113 +-- .../registries/vocabularies/KeywordsApi.java | 613 +++++++-------- .../org/fao/geonet/api/related/Related.java | 53 +- .../org/fao/geonet/api/reports/ReportApi.java | 102 ++- .../geonet/api/selections/SelectionsApi.java | 46 +- .../org/fao/geonet/api/site/LogosApi.java | 85 +- .../java/org/fao/geonet/api/site/SiteApi.java | 158 ++-- .../fao/geonet/api/sources/SourcesApi.java | 26 +- .../geonet/api/standards/StandardsApi.java | 70 +- .../geonet/api/tools/i18n/TranslationApi.java | 11 +- .../api/userfeedback/UserFeedbackAPI.java | 111 +-- .../org/fao/geonet/api/users/PasswordApi.java | 242 +++--- .../org/fao/geonet/api/users/RegisterApi.java | 214 +++--- .../api/users/transfer/TransferApi.java | 116 +-- .../fao/geonet/guiapi/search/SearchApi.java | 6 +- .../metadata/ExtractServicesLayers.java | 216 +++--- .../services/thesaurus/GetKeywords.java | 128 ++-- .../formatters/groovy/FunctionsTest.java | 11 +- .../main/java/org/fao/geonet/Geonetwork.java | 97 ++- web/src/main/webResources/WEB-INF/web.xml | 3 + 133 files changed, 6068 insertions(+), 4207 deletions(-) diff --git a/core/src/main/java/jeeves/interfaces/ApplicationHandler.java b/core/src/main/java/jeeves/interfaces/ApplicationHandler.java index 38d22256d1b7..38ba05a0e32a 100644 --- a/core/src/main/java/jeeves/interfaces/ApplicationHandler.java +++ b/core/src/main/java/jeeves/interfaces/ApplicationHandler.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2005 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -29,12 +29,19 @@ //============================================================================= +/** + * Used to maintain registry of handlers for {@link jeeves.server.dispatchers.ServiceManager}. + */ public interface ApplicationHandler { - public String getContextName(); + /** Context name for registry lookup */ + String getContextName(); - public Object start(Element config, ServiceContext s) throws Exception; + /** Start application handler, returning application context managed in registry */ - public void stop(); + Object start(Element config, ServiceContext s) throws Exception; + + /** Stop handler */ + void stop(); } //============================================================================= diff --git a/core/src/main/java/jeeves/monitor/MonitorManager.java b/core/src/main/java/jeeves/monitor/MonitorManager.java index 0e0b73044f4c..d4ad98d82fe5 100644 --- a/core/src/main/java/jeeves/monitor/MonitorManager.java +++ b/core/src/main/java/jeeves/monitor/MonitorManager.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -30,6 +30,7 @@ import jeeves.constants.ConfigFile; import jeeves.server.context.ServiceContext; +import jeeves.server.dispatchers.ServiceManager; import org.apache.commons.lang.StringUtils; import org.apache.log4j.LogManager; import org.fao.geonet.Util; @@ -75,6 +76,13 @@ public class MonitorManager { private MetricsRegistry metricsRegistry; private JmxReporter jmxReporter; + /** + * Internal service context created during init, and cleaned up during shutdown. + * + * A distinct service context is required as health checks are performed in the background. + */ + private ServiceContext monitorContext; + public void init(ServletContext context, String baseUrl) { String webappName = ""; @@ -130,44 +138,64 @@ private HealthCheckRegistry lookUpHealthCheckRegistry(ServletContext context, St return tmpHealthCheckRegistry; } - public void initMonitorsForApp(ServiceContext context) { - createHealthCheck(context, criticalServiceContextHealthChecks, criticalHealthCheckRegistry, "critical health check"); - createHealthCheck(context, warningServiceContextHealthChecks, warningHealthCheckRegistry, "warning health check"); - createHealthCheck(context, expensiveServiceContextHealthChecks, expensiveHealthCheckRegistry, "expensive health check"); + public void initMonitorsForApp(ServiceContext initContext) { + ServiceManager serviceManager = initContext.getBean(ServiceManager.class); + monitorContext = serviceManager.createServiceContext("monitor", initContext); + + createHealthCheck(monitorContext, criticalServiceContextHealthChecks, criticalHealthCheckRegistry, "critical health check"); + createHealthCheck(monitorContext, warningServiceContextHealthChecks, warningHealthCheckRegistry, "warning health check"); + createHealthCheck(monitorContext, expensiveServiceContextHealthChecks, expensiveHealthCheckRegistry, "expensive health check"); for (Class>> factoryClass : serviceContextGauges.keySet()) { Log.info(Log.ENGINE, "Instantiating : " + factoryClass.getName()); - Gauge instance = create(factoryClass, context, SERVICE_CONTEXT_GAUGE); + Gauge instance = create(factoryClass, monitorContext, SERVICE_CONTEXT_GAUGE); serviceContextGauges.put(factoryClass, instance); } for (Class> factoryClass : serviceContextTimers.keySet()) { Log.info(Log.ENGINE, "Instantiating : " + factoryClass.getName()); - Timer instance = create(factoryClass, context, SERVICE_CONTEXT_TIMER); + Timer instance = create(factoryClass, monitorContext, SERVICE_CONTEXT_TIMER); serviceContextTimers.put(factoryClass, instance); } for (Class> factoryClass : serviceContextCounters.keySet()) { Log.info(Log.ENGINE, "Instantiating : " + factoryClass.getName()); - Counter instance = create(factoryClass, context, SERVICE_CONTEXT_COUNTER); + Counter instance = create(factoryClass, monitorContext, SERVICE_CONTEXT_COUNTER); serviceContextCounters.put(factoryClass, instance); } for (Class> factoryClass : serviceContextHistogram.keySet()) { Log.info(Log.ENGINE, "Instantiating : " + factoryClass.getName()); - Histogram instance = create(factoryClass, context, SERVICE_CONTEXT_HISTOGRAM); + Histogram instance = create(factoryClass, monitorContext, SERVICE_CONTEXT_HISTOGRAM); serviceContextHistogram.put(factoryClass, instance); } for (Class> factoryClass : serviceContextMeter.keySet()) { Log.info(Log.ENGINE, "Instantiating : " + factoryClass.getName()); - Meter instance = create(factoryClass, context, SERVICE_CONTEXT_METER); + Meter instance = create(factoryClass, monitorContext, SERVICE_CONTEXT_METER); serviceContextMeter.put(factoryClass, instance); } } + /** + * Create and register health checks + * + * @param context + * @param checks factories used to create health checks + * @param registry registry listing heath checks + * @param type + */ private void createHealthCheck(ServiceContext context, List checks, HealthCheckRegistry registry, String type) { + ServiceManager serviceManager = context.getBean(ServiceManager.class); + for (HealthCheckFactory healthCheck : checks) { - Log.info(Log.ENGINE, "Registering " + type + ": " + healthCheck.getClass().getName()); - HealthCheck check = healthCheck.create(context); - healthCheckRegistry.register(check); - registry.register(check); + String factoryName = healthCheck.getClass().getName(); + try { + HealthCheck check = healthCheck.create(context); + + Log.info(Log.ENGINE, "Registering " + type + ": " + factoryName); + healthCheckRegistry.register(check); + registry.register(check); + } + catch (Throwable t){ + Log.info(Log.ENGINE, "Unable to register " + type + ": " + factoryName); + } } } @@ -306,6 +334,9 @@ public ResourceTracker getResourceTracker() { @PreDestroy public void shutdown() { Log.info(Log.ENGINE, "MonitorManager#shutdown"); + if (monitorContext != null){ + monitorContext.clear(); + } if (resourceTracker != null) { resourceTracker.clean(); } diff --git a/core/src/main/java/jeeves/server/JeevesEngine.java b/core/src/main/java/jeeves/server/JeevesEngine.java index a9e5898419d9..36f923ed7e5b 100644 --- a/core/src/main/java/jeeves/server/JeevesEngine.java +++ b/core/src/main/java/jeeves/server/JeevesEngine.java @@ -3,7 +3,7 @@ //=== JeevesEngine //=== //============================================================================= -//=== Copyright (C) 2001-2005 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -92,6 +92,8 @@ public class JeevesEngine { private Path _appPath; private int _maxUploadSize; + /** AppHandler service context used during init, tasks and background activities */ + private ServiceContext appHandlerContext; public static void handleStartupError(Throwable e) { Log.fatal(Log.ENGINE, "Raised exception during init"); @@ -391,6 +393,13 @@ private void initDefault(Element defaults, ServiceManager serviceMan) throws Exc //--- //--------------------------------------------------------------------------- + /** + * Setup application hanlder using the provided handler definition. + * + * @param handler handler definition + * @param servlet jeeves servlet responsible for http distpatch + * @throws Exception + */ private void initAppHandler(Element handler, JeevesServlet servlet) throws Exception { if (handler == null) { info("Handler not found"); @@ -413,20 +422,20 @@ private void initAppHandler(Element handler, JeevesServlet servlet) throws Excep ApplicationHandler h = (ApplicationHandler) c.newInstance(); - ServiceContext srvContext = serviceMan.createServiceContext("AppHandler", appContext); - srvContext.setLanguage(_defaultLang); - srvContext.setLogger(_appHandLogger); - srvContext.setServlet(servlet); - srvContext.setAsThreadLocal(); + appHandlerContext = serviceMan.createAppHandlerServiceContext(appContext); + appHandlerContext.setLanguage(_defaultLang); + appHandlerContext.setLogger(_appHandLogger); + appHandlerContext.setServlet(servlet); + appHandlerContext.setAsThreadLocal(); try { info("--- Starting handler --------------------------------------"); - Object context = h.start(handler, srvContext); + Object context = h.start(handler, appHandlerContext); _appHandlers.add(h); serviceMan.registerContext(h.getContextName(), context); - monitorManager.initMonitorsForApp(srvContext); + monitorManager.initMonitorsForApp(appHandlerContext); info("--- Handler started ---------------------------------------"); } catch (Exception e) { @@ -450,6 +459,9 @@ private void initAppHandler(Element handler, JeevesServlet servlet) throws Excep serviceMan.setStartupErrors(errors); } } + finally { + appHandlerContext.clearAsThreadLocal(); + } } } @@ -508,7 +520,11 @@ public void destroy() { info("Stopping handlers..."); stopHandlers(); + info("Clearing application handler context..."); + appHandlerContext.clear(); + info("=== System stopped ========================================"); + } catch (Exception e) { error("Raised exception during destroy"); error(" Exception : " + e); @@ -525,7 +541,12 @@ public void destroy() { private void stopHandlers() throws Exception { for (ApplicationHandler h : _appHandlers) { - h.stop(); + try { + h.stop(); + } catch (Throwable unexpected){ + _appHandLogger.error("Difficulty while stopping "+h.getContextName()); + _appHandLogger.error(unexpected); + } } } diff --git a/core/src/main/java/jeeves/server/context/BasicContext.java b/core/src/main/java/jeeves/server/context/BasicContext.java index 24930fd02acc..04776f5b5eb6 100644 --- a/core/src/main/java/jeeves/server/context/BasicContext.java +++ b/core/src/main/java/jeeves/server/context/BasicContext.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2005 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -43,9 +43,8 @@ //============================================================================= /** - * Contains a minimun context for a job execution (schedule, service etc...) + * Contains a minimum context for a job execution (schedule, service etc...) */ - public class BasicContext implements Logger { private final ConfigurableApplicationContext jeevesApplicationContext; diff --git a/core/src/main/java/jeeves/server/context/ServiceContext.java b/core/src/main/java/jeeves/server/context/ServiceContext.java index a64c2c7fb1f5..f2f1dbf28197 100644 --- a/core/src/main/java/jeeves/server/context/ServiceContext.java +++ b/core/src/main/java/jeeves/server/context/ServiceContext.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2005 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -44,6 +44,7 @@ import java.nio.file.Path; import java.util.HashMap; import java.util.Map; +import java.util.Objects; import javax.annotation.CheckForNull; import javax.persistence.EntityManager; @@ -52,21 +53,179 @@ /** * Contains the context for a service execution. + * + * When creating a ServiceContext you are responsible for manging its use on the current thread and any cleanup: + * 

+ * try {
+ *    context = serviceMan.createServiceContext("AppHandler", appContext);
+ *    context.setAsThreadLocal();
+ *    ...
+ * } finally {
+ *    context.clearAsThreadLocal();
+ *    context.clear();
+ * }
+ * + * @see ServiceManager */ -public class ServiceContext extends BasicContext { +public class ServiceContext extends BasicContext implements AutoCloseable { + /** + * ServiceContext is managed as a thread locale using setAsThreadLocal, clearAsThreadLocal and clear methods. + * ThreadLocalPolicy defines the behaviour of these methods double checking that they are being used correctly. + */ + public static enum ThreadLocalPolicy { + /** Direct management of thread local with no checking. */ + DIRECT, + /** Check behavior and log any unexpected use. */ + TRACE, + /** Raise any {@link IllegalStateException} for unexpected behaviour */ + STRICT }; + /** + * Use -Djeeves.server.context.service.policy to define policy: + *
    + *
  • direct: direct management of thread local with no checking
    • + *
  • trace: check behavior and log unusal use
    • + *
  • strict: raise illegal state exception for unusual behavior
    • + *
+ */ + private static final ThreadLocalPolicy POLICY; + static { + String property = System.getProperty("jeeves.server.context.policy", "TRACE"); + ThreadLocalPolicy policy; + try { + policy = ThreadLocalPolicy.valueOf(property.toUpperCase()); + } + catch (IllegalArgumentException defaultToDirect) { + policy = ThreadLocalPolicy.DIRECT; + } + POLICY = policy; + } + + /** + * Be careful with thread local to avoid leaking resources, set POLICY above to trace allocation. + */ private static final InheritableThreadLocal THREAD_LOCAL_INSTANCE = new InheritableThreadLocal(); - private UserSession _userSession = new UserSession(); - private InputMethod _input; - private OutputMethod _output; - private Map _headers; - private String _language; - private String _service; - private String _ipAddress; - private int _maxUploadSize; - private JeevesServlet _servlet; - private boolean _startupError = false; - private Map _startupErrors; + + /** + * Simple data structure recording service details. + * + * Lightweight data structure used logging service details such as name. + */ + public static class ServiceDetails { + private String ipAddress; + private String service; + private String language; + public ServiceDetails(ServiceContext context){ + this.ipAddress = context.getIpAddress(); + } + + public String getIpAddress() { + return ipAddress; + } + + public String getService() { + return service; + } + + public String getLanguage() { + return language; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + ServiceDetails that = (ServiceDetails) o; + return Objects.equals(ipAddress, that.ipAddress) && service.equals(that.service) && Objects.equals(language, that.language); + } + + @Override + public int hashCode() { + return Objects.hash(ipAddress, service, language); + } + } + + /** + * Shared service context offering limited functionality. + * + * Use of service context has been assumed in many parts of the codebase. This shared "AppHandler" service context + * is used during Jeeves startup and has some protection from being cleared. Additional managers such HarvestManager + * also use a shared service context to support background processes. + */ + public static class AppHandlerServiceContext extends ServiceContext { + + /** + * Shared AppHandler service context associated with application lifecycle. + * + * See factory method {@link ServiceManager#createAppHandlerServiceContext(ConfigurableApplicationContext, String)} and + * {@link ServiceManager#createAppHandlerServiceContext(ConfigurableApplicationContext)}. + * + * @param service Service name + * @param jeevesApplicationContext Application context + * @param contexts Handler context + * @param entityManager + */ + public AppHandlerServiceContext(final String service, final ConfigurableApplicationContext jeevesApplicationContext, + final Map contexts, final EntityManager entityManager) { + super( service, jeevesApplicationContext, contexts, entityManager ); + _language = "?"; + _userSession = null; + _ipAddress = "?"; + } + + @Override + public void setUserSession(UserSession session) { + if (session != null) { + warning("Shared service context \"" + _service + "\" context should not be configured with user session"); + } + super.setUserSession(session); + } + @Override + public void setIpAddress(String address) { + if( address != null && !"?".equals(address)) { + warning("Shared service context \""+_service+"\" should not be associated with an ip address"); + } + super.setIpAddress(address); + } + + public void clear() { + warning("Shared service context \""+_service+"\" context is shared, and should not be cleared"); + } + + @Override + public String toString() { + final StringBuilder sb = new StringBuilder("AppHandlerServiceContext "); + sb.append("'").append(_service).append('\''); + + return sb.toString(); + } + + }; + /** + * Trace allocation via {@link #setAsThreadLocal()}. + * + * Recording where the service context was assigned to the thread local to aid in debugging. + */ + protected Throwable allocation = null; + + /** + * Trace deallocation via {@link #clear()} method. + * + * Recording where the service context clear() was called to aid in debugging. + */ + protected Throwable deAllocation = null; + + protected UserSession _userSession = new UserSession(); + protected InputMethod _input; + protected OutputMethod _output; + protected Map _headers; + protected String _language; + protected String _service; + protected String _ipAddress; + protected int _maxUploadSize; + protected JeevesServlet _servlet; + protected boolean _startupError = false; + protected Map _startupErrors; /** * Property to be able to add custom response headers depending on the code (and not the xml of * Jeeves) @@ -76,7 +235,7 @@ public class ServiceContext extends BasicContext { * * @see #_statusCode */ - private Map _responseHeaders; + protected Map _responseHeaders; /** * Property to be able to add custom http status code headers depending on the code (and not the * xml of Jeeves) @@ -86,7 +245,16 @@ public class ServiceContext extends BasicContext { * * @see #_responseHeaders */ - private Integer _statusCode; + protected Integer _statusCode; + + /** + * Context for service execution. + * + * @param service Service name + * @param jeevesApplicationContext Application context + * @param contexts Handler context + * @param entityManager + */ public ServiceContext(final String service, final ConfigurableApplicationContext jeevesApplicationContext, final Map contexts, final EntityManager entityManager) { super(jeevesApplicationContext, contexts, entityManager); @@ -104,9 +272,47 @@ public ServiceContext(final String service, final ConfigurableApplicationContext */ @CheckForNull public static ServiceContext get() { - return THREAD_LOCAL_INSTANCE.get(); + ServiceContext context = THREAD_LOCAL_INSTANCE.get(); + if(context != null && context.isCleared()) { + context.checkCleared("Thread local access"); + } + return context; } + /** + * Auto closable for try-with-resources support. + *

+ * For use when creating service context for use as a parameter, will check and handle {@link #clear()} if needed: + * 

+     * try (ServiceContext context = serviceMan.createServiceContext("AppHandler", appContext)){
+     *     ...
+     * }
+     *
+ *

+ * Close will also check and handle {@link #clearAsThreadLocal()} if needed: + * 
+     * try (ServiceContext context = serviceMan.createServiceContext("AppHandler", appContext)){
+     *     setAsThreadLocal();
+     *     ....
+     * }
+     *
+ *

+ */ + public void close() { + try { + ServiceContext check = THREAD_LOCAL_INSTANCE.get(); + if( this == check){ + clearAsThreadLocal(); + } + } + finally { + if( !isCleared() ){ + // reuse clear method, but provide useful deAllocation context + clear(); + deAllocation = new Throwable("ServiceContext "+_service+" closed"); + } + } + } //-------------------------------------------------------------------------- //--- //--- Constructor @@ -115,10 +321,193 @@ public static ServiceContext get() { /** * Called to set the Service context for this thread and inherited threads. + * + * If you call this method you are responsible for thread context management and {@link #clearAsThreadLocal()}. + * 
+     * try {
+     *     context.setAsThreadLocal();
+     * }
+     * finally {
+     *     context.clearAsThreadLocal();
+     * }
+     *
*/ public void setAsThreadLocal() { + ServiceContext check = THREAD_LOCAL_INSTANCE.get(); + + if( POLICY == ThreadLocalPolicy.DIRECT || check == null){ + // step one set thread local + THREAD_LOCAL_INSTANCE.set(this); + // step two ensure ApplicationContextHolder thread local kept in sync + ApplicationContextHolder.set(this.getApplicationContext()); + // step three details on allocation + allocation = new Throwable("ServiceContext "+_service+" allocated to thread"); + + return; + } + + if (this == check) { + String unexpected = "Service " + _service + " Context: already in use for this thread"; + if( allocation != null ){ + // details on prior allocation + unexpected += "\n\tContext '"+check._service+"' conflict: " + check.allocation.getStackTrace()[1]; + } + // step one set thread local + // (already done) + // step two ensure ApplicationContextHolder thread local kept in sync + if( ApplicationContextHolder.get() != null ){ + ApplicationContextHolder.clear(); + } + ApplicationContextHolder.set(this.getApplicationContext()); + // step three detail on re-allocation + allocation = new Throwable("ServiceContext "+_service+" allocated to thread"); + + unexpected += "\n\tService '"+_service+"' allocate: " + allocation.getStackTrace()[1]; + checkUnexpectedState( unexpected ); + return; + } + + // thread being recycled or reused for new service context + // + THREAD_LOCAL_INSTANCE.remove(); + + String unexpected = "Service " + _service + " Context: Clearing prior service context " + check._service; + if( check.allocation != null ){ + // details on prior allocation + unexpected += "\n\tContext '"+check._service+"' conflict: " + check.allocation.getStackTrace()[1]; + } + + // step one set thread local THREAD_LOCAL_INSTANCE.set(this); + // step two ensure ApplicationContextHolder thread local kept in sync + if( ApplicationContextHolder.get() != null ){ + ApplicationContextHolder.clear(); + } ApplicationContextHolder.set(this.getApplicationContext()); + // step three detail on present re-allocation + allocation = new Throwable("ServiceContext "+_service+" allocated to thread"); + + unexpected += "\n\tService '"+_service+"' allocate: " + allocation.getStackTrace()[1]; + checkUnexpectedState( unexpected ); + } + + /** + * Check if _service name is available, or raise a NullPointerException if clear() has already been called. + * + * @param message message to use if clear() has already been called. + */ + protected void checkCleared(String message){ + if(isCleared()){ + String unavailable = message + " - service context no longer available\nCleared by " + deAllocation.getStackTrace()[1]; + throw new NullPointerException(unavailable); + } + } + + /** Log or raise exception based on {@link POLICY} */ + protected void checkUnexpectedState( String unexpected ){ + if( unexpected == null ){ + return; // nothing unexpected to report + } + switch( POLICY ){ + case DIRECT: + break; // ignore + case TRACE: + debug(unexpected); + break; + case STRICT: + throw new IllegalStateException(unexpected); + } + } + + /** + * Called to clear the Service context for this thread and inherited threads. + * + * In general code that creates ServiceContext is responsible thread management and any cleanup: + * 
+     * try {
+     *     context.setAsThreadLocal();
+     * }
+     * finally {
+     *     context.clearAsThreadLocal();
+     * }
+     *
+ */ + public void clearAsThreadLocal() { + ServiceContext check = THREAD_LOCAL_INSTANCE.get(); + + // clean up thread local + if( POLICY == ThreadLocalPolicy.DIRECT){ + if( check != null ){ + check.allocation = null; + check = null; + } + THREAD_LOCAL_INSTANCE.remove(); + allocation = null; + // ApplicationContextHolder.clear(); + return; + } + if( check == null ){ + String unexpected = "ServiceContext "+_service+" clearAsThreadLocal: '"+_service+"' unexpected state, thread local already cleared"; + if( allocation != null ){ + unexpected += "\n\tContext '"+_service+"' allocation: " + allocation.getStackTrace()[1]; + } + allocation = null; + // ApplicationContextHolder.clear(); + checkUnexpectedState( unexpected ); + return; + } + if (check == this){ + THREAD_LOCAL_INSTANCE.remove(); + allocation = null; + // ApplicationContextHolder.clear(); + return; + } + + String unexpected = "ServiceContext clearAsThreadLocal: \"+_service+\" unexpected state, thread local presently used by service context '"+check._service+"'"; + if( check.allocation != null ){ + unexpected += "\n\tContext '"+check._service+"' conflict: " + check.allocation.getStackTrace()[1]; + } + if( allocation != null ){ + unexpected += "\n\tContext '"+_service+"' allocation: " + allocation.getStackTrace()[1]; + } + THREAD_LOCAL_INSTANCE.remove(); + allocation = null; + // ApplicationContextHolder.clear(); + if( ApplicationContextHolder.get() != null && ApplicationContextHolder.get() != getApplicationContext() ){ + unexpected += "\n\tApplicationContext '"+ApplicationContextHolder.get().getApplicationName()+"' conflict detected"; + unexpected += "\n\tApplicationContext '"+getApplicationContext().getApplicationName()+"' expected"; + ApplicationContextHolder.clear(); + } + checkUnexpectedState( unexpected ); + } + + /** + * Release any resources tied up by this service context. + *

+ * In general code that creates a ServiceContext is responsible thread management and any cleanup: + * 

+     * ServiceContext context = serviceMan.createServiceContext("AppHandler", appContext);
+     * try {
+     *     context.setAsThreadLocal();
+     * }
+     * finally {
+     *     context.clearAsThreadLocal();
+     *     context.clear();
+     * }
+     *
+ */ + public void clear(){ + if( this._service != null) { + deAllocation = new Throwable("ServiceContext "+_service+" cleared"); + this._service = null; + this._headers = null; + this._responseHeaders = null; + this._servlet = null; + this._userSession = null; + } + else { + debug("Service context unexpectedly cleared twice, previously cleared by "+deAllocation.getStackTrace()[1]); + } } //-------------------------------------------------------------------------- @@ -127,27 +516,65 @@ public void setAsThreadLocal() { //--- //-------------------------------------------------------------------------- + /** + * Language code, or "?" if undefined. + * @return language code, or "?" if undefined. + */ public String getLanguage() { + // checkCleared("language not available"); return _language; } + /** + * Language code, or "?" if undefined. + * @param lang language code, or "?" if undefined. + */ public void setLanguage(final String lang) { _language = lang; } + /** + * True if {@link #clear()} has been called to reclaim resources. + * + * @return true if service context has been cleared + */ + public boolean isCleared(){ + return _service == null; + } + + + /** + * Service name, or null if service context is no longer in use. + * + * @return service name, or null if service is no longer in use + */ public String getService() { return _service; } - public void setService(final String service) { + public void setService(String service) { + if( service == null ){ + service = "internal"; + } this._service = service; logger = Log.createLogger(Log.WEBAPP + "." + service); } + /** + * IP address of request, or "?" for local loopback request. + * + * @return ip address, or "?" for loopback request. + */ public String getIpAddress() { + checkCleared("ip address not available"); return _ipAddress; } + /** + * IP address of request, or "?" for local loopback request. + * + * @param address ip, address or "?" for loopback request. + */ public void setIpAddress(final String address) { _ipAddress = address; } @@ -157,6 +584,7 @@ public Path getUploadDir() { } public int getMaxUploadSize() { + checkCleared("max upload size not available"); return _maxUploadSize; } @@ -170,6 +598,7 @@ public void setMaxUploadSize(final int size) { * @return the user session stored on httpsession */ public UserSession getUserSession() { + checkCleared("user session not available"); return _userSession; } @@ -177,6 +606,23 @@ public void setUserSession(final UserSession session) { _userSession = session; } + /** + * Safely look up user name, or anonymous. + * + * This is a quick null safe lookup of user name suitable for use in logging and error messages. + * + * @return username, or anonymous if unavailable. + */ + public String userName(){ + if (_userSession == null || _userSession.getUsername() == null ){ + return "anonymous"; + } + if( _userSession.getProfile() != null ){ + return _userSession.getUsername() + "/" + _userSession.getProfile(); + } + return _userSession.getUsername(); + } + public ProfileManager getProfileManager() { return getBean(ProfileManager.class); } @@ -184,6 +630,7 @@ public ProfileManager getProfileManager() { //-------------------------------------------------------------------------- public InputMethod getInputMethod() { + checkCleared("input method not available"); return _input; } @@ -192,6 +639,7 @@ public void setInputMethod(final InputMethod m) { } public OutputMethod getOutputMethod() { + checkCleared("output method not available"); return _output; } @@ -200,6 +648,7 @@ public void setOutputMethod(final OutputMethod m) { } public Map getStartupErrors() { + checkCleared("startup errors not available"); return _startupErrors; } @@ -209,6 +658,7 @@ public void setStartupErrors(final Map errs) { } public boolean isStartupError() { + checkCleared("is startup error not available"); return _startupError; } @@ -234,6 +684,7 @@ public void setLogger(final Logger l) { * @return The map of headers from the request */ public Map getHeaders() { + checkCleared("headers not available"); return _headers; } @@ -249,6 +700,7 @@ public void setHeaders(Map headers) { } public JeevesServlet getServlet() { + checkCleared("servlet not available"); return _servlet; } @@ -269,20 +721,27 @@ public void executeOnly(final LocalServiceRequest request) throws Exception { new TransactionTask() { @Override public Void doInTransaction(TransactionStatus transaction) throws Throwable { - final ServiceContext context = new ServiceContext(request.getService(), getApplicationContext(), htContexts, getEntityManager()); - UserSession session = ServiceContext.this._userSession; - if (session == null) { - session = new UserSession(); - } + final ServiceManager serviceManager = getApplicationContext().getBean(ServiceManager.class); + final ServiceContext localServiceContext = serviceManager.createServiceContext(request.getService(), getApplicationContext()); + try { - final ServiceManager serviceManager = context.getBean(ServiceManager.class); - serviceManager.dispatch(request, session, context); + UserSession session = ServiceContext.this._userSession; + if (session == null) { + session = new UserSession(); + } + localServiceContext.setUserSession(session); + + serviceManager.dispatch(request, session, localServiceContext); } catch (Exception e) { Log.error(Log.XLINK_PROCESSOR, "Failed to parse result xml" + request.getService()); throw new ServiceExecutionFailedException(request.getService(), e); } finally { - // set old context back as thread local - setAsThreadLocal(); + if( localServiceContext == ServiceContext.get()){ + // dispatch failed to clear cleanup localServiceContext + // restoring back as thread local + ServiceContext.this.setAsThreadLocal(); + } + localServiceContext.clear(); } return null; } @@ -320,6 +779,17 @@ public void setStatusCode(Integer statusCode) { this._statusCode = statusCode; } + @Override + public String toString() { + final StringBuilder sb = new StringBuilder("ServiceContext "); + sb.append("'").append(_service).append('\''); + sb.append(" ").append(_input).append(" --> ").append(_output); + sb.append(" { _language='").append(_language).append('\''); + sb.append(", _ipAddress='").append(_ipAddress).append('\''); + sb.append('}'); + + return sb.toString(); + } } //============================================================================= diff --git a/core/src/main/java/jeeves/server/dispatchers/ServiceManager.java b/core/src/main/java/jeeves/server/dispatchers/ServiceManager.java index 0bc08f24274f..37b64e69325e 100644 --- a/core/src/main/java/jeeves/server/dispatchers/ServiceManager.java +++ b/core/src/main/java/jeeves/server/dispatchers/ServiceManager.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2005 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -49,12 +49,14 @@ import org.fao.geonet.Constants; import org.fao.geonet.NodeInfo; import org.fao.geonet.Util; +import org.fao.geonet.domain.User; import org.fao.geonet.exceptions.JeevesException; import org.fao.geonet.exceptions.NotAllowedEx; import org.fao.geonet.exceptions.ServiceNotFoundEx; import org.fao.geonet.exceptions.ServiceNotMatchedEx; import org.fao.geonet.kernel.GeonetworkDataDirectory; import org.fao.geonet.kernel.setting.SettingManager; +import org.fao.geonet.repository.UserRepository; import org.fao.geonet.util.XslUtil; import org.fao.geonet.utils.BLOB; import org.fao.geonet.utils.BinaryFile; @@ -64,6 +66,9 @@ import org.fao.geonet.utils.Xml; import org.jdom.Element; import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.web.context.request.RequestAttributes; +import org.springframework.web.context.request.RequestContextHolder; +import org.springframework.web.context.request.ServletRequestAttributes; import javax.persistence.EntityManager; import javax.persistence.PersistenceContext; @@ -78,6 +83,10 @@ import java.util.Map.Entry; //============================================================================= + +/** + * Handles operations on services. + */ public class ServiceManager { private Map> htServices = new HashMap>(100); private Map htContexts = new HashMap(); @@ -342,6 +351,106 @@ public void addErrorPage(Element err) throws Exception { vErrorPipe.add(buildErrorPage(err)); } + /** + * Used to create an appContext placeholder service context used for initialization, background tasks and activities. + * + * This ServiceContext is used during initialization and is independent of any user session. + * This instance is the responsibility of a specific manager and will produce a warning if an attempt is made + * to clear or assign a user session. + * + * @param appContext GeoNetwork Application Context + * @return new service context with limited functionality + */ + public ServiceContext.AppHandlerServiceContext createAppHandlerServiceContext(ConfigurableApplicationContext appContext) { + ServiceContext.AppHandlerServiceContext context = new ServiceContext.AppHandlerServiceContext("AppHandler", appContext, htContexts, entityManager); + context.setBaseUrl(baseUrl); + context.setMaxUploadSize(maxUploadSize); + context.setServlet(servlet); + + return context; + } + + /** + * Used to create an appContext placeholder service context for a specific manager used for initialization, background tasks and activities. + * + * Previously a single AppHandler service context was shared managed by Jeeves. + * + * This instance is the responsibility of a specific manager and will produce a warning if an attempt is made + * to clear or assign a user session. + * + * @param manager Manager name such as AppContext or harvester + * @return new service context with limited functionality + */ + public ServiceContext.AppHandlerServiceContext createAppHandlerServiceContext(String manager, ServiceContext parent) { + ServiceContext.AppHandlerServiceContext context = new ServiceContext.AppHandlerServiceContext(manager, parent.getApplicationContext(), htContexts, entityManager); + context.setBaseUrl(baseUrl); + context.setMaxUploadSize(maxUploadSize); + context.setServlet(servlet); + + return context; + } + + + /** + * Used to create a serviceContext for later use, the object provided the new serviceContext is responsible + * for cleanup. + * 

+     * final ServiceContext taskContext = serviceMan.createServiceContext( serviceContext, "task");
+     * return new Runnable(){
+     *     public abstract void run(){
+     *         try {
+     *            taskContext.setAsThreadLocal();
+     *
+     *         }
+     *         finally {
+     *             taskContext.clear();
+     *         }
+     *     }
+     * };
+     *
+ * + * @param name + * @param parent + * @return new service context + */ + public ServiceContext createServiceContext(String name, ServiceContext parent ){ + ServiceContext context = createServiceContext( name, parent.getApplicationContext()); + context.setBaseUrl(parent.getBaseUrl()); + context.setLanguage(parent.getLanguage()); + context.setUserSession(null); // because this is intended for later use user session not included + context.setIpAddress(parent.getIpAddress()); + context.setMaxUploadSize(parent.getMaxUploadSize()); + context.setServlet(parent.getServlet()); + + return context; + } + /** + * Create an internal service context, not associated with a user or ip address. + * + * When creating a ServiceContext you are responsible for manging its use on the current thread and any cleanup. + * + * Using auto closable: + * 

+     * try(ServiceContext context = serviceMan.createServiceContext("AppHandler", appContext)){
+     *    ...
+     * }
+     *
+ * + * Or manually: + * 

+     * try {
+     *    context = serviceMan.createServiceContext("AppHandler", appContext);
+     *    context.setAsThreadLocal();
+     *    ...
+     * } finally {
+     *    context.clearAsThreadLocal();
+     *    context.clear();
+     * }
+ * + * @param name context name + * @param appContext application context + * @return ServiceContext + */ public ServiceContext createServiceContext(String name, ConfigurableApplicationContext appContext) { ServiceContext context = new ServiceContext(name, appContext, htContexts, entityManager); @@ -356,6 +465,36 @@ public ServiceContext createServiceContext(String name, ConfigurableApplicationC return context; } + /** + * Used to create a ServiceContext. + * + * When creating a ServiceContext you are responsible for manging its use on the current thread and any cleanup. + * + * Using auto closable: + * 

+     * try(ServiceContext context = serviceMan.createServiceContext("md.thumbnail.upload", lang, request)){
+     *    ...
+     * }
+     *
+ * Or manually: + * 

+     * ServiceContext context = serviceMan.createServiceContext("md.thumbnail.upload", lang, request);
+     * try {
+     *
+     *    context.setAsThreadLocal();
+     *    ...
+     * } finally {
+     *    context.clearAsThreadLocal();
+     *    context.clear();
+     * }
+ * + * The serviceContext is creating using the ApplicationContext from {@link ApplicationContextHolder}. + * + * @param name context name + * @param lang + * @param request servlet request + * @return ServiceContext + */ public ServiceContext createServiceContext(String name, String lang, HttpServletRequest request) { ServiceContext context = new ServiceContext(name, ApplicationContextHolder.get(), htContexts, entityManager); @@ -381,10 +520,80 @@ public ServiceContext createServiceContext(String name, String lang, HttpServlet return context; } + /** + * Create a transitory service context for use in a single try-with-resources block. + * + * Makes use of current http session if available (the usual case), or a temporary user session using the provided + * userId (when used from a background task or job). + *

+ * Code creating a service context is responsible for handling resources and cleanup. + *

+ * 
+     * try( ServiceContext context = createServiceContext("approve_record", event.getUser()){
+     *    ... utility methods can now use ServiceContext.get() ...
+     * }
+     *
+ * @param name service context name for approval record handling + * @param defaultUserId If a user session is not available, this id is used to create a temporary user session + * @return service context for approval record event handling + */ + public ServiceContext createServiceContext(String name, int defaultUserId){ + // If this implementation is generally useful it should migrate to ServiceManager, rather than cut and paste + ConfigurableApplicationContext applicationContext = ApplicationContextHolder.get(); + + ServiceContext context; + + HttpServletRequest request = getCurrentHttpRequest(); + if( request != null ) { + // reuse user session from http request + context = createServiceContext(name, "?", request); + } + else { + // Not in an http request, creating a temporary user session wiht provided userId + context = createServiceContext(name, applicationContext); + + UserRepository userRepository = applicationContext.getBean(UserRepository.class); + Optional user = userRepository.findById( defaultUserId ); + if( user.isPresent() ){ + UserSession session = new UserSession(); + session.loginAs(user.get()); + context.setUserSession(session); + } + } + context.setAsThreadLocal(); + + return context; + } + + /** + * Look up current HttpServletRequest if running in a servlet dispatch. + * + * @return http request, or null if running in a background task + */ + private static HttpServletRequest getCurrentHttpRequest(){ + RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes(); + if (requestAttributes instanceof ServletRequestAttributes) { + HttpServletRequest request = ((ServletRequestAttributes)requestAttributes).getRequest(); + return request; + } + return null; // not called during http request + } + + + /** + * Dispatch service request, creating a service context with the provided user session. + * + * @param req service request + * @param session user session + */ public void dispatch(ServiceRequest req, UserSession session) { ServiceContext context = new ServiceContext(req.getService(), ApplicationContextHolder.get(), htContexts, entityManager); - dispatch(req, session, context); + try { + dispatch(req, session, context); + } finally { + context.clear(); + } } //--------------------------------------------------------------------------- @@ -396,6 +605,14 @@ public void dispatch(ServiceRequest req, UserSession session) { //--- Dispatching methods //--- //--------------------------------------------------------------------------- + + /** + * Dispatch service request, configuring context with the provided user session. + * + * @param req service request + * @param session user session + * @param context service context + */ public void dispatch(ServiceRequest req, UserSession session, ServiceContext context) { context.setBaseUrl(baseUrl); context.setLanguage(req.getLanguage()); @@ -408,6 +625,11 @@ public void dispatch(ServiceRequest req, UserSession session, ServiceContext con context.setServlet(servlet); if (startupError) context.setStartupErrors(startupErrors); + ServiceContext priorContext = ServiceContext.get(); + if( priorContext != null){ + priorContext.debug("ServiceManger dispatch replacing current ServiceContext"); + priorContext.clearAsThreadLocal(); + } context.setAsThreadLocal(); //--- invoke service and build result @@ -505,6 +727,20 @@ public void dispatch(ServiceRequest req, UserSession session, ServiceContext con handleError(req, response, context, srvInfo, e); } } + finally { + ServiceContext checkContext = ServiceContext.get(); + if( checkContext == context ) { + context.clearAsThreadLocal(); + } + else { + context.debug("ServiceManager dispatch context was replaced before cleanup"); + } + context.clearAsThreadLocal(); + if( priorContext != null){ + priorContext.debug("ServiceManger dispatch restoring ServiceContext"); + priorContext.setAsThreadLocal(); + } + } } //--------------------------------------------------------------------------- @@ -844,7 +1080,7 @@ else if (outPage.isBLOB()) { } finally { timerContext.stop(); } - + if (outPage.getContentType() != null && outPage.getContentType().startsWith("text/plain")) { req.beginStream(outPage.getContentType(), -1, "attachment;", cache); diff --git a/core/src/main/java/jeeves/server/sources/ServiceRequest.java b/core/src/main/java/jeeves/server/sources/ServiceRequest.java index 063025dbf294..5f9ef351d8c6 100644 --- a/core/src/main/java/jeeves/server/sources/ServiceRequest.java +++ b/core/src/main/java/jeeves/server/sources/ServiceRequest.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2005 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -196,21 +196,36 @@ public boolean hasJSONOutput() { return jsonOutput; } + /** + * Write provided response element, ending the stream. + * + * @param response + * @throws IOException + */ public void write(Element response) throws IOException { Xml.writeResponse(new Document(response), outStream); endStream(); } /** - * called when the system starts streaming data + * Called when the system starts streaming data + * @param contentType mime type + * @param cache true if content can be cached, false to disable caching for dynamic content */ - public void beginStream(String contentType, boolean cache) { } //--------------------------------------------------------------------------- - public void beginStream(String contentType, int contentLength, String contentDisp, + /** + * Called when the system starts streaming data, filling in appropriate header details supported by protocol. + * + * @param contentType mime type + * @param contentLength content length in bytes if known, -1 if unknown + * @param contentDisposition content disposition (inline|attachment|attachment;filename="filename.jpg") + * @param cache true if content can be cached, false to disable caching for dynamic content + */ + public void beginStream(String contentType, int contentLength, String contentDisposition, boolean cache) { } @@ -219,7 +234,6 @@ public void beginStream(String contentType, int contentLength, String contentDis /** * called when the system ends streaming data */ - public void endStream() throws IOException { } diff --git a/core/src/main/java/org/fao/geonet/ContextContainer.java b/core/src/main/java/org/fao/geonet/ContextContainer.java index e6f7022df0fe..eb607d5e7e16 100644 --- a/core/src/main/java/org/fao/geonet/ContextContainer.java +++ b/core/src/main/java/org/fao/geonet/ContextContainer.java @@ -37,8 +37,10 @@ public class ContextContainer implements ApplicationContextAware { - //private GeonetContext geoctx; + /** Shared service context for GeoNetwork application */ private ServiceContext srvctx; + + /** Shared application context provided during initialization */ private ApplicationContext ctx; public ContextContainer() { @@ -46,30 +48,44 @@ public ContextContainer() { } - /* - public GeonetContext getGeoctx() { - return geoctx; - } - - public void setGeoctx(GeonetContext geoctx) { - - this.geoctx = geoctx; - } - */ - + /** + * Service context shared for GeoNetwork application. + * + * This is an application wide service context with limited functionality, no user session for example. + * + * Use of {@link ServiceContext#get()} is recommended in most situations for access + * to current user session. + * + * @return Shared service context for GeoNetwork application + */ public ServiceContext getSrvctx() { return srvctx; } + /** + * Service context shared for GeoNetwork application. + * + * @param srvctx Shared app handler service context for GeoNetwork application + */ public void setSrvctx(ServiceContext srvctx) { this.srvctx = srvctx; } + /** + * GeoNetwork application context provided during initialization. + * + * @return geonetwork application context + */ public ApplicationContext getApplicationContext() { if (ctx == null) throw new RuntimeException("applicationcontext not yet initialized"); return ctx; } + /** + * GeoNetwork application context provided during initialization. + * @param arg0 + * @throws BeansException + */ public void setApplicationContext(ApplicationContext arg0) throws BeansException { diff --git a/core/src/main/java/org/fao/geonet/GeonetContext.java b/core/src/main/java/org/fao/geonet/GeonetContext.java index 9453be1f80bd..615876d94d35 100644 --- a/core/src/main/java/org/fao/geonet/GeonetContext.java +++ b/core/src/main/java/org/fao/geonet/GeonetContext.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -25,10 +25,12 @@ import com.google.common.annotations.VisibleForTesting; -import org.fao.geonet.kernel.metadata.StatusActions; import org.fao.geonet.util.ThreadPool; import org.springframework.context.ApplicationContext; +/** + * GeoNetwork context managing application context and a shared thread pool. + */ public class GeonetContext { private final ApplicationContext _springAppContext; private final ThreadPool _threadPool; diff --git a/core/src/main/java/org/fao/geonet/api/records/attachments/AbstractStore.java b/core/src/main/java/org/fao/geonet/api/records/attachments/AbstractStore.java index 575105f21029..4e05a2fc29f4 100644 --- a/core/src/main/java/org/fao/geonet/api/records/attachments/AbstractStore.java +++ b/core/src/main/java/org/fao/geonet/api/records/attachments/AbstractStore.java @@ -1,27 +1,26 @@ -/* - * ============================================================================= - * === Copyright (C) 2019 Food and Agriculture Organization of the - * === United Nations (FAO-UN), United Nations World Food Programme (WFP) - * === and United Nations Environment Programme (UNEP) - * === - * === This program is free software; you can redistribute it and/or modify - * === it under the terms of the GNU General Public License as published by - * === the Free Software Foundation; either version 2 of the License, or (at - * === your option) any later version. - * === - * === This program is distributed in the hope that it will be useful, but - * === WITHOUT ANY WARRANTY; without even the implied warranty of - * === MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * === General Public License for more details. - * === - * === You should have received a copy of the GNU General Public License - * === along with this program; if not, write to the Free Software - * === Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA - * === - * === Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2, - * === Rome - Italy. email: geonetwork@osgeo.org - * ============================================================================== - */ +///============================================================================= +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the +//=== United Nations (FAO-UN), United Nations World Food Programme (WFP) +//=== and United Nations Environment Programme (UNEP) +//=== +//=== This program is free software; you can redistribute it and/or modify +//=== it under the terms of the GNU General Public License as published by +//=== the Free Software Foundation; either version 2 of the License, or (at +//=== your option) any later version. +//=== +//=== This program is distributed in the hope that it will be useful, but +//=== WITHOUT ANY WARRANTY; without even the implied warranty of +//=== MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +//=== General Public License for more details. +//=== +//=== You should have received a copy of the GNU General Public License +//=== along with this program; if not, write to the Free Software +//=== Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA +//=== +//=== Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2, +//=== Rome - Italy. email: geonetwork@osgeo.org +//============================================================================== + package org.fao.geonet.api.records.attachments; import jeeves.server.context.ServiceContext; @@ -125,23 +124,34 @@ protected int canEdit(ServiceContext context, String metadataUuid, MetadataResou boolean canEdit = getAccessManager(context).canEdit(context, String.valueOf(metadataId)); if ((visibility == null && !canEdit) || (visibility == MetadataResourceVisibility.PRIVATE && !canEdit)) { throw new SecurityException(String.format("User '%s' does not have privileges to access '%s' resources for metadata '%s'.", - context.getUserSession() != null ? - context.getUserSession().getUsername() + "/" + context.getUserSession() - .getProfile() : - "anonymous", visibility == null ? "any" : visibility, metadataUuid)); + context.userName(), visibility == null ? "any" : visibility, metadataUuid)); } return metadataId; } + /** + * + * @param context Service context used to determine user + * @param metadataUuid UUID of metadata record to check + * @param visibility resource visibility + * @param approved + * @return The metadata id used to access resources, obtained and approved from provided metadataUuid + * @throws Exception A security exception if the content is not allowed to access these resources + */ protected int canDownload(ServiceContext context, String metadataUuid, MetadataResourceVisibility visibility, Boolean approved) throws Exception { int metadataId = getAndCheckMetadataId(metadataUuid, approved); if (visibility == MetadataResourceVisibility.PRIVATE) { - boolean canDownload = getAccessManager(context).canDownload(context, String.valueOf(metadataId)); - if (!canDownload) { - throw new SecurityException(String.format( + if(context instanceof ServiceContext.AppHandlerServiceContext) { + // internal access granted + } + else { + boolean canDownload = getAccessManager(context).canDownload(context, String.valueOf(metadataId)); + if (!canDownload) { + throw new SecurityException(String.format( "Current user can't download resources for metadata '%s' and as such can't access the requested resource.", metadataUuid)); + } } } return metadataId; diff --git a/core/src/main/java/org/fao/geonet/kernel/AccessManager.java b/core/src/main/java/org/fao/geonet/kernel/AccessManager.java index 5ae066e1c55a..ea45a49a8577 100644 --- a/core/src/main/java/org/fao/geonet/kernel/AccessManager.java +++ b/core/src/main/java/org/fao/geonet/kernel/AccessManager.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -99,13 +99,27 @@ public class AccessManager { * perform on that metadata (an set of OPER_XXX as keys). If the user is authenticated the * permissions are taken from the groups the user belong. If the user is not authenticated, a * dynamic group is assigned depending on user location (0 for internal and 1 for external). + * + * @param context service context + * @param mdId metadata record to check + * @param ip IP Address used to determine base operations + * @return set of base operations along with any additional reserved operations available to user */ public Set getOperations(ServiceContext context, String mdId, String ip) throws Exception { return getOperations(context, mdId, ip, null); } /** - * TODO javadoc. + * Given a user(session) a list of groups and a metadata returns all operations that user can + * perform on that metadata (an set of OPER_XXX as keys). If the user is authenticated the + * permissions are taken from the groups the user belong. If the user is not authenticated, a + * dynamic group is assigned depending on user location (0 for internal and 1 for external). + * + * @param context service context + * @param mdId metadata record to check + * @param ip IP Address used to determine base operations (if not provided) + * @param operations base operations + * @return set of base operations along with any additional reserved operations available to user */ public Set getOperations(ServiceContext context, String mdId, String ip, Collection operations) throws Exception { Set results; diff --git a/core/src/main/java/org/fao/geonet/kernel/DataManager.java b/core/src/main/java/org/fao/geonet/kernel/DataManager.java index 500e5ab882c1..f76579667c0a 100644 --- a/core/src/main/java/org/fao/geonet/kernel/DataManager.java +++ b/core/src/main/java/org/fao/geonet/kernel/DataManager.java @@ -3,7 +3,7 @@ //=== DataManager //=== //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -122,24 +122,33 @@ public static void setNamespacePrefix(final Element md) { } /** - * Init Data manager and refresh index if needed. Can also be called after GeoNetwork startup in order to rebuild the lucene index + * Init data manager components. * - * @param force Force reindexing all from scratch + * @param context Service context used for setup **/ - public void init(ServiceContext context, Boolean force) throws Exception { - this.metadataIndexer.init(context, force); - this.metadataManager.init(context, force); - this.metadataUtils.init(context, force); + public void init(ServiceContext context) throws Exception { + this.metadataIndexer.init(context); + this.metadataManager.init(context); + this.metadataUtils.init(context); // FIXME this shouldn't login automatically ever! - if (context.getUserSession() == null) { - LOGGER_DATA_MANAGER.debug("Automatically login in as Administrator. Who is this? Who is calling this?"); - UserSession session = new UserSession(); - context.setUserSession(session); - session.loginAs(new User().setUsername("admin").setId(-1).setProfile(Profile.Administrator)); - LOGGER_DATA_MANAGER.debug("Hopefully this is cron job or routinely background task. Who called us?", - new Exception("Dummy Exception to know the stacktrace")); - } +// if (context.getUserSession() == null) { +// LOGGER_DATA_MANAGER.debug("Automatically login in as Administrator. Who is this? Who is calling this?"); +// UserSession session = new UserSession(); +// context.setUserSession(session); +// session.loginAs(new User().setUsername("admin").setId(-1).setProfile(Profile.Administrator)); +// LOGGER_DATA_MANAGER.debug("Hopefully this is cron job or routinely background task. Who called us?", +// new Exception("Dummy Exception to know the stacktrace")); +// } + } + + /** + * Clean up data manager during application shutdown. + */ + public void destroy() throws Exception { + this.metadataIndexer.destroy(); + this.metadataManager.destroy(); + this.metadataUtils.destroy(); } @Deprecated @@ -153,8 +162,8 @@ public synchronized void rebuildIndexForSelection(final ServiceContext context, } @Deprecated - public void batchIndexInThreadPool(ServiceContext context, List metadataIds) { - metadataIndexer.batchIndexInThreadPool(context, metadataIds); + public void batchIndexInThreadPool(List metadataIds) { + metadataIndexer.batchIndexInThreadPool(metadataIds); } @Deprecated diff --git a/core/src/main/java/org/fao/geonet/kernel/IndexMetadataTask.java b/core/src/main/java/org/fao/geonet/kernel/IndexMetadataTask.java index ac7db5535f35..9ad233a780ad 100644 --- a/core/src/main/java/org/fao/geonet/kernel/IndexMetadataTask.java +++ b/core/src/main/java/org/fao/geonet/kernel/IndexMetadataTask.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -25,11 +25,13 @@ import jeeves.server.context.ServiceContext; +import jeeves.server.dispatchers.ServiceManager; import org.fao.geonet.Util; import org.fao.geonet.constants.Geonet; import org.fao.geonet.domain.User; import org.fao.geonet.kernel.search.EsSearchManager; import org.fao.geonet.utils.Log; +import org.springframework.context.ConfigurableApplicationContext; import org.springframework.transaction.TransactionStatus; import java.io.IOException; @@ -45,28 +47,37 @@ */ public final class IndexMetadataTask implements Runnable { - private final ServiceContext _context; + private final String serviceName; + private final ServiceManager serviceManager; private final List _metadataIds; private final TransactionStatus _transactionStatus; private final Set _batchIndex; private final EsSearchManager searchManager; + private final ConfigurableApplicationContext appContext; private final AtomicInteger indexed; private User _user; /** - * Constructor. + * Setup index metadata task to be run. * - * @param context context object + * The context is used to look up beans for setup and configuration only. The task will create its own serviceContext + * to be used during indexing. + * + * @param context context object responsible for starting the activity * @param metadataIds the metadata ids to index (either integers or strings) + * @param batchIndex Set used to track outstanding tasks * @param transactionStatus if non-null, wait for the transaction to complete before indexing + * @param indexed Used to track number of indexed records */ public IndexMetadataTask(@Nonnull ServiceContext context, @Nonnull List metadataIds, Set batchIndex, @Nullable TransactionStatus transactionStatus, @Nonnull AtomicInteger indexed) { this.indexed = indexed; this._transactionStatus = transactionStatus; - this._context = context; + this.serviceName = context.getService(); this._metadataIds = metadataIds; this._batchIndex = batchIndex; + this.serviceManager = context.getBean(ServiceManager.class); + this.appContext = context.getApplicationContext(); this.searchManager = context.getBean(EsSearchManager.class); batchIndex.add(this); @@ -76,9 +87,17 @@ public IndexMetadataTask(@Nonnull ServiceContext context, @Nonnull List metad } } + /** + * Perform index task in a seperate thread. + *

+ * Task waits for transactionStatus (if available) to be completed, and for servlet to be initialized. + *

+ */ + @Override public void run() { - try { - _context.setAsThreadLocal(); + try (ServiceContext indexMedataContext = serviceManager.createServiceContext(serviceName+":IndexTask", appContext)) { + indexMedataContext.setAsThreadLocal(); + indexMedataContext.setAsThreadLocal(); while (_transactionStatus != null && !_transactionStatus.isCompleted()) { try { Thread.sleep(100); @@ -87,7 +106,7 @@ public void run() { } } // poll context to see whether servlet is up yet - while (!_context.isServletInitialized()) { + while (!indexMedataContext.isServletInitialized()) { if (Log.isDebugEnabled(Geonet.DATA_MANAGER)) { Log.debug(Geonet.DATA_MANAGER, "Waiting for servlet to finish initializing.."); } @@ -98,7 +117,7 @@ public void run() { } } - DataManager dataManager = _context.getBean(DataManager.class); + DataManager dataManager = indexMedataContext.getBean(DataManager.class); // servlet up so safe to index all metadata that needs indexing for (Object metadataId : _metadataIds) { this.indexed.incrementAndGet(); @@ -113,8 +132,8 @@ public void run() { + "\n" + Util.getStackTrace(e)); } } - if (_user != null && _context.getUserSession().getUserId() == null) { - _context.getUserSession().loginAs(_user); + if (_user != null && indexMedataContext.getUserSession().getUserId() == null) { + indexMedataContext.getUserSession().loginAs(_user); } searchManager.forceIndexChanges(); } finally { diff --git a/core/src/main/java/org/fao/geonet/kernel/SvnManager.java b/core/src/main/java/org/fao/geonet/kernel/SvnManager.java index 798b4b07814f..620df3e7eace 100644 --- a/core/src/main/java/org/fao/geonet/kernel/SvnManager.java +++ b/core/src/main/java/org/fao/geonet/kernel/SvnManager.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -90,11 +90,19 @@ import static org.fao.geonet.kernel.setting.Settings.METADATA_VCS; +/** + * Subversion manager. + */ public class SvnManager implements AfterCommitTransactionListener, BeforeRollbackTransactionListener { private static String username = "geonetwork"; private static String password = "geonetwork"; // configure via setter in Geonetwork app - private ServiceContext context; + /** + * Shared application handler service context provided by GeoNetwork application for bean lookup. + * + * In most cases a ServiceContext is provided for access ot the user session. + */ + private ServiceContext appHandlerContext; // configure in init method private SVNURL repoUrl; // configure in spring configuration of bean @@ -279,7 +287,7 @@ public void setSubversionPath(String subversionPath) { } public void setContext(ServiceContext context) { - this.context = context; + this.appHandlerContext = context; } /** @@ -553,7 +561,7 @@ public void commitMetadata(String id, ISVNEditor editor) throws Exception { return; } - DataManager dataMan = context.getBean(DataManager.class); + DataManager dataMan = appHandlerContext.getBean(DataManager.class); try { // get the metadata record and if different commit changes @@ -694,8 +702,8 @@ private void commitMetadataOwner(ISVNEditor editor, String id) throws Exception // get owner from the database Set ids = new HashSet(); ids.add(Integer.valueOf(id)); - AbstractMetadata metadata = this.context.getBean(IMetadataUtils.class).findOne(id); - User user = this.context.getBean(UserRepository.class).findById(metadata.getSourceInfo().getOwner()).get(); + AbstractMetadata metadata = appHandlerContext.getBean(IMetadataUtils.class).findOne(id); + User user = appHandlerContext.getBean(UserRepository.class).findById(metadata.getSourceInfo().getOwner()).get(); // Backwards compatibility. Format the metadata as XML in same format as previous versions. Element xml = new Element("results").addContent( new Element("record") diff --git a/core/src/main/java/org/fao/geonet/kernel/ThesaurusManager.java b/core/src/main/java/org/fao/geonet/kernel/ThesaurusManager.java index f86346c9b334..ff0cfe1060fb 100644 --- a/core/src/main/java/org/fao/geonet/kernel/ThesaurusManager.java +++ b/core/src/main/java/org/fao/geonet/kernel/ThesaurusManager.java @@ -1,4 +1,4 @@ -//=== Copyright (C) 2001-2005 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -43,6 +43,7 @@ import javax.annotation.Nonnull; import javax.annotation.Nullable; +import jeeves.server.dispatchers.ServiceManager; import org.fao.geonet.Util; import org.fao.geonet.constants.Geonet; import org.fao.geonet.domain.AbstractMetadata; @@ -73,6 +74,7 @@ import jeeves.server.context.ServiceContext; import jeeves.xlink.Processor; +import org.springframework.context.ConfigurableApplicationContext; public class ThesaurusManager implements ThesaurusFinder { @@ -149,7 +151,17 @@ private void batchBuildTable(boolean synchRun, ServiceContext context, Path thes try { Runnable worker = new InitThesauriTableTask(context, thesauriDir); if (synchRun) { - worker.run(); + ServiceContext restore = ServiceContext.get(); + try { + if( restore != null){ + restore.clearAsThreadLocal(); + } + worker.run(); + } finally { + if( restore != null){ + restore.setAsThreadLocal(); + } + } } else { executor = Executors.newFixedThreadPool(1); executor.execute(worker); @@ -546,17 +558,20 @@ public Element buildResultfromThTable(ServiceContext context) throws SQLExceptio */ final class InitThesauriTableTask implements Runnable { - private final ServiceContext context; + //private final ServiceContext context; private final Path thesauriDir; + private final ServiceManager serviceManager; + private final ConfigurableApplicationContext appContext; InitThesauriTableTask(ServiceContext context, Path thesauriDir) { - this.context = context; + //this.context = context; + this.serviceManager = context.getBean(ServiceManager.class); + this.appContext = context.getApplicationContext(); this.thesauriDir = thesauriDir; } public void run() { - context.setAsThreadLocal(); - try { + try (ServiceContext context = serviceManager.createServiceContext(Geonet.THESAURUS_MAN, appContext)) { // poll context to see whether servlet is up yet while (!context.isServletInitialized()) { if (Log.isDebugEnabled(Geonet.THESAURUS_MAN)) { diff --git a/core/src/main/java/org/fao/geonet/kernel/backup/ArchiveAllMetadataJob.java b/core/src/main/java/org/fao/geonet/kernel/backup/ArchiveAllMetadataJob.java index a0edb9b06e4a..1a707308c5e0 100644 --- a/core/src/main/java/org/fao/geonet/kernel/backup/ArchiveAllMetadataJob.java +++ b/core/src/main/java/org/fao/geonet/kernel/backup/ArchiveAllMetadataJob.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -93,22 +93,25 @@ public class ArchiveAllMetadataJob extends QuartzJobBean { @Override protected void executeInternal(JobExecutionContext jobContext) throws JobExecutionException { - ServiceContext serviceContext = serviceManager.createServiceContext("backuparchive", context); - serviceContext.setLanguage("eng"); - serviceContext.setAsThreadLocal(); + try (ServiceContext serviceContext = serviceManager.createServiceContext("backuparchive", context)) { + serviceContext.setLanguage("eng"); + serviceContext.setAsThreadLocal(); - ApplicationContextHolder.set(this.context); + // note: perhaps already done by setAsThreadLocal() above + ApplicationContextHolder.set(this.context); - if(!settingManager.getValueAsBool(Settings.METADATA_BACKUPARCHIVE_ENABLE)) { - Log.info(BACKUP_LOG, "Backup archive not enabled"); - return; - } + if(!settingManager.getValueAsBool(Settings.METADATA_BACKUPARCHIVE_ENABLE)) { + Log.info(BACKUP_LOG, "Backup archive not enabled"); + return; + } - try { - createBackup(serviceContext); - } catch (Exception e) { - Log.error(Geonet.GEONETWORK, "Error running " + ArchiveAllMetadataJob.class.getSimpleName(), e); + try { + createBackup(serviceContext); + } catch (Exception e) { + Log.error(Geonet.GEONETWORK, "Error running " + ArchiveAllMetadataJob.class.getSimpleName(), e); + } } + } public void createBackup(ServiceContext serviceContext) throws Exception { diff --git a/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataIndexer.java b/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataIndexer.java index 5c2a00a8d5b7..d6cd000c7758 100644 --- a/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataIndexer.java +++ b/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataIndexer.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -43,12 +43,21 @@ public interface IMetadataIndexer { /** - * This is a hopefully soon to be deprecated when no deps on context - * - * @param context + * Setup metadata indexer using app service context. + * + * This is a hopefully soon to be deprecated when no deps on context. + * + * @param context App Service context used for initial setup + * @throws Exception + */ + void init(ServiceContext context) throws Exception; + + /** + * Clean up when service is not in use. + * * @throws Exception */ - public void init(ServiceContext context, Boolean force) throws Exception; + void destroy() throws Exception; /** * Force the index to wait until all changes are processed and the next reader obtained will get the latest data. @@ -78,10 +87,9 @@ public interface IMetadataIndexer { * Index multiple metadata in a separate thread. Wait until the current transaction commits before starting threads (to make sure that * all metadata are committed). * - * @param context context object * @param metadataIds the metadata ids to index */ - void batchIndexInThreadPool(ServiceContext context, List metadataIds); + void batchIndexInThreadPool(List metadataIds); /** * Is the platform currently indexing? diff --git a/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataManager.java b/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataManager.java index 006b49340d7b..4825bc6ea75f 100644 --- a/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataManager.java +++ b/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataManager.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -53,11 +53,17 @@ public interface IMetadataManager { /** * This is a hopefully soon to be deprecated initialization function to replace the @Autowired annotation * - * @param context - * @param force + * @param context ServiceContext used for initialization + * @throws Exception + */ + void init(ServiceContext context) throws Exception; + + /** + * Clean up metadata manager during application shutdown. + * * @throws Exception */ - public void init(ServiceContext context, Boolean force) throws Exception; + void destroy() throws Exception; /** * Removes the record with the id metadataId diff --git a/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataUtils.java b/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataUtils.java index 4dc52beb5b64..498d5b4e2366 100644 --- a/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataUtils.java +++ b/core/src/main/java/org/fao/geonet/kernel/datamanager/IMetadataUtils.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -50,21 +50,28 @@ import jeeves.server.context.ServiceContext; /** - * Utility interface for records + * Utility interface for working with records. * - * @author delawen + * Operates as a facade with utility methods orchestrating common operations using a constellation + * beans drawn from across the application. * + * @author delawen */ public interface IMetadataUtils { /** * This is a hopefully soon to be deprecated initialization function to replace the @Autowired annotation * - * @param context - * @param force + * @param appHandlerContext this is the app handler context from jeeves initialization + * @throws Exception + */ + public void init(ServiceContext appHandlerContext) throws Exception; + + /** + * Clean up during application shutdown. * @throws Exception */ - public void init(ServiceContext context, Boolean force) throws Exception; + public void destroy() throws Exception; /** * Return the uuid of the record with the defined id diff --git a/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataIndexer.java b/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataIndexer.java index 6bc9c08aec4b..4989e7c7cd54 100644 --- a/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataIndexer.java +++ b/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataIndexer.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -27,6 +27,7 @@ import com.google.common.collect.Multimap; import jeeves.server.UserSession; import jeeves.server.context.ServiceContext; +import jeeves.server.dispatchers.ServiceManager; import jeeves.xlink.Processor; import org.apache.commons.lang.StringUtils; import org.eclipse.jetty.util.ConcurrentHashSet; @@ -71,7 +72,15 @@ import java.util.concurrent.Executors; import java.util.concurrent.atomic.AtomicInteger; - +/** + * Metadata indexer responsible for updating index in a background executor. + * + * Helper method exist to schedule records for reindex by id. These methods make use of the service context + * of the current thread if needed to access user session. + * + * This class maintains its own service context for use in the background, and does not have access + * to a user session. + */ public class BaseMetadataIndexer implements IMetadataIndexer, ApplicationEventPublisherAware { @Autowired @@ -110,16 +119,28 @@ public class BaseMetadataIndexer implements IMetadataIndexer, ApplicationEventPu @Autowired private Resources resources; - // FIXME remove when get rid of Jeeves - private ServiceContext servContext; - private ApplicationEventPublisher publisher; + /** Private service context managed by service init / destroy for use by metadata indexing tasks. */ + private ServiceContext indexMetadataTaskContext; + public BaseMetadataIndexer() { } - public void init(ServiceContext context, Boolean force) throws Exception { - servContext = context; + public void init(ServiceContext context) throws Exception { + ServiceManager serviceManager = context.getBean(ServiceManager.class); + if( indexMetadataTaskContext == null ) { + indexMetadataTaskContext = serviceManager.createServiceContext("_indexMetadataTask", context); + } else { + context.getLogger().debug("Metadata Indexer already initialized"); + } + } + + public void destroy(){ + if (indexMetadataTaskContext != null) { + indexMetadataTaskContext.clear(); + indexMetadataTaskContext = null; + } } @Override @@ -210,7 +231,7 @@ public synchronized void rebuildIndexXLinkedMetadata(final ServiceContext contex stringIds.add(id.toString()); } // execute indexing operation - batchIndexInThreadPool(context, stringIds); + batchIndexInThreadPool(stringIds); } } @@ -247,7 +268,7 @@ public synchronized void rebuildIndexForSelection(final ServiceContext context, } // execute indexing operation - batchIndexInThreadPool(context, listOfIdsToIndex); + batchIndexInThreadPool(listOfIdsToIndex); } } @@ -256,11 +277,10 @@ public synchronized void rebuildIndexForSelection(final ServiceContext context, * transaction commits before starting threads (to make sure that all metadata * are committed). * - * @param context context object * @param metadataIds the metadata ids to index */ @Override - public void batchIndexInThreadPool(ServiceContext context, List metadataIds) { + public void batchIndexInThreadPool(List metadataIds) { TransactionStatus transactionStatus = null; try { @@ -299,11 +319,11 @@ public void batchIndexInThreadPool(ServiceContext context, List metadataIds) } // create threads to process this chunk of ids - Runnable worker = new IndexMetadataTask(context, subList, batchIndex, transactionStatus, numIndexedTracker); + Runnable worker = new IndexMetadataTask(indexMetadataTaskContext, subList, batchIndex, transactionStatus, numIndexedTracker); executor.execute(worker); index += count; } - + // let the started threads finish in the background and then clean up executor executor.shutdown(); } @@ -324,6 +344,10 @@ public void indexMetadata(final String metadataId, final boolean forceRefreshRea throws Exception { AbstractMetadata fullMd; + if (searchManager == null) { + searchManager = getServiceContext().getBean(EsSearchManager.class); + } + try { Multimap fields = ArrayListMultimap.create(); int id$ = Integer.parseInt(metadataId); @@ -348,6 +372,11 @@ public void indexMetadata(final String metadataId, final boolean forceRefreshRea } fullMd = metadataUtils.findOne(id$); + if( fullMd == null){ + // Metadata record has been subsequently deleted + searchManager.delete(metadataId); + return; + } final String schema = fullMd.getDataInfo().getSchemaId(); final String createDate = fullMd.getDataInfo().getCreateDate().getDateAndTime(); @@ -614,9 +643,17 @@ public void versionMetadata(ServiceContext context, String id, Element md) throw } } - private ServiceContext getServiceContext() { + /** + * Service context for the current thread if available, or the one provided during init. + * + * @return service context for current thread if available, or service context used during init. + */ + protected ServiceContext getServiceContext() { ServiceContext context = ServiceContext.get(); - return context == null ? servContext : context; + if( context != null ){ + return context; // use ServiceContext from current ThreadLocal + } + return indexMetadataTaskContext; // backup ServiceContext provided during init } public void setApplicationEventPublisher(ApplicationEventPublisher publisher) { diff --git a/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataManager.java b/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataManager.java index ef9ed62c4185..70c7785faeea 100644 --- a/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataManager.java +++ b/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataManager.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2020 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -159,9 +159,15 @@ public void init() { metadataIndexer.setMetadataManager(this); } - public void init(ServiceContext context, Boolean force) throws Exception { + /** + * Setup using app handler service context. + * + * @param appHandlerServiceContext + * @throws Exception + */ + public void init(ServiceContext appHandlerServiceContext) throws Exception { try { - harvestInfoProvider = context.getBean(HarvestInfoProvider.class); + harvestInfoProvider = appHandlerServiceContext.getBean(HarvestInfoProvider.class); } catch (Exception e) { // If it doesn't exist, that's fine } @@ -170,6 +176,10 @@ public void init(ServiceContext context, Boolean force) throws Exception { searchManager.init(false, java.util.Optional.empty()); } + @Override + public void destroy() throws Exception { + } + /** * Refresh index if needed. Can also be called after GeoNetwork startup in * order to rebuild the lucene index @@ -240,7 +250,7 @@ public void synchronizeDbWithIndex(ServiceContext context, Boolean force, Boolea context.getBean(DataManager.class), integerList).process(false); } else { - metadataIndexer.batchIndexInThreadPool(context, toIndex); + metadataIndexer.batchIndexInThreadPool(toIndex); } } diff --git a/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataUtils.java b/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataUtils.java index fd9987153266..f281fa86fdbd 100644 --- a/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataUtils.java +++ b/core/src/main/java/org/fao/geonet/kernel/datamanager/base/BaseMetadataUtils.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -68,7 +68,11 @@ public class BaseMetadataUtils implements IMetadataUtils { @Autowired private MetadataRepository metadataRepository; - // FIXME Remove when get rid of Jeeves + /** + * Shared application handler service context. + * + * Used by {@link #getServiceContext()} if current service context unavailable. + */ private ServiceContext servContext; @Autowired protected IMetadataSchemaUtils metadataSchemaUtils; @@ -103,8 +107,8 @@ public void setMetadataManager(IMetadataManager metadataManager) { this.metadataManager = metadataManager; } - public void init(ServiceContext context, Boolean force) throws Exception { - servContext = context; + public void init(ServiceContext appHandlerContext) throws Exception { + servContext = appHandlerContext; stylePath = dataDirectory.resolveWebResource(Geonet.Path.STYLESHEETS); } @@ -116,6 +120,10 @@ public void init() { this.metadataIndexer.setMetadataUtils(this); } + @Override + public void destroy() throws Exception { + servContext = null; + } /** * @param id * @return diff --git a/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataIndexer.java b/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataIndexer.java index 9def9ac9f4e0..3da495315a9b 100644 --- a/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataIndexer.java +++ b/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataIndexer.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -39,6 +39,9 @@ import java.util.HashMap; import java.util.Map; +/** + * MetadataIndexer for indexing draft content in a background executor (see super class for details). + */ public class DraftMetadataIndexer extends BaseMetadataIndexer implements IMetadataIndexer { @Autowired @@ -48,8 +51,8 @@ public class DraftMetadataIndexer extends BaseMetadataIndexer implements IMetada EsSearchManager searchManager; @Override - public void init(ServiceContext context, Boolean force) throws Exception { - super.init(context, force); + public void init(ServiceContext context) throws Exception { + super.init(context); metadataDraftRepository = context.getBean(MetadataDraftRepository.class); } diff --git a/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataManager.java b/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataManager.java index 9872a5476bf7..6256b0d31a81 100644 --- a/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataManager.java +++ b/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataManager.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -59,9 +59,9 @@ public void init() { super.init(); } - public void init(ServiceContext context, Boolean force) throws Exception { + public void init(ServiceContext context) throws Exception { metadataDraftRepository = context.getBean(MetadataDraftRepository.class); - super.init(context, force); + super.init(context); } diff --git a/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataUtils.java b/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataUtils.java index 957cf2a48c69..06156f2be464 100644 --- a/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataUtils.java +++ b/core/src/main/java/org/fao/geonet/kernel/datamanager/draft/DraftMetadataUtils.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -88,9 +88,8 @@ public class DraftMetadataUtils extends BaseMetadataUtils { private ServiceContext context; - public void init(ServiceContext context, Boolean force) throws Exception { - this.context = context; - super.init(context, force); + public void init(ServiceContext appHandlerContext) throws Exception { + super.init(appHandlerContext); } @Override @@ -249,7 +248,7 @@ public boolean existsMetadataUuid(String uuid) throws Exception { public AbstractMetadata findOneByUuid(String uuid) { AbstractMetadata md = super.findOneByUuid(uuid); try { - if (md != null && am.canEdit(context, Integer.toString(md.getId()))) { + if (md != null && am.canEdit(getServiceContext(), Integer.toString(md.getId()))) { AbstractMetadata tmp = metadataDraftRepository.findOneByUuid(uuid); if (tmp != null) { md = tmp; @@ -560,8 +559,8 @@ protected String createDraft(ServiceContext context, String templateId, String g // --- use StatusActionsFactory and StatusActions class to // --- change status and carry out behaviours for status changes - StatusActionsFactory saf = context.getBean(StatusActionsFactory.class); - StatusActions sa = saf.createStatusActions(context); + StatusActionsFactory statusActionsFactory = context.getBean(StatusActionsFactory.class); + StatusActions statusActions = statusActionsFactory.createStatusActions(context); int author = context.getUserSession().getUserIdAsInt(); Integer status = Integer.valueOf(StatusValue.Status.DRAFT); @@ -580,7 +579,7 @@ protected String createDraft(ServiceContext context, String templateId, String g List listOfStatusChange = new ArrayList<>(1); listOfStatusChange.add(metadataStatus); - sa.onStatusChange(listOfStatusChange); + statusActions.onStatusChange(listOfStatusChange); } } @@ -594,7 +593,7 @@ protected String createDraft(ServiceContext context, String templateId, String g @Override public void cloneFiles(AbstractMetadata original, AbstractMetadata dest) { try { - StoreUtils.copyDataDir(context, original.getUuid(), dest.getUuid(), false); + StoreUtils.copyDataDir(getServiceContext(), original.getUuid(), dest.getUuid(), false); cloneStoreFileUploadRequests(original, dest); } catch (Exception ex) { @@ -614,7 +613,7 @@ public void replaceFiles(AbstractMetadata original, AbstractMetadata dest) { oldApproved=false; newApproved=true; } - StoreUtils.replaceDataDir(context, original.getUuid(), dest.getUuid(), oldApproved, newApproved); + StoreUtils.replaceDataDir(getServiceContext(), original.getUuid(), dest.getUuid(), oldApproved, newApproved); cloneStoreFileUploadRequests(original, dest); } catch (Exception ex) { @@ -653,7 +652,7 @@ public void cancelEditingSession(ServiceContext context, String id) throws Excep * Stores a file upload request in the MetadataFileUploads table. */ private void cloneStoreFileUploadRequests(AbstractMetadata original, AbstractMetadata copy) { - MetadataFileUploadRepository repo = context.getBean(MetadataFileUploadRepository.class); + MetadataFileUploadRepository repo = getServiceContext().getBean(MetadataFileUploadRepository.class); repo.deleteAll(MetadataFileUploadSpecs.hasMetadataId(copy.getId())); diff --git a/core/src/main/java/org/fao/geonet/kernel/metadata/DefaultStatusActions.java b/core/src/main/java/org/fao/geonet/kernel/metadata/DefaultStatusActions.java index 2f1b550e6380..fcb6e7820490 100644 --- a/core/src/main/java/org/fao/geonet/kernel/metadata/DefaultStatusActions.java +++ b/core/src/main/java/org/fao/geonet/kernel/metadata/DefaultStatusActions.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -72,6 +72,8 @@ public class DefaultStatusActions implements StatusActions { public static final Pattern metadataLuceneField = Pattern.compile("\\{\\{index:([^\\}]+)\\}\\}"); + + /** Externally managed service context */ protected ServiceContext context; protected String language; protected DataManager dm; @@ -152,8 +154,8 @@ public void onEdit(int id, boolean minorEdit) throws Exception { /** * Called when a record status is added. * - * @param listOfStatus - * @return + * @param listOfStatus List of status to update + * @return Ids of unchanged metadata records * @throws Exception */ public Set onStatusChange(List listOfStatus) throws Exception { @@ -195,18 +197,39 @@ public Set onStatusChange(List listOfStatus) throws Exc status.getMetadataId(), status.getStatusValue().getId(), e.getMessage())); } - //Throw events - Log.trace(Geonet.DATA_MANAGER, "Throw workflow events."); + // Issue events + Log.trace(Geonet.DATA_MANAGER, "Issue workflow events."); + + List unsuccessful = new ArrayList<>(); + Throwable statusChangeFailure = null; for (Integer mid : listOfId) { if (!unchanged.contains(mid)) { - Log.debug(Geonet.DATA_MANAGER, " > Status changed for record (" + mid + ") to status " + status); - context.getApplicationContext().publishEvent(new MetadataStatusChanged( - metadataUtils.findOne(Integer.valueOf(mid)), - status.getStatusValue(), status.getChangeMessage(), - status.getUserId())); + try { + Log.debug(Geonet.DATA_MANAGER, " > Status changed for record (" + mid + ") to status " + status); + context.getApplicationContext().publishEvent(new MetadataStatusChanged( + metadataUtils.findOne(Integer.valueOf(mid)), + status.getStatusValue(), status.getChangeMessage(), + status.getUserId())); + } catch (Exception error) { + Log.error(Geonet.DATA_MANAGER, + String.format("Failed to update metadata %s to status %s. Error is: %s", + mid, status.getStatusValue(), error.getMessage()), + error + ); + unsuccessful.add(String.valueOf(mid)); + if( statusChangeFailure == null ){ + statusChangeFailure = error; + } + } } } - + if (!unsuccessful.isEmpty()){ + throw new Exception( + "Unable to change status for metadata records: "+ + String.join(",", unsuccessful), + statusChangeFailure + ); + } } return unchanged; diff --git a/core/src/main/java/org/fao/geonet/kernel/metadata/StatusActions.java b/core/src/main/java/org/fao/geonet/kernel/metadata/StatusActions.java index 216555857387..f3e2395041aa 100644 --- a/core/src/main/java/org/fao/geonet/kernel/metadata/StatusActions.java +++ b/core/src/main/java/org/fao/geonet/kernel/metadata/StatusActions.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -31,12 +31,32 @@ import org.fao.geonet.domain.ISODate; import org.fao.geonet.domain.MetadataStatus; +/** + * Facade performing actions with record status. + */ public interface StatusActions { - public void init(ServiceContext context) throws Exception; - - public void onEdit(int id, boolean minorEdit) throws Exception; - - public Set onStatusChange(List status) throws Exception; + /** + * Setup using provided externally managed service context. + * + * @param context Externally managed service context. + */ + void init(ServiceContext context) throws Exception; + + /** + * Called when a record is edited to set/reset status. + * + * @param id The metadata id that has been edited. + * @param minorEdit If true then the edit was a minor edit. + */ + void onEdit(int id, boolean minorEdit) throws Exception; + + /** + * Called when a record status is added. + * + * @param statusList List of status to update + * @return Ids of unchanged metadata records + */ + Set onStatusChange(List statusList) throws Exception; } diff --git a/core/src/main/java/org/fao/geonet/kernel/metadata/StatusActionsFactory.java b/core/src/main/java/org/fao/geonet/kernel/metadata/StatusActionsFactory.java index 3d9222958ac0..4fcb52f79141 100644 --- a/core/src/main/java/org/fao/geonet/kernel/metadata/StatusActionsFactory.java +++ b/core/src/main/java/org/fao/geonet/kernel/metadata/StatusActionsFactory.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2011 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -30,29 +30,39 @@ import java.lang.reflect.Constructor; +/** + * Handle creation of {@link StatusActions} instances. + */ public class StatusActionsFactory { Class statusRules; + /** + * StatusAction implementation configured for creation. + */ private String className; private static final String DEFAULT_STATUS_ACTION_CLASS = "org.fao.geonet.kernel.metadata.DefaultStatusActions"; /** - * Constructor. - * + * Setup factory with default StatusActions implementation. */ public StatusActionsFactory() { new StatusActionsFactory(DEFAULT_STATUS_ACTION_CLASS); } + + /** + * Setup factory to use named StatusActions implementation. + * @param className StatusActions implementation + */ public StatusActionsFactory(String className) { this.className = className; try { this.statusRules = (Class) Class.forName(this.className); } catch (ClassNotFoundException e) { - Log.error(Geonet.DATA_MANAGER, String.format( + Log.warning(Geonet.DATA_MANAGER, String.format( "Class name '%s' is not found. You MUST use a valid class name loaded in the classpath. " + "The default status action class is used (ie. %s)", - this.className + this.className, DEFAULT_STATUS_ACTION_CLASS )); try { this.statusRules = (Class) Class.forName(DEFAULT_STATUS_ACTION_CLASS); @@ -63,7 +73,6 @@ public StatusActionsFactory(String className) { )); } } - } /** @@ -72,10 +81,11 @@ public StatusActionsFactory(String className) { * @param context ServiceContext from Jeeves */ public StatusActions createStatusActions(ServiceContext context) throws Exception { - Constructor ct = this.statusRules.getConstructor(); - StatusActions sa = ct.newInstance(); - sa.init(context); - return sa; + Constructor constructor = this.statusRules.getConstructor(); + StatusActions statusAction = constructor.newInstance(); + statusAction.init(context); + + return statusAction; } public String getClassName() { diff --git a/core/src/main/java/org/fao/geonet/kernel/search/index/IndexingTask.java b/core/src/main/java/org/fao/geonet/kernel/search/index/IndexingTask.java index dfb4eb305ec0..ede87802b8a0 100644 --- a/core/src/main/java/org/fao/geonet/kernel/search/index/IndexingTask.java +++ b/core/src/main/java/org/fao/geonet/kernel/search/index/IndexingTask.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2014 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -83,14 +83,15 @@ private void indexRecords() { @Override protected void executeInternal(JobExecutionContext jobContext) throws JobExecutionException { - ServiceContext serviceContext = serviceManager.createServiceContext("indexing", applicationContext); - serviceContext.setLanguage("eng"); - serviceContext.setAsThreadLocal(); + try (ServiceContext serviceContext = serviceManager.createServiceContext("indexing", applicationContext)) { + serviceContext.setLanguage("eng"); + serviceContext.setAsThreadLocal(); - if (Log.isDebugEnabled(Geonet.INDEX_ENGINE)) { - Log.debug(Geonet.INDEX_ENGINE, "Indexing task / Start at: " - + new Date() + ". Checking if any records need to be indexed ..."); + if (Log.isDebugEnabled(Geonet.INDEX_ENGINE)) { + Log.debug(Geonet.INDEX_ENGINE, "Indexing task / Start at: " + + new Date() + ". Checking if any records need to be indexed ..."); + } + indexRecords(); } - indexRecords(); } } diff --git a/core/src/main/java/org/fao/geonet/kernel/thumbnail/ThumbnailMaker.java b/core/src/main/java/org/fao/geonet/kernel/thumbnail/ThumbnailMaker.java index 3ac0fa272d77..a80a7e533ff8 100644 --- a/core/src/main/java/org/fao/geonet/kernel/thumbnail/ThumbnailMaker.java +++ b/core/src/main/java/org/fao/geonet/kernel/thumbnail/ThumbnailMaker.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2014 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -110,6 +110,11 @@ public static BufferedImage rotate(BufferedImage image, double angle) { return result; } + /** + * Setup for use based on service context configuration. + * + * @param context AppService context used to look up configuration details + */ public void init(ServiceContext context) { configFilePath = context.getAppPath() + File.separator + CONFIG_FILE; initMapPrinter(); diff --git a/core/src/main/java/org/fao/geonet/lib/NetLib.java b/core/src/main/java/org/fao/geonet/lib/NetLib.java index c47e52e34d65..15feb82f0f05 100644 --- a/core/src/main/java/org/fao/geonet/lib/NetLib.java +++ b/core/src/main/java/org/fao/geonet/lib/NetLib.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -97,6 +97,14 @@ public void setupProxy(SettingManager sm, XmlRequest req) { //--------------------------------------------------------------------------- + /** + * Setup proxy for http client + * + * @param context Service context used to lookup settings. + * @param client Http implementation + * @param requestHost + * @return + */ public CredentialsProvider setupProxy(ServiceContext context, HttpClientBuilder client, String requestHost) { GeonetContext gc = (GeonetContext) context.getHandlerContext(Geonet.CONTEXT_NAME); SettingManager sm = gc.getBean(SettingManager.class); @@ -106,6 +114,9 @@ public CredentialsProvider setupProxy(ServiceContext context, HttpClientBuilder /** * Setup proxy for http client + * @param sm settings + * @param client Http implementation + * @param requestHost */ public CredentialsProvider setupProxy(SettingManager sm, HttpClientBuilder client, String requestHost) { boolean enabled = sm.getValueAsBool(Settings.SYSTEM_PROXY_USE, false); diff --git a/core/src/main/java/org/fao/geonet/resources/Resources.java b/core/src/main/java/org/fao/geonet/resources/Resources.java index ed9cc4f2cba6..02b535e2daaf 100644 --- a/core/src/main/java/org/fao/geonet/resources/Resources.java +++ b/core/src/main/java/org/fao/geonet/resources/Resources.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -283,18 +283,20 @@ public void copyLogo(ServiceContext context, String icon, try { Path srcPath = locateResource(locateResourcesDir(context), servletContext, appDir, icon); String extension = Files.getFileExtension(srcPath.getFileName().toString()); - try(ResourceHolder src = getImage(context, srcPath.getFileName().toString(), srcPath.getParent()); - ResourceHolder des = getWritableImage(context, destName + "." + extension, - logosDir)) { - if (src != null) { - java.nio.file.Files.copy(src.getPath(), des.getPath(), REPLACE_EXISTING, NOFOLLOW_LINKS); - } else { - des.abort(); + try(ResourceHolder src = getImage(context, srcPath.getFileName().toString(), srcPath.getParent())){ + if( src == null) { + throw new IOException("Resource not found: "+srcPath.toString()); + } + try (ResourceHolder des = getWritableImage(context, destName + "." + extension, logosDir)) { + if (src != null) { + java.nio.file.Files.copy(src.getPath(), des.getPath(), REPLACE_EXISTING, NOFOLLOW_LINKS); + } else { + des.abort(); + } } } } catch (IOException e) { // --- we ignore exceptions here, just log them - context.warning("Cannot copy icon -> " + e.getMessage()); context.warning(" (C) Source : " + icon); context.warning(" (C) Destin : " + logosDir); diff --git a/core/src/main/java/org/fao/geonet/services/util/z3950/provider/GN/GNResultSet.java b/core/src/main/java/org/fao/geonet/services/util/z3950/provider/GN/GNResultSet.java index cfa1c7637a94..1a41129429a3 100644 --- a/core/src/main/java/org/fao/geonet/services/util/z3950/provider/GN/GNResultSet.java +++ b/core/src/main/java/org/fao/geonet/services/util/z3950/provider/GN/GNResultSet.java @@ -49,7 +49,8 @@ public class GNResultSet extends AbstractIRResultSet implements IRResultSet { private GNXMLQuery query; - private ServiceContext srvxtx; + /** Service context assumed to be shared */ + private ServiceContext appHandlerContext; private int status; private int fragmentcount; @@ -61,7 +62,7 @@ public GNResultSet(GNXMLQuery query, Object userInfo, Observer[] observers, ServiceContext srvctx) throws Exception { super(observers); this.query = query; - this.srvxtx = srvctx; + this.appHandlerContext = srvctx; throw new NotImplementedException("Z39.50 not implemented in ES"); // try { // @@ -78,6 +79,16 @@ public GNResultSet(GNXMLQuery query, Object userInfo, Observer[] observers, // } } + /** + * Access the current ServiceContext if available. + * + * @return current service context if available, or app handler context fallback. + */ + protected ServiceContext getServiceContext(){ + ServiceContext serviceContext = ServiceContext.get(); + return serviceContext != null ? serviceContext : appHandlerContext; + } + public int evaluate(int timeout) { try { if (Log.isDebugEnabled(Geonet.SRU)) @@ -96,7 +107,7 @@ public int evaluate(int timeout) { // perform the search and save search results - metasearcher.search(this.srvxtx, request, config); + metasearcher.search(getServiceContext(), request, config); // System.out.println("summary:\n" + Xml.getString(s.getSummary())); // // DEBUG @@ -136,7 +147,7 @@ public InformationFragment[] getFragment(int startingFragment, int count, Log.debug(Geonet.SRU, "Search request:\n" + Xml.getString(request)); // get result set - Element result = this.metasearcher.present(this.srvxtx, request, + Element result = this.metasearcher.present(getServiceContext(), request, config); if (Log.isDebugEnabled(Geonet.SRU)) diff --git a/core/src/main/java/org/fao/geonet/services/util/z3950/provider/GN/GNSearchable.java b/core/src/main/java/org/fao/geonet/services/util/z3950/provider/GN/GNSearchable.java index 18c53e711bde..016f1d80a6f5 100644 --- a/core/src/main/java/org/fao/geonet/services/util/z3950/provider/GN/GNSearchable.java +++ b/core/src/main/java/org/fao/geonet/services/util/z3950/provider/GN/GNSearchable.java @@ -34,9 +34,9 @@ import java.util.Map; import java.util.Observer; -//import org.fao.geonet.services.util.z3950.GNSearchTask; - /** + * Present GeoNetwork search results as JZkit Searchable. + * * @author 'Timo Proescholdt ' interface between JZkit and GN. not currently * used */ diff --git a/core/src/test/java/org/fao/geonet/AbstractCoreIntegrationTest.java b/core/src/test/java/org/fao/geonet/AbstractCoreIntegrationTest.java index c32bc8a1825a..0581e896bed2 100644 --- a/core/src/test/java/org/fao/geonet/AbstractCoreIntegrationTest.java +++ b/core/src/test/java/org/fao/geonet/AbstractCoreIntegrationTest.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -186,6 +186,15 @@ protected String getGeonetworkNodeId() { /** * Create a Service context without a user session but otherwise ready to use. + * + * This method assigns the created service context to the current thread, you are responsible for managing cleanup. + * 

+     * try {
+     *   context = createServiceContext();
+     * finally {
+     *     context.clearAsThreadLocal();
+     * }
+     *
*/ protected ServiceContext createServiceContext() throws Exception { final HashMap contexts = new HashMap(); diff --git a/core/src/test/java/org/fao/geonet/GeonetTestFixture.java b/core/src/test/java/org/fao/geonet/GeonetTestFixture.java index bcb9c42dfdbe..7df1ef60ef86 100644 --- a/core/src/test/java/org/fao/geonet/GeonetTestFixture.java +++ b/core/src/test/java/org/fao/geonet/GeonetTestFixture.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -155,21 +155,27 @@ public boolean accept(Path entry) throws IOException { ServiceContext serviceContext = test.createServiceContext(); - ApplicationContextHolder.set(_applicationContext); - serviceContext.setAsThreadLocal(); + try { + ApplicationContextHolder.set(_applicationContext); + //serviceContext.setAsThreadLocal(); + // TODOES // _applicationContext.getBean(EsSearchManager.class).initNonStaticData(100); - _applicationContext.getBean(DataManager.class).init(serviceContext, false); - _applicationContext.getBean(ThesaurusManager.class).init(true, serviceContext, "WEB-INF/data/config/codelist"); + _applicationContext.getBean(DataManager.class).init(serviceContext); + _applicationContext.getBean(ThesaurusManager.class).init(true, serviceContext, "WEB-INF/data/config/codelist"); - addSourceUUID(dataDir); + addSourceUUID(dataDir); - final DataSource dataSource = _applicationContext.getBean(DataSource.class); - try (Connection conn = dataSource.getConnection()) { - ThreadUtils.init(conn.getMetaData().getURL(), _applicationContext.getBean(SettingManager.class)); + final DataSource dataSource = _applicationContext.getBean(DataSource.class); + try (Connection conn = dataSource.getConnection()) { + ThreadUtils.init(conn.getMetaData().getURL(), _applicationContext.getBean(SettingManager.class)); + } + } finally { + serviceContext.clearAsThreadLocal(); } + } diff --git a/core/src/test/java/org/fao/geonet/kernel/DataManagerWorksWithoutTransactionIntegrationTest.java b/core/src/test/java/org/fao/geonet/kernel/DataManagerWorksWithoutTransactionIntegrationTest.java index d56af28c2960..2cbb4dfb7994 100644 --- a/core/src/test/java/org/fao/geonet/kernel/DataManagerWorksWithoutTransactionIntegrationTest.java +++ b/core/src/test/java/org/fao/geonet/kernel/DataManagerWorksWithoutTransactionIntegrationTest.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -51,25 +51,36 @@ public void testDataManagerCutpoints() throws Exception { (new TestTask() { @Override public void run() throws Exception { - ServiceContext serviceContext = createContextAndLogAsAdmin(); + ServiceContext restore = ServiceContext.get(); + if( restore != null ){ + restore.clearAsThreadLocal(); + } - String metadataCategory = metadataCategoryRepository.findAll().get(0).getName(); - Element sampleMetadataXml = getSampleMetadataXml(); - UserSession userSession = serviceContext.getUserSession(); - int userIdAsInt = userSession.getUserIdAsInt(); - String schema = dataManager.autodetectSchema(sampleMetadataXml); - String mdId = dataManager.insertMetadata(serviceContext, schema, sampleMetadataXml, - UUID.randomUUID().toString(), userIdAsInt, "2", "source", - MetadataType.METADATA.codeString, null, metadataCategory, new ISODate().getDateAndTime(), - new ISODate().getDateAndTime(), false, false); - Element newMd = new Element(sampleMetadataXml.getName(), sampleMetadataXml.getNamespace()).addContent(new Element("fileIdentifier", - GMD).addContent(new Element("CharacterString", GCO))); + ServiceContext serviceContext = createContextAndLogAsAdmin(); + try { + String metadataCategory = metadataCategoryRepository.findAll().get(0).getName(); + Element sampleMetadataXml = getSampleMetadataXml(); + UserSession userSession = serviceContext.getUserSession(); + int userIdAsInt = userSession.getUserIdAsInt(); + String schema = dataManager.autodetectSchema(sampleMetadataXml); + String mdId = dataManager.insertMetadata(serviceContext, schema, sampleMetadataXml, + UUID.randomUUID().toString(), userIdAsInt, "2", "source", + MetadataType.METADATA.codeString, null, metadataCategory, new ISODate().getDateAndTime(), + new ISODate().getDateAndTime(), false, false); + Element newMd = new Element(sampleMetadataXml.getName(), sampleMetadataXml.getNamespace()).addContent(new Element("fileIdentifier", + GMD).addContent(new Element("CharacterString", GCO))); - AbstractMetadata updateMd = dataManager.updateMetadata(serviceContext, mdId, newMd, false, false, false, "eng", - new ISODate().getDateAndTime(), false); - assertNotNull(updateMd); - boolean hasNext = updateMd.getCategories().iterator().hasNext(); - assertTrue(hasNext); + AbstractMetadata updateMd = dataManager.updateMetadata(serviceContext, mdId, newMd, false, false, false, "eng", + new ISODate().getDateAndTime(), false); + assertNotNull(updateMd); + boolean hasNext = updateMd.getCategories().iterator().hasNext(); + assertTrue(hasNext); + } finally { + serviceContext.clearAsThreadLocal(); + if( restore != null ){ + restore.setAsThreadLocal(); + } + } } }); } diff --git a/core/src/test/java/org/fao/geonet/kernel/LocalXLinksInMetadataIntegrationTest.java b/core/src/test/java/org/fao/geonet/kernel/LocalXLinksInMetadataIntegrationTest.java index 683c05e4242a..a1a4673706c4 100644 --- a/core/src/test/java/org/fao/geonet/kernel/LocalXLinksInMetadataIntegrationTest.java +++ b/core/src/test/java/org/fao/geonet/kernel/LocalXLinksInMetadataIntegrationTest.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -92,57 +92,58 @@ public void testResolveLocalXLink() throws Exception { } final Element metadata = getSampleMetadataXml().setContent(content); - ServiceContext context = createServiceContext(); - context.setAsThreadLocal(); - loginAsAdmin(context); + try (ServiceContext context = createServiceContext()) { + // context.setAsThreadLocal(); + loginAsAdmin(context); - _settingManager.setValue(Settings.SYSTEM_XLINKRESOLVER_ENABLE, true); + _settingManager.setValue(Settings.SYSTEM_XLINKRESOLVER_ENABLE, true); - String schema = _dataManager.autodetectSchema(metadata); - String uuid = UUID.randomUUID().toString(); - int owner = context.getUserSession().getUserIdAsInt(); - String groupOwner = "" + ReservedGroup.intranet.getId(); - String source = _settingManager.getSiteId(); - String metadataType = MetadataType.METADATA.codeString; - String changeDate; - String createDate = changeDate = new ISODate().getDateAndTime(); - String id = _dataManager.insertMetadata(context, schema, metadata, uuid, owner, groupOwner, source, metadataType, null, - null, createDate, changeDate, false, false); + String schema = _dataManager.autodetectSchema(metadata); + String uuid = UUID.randomUUID().toString(); + int owner = context.getUserSession().getUserIdAsInt(); + String groupOwner = "" + ReservedGroup.intranet.getId(); + String source = _settingManager.getSiteId(); + String metadataType = MetadataType.METADATA.codeString; + String changeDate; + String createDate = changeDate = new ISODate().getDateAndTime(); + String id = _dataManager.insertMetadata(context, schema, metadata, uuid, owner, groupOwner, source, metadataType, null, + null, createDate, changeDate, false, false); - SpringLocalServiceInvoker mockInvoker = resetAndGetMockInvoker(); + SpringLocalServiceInvoker mockInvoker = resetAndGetMockInvoker(); - String keyword1 = "World"; - Element element1 = new SAXBuilder().build(new StringReader(String.format(responseTemplate, keyword1))).getRootElement(); - when(mockInvoker.invoke(any(String.class))).thenReturn(element1); + String keyword1 = "World"; + Element element1 = new SAXBuilder().build(new StringReader(String.format(responseTemplate, keyword1))).getRootElement(); + when(mockInvoker.invoke(any(String.class))).thenReturn(element1); - final String xpath = "*//gmd:descriptiveKeywords//gmd:keyword/gco:CharacterString"; - assertNull(Xml.selectElement(metadata, xpath)); - verify(mockInvoker, never()).invoke(any(String.class)); + final String xpath = "*//gmd:descriptiveKeywords//gmd:keyword/gco:CharacterString"; + assertNull(Xml.selectElement(metadata, xpath)); + verify(mockInvoker, never()).invoke(any(String.class)); - final Element loadedMetadataNoXLinkAttributesNotEdit = _dataManager.getMetadata(context, id, false, false, false); - assertEqualsText(keyword1, loadedMetadataNoXLinkAttributesNotEdit, xpath, GCO, GMD); - verify(mockInvoker, times(1)).invoke(any(String.class)); + final Element loadedMetadataNoXLinkAttributesNotEdit = _dataManager.getMetadata(context, id, false, false, false); + assertEqualsText(keyword1, loadedMetadataNoXLinkAttributesNotEdit, xpath, GCO, GMD); + verify(mockInvoker, times(1)).invoke(any(String.class)); - final Element loadedMetadataKeepXLinkAttributesNotEdit = _dataManager.getMetadata(context, id, false, false, true); - assertEqualsText(keyword1, loadedMetadataKeepXLinkAttributesNotEdit, xpath, GCO, GMD); - verify(mockInvoker, times(2)).invoke(any(String.class)); + final Element loadedMetadataKeepXLinkAttributesNotEdit = _dataManager.getMetadata(context, id, false, false, true); + assertEqualsText(keyword1, loadedMetadataKeepXLinkAttributesNotEdit, xpath, GCO, GMD); + verify(mockInvoker, times(2)).invoke(any(String.class)); - final Element loadedMetadataNoXLinkAttributesEdit = _dataManager.getMetadata(context, id, false, true, false); - assertEqualsText(keyword1, loadedMetadataNoXLinkAttributesEdit, xpath, GCO, GMD); - verify(mockInvoker, times(3)).invoke(any(String.class)); + final Element loadedMetadataNoXLinkAttributesEdit = _dataManager.getMetadata(context, id, false, true, false); + assertEqualsText(keyword1, loadedMetadataNoXLinkAttributesEdit, xpath, GCO, GMD); + verify(mockInvoker, times(3)).invoke(any(String.class)); - final Element loadedMetadataKeepXLinkAttributesEdit = _dataManager.getMetadata(context, id, false, true, true); - assertEqualsText(keyword1, loadedMetadataKeepXLinkAttributesEdit, xpath, GCO, GMD); - verify(mockInvoker, times(4)).invoke(any(String.class)); + final Element loadedMetadataKeepXLinkAttributesEdit = _dataManager.getMetadata(context, id, false, true, true); + assertEqualsText(keyword1, loadedMetadataKeepXLinkAttributesEdit, xpath, GCO, GMD); + verify(mockInvoker, times(4)).invoke(any(String.class)); - Processor.clearCache(); + Processor.clearCache(); - String keyword2 = "Other Word"; - Element element2 = new SAXBuilder().build(new StringReader(String.format(responseTemplate, keyword2))).getRootElement(); - when(mockInvoker.invoke(any(String.class))).thenReturn(element2); + String keyword2 = "Other Word"; + Element element2 = new SAXBuilder().build(new StringReader(String.format(responseTemplate, keyword2))).getRootElement(); + when(mockInvoker.invoke(any(String.class))).thenReturn(element2); - final Element newLoad = _dataManager.getMetadata(context, id, false, true, true); - assertEqualsText(keyword2, newLoad, xpath, GCO, GMD); - verify(mockInvoker, times(5)).invoke(any(String.class)); + final Element newLoad = _dataManager.getMetadata(context, id, false, true, true); + assertEqualsText(keyword2, newLoad, xpath, GCO, GMD); + verify(mockInvoker, times(5)).invoke(any(String.class)); + } } } diff --git a/core/src/test/java/org/fao/geonet/kernel/LocalXLinksUpdateDeleteTest.java b/core/src/test/java/org/fao/geonet/kernel/LocalXLinksUpdateDeleteTest.java index 31f09e63c2d5..203e99d18c79 100644 --- a/core/src/test/java/org/fao/geonet/kernel/LocalXLinksUpdateDeleteTest.java +++ b/core/src/test/java/org/fao/geonet/kernel/LocalXLinksUpdateDeleteTest.java @@ -1,3 +1,26 @@ +/* + * Copyright (C) 2001-2021 Food and Agriculture Organization of the + * United Nations (FAO-UN), United Nations World Food Programme (WFP) + * and United Nations Environment Programme (UNEP) + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or (at + * your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + * + * Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2, + * Rome - Italy. email: geonetwork@osgeo.org + */ + package org.fao.geonet.kernel; import jeeves.server.context.ServiceContext; @@ -53,6 +76,7 @@ public class LocalXLinksUpdateDeleteTest extends AbstractIntegrationTestWithMock @Autowired private SettingManager settingManager; + /** Service context for test */ private ServiceContext context; @Before diff --git a/core/src/test/java/org/fao/geonet/kernel/mef/MEFLibIntegrationTest.java b/core/src/test/java/org/fao/geonet/kernel/mef/MEFLibIntegrationTest.java index 02343bd7b793..e7638ea88dfc 100644 --- a/core/src/test/java/org/fao/geonet/kernel/mef/MEFLibIntegrationTest.java +++ b/core/src/test/java/org/fao/geonet/kernel/mef/MEFLibIntegrationTest.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -92,8 +92,11 @@ public void testDoImportMefVersion2() throws Exception { } } + /** Import records for integration test */ public static class ImportMetadata { private final AbstractCoreIntegrationTest testClass; + + /** Integration test context */ private ServiceContext context; private List metadataIds = new ArrayList<>(); private List mefFilesToLoad = new ArrayList<>(); diff --git a/core/src/test/java/org/fao/geonet/kernel/search/AbstractLanguageSearchOrderIntegrationTest.java b/core/src/test/java/org/fao/geonet/kernel/search/AbstractLanguageSearchOrderIntegrationTest.java index bddc9171b289..32710af2d0bd 100644 --- a/core/src/test/java/org/fao/geonet/kernel/search/AbstractLanguageSearchOrderIntegrationTest.java +++ b/core/src/test/java/org/fao/geonet/kernel/search/AbstractLanguageSearchOrderIntegrationTest.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -50,6 +50,7 @@ public abstract class AbstractLanguageSearchOrderIntegrationTest extends AbstractCoreIntegrationTest { public static List METADATA_TO_IMPORT = new ArrayList(10); protected MetaSearcher _luceneSearcher; + /** Test service context */ protected ServiceContext _serviceContext; protected String _abstractSearchTerm; @Autowired diff --git a/core/src/test/java/org/fao/geonet/kernel/url/UrlAnalyzerTest.java b/core/src/test/java/org/fao/geonet/kernel/url/UrlAnalyzerTest.java index 1a27c54e2be0..18037834d9ce 100644 --- a/core/src/test/java/org/fao/geonet/kernel/url/UrlAnalyzerTest.java +++ b/core/src/test/java/org/fao/geonet/kernel/url/UrlAnalyzerTest.java @@ -1,3 +1,26 @@ +/* + * Copyright (C) 2001-2021 Food and Agriculture Organization of the + * United Nations (FAO-UN), United Nations World Food Programme (WFP) + * and United Nations Environment Programme (UNEP) + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or (at + * your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + * + * Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2, + * Rome - Italy. email: geonetwork@osgeo.org + */ + package org.fao.geonet.kernel.url; import jeeves.server.context.ServiceContext; @@ -76,6 +99,7 @@ public class UrlAnalyzerTest extends AbstractCoreIntegrationTest { @PersistenceContext private EntityManager entityManager; + /** Service context for test */ private ServiceContext context; @Before diff --git a/domain/src/main/java/org/fao/geonet/domain/Profile.java b/domain/src/main/java/org/fao/geonet/domain/Profile.java index e3a24e71074e..9f0198750ebd 100644 --- a/domain/src/main/java/org/fao/geonet/domain/Profile.java +++ b/domain/src/main/java/org/fao/geonet/domain/Profile.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -31,7 +31,15 @@ /** * The enumeration of profiles available in geonetwork. - * + *
    + *
  • Administrator
    • + *
  • Administrator - UserAdmin
    • + *
  • Administrator - UserAdmin - Reviewer
    • + *
  • Administrator - UserAdmin - Reviewer - Editor
    • + *
  • Administrator - UserAdmin - Reviewer - Editor - RegisteredUser
    • + *
  • Administrator - UserAdmin - Reviewer - Editor - RegisteredUser - Guest
    • + *
  • Administrator - Monitor
    • + *
* @author Jesse */ public enum Profile { diff --git a/domain/src/main/java/org/fao/geonet/domain/StatusValue.java b/domain/src/main/java/org/fao/geonet/domain/StatusValue.java index 26d5bf4ccc92..8f9a437d0173 100644 --- a/domain/src/main/java/org/fao/geonet/domain/StatusValue.java +++ b/domain/src/main/java/org/fao/geonet/domain/StatusValue.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -239,4 +239,13 @@ public static final class Events { public static final String RECORDIMPORTED = "62"; public static final String RECORDRESTORED = "63"; } + + @Override + public String toString() { + final StringBuffer sb = new StringBuffer("StatusValue{"); + sb.append("_id=").append(_id); + sb.append(", _name='").append(_name).append('\''); + sb.append('}'); + return sb.toString(); + } } diff --git a/harvesters/src/main/java/org/fao/geonet/component/harvester/csw/Harvest.java b/harvesters/src/main/java/org/fao/geonet/component/harvester/csw/Harvest.java index 24f53ee8a625..37722db1fbd3 100644 --- a/harvesters/src/main/java/org/fao/geonet/component/harvester/csw/Harvest.java +++ b/harvesters/src/main/java/org/fao/geonet/component/harvester/csw/Harvest.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -635,7 +635,7 @@ private Element createAcknowledgeResponse(Element asyncRequest) { } /** - * Runs the harvester. In synchronous mode, waits for it to finish. + * Runs CSW harvester in synchronous mode, waiting for it to finish. * * @param harvester - the harvester * @param context - everywhere in GN ! @@ -813,6 +813,7 @@ private class AsyncHarvestResponse implements RunnableFuture { Semaphore ready = new Semaphore(0); private Element harvester; private String responseHandler; + /** Shared service context managed by HarvestManager */ private ServiceContext serviceContext; /** diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/HarvestManager.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/HarvestManager.java index 2afdf443f31f..82eab7a0a5f2 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/HarvestManager.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/HarvestManager.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -106,26 +106,37 @@ public interface HarvestManager { boolean update(Element node, String ownerId) throws BadInputEx, SQLException, SchedulerException; /** - * Remove all metadata associated to one harvester + * Removes all the metadata associated with one harvester. * * @param id of the harvester + * @return {@link Common.OperResult#OK} indicating removal of associated metadata. + * @throws Exception */ Common.OperResult clearBatch(String id) throws Exception; + /** + * Remove the harvester, including deleting harvester history. + * + * @param id harvester id + * @return {@link Common.OperResult#OK} if remove succeeded, or {@link Common.OperResult#NOT_FOUND} if not available + * @throws Exception + */ Common.OperResult remove(String id) throws Exception; /** * Set harvester status to {@link org.fao.geonet.kernel.harvest.Common.Status#ACTIVE} and * schedule the harvester to be ran at the next time according to the harvesters schedule. * - * @return return {@link org.fao.geonet.kernel.harvest.Common.OperResult#ALREADY_ACTIVE} if the - * harvester is already active or {@link org.fao.geonet.kernel.harvest.Common.OperResult#OK} + * @param id harvester id + * @return {@link Common.OperResult#ALREADY_ACTIVE} if the + * harvester is already active or {@link Common.OperResult#OK} */ Common.OperResult start(String id) throws SQLException, SchedulerException; /** * Set the harvester status to the provided status and unschedule any scheduled jobs. * + * @param id harvester id * @return {@link org.fao.geonet.kernel.harvest.Common.OperResult#ALREADY_INACTIVE} if the not * currently enabled or {@link org.fao.geonet.kernel.harvest.Common.OperResult#OK} */ diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/HarvestManagerImpl.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/HarvestManagerImpl.java index 43ed1b4d60a2..fc40a692d041 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/HarvestManagerImpl.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/HarvestManagerImpl.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -24,6 +24,7 @@ package org.fao.geonet.kernel.harvest; import jeeves.server.context.ServiceContext; +import jeeves.server.dispatchers.ServiceManager; import org.apache.commons.lang.StringUtils; import org.apache.commons.lang.math.NumberUtils; import org.fao.geonet.GeonetContext; @@ -90,10 +91,18 @@ public class HarvestManagerImpl implements HarvestInfoProvider, HarvestManager { private HarvesterSettingsManager settingMan; private DataManager dataMan; private Path xslPath; - private ServiceContext context; + + /** Harvester service context */ + private ServiceContext.AppHandlerServiceContext harvesterContext; + + /** Read only mode */ private boolean readOnly; private ConfigurableApplicationContext applicationContext; + + /** Harvester available by id */ private Map hmHarvesters = new HashMap<>(); + + /** Harvester lookup by uuid */ private Map hmHarvestLookup = new HashMap<>(); private TranslationPackBuilder translationPackBuilder; @@ -111,21 +120,22 @@ public ConfigurableApplicationContext getApplicationContext() { /** * initialize the manager. * - * @param context service context + * @param initContext service context * @throws Exception hmm */ @Override - public void init(ServiceContext context, boolean isReadOnly) throws Exception { - this.context = context; - this.dataMan = context.getBean(DataManager.class); - this.settingMan = context.getBean(HarvesterSettingsManager.class); - this.translationPackBuilder = context.getBean(TranslationPackBuilder.class); + public void init(ServiceContext initContext, boolean isReadOnly) throws Exception { + //create a new (shared) context instead of using the Jeeves one + ServiceManager serviceManager = initContext.getBean(ServiceManager.class); + this.harvesterContext = serviceManager.createAppHandlerServiceContext("harvester", initContext); - applicationContext = context.getApplicationContext(); + this.dataMan = harvesterContext.getBean(DataManager.class); + this.settingMan = harvesterContext.getBean(HarvesterSettingsManager.class); + applicationContext = harvesterContext.getApplicationContext(); this.readOnly = isReadOnly; Log.debug(Geonet.HARVEST_MAN, "HarvesterManager initializing, READONLYMODE is " + this.readOnly); - xslPath = context.getAppPath().resolve(Geonet.Path.STYLESHEETS).resolve("xml/harvesting/"); + xslPath = harvesterContext.getAppPath().resolve(Geonet.Path.STYLESHEETS).resolve("xml/harvesting/"); AbstractHarvester.getScheduler().getListenerManager().addJobListener( HarversterJobListener.getInstance(this)); @@ -140,8 +150,8 @@ public void init(ServiceContext context, boolean isReadOnly) throws Exception { String id = node.getAttributeValue("id"); try { - AbstractHarvester ah = AbstractHarvester.create(type, context); - ah.init(node, context); + AbstractHarvester ah = AbstractHarvester.create(type, harvesterContext); + ah.init(node); hmHarvesters.put(ah.getID(), ah); hmHarvestLookup.put(ah.getParams().getUuid(), ah); } catch (OperationAbortedEx oae) { @@ -155,7 +165,7 @@ public void init(ServiceContext context, boolean isReadOnly) throws Exception { } /** - * TODO Javadoc. + * Sorted harvester nodes. * * @param nodes harvest nodes * @param sortField sort field @@ -170,7 +180,7 @@ private Element transformSort(Element nodes, String sortField) throws Exception } /** - * TODO Javadoc. + * Transformed harvest node. * * @param node harvest node * @return transformed harvest node @@ -183,7 +193,7 @@ private Element transform(Element node) throws Exception { } /** - * TODO Javadoc. + * Clean up harvest manager. */ @Override public void shutdown() { @@ -199,6 +209,11 @@ public void shutdown() { } catch (SchedulerException e) { Log.error(Geonet.HARVEST_MAN, "Error shutting down harvester scheduler"); } + //we created the context, so we have to clean it up + if (harvesterContext != null){ + // Call superclass cleanup to avoid AppHandlerServiceContext protections + ((ServiceContext)harvesterContext).clear(); + } } //--------------------------------------------------------------------------- @@ -208,7 +223,7 @@ public void shutdown() { //--------------------------------------------------------------------------- /** - * TODO javadoc. + * Harvest node, filtered to only include nodes visible to user session. * * @param id harvester id * @param context servicecontext @@ -236,7 +251,7 @@ public Element get(String id, ServiceContext context, String sort) throws Except // and use it for call harvesterSettingsManager.get // don't forget to clean parameter when update or delete - Profile profile = context.getUserSession().getProfile(); + Profile profile = context.getUserSession() == null ? Profile.Administrator : context.getUserSession().getProfile(); if (id != null && !id.equals("-1")) { // you're an Administrator if (profile == Profile.Administrator) { @@ -295,7 +310,7 @@ public Element get(String id, ServiceContext context, String sort) throws Except } /** - * TODO javadoc. + * Add harvester, returning the id new harvester. * * @param node harvester config * @param ownerId the id of the user doing this @@ -309,7 +324,7 @@ public String addHarvesterReturnId(Element node, String ownerId) throws JeevesEx Log.debug(Geonet.HARVEST_MAN, "Adding harvesting node : \n" + Xml.getString(node)); } String type = node.getAttributeValue("type"); - AbstractHarvester ah = AbstractHarvester.create(type, context); + AbstractHarvester ah = AbstractHarvester.create(type, harvesterContext); Element ownerIdE = new Element("ownerId"); ownerIdE.setText(ownerId); @@ -328,7 +343,8 @@ public String addHarvesterReturnId(Element node, String ownerId) throws JeevesEx } /** - * TODO Javadoc. + * Add harvester, returning UUID. + * @return uuid of new harvester */ @Override public String addHarvesterReturnUUID(Element node) throws JeevesException, SQLException { @@ -336,7 +352,7 @@ public String addHarvesterReturnUUID(Element node) throws JeevesException, SQLEx Log.debug(Geonet.HARVEST_MAN, "Adding harvesting node : \n" + Xml.getString(node)); } String type = node.getAttributeValue("type"); - AbstractHarvester ah = AbstractHarvester.create(type, context); + AbstractHarvester ah = AbstractHarvester.create(type, harvesterContext); ah.add(node); hmHarvesters.put(ah.getID(), ah); @@ -352,9 +368,10 @@ public String addHarvesterReturnUUID(Element node) throws JeevesException, SQLEx } /** - * TODO javadoc. + * Clone harvester. * * @param ownerId id of the user doing this + * @return id of the new harvester */ @Override public synchronized String createClone(String id, String ownerId, ServiceContext context) throws Exception { @@ -387,9 +404,10 @@ public synchronized String createClone(String id, String ownerId, ServiceContext } /** - * TODO javadoc. + * Update on harvester progress. * * @param ownerId id of the user doing this + * @return true if harvester updated */ @Override public synchronized boolean update(Element node, String ownerId) throws BadInputEx, SQLException, SchedulerException { @@ -439,7 +457,7 @@ public synchronized OperResult remove(final String id) throws Exception { if (StringUtils.isNotBlank(harvesterSetting)) { settingMan.remove("harvesting/id:" + id); - final HarvestHistoryRepository historyRepository = context.getBean(HarvestHistoryRepository.class); + final HarvestHistoryRepository historyRepository = harvesterContext.getBean(HarvestHistoryRepository.class); // set deleted status in harvest history table to 'y' historyRepository.markAllAsDeleted(uuid); hmHarvesters.remove(id); @@ -460,7 +478,8 @@ public synchronized OperResult remove(final String id) throws Exception { /** - * TODO Javadoc. + * Start harvester + * @param id harvester id */ @Override public OperResult start(String id) throws SQLException, SchedulerException { @@ -476,7 +495,10 @@ public OperResult start(String id) throws SQLException, SchedulerException { } /** - * TODO Javadoc. + * Stop harvester with provided status, and unschedule any outstanding jobs. + * @param id harvester id + * @param status New status + * @return harvester progress */ @Override public OperResult stop(String id, Common.Status status) throws SQLException, SchedulerException { @@ -492,7 +514,9 @@ public OperResult stop(String id, Common.Status status) throws SQLException, Sch } /** - * TODO Javadoc. + * Start harvester run + * @parm id harvester to run + * return harvester progress */ @Override public OperResult run(String id) throws SQLException, SchedulerException { @@ -516,7 +540,7 @@ public OperResult run(String id) throws SQLException, SchedulerException { } /** - * TODO Javadoc. + * Run the harvester check if harvest correctly completed. */ @Override public OperResult invoke(String id) { @@ -540,7 +564,10 @@ public OperResult invoke(String id) { } /** - * TODO Javadoc. + * Harvester details + * @param harvestUuid uuid to look up harvester info + * @param id + * @param uuid */ public Element getHarvestInfo(String harvestUuid, String id, String uuid) { Element info = new Element(Edit.Info.Elem.HARVEST_INFO); @@ -580,10 +607,13 @@ private void addInfo(Element node) { /** * Remove harvester information. For example, when records are removed, clean the last status * information if any. + * + * @param id harvester id + * @param ownerId */ public void removeInfo(String id, String ownerId) throws Exception { // get the specified harvester from the settings table - Element node = get(id, context, null); + Element node = get(id, harvesterContext, null); if (node != null) { Element info = node.getChild("info"); if (info != null) { @@ -611,6 +641,13 @@ public void setReadOnly(boolean readOnly) { this.readOnly = readOnly; } + /** + * Removes all the metadata associated with one harvester. + * + * @param id of the harvester + * @return {@link OperResult#OK} indicating removal of associated metadata. + * @throws Exception + */ public synchronized OperResult clearBatch(String id) throws Exception { if (Log.isDebugEnabled(Geonet.HARVEST_MAN)) Log.debug(Geonet.HARVEST_MAN, "Clearing harvesting with id : " + id); @@ -631,8 +668,18 @@ public synchronized OperResult clearBatch(String id) throws Exception { elapsedTime = (System.currentTimeMillis() - elapsedTime) / 1000; // clear last run info - removeInfo(id, context.getUserSession().getUserId()); - ah.emptyResult(); + ServiceContext context = ah.getContext(); + if (context.getUserSession() != null ) { + // Use user session if logged in + String userId = context.getUserSession().getUserId(); + removeInfo(id, userId); + ah.emptyResult(); + } else { + // Identify owner if not logged in + String userId = ah.getParams().getOwnerId(); + removeInfo(id, userId); + ah.emptyResult(); + } Element historyEl = new Element("result"); historyEl.addContent(new Element("cleared"). @@ -640,7 +687,7 @@ public synchronized OperResult clearBatch(String id) throws Exception { final String lastRun = OffsetDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_DATE_TIME); ISODate lastRunDate = new ISODate(lastRun); - HarvestHistoryRepository historyRepository = context.getBean(HarvestHistoryRepository.class); + HarvestHistoryRepository historyRepository = harvesterContext.getBean(HarvestHistoryRepository.class); HarvestHistory history = new HarvestHistory(); history.setDeleted(true); history.setElapsedTime((int) elapsedTime); diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/AbstractHarvester.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/AbstractHarvester.java index f514708afc2d..9a42ca460cb1 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/AbstractHarvester.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/AbstractHarvester.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2020 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -25,6 +25,7 @@ import jeeves.server.UserSession; import jeeves.server.context.ServiceContext; +import jeeves.server.dispatchers.ServiceManager; import org.apache.commons.lang.StringUtils; import org.apache.log4j.EnhancedPatternLayout; import org.apache.log4j.FileAppender; @@ -132,6 +133,12 @@ public abstract class AbstractHarvester errors = Collections.synchronizedList(new LinkedList<>()); private volatile boolean running = false; - public static AbstractHarvester create(String type, ServiceContext context) throws BadParameterEx, OperationAbortedEx { + /** + * Factory method for creating appropriate harvester. + * + * This method configures the harvester with its own service context and appropriate beans + * for operation. It is your responsibility to call {@link #destroy()} to clean up + * after this harvester when it is no longer used. + * + * @param type harvester type + * @param harvesterContext shared harvester service context used for bean lookup + * @return harvester instance + * @throws BadParameterEx + * @throws OperationAbortedEx + */ + public static AbstractHarvester create(String type, ServiceContext harvesterContext) throws BadParameterEx, OperationAbortedEx { if (type == null) { throw new BadParameterEx("type", null); } + ServiceManager serviceManager = harvesterContext.getBean(ServiceManager.class); try { - AbstractHarvester ah = context.getBean(type, AbstractHarvester.class); - ah.setContext(context); + AbstractHarvester ah = harvesterContext.getBean(type, AbstractHarvester.class); + + ServiceContext context = serviceManager.createServiceContext( "harvester."+type, harvesterContext ); + ah.initContext( context ); return ah; } catch (Exception e) { throw new OperationAbortedEx("Cannot instantiate harvester of type " + type, e); } } - protected void setContext(ServiceContext context) { + /** + * Service context provided for harvester for bean discovery and to manage user session. + * + * This method uses the provided context to look up data manager, metadata utils, harvester settings manager + * and other services for use during operation. + * + * @param context service context provided to this harvester to manage + */ + public void initContext(ServiceContext context) { this.context = context; this.dataMan = context.getBean(DataManager.class); this.metadataUtils = context.getBean(IMetadataUtils.class); @@ -236,15 +267,20 @@ public void add(Element node) throws BadInputEx, SQLException { id = doAdd(node); } - public void init(Element node, ServiceContext context) throws BadInputEx, SchedulerException { + /** + * Setup harvester using provide configuration. + * + * @param node harevester configuration + * @throws BadInputEx + * @throws SchedulerException + */ + public void init(Element node) throws BadInputEx, SchedulerException { id = node.getAttributeValue("id"); status = Status.parse(node.getChild("options").getChildText("status")); error = null; - this.context = context; doInit(node); - - initInfo(context); + initInfo(); initializeLog(); if (status == Status.ACTIVE) { @@ -252,7 +288,7 @@ public void init(Element node, ServiceContext context) throws BadInputEx, Schedu } } - private void initInfo(ServiceContext context) { + private void initInfo() { final HarvestHistoryRepository historyRepository = context.getBean(HarvestHistoryRepository.class); Specification spec = HarvestHistorySpecs.hasHarvesterUuid(getParams().getUuid()); Pageable pageRequest = PageRequest.of(0, 1, @@ -310,8 +346,12 @@ public static Scheduler getScheduler() throws SchedulerException { return QuartzSchedulerUtils.getScheduler(SCHEDULER_ID, true); } + /** Called during application shutdown to remove scheduled job and clean up service context. */ public void shutdown() throws SchedulerException { getScheduler().deleteJob(jobKey(getParams().getUuid(), HARVESTER_GROUP_NAME)); + + context.clear(); + context = null; } public static void shutdownScheduler() throws SchedulerException { @@ -581,14 +621,20 @@ public void addHarvestInfo(Element info, String id, String uuid) { info.addContent(new Element("type").setText(getType())); } - public ServiceContext getServiceContext() { - return context; - } - public Status getStatus() { return status; } + /** + * Service context maintained by this harvester, may be used to access UserSession. + * + * @return service context maintained by harvester + */ + public ServiceContext getContext() { + return this.context; + } + + /** * Nested class to handle harvesting with fast indexing. */ @@ -828,10 +874,20 @@ public final String getType() { return types[0]; } + /** + * Harvester configuration. + * + * @return configuration, strongly typed + */ public P getParams() { return params; } + /** + * Setup harvester with the provided configuration + * @param node harevester configuration + * @throws BadInputEx + */ private void doInit(Element node) throws BadInputEx { setParams(createParams()); params.create(node); diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/AbstractParams.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/AbstractParams.java index 5c45287d71b7..2c46f33c0f1f 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/AbstractParams.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/AbstractParams.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -116,7 +116,9 @@ private static HarvestValidationEnum readValidateFromParams(Element content) { } /** - * @param node + * Setup parameters with the provided configuration. + * + * @param node harvester configuration * @throws BadInputEx */ public void create(Element node) throws BadInputEx { diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/csw/Aligner.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/csw/Aligner.java index 2d195d5f6451..8db49e5c3650 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/csw/Aligner.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/csw/Aligner.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -89,6 +89,7 @@ public class Aligner extends BaseAligner { + /** Shared service context managed by HarvestManager */ private ServiceContext context; private DataManager dataMan; private CategoryMapper localCateg; diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/csw/Harvester.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/csw/Harvester.java index 4630f6ac5788..c2489c46a0a2 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/csw/Harvester.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/csw/Harvester.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -88,6 +88,7 @@ class Harvester implements IHarvester { private Logger log; private CswParams params; + /** Shared service context managed by HarvestManager */ private ServiceContext context; /** diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/fragment/FragmentHarvester.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/fragment/FragmentHarvester.java index b25afccd403c..2788767aa36f 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/fragment/FragmentHarvester.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/fragment/FragmentHarvester.java @@ -77,6 +77,7 @@ public class FragmentHarvester extends BaseAligner { private static final String REPLACEMENT_GROUP = "replacementGroup"; private Logger log; + /** Shared service context managed by HarvestManager */ private ServiceContext context; private DataManager dataMan; private IMetadataManager metadataManager; diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/Aligner.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/Aligner.java index 9271fe93921e..d466b8183f33 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/Aligner.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/Aligner.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2013 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -61,6 +61,7 @@ public class Aligner extends BaseAligner { private Logger log; + /** Shared service context managed by HarvetManager */ private ServiceContext context; private XmlRequest request; private DataManager dataMan; diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/Harvester.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/Harvester.java index d62553ca281c..68acaa1e1a3f 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/Harvester.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/Harvester.java @@ -81,6 +81,7 @@ class Harvester implements IHarvester { private GeoPRESTParams params; //--------------------------------------------------------------------------- + /** Shared service context managed by HarvestManager */ private ServiceContext context; //--------------------------------------------------------------------------- diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet/Aligner.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet/Aligner.java index e6d937bd300d..eca6f9f45c50 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet/Aligner.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet/Aligner.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -88,6 +88,7 @@ public class Aligner extends BaseAligner { private Logger log; + /** Shared service context managed by HarvestManager */ private ServiceContext context; private XmlRequest request; private DataManager dataMan; diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet/Harvester.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet/Harvester.java index 96ac8c5660b7..3004c9636ff5 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet/Harvester.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet/Harvester.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -72,6 +72,7 @@ class Harvester implements IHarvester { private Logger log; private GeonetParams params; + /** Shared service context managed by HarvestManager */ private ServiceContext context; /** diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet20/Aligner.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet20/Aligner.java index ee10ff3e8f90..462dc5ce7a8b 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet20/Aligner.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/geonet20/Aligner.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -64,6 +64,7 @@ public class Aligner extends AbstractAligner { private IMetadataManager metadataManager; + /** Shared service context managed by HarvestManager */ private ServiceContext context; private CategoryMapper localCateg; diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/localfilesystem/LocalFilesystemHarvester.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/localfilesystem/LocalFilesystemHarvester.java index e4338d7de992..28a80dd2ef79 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/localfilesystem/LocalFilesystemHarvester.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/localfilesystem/LocalFilesystemHarvester.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2009 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -131,7 +131,7 @@ private HarvestResult align(Path root) throws Exception { log.debug(String.format( "Starting indexing in batch thread pool of %d updated records ...", listOfRecordsToIndex.size())); - dataMan.batchIndexInThreadPool(context, listOfRecordsToIndex); + dataMan.batchIndexInThreadPool(listOfRecordsToIndex); log.debug("End of alignment for : " + params.getName()); return result; diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/oaipmh/Harvester.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/oaipmh/Harvester.java index f906d8e5dcd1..03541dbd1ace 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/oaipmh/Harvester.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/oaipmh/Harvester.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -88,6 +88,7 @@ class Harvester extends BaseAligner implements IHarvester implements IHarvester implements IHarvester { - - // Namespaces needed here.... - + // Namespaces needed here.... static private final Namespace invCatalog = Namespace.getNamespace("http://www.unidata.ucar.edu/namespaces/thredds/InvCatalog/v1.0"); static private final Namespace wms = Namespace.getNamespace("http://www.opengis.net/wms"); static private final Namespace gmd = Namespace.getNamespace("gmd", "http://www.isotc211.org/2005/gmd"); static private final Namespace srv = Namespace.getNamespace("srv", "http://www.isotc211.org/2005/srv"); static private final Namespace xlink = Namespace.getNamespace("xlink", "http://www.w3.org/1999/xlink"); - static private final Namespace xsi = Namespace.getNamespace("xsi","http://www.w3.org/2001/XMLSchema-instance"); - static private final Namespace gco = Namespace.getNamespace("gco","http://www.isotc211.org/2005/gco"); + static private final Namespace xsi = Namespace.getNamespace("xsi","http://www.w3.org/2001/XMLSchema-instance"); + static private final Namespace gco = Namespace.getNamespace("gco","http://www.isotc211.org/2005/gco"); static private final Namespace gmi = Namespace.getNamespace("gmi","http://www.isotc211.org/2005/gmi"); static private final Namespace gmx = Namespace.getNamespace("gmx","http://www.isotc211.org/2005/gmx"); static private final Namespace gsr = Namespace.getNamespace("gsr","http://www.isotc211.org/2005/gsr"); @@ -179,6 +177,7 @@ class Harvester extends BaseAligner implements IHarvester implements IHarvester { private Logger log; + /** Shared service context managed by HarvesterManager */ private ServiceContext context; private DataManager dataMan; private IMetadataManager metadataManager; diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/webdav/WebDavRetriever.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/webdav/WebDavRetriever.java index 2651740afab8..a08e4c7d6c70 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/webdav/WebDavRetriever.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/webdav/WebDavRetriever.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -45,6 +45,7 @@ class WebDavRetriever implements RemoteRetriever { private Logger log; + /** Shared service context managed by HarvesterManager */ private ServiceContext context; private WebDavParams params; diff --git a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/wfsfeatures/Harvester.java b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/wfsfeatures/Harvester.java index e1343c4cdaaa..7a64f0746f19 100644 --- a/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/wfsfeatures/Harvester.java +++ b/harvesters/src/main/java/org/fao/geonet/kernel/harvest/harvester/wfsfeatures/Harvester.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -132,6 +132,7 @@ class Harvester implements IHarvester { //--- API methods //--- //--------------------------------------------------------------------------- + /** Shared service context managed by HarvesterManager */ private ServiceContext context; private WfsFeaturesParams params; private IMetadataManager metadataManager; @@ -152,12 +153,14 @@ class Harvester implements IHarvester { * Contains a list of accumulated errors during the executing of this harvest. */ private List errors = new LinkedList(); + /** * Constructor * + * @param cancelMonitor Sentinel used to cancel + * @param log Logger to track progress * @param context Jeeves context - * @param params harvesting configuration for the node - * @return null + * @param params WFS harvesting configuration for the node */ public Harvester(AtomicBoolean cancelMonitor, Logger log, ServiceContext context, WfsFeaturesParams params) { this.cancelMonitor = cancelMonitor; diff --git a/harvesters/src/main/java/org/fao/geonet/services/harvesting/Util.java b/harvesters/src/main/java/org/fao/geonet/services/harvesting/Util.java index 5e66b6d0d9c0..bde02b60b245 100644 --- a/harvesters/src/main/java/org/fao/geonet/services/harvesting/Util.java +++ b/harvesters/src/main/java/org/fao/geonet/services/harvesting/Util.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -37,6 +37,14 @@ //============================================================================= +/** + * Utility class used by HarvestManager to schedule background activities. + *

+ * Please note that background activities make use of a shared service context and + * do not have access to the user session unless you take special care + * to provide a service context for their use. + *

+ */ public class Util { //-------------------------------------------------------------------------- //--- @@ -44,6 +52,17 @@ public class Util { //--- //-------------------------------------------------------------------------- + /** + * Utility method used to schedule job on a number of metadata records. + *

+ * Exec will process the provided job for each id provided as part of params. + *

+ * @param params Element listing harvesters to run + * @param context Service context used t look up GeonetContext + * @param job Job to run for each indicated harvester + * @return Response structured with each harvest job and their + * @throws Exception + */ public static Element exec(Element params, ServiceContext context, Job job) throws Exception { GeonetContext gc = (GeonetContext) context.getHandlerContext(Geonet.CONTEXT_NAME); HarvestManager hm = gc.getBean(HarvestManager.class); @@ -74,8 +93,19 @@ public static Element exec(Element params, ServiceContext context, Job job) thro //--- //-------------------------------------------------------------------------- + /** + * Execute job to run on all input ids, the status is returned for each one. + */ public interface Job { - public OperResult execute(HarvestManager hm, String id) throws Exception; + /** + * Execute job on input id, returning status. + * + * @param hm HarvestManager scheduling activity + * @param id harvester id + * @return operation result indicating job status + * @throws Exception + */ + OperResult execute(HarvestManager hm, String id) throws Exception; } } diff --git a/harvesters/src/test/java/org/fao/geonet/kernel/harvest/AbstractHarvesterIntegrationTest.java b/harvesters/src/test/java/org/fao/geonet/kernel/harvest/AbstractHarvesterIntegrationTest.java index 6ccd276106cd..fb8ad9f2265d 100644 --- a/harvesters/src/test/java/org/fao/geonet/kernel/harvest/AbstractHarvesterIntegrationTest.java +++ b/harvesters/src/test/java/org/fao/geonet/kernel/harvest/AbstractHarvesterIntegrationTest.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -77,7 +77,8 @@ public void testHarvest() throws Exception { customizeParams(params); final String harvesterUuid = _harvestManager.addHarvesterReturnUUID(params); AbstractHarvester _harvester = _harvestManager.getHarvester(harvesterUuid); - _harvester.init(params, context); + _harvester.initContext( context ); + _harvester.init(params); _harvester.invoke(); final Element result = _harvester.getResult(); diff --git a/harvesters/src/test/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/HarvesterTest.java b/harvesters/src/test/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/HarvesterTest.java index 1f04dc970df8..b61287cc7650 100644 --- a/harvesters/src/test/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/HarvesterTest.java +++ b/harvesters/src/test/java/org/fao/geonet/kernel/harvest/harvester/geoPREST/HarvesterTest.java @@ -18,6 +18,9 @@ import java.text.ParseException; import java.util.Date; +import java.util.HashMap; + +import jeeves.server.context.ServiceContext; import org.fao.geonet.utils.Log; import org.junit.Assert; @@ -25,6 +28,7 @@ public class HarvesterTest { + ServiceContext context = new ServiceContext("TEST", null, new HashMap<>(), null); public HarvesterTest() { } @@ -32,7 +36,7 @@ public HarvesterTest() { @Test public void testParseDate() throws Exception { - Harvester h = new Harvester(null, Log.createLogger("TEST"), null, null); + Harvester h = new Harvester(null, Log.createLogger("TEST"), context, null); // test EN date h.parseDate("Mon, 04 Feb 2013 10:19:00 +1000"); @@ -47,7 +51,7 @@ public void testParseDate() throws Exception { @Test public void testJDK8136539Workaround() throws Exception { - Harvester h = new Harvester(null, Log.createLogger("TEST"), null, null); + Harvester h = new Harvester(null, Log.createLogger("TEST"), context, null); Date p0 = h.parseDate("Fr, 24 Mär 2017 10:58:59 +0100"); Date p1 = h.parseDate("Fr, 24 Mrz 2017 10:58:59 +0100"); @@ -57,7 +61,7 @@ public void testJDK8136539Workaround() throws Exception { @Test public void testUnparsableDate() throws Exception { - Harvester h = new Harvester(null, Log.createLogger("TEST"), null, null); + Harvester h = new Harvester(null, Log.createLogger("TEST"), context, null); try { h.parseDate("Xyz, 04 Feb 2013 10:19:00 +1000"); diff --git a/inspire-atom/src/main/java/org/fao/geonet/services/inspireatom/AtomPredefinedFeed.java b/inspire-atom/src/main/java/org/fao/geonet/services/inspireatom/AtomPredefinedFeed.java index 84beb2312385..87e9cb666844 100644 --- a/inspire-atom/src/main/java/org/fao/geonet/services/inspireatom/AtomPredefinedFeed.java +++ b/inspire-atom/src/main/java/org/fao/geonet/services/inspireatom/AtomPredefinedFeed.java @@ -90,17 +90,18 @@ public HttpEntity localServiceDescribe( @RequestParam(value = "language", required = false) String language, NativeWebRequest webRequest) throws Exception { - ServiceContext context = createServiceContext(Geonet.DEFAULT_LANGUAGE, webRequest.getNativeRequest(HttpServletRequest.class)); + try (ServiceContext context = createServiceContext(Geonet.DEFAULT_LANGUAGE, webRequest.getNativeRequest(HttpServletRequest.class))) { + SettingManager sm = context.getBean(SettingManager.class); + boolean inspireEnable = sm.getValueAsBool(Settings.SYSTEM_INSPIRE_ENABLE); + if (!inspireEnable) { + Log.info(Geonet.ATOM, "INSPIRE is disabled"); + throw new OperationNotAllowedEx("INSPIRE option is not enabled on this catalog."); + } - SettingManager sm = context.getBean(SettingManager.class); - boolean inspireEnable = sm.getValueAsBool(Settings.SYSTEM_INSPIRE_ENABLE); - if (!inspireEnable) { - Log.info(Geonet.ATOM, "INSPIRE is disabled"); - throw new OperationNotAllowedEx("INSPIRE option is not enabled on this catalog."); + Element feed = getServiceFeed(context, uuid, language); + return writeOutResponse(Xml.getString(feed),"application", "atom+xml"); } - Element feed = getServiceFeed(context, uuid, language); - return writeOutResponse(Xml.getString(feed),"application", "atom+xml"); } /** @@ -123,22 +124,22 @@ public HttpEntity localDatasetDescribe( @RequestParam(value = "q", required = false) String searchTerms, NativeWebRequest webRequest) throws Exception { - ServiceContext context = createServiceContext("eng", webRequest.getNativeRequest(HttpServletRequest.class)); - - SettingManager sm = context.getBean(SettingManager.class); - boolean inspireEnable = sm.getValueAsBool(Settings.SYSTEM_INSPIRE_ENABLE); - if (!inspireEnable) { - Log.info(Geonet.ATOM, "INSPIRE is disabled"); - throw new OperationNotAllowedEx("INSPIRE option is not enabled on this catalog."); - } + try (ServiceContext context = createServiceContext("eng", webRequest.getNativeRequest(HttpServletRequest.class))) { + SettingManager sm = context.getBean(SettingManager.class); + boolean inspireEnable = sm.getValueAsBool(Settings.SYSTEM_INSPIRE_ENABLE); + if (!inspireEnable) { + Log.info(Geonet.ATOM, "INSPIRE is disabled"); + throw new OperationNotAllowedEx("INSPIRE option is not enabled on this catalog."); + } - Map params = getDefaultXSLParams(sm, context, XslUtil.twoCharLangCode(context.getLanguage())); - if (StringUtils.isNotBlank(searchTerms)) { - params.put("searchTerms", searchTerms.toLowerCase()); + Map params = getDefaultXSLParams(sm, context, XslUtil.twoCharLangCode(context.getLanguage())); + if (StringUtils.isNotBlank(searchTerms)) { + params.put("searchTerms", searchTerms.toLowerCase()); + } + Element feed = InspireAtomUtil.getDatasetFeed(context, spIdentifier, spNamespace, params, language); + return writeOutResponse(Xml.getString(feed), "application", "atom+xml"); } - Element feed = InspireAtomUtil.getDatasetFeed(context, spIdentifier, spNamespace, params, language); - return writeOutResponse(Xml.getString(feed), "application", "atom+xml"); } private Element getServiceFeed(ServiceContext context, final String uuid, final String language) throws Exception { @@ -191,6 +192,15 @@ private Map getDefaultXSLParams(SettingManager settingManager, S return params; } + /** + * Service context for atom.service. + * + * When creating a new service context you are responsible for thread local management and any cleanup. + * + * @param lang + * @param request + * @return service context for atom.service + */ private ServiceContext createServiceContext(String lang, HttpServletRequest request) { final ServiceManager serviceManager = ApplicationContextHolder.get().getBean(ServiceManager.class); return serviceManager.createServiceContext("atom.service", lang, request); @@ -215,7 +225,7 @@ private HttpEntity writeOutResponse(String content, String contentType, * @param language the language to be used for translation of title, etc. in the resulting dataset ATOM feed * @param searchTerms the searchTerms for filtering of the spatial datasets * @param webRequest the request object - * @return + * @return atom feed * @throws Exception */ @RequestMapping(value = "/" + InspireAtomUtil.LOCAL_DOWNLOAD_DATASET_URL_SUFFIX) @@ -228,57 +238,57 @@ public HttpEntity localDatasetDownload( @RequestParam(value = "q", required = false) String searchTerms, NativeWebRequest webRequest) throws Exception { - ServiceContext context = createServiceContext(Geonet.DEFAULT_LANGUAGE, webRequest.getNativeRequest(HttpServletRequest.class)); - - SettingManager sm = context.getBean(SettingManager.class); - boolean inspireEnable = sm.getValueAsBool(Settings.SYSTEM_INSPIRE_ENABLE); - if (!inspireEnable) { - Log.info(Geonet.ATOM, "INSPIRE is disabled"); - throw new OperationNotAllowedEx("INSPIRE option is not enabled on this catalog."); - } + try (ServiceContext context = createServiceContext(Geonet.DEFAULT_LANGUAGE, webRequest.getNativeRequest(HttpServletRequest.class))) { + SettingManager sm = context.getBean(SettingManager.class); + boolean inspireEnable = sm.getValueAsBool(Settings.SYSTEM_INSPIRE_ENABLE); + if (!inspireEnable) { + Log.info(Geonet.ATOM, "INSPIRE is disabled"); + throw new OperationNotAllowedEx("INSPIRE option is not enabled on this catalog."); + } - Map params = getDefaultXSLParams(sm, context, context.getLanguage()); - if (StringUtils.isNotBlank(crs)) { - crs = URLDecoder.decode(crs,Constants.ENCODING); - params.put("requestedCrs", crs); - } - if (StringUtils.isNotBlank(searchTerms)) { - params.put("searchTerms", searchTerms.toLowerCase()); - } - Element feed = InspireAtomUtil.getDatasetFeed(context, spIdentifier, spNamespace, params, language); - Map crsCounts = new HashMap();; - Namespace ns = Namespace.getNamespace("http://www.w3.org/2005/Atom"); - if (crs!=null) { - crsCounts = countDatasetsForCrs(feed, crs, ns); - } else { - List entries = (feed.getChildren("entry", ns)); - if (entries.size()==1) { - crsCounts.put(1, entries.get(0)); + Map params = getDefaultXSLParams(sm, context, context.getLanguage()); + if (StringUtils.isNotBlank(crs)) { + crs = URLDecoder.decode(crs,Constants.ENCODING); + params.put("requestedCrs", crs); } - } - int downloadCount = crsCounts.size()>0 ? crsCounts.keySet().iterator().next() : 0; - Element selectedEntry = crsCounts.get(downloadCount); - - // No download for the CRS specified - if (downloadCount == 0) { - throw new Exception("No downloads available for dataset (spatial_dataset_identifier_code: " + spIdentifier + ", spatial_dataset_identifier_namespace: " + spNamespace + ", crs: " + crs + ", searchTerms: " + searchTerms + ")"); - - // Only one download for the CRS specified - } else if (downloadCount == 1) { - String type = null; - Element link = selectedEntry.getChild("link", ns); - if (link!=null) { - type = link.getAttributeValue("type"); + if (StringUtils.isNotBlank(searchTerms)) { + params.put("searchTerms", searchTerms.toLowerCase()); + } + Element feed = InspireAtomUtil.getDatasetFeed(context, spIdentifier, spNamespace, params, language); + Map crsCounts = new HashMap();; + Namespace ns = Namespace.getNamespace("http://www.w3.org/2005/Atom"); + if (crs!=null) { + crsCounts = countDatasetsForCrs(feed, crs, ns); + } else { + List entries = (feed.getChildren("entry", ns)); + if (entries.size()==1) { + crsCounts.put(1, entries.get(0)); + } } - HttpServletResponse nativeRes = webRequest.getNativeResponse(HttpServletResponse.class); - nativeRes.setStatus(HttpServletResponse.SC_MOVED_PERMANENTLY); + int downloadCount = crsCounts.size()>0 ? crsCounts.keySet().iterator().next() : 0; + Element selectedEntry = crsCounts.get(downloadCount); + + // No download for the CRS specified + if (downloadCount == 0) { + throw new Exception("No downloads available for dataset (spatial_dataset_identifier_code: " + spIdentifier + ", spatial_dataset_identifier_namespace: " + spNamespace + ", crs: " + crs + ", searchTerms: " + searchTerms + ")"); + + // Only one download for the CRS specified + } else if (downloadCount == 1) { + String type = null; + Element link = selectedEntry.getChild("link", ns); + if (link!=null) { + type = link.getAttributeValue("type"); + } + HttpServletResponse nativeRes = webRequest.getNativeResponse(HttpServletResponse.class); + nativeRes.setStatus(HttpServletResponse.SC_MOVED_PERMANENTLY); // nativeRes.setHeader("Location", selectedEntry.getChildText("id",ns)); - return redirectResponse(selectedEntry.getChildText("id",ns)); - // Otherwise, return a feed with the downloads for the specified CRS - } else { - // Filter the dataset feed by CRS code. - InspireAtomUtil.filterDatasetFeedByCrs(feed, crs); - return writeOutResponse(Xml.getString(feed),"application", "atom+xml"); + return redirectResponse(selectedEntry.getChildText("id",ns)); + // Otherwise, return a feed with the downloads for the specified CRS + } else { + // Filter the dataset feed by CRS code. + InspireAtomUtil.filterDatasetFeedByCrs(feed, crs); + return writeOutResponse(Xml.getString(feed),"application", "atom+xml"); + } } } @@ -324,17 +334,18 @@ public HttpEntity localOpenSearchDescription( @RequestParam(value = "language", required = false) String language, NativeWebRequest webRequest) throws Exception { - ServiceContext context = createServiceContext(Geonet.DEFAULT_LANGUAGE, webRequest.getNativeRequest(HttpServletRequest.class)); + try (ServiceContext context = createServiceContext(Geonet.DEFAULT_LANGUAGE, webRequest.getNativeRequest(HttpServletRequest.class))) { + SettingManager sm = context.getBean(SettingManager.class); + boolean inspireEnable = sm.getValueAsBool(Settings.SYSTEM_INSPIRE_ENABLE); + if (!inspireEnable) { + Log.info(Geonet.ATOM, "INSPIRE is disabled"); + throw new OperationNotAllowedEx("INSPIRE option is not enabled on this catalog."); + } - SettingManager sm = context.getBean(SettingManager.class); - boolean inspireEnable = sm.getValueAsBool(Settings.SYSTEM_INSPIRE_ENABLE); - if (!inspireEnable) { - Log.info(Geonet.ATOM, "INSPIRE is disabled"); - throw new OperationNotAllowedEx("INSPIRE option is not enabled on this catalog."); - } + Element description = getOpenSearchDescription(context, uuid); + return writeOutResponse(Xml.getString(description), "application", "opensearchdescription+xml"); - Element description = getOpenSearchDescription(context, uuid); - return writeOutResponse(Xml.getString(description), "application", "opensearchdescription+xml"); + } } private Element getOpenSearchDescription(ServiceContext context, final String uuid) throws Exception { diff --git a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/ApproveRecord.java b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/ApproveRecord.java index 1a315ca05afe..3d5f8b26e075 100644 --- a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/ApproveRecord.java +++ b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/ApproveRecord.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -23,6 +23,8 @@ package org.fao.geonet.listener.metadata.draft; +import jeeves.server.context.ServiceContext; +import jeeves.server.dispatchers.ServiceManager; import org.fao.geonet.ApplicationContextHolder; import org.fao.geonet.constants.Geonet; import org.fao.geonet.domain.AbstractMetadata; @@ -65,6 +67,9 @@ public class ApproveRecord implements ApplicationListener @Autowired private IMetadataStatus metadataStatus; + @Autowired + ServiceManager serviceManager; + @Autowired private DraftUtilities draftUtilities; @@ -76,7 +81,7 @@ public void onApplicationEvent(MetadataStatusChanged event) { } @TransactionalEventListener(phase = TransactionPhase.BEFORE_COMMIT) - public void doAfterCommit(MetadataStatusChanged event) { + public void doBeforeCommit(MetadataStatusChanged event) { try { Log.trace(Geonet.DATA_MANAGER, "Status changed for metadata with id " + event.getMd().getId()); @@ -87,14 +92,16 @@ public void doAfterCommit(MetadataStatusChanged event) { case StatusValue.Status.DRAFT: case StatusValue.Status.SUBMITTED: if (event.getMd() instanceof Metadata) { - Log.trace(Geonet.DATA_MANAGER, - "Replacing contents of record (ID=" + event.getMd().getId() + ") with draft, if exists."); - draftUtilities.replaceMetadataWithDraft(event.getMd()); + try (ServiceContext context = serviceManager.createServiceContext("approve_record", event.getUser())) { + Log.trace(Geonet.DATA_MANAGER, + "Replacing contents of record (ID=" + event.getMd().getId() + ") with draft, if exists."); + draftUtilities.replaceMetadataWithDraft(event.getMd()); + } } break; case StatusValue.Status.RETIRED: // case StatusValue.Status.REJECTED: - try { + try (ServiceContext context = serviceManager.createServiceContext("approve_record", event.getUser())){ Log.trace(Geonet.DATA_MANAGER, "Removing draft from record (ID=" + event.getMd().getId() + "), if exists."); removeDraft(event.getMd()); @@ -104,7 +111,7 @@ public void doAfterCommit(MetadataStatusChanged event) { } break; case StatusValue.Status.APPROVED: - try { + try (ServiceContext context = serviceManager.createServiceContext("approve_record", event.getUser())){ Log.trace(Geonet.DATA_MANAGER, "Replacing contents of approved record (ID=" + event.getMd().getId() + ") with draft, if exists."); approveWithDraft(event); diff --git a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftCleanup.java b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftCleanup.java index 925e416303a5..f2cd26a76b58 100644 --- a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftCleanup.java +++ b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftCleanup.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -25,6 +25,8 @@ import java.util.List; +import jeeves.server.context.ServiceContext; +import jeeves.server.dispatchers.ServiceManager; import org.fao.geonet.constants.Geonet; import org.fao.geonet.domain.MetadataDraft; import org.fao.geonet.events.md.MetadataRemove; @@ -55,12 +57,15 @@ public class DraftCleanup { @Autowired private DraftUtilities draftUtilities; + @Autowired + ServiceManager serviceManager; + @TransactionalEventListener @Transactional(propagation = Propagation.REQUIRES_NEW) public void doAfterCommit(MetadataRemove event) { Log.trace(Geonet.DATA_MANAGER, "A metadata has been removed. Cleanup associated drafts of " + event.getSource()); - try { + try (ServiceContext context = serviceManager.createServiceContext("draft_cleanup", -1)) { List toRemove = metadataDraftRepository .findAll((Specification) MetadataSpecs.hasMetadataUuid(event.getMd().getUuid())); diff --git a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftCreated.java b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftCreated.java index 83d5458e7a62..64dd2cc474fb 100644 --- a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftCreated.java +++ b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftCreated.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -25,6 +25,8 @@ import java.util.Arrays; +import jeeves.server.context.ServiceContext; +import jeeves.server.dispatchers.ServiceManager; import org.fao.geonet.constants.Geonet; import org.fao.geonet.domain.AbstractMetadata; import org.fao.geonet.domain.MetadataDraft; @@ -55,6 +57,9 @@ public class DraftCreated implements ApplicationListener { @Autowired private IMetadataIndexer metadataIndexer; + @Autowired + ServiceManager serviceManager; + @Override public void onApplicationEvent(MetadataDraftAdd event) { } @@ -62,7 +67,7 @@ public void onApplicationEvent(MetadataDraftAdd event) { @TransactionalEventListener(phase = TransactionPhase.AFTER_COMPLETION) public void doAfterCommit(MetadataDraftAdd event) { Log.trace(Geonet.DATA_MANAGER, "Reindexing non drafted versions of uuid " + event.getMd().getUuid()); - try { + try (ServiceContext context = serviceManager.createServiceContext("draft_created", -1)) { for (AbstractMetadata md : metadataUtils.findAllByUuid(event.getMd().getUuid())) { if (!(md instanceof MetadataDraft)) { Log.trace(Geonet.DATA_MANAGER, "Reindexing " + md.getId()); diff --git a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftRemoved.java b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftRemoved.java index bc957e845548..3b2bbb3898bd 100644 --- a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftRemoved.java +++ b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftRemoved.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -29,6 +29,8 @@ import javax.transaction.Transactional; import javax.transaction.Transactional.TxType; +import jeeves.server.context.ServiceContext; +import jeeves.server.dispatchers.ServiceManager; import org.fao.geonet.constants.Geonet; import org.fao.geonet.domain.AbstractMetadata; import org.fao.geonet.domain.MetadataDraft; @@ -58,11 +60,14 @@ public class DraftRemoved { @Autowired private IMetadataIndexer metadataIndexer; + @Autowired + ServiceManager serviceManager; + @TransactionalEventListener(phase = TransactionPhase.AFTER_COMPLETION, fallbackExecution = true) public void doAfterCommit(MetadataDraftRemove event) { Log.trace(Geonet.DATA_MANAGER, "Reindexing non drafted versions of uuid " + event.getMd().getUuid()); - try { + try (ServiceContext context = serviceManager.createServiceContext("draft_removed", -1)) { for (AbstractMetadata md : getRecords(event)) { if (!(md instanceof MetadataDraft)) { Log.trace(Geonet.DATA_MANAGER, "Reindexing " + md.getId()); diff --git a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftUtilities.java b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftUtilities.java index e9df323af46b..c5180826d4a7 100644 --- a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftUtilities.java +++ b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/DraftUtilities.java @@ -1,3 +1,26 @@ +/* + * Copyright (C) 2001-2021 Food and Agriculture Organization of the + * United Nations (FAO-UN), United Nations World Food Programme (WFP) + * and United Nations Environment Programme (UNEP) + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or (at + * your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + * + * Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2, + * Rome - Italy. email: geonetwork@osgeo.org + */ + package org.fao.geonet.listener.metadata.draft; import jeeves.server.context.ServiceContext; @@ -20,6 +43,9 @@ import java.util.List; +/** + * Facade with utility methods responsible for workflow transitions. + */ @Service public class DraftUtilities { @@ -142,6 +168,9 @@ public AbstractMetadata replaceMetadataWithDraft(AbstractMetadata md, AbstractMe try { ServiceContext context = ServiceContext.get(); + if( context == null ){ + Log.trace(Geonet.DATA_MANAGER,"context unavailable"); + } Element xmlData = draft.getXmlData(false); String changeDate = draft.getDataInfo().getChangeDate().getDateAndTime(); diff --git a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/UpdateOperations.java b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/UpdateOperations.java index fb6049666c19..82269a886c22 100644 --- a/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/UpdateOperations.java +++ b/listeners/src/main/java/org/fao/geonet/listener/metadata/draft/UpdateOperations.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -25,6 +25,7 @@ import java.util.Arrays; +import jeeves.server.dispatchers.ServiceManager; import org.fao.geonet.constants.Geonet; import org.fao.geonet.domain.AbstractMetadata; import org.fao.geonet.domain.Group; @@ -70,12 +71,15 @@ public class UpdateOperations implements ApplicationListener { @Autowired private MetadataDraftRepository metadataDraftRepository; + @Autowired + ServiceManager serviceManager; + @Override public void onApplicationEvent(MetadataShare event) { } @TransactionalEventListener(phase = TransactionPhase.BEFORE_COMMIT) - public void doAfterCommit(MetadataShare event) { + public void doBeforeCommit(MetadataShare event) { try { @@ -95,39 +99,39 @@ public void doAfterCommit(MetadataShare event) { MetadataDraft draft = metadataDraftRepository.findOneByUuid(md.getUuid()); if (draft != null) { - // Copy privileges from original metadata - OperationAllowed op = event.getOp(); - ServiceContext context = ServiceContext.get(); - - // Only interested in editing and reviewing privileges - // No one else should be able to see it - if (op.getId().getOperationId() == ReservedOperation.editing.getId()) { - Log.trace(Geonet.DATA_MANAGER, "Updating privileges on draft " + draft.getId()); - - // except for reserved groups - Group g = groupRepository.findById(op.getId().getGroupId()).get(); - if (!g.isReserved()) { - try { - if (event.getType() == Type.REMOVE) { - Log.trace(Geonet.DATA_MANAGER, "Removing editing on group " - + op.getId().getGroupId() + " for draft " + draft.getId()); - - metadataOperations.forceUnsetOperation(context, draft.getId(), - op.getId().getGroupId(), op.getId().getOperationId()); - } else { - Log.trace(Geonet.DATA_MANAGER, "Adding editing on group " + op.getId().getGroupId() - + " for draft " + draft.getId()); - - metadataOperations.forceSetOperation(context, draft.getId(), - op.getId().getGroupId(), op.getId().getOperationId()); + try (ServiceContext context = serviceManager.createServiceContext("update_operations", -1)) { + // Copy privileges from original metadata + OperationAllowed op = event.getOp(); + + // Only interested in editing and reviewing privileges + // No one else should be able to see it + if (op.getId().getOperationId() == ReservedOperation.editing.getId()) { + Log.trace(Geonet.DATA_MANAGER, "Updating privileges on draft " + draft.getId()); + + // except for reserved groups + Group g = groupRepository.findById(op.getId().getGroupId()).get(); + if (!g.isReserved()) { + try { + if (event.getType() == Type.REMOVE) { + Log.trace(Geonet.DATA_MANAGER, "Removing editing on group " + + op.getId().getGroupId() + " for draft " + draft.getId()); + + metadataOperations.forceUnsetOperation(context, draft.getId(), + op.getId().getGroupId(), op.getId().getOperationId()); + } else { + Log.trace(Geonet.DATA_MANAGER, "Adding editing on group " + op.getId().getGroupId() + + " for draft " + draft.getId()); + + metadataOperations.forceSetOperation(context, draft.getId(), + op.getId().getGroupId(), op.getId().getOperationId()); + } + metadataIndexer.indexMetadata(Arrays.asList(String.valueOf(draft.getId()))); + } catch (Exception e) { + Log.error(Geonet.DATA_MANAGER, "Error cascading operation to draft", e); } - metadataIndexer.indexMetadata(Arrays.asList(String.valueOf(draft.getId()))); - } catch (Exception e) { - Log.error(Geonet.DATA_MANAGER, "Error cascading operation to draft", e); } } } - } } } catch (Throwable e) { diff --git a/services/src/main/java/org/fao/geonet/api/ApiUtils.java b/services/src/main/java/org/fao/geonet/api/ApiUtils.java index c154684dd104..752e73be3cef 100644 --- a/services/src/main/java/org/fao/geonet/api/ApiUtils.java +++ b/services/src/main/java/org/fao/geonet/api/ApiUtils.java @@ -77,6 +77,9 @@ /** * API utilities mainly to deal with parameters. + * + * Many of these methods assume a service context is available as a thread locale, + * see {@link #createServiceContext(HttpServletRequest)} methods for details. */ public class ApiUtils { @@ -137,14 +140,17 @@ public static String getInternalId(String uuidOrInternalId, Boolean approved) return id; } - //fixes the uri fragment portion (that the part after the "#") - // so it is properly encoded - //http://www.thesaurus.gc.ca/concept/#Offshore area --> http://www.thesaurus.gc.ca/concept/#Offshore%20area - //http://www.thesaurus.gc.ca/concept/#AIDS (disease) --> http://www.thesaurus.gc.ca/concept/#AIDS%20%28disease%29 - //http://www.thesaurus.gc.ca/concept/#Alzheimer's disease --> http://www.thesaurus.gc.ca/concept/#Alzheimer%27s%20disease - // - //Includes some special case handling for spaces and ":" - // + /** + * Fixes the uri fragment portion (that the part after the "#") so it is properly encoded. + * + *
    + *
  • http://www.thesaurus.gc.ca/concept/#Offshore area --> http://www.thesaurus.gc.ca/concept/#Offshore%20area
    • + *
  • http://www.thesaurus.gc.ca/concept/#AIDS (disease) --> http://www.thesaurus.gc.ca/concept/#AIDS%20%28disease%29
    • + *
  • http://www.thesaurus.gc.ca/concept/#Alzheimer's disease --> http://www.thesaurus.gc.ca/concept/#Alzheimer%27s%20disease
    • + *
+ * + * Includes some special case handling for spaces and ":" + */ //TODO: there could be other special handling for special cases in the future public static String fixURIFragment(String uri) throws UnsupportedEncodingException { String[] parts = uri.split("#"); @@ -157,7 +163,13 @@ public static String fixURIFragment(String uri) throws UnsupportedEncodingExcept return String.join("#",parts); } - + /** + * Look up metadata record. + * + * @param uuidOrInternalId + * @return record + * @throws ResourceNotFoundException + */ public static AbstractMetadata getRecord(String uuidOrInternalId) throws ResourceNotFoundException { IMetadataUtils metadataRepository = ApplicationContextHolder.get().getBean(IMetadataUtils.class); AbstractMetadata metadata = null; @@ -196,6 +208,9 @@ public static AbstractMetadata getRecord(String uuidOrInternalId) throws Resourc *

* If session is null, it's probably a bot due to {@link AllRequestsInterceptor#createSessionForAllButNotCrawlers(HttpServletRequest)}. * In such case return an exception. + * + * @param httpSession HTTP session + * @return Jeeves user session */ static public UserSession getUserSession(HttpSession httpSession) { if (httpSession == null) { @@ -211,6 +226,30 @@ static public UserSession getUserSession(HttpSession httpSession) { /** * If you really need a ServiceContext use this. Try to avoid in order to reduce dependency on * Jeeves. + *

+ * This method has a side effect of setting the created service context for the current thread. + * If you create a service context you are responsible for managing on the current thread and any cleanup: + *

+ * Using auto closable: + * 

+     * try(ServiceContext context = ApiUtils.createServiceContext(request, iso3langCode)){
+     *    ...
+     * }
+     *
+ * + * Or manually: + * 

+     * ServiceContext context = ApiUtils.createServiceContext(request, iso3langCode);
+     * try {
+     *     ...
+     * }
+     * finally {
+     *     context.clearAsThreadLocal();
+     *     context.clear();
+     * }
+     *
+ * @param request + * @return new sevice context, assigned to the current thread */ static public ServiceContext createServiceContext(HttpServletRequest request) { String iso3langCode = ApplicationContextHolder.get().getBean(LanguageUtils.class) @@ -218,13 +257,51 @@ static public ServiceContext createServiceContext(HttpServletRequest request) { return createServiceContext(request, iso3langCode); } + /** + * If you really need a ServiceContext use this. Try to avoid in order to reduce dependency on + * Jeeves. + * + * This method has a side effect of setting the created service context for the current thread. + * If you create a service context you are responsible for managing on the current thread and any cleanup: + * + * Using auto closable: + * 

+     * try(ServiceContext context = ApiUtils.createServiceContext(request, iso3langCode)){
+     *    ...
+     * }
+     *
+ * + * Or manually: + * 

+     * ServiceContext context = ApiUtils.createServiceContext(request, iso3langCode);
+     * try {
+     *     ...
+     * }
+     * finally {
+     *     context.clearAsThreadLocal();
+     *     context.clear();
+     * }
+     *
+ * + * @param request + * @param iso3langCode + * @return new sevice context, assigned to the current thread + */ static public ServiceContext createServiceContext(HttpServletRequest request, String iso3langCode) { ServiceManager serviceManager = ApplicationContextHolder.get().getBean(ServiceManager.class); - ServiceContext serviceContext = serviceManager.createServiceContext("Api", iso3langCode, request); + String contextName = "Api"+request.getPathInfo(); + ServiceContext serviceContext = serviceManager.createServiceContext(contextName, iso3langCode, request); serviceContext.setAsThreadLocal(); return serviceContext; } + /** + * Generate the filesize of files in a directory in KiB. + * + * @param lDir directory location + * @return size of files in directory in KiB + * @throws IOException + */ public static long sizeOfDirectory(Path lDir) throws IOException { final long[] size = new long[]{0}; Files.walkFileTree(lDir, new SimpleFileVisitor() { @@ -235,9 +312,17 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IO } }); - return size[0] / 1024; + return size[0] / 1024; // convert to KiB } + /** + * Download xml file into temporary location. + * + * @param url + * @return temporary file + * @throws IOException + * @throws URISyntaxException + */ public static Path downloadUrlInTemp(String url) throws IOException, URISyntaxException { URI uri = new URI(url); @@ -258,61 +343,169 @@ public static Path downloadUrlInTemp(String url) throws IOException, URISyntaxEx /** * Check if the current user can edit this record. + * + * This method creates a temporary service context using the provided request to check record access, + * if you have a service context already please use {@link #canEditRecord(String, ServiceContext)}. + * + * @param metadataUuid Look up metadata record + * @param request Request to identify current user + * @return metadata record + * @throws SecurityException if user is not allowed to edit */ static public AbstractMetadata canEditRecord(String metadataUuid, HttpServletRequest request) throws Exception { - ApplicationContext appContext = ApplicationContextHolder.get(); + ServiceContext previous = ServiceContext.get(); + if (previous != null) previous.clearAsThreadLocal(); + + try (ServiceContext context = createServiceContext(request)) { + return canEditRecord(metadataUuid, context); + } + finally { + if (previous != null) previous.setAsThreadLocal(); + } + } + + /** + * Check if the current user can edit this record. + * + * @param metadataUuid Look up metadata record + * @return metadata record + * @throws SecurityException if user is not allowed to edit + */ + static public AbstractMetadata canEditRecord(String metadataUuid, ServiceContext context) throws Exception { AbstractMetadata metadata = getRecord(metadataUuid); - AccessManager accessManager = appContext.getBean(AccessManager.class); - if (!accessManager.canEdit(createServiceContext(request), String.valueOf(metadata.getId()))) { + AccessManager accessManager = context.getBean(AccessManager.class); + if (!accessManager.canEdit(context, String.valueOf(metadata.getId()))) { throw new SecurityException(String.format( - "You can't edit record with UUID %s", metadataUuid)); + "User %s can't edit record with UUID %s", context.userName(), metadataUuid)); } return metadata; } /** * Check if the current user can review this record. + * + * This method creates a temporary service context using the provided request to check record access, + * if you have a service context already please use {@link #canReviewRecord(String, ServiceContext)}. + * + * @param metadataUuid Look up metadata record + * @param request Request to identify current user + * @return metadata record + * @throws SecurityException if user is not allowed to review + * @deprecated Not presently used */ static public AbstractMetadata canReviewRecord(String metadataUuid, HttpServletRequest request) throws Exception { - ApplicationContext appContext = ApplicationContextHolder.get(); + ServiceContext previous = ServiceContext.get(); + if (previous != null) previous.clearAsThreadLocal(); + + try (ServiceContext context = createServiceContext(request)) { + return canReviewRecord(metadataUuid,context); + } + finally { + if (previous != null) previous.setAsThreadLocal(); + } + } + + /** + * Check if the current user can review this record. + * + * @param metadataUuid Look up metadata record + * @return metadata record + * @throws SecurityException if user is not allowed to review + */ + static public AbstractMetadata canReviewRecord(String metadataUuid,ServiceContext context) throws Exception { AbstractMetadata metadata = getRecord(metadataUuid); - AccessManager accessManager = appContext.getBean(AccessManager.class); - if (!accessManager.canReview(createServiceContext(request), String.valueOf(metadata.getId()))) { + AccessManager accessManager = context.getBean(AccessManager.class); + if (!accessManager.canReview(context, String.valueOf(metadata.getId()))) { throw new SecurityException(String.format( - "You can't review or edit record with UUID %s", metadataUuid)); + "User %s can't review or edit record with UUID %s", context.userName(), metadataUuid)); } return metadata; } /** * Check if the current user can change status of this record. + * + * This method creates a temporary service context using the provided request to check record access, + * if you have a service context already please use {@link #canChangeStatusRecord(String, ServiceContext)}. + * + * @param metadataUuid Look up metadata record + * @param request Request to identify current user + * @return metadata record + * @throws SecurityException if user is not allowed to review + * @deprecated Not presently used */ static public AbstractMetadata canChangeStatusRecord(String metadataUuid, HttpServletRequest request) throws Exception { - ApplicationContext appContext = ApplicationContextHolder.get(); + ServiceContext previous = ServiceContext.get(); + if (previous != null) previous.clearAsThreadLocal(); + + try (ServiceContext context = createServiceContext(request)) { + return canChangeStatusRecord(metadataUuid,context); + } + finally { + if (previous != null) previous.setAsThreadLocal(); + } + } + + /** + * Check if the current user can change status of this record. + * + * @param metadataUuid Look up metadata record + * @return metadata record + * @throws SecurityException if user is not allowed to change status + */ + static public AbstractMetadata canChangeStatusRecord(String metadataUuid, ServiceContext context) throws Exception { AbstractMetadata metadata = getRecord(metadataUuid); - AccessManager accessManager = appContext.getBean(AccessManager.class); - if (!accessManager.canChangeStatus(createServiceContext(request), String.valueOf(metadata.getId()))) { + AccessManager accessManager = context.getBean(AccessManager.class); + if (!accessManager.canChangeStatus(context, String.valueOf(metadata.getId()))) { throw new SecurityException(String.format( - "You can't change status of record with UUID %s", metadataUuid)); + "User %s can't change status of record with UUID %s", context.userName(), metadataUuid)); } return metadata; } /** * Check if the current user can view this record. + * + * This method creates a temporary service context using the provided request to check record access, + * if you have a service context already please use {@link #canViewRecord(String, ServiceContext)}. + * + * @param metadataUuid Look up metadata record + * @param request Request to identify current user + * @return metadata record + * @throws SecurityException if user is not allowed to view */ public static AbstractMetadata canViewRecord(String metadataUuid, HttpServletRequest request) throws Exception { + ServiceContext previous = ServiceContext.get(); + if (previous != null) previous.clearAsThreadLocal(); + + try (ServiceContext context = createServiceContext(request)) { + return canViewRecord(metadataUuid,context); + } + finally { + if (previous != null) previous.setAsThreadLocal(); + } + } + /** + * Check if the current user can view this record. + * + * @param metadataUuid Look up metadata record + * @return metadata record + * @throws SecurityException if user is not allowed to view + */ + public static AbstractMetadata canViewRecord(String metadataUuid, ServiceContext context) throws Exception { AbstractMetadata metadata = getRecord(metadataUuid); try { - Lib.resource.checkPrivilege(createServiceContext(request), String.valueOf(metadata.getId()), ReservedOperation.view); + Lib.resource.checkPrivilege(context, String.valueOf(metadata.getId()), ReservedOperation.view); } catch (Exception e) { throw new SecurityException(String.format( - "You can't view record with UUID %s", metadataUuid)); + "User %s can't view record with UUID %s", context.userName(), metadataUuid)); } return metadata; } /** + * Create a favicon from the provided image. + * * @param img * @param outFile * @throws IOException diff --git a/services/src/main/java/org/fao/geonet/api/es/EsHTTPProxy.java b/services/src/main/java/org/fao/geonet/api/es/EsHTTPProxy.java index e54eeaaf9afc..db9e9b95464b 100644 --- a/services/src/main/java/org/fao/geonet/api/es/EsHTTPProxy.java +++ b/services/src/main/java/org/fao/geonet/api/es/EsHTTPProxy.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -254,8 +254,9 @@ public void search( String body, @Parameter(hidden = true) HttpEntity httpEntity) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - call(context, httpSession, request, response, "_search", httpEntity.getBody(), bucket); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + call(context, httpSession, request, response, "_search", httpEntity.getBody(), bucket); + } } @@ -287,9 +288,9 @@ public void call( String body, @Parameter(hidden = true) HttpEntity httpEntity) throws Exception { - - ServiceContext context = ApiUtils.createServiceContext(request); - call(context, httpSession, request, response, endPoint, httpEntity.getBody(), bucket); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + call(context, httpSession, request, response, endPoint, httpEntity.getBody(), bucket); + } } public void call(ServiceContext context, HttpSession httpSession, HttpServletRequest request, diff --git a/services/src/main/java/org/fao/geonet/api/groups/GroupsApi.java b/services/src/main/java/org/fao/geonet/api/groups/GroupsApi.java index d6770dabbbd2..1465c16f35ef 100644 --- a/services/src/main/java/org/fao/geonet/api/groups/GroupsApi.java +++ b/services/src/main/java/org/fao/geonet/api/groups/GroupsApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -184,51 +184,52 @@ public void getGroupLogo( Locale locale = languageUtils.parseAcceptLanguage(request.getLocales()); ApplicationContext context = ApplicationContextHolder.get(); - ServiceContext serviceContext = ApiUtils.createServiceContext(request, locale.getISO3Country()); - if (context == null) { - throw new RuntimeException("ServiceContext not available"); - } + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request, locale.getISO3Country())) { + if (context == null) { + throw new RuntimeException("ServiceContext not available"); + } - Optional group = groupRepository.findById(groupId); - if (!group.isPresent()) { - throw new ResourceNotFoundException(messages.getMessage("api.groups.group_not_found", new - Object[]{groupId}, locale)); - } - try { - final Resources resources = context.getBean(Resources.class); - final String logoUUID = group.get().getLogo(); - if (StringUtils.isNotBlank(logoUUID) && !logoUUID.startsWith("http://") && !logoUUID.startsWith("https//")) { - try (Resources.ResourceHolder image = getImage(resources, serviceContext, group.get())) { - if (image != null) { - FileTime lastModifiedTime = image.getLastModifiedTime(); - response.setDateHeader("Expires", System.currentTimeMillis() + SIX_HOURS * 1000L); - if (webRequest.checkNotModified(lastModifiedTime.toMillis())) { - // webRequest.checkNotModified sets the right HTTP headers + Optional group = groupRepository.findById(groupId); + if (!group.isPresent()) { + throw new ResourceNotFoundException(messages.getMessage("api.groups.group_not_found", new + Object[]{groupId}, locale)); + } + try { + final Resources resources = context.getBean(Resources.class); + final String logoUUID = group.get().getLogo(); + if (StringUtils.isNotBlank(logoUUID) && !logoUUID.startsWith("http://") && !logoUUID.startsWith("https//")) { + try (Resources.ResourceHolder image = getImage(resources, serviceContext, group.get())) { + if (image != null) { + FileTime lastModifiedTime = image.getLastModifiedTime(); + response.setDateHeader("Expires", System.currentTimeMillis() + SIX_HOURS * 1000L); + if (webRequest.checkNotModified(lastModifiedTime.toMillis())) { + // webRequest.checkNotModified sets the right HTTP headers + return; + } + response.setContentType(AttachmentsApi.getFileContentType(image.getPath())); + response.setContentLength((int) Files.size(image.getPath())); + response.addHeader("Cache-Control", "max-age=" + SIX_HOURS + ", public"); + FileUtils.copyFile(image.getPath().toFile(), response.getOutputStream()); return; } - response.setContentType(AttachmentsApi.getFileContentType(image.getPath())); - response.setContentLength((int) Files.size(image.getPath())); - response.addHeader("Cache-Control", "max-age=" + SIX_HOURS + ", public"); - FileUtils.copyFile(image.getPath().toFile(), response.getOutputStream()); - return; } } - } - // no logo image found. Return a transparent 1x1 png - FileTime lastModifiedTime = FileTime.fromMillis(0); - if (webRequest.checkNotModified(lastModifiedTime.toMillis())) { - return; + // no logo image found. Return a transparent 1x1 png + FileTime lastModifiedTime = FileTime.fromMillis(0); + if (webRequest.checkNotModified(lastModifiedTime.toMillis())) { + return; + } + response.setContentType("image/png"); + response.setContentLength(TRANSPARENT_1_X_1_PNG.length); + response.addHeader("Cache-Control", "max-age=" + SIX_HOURS + ", public"); + response.getOutputStream().write(TRANSPARENT_1_X_1_PNG); + + } catch (IOException e) { + Log.error(LOGGER, String.format("There was an error accessing the logo of the group with id '%d'", + groupId)); + throw new RuntimeException(e); } - response.setContentType("image/png"); - response.setContentLength(TRANSPARENT_1_X_1_PNG.length); - response.addHeader("Cache-Control", "max-age=" + SIX_HOURS + ", public"); - response.getOutputStream().write(TRANSPARENT_1_X_1_PNG); - - } catch (IOException e) { - Log.error(LOGGER, String.format("There was an error accessing the logo of the group with id '%d'", - groupId)); - throw new RuntimeException(e); } } diff --git a/services/src/main/java/org/fao/geonet/api/harvesting/HarvestersApi.java b/services/src/main/java/org/fao/geonet/api/harvesting/HarvestersApi.java index ca2b45d30f73..2c0fbc0c51dc 100644 --- a/services/src/main/java/org/fao/geonet/api/harvesting/HarvestersApi.java +++ b/services/src/main/java/org/fao/geonet/api/harvesting/HarvestersApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -201,15 +201,16 @@ public ResponseEntity checkHarvesterPropertyExist( @RequestParam String exist, HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - final Element list = harvestManager.get(null, context, "site[1]/name[1]"); - if (list.getChildren().stream() - .filter(h -> h instanceof Element) - .map(h -> ((Element) h).getChild("site").getChild(property).getTextTrim()) - .anyMatch(name -> ((String) name).equalsIgnoreCase(exist))) { - return new ResponseEntity<>(HttpStatus.OK); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + final Element list = harvestManager.get(null, context, "site[1]/name[1]"); + if (list.getChildren().stream() + .filter(h -> h instanceof Element) + .map(h -> ((Element) h).getChild("site").getChild(property).getTextTrim()) + .anyMatch(name -> ((String) name).equalsIgnoreCase(exist))) { + return new ResponseEntity<>(HttpStatus.OK); + } + + return new ResponseEntity<>(HttpStatus.NOT_FOUND); } - - return new ResponseEntity<>(HttpStatus.NOT_FOUND); } } diff --git a/services/src/main/java/org/fao/geonet/api/languages/LanguagesApi.java b/services/src/main/java/org/fao/geonet/api/languages/LanguagesApi.java index ad6b53f85e2f..04b8d6039fdc 100644 --- a/services/src/main/java/org/fao/geonet/api/languages/LanguagesApi.java +++ b/services/src/main/java/org/fao/geonet/api/languages/LanguagesApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -124,9 +124,10 @@ public void addLanguages( } } if (data.size() > 0) { - ServiceContext context = ApiUtils.createServiceContext(request); - DbLib.runSQL(context, data); - return; + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + DbLib.runSQL(context, data); + return; + } } } throw new ResourceNotFoundException(String.format( @@ -186,9 +187,10 @@ public void deleteLanguage( } } if (data.size() > 0) { - ServiceContext context = ApiUtils.createServiceContext(request); - DbLib.runSQL(context, data); - return; + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + DbLib.runSQL(context, data); + return; + } } } throw new ResourceNotFoundException(String.format( diff --git a/services/src/main/java/org/fao/geonet/api/links/LinksApi.java b/services/src/main/java/org/fao/geonet/api/links/LinksApi.java index 74a6426bdf98..639a19f078ee 100644 --- a/services/src/main/java/org/fao/geonet/api/links/LinksApi.java +++ b/services/src/main/java/org/fao/geonet/api/links/LinksApi.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -289,63 +289,64 @@ public SimpleMetadataProcessingReport analyzeRecordLinks( @Parameter(hidden = true) HttpServletRequest request ) throws IOException, JDOMException { - MAnalyseProcess registredMAnalyseProcess = getRegistredMAnalyseProcess(); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { + MAnalyseProcess registredMAnalyseProcess = getRegistredMAnalyseProcess(); - ServiceContext serviceContext = ApiUtils.createServiceContext(request); - UserSession session = ApiUtils.getUserSession(httpSession); + UserSession session = ApiUtils.getUserSession(httpSession); - boolean isAdministrator = session.getProfile() == Profile.Administrator; - if (isAdministrator && removeFirst) { - registredMAnalyseProcess.deleteAll(); - } + boolean isAdministrator = session.getProfile() == Profile.Administrator; + if (isAdministrator && removeFirst) { + registredMAnalyseProcess.deleteAll(); + } - SimpleMetadataProcessingReport report = - new SimpleMetadataProcessingReport(); + SimpleMetadataProcessingReport report = + new SimpleMetadataProcessingReport(); - Set ids = Sets.newHashSet(); + Set ids = Sets.newHashSet(); - if (uuids != null || StringUtils.isNotEmpty(bucket)) { - try { - Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, session); - for (String uuid : records) { - if (!metadataUtils.existsMetadataUuid(uuid)) { - report.incrementNullRecords(); - } - for (AbstractMetadata record : metadataRepository.findAllByUuid(uuid)) { - if (!accessManager.canEdit(serviceContext, String.valueOf(record.getId()))) { - report.addNotEditableMetadataId(record.getId()); - } else { - ids.add(record.getId()); - report.addMetadataId(record.getId()); - report.incrementProcessedRecords(); + if (uuids != null || StringUtils.isNotEmpty(bucket)) { + try { + Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, session); + for (String uuid : records) { + if (!metadataUtils.existsMetadataUuid(uuid)) { + report.incrementNullRecords(); + } + for (AbstractMetadata record : metadataRepository.findAllByUuid(uuid)) { + if (!accessManager.canEdit(serviceContext, String.valueOf(record.getId()))) { + report.addNotEditableMetadataId(record.getId()); + } else { + ids.add(record.getId()); + report.addMetadataId(record.getId()); + report.incrementProcessedRecords(); + } } } - } - } catch (Exception e) { - report.addError(e); - } finally { - report.close(); - } - } else { - if (isAdministrator) { - // Process all - final List metadataList = metadataRepository.findAll(); - for (Metadata m : metadataList) { - ids.add(m.getId()); - report.addMetadataId(m.getId()); - report.incrementProcessedRecords(); + } catch (Exception e) { + report.addError(e); + } finally { + report.close(); } } else { - throw new OperationNotAllowedEx(String.format( - "Only administrator can trigger link analysis on the entire catalogue. This is not allowed for %s.", - session.getProfile() - )); + if (isAdministrator) { + // Process all + final List metadataList = metadataRepository.findAll(); + for (Metadata m : metadataList) { + ids.add(m.getId()); + report.addMetadataId(m.getId()); + report.incrementProcessedRecords(); + } + } else { + throw new OperationNotAllowedEx(String.format( + "Only administrator can trigger link analysis on the entire catalogue. This is not allowed for %s.", + session.getProfile() + )); + } + report.close(); } - report.close(); - } - registredMAnalyseProcess.processMetadataAndTestLink(analyze, ids); - return report; + registredMAnalyseProcess.processMetadataAndTestLink(analyze, ids); + return report; + } } diff --git a/services/src/main/java/org/fao/geonet/api/mapservers/MapServersApi.java b/services/src/main/java/org/fao/geonet/api/mapservers/MapServersApi.java index f09a537da729..e9ae10e90102 100644 --- a/services/src/main/java/org/fao/geonet/api/mapservers/MapServersApi.java +++ b/services/src/main/java/org/fao/geonet/api/mapservers/MapServersApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -514,57 +514,56 @@ private String publishResource(String mapserverId, String metadataUuid, String metadataAbstract, HttpServletRequest request, MapServersUtils.ACTION action) throws Exception { - // purge \\n from metadataTitle - geoserver prefers layer titles on a single line - metadataTitle = metadataTitle.replace("\\n", ""); - metadataAbstract = metadataAbstract.replace("\\n", ""); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + // purge \\n from metadataTitle - geoserver prefers layer titles on a single line + metadataTitle = metadataTitle.replace("\\n", ""); + metadataAbstract = metadataAbstract.replace("\\n", ""); - ApplicationContext applicationContext = ApplicationContextHolder.get(); - MapServer m = mapServerRepository.findOneById(Integer.valueOf(mapserverId)); - GeoServerNode g = new GeoServerNode(m); + ApplicationContext applicationContext = ApplicationContextHolder.get(); + MapServer m = mapServerRepository.findOneById(Integer.valueOf(mapserverId)); + GeoServerNode g = new GeoServerNode(m); - - ServiceContext context = ApiUtils.createServiceContext(request); - - String baseUrl = settingManager.getSiteURL(context); - GeoServerRest gs = new GeoServerRest(requestFactory, g.getUrl(), - g.getUsername(), g.getUserpassword(), - g.getNamespacePrefix(), baseUrl, settingManager.getNodeURL(), - m.pushStyleInWorkspace()); + String baseUrl = settingManager.getSiteURL(context); + GeoServerRest gs = new GeoServerRest(requestFactory, g.getUrl(), + g.getUsername(), g.getUserpassword(), + g.getNamespacePrefix(), baseUrl, settingManager.getNodeURL(), + m.pushStyleInWorkspace()); // String access = Util.getParam(params, "access"); - //jdbc:postgresql://host:port/user:password@database#table - if (resource.startsWith("jdbc:postgresql")) { - String[] values = resource.split("/"); + //jdbc:postgresql://host:port/user:password@database#table + if (resource.startsWith("jdbc:postgresql")) { + String[] values = resource.split("/"); - String[] serverInfo = values[2].split(":"); - String host = serverInfo[0]; - String port = serverInfo[1]; + String[] serverInfo = values[2].split(":"); + String host = serverInfo[0]; + String port = serverInfo[1]; - String[] dbUserInfo = values[3].split("@"); + String[] dbUserInfo = values[3].split("@"); - String[] userInfo = dbUserInfo[0].split(":"); - String user = userInfo[0]; - String password = userInfo[1]; + String[] userInfo = dbUserInfo[0].split(":"); + String user = userInfo[0]; + String password = userInfo[1]; - String[] dbInfo = dbUserInfo[1].split("#"); - String db = dbInfo[0]; - String table = dbInfo[1]; + String[] dbInfo = dbUserInfo[1].split("#"); + String db = dbInfo[0]; + String table = dbInfo[1]; - return publishDbTable(action, gs, - "postgis", host, port, user, password, db, table, "postgis", - g.getNamespaceUrl(), metadataUuid, metadataTitle, metadataAbstract); - } else { - if (resource.startsWith("file://") || resource.startsWith("http://")) { - return addExternalFile(action, gs, - resource, - metadataUuid, metadataTitle, metadataAbstract); + return publishDbTable(action, gs, + "postgis", host, port, user, password, db, table, "postgis", + g.getNamespaceUrl(), metadataUuid, metadataTitle, metadataAbstract); } else { - // Get ZIP file from data directory - try (Store.ResourceHolder f = store.getResource(context, metadataUuid, resource)) { - return addZipFile(action, gs, - f.getPath(), resource, + if (resource.startsWith("file://") || resource.startsWith("http://")) { + return addExternalFile(action, gs, + resource, metadataUuid, metadataTitle, metadataAbstract); + } else { + // Get ZIP file from data directory + try (Store.ResourceHolder f = store.getResource(context, metadataUuid, resource)) { + return addZipFile(action, gs, + f.getPath(), resource, + metadataUuid, metadataTitle, metadataAbstract); + } } } } diff --git a/services/src/main/java/org/fao/geonet/api/processing/MInspireEtfValidateProcess.java b/services/src/main/java/org/fao/geonet/api/processing/MInspireEtfValidateProcess.java index b6b7708bc68a..a88507e40765 100644 --- a/services/src/main/java/org/fao/geonet/api/processing/MInspireEtfValidateProcess.java +++ b/services/src/main/java/org/fao/geonet/api/processing/MInspireEtfValidateProcess.java @@ -1,3 +1,26 @@ +/* + * Copyright (C) 2001-2021 Food and Agriculture Organization of the + * United Nations (FAO-UN), United Nations World Food Programme (WFP) + * and United Nations Environment Programme (UNEP) + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or (at + * your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + * + * Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2, + * Rome - Italy. email: geonetwork@osgeo.org + */ + package org.fao.geonet.api.processing; import jeeves.server.context.ServiceContext; @@ -47,7 +70,8 @@ public class MInspireEtfValidateProcess implements SelfNaming { private final ApplicationContext appContext; - private final ServiceContext serviceContext; + /** Shared validation service context used as a fallback if thread local unavailable */ + private ServiceContext validationServiceContext; private final String URL; private ObjectName probeName; @@ -63,7 +87,7 @@ public class MInspireEtfValidateProcess implements SelfNaming { public MInspireEtfValidateProcess(String URL, ServiceContext serviceContext, ApplicationContext appContext) { this.URL = URL; - this.serviceContext = serviceContext; + this.validationServiceContext = serviceContext; this.appContext = appContext; try { @@ -124,6 +148,18 @@ public Object doInTransaction(TransactionStatus transaction) throws Throwable { }); } + /** + * Gets the ServiceContext for the current request. + * + * If there isn't a current request, then this will return the validationServiceContext. + * + * @return ServiceContext for the current request + */ + protected ServiceContext getServiceContext(){ + ServiceContext context = ServiceContext.get(); + return context != null ? context : validationServiceContext; + } + public void processMetadata(Set uuids, String mode) throws Exception { IMetadataUtils metadataRepository = appContext.getBean(IMetadataUtils.class); MetadataValidationRepository metadataValidationRepository = appContext.getBean(MetadataValidationRepository.class); @@ -136,7 +172,7 @@ public void processMetadata(Set uuids, String mode) throws Exception { metadataToAnalyseCount = uuids.size(); analyseMdDate = System.currentTimeMillis(); - ServiceContext context = serviceContext; + ServiceContext context = getServiceContext(); for (String uuid : uuids) { if (!metadataRepository.existsMetadataUuid(uuid)) { @@ -147,7 +183,7 @@ public void processMetadata(Set uuids, String mode) throws Exception { for (AbstractMetadata record : metadataRepository.findAllByUuid(uuid)) { try { - if (!accessManager.canEdit(serviceContext, String.valueOf(record.getId()))) { + if (!accessManager.canEdit(context, String.valueOf(record.getId()))) { metadataAnalysed++; metadataNotAllowed++; } else { @@ -183,7 +219,7 @@ public Object doInTransaction(TransactionStatus transaction) throws Throwable { String testId = null; String getRecordByIdUrl = null; if (StringUtils.isEmpty(mode)) { - testId = inspireValidatorUtils.submitFile(serviceContext, URL, + testId = inspireValidatorUtils.submitFile(context, URL, new ByteArrayInputStream(mdToValidate.getBytes()), entry.getKey(), record.getUuid()); } else { String portal = null; @@ -208,18 +244,18 @@ public Object doInTransaction(TransactionStatus transaction) throws Throwable { portal, ISO19139Namespaces.GMD.getURI(), record.getUuid()); - testId = inspireValidatorUtils.submitUrl(serviceContext, URL, getRecordByIdUrl, entry.getKey(), record.getUuid()); + testId = inspireValidatorUtils.submitUrl(context, URL, getRecordByIdUrl, entry.getKey(), record.getUuid()); } } if (testId != null) { - inspireValidatorUtils.waitUntilReady(serviceContext, URL, testId); + inspireValidatorUtils.waitUntilReady(context, URL, testId); String reportUrl = inspireValidatorUtils.getReportUrl(URL, testId); String reportXmlUrl = InspireValidatorUtils.getReportUrlXML(URL, testId); - String reportXml = inspireValidatorUtils.retrieveReport(serviceContext, reportXmlUrl); + String reportXml = inspireValidatorUtils.retrieveReport(context, reportXmlUrl); - String validationStatus = inspireValidatorUtils.isPassed(serviceContext, URL, testId); + String validationStatus = inspireValidatorUtils.isPassed(context, URL, testId); MetadataValidationStatus metadataValidationStatus = inspireValidatorUtils.calculateValidationStatus(validationStatus); diff --git a/services/src/main/java/org/fao/geonet/api/processing/ProcessApi.java b/services/src/main/java/org/fao/geonet/api/processing/ProcessApi.java index b1a4ab0930fb..4fa15bd3a625 100644 --- a/services/src/main/java/org/fao/geonet/api/processing/ProcessApi.java +++ b/services/src/main/java/org/fao/geonet/api/processing/ProcessApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -28,6 +28,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.tags.Tag; import jeeves.server.UserSession; +import jeeves.server.context.ServiceContext; import org.fao.geonet.api.API; import org.fao.geonet.api.ApiParams; import org.fao.geonet.api.ApiUtils; @@ -174,7 +175,7 @@ public MetadataReplacementProcessingReport searchAndReplace( MetadataReplacementProcessingReport report = new MetadataReplacementProcessingReport("massive-content-update"); - try { + try (ServiceContext context = ApiUtils.createServiceContext(request)) { Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, userSession); report.setTotalRecords(records.size()); @@ -183,7 +184,7 @@ public MetadataReplacementProcessingReport searchAndReplace( process, isTesting, isCaseInsensitive, vacuumMode, allParams, - ApiUtils.createServiceContext(request), records, report); + context, records, report); m.process(); } catch (Exception e) { throw e; diff --git a/services/src/main/java/org/fao/geonet/api/processing/ValidateApi.java b/services/src/main/java/org/fao/geonet/api/processing/ValidateApi.java index 2f0d5baa7ac4..9b27d17a16b9 100644 --- a/services/src/main/java/org/fao/geonet/api/processing/ValidateApi.java +++ b/services/src/main/java/org/fao/geonet/api/processing/ValidateApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -161,9 +161,8 @@ public SimpleMetadataProcessingReport validateRecords( SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); - try { + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { ApplicationContext applicationContext = ApplicationContextHolder.get(); - ServiceContext serviceContext = ApiUtils.createServiceContext(request); Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, userSession); report.setTotalRecords(records.size()); @@ -255,9 +254,7 @@ public SimpleMetadataProcessingReport cleanValidationStatus( SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); - try { - ServiceContext serviceContext = ApiUtils.createServiceContext(request); - + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, userSession); for (String uuid : records) { diff --git a/services/src/main/java/org/fao/geonet/api/processing/XslProcessApi.java b/services/src/main/java/org/fao/geonet/api/processing/XslProcessApi.java index 9b7ec0a0fba9..34303b07edd0 100644 --- a/services/src/main/java/org/fao/geonet/api/processing/XslProcessApi.java +++ b/services/src/main/java/org/fao/geonet/api/processing/XslProcessApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -185,18 +185,20 @@ public Object previewProcessRecords( } mergedDocuments.addContent(dataMan.getMetadata(id)); } else { - // Save processed metadata - if (isText) { - output.append(XslProcessUtils.processAsText(ApiUtils.createServiceContext(request), - id, process, false, - xslProcessingReport, siteURL, request.getParameterMap()) - ); - } else { - Element record = XslProcessUtils.process(ApiUtils.createServiceContext(request), - id, process, false, false, - false, xslProcessingReport, siteURL, request.getParameterMap()); - if (record != null) { - preview.addContent(record.detach()); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + // Save processed metadata + if (isText) { + output.append(XslProcessUtils.processAsText(context, + id, process, false, + xslProcessingReport, siteURL, request.getParameterMap()) + ); + } else { + Element record = XslProcessUtils.process(context, + id, process, false, false, + false, xslProcessingReport, siteURL, request.getParameterMap()); + if (record != null) { + preview.addContent(record.detach()); + } } } } @@ -290,7 +292,7 @@ public XsltMetadataProcessingReport processRecords( XsltMetadataProcessingReport xslProcessingReport = new XsltMetadataProcessingReport(process); - try { + try (ServiceContext context = ApiUtils.createServiceContext(request)){ Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, session); UserSession userSession = ApiUtils.getUserSession(httpSession); @@ -299,7 +301,7 @@ public XsltMetadataProcessingReport processRecords( xslProcessingReport.setTotalRecords(records.size()); BatchXslMetadataReindexer m = new BatchXslMetadataReindexer( - ApiUtils.createServiceContext(request), + context, dataMan, records, process, httpSession, siteURL, xslProcessingReport, request, index, updateDateStamp, userSession.getUserIdAsInt()); m.process(); diff --git a/services/src/main/java/org/fao/geonet/api/records/CatalogApi.java b/services/src/main/java/org/fao/geonet/api/records/CatalogApi.java index 5aa68f8821e7..62f76dd0fd3f 100644 --- a/services/src/main/java/org/fao/geonet/api/records/CatalogApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/CatalogApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -250,78 +250,80 @@ public void exportAsMef( SelectionManager selectionManger = SelectionManager.getManager(session); Log.info(Geonet.MEF, "Current record(s) in selection: " + uuidList.size()); - ServiceContext context = ApiUtils.createServiceContext(request); - MEFLib.Version version = MEFLib.Version.find(acceptHeader); - if (version == MEFLib.Version.V1) { - throw new IllegalArgumentException("MEF version 1 only support one record. Use the /records/{uuid}/formatters/zip to retrieve that format"); - } else { - Set allowedUuid = new HashSet(); - for (Iterator iter = uuidList.iterator(); iter.hasNext(); ) { - String uuid = iter.next(); - try { - ApiUtils.canViewRecord(uuid, request); - allowedUuid.add(uuid); - } catch (Exception e) { - Log.debug(API.LOG_MODULE_NAME, String.format( - "Not allowed to export record '%s'.", uuid)); - } - } - - // If provided uuid, export the metadata record only - selectionManger.close(SelectionManager.SELECTION_METADATA); - selectionManger.addAllSelection(SelectionManager.SELECTION_METADATA, - allowedUuid); - - // MEF version 2 support multiple metadata record by file. - if (withRelated) { - int maxhits = Integer.parseInt(settingInfo.getSelectionMaxRecords()); - - Set tmpUuid = new HashSet(); - for (Iterator iter = allowedUuid.iterator(); iter.hasNext(); ) { + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + MEFLib.Version version = MEFLib.Version.find(acceptHeader); + if (version == MEFLib.Version.V1) { + throw new IllegalArgumentException("MEF version 1 only support one record. Use the /records/{uuid}/formatters/zip to retrieve that format"); + } else { + Set allowedUuid = new HashSet(); + for (Iterator iter = uuidList.iterator(); iter.hasNext(); ) { String uuid = iter.next(); - - // Search for children records - // and service record. At some point this might be extended to all type of relations. - final SearchResponse searchResponse = searchManager.query( - String.format("parentUuid:\"%s\" recordOperateOn:\"%s\"", uuid, uuid), - esHTTPProxy.buildPermissionsFilter(ApiUtils.createServiceContext(request)), - FIELDLIST_UUID, 0, maxhits); - - Arrays.asList(searchResponse.getHits().getHits()).forEach(h -> - tmpUuid.add((String) h.getSourceAsMap().get(Geonet.IndexFieldNames.UUID))); + try { + ApiUtils.canViewRecord(uuid, context); + allowedUuid.add(uuid); + } catch (Exception e) { + Log.debug(API.LOG_MODULE_NAME, String.format( + "Not allowed to export record '%s'.", uuid)); + } } - if (selectionManger.addAllSelection(SelectionManager.SELECTION_METADATA, tmpUuid)) { - Log.info(Geonet.MEF, "Child and services added into the selection"); + // If provided uuid, export the metadata record only + selectionManger.close(SelectionManager.SELECTION_METADATA); + selectionManger.addAllSelection(SelectionManager.SELECTION_METADATA, + allowedUuid); + + // MEF version 2 support multiple metadata record by file. + if (withRelated) { + int maxhits = Integer.parseInt(settingInfo.getSelectionMaxRecords()); + + Set tmpUuid = new HashSet(); + for (Iterator iter = allowedUuid.iterator(); iter.hasNext(); ) { + String uuid = iter.next(); + + // Search for children records + // and service record. At some point this might be extended to all type of relations. + final SearchResponse searchResponse = searchManager.query( + String.format("parentUuid:\"%s\" recordOperateOn:\"%s\"", uuid, uuid), + esHTTPProxy.buildPermissionsFilter(ApiUtils.createServiceContext(request)), + FIELDLIST_UUID, 0, maxhits); + + Arrays.asList(searchResponse.getHits().getHits()).forEach(h -> + tmpUuid.add((String) h.getSourceAsMap().get(Geonet.IndexFieldNames.UUID))); + } + + if (selectionManger.addAllSelection(SelectionManager.SELECTION_METADATA, tmpUuid)) { + Log.info(Geonet.MEF, "Child and services added into the selection"); + } + allowedUuid = selectionManger.getSelection(SelectionManager.SELECTION_METADATA); } - allowedUuid = selectionManger.getSelection(SelectionManager.SELECTION_METADATA); - } - Log.info(Geonet.MEF, "Building MEF2 file with " + uuidList.size() - + " records."); - try { - file = MEFLib.doMEF2Export(context, allowedUuid, format.toString(), - false, stylePath, - withXLinksResolved, withXLinkAttribute, - false, addSchemaLocation, approved); - - DateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HHmmss"); - String fileName = String.format("%s-%s.zip", - settingManager.getSiteName().replace(" ", ""), - df.format(new Date())); - - response.setHeader(HttpHeaders.CONTENT_DISPOSITION, String.format( - "inline; filename=\"%s\"", - fileName - )); - response.setHeader(HttpHeaders.CONTENT_LENGTH, String.valueOf(Files.size(file))); - response.setContentType(MEFLib.Version.Constants.MEF_V2_ACCEPT_TYPE); - FileUtils.copyFile(file.toFile(), response.getOutputStream()); - } finally { - // -- Reset selection manager - selectionManger.close(SelectionManager.SELECTION_METADATA); + Log.info(Geonet.MEF, "Building MEF2 file with " + uuidList.size() + + " records."); + try { + file = MEFLib.doMEF2Export(context, allowedUuid, format.toString(), + false, stylePath, + withXLinksResolved, withXLinkAttribute, + false, addSchemaLocation, approved); + + DateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HHmmss"); + String fileName = String.format("%s-%s.zip", + settingManager.getSiteName().replace(" ", ""), + df.format(new Date())); + + response.setHeader(HttpHeaders.CONTENT_DISPOSITION, String.format( + "inline; filename=\"%s\"", + fileName + )); + response.setHeader(HttpHeaders.CONTENT_LENGTH, String.valueOf(Files.size(file))); + response.setContentType(MEFLib.Version.Constants.MEF_V2_ACCEPT_TYPE); + FileUtils.copyFile(file.toFile(), response.getOutputStream()); + } finally { + // -- Reset selection manager + selectionManger.close(SelectionManager.SELECTION_METADATA); + } } } + } @io.swagger.v3.oas.annotations.Operation( @@ -506,30 +508,30 @@ public void exportAsCsv( uuids, bucket, session); int maxhits = Integer.parseInt(settingInfo.getSelectionMaxRecords()); - ServiceContext context = ApiUtils.createServiceContext(httpRequest); - - final SearchResponse searchResponse = searchManager.query( - String.format("uuid:(\"%s\")", String.join("\" or \"", uuidList)), - esHTTPProxy.buildPermissionsFilter(ApiUtils.createServiceContext(httpRequest)), - FIELDLIST_CORE, 0, maxhits); - - Element response = new Element("response"); - Arrays.asList(searchResponse.getHits().getHits()).forEach(h -> { - try { - response.addContent( - dataManager.getMetadata( - context, - (String) h.getSourceAsMap().get("id"), - false, false, false)); - } catch (Exception e) { - } - }); + try (ServiceContext context = ApiUtils.createServiceContext(httpRequest)) { + final SearchResponse searchResponse = searchManager.query( + String.format("uuid:(\"%s\")", String.join("\" or \"", uuidList)), + esHTTPProxy.buildPermissionsFilter(ApiUtils.createServiceContext(httpRequest)), + FIELDLIST_CORE, 0, maxhits); + + Element response = new Element("response"); + Arrays.asList(searchResponse.getHits().getHits()).forEach(h -> { + try { + response.addContent( + dataManager.getMetadata( + context, + (String) h.getSourceAsMap().get("id"), + false, false, false)); + } catch (Exception e) { + } + }); - Element r = new XsltResponseWriter(null,"search") - .withXml(response) - .withXsl("xslt/services/csv/csv-search.xsl") - .asElement(); - httpResponse.getWriter().write(r.getText()); + Element r = new XsltResponseWriter(null,"search") + .withXml(response) + .withXsl("xslt/services/csv/csv-search.xsl") + .asElement(); + httpResponse.getWriter().write(r.getText()); + } } @io.swagger.v3.oas.annotations.Operation( @@ -628,84 +630,85 @@ void getAsRdf( allRequestParams.put("hitsPerPage", Integer.toString(hitsPerPage)); allRequestParams.put("from", Integer.toString(from)); - ServiceContext context = ApiUtils.createServiceContext(request); - RdfOutputManager manager = new RdfOutputManager( - thesaurusManager.buildResultfromThTable(context), hitsPerPage); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + RdfOutputManager manager = new RdfOutputManager( + thesaurusManager.buildResultfromThTable(context), hitsPerPage); - // Copy all request parameters - /// Mimic old Jeeves param style - Element params = new Element("params"); - allRequestParams.forEach((k, v) -> { - params.addContent(new Element(k).setText(v)); - }); + // Copy all request parameters + /// Mimic old Jeeves param style + Element params = new Element("params"); + allRequestParams.forEach((k, v) -> { + params.addContent(new Element(k).setText(v)); + }); - // Perform the search on the Lucene Index - RdfSearcher rdfSearcher = new RdfSearcher(params, context); - List results = rdfSearcher.search(context); - rdfSearcher.close(); - - // Calculates the pagination information, needed for the LDP Paging and Hydra Paging - int numberMatched = rdfSearcher.getSize(); - int firstPageFrom = numberMatched > 0 ? 1 : 0; - int firstPageTo = numberMatched > hitsPerPage ? hitsPerPage : numberMatched; - int nextFrom = to < numberMatched ? to + 1 : to; - int nextTo = to + hitsPerPage < numberMatched ? to + hitsPerPage : numberMatched; - int prevFrom = from - hitsPerPage > 0 ? from - hitsPerPage : 1; - int prevTo = to - hitsPerPage > 0 ? to - hitsPerPage : numberMatched; - int lastPageFrom = 0 < (numberMatched % hitsPerPage) ? numberMatched - (numberMatched % hitsPerPage) + 1 : (numberMatched - hitsPerPage + 1 > 0 ? numberMatched - hitsPerPage + 1 : numberMatched); - long versionTokenETag = rdfSearcher.getVersionToken(); - String canonicalURL = hostURL + request.getRequestURI(); - String currentPage = canonicalURL + "?" + paramsAsString(allRequestParams) + "&from=" + from + "&to=" + to; - String lastPage = canonicalURL + "?" + paramsAsString(allRequestParams) + "&from=" + lastPageFrom + "&to=" + numberMatched; - String firstPage = canonicalURL + "?" + paramsAsString(allRequestParams) + "&from=" + firstPageFrom + "&to=" + firstPageTo; - String previousPage = canonicalURL + "?" + paramsAsString(allRequestParams) + "&from=" + prevFrom + "&to=" + prevTo; - String nextPage = canonicalURL + "?" + paramsAsString(allRequestParams) + "&from=" + nextFrom + "&to=" + nextTo; - - // Hydra Paging information (see also: http://www.hydra-cg.com/spec/latest/core/) - String hydraPagedCollection = "\n" + - "" + - "" + lastPage.replaceAll("&", "&") + "\n" + - "" + numberMatched + "\n" + - ((prevFrom <= prevTo && prevFrom < from && prevTo < to) ? "" + previousPage.replaceAll("&", "&") + "\n" : "") + - ((nextFrom <= nextTo && from < nextFrom && to < nextTo) ? "" + nextPage.replaceAll("&", "&") + "\n" : "") + - "" + firstPage.replaceAll("&", "&") + "\n" + - "" + hitsPerPage + "\n" + - ""; - // Construct the RDF output - File rdfFile = manager.createRdfFile(context, results, 1, hydraPagedCollection); - - try ( - ServletOutputStream out = response.getOutputStream(); - InputStream in = new FileInputStream(rdfFile) - ) { - byte[] bytes = new byte[1024]; - int bytesRead; - - response.setContentType("application/rdf+xml"); - - //Set the Lucene versionToken as ETag response header parameter - response.addHeader("ETag", Long.toString(versionTokenETag)); - //Include the response header "link" parameters as suggested by the W3C Linked Data Platform paging specification (see also: https://www.w3.org/2012/ldp/hg/ldp-paging.html). - response.addHeader("Link", "; rel=\"type\""); - response.addHeader("Link", canonicalURL + "; rel=\"canonical\"; etag=" + versionTokenETag); - - response.addHeader("Link", "<" + firstPage + "> ; rel=\"first\""); - if (nextFrom <= nextTo && from < nextFrom && to < nextTo) { - response.addHeader("Link", "<" + nextPage + "> ; rel=\"next\""); - } - if (prevFrom <= prevTo && prevFrom < from && prevTo < to) { - response.addHeader("Link", "<" + previousPage + "> ; rel=\"prev\""); - } - response.addHeader("Link", "<" + lastPage + "> ; rel=\"last\""); + // Perform the search on the Lucene Index + RdfSearcher rdfSearcher = new RdfSearcher(params, context); + List results = rdfSearcher.search(context); + rdfSearcher.close(); + + // Calculates the pagination information, needed for the LDP Paging and Hydra Paging + int numberMatched = rdfSearcher.getSize(); + int firstPageFrom = numberMatched > 0 ? 1 : 0; + int firstPageTo = numberMatched > hitsPerPage ? hitsPerPage : numberMatched; + int nextFrom = to < numberMatched ? to + 1 : to; + int nextTo = to + hitsPerPage < numberMatched ? to + hitsPerPage : numberMatched; + int prevFrom = from - hitsPerPage > 0 ? from - hitsPerPage : 1; + int prevTo = to - hitsPerPage > 0 ? to - hitsPerPage : numberMatched; + int lastPageFrom = 0 < (numberMatched % hitsPerPage) ? numberMatched - (numberMatched % hitsPerPage) + 1 : (numberMatched - hitsPerPage + 1 > 0 ? numberMatched - hitsPerPage + 1 : numberMatched); + long versionTokenETag = rdfSearcher.getVersionToken(); + String canonicalURL = hostURL + request.getRequestURI(); + String currentPage = canonicalURL + "?" + paramsAsString(allRequestParams) + "&from=" + from + "&to=" + to; + String lastPage = canonicalURL + "?" + paramsAsString(allRequestParams) + "&from=" + lastPageFrom + "&to=" + numberMatched; + String firstPage = canonicalURL + "?" + paramsAsString(allRequestParams) + "&from=" + firstPageFrom + "&to=" + firstPageTo; + String previousPage = canonicalURL + "?" + paramsAsString(allRequestParams) + "&from=" + prevFrom + "&to=" + prevTo; + String nextPage = canonicalURL + "?" + paramsAsString(allRequestParams) + "&from=" + nextFrom + "&to=" + nextTo; + + // Hydra Paging information (see also: http://www.hydra-cg.com/spec/latest/core/) + String hydraPagedCollection = "\n" + + "" + + "" + lastPage.replaceAll("&", "&") + "\n" + + "" + numberMatched + "\n" + + ((prevFrom <= prevTo && prevFrom < from && prevTo < to) ? "" + previousPage.replaceAll("&", "&") + "\n" : "") + + ((nextFrom <= nextTo && from < nextFrom && to < nextTo) ? "" + nextPage.replaceAll("&", "&") + "\n" : "") + + "" + firstPage.replaceAll("&", "&") + "\n" + + "" + hitsPerPage + "\n" + + ""; + // Construct the RDF output + File rdfFile = manager.createRdfFile(context, results, 1, hydraPagedCollection); + + try ( + ServletOutputStream out = response.getOutputStream(); + InputStream in = new FileInputStream(rdfFile) + ) { + byte[] bytes = new byte[1024]; + int bytesRead; + + response.setContentType("application/rdf+xml"); + + //Set the Lucene versionToken as ETag response header parameter + response.addHeader("ETag", Long.toString(versionTokenETag)); + //Include the response header "link" parameters as suggested by the W3C Linked Data Platform paging specification (see also: https://www.w3.org/2012/ldp/hg/ldp-paging.html). + response.addHeader("Link", "; rel=\"type\""); + response.addHeader("Link", canonicalURL + "; rel=\"canonical\"; etag=" + versionTokenETag); + + response.addHeader("Link", "<" + firstPage + "> ; rel=\"first\""); + if (nextFrom <= nextTo && from < nextFrom && to < nextTo) { + response.addHeader("Link", "<" + nextPage + "> ; rel=\"next\""); + } + if (prevFrom <= prevTo && prevFrom < from && prevTo < to) { + response.addHeader("Link", "<" + previousPage + "> ; rel=\"prev\""); + } + response.addHeader("Link", "<" + lastPage + "> ; rel=\"last\""); - //Write the paged RDF result to the message body - while ((bytesRead = in.read(bytes)) != -1) { - out.write(bytes, 0, bytesRead); + //Write the paged RDF result to the message body + while ((bytesRead = in.read(bytes)) != -1) { + out.write(bytes, 0, bytesRead); + } + } catch (FileNotFoundException e) { + Log.error(API.LOG_MODULE_NAME, "Get catalog content as RDF. Error: " + e.getMessage(), e); + } catch (IOException e) { + Log.error(API.LOG_MODULE_NAME, "Get catalog content as RDF. Error: " + e.getMessage(), e); } - } catch (FileNotFoundException e) { - Log.error(API.LOG_MODULE_NAME, "Get catalog content as RDF. Error: " + e.getMessage(), e); - } catch (IOException e) { - Log.error(API.LOG_MODULE_NAME, "Get catalog content as RDF. Error: " + e.getMessage(), e); } } diff --git a/services/src/main/java/org/fao/geonet/api/records/DoiApi.java b/services/src/main/java/org/fao/geonet/api/records/DoiApi.java index ed767e390220..e411de7bef1f 100644 --- a/services/src/main/java/org/fao/geonet/api/records/DoiApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/DoiApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -94,11 +94,12 @@ ResponseEntity> checkDoiStatus( @Parameter(hidden = true) HttpServletRequest request ) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ServiceContext serviceContext = ApiUtils.createServiceContext(request); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, serviceContext); - final Map reportStatus = doiManager.check(serviceContext, metadata, null); - return new ResponseEntity<>(reportStatus, HttpStatus.OK); + final Map reportStatus = doiManager.check(serviceContext, metadata, null); + return new ResponseEntity<>(reportStatus, HttpStatus.OK); + } } @@ -130,11 +131,13 @@ ResponseEntity> createDoi( @Parameter(hidden = true) HttpSession session ) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ServiceContext serviceContext = ApiUtils.createServiceContext(request); - Map doiInfo = doiManager.register(serviceContext, metadata); - return new ResponseEntity<>(doiInfo, HttpStatus.CREATED); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request);) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, serviceContext); + + Map doiInfo = doiManager.register(serviceContext, metadata); + return new ResponseEntity<>(doiInfo, HttpStatus.CREATED); + } } @@ -167,11 +170,13 @@ ResponseEntity unregisterDoi( @Parameter(hidden = true) HttpSession session ) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ServiceContext serviceContext = ApiUtils.createServiceContext(request); - doiManager.unregisterDoi(metadata, serviceContext); - return new ResponseEntity<>(HttpStatus.NO_CONTENT); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request);) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, serviceContext); + + doiManager.unregisterDoi(metadata, serviceContext); + return new ResponseEntity<>(HttpStatus.NO_CONTENT); + } } // TODO: At some point we may add support for DOI States management diff --git a/services/src/main/java/org/fao/geonet/api/records/InspireValidationApi.java b/services/src/main/java/org/fao/geonet/api/records/InspireValidationApi.java index c6c160e20269..03e849fcc669 100644 --- a/services/src/main/java/org/fao/geonet/api/records/InspireValidationApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/InspireValidationApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -212,7 +212,6 @@ String validateRecordForInspire( String id = String.valueOf(metadata.getId()); String URL = settingManager.getValue(Settings.SYSTEM_INSPIRE_REMOTE_VALIDATION_URL); - ServiceContext context = ApiUtils.createServiceContext(request); String getRecordByIdUrl = null; String testId = null; @@ -226,7 +225,7 @@ String validateRecordForInspire( if (StringUtils.isEmpty(mode)) { // Use formatter to convert the record if (!schema.equals("iso19139")) { - try { + try (ServiceContext context = ApiUtils.createServiceContext(request)) { Key key = new Key(metadata.getId(), "eng", FormatType.xml, "iso19139", true, FormatterWidth._100); final FormatterApi.FormatMetadata formatMetadata = @@ -246,24 +245,36 @@ String validateRecordForInspire( md.detach(); - Attribute schemaLocAtt = schemaManager.getSchemaLocation( + + // The following is unusual, we are creating a service context so it is our responsibility + // to ensure it is cleaned up. + // + // This is going to be accomplished by the scheduled InspireValidationRunnable + ServiceContext context = ApiUtils.createServiceContext(request); + try { + Attribute schemaLocAtt = schemaManager.getSchemaLocation( "iso19139", context); - if (schemaLocAtt != null) { - if (md.getAttribute( - schemaLocAtt.getName(), - schemaLocAtt.getNamespace()) == null) { - md.setAttribute(schemaLocAtt); - // make sure namespace declaration for schemalocation is present - - // remove it first (does nothing if not there) then add it - md.removeNamespaceDeclaration(schemaLocAtt.getNamespace()); - md.addNamespaceDeclaration(schemaLocAtt.getNamespace()); + if (schemaLocAtt != null) { + if (md.getAttribute( + schemaLocAtt.getName(), + schemaLocAtt.getNamespace()) == null) { + md.setAttribute(schemaLocAtt); + // make sure namespace declaration for schemalocation is present - + // remove it first (does nothing if not there) then add it + md.removeNamespaceDeclaration(schemaLocAtt.getNamespace()); + md.addNamespaceDeclaration(schemaLocAtt.getNamespace()); + } } - } + InputStream metadataToTest = convertElement2InputStream(md); + testId = inspireValidatorUtils.submitFile(context, URL, metadataToTest, testsuite, metadata.getUuid()); - InputStream metadataToTest = convertElement2InputStream(md); - testId = inspireValidatorUtils.submitFile(context, URL, metadataToTest, testsuite, metadata.getUuid()); + threadPool.runTask(new InspireValidationRunnable(context, URL, testId, metadata.getId())); + } finally { + context.clearAsThreadLocal(); + // context clear is handled scheduled InspireValidationRunnable above + } } else { String portal = NodeInfo.DEFAULT_NODE; if (!NodeInfo.DEFAULT_NODE.equals(mode)) { @@ -283,10 +294,20 @@ String validateRecordForInspire( portal, ISO19139Namespaces.GMD.getURI(), metadataUuid); - testId = inspireValidatorUtils.submitUrl(context, URL, getRecordByIdUrl, testsuite, metadata.getUuid()); - } - threadPool.runTask(new InspireValidationRunnable(context, URL, testId, metadata.getId())); + // The following is unusual, we are creating a service context so it is our responsibility + // to ensure it is cleaned up. + // + // This is going to be accomplished by the scheduled InspireValidationRunnable + ServiceContext context = ApiUtils.createServiceContext(request); + try { + testId = inspireValidatorUtils.submitUrl(context, URL, getRecordByIdUrl, testsuite, metadata.getUuid()); + threadPool.runTask(new InspireValidationRunnable(context, URL, testId, metadata.getId())); + } finally { + context.clearAsThreadLocal(); + // context clear is handled scheduled InspireValidationRunnable above + } + } return testId; } @@ -337,9 +358,8 @@ Map checkValidation( ) throws Exception { String URL = settingManager.getValue(Settings.SYSTEM_INSPIRE_REMOTE_VALIDATION_URL); - ServiceContext context = ApiUtils.createServiceContext(request); - try { + try (ServiceContext context = ApiUtils.createServiceContext(request)) { if (inspireValidatorUtils.isReady(context, URL, testId)) { Map values = new HashMap<>(); diff --git a/services/src/main/java/org/fao/geonet/api/records/InspireValidationRunnable.java b/services/src/main/java/org/fao/geonet/api/records/InspireValidationRunnable.java index 7413f2f115c3..497bb04c6595 100644 --- a/services/src/main/java/org/fao/geonet/api/records/InspireValidationRunnable.java +++ b/services/src/main/java/org/fao/geonet/api/records/InspireValidationRunnable.java @@ -1,3 +1,26 @@ +/* + * Copyright (C) 2001-2021 Food and Agriculture Organization of the + * United Nations (FAO-UN), United Nations World Food Programme (WFP) + * and United Nations Environment Programme (UNEP) + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or (at + * your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + * + * Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2, + * Rome - Italy. email: geonetwork@osgeo.org + */ + package org.fao.geonet.api.records; import jeeves.server.context.ServiceContext; @@ -26,53 +49,68 @@ public class InspireValidationRunnable implements Runnable { private final String testId; private final String endPoint; private final int mdId; - private final ServiceContext context; - + /** Provided service context, cleaned up when task is complete */ + private ServiceContext validationContext; + + /** + * Schedule INSPIRE validation for later. + * + * @param context Validation context, it is the responsibility of this runnable to clean up + * @param endPoint + * @param testId + * @param mdId + */ public InspireValidationRunnable(ServiceContext context, String endPoint, String testId, int mdId) { - this.context = context; + this.validationContext = context; this.testId = testId; this.mdId = mdId; this.endPoint = endPoint; } public void run() { - TransactionManager.runInTransaction("inspire-validation", ApplicationContextHolder.get(), - CREATE_NEW, ALWAYS_COMMIT, false, new TransactionTask() { - @Override - public Object doInTransaction(TransactionStatus transaction) throws Throwable { - InspireValidatorUtils inspireValidatorUtils = - ApplicationContextHolder.get().getBean(InspireValidatorUtils.class); + validationContext.setAsThreadLocal(); + try { + TransactionManager.runInTransaction("inspire-validation", ApplicationContextHolder.get(), + CREATE_NEW, ALWAYS_COMMIT, false, new TransactionTask() { + @Override + public Object doInTransaction(TransactionStatus transaction) throws Throwable { + InspireValidatorUtils inspireValidatorUtils = + ApplicationContextHolder.get().getBean(InspireValidatorUtils.class); - MetadataValidationRepository metadataValidationRepository = - ApplicationContextHolder.get().getBean(MetadataValidationRepository.class); + MetadataValidationRepository metadataValidationRepository = + ApplicationContextHolder.get().getBean(MetadataValidationRepository.class); - // Waits until the validation result is available - inspireValidatorUtils.waitUntilReady(context, endPoint, testId); + // Waits until the validation result is available + inspireValidatorUtils.waitUntilReady(validationContext, endPoint, testId); - String reportUrl = inspireValidatorUtils.getReportUrl(endPoint, testId); - String reportXmlUrl = InspireValidatorUtils.getReportUrlXML(endPoint, testId); - String reportXml = inspireValidatorUtils.retrieveReport(context, reportXmlUrl); + String reportUrl = inspireValidatorUtils.getReportUrl(endPoint, testId); + String reportXmlUrl = InspireValidatorUtils.getReportUrlXML(endPoint, testId); + String reportXml = inspireValidatorUtils.retrieveReport(validationContext, reportXmlUrl); - String validationStatus = inspireValidatorUtils.isPassed(context, endPoint, testId); + String validationStatus = inspireValidatorUtils.isPassed(validationContext, endPoint, testId); - MetadataValidationStatus metadataValidationStatus = - inspireValidatorUtils.calculateValidationStatus(validationStatus); + MetadataValidationStatus metadataValidationStatus = + inspireValidatorUtils.calculateValidationStatus(validationStatus); - MetadataValidation metadataValidation = new MetadataValidation() - .setId(new MetadataValidationId(mdId, "inspire")) - .setStatus(metadataValidationStatus).setRequired(false) - .setReportUrl(reportUrl).setReportContent(reportXml); + MetadataValidation metadataValidation = new MetadataValidation() + .setId(new MetadataValidationId(mdId, "inspire")) + .setStatus(metadataValidationStatus).setRequired(false) + .setReportUrl(reportUrl).setReportContent(reportXml); - metadataValidationRepository.save(metadataValidation); + metadataValidationRepository.save(metadataValidation); - DataManager dataManager = - ApplicationContextHolder.get().getBean(DataManager.class); + DataManager dataManager = + ApplicationContextHolder.get().getBean(DataManager.class); - dataManager.indexMetadata(new ArrayList<>(Arrays.asList(mdId + ""))); + dataManager.indexMetadata(new ArrayList<>(Arrays.asList(mdId + ""))); - return null; - } - }); + return null; + } + }); + } finally { + validationContext.clearAsThreadLocal(); + validationContext.clear(); + } } } diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataApi.java index 2f6650dd926d..1bd979cd2244 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -151,31 +151,33 @@ public String getRecord( HttpServletRequest request ) throws Exception { - try { - ApiUtils.canViewRecord(metadataUuid, request); - } catch (SecurityException e) { - Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); - throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); - } - List accept = Arrays.asList(acceptHeader.split(",")); - - String defaultFormatter = "xsl-view"; - if (accept.contains(MediaType.TEXT_HTML_VALUE) - || accept.contains(MediaType.APPLICATION_XHTML_XML_VALUE) - || accept.contains("application/pdf")) { - return "forward:" + (metadataUuid + "/formatters/" + defaultFormatter); - } else if (accept.contains(MediaType.APPLICATION_XML_VALUE) - || accept.contains(MediaType.APPLICATION_JSON_VALUE)) { - return "forward:" + (metadataUuid + "/formatters/xml"); - } else if (accept.contains("application/zip") - || accept.contains(MEF_V1_ACCEPT_TYPE) - || accept.contains(MEF_V2_ACCEPT_TYPE)) { - return "forward:" + (metadataUuid + "/formatters/zip"); - } else { - // FIXME this else is never reached because any of the accepted medias match one of the previous if conditions. - response.setHeader(HttpHeaders.ACCEPT, MediaType.APPLICATION_XHTML_XML_VALUE); - //response.sendRedirect(metadataUuid + "/formatters/" + defaultFormatter); - return "forward:" + (metadataUuid + "/formatters/" + defaultFormatter); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + try { + ApiUtils.canViewRecord(metadataUuid, context); + } catch (SecurityException e) { + Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); + throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); + } + List accept = Arrays.asList(acceptHeader.split(",")); + + String defaultFormatter = "xsl-view"; + if (accept.contains(MediaType.TEXT_HTML_VALUE) + || accept.contains(MediaType.APPLICATION_XHTML_XML_VALUE) + || accept.contains("application/pdf")) { + return "forward:" + (metadataUuid + "/formatters/" + defaultFormatter); + } else if (accept.contains(MediaType.APPLICATION_XML_VALUE) + || accept.contains(MediaType.APPLICATION_JSON_VALUE)) { + return "forward:" + (metadataUuid + "/formatters/xml"); + } else if (accept.contains("application/zip") + || accept.contains(MEF_V1_ACCEPT_TYPE) + || accept.contains(MEF_V2_ACCEPT_TYPE)) { + return "forward:" + (metadataUuid + "/formatters/zip"); + } else { + // FIXME this else is never reached because any of the accepted medias match one of the previous if conditions. + response.setHeader(HttpHeaders.ACCEPT, MediaType.APPLICATION_XHTML_XML_VALUE); + //response.sendRedirect(metadataUuid + "/formatters/" + defaultFormatter); + return "forward:" + (metadataUuid + "/formatters/" + defaultFormatter); + } } } @@ -234,75 +236,76 @@ Object getRecordAs( HttpServletRequest request ) throws Exception { - AbstractMetadata metadata; - try { - metadata = ApiUtils.canViewRecord(metadataUuid, request); - } catch (ResourceNotFoundException e) { - Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); - throw e; - } catch (Exception e) { - Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); - throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); - } - ServiceContext context = ApiUtils.createServiceContext(request); - try { - Lib.resource.checkPrivilege(context, - String.valueOf(metadata.getId()), - ReservedOperation.view); - } catch (Exception e) { - // TODO: i18n - // TODO: Report exception in JSON format - Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); - throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata; + try { + metadata = ApiUtils.canViewRecord(metadataUuid, context); + } catch (ResourceNotFoundException e) { + Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); + throw e; + } catch (Exception e) { + Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); + throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); + } + try { + Lib.resource.checkPrivilege(context, + String.valueOf(metadata.getId()), + ReservedOperation.view); + } catch (Exception e) { + // TODO: i18n + // TODO: Report exception in JSON format + Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); + throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); - } + } - if (increasePopularity) { - dataManager.increasePopularity(context, metadata.getId() + ""); - } + if (increasePopularity) { + dataManager.increasePopularity(context, metadata.getId() + ""); + } - boolean withValidationErrors = false, keepXlinkAttributes = false, forEditing = false; + boolean withValidationErrors = false, keepXlinkAttributes = false, forEditing = false; - String mdId = String.valueOf(metadata.getId()); + String mdId = String.valueOf(metadata.getId()); - //Here we just care if we need the approved version explicitly. - //ApiUtils.canViewRecord already filtered draft for non editors. - if (approved) { - mdId = String.valueOf(metadataRepository.findOneByUuid(metadata.getUuid()).getId()); - } + //Here we just care if we need the approved version explicitly. + //ApiUtils.canViewRecord already filtered draft for non editors. + if (approved) { + mdId = String.valueOf(metadataRepository.findOneByUuid(metadata.getUuid()).getId()); + } - Element xml = withInfo ? - dataManager.getMetadata(context, mdId, forEditing, - withValidationErrors, keepXlinkAttributes) : - dataManager.getMetadataNoInfo(context, mdId + ""); - - if (addSchemaLocation) { - Attribute schemaLocAtt = _schemaManager.getSchemaLocation( - metadata.getDataInfo().getSchemaId(), context); - - if (schemaLocAtt != null) { - if (xml.getAttribute( - schemaLocAtt.getName(), - schemaLocAtt.getNamespace()) == null) { - xml.setAttribute(schemaLocAtt); - // make sure namespace declaration for schemalocation is present - - // remove it first (does nothing if not there) then add it - xml.removeNamespaceDeclaration(schemaLocAtt.getNamespace()); - xml.addNamespaceDeclaration(schemaLocAtt.getNamespace()); + Element xml = withInfo ? + dataManager.getMetadata(context, mdId, forEditing, + withValidationErrors, keepXlinkAttributes) : + dataManager.getMetadataNoInfo(context, mdId + ""); + + if (addSchemaLocation) { + Attribute schemaLocAtt = _schemaManager.getSchemaLocation( + metadata.getDataInfo().getSchemaId(), context); + + if (schemaLocAtt != null) { + if (xml.getAttribute( + schemaLocAtt.getName(), + schemaLocAtt.getNamespace()) == null) { + xml.setAttribute(schemaLocAtt); + // make sure namespace declaration for schemalocation is present - + // remove it first (does nothing if not there) then add it + xml.removeNamespaceDeclaration(schemaLocAtt.getNamespace()); + xml.addNamespaceDeclaration(schemaLocAtt.getNamespace()); + } } } - } - boolean isJson = acceptHeader.contains(MediaType.APPLICATION_JSON_VALUE); + boolean isJson = acceptHeader.contains(MediaType.APPLICATION_JSON_VALUE); - String mode = (attachment) ? "attachment" : "inline"; - response.setHeader("Content-Disposition", String.format( - mode + "; filename=\"%s.%s\"", - metadata.getUuid(), - isJson ? "json" : "xml" - )); - return isJson ? Xml.getJSON(xml) : xml; + String mode = (attachment) ? "attachment" : "inline"; + response.setHeader("Content-Disposition", String.format( + mode + "; filename=\"%s.%s\"", + metadata.getUuid(), + isJson ? "json" : "xml" + )); + return isJson ? Xml.getJSON(xml) : xml; + } } @io.swagger.v3.oas.annotations.Operation( @@ -377,68 +380,69 @@ void getRecordAsZip( HttpServletRequest request ) throws Exception { - AbstractMetadata metadata; - try { - metadata = ApiUtils.canViewRecord(metadataUuid, request); - } catch (SecurityException e) { - Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); - throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); - } - Path stylePath = dataDirectory.getWebappDir().resolve(Geonet.Path.SCHEMAS); - Path file = null; - ServiceContext context = ApiUtils.createServiceContext(request); - MEFLib.Version version = MEFLib.Version.find(acceptHeader); - if (version == MEFLib.Version.V1) { - // This parameter is deprecated in v2. - boolean skipUUID = false; - - Integer id = -1; - - if (approved) { - id = metadataRepository.findOneByUuid(metadataUuid).getId(); - } else { - id = metadataUtils.findOneByUuid(metadataUuid).getId(); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata; + try { + metadata = ApiUtils.canViewRecord(metadataUuid, context); + } catch (SecurityException e) { + Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); + throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); } - - file = MEFLib.doExport( - context, id, format.toString(), - skipUUID, withXLinksResolved, withXLinkAttribute, addSchemaLocation - ); - response.setContentType(MEFLib.Version.Constants.MEF_V1_ACCEPT_TYPE); - } else { - Set tmpUuid = new HashSet(); - tmpUuid.add(metadataUuid); - // MEF version 2 support multiple metadata record by file. - if (withRelated) { - // Adding children in MEF file - - // Get children to export - It could be better to use GetRelated service TODO - Set childs = MetadataUtils.getUuidsToExport( - String.format("+%s:%s", Geonet.IndexFieldNames.PARENTUUID, metadataUuid)); - if (childs.size() != 0) { - tmpUuid.addAll(childs); + Path stylePath = dataDirectory.getWebappDir().resolve(Geonet.Path.SCHEMAS); + Path file = null; + MEFLib.Version version = MEFLib.Version.find(acceptHeader); + if (version == MEFLib.Version.V1) { + // This parameter is deprecated in v2. + boolean skipUUID = false; + + Integer id = -1; + + if (approved) { + id = metadataRepository.findOneByUuid(metadataUuid).getId(); + } else { + id = metadataUtils.findOneByUuid(metadataUuid).getId(); } - // Get linked services for export - Set services = MetadataUtils.getUuidsToExport( - String.format("+%s:%s", Geonet.IndexFieldNames.RECORDOPERATESON, metadataUuid)); - if (services.size() != 0) { - tmpUuid.addAll(services); + file = MEFLib.doExport( + context, id, format.toString(), + skipUUID, withXLinksResolved, withXLinkAttribute, addSchemaLocation + ); + response.setContentType(MEFLib.Version.Constants.MEF_V1_ACCEPT_TYPE); + } else { + Set tmpUuid = new HashSet(); + tmpUuid.add(metadataUuid); + // MEF version 2 support multiple metadata record by file. + if (withRelated) { + // Adding children in MEF file + + // Get children to export - It could be better to use GetRelated service TODO + Set childs = MetadataUtils.getUuidsToExport( + String.format("+%s:%s", Geonet.IndexFieldNames.PARENTUUID, metadataUuid)); + if (childs.size() != 0) { + tmpUuid.addAll(childs); + } + + // Get linked services for export + Set services = MetadataUtils.getUuidsToExport( + String.format("+%s:%s", Geonet.IndexFieldNames.RECORDOPERATESON, metadataUuid)); + if (services.size() != 0) { + tmpUuid.addAll(services); + } } - } - Log.info(Geonet.MEF, "Building MEF2 file with " + tmpUuid.size() - + " records."); + Log.info(Geonet.MEF, "Building MEF2 file with " + tmpUuid.size() + + " records."); - file = MEFLib.doMEF2Export(context, tmpUuid, format.toString(), false, stylePath, withXLinksResolved, withXLinkAttribute, false, addSchemaLocation, approved); + file = MEFLib.doMEF2Export(context, tmpUuid, format.toString(), false, stylePath, withXLinksResolved, withXLinkAttribute, false, addSchemaLocation, approved); - response.setContentType(MEFLib.Version.Constants.MEF_V2_ACCEPT_TYPE); + response.setContentType(MEFLib.Version.Constants.MEF_V2_ACCEPT_TYPE); + } + response.setHeader(HttpHeaders.CONTENT_DISPOSITION, String.format( + "inline; filename=\"%s.zip\"", + metadata.getUuid() + )); + response.setHeader(HttpHeaders.CONTENT_LENGTH, String.valueOf(Files.size(file))); + FileUtils.copyFile(file.toFile(), response.getOutputStream()); } - response.setHeader(HttpHeaders.CONTENT_DISPOSITION, String.format( - "inline; filename=\"%s.zip\"", - metadata.getUuid() - )); - response.setHeader(HttpHeaders.CONTENT_LENGTH, String.valueOf(Files.size(file))); - FileUtils.copyFile(file.toFile(), response.getOutputStream()); } @@ -463,19 +467,20 @@ public void getRecord( HttpServletRequest request ) throws Exception { - AbstractMetadata metadata; - try { - metadata = ApiUtils.canViewRecord(metadataUuid, request); - } catch (ResourceNotFoundException e) { - Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); - throw e; - } catch (Exception e) { - Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); - throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); - } - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata; + try { + metadata = ApiUtils.canViewRecord(metadataUuid, context); + } catch (ResourceNotFoundException e) { + Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); + throw e; + } catch (Exception e) { + Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); + throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); + } - dataManager.increasePopularity(context, metadata.getId() + ""); + dataManager.increasePopularity(context, metadata.getId() + ""); + } } @@ -517,31 +522,33 @@ public RelatedResponse getAssociatedResources( int rows, HttpServletRequest request) throws Exception { - AbstractMetadata md; - try { - md = ApiUtils.canViewRecord(metadataUuid, request); - } catch (SecurityException e) { - Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); - throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); - } + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata md; + try { + md = ApiUtils.canViewRecord(metadataUuid, context); + } catch (SecurityException e) { + Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); + throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); + } - String language = languageUtils.getIso3langCode(request.getLocales()); - - // TODO PERF: ByPass XSL processing and create response directly - // At least for related metadata and keep XSL only for links - final ServiceContext context = ApiUtils.createServiceContext(request); - Element raw = new Element("root").addContent(Arrays.asList( - new Element("gui").addContent(Arrays.asList( - new Element("language").setText(language), - new Element("url").setText(context.getBaseUrl()) - )), - MetadataUtils.getRelated(context, md.getId(), md.getUuid(), type, start, start + rows, true) - )); - Path relatedXsl = dataDirectory.getWebappDir().resolve("xslt/services/metadata/relation.xsl"); - - final Element transform = Xml.transform(raw, relatedXsl); - RelatedResponse response = (RelatedResponse) Xml.unmarshall(transform, RelatedResponse.class); - return response; + String language = languageUtils.getIso3langCode(request.getLocales()); + + // TODO PERF: ByPass XSL processing and create response directly + // At least for related metadata and keep XSL only for links + Element raw = new Element("root").addContent(Arrays.asList( + new Element("gui").addContent(Arrays.asList( + new Element("language").setText(language), + new Element("url").setText(context.getBaseUrl()) + )), + MetadataUtils.getRelated(context, md.getId(), md.getUuid(), type, start, start + rows, true) + )); + Path relatedXsl = dataDirectory.getWebappDir().resolve("xslt/services/metadata/relation.xsl"); + + final Element transform = Xml.transform(raw, relatedXsl); + RelatedResponse response = (RelatedResponse) Xml.unmarshall(transform, RelatedResponse.class); + return response; + + } } @io.swagger.v3.oas.annotations.Operation( diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataIndexApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataIndexApi.java index c1736e17698f..854460351c4e 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataIndexApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataIndexApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -98,38 +98,39 @@ JSONObject index( ) throws Exception { - ServiceContext serviceContext = ApiUtils.createServiceContext(request); - UserSession session = ApiUtils.getUserSession(httpSession); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { + UserSession session = ApiUtils.getUserSession(httpSession); - SelectionManager selectionManager = - SelectionManager.getManager(serviceContext.getUserSession()); + SelectionManager selectionManager = + SelectionManager.getManager(serviceContext.getUserSession()); - Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, session); - Set ids = Sets.newHashSet(); - int index = 0; + Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, session); + Set ids = Sets.newHashSet(); + int index = 0; - for (String uuid : records) { - try { - final String metadataId = dataManager.getMetadataId(uuid); - if (metadataId != null) { - ids.add(Integer.valueOf(metadataId)); - } - } catch (Exception e) { + for (String uuid : records) { try { - ids.add(Integer.valueOf(uuid)); - } catch (NumberFormatException nfe) { - // skip + final String metadataId = dataManager.getMetadataId(uuid); + if (metadataId != null) { + ids.add(Integer.valueOf(metadataId)); + } + } catch (Exception e) { + try { + ids.add(Integer.valueOf(uuid)); + } catch (NumberFormatException nfe) { + // skip + } } } - } - index = ids.size(); - new BatchOpsMetadataReindexer(dataManager, ids).process(false); + index = ids.size(); + new BatchOpsMetadataReindexer(dataManager, ids).process(false); - JSONObject res = new JSONObject(); - res.put("success", true); - res.put("count", index); + JSONObject res = new JSONObject(); + res.put("success", true); + res.put("count", index); - return res; + return res; + } } } diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataInsertDeleteApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataInsertDeleteApi.java index 1a5baf80e56d..4e0c0f18b9d6 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataInsertDeleteApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataInsertDeleteApi.java @@ -177,29 +177,31 @@ public void deleteRecord( @Parameter(description = API_PARAM_RECORD_UUID, required = true) @PathVariable String metadataUuid, @Parameter(description = API_PARAM_BACKUP_FIRST, required = false) @RequestParam(required = false, defaultValue = "true") boolean withBackup, HttpServletRequest request) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ServiceContext context = ApiUtils.createServiceContext(request); - Store store = context.getBean("resourceStore", Store.class); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); - MetadataPreRemove preRemoveEvent = new MetadataPreRemove(metadata); - ApplicationContextHolder.get().publishEvent(preRemoveEvent); + Store store = context.getBean("resourceStore", Store.class); - if (metadata.getDataInfo().getType() != MetadataType.SUB_TEMPLATE - && metadata.getDataInfo().getType() != MetadataType.TEMPLATE_OF_SUB_TEMPLATE && withBackup) { - MetadataUtils.backupRecord(metadata, context); - } + MetadataPreRemove preRemoveEvent = new MetadataPreRemove(metadata); + ApplicationContextHolder.get().publishEvent(preRemoveEvent); - boolean approved=true; - if (metadata instanceof MetadataDraft) { - approved=false; - } + if (metadata.getDataInfo().getType() != MetadataType.SUB_TEMPLATE + && metadata.getDataInfo().getType() != MetadataType.TEMPLATE_OF_SUB_TEMPLATE && withBackup) { + MetadataUtils.backupRecord(metadata, context); + } + + boolean approved=true; + if (metadata instanceof MetadataDraft) { + approved=false; + } - store.delResources(context, metadata.getUuid(), approved); - RecordDeletedEvent recordDeletedEvent = triggerDeletionEvent(request, metadata.getId() + ""); - metadataManager.deleteMetadata(context, metadata.getId() + ""); - recordDeletedEvent.publish(ApplicationContextHolder.get()); + store.delResources(context, metadata.getUuid(), approved); + RecordDeletedEvent recordDeletedEvent = triggerDeletionEvent(request, metadata.getId() + ""); + metadataManager.deleteMetadata(context, metadata.getId() + ""); + recordDeletedEvent.publish(ApplicationContextHolder.get()); - dataManager.forceIndexChanges(); + dataManager.forceIndexChanges(); + } } @io.swagger.v3.oas.annotations.Operation(summary = "Delete one or more records", description ="User MUST be able to edit the record to delete it. " @@ -220,40 +222,41 @@ public SimpleMetadataProcessingReport deleteRecords( @Parameter(description = ApiParams.API_PARAM_BUCKET_NAME, required = false) @RequestParam(required = false) String bucket, @Parameter(description = API_PARAM_BACKUP_FIRST, required = false) @RequestParam(required = false, defaultValue = "true") boolean withBackup, @Parameter(hidden = true) HttpSession session, HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - Store store = context.getBean("resourceStore", Store.class); - - Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, ApiUtils.getUserSession(session)); - - SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); - for (String uuid : records) { - AbstractMetadata metadata = metadataRepository.findOneByUuid(uuid); - if (metadata == null) { - report.incrementNullRecords(); - } else if (!accessManager.canEdit(context, String.valueOf(metadata.getId())) - || metadataDraftRepository.findOneByUuid(uuid) != null) { - report.addNotEditableMetadataId(metadata.getId()); - } else { - MetadataPreRemove preRemoveEvent = new MetadataPreRemove(metadata); - ApplicationContextHolder.get().publishEvent(preRemoveEvent); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + Store store = context.getBean("resourceStore", Store.class); + + Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, ApiUtils.getUserSession(session)); + + SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); + for (String uuid : records) { + AbstractMetadata metadata = metadataRepository.findOneByUuid(uuid); + if (metadata == null) { + report.incrementNullRecords(); + } else if (!accessManager.canEdit(context, String.valueOf(metadata.getId())) + || metadataDraftRepository.findOneByUuid(uuid) != null) { + report.addNotEditableMetadataId(metadata.getId()); + } else { + MetadataPreRemove preRemoveEvent = new MetadataPreRemove(metadata); + ApplicationContextHolder.get().publishEvent(preRemoveEvent); - if (metadata.getDataInfo().getType() != MetadataType.SUB_TEMPLATE - && metadata.getDataInfo().getType() != MetadataType.TEMPLATE_OF_SUB_TEMPLATE && withBackup) { - MetadataUtils.backupRecord(metadata, context); - } + if (metadata.getDataInfo().getType() != MetadataType.SUB_TEMPLATE + && metadata.getDataInfo().getType() != MetadataType.TEMPLATE_OF_SUB_TEMPLATE && withBackup) { + MetadataUtils.backupRecord(metadata, context); + } - store.delResources(context, metadata.getUuid()); + store.delResources(context, metadata.getUuid()); - RecordDeletedEvent recordDeletedEvent = triggerDeletionEvent(request, String.valueOf(metadata.getId())); - metadataManager.deleteMetadata(context, String.valueOf(metadata.getId())); - recordDeletedEvent.publish(ApplicationContextHolder.get()); + RecordDeletedEvent recordDeletedEvent = triggerDeletionEvent(request, String.valueOf(metadata.getId())); + metadataManager.deleteMetadata(context, String.valueOf(metadata.getId())); + recordDeletedEvent.publish(ApplicationContextHolder.get()); - report.incrementProcessedRecords(); - report.addMetadataId(metadata.getId()); + report.incrementProcessedRecords(); + report.addMetadataId(metadata.getId()); + } } + report.close(); + return report; } - report.close(); - return report; } @io.swagger.v3.oas.annotations.Operation(summary = "Add a record", description = "Add one or more record from an XML fragment, " @@ -357,41 +360,41 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IO throw new Exception( String.format("No XML or MEF or ZIP file found in server folder '%s'.", serverFolder)); } - ServiceContext context = ApiUtils.createServiceContext(request); - for (Path f : files) { - if (MEFLib.isValidArchiveExtensionForMEF(f.getFileName().toString())) { - try { - MEFLib.Version version = MEFLib.getMEFVersion(f); - List ids = MEFLib.doImport(version == MEFLib.Version.V1 ? "mef" : "mef2", - uuidProcessing, transformWith, settingManager.getSiteId(), metadataType, category, - group, rejectIfInvalid, assignToCatalog, context, f); - for (String id : ids) { - report.addMetadataInfos(Integer.parseInt(id), id, !publishToAll, false, + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + for (Path f : files) { + if (MEFLib.isValidArchiveExtensionForMEF(f.getFileName().toString())) { + try { + MEFLib.Version version = MEFLib.getMEFVersion(f); + List ids = MEFLib.doImport(version == MEFLib.Version.V1 ? "mef" : "mef2", + uuidProcessing, transformWith, settingManager.getSiteId(), metadataType, category, + group, rejectIfInvalid, assignToCatalog, context, f); + for (String id : ids) { + report.addMetadataInfos(Integer.parseInt(id), id, !publishToAll, false, String.format("Metadata imported from MEF with id '%s'", id)); - triggerCreationEvent(request, id); + triggerCreationEvent(request, id); - report.incrementProcessedRecords(); + report.incrementProcessedRecords(); + } + } catch (Exception e) { + report.addError(e); + report.addInfos(String.format("Failed to import MEF file '%s'. Check error for details.", + f.getFileName().toString())); } - } catch (Exception e) { - report.addError(e); - report.addInfos(String.format("Failed to import MEF file '%s'. Check error for details.", - f.getFileName().toString())); - } - } else { - try { - Pair pair = loadRecord(metadataType, Xml.loadFile(f), uuidProcessing, group, + } else { + try { + Pair pair = loadRecord(metadataType, Xml.loadFile(f), uuidProcessing, group, category, rejectIfInvalid, publishToAll, transformWith, schema, extra, request); - report.addMetadataInfos(pair.one(), pair.two(), !publishToAll, false, + report.addMetadataInfos(pair.one(), pair.two(), !publishToAll, false, String.format("Metadata imported from server folder with UUID '%s'", pair.two())); - triggerCreationEvent(request, pair.two()); + triggerCreationEvent(request, pair.two()); - } catch (Exception e) { - report.addError(e); + } catch (Exception e) { + report.addError(e); + } + report.incrementProcessedRecords(); } - report.incrementProcessedRecords(); } - } } report.close(); @@ -463,57 +466,58 @@ String create( } } - ServiceContext context = ApiUtils.createServiceContext(request); - String newId = dataManager.createMetadata(context, String.valueOf(sourceMetadata.getId()), group, - settingManager.getSiteId(), context.getUserSession().getUserIdAsInt(), - isChildOfSource ? sourceMetadata.getUuid() : null, metadataType.toString(), isVisibleByAllGroupMembers, - metadataUuid); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + String newId = dataManager.createMetadata(context, String.valueOf(sourceMetadata.getId()), group, + settingManager.getSiteId(), context.getUserSession().getUserIdAsInt(), + isChildOfSource ? sourceMetadata.getUuid() : null, metadataType.toString(), isVisibleByAllGroupMembers, + metadataUuid); - triggerCreationEvent(request, newId); + triggerCreationEvent(request, newId); - dataManager.activateWorkflowIfConfigured(context, newId, group); + dataManager.activateWorkflowIfConfigured(context, newId, group); - if (hasAttachmentsOfSource) { - try { - StoreUtils.copyDataDir(context, sourceMetadata.getId(), Integer.parseInt(newId), true); - } catch (Exception e) { - Log.warning(Geonet.DATA_MANAGER, - String.format( - "Error while copying metadata resources. Error is %s. " - + "Metadata is created but without resources from the source record with id '%s':", - e.getMessage(), newId)); + if (hasAttachmentsOfSource) { + try { + StoreUtils.copyDataDir(context, sourceMetadata.getId(), Integer.parseInt(newId), true); + } catch (Exception e) { + Log.warning(Geonet.DATA_MANAGER, + String.format( + "Error while copying metadata resources. Error is %s. " + + "Metadata is created but without resources from the source record with id '%s':", + e.getMessage(), newId)); + } } - } - if (hasCategoryOfSource) { - final Collection categories = dataManager.getCategories(sourceMetadata.getId() + ""); - try { - for (MetadataCategory c : categories) { - dataManager.setCategory(context, newId, c.getId() + ""); + if (hasCategoryOfSource) { + final Collection categories = dataManager.getCategories(sourceMetadata.getId() + ""); + try { + for (MetadataCategory c : categories) { + dataManager.setCategory(context, newId, c.getId() + ""); + } + } catch (Exception e) { + Log.warning(Geonet.DATA_MANAGER, + String.format("Error while copying source record category to new record. Error is %s. " + + "Metadata is created but without the categories from the source record with id '%d':", + e.getMessage(), newId)); } - } catch (Exception e) { - Log.warning(Geonet.DATA_MANAGER, - String.format("Error while copying source record category to new record. Error is %s. " - + "Metadata is created but without the categories from the source record with id '%d':", - e.getMessage(), newId)); } - } - if (category != null && category.length > 0) { - try { - for (String c : category) { - dataManager.setCategory(context, newId, c); + if (category != null && category.length > 0) { + try { + for (String c : category) { + dataManager.setCategory(context, newId, c); + } + } catch (Exception e) { + Log.warning(Geonet.DATA_MANAGER, + String.format( + "Error while setting record category to new record. Error is %s. " + + "Metadata is created but without the requested categories.", + e.getMessage(), newId)); } - } catch (Exception e) { - Log.warning(Geonet.DATA_MANAGER, - String.format( - "Error while setting record category to new record. Error is %s. " - + "Metadata is created but without the requested categories.", - e.getMessage(), newId)); } - } - return newId; + return newId; + } } @io.swagger.v3.oas.annotations.Operation(summary = "Add a record from XML or MEF/ZIP file", description ="Add record in the catalog by uploading files.") @@ -541,54 +545,55 @@ public SimpleMetadataProcessingReport insertFile( } SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); if (file != null) { - ServiceContext context = ApiUtils.createServiceContext(request); - for (MultipartFile f : file) { - if (MEFLib.isValidArchiveExtensionForMEF(f.getOriginalFilename())) { - Path tempFile = Files.createTempFile("mef-import", ".zip"); - try { - FileUtils.copyInputStreamToFile(f.getInputStream(), tempFile.toFile()); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + for (MultipartFile f : file) { + if (MEFLib.isValidArchiveExtensionForMEF(f.getOriginalFilename())) { + Path tempFile = Files.createTempFile("mef-import", ".zip"); + try { + FileUtils.copyInputStreamToFile(f.getInputStream(), tempFile.toFile()); - MEFLib.Version version = MEFLib.getMEFVersion(tempFile); + MEFLib.Version version = MEFLib.getMEFVersion(tempFile); - List ids = MEFLib.doImport(version == MEFLib.Version.V1 ? "mef" : "mef2", + List ids = MEFLib.doImport(version == MEFLib.Version.V1 ? "mef" : "mef2", uuidProcessing, transformWith, settingManager.getSiteId(), metadataType, category, group, rejectIfInvalid, assignToCatalog, context, tempFile); - if (ids.isEmpty()) { - //we could have used a finer-grained error handling inside the MEFLib import call (MEF MD file processing) - //This is a catch-for-call for the case when there is no record is imported, to notify the user the import is not successful. - throw new BadFormatEx("Import 0 record, check whether the importing file is a valid MEF archive."); - } - ids.forEach(e -> { - report.addMetadataInfos(Integer.parseInt(e), e, !publishToAll, false, - String.format("Metadata imported with ID '%s'", e)); - - try { - triggerCreationEvent(request, e); - } catch (Exception e1) { - report.addError(e1); - report.addInfos( - String.format("Impossible to store event for '%s'. Check error for details.", - f.getOriginalFilename())); + if (ids.isEmpty()) { + //we could have used a finer-grained error handling inside the MEFLib import call (MEF MD file processing) + //This is a catch-for-call for the case when there is no record is imported, to notify the user the import is not successful. + throw new BadFormatEx("Import 0 record, check whether the importing file is a valid MEF archive."); } + ids.forEach(e -> { + report.addMetadataInfos(Integer.parseInt(e), e, !publishToAll, false, + String.format("Metadata imported with ID '%s'", e)); - report.incrementProcessedRecords(); - }); - } catch (Exception e) { - report.addError(e); - report.addInfos(String.format("Failed to import MEF file '%s'. Check error for details.", - f.getOriginalFilename())); - } finally { - IO.deleteFile(tempFile, false, Geonet.MEF); - } - } else { - Pair pair = loadRecord(metadataType, Xml.loadStream(f.getInputStream()), + try { + triggerCreationEvent(request, e); + } catch (Exception e1) { + report.addError(e1); + report.addInfos( + String.format("Impossible to store event for '%s'. Check error for details.", + f.getOriginalFilename())); + } + + report.incrementProcessedRecords(); + }); + } catch (Exception e) { + report.addError(e); + report.addInfos(String.format("Failed to import MEF file '%s'. Check error for details.", + f.getOriginalFilename())); + } finally { + IO.deleteFile(tempFile, false, Geonet.MEF); + } + } else { + Pair pair = loadRecord(metadataType, Xml.loadStream(f.getInputStream()), uuidProcessing, group, category, rejectIfInvalid, publishToAll, transformWith, schema, extra, request); - report.addMetadataInfos(pair.one(), pair.two(), !publishToAll, false, String.format("Metadata imported with UUID '%s'", pair.two())); + report.addMetadataInfos(pair.one(), pair.two(), !publishToAll, false, String.format("Metadata imported with UUID '%s'", pair.two())); - triggerImportEvent(request, pair.two()); + triggerImportEvent(request, pair.two()); - report.incrementProcessedRecords(); + report.incrementProcessedRecords(); + } } } } @@ -626,112 +631,113 @@ public SimpleMetadataProcessingReport insertOgcMapContextFile( + "You MUST provide a filename in this case.")); } - ServiceContext context = ApiUtils.createServiceContext(request); - String styleSheetWmc = dataDirectory.getWebappDir() + File.separator + Geonet.Path.IMPORT_STYLESHEETS - + File.separator + "OGCWMC-OR-OWSC-to-ISO19139.xsl"; - - FilePathChecker.verify(filename); - - // Convert the context in an ISO19139 records - Map xslParams = new HashMap(); - xslParams.put("viewer_url", viewerUrl); - xslParams.put("map_url", url); - xslParams.put("topic", topic); - xslParams.put("title", title); - xslParams.put("abstract", recordAbstract); - xslParams.put("lang", context.getLanguage()); - - // Assign current user to the record - UserSession us = context.getUserSession(); - - if (us != null) { - xslParams.put("currentuser_name", us.getName() + " " + us.getSurname()); - // phone number is georchestra-specific - // xslParams.put("currentuser_phone", us.getPrincipal().getPhone()); - xslParams.put("currentuser_mail", us.getEmailAddr()); - xslParams.put("currentuser_org", us.getOrganisation()); - } + try (ServiceContext context = ApiUtils.createServiceContext(request)){ + String styleSheetWmc = dataDirectory.getWebappDir() + File.separator + Geonet.Path.IMPORT_STYLESHEETS + + File.separator + "OGCWMC-OR-OWSC-to-ISO19139.xsl"; - // 1. JDOMize the string - Element wmcDoc = Xml.loadString(xml, false); - // 2. Apply XSL (styleSheetWmc) - Element transformedMd = Xml.transform(wmcDoc, new File(styleSheetWmc).toPath(), xslParams); + FilePathChecker.verify(filename); - // 4. Inserts the metadata (does basically the same as the metadata.insert.paste - // service (see Insert.java) - String uuid = UUID.randomUUID().toString(); + // Convert the context in an ISO19139 records + Map xslParams = new HashMap(); + xslParams.put("viewer_url", viewerUrl); + xslParams.put("map_url", url); + xslParams.put("topic", topic); + xslParams.put("title", title); + xslParams.put("abstract", recordAbstract); + xslParams.put("lang", context.getLanguage()); - String date = new ISODate().toString(); - SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); + // Assign current user to the record + UserSession us = context.getUserSession(); - final List id = new ArrayList(); - final List md = new ArrayList(); - - md.add(transformedMd); - - // Import record - Importer.importRecord(uuid, uuidProcessing, md, "iso19139", 0, settingManager.getSiteId(), - settingManager.getSiteName(), null, context, id, date, date, group, MetadataType.METADATA); - - final Store store = context.getBean("resourceStore", Store.class); - final IMetadataUtils metadataUtils = context.getBean(IMetadataUtils.class); - final String metadataUuid = metadataUtils.getMetadataUuid(id.get(0)); - - // Save the context if no context-url provided - if (StringUtils.isEmpty(url)) { - store.putResource(context, metadataUuid, filename, IOUtils.toInputStream(Xml.getString(wmcDoc)), null, - MetadataResourceVisibility.PUBLIC, true); - - // Update the MD - Map onlineSrcParams = new HashMap(); - onlineSrcParams.put("protocol", "OGC:OWS-C"); - onlineSrcParams.put("url", - settingManager.getNodeURL() + String.format("api/records/%s/attachments/%s", uuid, filename)); - onlineSrcParams.put("name", filename); - onlineSrcParams.put("desc", title); - transformedMd = Xml.transform(transformedMd, - schemaManager.getSchemaDir("iso19139").resolve("process").resolve("onlinesrc-add.xsl"), - onlineSrcParams); - dataManager.updateMetadata(context, id.get(0), transformedMd, false, true, false, context.getLanguage(), - null, true); - } + if (us != null) { + xslParams.put("currentuser_name", us.getName() + " " + us.getSurname()); + // phone number is georchestra-specific + // xslParams.put("currentuser_phone", us.getPrincipal().getPhone()); + xslParams.put("currentuser_mail", us.getEmailAddr()); + xslParams.put("currentuser_org", us.getOrganisation()); + } - if (StringUtils.isNotEmpty(overview) && StringUtils.isNotEmpty(overviewFilename)) { - store.putResource(context, metadataUuid, overviewFilename, new ByteArrayInputStream(Base64.decodeBase64(overview)), null, - MetadataResourceVisibility.PUBLIC, true); - - // Update the MD - Map onlineSrcParams = new HashMap(); - onlineSrcParams.put("thumbnail_url", settingManager.getNodeURL() - + String.format("api/records/%s/attachments/%s", uuid, overviewFilename)); - transformedMd = Xml.transform(transformedMd, - schemaManager.getSchemaDir("iso19139").resolve("process").resolve("thumbnail-add.xsl"), - onlineSrcParams); - dataManager.updateMetadata(context, id.get(0), transformedMd, false, true, false, context.getLanguage(), - null, true); - } + // 1. JDOMize the string + Element wmcDoc = Xml.loadString(xml, false); + // 2. Apply XSL (styleSheetWmc) + Element transformedMd = Xml.transform(wmcDoc, new File(styleSheetWmc).toPath(), xslParams); + + // 4. Inserts the metadata (does basically the same as the metadata.insert.paste + // service (see Insert.java) + String uuid = UUID.randomUUID().toString(); + + String date = new ISODate().toString(); + SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); + + final List id = new ArrayList(); + final List md = new ArrayList(); + + md.add(transformedMd); + + // Import record + Importer.importRecord(uuid, uuidProcessing, md, "iso19139", 0, settingManager.getSiteId(), + settingManager.getSiteName(), null, context, id, date, date, group, MetadataType.METADATA); + + final Store store = context.getBean("resourceStore", Store.class); + final IMetadataUtils metadataUtils = context.getBean(IMetadataUtils.class); + final String metadataUuid = metadataUtils.getMetadataUuid(id.get(0)); + + // Save the context if no context-url provided + if (StringUtils.isEmpty(url)) { + store.putResource(context, metadataUuid, filename, IOUtils.toInputStream(Xml.getString(wmcDoc)), null, + MetadataResourceVisibility.PUBLIC, true); + + // Update the MD + Map onlineSrcParams = new HashMap(); + onlineSrcParams.put("protocol", "OGC:OWS-C"); + onlineSrcParams.put("url", + settingManager.getNodeURL() + String.format("api/records/%s/attachments/%s", uuid, filename)); + onlineSrcParams.put("name", filename); + onlineSrcParams.put("desc", title); + transformedMd = Xml.transform(transformedMd, + schemaManager.getSchemaDir("iso19139").resolve("process").resolve("onlinesrc-add.xsl"), + onlineSrcParams); + dataManager.updateMetadata(context, id.get(0), transformedMd, false, true, false, context.getLanguage(), + null, true); + } - int iId = Integer.parseInt(id.get(0)); - if (publishToAll) { - dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.view.getId()); - dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.download.getId()); - dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.dynamic.getId()); - } - if (StringUtils.isNotEmpty(group)) { - int gId = Integer.parseInt(group); - dataManager.setOperation(context, iId, gId, ReservedOperation.view.getId()); - dataManager.setOperation(context, iId, gId, ReservedOperation.download.getId()); - dataManager.setOperation(context, iId, gId, ReservedOperation.dynamic.getId()); - } + if (StringUtils.isNotEmpty(overview) && StringUtils.isNotEmpty(overviewFilename)) { + store.putResource(context, metadataUuid, overviewFilename, new ByteArrayInputStream(Base64.decodeBase64(overview)), null, + MetadataResourceVisibility.PUBLIC, true); + + // Update the MD + Map onlineSrcParams = new HashMap(); + onlineSrcParams.put("thumbnail_url", settingManager.getNodeURL() + + String.format("api/records/%s/attachments/%s", uuid, overviewFilename)); + transformedMd = Xml.transform(transformedMd, + schemaManager.getSchemaDir("iso19139").resolve("process").resolve("thumbnail-add.xsl"), + onlineSrcParams); + dataManager.updateMetadata(context, id.get(0), transformedMd, false, true, false, context.getLanguage(), + null, true); + } + + int iId = Integer.parseInt(id.get(0)); + if (publishToAll) { + dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.view.getId()); + dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.download.getId()); + dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.dynamic.getId()); + } + if (StringUtils.isNotEmpty(group)) { + int gId = Integer.parseInt(group); + dataManager.setOperation(context, iId, gId, ReservedOperation.view.getId()); + dataManager.setOperation(context, iId, gId, ReservedOperation.download.getId()); + dataManager.setOperation(context, iId, gId, ReservedOperation.dynamic.getId()); + } - dataManager.indexMetadata(id); - report.addMetadataInfos(Integer.parseInt(id.get(0)), uuid, !publishToAll, false, uuid); + dataManager.indexMetadata(id); + report.addMetadataInfos(Integer.parseInt(id.get(0)), uuid, !publishToAll, false, uuid); - triggerCreationEvent(request, uuid); + triggerCreationEvent(request, uuid); - report.incrementProcessedRecords(); - report.close(); - return report; + report.incrementProcessedRecords(); + report.close(); + return report; + } } /** @@ -761,28 +767,29 @@ private void triggerCreationEvent(HttpServletRequest request, String uuid) */ private RecordDeletedEvent triggerDeletionEvent(HttpServletRequest request, String uuid) throws Exception { - AbstractMetadata metadata = ApiUtils.getRecord(uuid); - ApplicationContext applicationContext = ApplicationContextHolder.get(); - UserSession userSession = ApiUtils.getUserSession(request.getSession()); - - ServiceContext serviceContext = ApiUtils.createServiceContext(request); - DataManager dataMan = applicationContext.getBean(DataManager.class); - Element beforeMetadata = dataMan.getMetadata(serviceContext, String.valueOf(metadata.getId()), false, false, false); - XMLOutputter outp = new XMLOutputter(); - String xmlBefore = outp.outputString(beforeMetadata); - LinkedHashMap titles = new LinkedHashMap<>(); - try { - titles = metadataUtils.extractTitles(Integer.toString(metadata.getId())); - } catch (Exception e) { - Log.warning(Geonet.DATA_MANAGER, - String.format( - "Error while extracting title for the metadata %d " + - "while creating delete event. Error is %s. " + - "It may happen on subtemplates.", - metadata.getId(), e.getMessage())); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.getRecord(uuid); + ApplicationContext applicationContext = ApplicationContextHolder.get(); + UserSession userSession = ApiUtils.getUserSession(request.getSession()); + + DataManager dataMan = applicationContext.getBean(DataManager.class); + Element beforeMetadata = dataMan.getMetadata(serviceContext, String.valueOf(metadata.getId()), false, false, false); + XMLOutputter outp = new XMLOutputter(); + String xmlBefore = outp.outputString(beforeMetadata); + LinkedHashMap titles = new LinkedHashMap<>(); + try { + titles = metadataUtils.extractTitles(Integer.toString(metadata.getId())); + } catch (Exception e) { + Log.warning(Geonet.DATA_MANAGER, + String.format( + "Error while extracting title for the metadata %d " + + "while creating delete event. Error is %s. " + + "It may happen on subtemplates.", + metadata.getId(), e.getMessage())); + } + return new RecordDeletedEvent(metadata.getId(), metadata.getUuid(), titles, userSession.getUserIdAsInt(), xmlBefore); } - return new RecordDeletedEvent(metadata.getId(), metadata.getUuid(), titles, userSession.getUserIdAsInt(), xmlBefore); - } + } /** @@ -807,119 +814,119 @@ private Pair loadRecord(MetadataType metadataType, Element xmlE final boolean rejectIfInvalid, final boolean publishToAll, final String transformWith, String schema, final String extra, HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - - if (!transformWith.equals("_none_")) { - Path folder = dataDirectory.getWebappDir().resolve(Geonet.Path.IMPORT_STYLESHEETS); - FilePathChecker.verify(transformWith); - Path xslFile = folder.resolve(transformWith + ".xsl"); - if (Files.exists(xslFile)) { - xmlElement = Xml.transform(xmlElement, xslFile); - } else { - throw new ResourceNotFoundException(String.format("XSL transformation '%s' not found.", transformWith)); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + if (!transformWith.equals("_none_")) { + Path folder = dataDirectory.getWebappDir().resolve(Geonet.Path.IMPORT_STYLESHEETS); + FilePathChecker.verify(transformWith); + Path xslFile = folder.resolve(transformWith + ".xsl"); + if (Files.exists(xslFile)) { + xmlElement = Xml.transform(xmlElement, xslFile); + } else { + throw new ResourceNotFoundException(String.format("XSL transformation '%s' not found.", transformWith)); + } } - } - if (schema == null) { - schema = dataManager.autodetectSchema(xmlElement); if (schema == null) { - throw new IllegalArgumentException("Can't detect schema for metadata automatically. " - + "You could try to force the schema with the schema parameter."); - // TODO: Report what are the supported schema + schema = dataManager.autodetectSchema(xmlElement); + if (schema == null) { + throw new IllegalArgumentException("Can't detect schema for metadata automatically. " + + "You could try to force the schema with the schema parameter."); + // TODO: Report what are the supported schema + } + } else { + // TODO: Check that the schema is supported } - } else { - // TODO: Check that the schema is supported - } - if (rejectIfInvalid) { - try { - Integer groupId = null; - if (StringUtils.isNotEmpty(group)) { - groupId = Integer.parseInt(group); + if (rejectIfInvalid) { + try { + Integer groupId = null; + if (StringUtils.isNotEmpty(group)) { + groupId = Integer.parseInt(group); + } + DataManager.validateExternalMetadata(schema, xmlElement, context, groupId); + } catch (XSDValidationErrorEx e) { + throw new IllegalArgumentException(e); } - DataManager.validateExternalMetadata(schema, xmlElement, context, groupId); - } catch (XSDValidationErrorEx e) { - throw new IllegalArgumentException(e); } - } - // --- if the uuid does not exist we generate it for metadata and templates - String uuid; - if (metadataType == MetadataType.SUB_TEMPLATE || metadataType == MetadataType.TEMPLATE_OF_SUB_TEMPLATE) { - // subtemplates may need to be loaded with a specific uuid - // that will be attached to the root element so check for that - // and if not found, generate a new uuid - uuid = xmlElement.getAttributeValue("uuid"); - if (StringUtils.isEmpty(uuid)) { - uuid = UUID.randomUUID().toString(); - } - } else { - uuid = dataManager.extractUUID(schema, xmlElement); - if (uuid.length() == 0) { - uuid = UUID.randomUUID().toString(); - xmlElement = dataManager.setUUID(schema, uuid, xmlElement); + // --- if the uuid does not exist we generate it for metadata and templates + String uuid; + if (metadataType == MetadataType.SUB_TEMPLATE || metadataType == MetadataType.TEMPLATE_OF_SUB_TEMPLATE) { + // subtemplates may need to be loaded with a specific uuid + // that will be attached to the root element so check for that + // and if not found, generate a new uuid + uuid = xmlElement.getAttributeValue("uuid"); + if (StringUtils.isEmpty(uuid)) { + uuid = UUID.randomUUID().toString(); + } + } else { + uuid = dataManager.extractUUID(schema, xmlElement); + if (uuid.length() == 0) { + uuid = UUID.randomUUID().toString(); + xmlElement = dataManager.setUUID(schema, uuid, xmlElement); + } } - } - if (uuidProcessing == MEFLib.UuidAction.NOTHING) { - AbstractMetadata md = metadataRepository.findOneByUuid(uuid); - if (md != null) { - throw new IllegalArgumentException( - String.format("A record with UUID '%s' already exist and you choose no " - + "action on UUID processing. Choose to overwrite existing record " - + "or to generate a new UUID.", uuid)); + if (uuidProcessing == MEFLib.UuidAction.NOTHING) { + AbstractMetadata md = metadataRepository.findOneByUuid(uuid); + if (md != null) { + throw new IllegalArgumentException( + String.format("A record with UUID '%s' already exist and you choose no " + + "action on UUID processing. Choose to overwrite existing record " + + "or to generate a new UUID.", uuid)); + } } - } - String date = new ISODate().toString(); + String date = new ISODate().toString(); - final List id = new ArrayList(); - final List md = new ArrayList(); - md.add(xmlElement); + final List id = new ArrayList(); + final List md = new ArrayList(); + md.add(xmlElement); - // Import record - Map sourceTranslations = Maps.newHashMap(); - try { - Importer.importRecord(uuid, uuidProcessing, md, schema, 0, settingManager.getSiteId(), - settingManager.getSiteName(), sourceTranslations, context, id, date, date, group, metadataType); + // Import record + Map sourceTranslations = Maps.newHashMap(); + try { + Importer.importRecord(uuid, uuidProcessing, md, schema, 0, settingManager.getSiteId(), + settingManager.getSiteName(), sourceTranslations, context, id, date, date, group, metadataType); - } catch (DataIntegrityViolationException ex) { - throw ex; - } catch (Exception ex) { - throw ex; - } - int iId = Integer.parseInt(id.get(0)); - uuid = dataManager.getMetadataUuid(iId + ""); + } catch (DataIntegrityViolationException ex) { + throw ex; + } catch (Exception ex) { + throw ex; + } + int iId = Integer.parseInt(id.get(0)); + uuid = dataManager.getMetadataUuid(iId + ""); - // Set template - dataManager.setTemplate(iId, metadataType, null); + // Set template + dataManager.setTemplate(iId, metadataType, null); - if (publishToAll) { - dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.view.getId()); - dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.download.getId()); - dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.dynamic.getId()); - } + if (publishToAll) { + dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.view.getId()); + dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.download.getId()); + dataManager.setOperation(context, iId, ReservedGroup.all.getId(), ReservedOperation.dynamic.getId()); + } - dataManager.activateWorkflowIfConfigured(context, id.get(0), group); + dataManager.activateWorkflowIfConfigured(context, id.get(0), group); - if (category != null) { - for (String c : category) { - dataManager.setCategory(context, id.get(0), c); + if (category != null) { + for (String c : category) { + dataManager.setCategory(context, id.get(0), c); + } } - } - if (extra != null) { - metadataRepository.update(iId, new Updater() { - @Override - public void apply(@Nonnull Metadata metadata) { - if (extra != null) { - metadata.getDataInfo().setExtra(extra); + if (extra != null) { + metadataRepository.update(iId, new Updater() { + @Override + public void apply(@Nonnull Metadata metadata) { + if (extra != null) { + metadata.getDataInfo().setExtra(extra); + } } - } - }); - } + }); + } - dataManager.indexMetadata(id.get(0), true); - return Pair.read(Integer.valueOf(id.get(0)), uuid); + dataManager.indexMetadata(id.get(0), true); + return Pair.read(Integer.valueOf(id.get(0)), uuid); + } } } diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataProcessApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataProcessApi.java index f40d2e293b08..b96cc96ba4e3 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataProcessApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataProcessApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -94,41 +94,41 @@ public class MetadataProcessApi { List getSuggestions( @Parameter(description = API_PARAM_RECORD_UUID, required = true) @PathVariable String metadataUuid, HttpServletRequest request) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - - ServiceContext context = ApiUtils.createServiceContext(request); - - Map xslParameter = new HashMap(); - xslParameter.put("guiLang", request.getLocale().getISO3Language()); - xslParameter.put("siteUrl", sm.getSiteURL(context)); - xslParameter.put("nodeUrl", sm.getNodeURL()); - xslParameter.put("baseUrl", context.getBaseUrl()); - xslParameter.put("action", "analyze"); - - // List or analyze all suggestions process registered for this schema - MetadataSchema metadataSchema = dm.getSchema(metadata.getDataInfo().getSchemaId()); - Path xslProcessing = metadataSchema.getSchemaDir().resolve(XSL_SUGGEST_FILE); - if (Files.exists(xslProcessing)) { - // -- here we send parameters set by user from - // URL if needed. - boolean forEditing = false, withValidationErrors = false, keepXlinkAttributes = false; - Element md = dm.getMetadata(context, String.valueOf(metadata.getId()), forEditing, withValidationErrors, - keepXlinkAttributes); - - Element xmlSuggestions; - try { - xmlSuggestions = Xml.transform(md, xslProcessing, xslParameter); - } catch (TransformerConfigurationException e) { - throw new WebApplicationException(String.format("Error while retrieving suggestion for record '%s'. " - + "Check your suggest.xsl process (and all its imports).", metadataUuid, xslProcessing), e); - } - SuggestionsType suggestions = (SuggestionsType) Xml.unmarshall(xmlSuggestions, SuggestionsType.class); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + + Map xslParameter = new HashMap(); + xslParameter.put("guiLang", request.getLocale().getISO3Language()); + xslParameter.put("siteUrl", sm.getSiteURL(context)); + xslParameter.put("nodeUrl", sm.getNodeURL()); + xslParameter.put("baseUrl", context.getBaseUrl()); + xslParameter.put("action", "analyze"); + + // List or analyze all suggestions process registered for this schema + MetadataSchema metadataSchema = dm.getSchema(metadata.getDataInfo().getSchemaId()); + Path xslProcessing = metadataSchema.getSchemaDir().resolve(XSL_SUGGEST_FILE); + if (Files.exists(xslProcessing)) { + // -- here we send parameters set by user from + // URL if needed. + boolean forEditing = false, withValidationErrors = false, keepXlinkAttributes = false; + Element md = dm.getMetadata(context, String.valueOf(metadata.getId()), forEditing, withValidationErrors, + keepXlinkAttributes); + + Element xmlSuggestions; + try { + xmlSuggestions = Xml.transform(md, xslProcessing, xslParameter); + } catch (TransformerConfigurationException e) { + throw new WebApplicationException(String.format("Error while retrieving suggestion for record '%s'. " + + "Check your suggest.xsl process (and all its imports).", metadataUuid, xslProcessing), e); + } + SuggestionsType suggestions = (SuggestionsType) Xml.unmarshall(xmlSuggestions, SuggestionsType.class); - return suggestions.getSuggestion(); - } else { - throw new ResourceNotFoundException( - String.format("No %s files available in schema '%s'. No suggestion to provides.", XSL_SUGGEST_FILE, - metadata.getDataInfo().getSchemaId())); + return suggestions.getSuggestion(); + } else { + throw new ResourceNotFoundException( + String.format("No %s files available in schema '%s'. No suggestion to provides.", XSL_SUGGEST_FILE, + metadata.getDataInfo().getSchemaId())); + } } } @@ -144,17 +144,19 @@ ResponseEntity processRecordPreview( @Parameter(description = API_PARAM_RECORD_UUID, required = true) @PathVariable String metadataUuid, @Parameter(description = ApiParams.API_PARAM_PROCESS_ID) @PathVariable String process, HttpServletRequest request) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - boolean save = request.getMethod().equals("POST"); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + boolean save = request.getMethod().equals("POST"); - ApplicationContext applicationContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); + ApplicationContext applicationContext = ApplicationContextHolder.get(); - XsltMetadataProcessingReport report = new XsltMetadataProcessingReport(process); + XsltMetadataProcessingReport report = new XsltMetadataProcessingReport(process); - Element processedMetadata = process(applicationContext, process, request, metadata, save, context, sm, report); + Element processedMetadata = process(applicationContext, process, request, metadata, save, context, sm, report); - return new ResponseEntity<>(processedMetadata, HttpStatus.OK); + return new ResponseEntity<>(processedMetadata, HttpStatus.OK); + + } } @io.swagger.v3.oas.annotations.Operation(summary = "Apply a process", description =API_OP_NOTE_PROCESS) @@ -169,16 +171,18 @@ ResponseEntity processRecord( @Parameter(description = API_PARAM_RECORD_UUID, required = true) @PathVariable String metadataUuid, @Parameter(description = ApiParams.API_PARAM_PROCESS_ID) @PathVariable String process, HttpServletRequest request) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - boolean save = true; + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + boolean save = true; - ApplicationContext applicationContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); + ApplicationContext applicationContext = ApplicationContextHolder.get(); - XsltMetadataProcessingReport report = new XsltMetadataProcessingReport(process); + XsltMetadataProcessingReport report = new XsltMetadataProcessingReport(process); - process(applicationContext, process, request, metadata, save, context, sm, report); - return new ResponseEntity<>(HttpStatus.NO_CONTENT); + process(applicationContext, process, request, metadata, save, context, sm, report); + return new ResponseEntity<>(HttpStatus.NO_CONTENT); + + } } private Element process(ApplicationContext applicationContext, String process, HttpServletRequest request, diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataSampleApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataSampleApi.java index edbfbc69e1b2..78fc840b301a 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataSampleApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataSampleApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -116,70 +116,71 @@ SimpleMetadataProcessingReport addSamples( HttpServletRequest request ) throws Exception { - ApplicationContext applicationContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); - SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); - UserSession userSession = ApiUtils.getUserSession(request.getSession()); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + ApplicationContext applicationContext = ApplicationContextHolder.get(); + SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); + UserSession userSession = ApiUtils.getUserSession(request.getSession()); - Element params = new Element("params"); - params.addContent(new Element("file_type").setText("mef")); - params.addContent(new Element("uuidAction").setText("overwrite")); - for (String schemaName : schema) { - Log.info(Geonet.DATA_MANAGER, "Loading sample data for schema " - + schemaName); - Path schemaDir = schemaManager.getSchemaSampleDataDir(schemaName); - if (schemaDir == null) { - report.addInfos(String.format( - "No samples available for schema '%s'.", schemaName - )); - continue; - } + Element params = new Element("params"); + params.addContent(new Element("file_type").setText("mef")); + params.addContent(new Element("uuidAction").setText("overwrite")); + for (String schemaName : schema) { + Log.info(Geonet.DATA_MANAGER, "Loading sample data for schema " + + schemaName); + Path schemaDir = schemaManager.getSchemaSampleDataDir(schemaName); + if (schemaDir == null) { + report.addInfos(String.format( + "No samples available for schema '%s'.", schemaName + )); + continue; + } - if (Log.isDebugEnabled(Geonet.DATA_MANAGER)) { - Log.debug(Geonet.DATA_MANAGER, "Searching for mefs in: " + schemaDir); - } + if (Log.isDebugEnabled(Geonet.DATA_MANAGER)) { + Log.debug(Geonet.DATA_MANAGER, "Searching for mefs in: " + schemaDir); + } - List sampleDataFilesList; - try (DirectoryStream newDirectoryStream = - Files.newDirectoryStream(schemaDir, "*.mef")) { - sampleDataFilesList = Lists.newArrayList(newDirectoryStream); - } + List sampleDataFilesList; + try (DirectoryStream newDirectoryStream = + Files.newDirectoryStream(schemaDir, "*.mef")) { + sampleDataFilesList = Lists.newArrayList(newDirectoryStream); + } - int schemaCount = 0; - for (final Path file : sampleDataFilesList) { - try { - if (Log.isDebugEnabled(Geonet.DATA_MANAGER)) { - Log.debug(Geonet.DATA_MANAGER, - String.format("Loading %s sample file %s ...", schemaName, file)); - } - List importedMdIds = MEFLib.doImport(params, context, file, null); + int schemaCount = 0; + for (final Path file : sampleDataFilesList) { + try { + if (Log.isDebugEnabled(Geonet.DATA_MANAGER)) { + Log.debug(Geonet.DATA_MANAGER, + String.format("Loading %s sample file %s ...", schemaName, file)); + } + List importedMdIds = MEFLib.doImport(params, context, file, null); - if (importedMdIds != null && importedMdIds.size() > 0) { - schemaCount += importedMdIds.size(); - for (String mdId : importedMdIds) { - AbstractMetadata metadata = ApiUtils.getRecord(mdId); - new RecordImportedEvent(Integer.parseInt(mdId), userSession.getUserIdAsInt(), - ObjectJSONUtils.convertObjectInJsonObject(userSession.getPrincipal(), RecordImportedEvent.FIELD), - metadata.getData()).publish(applicationContext); + if (importedMdIds != null && importedMdIds.size() > 0) { + schemaCount += importedMdIds.size(); + for (String mdId : importedMdIds) { + AbstractMetadata metadata = ApiUtils.getRecord(mdId); + new RecordImportedEvent(Integer.parseInt(mdId), userSession.getUserIdAsInt(), + ObjectJSONUtils.convertObjectInJsonObject(userSession.getPrincipal(), RecordImportedEvent.FIELD), + metadata.getData()).publish(applicationContext); + } } + } catch (Exception e) { + Log.error(Geonet.DATA_MANAGER, + String.format("Error loading %s sample file %s. Error is %s.", + schemaName, file, e.getMessage()), + e); + report.addError(new Exception(String.format( + "Error loading '%s' sample file '%s'. Error is %s.", + schemaName, file, e.getMessage()))); } - } catch (Exception e) { - Log.error(Geonet.DATA_MANAGER, - String.format("Error loading %s sample file %s. Error is %s.", - schemaName, file, e.getMessage()), - e); - report.addError(new Exception(String.format( - "Error loading '%s' sample file '%s'. Error is %s.", - schemaName, file, e.getMessage()))); + dataManager.flush(); } - dataManager.flush(); + report.addInfos(String.format( + "%d record(s) added for schema '%s'.", + schemaCount, schemaName)); } - report.addInfos(String.format( - "%d record(s) added for schema '%s'.", - schemaCount, schemaName)); + report.close(); + return report; } - report.close(); - return report; } @io.swagger.v3.oas.annotations.Operation( @@ -209,110 +210,110 @@ SimpleMetadataProcessingReport addTemplates( HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); - SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); + String siteId = settingManager.getSiteId(); + int owner = ApiUtils.getUserSession(session).getUserIdAsInt(); - String siteId = settingManager.getSiteId(); - int owner = ApiUtils.getUserSession(session).getUserIdAsInt(); + Log.info(Geonet.DATA_MANAGER, String.format( + "Loading templates for schemas '%s'.", schema)); - Log.info(Geonet.DATA_MANAGER, String.format( - "Loading templates for schemas '%s'.", schema)); - - for (String schemaName : schema) { - Path templatesDir = schemaManager.getSchemaTemplatesDir(schemaName); - if (templatesDir == null) { - report.addInfos(String.format( - "No templates available for schema '%s'.", schemaName - )); - continue; - } - final String subTemplatePrefix = "sub-"; - final String templateOfSubTemplatePrefix = "sub-tpl-"; - final int prefixLength = subTemplatePrefix.length(); - int schemaCount = 0; - try (DirectoryStream newDirectoryStream = - Files.newDirectoryStream(templatesDir, "*.xml")) { - for (Path temp : newDirectoryStream) { - String status = "failed"; - String templateName = temp.getFileName().toString(); + for (String schemaName : schema) { + Path templatesDir = schemaManager.getSchemaTemplatesDir(schemaName); + if (templatesDir == null) { + report.addInfos(String.format( + "No templates available for schema '%s'.", schemaName + )); + continue; + } + final String subTemplatePrefix = "sub-"; + final String templateOfSubTemplatePrefix = "sub-tpl-"; + final int prefixLength = subTemplatePrefix.length(); + int schemaCount = 0; + try (DirectoryStream newDirectoryStream = + Files.newDirectoryStream(templatesDir, "*.xml")) { + for (Path temp : newDirectoryStream) { + String status = "failed"; + String templateName = temp.getFileName().toString(); - Element template = new Element("template"); - template.setAttribute("name", templateName); + Element template = new Element("template"); + template.setAttribute("name", templateName); - if (Log.isDebugEnabled(Geonet.DATA_MANAGER)) { - Log.debug(Geonet.DATA_MANAGER, - String.format(" - Adding %s template file %s ...", - schemaName, templateName)); - } + if (Log.isDebugEnabled(Geonet.DATA_MANAGER)) { + Log.debug(Geonet.DATA_MANAGER, + String.format(" - Adding %s template file %s ...", + schemaName, templateName)); + } - try { - Element xml = Xml.loadFile(temp); - String uuid = UUID.randomUUID().toString(); - String isTemplate = "y"; - String title = null; + try { + Element xml = Xml.loadFile(temp); + String uuid = UUID.randomUUID().toString(); + String isTemplate = "y"; + String title = null; - if (templateName.startsWith(subTemplatePrefix)) { - isTemplate = templateName.startsWith(templateOfSubTemplatePrefix) ? - "t" : "s"; - } + if (templateName.startsWith(subTemplatePrefix)) { + isTemplate = templateName.startsWith(templateOfSubTemplatePrefix) ? + "t" : "s"; + } - if (isTemplate.equals("s")) { - // subtemplates loaded here can have a specific uuid - // attribute - String tryUuid = xml.getAttributeValue("uuid"); - if (!StringUtils.isEmpty(tryUuid)) uuid = tryUuid; - } - if (dataManager.existsMetadataUuid(uuid)) { - String upid = dataManager.getMetadataId(uuid); - AbstractMetadata metadata = dataManager.updateMetadata(context, upid, xml, false, true, false, context.getLanguage(), null, true); - report.addMetadataInfos(metadata, - String.format( - "Template for schema '%s' with UUID '%s' updated.", - schemaName, uuid)); - } else { - // - // insert metadata - // - Metadata metadata = new Metadata(); - metadata.setUuid(uuid); - metadata.getDataInfo(). - setSchemaId(schemaName). - setRoot(xml.getQualifiedName()). - setType(MetadataType.lookup(isTemplate)); - metadata.getSourceInfo(). - setSourceId(siteId). - setOwner(owner). - setGroupOwner(1); - // Set the UUID explicitly, insertMetadata doesn't update the xml with the generated UUID for templates - if (MetadataType.lookup(isTemplate) == MetadataType.TEMPLATE) { - xml = dataManager.setUUID(schemaName, uuid, xml); + if (isTemplate.equals("s")) { + // subtemplates loaded here can have a specific uuid + // attribute + String tryUuid = xml.getAttributeValue("uuid"); + if (!StringUtils.isEmpty(tryUuid)) uuid = tryUuid; + } + if (dataManager.existsMetadataUuid(uuid)) { + String upid = dataManager.getMetadataId(uuid); + AbstractMetadata metadata = dataManager.updateMetadata(context, upid, xml, false, true, false, context.getLanguage(), null, true); + report.addMetadataInfos(metadata, + String.format( + "Template for schema '%s' with UUID '%s' updated.", + schemaName, uuid)); + } else { + // + // insert metadata + // + Metadata metadata = new Metadata(); + metadata.setUuid(uuid); + metadata.getDataInfo(). + setSchemaId(schemaName). + setRoot(xml.getQualifiedName()). + setType(MetadataType.lookup(isTemplate)); + metadata.getSourceInfo(). + setSourceId(siteId). + setOwner(owner). + setGroupOwner(1); + // Set the UUID explicitly, insertMetadata doesn't update the xml with the generated UUID for templates + if (MetadataType.lookup(isTemplate) == MetadataType.TEMPLATE) { + xml = dataManager.setUUID(schemaName, uuid, xml); + } + dataManager.insertMetadata(context, metadata, xml, true, true, UpdateDatestamp.NO, false, true); + report.addMetadataInfos(metadata, + String.format( + "Template for schema '%s' with UUID '%s' added.", + schemaName, metadata.getUuid())); } - dataManager.insertMetadata(context, metadata, xml, true, true, UpdateDatestamp.NO, false, true); - report.addMetadataInfos(metadata, - String.format( - "Template for schema '%s' with UUID '%s' added.", - schemaName, metadata.getUuid())); - } - schemaCount++; - } catch (Exception e) { - Log.error(Geonet.DATA_MANAGER, - String.format("Error loading %s template file %s. Error is %s.", - schemaName, temp, e.getMessage()), - e); - report.addError(new Exception(String.format( - "Error loading '%s' template file '%s'. Error is %s.", - schemaName, temp, e.getMessage()))); + schemaCount++; + } catch (Exception e) { + Log.error(Geonet.DATA_MANAGER, + String.format("Error loading %s template file %s. Error is %s.", + schemaName, temp, e.getMessage()), + e); + report.addError(new Exception(String.format( + "Error loading '%s' template file '%s'. Error is %s.", + schemaName, temp, e.getMessage()))); + } } } - } - report.addInfos(String.format( - "%d record(s) added for schema '%s'.", - schemaCount, schemaName)); + report.addInfos(String.format( + "%d record(s) added for schema '%s'.", + schemaCount, schemaName)); + } + report.close(); + return report; } - report.close(); - return report; } } diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataSavedQueryApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataSavedQueryApi.java index 071e4e3f6ccc..10eb01ddd26a 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataSavedQueryApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataSavedQueryApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -27,6 +27,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.tags.Tag; +import jeeves.server.context.ServiceContext; import org.apache.commons.lang.StringUtils; import org.fao.geonet.api.API; import org.fao.geonet.api.ApiParams; @@ -87,17 +88,19 @@ public List getSavedQueries( @PathVariable final String metadataUuid, HttpServletRequest request ) throws Exception { - AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, request); - String schemaIdentifier = metadata.getDataInfo().getSchemaId(); - SchemaPlugin schemaPlugin = schemaManager.getSchema(schemaIdentifier).getSchemaPlugin(); - if (schemaPlugin == null) { - return new ArrayList<>(); - } - try { - MetadataSchema schema = schemaManager.getSchema(schemaIdentifier); - return schema.getSchemaPlugin().getSavedQueries(); - } catch (IllegalArgumentException e) { - return new ArrayList<>(); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, context); + String schemaIdentifier = metadata.getDataInfo().getSchemaId(); + SchemaPlugin schemaPlugin = schemaManager.getSchema(schemaIdentifier).getSchemaPlugin(); + if (schemaPlugin == null) { + return new ArrayList<>(); + } + try { + MetadataSchema schema = schemaManager.getSchema(schemaIdentifier); + return schema.getSchemaPlugin().getSavedQueries(); + } catch (IllegalArgumentException e) { + return new ArrayList<>(); + } } } @@ -134,9 +137,11 @@ public Map applyQuery( @Parameter(description = "The query parameters") @RequestBody(required = false) final HashMap parameters) throws Exception { - AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, context); - return query(metadata, savedQuery, parameters); + return query(metadata, savedQuery, parameters); + } } public Map query(AbstractMetadata metadata, String savedQuery, HashMap parameters) throws ResourceNotFoundException, IOException, NoResultsFoundException { diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataSharingApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataSharingApi.java index e0905af3a384..380cc3b198c6 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataSharingApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataSharingApi.java @@ -256,30 +256,31 @@ public void share( HttpServletRequest request ) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ApplicationContext appContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); - - boolean skipAllReservedGroup = false; - - //--- in case of owner, privileges for groups 0,1 and GUEST are disabled - //--- and are not sent to the server. So we cannot remove them - UserSession us = ApiUtils.getUserSession(session); - boolean isAdmin = Profile.Administrator == us.getProfile(); - if (!isAdmin && !accessManager.hasReviewPermission(context, Integer.toString(metadata.getId()))) { - skipAllReservedGroup = true; - } + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + ApplicationContext appContext = ApplicationContextHolder.get(); - List operationList = operationRepository.findAll(); - Map operationMap = new HashMap<>(operationList.size()); - for (Operation o : operationList) { - operationMap.put(o.getName(), o.getId()); - } + boolean skipAllReservedGroup = false; + + //--- in case of owner, privileges for groups 0,1 and GUEST are disabled + //--- and are not sent to the server. So we cannot remove them + UserSession us = ApiUtils.getUserSession(session); + boolean isAdmin = Profile.Administrator == us.getProfile(); + if (!isAdmin && !accessManager.hasReviewPermission(context, Integer.toString(metadata.getId()))) { + skipAllReservedGroup = true; + } + + List operationList = operationRepository.findAll(); + Map operationMap = new HashMap<>(operationList.size()); + for (Operation o : operationList) { + operationMap.put(o.getName(), o.getId()); + } - List privileges = sharing.getPrivileges(); - setOperations(sharing, dataManager, context, appContext, metadata, operationMap, privileges, - ApiUtils.getUserSession(session).getUserIdAsInt(), skipAllReservedGroup, null, request); - metadataIndexer.indexMetadataPrivileges(metadata.getUuid(), metadata.getId()); + List privileges = sharing.getPrivileges(); + setOperations(sharing, dataManager, context, appContext, metadata, operationMap, privileges, + ApiUtils.getUserSession(session).getUserIdAsInt(), skipAllReservedGroup, null, request); + metadataIndexer.indexMetadataPrivileges(metadata.getUuid(), metadata.getId()); + } } @io.swagger.v3.oas.annotations.Operation( @@ -499,73 +500,75 @@ public SharingResponse getRecordSharingSettings( ) throws Exception { // TODO: Restrict to user group only in response depending on settings? - AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, request); - ApplicationContext appContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); - UserSession userSession = ApiUtils.getUserSession(session); - - SharingResponse sharingResponse = new SharingResponse(); - sharingResponse.setOwner(userSession.getUserId()); - Integer groupOwner = metadata.getSourceInfo().getGroupOwner(); - if (groupOwner != null) { - sharingResponse.setGroupOwner(String.valueOf(groupOwner)); - } - - //--- retrieve groups operations - Set userGroups = accessManager.getUserGroups( - userSession, - context.getIpAddress(), // TODO: Use the request - false); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, context); + ApplicationContext appContext = ApplicationContextHolder.get(); - List elGroup = groupRepository.findAll(); - List allOperations = operationRepository.findAll(); + UserSession userSession = ApiUtils.getUserSession(session); - List groupPrivileges = new ArrayList<>(elGroup.size()); - if (elGroup != null) { - for (Group g : elGroup) { - GroupPrivilege groupPrivilege = new GroupPrivilege(); - groupPrivilege.setGroup(g.getId()); - groupPrivilege.setReserved(g.isReserved()); - // TODO: Restrict to user group only in response depending on settings? - groupPrivilege.setUserGroup(userGroups.contains(g.getId())); + SharingResponse sharingResponse = new SharingResponse(); + sharingResponse.setOwner(userSession.getUserId()); + Integer groupOwner = metadata.getSourceInfo().getGroupOwner(); + if (groupOwner != null) { + sharingResponse.setGroupOwner(String.valueOf(groupOwner)); + } - // TODO: Collecting all those info is probably a bit slow when having lots of groups - final Specification hasGroupId = UserGroupSpecs.hasGroupId(g.getId()); - final Specification hasUserId = UserGroupSpecs.hasUserId(userSession.getUserIdAsInt()); - final Specification hasUserIdAndGroupId = where(hasGroupId).and(hasUserId); - List userGroupEntities = userGroupRepository.findAll(hasUserIdAndGroupId); - List userGroupProfile = new ArrayList<>(); - for (UserGroup ug : userGroupEntities) { - userGroupProfile.add(ug.getProfile()); - } - groupPrivilege.setUserProfile(userGroupProfile); + //--- retrieve groups operations + Set userGroups = accessManager.getUserGroups( + userSession, + context.getIpAddress(), // TODO: Use the request + false); + + List elGroup = groupRepository.findAll(); + List allOperations = operationRepository.findAll(); + + List groupPrivileges = new ArrayList<>(elGroup.size()); + if (elGroup != null) { + for (Group g : elGroup) { + GroupPrivilege groupPrivilege = new GroupPrivilege(); + groupPrivilege.setGroup(g.getId()); + groupPrivilege.setReserved(g.isReserved()); + // TODO: Restrict to user group only in response depending on settings? + groupPrivilege.setUserGroup(userGroups.contains(g.getId())); + + // TODO: Collecting all those info is probably a bit slow when having lots of groups + final Specification hasGroupId = UserGroupSpecs.hasGroupId(g.getId()); + final Specification hasUserId = UserGroupSpecs.hasUserId(userSession.getUserIdAsInt()); + final Specification hasUserIdAndGroupId = where(hasGroupId).and(hasUserId); + List userGroupEntities = userGroupRepository.findAll(hasUserIdAndGroupId); + List userGroupProfile = new ArrayList<>(); + for (UserGroup ug : userGroupEntities) { + userGroupProfile.add(ug.getProfile()); + } + groupPrivilege.setUserProfile(userGroupProfile); - //--- get all operations that this group can do on given metadata - Specification hasGroupIdAndMetadataId = - where(hasGroupId(g.getId())) - .and(hasMetadataId(metadata.getId())); - List operationAllowedForGroup = - operationAllowedRepository.findAll(hasGroupIdAndMetadataId); + //--- get all operations that this group can do on given metadata + Specification hasGroupIdAndMetadataId = + where(hasGroupId(g.getId())) + .and(hasMetadataId(metadata.getId())); + List operationAllowedForGroup = + operationAllowedRepository.findAll(hasGroupIdAndMetadataId); - Map operations = new HashMap<>(allOperations.size()); - for (Operation o : allOperations) { + Map operations = new HashMap<>(allOperations.size()); + for (Operation o : allOperations) { - boolean operationSetForGroup = false; - for (OperationAllowed operationAllowed : operationAllowedForGroup) { - if (o.getId() == operationAllowed.getId().getOperationId()) { - operationSetForGroup = true; - break; + boolean operationSetForGroup = false; + for (OperationAllowed operationAllowed : operationAllowedForGroup) { + if (o.getId() == operationAllowed.getId().getOperationId()) { + operationSetForGroup = true; + break; + } } + operations.put(o.getName(), operationSetForGroup); } - operations.put(o.getName(), operationSetForGroup); + groupPrivilege.setOperations(operations); + groupPrivileges.add(groupPrivilege); } - groupPrivilege.setOperations(operations); - groupPrivileges.add(groupPrivilege); } + sharingResponse.setPrivileges(groupPrivileges); + return sharingResponse; } - sharingResponse.setPrivileges(groupPrivileges); - return sharingResponse; } @io.swagger.v3.oas.annotations.Operation( @@ -599,29 +602,34 @@ public void setRecordGroup( HttpServletRequest request ) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ApplicationContext appContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); - - Group group = groupRepository.findById(groupIdentifier).get(); - if (group == null) { - throw new ResourceNotFoundException(String.format( - "Group with identifier '%s' not found.", groupIdentifier - )); - } + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + ApplicationContext appContext = ApplicationContextHolder.get(); + + Group group = groupRepository.findById(groupIdentifier).get(); + if (group == null) { + throw new ResourceNotFoundException(String.format( + "Group with identifier '%s' not found.", groupIdentifier + )); + } - Integer previousGroup = metadata.getSourceInfo().getGroupOwner(); - Group oldGroup = null; - if (previousGroup != null) { - oldGroup = groupRepository.findById(previousGroup).get(); - } + Integer previousGroup = metadata.getSourceInfo().getGroupOwner(); + Group oldGroup = null; + if (previousGroup != null) { + oldGroup = groupRepository.findById(previousGroup).get(); + } - metadata.getSourceInfo().setGroupOwner(groupIdentifier); - metadataManager.save(metadata); - dataManager.indexMetadata(String.valueOf(metadata.getId()), true); + metadata.getSourceInfo().setGroupOwner(groupIdentifier); + metadataManager.save(metadata); + dataManager.indexMetadata(String.valueOf(metadata.getId()), true); - new RecordGroupOwnerChangeEvent(metadata.getId(), ApiUtils.getUserSession(request.getSession()).getUserIdAsInt(), ObjectJSONUtils.convertObjectInJsonObject(oldGroup, RecordGroupOwnerChangeEvent.FIELD), ObjectJSONUtils.convertObjectInJsonObject(group, RecordGroupOwnerChangeEvent.FIELD)).publish(appContext); - } + new RecordGroupOwnerChangeEvent(metadata.getId(), + ApiUtils.getUserSession(request.getSession()).getUserIdAsInt(), + ObjectJSONUtils.convertObjectInJsonObject(oldGroup, RecordGroupOwnerChangeEvent.FIELD), + ObjectJSONUtils.convertObjectInJsonObject(group, RecordGroupOwnerChangeEvent.FIELD) + ).publish(appContext); + } + } @io.swagger.v3.oas.annotations.Operation( summary = "Get record sharing settings", @@ -646,38 +654,38 @@ public SharingResponse getSharingSettings( HttpServletRequest request ) throws Exception { - ApplicationContext appContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); - UserSession userSession = ApiUtils.getUserSession(session); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + UserSession userSession = ApiUtils.getUserSession(session); - SharingResponse sharingResponse = new SharingResponse(); - sharingResponse.setOwner(userSession.getUserId()); + SharingResponse sharingResponse = new SharingResponse(); + sharingResponse.setOwner(userSession.getUserId()); - List allOperations = operationRepository.findAll(); + List allOperations = operationRepository.findAll(); - //--- retrieve groups operations - Set userGroups = accessManager.getUserGroups( - context.getUserSession(), - context.getIpAddress(), false); + //--- retrieve groups operations + Set userGroups = accessManager.getUserGroups( + context.getUserSession(), + context.getIpAddress(), false); - List elGroup = groupRepository.findAll(); - List groupPrivileges = new ArrayList<>(elGroup.size()); + List elGroup = groupRepository.findAll(); + List groupPrivileges = new ArrayList<>(elGroup.size()); - for (Group g : elGroup) { - GroupPrivilege groupPrivilege = new GroupPrivilege(); - groupPrivilege.setGroup(g.getId()); - groupPrivilege.setReserved(g.isReserved()); - groupPrivilege.setUserGroup(userGroups.contains(g.getId())); + for (Group g : elGroup) { + GroupPrivilege groupPrivilege = new GroupPrivilege(); + groupPrivilege.setGroup(g.getId()); + groupPrivilege.setReserved(g.isReserved()); + groupPrivilege.setUserGroup(userGroups.contains(g.getId())); - Map operations = new HashMap<>(allOperations.size()); - for (Operation o : allOperations) { - operations.put(o.getName(), false); + Map operations = new HashMap<>(allOperations.size()); + for (Operation o : allOperations) { + operations.put(o.getName(), false); + } + groupPrivilege.setOperations(operations); + groupPrivileges.add(groupPrivilege); } - groupPrivilege.setOperations(operations); - groupPrivileges.add(groupPrivilege); + sharingResponse.setPrivileges(groupPrivileges); + return sharingResponse; } - sharingResponse.setPrivileges(groupPrivileges); - return sharingResponse; } @io.swagger.v3.oas.annotations.Operation( @@ -732,14 +740,10 @@ MetadataProcessingReport setGroupAndOwner( throws Exception { MetadataProcessingReport report = new SimpleMetadataProcessingReport(); - try { + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, ApiUtils.getUserSession(session)); report.setTotalRecords(records.size()); - final ApplicationContext context = ApplicationContextHolder.get(); - - ServiceContext serviceContext = ApiUtils.createServiceContext(request); - List listOfUpdatedRecords = new ArrayList<>(); for (String uuid : records) { updateOwnership(groupIdentifier, userIdentifier, @@ -804,13 +808,11 @@ MetadataProcessingReport setRecordOwnership( throws Exception { MetadataProcessingReport report = new SimpleMetadataProcessingReport(); - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - try { - report.setTotalRecords(1); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, serviceContext); - final ApplicationContext context = ApplicationContextHolder.get(); + report.setTotalRecords(1); - ServiceContext serviceContext = ApiUtils.createServiceContext(request); List listOfUpdatedRecords = new ArrayList<>(); updateOwnership(groupIdentifier, userIdentifier, report, dataManager, accessManager, metadataRepository, @@ -960,40 +962,40 @@ private void checkCanPublishToAllGroup(ServiceContext context, DataManager dm, A */ private void shareMetadataWithAllGroup(String metadataUuid, boolean publish, HttpSession session, HttpServletRequest request) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ApplicationContext appContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + ApplicationContext appContext = ApplicationContextHolder.get(); + //--- in case of owner, privileges for groups 0,1 and GUEST are disabled + //--- and are not sent to the server. So we cannot remove them + UserSession us = ApiUtils.getUserSession(session); + boolean isAdmin = Profile.Administrator == us.getProfile(); + boolean isMdGroupReviewer = accessManager.getReviewerGroups(us).contains(metadata.getSourceInfo().getGroupOwner()); + boolean isReviewOperationAllowedOnMdForUser = accessManager.hasReviewPermission(context, Integer.toString(metadata.getId())); + boolean isPublishForbiden = !isMdGroupReviewer && !isAdmin && !isReviewOperationAllowedOnMdForUser; + if (isPublishForbiden) { - //--- in case of owner, privileges for groups 0,1 and GUEST are disabled - //--- and are not sent to the server. So we cannot remove them - UserSession us = ApiUtils.getUserSession(session); - boolean isAdmin = Profile.Administrator == us.getProfile(); - boolean isMdGroupReviewer = accessManager.getReviewerGroups(us).contains(metadata.getSourceInfo().getGroupOwner()); - boolean isReviewOperationAllowedOnMdForUser = accessManager.hasReviewPermission(context, Integer.toString(metadata.getId())); - boolean isPublishForbiden = !isMdGroupReviewer && !isAdmin && !isReviewOperationAllowedOnMdForUser; - if (isPublishForbiden) { - - throw new Exception(String.format("User not allowed to publish the metadata %s. You need to be administrator, or reviewer of the metadata group or reviewer with edit privilege on the metadata.", + throw new Exception(String.format("User not allowed to publish the metadata %s. You need to be administrator, or reviewer of the metadata group or reviewer with edit privilege on the metadata.", metadataUuid)); - } + } - DataManager dataManager = appContext.getBean(DataManager.class); + DataManager dataManager = appContext.getBean(DataManager.class); - OperationRepository operationRepository = appContext.getBean(OperationRepository.class); - List operationList = operationRepository.findAll(); - Map operationMap = new HashMap<>(operationList.size()); - for (Operation o : operationList) { - operationMap.put(o.getName(), o.getId()); - } + OperationRepository operationRepository = appContext.getBean(OperationRepository.class); + List operationList = operationRepository.findAll(); + Map operationMap = new HashMap<>(operationList.size()); + for (Operation o : operationList) { + operationMap.put(o.getName(), o.getId()); + } - SharingParameter sharing = buildSharingForPublicationConfig(publish); + SharingParameter sharing = buildSharingForPublicationConfig(publish); - List privileges = sharing.getPrivileges(); - setOperations(sharing, dataManager, context, appContext, metadata, operationMap, privileges, - ApiUtils.getUserSession(session).getUserIdAsInt(), true,null, request); - dataManager.indexMetadata(String.valueOf(metadata.getId()), true); + List privileges = sharing.getPrivileges(); + setOperations(sharing, dataManager, context, appContext, metadata, operationMap, privileges, + ApiUtils.getUserSession(session).getUserIdAsInt(), true,null, request); + dataManager.indexMetadata(String.valueOf(metadata.getId()), true); + } } @@ -1013,7 +1015,7 @@ private MetadataProcessingReport shareSelection(String[] uuids, String bucket, S MetadataProcessingReport report = new SimpleMetadataProcessingReport(); - try { + try (ServiceContext context = ApiUtils.createServiceContext(request)) { Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, ApiUtils.getUserSession(session)); report.setTotalRecords(records.size()); @@ -1025,15 +1027,13 @@ private MetadataProcessingReport shareSelection(String[] uuids, String bucket, S UserSession us = ApiUtils.getUserSession(session); boolean isAdmin = Profile.Administrator == us.getProfile(); - ServiceContext context = ApiUtils.createServiceContext(request); - List listOfUpdatedRecords = new ArrayList<>(); for (String uuid : records) { AbstractMetadata metadata = metadataRepository.findOneByUuid(uuid); if (metadata == null) { report.incrementNullRecords(); } else if (!accessMan.canEdit( - ApiUtils.createServiceContext(request), String.valueOf(metadata.getId()))) { + context, String.valueOf(metadata.getId()))) { report.addNotEditableMetadataId(metadata.getId()); } else { boolean skipAllReservedGroup = false; diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataSocialApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataSocialApi.java index 364c3c9b8bb4..540451c8ea1b 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataSocialApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataSocialApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -112,41 +112,42 @@ Integer rateRecord( HttpServletRequest request ) throws Exception { - AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, request); - ApplicationContext appContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, context); + ApplicationContext appContext = ApplicationContextHolder.get(); - String ip = context.getIpAddress(); - if (ip == null) { - ip = "???.???.???.???"; - } + String ip = context.getIpAddress(); + if (ip == null) { + ip = "???.???.???.???"; + } - if (rating < 0 || rating > 5) { - throw new BadParameterEx(String.format( - "Parameter rating MUST be between 1 and 5. Value %s is invalid."), rating); - } + if (rating < 0 || rating > 5) { + throw new BadParameterEx(String.format( + "Parameter rating MUST be between 1 and 5. Value %s is invalid."), rating); + } + + String harvUuid = metadata.getHarvestInfo().getUuid(); + + // look up value of localrating/enable + DataManager dataManager = appContext.getBean(DataManager.class); + HarvestManager hm = appContext.getBean(HarvestManager.class); + SettingManager settingManager = appContext.getBean(SettingManager.class); + String localRating = settingManager.getValue(SYSTEM_LOCALRATING_ENABLE); - String harvUuid = metadata.getHarvestInfo().getUuid(); - - // look up value of localrating/enable - DataManager dataManager = appContext.getBean(DataManager.class); - HarvestManager hm = appContext.getBean(HarvestManager.class); - SettingManager settingManager = appContext.getBean(SettingManager.class); - String localRating = settingManager.getValue(SYSTEM_LOCALRATING_ENABLE); - - if (localRating.equals(RatingsSetting.BASIC) || harvUuid == null) { - //--- metadata is local, just rate it - rating = dataManager.rateMetadata(metadata.getId(), ip, rating); - } else { - //--- the metadata is harvested, is type=geonetwork? - AbstractHarvester ah = hm.getHarvester(harvUuid); - if (ah.getType().equals(GeonetHarvester.TYPE)) { - rating = setRemoteRating(context, (GeonetParams) ah.getParams(), metadataUuid, rating); + if (localRating.equals(RatingsSetting.BASIC) || harvUuid == null) { + //--- metadata is local, just rate it + rating = dataManager.rateMetadata(metadata.getId(), ip, rating); } else { - rating = -1; + //--- the metadata is harvested, is type=geonetwork? + AbstractHarvester ah = hm.getHarvester(harvUuid); + if (ah.getType().equals(GeonetHarvester.TYPE)) { + rating = setRemoteRating(context, (GeonetParams) ah.getParams(), metadataUuid, rating); + } else { + rating = -1; + } } + return rating; } - return rating; } /** diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataTagApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataTagApi.java index bcf51b1378fd..e48ade532c62 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataTagApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataTagApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -28,6 +28,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.tags.Tag; import jeeves.server.UserSession; +import jeeves.server.context.ServiceContext; import jeeves.services.ReadWriteController; import org.fao.geonet.ApplicationContextHolder; import org.fao.geonet.api.API; @@ -105,8 +106,10 @@ public Set getRecordTags( String metadataUuid, HttpServletRequest request ) throws Exception { - AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, request); - return metadata.getCategories(); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, context); + return metadata.getCategories(); + } } @@ -146,35 +149,40 @@ public void tagRecord( boolean clear, HttpServletRequest request ) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ApplicationContext appContext = ApplicationContextHolder.get(); - Set before = metadata.getCategories(); - - if (clear) { - metadataManager.update( - metadata.getId(), entity -> entity.getCategories().clear()); - } - - for (int c : id) { - final MetadataCategory category = categoryRepository.findById(c).get(); - if (category != null) { - dataManager.setCategory( - ApiUtils.createServiceContext(request), - String.valueOf(metadata.getId()), String.valueOf(c)); - } else { - throw new ResourceNotFoundException(String.format( - "Can't assign non existing category with id '%d' to record '%s'", - c, metadataUuid)); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + ApplicationContext appContext = ApplicationContextHolder.get(); + Set before = metadata.getCategories(); + + if (clear) { + metadataManager.update( + metadata.getId(), entity -> entity.getCategories().clear()); } - } - dataManager.indexMetadata(String.valueOf(metadata.getId()), true); + for (int c : id) { + final MetadataCategory category = categoryRepository.findById(c).get(); + if (category != null) { + dataManager.setCategory( + ApiUtils.createServiceContext(request), + String.valueOf(metadata.getId()), String.valueOf(c)); + } else { + throw new ResourceNotFoundException(String.format( + "Can't assign non existing category with id '%d' to record '%s'", + c, metadataUuid)); + } + } - metadata = ApiUtils.canEditRecord(metadataUuid, request); - Set after = metadata.getCategories(); - UserSession userSession = ApiUtils.getUserSession(request.getSession()); - new RecordCategoryChangeEvent(metadata.getId(), userSession.getUserIdAsInt(), ObjectJSONUtils.convertObjectInJsonObject(before, RecordCategoryChangeEvent.FIELD), ObjectJSONUtils.convertObjectInJsonObject(after, RecordCategoryChangeEvent.FIELD)).publish(appContext); + dataManager.indexMetadata(String.valueOf(metadata.getId()), true); + metadata = ApiUtils.canEditRecord(metadataUuid, context); + Set after = metadata.getCategories(); + UserSession userSession = ApiUtils.getUserSession(request.getSession()); + new RecordCategoryChangeEvent(metadata.getId(), + userSession.getUserIdAsInt(), + ObjectJSONUtils.convertObjectInJsonObject(before, RecordCategoryChangeEvent.FIELD), + ObjectJSONUtils.convertObjectInJsonObject(after, RecordCategoryChangeEvent.FIELD) + ).publish(appContext); + } } @io.swagger.v3.oas.annotations.Operation( @@ -204,30 +212,35 @@ public void deleteTags( Integer[] id, HttpServletRequest request ) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ApplicationContext appContext = ApplicationContextHolder.get(); - Set before = metadata.getCategories(); - - if (id == null || id.length == 0) { - metadataManager.update( - metadata.getId(), entity -> entity.getCategories().clear()); - } - - if (id != null) { - for (int c : id) { - dataManager.unsetCategory( - ApiUtils.createServiceContext(request), - String.valueOf(metadata.getId()), c); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + ApplicationContext appContext = ApplicationContextHolder.get(); + Set before = metadata.getCategories(); + + if (id == null || id.length == 0) { + metadataManager.update( + metadata.getId(), entity -> entity.getCategories().clear()); } - } - dataManager.indexMetadata(String.valueOf(metadata.getId()), true); + if (id != null) { + for (int c : id) { + dataManager.unsetCategory( + context, + String.valueOf(metadata.getId()), c); + } + } - metadata = ApiUtils.canEditRecord(metadataUuid, request); - Set after = metadata.getCategories(); - UserSession userSession = ApiUtils.getUserSession(request.getSession()); - new RecordCategoryChangeEvent(metadata.getId(), userSession.getUserIdAsInt(), ObjectJSONUtils.convertObjectInJsonObject(before, RecordCategoryChangeEvent.FIELD), ObjectJSONUtils.convertObjectInJsonObject(after, RecordCategoryChangeEvent.FIELD)).publish(appContext); + dataManager.indexMetadata(String.valueOf(metadata.getId()), true); + metadata = ApiUtils.canEditRecord(metadataUuid, context); + Set after = metadata.getCategories(); + UserSession userSession = ApiUtils.getUserSession(request.getSession()); + new RecordCategoryChangeEvent(metadata.getId(), + userSession.getUserIdAsInt(), + ObjectJSONUtils.convertObjectInJsonObject(before, RecordCategoryChangeEvent.FIELD), + ObjectJSONUtils.convertObjectInJsonObject(after, RecordCategoryChangeEvent.FIELD) + ).publish(appContext); + } } @@ -286,7 +299,7 @@ public MetadataProcessingReport tagRecords( ) throws Exception { MetadataProcessingReport report = new SimpleMetadataProcessingReport(); - try { + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, ApiUtils.getUserSession(session)); report.setTotalRecords(records.size()); @@ -301,8 +314,7 @@ public MetadataProcessingReport tagRecords( Set before = info.getCategories(); if (info == null) { report.incrementNullRecords(); - } else if (!accessMan.canEdit( - ApiUtils.createServiceContext(request), String.valueOf(info.getId()))) { + } else if (!accessMan.canEdit(serviceContext, String.valueOf(info.getId()))) { report.addNotEditableMetadataId(info.getId()); } else { if (clear) { @@ -397,7 +409,7 @@ public MetadataProcessingReport deleteTagForRecords( ) throws Exception { MetadataProcessingReport report = new SimpleMetadataProcessingReport(); - try { + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)){ Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, ApiUtils.getUserSession(session)); report.setTotalRecords(records.size()); @@ -412,8 +424,7 @@ public MetadataProcessingReport deleteTagForRecords( Set before = info.getCategories(); if (info == null) { report.incrementNullRecords(); - } else if (!accessMan.canEdit( - ApiUtils.createServiceContext(request), String.valueOf(info.getId()))) { + } else if (!accessMan.canEdit(serviceContext, String.valueOf(info.getId()))) { report.addNotEditableMetadataId(info.getId()); } else { info.getCategories().clear(); diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataValidateApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataValidateApi.java index 0e98aa228664..e9b9aee1294e 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataValidateApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataValidateApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -163,115 +163,117 @@ Reports validateRecord( @Parameter(description = API_PARAM_RECORD_UUID, required = true) @PathVariable String metadataUuid, @Parameter(description = "Validation status. Should be provided only in case of SUBTEMPLATE validation. If provided for another type, throw a BadParameter Exception", required = false) @RequestParam(required = false) Boolean isvalid, HttpServletRequest request, @Parameter(hidden = true) HttpSession session) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ApplicationContext appContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); - DataManager dataManager = appContext.getBean(DataManager.class); - String id = String.valueOf(metadata.getId()); - String schemaName = dataManager.getMetadataSchema(id); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + ApplicationContext appContext = ApplicationContextHolder.get(); + DataManager dataManager = appContext.getBean(DataManager.class); - Locale locale = languageUtils.parseAcceptLanguage(request.getLocales()); + String id = String.valueOf(metadata.getId()); + String schemaName = dataManager.getMetadataSchema(id); - boolean isSubtemplate = metadata.getDataInfo().getType() == MetadataType.SUB_TEMPLATE; - boolean validSet = (isvalid != null); - if (!isSubtemplate && validSet) { - throw new BadParameterEx( - "Parameter isvalid can't be set if it is not a Subtemplate. You cannot force validation of a metadata or a template."); - } - if (isSubtemplate && !validSet) { - throw new BadParameterEx("Parameter isvalid MUST be set for subtemplate."); - } - if (isSubtemplate) { - MetadataValidation metadataValidation = new MetadataValidation() - .setId(new MetadataValidationId(metadata.getId(), "subtemplate")) - .setStatus(isvalid ? MetadataValidationStatus.VALID : MetadataValidationStatus.INVALID) - .setRequired(true).setNumTests(0).setNumFailures(0); - this.metadataValidationRepository.save(metadataValidation); - dataManager.indexMetadata(("" + metadata.getId()), true); - new RecordValidationTriggeredEvent(metadata.getId(), - ApiUtils.getUserSession(request.getSession()).getUserIdAsInt(), - metadataValidation.getStatus().getCode()).publish(appContext); - return new Reports(); - } + Locale locale = languageUtils.parseAcceptLanguage(request.getLocales()); - // --- validate metadata from session - Element errorReport; - try { - errorReport = new AjaxEditUtils(context).validateMetadataEmbedded(ApiUtils.getUserSession(session), id, - locale.getISO3Language()); - } catch (NullPointerException e) { - // TODO: Improve NPE catching exception - throw new BadParameterEx(String.format("To validate a record, the record MUST be in edition."), - metadataUuid); - } + boolean isSubtemplate = metadata.getDataInfo().getType() == MetadataType.SUB_TEMPLATE; + boolean validSet = (isvalid != null); + if (!isSubtemplate && validSet) { + throw new BadParameterEx( + "Parameter isvalid can't be set if it is not a Subtemplate. You cannot force validation of a metadata or a template."); + } + if (isSubtemplate && !validSet) { + throw new BadParameterEx("Parameter isvalid MUST be set for subtemplate."); + } + if (isSubtemplate) { + MetadataValidation metadataValidation = new MetadataValidation() + .setId(new MetadataValidationId(metadata.getId(), "subtemplate")) + .setStatus(isvalid ? MetadataValidationStatus.VALID : MetadataValidationStatus.INVALID) + .setRequired(true).setNumTests(0).setNumFailures(0); + this.metadataValidationRepository.save(metadataValidation); + dataManager.indexMetadata(("" + metadata.getId()), true); + new RecordValidationTriggeredEvent(metadata.getId(), + ApiUtils.getUserSession(request.getSession()).getUserIdAsInt(), + metadataValidation.getStatus().getCode()).publish(appContext); + return new Reports(); + } + + // --- validate metadata from session + Element errorReport; + try { + errorReport = new AjaxEditUtils(context).validateMetadataEmbedded(ApiUtils.getUserSession(session), id, + locale.getISO3Language()); + } catch (NullPointerException e) { + // TODO: Improve NPE catching exception + throw new BadParameterEx(String.format("To validate a record, the record MUST be in edition."), + metadataUuid); + } - restructureReportToHavePatternRuleHierarchy(errorReport); + restructureReportToHavePatternRuleHierarchy(errorReport); - // --- update element and return status - Element elResp = new Element("root"); - elResp.addContent(new Element(Geonet.Elem.ID).setText(id)); - elResp.addContent(new Element("language").setText(locale.getISO3Language())); - elResp.addContent(new Element("schema").setText(dataManager.getMetadataSchema(id))); - elResp.addContent(errorReport); - Element schematronTranslations = new Element("schematronTranslations"); + // --- update element and return status + Element elResp = new Element("root"); + elResp.addContent(new Element(Geonet.Elem.ID).setText(id)); + elResp.addContent(new Element("language").setText(locale.getISO3Language())); + elResp.addContent(new Element("schema").setText(dataManager.getMetadataSchema(id))); + elResp.addContent(errorReport); + Element schematronTranslations = new Element("schematronTranslations"); - final SchematronRepository schematronRepository = context.getBean(SchematronRepository.class); - // --- add translations for schematrons - final List schematrons = schematronRepository.findAllBySchemaName(schemaName); + final SchematronRepository schematronRepository = context.getBean(SchematronRepository.class); + // --- add translations for schematrons + final List schematrons = schematronRepository.findAllBySchemaName(schemaName); - MetadataSchema metadataSchema = dataManager.getSchema(schemaName); - Path schemaDir = metadataSchema.getSchemaDir(); - SAXBuilder builder = new SAXBuilder(); + MetadataSchema metadataSchema = dataManager.getSchema(schemaName); + Path schemaDir = metadataSchema.getSchemaDir(); + SAXBuilder builder = new SAXBuilder(); - for (Schematron schematron : schematrons) { - // it contains absolute path to the xsl file - String rule = schematron.getRuleName(); + for (Schematron schematron : schematrons) { + // it contains absolute path to the xsl file + String rule = schematron.getRuleName(); - Path file = schemaDir.resolve("loc").resolve(locale.getISO3Language()).resolve(rule + ".xml"); + Path file = schemaDir.resolve("loc").resolve(locale.getISO3Language()).resolve(rule + ".xml"); - Document document; - if (Files.isRegularFile(file)) { - try (InputStream in = IO.newInputStream(file)) { - document = builder.build(in); - } - Element element = document.getRootElement(); + Document document; + if (Files.isRegularFile(file)) { + try (InputStream in = IO.newInputStream(file)) { + document = builder.build(in); + } + Element element = document.getRootElement(); - Element s = new Element(rule); - element.detach(); - s.addContent(element); - schematronTranslations.addContent(s); + Element s = new Element(rule); + element.detach(); + s.addContent(element); + schematronTranslations.addContent(s); + } } - } - elResp.addContent(schematronTranslations); + elResp.addContent(schematronTranslations); - // TODO: Avoid XSL - GeonetworkDataDirectory dataDirectory = context.getBean(GeonetworkDataDirectory.class); - Path validateXsl = dataDirectory.getWebappDir().resolve("xslt/services/metadata/validate.xsl"); - Map params = new HashMap<>(); - params.put("rootTag", "reports"); - List elementList = getSchemaLocalization(metadata.getDataInfo().getSchemaId(), - locale.getISO3Language()); - for (Element e : elementList) { - elResp.addContent(e); - } - final Element transform = Xml.transform(elResp, validateXsl, params); + // TODO: Avoid XSL + GeonetworkDataDirectory dataDirectory = context.getBean(GeonetworkDataDirectory.class); + Path validateXsl = dataDirectory.getWebappDir().resolve("xslt/services/metadata/validate.xsl"); + Map params = new HashMap<>(); + params.put("rootTag", "reports"); + List elementList = getSchemaLocalization(metadata.getDataInfo().getSchemaId(), + locale.getISO3Language()); + for (Element e : elementList) { + elResp.addContent(e); + } + final Element transform = Xml.transform(elResp, validateXsl, params); - Reports response = (Reports) Xml.unmarshall(transform, Reports.class); + Reports response = (Reports) Xml.unmarshall(transform, Reports.class); - List reports = response.getReport(); + List reports = response.getReport(); - if (reports != null) { - int value = 1; - for (Report report : reports) { - if (!report.getSuccess().equals(report.getTotal())) { - value = 0; + if (reports != null) { + int value = 1; + for (Report report : reports) { + if (!report.getSuccess().equals(report.getTotal())) { + value = 0; + } } + new RecordValidationTriggeredEvent(metadata.getId(), + ApiUtils.getUserSession(request.getSession()).getUserIdAsInt(), Integer.toString(value)) + .publish(appContext); } - new RecordValidationTriggeredEvent(metadata.getId(), - ApiUtils.getUserSession(request.getSession()).getUserIdAsInt(), Integer.toString(value)) - .publish(appContext); + return response; } - return response; } } diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataVersionningApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataVersionningApi.java index 5d9442630dd0..f27779767df4 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataVersionningApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataVersionningApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -25,6 +25,7 @@ import io.swagger.v3.oas.annotations.Parameter; import io.swagger.v3.oas.annotations.tags.Tag; +import jeeves.server.context.ServiceContext; import jeeves.services.ReadWriteController; import org.fao.geonet.api.API; import org.fao.geonet.api.ApiParams; @@ -85,12 +86,14 @@ public ResponseEntity enableVersionControl( String metadataUuid, HttpServletRequest request ) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); - dataManager.versionMetadata(ApiUtils.createServiceContext(request), - String.valueOf(metadata.getId()), metadata.getXmlData(false)); + dataManager.versionMetadata(ApiUtils.createServiceContext(request), + String.valueOf(metadata.getId()), metadata.getXmlData(false)); - return new ResponseEntity(HttpStatus.CREATED); + return new ResponseEntity(HttpStatus.CREATED); + } } @@ -124,7 +127,7 @@ public MetadataProcessingReport enableVersionControlForRecords( ) throws Exception { MetadataProcessingReport report = new SimpleMetadataProcessingReport(); - try { + try (ServiceContext context = ApiUtils.createServiceContext(request)) { Set records = ApiUtils.getUuidsParameterOrSelection(uuids, bucket, ApiUtils.getUserSession(session)); report.setTotalRecords(records.size()); @@ -133,11 +136,10 @@ public MetadataProcessingReport enableVersionControlForRecords( report.incrementNullRecords(); } else { for (AbstractMetadata metadata : metadataRepository.findAllByUuid(uuid)) { - if (!accessMan.canEdit( - ApiUtils.createServiceContext(request), String.valueOf(metadata.getId()))) { + if (!accessMan.canEdit(context, String.valueOf(metadata.getId()))) { report.addNotEditableMetadataId(metadata.getId()); } else { - dataManager.versionMetadata(ApiUtils.createServiceContext(request), + dataManager.versionMetadata(context, String.valueOf(metadata.getId()), metadata.getXmlData(false)); report.incrementProcessedRecords(); } diff --git a/services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java b/services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java index 9ae704630005..ef196adba45e 100644 --- a/services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/MetadataWorkflowApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -155,19 +155,20 @@ public List getRecordStatusHistory( @RequestParam(required = false) boolean details, @Parameter(description = "Sort direction", required = false) @RequestParam(defaultValue = "DESC") Sort.Direction sortOrder, HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, context); - String sortField = SortUtils.createPath(MetadataStatus_.changeDate); + String sortField = SortUtils.createPath(MetadataStatus_.changeDate); - List listOfStatus = metadataStatusRepository.findAllByMetadataId(metadata.getId(), - Sort.by(sortOrder, sortField)); + List listOfStatus = metadataStatusRepository.findAllByMetadataId(metadata.getId(), + Sort.by(sortOrder, sortField)); - List response = buildMetadataStatusResponses(listOfStatus, details, - context.getLanguage()); + List response = buildMetadataStatusResponses(listOfStatus, details, + context.getLanguage()); - // TODO: Add paging - return response; + // TODO: Add paging + return response; + } } @io.swagger.v3.oas.annotations.Operation(summary = "Get record status history by type", description = "") @@ -180,19 +181,20 @@ public List getRecordStatusHistoryByType( @RequestParam(required = false) boolean details, @Parameter(description = "Sort direction", required = false) @RequestParam(defaultValue = "DESC") Sort.Direction sortOrder, HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, context); - String sortField = SortUtils.createPath(MetadataStatus_.changeDate); + String sortField = SortUtils.createPath(MetadataStatus_.changeDate); - List listOfStatus = metadataStatusRepository.findAllByMetadataIdAndByType(metadata.getId(), type, - Sort.by(sortOrder, sortField)); + List listOfStatus = metadataStatusRepository.findAllByMetadataIdAndByType(metadata.getId(), type, + Sort.by(sortOrder, sortField)); - List response = buildMetadataStatusResponses(listOfStatus, details, - context.getLanguage()); + List response = buildMetadataStatusResponses(listOfStatus, details, + context.getLanguage()); - // TODO: Add paging - return response; + // TODO: Add paging + return response; + } } @io.swagger.v3.oas.annotations.Operation(summary = "Get last workflow status for a record", description = "") @@ -206,34 +208,34 @@ public List getRecordStatusHistoryByType( public MetadataWorkflowStatusResponse getStatus( @Parameter(description = API_PARAM_RECORD_UUID, required = true) @PathVariable String metadataUuid, HttpServletRequest request) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ApplicationContext appContext = ApplicationContextHolder.get(); Locale locale = languageUtils.parseAcceptLanguage(request.getLocales()); - ServiceContext context = ApiUtils.createServiceContext(request, locale.getISO3Language()); - - // --- only allow the owner of the record to set its status - if (!accessManager.isOwner(context, String.valueOf(metadata.getId()))) { - throw new SecurityException(String.format( - "Only the owner of the metadata can get the status. User is not the owner of the metadata")); - } + try (ServiceContext context = ApiUtils.createServiceContext(request, locale.getISO3Language())) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + ApplicationContext appContext = ApplicationContextHolder.get(); + + // --- only allow the owner of the record to set its status + if (!accessManager.isOwner(context, String.valueOf(metadata.getId()))) { + throw new SecurityException(String.format( + "Only the owner of the metadata can get the status. User is not the owner of the metadata")); + } - MetadataStatus recordStatus = metadataStatus.getStatus(metadata.getId()); + MetadataStatus recordStatus = metadataStatus.getStatus(metadata.getId()); - List elStatus = statusValueRepository.findAllByType(StatusValueType.workflow); + List elStatus = statusValueRepository.findAllByType(StatusValueType.workflow); - // --- get the list of content reviewers for this metadata record - Set ids = new HashSet(); - ids.add(Integer.valueOf(metadata.getId())); - List> reviewers = userRepository.findAllByGroupOwnerNameAndProfile(ids, Profile.Reviewer); - Collections.sort(reviewers, Comparator.comparing(s -> s.two().getName())); + // --- get the list of content reviewers for this metadata record + Set ids = new HashSet(); + ids.add(Integer.valueOf(metadata.getId())); + List> reviewers = userRepository.findAllByGroupOwnerNameAndProfile(ids, Profile.Reviewer); + Collections.sort(reviewers, Comparator.comparing(s -> s.two().getName())); - List listOfReviewers = new ArrayList<>(); - for (Pair reviewer : reviewers) { - listOfReviewers.add(reviewer.two()); + List listOfReviewers = new ArrayList<>(); + for (Pair reviewer : reviewers) { + listOfReviewers.add(reviewer.two()); + } + return new MetadataWorkflowStatusResponse(recordStatus, listOfReviewers, + accessManager.hasEditPermission(context, metadata.getId() + ""), elStatus); } - return new MetadataWorkflowStatusResponse(recordStatus, listOfReviewers, - accessManager.hasEditPermission(context, metadata.getId() + ""), elStatus); - } @io.swagger.v3.oas.annotations.Operation(summary = "Set the record status", description = "") @@ -246,50 +248,50 @@ public MetadataWorkflowStatusResponse getStatus( public void setStatus(@Parameter(description = API_PARAM_RECORD_UUID, required = true) @PathVariable String metadataUuid, @Parameter(description = "Metadata status", required = true) @RequestBody(required = true) MetadataStatusParameter status, HttpServletRequest request) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ServiceContext context = ApiUtils.createServiceContext(request, - languageUtils.getIso3langCode(request.getLocales())); + try (ServiceContext context = ApiUtils.createServiceContext(request, languageUtils.getIso3langCode(request.getLocales()))) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); - boolean isMdWorkflowEnable = settingManager.getValueAsBool(Settings.METADATA_WORKFLOW_ENABLE); + boolean isMdWorkflowEnable = settingManager.getValueAsBool(Settings.METADATA_WORKFLOW_ENABLE); - int author = context.getUserSession().getUserIdAsInt(); - MetadataStatus metadataStatus = convertParameter(metadata.getId(), metadata.getUuid(), status, author); + int author = context.getUserSession().getUserIdAsInt(); + MetadataStatus metadataStatus = convertParameter(metadata.getId(), metadata.getUuid(), status, author); - if (metadataStatus.getStatusValue().getType() == StatusValueType.workflow - && !isMdWorkflowEnable) { - throw new FeatureNotEnabledException( - "Metadata workflow is disabled, can not be set the status of metadata"); - } + if (metadataStatus.getStatusValue().getType() == StatusValueType.workflow + && !isMdWorkflowEnable) { + throw new FeatureNotEnabledException( + "Metadata workflow is disabled, can not be set the status of metadata"); + } - // --- only allow the owner of the record to set its status - if (!accessManager.isOwner(context, String.valueOf(metadata.getId()))) { - throw new SecurityException(String.format( - "Only the owner of the metadata can set the status of this record. User is not the owner of the metadata.")); - } + // --- only allow the owner of the record to set its status + if (!accessManager.isOwner(context, String.valueOf(metadata.getId()))) { + throw new SecurityException(String.format( + "Only the owner of the metadata can set the status of this record. User is not the owner of the metadata.")); + } - boolean isAllowedSubmitApproveInvalidMd = settingManager - .getValueAsBool(Settings.METADATA_WORKFLOW_ALLOW_SUBMIT_APPROVE_INVALID_MD); - if (((status.getStatus() == Integer.parseInt(StatusValue.Status.SUBMITTED)) - || (status.getStatus() == Integer.parseInt(StatusValue.Status.APPROVED))) - && !isAllowedSubmitApproveInvalidMd) { + boolean isAllowedSubmitApproveInvalidMd = settingManager + .getValueAsBool(Settings.METADATA_WORKFLOW_ALLOW_SUBMIT_APPROVE_INVALID_MD); + if (((status.getStatus() == Integer.parseInt(StatusValue.Status.SUBMITTED)) + || (status.getStatus() == Integer.parseInt(StatusValue.Status.APPROVED))) + && !isAllowedSubmitApproveInvalidMd) { - boolean isInvalid = MetadataUtils.retrieveMetadataValidationStatus(metadata, context); + boolean isInvalid = MetadataUtils.retrieveMetadataValidationStatus(metadata, context); - if (isInvalid) { - throw new Exception("Metadata is invalid: can't be submitted or approved"); + if (isInvalid) { + throw new Exception("Metadata is invalid: can't be submitted or approved"); + } } - } - // --- use StatusActionsFactory and StatusActions class to - // --- change status and carry out behaviours for status changes - StatusActions sa = statusActionFactory.createStatusActions(context); + // --- use StatusActionsFactory and StatusActions class to + // --- change status and carry out behaviours for status changes + StatusActions sa = statusActionFactory.createStatusActions(context); - List listOfStatusChange = new ArrayList<>(1); - listOfStatusChange.add(metadataStatus); - sa.onStatusChange(listOfStatusChange); + List listOfStatusChange = new ArrayList<>(1); + listOfStatusChange.add(metadataStatus); + sa.onStatusChange(listOfStatusChange); - //--- reindex metadata - metadataIndexer.indexMetadata(String.valueOf(metadata.getId()), true); + //--- reindex metadata + metadataIndexer.indexMetadata(String.valueOf(metadata.getId()), true); + } } @io.swagger.v3.oas.annotations.Operation( @@ -424,34 +426,34 @@ public List getWorkflowStatusByType( @RequestParam(required = false, defaultValue = "100") Integer size, HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + PageRequest pageRequest; + if (sortOrder != null) { + Sort sortByStatusChangeDate = SortUtils.createSort(sortOrder, MetadataStatus_.changeDate).and(SortUtils.createSort(sortOrder, MetadataStatus_.id)); + pageRequest = PageRequest.of(from, size, sortByStatusChangeDate); + } else { + // Default sort order + Sort sortByStatusChangeDate = SortUtils.createSort(Sort.Direction.DESC, MetadataStatus_.changeDate).and(SortUtils.createSort(Sort.Direction.DESC, MetadataStatus_.id)); + pageRequest = PageRequest.of(from, size, sortByStatusChangeDate); + } - PageRequest pageRequest; - if (sortOrder != null) { - Sort sortByStatusChangeDate = SortUtils.createSort(sortOrder, MetadataStatus_.changeDate).and(SortUtils.createSort(sortOrder, MetadataStatus_.id)); - pageRequest = PageRequest.of(from, size, sortByStatusChangeDate); - } else { - // Default sort order - Sort sortByStatusChangeDate = SortUtils.createSort(Sort.Direction.DESC, MetadataStatus_.changeDate).and(SortUtils.createSort(Sort.Direction.DESC, MetadataStatus_.id)); - pageRequest = PageRequest.of(from, size, sortByStatusChangeDate); - } + List metadataStatuses; + if (CollectionUtils.isNotEmpty(id) || + CollectionUtils.isNotEmpty(uuid) || + CollectionUtils.isNotEmpty(type) || + CollectionUtils.isNotEmpty(author) || + CollectionUtils.isNotEmpty(owner) || + CollectionUtils.isNotEmpty(record) || + CollectionUtils.isNotEmpty(statusIds)) { + metadataStatuses = metadataStatusRepository.searchStatus( + id, uuid, type, author, owner, record, statusIds, + dateFrom, dateTo, pageRequest); + } else { + metadataStatuses = metadataStatusRepository.findAll(pageRequest).getContent(); + } - List metadataStatuses; - if (CollectionUtils.isNotEmpty(id) || - CollectionUtils.isNotEmpty(uuid) || - CollectionUtils.isNotEmpty(type) || - CollectionUtils.isNotEmpty(author) || - CollectionUtils.isNotEmpty(owner) || - CollectionUtils.isNotEmpty(record) || - CollectionUtils.isNotEmpty(statusIds)) { - metadataStatuses = metadataStatusRepository.searchStatus( - id, uuid, type, author, owner, record, statusIds, - dateFrom, dateTo, pageRequest); - } else { - metadataStatuses = metadataStatusRepository.findAll(pageRequest).getContent(); + return buildMetadataStatusResponses(metadataStatuses, details, context.getLanguage()); } - - return buildMetadataStatusResponses(metadataStatuses, details, context.getLanguage()); } /** @@ -574,67 +576,67 @@ public void restoreAtStatusSave( // Try to get previous state text this will also check to ensure that user is allowed to access the data. String previousStateText = getValidatedStateText(metadataStatus, State.BEFORE, request, httpSession); - // For cases where the records was not deleted, we will attempt to get the metadata record. - // If it remains as null then the record did not exists and this is a recovery. - AbstractMetadata metadata; - try { - metadata = ApiUtils.canEditRecord(metadataStatus.getUuid(), request); - } catch (ResourceNotFoundException e) { - // resource not found so lets set it to null; - metadata = null; - } - - // Begin the recovery Locale locale = languageUtils.parseAcceptLanguage(request.getLocales()); - ServiceContext context = ApiUtils.createServiceContext(request, locale.getISO3Language()); + try (ServiceContext context = ApiUtils.createServiceContext(request, locale.getISO3Language())) { + // For cases where the records was not deleted, we will attempt to get the metadata record. + // If it remains as null then the record did not exists and this is a recovery. + AbstractMetadata metadata; + try { + metadata = ApiUtils.canEditRecord(metadataStatus.getUuid(), context); + } catch (ResourceNotFoundException e) { + // resource not found so lets set it to null; + metadata = null; + } - // If not a recovery from delete then get the before state - Element beforeMetadata = null; - String xmlBefore = null; - if (metadata != null) { - beforeMetadata = dataMan.getMetadata(context, String.valueOf(metadata.getId()), false, false, false); + // Begin the recovery + // If not a recovery from delete then get the before state + Element beforeMetadata = null; + String xmlBefore = null; + if (metadata != null) { + beforeMetadata = dataMan.getMetadata(context, String.valueOf(metadata.getId()), false, false, false); - XMLOutputter outp = new XMLOutputter(); - if (beforeMetadata != null) { - xmlBefore = outp.outputString(beforeMetadata); - } + XMLOutputter outp = new XMLOutputter(); + if (beforeMetadata != null) { + xmlBefore = outp.outputString(beforeMetadata); + } - if (xmlBefore.equals(previousStateText)) { - throw new NotAllowedException("Error recovering metadata id " + metadataUuid + ". Cannot recover record which are identical. Possibly already recovered."); + if (xmlBefore.equals(previousStateText)) { + throw new NotAllowedException("Error recovering metadata id " + metadataUuid + ". Cannot recover record which are identical. Possibly already recovered."); + } } - } - // Now begin the recovery - IMetadataManager iMetadataManager = context.getBean(IMetadataManager.class); - Integer recoveredMetadataId = null; - if (metadata != null) { - Element md = Xml.loadString(previousStateText, false); - Element mdNoGeonetInfo = metadataUtils.removeMetadataInfo(md); + // Now begin the recovery + IMetadataManager iMetadataManager = context.getBean(IMetadataManager.class); + Integer recoveredMetadataId = null; + if (metadata != null) { + Element md = Xml.loadString(previousStateText, false); + Element mdNoGeonetInfo = metadataUtils.removeMetadataInfo(md); - iMetadataManager.updateMetadata(context, String.valueOf(metadata.getId()), mdNoGeonetInfo, false, true, true, context.getLanguage(), + iMetadataManager.updateMetadata(context, String.valueOf(metadata.getId()), mdNoGeonetInfo, false, true, true, context.getLanguage(), null, false); - recoveredMetadataId = metadata.getId(); - } else { - // Recover from delete - Element element = null; - try { - element = Xml.loadString(previousStateText, false); - } catch (JDOMParseException ex) { - throw new IllegalArgumentException( + recoveredMetadataId = metadata.getId(); + } else { + // Recover from delete + Element element = null; + try { + element = Xml.loadString(previousStateText, false); + } catch (JDOMParseException ex) { + throw new IllegalArgumentException( String.format("XML fragment is invalid. Error is %s", ex.getMessage())); + } + recoveredMetadataId = reloadRecord(metadataStatus, element, iMetadataManager, httpSession, request); } - recoveredMetadataId = reloadRecord(metadataStatus, element, iMetadataManager, httpSession, request); - } - dataManager.indexMetadata(String.valueOf(recoveredMetadataId), true); + dataManager.indexMetadata(String.valueOf(recoveredMetadataId), true); - UserSession session = ApiUtils.getUserSession(request.getSession()); - if (session != null) { - // Create a new event - Element afterMetadata = dataMan.getMetadata(context, String.valueOf(recoveredMetadataId), false, false, false); - XMLOutputter outp = new XMLOutputter(); - String xmlAfter = outp.outputString(afterMetadata); - new RecordRestoredEvent(recoveredMetadataId, metadataStatus.getUuid(), session.getUserIdAsInt(), xmlBefore, xmlAfter, metadataStatus).publish(applicationContext); + UserSession session = ApiUtils.getUserSession(request.getSession()); + if (session != null) { + // Create a new event + Element afterMetadata = dataMan.getMetadata(context, String.valueOf(recoveredMetadataId), false, false, false); + XMLOutputter outp = new XMLOutputter(); + String xmlAfter = outp.outputString(afterMetadata); + new RecordRestoredEvent(recoveredMetadataId, metadataStatus.getUuid(), session.getUserIdAsInt(), xmlBefore, xmlAfter, metadataStatus).publish(applicationContext); + } } } @@ -839,52 +841,52 @@ private int reloadRecord(MetadataStatus metadataStatus, Element md, IMetadataMan } } - ServiceContext context = ApiUtils.createServiceContext(request); - - String schema = info.getChildText(Edit.Info.Elem.SCHEMA); - if (schema == null) { - schema = dataManager.autodetectSchema(md); - throw new IllegalArgumentException("Can't detect schema for metadata automatically. " + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + String schema = info.getChildText(Edit.Info.Elem.SCHEMA); + if (schema == null) { + schema = dataManager.autodetectSchema(md); + throw new IllegalArgumentException("Can't detect schema for metadata automatically. " + "You could try to force the schema with the schema parameter."); - } + } - String uuid = info.getChildText(Edit.Info.Elem.UUID); - if (uuid == null) { - // --- if the uuid does not exist we generate it for metadata and templates - uuid = dataManager.extractUUID(schema, md); - if (uuid.length() == 0) { - throw new IllegalArgumentException("Could not locate the UUID for the document being restored."); + String uuid = info.getChildText(Edit.Info.Elem.UUID); + if (uuid == null) { + // --- if the uuid does not exist we generate it for metadata and templates + uuid = dataManager.extractUUID(schema, md); + if (uuid.length() == 0) { + throw new IllegalArgumentException("Could not locate the UUID for the document being restored."); + } } - } - if (metadataRepository.findOneByUuid(uuid) != null) { - throw new IllegalArgumentException( + if (metadataRepository.findOneByUuid(uuid) != null) { + throw new IllegalArgumentException( String.format("A record with UUID '%s' already exist", uuid)); - } + } - String date = new ISODate().toString(); + String date = new ISODate().toString(); - // insert record - boolean ufo = false, indexImmediate = false; - String metadataId = iMetadataManager.insertMetadata(context, schema, md, uuid, + // insert record + boolean ufo = false, indexImmediate = false; + String metadataId = iMetadataManager.insertMetadata(context, schema, md, uuid, context.getUserSession().getUserIdAsInt(), groupId, settingManager.getSiteId(), MetadataType.METADATA.codeString , null, null, date, date, ufo, indexImmediate); - int id = Integer.parseInt(metadataId); + int id = Integer.parseInt(metadataId); - List categoryList = info.getChildren(Edit.Info.Elem.CATEGORY); - if (categoryList != null && categoryList.size() > 0) { - final MetadataCategoryRepository categoryRepository = context.getBean(MetadataCategoryRepository.class); - for (Element cat : categoryList) { - String catName = cat.getText(); - final MetadataCategory metadataCategory = categoryRepository.findOneByName(catName); - if (metadataCategory != null) { - dataManager.setCategory(context, metadataId, String.valueOf(metadataCategory.getId())); + List categoryList = info.getChildren(Edit.Info.Elem.CATEGORY); + if (categoryList != null && categoryList.size() > 0) { + final MetadataCategoryRepository categoryRepository = context.getBean(MetadataCategoryRepository.class); + for (Element cat : categoryList) { + String catName = cat.getText(); + final MetadataCategory metadataCategory = categoryRepository.findOneByName(catName); + if (metadataCategory != null) { + dataManager.setCategory(context, metadataId, String.valueOf(metadataCategory.getId())); + } } } - } - return id; + return id; + } } private MetadataStatus getMetadataStatus(String uuidOrInternalId, int statusId, int userId, String changeDate) throws ResourceNotFoundException { diff --git a/services/src/main/java/org/fao/geonet/api/records/attachments/AttachmentsActionsApi.java b/services/src/main/java/org/fao/geonet/api/records/attachments/AttachmentsActionsApi.java index 8a259e676cd6..f65b53f74788 100644 --- a/services/src/main/java/org/fao/geonet/api/records/attachments/AttachmentsActionsApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/attachments/AttachmentsActionsApi.java @@ -1,6 +1,6 @@ /* * ============================================================================= - * === Copyright (C) 2001-2016 Food and Agriculture Organization of the + * === Copyright (C) 2001-2021 Food and Agriculture Organization of the * === United Nations (FAO-UN), United Nations World Food Programme (WFP) * === and United Nations Environment Programme (UNEP) * === @@ -120,15 +120,15 @@ public MetadataResource saveThumbnail( HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + String metadataId = dataMan.getMetadataId(metadataUuid); + Lib.resource.checkEditPrivilege(context, metadataId); - String metadataId = dataMan.getMetadataId(metadataUuid); - Lib.resource.checkEditPrivilege(context, metadataId); + Path thumbnailFile = thumbnailMaker.generateThumbnail( + jsonConfig, + rotationAngle); - Path thumbnailFile = thumbnailMaker.generateThumbnail( - jsonConfig, - rotationAngle); - - return store.putResource(context, metadataUuid, thumbnailFile, MetadataResourceVisibility.PUBLIC); + return store.putResource(context, metadataUuid, thumbnailFile, MetadataResourceVisibility.PUBLIC); + } } } diff --git a/services/src/main/java/org/fao/geonet/api/records/attachments/AttachmentsApi.java b/services/src/main/java/org/fao/geonet/api/records/attachments/AttachmentsApi.java index 9acd4bceccb6..531867adde43 100644 --- a/services/src/main/java/org/fao/geonet/api/records/attachments/AttachmentsApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/attachments/AttachmentsApi.java @@ -1,6 +1,6 @@ /* * ============================================================================= - * === Copyright (C) 2001-2016 Food and Agriculture Organization of the + * === Copyright (C) 2001-2021 Food and Agriculture Organization of the * === United Nations (FAO-UN), United Nations World Food Programme (WFP) * === and United Nations Environment Programme (UNEP) * === @@ -154,9 +154,11 @@ public List getAllResources( @Parameter(description = "Use approved version or not", example = "true") @RequestParam(required = false, defaultValue = "true") Boolean approved, @RequestParam(required = false, defaultValue = FilesystemStore.DEFAULT_FILTER) String filter, @Parameter(hidden = true) HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - List list = store.getResources(context, metadataUuid, sort, filter, approved); - return list; + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + List list = store.getResources(context, metadataUuid, sort, filter, approved); + return list; + + } } @io.swagger.v3.oas.annotations.Operation(summary = "Delete all uploaded metadata resources") @@ -169,15 +171,16 @@ public void delResources( @Parameter(description = "The metadata UUID", required = true, example = "43d7c186-2187-4bcd-8843-41e575a5ef56") @PathVariable String metadataUuid, @Parameter(description = "Use approved version or not", example = "true") @RequestParam(required = false, defaultValue = "false") Boolean approved, @Parameter(hidden = true) HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - store.delResources(context, metadataUuid, approved); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + store.delResources(context, metadataUuid, approved); - String metadataIdString = ApiUtils.getInternalId(metadataUuid, approved); - if (metadataIdString != null) { - long metadataId = Long.parseLong(metadataIdString); - UserSession userSession = ApiUtils.getUserSession(request.getSession()); - new AttachmentDeletedEvent(metadataId, userSession.getUserIdAsInt(), "All attachments") - .publish(ApplicationContextHolder.get()); + String metadataIdString = ApiUtils.getInternalId(metadataUuid, approved); + if (metadataIdString != null) { + long metadataId = Long.parseLong(metadataIdString); + UserSession userSession = ApiUtils.getUserSession(request.getSession()); + new AttachmentDeletedEvent(metadataId, userSession.getUserIdAsInt(), "All attachments") + .publish(ApplicationContextHolder.get()); + } } } @@ -194,18 +197,19 @@ public MetadataResource putResource( @Parameter(description = "The file to upload") @RequestParam("file") MultipartFile file, @Parameter(description = "Use approved version or not", example = "true") @RequestParam(required = false, defaultValue = "false") Boolean approved, @Parameter(hidden = true) HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - MetadataResource resource = store.putResource(context, metadataUuid, file, visibility, approved); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + MetadataResource resource = store.putResource(context, metadataUuid, file, visibility, approved); - String metadataIdString = ApiUtils.getInternalId(metadataUuid, approved); - if (metadataIdString != null && file != null && !file.isEmpty()) { - long metadataId = Long.parseLong(metadataIdString); - UserSession userSession = ApiUtils.getUserSession(request.getSession()); - new AttachmentAddedEvent(metadataId, userSession.getUserIdAsInt(), file.getOriginalFilename()) - .publish(ApplicationContextHolder.get()); - } + String metadataIdString = ApiUtils.getInternalId(metadataUuid, approved); + if (metadataIdString != null && file != null && !file.isEmpty()) { + long metadataId = Long.parseLong(metadataIdString); + UserSession userSession = ApiUtils.getUserSession(request.getSession()); + new AttachmentAddedEvent(metadataId, userSession.getUserIdAsInt(), file.getOriginalFilename()) + .publish(ApplicationContextHolder.get()); + } - return resource; + return resource; + } } @io.swagger.v3.oas.annotations.Operation(summary = "Create a new resource from a URL for a given metadata") @@ -221,18 +225,19 @@ public MetadataResource putResourceFromURL( @Parameter(description = "The URL to load in the store") @RequestParam("url") URL url, @Parameter(description = "Use approved version or not", example = "true") @RequestParam(required = false, defaultValue = "false") Boolean approved, @Parameter(hidden = true) HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - MetadataResource resource = store.putResource(context, metadataUuid, url, visibility, approved); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + MetadataResource resource = store.putResource(context, metadataUuid, url, visibility, approved); - String metadataIdString = ApiUtils.getInternalId(metadataUuid, approved); - if (metadataIdString != null && url != null) { - long metadataId = Long.parseLong(metadataIdString); - UserSession userSession = ApiUtils.getUserSession(request.getSession()); - new AttachmentAddedEvent(metadataId, userSession.getUserIdAsInt(), url.toString()) - .publish(ApplicationContextHolder.get()); - } + String metadataIdString = ApiUtils.getInternalId(metadataUuid, approved); + if (metadataIdString != null && url != null) { + long metadataId = Long.parseLong(metadataIdString); + UserSession userSession = ApiUtils.getUserSession(request.getSession()); + new AttachmentAddedEvent(metadataId, userSession.getUserIdAsInt(), url.toString()) + .publish(ApplicationContextHolder.get()); + } - return resource; + return resource; + } } @io.swagger.v3.oas.annotations.Operation(summary = "Get a metadata resource") @@ -249,10 +254,9 @@ public HttpEntity getResource( @Parameter(description = "Use approved version or not", example = "true") @RequestParam(required = false, defaultValue = "true") Boolean approved, @Parameter(description = "Size (only applies to images). From 1px to 2048px.", example = "200") @RequestParam(required = false) Integer size, @Parameter(hidden = true) HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - try (Store.ResourceHolder file = store.getResource(context, metadataUuid, resourceId, approved)) { - - ApiUtils.canViewRecord(metadataUuid, request); + try (ServiceContext context = ApiUtils.createServiceContext(request); + Store.ResourceHolder file = store.getResource(context, metadataUuid, resourceId, approved)) { + ApiUtils.canViewRecord(metadataUuid, context); MultiValueMap headers = new HttpHeaders(); headers.add("Content-Disposition", "inline; filename=\"" + file.getMetadata().getFilename() + "\""); @@ -295,8 +299,9 @@ public MetadataResource patchResource( @Parameter(description = "The visibility", required = true, example = "public") @RequestParam(required = true) MetadataResourceVisibility visibility, @Parameter(description = "Use approved version or not", example = "true") @RequestParam(required = false, defaultValue = "false") Boolean approved, @Parameter(hidden = true) HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - return store.patchResourceStatus(context, metadataUuid, resourceId, visibility, approved); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + return store.patchResourceStatus(context, metadataUuid, resourceId, visibility, approved); + } } @io.swagger.v3.oas.annotations.Operation(summary = "Delete a metadata resource") @@ -310,15 +315,16 @@ public void delResource( @Parameter(description = "The resource identifier (ie. filename)", required = true) @PathVariable String resourceId, @Parameter(description = "Use approved version or not", example = "true") @RequestParam(required = false, defaultValue = "false") Boolean approved, @Parameter(hidden = true) HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - store.delResource(context, metadataUuid, resourceId, approved); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + store.delResource(context, metadataUuid, resourceId, approved); - String metadataIdString = ApiUtils.getInternalId(metadataUuid, approved); - if (metadataIdString != null) { - long metadataId = Long.parseLong(metadataIdString); - UserSession userSession = ApiUtils.getUserSession(request.getSession()); - new AttachmentDeletedEvent(metadataId, userSession.getUserIdAsInt(), resourceId) - .publish(ApplicationContextHolder.get()); + String metadataIdString = ApiUtils.getInternalId(metadataUuid, approved); + if (metadataIdString != null) { + long metadataId = Long.parseLong(metadataIdString); + UserSession userSession = ApiUtils.getUserSession(request.getSession()); + new AttachmentDeletedEvent(metadataId, userSession.getUserIdAsInt(), resourceId) + .publish(ApplicationContextHolder.get()); + } } } } diff --git a/services/src/main/java/org/fao/geonet/api/records/backup/BackupArchiveApi.java b/services/src/main/java/org/fao/geonet/api/records/backup/BackupArchiveApi.java index ea616528e089..34fd4dcd81cc 100644 --- a/services/src/main/java/org/fao/geonet/api/records/backup/BackupArchiveApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/backup/BackupArchiveApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -85,34 +85,35 @@ public class BackupArchiveApi { @ResponseBody public ResponseEntity downloadBackup(HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - ApplicationContext appContext = ApplicationContextHolder.get(); - GeonetworkDataDirectory dataDirectory = appContext.getBean(GeonetworkDataDirectory.class); - ServiceManager serviceManager = appContext.getBean(ServiceManager.class); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + ApplicationContext appContext = ApplicationContextHolder.get(); + GeonetworkDataDirectory dataDirectory = appContext.getBean(GeonetworkDataDirectory.class); + ServiceManager serviceManager = appContext.getBean(ServiceManager.class); - Log.info(ArchiveAllMetadataJob.BACKUP_LOG, "User " + context.getUserSession().getUsername() + " from IP: " + context - .getIpAddress() + " has started to download backup archive"); + Log.info(ArchiveAllMetadataJob.BACKUP_LOG, "User " + context.userName() + " from IP: " + context + .getIpAddress() + " has started to download backup archive"); - File backupDir = dataDirectory.getBackupDir().resolve(ArchiveAllMetadataJob.BACKUP_DIR).toFile(); - if (!backupDir.exists()) { - throw new ResourceNotFoundException("Backup archive folder does not exist"); - } - File[] files = backupDir.listFiles(new FileFilter() { - @Override - public boolean accept(File pathname) { - return !pathname.isDirectory(); + File backupDir = dataDirectory.getBackupDir().resolve(ArchiveAllMetadataJob.BACKUP_DIR).toFile(); + if (!backupDir.exists()) { + throw new ResourceNotFoundException("Backup archive folder does not exist"); + } + File[] files = backupDir.listFiles(new FileFilter() { + @Override + public boolean accept(File pathname) { + return !pathname.isDirectory(); + } + }); + if (files == null || files.length == 0) { + throw new ResourceNotFoundException("Backup archive file does not yet exist"); } - }); - if (files == null || files.length == 0) { - throw new ResourceNotFoundException("Backup archive file does not yet exist"); - } - MultiValueMap headers = new HttpHeaders(); - headers.add("content-disposition", "attachment; filename=" + files[0].getName()); + MultiValueMap headers = new HttpHeaders(); + headers.add("content-disposition", "attachment; filename=" + files[0].getName()); - final ResponseEntity response = new ResponseEntity<>(new FileSystemResource(files[0]), headers, HttpStatus.OK); + final ResponseEntity response = new ResponseEntity<>(new FileSystemResource(files[0]), headers, HttpStatus.OK); - return response; + return response; + } } @io.swagger.v3.oas.annotations.Operation(summary = "Trigger MEF backup archive", @@ -128,11 +129,12 @@ public boolean accept(File pathname) { }) @ResponseBody public String trigger(HttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - final Trigger trigger = newTrigger().forJob("archiveAllMetadata", "gnBackgroundTasks").startNow().build(); - context.getBean("gnBackgroundJobScheduler", Scheduler.class).scheduleJob(trigger); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + final Trigger trigger = newTrigger().forJob("archiveAllMetadata", "gnBackgroundTasks").startNow().build(); + context.getBean("gnBackgroundJobScheduler", Scheduler.class).scheduleJob(trigger); - return "{\"success\":true}"; + return "{\"success\":true}"; + } } } diff --git a/services/src/main/java/org/fao/geonet/api/records/editing/AjaxEditUtils.java b/services/src/main/java/org/fao/geonet/api/records/editing/AjaxEditUtils.java index 0a881ff5a697..979713f197d2 100644 --- a/services/src/main/java/org/fao/geonet/api/records/editing/AjaxEditUtils.java +++ b/services/src/main/java/org/fao/geonet/api/records/editing/AjaxEditUtils.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -47,7 +47,10 @@ import java.util.*; /** - * Embedded Metadata Update API for AJAX Editor support + * Embedded Metadata Update API for AJAX Editor support. + * + * Facade provides additional utility methods to assist with AJAX editing, making use of beans + * obtained from the provided service context. */ public class AjaxEditUtils extends EditUtils { diff --git a/services/src/main/java/org/fao/geonet/api/records/editing/BatchEditsApi.java b/services/src/main/java/org/fao/geonet/api/records/editing/BatchEditsApi.java index 2973ccdb13eb..663d81724490 100644 --- a/services/src/main/java/org/fao/geonet/api/records/editing/BatchEditsApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/editing/BatchEditsApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -131,107 +131,108 @@ public IProcessingReport batchEdit( } - ServiceContext serviceContext = ApiUtils.createServiceContext(request); - final Set setOfUuidsToEdit; - if (uuids == null) { - SelectionManager selectionManager = - SelectionManager.getManager(serviceContext.getUserSession()); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { + final Set setOfUuidsToEdit; + if (uuids == null) { + SelectionManager selectionManager = + SelectionManager.getManager(serviceContext.getUserSession()); - synchronized ( - selectionManager.getSelection(bucket)) { - final Set selection = selectionManager.getSelection(bucket); - setOfUuidsToEdit = Sets.newHashSet(selection); + synchronized ( + selectionManager.getSelection(bucket)) { + final Set selection = selectionManager.getSelection(bucket); + setOfUuidsToEdit = Sets.newHashSet(selection); + } + } else { + setOfUuidsToEdit = Sets.newHashSet(Arrays.asList(uuids)); } - } else { - setOfUuidsToEdit = Sets.newHashSet(Arrays.asList(uuids)); - } - if (setOfUuidsToEdit.size() == 0) { - throw new IllegalArgumentException("At least one record should be defined or selected for updates."); - } + if (setOfUuidsToEdit.size() == 0) { + throw new IllegalArgumentException("At least one record should be defined or selected for updates."); + } - ConfigurableApplicationContext appContext = ApplicationContextHolder.get(); - DataManager dataMan = appContext.getBean(DataManager.class); - SchemaManager _schemaManager = context.getBean(SchemaManager.class); - AccessManager accessMan = context.getBean(AccessManager.class); - final String settingId = Settings.SYSTEM_CSW_TRANSACTION_XPATH_UPDATE_CREATE_NEW_ELEMENTS; - boolean createXpathNodeIfNotExists = - context.getBean(SettingManager.class).getValueAsBool(settingId); - - - SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); - report.setTotalRecords(setOfUuidsToEdit.size()); - UserSession userSession = ApiUtils.getUserSession(request.getSession()); - - String changeDate = null; - final IMetadataUtils metadataRepository = context.getBean(IMetadataUtils.class); - for (String recordUuid : setOfUuidsToEdit) { - AbstractMetadata record = metadataRepository.findOneByUuid(recordUuid); - if (record == null) { - report.incrementNullRecords(); - } else if (!accessMan.isOwner(serviceContext, String.valueOf(record.getId()))) { - report.addNotEditableMetadataId(record.getId()); - } else { - // Processing - try { - EditLib editLib = new EditLib(_schemaManager); - MetadataSchema metadataSchema = _schemaManager.getSchema(record.getDataInfo().getSchemaId()); - Element metadata = record.getXmlData(false); - boolean metadataChanged = false; - - Iterator listOfUpdatesIterator = listOfUpdates.iterator(); - while (listOfUpdatesIterator.hasNext()) { - BatchEditParameter batchEditParameter = - listOfUpdatesIterator.next(); - - AddElemValue propertyValue = - new AddElemValue(batchEditParameter.getValue()); - - boolean applyEdit = true; - if (StringUtils.isNotEmpty(batchEditParameter.getCondition())) { - applyEdit = false; - final Object node = Xml.selectSingle(metadata, batchEditParameter.getCondition(), metadataSchema.getNamespaces()); - if (node != null && node instanceof Boolean && (Boolean)node == true) { - applyEdit = true; + ConfigurableApplicationContext appContext = ApplicationContextHolder.get(); + DataManager dataMan = appContext.getBean(DataManager.class); + SchemaManager _schemaManager = context.getBean(SchemaManager.class); + AccessManager accessMan = context.getBean(AccessManager.class); + final String settingId = Settings.SYSTEM_CSW_TRANSACTION_XPATH_UPDATE_CREATE_NEW_ELEMENTS; + boolean createXpathNodeIfNotExists = + context.getBean(SettingManager.class).getValueAsBool(settingId); + + + SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); + report.setTotalRecords(setOfUuidsToEdit.size()); + UserSession userSession = ApiUtils.getUserSession(request.getSession()); + + String changeDate = null; + final IMetadataUtils metadataRepository = context.getBean(IMetadataUtils.class); + for (String recordUuid : setOfUuidsToEdit) { + AbstractMetadata record = metadataRepository.findOneByUuid(recordUuid); + if (record == null) { + report.incrementNullRecords(); + } else if (!accessMan.isOwner(serviceContext, String.valueOf(record.getId()))) { + report.addNotEditableMetadataId(record.getId()); + } else { + // Processing + try { + EditLib editLib = new EditLib(_schemaManager); + MetadataSchema metadataSchema = _schemaManager.getSchema(record.getDataInfo().getSchemaId()); + Element metadata = record.getXmlData(false); + boolean metadataChanged = false; + + Iterator listOfUpdatesIterator = listOfUpdates.iterator(); + while (listOfUpdatesIterator.hasNext()) { + BatchEditParameter batchEditParameter = + listOfUpdatesIterator.next(); + + AddElemValue propertyValue = + new AddElemValue(batchEditParameter.getValue()); + + boolean applyEdit = true; + if (StringUtils.isNotEmpty(batchEditParameter.getCondition())) { + applyEdit = false; + final Object node = Xml.selectSingle(metadata, batchEditParameter.getCondition(), metadataSchema.getNamespaces()); + if (node != null && node instanceof Boolean && (Boolean)node == true) { + applyEdit = true; + } + } + if (applyEdit) { + metadataChanged = editLib.addElementOrFragmentFromXpath( + metadata, + metadataSchema, + batchEditParameter.getXpath(), + propertyValue, + createXpathNodeIfNotExists + ) || metadataChanged; } } - if (applyEdit) { - metadataChanged = editLib.addElementOrFragmentFromXpath( - metadata, - metadataSchema, - batchEditParameter.getXpath(), - propertyValue, - createXpathNodeIfNotExists - ) || metadataChanged; + if (metadataChanged) { + boolean validate = false; + boolean ufo = true; + boolean index = true; + boolean uds = updateDateStamp; + Element beforeMetadata = dataMan.getMetadata(serviceContext, String.valueOf(record.getId()), false, false, false); + + dataMan.updateMetadata( + serviceContext, record.getId() + "", metadata, + validate, ufo, index, + "eng", // Not used when validate is false + changeDate, uds); + report.addMetadataInfos(record, "Metadata updated."); + + Element afterMetadata = dataMan.getMetadata(serviceContext, String.valueOf(record.getId()), false, false, false); + XMLOutputter outp = new XMLOutputter(); + String xmlBefore = outp.outputString(beforeMetadata); + String xmlAfter = outp.outputString(afterMetadata); + new RecordUpdatedEvent(record.getId(), userSession.getUserIdAsInt(), xmlBefore, xmlAfter).publish(appContext); } + } catch (Exception e) { + report.addMetadataError(record, e); } - if (metadataChanged) { - boolean validate = false; - boolean ufo = true; - boolean index = true; - boolean uds = updateDateStamp; - Element beforeMetadata = dataMan.getMetadata(serviceContext, String.valueOf(record.getId()), false, false, false); - - dataMan.updateMetadata( - serviceContext, record.getId() + "", metadata, - validate, ufo, index, - "eng", // Not used when validate is false - changeDate, uds); - report.addMetadataInfos(record, "Metadata updated."); - - Element afterMetadata = dataMan.getMetadata(serviceContext, String.valueOf(record.getId()), false, false, false); - XMLOutputter outp = new XMLOutputter(); - String xmlBefore = outp.outputString(beforeMetadata); - String xmlAfter = outp.outputString(afterMetadata); - new RecordUpdatedEvent(record.getId(), userSession.getUserIdAsInt(), xmlBefore, xmlAfter).publish(appContext); - } - } catch (Exception e) { - report.addMetadataError(record, e); + report.incrementProcessedRecords(); } - report.incrementProcessedRecords(); } + report.close(); + return report; } - report.close(); - return report; } } diff --git a/services/src/main/java/org/fao/geonet/api/records/editing/EditUtils.java b/services/src/main/java/org/fao/geonet/api/records/editing/EditUtils.java index 1618862ec163..0052fc6c9428 100644 --- a/services/src/main/java/org/fao/geonet/api/records/editing/EditUtils.java +++ b/services/src/main/java/org/fao/geonet/api/records/editing/EditUtils.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -50,10 +50,14 @@ /** - * Utilities. + * Utilities methods to assist with editing. + * + * This facade wraps around GeoNetwork beans obtained from serviceContext + * to perform common editing operations involving several components. */ class EditUtils { + /** Transitory use of service context */ protected ServiceContext context; protected DataManager dataManager; protected XmlSerializer xmlSerializer; diff --git a/services/src/main/java/org/fao/geonet/api/records/editing/MetadataEditingApi.java b/services/src/main/java/org/fao/geonet/api/records/editing/MetadataEditingApi.java index 7685f8db47b7..733d6619790f 100644 --- a/services/src/main/java/org/fao/geonet/api/records/editing/MetadataEditingApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/editing/MetadataEditingApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -113,50 +113,51 @@ public void startEditing( boolean showValidationErrors = false; - ServiceContext context = ApiUtils.createServiceContext(request); - ApplicationContext applicationContext = ApplicationContextHolder.get(); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + ApplicationContext applicationContext = ApplicationContextHolder.get(); - // Start editing session - IMetadataUtils dm = applicationContext.getBean(IMetadataUtils.class); - Integer id2 = dm.startEditingSession(context, String.valueOf(metadata.getId())); + // Start editing session + IMetadataUtils dm = applicationContext.getBean(IMetadataUtils.class); + Integer id2 = dm.startEditingSession(context, String.valueOf(metadata.getId())); - // Maybe we are redirected to another metadata? - if (id2 != metadata.getId()) { + // Maybe we are redirected to another metadata? + if (id2 != metadata.getId()) { - StringBuilder sb = new StringBuilder("?"); + StringBuilder sb = new StringBuilder("?"); - Enumeration parameters = request.getParameterNames(); + Enumeration parameters = request.getParameterNames(); - // As this editor will redirect, make sure there is something to go - // back that makes sense and prevent a loop: - boolean hasPreviousURL = false; + // As this editor will redirect, make sure there is something to go + // back that makes sense and prevent a loop: + boolean hasPreviousURL = false; - while (parameters.hasMoreElements()) { - String key = parameters.nextElement(); - sb.append(key + "=" + request.getParameter(key) + "%26"); - if (key.equalsIgnoreCase("redirectUrl")) { - hasPreviousURL = true; + while (parameters.hasMoreElements()) { + String key = parameters.nextElement(); + sb.append(key + "=" + request.getParameter(key) + "%26"); + if (key.equalsIgnoreCase("redirectUrl")) { + hasPreviousURL = true; + } } - } - if (!hasPreviousURL) { - sb.append("redirectUrl=catalog.edit"); - } + if (!hasPreviousURL) { + sb.append("redirectUrl=catalog.edit"); + } - context.getUserSession().setProperty(Geonet.Session.METADATA_EDITING_CREATED_DRAFT, true); + context.getUserSession().setProperty(Geonet.Session.METADATA_EDITING_CREATED_DRAFT, true); - Element el = new Element("script"); - el.setText("window.location.hash = decodeURIComponent(\"#/metadata/" + id2 + sb.toString() + "\")"); - String elStr = Xml.getString(el); - response.getWriter().print(elStr); - return; - } - // End of start editing session + Element el = new Element("script"); + el.setText("window.location.hash = decodeURIComponent(\"#/metadata/" + id2 + sb.toString() + "\")"); + String elStr = Xml.getString(el); + response.getWriter().print(elStr); + return; + } + // End of start editing session - Element elMd = new AjaxEditUtils(context).getMetadataEmbedded(context, String.valueOf(metadata.getId()), true, - showValidationErrors); - buildEditorForm(currTab, session, allRequestParams, request, elMd, metadata.getDataInfo().getSchemaId(), - context, applicationContext, false, false, response); + Element elMd = new AjaxEditUtils(context).getMetadataEmbedded(context, String.valueOf(metadata.getId()), true, + showValidationErrors); + buildEditorForm(currTab, session, allRequestParams, request, elMd, metadata.getDataInfo().getSchemaId(), + context, applicationContext, false, false, response); + } } @io.swagger.v3.oas.annotations.Operation(summary = "Save edits", description = "Save the HTML form content.") @@ -228,207 +229,210 @@ public void saveEdits( ) throws Exception { Log.trace(Geonet.DATA_MANAGER, "Saving metadata editing with UUID " + metadataUuid); - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ServiceContext context = ApiUtils.createServiceContext(request); - AjaxEditUtils ajaxEditUtils = new AjaxEditUtils(context); - // ajaxEditUtils.preprocessUpdate(allRequestParams, context); - ApplicationContext applicationContext = ApplicationContextHolder.get(); - DataManager dataMan = applicationContext.getBean(DataManager.class); - UserSession session = ApiUtils.getUserSession(httpSession); - IMetadataValidator validator = applicationContext.getBean(IMetadataValidator.class); - BaseMetadataStatus statusRepository = ApplicationContextHolder.get().getBean(BaseMetadataStatus.class); - String id = String.valueOf(metadata.getId()); - Log.trace(Geonet.DATA_MANAGER, " > ID of the record to edit: " + id); - String isTemplate = allRequestParams.get(Params.TEMPLATE); - SettingManager sm = context.getBean(SettingManager.class); - // boolean finished = config.getValue(Params.FINISHED, "no").equals("yes"); - // boolean forget = config.getValue(Params.FORGET, "no").equals("yes"); - // boolean commit = config.getValue(Params.START_EDITING_SESSION, - // "no").equals("yes"); - boolean isEditor = session.getProfile().equals(Profile.Editor); - boolean isReviewer = session.getProfile().equals(Profile.Reviewer); - boolean isAdmin = session.getProfile().equals(Profile.Administrator); - - // Checks when workflow enabled if the user is allowed - boolean isEnabledWorkflow = sm.getValueAsBool(Settings.METADATA_WORKFLOW_ENABLE); - if (isEnabledWorkflow && isEditor && !statusRepository.canEditorEdit(metadata.getId())) { - throw new NotAllowedException("Editing is allowed only in Draft state for the current profile."); - } - - // TODO: Use map only to avoid this conversion - Log.trace(Geonet.DATA_MANAGER, " > Getting parameters from request"); - Element params = new Element("request"); - Map forwardedParams = new HashMap<>(); - for (Map.Entry e : allRequestParams.entrySet()) { - params.addContent(new Element(e.getKey()).setText(e.getValue())); - if (!e.getKey().startsWith("_")) { - forwardedParams.put(e.getKey(), e.getValue()); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + + AjaxEditUtils ajaxEditUtils = new AjaxEditUtils(context); + // ajaxEditUtils.preprocessUpdate(allRequestParams, context); + + ApplicationContext applicationContext = ApplicationContextHolder.get(); + DataManager dataMan = applicationContext.getBean(DataManager.class); + UserSession session = ApiUtils.getUserSession(httpSession); + IMetadataValidator validator = applicationContext.getBean(IMetadataValidator.class); + BaseMetadataStatus statusRepository = ApplicationContextHolder.get().getBean(BaseMetadataStatus.class); + String id = String.valueOf(metadata.getId()); + Log.trace(Geonet.DATA_MANAGER, " > ID of the record to edit: " + id); + String isTemplate = allRequestParams.get(Params.TEMPLATE); + SettingManager sm = context.getBean(SettingManager.class); + // boolean finished = config.getValue(Params.FINISHED, "no").equals("yes"); + // boolean forget = config.getValue(Params.FORGET, "no").equals("yes"); + // boolean commit = config.getValue(Params.START_EDITING_SESSION, + // "no").equals("yes"); + boolean isEditor = session.getProfile().equals(Profile.Editor); + boolean isReviewer = session.getProfile().equals(Profile.Reviewer); + boolean isAdmin = session.getProfile().equals(Profile.Administrator); + + // Checks when workflow enabled if the user is allowed + boolean isEnabledWorkflow = sm.getValueAsBool(Settings.METADATA_WORKFLOW_ENABLE); + if (isEnabledWorkflow && isEditor && !statusRepository.canEditorEdit(metadata.getId())) { + throw new NotAllowedException("Editing is allowed only in Draft state for the current profile."); } - } + // TODO: Use map only to avoid this conversion + Log.trace(Geonet.DATA_MANAGER, " > Getting parameters from request"); + Element params = new Element("request"); + Map forwardedParams = new HashMap<>(); + for (Map.Entry e : allRequestParams.entrySet()) { + params.addContent(new Element(e.getKey()).setText(e.getValue())); + if (!e.getKey().startsWith("_")) { + forwardedParams.put(e.getKey(), e.getValue()); + } + } - if (Log.isTraceEnabled(Geonet.DATA_MANAGER)) { - Log.trace(Geonet.DATA_MANAGER, " > Setting type of record " + MetadataType.lookup(isTemplate)); - } - int iLocalId = Integer.parseInt(id); - Log.trace(Geonet.DATA_MANAGER, " > Id is " + iLocalId); - dataMan.setTemplateExt(iLocalId, MetadataType.lookup(isTemplate)); - - - // --- use StatusActionsFactory and StatusActions class to possibly - // --- change status as a result of this edit (use onEdit method) - Log.trace(Geonet.DATA_MANAGER, " > Trigger status actions based on this edit"); - StatusActionsFactory saf = context.getBean(StatusActionsFactory.class); - StatusActions sa = saf.createStatusActions(context); - sa.onEdit(iLocalId, minor); - Element beforeMetadata = dataMan.getMetadata(context, String.valueOf(metadata.getId()), false, false, false); - - if (StringUtils.isNotEmpty(data)) { - Log.trace(Geonet.DATA_MANAGER, " > Updating metadata through data manager"); - Element md = Xml.loadString(data, false); - String changeDate = null; - boolean updateDateStamp = !minor; - boolean ufo = true; - boolean index = true; - dataMan.updateMetadata(context, id, md, withValidationErrors, ufo, index, context.getLanguage(), changeDate, - updateDateStamp); - if (terminate) { - XMLOutputter outp = new XMLOutputter(); - String xmlBefore = outp.outputString(beforeMetadata); - String xmlAfter = outp.outputString(md); - new RecordUpdatedEvent(Long.parseLong(id), session.getUserIdAsInt(), xmlBefore, xmlAfter) - .publish(applicationContext); + if (Log.isTraceEnabled(Geonet.DATA_MANAGER)) { + Log.trace(Geonet.DATA_MANAGER, " > Setting type of record " + MetadataType.lookup(isTemplate)); } - } else { - Log.trace(Geonet.DATA_MANAGER, " > Updating contents"); - ajaxEditUtils.updateContent(params, false, true); + int iLocalId = Integer.parseInt(id); + Log.trace(Geonet.DATA_MANAGER, " > Id is " + iLocalId); + dataMan.setTemplateExt(iLocalId, MetadataType.lookup(isTemplate)); + + + // --- use StatusActionsFactory and StatusActions class to possibly + // --- change status as a result of this edit (use onEdit method) + Log.trace(Geonet.DATA_MANAGER, " > Trigger status actions based on this edit"); + StatusActionsFactory saf = context.getBean(StatusActionsFactory.class); + StatusActions statusActions = saf.createStatusActions(context); + statusActions.onEdit(iLocalId, minor); + Element beforeMetadata = dataMan.getMetadata(context, String.valueOf(metadata.getId()), false, false, false); + + if (StringUtils.isNotEmpty(data)) { + Log.trace(Geonet.DATA_MANAGER, " > Updating metadata through data manager"); + Element md = Xml.loadString(data, false); + String changeDate = null; + boolean updateDateStamp = !minor; + boolean ufo = true; + boolean index = true; + dataMan.updateMetadata(context, id, md, withValidationErrors, ufo, index, context.getLanguage(), changeDate, + updateDateStamp); + + if (terminate) { + XMLOutputter outp = new XMLOutputter(); + String xmlBefore = outp.outputString(beforeMetadata); + String xmlAfter = outp.outputString(md); + new RecordUpdatedEvent(Long.parseLong(id), session.getUserIdAsInt(), xmlBefore, xmlAfter) + .publish(applicationContext); + } + } else { + Log.trace(Geonet.DATA_MANAGER, " > Updating contents"); + ajaxEditUtils.updateContent(params, false, true); - Element afterMetadata = dataMan.getMetadata(context, String.valueOf(metadata.getId()), false, false, false); + Element afterMetadata = dataMan.getMetadata(context, String.valueOf(metadata.getId()), false, false, false); - if (terminate) { - XMLOutputter outp = new XMLOutputter(); - String xmlBefore = outp.outputString(beforeMetadata); - String xmlAfter = outp.outputString(afterMetadata); - new RecordUpdatedEvent(Long.parseLong(id), session.getUserIdAsInt(), xmlBefore, xmlAfter) - .publish(applicationContext); + if (terminate) { + XMLOutputter outp = new XMLOutputter(); + String xmlBefore = outp.outputString(beforeMetadata); + String xmlAfter = outp.outputString(afterMetadata); + new RecordUpdatedEvent(Long.parseLong(id), session.getUserIdAsInt(), xmlBefore, xmlAfter) + .publish(applicationContext); + } } - } - // ----------------------------------------------------------------------- - // --- update element and return status - // Element elResp = new Element(Jeeves.Elem.RESPONSE); - // elResp.addContent(new Element(Geonet.Elem.ID).setText(id)); - // elResp.addContent(new Element(Geonet.Elem.SHOWVALIDATIONERRORS) - // .setText(String.valueOf(withValidationErrors))); - //// boolean justCreated = Util.getParam(params, Params.JUST_CREATED, null) != - // null; - //// if (justCreated) { - //// elResp.addContent(new Element(Geonet.Elem.JUSTCREATED).setText("true")); - //// } - // elResp.addContent(new - // Element(Params.MINOREDIT).setText(String.valueOf(minor))); - - // --- if finished then remove the XML from the session - if ((commit) && (!terminate)) { - return; - } - if (terminate) { - Log.trace(Geonet.DATA_MANAGER, " > Closing editor"); + // ----------------------------------------------------------------------- + // --- update element and return status + // Element elResp = new Element(Jeeves.Elem.RESPONSE); + // elResp.addContent(new Element(Geonet.Elem.ID).setText(id)); + // elResp.addContent(new Element(Geonet.Elem.SHOWVALIDATIONERRORS) + // .setText(String.valueOf(withValidationErrors))); + //// boolean justCreated = Util.getParam(params, Params.JUST_CREATED, null) != + // null; + //// if (justCreated) { + //// elResp.addContent(new Element(Geonet.Elem.JUSTCREATED).setText("true")); + //// } + // elResp.addContent(new + // Element(Params.MINOREDIT).setText(String.valueOf(minor))); + + // --- if finished then remove the XML from the session + if ((commit) && (!terminate)) { + return; + } + if (terminate) { + Log.trace(Geonet.DATA_MANAGER, " > Closing editor"); - boolean forceValidationOnMdSave = sm.getValueAsBool("metadata/workflow/forceValidationOnMdSave"); + boolean forceValidationOnMdSave = sm.getValueAsBool("metadata/workflow/forceValidationOnMdSave"); - boolean reindex = false; + boolean reindex = false; - // Save validation if the forceValidationOnMdSave is enabled - if (forceValidationOnMdSave) { - validator.doValidate(metadata, context.getLanguage()); - reindex = true; - } + // Save validation if the forceValidationOnMdSave is enabled + if (forceValidationOnMdSave) { + validator.doValidate(metadata, context.getLanguage()); + reindex = true; + } - // Automatically change the workflow state after save - if (isEnabledWorkflow) { - if (status.equals(StatusValue.Status.SUBMITTED)) { - // Only editors can submit a record - if (isEditor || isAdmin) { - Integer changeToStatus = Integer.parseInt(StatusValue.Status.SUBMITTED); - statusRepository.changeCurrentStatus(session.getUserIdAsInt(), metadata.getId(), - changeToStatus); - } else { - throw new SecurityException(String.format("Only users with editor profile can submit.")); + // Automatically change the workflow state after save + if (isEnabledWorkflow) { + if (status.equals(StatusValue.Status.SUBMITTED)) { + // Only editors can submit a record + if (isEditor || isAdmin) { + Integer changeToStatus = Integer.parseInt(StatusValue.Status.SUBMITTED); + statusRepository.changeCurrentStatus(session.getUserIdAsInt(), metadata.getId(), + changeToStatus); + } else { + throw new SecurityException(String.format("Only users with editor profile can submit.")); + } } - } - if (status.equals(StatusValue.Status.APPROVED)) { - // Only reviewers can approve - if (isReviewer || isAdmin) { - Integer changeToStatus = Integer.parseInt(StatusValue.Status.APPROVED); - statusRepository.changeCurrentStatus(session.getUserIdAsInt(), metadata.getId(), - changeToStatus); - } else { - throw new SecurityException(String.format("Only users with review profile can approve.")); + if (status.equals(StatusValue.Status.APPROVED)) { + // Only reviewers can approve + if (isReviewer || isAdmin) { + Integer changeToStatus = Integer.parseInt(StatusValue.Status.APPROVED); + statusRepository.changeCurrentStatus(session.getUserIdAsInt(), metadata.getId(), + changeToStatus); + } else { + throw new SecurityException(String.format("Only users with review profile can approve.")); + } } } - } - boolean automaticUnpublishInvalidMd = sm.getValueAsBool("metadata/workflow/automaticUnpublishInvalidMd"); - boolean isUnpublished = false; + boolean automaticUnpublishInvalidMd = sm.getValueAsBool("metadata/workflow/automaticUnpublishInvalidMd"); + boolean isUnpublished = false; + + // Unpublish the metadata automatically if the setting + // automaticUnpublishInvalidMd is enabled and + // the metadata becomes invalid + if (automaticUnpublishInvalidMd) { + final OperationAllowedRepository operationAllowedRepo = context + .getBean(OperationAllowedRepository.class); - // Unpublish the metadata automatically if the setting - // automaticUnpublishInvalidMd is enabled and - // the metadata becomes invalid - if (automaticUnpublishInvalidMd) { - final OperationAllowedRepository operationAllowedRepo = context - .getBean(OperationAllowedRepository.class); + boolean isPublic = (operationAllowedRepo.count(where(hasMetadataId(id)) + .and(hasOperation(ReservedOperation.view)).and(hasGroupId(ReservedGroup.all.getId()))) > 0); - boolean isPublic = (operationAllowedRepo.count(where(hasMetadataId(id)) - .and(hasOperation(ReservedOperation.view)).and(hasGroupId(ReservedGroup.all.getId()))) > 0); + if (isPublic) { + final MetadataValidationRepository metadataValidationRepository = context + .getBean(MetadataValidationRepository.class); - if (isPublic) { - final MetadataValidationRepository metadataValidationRepository = context - .getBean(MetadataValidationRepository.class); + boolean isInvalid = (metadataValidationRepository + .count(MetadataValidationSpecs.isInvalidAndRequiredForMetadata(Integer.parseInt(id))) > 0); - boolean isInvalid = (metadataValidationRepository - .count(MetadataValidationSpecs.isInvalidAndRequiredForMetadata(Integer.parseInt(id))) > 0); + if (isInvalid) { + isUnpublished = true; + operationAllowedRepo + .deleteAll(where(hasMetadataId(id)).and(hasGroupId(ReservedGroup.all.getId()))); + } - if (isInvalid) { - isUnpublished = true; - operationAllowedRepo - .deleteAll(where(hasMetadataId(id)).and(hasGroupId(ReservedGroup.all.getId()))); + reindex = true; } - reindex = true; } - } - - if (reindex) { - Log.trace(Geonet.DATA_MANAGER, " > Reindexing record"); - dataMan.indexMetadata(id, true); - } + if (reindex) { + Log.trace(Geonet.DATA_MANAGER, " > Reindexing record"); + dataMan.indexMetadata(id, true); + } - ajaxEditUtils.removeMetadataEmbedded(session, id); - dataMan.endEditingSession(id, session); - if (isUnpublished) { - throw new IllegalStateException(String.format("Record saved but as it was invalid at the end of " - + "the editing session. The public record '%s' was unpublished.", metadata.getUuid())); - } else { - return; + ajaxEditUtils.removeMetadataEmbedded(session, id); + dataMan.endEditingSession(id, session); + if (isUnpublished) { + throw new IllegalStateException(String.format("Record saved but as it was invalid at the end of " + + "the editing session. The public record '%s' was unpublished.", metadata.getUuid())); + } else { + return; + } } - } - // if (!finished && !forget && commit) { - // dataMan.startEditingSession(context, id); - // } - Element elMd = new AjaxEditUtils(context).getMetadataEmbedded(context, id, true, - withValidationErrors); + // if (!finished && !forget && commit) { + // dataMan.startEditingSession(context, id); + // } + Element elMd = new AjaxEditUtils(context).getMetadataEmbedded(context, id, true, + withValidationErrors); - buildEditorForm(tab, httpSession, forwardedParams, request, elMd, metadata.getDataInfo().getSchemaId(), context, - applicationContext, false, false, response); + buildEditorForm(tab, httpSession, forwardedParams, request, elMd, metadata.getDataInfo().getSchemaId(), context, + applicationContext, false, false, response); - if (isEnabledWorkflow) { - // After saving the form remove the information to remove the draft copy if the user cancels the editor - context.getUserSession().removeProperty(Geonet.Session.METADATA_EDITING_CREATED_DRAFT); + if (isEnabledWorkflow) { + // After saving the form remove the information to remove the draft copy if the user cancels the editor + context.getUserSession().removeProperty(Geonet.Session.METADATA_EDITING_CREATED_DRAFT); + } } } @@ -443,12 +447,14 @@ public void saveEdits( public void cancelEdits(@Parameter(description = API_PARAM_RECORD_UUID, required = true) @PathVariable String metadataUuid, @Parameter(hidden = true) @RequestParam Map allRequestParams, HttpServletRequest request, @Parameter(hidden = true) HttpSession httpSession) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); ApplicationContext applicationContext = ApplicationContextHolder.get(); DataManager dataMan = applicationContext.getBean(DataManager.class); - ServiceContext context = ApiUtils.createServiceContext(request); - dataMan.cancelEditingSession(context, String.valueOf(metadata.getId())); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + + dataMan.cancelEditingSession(context, String.valueOf(metadata.getId())); + } } @io.swagger.v3.oas.annotations.Operation(summary = "Add element", description = "") @@ -466,32 +472,33 @@ public void addElement(@Parameter(description = API_PARAM_RECORD_UUID, required @Parameter(hidden = true) @RequestParam Map allRequestParams, HttpServletRequest request, HttpServletResponse response, @Parameter(hidden = true) HttpSession httpSession) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); ApplicationContext applicationContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); - - // -- build the element to be added - // -- Here we do mark the element that is added - // -- then we traverse up the tree to the root - // -- clone from the root and return the clone - // -- this is done so that the style sheets have - // -- access to important information like the - // -- document language and other locales - // -- this is important for multilingual editing - // -- - // -- Note that the metadata-embedded.xsl stylesheet - // -- only applies the templating to the added element, not to - // -- the entire metadata so performance should not be a big issue - Element elResp = new AjaxEditUtils(context).addElementEmbedded(ApiUtils.getUserSession(httpSession), - String.valueOf(metadata.getId()), ref, name, child); - EditLib.tagForDisplay(elResp); - Element md = (Element) findRoot(elResp).clone(); - EditLib.removeDisplayTag(elResp); - - buildEditorForm(allRequestParams.get("currTab"), httpSession, allRequestParams, request, md, - metadata.getDataInfo().getSchemaId(), context, applicationContext, true, true, response); - } + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + + // -- build the element to be added + // -- Here we do mark the element that is added + // -- then we traverse up the tree to the root + // -- clone from the root and return the clone + // -- this is done so that the style sheets have + // -- access to important information like the + // -- document language and other locales + // -- this is important for multilingual editing + // -- + // -- Note that the metadata-embedded.xsl stylesheet + // -- only applies the templating to the added element, not to + // -- the entire metadata so performance should not be a big issue + Element elResp = new AjaxEditUtils(context).addElementEmbedded(ApiUtils.getUserSession(httpSession), + String.valueOf(metadata.getId()), ref, name, child); + EditLib.tagForDisplay(elResp); + Element md = (Element) findRoot(elResp).clone(); + EditLib.removeDisplayTag(elResp); + + buildEditorForm(allRequestParams.get("currTab"), httpSession, allRequestParams, request, md, + metadata.getDataInfo().getSchemaId(), context, applicationContext, true, true, response); + } + } @io.swagger.v3.oas.annotations.Operation(summary = "Reorder element", description = "") @RequestMapping(value = "/{metadataUuid}/editor/elements/{direction}", method = RequestMethod.PUT, consumes = { @@ -507,11 +514,12 @@ public void addElement(@Parameter(description = API_PARAM_RECORD_UUID, required @Parameter(description = "Should attributes be shown on the editor snippet?", required = false) @RequestParam(defaultValue = "false") boolean displayAttributes, @Parameter(hidden = true) @RequestParam Map allRequestParams, HttpServletRequest request, @Parameter(hidden = true) HttpSession httpSession) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); - new AjaxEditUtils(context).swapElementEmbedded(ApiUtils.getUserSession(httpSession), - String.valueOf(metadata.getId()), ref, direction == Direction.down); + new AjaxEditUtils(context).swapElementEmbedded(ApiUtils.getUserSession(httpSession), + String.valueOf(metadata.getId()), ref, direction == Direction.down); + } } @io.swagger.v3.oas.annotations.Operation(summary = "Delete element", description = "") @@ -528,13 +536,13 @@ public void deleteElement( @Parameter(description = "Name of the parent.", required = true) @RequestParam String parent, @Parameter(description = "Should attributes be shown on the editor snippet?", required = false) @RequestParam(defaultValue = "false") boolean displayAttributes, HttpServletRequest request, @Parameter(hidden = true) HttpSession httpSession) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ServiceContext context = ApiUtils.createServiceContext(request); - - String id = String.valueOf(metadata.getId()); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); + String id = String.valueOf(metadata.getId()); - for (int i = 0; i < ref.length; i++) { - new AjaxEditUtils(context).deleteElementEmbedded(ApiUtils.getUserSession(httpSession), id, ref[i], parent); + for (int i = 0; i < ref.length; i++) { + new AjaxEditUtils(context).deleteElementEmbedded(ApiUtils.getUserSession(httpSession), id, ref[i], parent); + } } } @@ -551,11 +559,12 @@ public void deleteAttribute( @Parameter(description = "Reference of the attribute to remove.", required = true) @RequestParam String ref, @Parameter(description = "Should attributes be shown on the editor snippet?", required = false) @RequestParam(defaultValue = "false") boolean displayAttributes, HttpServletRequest request, @Parameter(hidden = true) HttpSession httpSession) throws Exception { - AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, request); - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canEditRecord(metadataUuid, context); - new AjaxEditUtils(context).deleteAttributeEmbedded(ApiUtils.getUserSession(httpSession), - String.valueOf(metadata.getId()), ref); + new AjaxEditUtils(context).deleteAttributeEmbedded(ApiUtils.getUserSession(httpSession), + String.valueOf(metadata.getId()), ref); + } } private Element findRoot(Element element) { diff --git a/services/src/main/java/org/fao/geonet/api/records/extent/MetadataExtentApi.java b/services/src/main/java/org/fao/geonet/api/records/extent/MetadataExtentApi.java index 4e586398e6b4..d9c628252a7b 100644 --- a/services/src/main/java/org/fao/geonet/api/records/extent/MetadataExtentApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/extent/MetadataExtentApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -169,47 +169,49 @@ public List getAllRecordExtentAsJson( String metadataUuid, @Parameter(hidden = true) HttpServletRequest request) throws Exception { - AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, request); - - String schemaId = metadata.getDataInfo().getSchemaId(); - MetadataSchema schema = schemaManager.getSchema(schemaId); - - Element xmlData = metadata.getXmlData(false); - List extentList = Xml.selectNodes( - xmlData, - EXTENT_XPATH, schema.getNamespaces()); - - List response = new ArrayList<>(extentList.size() + 1); - if (!"iso19110".equals(schemaId)) { - response.add(new ExtentDto( - String.format("%sapi/records/%s/extents.png", - settingManager.getNodeURL(), metadataUuid), - "ALL", - "", - "")); - } - - int index = 1; + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, context); - for (Object extent : extentList) { - if (extent instanceof Element) { - Element extentElement = (Element) extent; + String schemaId = metadata.getDataInfo().getSchemaId(); + MetadataSchema schema = schemaManager.getSchema(schemaId); - String description = - Xml.selectString(extentElement, - EXTENT_DESCRIPTION_XPATH, - schema.getNamespaces()); + Element xmlData = metadata.getXmlData(false); + List extentList = Xml.selectNodes( + xmlData, + EXTENT_XPATH, schema.getNamespaces()); + List response = new ArrayList<>(extentList.size() + 1); + if (!"iso19110".equals(schemaId)) { response.add(new ExtentDto( - String.format("%sapi/records/%s/extents/%d.png", - settingManager.getNodeURL(), metadataUuid, index), - extentElement.getName(), - XPath.getXPath(xmlData, (Element) extent), - description)); - index ++; + String.format("%sapi/records/%s/extents.png", + settingManager.getNodeURL(), metadataUuid), + "ALL", + "", + "")); } + + int index = 1; + + for (Object extent : extentList) { + if (extent instanceof Element) { + Element extentElement = (Element) extent; + + String description = + Xml.selectString(extentElement, + EXTENT_DESCRIPTION_XPATH, + schema.getNamespaces()); + + response.add(new ExtentDto( + String.format("%sapi/records/%s/extents/%d.png", + settingManager.getNodeURL(), metadataUuid, index), + extentElement.getName(), + XPath.getXPath(xmlData, (Element) extent), + description)); + index ++; + } + } + return response; } - return response; } @@ -253,53 +255,54 @@ public HttpEntity getOneRecordExtentAsImage( } private HttpEntity getExtent(String metadataUuid, String srs, Integer width, Integer height, String background, String fillColor, String strokeColor, Integer extentOrderOfAppearence, NativeWebRequest nativeWebRequest, HttpServletRequest request) throws Exception { - AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, request); - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, context); - if (width != null && height != null) { - throw new BadParameterEx(WIDTH_PARAM, WIDTH_AND_HEIGHT_BOTH_DEFINED_MESSAGE); - } + if (width != null && height != null) { + throw new BadParameterEx(WIDTH_PARAM, WIDTH_AND_HEIGHT_BOTH_DEFINED_MESSAGE); + } - if (width == null && height == null) { - throw new BadParameterEx(WIDTH_PARAM, WIDTH_AND_HEIGHT_BOTH_MISSING_MESSAGE); - } + if (width == null && height == null) { + throw new BadParameterEx(WIDTH_PARAM, WIDTH_AND_HEIGHT_BOTH_MISSING_MESSAGE); + } - if ((background != null) && (background.startsWith("http")) && (disableFullUrlBackgroundMapServices)) { - throw new BadParameterEx(BACKGROUND_PARAM, "Background layers from provided are not supported, " + - "use a preconfigured background layers map service."); - } + if ((background != null) && (background.startsWith("http")) && (disableFullUrlBackgroundMapServices)) { + throw new BadParameterEx(BACKGROUND_PARAM, "Background layers from provided are not supported, " + + "use a preconfigured background layers map service."); + } - String regionId; - if (extentOrderOfAppearence == null) { - regionId = String.format("metadata:@id%s", metadata.getId()); - } else { - regionId = String.format("metadata:@id%s:@xpath(%s)[%d]", - metadata.getId(), EXTENT_XPATH, extentOrderOfAppearence); - } + String regionId; + if (extentOrderOfAppearence == null) { + regionId = String.format("metadata:@id%s", metadata.getId()); + } else { + regionId = String.format("metadata:@id%s:@xpath(%s)[%d]", + metadata.getId(), EXTENT_XPATH, extentOrderOfAppearence); + } - Request searchRequest = metadataRegionDAO.createSearchRequest(context).id(regionId); - if (searchRequest.getLastModified().isPresent() && nativeWebRequest.checkNotModified(searchRequest.getLastModified().get())) { - return null; - } + Request searchRequest = metadataRegionDAO.createSearchRequest(context).id(regionId); + if (searchRequest.getLastModified().isPresent() && nativeWebRequest.checkNotModified(searchRequest.getLastModified().get())) { + return null; + } - MapRenderer renderer = new MapRenderer(context); - BufferedImage image = renderer.render( - regionId, srs, width, height, background, - null, null, null, - fillColor, - strokeColor); + MapRenderer renderer = new MapRenderer(context); + BufferedImage image = renderer.render( + regionId, srs, width, height, background, + null, null, null, + fillColor, + strokeColor); - if (image == null) { - return null; - } + if (image == null) { + return null; + } - try (ByteArrayOutputStream out = new ByteArrayOutputStream()) { - ImageIO.write(image, "png", out); - MultiValueMap headers = new HttpHeaders(); - headers.add("Content-Disposition", String.format("inline; filename=\"%s-extent.png\"", metadataUuid)); - headers.add("Cache-Control", "no-cache"); - headers.add("Content-Type", "image/png"); - return new HttpEntity<>(out.toByteArray(), headers); + try (ByteArrayOutputStream out = new ByteArrayOutputStream()) { + ImageIO.write(image, "png", out); + MultiValueMap headers = new HttpHeaders(); + headers.add("Content-Disposition", String.format("inline; filename=\"%s-extent.png\"", metadataUuid)); + headers.add("Cache-Control", "no-cache"); + headers.add("Content-Type", "image/png"); + return new HttpEntity<>(out.toByteArray(), headers); + } } } } diff --git a/services/src/main/java/org/fao/geonet/api/records/formatters/FormatterApi.java b/services/src/main/java/org/fao/geonet/api/records/formatters/FormatterApi.java index 31650bb710a1..3393f3e86f7d 100644 --- a/services/src/main/java/org/fao/geonet/api/records/formatters/FormatterApi.java +++ b/services/src/main/java/org/fao/geonet/api/records/formatters/FormatterApi.java @@ -1,5 +1,5 @@ //============================================================================== -//=== Copyright (C) 2001-2008 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -265,47 +265,50 @@ public void getRecordFormattedBy( Validator validator; - final ServiceContext context = createServiceContext( + + try(ServiceContext context = createServiceContext( language, formatType, - request.getNativeRequest(HttpServletRequest.class)); - - if (changeDate != null) { - final long changeDateAsTime = changeDate.toDate().getTime(); - long roundedChangeDate = changeDateAsTime / 1000 * 1000; - if (request.checkNotModified(language, roundedChangeDate) && - context.getBean(CacheConfig.class).allowCaching(key)) { + request.getNativeRequest(HttpServletRequest.class))){ + // context used as a parameter, not set as threadlocal + + if (changeDate != null) { + final long changeDateAsTime = changeDate.toDate().getTime(); + long roundedChangeDate = changeDateAsTime / 1000 * 1000; + if (request.checkNotModified(language, roundedChangeDate) && + context.getBean(CacheConfig.class).allowCaching(key)) { + if (!skipPopularityBool) { + context.getBean(DataManager.class).increasePopularity(context, String.valueOf(metadata.getId())); + } + return; + } + validator = new ChangeDateValidator(changeDateAsTime); + } else { + validator = new NoCacheValidator(); + } + final FormatMetadata formatMetadata = new FormatMetadata(context, key, request); + + byte[] bytes; + if (hasNonStandardParameters(request)) { + // the http headers can cause a formatter to output custom output due to the parameters. + // because it is not known how the parameters may affect the output then we have two choices + // 1. make a unique cache for each configuration of parameters + // 2. don't cache anything that has extra parameters beyond the standard parameters used to + // create the key + // #1 has a major flaw because an attacker could simply make new requests always changing the parameters + // and completely swamp the cache. So we go with #2. The formatters are pretty fast so it is a fine solution + bytes = formatMetadata.call().data; + } else { + bytes = context.getBean(FormatterCache.class).get(key, validator, formatMetadata, false); + } + if (bytes != null) { if (!skipPopularityBool) { context.getBean(DataManager.class).increasePopularity(context, String.valueOf(metadata.getId())); } - return; + writeOutResponse(context, metadataUuid, + isoLanguagesMapper.iso639_2T_to_iso639_2B(locale.getISO3Language()), + request.getNativeResponse(HttpServletResponse.class), formatType, bytes); } - validator = new ChangeDateValidator(changeDateAsTime); - } else { - validator = new NoCacheValidator(); - } - final FormatMetadata formatMetadata = new FormatMetadata(context, key, request); - - byte[] bytes; - if (hasNonStandardParameters(request)) { - // the http headers can cause a formatter to output custom output due to the parameters. - // because it is not known how the parameters may affect the output then we have two choices - // 1. make a unique cache for each configuration of parameters - // 2. don't cache anything that has extra parameters beyond the standard parameters used to - // create the key - // #1 has a major flaw because an attacker could simply make new requests always changing the parameters - // and completely swamp the cache. So we go with #2. The formatters are pretty fast so it is a fine solution - bytes = formatMetadata.call().data; - } else { - bytes = context.getBean(FormatterCache.class).get(key, validator, formatMetadata, false); - } - if (bytes != null) { - if (!skipPopularityBool) { - context.getBean(DataManager.class).increasePopularity(context, String.valueOf(metadata.getId())); - } - writeOutResponse(context, metadataUuid, - isoLanguagesMapper.iso639_2T_to_iso639_2B(locale.getISO3Language()), - request.getNativeResponse(HttpServletResponse.class), formatType, bytes); } } @@ -347,27 +350,31 @@ public void execXml( } FormatType formatType = FormatType.valueOf(type.toLowerCase()); - final ServiceContext context = createServiceContext(lang, formatType, request.getNativeRequest(HttpServletRequest.class)); - if (metadata == null) { - metadata = getXmlFromUrl(context, lang, url, request); - } - Element metadataEl = Xml.loadString(metadata, false); + // context used as a parameter, not set as threadlocal + try (ServiceContext context = createServiceContext(lang, formatType, request.getNativeRequest(HttpServletRequest.class))) { + if (metadata == null) { + metadata = getXmlFromUrl(context, lang, url, request); + } + Element metadataEl = Xml.loadString(metadata, false); - if (mdPath != null) { - final List namespaces = context.getBean(SchemaManager.class).getSchema(schema).getNamespaces(); - metadataEl = Xml.selectElement(metadataEl, mdPath, namespaces); - metadataEl.detach(); - } - Metadata metadataInfo = new Metadata(); - metadataInfo.setData(metadata).setId(1).setUuid("uuid"); - metadataInfo.getDataInfo().setType(MetadataType.METADATA).setRoot(metadataEl.getQualifiedName()).setSchemaId(schema); + if (mdPath != null) { + final List namespaces = context.getBean(SchemaManager.class).getSchema(schema).getNamespaces(); + metadataEl = Xml.selectElement(metadataEl, mdPath, namespaces); + metadataEl.detach(); + } + Metadata metadataInfo = new Metadata(); + metadataInfo.setData(metadata).setId(1).setUuid("uuid"); + metadataInfo.getDataInfo().setType(MetadataType.METADATA).setRoot(metadataEl.getQualifiedName()).setSchemaId(schema); - Pair result = createFormatterAndParams(lang, formatType, xslid, width, - request, context, metadataEl, metadataInfo); - final String formattedMetadata = result.one().format(result.two()); - byte[] bytes = formattedMetadata.getBytes(Constants.CHARSET); + Pair result = createFormatterAndParams(lang, formatType, xslid, width, + request, context, metadataEl, metadataInfo); + final String formattedMetadata = result.one().format(result.two()); + byte[] bytes = formattedMetadata.getBytes(Constants.CHARSET); - writeOutResponse(context, "", lang, request.getNativeResponse(HttpServletResponse.class), formatType, bytes); + writeOutResponse(context, "", lang, request.getNativeResponse(HttpServletResponse.class), formatType, bytes); + + context.clear(); // prevent further use + } } /** @@ -430,44 +437,47 @@ public void exec( final FormatType formatType = FormatType.valueOf(type.toLowerCase()); String resolvedId = resolveId(id, uuid); - ServiceContext context = createServiceContext(lang, formatType, request.getNativeRequest(HttpServletRequest.class)); - Lib.resource.checkPrivilege(context, resolvedId, ReservedOperation.view); + // context used as a parameter, not set as threadlocal + try (ServiceContext context = createServiceContext(lang, formatType, request.getNativeRequest(HttpServletRequest.class))) { + Lib.resource.checkPrivilege(context, resolvedId, ReservedOperation.view); - final boolean hideWithheld = Boolean.TRUE.equals(hide_withheld) || - !context.getBean(AccessManager.class).canEdit(context, resolvedId); - Key key = new Key(Integer.parseInt(resolvedId), lang, formatType, xslid, hideWithheld, width); - final boolean skipPopularityBool = new ParamValue(skipPopularity).toBool(); + final boolean hideWithheld = Boolean.TRUE.equals(hide_withheld) || + !context.getBean(AccessManager.class).canEdit(context, resolvedId); + Key key = new Key(Integer.parseInt(resolvedId), lang, formatType, xslid, hideWithheld, width); + final boolean skipPopularityBool = new ParamValue(skipPopularity).toBool(); - ISODate changeDate = context.getBean(EsSearchManager.class).getDocChangeDate(resolvedId); + ISODate changeDate = context.getBean(EsSearchManager.class).getDocChangeDate(resolvedId); - Validator validator; - if (changeDate != null) { - final long changeDateAsTime = changeDate.toDate().getTime(); - validator = new ChangeDateValidator(changeDateAsTime); - } else { - validator = new NoCacheValidator(); - } - final FormatMetadata formatMetadata = new FormatMetadata(context, key, request); - - byte[] bytes; - if (hasNonStandardParameters(request)) { - // the http headers can cause a formatter to output custom output due to the parameters. - // because it is not known how the parameters may affect the output then we have two choices - // 1. make a unique cache for each configuration of parameters - // 2. don't cache anything that has extra parameters beyond the standard parameters used to - // create the key - // #1 has a major flaw because an attacker could simply make new requests always changing the parameters - // and completely swamp the cache. So we go with #2. The formatters are pretty fast so it is a fine solution - bytes = formatMetadata.call().data; - } else { - bytes = context.getBean(FormatterCache.class).get(key, validator, formatMetadata, false); - } - if (bytes != null) { - if (!skipPopularityBool) { - context.getBean(DataManager.class).increasePopularity(context, resolvedId); + Validator validator; + if (changeDate != null) { + final long changeDateAsTime = changeDate.toDate().getTime(); + validator = new ChangeDateValidator(changeDateAsTime); + } else { + validator = new NoCacheValidator(); + } + final FormatMetadata formatMetadata = new FormatMetadata(context, key, request); + + byte[] bytes; + if (hasNonStandardParameters(request)) { + // the http headers can cause a formatter to output custom output due to the parameters. + // because it is not known how the parameters may affect the output then we have two choices + // 1. make a unique cache for each configuration of parameters + // 2. don't cache anything that has extra parameters beyond the standard parameters used to + // create the key + // #1 has a major flaw because an attacker could simply make new requests always changing the parameters + // and completely swamp the cache. So we go with #2. The formatters are pretty fast so it is a fine solution + bytes = formatMetadata.call().data; + } else { + bytes = context.getBean(FormatterCache.class).get(key, validator, formatMetadata, false); } + if (bytes != null) { + if (!skipPopularityBool) { + context.getBean(DataManager.class).increasePopularity(context, resolvedId); + } - writeOutResponse(context, resolvedId, lang, request.getNativeResponse(HttpServletResponse.class), formatType, bytes); + writeOutResponse(context, resolvedId, lang, request.getNativeResponse(HttpServletResponse.class), formatType, bytes); + } + context.clear(); } } @@ -555,6 +565,17 @@ Pair loadMetadataAndCreateFormatterAndParams(Ser return createFormatterAndParams(key.lang, key.formatType, key.formatterId, key.width, request, context, metadata, metadataInfo); } + /** + * Service context for metadata.formatter. + * + * When creating a service context you are responsible for managing on the current thread and any cleanup. + * + * The serviceContext is creating using the ApplicationContext from {@link ApplicationContextHolder}. + * @param lang la + * @param type + * @param request + * @return service context for metadat.formatter + */ private ServiceContext createServiceContext(String lang, FormatType type, HttpServletRequest request) { final ServiceManager serviceManager = ApplicationContextHolder.get().getBean(ServiceManager.class); return serviceManager.createServiceContext("metadata.formatter" + type, lang, request); @@ -777,26 +798,30 @@ public FormatMetadata(ServiceContext context, Key key, NativeWebRequest request) @Override public StoreInfoAndDataLoadResult call() throws Exception { serviceContext.setAsThreadLocal(); - - Pair result = - loadMetadataAndCreateFormatterAndParams(serviceContext, key, request); - FormatterImpl formatter = result.one(); - FormatterParams fparams = result.two(); - final String formattedMetadata = formatter.format(fparams); - byte[] bytes = formattedMetadata.getBytes(Constants.CHARSET); - long changeDate = fparams.metadataInfo.getDataInfo().getChangeDate().toDate().getTime(); - final Specification isPublished = OperationAllowedSpecs.isPublic(ReservedOperation.view); - final Specification hasMdId = OperationAllowedSpecs.hasMetadataId(key.mdId); - final Optional one = serviceContext.getBean(OperationAllowedRepository.class).findOne(where(hasMdId).and(isPublished)); - final boolean isPublishedMd = one.isPresent(); - - Key withheldKey = null; - FormatMetadata loadWithheld = null; - if (!key.hideWithheld && isPublishedMd) { - withheldKey = new Key(key.mdId, key.lang, key.formatType, key.formatterId, true, key.width); - loadWithheld = new FormatMetadata(serviceContext, withheldKey, request); + try { + Pair result = + loadMetadataAndCreateFormatterAndParams(serviceContext, key, request); + FormatterImpl formatter = result.one(); + FormatterParams fparams = result.two(); + final String formattedMetadata = formatter.format(fparams); + byte[] bytes = formattedMetadata.getBytes(Constants.CHARSET); + long changeDate = fparams.metadataInfo.getDataInfo().getChangeDate().toDate().getTime(); + final Specification isPublished = OperationAllowedSpecs.isPublic(ReservedOperation.view); + final Specification hasMdId = OperationAllowedSpecs.hasMetadataId(key.mdId); + final Optional one = serviceContext.getBean(OperationAllowedRepository.class).findOne(where(hasMdId).and(isPublished)); + final boolean isPublishedMd = one.isPresent(); + + Key withheldKey = null; + FormatMetadata loadWithheld = null; + if (!key.hideWithheld && isPublishedMd) { + withheldKey = new Key(key.mdId, key.lang, key.formatType, key.formatterId, true, key.width); + loadWithheld = new FormatMetadata(serviceContext, withheldKey, request); + } + return new StoreInfoAndDataLoadResult(bytes, changeDate, isPublishedMd, withheldKey, loadWithheld); + } + finally { + serviceContext.clearAsThreadLocal(); } - return new StoreInfoAndDataLoadResult(bytes, changeDate, isPublishedMd, withheldKey, loadWithheld); } } } diff --git a/services/src/main/java/org/fao/geonet/api/regions/RegionsApi.java b/services/src/main/java/org/fao/geonet/api/regions/RegionsApi.java index e5bb16d46558..589405689d87 100644 --- a/services/src/main/java/org/fao/geonet/api/regions/RegionsApi.java +++ b/services/src/main/java/org/fao/geonet/api/regions/RegionsApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -121,23 +121,25 @@ public ListRegionsResponse getRegions( final HttpServletRequest nativeRequest = webRequest.getNativeRequest(HttpServletRequest.class); - ServiceContext context = ApiUtils.createServiceContext(nativeRequest); - ApplicationContext applicationContext = ApplicationContextHolder.get(); - Collection daos = - applicationContext.getBeansOfType(RegionsDAO.class).values(); + try (ServiceContext context = ApiUtils.createServiceContext(nativeRequest)) { + ApplicationContext applicationContext = ApplicationContextHolder.get(); + Collection daos = + applicationContext.getBeansOfType(RegionsDAO.class).values(); - Collection regions = Lists.newArrayList(); - for (RegionsDAO dao : daos) { - if (dao.includeInListing()) { - Request request = createRequest(label, categoryId, maxRecords, context, dao); - regions.addAll(request.execute()); + Collection regions = Lists.newArrayList(); + for (RegionsDAO dao : daos) { + if (dao.includeInListing()) { + Request request = createRequest(label, categoryId, maxRecords, context, dao); + regions.addAll(request.execute()); + } } - } - final HttpServletResponse nativeResponse = webRequest.getNativeResponse(HttpServletResponse.class); + final HttpServletResponse nativeResponse = webRequest.getNativeResponse(HttpServletResponse.class); + + nativeResponse.setHeader("Cache-Control", "no-cache"); + return new ListRegionsResponse(regions); + } - nativeResponse.setHeader("Cache-Control", "no-cache"); - return new ListRegionsResponse(regions); } @io.swagger.v3.oas.annotations.Operation( @@ -156,45 +158,45 @@ public ListRegionsResponse getRegions( @ResponseBody public List getRegionTypes( HttpServletRequest request) throws Exception { + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + String language = languageUtils.getIso3langCode(request.getLocales()); + Collection daos = ApplicationContextHolder.get().getBeansOfType(RegionsDAO.class).values(); + List response = new ArrayList<>(); + for (RegionsDAO dao : daos) { + if (dao instanceof ThesaurusBasedRegionsDAO) { + java.util.List keywords = + ((ThesaurusBasedRegionsDAO) dao).getRegionTopConcepts(context); + if (keywords != null) { + for (KeywordBean k : keywords) { + String label = ""; + try { + label = k.getPreferredLabel(language); + } catch (LabelNotFoundException ex) { + label = k.getDefaultValue(); + } - String language = languageUtils.getIso3langCode(request.getLocales()); - ServiceContext context = ApiUtils.createServiceContext(request); - Collection daos = ApplicationContextHolder.get().getBeansOfType(RegionsDAO.class).values(); - List response = new ArrayList<>(); - for (RegionsDAO dao : daos) { - if (dao instanceof ThesaurusBasedRegionsDAO) { - java.util.List keywords = - ((ThesaurusBasedRegionsDAO) dao).getRegionTopConcepts(context); - if (keywords != null) { - for (KeywordBean k : keywords) { - String label = ""; - try { - label = k.getPreferredLabel(language); - } catch (LabelNotFoundException ex) { - label = k.getDefaultValue(); + Category c = new Category( + k.getUriCode(), + label + ); + response.add(c); } - - Category c = new Category( - k.getUriCode(), - label - ); - response.add(c); } - } - } else { - Collection ids = dao.getRegionCategoryIds(context); - if (ids != null) { - for (String id : ids) { - Category c = new Category( - id, - null - ); - response.add(c); + } else { + Collection ids = dao.getRegionCategoryIds(context); + if (ids != null) { + for (String id : ids) { + Category c = new Category( + id, + null + ); + response.add(c); + } } } } + return response; } - return response; } @io.swagger.v3.oas.annotations.Operation( @@ -224,42 +226,43 @@ public HttpEntity getGeomAsImage( NativeWebRequest nativeWebRequest, @Parameter(hidden = true) HttpServletRequest request) throws Exception { - final ServiceContext context = ApiUtils.createServiceContext(request); - if (width != null && height != null) { - throw new BadParameterEx( - WIDTH_PARAM, - "Only one of " - + WIDTH_PARAM - + " and " - + HEIGHT_PARAM - + " can be defined currently. Future versions may support this but it is not supported at the moment"); - } + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + if (width != null && height != null) { + throw new BadParameterEx( + WIDTH_PARAM, + "Only one of " + + WIDTH_PARAM + + " and " + + HEIGHT_PARAM + + " can be defined currently. Future versions may support this but it is not supported at the moment"); + } - if (width == null && height == null) { - throw new BadParameterEx(WIDTH_PARAM, "One of " + WIDTH_PARAM + " or " + HEIGHT_PARAM - + " parameters must be included in the request"); + if (width == null && height == null) { + throw new BadParameterEx(WIDTH_PARAM, "One of " + WIDTH_PARAM + " or " + HEIGHT_PARAM + + " parameters must be included in the request"); - } + } - String outputFileName = "geom.png"; - String regionId = null; + String outputFileName = "geom.png"; + String regionId = null; - if (nativeWebRequest.checkNotModified(geomParam + srs + background)) { - return null; - } + if (nativeWebRequest.checkNotModified(geomParam + srs + background)) { + return null; + } - MapRenderer renderer = new MapRenderer(context); - BufferedImage image = renderer.render(regionId, srs, width, height, background, geomParam, geomType, geomSrs, null, null); + MapRenderer renderer = new MapRenderer(context); + BufferedImage image = renderer.render(regionId, srs, width, height, background, geomParam, geomType, geomSrs, null, null); - if (image == null) return null; + if (image == null) return null; - try (ByteArrayOutputStream out = new ByteArrayOutputStream()) { - ImageIO.write(image, "png", out); - MultiValueMap headers = new HttpHeaders(); - headers.add("Content-Disposition", "inline; filename=\"" + outputFileName + "\""); - headers.add("Cache-Control", "public, max-age: " + TimeUnit.DAYS.toSeconds(5)); - headers.add("Content-Type", "image/png"); - return new HttpEntity<>(out.toByteArray(), headers); + try (ByteArrayOutputStream out = new ByteArrayOutputStream()) { + ImageIO.write(image, "png", out); + MultiValueMap headers = new HttpHeaders(); + headers.add("Content-Disposition", "inline; filename=\"" + outputFileName + "\""); + headers.add("Cache-Control", "public, max-age: " + TimeUnit.DAYS.toSeconds(5)); + headers.add("Content-Type", "image/png"); + return new HttpEntity<>(out.toByteArray(), headers); + } } } } diff --git a/services/src/main/java/org/fao/geonet/api/regions/ThesaurusRequest.java b/services/src/main/java/org/fao/geonet/api/regions/ThesaurusRequest.java index 483bd9d8119e..d7344c2aed7d 100644 --- a/services/src/main/java/org/fao/geonet/api/regions/ThesaurusRequest.java +++ b/services/src/main/java/org/fao/geonet/api/regions/ThesaurusRequest.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -54,6 +54,9 @@ public class ThesaurusRequest extends Request { private static final CoordinateReferenceSystem WGS84 = Region.WGS84; private final WeakHashMap> categoryTranslations; + /** + * Service context for the request, used for bean lookup. + */ private final ServiceContext serviceContext; private final KeywordSearchParamsBuilder searchBuilder; private final Thesaurus thesaurus; diff --git a/services/src/main/java/org/fao/geonet/api/registries/DirectoryApi.java b/services/src/main/java/org/fao/geonet/api/registries/DirectoryApi.java index f46658c8073d..5d0c35d7ed8b 100644 --- a/services/src/main/java/org/fao/geonet/api/registries/DirectoryApi.java +++ b/services/src/main/java/org/fao/geonet/api/registries/DirectoryApi.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2016 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -193,9 +193,9 @@ public ResponseEntity previewExtractedEntries( String identifierXpath, HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - - return collectEntries(context, uuids, bucket, xpath, identifierXpath, false, null); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + return collectEntries(context, uuids, bucket, xpath, identifierXpath, false, null); + } } @@ -238,9 +238,9 @@ public ResponseEntity extractEntries( // TODO: Add an option to set groupOwner ? // TODO: Add an option to set privileges ? ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - - return collectEntries(context, uuids, bucket, xpath, identifierXpath, true, null); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + return collectEntries(context, uuids, bucket, xpath, identifierXpath, true, null); + } } @@ -368,9 +368,9 @@ public ResponseEntity previewUpdatedRecordEntries( String fq, HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - - return updateRecordEntries(context, uuids, bucket, xpath, identifierXpath, propertiesToCopy, substituteAsXLink, false, fq); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + return updateRecordEntries(context, uuids, bucket, xpath, identifierXpath, propertiesToCopy, substituteAsXLink, false, fq); + } } @@ -422,9 +422,9 @@ public ResponseEntity updateRecordEntries( String fq, HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - - return updateRecordEntries(context, uuids, bucket, xpath, identifierXpath, propertiesToCopy, substituteAsXLink, true, fq); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + return updateRecordEntries(context, uuids, bucket, xpath, identifierXpath, propertiesToCopy, substituteAsXLink, true, fq); + } } @@ -628,105 +628,106 @@ public SimpleMetadataProcessingReport importSpatialEntries( MultipartHttpServletRequest request) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - ApplicationContext applicationContext = ApplicationContextHolder.get(); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + ApplicationContext applicationContext = ApplicationContextHolder.get(); - MetadataSchema metadataSchema = dataManager.getSchema(schema); - Path xslProcessing = metadataSchema.getSchemaDir().resolve("process").resolve(process + ".xsl"); + MetadataSchema metadataSchema = dataManager.getSchema(schema); + Path xslProcessing = metadataSchema.getSchemaDir().resolve("process").resolve(process + ".xsl"); - File[] shapeFiles = unzipAndFilterShp(file); + File[] shapeFiles = unzipAndFilterShp(file); - CollectResults collectResults = new CollectResults(); + CollectResults collectResults = new CollectResults(); - SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); + SimpleMetadataProcessingReport report = new SimpleMetadataProcessingReport(); - for (File shapeFile : shapeFiles) { + for (File shapeFile : shapeFiles) { - SimpleFeatureCollection collection = shapeFileToFeatureCollection(shapeFile, charset); + SimpleFeatureCollection collection = shapeFileToFeatureCollection(shapeFile, charset); - try (FeatureIterator features = collection.features()) { + try (FeatureIterator features = collection.features()) { - while (features.hasNext()) { - SimpleFeature feature = features.next(); + while (features.hasNext()) { + SimpleFeature feature = features.next(); - String uuid = computeUuid(uuidAttribute, uuidPattern, feature); - String description = computeDescription(descriptionAttribute, feature); - Envelope wgsEnvelope = computeEnvelope(feature); - Geometry featureGeometry = reprojGeom(geomProjectionTo, lenient, feature); - String xmlGeometry = geometryToXml(featureGeometry, collection.getSchema()); + String uuid = computeUuid(uuidAttribute, uuidPattern, feature); + String description = computeDescription(descriptionAttribute, feature); + Envelope wgsEnvelope = computeEnvelope(feature); + Geometry featureGeometry = reprojGeom(geomProjectionTo, lenient, feature); + String xmlGeometry = geometryToXml(featureGeometry, collection.getSchema()); - Map parameters = new HashMap<>(); + Map parameters = new HashMap<>(); - parameters.put("uuid", uuid); - parameters.put("description", description); - parameters.put("east", wgsEnvelope.getMaxX()); - parameters.put("north", wgsEnvelope.getMaxY()); - parameters.put("west", wgsEnvelope.getMinX()); - parameters.put("south", wgsEnvelope.getMinY()); - parameters.put("onlyBoundingBox", onlyBoundingBox); - parameters.put("geometry", xmlGeometry); + parameters.put("uuid", uuid); + parameters.put("description", description); + parameters.put("east", wgsEnvelope.getMaxX()); + parameters.put("north", wgsEnvelope.getMaxY()); + parameters.put("west", wgsEnvelope.getMinX()); + parameters.put("south", wgsEnvelope.getMinY()); + parameters.put("onlyBoundingBox", onlyBoundingBox); + parameters.put("geometry", xmlGeometry); - Element subtemplate = new Element("root"); - Element snippet = Xml.transform(subtemplate, xslProcessing, parameters); + Element subtemplate = new Element("root"); + Element snippet = Xml.transform(subtemplate, xslProcessing, parameters); - collectResults.getEntries().put(uuid, uuid, snippet); + collectResults.getEntries().put(uuid, uuid, snippet); + } } + + report.addInfos(String.format( + "%d entries extracted from shapefile '%s'.", + collection.size(), + shapeFile.getName() + )); } - report.addInfos(String.format( - "%d entries extracted from shapefile '%s'.", - collection.size(), - shapeFile.getName() - )); - } + report.setTotalRecords(collectResults.getEntries().size()); - report.setTotalRecords(collectResults.getEntries().size()); + // Save the snippets and index + if (collectResults.getEntries().size() > 0) { + // Create an empty record providing schema information + // about collected subtemplates + Metadata record = new Metadata(); + record.getDataInfo().setSchemaId(schema); + collectResults.setRecord(record); - // Save the snippets and index - if (collectResults.getEntries().size() > 0) { - // Create an empty record providing schema information - // about collected subtemplates - Metadata record = new Metadata(); - record.getDataInfo().setSchemaId(schema); - collectResults.setRecord(record); + int user = context.getUserSession().getUserIdAsInt(); + String siteId = settingManager.getSiteId(); - int user = context.getUserSession().getUserIdAsInt(); - String siteId = settingManager.getSiteId(); + Map errors = DirectoryUtils.saveEntries( + context, + collectResults, + siteId, user, + group, + false); - Map errors = DirectoryUtils.saveEntries( - context, - collectResults, - siteId, user, - group, - false); + dataManager.flush(); - dataManager.flush(); + Set listOfRecordInternalId = new HashSet<>(); + listOfRecordInternalId.addAll( + collectResults.getEntryIdentifiers().values() + ); - Set listOfRecordInternalId = new HashSet<>(); - listOfRecordInternalId.addAll( - collectResults.getEntryIdentifiers().values() - ); + report.addInfos(String.format( + "%d entries saved.", + listOfRecordInternalId.size() + )); - report.addInfos(String.format( - "%d entries saved.", - listOfRecordInternalId.size() - )); - - BatchOpsMetadataReindexer r = new BatchOpsMetadataReindexer(dataManager, listOfRecordInternalId); - r.process(); + BatchOpsMetadataReindexer r = new BatchOpsMetadataReindexer(dataManager, listOfRecordInternalId); + r.process(); - errors.forEach((k, v) -> - report.addError(v) - ); + errors.forEach((k, v) -> + report.addError(v) + ); - report.close(); - } else { - report.addInfos(String.format("No entry found in ZIP file '%s'", - file.getOriginalFilename())); - report.close(); + report.close(); + } else { + report.addInfos(String.format("No entry found in ZIP file '%s'", + file.getOriginalFilename())); + report.close(); + } + return report; } - return report; } private Geometry reprojGeom(String geomProjectionTo, boolean lenient, SimpleFeature feature) diff --git a/services/src/main/java/org/fao/geonet/api/registries/DirectoryEntriesApi.java b/services/src/main/java/org/fao/geonet/api/registries/DirectoryEntriesApi.java index eb1227744e58..849d8a3a7d9d 100644 --- a/services/src/main/java/org/fao/geonet/api/registries/DirectoryEntriesApi.java +++ b/services/src/main/java/org/fao/geonet/api/registries/DirectoryEntriesApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -149,71 +149,72 @@ public Element getEntry( "The record found with UUID '%s' is not a subtemplate", uuid)); } - ServiceContext context = ApiUtils.createServiceContext(request); - if (langs == null) { - langs = context.getLanguage().split(","); - } + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + if (langs == null) { + langs = context.getLanguage().split(","); + } - Element tpl = metadata.getXmlData(false); + Element tpl = metadata.getXmlData(false); - // Processing parameters process=xpath~value. - // xpath must point to an Element or an Attribute. - if (process != null) { - String[] replaceList = process; - for (String parameters : replaceList) { - int endIndex = parameters.indexOf(SEPARATOR); - if (endIndex == -1) { - continue; - } - String xpath = parameters.substring(0, endIndex); - String value = parameters.substring(endIndex + 1); + // Processing parameters process=xpath~value. + // xpath must point to an Element or an Attribute. + if (process != null) { + String[] replaceList = process; + for (String parameters : replaceList) { + int endIndex = parameters.indexOf(SEPARATOR); + if (endIndex == -1) { + continue; + } + String xpath = parameters.substring(0, endIndex); + String value = parameters.substring(endIndex + 1); - Set allNamespaces = Sets.newHashSet(); - final Iterator descendants = tpl.getDescendants(); - while (descendants.hasNext()) { - Object next = descendants.next(); - if (next instanceof Element) { - Element element = (Element) next; - allNamespaces.add(element.getNamespace()); - for (Object o : tpl.getAdditionalNamespaces()) { - if (o instanceof Namespace) { - Namespace namespace = (Namespace) o; - allNamespaces.add(namespace); + Set allNamespaces = Sets.newHashSet(); + final Iterator descendants = tpl.getDescendants(); + while (descendants.hasNext()) { + Object next = descendants.next(); + if (next instanceof Element) { + Element element = (Element) next; + allNamespaces.add(element.getNamespace()); + for (Object o : tpl.getAdditionalNamespaces()) { + if (o instanceof Namespace) { + Namespace namespace = (Namespace) o; + allNamespaces.add(namespace); + } } } } - } - Object o = Xml.selectSingle(tpl, xpath, Lists.newArrayList(allNamespaces)); - if (o instanceof Element) { - ((Element) o).setText(value); - } else if (o instanceof Attribute) { - ((Attribute) o).setValue(value); + Object o = Xml.selectSingle(tpl, xpath, Lists.newArrayList(allNamespaces)); + if (o instanceof Element) { + ((Element) o).setText(value); + } else if (o instanceof Attribute) { + ((Attribute) o).setValue(value); + } } } - } - // Multilingual record: Remove all localizedString from the subtemplate for langs that are not in the metadata and set the gco:CharacterString - // Monolingual record: Remove all localized strings and extract main gco:CharacterString - List twoCharLangs = new ArrayList(); - for (String l : langs) { - twoCharLangs.add("#" + XslUtil.twoCharLangCode(l).toUpperCase()); - } - MultilingualSchemaPlugin plugin = (MultilingualSchemaPlugin) schemaManager.getSchema(schema).getSchemaPlugin(); - if (plugin != null) { - plugin.removeTranslationFromElement(tpl, twoCharLangs); - } + // Multilingual record: Remove all localizedString from the subtemplate for langs that are not in the metadata and set the gco:CharacterString + // Monolingual record: Remove all localized strings and extract main gco:CharacterString + List twoCharLangs = new ArrayList(); + for (String l : langs) { + twoCharLangs.add("#" + XslUtil.twoCharLangCode(l).toUpperCase()); + } + MultilingualSchemaPlugin plugin = (MultilingualSchemaPlugin) schemaManager.getSchema(schema).getSchemaPlugin(); + if (plugin != null) { + plugin.removeTranslationFromElement(tpl, twoCharLangs); + } - if (transformation != null) { - Element root = new Element("root"); - Element requestElt = new Element("request"); - requestElt.addContent(new Element("transformation").setText(transformation)); - root.addContent(requestElt); - root.addContent(tpl); + if (transformation != null) { + Element root = new Element("root"); + Element requestElt = new Element("request"); + requestElt.addContent(new Element("transformation").setText(transformation)); + root.addContent(requestElt); + root.addContent(tpl); - Path xslt = dataDirectory.getWebappDir() - .resolve("xslt/services/subtemplate/convert.xsl"); - return Xml.transform(root, xslt); - } else { - return tpl; + Path xslt = dataDirectory.getWebappDir() + .resolve("xslt/services/subtemplate/convert.xsl"); + return Xml.transform(root, xslt); + } else { + return tpl; + } } } } diff --git a/services/src/main/java/org/fao/geonet/api/registries/vocabularies/KeywordsApi.java b/services/src/main/java/org/fao/geonet/api/registries/vocabularies/KeywordsApi.java index 1bf2559de503..49c681c1b729 100644 --- a/services/src/main/java/org/fao/geonet/api/registries/vocabularies/KeywordsApi.java +++ b/services/src/main/java/org/fao/geonet/api/registries/vocabularies/KeywordsApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -266,55 +266,55 @@ public Object searchKeywords( HttpSession httpSession ) throws Exception { - ConfigurableApplicationContext applicationContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); - UserSession session = ApiUtils.getUserSession(httpSession); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + UserSession session = ApiUtils.getUserSession(httpSession); // Locale locale = languageUtils.parseAcceptLanguage(request.getLocales()); // lang = locale.getISO3Language(); - KeywordsSearcher searcher; - // perform the search and save search result into session - if (Log.isDebugEnabled("KeywordsManager")) { - Log.debug("KeywordsManager", "Creating new keywords searcher"); - } - searcher = new KeywordsSearcher(context, thesaurusMan); + KeywordsSearcher searcher; + // perform the search and save search result into session + if (Log.isDebugEnabled("KeywordsManager")) { + Log.debug("KeywordsManager", "Creating new keywords searcher"); + } + searcher = new KeywordsSearcher(context, thesaurusMan); - String thesauriDomainName = null; + String thesauriDomainName = null; - List thesauri=null; - if (thesaurus!=null) - thesauri=Arrays.asList(thesaurus); + List thesauri=null; + if (thesaurus!=null) + thesauri=Arrays.asList(thesaurus); - KeywordSearchParamsBuilder builder = parseBuilder( - lang, q, rows, start, - targetLangs, thesauri, - thesauriDomainName, type, uri, languagesMapper); + KeywordSearchParamsBuilder builder = parseBuilder( + lang, q, rows, start, + targetLangs, thesauri, + thesauriDomainName, type, uri, languagesMapper); // if (checkModified(webRequest, thesaurusMan, builder)) { // return null; // } - if (q == null || q.trim().isEmpty()) { - builder.setComparator(KeywordSort.defaultLabelSorter(SortDirection.parse(sort))); - } else { - builder.setComparator(KeywordSort.searchResultsSorter(q, SortDirection.parse(sort))); - } + if (q == null || q.trim().isEmpty()) { + builder.setComparator(KeywordSort.defaultLabelSorter(SortDirection.parse(sort))); + } else { + builder.setComparator(KeywordSort.searchResultsSorter(q, SortDirection.parse(sort))); + } - searcher.search(builder.build()); - session.setProperty(Geonet.Session.SEARCH_KEYWORDS_RESULT, - searcher); + searcher.search(builder.build()); + session.setProperty(Geonet.Session.SEARCH_KEYWORDS_RESULT, + searcher); - List keywords = searcher.getResults(); + List keywords = searcher.getResults(); - if ("xml".equals(request.getParameter(CONTENT_TYPE))) { - Element root = new Element("response"); - for (KeywordBean kw : keywords) { - root.addContent(kw.toElement("eng")); // FIXME: Localize + if ("xml".equals(request.getParameter(CONTENT_TYPE))) { + Element root = new Element("response"); + for (KeywordBean kw : keywords) { + root.addContent(kw.toElement("eng")); // FIXME: Localize + } + return root; + } else { + return keywords; } - return root; - } else { - return keywords; } } @@ -394,132 +394,133 @@ public Object getKeywordById( HttpServletRequest request ) throws Exception { final String SEPARATOR = ","; - ServiceContext context = ApiUtils.createServiceContext(request); - boolean isJson = MediaType.APPLICATION_JSON_VALUE.equals(accept); - - // Search thesaurus by name (as facet key only contains the name of the thesaurus) - Thesaurus thesaurus = thesaurusManager.getThesaurusByName(sThesaurusName); - if (thesaurus == null) { - String finalSThesaurusName = sThesaurusName; - Optional thesaurusEntry = thesaurusManager.getThesauriMap().values().stream().filter(t -> t.getKey().endsWith(finalSThesaurusName)).findFirst(); - if (!thesaurusEntry.isPresent()) { - throw new IllegalArgumentException(String.format( - "Thesaurus '%s' not found.", sThesaurusName)); - } else { - thesaurus = thesaurusEntry.get(); - sThesaurusName = thesaurusEntry.get().getKey(); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + boolean isJson = MediaType.APPLICATION_JSON_VALUE.equals(accept); + + // Search thesaurus by name (as facet key only contains the name of the thesaurus) + Thesaurus thesaurus = thesaurusManager.getThesaurusByName(sThesaurusName); + if (thesaurus == null) { + String finalSThesaurusName = sThesaurusName; + Optional thesaurusEntry = thesaurusManager.getThesauriMap().values().stream().filter(t -> t.getKey().endsWith(finalSThesaurusName)).findFirst(); + if (!thesaurusEntry.isPresent()) { + throw new IllegalArgumentException(String.format( + "Thesaurus '%s' not found.", sThesaurusName)); + } else { + thesaurus = thesaurusEntry.get(); + sThesaurusName = thesaurusEntry.get().getKey(); + } } - } - if (langs == null) { - langs = context.getLanguage().split(","); - } - String[] iso3langCodes = Arrays.copyOf(langs, langs.length); - for (int i = 0; i < langs.length; i++) { - if (StringUtils.isNotEmpty(langs[i])) { - langs[i] = mapper.iso639_2_to_iso639_1(langs[i], langs[i].substring(0,2)); //default: fra -> fr + if (langs == null) { + langs = context.getLanguage().split(","); + } + String[] iso3langCodes = Arrays.copyOf(langs, langs.length); + for (int i = 0; i < langs.length; i++) { + if (StringUtils.isNotEmpty(langs[i])) { + langs[i] = mapper.iso639_2_to_iso639_1(langs[i], langs[i].substring(0,2)); //default: fra -> fr + } } - } - Element descKeys; - Map jsonResponse = new HashMap<>(); + Element descKeys; + Map jsonResponse = new HashMap<>(); - uri = URLDecoder.decode(uri, "UTF-8"); + uri = URLDecoder.decode(uri, "UTF-8"); - if (uri == null) { - descKeys = new Element("descKeys"); - } else { - KeywordsSearcher searcher = new KeywordsSearcher(context, thesaurusManager); + if (uri == null) { + descKeys = new Element("descKeys"); + } else { + KeywordsSearcher searcher = new KeywordsSearcher(context, thesaurusManager); - KeywordBean kb; - String[] url; - if (!uri.contains(SEPARATOR)) { - url = new String[]{uri}; - } - else { - url = uri.split(SEPARATOR); - } - List kbList = new ArrayList<>(); - for (String currentUri : url) { - kb = searcher.searchById(currentUri, sThesaurusName, iso3langCodes); - if (kb == null) { - kb = searcher.searchById(currentUri, sThesaurusName, langs); + KeywordBean kb; + String[] url; + if (!uri.contains(SEPARATOR)) { + url = new String[]{uri}; } - if (kb == null) { - kb = searcher.searchById(ApiUtils.fixURIFragment(currentUri), sThesaurusName, iso3langCodes); + else { + url = uri.split(SEPARATOR); } - if (kb == null) { - kb = searcher.searchById(ApiUtils.fixURIFragment(currentUri), sThesaurusName, langs); + List kbList = new ArrayList<>(); + for (String currentUri : url) { + kb = searcher.searchById(currentUri, sThesaurusName, iso3langCodes); + if (kb == null) { + kb = searcher.searchById(currentUri, sThesaurusName, langs); + } + if (kb == null) { + kb = searcher.searchById(ApiUtils.fixURIFragment(currentUri), sThesaurusName, iso3langCodes); + } + if (kb == null) { + kb = searcher.searchById(ApiUtils.fixURIFragment(currentUri), sThesaurusName, langs); + } + if (kb != null) { + kbList.add(kb); + } } - if (kb != null) { - kbList.add(kb); + descKeys = new Element("descKeys"); + for (KeywordBean keywordBean : kbList) { + if (isJson) { + jsonResponse.put( + keywordBean.getUriCode(), + // Requested lang or the first non empty value + keywordBean.getDefaultValue() + ); + } else { + KeywordsSearcher.toRawElement(descKeys, keywordBean); + } } } - descKeys = new Element("descKeys"); - for (KeywordBean keywordBean : kbList) { - if (isJson) { - jsonResponse.put( - keywordBean.getUriCode(), - // Requested lang or the first non empty value - keywordBean.getDefaultValue() - ); - } else { - KeywordsSearcher.toRawElement(descKeys, keywordBean); + + Element langConversion = null; + if ( (langMapJson != null) && (!langMapJson.isEmpty()) ){ + JSONObject obj = JSONObject.fromObject(langMapJson); + langConversion = new Element("languageConversions"); + for(Object entry : obj.entrySet()) { + String key = ((Map.Entry) entry).getKey().toString(); + String value = ((Map.Entry) entry).getValue().toString(); + Element conv = new Element("conversion"); + conv.setAttribute("from",key.toString()); + conv.setAttribute("to",value.toString().replace("#","")); + langConversion.addContent(conv); } - } - } - Element langConversion = null; - if ( (langMapJson != null) && (!langMapJson.isEmpty()) ){ - JSONObject obj = JSONObject.fromObject(langMapJson); - langConversion = new Element("languageConversions"); - for(Object entry : obj.entrySet()) { - String key = ((Map.Entry) entry).getKey().toString(); - String value = ((Map.Entry) entry).getValue().toString(); - Element conv = new Element("conversion"); - conv.setAttribute("from",key.toString()); - conv.setAttribute("to",value.toString().replace("#","")); - langConversion.addContent(conv); } - } - - if (isJson) { - return jsonResponse; - } else { - Path convertXsl = dataDirectory.getWebappDir().resolve("xslt/services/thesaurus/convert.xsl"); - - Element gui = new Element("gui"); - Element nodeUrl = new Element("nodeUrl").setText(settingManager.getNodeURL()); - Element nodeId = new Element("nodeId").setText(context.getNodeId()); - Element thesaurusEl = new Element("thesaurus"); - final Element root = new Element("root"); - - gui.addContent(thesaurusEl); - thesaurusEl.addContent(thesaurusManager.buildResultfromThTable(context)); - - Element requestParams = new Element("request"); - for (Map.Entry e : allRequestParams.entrySet()) { - if (e.getKey().equals("lang")) { - requestParams.addContent(new Element(e.getKey()) - .setText(String.join(",", iso3langCodes))); - } else { - requestParams.addContent(new Element(e.getKey()).setText(e.getValue())); + if (isJson) { + return jsonResponse; + } else { + Path convertXsl = dataDirectory.getWebappDir().resolve("xslt/services/thesaurus/convert.xsl"); + + Element gui = new Element("gui"); + Element nodeUrl = new Element("nodeUrl").setText(settingManager.getNodeURL()); + Element nodeId = new Element("nodeId").setText(context.getNodeId()); + Element thesaurusEl = new Element("thesaurus"); + final Element root = new Element("root"); + + gui.addContent(thesaurusEl); + thesaurusEl.addContent(thesaurusManager.buildResultfromThTable(context)); + + Element requestParams = new Element("request"); + for (Map.Entry e : allRequestParams.entrySet()) { + if (e.getKey().equals("lang")) { + requestParams.addContent(new Element(e.getKey()) + .setText(String.join(",", iso3langCodes))); + } else { + requestParams.addContent(new Element(e.getKey()).setText(e.getValue())); + } + } + if (langConversion != null) { + requestParams.addContent(langConversion); } - } - if (langConversion != null) { - requestParams.addContent(langConversion); - } - root.addContent(requestParams); - root.addContent(descKeys); - root.addContent(gui); - root.addContent(nodeUrl); - root.addContent(nodeId); - final Element transform = Xml.transform(root, convertXsl); + root.addContent(requestParams); + root.addContent(descKeys); + root.addContent(gui); + root.addContent(nodeUrl); + root.addContent(nodeId); + final Element transform = Xml.transform(root, convertXsl); - return transform; + return transform; + } } } @@ -674,74 +675,76 @@ public String uploadThesaurus( ) throws Exception { long start = System.currentTimeMillis(); - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { - // Different options for upload - boolean fileUpload = file != null && !file.isEmpty(); - // Upload RDF file - Path rdfFile = null; - String fname = null; - File tempDir = null; + // Different options for upload + boolean fileUpload = file != null && !file.isEmpty(); - if (fileUpload) { + // Upload RDF file + Path rdfFile = null; + String fname = null; + File tempDir = null; - Log.debug(Geonet.THESAURUS, "Uploading thesaurus file: " + file.getOriginalFilename()); + if (fileUpload) { - tempDir = Files.createTempDirectory("thesaurus").toFile(); + Log.debug(Geonet.THESAURUS, "Uploading thesaurus file: " + file.getOriginalFilename()); - Path tempFilePath = tempDir.toPath().resolve(file.getOriginalFilename()); - File convFile = tempFilePath.toFile(); - file.transferTo(convFile); + tempDir = Files.createTempDirectory("thesaurus").toFile(); - rdfFile = convFile.toPath(); - fname = file.getOriginalFilename(); - } else { + Path tempFilePath = tempDir.toPath().resolve(file.getOriginalFilename()); + File convFile = tempFilePath.toFile(); + file.transferTo(convFile); - Log.debug(Geonet.THESAURUS, "No file provided for thesaurus upload."); - throw new MissingServletRequestParameterException("Thesaurus source not provided", "file"); - } + rdfFile = convFile.toPath(); + fname = file.getOriginalFilename(); + } else { - try { - if (StringUtils.isEmpty(fname)) { - throw new Exception("File upload from URL or file return null"); + Log.debug(Geonet.THESAURUS, "No file provided for thesaurus upload."); + throw new MissingServletRequestParameterException("Thesaurus source not provided", "file"); } - long fsize; - if (rdfFile != null && Files.exists(rdfFile)) { - fsize = Files.size(rdfFile); - } else { - throw new MissingServletRequestParameterException("Thesaurus file doesn't exist", "file"); - } + try { + if (StringUtils.isEmpty(fname)) { + throw new Exception("File upload from URL or file return null"); + } - // -- check that the archive actually has something in it - if (fsize == 0) { - throw new MissingServletRequestParameterException("Thesaurus file has zero size", "file"); - } + long fsize; + if (rdfFile != null && Files.exists(rdfFile)) { + fsize = Files.size(rdfFile); + } else { + throw new MissingServletRequestParameterException("Thesaurus file doesn't exist", "file"); + } - String extension = FilenameUtils.getExtension(fname); + // -- check that the archive actually has something in it + if (fsize == 0) { + throw new MissingServletRequestParameterException("Thesaurus file has zero size", "file"); + } - if (extension.equalsIgnoreCase("rdf") || - extension.equalsIgnoreCase("xml")) { - Log.debug(Geonet.THESAURUS, "Uploading thesaurus: " + fname); + String extension = FilenameUtils.getExtension(fname); - // Rename .xml to .rdf for all thesaurus - fname = fname.replace(extension, "rdf"); - uploadThesaurus(rdfFile, stylesheet, context, fname, type, dir); - } else { - Log.debug(Geonet.THESAURUS, "Incorrect extension for thesaurus named: " + fname); - throw new Exception("Incorrect extension for thesaurus named: " - + fname); - } + if (extension.equalsIgnoreCase("rdf") || + extension.equalsIgnoreCase("xml")) { + Log.debug(Geonet.THESAURUS, "Uploading thesaurus: " + fname); - long end = System.currentTimeMillis(); - long duration = (end - start) / 1000; + // Rename .xml to .rdf for all thesaurus + fname = fname.replace(extension, "rdf"); + uploadThesaurus(rdfFile, stylesheet, context, fname, type, dir); + } else { + Log.debug(Geonet.THESAURUS, "Incorrect extension for thesaurus named: " + fname); + throw new Exception("Incorrect extension for thesaurus named: " + + fname); + } - return String.format("Thesaurus '%s' loaded in %d sec.", - fname, duration); - } finally { - if (tempDir != null) { - FileUtils.deleteQuietly(tempDir); + long end = System.currentTimeMillis(); + long duration = (end - start) / 1000; + + return String.format("Thesaurus '%s' loaded in %d sec.", + fname, duration); + } finally { + if (tempDir != null) { + FileUtils.deleteQuietly(tempDir); + } } } } @@ -832,67 +835,67 @@ public void importCsvAsThesaurus( HttpServletRequest request, HttpServletResponse response ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + String fname = file.getOriginalFilename(); + Log.debug(Geonet.THESAURUS, "Uploading CSV file: " + fname); + File tempDir = Files.createTempDirectory("thesaurus").toFile(); + Path tempFilePath = tempDir.toPath().resolve(file.getOriginalFilename()); + File convFile = tempFilePath.toFile(); + file.transferTo(convFile); + Path csvFile = convFile.toPath(); - String fname = file.getOriginalFilename(); - Log.debug(Geonet.THESAURUS, "Uploading CSV file: " + fname); - File tempDir = Files.createTempDirectory("thesaurus").toFile(); - Path tempFilePath = tempDir.toPath().resolve(file.getOriginalFilename()); - File convFile = tempFilePath.toFile(); - file.transferTo(convFile); - Path csvFile = convFile.toPath(); + try { + if (StringUtils.isEmpty(fname)) { + throw new Exception("File missing."); + } - try { - if (StringUtils.isEmpty(fname)) { - throw new Exception("File missing."); - } + long fsize; + if (csvFile != null && Files.exists(csvFile)) { + fsize = Files.size(csvFile); + } else { + throw new MissingServletRequestParameterException("CSV file doesn't exist", "file"); + } - long fsize; - if (csvFile != null && Files.exists(csvFile)) { - fsize = Files.size(csvFile); - } else { - throw new MissingServletRequestParameterException("CSV file doesn't exist", "file"); - } + if (fsize == 0) { + throw new MissingServletRequestParameterException("CSV file has zero size", "file"); + } - if (fsize == 0) { - throw new MissingServletRequestParameterException("CSV file has zero size", "file"); - } + String extension = FilenameUtils.getExtension(fname); + Element element = convertCsvToSkos(csvFile, + languages, + encoding, + thesaurusNs, + thesaurusTitle, + conceptIdColumn, + conceptLabelColumn, + conceptDescriptionColumn, + conceptBroaderIdColumn, + conceptNarrowerIdColumn, + conceptRelatedIdColumn, + conceptLinkSeparator); - String extension = FilenameUtils.getExtension(fname); - Element element = convertCsvToSkos(csvFile, - languages, - encoding, - thesaurusNs, - thesaurusTitle, - conceptIdColumn, - conceptLabelColumn, - conceptDescriptionColumn, - conceptBroaderIdColumn, - conceptNarrowerIdColumn, - conceptRelatedIdColumn, - conceptLinkSeparator); - - fname = fname.replace(extension, "rdf"); - - if(importAsThesaurus) { - Path rdfFile = tempDir.toPath().resolve(fname); - XMLOutputter xmlOutput = new XMLOutputter(); - xmlOutput.setFormat(Format.getCompactFormat()); - xmlOutput.output(element, - new OutputStreamWriter(new FileOutputStream(rdfFile.toFile().getCanonicalPath()), - StandardCharsets.UTF_8)); - uploadThesaurus(rdfFile, "_none_", context, fname, type, dir); - response.setStatus(HttpServletResponse.SC_CREATED); - } else { - response.addHeader("Content-Disposition", "inline; filename=\"" + fname + "\""); - response.setStatus(HttpServletResponse.SC_OK); - response.setCharacterEncoding(Constants.ENCODING); - response.setContentType(MediaType.APPLICATION_XML_VALUE); - response.getOutputStream().write(Xml.getString(element).getBytes()); - } - } finally { - if (tempDir != null) { - FileUtils.deleteQuietly(tempDir); + fname = fname.replace(extension, "rdf"); + + if(importAsThesaurus) { + Path rdfFile = tempDir.toPath().resolve(fname); + XMLOutputter xmlOutput = new XMLOutputter(); + xmlOutput.setFormat(Format.getCompactFormat()); + xmlOutput.output(element, + new OutputStreamWriter(new FileOutputStream(rdfFile.toFile().getCanonicalPath()), + StandardCharsets.UTF_8)); + uploadThesaurus(rdfFile, "_none_", context, fname, type, dir); + response.setStatus(HttpServletResponse.SC_CREATED); + } else { + response.addHeader("Content-Disposition", "inline; filename=\"" + fname + "\""); + response.setStatus(HttpServletResponse.SC_OK); + response.setCharacterEncoding(Constants.ENCODING); + response.setContentType(MediaType.APPLICATION_XML_VALUE); + response.getOutputStream().write(Xml.getString(element).getBytes()); + } + } finally { + if (tempDir != null) { + FileUtils.deleteQuietly(tempDir); + } } } } @@ -1113,85 +1116,85 @@ public String uploadThesaurusFromUrl( ) throws Exception { long start = System.currentTimeMillis(); - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + boolean urlUpload = !StringUtils.isEmpty(url); + boolean registryUpload = !StringUtils.isEmpty(registryUrl); - boolean urlUpload = !StringUtils.isEmpty(url); - boolean registryUpload = !StringUtils.isEmpty(registryUrl); + // Upload RDF file + Path rdfFile = null; + String fname = null; - // Upload RDF file - Path rdfFile = null; - String fname = null; + // Specific upload steps + if (urlUpload) { - // Specific upload steps - if (urlUpload) { + Log.debug(Geonet.THESAURUS, "Uploading thesaurus from URL: " + url); - Log.debug(Geonet.THESAURUS, "Uploading thesaurus from URL: " + url); + rdfFile = getXMLContentFromUrl(url, context); + fname = url.substring(url.lastIndexOf("/") + 1).replaceAll("\\s+", ""); - rdfFile = getXMLContentFromUrl(url, context); - fname = url.substring(url.lastIndexOf("/") + 1).replaceAll("\\s+", ""); - - // File with no extension in URL - if (fname.lastIndexOf('.') == -1) { - fname += ".rdf"; - } + // File with no extension in URL + if (fname.lastIndexOf('.') == -1) { + fname += ".rdf"; + } - } else if (registryUpload) { - if (ArrayUtils.isEmpty(registryLanguage)) { - throw new MissingServletRequestParameterException("Select at least one language.", "language"); - } + } else if (registryUpload) { + if (ArrayUtils.isEmpty(registryLanguage)) { + throw new MissingServletRequestParameterException("Select at least one language.", "language"); + } - Log.debug(Geonet.THESAURUS, "Uploading thesaurus from registry : " + registryUrl); + Log.debug(Geonet.THESAURUS, "Uploading thesaurus from registry : " + registryUrl); - String itemName = registryUrl.substring((registryUrl.lastIndexOf("/") + 1)); + String itemName = registryUrl.substring((registryUrl.lastIndexOf("/") + 1)); - rdfFile = extractSKOSFromRegistry(registryUrl, registryType, itemName, registryLanguage, context); - fname = registryUrl.replaceAll("[^A-Za-z]+", "") + - "-" + - itemName + ".rdf"; + rdfFile = extractSKOSFromRegistry(registryUrl, registryType, itemName, registryLanguage, context); + fname = registryUrl.replaceAll("[^A-Za-z]+", "") + + "-" + + itemName + ".rdf"; - } else { + } else { - Log.debug(Geonet.THESAURUS, "No URL or file name provided for thesaurus upload."); - throw new MissingServletRequestParameterException("Thesaurus source not provided", "url"); + Log.debug(Geonet.THESAURUS, "No URL or file name provided for thesaurus upload."); + throw new MissingServletRequestParameterException("Thesaurus source not provided", "url"); - } + } - if (StringUtils.isEmpty(fname)) { - throw new ResourceNotFoundException("File upload from URL or file return null"); - } + if (StringUtils.isEmpty(fname)) { + throw new ResourceNotFoundException("File upload from URL or file return null"); + } - long fsize; - if (rdfFile != null && Files.exists(rdfFile)) { - fsize = Files.size(rdfFile); - } else { - throw new ResourceNotFoundException("Thesaurus file doesn't exist"); - } + long fsize; + if (rdfFile != null && Files.exists(rdfFile)) { + fsize = Files.size(rdfFile); + } else { + throw new ResourceNotFoundException("Thesaurus file doesn't exist"); + } - // -- check that the archive actually has something in it - if (fsize == 0) { - throw new ResourceNotFoundException("Thesaurus file has zero size"); - } + // -- check that the archive actually has something in it + if (fsize == 0) { + throw new ResourceNotFoundException("Thesaurus file has zero size"); + } - String extension = FilenameUtils.getExtension(fname); + String extension = FilenameUtils.getExtension(fname); - if (extension.equalsIgnoreCase("rdf") || - extension.equalsIgnoreCase("xml")) { - Log.debug(Geonet.THESAURUS, "Uploading thesaurus: " + fname); + if (extension.equalsIgnoreCase("rdf") || + extension.equalsIgnoreCase("xml")) { + Log.debug(Geonet.THESAURUS, "Uploading thesaurus: " + fname); - // Rename .xml to .rdf for all thesaurus - fname = fname.replace(extension, "rdf"); - uploadThesaurus(rdfFile, stylesheet, context, fname, type, dir); - } else { - Log.debug(Geonet.THESAURUS, "Incorrect extension for thesaurus named: " + fname); - throw new MissingServletRequestParameterException("Incorrect extension for thesaurus", fname); - } + // Rename .xml to .rdf for all thesaurus + fname = fname.replace(extension, "rdf"); + uploadThesaurus(rdfFile, stylesheet, context, fname, type, dir); + } else { + Log.debug(Geonet.THESAURUS, "Incorrect extension for thesaurus named: " + fname); + throw new MissingServletRequestParameterException("Incorrect extension for thesaurus", fname); + } - long end = System.currentTimeMillis(); - long duration = (end - start) / 1000; + long end = System.currentTimeMillis(); + long duration = (end - start) / 1000; - return String.format("Thesaurus '%s' loaded in %d sec.", - fname, duration); + return String.format("Thesaurus '%s' loaded in %d sec.", + fname, duration); + } } /** diff --git a/services/src/main/java/org/fao/geonet/api/related/Related.java b/services/src/main/java/org/fao/geonet/api/related/Related.java index 63eb9ecc652f..176b98a843ff 100644 --- a/services/src/main/java/org/fao/geonet/api/related/Related.java +++ b/services/src/main/java/org/fao/geonet/api/related/Related.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -106,34 +106,35 @@ public Map getAssociatedResourcesForRecords( String[] uuids, HttpServletRequest request) throws Exception { - Locale language = languageUtils.parseAcceptLanguage(request.getLocales()); - final ServiceContext context = ApiUtils.createServiceContext(request); - Path relatedXsl = dataDirectory.getWebappDir().resolve("xslt/services/metadata/relation.xsl"); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + Locale language = languageUtils.parseAcceptLanguage(request.getLocales()); + Path relatedXsl = dataDirectory.getWebappDir().resolve("xslt/services/metadata/relation.xsl"); - AbstractMetadata md; - Map res = new HashMap(); + AbstractMetadata md; + Map res = new HashMap(); - for (String uuid : uuids) { - try { - md = ApiUtils.canViewRecord(uuid, request); - Element raw = new Element("root").addContent(Arrays.asList( - new Element("gui").addContent(Arrays.asList( - new Element("language").setText(language.getISO3Language()), - new Element("url").setText(context.getBaseUrl()) - )), - MetadataUtils.getRelated(context, md.getId(), md.getUuid(), types, 0, 100, true) - )); - final Element transform = Xml.transform(raw, relatedXsl); - RelatedResponse response = (RelatedResponse) Xml.unmarshall(transform, RelatedResponse.class); - res.put(uuid, response); - } catch (SecurityException e) { - Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); - throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); - } catch (Exception exception) { - Log.debug(API.LOG_MODULE_NAME, exception.getMessage(), exception); - } + for (String uuid : uuids) { + try { + md = ApiUtils.canViewRecord(uuid, context); + Element raw = new Element("root").addContent(Arrays.asList( + new Element("gui").addContent(Arrays.asList( + new Element("language").setText(language.getISO3Language()), + new Element("url").setText(context.getBaseUrl()) + )), + MetadataUtils.getRelated(context, md.getId(), md.getUuid(), types, 0, 100, true) + )); + final Element transform = Xml.transform(raw, relatedXsl); + RelatedResponse response = (RelatedResponse) Xml.unmarshall(transform, RelatedResponse.class); + res.put(uuid, response); + } catch (SecurityException e) { + Log.debug(API.LOG_MODULE_NAME, e.getMessage(), e); + throw new NotAllowedException(ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); + } catch (Exception exception) { + Log.debug(API.LOG_MODULE_NAME, exception.getMessage(), exception); + } + } + return res; } - return res; } } diff --git a/services/src/main/java/org/fao/geonet/api/reports/ReportApi.java b/services/src/main/java/org/fao/geonet/api/reports/ReportApi.java index e97089566766..5af00334b9e0 100644 --- a/services/src/main/java/org/fao/geonet/api/reports/ReportApi.java +++ b/services/src/main/java/org/fao/geonet/api/reports/ReportApi.java @@ -1,3 +1,26 @@ +/* + * Copyright (C) 2001-2021 Food and Agriculture Organization of the + * United Nations (FAO-UN), United Nations World Food Programme (WFP) + * and United Nations Environment Programme (UNEP) + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or (at + * your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + * + * Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2, + * Rome - Italy. email: geonetwork@osgeo.org + */ + package org.fao.geonet.api.reports; import io.swagger.v3.oas.annotations.Operation; @@ -73,15 +96,15 @@ public void getReportDataDownloads( final HttpServletResponse response, final HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - - ReportFilter filter = new ReportFilter(dateFrom, dateTo, - ReportUtils.groupsForFilter(context, groups)); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + ReportFilter filter = new ReportFilter(dateFrom, dateTo, + ReportUtils.groupsForFilter(context, groups)); - ReportDownloads report = new ReportDownloads(filter); - response.setHeader("Content-Disposition", - "attachment; filename=\"downloads.csv\""); - report.create(context, response.getWriter()); + ReportDownloads report = new ReportDownloads(filter); + response.setHeader("Content-Disposition", + "attachment; filename=\"downloads.csv\""); + report.create(context, response.getWriter()); + } } @@ -123,15 +146,15 @@ public void getReportDataUploads( final HttpServletResponse response, final HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - - ReportFilter filter = new ReportFilter(dateFrom, dateTo, - ReportUtils.groupsForFilter(context, groups)); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + ReportFilter filter = new ReportFilter(dateFrom, dateTo, + ReportUtils.groupsForFilter(context, groups)); - ReportUploads report = new ReportUploads(filter); - response.setHeader("Content-Disposition", - "attachment; filename=\"uploads.csv\""); - report.create(context, response.getWriter()); + ReportUploads report = new ReportUploads(filter); + response.setHeader("Content-Disposition", + "attachment; filename=\"uploads.csv\""); + report.create(context, response.getWriter()); + } } @@ -175,15 +198,15 @@ public void getActiveUsers( final HttpServletResponse response, final HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + ReportFilter filter = new ReportFilter(dateFrom, dateTo, + ReportUtils.groupsForFilter(context, groups)); - ReportFilter filter = new ReportFilter(dateFrom, dateTo, - ReportUtils.groupsForFilter(context, groups)); - - ReportUsers report = new ReportUsers(filter); - response.setHeader("Content-Disposition", - "attachment; filename=\"users.csv\""); - report.create(context, response.getWriter()); + ReportUsers report = new ReportUsers(filter); + response.setHeader("Content-Disposition", + "attachment; filename=\"users.csv\""); + report.create(context, response.getWriter()); + } } @@ -226,15 +249,16 @@ public void getReportInternalMetadata( final HttpServletResponse response, final HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + ReportFilter filter = new ReportFilter(dateFrom, dateTo, + ReportUtils.groupsForFilter(context, groups)); - ReportFilter filter = new ReportFilter(dateFrom, dateTo, - ReportUtils.groupsForFilter(context, groups)); + ReportInternalMetadata report = new ReportInternalMetadata(filter); + response.setHeader("Content-Disposition", + "attachment; filename=\"internalmetadata.csv\""); + report.create(context, response.getWriter()); - ReportInternalMetadata report = new ReportInternalMetadata(filter); - response.setHeader("Content-Disposition", - "attachment; filename=\"internalmetadata.csv\""); - report.create(context, response.getWriter()); + } } @@ -277,14 +301,14 @@ public void getReportUpdatedMetadata( final HttpServletResponse response, final HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - - ReportFilter filter = new ReportFilter(dateFrom, dateTo, - ReportUtils.groupsForFilter(context, groups)); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + ReportFilter filter = new ReportFilter(dateFrom, dateTo, + ReportUtils.groupsForFilter(context, groups)); - ReportUpdatedMetadata report = new ReportUpdatedMetadata(filter); - response.setHeader("Content-Disposition", - "attachment; filename=\"updatedmetadata.csv\""); - report.create(context, response.getWriter()); + ReportUpdatedMetadata report = new ReportUpdatedMetadata(filter); + response.setHeader("Content-Disposition", + "attachment; filename=\"updatedmetadata.csv\""); + report.create(context, response.getWriter()); + } } } diff --git a/services/src/main/java/org/fao/geonet/api/selections/SelectionsApi.java b/services/src/main/java/org/fao/geonet/api/selections/SelectionsApi.java index dc840eae02c4..eb55af37e5e8 100644 --- a/services/src/main/java/org/fao/geonet/api/selections/SelectionsApi.java +++ b/services/src/main/java/org/fao/geonet/api/selections/SelectionsApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -25,6 +25,7 @@ import io.swagger.v3.oas.annotations.Parameter; import io.swagger.v3.oas.annotations.tags.Tag; import jeeves.server.UserSession; +import jeeves.server.context.ServiceContext; import org.fao.geonet.api.API; import org.fao.geonet.api.ApiParams; import org.fao.geonet.api.ApiUtils; @@ -107,17 +108,20 @@ ResponseEntity add( HttpServletRequest request ) throws Exception { - UserSession session = ApiUtils.getUserSession(httpSession); - int nbSelected = SelectionManager.updateSelection(bucket, - session, - uuid != null ? - SelectionManager.ADD_SELECTED : - SelectionManager.ADD_ALL_SELECTED, - uuid != null ? - Arrays.asList(uuid) : null, - ApiUtils.createServiceContext(request)); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + UserSession session = ApiUtils.getUserSession(httpSession); + int nbSelected = SelectionManager.updateSelection(bucket, + session, + uuid != null ? + SelectionManager.ADD_SELECTED : + SelectionManager.ADD_ALL_SELECTED, + uuid != null ? + Arrays.asList(uuid) : null, + context); - return new ResponseEntity<>(nbSelected, HttpStatus.CREATED); + return new ResponseEntity<>(nbSelected, HttpStatus.CREATED); + + } } @@ -147,16 +151,18 @@ ResponseEntity clear( HttpServletRequest request ) throws Exception { + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + int nbSelected = SelectionManager.updateSelection(bucket, + ApiUtils.getUserSession(httpSession), + uuid != null ? + SelectionManager.REMOVE_SELECTED : + SelectionManager.REMOVE_ALL_SELECTED, + uuid != null ? + Arrays.asList(uuid) : null, + context); - int nbSelected = SelectionManager.updateSelection(bucket, - ApiUtils.getUserSession(httpSession), - uuid != null ? - SelectionManager.REMOVE_SELECTED : - SelectionManager.REMOVE_ALL_SELECTED, - uuid != null ? - Arrays.asList(uuid) : null, - ApiUtils.createServiceContext(request)); + return new ResponseEntity<>(nbSelected, HttpStatus.OK); - return new ResponseEntity<>(nbSelected, HttpStatus.OK); + } } } diff --git a/services/src/main/java/org/fao/geonet/api/site/LogosApi.java b/services/src/main/java/org/fao/geonet/api/site/LogosApi.java index 18415b931ec2..802a1b54ca5e 100644 --- a/services/src/main/java/org/fao/geonet/api/site/LogosApi.java +++ b/services/src/main/java/org/fao/geonet/api/site/LogosApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -105,16 +105,17 @@ public boolean accept(Path file) { public Set getLogos( HttpServletRequest request ) { - ApplicationContext context = ApplicationContextHolder.get(); - Set icons = context.getBean(Resources.class).listFiles( - ApiUtils.createServiceContext(request), - "harvesting", - iconFilter); - Set iconsList = new HashSet<>(icons.size()); - for (Path i : icons) { - iconsList.add(i.getFileName().toString()); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + Set icons = context.getBean(Resources.class).listFiles( + ApiUtils.createServiceContext(request), + "harvesting", + iconFilter); + Set iconsList = new HashSet<>(icons.size()); + for (Path i : icons) { + iconsList.add(i.getFileName().toString()); + } + return iconsList; } - return iconsList; } @io.swagger.v3.oas.annotations.Operation( @@ -149,25 +150,26 @@ public ResponseEntity addLogo( boolean overwrite, HttpServletRequest request ) throws Exception { - final ApplicationContext appContext = ApplicationContextHolder.get(); - final Resources resources = appContext.getBean(Resources.class); - final ServiceContext serviceContext = ApiUtils.createServiceContext(request); - final Path directoryPath = resources.locateHarvesterLogosDirSMVC(appContext); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { + final ApplicationContext appContext = ApplicationContextHolder.get(); + final Resources resources = appContext.getBean(Resources.class); + final Path directoryPath = resources.locateHarvesterLogosDirSMVC(appContext); - for (MultipartFile f : file) { - String fileName = f.getOriginalFilename(); + for (MultipartFile f : file) { + String fileName = f.getOriginalFilename(); - checkFileName(fileName); + checkFileName(fileName); - try (Resources.ResourceHolder holder = resources.getWritableImage(serviceContext, fileName, directoryPath)) { - if (Files.exists(holder.getPath()) && !overwrite) { - holder.abort(); - throw new ResourceAlreadyExistException(fileName); + try (Resources.ResourceHolder holder = resources.getWritableImage(serviceContext, fileName, directoryPath)) { + if (Files.exists(holder.getPath()) && !overwrite) { + holder.abort(); + throw new ResourceAlreadyExistException(fileName); + } + Files.copy(f.getInputStream(), holder.getPath()); } - Files.copy(f.getInputStream(), holder.getPath()); } + return new ResponseEntity(HttpStatus.CREATED); } - return new ResponseEntity(HttpStatus.CREATED); } private void checkFileName(String fileName) throws Exception { @@ -206,26 +208,27 @@ public void deleteLogo( checkFileName(file); FilePathChecker.verify(file); - final ApplicationContext appContext = ApplicationContextHolder.get(); - final Resources resources = appContext.getBean(Resources.class); - final ServiceContext serviceContext = ApiUtils.createServiceContext(request); - final Path nodeLogoDirectory = resources.locateHarvesterLogosDirSMVC(appContext); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { + final ApplicationContext appContext = ApplicationContextHolder.get(); + final Resources resources = appContext.getBean(Resources.class); + final Path nodeLogoDirectory = resources.locateHarvesterLogosDirSMVC(appContext); - try (Resources.ResourceHolder image = resources.getImage(serviceContext, file, nodeLogoDirectory)) { - if (image != null) { - final List groups = groupRepository.findByLogo(file); - if (groups != null && groups.size() > 0) { - final List groupIds = - groups.stream().map(Group::getName).collect(Collectors.toList()); - throw new IllegalArgumentException(String.format( - "Logo '%s' is used by %d group(s). Assign another logo to the following groups: %s.", - file, groups.size(), groupIds.toString())); - } + try (Resources.ResourceHolder image = resources.getImage(serviceContext, file, nodeLogoDirectory)) { + if (image != null) { + final List groups = groupRepository.findByLogo(file); + if (groups != null && groups.size() > 0) { + final List groupIds = + groups.stream().map(Group::getName).collect(Collectors.toList()); + throw new IllegalArgumentException(String.format( + "Logo '%s' is used by %d group(s). Assign another logo to the following groups: %s.", + file, groups.size(), groupIds.toString())); + } - resources.deleteImageIfExists(file, nodeLogoDirectory); - } else { - throw new ResourceNotFoundException(String.format( - "No logo found with filename '%s'.", file)); + resources.deleteImageIfExists(file, nodeLogoDirectory); + } else { + throw new ResourceNotFoundException(String.format( + "No logo found with filename '%s'.", file)); + } } } } diff --git a/services/src/main/java/org/fao/geonet/api/site/SiteApi.java b/services/src/main/java/org/fao/geonet/api/site/SiteApi.java index a9be0aa23a45..ef6aea9d2a28 100644 --- a/services/src/main/java/org/fao/geonet/api/site/SiteApi.java +++ b/services/src/main/java/org/fao/geonet/api/site/SiteApi.java @@ -462,13 +462,14 @@ public javax.persistence.criteria.Path getPath(Root root) { } SettingInfo info = applicationContext.getBean(SettingInfo.class); - ServiceContext context = ApiUtils.createServiceContext(request); - ServerBeanPropertyUpdater.updateURL(info.getSiteUrl() + - context.getBaseUrl(), - applicationContext); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + ServerBeanPropertyUpdater.updateURL(info.getSiteUrl() + + context.getBaseUrl(), + applicationContext); - // Reload services affected by updated settings - reloadServices(context); + // Reload services affected by updated settings + reloadServices(context); + } } @io.swagger.v3.oas.annotations.Operation( @@ -485,9 +486,10 @@ public javax.persistence.criteria.Path getPath(Root root) { @ResponseBody public SiteInformation getInformation(HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - return new SiteInformation(context, (GeonetContext) context - .getHandlerContext(Geonet.CONTEXT_NAME)); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + return new SiteInformation(context, (GeonetContext) context + .getHandlerContext(Geonet.CONTEXT_NAME)); + } } @io.swagger.v3.oas.annotations.Operation( @@ -504,8 +506,9 @@ public SiteInformation getInformation(HttpServletRequest request public boolean isCasEnabled( HttpServletRequest request ) throws Exception { - ApiUtils.createServiceContext(request); - return ProfileManager.isCasEnabled(); + try(ServiceContext context = ApiUtils.createServiceContext(request)) { + return ProfileManager.isCasEnabled(); + } } @io.swagger.v3.oas.annotations.Operation( @@ -554,8 +557,9 @@ public boolean isReadOnly( public boolean isIndexing( HttpServletRequest request ) throws Exception { - ApiUtils.createServiceContext(request); - return ApplicationContextHolder.get().getBean(DataManager.class).isIndexing(); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + return ApplicationContextHolder.get().getBean(DataManager.class).isIndexing(); + } } @io.swagger.v3.oas.annotations.Operation( @@ -593,28 +597,29 @@ public HttpEntity index( String bucket, HttpServletRequest request ) throws Exception { - ServiceContext context = ApiUtils.createServiceContext(request); - EsSearchManager searchMan = ApplicationContextHolder.get().getBean(EsSearchManager.class); - DataManager dataManager = ApplicationContextHolder.get().getBean(DataManager.class); - boolean isIndexing = dataManager.isIndexing(); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + EsSearchManager searchMan = ApplicationContextHolder.get().getBean(EsSearchManager.class); + DataManager dataManager = ApplicationContextHolder.get().getBean(DataManager.class); + boolean isIndexing = dataManager.isIndexing(); + + if (isIndexing) { + throw new NotAllowedException( + "Indexing is already in progress. Wait for the current task to complete."); + } - if (isIndexing) { - throw new NotAllowedException( - "Indexing is already in progress. Wait for the current task to complete."); - } + if (reset) { + searchMan.init(true, Optional.of(Arrays.asList(indices))); + } - if (reset) { - searchMan.init(true, Optional.of(Arrays.asList(indices))); - } + if (StringUtils.isEmpty(bucket)) { + BaseMetadataManager metadataManager = ApplicationContextHolder.get().getBean(BaseMetadataManager.class); + metadataManager.synchronizeDbWithIndex(context, false, asynchronous); + } else { + searchMan.rebuildIndex(context, havingXlinkOnly, false, bucket); + } - if (StringUtils.isEmpty(bucket)) { - BaseMetadataManager metadataManager = ApplicationContextHolder.get().getBean(BaseMetadataManager.class); - metadataManager.synchronizeDbWithIndex(context, false, asynchronous); - } else { - searchMan.rebuildIndex(context, havingXlinkOnly, false, bucket); + return new HttpEntity<>(HttpStatus.CREATED); } - - return new HttpEntity<>(HttpStatus.CREATED); } @io.swagger.v3.oas.annotations.Operation( @@ -743,59 +748,60 @@ public void setLogo( final ApplicationContext appContext = ApplicationContextHolder.get(); final Resources resources = appContext.getBean(Resources.class); final Path logoDirectory = resources.locateHarvesterLogosDirSMVC(appContext); - final ServiceContext serviceContext = ApiUtils.createServiceContext(request); - checkFileName(file); - FilePathChecker.verify(file); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { + checkFileName(file); + FilePathChecker.verify(file); - SettingManager settingMan = appContext.getBean(SettingManager.class); - String nodeUuid = settingMan.getSiteId(); + SettingManager settingMan = appContext.getBean(SettingManager.class); + String nodeUuid = settingMan.getSiteId(); - Resources.ResourceHolder holder = resources.getImage(serviceContext, file, logoDirectory); - final Path resourcesDir = - resources.locateResourcesDir(request.getServletContext(), serviceContext.getApplicationContext()); - if (holder == null || holder.getPath() == null) { - holder = resources.getImage(serviceContext, "images/harvesting/" + file, resourcesDir); - } - try { - try (InputStream inputStream = Files.newInputStream(holder.getPath())) { - BufferedImage source = ImageIO.read(inputStream); - - if (asFavicon) { - try (Resources.ResourceHolder favicon = - resources.getWritableImage(serviceContext, "images/logos/favicon.png", - resourcesDir)) { - ApiUtils.createFavicon(source, favicon.getPath()); - } - } else { - try (Resources.ResourceHolder logo = - resources.getWritableImage(serviceContext, - "images/logos/" + nodeUuid + ".png", - resourcesDir); - Resources.ResourceHolder defaultLogo = - resources.getWritableImage(serviceContext, - "images/logo.png", resourcesDir)) { - if (!file.endsWith(".png")) { - try ( - OutputStream logoOut = Files.newOutputStream(logo.getPath()); - OutputStream defLogoOut = Files.newOutputStream(defaultLogo.getPath()) - ) { - ImageIO.write(source, "png", logoOut); - ImageIO.write(source, "png", defLogoOut); + Resources.ResourceHolder holder = resources.getImage(serviceContext, file, logoDirectory); + final Path resourcesDir = + resources.locateResourcesDir(request.getServletContext(), serviceContext.getApplicationContext()); + if (holder == null || holder.getPath() == null) { + holder = resources.getImage(serviceContext, "images/harvesting/" + file, resourcesDir); + } + try { + try (InputStream inputStream = Files.newInputStream(holder.getPath())) { + BufferedImage source = ImageIO.read(inputStream); + + if (asFavicon) { + try (Resources.ResourceHolder favicon = + resources.getWritableImage(serviceContext, "images/logos/favicon.png", + resourcesDir)) { + ApiUtils.createFavicon(source, favicon.getPath()); + } + } else { + try (Resources.ResourceHolder logo = + resources.getWritableImage(serviceContext, + "images/logos/" + nodeUuid + ".png", + resourcesDir); + Resources.ResourceHolder defaultLogo = + resources.getWritableImage(serviceContext, + "images/logo.png", resourcesDir)) { + if (!file.endsWith(".png")) { + try ( + OutputStream logoOut = Files.newOutputStream(logo.getPath()); + OutputStream defLogoOut = Files.newOutputStream(defaultLogo.getPath()) + ) { + ImageIO.write(source, "png", logoOut); + ImageIO.write(source, "png", defLogoOut); + } + } else { + Files.copy(holder.getPath(), logo.getPath(), StandardCopyOption.REPLACE_EXISTING); + Files.copy(holder.getPath(), defaultLogo.getPath(), + StandardCopyOption.REPLACE_EXISTING); } - } else { - Files.copy(holder.getPath(), logo.getPath(), StandardCopyOption.REPLACE_EXISTING); - Files.copy(holder.getPath(), defaultLogo.getPath(), - StandardCopyOption.REPLACE_EXISTING); } } } + } catch (Exception e) { + throw new Exception( + "Unable to move uploaded thumbnail to destination directory. Error: " + e.getMessage()); + } finally { + holder.close(); } - } catch (Exception e) { - throw new Exception( - "Unable to move uploaded thumbnail to destination directory. Error: " + e.getMessage()); - } finally { - holder.close(); } } diff --git a/services/src/main/java/org/fao/geonet/api/sources/SourcesApi.java b/services/src/main/java/org/fao/geonet/api/sources/SourcesApi.java index 1355fecf52dd..ffe61ba4f6f8 100644 --- a/services/src/main/java/org/fao/geonet/api/sources/SourcesApi.java +++ b/services/src/main/java/org/fao/geonet/api/sources/SourcesApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -206,9 +206,10 @@ public ResponseEntity addSource( private void copySourceLogo(Source source, HttpServletRequest request) { if (source.getLogo() != null) { - ServiceContext context = ApiUtils.createServiceContext(request); - context.getBean(Resources.class).copyLogo(context, "images" + File.separator + "harvesting" + File.separator + source.getLogo(), - source.getUuid()); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + context.getBean(Resources.class).copyLogo(context, "images" + File.separator + "harvesting" + File.separator + source.getLogo(), + source.getUuid()); + } } } @@ -289,14 +290,15 @@ public ResponseEntity deleteSource( Optional existingSource = sourceRepository.findById(sourceIdentifier); if (existingSource.isPresent()) { if (existingSource.get().getLogo() != null) { - ServiceContext context = ApiUtils.createServiceContext(request); - final Resources resources = context.getBean(Resources.class); - final Path logoDir = resources.locateLogosDir(context); - try { - resources.deleteImageIfExists(existingSource.get().getUuid() + "." + - FilenameUtils.getExtension(existingSource.get().getLogo()), - logoDir); - } catch (IOException ignored) { + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + final Resources resources = context.getBean(Resources.class); + final Path logoDir = resources.locateLogosDir(context); + try { + resources.deleteImageIfExists(existingSource.get().getUuid() + "." + + FilenameUtils.getExtension(existingSource.get().getLogo()), + logoDir); + } catch (IOException ignored) { + } } } sourceRepository.delete(existingSource.get()); diff --git a/services/src/main/java/org/fao/geonet/api/standards/StandardsApi.java b/services/src/main/java/org/fao/geonet/api/standards/StandardsApi.java index fcc69168dc3f..9f0e4c46e8da 100644 --- a/services/src/main/java/org/fao/geonet/api/standards/StandardsApi.java +++ b/services/src/main/java/org/fao/geonet/api/standards/StandardsApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -204,20 +204,21 @@ public Map getCodelistsTranslations( HttpServletRequest request ) throws Exception { Map response = new LinkedHashMap(); - final ServiceContext context = ApiUtils.createServiceContext(request); - Locale language = languageUtils.parseAcceptLanguage(request.getLocales()); - context.setLanguage(language.getISO3Language()); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + Locale language = languageUtils.parseAcceptLanguage(request.getLocales()); + context.setLanguage(language.getISO3Language()); - for (String c : codelist) { - Element e = StandardsUtils.getCodelist(c, schemaManager, - schema, null, null, null, context, null); + for (String c : codelist) { + Element e = StandardsUtils.getCodelist(c, schemaManager, + schema, null, null, null, context, null); - List listOfEntry = e.getChildren("entry"); - for (Element entry : listOfEntry) { - response.put(entry.getChildText("code"), entry.getChildText("label")); + List listOfEntry = e.getChildren("entry"); + for (Element entry : listOfEntry) { + response.put(entry.getChildText("code"), entry.getChildText("label")); + } } + return response; } - return response; } @@ -243,19 +244,20 @@ public Map getSchemaTranslations( @RequestParam(required = false) String isoType, HttpServletRequest request ) throws Exception { - Map response = new LinkedHashMap(); - final ServiceContext context = ApiUtils.createServiceContext(request); - Locale language = languageUtils.parseAcceptLanguage(request.getLocales()); - context.setLanguage(language.getISO3Language()); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + Map response = new LinkedHashMap(); + Locale language = languageUtils.parseAcceptLanguage(request.getLocales()); + context.setLanguage(language.getISO3Language()); - Element e = StandardsUtils.getCodelist(codelist, schemaManager, - schema, parent, xpath, isoType, context, displayIf); + Element e = StandardsUtils.getCodelist(codelist, schemaManager, + schema, parent, xpath, isoType, context, displayIf); - List listOfEntry = e.getChildren("entry"); - for (Element entry : listOfEntry) { - response.put(entry.getChildText("code"), entry.getChildText("label")); + List listOfEntry = e.getChildren("entry"); + for (Element entry : listOfEntry) { + response.put(entry.getChildText("code"), entry.getChildText("label")); + } + return response; } - return response; } @io.swagger.v3.oas.annotations.Operation(summary = "Get codelist details") @@ -293,14 +295,15 @@ public Codelists.Codelist getSchemaCodelistsWithDetails( @RequestParam(required = false) String isoType, HttpServletRequest request ) throws Exception { - final ServiceContext context = ApiUtils.createServiceContext(request); - Locale language = languageUtils.parseAcceptLanguage(request.getLocales()); - context.setLanguage(language.getISO3Language()); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + Locale language = languageUtils.parseAcceptLanguage(request.getLocales()); + context.setLanguage(language.getISO3Language()); - Element e = StandardsUtils.getCodelist(codelist, schemaManager, - schema, parent, xpath, isoType, context, displayIf); + Element e = StandardsUtils.getCodelist(codelist, schemaManager, + schema, parent, xpath, isoType, context, displayIf); - return (Codelists.Codelist) Xml.unmarshall(e, Codelists.Codelist.class); + return (Codelists.Codelist) Xml.unmarshall(e, Codelists.Codelist.class); + } } @io.swagger.v3.oas.annotations.Operation(summary = "Get descriptor details") @@ -327,14 +330,15 @@ public org.fao.geonet.kernel.schema.labels.Element getElementDetails( @RequestParam(required = false) String isoType, HttpServletRequest request ) throws Exception { - final ServiceContext context = ApiUtils.createServiceContext(request); - Locale language = languageUtils.parseAcceptLanguage(request.getLocales()); - context.setLanguage(language.getISO3Language()); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + Locale language = languageUtils.parseAcceptLanguage(request.getLocales()); + context.setLanguage(language.getISO3Language()); - Element e = StandardsUtils.getLabel(element, schemaManager, - schema, parent, xpath, isoType, displayIf, context); + Element e = StandardsUtils.getLabel(element, schemaManager, + schema, parent, xpath, isoType, displayIf, context); - return (org.fao.geonet.kernel.schema.labels.Element) Xml.unmarshall(e, org.fao.geonet.kernel.schema.labels.Element.class); + return (org.fao.geonet.kernel.schema.labels.Element) Xml.unmarshall(e, org.fao.geonet.kernel.schema.labels.Element.class); + } } diff --git a/services/src/main/java/org/fao/geonet/api/tools/i18n/TranslationApi.java b/services/src/main/java/org/fao/geonet/api/tools/i18n/TranslationApi.java index eb6c6d5484ee..862884f5fb09 100644 --- a/services/src/main/java/org/fao/geonet/api/tools/i18n/TranslationApi.java +++ b/services/src/main/java/org/fao/geonet/api/tools/i18n/TranslationApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -261,10 +261,11 @@ public Map getTranslationsPackage( ServletRequest request, HttpServletRequest httpRequest ) throws Exception { - final ServiceContext context = ApiUtils.createServiceContext(httpRequest); - Locale locale = languageUtils.parseAcceptLanguage(request.getLocales()); - String language = isoLanguagesMapper.iso639_2T_to_iso639_2B(locale.getISO3Language()); - return translationPackBuilder.getPack(language, pack, context); + try (ServiceContext context = ApiUtils.createServiceContext(httpRequest)) { + Locale locale = languageUtils.parseAcceptLanguage(request.getLocales()); + String language = isoLanguagesMapper.iso639_2T_to_iso639_2B(locale.getISO3Language()); + return translationPackBuilder.getPack(language, pack, context); + } } diff --git a/services/src/main/java/org/fao/geonet/api/userfeedback/UserFeedbackAPI.java b/services/src/main/java/org/fao/geonet/api/userfeedback/UserFeedbackAPI.java index c31cf2bc5f21..3d9353444df3 100644 --- a/services/src/main/java/org/fao/geonet/api/userfeedback/UserFeedbackAPI.java +++ b/services/src/main/java/org/fao/geonet/api/userfeedback/UserFeedbackAPI.java @@ -28,6 +28,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.tags.Tag; import jeeves.server.UserSession; +import jeeves.server.context.ServiceContext; import org.apache.commons.lang3.StringUtils; import org.apache.jcs.access.exception.ObjectNotFoundException; import org.fao.geonet.ApplicationContextHolder; @@ -183,41 +184,43 @@ public RatingAverage getMetadataRating( @Parameter(hidden = true) final HttpServletResponse response, @Parameter(hidden = true) final HttpSession httpSession) { - final String functionEnabled = settingManager.getValue(Settings.SYSTEM_LOCALRATING_ENABLE); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + final String functionEnabled = settingManager.getValue(Settings.SYSTEM_LOCALRATING_ENABLE); - if (!functionEnabled.equals(RatingsSetting.ADVANCED)) { - response.setStatus(HttpStatus.FORBIDDEN.value()); - return null; - } - - try { - Log.debug("org.fao.geonet.api.userfeedback.UserFeedback", "getMetadataUserComments"); - - // Check permission for metadata - final AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, request); - if (metadata == null) { - printOutputMessage(response, HttpStatus.FORBIDDEN, ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); + if (!functionEnabled.equals(RatingsSetting.ADVANCED)) { + response.setStatus(HttpStatus.FORBIDDEN.value()); return null; } - final UserSession session = ApiUtils.getUserSession(httpSession); + try { + Log.debug("org.fao.geonet.api.userfeedback.UserFeedback", "getMetadataUserComments"); - boolean published = true; // Takes only published comments + // Check permission for metadata + final AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, context); + if (metadata == null) { + printOutputMessage(response, HttpStatus.FORBIDDEN, ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); + return null; + } - // showing not published comments only to logged users (maybe better - // restrict to Reviewers) - if (session != null && session.isAuthenticated()) { - published = false; - } + final UserSession session = ApiUtils.getUserSession(httpSession); - final IUserFeedbackService userFeedbackService = getUserFeedbackService(); + boolean published = true; // Takes only published comments - final UserFeedbackUtils utils = new UserFeedbackUtils(); + // showing not published comments only to logged users (maybe better + // restrict to Reviewers) + if (session != null && session.isAuthenticated()) { + published = false; + } - return utils.getAverage(userFeedbackService.retrieveUserFeedbackForMetadata(metadataUuid, -1, published)); - } catch (final Exception e) { - Log.error(API.LOG_MODULE_NAME, "UserFeedbackAPI - getMetadataRating: " + e.getMessage(), e); - return null; + final IUserFeedbackService userFeedbackService = getUserFeedbackService(); + + final UserFeedbackUtils utils = new UserFeedbackUtils(); + + return utils.getAverage(userFeedbackService.retrieveUserFeedbackForMetadata(metadataUuid, -1, published)); + } catch (final Exception e) { + Log.error(API.LOG_MODULE_NAME, "UserFeedbackAPI - getMetadataRating: " + e.getMessage(), e); + return null; + } } } @@ -246,44 +249,46 @@ public UserFeedbackDTO getUserComment( @Parameter(hidden = true) final HttpSession httpSession) throws Exception { - final String functionEnabled = settingManager.getValue(Settings.SYSTEM_LOCALRATING_ENABLE); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + final String functionEnabled = settingManager.getValue(Settings.SYSTEM_LOCALRATING_ENABLE); - if (!functionEnabled.equals(RatingsSetting.ADVANCED)) { - response.setStatus(HttpStatus.FORBIDDEN.value()); - return null; - } + if (!functionEnabled.equals(RatingsSetting.ADVANCED)) { + response.setStatus(HttpStatus.FORBIDDEN.value()); + return null; + } - Log.debug("org.fao.geonet.api.userfeedback.UserFeedback", "getUserComment"); + Log.debug("org.fao.geonet.api.userfeedback.UserFeedback", "getUserComment"); - final IUserFeedbackService userFeedbackService = (IUserFeedbackService) ApplicationContextHolder.get() - .getBean("userFeedbackService"); + final IUserFeedbackService userFeedbackService = (IUserFeedbackService) ApplicationContextHolder.get() + .getBean("userFeedbackService"); - final UserSession session = ApiUtils.getUserSession(httpSession); + final UserSession session = ApiUtils.getUserSession(httpSession); - boolean published = true; // Takes only published comments + boolean published = true; // Takes only published comments - // showing not published comments only to logged users (maybe better - // restrict to Reviewers) - if (session != null && session.isAuthenticated()) { - published = false; - } + // showing not published comments only to logged users (maybe better + // restrict to Reviewers) + if (session != null && session.isAuthenticated()) { + published = false; + } - final UserFeedback userfeedback = userFeedbackService.retrieveUserFeedback(uuid, published); + final UserFeedback userfeedback = userFeedbackService.retrieveUserFeedback(uuid, published); - UserFeedbackDTO dto = null; + UserFeedbackDTO dto = null; - if (userfeedback != null) { - dto = UserFeedbackUtils.convertToDto(userfeedback); - } + if (userfeedback != null) { + dto = UserFeedbackUtils.convertToDto(userfeedback); + } - // Check permission for metadata - final AbstractMetadata metadata = ApiUtils.canViewRecord(userfeedback.getMetadata().getUuid(), request); - if (metadata == null) { - printOutputMessage(response, HttpStatus.FORBIDDEN, ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); - return null; - } + // Check permission for metadata + final AbstractMetadata metadata = ApiUtils.canViewRecord(userfeedback.getMetadata().getUuid(), context); + if (metadata == null) { + printOutputMessage(response, HttpStatus.FORBIDDEN, ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW); + return null; + } - return dto; + return dto; + } } /** diff --git a/services/src/main/java/org/fao/geonet/api/users/PasswordApi.java b/services/src/main/java/org/fao/geonet/api/users/PasswordApi.java index fc68ae89ce20..9e2a825f6076 100644 --- a/services/src/main/java/org/fao/geonet/api/users/PasswordApi.java +++ b/services/src/main/java/org/fao/geonet/api/users/PasswordApi.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -103,71 +103,72 @@ public ResponseEntity updatePassword( return new ResponseEntity<>(messages.getString("security_provider_unsupported_functionality"), HttpStatus.PRECONDITION_FAILED); } - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { - User user = userRepository.findOneByUsername(username); - if (user == null) { - Log.warning(LOGGER, String.format("User update password. Can't find user '%s'", - username)); + User user = userRepository.findOneByUsername(username); + if (user == null) { + Log.warning(LOGGER, String.format("User update password. Can't find user '%s'", + username)); - // Return response not providing details about the issue, that should be logged. - return new ResponseEntity<>(String.format( - messages.getString("user_password_notchanged"), - XslUtil.encodeForJavaScript(username) - ), HttpStatus.PRECONDITION_FAILED); - } - if (LDAPConstants.LDAP_FLAG.equals(user.getSecurity().getAuthType())) { - Log.warning(LOGGER, String.format("User '%s' is authenticated using LDAP. Password can't be sent by email.", - username)); + // Return response not providing details about the issue, that should be logged. + return new ResponseEntity<>(String.format( + messages.getString("user_password_notchanged"), + XslUtil.encodeForJavaScript(username) + ), HttpStatus.PRECONDITION_FAILED); + } + if (LDAPConstants.LDAP_FLAG.equals(user.getSecurity().getAuthType())) { + Log.warning(LOGGER, String.format("User '%s' is authenticated using LDAP. Password can't be sent by email.", + username)); - // Return response not providing details about the issue, that should be logged. - return new ResponseEntity<>(String.format( - messages.getString("user_password_notchanged"), - XslUtil.encodeForJavaScript(username) - ), HttpStatus.PRECONDITION_FAILED); - } + // Return response not providing details about the issue, that should be logged. + return new ResponseEntity<>(String.format( + messages.getString("user_password_notchanged"), + XslUtil.encodeForJavaScript(username) + ), HttpStatus.PRECONDITION_FAILED); + } - // construct expected change key - only valid today - String scrambledPassword = user.getPassword(); - Calendar cal = Calendar.getInstance(); - SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT); - String todaysDate = sdf.format(cal.getTime()); - boolean passwordMatches = PasswordUtil.encoder(ApplicationContextHolder.get()).matches(scrambledPassword + todaysDate, passwordAndChangeKey.getChangeKey()); + // construct expected change key - only valid today + String scrambledPassword = user.getPassword(); + Calendar cal = Calendar.getInstance(); + SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT); + String todaysDate = sdf.format(cal.getTime()); + boolean passwordMatches = PasswordUtil.encoder(ApplicationContextHolder.get()).matches(scrambledPassword + todaysDate, passwordAndChangeKey.getChangeKey()); - //check change key - if (!passwordMatches) { - return new ResponseEntity<>(String.format( - messages.getString("user_password_invalid_changekey"), - passwordAndChangeKey.getChangeKey(), XslUtil.encodeForJavaScript(username) - ), HttpStatus.PRECONDITION_FAILED); - } + //check change key + if (!passwordMatches) { + return new ResponseEntity<>(String.format( + messages.getString("user_password_invalid_changekey"), + passwordAndChangeKey.getChangeKey(), XslUtil.encodeForJavaScript(username) + ), HttpStatus.PRECONDITION_FAILED); + } - user.getSecurity().setPassword(PasswordUtil.encode(context, passwordAndChangeKey.getPassword())); - userRepository.save(user); - - String adminEmail = sm.getValue(Settings.SYSTEM_FEEDBACK_EMAIL); - String subject = String.format( - messages.getString("password_change_subject"), - sm.getSiteName()); - String content = String.format( - messages.getString("password_change_message"), - sm.getSiteName(), - adminEmail, - sm.getSiteName()); - - // send change link via email with admin in CC - if (!MailUtil.sendMail(user.getEmail(), - subject, - content, - null, sm, - adminEmail, "")) { + user.getSecurity().setPassword(PasswordUtil.encode(context, passwordAndChangeKey.getPassword())); + userRepository.save(user); + + String adminEmail = sm.getValue(Settings.SYSTEM_FEEDBACK_EMAIL); + String subject = String.format( + messages.getString("password_change_subject"), + sm.getSiteName()); + String content = String.format( + messages.getString("password_change_message"), + sm.getSiteName(), + adminEmail, + sm.getSiteName()); + + // send change link via email with admin in CC + if (!MailUtil.sendMail(user.getEmail(), + subject, + content, + null, sm, + adminEmail, "")) { + return new ResponseEntity<>(String.format( + messages.getString("mail_error")), HttpStatus.PRECONDITION_FAILED); + } return new ResponseEntity<>(String.format( - messages.getString("mail_error")), HttpStatus.PRECONDITION_FAILED); + messages.getString("user_password_changed"), + XslUtil.encodeForJavaScript(username) + ), HttpStatus.CREATED); } - return new ResponseEntity<>(String.format( - messages.getString("user_password_changed"), - XslUtil.encodeForJavaScript(username) - ), HttpStatus.CREATED); } @io.swagger.v3.oas.annotations.Operation(summary = "Send user password reminder by email", @@ -196,78 +197,81 @@ public ResponseEntity sendPasswordByEmail( return new ResponseEntity<>(messages.getString("security_provider_unsupported_functionality"), HttpStatus.PRECONDITION_FAILED); } - ServiceContext serviceContext = ApiUtils.createServiceContext(request); + try (ServiceContext serviceContext = ApiUtils.createServiceContext(request)) { + final User user = userRepository.findOneByUsername(username); + if (user == null) { + Log.warning(LOGGER, String.format("User reset password. Can't find user '%s'", + username)); - final User user = userRepository.findOneByUsername(username); - if (user == null) { - Log.warning(LOGGER, String.format("User reset password. Can't find user '%s'", - username)); + // Return response not providing details about the issue, that should be logged. + return new ResponseEntity<>(String.format( + messages.getString("user_password_sent"), + XslUtil.encodeForJavaScript(username) + ), HttpStatus.CREATED); + } - // Return response not providing details about the issue, that should be logged. - return new ResponseEntity<>(String.format( - messages.getString("user_password_sent"), - XslUtil.encodeForJavaScript(username) - ), HttpStatus.CREATED); - } + if (LDAPConstants.LDAP_FLAG.equals(user.getSecurity().getAuthType())) { + Log.warning(LOGGER, String.format("User '%s' is authenticated using LDAP. Password can't be sent by email.", + username)); - if (LDAPConstants.LDAP_FLAG.equals(user.getSecurity().getAuthType())) { - Log.warning(LOGGER, String.format("User '%s' is authenticated using LDAP. Password can't be sent by email.", - username)); + // Return response not providing details about the issue, that should be logged. + return new ResponseEntity<>(String.format( + messages.getString("user_password_sent"), + XslUtil.encodeForJavaScript(username) + ), HttpStatus.CREATED); + } - // Return response not providing details about the issue, that should be logged. - return new ResponseEntity<>(String.format( - messages.getString("user_password_sent"), - XslUtil.encodeForJavaScript(username) - ), HttpStatus.CREATED); - } + String email = user.getEmail(); + if (StringUtils.isEmpty(email)) { + Log.warning(LOGGER, String.format("User reset password. User '%s' has no email", + username)); - String email = user.getEmail(); - if (StringUtils.isEmpty(email)) { - Log.warning(LOGGER, String.format("User reset password. User '%s' has no email", - username)); + // Return response not providing details about the issue, that should be logged. + return new ResponseEntity<>(String.format( + messages.getString("user_password_sent"), + XslUtil.encodeForJavaScript(username) + ), HttpStatus.CREATED); + } - // Return response not providing details about the issue, that should be logged. + // get mail settings + String adminEmail = sm.getValue(Settings.SYSTEM_FEEDBACK_EMAIL); + + // construct change key - only valid today + String scrambledPassword = user.getPassword(); + Calendar cal = Calendar.getInstance(); + SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT); + String todaysDate = sdf.format(cal.getTime()); + String changeKey = PasswordUtil.encode(serviceContext, + scrambledPassword + todaysDate); + + String subject = String.format( + messages.getString("password_forgotten_subject"), + sm.getSiteName(), + username); + String content = String.format( + messages.getString("password_forgotten_message"), + sm.getSiteName(), + sm.getSiteURL(language), + username, + changeKey, + sm.getSiteName()); + + // send change link via email with admin in CC + if (!MailUtil.sendMail(email, + subject, + content, + null, sm, + adminEmail, "")) { + return new ResponseEntity<>(String.format( + messages.getString("mail_error")), HttpStatus.PRECONDITION_FAILED); + } return new ResponseEntity<>(String.format( messages.getString("user_password_sent"), XslUtil.encodeForJavaScript(username) ), HttpStatus.CREATED); } - // get mail settings - String adminEmail = sm.getValue(Settings.SYSTEM_FEEDBACK_EMAIL); - - // construct change key - only valid today - String scrambledPassword = user.getPassword(); - Calendar cal = Calendar.getInstance(); - SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT); - String todaysDate = sdf.format(cal.getTime()); - String changeKey = PasswordUtil.encode(serviceContext, - scrambledPassword + todaysDate); - - String subject = String.format( - messages.getString("password_forgotten_subject"), - sm.getSiteName(), - username); - String content = String.format( - messages.getString("password_forgotten_message"), - sm.getSiteName(), - sm.getSiteURL(language), - username, - changeKey, - sm.getSiteName()); - - // send change link via email with admin in CC - if (!MailUtil.sendMail(email, - subject, - content, - null, sm, - adminEmail, "")) { - return new ResponseEntity<>(String.format( - messages.getString("mail_error")), HttpStatus.PRECONDITION_FAILED); - } - return new ResponseEntity<>(String.format( - messages.getString("user_password_sent"), - XslUtil.encodeForJavaScript(username) - ), HttpStatus.CREATED); + + } } diff --git a/services/src/main/java/org/fao/geonet/api/users/RegisterApi.java b/services/src/main/java/org/fao/geonet/api/users/RegisterApi.java index 8ec00d4d27d9..6e65a4abb0f8 100644 --- a/services/src/main/java/org/fao/geonet/api/users/RegisterApi.java +++ b/services/src/main/java/org/fao/geonet/api/users/RegisterApi.java @@ -99,128 +99,128 @@ public ResponseEntity registerUser( return new ResponseEntity<>(messages.getString("security_provider_unsupported_functionality"), HttpStatus.PRECONDITION_FAILED); } - ServiceContext context = ApiUtils.createServiceContext(request); - - SettingManager sm = context.getBean(SettingManager.class); - boolean selfRegistrationEnabled = sm.getValueAsBool(Settings.SYSTEM_USERSELFREGISTRATION_ENABLE); - if (!selfRegistrationEnabled) { - return new ResponseEntity<>(String.format( - messages.getString("self_registration_disabled") - ), HttpStatus.PRECONDITION_FAILED); - } + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + SettingManager sm = context.getBean(SettingManager.class); + boolean selfRegistrationEnabled = sm.getValueAsBool(Settings.SYSTEM_USERSELFREGISTRATION_ENABLE); + if (!selfRegistrationEnabled) { + return new ResponseEntity<>(String.format( + messages.getString("self_registration_disabled") + ), HttpStatus.PRECONDITION_FAILED); + } - boolean recaptchaEnabled = sm.getValueAsBool(Settings.SYSTEM_USERSELFREGISTRATION_RECAPTCHA_ENABLE); + boolean recaptchaEnabled = sm.getValueAsBool(Settings.SYSTEM_USERSELFREGISTRATION_RECAPTCHA_ENABLE); - if (recaptchaEnabled) { - boolean validRecaptcha = RecaptchaChecker.verify(userRegisterDto.getCaptcha(), - sm.getValue(Settings.SYSTEM_USERSELFREGISTRATION_RECAPTCHA_SECRETKEY)); - if (!validRecaptcha) { - return new ResponseEntity<>( - messages.getString("recaptcha_not_valid"), HttpStatus.PRECONDITION_FAILED); + if (recaptchaEnabled) { + boolean validRecaptcha = RecaptchaChecker.verify(userRegisterDto.getCaptcha(), + sm.getValue(Settings.SYSTEM_USERSELFREGISTRATION_RECAPTCHA_SECRETKEY)); + if (!validRecaptcha) { + return new ResponseEntity<>( + messages.getString("recaptcha_not_valid"), HttpStatus.PRECONDITION_FAILED); + } } - } - // Validate the user registration - if (bindingResult.hasErrors()) { - List errorList = bindingResult.getAllErrors(); - - StringBuilder sb = new StringBuilder(); - Iterator it = errorList.iterator(); - while (it.hasNext()) { - sb.append(messages.getString(it.next().getDefaultMessage())); - if (it.hasNext()) { - sb.append(", "); + // Validate the user registration + if (bindingResult.hasErrors()) { + List errorList = bindingResult.getAllErrors(); + + StringBuilder sb = new StringBuilder(); + Iterator it = errorList.iterator(); + while (it.hasNext()) { + sb.append(messages.getString(it.next().getDefaultMessage())); + if (it.hasNext()) { + sb.append(", "); + } } + + return new ResponseEntity<>(sb.toString(), HttpStatus.PRECONDITION_FAILED); } - return new ResponseEntity<>(sb.toString(), HttpStatus.PRECONDITION_FAILED); - } + final UserRepository userRepository = context.getBean(UserRepository.class); + if (userRepository.findOneByEmail(userRegisterDto.getEmail()) != null) { + return new ResponseEntity<>(String.format( + messages.getString("user_with_that_email_found"), + userRegisterDto.getEmail() + ), HttpStatus.PRECONDITION_FAILED); + } - final UserRepository userRepository = context.getBean(UserRepository.class); - if (userRepository.findOneByEmail(userRegisterDto.getEmail()) != null) { - return new ResponseEntity<>(String.format( - messages.getString("user_with_that_email_found"), - userRegisterDto.getEmail() - ), HttpStatus.PRECONDITION_FAILED); - } + if (userRepository.findByUsernameIgnoreCase(userRegisterDto.getEmail()).size() != 0) { + // username is ignored and the email is used as username in selfregister + return new ResponseEntity<>(String.format( + messages.getString("user_with_that_username_found"), + userRegisterDto.getEmail() + ), HttpStatus.PRECONDITION_FAILED); + } - if (userRepository.findByUsernameIgnoreCase(userRegisterDto.getEmail()).size() != 0) { - // username is ignored and the email is used as username in selfregister - return new ResponseEntity<>(String.format( - messages.getString("user_with_that_username_found"), - userRegisterDto.getEmail() - ), HttpStatus.PRECONDITION_FAILED); - } + User user = new User(); + + // user.setUsername(userRegisterDto.getUsername()); + user.setName(userRegisterDto.getName()); + user.setOrganisation(userRegisterDto.getOrganisation()); + user.setProfile(Profile.findProfileIgnoreCase(userRegisterDto.getProfile())); + user.getAddresses().add(userRegisterDto.getAddress()); + user.getEmailAddresses().add(userRegisterDto.getEmail()); + + + String password = User.getRandomPassword(); + user.getSecurity().setPassword( + PasswordUtil.encode(context, password) + ); + user.setUsername(user.getEmail()); + Profile requestedProfile = user.getProfile(); + user.setProfile(Profile.RegisteredUser); + user = userRepository.save(user); + + Group targetGroup = getGroup(context); + if (targetGroup != null) { + UserGroup userGroup = new UserGroup().setUser(user).setGroup(targetGroup).setProfile(Profile.RegisteredUser); + context.getBean(UserGroupRepository.class).save(userGroup); + } - User user = new User(); - - // user.setUsername(userRegisterDto.getUsername()); - user.setName(userRegisterDto.getName()); - user.setOrganisation(userRegisterDto.getOrganisation()); - user.setProfile(Profile.findProfileIgnoreCase(userRegisterDto.getProfile())); - user.getAddresses().add(userRegisterDto.getAddress()); - user.getEmailAddresses().add(userRegisterDto.getEmail()); - - - String password = User.getRandomPassword(); - user.getSecurity().setPassword( - PasswordUtil.encode(context, password) - ); - user.setUsername(user.getEmail()); - Profile requestedProfile = user.getProfile(); - user.setProfile(Profile.RegisteredUser); - user = userRepository.save(user); - - Group targetGroup = getGroup(context); - if (targetGroup != null) { - UserGroup userGroup = new UserGroup().setUser(user).setGroup(targetGroup).setProfile(Profile.RegisteredUser); - context.getBean(UserGroupRepository.class).save(userGroup); - } + String catalogAdminEmail = sm.getValue(Settings.SYSTEM_FEEDBACK_EMAIL); + String subject = String.format( + messages.getString("register_email_admin_subject"), + sm.getSiteName(), + user.getEmail(), + requestedProfile + ); + String message = String.format( + messages.getString("register_email_admin_message"), + user.getEmail(), + requestedProfile, + sm.getNodeURL(), + sm.getSiteName() + ); + if (!MailUtil.sendMail(catalogAdminEmail, subject, message, null, sm)) { + return new ResponseEntity<>(String.format( + messages.getString("mail_error")), HttpStatus.PRECONDITION_FAILED); + } - String catalogAdminEmail = sm.getValue(Settings.SYSTEM_FEEDBACK_EMAIL); - String subject = String.format( - messages.getString("register_email_admin_subject"), - sm.getSiteName(), - user.getEmail(), - requestedProfile - ); - String message = String.format( - messages.getString("register_email_admin_message"), - user.getEmail(), - requestedProfile, - sm.getNodeURL(), - sm.getSiteName() - ); - if (!MailUtil.sendMail(catalogAdminEmail, subject, message, null, sm)) { - return new ResponseEntity<>(String.format( - messages.getString("mail_error")), HttpStatus.PRECONDITION_FAILED); - } + subject = String.format( + messages.getString("register_email_subject"), + sm.getSiteName(), + user.getProfile() + ); + message = String.format( + messages.getString("register_email_message"), + sm.getSiteName(), + user.getUsername(), + password, + Profile.RegisteredUser, + requestedProfile, + sm.getNodeURL(), + sm.getSiteName() + ); + if (!MailUtil.sendMail(user.getEmail(), subject, message, null, sm)) { + return new ResponseEntity<>(String.format( + messages.getString("mail_error")), HttpStatus.PRECONDITION_FAILED); + } - subject = String.format( - messages.getString("register_email_subject"), - sm.getSiteName(), - user.getProfile() - ); - message = String.format( - messages.getString("register_email_message"), - sm.getSiteName(), - user.getUsername(), - password, - Profile.RegisteredUser, - requestedProfile, - sm.getNodeURL(), - sm.getSiteName() - ); - if (!MailUtil.sendMail(user.getEmail(), subject, message, null, sm)) { return new ResponseEntity<>(String.format( - messages.getString("mail_error")), HttpStatus.PRECONDITION_FAILED); + messages.getString("user_registered"), + user.getUsername() + ), HttpStatus.CREATED); } - - return new ResponseEntity<>(String.format( - messages.getString("user_registered"), - user.getUsername() - ), HttpStatus.CREATED); } Group getGroup(ServiceContext context) throws SQLException { diff --git a/services/src/main/java/org/fao/geonet/api/users/transfer/TransferApi.java b/services/src/main/java/org/fao/geonet/api/users/transfer/TransferApi.java index f6808d34ae54..231d55e1c4ed 100644 --- a/services/src/main/java/org/fao/geonet/api/users/transfer/TransferApi.java +++ b/services/src/main/java/org/fao/geonet/api/users/transfer/TransferApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -180,78 +180,78 @@ public ResponseEntity saveOwners( HttpServletRequest request ) throws Exception { ApplicationContext applicationContext = ApplicationContextHolder.get(); - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + //--- transfer privileges (if case) - //--- transfer privileges (if case) + Set sourcePriv = retrievePrivileges( + context, transfer.getSourceUser(), transfer.getSourceGroup()); + Set targetPriv = retrievePrivileges( + context, null, transfer.getTargetGroup()); - Set sourcePriv = retrievePrivileges( - context, transfer.getSourceUser(), transfer.getSourceGroup()); - Set targetPriv = retrievePrivileges( - context, null, transfer.getTargetGroup()); + //--- a commit just to release some resources + dataManager.flush(); - //--- a commit just to release some resources - dataManager.flush(); + int privCount = 0; - int privCount = 0; + Set metadata = new HashSet(); - Set metadata = new HashSet(); + if (sourcePriv.size() > 0) { + for (String priv : sourcePriv) { + StringTokenizer st = new StringTokenizer(priv, "|"); - if (sourcePriv.size() > 0) { - for (String priv : sourcePriv) { - StringTokenizer st = new StringTokenizer(priv, "|"); + int opId = Integer.parseInt(st.nextToken()); + int mdId = Integer.parseInt(st.nextToken()); - int opId = Integer.parseInt(st.nextToken()); - int mdId = Integer.parseInt(st.nextToken()); + // 2 cases could happen, 1) only the owner change + // in that case sourceGrp = targetGrp and operations + // allowed does not need to be modified. + if (transfer.getSourceGroup() != transfer.getTargetGroup()) { + // 2) the sourceGrp != targetGrp and in that + // case, all operations need to be transfered to + // the new group if not already defined. + dataManager.unsetOperation(context, mdId, transfer.getSourceGroup(), opId); - // 2 cases could happen, 1) only the owner change - // in that case sourceGrp = targetGrp and operations - // allowed does not need to be modified. - if (transfer.getSourceGroup() != transfer.getTargetGroup()) { - // 2) the sourceGrp != targetGrp and in that - // case, all operations need to be transfered to - // the new group if not already defined. - dataManager.unsetOperation(context, mdId, transfer.getSourceGroup(), opId); - - if (!targetPriv.contains(priv)) { - OperationAllowedId id = new OperationAllowedId() - .setGroupId(transfer.getTargetGroup()) - .setMetadataId(mdId) - .setOperationId(opId); - OperationAllowed operationAllowed = new OperationAllowed(id); - operationAllowedRepository.save(operationAllowed); + if (!targetPriv.contains(priv)) { + OperationAllowedId id = new OperationAllowedId() + .setGroupId(transfer.getTargetGroup()) + .setMetadataId(mdId) + .setOperationId(opId); + OperationAllowed operationAllowed = new OperationAllowed(id); + operationAllowedRepository.save(operationAllowed); + } } - } - // Collect all metadata ids - metadata.add(mdId); - privCount++; + // Collect all metadata ids + metadata.add(mdId); + privCount++; + } } - } - // If no privileges defined for the target group - // assign the new owner and ownerGroup for the source - // user records. - final List sourceUserRecords = - metadataRepository.findAllIdsBy(MetadataSpecs.hasOwner(transfer.getSourceUser())); - metadata.addAll(sourceUserRecords); + // If no privileges defined for the target group + // assign the new owner and ownerGroup for the source + // user records. + final List sourceUserRecords = + metadataRepository.findAllIdsBy(MetadataSpecs.hasOwner(transfer.getSourceUser())); + metadata.addAll(sourceUserRecords); - // Set owner for all records to be modified. - for (Integer i : metadata) { - final AbstractMetadata metadata1 = metadataRepository.findOne(i); - metadata1.getSourceInfo() - .setGroupOwner(transfer.getTargetGroup()) - .setOwner(transfer.getTargetUser()); - metadataManager.save(metadata1); - } + // Set owner for all records to be modified. + for (Integer i : metadata) { + final AbstractMetadata metadata1 = metadataRepository.findOne(i); + metadata1.getSourceInfo() + .setGroupOwner(transfer.getTargetGroup()) + .setOwner(transfer.getTargetUser()); + metadataManager.save(metadata1); + } - dataManager.flush(); + dataManager.flush(); - //--- reindex metadata - List list = new ArrayList(); - for (int mdId : metadata) { - list.add(Integer.toString(mdId)); + //--- reindex metadata + List list = new ArrayList(); + for (int mdId : metadata) { + list.add(Integer.toString(mdId)); + } + dataManager.indexMetadata(list); + return new ResponseEntity(HttpStatus.CREATED); } - dataManager.indexMetadata(list); - return new ResponseEntity(HttpStatus.CREATED); } private Set retrievePrivileges(ServiceContext context, Integer userId, int groupId) throws SQLException { diff --git a/services/src/main/java/org/fao/geonet/guiapi/search/SearchApi.java b/services/src/main/java/org/fao/geonet/guiapi/search/SearchApi.java index c53bdc0dee4a..6b81f0ada8fc 100644 --- a/services/src/main/java/org/fao/geonet/guiapi/search/SearchApi.java +++ b/services/src/main/java/org/fao/geonet/guiapi/search/SearchApi.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -123,7 +123,9 @@ public void getFieldInfo( private Element query(Map queryFields, HttpServletRequest request) { ApplicationContext applicationContext = ApplicationContextHolder.get(); EsSearchManager searchMan = applicationContext.getBean(EsSearchManager.class); - ServiceContext context = ApiUtils.createServiceContext(request); + try (ServiceContext context = ApiUtils.createServiceContext(request)) { + + } // TODOES this is the proxy throw new NotImplementedException("Not implemented in ES"); diff --git a/services/src/main/java/org/fao/geonet/services/metadata/ExtractServicesLayers.java b/services/src/main/java/org/fao/geonet/services/metadata/ExtractServicesLayers.java index 2e5c056746e4..1be931a99ea0 100644 --- a/services/src/main/java/org/fao/geonet/services/metadata/ExtractServicesLayers.java +++ b/services/src/main/java/org/fao/geonet/services/metadata/ExtractServicesLayers.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2007 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -63,123 +63,123 @@ public JSONObject getLayersFromSelectedMetadatas( final NativeWebRequest webRequest) throws Exception { final ServiceManager serviceManager = ApplicationContextHolder.get().getBean(ServiceManager.class); - ServiceContext context = serviceManager.createServiceContext("selection.layers", lang, webRequest.getNativeRequest(HttpServletRequest.class)); - DataManager dm = context.getBean(DataManager.class); - UserSession us = context.getUserSession(); - SelectionManager sm = SelectionManager.getManager(us); - - JSONObject ret = new JSONObject(); - JSONArray services = new JSONArray(); - JSONArray layers = new JSONArray(); - - ArrayList lst = new ArrayList(); - - // case #1 : #id parameter is undefined - if (paramId == null) { - synchronized (sm.getSelection("metadata")) { - for (Iterator iter = sm.getSelection("metadata").iterator(); iter.hasNext(); ) { - String uuid = iter.next(); - String id = dm.getMetadataId(uuid); - lst.add(id); + try (ServiceContext context = serviceManager.createServiceContext("selection.layers", lang, webRequest.getNativeRequest(HttpServletRequest.class))) { + DataManager dm = context.getBean(DataManager.class); + UserSession us = context.getUserSession(); + SelectionManager sm = SelectionManager.getManager(us); + + JSONObject ret = new JSONObject(); + JSONArray services = new JSONArray(); + JSONArray layers = new JSONArray(); + + ArrayList lst = new ArrayList(); + + // case #1 : #id parameter is undefined + if (paramId == null) { + synchronized (sm.getSelection("metadata")) { + for (Iterator iter = sm.getSelection("metadata").iterator(); iter.hasNext(); ) { + String uuid = iter.next(); + String id = dm.getMetadataId(uuid); + lst.add(id); + } } + } else { // case #2 : id parameter has been passed + lst.add(paramId); } - } else { // case #2 : id parameter has been passed - lst.add(paramId); - } - - for (Iterator iter = lst.iterator(); iter.hasNext(); ) { - String id = iter.next(); - String uuid = dm.getMetadataUuid(id); - - Element curMd = dm.getMetadata(context, id, false, false, false); - - XPath xpath = XPath.newInstance("gmd:distributionInfo/gmd:MD_Distribution/gmd:transferOptions/gmd:MD_DigitalTransferOptions/gmd:onLine"); - - List elems; - - try { - @SuppressWarnings("unchecked") - List tmp = xpath.selectNodes(curMd); - elems = tmp; - } catch (Exception e) { - // Bad XML input ? - continue; - } - - for (Element curnode : elems) { - XPath pLinkage = XPath.newInstance("gmd:CI_OnlineResource/gmd:linkage/gmd:URL"); - XPath pProtocol = XPath.newInstance("gmd:CI_OnlineResource/gmd:protocol/gco:CharacterString"); - XPath pName = XPath.newInstance("gmd:CI_OnlineResource/gmd:name/gco:CharacterString"); - XPath pDescription = XPath.newInstance("gmd:CI_OnlineResource/gmd:description/gco:CharacterString"); - Element eLinkage = (Element) pLinkage.selectSingleNode(curnode); - Element eProtocol = (Element) pProtocol.selectSingleNode(curnode); - Element eName = (Element) pName.selectSingleNode(curnode); - Element eDescription = (Element) pDescription.selectSingleNode(curnode); - - if (eLinkage == null) { - continue; - } - if (eProtocol == null) { - continue; - } - if (eName == null) { - continue; - } + for (Iterator iter = lst.iterator(); iter.hasNext(); ) { + String id = iter.next(); + String uuid = dm.getMetadataUuid(id); - String sLinkage = eLinkage.getValue(); - String sProtocol = eProtocol.getValue(); - String sName = eName.getValue(); - String sDescription = eDescription != null ? eDescription.getValue() : ""; + Element curMd = dm.getMetadata(context, id, false, false, false); - if ((sLinkage == null) || (sLinkage.equals(""))) { - continue; - } - if ((sProtocol == null) || (sProtocol.equals(""))) { - continue; - } + XPath xpath = XPath.newInstance("gmd:distributionInfo/gmd:MD_Distribution/gmd:transferOptions/gmd:MD_DigitalTransferOptions/gmd:onLine"); - String sProto2 = "WMS"; // by default + List elems; - if (sProtocol.contains("OGC:WMS")) { - sProto2 = "WMS"; - } else if (sProtocol.contains("OGC:WFS")) { - sProto2 = "WFS"; - } else if (sProtocol.contains("OGC:WCS")) { - sProto2 = "WMS"; - } else { + try { + @SuppressWarnings("unchecked") + List tmp = xpath.selectNodes(curMd); + elems = tmp; + } catch (Exception e) { + // Bad XML input ? continue; } - // If no name, we are on a service - if ((sName == null) || (sName.equals(""))) { - JSONObject serviceObj = new JSONObject(); - serviceObj.put("owsurl", sLinkage); - serviceObj.put("owstype", sProto2); - serviceObj.put("text", sDescription); - serviceObj.put("mdid", id); - serviceObj.put("muuid", uuid); - services.add(serviceObj); - } - // else it is a Layer - else { - JSONObject layerObj = new JSONObject(); - layerObj.put("owsurl", sLinkage); - layerObj.put("owstype", sProto2); - layerObj.put("layername", sName); - layerObj.put("title", sDescription); - layerObj.put("mdid", id); - layerObj.put("muuid", uuid); - layers.add(layerObj); - } - } // for - } // iterates - - ret.put("layers", layers); - ret.put("services", services); - - return ret; - + for (Element curnode : elems) { + XPath pLinkage = XPath.newInstance("gmd:CI_OnlineResource/gmd:linkage/gmd:URL"); + XPath pProtocol = XPath.newInstance("gmd:CI_OnlineResource/gmd:protocol/gco:CharacterString"); + XPath pName = XPath.newInstance("gmd:CI_OnlineResource/gmd:name/gco:CharacterString"); + XPath pDescription = XPath.newInstance("gmd:CI_OnlineResource/gmd:description/gco:CharacterString"); + + Element eLinkage = (Element) pLinkage.selectSingleNode(curnode); + Element eProtocol = (Element) pProtocol.selectSingleNode(curnode); + Element eName = (Element) pName.selectSingleNode(curnode); + Element eDescription = (Element) pDescription.selectSingleNode(curnode); + + if (eLinkage == null) { + continue; + } + if (eProtocol == null) { + continue; + } + if (eName == null) { + continue; + } + + String sLinkage = eLinkage.getValue(); + String sProtocol = eProtocol.getValue(); + String sName = eName.getValue(); + String sDescription = eDescription != null ? eDescription.getValue() : ""; + + if ((sLinkage == null) || (sLinkage.equals(""))) { + continue; + } + if ((sProtocol == null) || (sProtocol.equals(""))) { + continue; + } + + String sProto2 = "WMS"; // by default + + if (sProtocol.contains("OGC:WMS")) { + sProto2 = "WMS"; + } else if (sProtocol.contains("OGC:WFS")) { + sProto2 = "WFS"; + } else if (sProtocol.contains("OGC:WCS")) { + sProto2 = "WMS"; + } else { + continue; + } + + // If no name, we are on a service + if ((sName == null) || (sName.equals(""))) { + JSONObject serviceObj = new JSONObject(); + serviceObj.put("owsurl", sLinkage); + serviceObj.put("owstype", sProto2); + serviceObj.put("text", sDescription); + serviceObj.put("mdid", id); + serviceObj.put("muuid", uuid); + services.add(serviceObj); + } + // else it is a Layer + else { + JSONObject layerObj = new JSONObject(); + layerObj.put("owsurl", sLinkage); + layerObj.put("owstype", sProto2); + layerObj.put("layername", sName); + layerObj.put("title", sDescription); + layerObj.put("mdid", id); + layerObj.put("muuid", uuid); + layers.add(layerObj); + } + } // for + } // iterates + + ret.put("layers", layers); + ret.put("services", services); + + return ret; + } } } diff --git a/services/src/main/java/org/fao/geonet/services/thesaurus/GetKeywords.java b/services/src/main/java/org/fao/geonet/services/thesaurus/GetKeywords.java index dc4398c15f5e..a35d8f61597a 100644 --- a/services/src/main/java/org/fao/geonet/services/thesaurus/GetKeywords.java +++ b/services/src/main/java/org/fao/geonet/services/thesaurus/GetKeywords.java @@ -1,5 +1,5 @@ //============================================================================= -//=== Copyright (C) 2001-2005 Food and Agriculture Organization of the +//=== Copyright (C) 2001-2021 Food and Agriculture Organization of the //=== United Nations (FAO-UN), United Nations World Food Programme (WFP) //=== and United Nations Environment Programme (UNEP) //=== @@ -104,82 +104,84 @@ public HttpEntity exec( NativeWebRequest webRequest) throws Exception { ConfigurableApplicationContext applicationContext = ApplicationContextHolder.get(); - ServiceContext context = applicationContext.getBean(ServiceManager.class).createServiceContext("keywords", uiLang, - webRequest.getNativeRequest(HttpServletRequest.class)); - Element responseXml = new Element(Jeeves.Elem.RESPONSE); - UserSession session = context.getUserSession(); + try (ServiceContext context = applicationContext.getBean(ServiceManager.class).createServiceContext("keywords", uiLang, + webRequest.getNativeRequest(HttpServletRequest.class))) { + Element responseXml = new Element(Jeeves.Elem.RESPONSE); + UserSession session = context.getUserSession(); - KeywordsSearcher searcher; - if (newSearch) { - // perform the search and save search result into session - ThesaurusManager thesaurusMan = applicationContext.getBean(ThesaurusManager.class); - if (Log.isDebugEnabled("KeywordsManager")) { - Log.debug("KeywordsManager", "Creating new keywords searcher"); - } - searcher = new KeywordsSearcher(context, thesaurusMan); + KeywordsSearcher searcher; + if (newSearch) { + // perform the search and save search result into session + ThesaurusManager thesaurusMan = applicationContext.getBean(ThesaurusManager.class); - IsoLanguagesMapper languagesMapper = applicationContext.getBean(IsoLanguagesMapper.class); - KeywordSearchParamsBuilder builder = parseBuilder(uiLang, searchTerm, maxResults, offset, - targetLangs, thesauri, thesauriDomainName, typeSearch, keywordUriCode, languagesMapper); + if (Log.isDebugEnabled("KeywordsManager")) { + Log.debug("KeywordsManager", "Creating new keywords searcher"); + } + searcher = new KeywordsSearcher(context, thesaurusMan); - if (checkModified(webRequest, thesaurusMan, builder)) { - return null; - } + IsoLanguagesMapper languagesMapper = applicationContext.getBean(IsoLanguagesMapper.class); + KeywordSearchParamsBuilder builder = parseBuilder(uiLang, searchTerm, maxResults, offset, + targetLangs, thesauri, thesauriDomainName, typeSearch, keywordUriCode, languagesMapper); - if (searchTerm == null || searchTerm.trim().isEmpty()) { - builder.setComparator(KeywordSort.defaultLabelSorter(SortDirection.parse(sort))); + if (checkModified(webRequest, thesaurusMan, builder)) { + return null; + } + + if (searchTerm == null || searchTerm.trim().isEmpty()) { + builder.setComparator(KeywordSort.defaultLabelSorter(SortDirection.parse(sort))); + } else { + builder.setComparator(KeywordSort.searchResultsSorter(searchTerm, SortDirection.parse(sort))); + } + + searcher.search(builder.build()); + session.setProperty(Geonet.Session.SEARCH_KEYWORDS_RESULT, + searcher); } else { - builder.setComparator(KeywordSort.searchResultsSorter(searchTerm, SortDirection.parse(sort))); + searcher = (KeywordsSearcher) session + .getProperty(Geonet.Session.SEARCH_KEYWORDS_RESULT); } - searcher.search(builder.build()); - session.setProperty(Geonet.Session.SEARCH_KEYWORDS_RESULT, - searcher); - } else { - searcher = (KeywordsSearcher) session - .getProperty(Geonet.Session.SEARCH_KEYWORDS_RESULT); - } - - // get the results - responseXml.addContent(searcher.getXmlResults()); + // get the results + responseXml.addContent(searcher.getXmlResults()); - // If editing - if (mode != null) { - if (mode.equals("edit") || mode.equals("consult")) { - responseXml.addContent(new Element("thesaurus") - .addContent(thesauri)); + // If editing + if (mode != null) { + if (mode.equals("edit") || mode.equals("consult")) { + responseXml.addContent(new Element("thesaurus") + .addContent(thesauri)); - responseXml.addContent((new Element("mode")).addContent(mode)); + responseXml.addContent((new Element("mode")).addContent(mode)); + } + } + String[] acceptHeader = webRequest.getHeaderValues("Accept"); + final Set acceptContentType = Sets.newHashSet( + acceptHeader != null ? acceptHeader : new String[]{"text/plain"}); + + byte[] response; + String contentType; + if (acceptsType(acceptContentType, "json") || + "json".equals(webRequest.getParameter("_content_type"))) { + response = Xml.getJSON(responseXml).getBytes(Constants.CHARSET); + contentType = "application/json"; + } else if (acceptContentType.isEmpty() || + acceptsType(acceptContentType, "xml") || + acceptContentType.contains("*/*") || + acceptContentType.contains("text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2") || + acceptContentType.contains("text/plain")) { + response = Xml.getString(responseXml).getBytes(Constants.CHARSET); + contentType = "application/xml"; + } else { + throw new IllegalArgumentException(acceptContentType + " is not supported"); } - } - String[] acceptHeader = webRequest.getHeaderValues("Accept"); - final Set acceptContentType = Sets.newHashSet( - acceptHeader != null ? acceptHeader : new String[]{"text/plain"}); - - byte[] response; - String contentType; - if (acceptsType(acceptContentType, "json") || - "json".equals(webRequest.getParameter("_content_type"))) { - response = Xml.getJSON(responseXml).getBytes(Constants.CHARSET); - contentType = "application/json"; - } else if (acceptContentType.isEmpty() || - acceptsType(acceptContentType, "xml") || - acceptContentType.contains("*/*") || - acceptContentType.contains("text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2") || - acceptContentType.contains("text/plain")) { - response = Xml.getString(responseXml).getBytes(Constants.CHARSET); - contentType = "application/xml"; - } else { - throw new IllegalArgumentException(acceptContentType + " is not supported"); - } - MultiValueMap headers = new HttpHeaders(); - headers.add("Content-Type", contentType); - headers.add("Cache-Control", "no-cache"); + MultiValueMap headers = new HttpHeaders(); + headers.add("Content-Type", contentType); + headers.add("Cache-Control", "no-cache"); - return new HttpEntity<>(response, headers); + return new HttpEntity<>(response, headers); + } } private boolean checkModified(NativeWebRequest webRequest, ThesaurusManager thesaurusMan, KeywordSearchParamsBuilder builder) { diff --git a/services/src/test/java/org/fao/geonet/api/records/formatters/groovy/FunctionsTest.java b/services/src/test/java/org/fao/geonet/api/records/formatters/groovy/FunctionsTest.java index 878acaff1ab6..fdc091cf2abc 100644 --- a/services/src/test/java/org/fao/geonet/api/records/formatters/groovy/FunctionsTest.java +++ b/services/src/test/java/org/fao/geonet/api/records/formatters/groovy/FunctionsTest.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001-2016 Food and Agriculture Organization of the + * Copyright (C) 2001-2021 Food and Agriculture Organization of the * United Nations (FAO-UN), United Nations World Food Programme (WFP) * and United Nations Environment Programme (UNEP) * @@ -40,6 +40,7 @@ import org.fao.geonet.languages.IsoLanguagesMapper; import org.fao.geonet.repository.IsoLanguageRepository; import org.fao.geonet.utils.IO; +import org.junit.After; import org.junit.Before; import org.junit.Test; import org.mockito.Mockito; @@ -132,6 +133,14 @@ protected ConfigFile getConfigFile(SchemaManager schemaManager, String schema) t }; } + @After + public void tearDown() throws Exception { + if( fparams != null ){ + fparams.context.clearAsThreadLocal(); + fparams.context.clear(); + } + } + @Test public void testTranslate() throws Exception { diff --git a/web/src/main/java/org/fao/geonet/Geonetwork.java b/web/src/main/java/org/fao/geonet/Geonetwork.java index 11e27c0f047c..0f203d4b39aa 100644 --- a/web/src/main/java/org/fao/geonet/Geonetwork.java +++ b/web/src/main/java/org/fao/geonet/Geonetwork.java @@ -28,7 +28,9 @@ import jeeves.interfaces.ApplicationHandler; import jeeves.server.JeevesProxyInfo; import jeeves.server.ServiceConfig; +import jeeves.server.UserSession; import jeeves.server.context.ServiceContext; +import jeeves.server.dispatchers.ServiceManager; import jeeves.server.sources.http.ServletPathFinder; import jeeves.xlink.Processor; import org.apache.commons.lang.StringUtils; @@ -108,8 +110,12 @@ public String getContextName() { /** * Inits the engine, loading all needed data. + * + * @param config Handler configuration + * @param context application handler servlet context + * @return GeonetContext for application */ - public Object start(Element config, ServiceContext context) throws Exception { + public GeonetContext start(Element config, ServiceContext context) throws Exception { context.setAsThreadLocal(); this._applicationContext = context.getApplicationContext(); ApplicationContextHolder.set(this._applicationContext); @@ -275,7 +281,7 @@ public Object start(Element config, ServiceContext context) throws Exception { beanFactory.registerSingleton("oaipmhDisatcher", oaipmhDis); - _applicationContext.getBean(DataManager.class).init(context, false); + _applicationContext.getBean(DataManager.class).init(context); _applicationContext.getBean(HarvestManager.class).init(context, gnContext.isReadOnly()); _applicationContext.getBean(ThumbnailMaker.class).init(context); @@ -338,7 +344,7 @@ public Object start(Element config, ServiceContext context) throws Exception { createDBHeartBeat(gnContext, dbHeartBeatInitialDelay, dbHeartBeatFixedDelay); } - fillCaches(context); + fillCaches(); AbstractEntityListenerManager.setSystemRunning(true); @@ -347,51 +353,56 @@ public Object start(Element config, ServiceContext context) throws Exception { return gnContext; } - private void fillCaches(final ServiceContext context) { - final FormatterApi formatService = context.getBean(FormatterApi.class); // this will initialize the formatter - + private void fillCaches() { Thread fillCaches = new Thread(new Runnable() { @Override public void run() { - final ServletContext servletContext = context.getServlet().getServletContext(); - context.setAsThreadLocal(); - ApplicationContextHolder.set(_applicationContext); - GeonetWro4jFilter filter = (GeonetWro4jFilter) servletContext.getAttribute(GeonetWro4jFilter.GEONET_WRO4J_FILTER_KEY); - - @SuppressWarnings("unchecked") - List wro4jUrls = _applicationContext.getBean("wro4jUrlsToInitialize", List.class); - - for (String wro4jUrl : wro4jUrls) { - Log.info(Geonet.GEONETWORK, "Initializing the WRO4J group: " + wro4jUrl + " cache"); - final MockHttpServletRequest servletRequest = new MockHttpServletRequest(servletContext, "GET", "/static/" + wro4jUrl); - final MockHttpServletResponse response = new MockHttpServletResponse(); - try { - filter.doFilter(servletRequest, response, new MockFilterChain()); - } catch (Throwable t) { - Log.info(Geonet.GEONETWORK, "Error while initializing the WRO4J group: " + wro4jUrl + " cache", t); - } - } + ServiceManager serviceManager = _applicationContext.getBean(ServiceManager.class); + try (ServiceContext fillCacheServiceContext = serviceManager.createServiceContext( "init.filleCaches",_applicationContext)) { + fillCacheServiceContext.setUserSession( new UserSession() ); + FormatterApi formatService = fillCacheServiceContext.getBean(FormatterApi.class); // this will initialize the formatter + final ServletContext servletContext = fillCacheServiceContext.getServlet().getServletContext(); + fillCacheServiceContext.setAsThreadLocal(); + ApplicationContextHolder.set(_applicationContext); + + GeonetWro4jFilter filter = (GeonetWro4jFilter) servletContext.getAttribute(GeonetWro4jFilter.GEONET_WRO4J_FILTER_KEY); - final Page metadatas = _applicationContext.getBean(MetadataRepository.class).findAll(PageRequest.of(0, 1)); - if (metadatas.getNumberOfElements() > 0) { - Integer mdId = metadatas.getContent().get(0).getId(); - context.getUserSession().loginAs(new User().setName("admin").setProfile(Profile.Administrator).setUsername("admin")); @SuppressWarnings("unchecked") - List formattersToInitialize = _applicationContext.getBean("formattersToInitialize", List.class); - - for (String formatterName : formattersToInitialize) { - Log.info(Geonet.GEONETWORK, "Initializing the Formatter with id: " + formatterName); - final MockHttpSession servletSession = new MockHttpSession(servletContext); - servletSession.setAttribute(Jeeves.Elem.SESSION, context.getUserSession()); - final MockHttpServletRequest servletRequest = new MockHttpServletRequest(servletContext); - servletRequest.setSession(servletSession); + List wro4jUrls = _applicationContext.getBean("wro4jUrlsToInitialize", List.class); + + for (String wro4jUrl : wro4jUrls) { + Log.info(Geonet.GEONETWORK, "Initializing the WRO4J group: " + wro4jUrl + " cache"); + final MockHttpServletRequest servletRequest = new MockHttpServletRequest(servletContext, "GET", "/static/" + wro4jUrl); final MockHttpServletResponse response = new MockHttpServletResponse(); try { - formatService.exec("eng", FormatType.html.toString(), mdId.toString(), null, formatterName, - Boolean.TRUE.toString(), false, FormatterWidth._100, new ServletWebRequest(servletRequest, response)); + filter.doFilter(servletRequest, response, new MockFilterChain()); } catch (Throwable t) { - Log.info(Geonet.GEONETWORK, "Error while initializing the Formatter with id: " + formatterName, t); + Log.info(Geonet.GEONETWORK, "Error while initializing the WRO4J group: " + wro4jUrl + " cache", t); + } + } + + + final Page metadatas = _applicationContext.getBean(MetadataRepository.class).findAll(PageRequest.of(0, 1)); + if (metadatas.getNumberOfElements() > 0) { + Integer mdId = metadatas.getContent().get(0).getId(); + fillCacheServiceContext.getUserSession().loginAs(new User().setName("admin").setProfile(Profile.Administrator).setUsername("admin")); + @SuppressWarnings("unchecked") + List formattersToInitialize = _applicationContext.getBean("formattersToInitialize", List.class); + + for (String formatterName : formattersToInitialize) { + Log.info(Geonet.GEONETWORK, "Initializing the Formatter with id: " + formatterName); + final MockHttpSession servletSession = new MockHttpSession(servletContext); + servletSession.setAttribute(Jeeves.Elem.SESSION, fillCacheServiceContext.getUserSession()); + final MockHttpServletRequest servletRequest = new MockHttpServletRequest(servletContext); + servletRequest.setSession(servletSession); + final MockHttpServletResponse response = new MockHttpServletResponse(); + try { + formatService.exec("eng", FormatType.html.toString(), mdId.toString(), null, formatterName, + Boolean.TRUE.toString(), false, FormatterWidth._100, new ServletWebRequest(servletRequest, response)); + } catch (Throwable t) { + Log.info(Geonet.GEONETWORK, "Error while initializing the Formatter with id: " + formatterName, t); + } } } } @@ -545,5 +556,13 @@ public void stop() { // Beans registered using SingletonBeanRegistry#registerSingleton don't have their // @PreDestroy called. So do it manually. oaipmhDis.shutdown(); + + // shutdown data manager + try { + _applicationContext.getBean(DataManager.class).destroy(); + } catch (Exception e) { + logger.error("Raised exception while stopping data manager"); + logger.error(e); + } } } diff --git a/web/src/main/webResources/WEB-INF/web.xml b/web/src/main/webResources/WEB-INF/web.xml index 83f83ac00755..3b1d8940c553 100644 --- a/web/src/main/webResources/WEB-INF/web.xml +++ b/web/src/main/webResources/WEB-INF/web.xml @@ -39,6 +39,9 @@ org.springframework.web.context.request.RequestContextListener + + org.fao.geonet.GeonetworkHttpSessionListener +