Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

fix: symlinks now work with apache-commons compress #157

Merged
merged 2 commits into from
Oct 31, 2024
Merged

fix: symlinks now work with apache-commons compress #157

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ccffa0
fix: symlinks now work with apache-commons compress
aleyeeey Oct 31, 2024
1ef22d6
refactor: added exception
aleyeeey Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 57 additions & 81 deletions libraries/ae-inventory-processor/src/main/java/org/metaeffekt/core/util/ArchiveUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
*/
package org.metaeffekt.core.util;

import org.apache.commons.compress.archivers.ar.ArArchiveEntry;
import org.apache.commons.compress.archivers.ar.ArArchiveInputStream;
import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
import org.apache.commons.compress.archivers.tar.TarArchiveInputStream;
import org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream;
import org.apache.commons.compress.compressors.xz.XZCompressorInputStream;
import org.apache.commons.io.FilenameUtils;
Expand All @@ -25,7 +25,6 @@
import org.apache.tools.ant.Project;
import org.apache.tools.ant.taskdefs.Expand;
import org.apache.tools.ant.taskdefs.GUnzip;
import org.apache.tools.ant.taskdefs.Untar;
import org.apache.tools.ant.taskdefs.Zip;
import org.metaeffekt.core.inventory.processor.model.Artifact;
import org.metaeffekt.core.inventory.processor.model.FilePatternQualifierMapper;
Expand All @@ -35,6 +34,7 @@

import java.io.*;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.*;
import java.util.concurrent.TimeUnit;

Expand Down Expand Up @@ -200,6 +200,7 @@ public static void untar(File file, File targetDir) throws IOException {
}
}


try {
untarInternal(file, targetDir);
} catch (Exception e) {
Expand Down Expand Up @@ -234,80 +235,15 @@ private static void expandBzip2(File file, File targetFile) throws IOException {

private static void untarInternal(File file, File targetFile) throws IOException {
try {
// attempt ant untar (anticipating broad compatibility)
final Project project = new Project();
Untar expandTask = new Untar();
expandTask.setProject(project);
expandTask.setDest(targetFile);
expandTask.setSrc(file);
expandTask.setAllowFilesToEscapeDest(false);
expandTask.setOverwrite(true);
expandTask.execute();
} catch (Exception antUntarException) {
LOG.debug("Could not untar file [{}] due to [{}].", file.getAbsolutePath(), antUntarException.getMessage());
try {
// TODO: document or fix: why are we trying to extract a tar as an "ar" archive?
// interpreting it as an ar archive might not support symlinks with the current api.

// fallback to commons-compress (local code with support for specific cases (i.e., .deb)
final InputStream fin = Files.newInputStream(file.toPath());
final BufferedInputStream in = new BufferedInputStream(fin);
final ArArchiveInputStream xzIn = new ArArchiveInputStream(in);
unpackAndClose(xzIn, targetFile);
} catch (Exception commonsCompressException) {
// report commons compress exception only and indicate fallback
LOG.debug(
"Cannot untar file [{}] due to [{}]. Attempting untar via command line.",
file.getAbsolutePath(),
commonsCompressException.getMessage()
);

// FIXME: this fallback doesn't adjust file permissions, leading to "Permission denied" while scanning.
// this also means that prepareScanDirectory may fail on rescan.
// we should probably just make sure that the java-native unwrao doesn't fail instead of relying on
// this last-ditch efford to give good support.
// fallback to native support on command line

Process tarExtract = new ProcessBuilder().command(
"tar",
"-x",
"-f", file.getAbsolutePath(),
"--no-same-permissions",
"-C", targetFile.getAbsolutePath())
.redirectErrorStream(true)
.redirectOutput(ProcessBuilder.Redirect.INHERIT)
.start();

// wait for untar. if our untar takes more than one hour, we can be pretty sure that something is broken
try {
if (!tarExtract.waitFor(UNTAR_TIMEOUT_NUMBER, UNTAR_TIMEOUT_UNIT)) {
// timeout
LOG.error("Failed to untar [{}].", file.getAbsolutePath());

LOG.error("Killing untar process...");
tarExtract.destroyForcibly();
if (!tarExtract.waitFor(1, TimeUnit.MINUTES)) {
// once we are in Java 9 or newer, we should output PID in this case
LOG.error("Failed to kill untar! This will leave a tar process with unknown state!");
}

throw new IOException("Untar failed: timed out.");
}
} catch (InterruptedException e) {
throw new IOException("Untar thread was interrupted.", e);
}

if (tarExtract.exitValue() != 0) {
LOG.error(
"Untar of [{}] failed with exit value [{}].",
file.getAbsolutePath(),
tarExtract.exitValue()
);
throw new IOException("Failed to untar requested file.");
}

// NOTE: further exceptions are handled upstream
final InputStream fin = Files.newInputStream(file.toPath());
final BufferedInputStream in = new BufferedInputStream(fin);
final TarArchiveInputStream xzIn = new TarArchiveInputStream(in);
if (!targetFile.exists()) {
FileUtils.forceMkdir(targetFile);
}
unpackAndClose(xzIn, targetFile);
} catch (Exception commonCompressException) {
throw new IOException("Could not untar file [{" + file.getAbsolutePath() + "}]", commonCompressException);
}
}

Expand All @@ -324,13 +260,53 @@ private static void unpackAndClose(InputStream in, OutputStream out) throws IOEx
}
}

private static void unpackAndClose(ArArchiveInputStream in, File targetDir) throws IOException {
private static void unpackAndClose(TarArchiveInputStream in, File targetDir) throws IOException {
try {
ArArchiveEntry entry;
while ((entry = in.getNextArEntry()) != null) {
TarArchiveEntry entry;

// we need to check the os we are running on
boolean isWindows = System.getProperty("os.name").toLowerCase().startsWith("windows");

while ((entry = in.getNextEntry()) != null) {
final File targetFile = new File(targetDir, entry.getName());
try (OutputStream out = Files.newOutputStream(targetFile.toPath())) {
IOUtils.copy(in, out);

if (!isWindows) {
try {
int uid = (Integer) Files.getAttribute(targetDir.toPath(), "unix:uid");
int gid = (Integer) Files.getAttribute(targetDir.toPath(), "unix:gid");
entry.setUserId(uid);
entry.setGroupId(gid);
} catch (UnsupportedOperationException e) {
LOG.warn("Unix file attributes not supported on this platform.");
}
}

if (entry.isDirectory()) {
FileUtils.forceMkdir(targetFile);
} else {
if (targetFile.exists() || Files.isSymbolicLink(targetFile.toPath())) {
FileUtils.forceDelete(targetFile);
}
if (entry.isSymbolicLink()) {
Path linkTarget;
if (entry.getLinkName().startsWith("/")) {
// handle absolute paths
linkTarget = targetDir.toPath().resolve(entry.getLinkName().substring(1));
} else {
// handle relative paths
linkTarget = targetFile.toPath().getParent().resolve(entry.getLinkName()).normalize();
}

try {
Files.createSymbolicLink(targetFile.toPath(), linkTarget);
} catch (UnsupportedOperationException | IOException e) {
LOG.warn("Symbolic links not supported or insufficient permissions. Skipping symbolic link creation.");
}
} else {
try (OutputStream out = Files.newOutputStream(targetFile.toPath())) {
IOUtils.copy(in, out);
}
}
}
}
} finally {
Expand Down
Loading