DEV Community

Cover image for Working with .zip files in C#
Karen Payne
Karen Payne

Posted on

Working with .zip files in C#

#dotnet #csharp

Introduction

Learn how to create archive (.zip) files using Microsoft classes, a dontationware library known as DotNetZip and a third party library, Telerik/Progress.

Each of these provide basic functionality to create and extract file archive.

Note: recommendation, if this article can not answer a specific question ask on Stackoverflow.

When working with DotZip or Telerik libraries which offer password protection after a first time extraction a password is no longer required.

windows 10 saves the password of zip folders during your login session. Once you enter your zip password once, you can access the file as many times as you want during one login session

Paths

🔴 In many code samples there are hard coded paths e.g. C:\OED... change these paths to a folder such as C:\DotNetZipTesting.

Microsoft: System.IO.Compression.ZipFile

System.IO.Compression.ZipFile

Method

For common operations Zip file class provided everything a developer requires to create and extract items from archive files. For more complex operations which requires creating archive files from one or more folders that are not related e.g. one folder C:\Data, another C:\Archives and perhaps D:\Data ZipFile class requires decent amount of code. Also no events nor easy way to track progress for creating or extraction operations. Need to password protect a archive this class does not provide password projection.

Even with these deficiencies Microsoft has done well by providing these methods to developers.

To Use Overloads
Create a zip archive from a directory CreateFromDirectory ✔️
Extract the contents of a zip archive to a directory ExtractToDirectory ✔️
Add new files to an existing zip archive CreateEntry ✔️
Retrieve a file in a zip archive GetEntry ❌
Retrieve all of the files in a zip archive Entries ❌
To open a stream to an individual file contained in a zip archive Open ❌
Delete a file from a zip archive Delete ❌

Simple code sample in this repository

Before running

Extract files with progress bar

DotNetZip

This library should be considered when Microsoft's archive classes do not meet specific requirements like notifictions of events, perhaps having the ability to validate a password for an archive file.

All code samples can be found in ZipOperations class.

