com.artipie.debian.metadata.Control Maven / Gradle / Ivy
The newest version!
/*
* The MIT License (MIT)
*
* Copyright (c) 2020 Artipie
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.artipie.debian.metadata;
import java.io.BufferedInputStream;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.compress.archivers.ArchiveException;
import org.apache.commons.compress.archivers.ArchiveInputStream;
import org.apache.commons.compress.archivers.ArchiveStreamFactory;
import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
import org.apache.commons.compress.archivers.tar.TarArchiveInputStream;
import org.apache.commons.compress.compressors.gzip.GzipCompressorInputStream;
import org.apache.commons.compress.compressors.xz.XZCompressorInputStream;
import org.apache.commons.io.IOUtils;
/**
* Control metadata file from debian package.
* See docs.
* @since 0.1
*/
public interface Control {
/**
* Control file content as string.
* @return String with package info
*/
String asString();
/**
* Control from debian binary package.
* Check docs.
* @since 0.1
*/
final class FromBinary implements Control {
/**
* Control file name.
*/
private static final String FILE_NAME = "control";
/**
* Debian binary package bytes.
*/
private final byte[] pkg;
/**
* Ctor.
*
* @param pkg Debian binary package
*/
public FromBinary(final byte[] pkg) {
this.pkg = pkg;
}
@Override
@SuppressWarnings("PMD.AssignmentInOperand")
public String asString() {
try (
ArchiveInputStream input = new ArchiveStreamFactory().createArchiveInputStream(
new BufferedInputStream(new ByteArrayInputStream(this.pkg))
)
) {
ArchiveEntry entry;
while ((entry = input.getNextEntry()) != null) {
if (!input.canReadEntryData(entry)) {
continue;
}
if (entry.getName().startsWith(FromBinary.FILE_NAME)) {
return FromBinary.unpackTar(FromBinary.stream(input, entry.getName()));
}
}
} catch (final ArchiveException | IOException ex) {
throw new IllegalStateException("Failed to obtain package metadata", ex);
}
throw new IllegalStateException("Archive `control` is not found in the package");
}
/**
* Returns correct (depending on archive type) input stream for archive entry input stream.
*
* @param input Archived entry input
* @param name Archived entry name
* @return Corresponding InputStream instance
* @throws IOException On error
*/
private static InputStream stream(final ArchiveInputStream input, final String name)
throws IOException {
final InputStream res;
if (name.endsWith("gz")) {
res = new GzipCompressorInputStream(input);
} else if (name.endsWith("xz")) {
res = new XZCompressorInputStream(input);
} else {
throw new IllegalStateException("Unsupported archive type");
}
return res;
}
/**
* Unpacks internal tar and reads control file.
*
* @param input Input stream
* @return Control file as string
* @throws IOException On error
*/
@SuppressWarnings("PMD.AssignmentInOperand")
private static String unpackTar(final InputStream input) throws IOException {
try (TarArchiveInputStream tar = new TarArchiveInputStream(input)) {
TarArchiveEntry entry;
while ((entry = (TarArchiveEntry) tar.getNextEntry()) != null) {
if (entry.isFile()
&& entry.getName().equals(String.format("./%s", FromBinary.FILE_NAME))) {
return IOUtils.toString(tar, StandardCharsets.UTF_8);
}
}
} finally {
input.close();
}
throw new IllegalStateException(
"File `control` is not found in `control` archive"
);
}
}
}