1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
|
// SimpleZip.cs
//
// Copyright 2005 John Reilly
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// Linking this library statically or dynamically with other modules is
// making a combined work based on this library. Thus, the terms and
// conditions of the GNU General Public License cover the whole
// combination.
//
// As a special exception, the copyright holders of this library give you
// permission to link this library with independent modules to produce an
// executable, regardless of the license terms of these independent
// modules, and to copy and distribute the resulting executable under
// terms of your choice, provided that you also meet, for each linked
// independent module, the terms and conditions of the license of that
// module. An independent module is a module which is not derived from
// or based on this library. If you modify this library, you may extend
// this exception to your version of the library, but you are not
// obligated to do so. If you do not wish to do so, delete this
// exception statement from your version.
using System;
using System.IO;
using ICSharpCode.SharpZipLib.Core;
namespace ICSharpCode.SharpZipLib.Zip
{
/// <summary>
/// FastZipEvents supports all events applicable to <see cref="FastZip">FastZip</see> operations.
/// </summary>
public class FastZipEvents
{
/// <summary>
/// Delegate to invoke when processing directories.
/// </summary>
public ProcessDirectoryDelegate ProcessDirectory;
/// <summary>
/// Delegate to invoke when processing files.
/// </summary>
public ProcessFileDelegate ProcessFile;
/// <summary>
/// Delegate to invoke when processing directory failures.
/// </summary>
public DirectoryFailureDelegate DirectoryFailure;
/// <summary>
/// Delegate to invoke when processing file failures.
/// </summary>
public FileFailureDelegate FileFailure;
/// <summary>
/// Raise the directory failure event.
/// </summary>
/// <param name="directory">The directory.</param>
/// <param name="e">The exception for this event.</param>
public void OnDirectoryFailure(string directory, Exception e)
{
if ( DirectoryFailure != null ) {
ScanFailureEventArgs args = new ScanFailureEventArgs(directory, e);
DirectoryFailure(this, args);
}
}
/// <summary>
/// Raises the file failure event.
/// </summary>
/// <param name="file">The file for this event.</param>
/// <param name="e">The exception for this event.</param>
public void OnFileFailure(string file, Exception e)
{
if ( FileFailure != null ) {
ScanFailureEventArgs args = new ScanFailureEventArgs(file, e);
FileFailure(this, args);
}
}
/// <summary>
/// Raises the ProcessFileEvent.
/// </summary>
/// <param name="file">The file for this event.</param>
public void OnProcessFile(string file)
{
if ( ProcessFile != null ) {
ScanEventArgs args = new ScanEventArgs(file);
ProcessFile(this, args);
}
}
/// <summary>
/// Raises the ProcessDirectoryEvent.
/// </summary>
/// <param name="directory">The directory for this event.</param>
/// <param name="hasMatchingFiles">Flag indicating if directory has matching files as determined by the current filter.</param>
public void OnProcessDirectory(string directory, bool hasMatchingFiles)
{
if ( ProcessDirectory != null ) {
DirectoryEventArgs args = new DirectoryEventArgs(directory, hasMatchingFiles);
ProcessDirectory(this, args);
}
}
}
/// <summary>
/// FastZip provides facilities for creating and extracting zip files.
/// Only relative paths are supported.
/// </summary>
public class FastZip
{
/// <summary>
/// Initialize a default instance of FastZip.
/// </summary>
public FastZip()
{
this.events = null;
}
/// <summary>
/// Initialise a new instance of <see cref="FastZip"/>
/// </summary>
/// <param name="events"></param>
public FastZip(FastZipEvents events)
{
this.events = events;
}
/// <summary>
/// Defines the desired handling when overwriting files.
/// </summary>
public enum Overwrite {
/// <summary>
/// Prompt the user to confirm overwriting
/// </summary>
Prompt,
/// <summary>
/// Never overwrite files.
/// </summary>
Never,
/// <summary>
/// Always overwrite files.
/// </summary>
Always
}
/// <summary>
/// Get/set a value indicating wether empty directories should be created.
/// </summary>
public bool CreateEmptyDirectories
{
get { return createEmptyDirectories; }
set { createEmptyDirectories = value; }
}
/// <summary>
/// Delegate called when confirming overwriting of files.
/// </summary>
public delegate bool ConfirmOverwriteDelegate(string fileName);
/// <summary>
/// Create a zip file.
/// </summary>
/// <param name="zipFileName">The name of the zip file to create.</param>
/// <param name="sourceDirectory">The directory to source files from.</param>
/// <param name="recurse">True to recurse directories, false for no recursion.</param>
/// <param name="fileFilter">The file filter to apply.</param>
/// <param name="directoryFilter">The directory filter to apply.</param>
public void CreateZip(string zipFileName, string sourceDirectory, bool recurse, string fileFilter, string directoryFilter)
{
NameTransform = new ZipNameTransform(true, sourceDirectory);
this.sourceDirectory = sourceDirectory;
outputStream = new ZipOutputStream(File.Create(zipFileName));
try {
FileSystemScanner scanner = new FileSystemScanner(fileFilter, directoryFilter);
scanner.ProcessFile += new ProcessFileDelegate(ProcessFile);
if ( this.CreateEmptyDirectories ) {
scanner.ProcessDirectory += new ProcessDirectoryDelegate(ProcessDirectory);
}
scanner.Scan(sourceDirectory, recurse);
}
finally {
outputStream.Close();
}
}
/// <summary>
/// Create a zip file/archive.
/// </summary>
/// <param name="zipFileName">The name of the zip file to create.</param>
/// <param name="sourceDirectory">The directory to obtain files and directories from.</param>
/// <param name="recurse">True to recurse directories, false for no recursion.</param>
/// <param name="fileFilter">The file filter to apply.</param>
public void CreateZip(string zipFileName, string sourceDirectory, bool recurse, string fileFilter)
{
CreateZip(zipFileName, sourceDirectory, recurse, fileFilter, null);
}
/// <summary>
/// Extract the contents of a zip file.
/// </summary>
/// <param name="zipFileName">The zip file to extract from.</param>
/// <param name="targetDirectory">The directory to save extracted information in.</param>
/// <param name="fileFilter">A filter to apply to files.</param>
public void ExtractZip(string zipFileName, string targetDirectory, string fileFilter)
{
ExtractZip(zipFileName, targetDirectory, Overwrite.Always, null, fileFilter, null);
}
/// <summary>
/// Exatract the contents of a zip file.
/// </summary>
/// <param name="zipFileName">The zip file to extract from.</param>
/// <param name="targetDirectory">The directory to save extracted information in.</param>
/// <param name="overwrite">The style of <see cref="Overwrite">overwriting</see> to apply.</param>
/// <param name="confirmDelegate">A delegate to invoke when confirming overwriting.</param>
/// <param name="fileFilter">A filter to apply to files.</param>
/// <param name="directoryFilter">A filter to apply to directories.</param>
public void ExtractZip(string zipFileName, string targetDirectory,
Overwrite overwrite, ConfirmOverwriteDelegate confirmDelegate,
string fileFilter, string directoryFilter)
{
if ((overwrite == Overwrite.Prompt) && (confirmDelegate == null)) {
throw new ArgumentNullException("confirmDelegate");
}
this.overwrite = overwrite;
this.confirmDelegate = confirmDelegate;
this.targetDirectory = targetDirectory;
this.fileFilter = new NameFilter(fileFilter);
this.directoryFilter = new NameFilter(directoryFilter);
inputStream = new ZipInputStream(File.OpenRead(zipFileName));
try {
if (password != null) {
inputStream.Password = password;
}
ZipEntry entry;
while ( (entry = inputStream.GetNextEntry()) != null ) {
if ( this.directoryFilter.IsMatch(Path.GetDirectoryName(entry.Name)) && this.fileFilter.IsMatch(entry.Name) ) {
ExtractEntry(entry);
}
}
}
finally {
inputStream.Close();
}
}
void ProcessDirectory(object sender, DirectoryEventArgs e)
{
if ( !e.HasMatchingFiles && createEmptyDirectories ) {
if ( events != null ) {
events.OnProcessDirectory(e.Name, e.HasMatchingFiles);
}
if (e.Name != sourceDirectory) {
string cleanedName = nameTransform.TransformDirectory(e.Name);
ZipEntry entry = new ZipEntry(cleanedName);
outputStream.PutNextEntry(entry);
}
}
}
void ProcessFile(object sender, ScanEventArgs e)
{
if ( events != null ) {
events.OnProcessFile(e.Name);
}
string cleanedName = nameTransform.TransformFile(e.Name);
ZipEntry entry = new ZipEntry(cleanedName);
outputStream.PutNextEntry(entry);
AddFileContents(e.Name);
}
void AddFileContents(string name)
{
if ( buffer == null ) {
buffer = new byte[4096];
}
FileStream stream = File.OpenRead(name);
try {
int length;
do {
length = stream.Read(buffer, 0, buffer.Length);
outputStream.Write(buffer, 0, length);
} while ( length > 0 );
}
finally {
stream.Close();
}
}
void ExtractFileEntry(ZipEntry entry, string targetName)
{
bool proceed = true;
if ((overwrite == Overwrite.Prompt) && (confirmDelegate != null)) {
if (File.Exists(targetName) == true) {
proceed = confirmDelegate(targetName);
}
}
if ( proceed ) {
if ( events != null ) {
events.OnProcessFile(entry.Name);
}
FileStream streamWriter = File.Create(targetName);
try {
if ( buffer == null ) {
buffer = new byte[4096];
}
int size;
do {
size = inputStream.Read(buffer, 0, buffer.Length);
streamWriter.Write(buffer, 0, size);
} while (size > 0);
}
finally {
streamWriter.Close();
}
if (restoreDateTime) {
File.SetLastWriteTime(targetName, entry.DateTime);
}
}
}
bool NameIsValid(string name)
{
return name != null && name.Length > 0 && name.IndexOfAny(Path.InvalidPathChars) < 0;
}
void ExtractEntry(ZipEntry entry)
{
bool doExtraction = NameIsValid(entry.Name);
string dirName = null;
string targetName = null;
if ( doExtraction ) {
string entryFileName;
if (Path.IsPathRooted(entry.Name)) {
string workName = Path.GetPathRoot(entry.Name);
workName = entry.Name.Substring(workName.Length);
entryFileName = Path.Combine(Path.GetDirectoryName(workName), Path.GetFileName(entry.Name));
} else {
entryFileName = entry.Name;
}
targetName = Path.Combine(targetDirectory, entryFileName);
dirName = Path.GetDirectoryName(Path.GetFullPath(targetName));
doExtraction = doExtraction && (entryFileName.Length > 0);
}
if ( doExtraction && !Directory.Exists(dirName) )
{
if ( !entry.IsDirectory || this.CreateEmptyDirectories ) {
try {
Directory.CreateDirectory(dirName);
}
catch {
doExtraction = false;
}
}
}
if ( doExtraction && entry.IsFile ) {
ExtractFileEntry(entry, targetName);
}
}
/// <summary>
/// Get or set the <see cref="ZipNameTransform"> active when creating Zip files.</see>
/// </summary>
public ZipNameTransform NameTransform
{
get { return nameTransform; }
set {
if ( value == null ) {
nameTransform = new ZipNameTransform();
}
else {
nameTransform = value;
}
}
}
#region Instance Fields
byte[] buffer;
ZipOutputStream outputStream;
ZipInputStream inputStream;
string password = null;
string targetDirectory;
string sourceDirectory;
NameFilter fileFilter;
NameFilter directoryFilter;
Overwrite overwrite;
ConfirmOverwriteDelegate confirmDelegate;
bool restoreDateTime = false;
bool createEmptyDirectories = false;
FastZipEvents events;
ZipNameTransform nameTransform;
#endregion
}
}
|