MCR-3339 Ensure usage of MCRResourceResolver with custom PMD rule

mycore-base/src/main/java/org/mycore/common/MCRCoreVersion.java

@@ -52,6 +52,7 @@ public static String getVersion() {
         return VERSION;
     }
 
+    @SuppressWarnings("PMD.MCR.ResourceResolver")
     private static Properties loadVersionProperties() {
         Properties props = new Properties();
         URL gitPropURL = MCRCoreVersion.class.getResource("/org/mycore/git.properties");

mycore-base/src/main/java/org/mycore/common/config/MCRComponent.java

@@ -41,6 +41,7 @@
  * @since 2013.12
  * @see MCRRuntimeComponentDetector
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public class MCRComponent implements Comparable<MCRComponent> {
 
     private static final Logger LOGGER = LogManager.getLogger();

mycore-base/src/main/java/org/mycore/common/config/MCRConfigurationInputStream.java

@@ -53,6 +53,7 @@
  * @author Robert Stephan
  * @since 2013.12
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public class MCRConfigurationInputStream extends InputStream {
 
     private static final String MYCORE_PROPERTIES = "mycore.properties";

mycore-base/src/main/java/org/mycore/common/config/MCRDefaultConfigurationLoader.java

@@ -37,6 +37,7 @@
  * @author Thomas Scheffler (yagee)
  * @since 2013.12
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public class MCRDefaultConfigurationLoader implements MCRConfigurationLoader {
 
     MCRProperties properties;

mycore-base/src/main/java/org/mycore/common/config/MCRRuntimeComponentDetector.java

@@ -49,6 +49,7 @@
  * @author Thomas Scheffler (yagee)
  * @since 2013.12
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public class MCRRuntimeComponentDetector {
 
     private static final Logger LOGGER = LogManager.getLogger();

mycore-base/src/main/java/org/mycore/common/events/MCRServletContainerInitializer.java

@@ -39,6 +39,7 @@
 /**
  * @author Thomas Scheffler (yagee)
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public class MCRServletContainerInitializer implements ServletContainerInitializer {
 
     /* (non-Javadoc)

mycore-base/src/main/java/org/mycore/common/xml/MCREntityResolver.java

@@ -58,6 +58,7 @@
  * @author Thomas Scheffler (yagee)
  * @since 2013.10
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public final class MCREntityResolver implements EntityResolver2, LSResourceResolver {
 
     private static final Logger LOGGER = LogManager.getLogger();

mycore-base/src/main/java/org/mycore/common/xsl/MCRXSLInfoServlet.java

@@ -64,6 +64,7 @@
  *
  * @author Frank Lützenkirchen
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public final class MCRXSLInfoServlet extends MCRServlet {
 
     @Serial

mycore-base/src/main/java/org/mycore/datamodel/metadata/validator/MCREditorOutValidator.java

@@ -451,16 +451,16 @@ private void updateConditionsValueAttribute(Element rootbool) {
     }
 
     private Document loadDefaultAclDocument() throws IOException, JDOMException {
-        String resourcetype = "/editor_default_acls_" + id.getTypeId() + ".xml";
-        String resourcebase = "/editor_default_acls_" + id.getBase() + ".xml";
-        InputStream aclxml = MCREditorOutValidator.class.getResourceAsStream(resourcebase);
+        String resourcetype = "editor_default_acls_" + id.getTypeId() + ".xml";
+        String resourcebase = "editor_default_acls_" + id.getBase() + ".xml";
+        InputStream aclxml = MCRResourceHelper.getResourceAsStream(resourcebase);
         if (aclxml == null) {
-            aclxml = MCREditorOutValidator.class.getResourceAsStream(resourcetype);
+            aclxml = MCRResourceHelper.getResourceAsStream(resourcetype);
             if (aclxml == null) {
                 LOGGER.warn("Can't find default object ACL file {} or {}",
-                    () -> resourcebase.substring(1), () -> resourcetype.substring(1));
-                String resource = "/editor_default_acls.xml"; // fallback
-                aclxml = MCREditorOutValidator.class.getResourceAsStream(resource);
+                    resourcebase, resourcetype);
+                String resource = "editor_default_acls.xml"; // fallback
+                aclxml = MCRResourceHelper.getResourceAsStream(resource);
                 if (aclxml == null) {
                     return null;
                 }

mycore-base/src/main/java/org/mycore/frontend/cli/MCRBasicCommands.java

@@ -44,7 +44,6 @@
 import org.jdom2.input.SAXBuilder;
 import org.jdom2.output.Format;
 import org.jdom2.output.XMLOutputter;
-import org.mycore.common.MCRClassTools;
 import org.mycore.common.config.MCRComponent;
 import org.mycore.common.config.MCRConfiguration2;
 import org.mycore.common.config.MCRConfigurationDir;
@@ -54,6 +53,7 @@
 import org.mycore.common.xml.MCRXMLParserFactory;
 import org.mycore.frontend.cli.annotation.MCRCommand;
 import org.mycore.frontend.cli.annotation.MCRCommandGroup;
+import org.mycore.resource.MCRResourceHelper;
 
 /**
  * This class contains the basic commands for MyCoRe Command Line and WebCLI.
@@ -224,7 +224,6 @@ private static boolean createDirectory(File directory) {
     }
 
     private static void createSampleConfigFile(String path) throws IOException {
-        ClassLoader classLoader = MCRClassTools.getClassLoader();
         Path configurationDirectory = MCRConfigurationDir.getConfigurationDirectory().toPath();
         Path targetFile = configurationDirectory.resolve(path);
         if (Files.exists(targetFile)) {
@@ -237,7 +236,7 @@ private static void createSampleConfigFile(String path) throws IOException {
                 throw new IOException("Could not create directory for file: " + targetFile);
             }
         }
-        try (InputStream templateResource = classLoader.getResourceAsStream("configdir.template/" + path)) {
+        try (InputStream templateResource = MCRResourceHelper.getResourceAsStream("configdir.template/" + path)) {
             if (templateResource == null) {
                 throw new IOException("Could not find template for " + path);
             }
@@ -301,6 +300,7 @@ private static boolean updatePersistenceH2JdbcUrl(Document persistenceDoc) {
      * @return true, if the mappings changed
      * @throws IOException
      */
+    @SuppressWarnings("PMD.MCR.ResourceResolver")
     private static boolean updatePersistenceMappings(Document persistenceDoc) throws IOException {
         Namespace nsPersistence = persistenceDoc.getRootElement().getNamespace();
         Element ePersistenceUnit = persistenceDoc.getRootElement().getChild("persistence-unit", nsPersistence);

mycore-base/src/main/java/org/mycore/frontend/cli/MCRCommandLineInterface.java

@@ -42,7 +42,6 @@
 
 import org.apache.commons.text.StringSubstitutor;
 import org.jdom2.Element;
-import org.mycore.common.MCRClassTools;
 import org.mycore.common.MCRSession;
 import org.mycore.common.MCRSessionMgr;
 import org.mycore.common.MCRSystemUserInformation;
@@ -51,6 +50,7 @@
 import org.mycore.common.content.MCRJDOMContent;
 import org.mycore.common.events.MCRStartupHandler;
 import org.mycore.common.xml.MCRURIResolver;
+import org.mycore.resource.MCRResourceHelper;
 
 /**
  * The main class implementing the MyCoRe command line interface. With the
@@ -334,7 +334,7 @@ public static List<String> readCommandsFile(String file) throws IOException {
     }
 
     public static List<String> readCommandsRessource(String resource) throws IOException {
-        final URL resourceURL = MCRClassTools.getClassLoader().getResource(resource);
+        final URL resourceURL = MCRResourceHelper.getResourceUrl(resource);
         if (resourceURL == null) {
             throw new IOException("Resource URL is null!");
         }

mycore-base/src/main/java/org/mycore/frontend/servlets/persistence/MCRCreateObjectServlet.java

@@ -140,7 +140,7 @@ private void redirectToCreateObject(HttpServletRequest request, HttpServletRespo
             sb.append('-').append(layout);
         }
         String baseName = sb.toString();
-        String form = MCRPersistenceHelper.getWebPage(getServletContext(), baseName + ".xed", baseName + ".xml");
+        String form = MCRPersistenceHelper.getWebPage(baseName + ".xed", baseName + ".xml");
         Properties params = new Properties();
         params.put("cancelUrl", MCRPersistenceHelper.getCancelUrl(request));
         params.put("mcrid", objectID.toString());

mycore-base/src/main/java/org/mycore/frontend/servlets/persistence/MCRPersistenceHelper.java

@@ -20,7 +20,6 @@
 
 import java.io.IOException;
 import java.io.StringWriter;
-import java.net.MalformedURLException;
 import java.util.Map;
 import java.util.Properties;
 import java.util.stream.Collectors;
@@ -37,6 +36,7 @@
 import org.mycore.datamodel.metadata.validator.MCREditorOutValidator;
 import org.mycore.frontend.MCRFrontendUtil;
 import org.mycore.frontend.servlets.MCRServlet;
+import org.mycore.resource.MCRResourceHelper;
 
 import jakarta.servlet.ServletContext;
 import jakarta.servlet.ServletException;
@@ -130,18 +130,17 @@ static MCRObject getMCRObject(Document doc) throws JDOMException, IOException, M
         return new MCRObject(validMyCoReObject);
     }
 
-    protected static String getWebPage(ServletContext context, String modernPage, String deprecatedPage)
-        throws ServletException {
-        try {
-            if (context.getResource("/" + modernPage) == null
-                && context.getResource("/" + deprecatedPage) != null) {
-                LogManager.getLogger()
-                    .warn("Could not find {} in webapp root, using deprecated {} instead.", modernPage,
-                        deprecatedPage);
-                return deprecatedPage;
-            }
-        } catch (MalformedURLException e) {
-            throw new ServletException(e);
+    @Deprecated
+    protected static String getWebPage(ServletContext context, String modernPage, String deprecatedPage) {
+        return getWebPage(modernPage, deprecatedPage);
+    }
+
+    protected static String getWebPage(String modernPage, String deprecatedPage) {
+        if (MCRResourceHelper.getWebResourceUrl(modernPage) == null
+            && MCRResourceHelper.getWebResourceUrl(deprecatedPage) != null) {
+            LOGGER.warn("Could not find {} in webapp root, using deprecated {} instead.",
+                modernPage, deprecatedPage);
+            return deprecatedPage;
         }
         return modernPage; //even if it does not exist: nice 404 helps the user
     }

mycore-base/src/main/java/org/mycore/frontend/servlets/persistence/MCRPersistenceServlet.java

@@ -62,7 +62,7 @@ abstract class MCRPersistenceServlet extends MCRServlet {
     public void init() throws ServletException {
         super.init();
         String configuredPage = MCRConfiguration2.getStringOrThrow("MCR.FileUpload.WebPage");
-        uploadPage = MCRPersistenceHelper.getWebPage(getServletContext(), configuredPage, "fileupload_commit.xml");
+        uploadPage = MCRPersistenceHelper.getWebPage(configuredPage, "fileupload_commit.xml");
     }
 
     @Override

mycore-base/src/main/java/org/mycore/frontend/servlets/persistence/MCRUpdateDerivateServlet.java

@@ -136,7 +136,7 @@ private void redirectToUpdateDerivate(HttpServletRequest request, HttpServletRes
             Properties params = new Properties();
             params.put("sourceUri", "xslStyle:mycorederivate-editor:mcrobject:" + derivateID);
             params.put("cancelUrl", MCRPersistenceHelper.getCancelUrl(request));
-            String page = MCRPersistenceHelper.getWebPage(getServletContext(), "editor_form_derivate.xed",
+            String page = MCRPersistenceHelper.getWebPage("editor_form_derivate.xed",
                 "editor_form_derivate.xml");
             String redirectURL = MCRFrontendUtil.getBaseURL() + page;
             response

mycore-base/src/main/java/org/mycore/resource/locator/MCRClassLoaderResourceLocator.java

@@ -48,6 +48,7 @@
  * [...].Class=org.mycore.resource.locator.MCRClassLoaderResourceLocator
  * </pre>
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 @MCRConfigurationProxy(proxyClass = MCRClassLoaderResourceLocator.Factory.class)
 public class MCRClassLoaderResourceLocator extends MCRResourceLocatorBase {
 

mycore-base/src/main/java/org/mycore/resource/locator/MCRServletContextResourceLocator.java

@@ -48,6 +48,7 @@
  * [...].Class=org.mycore.resource.locator.MCRServletContextResourceLocator
  * </pre>
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 @MCRConfigurationProxy(proxyClass = MCRServletContextResourceLocator.Factory.class)
 public class MCRServletContextResourceLocator extends MCRResourceLocatorBase {
 

mycore-base/src/main/java/org/mycore/resource/provider/MCRClassLoaderResourceProvider.java

@@ -47,6 +47,7 @@
  * [...].Coverage=Lorem ipsum dolor sit amet
  * </pre>
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 @MCRConfigurationProxy(proxyClass = MCRClassLoaderResourceProvider.Factory.class)
 public class MCRClassLoaderResourceProvider extends MCRResourceProviderBase {
 

mycore-base/src/main/java/org/mycore/services/i18n/MCRTranslation.java

@@ -405,6 +405,7 @@ static boolean isArray(String masked) {
         return false;
     }
 
+    @SuppressWarnings("PMD.MCR.ResourceResolver")
     static Properties loadProperties() {
         Properties deprecatedMapping = new Properties();
         try {

mycore-base/src/main/java/org/mycore/tools/MyCoReWebPageProvider.java

@@ -37,6 +37,7 @@
 import org.jdom2.Text;
 import org.jdom2.input.SAXBuilder;
 import org.mycore.frontend.servlets.MCRServlet;
+import org.mycore.resource.MCRResourceHelper;
 import org.xml.sax.InputSource;
 
 /**
@@ -56,6 +57,7 @@
  * @author shermann
  * @author Matthias Eichner
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public class MyCoReWebPageProvider {
 
     /** German language key */
@@ -112,7 +114,7 @@ public Element addSection(String title, String xmlAsString, String lang) throws
         SAXBuilder saxBuilder = new SAXBuilder();
         saxBuilder.setEntityResolver((publicId, systemId) -> {
             String resource = systemId.substring(systemId.lastIndexOf('/'));
-            InputStream is = getClass().getResourceAsStream(resource);
+            InputStream is = MCRResourceHelper.getResourceAsStream(resource);
             if (is == null) {
                 throw new IOException(new FileNotFoundException("Unable to locate resource " + resource));
             }

mycore-fo/src/main/java/org/mycore/component/fo/common/fo/MCRFoFormatterFOP.java

@@ -77,7 +77,7 @@ public class MCRFoFormatterFOP implements MCRFoFormatterInterface {
     final ResourceResolver resolver = new ResourceResolver() {
         @Override
         public OutputStream getOutputStream(URI uri) throws IOException {
-            URL url = MCRURIResolver.getServletContext().getResource(uri.toString());
+            URL url = MCRResourceHelper.getResourceUrl(uri.toString());
             return url.openConnection().getOutputStream();
         }
 

mycore-mets/src/main/java/org/mycore/mets/resource/MetsResource.java

@@ -30,7 +30,6 @@
 import org.jdom2.input.SAXBuilder;
 import org.jdom2.output.XMLOutputter;
 import org.mycore.access.MCRAccessManager;
-import org.mycore.common.MCRClassTools;
 import org.mycore.common.MCRException;
 import org.mycore.common.config.MCRConfiguration2;
 import org.mycore.datamodel.metadata.MCRMetadataManager;
@@ -44,6 +43,7 @@
 import org.mycore.mets.model.converter.MCRXMLSimpleModelConverter;
 import org.mycore.mets.model.simple.MCRMetsSimpleModel;
 import org.mycore.mets.tools.MCRMetsLock;
+import org.mycore.resource.MCRResourceHelper;
 
 import jakarta.ws.rs.Consumes;
 import jakarta.ws.rs.DELETE;
@@ -72,7 +72,7 @@ public String startEditor(@PathParam(DERIVATE_ID) String derivateId) {
         checkDerivateExists(derivateIdObject);
         checkDerivateAccess(derivateIdObject, MCRAccessManager.PERMISSION_WRITE);
 
-        try (InputStream resourceAsStream = MCRClassTools.getClassLoader().getResourceAsStream("mets-editor.html")) {
+        try (InputStream resourceAsStream = MCRResourceHelper.getResourceAsStream("mets-editor.html")) {
             String htmlTemplate = new String(resourceAsStream.readAllBytes(), StandardCharsets.UTF_8);
             // add additional javascript code
             String js = MCRConfiguration2.getString("MCR.Mets.Editor.additional.javascript").orElse(null);

mycore-pandoc/src/main/java/org/mycore/pandoc/MCRPandocAPI.java

@@ -29,6 +29,7 @@
 import org.jdom2.Element;
 import org.jdom2.input.SAXBuilder;
 import org.mycore.common.config.MCRConfiguration2;
+import org.mycore.resource.MCRResourceHelper;
 
 /**
  * Interface to the command line utility <a href="https://pandoc.org">Pandoc</a>,
@@ -45,7 +46,7 @@ public class MCRPandocAPI {
     private static final int TIMEOUT = MCRConfiguration2.getInt("MCR.Pandoc.Timeout").orElse(5);
 
     private static final String LUA_PATH = MCRConfiguration2.getString("MCR.Pandoc.LuaPath")
-        .orElse(Thread.currentThread().getContextClassLoader().getResource("lua").getPath() + "?.lua");
+        .orElse(MCRResourceHelper.getResourceUrl("lua").getPath() + "?.lua");
 
     private enum Action {
         READER("Reader"), WRITER("Writer");
@@ -122,7 +123,7 @@ private static String convertFormatToPath(Action action, String format) {
         String path = MCRConfiguration2.getString("MCR.Pandoc." + action + "." + format + ".Path").orElse("");
         if (!property.isEmpty()) {
             if (path.isEmpty()) {
-                return Thread.currentThread().getContextClassLoader().getResource(property).getFile();
+                return MCRResourceHelper.getResourceUrl(property).getFile();
             } else {
                 return Paths.get(path).resolve(property).toString();
             }

mycore-pi/src/main/java/org/mycore/pi/doi/cli/MCRDOICommands.java

@@ -69,6 +69,7 @@
 import org.mycore.pi.doi.crossref.MCRCrossrefUtil;
 import org.mycore.pi.exceptions.MCRIdentifierUnresolvableException;
 import org.mycore.pi.exceptions.MCRPersistentIdentifierException;
+import org.mycore.resource.MCRResourceHelper;
 import org.xml.sax.SAXException;
 
 @MCRCommandGroup(name = "DOI Commands")
@@ -303,7 +304,7 @@ public static void validateCrossrefDocument(String mycoreIDString, String transf
         final Schema schema;
         try {
             SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
-            URL localSchemaURL = Thread.currentThread().getContextClassLoader().getResource(CROSSREF_SCHEMA_PATH);
+            URL localSchemaURL = MCRResourceHelper.getResourceUrl(CROSSREF_SCHEMA_PATH);
             if (localSchemaURL == null) {
                 LOGGER.error(CROSSREF_SCHEMA_PATH + " was not found!");
                 return;

mycore-tei/pom.xml

@@ -29,9 +29,22 @@
   <artifactId>mycore-tei</artifactId>
   <name>MyCoRe TEI</name>
   <dependencies>
+    <dependency>
+      <groupId>jakarta.servlet</groupId>
+      <artifactId>jakarta.servlet-api</artifactId>
+    </dependency>
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.mycore</groupId>
+      <artifactId>mycore-base</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.mycore</groupId>
+      <artifactId>mycore-base</artifactId>
+      <type>test-jar</type>
+    </dependency>
   </dependencies>
 </project>