Since this library supports various events (which Microsoft's classes do not events) which can make

  • Presenting progress back to the user interface easy and simple.
  • Notifications when various operations have completed possible like finished creating an archive file, finished extracting files from archive.
  • When there are runtime issues for this library.
  • There are countless test methods to work with

Asynchronous

Since working with many files and or folders, code in ZipOperations are asynchronous to keep the user interface responsive. If a developer has only a few files and/or folders best to keep asynchronous as this will not degrade application performance.

Diving in level 1 creating archive files

Rather than starting off with a simple create archive, this code sample shows adding to folders to an archive just a tad pass simple.

  • zip.AddDirectory(unprotectedPath); adds a folder which is not password protected.
  • zip.AddDirectory(path); will be protected as per zip.Password = "password"; 
public static void Demo(string unprotectedPath, string path, string outputPath)
{
    using (ZipFile zip = new ZipFile())
    {
        zip.AddDirectory(unprotectedPath);
        zip.Password = "password";
        //...but this will be password protected
        zip.AddDirectory(path);
        zip.Save(outputPath);
    }
}
Enter fullscreen mode Exit fullscreen mode

While this code will protect both entries because we set password first before adding any entries.

public static void Demo(string unprotectedPath, string path, string outputPath)
{
    using (ZipFile zip = new ZipFile())
    {
        zip.Password = "password";
        zip.AddDirectory(unprotectedPath);
        zip.AddDirectory(path);
        zip.Save(outputPath);
    }
}
Enter fullscreen mode Exit fullscreen mode

💡 Many methods like AddDirectory have overloads, AddDirectory (directoryName) and AddDirectory (directoryName, directoryPathInArchive) so knowing this take time to read the documentation.

Diving in level 2 creating archive files

Suppose a requirement is to allow a client to drag and drop directories to a ListView, allow them to exclude one or more directories? In the following example when a directory or directories are dropped into the ListView they are by default checked, the user can un-check one or more which indicates they are to be excluded when creating the archive file. Also, think ahead, duplicates are ignored and when directory is dropped becomes the selected row so the user can see it's a duplicate.

Extract files windows form

Let's look at what it takes to create an archive with the above reqirements.

public async Task CreateWithPasswordTask()
{
    var fileName = ZipFileName;

    if (File.Exists(fileName))
    {
        File.Delete(fileName);
    }

    await Task.Run(async () =>
    {
        await Task.Delay(1);

        using (var zip = new ZipFile())
        {
            zip.ZipError += OnZipError;
            zip.SaveProgress += ZipOnSaveProgress;

            if (UsePassword && !string.IsNullOrWhiteSpace(Password))
            {
                zip.Password = Password;

                if (UseEncryption)
                {
                    zip.Encryption = EncryptionAlgorithm.WinZipAes256;
                }

            }

            if (AddDirectoryList.Count >1)
            {
                var (folderName, exception) = FileHelpers.CreateUniqueTempDirectory();

                /*
                 * Insufficient permissions to create temp folder
                 */
                if (exception != null)
                {
                    throw exception;
                }

                _uniqueTempDirectory = folderName;

                foreach (var directoryName in AddDirectoryList)
                {
                    // create folder under temporary directory
                    Directory.CreateDirectory(Path.Combine(folderName, Path.GetFileName(directoryName)));

                    // copy folder with sub-directories
                    FileHelpers.CopyFilesRecursively(directoryName, Path.Combine(folderName, Path.GetFileName(directoryName)));
                }

            }
            else
            {
                zip.AddDirectory(AddDirectoryList.FirstOrDefault());
            }

            // remove any exclusion folders
            if (RemoveSelectedEntryList.Count > 0)
            {
                RemoveSelectedEntryList.ForEach(entry => zip.RemoveSelectedEntries(entry));
            }

            if (!string.IsNullOrWhiteSpace(ZipFileComment))
            {
                zip.Comment = ZipFileComment;
            }

            try
            {

                if (File.Exists(ZipFileName))
                {
                    File.Delete(ZipFileName);
                }

            }
            catch (Exception ex)
            {
                ErrorHandler?.Invoke(ex);
            }

            // Single directory
            if (string.IsNullOrWhiteSpace( _uniqueTempDirectory ))
            {
                zip.Save(ZipFileName);
            }
            else
            {
                // add unique temporary directory containing multiple folders
                zip.AddDirectory( _uniqueTempDirectory );
                zip.Save(ZipFileName);

                // remove temporary directory
                var ( _ , exception) = FileHelpers.RemoveUniqueTempDirectory( _uniqueTempDirectory );
                if (exception != null)
                {
                    ErrorHandler?.Invoke(exception);
                }
                zip.Dispose();

            }
        }
    });
}
Enter fullscreen mode Exit fullscreen mode
  1. Check if the archive files currently exists, if yes, delete the file.
  2. Subscribe to ZipError to notify the caller if an exception is raised during the create process.
  3. Subscribe to SaveProgress, invoked when the Save method executes.
  4. Set the archive password if a password has been passed.
  5. Add directories using AddDirectoryList which is a list of string for directories to include in the file
    • A temp folder is created when AddDirectoryList count is greater then zero for each directory with a unique name.
    • When processing is done the folder is removed.
    • Each folder is copied recursively
  6. if there are exclusions they are removed and not included in the archive
  7. If a comment was passed, the comment is assigned to the archive file
  8. Create the archive file.
  9. Remove the temp directory

Important when removing the temp direcory

In some cases a file in the temp directory may be marked as read-only which if not handled properly will raise a run time exception. This is done using the following method.

public static void SetReadOnlyFlagForAllFiles(DirectoryInfo directoryInfo, bool readOnlyValue)
{
    // Iterate over ALL files using "*" wildcard and choosing to search all directories.
    foreach (FileInfo fileInfo in directoryInfo.GetFiles("*", SearchOption.AllDirectories))
    {
        fileInfo.IsReadOnly = readOnlyValue;
    }
}
Enter fullscreen mode Exit fullscreen mode

From

public static (bool success, Exception exception) RemoveUniqueTempDirectory(string tempDirectory)
{
    if (string.IsNullOrWhiteSpace(tempDirectory)) return (true, null);

    var di = new DirectoryInfo(tempDirectory);

    try
    {

        if (Directory.Exists(tempDirectory))
        {
            SetReadOnlyFlagForAllFiles(di, false);
            Directory.Delete(tempDirectory, true);
        }

        return (true, null);

    }
    catch (Exception exception)
    {
        return (false, exception);
    }

}
Enter fullscreen mode Exit fullscreen mode

If for any reason there is still an exception raised a developer can check via the first part of the return of type named Value Tuple.

In the above methods, each directory added to the archive will include its original path, in the following code sample the focus is on allowing or disallowing the original path to be included controlled by parameter directoryPathInArchive.

public Exception CreateFromSingleFolder(List<string> fileList, string zipFileName, string directoryPathInArchive = "")
{
    try
    {
        if (File.Exists(zipFileName))
        {
            File.Delete(zipFileName);
        }

        using (var zip = new ZipFile())
        {
            foreach (var fileName in fileList)
            {
                zip.AddFile(fileName, directoryPathInArchive);
            }

            zip.Save(zipFileName);
        }

        return null;
    }
    catch (Exception exception)
    {
        return exception;
    }
}
Enter fullscreen mode Exit fullscreen mode

Another option, remove a single file from an existing archive. In this case we assume the entry exists as there is a user interface to select files in archive to select from.

🛑 Documentation says zip["Readme.txt"] = null; which does not work now so use the following.

public void RemoveSingleFileFromFile(Entry entry, string zipFileName)
{

    using (var zip = ZipFile.Read(zipFileName))
    {
         if (zip.EntryFileNames.Contains(entry.FileName))
        {
            zip.RemoveEntry(entry);
            zip.Save();
        }

    }
}
Enter fullscreen mode Exit fullscreen mode

Optional, wrap in a try-catch, return a bool or (bool,Exception) named Value Tuple if confirmation is needed.

⚙️ For getting a broad view of DotNetZip download the source, build the following tool, run and check out the features without writing a single line of code.

⚙️ Ready to run console project.

⚙️ Command-line tool that creates a self-extracting Zip archive, given a standard zip archive.

Diving in extracting from archive file

The following screenshot provides a method to get all fiiles in an achive file, indicate if an entry is a file or folder, last modified, size and ratio.

View .zip file files

public List<Entry> ViewZipFileContents(string fileName)
{
    var entries = new List<Entry>();

    if (Directory.Exists(UnZipFolderName))
    {
        Directory.Delete(UnZipFolderName, true);
    }

    using (var zip = ZipFile.Read(fileName))
    {
        foreach (ZipEntry entry in zip)
        {
            entries.Add(new Entry(entry));
        }
    }

    return entries;
}
Enter fullscreen mode Exit fullscreen mode

Entry definition

Which inherits ZipEntry from DotNetZip

  • ItemArray is for populating a ListView, see the following.
  • new is used on several properties to hide base properties 
using Ionic.Zip;

namespace CompressionLibrary.Classes
{
    /// <summary>
    /// Since ZipEntry is not a partial class we must create our own class
    /// </summary>
    /// <remarks>
    /// The "new" modifier
    /// It's used to tell the compiler that the given C# property, method or member hides a similar
    /// member in the base class, in this case <see cref="ZipEntry"/> in ZipFile class.
    /// </remarks>
    public class Entry : ZipEntry
    {
        public Entry(ZipEntry source)
        {
            FileName = source.FileName;
            UncompressedSize = source.UncompressedSize;
            CompressionRatio = source.CompressionRatio;
            LastModified = source.LastModified;
            UsesEncryption = source.UsesEncryption;
            IsDirectory = source.IsDirectory;
            Length = source.FileName.Length;
            Comment = source.Comment;
        }

        public new long UncompressedSize { get; set; }
        public new double CompressionRatio { get; set; }
        public new bool UsesEncryption { get; set; }
        public new bool IsDirectory { get; set; }
        public int Length { get; set; }

        public EntryTag Tag => new EntryTag()
        {
            FileName = FileName, 
            Length = Length,
            IsDirectory = IsDirectory,
            IsFolder = IsDirectory ? "Yes" : "No",
            Comment = Comment ?? ""
        };

        public string[] ItemArray => new[]
        {
            Tag.IsFolder,
            Length.ToString(),
            FileName,
            $"{LastModified::yyyy-MM-dd HH:mm:ss}",
            FileHelpers.SizeSuffix(UncompressedSize),
            $"{CompressionRatio,5:F0}%"
        };
    }
}
Enter fullscreen mode Exit fullscreen mode

Password check/validation

If an archive has a password and being extracted in an application where the user must enter a password, use the following method to valid the password. Note the method in DotNetZip take several seconds.

Unit test method

/// <summary>
/// Warning, this is method take over four seconds to run.
/// </summary>
/// <returns></returns>
[TestMethod]
[TestTraits(Trait.ZipOperations)]
public async Task CheckZipFilePasswordTest()
{
    var isValidPassword = await ZipPasswordTester.IsValidFilePassword(ZipFileName, _password);
    Assert.IsTrue(isValidPassword);
}
Enter fullscreen mode Exit fullscreen mode

Source

using System.Threading.Tasks;
using Ionic.Zip;
namespace CompressionLibrary
{
    public partial class ZipPasswordTester
    {
        /// <summary>
        /// Check if password for file is valid
        /// </summary>
        /// <param name="fileName">file compressed with password using DotNetZip</param>
        /// <param name="password">Password to validate</param>
        /// <returns>true if valid password, false if password is invalid</returns>
        /// <remarks>
        /// Must run async as CheckZipPassword takes time to run.
        /// </remarks>
        public static async Task<bool> IsValidFilePassword(string fileName, string password)
        {
            var result = false;

            await Task.Run(async () =>
            {
                await Task.Delay(10);
                result = ZipFile.CheckZipPassword(fileName, password);
            });

            return result;

        }
        /// <summary>
        /// Validate password for <see cref="ZipEntry"/>
        /// </summary>
        /// <param name="entry">Entity to check</param>
        /// <param name="password">Password to validate</param>
        /// <returns>true if valid, false if invalid password</returns>
        public static bool CheckPassword(ZipEntry entry, string password)
        {
            try
            {
                using (var itemCheckStream = new PasswordCheckStream())
                {
                    entry.ExtractWithPassword(itemCheckStream, password);
                }

                return true;
            }
            catch (BadPasswordException)
            {
                return false;
            }
            catch (PasswordCheckStream.GoodPasswordException)
            {
                return true;
            }
        }
    }
}
Enter fullscreen mode Exit fullscreen mode

To determine if a file exits in archive

/// <summary>
/// Find <see cref="Entry"/> by file name
/// </summary>
/// <param name="fileName">zip file name</param>
/// <param name="entryFileName">file name to find in fileName</param>
/// <returns></returns>
public Entry FindEntry(string fileName, string entryFileName) =>
    ViewZipFileContents(fileName).FirstOrDefault(item => item.FileName == entryFileName);

/// <summary>
/// Determine if a file name exists in a .zip file
/// </summary>
/// <param name="fileName">zip file to check</param>
/// <param name="entryFileName">file name in .zip file to find</param>
/// <returns></returns>
public bool ContainsEntry(string fileName, string entryFileName)
{
    using (var zip = ZipFile.Read(fileName))
    {
        return zip.Any(entry => entry.FileName == entryFileName);
    }
}
Enter fullscreen mode Exit fullscreen mode

Extract with no password no progressbar

Usage

private async void UnzipButton_Click(object sender, EventArgs e)
{
    UnzipButton.Enabled = false;
    progressBar1.Visible = true;
    CurrentExtractonLabel.Visible = true;

    var zipOperations = new ZipOperations
    {
        Password = PasswordTextBox.Text,
        UnZipFolderName = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Extracted")
    };

    zipOperations.ExtractFinishedHandler += ZipOperationsOnExtractFinishedHandler;
    zipOperations.SendProgressUpdate += ZipOperationsOnSendProgressUpdate;

    try
    {
        await zipOperations.DecompressNoPasswordTask(SaveFileNameTextBox.Text, @"C:\OED\DumpZipFiles");
    }
    finally
    {
        UnzipButton.Enabled = true;
        await Task.Delay(500);
        progressBar1.Visible = false;
        CurrentExtractonLabel.Visible = false;
    }

    zipOperations.ExtractFinishedHandler -= ZipOperationsOnExtractFinishedHandler;

}
Enter fullscreen mode Exit fullscreen mode

Source

public async Task DecompressNoPasswordTask(string fileName, string destinationFileName = "")
{

    if (!string.IsNullOrWhiteSpace(destinationFileName))
    {
        UnZipFolderName = destinationFileName;
    }

    ZipEntry currentEntry = new ZipEntry();

    string extractPath = @"C:\OED\DumpZipFiles";

    if (Directory.Exists(extractPath))
    {
        var di = new DirectoryInfo(extractPath);
        FileHelpers.SetReadOnlyFlagForAllFiles(di, false);

        if (Directory.Exists(extractPath))
        {
            Directory.Delete(extractPath, true);
        }
    }



    await Task.Run(async () =>
    {

        using (var zip = ZipFile.Read(fileName))
        {
            //zip.ExtractProgress += ExtractProgress;
            zip.ExtractProgress += ZipOnExtractProgress;

            var selection = from zipEntry in zip.Entries select zipEntry;

            try
            {
                foreach (ZipEntry entry in selection)
                {
                    currentEntry = entry;
                    entry.Extract(extractPath);
                }
            }
            catch (Exception ex)
            {
                // TODO
            }
        }

        /*
         * arbitrary time done with experimentation 
         */
        await Task.Delay(500);

    });
}
Enter fullscreen mode Exit fullscreen mode

Extract with no password with progressbar 

private async void UnzipButton_Click(object sender, EventArgs e)
{
    UnzipButton.Enabled = false;
    progressBar1.Visible = true;
    CurrentExtractonLabel.Visible = true;

    var zipOperations = new ZipOperations
    {
        Password = PasswordTextBox.Text,
        UnZipFolderName = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Extracted")
    };

    zipOperations.ExtractFinishedHandler += ZipOperationsOnExtractFinishedHandler;
    zipOperations.SendProgressUpdate += ZipOperationsOnSendProgressUpdate;

    try
    {
        await zipOperations.DecompressNoPasswordTask(SaveFileNameTextBox.Text, @"C:\OED\DumpZipFiles");
    }
    finally
    {
        UnzipButton.Enabled = true;
        await Task.Delay(500);
        progressBar1.Visible = false;
        CurrentExtractonLabel.Visible = false;
    }

    zipOperations.ExtractFinishedHandler -= ZipOperationsOnExtractFinishedHandler;

}

/// <summary>
/// Prevent cross-threading
/// </summary>
private void ZipOperationsOnSendProgressUpdate(object sender, ExtractProgressEventArgs e)
{
    if (InvokeRequired)
    {
        Invoke(new Action<object, ExtractProgressEventArgs>(UpdateProgress), sender, e);
    }
}
/// <summary>
/// Super simple report progress on archive extraction
/// </summary>
private void UpdateProgress(object arg1, ExtractProgressEventArgs e)
{

    if (e.TotalBytesToTransfer <= 0) return;

    progressBar1.Value = Convert.ToInt32(100 * e.BytesTransferred / e.TotalBytesToTransfer);
    CurrentExtractonLabel.Text = e.CurrentEntry.FileName;

}
Enter fullscreen mode Exit fullscreen mode

File helpers

In many cases there are resonsibilites that will be used more than once so they are placed into a class.

using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace CompressionLibrary
{
    public static class FileHelpers
    {
        /// <summary>
        /// Copy files in parent and child folders. Caller is an async task
        /// </summary>
        /// <param name="sourcePath"></param>
        /// <param name="targetPath"></param>
        public static void CopyFilesRecursively(string sourcePath, string targetPath)
        {
            foreach (string dirPath in Directory.GetDirectories(sourcePath, "*", SearchOption.AllDirectories))
            {
                Directory.CreateDirectory(dirPath.Replace(sourcePath, targetPath));
            }

            foreach (string newPath in Directory.GetFiles(sourcePath, "*.*", SearchOption.AllDirectories))
            {
                File.Copy(newPath, newPath.Replace(sourcePath, targetPath), true);
            }
        }

        private static readonly string[] SizeSuffixes = { "bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" };

        /// <summary>
        /// Format int as readable file size
        /// </summary>
        /// <param name="value">value to format</param>
        /// <param name="decimalPlaces">decimal places, default is 1</param>
        /// <returns></returns>
        public static string SizeSuffix(long value, int decimalPlaces = 1)
        {

            if (value < 0)
            {
                return "-" + SizeSuffix(-value);
            }

            int size = 0;
            var dValue = (decimal)value;

            while (Math.Round(dValue, decimalPlaces) >= 1000)
            {
                dValue /= 1024M;
                size += 1;
            }

            return string.Format("{0:n" + decimalPlaces + "} {1}", dValue, SizeSuffixes[size]);

        }

        /// <summary>
        /// Creates the unique temporary directory.
        /// </summary>
        /// <returns>
        /// Directory path.
        /// </returns>
        public static (string folderName, Exception exception) CreateUniqueTempDirectory()
        {
            var uniqueTempDir = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());

            try
            {
                Directory.CreateDirectory(uniqueTempDir);
                return (uniqueTempDir, null);
            }
            catch (Exception exception)
            {
                return (null, exception);
            }

        }

        /// <summary>
        /// Clean up
        /// </summary>
        /// <param name="tempDirectory"></param>
        /// <returns></returns>
        public static (bool success, Exception exception) RemoveUniqueTempDirectory(string tempDirectory)
        {
            if (string.IsNullOrWhiteSpace(tempDirectory)) return (true, null);

            var di = new DirectoryInfo(tempDirectory);

            try
            {

                if (Directory.Exists(tempDirectory))
                {
                    SetReadOnlyFlagForAllFiles(di, false);
                    Directory.Delete(tempDirectory, true);
                }

                return (true, null);

            }
            catch (Exception exception)
            {
                return (false, exception);
            }

        }

        /// <summary>
        /// Set read-only attribute for each file in a folder
        /// </summary>
        /// <param name="directoryInfo">Directory to recursively iterate to set file attribute to false or true</param>
        /// <param name="readOnlyValue">True to set, false to remove</param>
        public static void SetReadOnlyFlagForAllFiles(DirectoryInfo directoryInfo, bool readOnlyValue)
        {
            // Iterate over ALL files using "*" wildcard and choosing to search all directories.
            foreach (FileInfo fileInfo in directoryInfo.GetFiles("*", SearchOption.AllDirectories))
            {
                fileInfo.IsReadOnly = readOnlyValue;
            }
        }

        /// <summary>
        /// Recursively set file attributes to <see cref="FileAttributes.Normal"/>
        /// </summary>
        /// <param name="parentDirectory"></param>
        /// <code>
        ///  DirectoryInfo parentDirectoryInfo = new DirectoryInfo(@"C:\OED");
        ///  ClearReadOnly(parentDirectoryInfo);
        /// </code>
        public static void ClearReadOnly(DirectoryInfo parentDirectory)
        {
            if (parentDirectory == null) return;

            parentDirectory.Attributes = FileAttributes.Normal;

            foreach (FileInfo fileInfo in parentDirectory.GetFiles())
            {
                fileInfo.Attributes = FileAttributes.Normal;
            }

            foreach (DirectoryInfo directoryInfo in parentDirectory.GetDirectories())
            {
                ClearReadOnly(directoryInfo);
            }

        }

        /// <summary>
        /// Create a unique file name
        /// </summary>
        /// <param name="useGuid">true to include Guid, false to exclude Guid</param>
        /// <param name="extension">File extension with period, if not specified .zip is used</param>
        /// <returns>unique file name</returns>
        /// <remarks>
        ///  -- is used to separate date part from time part, feel free to change this
        /// Change this methods logic the method <see cref="DateTimeFromFileName"/> must be altered
        /// </remarks>
        public static string UniqueFileName(bool useGuid,string extension = ".zip") => useGuid ? 
            $"{DateTime.Now:yyyy-dd-M--HH-mm-ss-ms}{Guid.NewGuid()}{extension}" : 
            $"{DateTime.Now:yyyy-dd-M--HH-mm-ss-ms}{extension}";


        /// <summary>
        /// Helper for <see cref="UniqueFileName"/> to split out date time from file name
        /// </summary>
        /// <param name="source">Created with <see cref="UniqueFileName"/></param>
        /// <returns>DateTime</returns>
        /// <returns>DateTime</returns>
        public static DateTime DateTimeFromFileName(string source)
        {
            /*
             * Can split easily when we have -- and - in the string so change -- to ~ and remove the extension
             */
            var sanitized = source.Replace("--", "~").Replace(".zip", "").Split('~');

            /*
             * Since replacing -- with ~ we can properly get time element
             */
            var parts = sanitized[1].Split('-');

            /*
             * Combine data part (element 0) with time part (element 1)
             * and create our date time
             */
            var thisTime = $"{parts[0]}:{parts[1]}:{parts[2]}";

            return Convert.ToDateTime($"{sanitized[0]} {thisTime}", CultureInfo.InvariantCulture);
        }
    }
}
Enter fullscreen mode Exit fullscreen mode

