Added Zstd support

mehmet-karaman · mehmet-karaman · commit 8d91b8da29a3 · 2025-03-25T23:41:13.000+01:00
diff --git a/ZipEditor-test/META-INF/MANIFEST.MF b/ZipEditor-test/META-INF/MANIFEST.MF
@@ -9,6 +9,7 @@ Require-Bundle: org.eclipse.core.runtime,
  org.eclipse.core.filesystem,
  org.eclipse.search,
  ZipEditor,
- org.junit
+ org.junit,
+ org.apache.commons.commons-compress
 Eclipse-LazyStart: false
 Bundle-Vendor: %Bundle-Vendor.0
diff --git a/ZipEditor-test/resources/zstd.zip b/ZipEditor-test/resources/zstd.zip
diff --git a/ZipEditor-test/src/zipeditor/model/AbstractModelTest.java b/ZipEditor-test/src/zipeditor/model/AbstractModelTest.java
@@ -13,7 +13,7 @@
 
 public abstract class AbstractModelTest {
 
-	private ZipModel model;
+	protected ZipModel model;
 
 	public abstract String getArchiveName();
 
diff --git a/ZipEditor-test/src/zipeditor/model/ZipModelZstdTest.java b/ZipEditor-test/src/zipeditor/model/ZipModelZstdTest.java
@@ -0,0 +1,55 @@
+package zipeditor.model;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.apache.commons.compress.archivers.zip.ZipMethod;
+import org.junit.Test;
+
+import zipeditor.model.ZipContentDescriber.ContentTypeId;
+
+public class ZipModelZstdTest extends AbstractModelTest {
+
+	@Override
+	public String getArchiveName() {
+		return "zstd.zip";
+	}
+
+	@Override
+	public ContentTypeId getArchiveType() {
+		return ContentTypeId.ZIP_FILE;
+	}
+
+	@Override
+	public void shouldOpenNodes() throws Exception {
+		assertEquals(getArchiveType(), model.getType());
+		assertEquals("", model.getRoot().getPath());
+		assertEquals(2, model.getRoot().getChildren().length);
+		
+		ZipNode childByName = (ZipNode) model.getRoot().getChildByName(".classpath", false);
+		assertEquals(".classpath", childByName.getName());
+		assertEquals(childByName.getMethod(), ZipMethod.ZSTD.getCode());
+		
+		childByName = (ZipNode) model.getRoot().getChildByName(".project", false);
+		assertEquals(".project", childByName.getName());
+		assertEquals(childByName.getMethod(), ZipMethod.ZSTD.getCode());
+	}
+	
+	@Test
+	public void extractZstdNode() throws IOException {
+		ZipNode childByName = (ZipNode) model.getRoot().getChildByName(".project", false);
+		assertEquals(".project", childByName.getName());
+		assertEquals(childByName.getMethod(), ZipMethod.ZSTD.getCode());
+		
+		InputStream content = childByName.getContent();
+		String string = new String(content.readAllBytes());
+
+		String[] split = string.split("\n");
+		assertEquals("<?xml version=\"1.0\" encoding=\"UTF-8\"?>", split[0]);
+		assertEquals(23, split.length);
+	}
+	
+}
diff --git a/ZipEditor/.classpath b/ZipEditor/.classpath
@@ -7,5 +7,6 @@
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
+	<classpathentry kind="lib" path="lib/aircompressor-0.27.jar" sourcepath="lib/aircompressor-0.27-sources.jar"/>
 	<classpathentry kind="output" path="bin"/>
 </classpath>
diff --git a/ZipEditor/META-INF/MANIFEST.MF b/ZipEditor/META-INF/MANIFEST.MF
@@ -2,9 +2,12 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Automatic-Module-Name: %Bundle-Name.0
 Bundle-Name: %Bundle-Name.0
+Bundle-RequiredExecutionEnvironment: JavaSE-21
 Bundle-SymbolicName: ZipEditor;singleton:=true
 Bundle-Version: 1.1.9.qualifier
 Bundle-Activator: zipeditor.ZipEditorPlugin
+Bundle-ClassPath: .,
+ lib/aircompressor-0.27.jar
 Bundle-Localization: plugin
 Require-Bundle: org.eclipse.core.runtime,
  org.eclipse.core.resources,
@@ -18,8 +21,9 @@ Require-Bundle: org.eclipse.core.runtime,
  org.eclipse.search,
  org.apache.ant,
  org.apache.commons.commons-io,
- org.apache.commons.commons-compress;bundle-version="1.27.1",
- org.apache.commons.lang3;bundle-version="3.17.0"
+ org.apache.commons.lang3;bundle-version="3.17.0",
+ org.apache.commons.commons-compress;bundle-version="1.28.0",
+ wrapped.io.airlift.aircompressor;bundle-version="2.0.2"
 Bundle-ActivationPolicy: lazy
 Bundle-Vendor: %Bundle-Vendor.0
 Export-Package: zipeditor,
diff --git a/ZipEditor/build.properties b/ZipEditor/build.properties
@@ -7,4 +7,5 @@ bin.includes = META-INF/,\
                .options,\
                about_files/,\
                about.html,\
-               plugin.properties
+               plugin.properties,\
+               lib/aircompressor-0.27.jar
diff --git a/ZipEditor/lib/aircompressor-0.27-sources.jar b/ZipEditor/lib/aircompressor-0.27-sources.jar
diff --git a/ZipEditor/lib/aircompressor-0.27.jar b/ZipEditor/lib/aircompressor-0.27.jar
diff --git a/ZipEditor/src/zipeditor/actions/AddAction.java b/ZipEditor/src/zipeditor/actions/AddAction.java
@@ -10,6 +10,7 @@
 
 import zipeditor.ZipEditorPlugin;
 import zipeditor.model.Node;
+import zipeditor.model.ZipContentDescriber.ContentTypeId;
 import zipeditor.operations.AddOperation;
 
 public class AddAction extends DialogAction {
@@ -20,13 +21,13 @@ public AddAction(StructuredViewer viewer) {
 	}
 
 	public void run() {
-		File[] paths = openDialog(ActionMessages.getString("AddAction.2"), null, true, true); //$NON-NLS-1$);
-		if (paths == null || paths.length == 0)
-			return;
 		Node[] selectedNodes = getSelectedNodes();
 		Node targetNode = selectedNodes.length > 0 ? selectedNodes[0] : getViewerInputAsNode();
+		File[] paths = openDialog(ActionMessages.getString("AddAction.2"), null, true, true, targetNode.getModel().getType() == ContentTypeId.ZIP_FILE); //$NON-NLS-1$);
+		if (paths == null || paths.length == 0)
+			return;
 		AddOperation operation = new AddOperation();
-		operation.execute(paths, targetNode, null, getViewer());
+		operation.execute(paths, targetNode, null, getViewer(), isZstdCompression());
 	}
 
 }
diff --git a/ZipEditor/src/zipeditor/actions/DialogAction.java b/ZipEditor/src/zipeditor/actions/DialogAction.java
@@ -19,7 +19,10 @@
 import org.eclipse.jface.window.Window;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.custom.SashForm;
+import org.eclipse.swt.events.SelectionAdapter;
+import org.eclipse.swt.events.SelectionEvent;
 import org.eclipse.swt.layout.GridData;
+import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Control;
 import org.eclipse.swt.widgets.Label;
@@ -30,6 +33,8 @@
 
 public abstract class DialogAction extends ViewerAction {
 
+	private boolean zstdCompression = false;
+	
 	private class FileDialog extends Dialog implements ISelectionChangedListener {
 		private FileSystemChooseControl fWorkspaceViewer;
 		private FileSystemChooseControl fFileSystemViewer;
@@ -40,9 +45,11 @@ private class FileDialog extends Dialog implements ISelectionChangedListener {
 		private boolean fMultiSelection;
 		private boolean fShowFiles;
 		private File fInitialSelection;
+		private boolean fAllowZstd;
 
-		private FileDialog(String text) {
+		private FileDialog(String text, boolean allowZstd) {
 			super(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell());
+			fAllowZstd = allowZstd;
 			setShellStyle(getShellStyle() | SWT.SHELL_TRIM);
 			fText = text;
 		}
@@ -68,6 +75,19 @@ protected Control createDialogArea(Composite parent) {
 			fStatusLabel = new Label(control, SWT.LEFT | SWT.WRAP);
 			fStatusLabel.setLayoutData(new GridData(GridData.FILL, SWT.END, true, false));
 			
+			if (fAllowZstd) {
+				Button useZstdCheckbox = new Button(control, SWT.CHECK);
+				useZstdCheckbox.setText("Use Zstd Compression"); //$NON-NLS-1$
+				useZstdCheckbox.setSelection(zstdCompression);
+				useZstdCheckbox.addSelectionListener(new SelectionAdapter() {
+					
+					@Override
+					public void widgetSelected(SelectionEvent e) {
+						zstdCompression = useZstdCheckbox.getSelection();			
+					}
+					
+				});
+			}
 			applyDialogFont(control);
 			return control;
 		}
@@ -168,12 +188,16 @@ protected DialogAction(String text, StructuredViewer viewer, boolean useFilter)
 		super(text, viewer);
 	}
 
-	protected File[] openDialog(String text, File path, boolean multiSelection, boolean showFiles) {
-		FileDialog dialog = new FileDialog(text);
+	protected File[] openDialog(String text, File path, boolean multiSelection, boolean showFiles, boolean allowZstd) {
+		FileDialog dialog = new FileDialog(text, allowZstd);
 		dialog.setMultiSelection(multiSelection);
 		dialog.setShowFiles(showFiles);
 		dialog.setSelection(path);
 		int result = dialog.open();
 		return result == Window.OK ? dialog.getFiles() : null;
 	}
+	
+	public boolean isZstdCompression() {
+		return zstdCompression;
+	}
 }
diff --git a/ZipEditor/src/zipeditor/actions/ExtractAction.java b/ZipEditor/src/zipeditor/actions/ExtractAction.java
@@ -45,7 +45,7 @@ public void run() {
 		Node[] nodes = getSelectedNodes();
 		if (nodes.length == 0)
 			nodes = new Node[] { getViewerInputAsNode() };
-		File[] folder = openDialog(ActionMessages.getString("ExtractAction.2"), fSelectedFolder, false, false); //$NON-NLS-1$
+		File[] folder = openDialog(ActionMessages.getString("ExtractAction.2"), fSelectedFolder, false, false, false); //$NON-NLS-1$
 		if (folder != null && folder.length > 0) {
 			ExtractOperation operation = new ExtractOperation();
 			operation.setRefreshJob(new RefreshJob());
diff --git a/ZipEditor/src/zipeditor/messages.properties b/ZipEditor/src/zipeditor/messages.properties
@@ -67,3 +67,4 @@ TarNodePropertyPage.1=Invalid user id, must be an Integer
 TarNodePropertyPage.2=Invalid mode
 MappingPropertyAccessor.0=Stored
 MappingPropertyAccessor.8=Deflated
+MappingPropertyAccessor.93=Zstd
diff --git a/ZipEditor/src/zipeditor/model/Node.java b/ZipEditor/src/zipeditor/model/Node.java
@@ -14,6 +14,7 @@
 import java.util.Iterator;
 import java.util.List;
 
+import org.apache.commons.compress.archivers.zip.ZipMethod;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.PlatformObject;
 import org.eclipse.ui.model.IWorkbenchAdapter;
@@ -272,8 +273,11 @@ public void add(Node node, Node beforeSibling) {
 		internalAdd(node, children != null && beforeSibling != null ? children.indexOf(beforeSibling) : -1);
 	}
 	
-	public void add(File file, Node beforeSibling, IProgressMonitor monitor) {
+	public void add(File file, Node beforeSibling, IProgressMonitor monitor, boolean useZstdCompression) {
 		Node node = create(model, file.getName(), file.isDirectory());
+		if (useZstdCompression && node instanceof ZipNode) {
+			((ZipNode)node).setMethod(ZipMethod.ZSTD.getCode());
+		}
 		add(node, beforeSibling);
 		node.state |= ADDED;
 		if (node.isFolder()) {
@@ -284,7 +288,7 @@ public void add(File file, Node beforeSibling, IProgressMonitor monitor) {
 					if (monitor.isCanceled())
 						break;
 					monitor.subTask(files[i].getName());
-					node.add(files[i], null, monitor);
+					node.add(files[i], null, monitor, useZstdCompression);
 				}
 			}
 			node.state |= MODIFIED;
diff --git a/ZipEditor/src/zipeditor/model/NodeProperty.java b/ZipEditor/src/zipeditor/model/NodeProperty.java
@@ -14,12 +14,14 @@ public class NodeProperty {
 	public static final int SIZE = 4;
 	public static final int PATH = 9;
 	public static final int PERSISTED = 12;
+	public static final int METHOD = 13;
 	public static final NodeProperty PNAME = new NodeProperty(NAME);
 	public static final NodeProperty PTYPE = new NodeProperty(TYPE);
 	public static final NodeProperty PDATE = new NodeProperty(DATE);
 	public static final NodeProperty PSIZE = new NodeProperty(SIZE);
 	public static final NodeProperty PPATH = new NodeProperty(PATH);
 	public static final NodeProperty PPERSISTED = new NodeProperty(PERSISTED);
+	public static final NodeProperty PMETHOD = new NodeProperty(METHOD);
 	protected int type;
 
 	protected NodeProperty(int type) {
diff --git a/ZipEditor/src/zipeditor/model/ZipModel.java b/ZipEditor/src/zipeditor/model/ZipModel.java
@@ -18,12 +18,12 @@
 import java.util.zip.CRC32;
 import java.util.zip.GZIPInputStream;
 import java.util.zip.GZIPOutputStream;
-import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
 
 import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
 import org.apache.commons.compress.archivers.zip.ZipArchiveInputStream;
 import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
+import org.apache.commons.compress.archivers.zip.ZipMethod;
 import org.apache.tools.bzip2.CBZip2InputStream;
 import org.apache.tools.bzip2.CBZip2OutputStream;
 import org.apache.tools.tar.TarConstants;
@@ -38,6 +38,8 @@
 import org.eclipse.core.runtime.Status;
 import org.eclipse.core.runtime.jobs.Job;
 
+import io.airlift.compress.zstd.ZstdInputStream;
+import io.airlift.compress.zstd.ZstdOutputStream;
 import zipeditor.Messages;
 import zipeditor.Utils;
 import zipeditor.ZipEditorPlugin;
@@ -105,7 +107,14 @@ public static ContentTypeId detectType(InputStream contents) {
 			if (count == -1)
 				return null;
 			try {
-				ZipArchiveInputStream zip = new ZipArchiveInputStream(contents);
+				ZipArchiveInputStream zip = new ZipArchiveInputStream(contents) {
+					
+					@Override
+					protected InputStream createZstdInputStream(InputStream in) throws IOException {
+						return new ZstdInputStream(in);
+					}
+					
+				};
 				if (zip.getNextEntry() != null) {
 					contents.reset();
 					return ContentTypeId.ZIP_FILE;
@@ -434,7 +443,12 @@ private InputStream detectStream(InputStream contents) throws IOException {
 		default:
 			return in;
 		case ContentTypeId.ZIP:
-			return new ZipArchiveInputStream(in);
+			return new ZipArchiveInputStream(in) {
+				@Override
+				protected InputStream createZstdInputStream(InputStream in) throws IOException {
+					return new ZstdInputStream(in);
+				}
+			};
 		case ContentTypeId.TAR:
 			return new TarInputStream(in);
 		case ContentTypeId.GZ:
@@ -512,7 +526,7 @@ private void saveNode(OutputStream out, Node node, ContentTypeId type, IProgress
 				monitor.subTask(entryName);
 				zipEntry.setComment(((ZipNode) node).getComment());
 				zipEntry.setMethod(((ZipNode) node).getMethod());
-				if (zipEntry.getMethod() == ZipEntry.STORED) {
+				if (zipEntry.getMethod() == ZipMethod.STORED.getCode() || zipEntry.getMethod() == ZipMethod.ZSTD.getCode() || zipEntry.getMethod() == ZipMethod.ZSTD_DEPRECATED.getCode()) {
 					handleCrc(node, entryName, zipEntry);
 				}
 			}
@@ -535,12 +549,41 @@ private void saveNode(OutputStream out, Node node, ContentTypeId type, IProgress
 			((ZipArchiveOutputStream) out).putArchiveEntry(zipEntry);
 		else if (out instanceof TarOutputStream)
 			((TarOutputStream) out).putNextEntry(tarEntry);
-		Utils.readAndWrite(node.getContent(), out, false);
+		if (node instanceof ZipNode && ((ZipNode)node).getMethod() == ZipMethod.ZSTD.getCode()) {
+			ZstdOutputStream zstdOutput = new ZstdOutputStream(noClose(out));
+			Utils.readAndWrite(node.getContent(), zstdOutput, false);
+			zstdOutput.flush();
+			zstdOutput.close();
+	    } else {
+			Utils.readAndWrite(node.getContent(), out, false);
+		}
+		if (zipEntry != null) {
+			((ZipArchiveOutputStream)out).closeArchiveEntry();
+		}
 		if (tarEntry != null)
 			((TarOutputStream) out).closeEntry();
 		monitor.worked(1);
 	}
 
+	private OutputStream noClose(OutputStream out) {
+		return new OutputStream() {
+			@Override
+			public void write(byte[] b) throws IOException {
+				out.write(b);
+			}
+			
+			@Override
+			public void write(int b) throws IOException {
+				out.write(b);
+			}
+			
+			@Override
+			public void write(byte[] b, int off, int len) throws IOException {
+				out.write(b, off, len);
+			}
+		};
+	}
+
 	private void handleCrc(Node child, String entryName, ZipArchiveEntry zipEntry) throws IOException {
 		if (child.isModified()) {
 			long time = System.currentTimeMillis();
diff --git a/ZipEditor/src/zipeditor/model/ZipNode.java b/ZipEditor/src/zipeditor/model/ZipNode.java
@@ -5,6 +5,9 @@
 package zipeditor.model;
 
 import org.apache.commons.compress.archivers.zip.ZipFile;
+
+import io.airlift.compress.zstd.ZstdInputStream;
+
 import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
 import java.io.IOException;
 import java.io.InputStream;
@@ -85,7 +88,7 @@ protected InputStream doGetContent() throws IOException {
 		if (in != null)
 			return in;
 		if (zipEntry != null) {
-			return model.getZipPath() != null ? new EntryStream(zipEntry, ZipFile.builder().setFile(model.getZipPath()).get()) : null;
+			return model.getZipPath() != null ? new EntryStream(zipEntry, ZipFile.builder().setZstdInputStreamFactory(ZstdInputStream::new).setFile(model.getZipPath()).get()) : null;
 		}
 		return null;
 	}
diff --git a/ZipEditor/src/zipeditor/operations/AddOperation.java b/ZipEditor/src/zipeditor/operations/AddOperation.java
diff --git a/latest.target b/latest.target
