How to compress and decompress files with GZip in .NET C#

You have probably seen compressed files with the “gz” extension. These are files that hold a single compressed file according to the GZIP specifications.

GZip files are represented by the GZipStream object in .NET. It’s important to note that the GZip format doesn’t support adding multiple files to the same .gz file. If you need to insert multiple files in a GZip file then you’ll need to create a “tar” file first which bundles the individual files and then compresses the tar file itself. The result will be a “.tar.gz” file. At present tar files are not supported in .NET. They are supported by the ICSharpCode SharpZipLib library available here. We’ll look at tar files in another post soon.

With that in mind let’s see how a single file can be gzipped:

FileInfo fileToBeGZipped = new FileInfo(@"c:\gzip\logfile.txt");
FileInfo gzipFileName = new FileInfo(string.Concat(fileToBeGZipped.FullName, ".gz"));
			
using (FileStream fileToBeZippedAsStream = fileToBeGZipped.OpenRead())
{
	using (FileStream gzipTargetAsStream = gzipFileName.Create())
        {
		using (GZipStream gzipStream = new GZipStream(gzipTargetAsStream, CompressionMode.Compress))
		{
			try
			{
				fileToBeZippedAsStream.CopyTo(gzipStream);
			}
			catch (Exception ex)
			{
				Console.WriteLine(ex.Message);
			}
		}
	}
}

…and this is how you can decompress the gz file:

using (FileStream fileToDecompressAsStream = gzipFileName.OpenRead())
{
	string decompressedFileName = @"c:\gzip\decompressed.txt";
	using (FileStream decompressedStream = File.Create(decompressedFileName))
	{
		using (GZipStream decompressionStream = new GZipStream(fileToDecompressAsStream, CompressionMode.Decompress))
		{
			try
			{
				decompressionStream.CopyTo(decompressedStream);
			}
         		catch (Exception ex)
			{
				Console.WriteLine(ex.Message);
			}
		}
	}
}

Read all posts dedicated to file I/O here.

5 ways to write to a file with C# .NET

It’s a common scenario that you need to write some content to a file. Here you see 5 ways to achieve that.

1. Using a FileStream:

private void WriteToAFileWithFileStream()
{
	using (FileStream target = File.Create(@"c:\mydirectory\target.txt"))
	{
		using (StreamWriter writer = new StreamWriter(target))
		{
			writer.WriteLine("Hello world");
		}
	}
}

This will create a new file or overwrite an existing one.

Write and WriteLine have asynchronous versions as well: WriteAsync and WriteLineAsync. If you don’t know how to use async methods that return a Task then start here.

The following variation will append the text to an existing file or create a new one:

using (FileStream target = File.Open(@"c:\mydirectory\target2.txt", FileMode.Append, FileAccess.Write))
{
	using (StreamWriter writer = new StreamWriter(target))
	{
		writer.WriteLine("Hello world");
	}
}

2. Using a StreamWriter directly – to be used for text files:

private static void WriteToAFileWithStreamWriter()
{
	using (StreamWriter writer = File.CreateText(@"c:\mydirectory\target.txt"))
	{
		writer.WriteLine("Bye world");
	}
}

This will create a new file or overwrite an existing one.

The following variation will append the text to an existing file or create a new one:

using (StreamWriter writer = File.AppendText(@"c:\mydirectory\target.txt"))
{
	writer.WriteLine("Bye world");
}

3. Using File:

private static void WriteToAFileWithFile()
{
	File.WriteAllText(@"c:\mydirectory\target.txt", "Hello again World");
}

There’s File.WriteAllBytes as well if you have the contents as a byte array. There’s also a File.AppendAllText method to append to an existing file or create a new one if it doesn’t exist.

4. Using a MemoryStream first:

private static void WriteToAFileFromMemoryStream()
{
	using (MemoryStream memory = new MemoryStream())
	{
		using (StreamWriter writer = new StreamWriter(memory))
		{
			writer.WriteLine("Hello world from memory");
			writer.Flush();
			using (FileStream fileStream = File.Create(@"c:\mydirectory\memory.txt"))
			{
				memory.WriteTo(fileStream);
			}
		}
	}
}

5. Using a BufferedStream:

