Replace static ZipStrings with instances of StringCodec

Author: piksel

src/ICSharpCode.SharpZipLib/Zip/Compression/Streams/DeflaterOutputStream.cs

@@ -2,6 +2,7 @@
 using System;
 using System.IO;
 using System.Security.Cryptography;
+using System.Text;
 
 namespace ICSharpCode.SharpZipLib.Zip.Compression.Streams
 {
@@ -185,6 +186,9 @@ public string Password
 			}
 		}
 
+		/// <inheritdoc cref="StringCodec.ZipCryptoEncoding"/>
+		public Encoding ZipCryptoEncoding { get; set; } = StringCodec.DefaultZipCryptoEncoding;
+
 		/// <summary>
 		/// Encrypt a block of data
 		/// </summary>
@@ -209,7 +213,7 @@ protected void EncryptBlock(byte[] buffer, int offset, int length)
 		protected void InitializePassword(string password)
 		{
 			var pkManaged = new PkzipClassicManaged();
-			byte[] key = PkzipClassic.GenerateKeys(ZipStrings.ConvertToArray(password));
+			byte[] key = PkzipClassic.GenerateKeys(ZipCryptoEncoding.GetBytes(password));
 			cryptoTransform_ = pkManaged.CreateEncryptor(key, null);
 		}
 

src/ICSharpCode.SharpZipLib/Zip/FastZip.cs

@@ -345,6 +345,22 @@ public Deflater.CompressionLevel CompressionLevel
 			set { compressionLevel_ = value; }
 		}
 
+		/// <summary>
+		/// Reflects the opposite of the internal <see cref="StringCodec.ForceZipLegacyEncoding"/>, setting it to <c>false</c> overrides the encoding used for reading and writing zip entries
+		/// </summary>
+		public bool UseUnicode
+		{
+			get => !_stringCodec.ForceZipLegacyEncoding;
+			set => _stringCodec.ForceZipLegacyEncoding = !value;
+		}
+
+		/// <summary> Gets or sets the code page used for reading/writing zip file entries when unicode is disabled </summary>
+		public int LegacyCodePage
+		{
+			get => _stringCodec.CodePage;
+			set => _stringCodec.CodePage = value;
+		}
+
 		#endregion Properties
 
 		#region Delegates
@@ -967,6 +983,7 @@ private static bool NameIsValid(string name)
 		private INameTransform extractNameTransform_;
 		private UseZip64 useZip64_ = UseZip64.Dynamic;
 		private CompressionLevel compressionLevel_ = CompressionLevel.DEFAULT_COMPRESSION;
+		private readonly StringCodec _stringCodec = new StringCodec();
 
 		private string password_;
 

src/ICSharpCode.SharpZipLib/Zip/ZipConstants.cs

@@ -470,48 +470,5 @@ public static class ZipConstants
 		public const int ENDSIG = 'P' | ('K' << 8) | (5 << 16) | (6 << 24);
 
 		#endregion Header Signatures
-
-		/// <summary>
-		/// Default encoding used for string conversion.  0 gives the default system OEM code page.
-		/// Using the default code page isnt the full solution necessarily
-		/// there are many variable factors, codepage 850 is often a good choice for
-		/// European users, however be careful about compatability.
-		/// </summary>
-		[Obsolete("Use ZipStrings instead")]
-		public static int DefaultCodePage
-		{
-			get => ZipStrings.CodePage;
-			set => ZipStrings.CodePage = value;
-		}
-
-		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToString(byte[], int)"/></summary>
-		[Obsolete("Use ZipStrings.ConvertToString instead")]
-		public static string ConvertToString(byte[] data, int count)
-			=> ZipStrings.ConvertToString(data, count);
-
-		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToString(byte[])"/></summary>
-		[Obsolete("Use ZipStrings.ConvertToString instead")]
-		public static string ConvertToString(byte[] data)
-			=> ZipStrings.ConvertToString(data);
-
-		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToStringExt(int, byte[], int)"/></summary>
-		[Obsolete("Use ZipStrings.ConvertToStringExt instead")]
-		public static string ConvertToStringExt(int flags, byte[] data, int count)
-			=> ZipStrings.ConvertToStringExt(flags, data, count);
-
-		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToStringExt(int, byte[])"/></summary>
-		[Obsolete("Use ZipStrings.ConvertToStringExt instead")]
-		public static string ConvertToStringExt(int flags, byte[] data)
-			=> ZipStrings.ConvertToStringExt(flags, data);
-
-		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToArray(string)"/></summary>
-		[Obsolete("Use ZipStrings.ConvertToArray instead")]
-		public static byte[] ConvertToArray(string str)
-			=> ZipStrings.ConvertToArray(str);
-
-		/// <summary> Deprecated wrapper for <see cref="ZipStrings.ConvertToArray(int, string)"/></summary>
-		[Obsolete("Use ZipStrings.ConvertToArray instead")]
-		public static byte[] ConvertToArray(int flags, string str)
-			=> ZipStrings.ConvertToArray(flags, str);
 	}
 }

