5 // Martin Baulig <martin.baulig@xamarin.com>
6 // Joao Matos <joao.matos@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;
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 Dictionary<string, ZipArchiveEntry> entries;
43 internal ZipFile zipFile;
45 public ZipArchive (Stream stream)
48 throw new ArgumentNullException("stream");
51 mode = ZipArchiveMode.Read;
52 CreateZip(stream, mode);
55 public ZipArchive (Stream stream, ZipArchiveMode mode)
58 throw new ArgumentNullException("stream");
62 CreateZip(stream, mode);
65 public ZipArchive (Stream stream, ZipArchiveMode mode, bool leaveOpen)
68 throw new ArgumentNullException("stream");
72 this.leaveStreamOpen = leaveOpen;
73 CreateZip(stream, mode);
76 public ZipArchive (Stream stream, ZipArchiveMode mode, bool leaveOpen, Encoding entryNameEncoding)
79 throw new ArgumentNullException("stream");
83 this.leaveStreamOpen = leaveOpen;
84 this.entryNameEncoding = entryNameEncoding;
85 CreateZip(stream, mode);
88 private void CreateZip(Stream stream, ZipArchiveMode mode)
90 if (mode != ZipArchiveMode.Read && mode != ZipArchiveMode.Create && mode != ZipArchiveMode.Update)
91 throw new ArgumentOutOfRangeException("mode");
93 // If the mode parameter is set to Read, the stream must support reading.
94 if (mode == ZipArchiveMode.Read && !stream.CanRead)
95 throw new ArgumentException("Stream must support reading for Read archive mode");
97 // If the mode parameter is set to Create, the stream must support writing.
98 if (mode == ZipArchiveMode.Create && !stream.CanWrite)
99 throw new ArgumentException("Stream must support writing for Create archive mode");
101 // If the mode parameter is set to Update, the stream must support reading, writing, and seeking.
102 if (mode == ZipArchiveMode.Update && (!stream.CanRead || !stream.CanWrite || !stream.CanSeek))
103 throw new ArgumentException("Stream must support reading, writing and seeking for Update archive mode");
106 zipFile = new ZipFile(stream, (mode != ZipArchiveMode.Read) ? stream : null, leaveStreamOpen,
109 if (stream.Length != 0) {
110 zipFile.FullScan = true;
111 zipFile.ReadToInstance();
114 if (mode == ZipArchiveMode.Create)
116 } catch (Exception) {
117 throw new InvalidDataException("The contents of the stream are not in the zip archive format.");
120 entries = new Dictionary<string, ZipArchiveEntry>();
121 if (Mode != ZipArchiveMode.Create) {
122 foreach (var entry in zipFile.Entries) {
123 var zipEntry = new ZipArchiveEntry(this, entry);
124 entries[entry.FileName] = zipEntry;
129 public ReadOnlyCollection<ZipArchiveEntry> Entries {
132 throw new ObjectDisposedException("The zip archive has been disposed.");
134 if (Mode == ZipArchiveMode.Create)
135 throw new NotSupportedException("Cannot access entries in Create mode.");
138 throw new InvalidDataException("The zip archive is corrupt, and its entries cannot be retrieved.");
141 return new ReadOnlyCollection<ZipArchiveEntry>(new List<ZipArchiveEntry>());
143 return new ReadOnlyCollection<ZipArchiveEntry>(entries.Values.ToList());
147 public ZipArchiveMode Mode {
150 throw new ObjectDisposedException("The zip archive has been disposed.");
156 public ZipArchiveEntry CreateEntry (string entryName)
159 throw new ObjectDisposedException("The zip archive has been disposed.");
161 return CreateEntry(entryName, CompressionLevel.Optimal);
164 public ZipArchiveEntry CreateEntry (string entryName,
165 CompressionLevel compressionLevel)
168 throw new ObjectDisposedException("The zip archive has been disposed.");
170 if (entryName == string.Empty)
171 throw new ArgumentException("Entry name cannot be empty.");
173 if (entryName == null)
174 throw new ArgumentNullException("entryName");
176 if (mode != ZipArchiveMode.Create && mode != ZipArchiveMode.Update)
177 throw new NotSupportedException("The zip archive does not support writing.");
180 throw new InvalidDataException("The zip archive is corrupt, and its entries cannot be retrieved.");
182 var memoryStream = new MemoryStream();
183 var entry = zipFile.AddEntry(entryName, memoryStream);
184 var archiveEntry = new ZipArchiveEntry(this, entry);
185 entries[entryName] = archiveEntry;
190 public ZipArchiveEntry GetEntry (string entryName)
193 throw new ObjectDisposedException("The zip archive has been disposed.");
195 if (entryName == string.Empty)
196 throw new ArgumentException("Entry name cannot be empty.");
198 if (entryName == null)
199 throw new ArgumentNullException("entryName");
201 if (mode != ZipArchiveMode.Read && mode != ZipArchiveMode.Update)
202 throw new NotSupportedException("The zip archive does not support reading.");
205 throw new InvalidDataException("The zip archive is corrupt, and its entries cannot be retrieved.");
207 return entries.ContainsKey(entryName) ? entries[entryName] : null;
212 // We save to a memory stream first because Ionic does not deal well
213 // with saving to a file that has previously been open before.
214 using (var newZip = new MemoryStream()) {
215 zipFile.Save(newZip);
219 newZip.CopyTo(stream);
223 protected virtual void Dispose (bool disposing)
228 if (mode != ZipArchiveMode.Read)
236 if (stream != null) {
242 public void Dispose ()
245 GC.SuppressFinalize(this);