// TarEntry.cs
// Copyright (C) 2001 Mike Krueger
//
// 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.Diagnostics.CodeAnalysis;
using System.IO;
using System.Text;
namespace BCG.Utilities.SharpZipLib.Tar {
///
/// This class represents an entry in a Tar archive. It consists
/// of the entry's header, as well as the entry's File. Entries
/// can be instantiated in one of three ways, depending on how
/// they are to be used.
///
/// TarEntries that are created from the header bytes read from
/// an archive are instantiated with the TarEntry( byte[] )
/// constructor. These entries will be used when extracting from
/// or listing the contents of an archive. These entries have their
/// header filled in using the header bytes. They also set the File
/// to null, since they reference an archive entry not a file.
///
/// TarEntries that are created from Files that are to be written
/// into an archive are instantiated with the TarEntry( File )
/// constructor. These entries have their header filled in using
/// the File's information. They also keep a reference to the File
/// for convenience when writing entries.
///
/// Finally, TarEntries can be constructed from nothing but a name.
/// This allows the programmer to construct the entry by hand, for
/// instance when only an InputStream is available for writing to
/// the archive, and the header information is constructed from
/// other information. In this case the header fields are set to
/// defaults and the File is set to null.
///
///
/// The C structure for a Tar Entry's header is:
///
/// struct header {
/// char name[NAMSIZ];
/// char mode[8];
/// char uid[8];
/// char gid[8];
/// char size[12];
/// char mtime[12];
/// char chksum[8];
/// char linkflag;
/// char linkname[NAMSIZ];
/// char magic[8];
/// char uname[TUNMLEN];
/// char gname[TGNMLEN];
/// char devmajor[8];
/// char devminor[8];
/// } header;
///
///
///
///
public class TarEntry
{
///
/// If this entry represents a File, this references it.
///
protected string? file;
///
/// This is the entry's header information.
///
protected TarHeader? header;
///
/// Only Create Entries with the static CreateXYZ methods or a headerBuffer.
///
private TarEntry()
{
}
///
/// Construct an entry from an archive's header bytes. File is set
/// to null.
///
///
/// The header bytes from a tar archive entry.
///
public TarEntry(byte[] headerBuf)
{
this.Initialize();
this.ParseTarHeader(this.header, headerBuf);
}
///
/// Construct an entry with only a name. This allows the programmer
/// to construct the entry's header "by hand". File is set to null.
///
public static TarEntry CreateTarEntry(string name)
{
TarEntry entry = new TarEntry();
entry.Initialize();
entry.NameTarHeader(entry.header, name);
return entry;
}
///
/// Construct an entry for a file. File is set to file, and the
/// header is constructed from information from the file.
///
///
/// The file that the entry represents.
///
public static TarEntry CreateEntryFromFile(string fileName)
{
TarEntry entry = new TarEntry();
entry.Initialize();
entry.GetFileTarHeader(entry.header, fileName);
return entry;
}
///
/// Initialization code common to all constructors.
///
[MemberNotNull(nameof(header))]
void Initialize()
{
this.file = null;
this.header = new TarHeader();
}
public bool Equals(TarEntry? other) =>
other is not null && header?.name?.ToString() == other.header?.name?.ToString();
///
/// Determine if the two entries are equal. Equality is determined
/// by the header names being equal.
///
///
/// True if the entries are equal.
///
public override bool Equals(object? obj) =>
Equals(obj as TarEntry);
///
/// Must be overridden when you override Equals.
///
public override int GetHashCode() =>
header?.name?.ToString()?.GetHashCode() ?? 0;
///
/// Determine if the given entry is a descendant of this entry.
/// Descendancy is determined by the name of the descendant
/// starting with this entry's name.
///
///
/// Entry to be checked as a descendent of this.
///
///
/// True if entry is a descendant of this.
///
[MemberNotNull(nameof(header))]
public bool IsDescendent(TarEntry desc) {
assertHeader();
desc.assertHeader();
return desc.header.name.ToString().StartsWith(header.name.ToString());
}
///
/// Get this entry's header.
///
///
/// This entry's TarHeader.
///
public TarHeader TarHeader {
get {
assertHeader();
return this.header;
}
}
///
/// Get/Set this entry's name.
///
public string Name {
get {
assertHeader();
return this.header.name.ToString();
}
set {
assertHeader();
this.header.name = new StringBuilder(value);
}
}
///
/// Get/set this entry's user id.
///
public int UserId {
get {
assertHeader();
return this.header.userId;
}
set {
assertHeader();
this.header.userId = value;
}
}
///
/// Get/set this entry's group id.
///
public int GroupId {
get {
assertHeader();
return this.header.groupId;
}
set {
assertHeader();
this.header.groupId = value;
}
}
///
/// Get/set this entry's user name.
///
public string UserName {
get {
assertHeader();
return this.header.userName.ToString();
}
set {
assertHeader();
this.header.userName = new StringBuilder(value);
}
}
///
/// Get/set this entry's group name.
///
public string GroupName {
get {
assertHeader();
return this.header.groupName.ToString();
}
set {
assertHeader();
this.header.groupName = new StringBuilder(value);
}
}
///
/// Convenience method to set this entry's group and user ids.
///
///
/// This entry's new user id.
///
///
/// This entry's new group id.
///
public void SetIds(int userId, int groupId)
{
UserId = userId;
GroupId = groupId;
}
///
/// Convenience method to set this entry's group and user names.
///
///
/// This entry's new user name.
///
///
/// This entry's new group name.
///
public void SetNames(string userName, string groupName)
{
UserName = userName;
GroupName = groupName;
}
// TODO :
// /**
// * Set this entry's modification time. The parameter passed
// * to this method is in "Java time".
// *
// * @param time This entry's new modification time.
// */
// public void setModTime( long time )
// {
// this.header.modTime = time / 1000;
// }
/// Convert time to DateTimes
/**
* Get/Set this entry's modification time.
*
* @param time This entry's new modification time.
*/
public DateTime ModTime {
get {
assertHeader();
return this.header.modTime;
}
set {
assertHeader();
this.header.modTime = value;
}
}
///
/// Get this entry's file.
///
///
/// This entry's file.
///
public string? File => file;
///
/// Get/set this entry's file size.
///
public long Size {
get {
assertHeader();
return this.header.size;
}
set {
assertHeader();
this.header.size = value;
}
}
///
/// Convenience method that will modify an entry's name directly
/// in place in an entry header buffer byte array.
///
///
/// The buffer containing the entry header to modify.
///
///
/// The new name to place into the header buffer.
///
public void AdjustEntryName(byte[] outbuf, string newName)
{
int offset = 0;
offset = TarHeader.GetNameBytes(new StringBuilder(newName), outbuf, offset, TarHeader.NAMELEN);
}
///
/// Return whether or not this entry represents a directory.
///
///
/// True if this entry is a directory.
///
public bool IsDirectory
{
get {
if (this.file != null) {
return Directory.Exists(file);
}
if (this.header != null) {
if (this.header.linkFlag == TarHeader.LF_DIR || this.header.name.ToString().EndsWith( "/" )) {
return true;
}
}
return false;
}
}
///
/// Fill in a TarHeader with information from a File.
///
///
/// The TarHeader to fill in.
///
///
/// The file from which to get the header information.
///
public void GetFileTarHeader(TarHeader hdr, string file)
{
this.file = file;
var name = Path.GetDirectoryName(file)
?? throw new ArgumentException($"Invalid file (GetDirectoryName returned null): {file}");
if (Path.DirectorySeparatorChar == '\\') { // check if the OS is a windows
// Strip off drive letters!
if (name.Length > 2) {
char ch1 = name[0];
char ch2 = name[1];
if (ch2 == ':' && Char.IsLetter(ch1)) {
name = name.Substring(2);
}
}
}
name = name.Replace(Path.DirectorySeparatorChar, '/');
// No absolute pathnames
// Windows (and Posix?) paths can start with "\\NetworkDrive\",
// so we loop on starting /'s.
while (name.StartsWith("/")) {
name = name.Substring(1);
}
hdr.linkName = new StringBuilder(String.Empty);
hdr.name = new StringBuilder(name);
if (Directory.Exists(file)) {
hdr.mode = 040755; // TODO : what does this magic number ?? Mike
hdr.linkFlag = TarHeader.LF_DIR;
if (hdr.name[hdr.name.Length - 1] != '/') {
hdr.name.Append("/");
}
hdr.size = 0;
} else {
hdr.mode = 0100644; // TODO : again a magic number
hdr.linkFlag = TarHeader.LF_NORMAL;
Console.WriteLine(file.Replace('/', Path.DirectorySeparatorChar));
hdr.size = new FileInfo(file.Replace('/', Path.DirectorySeparatorChar)).Length;
}
// UNDONE When File lets us get the userName, use it!
hdr.modTime = System.IO.File.GetLastAccessTime(file.Replace('/', Path.DirectorySeparatorChar));
hdr.checkSum = 0;
hdr.devMajor = 0;
hdr.devMinor = 0;
}
///
/// If this entry represents a file, and the file is a directory, return
/// an array of TarEntries for this entry's children.
///
///
/// An array of TarEntry's for this entry's children.
///
public TarEntry[] GetDirectoryEntries()
{
if (this.file == null || !Directory.Exists(this.file)) {
return new TarEntry[0];
}
string[] list = Directory.GetFileSystemEntries(this.file);
TarEntry[] result = new TarEntry[list.Length];
string dirName = file;
if (!dirName.EndsWith(Path.DirectorySeparatorChar.ToString())) {
dirName += Path.DirectorySeparatorChar;
}
for (int i = 0; i < list.Length; ++i) {
result[i] = TarEntry.CreateEntryFromFile(list[i]);
}
return result;
}
///
/// Compute the checksum of a tar entry header.
///
///
/// The tar entry's header buffer.
///
///
/// The computed checksum.
///
public long ComputeCheckSum(byte[] buf)
{
long sum = 0;
for (int i = 0; i < buf.Length; ++i) {
sum += 255 & buf[i]; // TODO : I think the 255 & x isn't neccessary += buf[i] should be enough. CHECK IT!
}
return sum;
}
///
/// Write an entry's header information to a header buffer.
///
///
/// The tar entry header buffer to fill in.
///
[MemberNotNull(nameof(header))]
public void WriteEntryHeader(byte[] outbuf)
{
assertHeader();
int offset = 0;
offset = TarHeader.GetNameBytes(this.header.name, outbuf, offset, TarHeader.NAMELEN);
offset = TarHeader.GetOctalBytes(this.header.mode, outbuf, offset, TarHeader.MODELEN);
offset = TarHeader.GetOctalBytes(this.header.userId, outbuf, offset, TarHeader.UIDLEN);
offset = TarHeader.GetOctalBytes(this.header.groupId, outbuf, offset, TarHeader.GIDLEN);
long size = this.header.size;
offset = TarHeader.GetLongOctalBytes(size, outbuf, offset, TarHeader.SIZELEN);
offset = TarHeader.GetLongOctalBytes(GetCTime(this.header.modTime), outbuf, offset, TarHeader.MODTIMELEN);
int csOffset = offset;
for (int c = 0; c < TarHeader.CHKSUMLEN; ++c) {
outbuf[offset++] = (byte)' ';
}
outbuf[offset++] = this.header.linkFlag;
offset = TarHeader.GetNameBytes(this.header.linkName, outbuf, offset, TarHeader.NAMELEN);
offset = TarHeader.GetNameBytes(this.header.magic, outbuf, offset, TarHeader.MAGICLEN);
offset = TarHeader.GetNameBytes(this.header.userName, outbuf, offset, TarHeader.UNAMELEN);
offset = TarHeader.GetNameBytes(this.header.groupName, outbuf, offset, TarHeader.GNAMELEN);
offset = TarHeader.GetOctalBytes(this.header.devMajor, outbuf, offset, TarHeader.DEVLEN);
offset = TarHeader.GetOctalBytes(this.header.devMinor, outbuf, offset, TarHeader.DEVLEN);
for (; offset < outbuf.Length;) {
outbuf[offset++] = 0;
}
long checkSum = this.ComputeCheckSum(outbuf);
TarHeader.GetCheckSumOctalBytes(checkSum, outbuf, csOffset, TarHeader.CHKSUMLEN);
}
// time conversion functions
readonly static long timeConversionFactor = 10000000L;
readonly static DateTime datetTime1970 = new DateTime(1970, 1, 1, 0, 0, 0, 0);
static int GetCTime(System.DateTime dateTime)
{
return (int)((dateTime.Ticks - datetTime1970.Ticks) / timeConversionFactor);
}
static DateTime GetDateTimeFromCTime(long ticks)
{
return new DateTime(datetTime1970.Ticks + ticks * timeConversionFactor);
}
///
/// Parse an entry's TarHeader information from a header buffer.
///
///
/// Parse an entry's TarHeader information from a header buffer.
///
///
/// The tar entry header buffer to get information from.
///
public void ParseTarHeader(TarHeader hdr, byte[] header)
{
int offset = 0;
hdr.name = TarHeader.ParseName(header, offset, TarHeader.NAMELEN);
offset += TarHeader.NAMELEN;
hdr.mode = (int)TarHeader.ParseOctal(header, offset, TarHeader.MODELEN);
offset += TarHeader.MODELEN;
hdr.userId = (int)TarHeader.ParseOctal(header, offset, TarHeader.UIDLEN);
offset += TarHeader.UIDLEN;
hdr.groupId = (int)TarHeader.ParseOctal(header, offset, TarHeader.GIDLEN);
offset += TarHeader.GIDLEN;
hdr.size = TarHeader.ParseOctal(header, offset, TarHeader.SIZELEN);
offset += TarHeader.SIZELEN;
hdr.modTime = GetDateTimeFromCTime(TarHeader.ParseOctal(header, offset, TarHeader.MODTIMELEN));
offset += TarHeader.MODTIMELEN;
hdr.checkSum = (int)TarHeader.ParseOctal(header, offset, TarHeader.CHKSUMLEN);
offset += TarHeader.CHKSUMLEN;
hdr.linkFlag = header[ offset++ ];
hdr.linkName = TarHeader.ParseName(header, offset, TarHeader.NAMELEN);
offset += TarHeader.NAMELEN;
hdr.magic = TarHeader.ParseName(header, offset, TarHeader.MAGICLEN);
offset += TarHeader.MAGICLEN;
hdr.userName = TarHeader.ParseName(header, offset, TarHeader.UNAMELEN);
offset += TarHeader.UNAMELEN;
hdr.groupName = TarHeader.ParseName(header, offset, TarHeader.GNAMELEN);
offset += TarHeader.GNAMELEN;
hdr.devMajor = (int)TarHeader.ParseOctal(header, offset, TarHeader.DEVLEN);
offset += TarHeader.DEVLEN;
hdr.devMinor = (int)TarHeader.ParseOctal(header, offset, TarHeader.DEVLEN);
}
///
/// Fill in a TarHeader given only the entry's name.
///
///
/// The TarHeader to fill in.
///
///
/// The tar entry name.
///
public void NameTarHeader(TarHeader hdr, string name)
{
bool isDir = name.EndsWith("/");
hdr.checkSum = 0;
hdr.devMajor = 0;
hdr.devMinor = 0;
hdr.name = new StringBuilder(name);
hdr.mode = isDir ? 040755 : 0100644; // TODO : I think I've seen these magics before ...
hdr.userId = 0;
hdr.groupId = 0;
hdr.size = 0;
hdr.checkSum = 0;
hdr.modTime = DateTime.Now;//(new java.util.Date()).getTime() / 1000;
hdr.linkFlag = isDir ? TarHeader.LF_DIR : TarHeader.LF_NORMAL;
hdr.linkName = new StringBuilder(String.Empty);
hdr.userName = new StringBuilder(String.Empty);
hdr.groupName = new StringBuilder(String.Empty);
hdr.devMajor = 0;
hdr.devMinor = 0;
}
[MemberNotNull(nameof(header))]
void assertHeader() {
if (header is null) {
throw new InvalidOperationException("header is null");
}
}
}
}
/* The original Java file had this header:
*
** Authored by Timothy Gerard Endres
**
**
** This work has been placed into the public domain.
** You may use this work in any way and for any purpose you wish.
**
** THIS SOFTWARE IS PROVIDED AS-IS WITHOUT WARRANTY OF ANY KIND,
** NOT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY. THE AUTHOR
** OF THIS SOFTWARE, ASSUMES _NO_ RESPONSIBILITY FOR ANY
** CONSEQUENCE RESULTING FROM THE USE, MODIFICATION, OR
** REDISTRIBUTION OF THIS SOFTWARE.
**
*/