/SourseRestore/zip/Tar/TarEntry.cs
C# | 571 lines | 262 code | 54 blank | 255 comment | 20 complexity | e79fc18c07a7b4265b4e10dce3cf8990 MD5 | raw file
- // 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.IO;
- using System.Text;
-
- namespace ICSharpCode.SharpZipLib.Tar
- {
-
- /// <summary>
- /// 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.
- /// <p>
- /// 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.</p>
- /// <p>
- /// TarEntries that are created from files that are to be written
- /// into an archive are instantiated with the CreateEntryFromFile(string)
- /// pseudo 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.</p>
- /// <p>
- /// 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.</p>
- ///
- /// <see cref="TarHeader"/>
- /// </summary>
- public class TarEntry : ICloneable
- {
- /// <summary>
- /// The name of the file this entry represents or null if the entry is not based on a file.
- /// </summary>
- string file;
-
- /// <summary>
- /// The entry's header information.
- /// </summary>
- TarHeader header;
-
- /// <summary>
- /// Only allow creation of Entries with the static CreateXYZ factory methods.
- /// </summary>
- private TarEntry()
- {
- }
-
- /// <summary>
- /// Construct an entry from an archive's header bytes. File is set
- /// to null.
- /// </summary>
- /// <param name = "headerBuf">
- /// The header bytes from a tar archive entry.
- /// </param>
- public TarEntry(byte[] headerBuf)
- {
- this.Initialize();
- this.header.ParseBuffer(headerBuf);
- }
-
-
- /// <summary>
- /// Construct a TarEntry using the <paramref name="header">header</paramref> provided
- /// </summary>
- /// <param name="header">Header details for entry</param>
- public TarEntry(TarHeader header)
- {
- file = null;
- this.header = header;
- }
-
- /// <summary>
- /// Clone this tar entry.
- /// </summary>
- /// <returns>Returns a clone of this entry.</returns>
- public object Clone()
- {
- TarEntry entry = new TarEntry();
- entry.file = this.file;
- entry.header = (TarHeader)this.header.Clone();
- entry.Name = this.Name;
- return entry;
- }
-
- /// <summary>
- /// Construct an entry with only a <paramref name="name"></paramref>.
- /// This allows the programmer to construct the entry's header "by hand".
- /// </summary>
- public static TarEntry CreateTarEntry(string name)
- {
- TarEntry entry = new TarEntry();
- entry.Initialize();
- entry.NameTarHeader(entry.header, name);
- return entry;
- }
-
- /// <summary>
- /// Construct an entry for a file. File is set to file, and the
- /// header is constructed from information from the file.
- /// </summary>
- /// <param name = "fileName">
- /// The file that the entry represents.
- /// </param>
- public static TarEntry CreateEntryFromFile(string fileName)
- {
- TarEntry entry = new TarEntry();
- entry.Initialize();
- entry.GetFileTarHeader(entry.header, fileName);
- return entry;
- }
-
- /// <summary>
- /// Initialization code common to all pseudo constructors.
- /// </summary>
- void Initialize()
- {
- this.file = null;
- this.header = new TarHeader();
- }
-
- /// <summary>
- /// Determine if the two entries are equal. Equality is determined
- /// by the header names being equal.
- /// </summary>
- /// <returns>
- /// True if the entries are equal.
- /// </returns>
- public override bool Equals(object it)
- {
- if (!(it is TarEntry))
- {
- return false;
- }
- return this.Name.Equals(((TarEntry)it).Name);
- }
-
- /// <summary>
- /// Must be overridden when you override Equals.
- /// </summary>
- public override int GetHashCode()
- {
- return Name.GetHashCode();
- }
-
-
- /// <summary>
- /// 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.
- /// </summary>
- /// <param name = "desc">
- /// Entry to be checked as a descendent of this.
- /// </param>
- /// <returns>
- /// True if entry is a descendant of this.
- /// </returns>
- public bool IsDescendent(TarEntry desc)
- {
- return desc.Name.StartsWith(Name);
- }
-
- /// <summary>
- /// Get this entry's header.
- /// </summary>
- /// <returns>
- /// This entry's TarHeader.
- /// </returns>
- public TarHeader TarHeader
- {
- get
- {
- return this.header;
- }
- }
-
- /// <summary>
- /// Get/Set this entry's name.
- /// </summary>
- public string Name
- {
- get
- {
- return header.Name;
- }
- set
- {
- header.Name = value;
- }
- }
-
- /// <summary>
- /// Get/set this entry's user id.
- /// </summary>
- public int UserId
- {
- get
- {
- return header.UserId;
- }
- set
- {
- header.UserId = value;
- }
- }
-
- /// <summary>
- /// Get/set this entry's group id.
- /// </summary>
- public int GroupId
- {
- get
- {
- return this.header.GroupId;
- }
- set
- {
- this.header.GroupId = value;
- }
- }
-
- /// <summary>
- /// Get/set this entry's user name.
- /// </summary>
- public string UserName
- {
- get
- {
- return this.header.UserName;
- }
- set
- {
- this.header.UserName = value;
- }
- }
-
- /// <summary>
- /// Get/set this entry's group name.
- /// </summary>
- public string GroupName
- {
- get
- {
- return this.header.GroupName;
- }
- set
- {
- this.header.GroupName = value;
- }
- }
-
- /// <summary>
- /// Convenience method to set this entry's group and user ids.
- /// </summary>
- /// <param name="userId">
- /// This entry's new user id.
- /// </param>
- /// <param name="groupId">
- /// This entry's new group id.
- /// </param>
- public void SetIds(int userId, int groupId)
- {
- UserId = userId;
- GroupId = groupId;
- }
-
- /// <summary>
- /// Convenience method to set this entry's group and user names.
- /// </summary>
- /// <param name="userName">
- /// This entry's new user name.
- /// </param>
- /// <param name="groupName">
- /// This entry's new group name.
- /// </param>
- public void SetNames(string userName, string groupName)
- {
- UserName = userName;
- GroupName = groupName;
- }
-
- /// <summary>
- /// Get/Set the modification time for this entry
- /// </summary>
- public DateTime ModTime
- {
- get
- {
- return this.header.ModTime;
- }
- set
- {
- this.header.ModTime = value;
- }
- }
-
- /// <summary>
- /// Get this entry's file.
- /// </summary>
- /// <returns>
- /// This entry's file.
- /// </returns>
- public string File
- {
- get
- {
- return this.file;
- }
- }
-
- /// <summary>
- /// Get/set this entry's recorded file size.
- /// </summary>
- public long Size
- {
- get
- {
- return this.header.Size;
- }
- set
- {
- this.header.Size = value;
- }
- }
-
- /// <summary>
- /// Convenience method that will modify an entry's name directly
- /// in place in an entry header buffer byte array.
- /// </summary>
- /// <param name="outbuf">
- /// The buffer containing the entry header to modify.
- /// </param>
- /// <param name="newName">
- /// The new name to place into the header buffer.
- /// </param>
- public void AdjustEntryName(byte[] outbuf, string newName)
- {
- int offset = 0;
- TarHeader.GetNameBytes(newName, outbuf, offset, TarHeader.NAMELEN);
- }
-
- /// <summary>
- /// Return true if this entry represents a directory, false otherwise
- /// </summary>
- /// <returns>
- /// True if this entry is a directory.
- /// </returns>
- public bool IsDirectory
- {
- get
- {
- if (this.file != null)
- {
- return Directory.Exists(file);
- }
-
- if (this.header != null)
- {
- if (this.header.TypeFlag == TarHeader.LF_DIR || Name.EndsWith("/"))
- {
- return true;
- }
- }
- return false;
- }
- }
-
- /// <summary>
- /// Fill in a TarHeader with information from a File.
- /// </summary>
- /// <param name="hdr">
- /// The TarHeader to fill in.
- /// </param>
- /// <param name="file">
- /// The file from which to get the header information.
- /// </param>
- public void GetFileTarHeader(TarHeader hdr, string file)
- {
- this.file = file;
-
- // bugfix from torhovl from #D forum:
- string name = file;
-
- #if !COMPACT_FRAMEWORK
- // 23-Jan-2004 GnuTar allows device names in path where the name is not local to the current directory
- if (name.IndexOf(Environment.CurrentDirectory) == 0)
- {
- name = name.Substring(Environment.CurrentDirectory.Length);
- }
- #endif
-
- /*
- if (Path.DirectorySeparatorChar == '\\')
- { // check if the OS is 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 UNC style "\\NetworkDrive\",
- // so we loop on starting /'s.
- while (name.StartsWith("/"))
- {
- name = name.Substring(1);
- }
-
- hdr.LinkName = String.Empty;
- hdr.Name = name;
-
- if (Directory.Exists(file))
- {
- hdr.Mode = 1003; // Magic number for security access for a UNIX filesystem
- hdr.TypeFlag = TarHeader.LF_DIR;
- if (hdr.Name.Length == 0 || hdr.Name[hdr.Name.Length - 1] != '/')
- {
- hdr.Name = hdr.Name + "/";
- }
-
- hdr.Size = 0;
- }
- else
- {
- hdr.Mode = 33216; // Magic number for security access for a UNIX filesystem
- hdr.TypeFlag = TarHeader.LF_NORMAL;
- hdr.Size = new FileInfo(file.Replace('/', Path.DirectorySeparatorChar)).Length;
- }
-
- hdr.ModTime = System.IO.File.GetLastWriteTime(file.Replace('/', Path.DirectorySeparatorChar)).ToUniversalTime();
- hdr.DevMajor = 0;
- hdr.DevMinor = 0;
- }
-
- /// <summary>
- /// Get entries for all files present in this entries directory.
- /// If this entry doesnt represent a directory zero entries are returned.
- /// </summary>
- /// <returns>
- /// An array of TarEntry's for this entry's children.
- /// </returns>
- 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];
-
- for (int i = 0; i < list.Length; ++i)
- {
- result[i] = TarEntry.CreateEntryFromFile(list[i]);
- }
-
- return result;
- }
-
- /// <summary>
- /// Write an entry's header information to a header buffer.
- /// </summary>
- /// <param name = "outbuf">
- /// The tar entry header buffer to fill in.
- /// </param>
- public void WriteEntryHeader(byte[] outbuf)
- {
- this.header.WriteHeader(outbuf);
- }
-
- /// <summary>
- /// Fill in a TarHeader given only the entry's name.
- /// </summary>
- /// <param name="hdr">
- /// The TarHeader to fill in.
- /// </param>
- /// <param name="name">
- /// The tar entry name.
- /// </param>
- public void NameTarHeader(TarHeader hdr, string name)
- {
- bool isDir = name.EndsWith("/");
-
- hdr.Name = name;
- hdr.Mode = isDir ? 1003 : 33216;
- hdr.UserId = 0;
- hdr.GroupId = 0;
- hdr.Size = 0;
-
- hdr.ModTime = DateTime.UtcNow;
-
- hdr.TypeFlag = isDir ? TarHeader.LF_DIR : TarHeader.LF_NORMAL;
-
- hdr.LinkName = String.Empty;
- hdr.UserName = String.Empty;
- hdr.GroupName = String.Empty;
-
- hdr.DevMajor = 0;
- hdr.DevMinor = 0;
- }
- }
- }
-
-
-
- /* The original Java file had this header:
- *
- ** Authored by Timothy Gerard Endres
- ** <mailto:time@gjt.org> <http://www.trustice.com>
- **
- ** 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.
- **
- */