Unit test project

Take note of MainTest.cs under the Base folder, Initialization method has logic for specific test for preparation prior to running test.

Telerik code samples

This library has powerful features but lacks events which is one reason DotNetZip shines,

Create an archive with password

private void CreateZipPasswordButton_Click(object sender, EventArgs e)
{


    using (Stream stream = File.Open("demo.zip", FileMode.Create))
    {
        DefaultEncryptionSettings encryptionSettings = new DefaultEncryptionSettings
        {
            Password = "password"
        };

        using (var archive1 = new ZipArchive(stream, ZipArchiveMode.Create, false, null, null, encryptionSettings))
        {
            using (ZipArchiveEntry textFileEntry = archive1.CreateEntry("text.txt"))
            {
                StreamWriter writer = new StreamWriter(textFileEntry.Open());
                writer.WriteLine("Hello world!");
                writer.Flush();
            }

            archive1.CreateEntryFromFile("Doc1.docx", "doc.docx", CompressionLevel.Best);

        }
    }
}
Enter fullscreen mode Exit fullscreen mode

Create archive, no password using a custom method

private async void FromFolderRecursiveButton_Click(object sender, EventArgs e)
{
    var (success, exception) = await ZipOperations.FromDirectory(@"C:\OED\Documents", "dump.zip");

    MessageBox.Show(success ? "Done" : $"Encountered an issue\n{exception.Message}");
}
Enter fullscreen mode Exit fullscreen mode