src/ICSharpCode.SharpZipLib/Zip/ZipEntry.cs

@@ -1,5 +1,6 @@
 using System;
 using System.IO;
+using System.Text;
 
 namespace ICSharpCode.SharpZipLib.Zip
 {
@@ -150,7 +151,7 @@ private enum Known : byte
 		/// The name passed is null
 		/// </exception>
 		public ZipEntry(string name)
-			: this(name, 0, ZipConstants.VersionMadeBy, CompressionMethod.Deflated)
+			: this(name, 0, ZipConstants.VersionMadeBy, CompressionMethod.Deflated, true)
 		{
 		}
 
@@ -171,7 +172,7 @@ public ZipEntry(string name)
 		/// </exception>
 		internal ZipEntry(string name, int versionRequiredToExtract)
 			: this(name, versionRequiredToExtract, ZipConstants.VersionMadeBy,
-			CompressionMethod.Deflated)
+			CompressionMethod.Deflated, true)
 		{
 		}
 
@@ -182,6 +183,7 @@ internal ZipEntry(string name, int versionRequiredToExtract)
 		/// <param name="madeByInfo">Version and HostSystem Information</param>
 		/// <param name="versionRequiredToExtract">Minimum required zip feature version required to extract this entry</param>
 		/// <param name="method">Compression method for this entry.</param>
+		/// <param name="unicode">Whether the entry uses unicode for name and comment</param>
 		/// <exception cref="ArgumentNullException">
 		/// The name passed is null
 		/// </exception>
@@ -193,7 +195,7 @@ internal ZipEntry(string name, int versionRequiredToExtract)
 		/// It is not generally useful, use the constructor specifying the name only.
 		/// </remarks>
 		internal ZipEntry(string name, int versionRequiredToExtract, int madeByInfo,
-			CompressionMethod method)
+			CompressionMethod method, bool unicode)
 		{
 			if (name == null)
 			{
@@ -216,7 +218,7 @@ internal ZipEntry(string name, int versionRequiredToExtract, int madeByInfo,
 			this.versionToExtract = (ushort)versionRequiredToExtract;
 			this.method = method;
 
-			IsUnicodeText = ZipStrings.UseUnicode;
+			IsUnicodeText = unicode;
 		}
 
 		/// <summary>

src/ICSharpCode.SharpZipLib/Zip/ZipEntryFactory.cs

@@ -68,7 +68,7 @@ public enum TimeSetting
 		public ZipEntryFactory()
 		{
 			nameTransform_ = new ZipNameTransform();
-			isUnicodeText_ = ZipStrings.UseUnicode;
+			isUnicodeText_ = true;
 		}
 
 		/// <summary>
@@ -162,7 +162,7 @@ public int SetAttributes
 		}
 
 		/// <summary>
-		/// Get set a value indicating whether unidoce text should be set on.
+		/// Get set a value indicating whether unicode text should be set on.
 		/// </summary>
 		public bool IsUnicodeText
 		{

src/ICSharpCode.SharpZipLib/Zip/ZipFile.cs

@@ -367,7 +367,7 @@ public string Password
 				}
 				else
 				{
-					key = PkzipClassic.GenerateKeys(ZipStrings.ConvertToArray(value));
+					key = PkzipClassic.GenerateKeys(ZipCryptoEncoding.GetBytes(value));
 				}
 
 				rawPassword_ = value;
@@ -725,6 +725,14 @@ public ZipEntry this[int index]
 			}
 		}
 
+
+		/// <inheritdoc cref="StringCodec.ZipCryptoEncoding"/>
+		public Encoding ZipCryptoEncoding
+		{
+			get => _stringCodec.ZipCryptoEncoding;
+			set => _stringCodec.ZipCryptoEncoding = value;
+		}
+
 		#endregion Properties
 
 		#region Input Handling
