5 // Joao Matos <joao.matos@xamarin.com>
6 // Martin Baulig <martin.baulig@xamarin.com>
8 // Copyright (c) 2013 Xamarin Inc. (http://www.xamarin.com)
10 // Permission is hereby granted, free of charge, to any person obtaining a copy
11 // of this software and associated documentation files (the "Software"), to deal
12 // in the Software without restriction, including without limitation the rights
13 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 // copies of the Software, and to permit persons to whom the Software is
15 // furnished to do so, subject to the following conditions:
17 // The above copyright notice and this permission notice shall be included in
18 // all copies or substantial portions of the Software.
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 using System.Collections.Generic;
28 using System.Collections.ObjectModel;
31 using SharpCompress.Common;
33 namespace System.IO.Compression
35 public class ZipArchive : IDisposable
37 internal Stream stream;
38 internal readonly bool leaveStreamOpen;
39 internal readonly ZipArchiveMode mode;
40 internal Encoding entryNameEncoding;
41 internal bool disposed;
42 internal List<ZipArchiveEntry> entries;
43 internal SharpCompress.Archive.Zip.ZipArchive zipFile;
45 public ZipArchive (Stream stream)
48 throw new ArgumentNullException("stream");
51 mode = ZipArchiveMode.Read;
55 public ZipArchive (Stream stream, ZipArchiveMode mode)
58 throw new ArgumentNullException("stream");
65 public ZipArchive (Stream stream, ZipArchiveMode mode, bool leaveOpen)
68 throw new ArgumentNullException("stream");
72 leaveStreamOpen = leaveOpen;
76 public ZipArchive (Stream stream, ZipArchiveMode mode, bool leaveOpen, Encoding entryNameEncoding)
79 throw new ArgumentNullException("stream");
83 leaveStreamOpen = leaveOpen;
84 this.entryNameEncoding = entryNameEncoding;
88 private void CreateZip(ZipArchiveMode mode)
91 if (mode != ZipArchiveMode.Read && mode != ZipArchiveMode.Create && mode != ZipArchiveMode.Update)
92 throw new ArgumentOutOfRangeException("mode");
94 // If the mode parameter is set to Read, the stream must support reading.
95 if (mode == ZipArchiveMode.Read && !stream.CanRead)
96 throw new ArgumentException("Stream must support reading for Read archive mode");
98 // If the mode parameter is set to Create, the stream must support writing.
99 if (mode == ZipArchiveMode.Create && !stream.CanWrite)
100 throw new ArgumentException("Stream must support writing for Create archive mode");
102 // If the mode parameter is set to Update, the stream must support reading, writing, and seeking.
103 if (mode == ZipArchiveMode.Update && (!stream.CanRead || !stream.CanWrite || !stream.CanSeek))
104 throw new ArgumentException("Stream must support reading, writing and seeking for Update archive mode");
106 // If the stream is not seekable, then buffer it into memory (same behavior as .NET).
107 if (mode == ZipArchiveMode.Read && !stream.CanSeek)
109 var memoryStream = new MemoryStream();
110 stream.CopyTo(memoryStream);
112 if (!leaveStreamOpen)
115 this.stream = memoryStream;
119 zipFile = mode != ZipArchiveMode.Create && stream.Length != 0
120 ? SharpCompress.Archive.Zip.ZipArchive.Open(stream)
121 : SharpCompress.Archive.Zip.ZipArchive.Create();
122 } catch (Exception e) {
123 throw new InvalidDataException("The contents of the stream are not in the zip archive format.", e);
126 entries = new List<ZipArchiveEntry>();
127 if (Mode != ZipArchiveMode.Create) {
128 foreach (var entry in zipFile.Entries) {
129 var zipEntry = new ZipArchiveEntry(this, entry);
130 entries.Add(zipEntry);
135 if (!leaveStreamOpen)
141 public ReadOnlyCollection<ZipArchiveEntry> Entries {
144 throw new ObjectDisposedException("The zip archive has been disposed.");
146 if (Mode == ZipArchiveMode.Create)
147 throw new NotSupportedException("Cannot access entries in Create mode.");
150 throw new InvalidDataException("The zip archive is corrupt, and its entries cannot be retrieved.");
153 return new ReadOnlyCollection<ZipArchiveEntry>(new List<ZipArchiveEntry>());
155 return new ReadOnlyCollection<ZipArchiveEntry>(entries);
159 public ZipArchiveMode Mode {
162 throw new ObjectDisposedException("The zip archive has been disposed.");
168 public ZipArchiveEntry CreateEntry (string entryName)
171 throw new ObjectDisposedException("The zip archive has been disposed.");
173 return CreateEntry(entryName, CompressionLevel.Optimal);
176 internal SharpCompress.Archive.Zip.ZipArchiveEntry CreateEntryInternal(string entryName)
178 var memoryStream = new MemoryStream();
179 var entry = zipFile.AddEntry(entryName, memoryStream);
184 public ZipArchiveEntry CreateEntry (string entryName, CompressionLevel compressionLevel)
187 throw new ObjectDisposedException("The zip archive has been disposed.");
189 if (entryName == string.Empty)
190 throw new ArgumentException("Entry name cannot be empty.");
192 if (entryName == null)
193 throw new ArgumentNullException("entryName");
195 if (mode != ZipArchiveMode.Create && mode != ZipArchiveMode.Update)
196 throw new NotSupportedException("The zip archive does not support writing.");
199 throw new InvalidDataException("The zip archive is corrupt, and its entries cannot be retrieved.");
201 var internalEntry = CreateEntryInternal(entryName);
202 var archiveEntry = new ZipArchiveEntry(this, internalEntry);
203 entries.Add(archiveEntry);
208 public ZipArchiveEntry GetEntry (string entryName)
211 throw new ObjectDisposedException("The zip archive has been disposed.");
213 if (entryName == string.Empty)
214 throw new ArgumentException("Entry name cannot be empty.");
216 if (entryName == null)
217 throw new ArgumentNullException("entryName");
219 if (mode != ZipArchiveMode.Read && mode != ZipArchiveMode.Update)
220 throw new NotSupportedException("The zip archive does not support reading.");
223 throw new InvalidDataException("The zip archive is corrupt, and its entries cannot be retrieved.");
225 return entries.FirstOrDefault(e => e.FullName == entryName);
230 using (var newZip = new MemoryStream()) {
231 zipFile.SaveTo(newZip, CompressionType.Deflate, entryNameEncoding ?? Encoding.UTF8);
236 newZip.CopyTo(stream);
240 internal void RemoveEntryInternal(ZipArchiveEntry entry)
242 zipFile.RemoveEntry(entry.entry);
243 entries.Remove(entry);
246 protected virtual void Dispose (bool disposing)
251 if (mode != ZipArchiveMode.Read)
259 if (stream != null) {
265 public void Dispose ()
268 GC.SuppressFinalize(this);