Custom operations class

using System;
using System.IO;
using System.Threading.Tasks;
using Telerik.Windows.Zip;
using Telerik.Windows.Zip.Extensions;

namespace TelerikZipCodeSamples
{
    public class ZipOperations
    {
        /// <summary>
        /// Example for creating a .zip (archive) file from a folder where
        /// all sub-folders and files will be included.
        /// </summary>
        /// <param name="folder">Root folder</param>
        /// <param name="zipName">Zip file name, may include a path</param>
        /// <returns></returns>
        public static async Task<(bool success, Exception exception)> FromDirectory(string folder, string zipName)
        {
            return await Task.Run(async () =>
            {
                await Task.Delay(1);

                try
                {
                    if (File.Exists(zipName))
                    {
                        File.Delete(zipName);
                    }

                    ZipFile.CreateFromDirectory(folder, zipName);

                    return (true, null);

                }
                catch (Exception ex)
                {
                    return (false, ex);
                }

            });
        }

        /// <summary>
        /// Create a .zip (archive file) with password
        /// </summary>
        /// <param name="sourceDirectoryName"></param>
        /// <param name="destinationArchiveFileName"></param>
        /// <param name="password">Password for archive file</param>
        /// <returns></returns>
        public static async Task<bool> CreateEncryptedZipFileFromDirectory(string sourceDirectoryName, string destinationArchiveFileName, string password)
        {
            return await Task.Run(() =>
            {
                char[] directorySeparatorChar =
                {
                    Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar
                };

                if (!string.IsNullOrWhiteSpace(sourceDirectoryName))
                {
                    using (FileStream archiveStream = File.Open(destinationArchiveFileName, FileMode.Create))
                    {
                        // Set password to protect ZIP archive
                        DefaultEncryptionSettings encryptionSettings = new DefaultEncryptionSettings
                        {
                            Password = password
                        };

                        using (ZipArchive archive = new ZipArchive(archiveStream, ZipArchiveMode.Create, true, null, null, encryptionSettings))
                        {
                            foreach (string fileName in Directory.GetFiles(sourceDirectoryName))
                            {
                                using (FileStream file = File.OpenRead(fileName))
                                {
                                    int length = fileName.Length - sourceDirectoryName.Length;
                                    string entryName = fileName.Substring(sourceDirectoryName.Length, length);
                                    entryName = entryName.TrimStart(directorySeparatorChar);

                                    using (ZipArchiveEntry entry = archive.CreateEntry(entryName))
                                    {
                                        using (Stream entryStream = entry.Open())
                                        {
                                            file.CopyTo(entryStream);
                                        }
                                    }
                                }
                            }
                        }
                    }

                    return Task.FromResult(true);
                }
                else
                {
                    return Task.FromResult(false);
                }

            });
        }
    }
}
Enter fullscreen mode Exit fullscreen mode

