Hi everyone,
\r\nI'm trying to find a C# example of Unzipping a file with progress. I'm not sure which of the ExtractExistingFileAction (Overwrite Silently, or InvokeExtractProgressEvent) I should be using.
I've seen several posts where other developers are using the Library with VB.NET however it's really confusing trying to convert the code to what I would need in C#. Could someone point me in the right direction please?
Thanks,
Jim
Hey Jim,
\r\nThat's one example I apparently haven't written. There is an "unzip with progressbar" written in VB. There is a "create zip with progressbar" written in C#. But I don't think there is a simple "unzip with progressbar" in C#. I should\r\n write one. I'll put it on my list of things to do.
\r\nTo answer your questions, ExtractExistingFileAction is a property that specifies what DotNetZip will do when you extract a file that already exists in the filesystem. This isn't appropriate for use when driving a progress bar. It's really something\r\n for exceptional cases, and it allows your application to handle that exceptional case, flexibly.
\r\nWhat you want is to set the \r\nExtractProgress event. There are examples in the documentation showing how to use the ExtractProgress event from within C#, and a CONSOLE app. This is obviously not what you asked for, but it gets you pretty close to what you want.
\r\nYou could use the same approach as in the console examples, but rather than writing to the console during the progress event, simply update the Value of your progressbar. That will work but is simplistic. Here's why: normally in a Winforms app,\r\n you want to keep the user interface active, even as you are performing IO, like extracting a compressed zip file. Some zip files are really big and extracting can take a minute, ten minutes, an hour. In these cases, you want your application to\r\n remain responsive to button clicks, so the user could, for example, cancel the operation if he gets tired of waiting.
\r\nDoing DotNetZip in WinForms programming, and one is tempted to put the zipfile extraction logic in the Button_Click event. But if you do this, the UI will freeze for the entire len gth of time it takes to extract the zip file. Bad manners. \r\n So what you need to do is use a BackgroundWorker, to perform the possibly lengthy job of extracting the zipfile. In the Button_Click event, kickoff the BackgroundWorker (if it is not already running, of course!). In the BG worker code, is where\r\n you should do the extraction of the zipfile.
\r\nWhy am I telling you all this? Well, if you use an ExtractProgress event in your extraction code that runs on the context of the background worker, you must not try to update the UI (like a progress bar) from that background thread. Huh? In\r\n Winforms, only one thread is permitted to update the UI, and when you use a BG worker, that worker logic does not run on the UI thread. (This is sort of the point, after all. We want the UI to remain responsive, so we avoid doing IO work on the\r\n UI thread). So what you need to do is call the background worker's ReportProgress method, inside the ExtractProgress event. Get it? And update the progressbar in the ReportProgress method. That insures that the progress bar\r\n gets updated only on the UI thread, as required.
\r\nSee this article for a writeup of how to do this: \r\nhttp://p3net.mvps.org/Topics/WinForms/BackgroundWorker.aspx This article doesn't use DotNetZip, but it covers progress bars in a winforms app, and a background worker.
\r\nIn the meantime I'll work on adding a functional example to DotNetZip that does just what you want.
\r\n\r\n", "PostedDate": "2010-10-24T06:26:10.457-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "512688", "ThreadId": "231663", "Html": "\r\n
Thanks for the quick reply Cheeso! :) I thought I had something working just before I got your reply but now I think I've gotten off on a tangent and between what I thought I had working and the code from that discussion on the background\r\n worker, I'm throughly confused now.
\r\nHere is the code I'm currently working with which I am sure I don't need everything in it:
\r\n
private BackgroundWorker _zipBGWorker;
\r\nprivate delegate void ZipProgressEventHandler(ExtractProgressEventArgs e);
\r\nprivate delegate void ExtractEntryProgressEventHandler(ExtractProgressEventArgs e);
private void DoExtract(string ZipToExtract)
\r\n{
\r\n object[] args = new object[3];
\r\n args[0] = ZipToExtract;
\r\n args[1] = ExtractPath;
\r\n _zipBGWorker = new BackgroundWorker();
\r\n _zipBGWorker.WorkerSupportsCancellation = false;
\r\n _zipBGWorker.WorkerReportsProgress = true;
\r\n _zipBGWorker.DoWork += new DoWorkEventHandler(_zipBGWorker_DoWork);
\r\n _zipBGWorker.RunWorkerCompleted += new RunWorkerCompletedEventHandler(_zipBGWorker_RunWorkerCompleted);
\r\n _zipBGWorker.ProgressChanged += new ProgressChangedEventHandler(_zipBGWorker_ProgressChanged);
\r\n _zipBGWorker.RunWorkerAsync(args);
\r\n this.Cursor = Cursors.WaitCursor;
\r\n}
void _zipBGWorker_ProgressChanged(object sender, ProgressChangedEventArgs e)
\r\n{
\r\n progressBar1.Value = e.ProgressPercentage;
\r\n}
void _zipBGWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
\r\n{
\r\n this.Close();
\r\n}
private void _zipBGWorker_DoWork(object sender, DoWorkEventArgs e)
\r\n{
\r\n //bool extractCancelled = false;
object[] args = (object[])e.Argument;
\r\n var list = args.Cast<string>().ToList();
\r\n string ZipToUnpack = list[0];
\r\n string extractDir = list[1];
try
\r\n {
\r\n using (ZipFile zip = ZipFile.Read(ZipToUnpack))
\r\n {
\r\n SetProgressBarMax(zip.Entries.Count);
\r\n zip.ExtractProgress += new EventHandler<ExtractProgressEventArgs>(zip_ExtractProgress);
\r\n zip.ExtractAll(extractDir, ExtractExistingFileAction.OverwriteSilently);
\r\n }
\r\n }
\r\n catch (Exception ex)
\r\n {
\r\n MessageBox.Show(string.Format("There's been a problem extracting that zip file. {0}", ex.Message),\r\n
\r\n "Error Extracting", MessageBoxButtons.OK, MessageBoxIcon.Exclamation, MessageBoxDefaultButton.Button1);
\r\n }
\r\n}
void zip_ExtractProgress(object sender, ExtractProgressEventArgs e)
\r\n{
\r\n progressBar1.Value = Convert.ToInt32(100 * e.BytesTransferred / e.TotalBytesToTransfer);
\r\n}
private void SetProgressBarMax(int n)
\r\n{
\r\n if (progressBar1.InvokeRequired)
\r\n {
\r\n progressBar1.Invoke(new Action<int>(SetProgressBarMax), new object[] { n });
\r\n }
\r\n else
\r\n {
\r\n progressBar1.Maximum = n;
\r\n progressBar1.Step = 1;
\r\n }
\r\n}
private void StepEntryProgress(ExtractProgressEventArgs e)
\r\n{
if (progressBar1.InvokeRequired)
\r\n {
\r\n progressBar1.Invoke(new ExtractEntryProgressEventHandler(this.StepEntryProgress), new object[] { e });
\r\n }
\r\n else
\r\n {
\r\n progressBar1.Value = Convert.ToInt32(100 * e.BytesTransferred / e.TotalBytesToTransfer);
\r\n }
\r\n}
I finally got something working but I feel like I'm missing something or I'm doing more than I need to. Any thoughts? :)\r\n\r\n
using System;\r\nusing System.Collections;\r\nusing System.Collections.Generic;\r\nusing System.ComponentModel;\r\nusing System.Data;\r\nusing System.Linq;\r\nusing System.Text;\r\nusing System.Windows.Forms;\r\nusing Ionic.Zip;\r\nusing System.Threading;\r\nusing Microsoft.Win32;\r\nusing System.IO;\r\nusing test.saic.library;\r\nusing CTSDBExtractionApp.StringExtentions;\r\n\r\n\r\nnamespace CTSDB\r\n{\r\n public partial class FormProgress : Form\r\n {\r\n\r\n private BackgroundWorker _zipBGWorker;\r\n private delegate void ZipProgressEventHandler(ExtractProgressEventArgs e);\r\n private delegate void ExtractEntryProgressEventHandler(ExtractProgressEventArgs e);\r\n\r\n public string ExtractPath { get; set; }\r\n\r\n // Disable User Closing Form\r\n private bool AllowClose = false;\r\n\r\n public FormProgress()\r\n {\r\n InitializeComponent();\r\n SetTitle();\r\n }\r\n\r\n private void SetTitle()\r\n {\r\n this.Text = "CTS Database Decompression";\r\n }\r\n\r\n private void GetMSSQLPath()\r\n {\r\n string sKey = "Software\\\\Microsoft\\\\Microsoft SQL Server\\\\CTSDB\\\\Setup";\r\n RegistryKey rk = Registry.LocalMachine;\r\n\r\n try\r\n {\r\n RegistryKey sk1 = rk.OpenSubKey(sKey);\r\n\r\n string sVal = (string)sk1.GetValue("SQLPath");\r\n if (sVal == null)\r\n {\r\n MessageBox.Show("Registry value " + sKey + " not set.",\r\n "CTS Database Extraction", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);\r\n }\r\n\r\n int iVal;\r\n bool bConverted = Int32.TryParse(sVal.Right(1), out iVal);\r\n if (bConverted && iVal == 0)\r\n {\r\n ExtractPath = sVal.Left(sVal.Length - 1) + "\\\\Data";\r\n }\r\n else\r\n {\r\n ExtractPath = sVal + "\\\\Data";\r\n }\r\n\r\n }\r\n catch (Exception e)\r\n {\r\n MessageBox.Show("Unable to open key " + sKey + ": " + e.Message,\r\n "CTS Database Extraction", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);\r\n }\r\n }\r\n\r\n private void Form1_Load(object sender, EventArgs e)\r\n {\r\n GetMSSQLPath();\r\n DoExtract("Cdrsqlbs.zip");\r\n }\r\n\r\n private void DoExtract(string ZipToExtract)\r\n {\r\n object[] args = new object[3];\r\n args[0] = ZipToExtract;\r\n args[1] = ExtractPath;\r\n _zipBGWorker = new BackgroundWorker();\r\n _zipBGWorker.WorkerSupportsCancellation = true;\r\n _zipBGWorker.WorkerReportsProgress = false;\r\n _zipBGWorker.DoWork += new DoWorkEventHandler(_zipBGWorker_DoWork);\r\n _zipBGWorker.RunWorkerCompleted += new RunWorkerCompletedEventHandler(_zipBGWorker_RunWorkerCompleted);\r\n _zipBGWorker.RunWorkerAsync(args);\r\n this.Cursor = Cursors.WaitCursor;\r\n }\r\n\r\n void _zipBGWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)\r\n {\r\n this.Close();\r\n }\r\n\r\n private void _zipBGWorker_DoWork(object sender, DoWorkEventArgs e)\r\n {\r\n object[] args = (object[])e.Argument;\r\n var list = args.Cast<string>().ToList();\r\n string ZipToUnpack = list[0];\r\n string extractDir = list[1];\r\n\r\n try\r\n {\r\n using (ZipFile zip = ZipFile.Read(ZipToUnpack))\r\n {\r\n SetProgressBarMax(zip.Entries.Count);\r\n zip.ExtractProgress += new EventHandler<ExtractProgressEventArgs>(zip_ExtractProgress);\r\n zip.ExtractAll(extractDir, ExtractExistingFileAction.OverwriteSilently);\r\n }\r\n }\r\n catch (Exception ex)\r\n {\r\n MessageBox.Show(string.Format("There's been a problem extracting that zip file. {0}", ex.Message), \r\n "Error Extracting", MessageBoxButtons.OK, MessageBoxIcon.Exclamation, MessageBoxDefaultButton.Button1);\r\n }\r\n }\r\n\r\n void zip_ExtractProgress(object sender, ExtractProgressEventArgs e)\r\n {\r\n if (e.EventType == ZipProgressEventType.Extracting_EntryBytesWritten)\r\n {\r\n StepEntryProgress(e);\r\n }\r\n }\r\n\r\n private void SetProgressBarMax(int n)\r\n {\r\n if (progressBar1.InvokeRequired)\r\n {\r\n progressBar1.Invoke(new Action<int>(SetProgressBarMax), new object[] { n });\r\n }\r\n else\r\n {\r\n progressBar1.Maximum = n;\r\n progressBar1.Step = 1;\r\n }\r\n }\r\n\r\n private void StepEntryProgress(ExtractProgressEventArgs e)\r\n {\r\n\r\n if (progressBar1.InvokeRequired)\r\n {\r\n progressBar1.Invoke(new ExtractEntryProgressEventHandler(this.StepEntryProgress), new object[] { e });\r\n }\r\n else\r\n {\r\n progressBar1.Maximum = 100;\r\n progressBar1.Value = Convert.ToInt32(100 * e.BytesTransferred / e.TotalBytesToTransfer);\r\n }\r\n }\r\n\r\n private void Form1_FormClosing(object sender, FormClosingEventArgs e)\r\n {\r\n if (e.CloseReason == CloseReason.UserClosing && AllowClose)\r\n {\r\n e.Cancel = true;\r\n }\r\n }\r\n\r\n public void ForceClose()\r\n {\r\n AllowClose = true;\r\n this.Close();\r\n AllowClose = false;\r\n }\r\n\r\n }\r\n}\r\n\r\n
It looks about right to me.
\r\nThere are lots of extra pushups required if you want to do asynch work in a Winforms app.
\r\n\r\n", "PostedDate": "2010-10-26T18:23:03.767-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "635064", "ThreadId": "231663", "Html": "
Hello Cheeso,
\r\nGuess a little late on this post :)
\r\nIs there a way show extract progress in webforms ?
\r\nThanks.
", "PostedDate": "2011-06-29T15:08:57.3-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "637240", "ThreadId": "231663", "Html": "Extract progress in webforms - meaning extract on a server and update the browser when the server-side extract is done?
\nThe way I would do it is to poll from browser to server periodically; The server needs to update a server-wide variable \"PercentExtracted\" or something like that. The polling request would then retrieve that number, something between 0 and 100, and display a jQuery progressbar of the appropriate length .This would work only with a long-running extraction, something where the extract would take much much longer than 5 or 6 HTTP requests. So... like a minute or more.
\nIf the extraction on the server side takes less than a minute, which will be the case for most zipfiles less than 100mb, then a simple spinning \"wait\" cursor should be sufficient. That's my opinion. I'm not a web UI expert, but I do think it's possible to over-engineer things.
\nAnd yes, resurrecting a very old post to ask a completely unrelated question is bad manners. Don't do that. open a new thread.
", "PostedDate": "2011-07-04T18:52:16.043-07:00", "UserRole": null, "MarkedAsAnswerDate": null }, { "Id": "695414", "ThreadId": "231663", "Html": "JDM6763 example makes my progress bar jump back and forth when I extract the files, anyone know why? (any help or tip is appricieated)
", "PostedDate": "2011-11-08T09:53:13.117-08:00", "UserRole": null, "MarkedAsAnswerDate": null } ]