using System; using System.Text.RegularExpressions; using SabreTools.Library.Data; using SabreTools.Library.FileTypes; using SabreTools.Library.Items; #if MONO using System.IO; #else using Alphaleonis.Win32.Filesystem; using BinaryReader = System.IO.BinaryReader; using SeekOrigin = System.IO.SeekOrigin; using Stream = System.IO.Stream; #endif using SharpCompress.Common; namespace SabreTools.Library.Tools { /// /// Tools for working with archives /// /// /// TODO: Full archive support for: RAR, LRZip, ZPAQ?, Zstd?, LZ4? /// ZPAQ: https://github.com/zpaq/zpaq - In progress as external DLL /// Zstd: https://github.com/skbkontur/ZstdNet /// LZ4: https://github.com/lz4/lz4 /// public static class ArchiveTools { #region Factory /// /// Create an archive of the specified type, if possible /// /// Name of the file to create the archive from /// Archive object representing the inputs public static BaseArchive CreateArchiveFromExistingInput(string input) { BaseArchive archive = null; // First get the archive type ArchiveType? at = GetCurrentArchiveType(input); // If we got back null, then it's not an archive, so we we return if (at == null) { return archive; } // Create the archive based on the type Globals.Logger.Verbose("Found archive of type: {0}", at); switch (at) { case ArchiveType.GZip: archive = new GZipArchive(input); break; case ArchiveType.Rar: archive = new RarArchive(input); break; case ArchiveType.SevenZip: archive = new SevenZipArchive(input); break; case ArchiveType.Tar: archive = new TapeArchive(input); break; case ArchiveType.Zip: archive = new TorrentZipArchive(input); break; } return archive; } /// /// Create an archive of the specified type, if possible /// /// SharpCompress.Common.ArchiveType representing the archive to create /// Archive object representing the inputs public static BaseArchive CreateArchiveFromArchiveType(ArchiveType archiveType) { switch(archiveType) { case ArchiveType.GZip: return new GZipArchive(); case ArchiveType.Rar: return new RarArchive(); case ArchiveType.SevenZip: return new SevenZipArchive(); case ArchiveType.Tar: return new TapeArchive(); case ArchiveType.Zip: return new TorrentZipArchive(); default: return null; } } /// /// Create an archive of the specified type, if possible /// /// SabreTools.Library.Data.SharpCompress.OutputFormat representing the archive to create /// Archive object representing the inputs public static BaseArchive CreateArchiveFromOutputFormat(OutputFormat outputFormat) { switch (outputFormat) { case OutputFormat.Folder: return new Folder(); case OutputFormat.TapeArchive: return new TapeArchive(); case OutputFormat.Torrent7Zip: return new SevenZipArchive(); case OutputFormat.TorrentGzip: return new GZipArchive(); case OutputFormat.TorrentLrzip: return new LRZArchive(); case OutputFormat.TorrentRar: return new RarArchive(); case OutputFormat.TorrentXZ: return new XZArchive(); case OutputFormat.TorrentZip: return new TorrentZipArchive(); default: return null; } } #endregion #region Information /// /// Retrieve file information for a single torrent GZ file /// /// Filename to get information from /// Populated DatItem object if success, empty one on error public static Rom GetTorrentGZFileInfo(string input) { // Check for the file existing first if (!File.Exists(input)) { return null; } string datum = Path.GetFileName(input).ToLowerInvariant(); long filesize = new FileInfo(input).Length; // If we have the romba depot files, just skip them gracefully if (datum == ".romba_size" || datum == ".romba_size.backup") { Globals.Logger.Verbose("Romba depot file found, skipping: {0}", input); return null; } // Check if the name is the right length if (!Regex.IsMatch(datum, @"^[0-9a-f]{" + Constants.SHA1Length + @"}\.gz")) // TODO: When updating to SHA-256, this needs to update to Constants.SHA256Length { Globals.Logger.Warning("Non SHA-1 filename found, skipping: '{0}'", Path.GetFullPath(input)); return null; } // Check if the file is at least the minimum length if (filesize < 40 /* bytes */) { Globals.Logger.Warning("Possibly corrupt file '{0}' with size {1}", Path.GetFullPath(input), Style.GetBytesReadable(filesize)); return null; } // Get the Romba-specific header data byte[] header; // Get preamble header for checking byte[] headermd5; // MD5 byte[] headercrc; // CRC ulong headersz; // Int64 size BinaryReader br = new BinaryReader(FileTools.TryOpenRead(input)); header = br.ReadBytes(12); headermd5 = br.ReadBytes(16); headercrc = br.ReadBytes(4); headersz = br.ReadUInt64(); br.Dispose(); // If the header is not correct, return a blank rom bool correct = true; for (int i = 0; i < header.Length; i++) { // This is a temp fix to ignore the modification time and OS until romba can be fixed if (i == 4 || i == 5 || i == 6 || i == 7 || i == 9) { continue; } correct &= (header[i] == Constants.TorrentGZHeader[i]); } if (!correct) { return null; } // Now convert the data and get the right position string gzmd5 = BitConverter.ToString(headermd5).Replace("-", string.Empty); string gzcrc = BitConverter.ToString(headercrc).Replace("-", string.Empty); long extractedsize = (long)headersz; Rom rom = new Rom { Type = ItemType.Rom, Name = Path.GetFileNameWithoutExtension(input).ToLowerInvariant(), Size = extractedsize, CRC = gzcrc.ToLowerInvariant(), MD5 = gzmd5.ToLowerInvariant(), SHA1 = Path.GetFileNameWithoutExtension(input).ToLowerInvariant(), // TODO: When updating to SHA-256, this needs to update to SHA256 MachineName = Path.GetFileNameWithoutExtension(input).ToLowerInvariant(), }; return rom; } /// /// Returns the archive type of an input file /// /// Input file to check /// ArchiveType of inputted file (null on error) public static ArchiveType? GetCurrentArchiveType(string input) { ArchiveType? outtype = null; // If the file is null, then we have no archive type if (input == null) { return outtype; } // First line of defense is going to be the extension, for better or worse string ext = Path.GetExtension(input).ToLowerInvariant(); if (ext.StartsWith(".")) { ext = ext.Substring(1); } if (ext != "7z" && ext != "gz" && ext != "lzma" && ext != "rar" && ext != "rev" && ext != "r00" && ext != "r01" && ext != "tar" && ext != "tgz" && ext != "tlz" && ext != "zip" && ext != "zipx") { return outtype; } // Read the first bytes of the file and get the magic number try { byte[] magic = new byte[8]; BinaryReader br = new BinaryReader(FileTools.TryOpenRead(input)); magic = br.ReadBytes(8); br.Dispose(); // Convert it to an uppercase string string mstr = string.Empty; for (int i = 0; i < magic.Length; i++) { mstr += BitConverter.ToString(new byte[] { magic[i] }); } mstr = mstr.ToUpperInvariant(); // Now try to match it to a known signature if (mstr.StartsWith(Constants.SevenZipSig)) { outtype = ArchiveType.SevenZip; } else if (mstr.StartsWith(Constants.GzSig)) { outtype = ArchiveType.GZip; } else if (mstr.StartsWith(Constants.RarSig) || mstr.StartsWith(Constants.RarFiveSig)) { outtype = ArchiveType.Rar; } else if (mstr.StartsWith(Constants.TarSig) || mstr.StartsWith(Constants.TarZeroSig)) { outtype = ArchiveType.Tar; } else if (mstr.StartsWith(Constants.ZipSig) || mstr.StartsWith(Constants.ZipSigEmpty) || mstr.StartsWith(Constants.ZipSigSpanned)) { outtype = ArchiveType.Zip; } } catch (Exception) { // Don't log file open errors } return outtype; } /// /// Get if the current file should be scanned internally and externally /// /// Name of the input file to check /// ArchiveScanLevel representing the archive handling levels /// Output parameter determining if file should be processed externally /// Output parameter determining if file should be processed internally public static void GetInternalExternalProcess(string input, ArchiveScanLevel archiveScanLevel, out bool shouldExternalProcess, out bool shouldInternalProcess) { shouldExternalProcess = true; shouldInternalProcess = true; ArchiveType? archiveType = GetCurrentArchiveType(input); switch (archiveType) { case null: shouldExternalProcess = true; shouldInternalProcess = false; break; case ArchiveType.GZip: shouldExternalProcess = ((archiveScanLevel & ArchiveScanLevel.GZipExternal) != 0); shouldInternalProcess = ((archiveScanLevel & ArchiveScanLevel.GZipInternal) != 0); break; case ArchiveType.Rar: shouldExternalProcess = ((archiveScanLevel & ArchiveScanLevel.RarExternal) != 0); shouldInternalProcess = ((archiveScanLevel & ArchiveScanLevel.RarInternal) != 0); break; case ArchiveType.SevenZip: shouldExternalProcess = ((archiveScanLevel & ArchiveScanLevel.SevenZipExternal) != 0); shouldInternalProcess = ((archiveScanLevel & ArchiveScanLevel.SevenZipInternal) != 0); break; case ArchiveType.Zip: shouldExternalProcess = ((archiveScanLevel & ArchiveScanLevel.ZipExternal) != 0); shouldInternalProcess = ((archiveScanLevel & ArchiveScanLevel.ZipInternal) != 0); break; } } /// /// Get the archive scan level based on the inputs /// /// User-defined scan level for 7z archives /// User-defined scan level for GZ archives /// User-defined scan level for RAR archives /// User-defined scan level for Zip archives /// ArchiveScanLevel representing the levels public static ArchiveScanLevel GetArchiveScanLevelFromNumbers(int sevenzip, int gzip, int rar, int zip) { ArchiveScanLevel archiveScanLevel = 0x0000; // 7z sevenzip = (sevenzip < 0 || sevenzip > 2 ? 0 : sevenzip); switch (sevenzip) { case 0: archiveScanLevel |= ArchiveScanLevel.SevenZipBoth; break; case 1: archiveScanLevel |= ArchiveScanLevel.SevenZipInternal; break; case 2: archiveScanLevel |= ArchiveScanLevel.SevenZipExternal; break; } // GZip gzip = (gzip < 0 || gzip > 2 ? 0 : gzip); switch (gzip) { case 0: archiveScanLevel |= ArchiveScanLevel.GZipBoth; break; case 1: archiveScanLevel |= ArchiveScanLevel.GZipInternal; break; case 2: archiveScanLevel |= ArchiveScanLevel.GZipExternal; break; } // RAR rar = (rar < 0 || rar > 2 ? 0 : rar); switch (rar) { case 0: archiveScanLevel |= ArchiveScanLevel.RarBoth; break; case 1: archiveScanLevel |= ArchiveScanLevel.RarInternal; break; case 2: archiveScanLevel |= ArchiveScanLevel.RarExternal; break; } // Zip zip = (zip < 0 || zip > 2 ? 0 : zip); switch (zip) { case 0: archiveScanLevel |= ArchiveScanLevel.ZipBoth; break; case 1: archiveScanLevel |= ArchiveScanLevel.ZipInternal; break; case 2: archiveScanLevel |= ArchiveScanLevel.ZipExternal; break; } return archiveScanLevel; } /// /// (INCOMPLETE) Retrieve file information for a RAR file /// /// Filename to get information from public static void GetRarFileInfo(string input) { if (!File.Exists(input)) { return; } BinaryReader br = new BinaryReader(FileTools.TryOpenRead(input)); // Check for the signature first (Skipping the SFX Module) byte[] signature = br.ReadBytes(8); int startpos = 0; while (startpos < Constants.MibiByte && BitConverter.ToString(signature, 0, 7) != Constants.RarSig && BitConverter.ToString(signature) != Constants.RarFiveSig) { startpos++; br.BaseStream.Position = startpos; signature = br.ReadBytes(8); } if (BitConverter.ToString(signature, 0, 7) != Constants.RarSig && BitConverter.ToString(signature) != Constants.RarFiveSig) { return; } CoreRarArchive cra = new CoreRarArchive(); if (startpos > 0) { br.BaseStream.Position = 0; cra.SFX = br.ReadBytes(startpos); } // Get all archive header information cra.HeaderCRC32 = br.ReadUInt32(); cra.HeaderSize = br.ReadUInt32(); uint headerType = br.ReadUInt32(); // Special encryption information bool hasEncryptionHeader = false; // If it's encrypted if (headerType == (uint)RarHeaderType.ArchiveEncryption) { hasEncryptionHeader = true; cra.EncryptionHeaderCRC32 = cra.HeaderCRC32; cra.EncryptionHeaderSize = cra.HeaderSize; cra.EncryptionHeaderFlags = (RarHeaderFlags)br.ReadUInt32(); cra.EncryptionVersion = br.ReadUInt32(); cra.EncryptionFlags = br.ReadUInt32(); cra.KDFCount = br.ReadByte(); cra.Salt = br.ReadBytes(16); cra.CheckValue = br.ReadBytes(12); cra.HeaderCRC32 = br.ReadUInt32(); cra.HeaderSize = br.ReadUInt32(); headerType = br.ReadUInt32(); } cra.HeaderFlags = (RarHeaderFlags)br.ReadUInt32(); if ((cra.HeaderFlags & RarHeaderFlags.ExtraAreaPresent) != 0) { cra.ExtraAreaSize = br.ReadUInt32(); } cra.ArchiveFlags = (RarArchiveFlags)br.ReadUInt32(); if ((cra.ArchiveFlags & RarArchiveFlags.VolumeNumberField) != 0) { cra.VolumeNumber = br.ReadUInt32(); } if (((cra.HeaderFlags & RarHeaderFlags.ExtraAreaPresent) != 0) && cra.ExtraAreaSize != 0) { cra.ExtraArea = br.ReadBytes((int)cra.ExtraAreaSize); } // Archive Comment Service Header // Now for file headers for (;;) { CoreRarArchiveEntry crae = new CoreRarArchiveEntry(); crae.HeaderCRC32 = br.ReadUInt32(); crae.HeaderSize = br.ReadUInt32(); crae.HeaderType = (RarHeaderType)br.ReadUInt32(); if (crae.HeaderType == RarHeaderType.EndOfArchive) { break; } crae.HeaderFlags = (RarHeaderFlags)br.ReadUInt32(); if ((crae.HeaderFlags & RarHeaderFlags.ExtraAreaPresent) != 0) { crae.ExtraAreaSize = br.ReadUInt32(); } if ((crae.HeaderFlags & RarHeaderFlags.DataAreaPresent) != 0) { crae.DataAreaSize = br.ReadUInt32(); } crae.FileFlags = (RarFileFlags)br.ReadUInt32(); crae.UnpackedSize = br.ReadUInt32(); if ((crae.FileFlags & RarFileFlags.UnpackedSizeUnknown) != 0) { crae.UnpackedSize = 0; } crae.Attributes = br.ReadUInt32(); crae.mtime = br.ReadUInt32(); crae.DataCRC32 = br.ReadUInt32(); crae.CompressionInformation = br.ReadUInt32(); crae.HostOS = br.ReadUInt32(); crae.NameLength = br.ReadUInt32(); crae.Name = br.ReadBytes((int)crae.NameLength); if ((crae.HeaderFlags & RarHeaderFlags.ExtraAreaPresent) != 0) { uint extraSize = br.ReadUInt32(); switch (br.ReadUInt32()) // Extra Area Type { case 0x01: // File encryption information crae.EncryptionSize = extraSize; crae.EncryptionFlags = (RarEncryptionFlags)br.ReadUInt32(); crae.KDFCount = br.ReadByte(); crae.Salt = br.ReadBytes(16); crae.IV = br.ReadBytes(16); crae.CheckValue = br.ReadBytes(12); break; case 0x02: // File data hash crae.HashSize = extraSize; crae.HashType = br.ReadUInt32(); crae.HashData = br.ReadBytes(32); break; case 0x03: // High precision file time crae.TimeSize = extraSize; crae.TimeFlags = (RarTimeFlags)br.ReadUInt32(); if ((crae.TimeFlags & RarTimeFlags.TimeInUnixFormat) != 0) { if ((crae.TimeFlags & RarTimeFlags.ModificationTimePresent) != 0) { crae.TimeMtime64 = br.ReadUInt64(); } if ((crae.TimeFlags & RarTimeFlags.CreationTimePresent) != 0) { crae.TimeCtime64 = br.ReadUInt64(); } if ((crae.TimeFlags & RarTimeFlags.LastAccessTimePresent) != 0) { crae.TimeLtime64 = br.ReadUInt64(); } } else { if ((crae.TimeFlags & RarTimeFlags.ModificationTimePresent) != 0) { crae.TimeMtime = br.ReadUInt32(); } if ((crae.TimeFlags & RarTimeFlags.CreationTimePresent) != 0) { crae.TimeCtime = br.ReadUInt32(); } if ((crae.TimeFlags & RarTimeFlags.LastAccessTimePresent) != 0) { crae.TimeLtime = br.ReadUInt32(); } } break; case 0x04: // File version number crae.VersionSize = extraSize; /* crae.VersionFlags = */ br.ReadUInt32(); crae.VersionNumber = br.ReadUInt32(); break; case 0x05: // File system redirection crae.RedirectionSize = extraSize; crae.RedirectionType = (RarRedirectionType)br.ReadUInt32(); crae.RedirectionFlags = br.ReadUInt32(); crae.RedirectionNameLength = br.ReadUInt32(); crae.RedirectionName = br.ReadBytes((int)crae.RedirectionNameLength); break; case 0x06: // Unix owner and group information crae.UnixOwnerSize = extraSize; crae.UnixOwnerFlags = (RarUnixOwnerRecordFlags)br.ReadUInt32(); if ((crae.UnixOwnerFlags & RarUnixOwnerRecordFlags.UserNameStringIsPresent) != 0) { crae.UnixOwnerUserNameLength = br.ReadUInt32(); crae.UnixOwnerUserName = br.ReadBytes((int)crae.UnixOwnerUserNameLength); } if ((crae.UnixOwnerFlags & RarUnixOwnerRecordFlags.GroupNameStringIsPresent) != 0) { crae.UnixOwnerGroupNameLength = br.ReadUInt32(); crae.UnixOwnerGroupName = br.ReadBytes((int)crae.UnixOwnerGroupNameLength); } if ((crae.UnixOwnerFlags & RarUnixOwnerRecordFlags.NumericUserIdIsPresent) != 0) { crae.UnixOwnerUserId = br.ReadUInt32(); } if ((crae.UnixOwnerFlags & RarUnixOwnerRecordFlags.NumericGroupIdIsPresent) != 0) { crae.UnixOwnerGroupId = br.ReadUInt32(); } break; case 0x07: // Service header data array break; } } if ((crae.HeaderFlags & RarHeaderFlags.DataAreaPresent) != 0) { crae.DataArea = br.ReadBytes((int)crae.DataAreaSize); } } } /// /// (INCOMPLETE) Get the T7Z status of the file /// /// Name of the file to check /// 0 if the file isn't 7z, 1 if the file is t7z, 2 if the file is 7z public static int IsT7z(string filename) { int ist7z = 0; if (File.Exists(filename)) { try { Stream fread = FileTools.TryOpenRead(filename); uint ar, offs = 0; fread.Seek(0, SeekOrigin.Begin); byte[] buffer = new byte[128]; ar = (uint)fread.Read(buffer, 0, 4 + Constants.Torrent7ZipSignature.Length + 4); if (ar < (4 + Constants.Torrent7ZipSignature.Length + 4)) { if (ar >= Constants.Torrent7ZipSignature.Length + 4) { ar -= (uint)(Constants.Torrent7ZipSignature.Length + 4); } if (ar <= Constants.Torrent7ZipHeader.Length) { ar = (uint)Constants.Torrent7ZipHeader.Length; } // memset(buffer+offs+ar,0,crcsz-ar) } fread.Dispose(); } catch { Globals.Logger.Warning("File '{0}' could not be opened", filename); ist7z = 0; } } return ist7z; } #endregion } }