Hi,
\r\nI'm trying to extract a zip with a single progress bar that displays the overall process (Rather than individual files - my zips contain a single large file)
I've looked through the examples and documentation but cannot find a working example. The Winforms example doesn't seem to work.
I'm just trying to display a single progress bar with the overall extraction progress. (With a label displaying percentage)
\r\nThanks.
\r\n\r\n
", "PostedDate": "2010-06-15T15:26:43.22-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "455856", "ThreadId": "216137", "Html": "
Here's the example I'm working with, the progress bar does not work:
\r\n\r\n
Imports System\r\nImports System.IO\r\nImports Ionic.Zip\r\n\r\nPublic Class Form1\r\n\r\n Private Delegate Sub ZipProgress(ByVal e As ZipProgressEventArgs)\r\n Dim _operationCanceled As Boolean\r\n Dim nFilesCompleted As Integer\r\n Dim totalEntriesToProcess As Integer\r\n Dim _appCuKey As Microsoft.Win32.RegistryKey\r\n Dim _extractThread As System.Threading.Thread\r\n Dim AppRegyPath As String = "Software\\Ionic\\VBunZip"\r\n Dim rvn_ZipFile As String = "zipfile"\r\n Dim rvn_ExtractDir As String = "extractdir"\r\n\r\n Private Sub btnZipBrowse_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnZipBrowse.Click\r\n Dim openFileDialog1 As New OpenFileDialog\r\n If (String.IsNullOrEmpty(tbZipToOpen.Text)) Then\r\n openFileDialog1.InitialDirectory = "c:\\"\r\n Else\r\n openFileDialog1.InitialDirectory = IIf(File.Exists(Me.tbZipToOpen.Text), Path.GetDirectoryName(Me.tbZipToOpen.Text), Me.tbZipToOpen.Text)\r\n End If\r\n openFileDialog1.Filter = "zip files|*.zip|EXE files|*.exe|All Files|*.*"\r\n openFileDialog1.FilterIndex = 1\r\n openFileDialog1.RestoreDirectory = True\r\n If (openFileDialog1.ShowDialog = DialogResult.OK) Then\r\n Me.tbZipToOpen.Text = openFileDialog1.FileName\r\n If File.Exists(Me.tbZipToOpen.Text) Then\r\n Me.btnUnzip_Click(sender, e)\r\n End If\r\n End If\r\n End Sub\r\n\r\n\r\n Private Sub btnUnzip_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnUnzip.Click\r\n If Not String.IsNullOrEmpty(tbZipToOpen.Text) And _\r\n File.Exists(Me.tbZipToOpen.Text) And _\r\n Not String.IsNullOrEmpty(tbExtractDir.Text) And _\r\n Directory.Exists(tbExtractDir.Text) Then\r\n btnCancel.Enabled = True\r\n btnUnzip.Enabled = False\r\n KickoffExtract()\r\n End If\r\n End Sub\r\n\r\n\r\n Private Sub KickoffExtract()\r\n If Not String.IsNullOrEmpty(tbExtractDir.Text) Then\r\n lblStatus.Text = "Extracting..."\r\n Dim args(2) As Object\r\n args(0) = tbZipToOpen.Text\r\n args(1) = tbExtractDir.Text\r\n _extractThread = New System.Threading.Thread(New System.Threading.ParameterizedThreadStart(AddressOf UnzipFile))\r\n _extractThread.Start(args)\r\n Me.Cursor = Cursors.WaitCursor\r\n End If\r\n End Sub\r\n\r\n\r\n\r\n Private Sub btnExtractDirBrowse_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnExtractDirBrowse.Click\r\n Dim dlg As New FolderBrowserDialog\r\n dlg.Description = "Select a folder to zip up:"\r\n dlg.ShowNewFolderButton = False\r\n 'dlg.ShowEditBox = True\r\n dlg.SelectedPath = Me.tbExtractDir.Text\r\n 'dlg.ShowFullPathInEditBox = True\r\n If (dlg.ShowDialog = DialogResult.OK) Then\r\n tbExtractDir.Text = dlg.SelectedPath\r\n End If\r\n End Sub\r\n\r\n\r\n Private Sub UnzipFile(ByVal args As Object())\r\n Dim extractCancelled As Boolean = False\r\n Dim zipToRead As String = args(0)\r\n Dim extractDir As String = args(1)\r\n Try\r\n Using zip As ZipFile = ZipFile.Read(zipToRead)\r\n totalEntriesToProcess = zip.Entries.Count\r\n SetProgressBarMax(zip.Entries.Count)\r\n AddHandler zip.ExtractProgress, New EventHandler(Of ExtractProgressEventArgs)(AddressOf Me.zip_ExtractProgress)\r\n zip.ExtractAll(extractDir, Ionic.Zip.ExtractExistingFileAction.OverwriteSilently)\r\n End Using\r\n Catch ex1 As Exception\r\n MessageBox.Show(String.Format("There's been a problem extracting that zip file. {0}", ex1.Message), "Error Extracting", MessageBoxButtons.OK, MessageBoxIcon.Exclamation, MessageBoxDefaultButton.Button1)\r\n End Try\r\n ResetUI()\r\n End Sub\r\n\r\n Private Sub ResetUI()\r\n If btnCancel.InvokeRequired Then\r\n btnCancel.Invoke(New Action(AddressOf ResetUI), New Object() {})\r\n Else\r\n btnUnzip.Enabled = True\r\n btnCancel.Enabled = False\r\n ProgressBar1.Maximum = 1\r\n ProgressBar1.Value = 0\r\n Me.Cursor = Cursors.Arrow\r\n End If\r\n End Sub\r\n\r\n Private Sub SetProgressBarMax(ByVal n As Integer)\r\n If ProgressBar1.InvokeRequired Then\r\n ProgressBar1.Invoke(New Action(Of Integer)(AddressOf SetProgressBarMax), New Object() {n})\r\n Else\r\n ProgressBar1.Maximum = n\r\n ProgressBar1.Step = 1\r\n End If\r\n End Sub\r\n\r\n Private Sub zip_ExtractProgress(ByVal sender As Object, ByVal e As ExtractProgressEventArgs)\r\n If (e.EventType = Ionic.Zip.ZipProgressEventType.Extracting_AfterExtractEntry) Then\r\n StepEntryProgress(e)\r\n ElseIf (e.EventType = ZipProgressEventType.Extracting_BeforeExtractAll) Then\r\n 'StepArchiveProgress(e)\r\n End If\r\n End Sub\r\n\r\n\r\n Private Sub StepEntryProgress(ByVal e As ZipProgressEventArgs)\r\n If ProgressBar1.InvokeRequired Then\r\n ProgressBar1.Invoke(New ZipProgress(AddressOf StepEntryProgress), New Object() {e})\r\n ElseIf Not _operationCanceled Then\r\n ProgressBar1.PerformStep()\r\n System.Threading.Thread.Sleep(100)\r\n 'set a label with status information\r\n nFilesCompleted = nFilesCompleted + 1\r\n lblStatus.Text = String.Format("{0} of {1} files...({2})", nFilesCompleted, totalEntriesToProcess, e.CurrentEntry.FileName)\r\n Me.Update()\r\n End If\r\n End Sub\r\n\r\n\r\n\r\n 'Private Sub StepArchiveProgress(ByVal e As ZipProgressEventArgs)\r\n ' If ProgressBar1.InvokeRequired Then\r\n ' ProgressBar1.Invoke(New ZipProgress(AddressOf StepArchiveProgress), New Object() {e})\r\n ' ElseIf Not _operationCanceled Then\r\n ' _nFilesCompleted = _nFilesCompleted + 1\r\n ' ProgressBar1.PerformStep()\r\n ' progressBar2.Value = progressBar2.Maximum = 1\r\n ' MyBase.Update()\r\n ' End If\r\n 'End Sub\r\n\r\n Private Sub btnCancel_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnCancel.Click\r\n _operationCanceled = True\r\n ProgressBar1.Maximum = 1\r\n ProgressBar1.Value = 0\r\n End Sub\r\n\r\n\r\n Private Sub SaveFormToRegistry()\r\n If AppCuKey IsNot Nothing Then\r\n If Not String.IsNullOrEmpty(tbZipToOpen.Text) Then\r\n AppCuKey.SetValue(rvn_ZipFile, Me.tbZipToOpen.Text)\r\n End If\r\n If Not String.IsNullOrEmpty(tbExtractDir.Text) Then\r\n AppCuKey.SetValue(rvn_ExtractDir, tbExtractDir.Text)\r\n End If\r\n End If\r\n End Sub\r\n\r\n Private Sub LoadFormFromRegistry()\r\n If AppCuKey IsNot Nothing Then\r\n Dim s As String\r\n s = AppCuKey.GetValue(rvn_ZipFile)\r\n If Not String.IsNullOrEmpty(s) Then\r\n Me.tbZipToOpen.Text = s\r\n End If\r\n s = AppCuKey.GetValue(rvn_ExtractDir)\r\n If Not String.IsNullOrEmpty(s) Then\r\n tbExtractDir.Text = s\r\n End If\r\n End If\r\n End Sub\r\n\r\n\r\n Public ReadOnly Property AppCuKey() As Microsoft.Win32.RegistryKey\r\n Get\r\n If (_appCuKey Is Nothing) Then\r\n Me._appCuKey = Microsoft.Win32.Registry.CurrentUser.OpenSubKey(AppRegyPath, True)\r\n If (Me._appCuKey Is Nothing) Then\r\n Me._appCuKey = Microsoft.Win32.Registry.CurrentUser.CreateSubKey(AppRegyPath)\r\n End If\r\n End If\r\n Return _appCuKey\r\n End Get\r\n End Property\r\n\r\n Private Sub Form1_FormClosing(ByVal sender As System.Object, ByVal e As System.Windows.Forms.FormClosingEventArgs) Handles MyBase.FormClosing\r\n SaveFormToRegistry()\r\n End Sub\r\n\r\n Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load\r\n LoadFormFromRegistry()\r\n End Sub\r\nEnd Class\r\n\r\n\r\n\r\n
I'd suggest putting a breakpoint in the ExtractProgress event, to verify that it is actually being called.
\r\nIf it IS being called, then you'll need to debug why the code is not working as you expect.
\r\n\r\n
", "PostedDate": "2010-06-15T17:14:38.21-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "456098", "ThreadId": "216137", "Html": "
Hi Cheeso, I've simplified an example to try and get this progress working. What value should I use to set the progress bars maximum value?
\r\nImports Ionic.Zip\r\n\r\nPublic Class Form1\r\n\r\n Dim zipfileName As String = "C:\\Test\\test.zip"\r\n Dim extractDirectory As String = "C:\\Test\\"\r\n\r\n Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load\r\n End Sub\r\n\r\n Private Sub Unzip()\r\n Dim args(2) As String\r\n args(0) = Me.zipfileName\r\n args(1) = Me.extractDirectory\r\n Dim worker As System.Threading.Thread\r\n worker = New System.Threading.Thread(New System.Threading.ParameterizedThreadStart(AddressOf UnzipFile))\r\n worker.Start(args)\r\n End Sub\r\n\r\n Private Sub UnzipFile(ByVal args As String())\r\n Try\r\n Using zip As ZipFile = ZipFile.Read(args(0))\r\n Me.ProgressBar1.Maximum = ????\r\n Dim entry As ZipEntry\r\n For Each entry In zip\r\n UpdateUi(entry.FileName)\r\n entry.Extract(args(1), ExtractExistingFileAction.OverwriteSilently)\r\n '' Sleep a little because it's really fast\r\n System.Threading.Thread.Sleep(20)\r\n Next\r\n UpdateUi(String.Format("Finished unzipping {0} entries", zip.Entries.Count))\r\n End Using\r\n Catch ex1 As Exception\r\n Me.label1.Text = ("Exception: " & ex1.ToString)\r\n End Try\r\n End Sub\r\n\r\n Private Sub UpdateUi(ByVal filename As String)\r\n If Me.InvokeRequired Then\r\n '' invoke on the proper thread \r\n Me.Invoke(New Action(Of String)(AddressOf UpdateUi), New Object() {filename})\r\n Else\r\n Me.label1.Text = filename\r\n Me.ProgressBar1.PerformStep()\r\n MyBase.Update()\r\n End If\r\n End Sub\r\n\r\n\r\n\r\n Private Sub BtnUnzip_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles BtnUnzip.Click\r\n Unzip()\r\n End Sub\r\nEnd Class\r\n\r\n\r\n
It looks like the WinForms-Unzip is broken? (From the Dev kit example)
Theres one progress bar which indicates the progress through the number of files in the zip in steps.
Theres some commented out code that appears to be for the actual progress through each file, I've uncommented this, added a second progress bar to get an understanding of what I want.
Do you have any examples of progress for the whole extraction event rather than stepped individual file extraction? (Similar to what the second progress bar is meant to do but for the whole extraction)
\r\nThanks.
", "PostedDate": "2010-06-16T05:17:41.443-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "456259", "ThreadId": "216137", "Html": "> It looks like the WinForms-Unzip is broken? (From the Dev kit example)
In what way is it broken? Does it simply not work? Does it not compile? If you provide a clear description I'll file a workitem, then investigate it and fix as appropriate.
> Do you have any examples of progress for the whole extraction event rather than stepped individual file extraction? (Similar to what the second progress bar is meant to do but for the whole extraction)
\r\nHmm, by "the whole extraction event", I guess you want the progress through the aggregate size of the extracted files, is that right? Here's the thing - there's no general way for the library to know how many entries you are extracting, and therefore there's no way for the library to know the aggregate size of the intended extracted entries. In the specific case of an ExtractAll(), theoretically the library would be able to calculate the aggregate extracted size, before extraction occurred. It could then present, in the extraction progress event, the "total size" and the "size extracted so far", via properties in the custom EventArgs. Theoretically the library could do this, but I don't believe it does so, today. I'm not able to look at the code, so I can't recall if that is true.
\r\nIn any case that would work only for the ExtractAll() case. If an application extracts anything other than "every entry" , then the library cannot know how many entries will be extracted, nor the aggregate size of those extracted entries.
\r\nBut, th application could pretty simply drive the kind of progress bar you want. To do it, compute the total expected size of the entries to be extracted (by summing ZipEntry.UncompressedSize across all those entries), before beginning the extraction. Then keep a running total of the "extracted so far" size within the ExtractProgress event, and update your progress bar appropriately.
\r\n\r\n
I see, that solution could work.
For me it's unlikely a zip would contain more than one file (Will contain a single zipped up sql .bak backup)
So I could get away with just:
\r\nMe.ProgressBar1.Value = 100 * e.BytesTransferred / e.TotalBytesToTransfer
\r\nAlthough I would be interested in implementing a solution that can handle multiple files.
I think I've managed to get the sum of ZipEntry.UncompressedSize, how do I pass this to the event handler?:
\r\n\r\n\r\nImports Ionic.Zip\r\nImports System.Threading\r\nImports System.ComponentModel\r\n\r\nPublic Class Form1\r\n Dim TotalSize As Long ' Bits\r\n Dim ZipUncompressedSize As Long\r\n Dim ZipUncompressedSize2 As Long\r\n Private _zipBGWorker As System.ComponentModel.BackgroundWorker\r\n Private Delegate Sub ZipProgress(ByVal e As ExtractProgressEventArgs)\r\n Private Delegate Sub ExtractEntryProgress(ByVal e As ExtractProgressEventArgs)\r\n Private Sub BtnUnzip_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles BtnUnzip.Click\r\n MyExtract()\r\n End Sub\r\n\r\n Private Sub MyExtract()\r\n Dim args(2) As String\r\n args(0) = "C:\\Test\\Test2.zip"\r\n args(1) = "C:\\Test\\ZipTestExtract\\"\r\n _zipBGWorker = New System.ComponentModel.BackgroundWorker()\r\n _zipBGWorker.WorkerSupportsCancellation = False\r\n _zipBGWorker.WorkerReportsProgress = False\r\n AddHandler Me._zipBGWorker.DoWork, New DoWorkEventHandler(AddressOf Me.UnzipFile)\r\n _zipBGWorker.RunWorkerAsync(args)\r\n\r\n End Sub\r\n\r\n Private Sub UnzipFile(ByVal sender As Object, ByVal e As DoWorkEventArgs)\r\n Dim extractCancelled As Boolean = False\r\n Dim args() As String = e.Argument\r\n Dim ZipToUnpack As String = args(0)\r\n Dim extractDir As String = args(1)\r\n \r\n Using zip As ZipFile = ZipFile.Read(ZipToUnpack)\r\n AddHandler zip.ExtractProgress, New EventHandler(Of ExtractProgressEventArgs)(AddressOf Me.zip_ExtractProgress)\r\n For Each backup In zip\r\n TotalSize = backup.UncompressedSize + TotalSize\r\n Next\r\n For Each backup In zip\r\n backup.Extract(extractDir, Ionic.Zip.ExtractExistingFileAction.OverwriteSilently)\r\n Next\r\n End Using\r\n End Sub\r\n\r\n Private Sub zip_ExtractProgress(ByVal sender As Object, ByVal e As ExtractProgressEventArgs)\r\n\r\n If (e.EventType = ZipProgressEventType.Extracting_AfterExtractEntry) Then\r\n ZipUncompressedSize2 = ZipUncompressedSize + ZipUncompressedSize2\r\n ElseIf (e.EventType = ZipProgressEventType.Extracting_EntryBytesWritten) Then\r\n StepEntryProgress(e)\r\n\r\n ZipUncompressedSize = e.BytesTransferred + ZipUncompressedSize2\r\n\r\n End If\r\n End Sub\r\n\r\n Private Sub StepEntryProgress(ByVal e As ExtractProgressEventArgs)\r\n\r\n\r\n If Me.ProgressBar1.InvokeRequired Then\r\n Me.ProgressBar1.Invoke(New ExtractEntryProgress(AddressOf Me.StepEntryProgress), New Object() {e})\r\n Else\r\n\r\n Me.ProgressBar1.Maximum = 100\r\n Me.ProgressBar1.Value = 100 * ZipUncompressedSize / TotalSize\r\n Me.LblStatus.Text = CStr(100 * (ZipUncompressedSize / TotalSize).ToString("#,##0.00")) & "% Complete"\r\n\r\n End If\r\n End Sub\r\n\r\n\r\n \r\nEnd Class\r\n\r\n\r\n\r\n\r\n
\r\n
Thank you for your help.\r\n
if you are concerned about extracting a single entry, then you don't need any of what I described. the EventArgs contains a reference to the ZipEntry, from which you can get UncompressedSize.
\r\nIn the general case, the easiest way to "pass" the aggregate uncompressed size to the event handler would be to use an instance variable on your Form or Window to store that quantity.
\r\n", "PostedDate": "2010-06-16T13:47:03.267-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "456381", "ThreadId": "216137", "Html": "
Hi Cheeso,
\r\nFor the moment that's fine but I can see this ability being useful in the future.
I've noticed the total bytes from BytesTransferred is slightly wrong,
Windows & ZipEntry.UncompressedSize give 305150464 (Total of 3 files in zip)
BytesTransfeered gives 361510400.
I've updated the above code with what I'm currently using to get these figures.
\r\nThanks.
\r\n\r\n
\r\n
", "PostedDate": "2010-06-16T14:39:04.78-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "456385", "ThreadId": "216137", "Html": "
if you have a smaller archive that exhibits the discrepancy, I'd like to have a look at it.
\r\n", "PostedDate": "2010-06-16T14:57:03.003-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "456386", "ThreadId": "216137", "Html": "Sure, I will create an example now.", "PostedDate": "2010-06-16T14:58:56.1-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "456411", "ThreadId": "216137", "Html": "
I've tried with several zips containing different file types but cannot reproduce this...
\r\n
I'm having problems keeping a runnig total of BytesTransferred:
http://www.daniweb.com/forums/thread290601.html
Values after extracting 3 files:
TotalSize = (UncompressedSize - Global) 305150464 (Which is correct for the total size of all files)
TransferTotal (Global Long) = 2447309139968 (I expected it to total TotalSize?)
Values after extracting first file:
BytesToTransfer = 56378880 for the first file (Which is correct)
TransferTotal (Global) = 97109969920 in relation to the above value... Not sure how it's getting this figure... Should be the same?
I have "TranferTotal = e.BytesTransferred + TranferTotal" on event "ZipProgressEventType.Extracting_EntryBytesWritten"
To increment TransferTotal between extracted files.
Thanks.
", "PostedDate": "2010-06-16T16:56:47.323-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "456693", "ThreadId": "216137", "Html": "Right, it sounds like you're having some problems with the logic in your code.
\r\nExtractProgressEventArgs.BytesTransferred is the running total of bytes transferred for the current entry being extracted. Suppose you have an entry that is 10,000 bytes. On successive invocations of the ExtractProgress event, e.BytesTransferrred might progress through 1000, 2000, 3000, and so on, up to 10,0000.
\r\nYou are accumulating this quantity, which is not appropriate. It is already an accumulated value.
Therefore you'll need to use different arithmetic to accomplish what you want.
Ahh, I see.
\r\nI've added "TransferTotal = TransferTotal + backup.UncompressedSize" to the extaction loop which works great.
Is there an extraction completion event I can use to update labels etc? For extracting I only see AfterExtractAll?
Thanks.
", "PostedDate": "2010-06-17T08:09:22.933-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "456825", "ThreadId": "216137", "Html": "Ah - when your app extracts entries in a loop, there's no way for the library to know when your app is done extracting. So... the way to update the labels when the extraction is done is to do so upon exit from your application's loop.
\r\nExtractAll is a special case - obviously at the end of that method it's possible to invoke an event, and AfterExtractAll is that event.
\r\nI think it would be worthwhile to provide a similar event after ExtractSelectedItems() but... today I don't believe that there is such an event available.
\r\n", "PostedDate": "2010-06-17T09:46:37.843-07:00", "UserRole": null, "MarkedAsAnswerDate": null } ]