Merge pull request #95 from kishikawakatsumi/debugdescription

Improve debug description

Sources/SMBClient/FileTime.swift

@@ -21,6 +21,10 @@ public struct FileTime {
 
 extension FileTime: CustomDebugStringConvertible {
   public var debugDescription: String {
-    date.debugDescription
+    if raw == 0 {
+      return "No time specified \(raw)"
+    } else {
+      return date.description
+    }
   }
 }

Sources/SMBClient/Messages/Close+CustomDebugStringConvertible.swift

@@ -0,0 +1,42 @@
+import Foundation
+
+extension Close.Request: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    """
+    \(header)
+    Close Request (\(String(format: "0x%02x", header.command)))
+      StructureSize: \(structureSize)
+      Close Flags: \(flags)
+      Reserved: \(String(format: "%04x", reserved))
+      GUID handle File: \(UUID(data: fileId))
+    """
+  }
+}
+
+extension Close.Response: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    """
+    \(header)
+    Close Response (\(String(format: "0x%02x", header.command)))
+      StructureSize: \(structureSize)
+      Flags: \(flags)
+      Reserved: \(String(format: "%04x", reserved))
+      Create: \(FileTime(creationTime))
+      Last Access: \(FileTime(lastAccessTime))
+      Last Write: \(FileTime(lastWriteTime))
+      Last Change: \(FileTime(changeTime))
+      Allocation Size: \(allocationSize)
+      End Of File: \(endOfFile)
+      File Attributes: \(FileAttributes(rawValue: fileAttributes))
+    """
+  }
+}
+
+extension Close.Flags: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    switch self {
+    case .postQueryAttrib:
+      return "\(String(format: "0x%04x", rawValue)) (PostQuery Attrib: True)"
+    }
+  }
+}

Sources/SMBClient/Messages/Create+CustomDebugStringConvertible.swift