private static void WriteToAFileFromBufferedStream()
{
	using (FileStream fileStream = File.Create(@"c:\mydirectory\buffered.txt"))
	{
		using (BufferedStream buffered = new BufferedStream(fileStream))
		{
			using (StreamWriter writer = new StreamWriter(buffered))
			{
				writer.WriteLine("Hello from buffered.");
			}
		}
	}
}

Read all posts dedicated to file I/O here.

4 ways to read the contents of a file with C# .NET

.NET supports a number of ways to read from a file. Here come 4 of them.

1. Using FileStream:

private void ReadFileWithFileStream()
{
	using (FileStream fileStream = File.Open(@"c:\mydirectory\source.txt", FileMode.Open, FileAccess.Read))
	{
		using (StreamReader streamReader = new StreamReader(fileStream))
		{
			Console.Write(streamReader.ReadToEnd());
		}
	}
}

2. Using StreamReader:

private void ReadFileWithStreamReader()
{
	using (StreamReader reader = File.OpenText(@"c:\mydirectory\source.txt"))
	{
		Console.Write(reader.ReadToEnd());
	}
}

StreamReader.ReadToEnd has an awaitable version ReadToEndAsync which you can use to read from the file asynchronously. If you don’t know what this means then start here.

3. Using File:

private void ReadFileWithFile()
{
	Console.WriteLine(File.ReadAllText(@"c:\mydirectory\source.txt"));
}

4. Using BufferedStream:

private void ReadFileWithBufferedStream()
{
	using (FileStream fileStream = File.Open(@"c:\mydirectory\source.txt", FileMode.Open, FileAccess.Read))
	{
		using (BufferedStream bufferedStream = new BufferedStream(fileStream))
		{
			using (StreamReader streamReader = new StreamReader(bufferedStream))
			{
				Console.Write(streamReader.ReadToEnd());
			}
		}
	}
}

Read all posts dedicated to file I/O here.

How to partially read a file with C# .NET

Say you have a large file with a lot of text in it and you need to find a particular bit. One way could be to read the entire text into memory and search through it. Another, more memory-friendly solution is to keep reading the file line by line until the search term has been found.

Suppose you have a text file with the following random English content:

—————–
Unfeeling so rapturous discovery he exquisite. Reasonably so middletons or impression by terminated. Old pleasure required removing elegance him had. Down she bore sing saw calm high. Of an or game gate west face shed. no great but music too old found arose.

Offered say visited elderly and. Waited period are played family man formed. He ye body or made on pain part meet. You one delay nor begin our folly abode. By disposed replying mr me unpacked no. As moonlight of my resolving unwilling.

Inquietude simplicity terminated she compliment remarkably few her nay. The weeks are ham asked jokes. Neglected perceived shy nay concluded. Not mile draw plan snug next all. Houses latter an valley be indeed wished merely in my. Money doubt oh drawn every or an china. Visited out friends for expense message set eat.
—————-

Also suppose that you’d like to find the first occurrence of “formed”. The following code will do just that:

private static void ReadFilePartially()
{
	using (StreamReader streamReader = File.OpenText(@"c:\mydirectory\source.txt"))
	{
		String searchString = "formed";
		bool searchStringFound = false;

		while (!searchStringFound && !streamReader.EndOfStream)
		{
			string line = streamReader.ReadLine();
			if (line.Contains(searchString))
			{
				Console.WriteLine("Search term {0} found in the following line:\n{1}", searchString, line);
				searchStringFound = true;
			}
		}
	}
}

Read all posts dedicated to file I/O here.

Monitor the file system with FileSystemWatcher in C# .NET Part 4: other features

In the first three parts of this mini-series – starting here – we looked at how to subscribe to the events raised by a FileSystemWatcher object. FileSystemWatcher has a couple more properties that can be interesting.

Consider the following code:

static void Main(string[] args)
{
	RunVariousFeaturesExample();
	Console.ReadKey();
}

private static void RunVariousFeaturesExample()
{
	FileSystemWatcher watcher = new FileSystemWatcher();
	watcher.Path = @"c:\mydirectory";
	watcher.Filter = "*.txt";
	watcher.IncludeSubdirectories = true;
	watcher.NotifyFilter = NotifyFilters.Security | NotifyFilters.Size;
	watcher.Changed += watcher_Changed;
	watcher.EnableRaisingEvents = true;
}