Issues

  • Passwording can be problematic when attempting to extract from Windows Explorer but not when extraction is done using DotNetZip code. This is an operating system issue which could be resolved by changing the library code but that means this can be an issue if a new version is released.
  • Adding folders with long path then extracting to a extraction folder with a long path can cause a catchable runtime error from the library. This is a fringe case and there are ways around this.

Tips

  • Consider when creating an archive with multiple folders to create a temp folder, do the work, copy archive file to indended path then remove the temp folder
    • Do not assume even though code performed the above operaton the removal of the temp folder will work. There may be files that by file attributes will deny removal which means a method is needed to set each file to normal attribute.
  • Consider
    • A method to create a unique temp folder and a method to remove that folder
    • Recommend a class without static methods for archive create and unzip operations
    • Use plenty of assertions rather than relying solely on try-catch statements
    • Always think about will an operation cause the user interface to become unresponsive and if so use asynchronous code.
    • In some cases asynchronous code can slow things down so test asynchronous and synchronous.

Summary

There is a great deal of information and code presented, best not simply copy and paste code and expect the code to work as there are things like permissions to folders to take into consideration.

Source code

Clone the following GitHub repository, branch ArticleDev

Top comments (0)

Read next

isaacojeda profile image

Integration Tests en .NET con TestContainers: Pruebas de Base de Datos Aisladas

Isaac Ojeda -

yogini16 profile image

Any() vs Count, Which one to choose??

yogini16 -

abdullahal_mahmud profile image

🔎Exploring Design Patterns: Factory Method

Abdullah Al Mahmud -

paulotorrestech profile image

Developing an Equity Business Application with .NET 8, Azure, and AI

Paulo Torres -