Files
transmission/macosx/QuickLookExtension/PreviewProvider.mm
Dzmitry Neviadomski 9b496350a9 feat: Data-based QuickLook extension for macOS 12+ (#7213)
* feat: Prepate Xcode project skeleton for QuickLookExtension

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* feat: Add initial implementation of QuickLookExtension

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* feat: Add working Data-based QuickLook Preview

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* feat: Add new style.css

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* feat: Copy Localization.strings as is from legacy QuickLook plugin

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* fixup: Fix compilation missing NSStringAdditions

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* fixup: Apply clang-format, update style.css, fix file name reference

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* feat: Adopt CMake build from legacy QuickLook Plugin

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* fixup: Remove counter for debug

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* fixup: Make header row for file span across all table

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* feat: Improve style.css

- Use CSS Vars
- Add missing paddings
- Add sticky headers for tables

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* Use UTType for Image generation more directly.

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* Fixup for Xcode project checks in PR

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* Fix Copyright and remove Xcode generated comments

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* Remove unneeded fields from targets Info.plist template.

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* Move tx localization to new QuickLook Extension

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

* Apply code review suggestions

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>

---------

Signed-off-by: Dzmitry Neviadomski <nevack.d@gmail.com>
2025-10-31 11:30:55 -05:00

291 lines
11 KiB
Plaintext

// This file Copyright © Transmission authors and contributors.
// It may be used under the MIT (SPDX: MIT) license.
// License text can be found in the licenses/ folder.
#import "PreviewProvider.h"
#include <string>
#include <unordered_map>
#include <vector>
#include <libtransmission/torrent-metainfo.h>
#include <libtransmission/utils.h>
#import "NSStringAdditions.h"
static NSUInteger const kIconWidth = 16;
namespace
{
class FileTreeNode
{
public:
FileTreeNode() = default;
~FileTreeNode() = default;
auto MaybeCreateChild(std::string_view child_name)
{
return children_.try_emplace(std::string{ child_name });
}
private:
FileTreeNode(FileTreeNode const&) = delete;
FileTreeNode& operator=(FileTreeNode&) = delete;
std::unordered_map<std::string, FileTreeNode> children_;
};
} // namespace
NSString* generateIconData(UTType* type, NSUInteger width, NSMutableDictionary<NSString*, QLPreviewReplyAttachment*>* allImgProps)
{
// We need to do this once per file type, per image size
NSString* iconFileName = [NSString stringWithFormat:@"%@.%ld.tiff", type.identifier, width];
if (!allImgProps[iconFileName])
{
NSImage* icon = [NSWorkspace.sharedWorkspace iconForContentType:type];
NSRect const iconFrame = NSMakeRect(0.0, 0.0, width, width);
NSImage* renderedIcon = [[NSImage alloc] initWithSize:iconFrame.size];
[renderedIcon lockFocus];
[icon drawInRect:iconFrame];
[renderedIcon unlockFocus];
NSData* iconData = renderedIcon.TIFFRepresentation;
QLPreviewReplyAttachment* imageAttachment = [[QLPreviewReplyAttachment alloc] initWithData:iconData contentType:UTTypePNG];
allImgProps[iconFileName] = imageAttachment;
}
return [@"cid:" stringByAppendingString:iconFileName];
}
@implementation PreviewProvider
- (void)providePreviewForFileRequest:(QLFilePreviewRequest*)request
completionHandler:(void (^)(QLPreviewReply* _Nullable reply, NSError* _Nullable error))handler
{
QLPreviewReply* reply = [[QLPreviewReply alloc]
initWithDataOfContentType:UTTypeHTML
contentSize:CGSizeMake(1200, 800)
dataCreationBlock:^NSData* _Nullable(QLPreviewReply* _Nonnull replyToUpdate, NSError* __autoreleasing _Nullable* _Nullable error) {
NSString* previewHTML = [self generateHTMLPreviewFor:request.fileURL andReply:replyToUpdate];
return [previewHTML dataUsingEncoding:NSUTF8StringEncoding];
}];
handler(reply, nil);
}
- (NSString*)generateHTMLPreviewFor:(NSURL*)url andReply:(QLPreviewReply* _Nonnull)replyToUpdate
{
// Try to parse the torrent file
auto metainfo = tr_torrent_metainfo{};
if (!metainfo.parse_torrent_file(url.fileSystemRepresentation))
{
return nil;
}
NSBundle* bundle = NSBundle.mainBundle;
NSURL* styleURL = [bundle URLForResource:@"style" withExtension:@"css"];
NSString* styleContents = [NSString stringWithContentsOfURL:styleURL encoding:NSUTF8StringEncoding error:NULL];
NSMutableString* htmlString = [NSMutableString string];
[htmlString appendFormat:@"<html><style type=\"text/css\">%@</style><body>", styleContents];
NSMutableDictionary<NSString*, QLPreviewReplyAttachment*>* attachments = [NSMutableDictionary dictionary];
NSString* name = @(metainfo.name().c_str());
auto const n_files = metainfo.file_count();
auto const is_multifile = n_files > 1;
UTType* fileType = is_multifile ? UTTypeFolder : [UTType typeWithFilenameExtension:name.pathExtension];
NSUInteger const width = 32;
[htmlString appendFormat:@"<h2><img class=\"icon\" src=\"%@\" width=\"%ld\" height=\"%ld\" />%@</h2>",
generateIconData(fileType, width, attachments),
width,
width,
name];
NSString* fileSizeString = [NSString stringForFileSize:metainfo.total_size()];
if (is_multifile)
{
NSString* fileCountString = [NSString
localizedStringWithFormat:NSLocalizedStringFromTableInBundle(@"%lu files", nil, bundle, "quicklook file count"), n_files];
fileSizeString = [NSString stringWithFormat:@"%@, %@", fileCountString, fileSizeString];
}
[htmlString appendFormat:@"<p>%@</p>", fileSizeString];
auto const date_created = metainfo.date_created();
NSString* dateCreatedString = date_created > 0 ?
[NSDateFormatter localizedStringFromDate:[NSDate dateWithTimeIntervalSince1970:date_created] dateStyle:NSDateFormatterLongStyle
timeStyle:NSDateFormatterShortStyle] :
nil;
auto const& creator = metainfo.creator();
NSString* creatorString = !std::empty(creator) ? @(creator.c_str()) : nil;
if ([creatorString isEqualToString:@""])
{
creatorString = nil;
}
NSString* creationString = nil;
if (dateCreatedString && creatorString)
{
creationString = [NSString
stringWithFormat:NSLocalizedStringFromTableInBundle(@"Created on %@ with %@", nil, bundle, "quicklook creation info"),
dateCreatedString,
creatorString];
}
else if (dateCreatedString)
{
creationString = [NSString
stringWithFormat:NSLocalizedStringFromTableInBundle(@"Created on %@", nil, bundle, "quicklook creation info"), dateCreatedString];
}
else if (creatorString)
{
creationString = [NSString
stringWithFormat:NSLocalizedStringFromTableInBundle(@"Created with %@", nil, bundle, "quicklook creation info"), creatorString];
}
if (creationString)
{
[htmlString appendFormat:@"<p>%@</p>", creationString];
}
auto const& commentStr = metainfo.comment();
if (!std::empty(commentStr))
{
NSString* comment = @(commentStr.c_str());
if (![comment isEqualToString:@""])
[htmlString appendFormat:@"<p>%@</p>", comment];
}
NSMutableArray* lists = [NSMutableArray array];
auto const n_webseeds = metainfo.webseed_count();
if (n_webseeds > 0)
{
NSMutableString* listSection = [NSMutableString string];
[listSection appendString:@"<table>"];
NSString* headerTitleString = n_webseeds == 1 ?
NSLocalizedStringFromTableInBundle(@"1 Web Seed", nil, bundle, "quicklook web seed header") :
[NSString localizedStringWithFormat:NSLocalizedStringFromTableInBundle(@"%lu Web Seeds", nil, bundle, "quicklook web seed header"),
n_webseeds];
[listSection appendFormat:@"<tr><th>%@</th></tr>", headerTitleString];
for (size_t i = 0; i < n_webseeds; ++i)
{
[listSection appendFormat:@"<tr><td>%s</td></tr>", metainfo.webseed(i).c_str()];
}
[listSection appendString:@"</table>"];
[lists addObject:listSection];
}
auto const& announce_list = metainfo.announce_list();
if (!std::empty(announce_list))
{
NSMutableString* listSection = [NSMutableString string];
[listSection appendString:@"<table>"];
auto const n = std::size(announce_list);
NSString* headerTitleString = n == 1 ?
NSLocalizedStringFromTableInBundle(@"1 Tracker", nil, bundle, "quicklook tracker header") :
[NSString localizedStringWithFormat:NSLocalizedStringFromTableInBundle(@"%lu Trackers", nil, bundle, "quicklook tracker header"), n];
[listSection appendFormat:@"<tr><th>%@</th></tr>", headerTitleString];
// TODO: handle tiers?
for (auto const& tracker : announce_list)
{
[listSection appendFormat:@"<tr><td>%s</td></tr>", tracker.announce.c_str()];
}
[listSection appendString:@"</table>"];
[lists addObject:listSection];
}
if (is_multifile)
{
NSMutableString* listSection = [NSMutableString string];
[listSection appendString:@"<table>"];
NSString* fileTitleString = [NSString
localizedStringWithFormat:NSLocalizedStringFromTableInBundle(@"%lu Files", nil, bundle, "quicklook file header"), n_files];
[listSection appendFormat:@"<tr><th colspan=\"2\">%@</th></tr>", fileTitleString];
FileTreeNode root{};
for (auto const& [path, size] : metainfo.files().sorted_by_path())
{
FileTreeNode* curNode = &root;
size_t level = 0;
auto subpath = std::string_view{ path };
auto path_vec = std::vector<std::string_view>{};
auto token = std::string_view{};
while (tr_strv_sep(&subpath, &token, '/'))
{
path_vec.emplace_back(token);
}
size_t const last = path_vec.size() - 1;
for (auto const& part : path_vec)
{
auto [it, inserted] = curNode->MaybeCreateChild(part);
if (inserted)
{
NSString* pathPart = @(it->first.c_str());
UTType* pathType = nil;
NSString* fileSize = nil;
if (level < last)
{
// This node is a directory.
pathType = UTTypeFolder;
fileSize = @"";
}
else
{
// This node is a leaf file.
pathType = [UTType typeWithFilenameExtension:pathPart.pathExtension];
fileSize = [NSString stringForFileSize:size];
}
[listSection appendFormat:@"<tr><td><img style=\"padding-left: %ldpx\" class=\"icon\" src=\"%@\" width=\"%ld\" height=\"%ld\" />%@</td><td class=\"grey\">%@</td></tr>",
level * kIconWidth,
generateIconData(pathType, kIconWidth, attachments),
kIconWidth,
kIconWidth,
pathPart,
fileSize];
}
curNode = &it->second;
level++;
}
}
[listSection appendString:@"</table>"];
[lists addObject:listSection];
}
if (lists.count > 0)
{
[htmlString appendFormat:@"<hr/><br>%@", [lists componentsJoinedByString:@"<br>"]];
}
[htmlString appendString:@"</body></html>"];
replyToUpdate.attachments = attachments;
return htmlString;
}
@end