Merge pull request #540 from insidegui/new-vm-thumbnail

Revamp virtual machine thumbnails

Author: insidegui

VirtualBuddy.xcodeproj/project.pbxproj

@@ -2,10 +2,13 @@ import Cocoa
 import SwiftUI
 import VirtualUI
 import VirtualWormhole
+import OSLog
 
 @NSApplicationMain
 final class GuestAppDelegate: NSObject, NSApplicationDelegate {
 
+    private let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "Guest", category: "GuestAppDelegate")
+
     private lazy var launchAtLoginManager = GuestLaunchAtLoginManager()
 
     private lazy var sharedFolders = GuestSharedFoldersManager()
@@ -40,6 +43,8 @@ final class GuestAppDelegate: NSObject, NSApplicationDelegate {
         }
     }
 
+    private var isPoweringOff = false
+
     func applicationDidFinishLaunching(_ notification: Notification) {
         /// Skip regular app activation if installation is needed (i.e. running from disk image).
         guard !installer.needsInstall else { return }
@@ -55,6 +60,12 @@ final class GuestAppDelegate: NSObject, NSApplicationDelegate {
         dashboardItem.install()
 
         perform(#selector(showPanelForFirstLaunchIfNeeded), with: nil, afterDelay: 0.5)
+
+        NSWorkspace.shared.notificationCenter.addObserver(forName: NSWorkspace.willPowerOffNotification, object: nil, queue: nil) { _ in
+            self.logger.notice("Received power off notification.")
+            
+            self.isPoweringOff = true
+        }
     }
 
     func applicationShouldHandleReopen(_ sender: NSApplication, hasVisibleWindows flag: Bool) -> Bool {
@@ -76,4 +87,19 @@ final class GuestAppDelegate: NSObject, NSApplicationDelegate {
         dashboardItem.showPanel()
     }
 
+    func applicationShouldTerminate(_ sender: NSApplication) -> NSApplication.TerminateReply {
+        logger.debug(#function)
+
+        guard isPoweringOff else { return .terminateNow }
+
+        logger.notice("Guest is powering off, delaying slightly to allow for final messages to be sent to host.")
+
+        DispatchQueue.main.asyncAfter(deadline: .now() + 1) { [self] in
+            logger.notice("Allowing guest to terminate now.")
+            NSApp.reply(toApplicationShouldTerminate: true)
+        }
+
+        return .terminateLater
+    }
+
 }

VirtualBuddyGuest/GuestAppDelegate.swift

@@ -9,8 +9,13 @@ public extension VBVirtualMachine {
     static func previewMachine(named name: String) -> VBVirtualMachine {
         try! VBVirtualMachine(bundleURL: Bundle.virtualCore.url(forResource: name, withExtension: VBVirtualMachine.bundleExtension, subdirectory: previewLibraryDirName)!)
     }
-    static let preview = VBVirtualMachine.previewMachine(named: "Preview")
-    static let previewLinux = VBVirtualMachine.previewMachine(named: "Preview-Linux")
+    static let preview = VBVirtualMachine.previewMachine(named: "PreviewMac")
+    static let previewBlurHash = VBVirtualMachine.previewMachine(named: "PreviewMacBlurHash")
+    static let previewNoArtwork = VBVirtualMachine.previewMachine(named: "PreviewMacNoArtwork")
+
+    static let previewLinux = VBVirtualMachine.previewMachine(named: "PreviewLinux")
+    static let previewLinuxBlurHash = VBVirtualMachine.previewMachine(named: "PreviewLinuxBlurHash")
+    static let previewLinuxNoArtwork = VBVirtualMachine.previewMachine(named: "PreviewLinuxNoArtwork")
 }
 
 extension Bundle {

VirtualCore/Source/Definitions/PreviewSupport.swift

@@ -85,7 +85,9 @@ public final class GuestAdditionsDiskImage {
         }
     }
 
-    private var imagesRootURL: URL { URL.defaultVirtualBuddyLibraryURL.appendingPathComponent("_GuestImage") }
+    static let imagesRootURL: URL = URL.defaultVirtualBuddyLibraryURL.appendingPathComponent("_GuestImage")
+
+    private var imagesRootURL: URL { Self.imagesRootURL }
 
     private var installedImageDigestURL: URL {
         imagesRootURL

VirtualCore/Source/GuestSupport/GuestAdditionsDiskImage.swift

@@ -28,4 +28,10 @@ public extension BlurHashToken {
         value: "U4H09BEfIY$%U7ocVcM$8%R*M}f~zwIXcArd",
         size: 4
     )
+
+    /// Hardcoded VirtualBuddy background blur hash for Linux VMs.
+    static let virtualBuddyBackgroundLinux = BlurHashToken(
+        value: "UsLn]CG1I;t19uxAR$jJOXjEj=ayn%fkjubI",
+        size: 4
+    )
 }

VirtualCore/Source/Models/BlurHashToken.swift

@@ -22,25 +22,21 @@ public extension VBVirtualMachine {
     }
 
     func deleteMetadataFile(named name: String) throws {
-        let baseURL = try metadataDirectoryCreatingIfNeeded()
-
-        let fileURL = baseURL.appendingPathComponent(name)
+        let fileURL = metadataDirectoryURL.appendingPathComponent(name)
 
         guard FileManager.default.fileExists(atPath: fileURL.path) else { return }
 
         try FileManager.default.removeItem(at: fileURL)
     }
 
-    func metadataFileURL(_ fileName: String) throws -> URL {
-        let baseURL = try metadataDirectoryCreatingIfNeeded()
-
-        let fileURL = baseURL.appendingPathComponent(fileName)
+    func metadataFileURL(_ fileName: String) -> URL {
+        let fileURL = metadataDirectoryURL.appendingPathComponent(fileName)
 
         return fileURL
     }
 
     func metadataContents(_ fileName: String) -> Data? {
-        guard let fileURL = try? metadataFileURL(fileName) else { return nil }
+        let fileURL = metadataFileURL(fileName)
 
         guard FileManager.default.fileExists(atPath: fileURL.path) else { return nil }
 
@@ -57,3 +53,19 @@ extension URL {
         return self
     }
 }
+
+extension URL {
+    /// `true` if URL points to a file contained within a VirtualBuddy VM bundle metadata directory.
+    var isVirtualBuddyDataDirectoryFile: Bool {
+        deletingLastPathComponent().lastPathComponent == VBVirtualMachine.metadataDirectoryName
+    }
+
+    var virtualMachineBundleParent: URL? {
+        var current = self
+        while current.pathExtension != VBVirtualMachine.bundleExtension {
+            current = current.deletingLastPathComponent()
+            guard current.path != "/" else { return nil }
+        }
+        return current
+    }
+}

VirtualCore/Source/Models/VBVirtualMachine+Metadata.swift

@@ -7,8 +7,13 @@ public extension VBVirtualMachine {
         return NSImage(data: imageData)
     }
 
+    var thumbnail: NSImage? {
+        guard let imageData = metadataContents(VBVirtualMachine.thumbnailFileName) ?? metadataContents(VBVirtualMachine._legacyThumbnailFileName) else { return nil }
+        return NSImage(data: imageData)
+    }
+
     func thumbnailImage() -> NSImage? {
-        guard let thumbnailURL = try? metadataFileURL(Self.thumbnailFileName) else { return nil }
+        let thumbnailURL = metadataFileURL(Self.thumbnailFileName)
 
         if let existingImage = NSImage(contentsOf: thumbnailURL) {
             return existingImage
@@ -19,10 +24,6 @@ public extension VBVirtualMachine {
 
     func invalidateThumbnail() throws {
         try deleteMetadataFile(named: Self.thumbnailFileName)
-
-        DispatchQueue.main.async {
-            self.didInvalidateThumbnail.send()
-        }
     }
 
 }

VirtualCore/Source/Models/VBVirtualMachine+Screenshot.swift

@@ -7,7 +7,7 @@ public typealias BoolSubject = PassthroughSubject<Bool, Never>
 
 public struct VBVirtualMachine: Identifiable, VBStorageDeviceContainer {
 
-    public struct Metadata: Codable {
+    public struct Metadata: Hashable, Codable {
         public static let currentVersion = 1
         @DecodableDefault.EmptyPlaceholder
         public var uuid = UUID()
@@ -40,6 +40,12 @@ public struct VBVirtualMachine: Identifiable, VBStorageDeviceContainer {
                 remoteInstallImageURL = url
             }
         }
+
+        /// If Linux VM is using fallback VirtualBuddy orange background hash, updates it to use the Linux-specific one.
+        fileprivate mutating func setLinuxBackgroundHashIfNeeded() {
+            guard backgroundHash == .virtualBuddyBackground else { return }
+            backgroundHash = .virtualBuddyBackgroundLinux
+        }
     }
 
     public var id: String { bundleURL.absoluteString }
@@ -72,8 +78,6 @@ public struct VBVirtualMachine: Identifiable, VBStorageDeviceContainer {
         get { _installRestoreData }
         set { _installRestoreData = newValue }
     }
-
-    public private(set) var didInvalidateThumbnail = VoidSubject()
 
 }
 
@@ -110,8 +114,10 @@ extension VBVirtualMachine {
 
     public var metadataDirectoryURL: URL { Self.metadataDirectoryURL(for: bundleURL) }
 
+    static let metadataDirectoryName = ".vbdata"
+
     static func metadataDirectoryURL(for bundleURL: URL) -> URL {
-        bundleURL.appendingPathComponent(".vbdata")
+        bundleURL.appendingPathComponent(metadataDirectoryName)
     }
 
     public var needsInstall: Bool {
@@ -131,8 +137,19 @@ public extension UTType {
 }
 
 public extension VBVirtualMachine {
-    
-    init(bundleURL: URL, isNewInstall: Bool = false) throws {
+
+    struct BundleDirectoryMissingError: Error { }
+
+    init(bundleURL: URL, isNewInstall: Bool = false, createIfNeeded: Bool = true) throws {
+        /// If we're not allowed to create the bundle and its metadata directory doesn't exist, throw a specific error type that's caught in ``VMLibraryController``.
+        /// This is to prevent the app from creating a dummy VM bundle after a VM is deleted from the library.
+        if !createIfNeeded {
+            let metaDirectory = bundleURL.appending(path: Self.metadataDirectoryName, directoryHint: .isDirectory)
+            guard metaDirectory.isReadableDirectory else {
+                throw BundleDirectoryMissingError()
+            }
+        }
+
         if !FileManager.default.fileExists(atPath: bundleURL.path) {
             #if DEBUG
             guard !ProcessInfo.isSwiftUIPreview else {
@@ -142,14 +159,19 @@ public extension VBVirtualMachine {
 
             try FileManager.default.createDirectory(at: bundleURL, withIntermediateDirectories: true)
         }
-        
+
         self.bundleURL = bundleURL
         var (metadata, config, installRestore) = try loadMetadata()
 
         /// Migration from previous versions that didn't have a configuration file
         /// describing the storage devices.
         config.hardware.addMissingBootDeviceIfNeeded()
-        
+
+        /// Migration from previous versions that didn't have dedicated fallback artwork for Linux.
+        if config.systemType == .linux {
+            metadata?.setLinuxBackgroundHashIfNeeded()
+        }
+
         self.configuration = config
 
         if let metadata {
@@ -170,6 +192,7 @@ public extension VBVirtualMachine {
         self.configuration = .init(systemType: .linux)
 
         self.metadata = Metadata(installFinished: false, firstBootDate: .now, lastBootDate: .now)
+        metadata.setLinuxBackgroundHashIfNeeded()
 
         try saveMetadata()
     }
@@ -197,10 +220,6 @@ public extension VBVirtualMachine {
     }
 
     func loadMetadata() throws -> (Metadata?, VBMacConfiguration, Data?) {
-        #if DEBUG
-        guard !ProcessInfo.isSwiftUIPreview else { return (nil, .default, nil) }
-        #endif
-
         let metadata: Metadata?
         let config: VBMacConfiguration
         let installRestore: Data?