Add writing support to Basic Lisa Utility disk image.

DiscImageChef.Decoders/LisaTag.cs

@@ -219,7 +219,7 @@ namespace DiscImageChef.Decoders
             /// <summary>
             ///     Converts this tag to Apple Profile format
             /// </summary>
-            public ProfileTag Profile()
+            public ProfileTag ToProfile()
             {
                 return new ProfileTag
                 {

DiscImageChef.DiscImages/BLU.cs

@@ -33,13 +33,17 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
+using System.Text;
 using DiscImageChef.CommonTypes;
 using DiscImageChef.Console;
+using DiscImageChef.Decoders;
 using DiscImageChef.Filters;
+using Version = DiscImageChef.Interop.Version;
 
 namespace DiscImageChef.DiscImages
 {
-    public class Blu : IMediaImage
+    public class Blu : IWritableImage
     {
         const string PROFILE_NAME   = "PROFILE      ";
         const string PROFILE10_NAME = "PROFILE 10   ";
@@ -50,6 +54,7 @@ namespace DiscImageChef.DiscImages
 
         BluHeader  imageHeader;
         ImageInfo  imageInfo;
+        FileStream writingStream;
 
         public Blu()
         {
@@ -112,7 +117,9 @@ namespace DiscImageChef.DiscImages
             tmpHdr.DeviceBlocks  = BigEndianBitConverter.ToUInt32(header, 0x11) & 0x00FFFFFF;
             tmpHdr.BytesPerBlock = BigEndianBitConverter.ToUInt16(header, 0x15);
 
-            for(int i = 0; i < 0xD; i++) if(tmpHdr.DeviceName[i] < 0x20) return false;
+            for(int i = 0; i            < 0xD; i++)
+                if(tmpHdr.DeviceName[i] < 0x20)
+                    return false;
 
             return (tmpHdr.BytesPerBlock & 0xFE00) == 0x200;
         }
@@ -138,7 +145,9 @@ namespace DiscImageChef.DiscImages
             DicConsole.DebugWriteLine("BLU plugin", "ImageHeader.deviceBlock = {0}",   imageHeader.DeviceBlocks);
             DicConsole.DebugWriteLine("BLU plugin", "ImageHeader.bytesPerBlock = {0}", imageHeader.BytesPerBlock);
 
-            for(int i = 0; i < 0xD; i++) if(imageHeader.DeviceName[i] < 0x20) return false;
+            for(int i = 0; i                 < 0xD; i++)
+                if(imageHeader.DeviceName[i] < 0x20)
+                    return false;
 
             if((imageHeader.BytesPerBlock & 0xFE00) != 0x200) return false;
 
@@ -157,19 +166,22 @@ namespace DiscImageChef.DiscImages
             switch(StringHandlers.CToString(imageHeader.DeviceName))
             {
                 case PROFILE_NAME:
-                    imageInfo.MediaType = imageInfo.Sectors == 0x2600 ? MediaType.AppleProfile : MediaType.GENERIC_HDD;
+                    imageInfo.MediaType =
+                        imageInfo.Sectors == 0x2600 ? MediaType.AppleProfile : MediaType.GENERIC_HDD;
                     imageInfo.Cylinders       = 152;
                     imageInfo.Heads           = 4;
                     imageInfo.SectorsPerTrack = 16;
                     break;
                 case PROFILE10_NAME:
-                    imageInfo.MediaType = imageInfo.Sectors == 0x4C00 ? MediaType.AppleProfile : MediaType.GENERIC_HDD;
+                    imageInfo.MediaType =
+                        imageInfo.Sectors == 0x4C00 ? MediaType.AppleProfile : MediaType.GENERIC_HDD;
                     imageInfo.Cylinders       = 304;
                     imageInfo.Heads           = 4;
                     imageInfo.SectorsPerTrack = 16;
                     break;
                 case WIDGET_NAME:
-                    imageInfo.MediaType = imageInfo.Sectors == 0x4C00 ? MediaType.AppleWidget : MediaType.GENERIC_HDD;
+                    imageInfo.MediaType =
+                        imageInfo.Sectors == 0x4C00 ? MediaType.AppleWidget : MediaType.GENERIC_HDD;
                     imageInfo.Cylinders       = 304;
                     imageInfo.Heads           = 4;
                     imageInfo.SectorsPerTrack = 16;
@@ -344,15 +356,7 @@ namespace DiscImageChef.DiscImages
             throw new FeatureUnsupportedImageException("Feature not supported by image format");
         }
 
-        struct BluHeader
+        // TODO: Check tag checkums
-        {
-            public byte[] DeviceName;
-            public uint DeviceType;
-            public uint DeviceBlocks;
-            public ushort BytesPerBlock;
-        }
-
-        #region Verification, should add tag checksum checks
         public bool? VerifySector(ulong sectorAddress)
         {
             return null;
@@ -389,6 +393,368 @@ namespace DiscImageChef.DiscImages
         {
             return null;
         }
-        #endregion Verification, should add tag checksum checks
+
+        public IEnumerable<MediaTagType>  SupportedMediaTags  => new MediaTagType[] { };
+        public IEnumerable<SectorTagType> SupportedSectorTags => new[] {SectorTagType.AppleSectorTag};
+        public IEnumerable<MediaType>     SupportedMediaTypes =>
+            new[]
+            {
+                MediaType.AppleProfile, MediaType.AppleWidget, MediaType.PriamDataTower, MediaType.GENERIC_HDD,
+                MediaType.Unknown
+            };
+        public IEnumerable<(string name, Type type, string description)> SupportedOptions =>
+            new (string name, Type type, string description)[] { };
+        public IEnumerable<string> KnownExtensions => new[] {".blu"}; // Just invented
+        public bool                IsWriting       { get; private set; }
+        public string              ErrorMessage    { get; private set; }
+
+        public bool Create(string path, MediaType mediaType, Dictionary<string, string> options, ulong sectors,
+                           uint   sectorSize)
+        {
+            if(sectorSize != 512)
+            {
+                ErrorMessage = "Unsupported sector size";
+                return false;
+            }
+
+            if(sectors > 0xFFFFFF)
+            {
+                ErrorMessage = $"Too many sectors";
+                return false;
+            }
+
+            if(!SupportedMediaTypes.Contains(mediaType))
+            {
+                ErrorMessage = $"Unsupport media format {mediaType}";
+                return false;
+            }
+
+            imageInfo = new ImageInfo {MediaType = mediaType, SectorSize = sectorSize, Sectors = sectors};
+
+            try { writingStream = new FileStream(path, FileMode.CreateNew, FileAccess.ReadWrite, FileShare.None); }
+            catch(IOException e)
+            {
+                ErrorMessage = $"Could not create new image file, exception {e.Message}";
+                return false;
+            }
+
+            IsWriting    = true;
+            ErrorMessage = null;
+            return true;
+        }
+
+        public bool WriteMediaTag(byte[] data, MediaTagType tag)
+        {
+            ErrorMessage = "Writing media tags is not supported.";
+            return false;
+        }
+
+        public bool WriteSector(byte[] data, ulong sectorAddress)
+        {
+            int longSectorSize = imageInfo.MediaType == MediaType.PriamDataTower ? 536 : 532;
+
+            if(!IsWriting)
+            {
+                ErrorMessage = "Tried to write on a non-writable image";
+                return false;
+            }
+
+            if(data.Length != 512)
+            {
+                ErrorMessage = "Incorrect data size";
+                return false;
+            }
+
+            if(sectorAddress >= imageInfo.Sectors)
+            {
+                ErrorMessage = "Tried to write past image size";
+                return false;
+            }
+
+            writingStream.Seek(longSectorSize + (long)sectorAddress * longSectorSize, SeekOrigin.Begin);
+            writingStream.Write(data, 0, data.Length);
+
+            ErrorMessage = "";
+            return true;
+        }
+
+        public bool WriteSectors(byte[] data, ulong sectorAddress, uint length)
+        {
+            int longSectorSize = imageInfo.MediaType == MediaType.PriamDataTower ? 536 : 532;
+
+            if(!IsWriting)
+            {
+                ErrorMessage = "Tried to write on a non-writable image";
+                return false;
+            }
+
+            if(data.Length % 512 != 0)
+            {
+                ErrorMessage = "Incorrect data size";
+                return false;
+            }
+
+            if(sectorAddress + length > imageInfo.Sectors)
+            {
+                ErrorMessage = "Tried to write past image size";
+                return false;
+            }
+
+            writingStream.Seek(longSectorSize + (long)sectorAddress * longSectorSize, SeekOrigin.Begin);
+            writingStream.Write(data, 0, data.Length);
+
+            ErrorMessage = "";
+            return true;
+        }
+
+        public bool WriteSectorLong(byte[] data, ulong sectorAddress)
+        {
+            if(!IsWriting)
+            {
+                ErrorMessage = "Tried to write on a non-writable image";
+                return false;
+            }
+
+            if(sectorAddress >= imageInfo.Sectors)
+            {
+                ErrorMessage = "Tried to write past image size";
+                return false;
+            }
+
+            int longSectorSize = imageInfo.MediaType == MediaType.PriamDataTower ? 536 : 532;
+
+            byte[] oldTag;
+            byte[] newTag;
+
+            switch(data.Length - 512)
+            {
+                // Sony tag, convert to Profile
+                case 12 when longSectorSize == 532:
+                    oldTag = new byte[12];
+                    Array.Copy(data, 512, oldTag, 0, 12);
+                    newTag = LisaTag.DecodeSonyTag(oldTag)?.ToProfile().GetBytes();
+                    break;
+                // Sony tag, convert to Priam
+                case 12 when longSectorSize == 536:
+                    oldTag = new byte[12];
+                    Array.Copy(data, 512, oldTag, 0, 12);
+                    newTag = LisaTag.DecodeSonyTag(oldTag)?.ToPriam().GetBytes();
+                    break;
+                // Profile tag, copy to Profile
+                case 20 when longSectorSize == 532:
+                    newTag = new byte[20];
+                    Array.Copy(data, 512, newTag, 0, 20);
+                    break;
+                // Profile tag, convert to Priam
+                case 20 when longSectorSize == 536:
+                    oldTag = new byte[20];
+                    Array.Copy(data, 512, oldTag, 0, 20);
+                    newTag = LisaTag.DecodeProfileTag(oldTag)?.ToPriam().GetBytes();
+                    break;
+                // Priam tag, convert to Profile
+                case 24 when longSectorSize == 532:
+                    oldTag = new byte[24];
+                    Array.Copy(data, 512, oldTag, 0, 24);
+                    newTag = LisaTag.DecodePriamTag(oldTag)?.ToProfile().GetBytes();
+                    break;
+                // Priam tag, copy to Priam
+                case 12 when longSectorSize == 536:
+                    newTag = new byte[24];
+                    Array.Copy(data, 512, newTag, 0, 24);
+                    break;
+                case 0:
+                    newTag = null;
+                    break;
+                default:
+                    ErrorMessage = "Incorrect data size";
+                    return false;
+            }
+
+            if(newTag == null) newTag = new byte[longSectorSize - 512];
+
+            writingStream.Seek(longSectorSize + (long)sectorAddress * longSectorSize, SeekOrigin.Begin);
+            writingStream.Write(data,   0, 512);
+            writingStream.Write(newTag, 0, newTag.Length);
+
+            ErrorMessage = "";
+            return true;
+        }
+
+        public bool WriteSectorsLong(byte[] data, ulong sectorAddress, uint length)
+        {
+            if(!IsWriting)
+            {
+                ErrorMessage = "Tried to write on a non-writable image";
+                return false;
+            }
+
+            if(sectorAddress + length > imageInfo.Sectors)
+            {
+                ErrorMessage = "Tried to write past image size";
+                return false;
+            }
+
+            int  longSectorSize  = imageInfo.MediaType == MediaType.PriamDataTower ? 536 : 532;
+            long givenSectorSize = data.Length / length;
+
+            switch(givenSectorSize)
+            {
+                case 536:
+                case 532:
+                case 524:
+                case 512: break;
+                default:
+                    ErrorMessage = "Incorrect data size";
+                    return false;
+            }
+
+            for(uint i = 0; i < length; i++)
+            {
+                byte[] oldTag;
+                byte[] newTag;
+
+                switch(givenSectorSize - 512)
+                {
+                    // Sony tag, convert to Profile
+                    case 12 when longSectorSize == 532:
+                        oldTag = new byte[12];
+                        Array.Copy(data, givenSectorSize * i + 512, oldTag, 0, 12);
+                        newTag = LisaTag.DecodeSonyTag(oldTag)?.ToProfile().GetBytes();
+                        break;
+                    // Sony tag, convert to Priam
+                    case 12 when longSectorSize == 536:
+                        oldTag = new byte[12];
+                        Array.Copy(data, givenSectorSize * i + 512, oldTag, 0, 12);
+                        newTag = LisaTag.DecodeSonyTag(oldTag)?.ToPriam().GetBytes();
+                        break;
+                    // Profile tag, copy to Profile
+                    case 20 when longSectorSize == 532:
+                        newTag = new byte[20];
+                        Array.Copy(data, givenSectorSize * i + 512, newTag, 0, 20);
+                        break;
+                    // Profile tag, convert to Priam
+                    case 20 when longSectorSize == 536:
+                        oldTag = new byte[20];
+                        Array.Copy(data, givenSectorSize * i + 512, oldTag, 0, 20);
+                        newTag = LisaTag.DecodeProfileTag(oldTag)?.ToPriam().GetBytes();
+                        break;
+                    // Priam tag, convert to Profile
+                    case 24 when longSectorSize == 532:
+                        oldTag = new byte[24];
+                        Array.Copy(data, givenSectorSize * i + 512, oldTag, 0, 24);
+                        newTag = LisaTag.DecodePriamTag(oldTag)?.ToProfile().GetBytes();
+                        break;
+                    // Priam tag, copy to Priam
+                    case 12 when longSectorSize == 536:
+                        newTag = new byte[24];
+                        Array.Copy(data, givenSectorSize * i + 512, newTag, 0, 24);
+                        break;
+                    case 0:
+                        newTag = null;
+                        break;
+                    default:
+                        ErrorMessage = "Incorrect data size";
+                        return false;
+                }
+
+                if(newTag == null) newTag = new byte[longSectorSize - 512];
+
+                writingStream.Seek(longSectorSize + (long)sectorAddress * longSectorSize, SeekOrigin.Begin);
+                writingStream.Write(data,   (int)(givenSectorSize       * i), 512);
+                writingStream.Write(newTag, 0,                                newTag.Length);
+            }
+
+            ErrorMessage = "";
+            return true;
+        }
+
+        public bool SetTracks(List<Track> tracks)
+        {
+            ErrorMessage = "Unsupported feature";
+            return false;
+        }
+
+        public bool Close()
+        {
+            if(!IsWriting)
+            {
+                ErrorMessage = "Image is not opened for writing";
+                return false;
+            }
+
+            BigEndianBitConverter.IsLittleEndian = BitConverter.IsLittleEndian;
+            byte[] markerTag                     = Encoding.UTF8.GetBytes("DiscImageChef " + Version.GetVersion());
+            byte[] driveName;
+            byte[] driveType      = new byte[3];
+            byte[] driveBlocks    = BigEndianBitConverter.GetBytes((uint)imageInfo.Sectors);
+            int    longSectorSize = imageInfo.MediaType == MediaType.PriamDataTower ? 536 : 532;
+            byte[] blockSize      = BigEndianBitConverter.GetBytes((ushort)longSectorSize);
+
+            switch(imageInfo.MediaType)
+            {
+                case MediaType.AppleProfile when imageInfo.Sectors == 0x4C00:
+                    driveName = Encoding.ASCII.GetBytes(PROFILE10_NAME);
+                    break;
+                case MediaType.AppleWidget when imageInfo.Sectors == 0x4C00:
+                    driveType[1] = 0x01;
+                    driveName    = Encoding.ASCII.GetBytes(PROFILE10_NAME);
+                    break;
+                case MediaType.PriamDataTower when imageInfo.Sectors == 0x22C7C:
+                    driveType[1] = 0xFF;
+                    driveName    = Encoding.ASCII.GetBytes(PRIAM_NAME);
+                    break;
+                default:
+                    driveName = Encoding.ASCII.GetBytes(PROFILE_NAME);
+                    break;
+            }
+
+            writingStream.Seek(0, SeekOrigin.Begin);
+            writingStream.Write(driveName, 0, driveName.Length >= 0xD ? 0xD : driveName.Length);
+            writingStream.Seek(0xD, SeekOrigin.Begin);
+            writingStream.Write(driveType, 0, 3);
+            writingStream.Seek(0x12, SeekOrigin.Begin);
+            writingStream.Write(driveBlocks, 1, 3);
+            writingStream.Seek(0x15, SeekOrigin.Begin);
+            writingStream.Write(blockSize, 1, 2);
+            writingStream.Seek(512, SeekOrigin.Begin);
+            writingStream.Write(markerTag, 0,
+                                markerTag.Length >= longSectorSize - 512 ? longSectorSize - 512 : markerTag.Length);
+
+            writingStream.Flush();
+            writingStream.Close();
+
+            return true;
+        }
+
+        public bool SetMetadata(ImageInfo metadata)
+        {
+            return true;
+        }
+
+        public bool SetGeometry(uint cylinders, uint heads, uint sectorsPerTrack)
+        {
+            // Geometry is not stored in image
+            return true;
+        }
+
+        public bool WriteSectorTag(byte[] data, ulong sectorAddress, SectorTagType tag)
+        {
+            ErrorMessage = "Unsupported feature";
+            return false;
+        }
+
+        public bool WriteSectorsTag(byte[] data, ulong sectorAddress, uint length, SectorTagType tag)
+        {
+            ErrorMessage = "Unsupported feature";
+            return false;
+        }
+
+        struct BluHeader
+        {
+            public byte[] DeviceName;
+            public uint   DeviceType;
+            public uint   DeviceBlocks;
+            public ushort BytesPerBlock;
+        }
     }
 }