Proposal: Opening/Closing Mechanism for Zip Files #1947

Michael5601 · 2024-06-10T10:27:22Z

Proposal: Opening/Closing Mechanism for Zip Files

Background

The Eclipse IDE has no built in functionality to open Zip Files and read or manipulate their content. Because of this, other operations like searching inside of Zip Files or comparing two Zip Files were also not possible.

Description

This PR introduces UI support for accesing the opening/closing mechanism for Zip Files over the UI-menu. It is accessed by right-clicking the Zip File that should be opened and then clicking on "Open Zip File". Closing is accessed the same way but when right-clicking an opened Zip File.

Please see Plaform PR for the PR on the repository eclipse.platform for the platform implementation and further information.

Co-Authored-By: CodeLtDave [email protected]

The Eclipse IDE has no built in functionality to open Zip Files and read or manipulate their content. Because of this, other operations like searching inside of Zip Files or comparing two Zip Files were also not possible. This pull request introduces a mechanism for handling Zip Files within the Eclipse workspace, enhancing the functionality to read and write Zip files. The primary goal is to provide a seamless experience for developers working with zip archives directly within Eclipse. Zip files must be opened manually within the workspace by using the new command "Open Zip File" in the menu when right clicking the zip file. It is also possible to open nested zip files. Zip Files are opened by replacing the file in the workspace with a linked folder that reads and writes the Zip File in the file system. By closing the Zip FIle, the linked folder will be deleted and the file can be seen in the workspace again. Please note that only ZIP Archives are supported in this current implementation. Other archive types can be added in future improvements. Also linked Zip Files can not be opened with this implementation because the Zip File must be local. An additional PR for the repository **eclipse.platform.ui** that grants access to the open/close mechanism for zip files over UI can be found in the following: eclipse-platform/eclipse.platform.ui#1947 Co-Authored-By: David <David.Erdoes @vector.com>

iloveeclipse

Co-Authored-By: CodeLtDave [email protected]

Here and on other PR: ALL contributors must sign ECA.

If [email protected] has not signed ECA, we can't merge this PR.

jukzi · 2024-06-10T14:27:53Z

bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/fileSystem/zip/CloseZipFileHandler.java

