WPinternals/DiscUtils/Ntfs/StandardInformation.cs

//
// Copyright (c) 2008-2011, Kenneth Bell
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//

namespace DiscUtils.Ntfs
{
    using System;
    using System.IO;

    internal sealed class StandardInformation : IByteArraySerializable, IDiagnosticTraceable
    {
        public DateTime CreationTime;
        public DateTime ModificationTime;
        public DateTime MftChangedTime;
        public DateTime LastAccessTime;
        public FileAttributeFlags FileAttributes;
        public uint MaxVersions;
        public uint Version;
        public uint ClassId;
        public uint OwnerId;
        public uint SecurityId;
        public ulong QuotaCharged;
        public ulong UpdateSequenceNumber;

        private bool _haveExtraFields = true;

        public int Size
        {
            get { return _haveExtraFields ? 0x48 : 0x30; }
        }

        public static StandardInformation InitializeNewFile(File file, FileAttributeFlags flags)
        {
            DateTime now = DateTime.UtcNow;

            NtfsStream siStream = file.CreateStream(AttributeType.StandardInformation, null);
            StandardInformation si = new StandardInformation();
            si.CreationTime = now;
            si.ModificationTime = now;
            si.MftChangedTime = now;
            si.LastAccessTime = now;
            si.FileAttributes = flags;
            siStream.SetContent(si);

            return si;
        }

        public int ReadFrom(byte[] buffer, int offset)
        {
            CreationTime = ReadDateTime(buffer, 0x00);
            ModificationTime = ReadDateTime(buffer, 0x08);
            MftChangedTime = ReadDateTime(buffer, 0x10);
            LastAccessTime = ReadDateTime(buffer, 0x18);
            FileAttributes = (FileAttributeFlags)Utilities.ToUInt32LittleEndian(buffer, 0x20);
            MaxVersions = Utilities.ToUInt32LittleEndian(buffer, 0x24);
            Version = Utilities.ToUInt32LittleEndian(buffer, 0x28);
            ClassId = Utilities.ToUInt32LittleEndian(buffer, 0x2C);

            if (buffer.Length > 0x30)
            {
                OwnerId = Utilities.ToUInt32LittleEndian(buffer, 0x30);
                SecurityId = Utilities.ToUInt32LittleEndian(buffer, 0x34);
                QuotaCharged = Utilities.ToUInt64LittleEndian(buffer, 0x38);
                UpdateSequenceNumber = Utilities.ToUInt64LittleEndian(buffer, 0x40);
                _haveExtraFields = true;
                return 0x48;
            }
            else
            {
                _haveExtraFields = false;
                return 0x30;
            }
        }

        public void WriteTo(byte[] buffer, int offset)
        {
            Utilities.WriteBytesLittleEndian(CreationTime.ToFileTimeUtc(), buffer, 0x00);
            Utilities.WriteBytesLittleEndian(ModificationTime.ToFileTimeUtc(), buffer, 0x08);
            Utilities.WriteBytesLittleEndian(MftChangedTime.ToFileTimeUtc(), buffer, 0x10);
            Utilities.WriteBytesLittleEndian(LastAccessTime.ToFileTimeUtc(), buffer, 0x18);
            Utilities.WriteBytesLittleEndian((uint)FileAttributes, buffer, 0x20);
            Utilities.WriteBytesLittleEndian(MaxVersions, buffer, 0x24);
            Utilities.WriteBytesLittleEndian(Version, buffer, 0x28);
            Utilities.WriteBytesLittleEndian(ClassId, buffer, 0x2C);

            if (_haveExtraFields)
            {
                Utilities.WriteBytesLittleEndian(OwnerId, buffer, 0x30);
                Utilities.WriteBytesLittleEndian(SecurityId, buffer, 0x34);
                Utilities.WriteBytesLittleEndian(QuotaCharged, buffer, 0x38);
                Utilities.WriteBytesLittleEndian(UpdateSequenceNumber, buffer, 0x38);
            }
        }

        public void Dump(TextWriter writer, string indent)
        {
            writer.WriteLine(indent + "      Creation Time: " + CreationTime);
            writer.WriteLine(indent + "  Modification Time: " + ModificationTime);
            writer.WriteLine(indent + "   MFT Changed Time: " + MftChangedTime);
            writer.WriteLine(indent + "   Last Access Time: " + LastAccessTime);
            writer.WriteLine(indent + "   File Permissions: " + FileAttributes);
            writer.WriteLine(indent + "       Max Versions: " + MaxVersions);
            writer.WriteLine(indent + "            Version: " + Version);
            writer.WriteLine(indent + "           Class Id: " + ClassId);
            writer.WriteLine(indent + "        Security Id: " + SecurityId);
            writer.WriteLine(indent + "      Quota Charged: " + QuotaCharged);
            writer.WriteLine(indent + "     Update Seq Num: " + UpdateSequenceNumber);
        }

        internal static FileAttributes ConvertFlags(FileAttributeFlags flags, bool isDirectory)
        {
            FileAttributes result = (FileAttributes)(((uint)flags) & 0xFFFF);

            if (isDirectory)
            {
                result |= System.IO.FileAttributes.Directory;
            }

            return result;
        }

        internal static FileAttributeFlags SetFileAttributes(FileAttributes newAttributes, FileAttributeFlags existing)
        {
            return (FileAttributeFlags)(((uint)existing & 0xFFFF0000) | ((uint)newAttributes & 0xFFFF));
        }

        private static DateTime ReadDateTime(byte[] buffer, int offset)
        {
            try
            {
                return DateTime.FromFileTimeUtc(Utilities.ToInt64LittleEndian(buffer, offset));
            }
            catch (ArgumentException)
            {
                return DateTime.FromFileTimeUtc(0);
            }
        }
    }
}