static void watcher_Changed(object sender, FileSystemEventArgs e)
{
	Console.WriteLine("A change occurred in the monitored directory. Change type: {0}, file name: {1}", e.ChangeType, e.Name);
}

We set the path to be monitored as usual. We can filter the file names to be monitored. Here we’re interested in text files only. We also specify that we want to monitor all subfolders of the “Path” directory through the IncludeSubdirectories property. With NotifyFilter we can further refine the cases when we want to be notified of a file change. Here we want to be notified if either the file size changes or the security properties have been updated. Then we subscribe to the generic Changed event which is raised in case an existing file changes.

In the below example I’ve updated the security settings of a file and it successfully raised the Changed event:

File change monitored by filesystemwatcher

Read all posts dedicated to file I/O here.

Monitor the file system with FileSystemWatcher in C# .NET Part 3: errors

In this and this post we looked at how to use FileSystemWatcher to monitor the creation, deletion and update of files within a directory. It can happen that there are more changes than the FileSystemWatcher object can handle. In that case FileSystemWatcher raises the Error event which you can subscribe to as follows:

static void Main(string[] args)
{
	RunErrorExample();
	Console.ReadKey();
}

private static void RunErrorExample()
{
	FileSystemWatcher watcher = new FileSystemWatcher();
	watcher.Path = @"c:\mydirectory";
	watcher.Error += watcher_Error;
	watcher.EnableRaisingEvents = true;
}

static void watcher_Error(object sender, ErrorEventArgs e)
{
	Exception ex = e.GetException();
	Console.WriteLine(ex.Message);
	if (ex.InnerException != null)
	{
		Console.WriteLine(ex.InnerException);
	}
}

Read the next and last installment on this topic here.

Read all posts dedicated to file I/O here.

Monitor the file system with FileSystemWatcher in C# .NET Part 2: updates

In this post we saw how to set up a FileSystemWatcher to monitor a directory for file insertions and creations.

The FileSystemWatcher object also lets you monitor a given directory for file updates. The following code is very similar to the one referred to in the above link. The difference is that we subscribe to the Renamed event:

static void Main(string[] args)
{
	RunUpdateExample();
	Console.ReadKey();
}

private static void RunUpdateExample()
{
	FileSystemWatcher watcher = new FileSystemWatcher();
	watcher.Path = @"c:\mydirectory";
	watcher.Renamed += watcher_Renamed;
	watcher.EnableRaisingEvents = true;
}

static void watcher_Renamed(object sender, RenamedEventArgs e)
{
	Console.WriteLine("File updated. Old name: {0}, new name: {1}", e.OldName, e.Name);
}

Again, we have the Console.ReadKey(); in Main to make sure that the console app doesn’t just quit, otherwise the file system watcher process dies.

If you run this code and rename a file in the monitored directory you may see an output similar to the following:

File name change monitored by filesystemwatcher

Read the next installment here.

Read all posts dedicated to file I/O here.

Monitor the file system with FileSystemWatcher in C# .NET Part 1

In this mini-series we’ll look at how you can use the FileSystemWatcher object to monitor the Windows file system for various changes.

A FileSystemWatcher object enables you to be notified when some change occurs in the selected part of the file system. This can be any directory, such as “c:\” or any subdirectory under the C: drive. So if you’d like to make sure you know if a change occurs on e.g. “c:\myfolder” – especially if it’s editable by your colleagues – then FileSystemWatcher is a good candidate.

Consider the following Console application:

class Program
{
	static void Main(string[] args)
	{
		RunFirstExample();
		Console.ReadKey();
	}

	private static void RunFirstExample()
	{
		FileSystemWatcher watcher = new FileSystemWatcher();
		watcher.Path = @"c:\mydirectory";
		watcher.Created += watcher_Created;
		watcher.Deleted += watcher_Deleted;
		watcher.EnableRaisingEvents = true;			
	}

	static void watcher_Deleted(object sender, FileSystemEventArgs e)
	{
		Console.WriteLine("File deleted. Name: {0}", e.Name);
	}

	static void watcher_Created(object sender, FileSystemEventArgs e)
	{
		Console.WriteLine("File created. Name: {0}", e.Name);
	}
}