+		try {
+			ZipFileTransformer.closeZipFile((IFolder) element);
+		} catch (Exception e) {
+			MessageDialog.openError(shell, "Error", "Error opening zip file"); //$NON-NLS-1$ //$NON-NLS-2$


log this error instead of error dialog/std.err

thanks for the input. I commited the changed under 297459a. But I wonder if the user should get a response that closing the zip file did not work. This was the reason behind the MessageDialog even though the message is wrong and should be "Error closing zip file".

bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/fileSystem/zip/OpenZipFileHandler.java

jukzi · 2024-06-10T14:31:13Z

bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/fileSystem/zip/ZipFileSystemContributor.java

@@ -0,0 +1,84 @@
+/*******************************************************************************
+ * Copyright (c) 2022 IBM Corporation and others.


2024 Vector?

This method is copied unchanged from the example project. We thought this would be the best place for it but did not change it, thus the Copyright is still the old one.

bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/fileSystem/zip/ZipFileSystemContributor.java

jukzi · 2024-06-10T14:34:44Z

bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/fileSystem/zip/ZipFileSystemContributor.java

+	}
+
+	@Override
+	public URI getURI(String pathString) {


this method feels confusing complicated. please give an example in java comment what the resulting URI will look like.

jukzi · 2024-06-10T14:36:04Z

Please post some screenshots about the workflow.

Michael5601 · 2024-06-11T12:07:58Z

I want to clarify the workflow with the following screenshots:

At first the Zip File is closed and it is not possible to view/modify or search its contents.

By right-clicking and selection "Open Zip File" the Zip File can be opened.

Opening the Zip File allows using it like a normal folder with all operations supported.

Opening a resource inside of the zip opens the editor for the resource.

Opened Zip Files can be closed by right-clicking and selecting "Close Zip File".

After closing the zip file we have the same state as in the beginning.

For other archive types than "zip" the button will not show in the menu when right-clicking the archive.
I hope these screenshots could help to understand the workflow.

jukzi · 2024-06-11T12:18:45Z

I hope these screenshots could help to understand the workflow.

Makes sense. I would have expected open/close to be more at the top, as the normal "Open" action is:

The Eclipse IDE has no built in functionality to open Zip Files and read or manipulate their content. Because of this, other operations like searching inside of Zip Files or comparing two Zip Files were also not possible. This pull request introduces a mechanism for handling Zip Files within the Eclipse workspace, enhancing the functionality to read and write Zip files. The primary goal is to provide a seamless experience for developers working with zip archives directly within Eclipse. Zip files must be opened manually within the workspace by using the new command "Open Zip File" in the menu when right clicking the zip file. It is also possible to open nested zip files. Zip Files are opened by replacing the file in the workspace with a linked folder that reads and writes the Zip File in the file system. By closing the Zip FIle, the linked folder will be deleted and the file can be seen in the workspace again. Please note that only ZIP Archives are supported in this current implementation. Other archive types can be added in future improvements. Also linked Zip Files can not be opened with this implementation because the Zip File must be local. An additional PR for the repository **eclipse.platform.ui** that grants access to the open/close mechanism for zip files over UI can be found in the following: eclipse-platform/eclipse.platform.ui#1947 Co-Authored-By: David Erdös <[email protected]>

jukzi · 2024-06-14T09:56:49Z

Just another idea: explicit open/closing zipfiles could be avoided by adding a node "Archives" like JDT already does for "Referenced Libraries" which makes it possible to explore the zip files contents too.

github-actions · 2024-06-17T12:02:20Z

Test Results

0 files - 1 815 0 suites - 1 815 0s ⏱️ - 1h 31m 7s
0 tests - 7 636 0 ✅ - 7 408 0 💤 - 228 0 ❌ ±0
0 runs - 24 069 0 ✅ - 23 320 0 💤 - 749 0 ❌ ±0

Results for commit 91f9a51. ± Comparison against base commit 385b30b.

The Eclipse IDE has no built in functionality to open Zip Files and read or manipulate their content. Because of this, other operations like searching inside of Zip Files or comparing two Zip Files were also not possible. This pull request introduces a mechanism for handling Zip Files within the Eclipse workspace, enhancing the functionality to read and write Zip files. The primary goal is to provide a seamless experience for developers working with zip archives directly within Eclipse. Zip files must be opened manually within the workspace by using the new command "Open Zip File" in the menu when right clicking the zip file. It is also possible to open nested zip files. Zip Files are opened by replacing the file in the workspace with a linked folder that reads and writes the Zip File in the file system. By closing the Zip FIle, the linked folder will be deleted and the file can be seen in the workspace again. Please note that only ZIP Archives are supported in this current implementation. Other archive types can be added in future improvements. Also linked Zip Files can not be opened with this implementation because the Zip File must be local. An additional PR for the repository **eclipse.platform.ui** that grants access to the open/close mechanism for zip files over UI can be found in the following: eclipse-platform/eclipse.platform.ui#1947 Co-Authored-By: David Erdös <[email protected]>

The Eclipse IDE has no built in functionality to open Zip Files and read or manipulate their content. Because of this, other operations like searching inside of Zip Files or comparing two Zip Files were also not possible. This pull request introduces a mechanism for handling Zip Files within the Eclipse workspace, enhancing the functionality to read and write Zip files. The primary goal is to provide a seamless experience for developers working with zip archives directly within Eclipse. Zip files must be opened manually within the workspace by using the new command "Open Zip File" in the menu when right clicking the zip file. It is also possible to open nested zip files. Zip Files are opened by replacing the file in the workspace with a linked folder that reads and writes the Zip File in the file system. By closing the Zip FIle, the linked folder will be deleted and the file can be seen in the workspace again. Please note that only ZIP Archives are supported in this current implementation. Other archive types can be added in future improvements. Also linked Zip Files can not be opened with this implementation because the Zip File must be local. An additional PR for the repository **eclipse.platform.ui** that grants access to the open/close mechanism for zip files over UI can be found in the following: eclipse-platform/eclipse.platform.ui#1947 Co-Authored-By: David Erdös <[email protected]> fix rebase

Proposal: Opening/Closing Mechanism for Zip Files The Eclipse IDE has no built in functionality to open Zip Files and read or manipulate their content. Because of this, other operations like searching inside of Zip Files or comparing two Zip Files were also not possible. This PR introduces UI support for accesing the opening/closing mechanism for Zip Files over the UI-menu. It is accessed by right-clicking the Zip File that should be opened and then clicking on "Open Zip File". Closing is accessed the same way but when right-clicking an opened Zip File. Please see eclipse-platform#1408 for the PR on the repository **eclipse.platform** for the platform implementation and further information. Co-Authored-By: David Erdös <[email protected]>

This change removes the ProgressDialog in the OpenZipHandler because the operation is so fast that it is not needed. Errors are logged instead of being printed.

Please mind that the "Open Zip File" and "Close Zip File" Buttons are still implemented in the menu

This reverts commit 4a87a0c.

This commit introduces as special case check when performing the Show In System Explorer Operation on files inside of a zip file. An investigation of better solutions will follow.

Deleting an opened zip file also deletes the resource in the local file system. An opened zip file is represented as a linked folder which shows a specific Messagedialog when being deleted indicating that only the link will be deleted. In this case the delete operation of zip files also deletes the resource in the local file system. Please mind that one dialog exists in JDT which should also be adjusted similarily.

This implementation is not yet finished as a proper editor handling needs to be added.

This reverts commit 6a3216e.

Michael5601 mentioned this pull request Jun 10, 2024

Proposal: Opening/Closing Mechanism for Zip Files eclipse-platform/eclipse.platform#1413

Draft

Michael5601 force-pushed the ZipFileImplementation branch from c1b2bc8 to 1c2c68f Compare June 10, 2024 13:14

Michael5601 force-pushed the ZipFileImplementation branch from 1c2c68f to 1ede745 Compare June 10, 2024 13:23

iloveeclipse requested changes Jun 10, 2024

View reviewed changes