@@ -1191,6 +1199,8 @@ private long TestLocalHeader(ZipEntry entry, HeaderTest tests)
 						throw new ZipException(string.Format("Version required to extract this entry is invalid ({0})", extractVersion));
 					}
 
+					var localEncoding = _stringCodec.ZipInputEncoding(localFlags);
+
 					// Local entry flags dont have reserved bit set on.
 					if ((localFlags & (int)(GeneralBitFlags.ReservedPKware4 | GeneralBitFlags.ReservedPkware14 | GeneralBitFlags.ReservedPkware15)) != 0)
 					{
@@ -1283,7 +1293,7 @@ private long TestLocalHeader(ZipEntry entry, HeaderTest tests)
 					}
 
 					// Name data has already been read convert it and compare.
-					string localName = ZipStrings.ConvertToStringExt(localFlags, nameData);
+					string localName = localEncoding.GetString(nameData);
 
 					// Central directory and local entry name match
 					if (localName != entry.Name)
@@ -1581,7 +1591,7 @@ public void CommitUpdate()
 					// Create an empty archive if none existed originally.
 					if (entries_.Length == 0)
 					{
-						byte[] theComment = (newComment_ != null) ? newComment_.RawComment : ZipStrings.ConvertToArray(comment_);
+						byte[] theComment = (newComment_ != null) ? newComment_.RawComment : _stringCodec.ZipArchiveCommentEncoding.GetBytes(comment_);
 						using (ZipHelperStream zhs = new ZipHelperStream(baseStream_))
 						{
 							zhs.WriteEndOfCentralDirectory(0, 0, 0, theComment);
@@ -1619,7 +1629,7 @@ public void SetComment(string comment)
 
 			CheckUpdating();
 
-			newComment_ = new ZipString(comment);
+			newComment_ = new ZipString(comment, _stringCodec.ZipArchiveCommentEncoding);
 
 			if (newComment_.RawLength > 0xffff)
 			{
@@ -2147,7 +2157,8 @@ private void WriteLocalEntryHeader(ZipUpdate update)
 				WriteLEInt((int)entry.Size);
 			}
 
-			byte[] name = ZipStrings.ConvertToArray(entry.Flags, entry.Name);
+			var entryEncoding = _stringCodec.ZipInputEncoding(entry.Flags);
+			byte[] name = entryEncoding.GetBytes(entry.Name);
 
 			if (name.Length > 0xFFFF)
 			{
@@ -2254,7 +2265,8 @@ private int WriteCentralDirectoryHeader(ZipEntry entry)
 				WriteLEInt((int)entry.Size);
 			}
 
-			byte[] name = ZipStrings.ConvertToArray(entry.Flags, entry.Name);
+			var entryEncoding = _stringCodec.ZipInputEncoding(entry.Flags);
+			byte[] name = entryEncoding.GetBytes(entry.Name);
 
 			if (name.Length > 0xFFFF)
 			{
@@ -3081,7 +3093,7 @@ private void RunUpdates()
 					}
 				}
 
-				byte[] theComment = (newComment_ != null) ? newComment_.RawComment : ZipStrings.ConvertToArray(comment_);
+				byte[] theComment = newComment_?.RawComment ?? _stringCodec.ZipArchiveCommentEncoding.GetBytes(comment_);
 				using (ZipHelperStream zhs = new ZipHelperStream(workFile.baseStream_))
 				{
 					zhs.WriteEndOfCentralDirectory(updateCount_, sizeEntries, centralDirOffset, theComment);
@@ -3481,7 +3493,7 @@ private void ReadEntries()
 				byte[] comment = new byte[commentSize];
 
 				StreamUtils.ReadFully(baseStream_, comment);
-				comment_ = ZipStrings.ConvertToString(comment);
+				comment_ = _stringCodec.ZipArchiveCommentEncoding.GetString(comment);
 			}
 			else
 			{
@@ -3598,11 +3610,13 @@ private void ReadEntries()
 				long offset = ReadLEUint();
 
 				byte[] buffer = new byte[Math.Max(nameLen, commentLen)];
+				var entryEncoding = _stringCodec.ZipInputEncoding(bitFlags);
 
 				StreamUtils.ReadFully(baseStream_, buffer, 0, nameLen);
-				string name = ZipStrings.ConvertToStringExt(bitFlags, buffer, nameLen);
+				string name = entryEncoding.GetString(buffer, 0, nameLen);
+				var unicode = entryEncoding.IsZipUnicode();
 
-				var entry = new ZipEntry(name, versionToExtract, versionMadeBy, (CompressionMethod)method)
+				var entry = new ZipEntry(name, versionToExtract, versionMadeBy, (CompressionMethod)method, unicode)
 				{
 					Crc = crc & 0xffffffffL,
 					Size = size & 0xffffffffL,
@@ -3635,7 +3649,7 @@ private void ReadEntries()
 				if (commentLen > 0)
 				{
 					StreamUtils.ReadFully(baseStream_, buffer, 0, commentLen);
-					entry.Comment = ZipStrings.ConvertToStringExt(bitFlags, buffer, commentLen);
+					entry.Comment = entryEncoding.GetString(buffer, 0, commentLen);
 				}
 
 				entries_[i] = entry;
@@ -3787,6 +3801,7 @@ private static void WriteEncryptionHeader(Stream stream, long crcValue)
 		private ZipEntry[] entries_;
 		private byte[] key;
 		private bool isNewArchive_;
+		private readonly StringCodec _stringCodec = new StringCodec();
 
 		// Default is dynamic which is not backwards compatible and can cause problems
 		// with XP's built in compression which cant read Zip64 archives.
@@ -3825,19 +3840,23 @@ private class ZipString
 			/// Initialise a <see cref="ZipString"/> with a string.
 			/// </summary>
 			/// <param name="comment">The textual string form.</param>
-			public ZipString(string comment)
+			/// <param name="encoding"></param>
+			public ZipString(string comment, Encoding encoding)
 			{
 				comment_ = comment;
 				isSourceString_ = true;
+				_encoding = encoding;
 			}
 
 			/// <summary>
 			/// Initialise a <see cref="ZipString"/> using a string in its binary 'raw' form.
 			/// </summary>
 			/// <param name="rawString"></param>
-			public ZipString(byte[] rawString)
+			/// <param name="encoding"></param>
+			public ZipString(byte[] rawString, Encoding encoding)
 			{
 				rawComment_ = rawString;
+				_encoding = encoding;
 			}
 
 			#endregion Constructors
@@ -3846,10 +3865,7 @@ public ZipString(byte[] rawString)
 			/// Get a value indicating the original source of data for this instance.
 			/// True if the source was a string; false if the source was binary data.
 			/// </summary>
-			public bool IsSourceString
-			{
-				get { return isSourceString_; }
-			}
+			public bool IsSourceString => isSourceString_;
 
 			/// <summary>
 			/// Get the length of the comment when represented as raw bytes.
@@ -3894,15 +3910,15 @@ private void MakeTextAvailable()
 			{
 				if (comment_ == null)
 				{
-					comment_ = ZipStrings.ConvertToString(rawComment_);
+					comment_ = _encoding.GetString(rawComment_);
 				}
 			}
 
 			private void MakeBytesAvailable()
 			{
 				if (rawComment_ == null)
 				{
-					rawComment_ = ZipStrings.ConvertToArray(comment_);
+					rawComment_ = _encoding.GetBytes(comment_);
 				}
 			}
 
@@ -3911,7 +3927,7 @@ private void MakeBytesAvailable()
 			/// </summary>
 			/// <param name="zipString">The <see cref="ZipString"/> to convert to a string.</param>
 			/// <returns>The textual equivalent for the input value.</returns>
-			static public implicit operator string(ZipString zipString)
+			public static implicit operator string(ZipString zipString)
 			{
 				zipString.MakeTextAvailable();
 				return zipString.comment_;
@@ -3922,6 +3938,7 @@ static public implicit operator string(ZipString zipString)
 			private string comment_;
 			private byte[] rawComment_;
 			private readonly bool isSourceString_;
+			private readonly Encoding _encoding;
 
 			#endregion Instance Fields
 		}

src/ICSharpCode.SharpZipLib/Zip/ZipHelperStream.cs

@@ -236,7 +236,9 @@ private void WriteLocalHeader(ZipEntry entry, EntryPatchData patchData)
 				}
 			}
 
-			byte[] name = ZipStrings.ConvertToArray(entry.Flags, entry.Name);
+			// TODO: This should be class instanced if used!
+			var stringCodec = new StringCodec();
+			byte[] name = stringCodec.ZipInputEncoding(entry.Flags).GetBytes(entry.Name);
 
 			if (name.Length > 0xFFFF)
 			{