Files
Aaru/Aaru.Images/VMware/Write.cs

416 lines
12 KiB
C#

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename : Write.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : Disk image plugins.
//
// --[ Description ] ----------------------------------------------------------
//
// Writes VMware disk images.
//
// --[ License ] --------------------------------------------------------------
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, see <http://www.gnu.org/licenses/>.
//
// ----------------------------------------------------------------------------
// Copyright © 2011-2025 Natalia Portillo
// ****************************************************************************/
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using Aaru.CommonTypes;
using Aaru.CommonTypes.AaruMetadata;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs;
using Aaru.Logging;
namespace Aaru.Images;
public sealed partial class VMware
{
#region IWritableImage Members
/// <inheritdoc />
public bool Create(string path, MediaType mediaType, Dictionary<string, string> options, ulong sectors,
uint negativeSectors, uint overflowSectors, uint sectorSize)
{
if(options != null)
{
if(options.TryGetValue("adapter", out _adapterType))
{
switch(_adapterType.ToLowerInvariant())
{
case "ide":
case "lsilogic":
case "buslogic":
_adapterType = _adapterType.ToLowerInvariant();
break;
case "legacyesx":
_adapterType = "legacyESX";
break;
default:
ErrorMessage = string.Format(Localization.Invalid_adapter_type_0, _adapterType);
return false;
}
}
else
_adapterType = "ide";
if(options.TryGetValue("hwversion", out string tmpValue))
{
if(!uint.TryParse(tmpValue, out _hwversion))
{
ErrorMessage = Localization.Invalid_value_for_hwversion_option;
return false;
}
}
else
_hwversion = 4;
if(options.TryGetValue("split", out tmpValue))
{
if(!bool.TryParse(tmpValue, out bool tmpBool))
{
ErrorMessage = Localization.Invalid_value_for_split_option;
return false;
}
if(tmpBool)
{
ErrorMessage = Localization.Splitted_images_not_yet_implemented;
return false;
}
}
if(options.TryGetValue("sparse", out tmpValue))
{
if(!bool.TryParse(tmpValue, out bool tmpBool))
{
ErrorMessage = Localization.Invalid_value_for_sparse_option;
return false;
}
if(tmpBool)
{
ErrorMessage = Localization.Sparse_images_not_yet_implemented;
return false;
}
}
}
else
{
_adapterType = "ide";
_hwversion = 4;
}
if(sectorSize != 512)
{
ErrorMessage = Localization.Unsupported_sector_size;
return false;
}
if(negativeSectors != 0)
{
ErrorMessage = Localization.Negative_sectors_are_not_supported;
return false;
}
if(overflowSectors != 0)
{
ErrorMessage = Localization.Overflow_sectors_are_not_supported;
return false;
}
if(!SupportedMediaTypes.Contains(mediaType))
{
ErrorMessage = string.Format(Localization.Unsupported_media_format_0, mediaType);
return false;
}
_imageInfo = new ImageInfo
{
MediaType = mediaType,
SectorSize = sectorSize,
Sectors = sectors
};
try
{
_writingBaseName = Path.Combine(Path.GetDirectoryName(path) ?? "", Path.GetFileNameWithoutExtension(path));
_descriptorStream = new StreamWriter(path, false, Encoding.ASCII);
// TODO: Support split
_writingStream = new FileStream(_writingBaseName + "-flat.vmdk",
FileMode.CreateNew,
FileAccess.ReadWrite,
FileShare.None);
}
catch(IOException ex)
{
ErrorMessage = string.Format(Localization.Could_not_create_new_image_file_exception_0, ex.Message);
AaruLogging.Exception(ex, Localization.Could_not_create_new_image_file_exception_0, ex.Message);
return false;
}
IsWriting = true;
ErrorMessage = null;
return true;
}
/// <inheritdoc />
public bool WriteMediaTag(byte[] data, MediaTagType tag)
{
ErrorMessage = Localization.Writing_media_tags_is_not_supported;
return false;
}
/// <inheritdoc />
public bool WriteSector(byte[] data, ulong sectorAddress, bool negative, SectorStatus sectorStatus)
{
if(!IsWriting)
{
ErrorMessage = Localization.Tried_to_write_on_a_non_writable_image;
return false;
}
if(negative)
{
ErrorMessage = Localization.Unsupported_feature;
return false;
}
if(data.Length != 512)
{
ErrorMessage = Localization.Incorrect_data_size;
return false;
}
if(sectorAddress >= _imageInfo.Sectors)
{
ErrorMessage = Localization.Tried_to_write_past_image_size;
return false;
}
_writingStream.Seek((long)(sectorAddress * 512), SeekOrigin.Begin);
_writingStream.Write(data, 0, data.Length);
ErrorMessage = "";
return true;
}
// TODO: Implement sparse and split
/// <inheritdoc />
public bool WriteSectors(byte[] data, ulong sectorAddress, bool negative, uint length, SectorStatus[] sectorStatus)
{
if(!IsWriting)
{
ErrorMessage = Localization.Tried_to_write_on_a_non_writable_image;
return false;
}
if(negative)
{
ErrorMessage = Localization.Unsupported_feature;
return false;
}
if(data.Length % 512 != 0)
{
ErrorMessage = Localization.Incorrect_data_size;
return false;
}
if(sectorAddress + length > _imageInfo.Sectors)
{
ErrorMessage = Localization.Tried_to_write_past_image_size;
return false;
}
_writingStream.Seek((long)(sectorAddress * 512), SeekOrigin.Begin);
_writingStream.Write(data, 0, data.Length);
ErrorMessage = "";
return true;
}
/// <inheritdoc />
public bool WriteSectorLong(byte[] data, ulong sectorAddress, bool negative, SectorStatus sectorStatus)
{
ErrorMessage = Localization.Writing_sectors_with_tags_is_not_supported;
return false;
}
/// <inheritdoc />
public bool WriteSectorsLong(byte[] data, ulong sectorAddress, bool negative, uint length,
SectorStatus[] sectorStatus)
{
ErrorMessage = Localization.Writing_sectors_with_tags_is_not_supported;
return false;
}
// TODO: Implement sparse and split
/// <inheritdoc />
public bool Close()
{
if(!IsWriting)
{
ErrorMessage = Localization.Image_is_not_opened_for_writing;
return false;
}
_writingStream.Flush();
_writingStream.Close();
if(_imageInfo.Cylinders == 0)
{
_imageInfo.Cylinders = (uint)(_imageInfo.Sectors / 16 / 63);
_imageInfo.Heads = 16;
_imageInfo.SectorsPerTrack = 63;
while(_imageInfo.Cylinders == 0)
{
_imageInfo.Heads--;
if(_imageInfo.Heads == 0)
{
_imageInfo.SectorsPerTrack--;
_imageInfo.Heads = 16;
}
_imageInfo.Cylinders = (uint)(_imageInfo.Sectors / _imageInfo.Heads / _imageInfo.SectorsPerTrack);
if(_imageInfo.Cylinders == 0 && _imageInfo is { Heads: 0, SectorsPerTrack: 0 }) break;
}
}
_descriptorStream.WriteLine("# Disk DescriptorFile");
_descriptorStream.WriteLine("version=1");
_descriptorStream.WriteLine($"CID={new Random().Next(int.MinValue, int.MaxValue):x8}");
_descriptorStream.WriteLine("parentCID=ffffffff");
_descriptorStream.WriteLine("createType=\"monolithicFlat\"");
_descriptorStream.WriteLine();
_descriptorStream.WriteLine("# Extent description");
_descriptorStream.WriteLine($"RW {_imageInfo.Sectors} FLAT \"{_writingBaseName + "-flat.vmdk"}\" 0");
_descriptorStream.WriteLine();
_descriptorStream.WriteLine("# The Disk Data Base");
_descriptorStream.WriteLine("#DDB");
_descriptorStream.WriteLine();
_descriptorStream.WriteLine($"ddb.virtualHWVersion = \"{_hwversion}\"");
_descriptorStream.WriteLine($"ddb.geometry.cylinders = \"{_imageInfo.Cylinders}\"");
_descriptorStream.WriteLine($"ddb.geometry.heads = \"{_imageInfo.Heads}\"");
_descriptorStream.WriteLine($"ddb.geometry.sectors = \"{_imageInfo.SectorsPerTrack}\"");
_descriptorStream.WriteLine($"ddb.adapterType = \"{_adapterType}\"");
_descriptorStream.Flush();
_descriptorStream.Close();
IsWriting = false;
ErrorMessage = "";
return true;
}
/// <inheritdoc />
public bool SetImageInfo(ImageInfo imageInfo) => true;
/// <inheritdoc />
public bool SetGeometry(uint cylinders, uint heads, uint sectorsPerTrack)
{
if(cylinders > ushort.MaxValue)
{
ErrorMessage = Localization.Too_many_cylinders;
return false;
}
if(heads > byte.MaxValue)
{
ErrorMessage = Localization.Too_many_heads;
return false;
}
if(sectorsPerTrack > byte.MaxValue)
{
ErrorMessage = Localization.Too_many_sectors_per_track;
return false;
}
_imageInfo.SectorsPerTrack = sectorsPerTrack;
_imageInfo.Heads = heads;
_imageInfo.Cylinders = cylinders;
return true;
}
/// <inheritdoc />
public bool WriteSectorTag(byte[] data, ulong sectorAddress, bool negative, SectorTagType tag)
{
ErrorMessage = Localization.Unsupported_feature;
return false;
}
/// <inheritdoc />
public bool WriteSectorsTag(byte[] data, ulong sectorAddress, bool negative, uint length, SectorTagType tag)
{
ErrorMessage = Localization.Unsupported_feature;
return false;
}
/// <inheritdoc />
public bool SetDumpHardware(List<DumpHardware> dumpHardware) => false;
/// <inheritdoc />
public bool SetMetadata(Metadata metadata) => false;
#endregion
}