In RunFirstExample we specify that we’re interested in monitoring the c:\mydirectory directory. Then we subscribe to the Created and Deleted events which represent the insertion of a new file and the deletion of an existing file in the directory. The FileSystemEventArgs has a couple of properties to show the event type, such as “Created” or “Deleted” in a WatcherChangeTypes enumeration, the file name and the file full path. We then start running the monitoring process by setting EnableRaisingEvents to true.

Note the call to Console.ReadKey(); in Main. The process won’t magically run in the background once Main is done. The FileSystemWatcher must sit within a continuous process, such as a Windows service.

Run the above code and insert a new file into the monitored directory. Then delete the file and watch the console output. Insertion example:

File creation monitored by filesystemwatcher

File deleted:

File deletion monitored by filesystemwatcher

Read the next part here.

Read all posts dedicated to file I/O here.

Inspecting the directories on the local PC using C# .NET

In this post we saw how to enumerate all the drives on your Windows machine. Once you have the drive name, such as C:\ you can start digging into it to see what files and folders it contains.

The DirectoryInfo object is the entry point to the exercise:

DirectoryInfo directoryInfo = new DirectoryInfo(@"c:\");

The empty GetDirectories() method will find all subfolders directly under “c:\” i.e. exclude the subfolders within the folders on c:\

DirectoryInfo[] allSubFolders = directoryInfo.GetDirectories();
foreach (DirectoryInfo subFolder in allSubFolders)
{
	Console.WriteLine("Sub directory name: {0}", subFolder.Name);
        Console.WriteLine("Sub directory creation time: {0}", subFolder.CreationTimeUtc);
}

DirectoryInfo has several other properties such as last access time that can be interesting for you.

GetDirectories has two overloads which let you search for a folder. The following will list all subdirectories whose name starts with an “a”:

DirectoryInfo[] searchedFolders = directoryInfo.GetDirectories("a*");

…and this is how you extend the search to all directories under c:\

DirectoryInfo[] searchedFolders = directoryInfo.GetDirectories("a*", SearchOption.AllDirectories);

The search is case-insensitive so this returns all folders starting with “a” and “A”.

You can search for files in much the same way. The file-equivalent class of DirectoryInfo is FileInfo. This is how to list all files available directly within a directory:

FileInfo[] filesInDir = directoryInfo.GetFiles();

GetFiles() also has overloads similar to GetDirectories that enable you to search for files.

Read all posts dedicated to file I/O here.

Inspecting the drives on the local PC using C# .NET

It’s very simple to enumerate the drives on a Windows computer. The DriveInfo object has a GetDrives static method which returns an array of DriveInfo objects. A DriveInfo describes a drive through its properties. It is similar to the FileInfo class which in turn describes a file.

There are some properties that can only be extracted if the drive is ready, e.g. a CD-Rom drive. The following method prints the available drives:

DriveInfo[] drives = DriveInfo.GetDrives();
foreach (DriveInfo drive in drives)
{
	Console.WriteLine("Drive name: {0}", drive.Name);
	if (drive.IsReady)
	{
		Console.WriteLine("Total size: {0}", drive.TotalSize);
		Console.WriteLine("Total free space: {0}", drive.TotalFreeSpace);
		Console.WriteLine("Available free space: {0}", drive.AvailableFreeSpace);
		Console.WriteLine("Drive format: {0}", drive.DriveFormat);
	}
	else
	{
		Console.WriteLine("Device {0} is not ready.", drive.Name);									
	}
	Console.WriteLine("Drive type: {0}", drive.DriveType);	
}

I got the following output:

Drives enumerated

DriveType can have the following values:

  • CDRom: an optical drive such as a CD-ROM, DVD etc.
  • Fixed: a fixed disk, quite often labelled as “C:\”
  • Network: a mapped drive
  • NoRootDirectory: a drive with no root directory
  • Ram: a RAM drive
  • Removable: a removable drive such as a pen-drive
  • Unknown: a drive whose type could not be determined

Read all posts dedicated to file I/O here.

Elliot Balynn's Blog

A directory of wonderful thoughts

Software Engineering

Web development

Disparate Opinions

Various tidbits

chsakell's Blog

WEB APPLICATION DEVELOPMENT TUTORIALS WITH OPEN-SOURCE PROJECTS

Once Upon a Camayoc

ARCHIVED: Bite-size insight on Cyber Security for the not too technical.