/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina.webresources;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import jakarta.servlet.ServletContext;
import org.apache.catalina.LifecycleException;
import org.apache.catalina.WebResource;
import org.apache.catalina.startup.ExpandWar;
import org.apache.catalina.util.IOTools;
import org.apache.tomcat.util.res.StringManager;
/**
* If the main resources are packaged as a WAR file then any JARs will be extracted to the work directory and used from
* there.
*/
public class ExtractingRoot extends StandardRoot {
private static final StringManager sm = StringManager.getManager(ExtractingRoot.class);
private static final String APPLICATION_JARS_DIR = "application-jars";
@Override
protected void processWebInfLib() throws LifecycleException {
// Don't extract JAR files unless the application is deployed as a
// packed WAR file.
if (!super.isPackedWarFile()) {
super.processWebInfLib();
return;
}
File expansionTarget = getExpansionTarget();
if (!expansionTarget.isDirectory()) {
if (!expansionTarget.mkdirs()) {
throw new LifecycleException(sm.getString("extractingRoot.targetFailed", expansionTarget));
}
}
WebResource[] possibleJars = listResources("/WEB-INF/lib", false);
for (WebResource possibleJar : possibleJars) {
if (possibleJar.isFile() && possibleJar.getName().endsWith(".jar")) {
try {
File dest = new File(expansionTarget, possibleJar.getName());
dest = dest.getCanonicalFile();
try (InputStream sourceStream = possibleJar.getInputStream();
OutputStream destStream = new FileOutputStream(dest)) {
IOTools.flow(sourceStream, destStream);
}
createWebResourceSet(ResourceSetType.CLASSES_JAR, "/WEB-INF/classes", dest.toURI().toURL(), "/");
} catch (IOException ioe) {
throw new LifecycleException(sm.getString("extractingRoot.jarFailed", possibleJar.getName()), ioe);
}
}
}
}
private File getExpansionTarget() {
File tmpDir = (File) getContext().getServletContext().getAttribute(ServletContext.TEMPDIR);
return new File(tmpDir, APPLICATION_JARS_DIR);
}
@Override
protected boolean isPackedWarFile() {
return false;
}
@Override
protected void stopInternal() throws LifecycleException {
super.stopInternal();
if (super.isPackedWarFile()) {
// Remove the extracted JARs from the work directory
File expansionTarget = getExpansionTarget();
ExpandWar.delete(expansionTarget);
}
}
}