@@ -0,0 +1,262 @@
+import Foundation
+
+extension Create.Request: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    """
+    \(header)
+    Create Request (\(String(format: "0x%02x", header.command)))
+      StructureSize: \(structureSize)
+      Security Flags: \(securityFlags)
+      Oplock: \(Create.OplockLevel.debugDescription(rawValue: requestedOplockLevel))
+      Impersonation level: \(Create.ImpersonationLevel.debugDescription(rawValue: impersonationLevel))
+      Create Flags: \(String(format: "0x%016x", smbCreateFlags))
+      Reserved: \(String(format: "0x%016x", reserved))
+      Access Mask: \(desiredAccess)
+      File Attributes: \(fileAttributes)
+      Share Access: \(shareAccess)
+      Disposition: \(Create.CreateDisposition.debugDescription(rawValue: createDisposition))
+      Create Options: \(createOptions)
+      Blob Offset: \(nameOffset)
+      Blob Length: \(nameLength)
+      Create Contexts Offset: \(createContextsOffset)
+      Create Contexts Length: \(createContextsLength)
+      Filename: \(String(data: buffer, encoding: .utf16LittleEndian) ?? buffer.hex)
+    """
+  }
+}
+
+extension Create.Response: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    """
+    \(header)
+    Create Response (\(String(format: "0x%02x", header.command)))
+      StructureSize: \(structureSize)
+      Oplock: \(Create.OplockLevel.debugDescription(rawValue: oplockLevel))
+      Response Flags: \(flags)
+      Create Action: \(Create.CreateAction.debugDescription(rawValue: createAction))
+      Create: \(FileTime(creationTime))
+      Last Access: \(FileTime(lastAccessTime))
+      Last Write: \(FileTime(lastWriteTime))
+      Last Change: \(FileTime(changeTime))
+      Allocation Size: \(allocationSize)
+      End Of File: \(endOfFile)
+      File Attributes: \(fileAttributes)
+      Reserved: \(String(format: "%04x", reserved2))
+      GUID handle File: \(UUID(data: fileId))
+      Blob Offset: \(createContextsOffset)
+      Blob Length: \(createContextsLength)
+      ExtraInfo: \(buffer.hex)
+    """
+  }
+}
+
+extension Create.OplockLevel: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    switch self {
+    case .none:
+      return "No oplock"
+    case .ii:
+      return "Level2 oplock"
+    case .exclusive:
+      return "Exclusive oplock"
+    case .batch:
+      return "Batch oplock"
+    case .lease:
+      return "Lease"
+
+    }
+  }
+
+  static public func debugDescription(rawValue: UInt8) -> String {
+    if let oplockLevel = Create.OplockLevel(rawValue: rawValue) {
+      return oplockLevel.debugDescription
+    } else {
+      return String(format: "0x%02x", rawValue)
+    }
+  }
+}
+
+extension Create.ImpersonationLevel: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    switch self {
+    case .anonymous:
+      return "Anonymous"
+    case .identification:
+      return "Identification"
+    case .impersonation:
+      return "Impersonation"
+    case .delegation:
+      return "Delegation"
+    }
+  }
+
+  static public func debugDescription(rawValue: UInt32) -> String {
+    if let impersonationLevel =  Create.ImpersonationLevel(rawValue: rawValue) {
+      return impersonationLevel.debugDescription
+    } else {
+      return String(format: "0x%08x", rawValue)
+    }
+  }
+}
+
+extension Create.ShareAccess: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    var values = [String]()
+    if contains(.read) {
+      values.append("Read")
+    }
+    if contains(.write) {
+      values.append("Write")
+    }
+    if contains(.delete) {
+      values.append("Delete")
+    }
+
+    if values.isEmpty {
+      return "\(String(format: "0x%08x", rawValue))"
+    } else {
+      return "\(String(format: "0x%08x", rawValue)) (\(values.joined(separator: ", ")))"
+    }
+  }
+}
+
+extension Create.CreateDisposition: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    switch self {
+    case .supersede:
+      return "Supersede (supersede existing file (if it exists))"
+    case .open:
+      return "Open (if file exists open it, else fail)"
+    case .create:
+      return "Create (if file exists fail, else create it)"
+    case .openIf:
+      return "Open If (if file exists open it, else create it)"
+    case .overwrite:
+      return "Overwrite (if file exists overwrite, else fail)"
+    case .overwriteIf:
+      return "Overwrite If (if file exists overwrite, else create it)"
+    }
+  }
+
+  static public func debugDescription(rawValue: UInt32) -> String {
+    if let disposition = Create.CreateDisposition(rawValue: rawValue) {
+      return disposition.debugDescription
+    } else {
+      return String(format: "0x%08x", rawValue)
+    }
+  }
+}
+
+extension Create.CreateOptions: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    var values = [String]()
+
+    if contains(.directoryFile) {
+      values.append("Directory")
+    }
+    if contains(.writeThrough) {
+      values.append("Write Through")
+    }
+    if contains(.sequentialOnly) {
+      values.append("Sequential Only")
+    }
+    if contains(.noIntermediateBuffering) {
+      values.append("Intermediate Buffering")
+    }
+    if contains(.synchronousIoAlert) {
+      values.append("Sync I/O Alert")
+    }
+    if contains(.synchronousIoNonAlert) {
+      values.append("Sync I/O Nonalert")
+    }
+    if contains(.nonDirectoryFile) {
+      values.append("Non-Directory")
+    }
+    if contains(.completeIfOplocked) {
+      values.append("Complete If Oplocked")
+    }
+    if contains(.noEaKnowledge) {
+      values.append("No EA Knowledge")
+    }
+    if contains(.randomAccess) {
+      values.append("Random Access")
+    }
+    if contains(.deleteOnClose) {
+      values.append("Delete On Close")
+    }
+    if contains(.openByFileId) {
+      values.append("Open By FileID")
+    }
+    if contains(.openForBackupIntent) {
+      values.append("Backup Intent")
+    }
+    if contains(.noCompression) {
+      values.append("No Compression")
+    }
+    if contains(.openRemoteInstance) {
+      values.append("Open Remote Instance")
+    }
+    if contains(.requiringOplock) {
+      values.append("Requiring Oplock")
+    }
+    if contains(.disallowExclusive) {
+      values.append("Disallow Exclusive")
+    }
+    if contains(.reserveOpfilter) {
+      values.append("Reserve Opfilter")
+    }
+    if contains(.openReparsePoint) {
+      values.append("Open Reparse Point")
+    }
+    if contains(.openNoRecall) {
+      values.append("Open No Recall")
+    }
+    if contains(.openForFreeSpaceQuery) {
+      values.append("Open For Free Space Query")
+    }
+
+    if values.isEmpty {
+      return "\(String(format: "0x%08x", rawValue))"
+    } else {
+      return "\(String(format: "0x%08x", rawValue)) (\(values.joined(separator: ", ")))"
+    }
+  }
+}
+
+extension Create.Flags: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    var values = [String]()
+    if contains(.releasePoint) {
+      values.append("Release Point")
+    }
+
+    if values.isEmpty {
+      return "\(String(format: "0x%02x", rawValue))"
+    } else {
+      return "\(String(format: "0x%02x", rawValue)) (\(values.joined(separator: ", ")))"
+    }
+  }
+}
+
+extension Create.CreateAction: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    switch self {
+    case .superseded:
+      return "No action taken?"
+    case .opened:
+      return "The file existed and was opened"
+    case .created:
+      return "The file did not exist but was created"
+    case .overwritten:
+      return "The file existed and was truncated"
+    }
+  }
+
+  static public func debugDescription(rawValue: UInt32) -> String {
+    if let action = Create.CreateAction(rawValue: rawValue) {
+      return action.debugDescription
+    } else {
+      return String(format: "0x%08x", rawValue)
+    }
+  }
+}

Sources/SMBClient/Messages/Create.swift

@@ -112,23 +112,6 @@ public enum Create {
     public let createContextsLength: UInt32
     public let buffer: Data
 
-    public struct Flags: OptionSet, Sendable {
-      public let rawValue: UInt8
-
-      public init(rawValue: UInt8) {
-        self.rawValue = rawValue
-      }
-
-      public static let releasePoint = Flags(rawValue: 0x00000001)
-    }
-
-    public enum CreateAction: UInt32 {
-      case superseded = 0x00000000
-      case opened = 0x00000001
-      case created = 0x00000002
-      case overwritten = 0x00000003
-    }
-
     public init(data: Data) {
       let reader = ByteReader(data)
 
@@ -222,4 +205,21 @@ public enum Create {
     public static let openNoRecall = CreateOptions(rawValue: 0x00400000)
     public static let openForFreeSpaceQuery = CreateOptions(rawValue: 0x00800000)
   }
+
+  public struct Flags: OptionSet, Sendable {
+    public let rawValue: UInt8
+
+    public init(rawValue: UInt8) {
+      self.rawValue = rawValue
+    }
+
+    public static let releasePoint = Flags(rawValue: 0x00000001)
+  }
+
+  public enum CreateAction: UInt32 {
+    case superseded = 0x00000000
+    case opened = 0x00000001
+    case created = 0x00000002
+    case overwritten = 0x00000003
+  }
 }