Thumbnail generator

Whisky-App · Sep 10, 2023 · edcb5cb · edcb5cb
1 parent ccc172b
commit edcb5cb
Show file tree

Hide file tree

Showing 17 changed files with 354 additions and 64 deletions.
diff --git a/Whisky.xcodeproj/project.pbxproj b/Whisky.xcodeproj/project.pbxproj
diff --git a/Whisky/Views/Bottle Views/BottleView.swift b/Whisky/Views/Bottle Views/BottleView.swift
@@ -8,6 +8,7 @@
 import SwiftUI
 import UniformTypeIdentifiers
 import QuickLookThumbnailing
+import WhiskyKit
 
 struct BottleView: View {
     @Binding var bottle: Bottle
@@ -275,19 +276,7 @@ struct ShellLinkView: View {
             if let linkInfo = link.linkInfo, let program = linkInfo.program {
                 do {
                     let peFile = try PEFile(data: Data(contentsOf: program.url))
-                    var icons: [NSImage] = []
-                    if let resourceSection = peFile.resourceSection {
-                        for entries in resourceSection.allEntries where entries.icon.isValid {
-                            icons.append(entries.icon)
-                        }
-                    } else {
-                        print("No resource section")
-                        return
-                    }
-
-                    if icons.count > 0 {
-                        image = icons.max(by: { $0.size.height < $1.size.height })
-                    }
+                    image = peFile.bestIcon()
                 } catch {
                     print(error)
                 }
@@ -334,19 +323,7 @@ struct ShortcutView: View {
                                   bottle: bottle)
             do {
                 let peFile = try PEFile(data: Data(contentsOf: program.url))
-                var icons: [NSImage] = []
-                if let resourceSection = peFile.resourceSection {
-                    for entries in resourceSection.allEntries where entries.icon.isValid {
-                        icons.append(entries.icon)
-                    }
-                } else {
-                    print("No resource section")
-                    return
-                }
-
-                if icons.count > 0 {
-                    image = icons.max(by: { $0.size.height < $1.size.height })
-                }
+                image = peFile.bestIcon()
             } catch {
                 print(error)
             }

diff --git a/Whisky/Views/ProgramView.swift b/Whisky/Views/ProgramView.swift
@@ -6,6 +6,7 @@
 //
 
 import SwiftUI
+import WhiskyKit
 
 struct ProgramView: View {
     @Binding var program: Program
@@ -86,19 +87,7 @@ struct ProgramView: View {
         .onAppear {
             do {
                 let peFile = try PEFile(data: Data(contentsOf: program.url))
-                var icons: [NSImage] = []
-                if let resourceSection = peFile.resourceSection {
-                    for entries in resourceSection.allEntries where entries.icon.isValid {
-                        icons.append(entries.icon)
-                    }
-                } else {
-                    print("No resource section")
-                    return
-                }
-
-                if icons.count > 0 {
-                    image = icons.max(by: { $0.size.height < $1.size.height })
-                }
+                image = peFile.bestIcon()
             } catch {
                 print(error)
             }

diff --git a/Whisky/Extensions/DataExtensions.swift → WhiskyKit/Extensions/DataExtensions.swift b/Whisky/Extensions/DataExtensions.swift → WhiskyKit/Extensions/DataExtensions.swift
@@ -1,14 +1,14 @@
 //
 //  DataExtensions.swift
-//  Whisky
+//  WhiskyKit
 //
 //  Created by Isaac Marovitz on 01/04/2023.
 //
 
 import Foundation
 
 extension Data {
-    func extract<T>(_ type: T.Type, offset: Int = 0) -> T? {
+    public func extract<T>(_ type: T.Type, offset: Int = 0) -> T? {
         if offset + MemoryLayout<T>.size < self.count {
             let data = self[offset..<offset + MemoryLayout<T>.size]
             return data.withUnsafeBytes { $0.loadUnaligned(as: T.self) }
@@ -18,7 +18,7 @@ extension Data {
     }
 
     // Thanks ChatGPT
-    func nullTerminatedStrings(using encoding: String.Encoding = .utf8) -> [String] {
+    public func nullTerminatedStrings(using encoding: String.Encoding = .utf8) -> [String] {
         var strings = [String]()
         self.withUnsafeBytes { (ptr: UnsafeRawBufferPointer) in
             if let baseAddress = ptr.baseAddress {

diff --git a/Whisky/Extensions/URLExtensions.swift → WhiskyKit/Extensions/URLExtensions.swift b/Whisky/Extensions/URLExtensions.swift → WhiskyKit/Extensions/URLExtensions.swift
@@ -1,14 +1,14 @@
 //
 //  URLExtensions.swift
-//  Whisky
+//  WhiskyKit
 //
 //  Created by Isaac Marovitz on 13/06/2023.
 //
 
 import Foundation
 
 extension String {
-    var esc: String {
+    public var esc: String {
         let esc = ["\\", "\"", "'", " ", "(", ")", "[", "]", "{", "}", "&", "|",
                    ";", "<", ">", "`", "$", "!", "*", "?", "#", "~", "="]
         var str = self
@@ -20,11 +20,11 @@ extension String {
 }
 
 extension URL {
-    var esc: String {
+    public var esc: String {
         path.esc
     }
 
-    func prettyPath() -> String {
+    public func prettyPath() -> String {
         var prettyPath = path
         prettyPath = prettyPath
             .replacingOccurrences(of: Bundle.main.bundleIdentifier ?? "com.isaacmarovitz.Whisky", with: "Whisky")

diff --git a/WhiskyKit/GPTK/GPTKDownloader.swift b/WhiskyKit/GPTK/GPTKDownloader.swift
@@ -1,6 +1,6 @@
 //
 //  GPTKDownloader.swift
-//  Whisky
+//  WhiskyKit
 //
 //  Created by Isaac Marovitz on 19/06/2023.
 //

diff --git a/WhiskyKit/GPTK/GPTKInstaller.swift b/WhiskyKit/GPTK/GPTKInstaller.swift
@@ -1,6 +1,6 @@
 //
 //  GPTKInstaller.swift
-//  Whisky
+//  WhiskyKit
 //
 //  Created by Isaac Marovitz on 14/06/2023.
 //

diff --git a/WhiskyKit/PE/BitmapInfo.swift b/WhiskyKit/PE/BitmapInfo.swift
@@ -1,6 +1,6 @@
 //
 //  BitmapInfo.swift
-//  Whisky
+//  WhiskyKit
 //
 //  Created by Isaac Marovitz on 09/09/2023.
 //

diff --git a/WhiskyKit/PE/PortableExecutable.swift b/WhiskyKit/PE/PortableExecutable.swift
@@ -1,11 +1,12 @@
 //
 //  PortableExecutable.swift
-//  Whisky
+//  WhiskyKit
 //
 //  Created by Isaac Marovitz on 03/04/2023.
 //
 
 import Foundation
+import AppKit
 
 public struct PEError: Error {
     public let message: String
@@ -226,7 +227,7 @@ public struct PEFile: Hashable {
     public let coffFileHeader: COFFFileHeader
     public let resourceSection: ResourceSection?
 
-    init(data: Data) throws {
+    public init(data: Data) throws {
         // Verify it is a PE file by checking for the PE header
         let offsetToPEHeader = data.extract(UInt32.self, offset: 0x3C) ?? 0
         let peHeader = data.extract(UInt32.self, offset: Int(offsetToPEHeader))
@@ -238,4 +239,21 @@ public struct PEFile: Hashable {
                                               sectionTable: coffFileHeader.sectionTable,
                                               imageBase: coffFileHeader.optionalHeader.imageBase)
     }
+
+    public func bestIcon() -> NSImage? {
+        var icons: [NSImage] = []
+        if let resourceSection = resourceSection {
+            for entries in resourceSection.allEntries where entries.icon.isValid {
+                icons.append(entries.icon)
+            }
+        } else {
+            print("No resource section")
+        }
+
+        if icons.count > 0 {
+            return icons.max(by: { $0.size.height < $1.size.height })
+        }
+
+        return NSImage()
+    }
 }
diff --git a/WhiskyKit/PE/ResourceSection.swift b/WhiskyKit/PE/ResourceSection.swift
@@ -1,6 +1,6 @@
 //
 //  ResourceSection.swift
-//  Whisky
+//  WhiskyKit
 //
 
 import Foundation

diff --git a/WhiskyKit/Tar.swift b/WhiskyKit/Tar.swift
@@ -1,6 +1,6 @@
 //
 //  Tar.swift
-//  Whisky
+//  WhiskyKit
 //
 //  Created by Isaac Marovitz on 14/06/2023.
 //

diff --git a/WhiskyThumbnail/Icons.xcassets/Contents.json b/WhiskyThumbnail/Icons.xcassets/Contents.json
@@ -0,0 +1,6 @@
+{
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}
diff --git a/WhiskyThumbnail/Icons.xcassets/Icon.imageset/512R512x1.png b/WhiskyThumbnail/Icons.xcassets/Icon.imageset/512R512x1.png
diff --git a/WhiskyThumbnail/Icons.xcassets/Icon.imageset/Contents.json b/WhiskyThumbnail/Icons.xcassets/Icon.imageset/Contents.json
@@ -0,0 +1,21 @@
+{
+  "images" : [
+    {
+      "filename" : "512R512x1.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}
diff --git a/WhiskyThumbnail/Info.plist b/WhiskyThumbnail/Info.plist
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>NSExtension</key>
+	<dict>
+		<key>NSExtensionAttributes</key>
+		<dict>
+			<key>QLSupportedContentTypes</key>
+			<array>
+				<string>com.microsoft.windows-executable</string>
+			</array>
+			<key>QLThumbnailMinimumDimension</key>
+			<integer>0</integer>
+		</dict>
+		<key>NSExtensionPointIdentifier</key>
+		<string>com.apple.quicklook.thumbnail</string>
+		<key>NSExtensionPrincipalClass</key>
+		<string>$(PRODUCT_MODULE_NAME).ThumbnailProvider</string>
+	</dict>
+</dict>
+</plist>
diff --git a/WhiskyThumbnail/ThumbnailProvider.swift b/WhiskyThumbnail/ThumbnailProvider.swift
@@ -0,0 +1,58 @@
+//
+//  ThumbnailProvider.swift
+//  Whisky
+//
+//  Created by Isaac Marovitz on 09/09/2023.
+//
+
+import Foundation
+import QuickLookThumbnailing
+import AppKit
+import WhiskyKit
+
+class ThumbnailProvider: QLThumbnailProvider {
+    override func provideThumbnail(for request: QLFileThumbnailRequest,
+                                   _ handler: @escaping (QLThumbnailReply?, Error?) -> Void) {
+        let thumbnailSize = CGSize(width: request.maximumSize.width,
+                                   height: request.maximumSize.height)
+
+        // % of thumbnail occupied by icon
+        let iconScaleFactor = 0.9
+        let whiskyIconScaleFactor = 0.4
+
+        // AppKit coordinate system origin is in the bottom-left
+        // Icon is centered
+        let iconFrame = CGRect(x: (request.maximumSize.width - request.maximumSize.width * iconScaleFactor) / 2.0,
+                               y: (request.maximumSize.height - request.maximumSize.height * iconScaleFactor) / 2.0,
+                               width: request.maximumSize.width * iconScaleFactor,
+                               height: request.maximumSize.height * iconScaleFactor)
+
+        // Whisky icon is aligned bottom-right
+        let whiskyIconFrame = CGRect(x: request.maximumSize.width - request.maximumSize.width * whiskyIconScaleFactor,
+                                     y: 0,
+                                     width: request.maximumSize.width * whiskyIconScaleFactor,
+                                     height: request.maximumSize.height * whiskyIconScaleFactor)
+        do {
+            var image: NSImage?
+
+            let peFile = try PEFile(data: Data(contentsOf: request.fileURL))
+            image = peFile.bestIcon()
+
+            let reply: QLThumbnailReply = QLThumbnailReply.init(contextSize: thumbnailSize) { () -> Bool in
+                if let image = image {
+                    image.draw(in: iconFrame)
+                    let whiskyIcon = NSImage(named: NSImage.Name("Icon"))
+                    whiskyIcon?.draw(in: whiskyIconFrame, from: .zero, operation: .sourceOver, fraction: 1)
+                    return true
+                }
+
+                // We didn't draw anything
+                return false
+            }
+
+            handler(reply, nil)
+        } catch {
+            handler(nil, nil)
+        }
+    }
+}
diff --git a/WhiskyThumbnail/WhiskyThumbnail.entitlements b/WhiskyThumbnail/WhiskyThumbnail.entitlements
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>com.apple.security.app-sandbox</key>
+    <true/>
+    <key>com.apple.security.files.user-selected.read-only</key>
+    <true/>
+</dict>
+</plist>