Consistent filename handling in logs

Marginal · Marginal · commit bc718318dc53 · 2023-10-05T13:29:13.000+01:00
diff --git a/mdimporter/GetMetadataForFile.m b/mdimporter/GetMetadataForFile.m
@@ -160,12 +160,12 @@ Boolean GetMetadataForFile(void *thisInterface, CFMutableDictionaryRef attribute
     {
         if (!logger)
             logger = os_log_create("uk.org.marginal.qlvideo", "mdimporter");
-        os_log_info(logger, "Import with UTI=%{public}@ for %{public}@", contentTypeUTI, pathToFile);
+        os_log_info(logger, "Import " LOGPRIVATE " with UTI=%{public}@", pathToFile, contentTypeUTI);
 
         CFURLRef url = CFURLCreateWithFileSystemPath(NULL, pathToFile, kCFURLPOSIXPathStyle, false);
         Snapshotter *snapshotter = [[Snapshotter alloc] initWithURL:url];
         if (!snapshotter) {
-            os_log_error(logger, "Can't import %@", pathToFile);
+            os_log_error(logger, "Can't import " LOGPRIVATE, pathToFile);
             return false;
         }
 
@@ -242,7 +242,7 @@ Boolean GetMetadataForFile(void *thisInterface, CFMutableDictionaryRef attribute
             } else if (!strcasecmp(tag->key, "wm/mediaoriginalbroadcastdatetime")) {
                 attrs[(__bridge NSString *)kMDItemRecordingDate] = dateString(@(tag->value));
             } else {
-                os_log_info(logger, "Skipping unknown tag %{public}s=%{public}s in %{public}@", tag->key, tag->value, pathToFile);
+                os_log_info(logger, "Skipping unknown tag %{public}s=%{public}s in " LOGPRIVATE, tag->key, tag->value, pathToFile);
             }
         }
 
@@ -326,7 +326,7 @@ Boolean GetMetadataForFile(void *thisInterface, CFMutableDictionaryRef attribute
                     break;
 
                 default:
-                    os_log_info(logger, "Skipping unknown stream #%d:%{public}s in %{public}@", stream_idx, title ? title->value : "", pathToFile);
+                    os_log_info(logger, "Skipping unknown stream #%d:%{public}s in " LOGPRIVATE, stream_idx, title ? title->value : "", pathToFile);
             }
 
             // All recognised types
@@ -389,7 +389,7 @@ Boolean GetMetadataForFile(void *thisInterface, CFMutableDictionaryRef attribute
                 const char *profile = av_get_profile_name(codec, params->profile);
                 addArrayAttributeNoDupes(attrs, (__bridge NSString *)kMDItemCodecs, profile ? [NSString stringWithFormat:@"%s [%s]", name, profile] : @(name));
             } else {
-                os_log_info(logger, "Unsupported codec with id %d for stream #%d:%{public}s in %{public}@", params->codec_id, stream_idx, title ? title->value : "", pathToFile);
+                os_log_info(logger, "Unsupported codec with id %d for stream #%d:%{public}s in " LOGPRIVATE, params->codec_id, stream_idx, title ? title->value : "", pathToFile);
             }
         } // From each stream
     }
diff --git a/qlgenerator/GeneratePreviewForURL.m b/qlgenerator/GeneratePreviewForURL.m
@@ -86,7 +86,7 @@ OSStatus GeneratePreviewForURL(void *thisInterface, QLPreviewRequestRef preview,
 
     @autoreleasepool
     {
-        os_log_info(logger, "Preview with options=%{public}@ UTI=%{public}@ for %{public}@", options, contentTypeUTI, [(__bridge NSURL*)url path]);
+        os_log_info(logger, "Preview " LOGPRIVATE " with options=%{public}@ UTI=%{public}@", [(__bridge NSURL*)url path], options, contentTypeUTI);
         Snapshotter *snapshotter = nil;
 
         // Prefer any cover art (if present) over a playable preview or static snapshot in Finder and Spotlight views
@@ -100,7 +100,7 @@ OSStatus GeneratePreviewForURL(void *thisInterface, QLPreviewRequestRef preview,
             if (cover)
             {
                 CGSize coversize = CGSizeMake(CGImageGetWidth(cover), CGImageGetHeight(cover));
-                os_log_info(logger, "Supplying %dx%d cover art for %{public}@", (int) coversize.width, (int) coversize.height, [(__bridge NSURL*)url path]);
+                os_log_info(logger, "Supplying %dx%d cover art for " LOGPRIVATE, (int) coversize.width, (int) coversize.height, [(__bridge NSURL*)url path]);
                 CGContextRef context = QLPreviewRequestCreateContext(preview, coversize, true, nil);
                 CGContextDrawImage(context, CGRectMake(0, 0, coversize.width, coversize.height), cover);
                 QLPreviewRequestFlushContext(preview, context);
@@ -116,8 +116,8 @@ OSStatus GeneratePreviewForURL(void *thisInterface, QLPreviewRequestRef preview,
         if (QLPreviewRequestIsCancelled(preview)) return kQLReturnNoError;
         CFBundleRef myBundle = QLPreviewRequestGetGeneratorBundle(preview);
         NSUserDefaults *defaults = [[NSUserDefaults alloc] initWithSuiteName:kSettingsSuiteName];
-        os_log_debug(logger, "QLvideo preview defaults=%@", defaults);
-        os_log_debug(logger, "QLvideo preview SnapshoCount=%ld", (long)[defaults integerForKey:kSettingsSnapshotCount]);
+        os_log_debug(logger, "QLvideo preview defaults=%{public}@", defaults);
+        os_log_debug(logger, "QLvideo preview SnapshotCount=%ld", (long)[defaults integerForKey:kSettingsSnapshotCount]);
 
         if (![defaults boolForKey:kSettingsSnapshotAlways])
             @autoreleasepool    // Reduce peak footprint
@@ -126,7 +126,7 @@ OSStatus GeneratePreviewForURL(void *thisInterface, QLPreviewRequestRef preview,
 
             if (player.playable)
             {
-                os_log_info(logger, "Handing off %{public}@ to AVFoundation", [(__bridge NSURL*)url path]);
+                os_log_info(logger, "Handing off " LOGPRIVATE " to AVFoundation", [(__bridge NSURL*)url path]);
                 NSString *title = [player title];
                 if (!title)
                     title = [(__bridge NSURL *)url lastPathComponent];
@@ -165,7 +165,7 @@ OSStatus GeneratePreviewForURL(void *thisInterface, QLPreviewRequestRef preview,
             if (cover)
             {
                 CGSize coversize = CGSizeMake(CGImageGetWidth(cover), CGImageGetHeight(cover));
-                os_log_info(logger, "Supplying %dx%d cover art for %{public}@", (int) coversize.width, (int) coversize.height, [(__bridge NSURL*)url path]);
+                os_log_info(logger, "Supplying %dx%d cover art for " LOGPRIVATE, (int) coversize.width, (int) coversize.height, [(__bridge NSURL*)url path]);
                 NSDictionary *properties = @{(NSString *) kQLPreviewPropertyDisplayNameKey: theTitle};
                 CGContextRef context = QLPreviewRequestCreateContext(preview, coversize, true, (__bridge CFDictionaryRef) properties);
                 CGContextDrawImage(context, CGRectMake(0, 0, coversize.width, coversize.height), cover);
@@ -247,7 +247,7 @@ OSStatus GeneratePreviewForURL(void *thisInterface, QLPreviewRequestRef preview,
                                          (__bridge NSString *) kQLPreviewPropertyPageElementXPathKey: @"/html/body/div",
                                          (NSString *) kQLPreviewPropertyPDFStyleKey: @(kQLPreviewPDFPagesWithThumbnailsOnLeftStyle),
                                          (NSString *) kQLPreviewPropertyAttachmentsKey: attachments};
-            os_log_info(logger, "Supplying %lu %dx%d images for %{public}@", [properties[(NSString *) kQLPreviewPropertyAttachmentsKey] count], (int) scaled.width, (int) scaled.height, [(__bridge NSURL*)url path]);
+            os_log_info(logger, "Supplying %lu %dx%d images for " LOGPRIVATE, [properties[(NSString *) kQLPreviewPropertyAttachmentsKey] count], (int) scaled.width, (int) scaled.height, [(__bridge NSURL*)url path]);
             QLPreviewRequestSetDataRepresentation(preview, (__bridge CFDataRef) [html dataUsingEncoding:NSUTF8StringEncoding], kUTTypeHTML,
                                                   (__bridge CFDictionaryRef) properties);
             return kQLReturnNoError;    // early exit
@@ -275,7 +275,7 @@ OSStatus GeneratePreviewForURL(void *thisInterface, QLPreviewRequestRef preview,
             else
                 size = CGSizeMake(round(original.width * kMaxHeight / original.height), kMaxHeight);
 # endif
-            os_log_info(logger, "Supplying %dx%d image for %{public}@", (int) size.width, (int) size.height, [(__bridge NSURL*)url path]);
+            os_log_info(logger, "Supplying %dx%d image for " LOGPRIVATE, (int) size.width, (int) size.height, [(__bridge NSURL*)url path]);
             NSDictionary *properties = @{(NSString *) kQLPreviewPropertyDisplayNameKey: theTitle};
             CGContextRef context = QLPreviewRequestCreateContext(preview, size, true, (__bridge CFDictionaryRef) properties);
             CGContextDrawImage(context, CGRectMake(0, 0, size.width, size.height), thePreview);
@@ -285,7 +285,7 @@ OSStatus GeneratePreviewForURL(void *thisInterface, QLPreviewRequestRef preview,
         }
         else
         {
-            os_log_error(logger, "Can't supply anything for %@", [(__bridge NSURL*)url path]);
+            os_log_error(logger, "Can't supply anything for " LOGPRIVATE, [(__bridge NSURL*)url path]);
         }
     }
     return kQLReturnNoError;
diff --git a/qlgenerator/GenerateThumbnailForURL.m b/qlgenerator/GenerateThumbnailForURL.m
@@ -42,7 +42,7 @@ OSStatus GenerateThumbnailForURL(void *thisInterface, QLThumbnailRequestRef thum
 #ifndef DEBUG   // Skip this check to enable debugging with qlmanage -t ...
     // On Catalina and later the QLThumbnailGenerator application extension generates thumbnails. On Ventura and later this isn't even called.
     if (newQuickLook) {
-        os_log_info(logger, "Ignoring thumbnail with options=%{public}@ UTI=%{public}@ size=%dx%d for %{public}@", options, contentTypeUTI, (int) maxSize.width, (int) maxSize.height, url);
+        os_log_info(logger, "Ignoring thumbnail request for " LOGPRIVATE " with options=%{public}@ UTI=%{public}@ size=%dx%d", url, options, contentTypeUTI, (int) maxSize.width, (int) maxSize.height);
         return kQLReturnNoError;
     }
 #endif
@@ -51,14 +51,16 @@ OSStatus GenerateThumbnailForURL(void *thisInterface, QLThumbnailRequestRef thum
 
     @autoreleasepool
     {
-        os_log_info(logger, "Thumbnail with options=%{public}@ UTI=%{public}@ size=%dx%d for %{public}@", options, contentTypeUTI, (int) maxSize.width, (int) maxSize.height, url);
+        os_log_info(logger, "Thumbnail " LOGPRIVATE " with options=%{public}@ UTI=%{public}@ size=%dx%d", url, options, contentTypeUTI, (int) maxSize.width, (int) maxSize.height);
         Snapshotter *snapshotter = [[Snapshotter alloc] initWithURL:url];
         if (!snapshotter) return kQLReturnNoError;
 
         // Use cover art if present
         snapshot = [snapshotter newCoverArtWithMode:CoverArtThumbnail];
         if (snapshot)
         {
+            os_log_info(logger, "Supplying %ldx%ld cover art for " LOGPRIVATE, CGImageGetWidth(snapshot), CGImageGetHeight(snapshot), url);
+
             CFStringRef flavor = newQuickLook ? kQLThumbnailPropertyIconFlavorKey_10_15 : kQLThumbnailPropertyIconFlavorKey;
             NSDictionary *properties = @{(__bridge NSString *) flavor: @(kQLThumbnailIconGlossFlavor) }; // suppress letterbox mattes
             QLThumbnailRequestSetImage(thumbnail, snapshot, (__bridge CFDictionaryRef) properties);
@@ -95,6 +97,8 @@ OSStatus GenerateThumbnailForURL(void *thisInterface, QLThumbnailRequestRef thum
 
     if (snapshot)
     {
+        os_log_info(logger, "Supplying %ldx%ld snapshot/picture for " LOGPRIVATE, CGImageGetWidth(snapshot), CGImageGetHeight(snapshot), url);
+
         // explicitly request letterbox mattes for UTIs that don't derive from public.media, such as com.microsoft.advanced-systems-format
         CFStringRef flavor = newQuickLook ? kQLThumbnailPropertyIconFlavorKey_10_15 : kQLThumbnailPropertyIconFlavorKey;
         NSDictionary *properties = @{(__bridge NSString *) flavor: @(kQLThumbnailIconMovieFlavor) };
diff --git a/qlgenerator/Snapshotter.h b/qlgenerator/Snapshotter.h
@@ -13,6 +13,13 @@
 #include "libavformat/avformat.h"
 
 
+#ifdef DEBUG
+    #define LOGPRIVATE "%{public}@"
+#else
+    #define LOGPRIVATE "%{mask.hash}@"
+#endif
+
+
 typedef NS_ENUM(NSInteger, CoverArtMode)
 {
     CoverArtDefault     = 0,
diff --git a/qlgenerator/Snapshotter.m b/qlgenerator/Snapshotter.m
@@ -112,10 +112,10 @@ - (instancetype) initWithURL:(CFURLRef)url
     if (!(self = [super init]))
         return nil;
 
-
-    if (avformat_open_input(&fmt_ctx, [[(__bridge NSURL*) url path] UTF8String], NULL, NULL))
+    int ret;
+    if ((ret = avformat_open_input(&fmt_ctx, [[(__bridge NSURL*) url path] UTF8String], NULL, NULL)))
     {
-        os_log_error(logger, "Can't open %@", [(__bridge NSURL*) url path]);
+        os_log_error(logger, "Can't open " LOGPRIVATE " - %{public}s", [(__bridge NSURL*) url path], av_err2str(ret));
         return nil;
     }
 
diff --git a/thumbnailer/ThumbnailProvider.m b/thumbnailer/ThumbnailProvider.m
@@ -59,18 +59,18 @@ - (void)provideThumbnailForFileRequest:(QLFileThumbnailRequest *)request complet
     if (!logger)
         logger = os_log_create("uk.org.marginal.qlvideo", "thumbnailer");
 
-    os_log_info(logger, "Thumbnailer with attributes=%{public}@ scale=%.2lf minimumSize=%dx%d maximumSize=%dx%d for %{public}@",
+    os_log_info(logger, "Thumbnailer " LOGPRIVATE " with attributes=%{public}@ scale=%.2lf minimumSize=%dx%d maximumSize=%dx%d",
+                request.fileURL,
                 request.attributeKeys, request.scale,
                 (int) request.minimumSize.width, (int) request.minimumSize.height,
-                (int) request.maximumSize.width, (int) request.maximumSize.height,
-                request.fileURL);
+                (int) request.maximumSize.width, (int) request.maximumSize.height);
 
     // @autoreleasepool
     {
         Snapshotter *snapshotter = [[Snapshotter alloc] initWithURL:(__bridge CFURLRef) request.fileURL];
         if (!snapshotter)
         {
-            os_log_error(logger, "Can't supply anything for %@", request.fileURL);
+            os_log_error(logger, "Can't supply anything for " LOGPRIVATE, request.fileURL);
             return;
         }
 
@@ -122,7 +122,7 @@ - (void)provideThumbnailForFileRequest:(QLFileThumbnailRequest *)request complet
         }
 
         if (snapshot) {
-            os_log_info(logger, "Supplying %dx%d %s for %{public}@", (int) snapshotsize.width, (int) snapshotsize.height,
+            os_log_info(logger, "Supplying %dx%d %s for " LOGPRIVATE, (int) snapshotsize.width, (int) snapshotsize.height,
                         isCoverArt ? "cover art" : ([snapshotter pictures] ? "picture" : "snapshot"), request.fileURL);
 
             // explicitly request letterbox mattes for UTIs that don't derive from public.media such as com.microsoft.advanced-systems-format, and explicitly suppress them for cover art
@@ -138,7 +138,7 @@ - (void)provideThumbnailForFileRequest:(QLFileThumbnailRequest *)request complet
             return;
         }
 
-        os_log_error(logger, "Couldn't get thumbnail for %@", request.fileURL);
+        os_log_error(logger, "Couldn't get thumbnail for " LOGPRIVATE, request.fileURL);
     }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -160,12 +160,12 @@ Boolean GetMetadataForFile(void *thisInterface, CFMutableDictionaryRef attribute`
`160`	`160`	`{`
`161`	`161`	`if (!logger)`
`162`	`162`	`logger = os_log_create("uk.org.marginal.qlvideo", "mdimporter");`
`163`		`- os_log_info(logger, "Import with UTI=%{public}@ for %{public}@", contentTypeUTI, pathToFile);`
	`163`	`+ os_log_info(logger, "Import " LOGPRIVATE " with UTI=%{public}@", pathToFile, contentTypeUTI);`
`164`	`164`
`165`	`165`	`CFURLRef url = CFURLCreateWithFileSystemPath(NULL, pathToFile, kCFURLPOSIXPathStyle, false);`
`166`	`166`	`Snapshotter *snapshotter = [[Snapshotter alloc] initWithURL:url];`
`167`	`167`	`if (!snapshotter) {`
`168`		`- os_log_error(logger, "Can't import %@", pathToFile);`
	`168`	`+ os_log_error(logger, "Can't import " LOGPRIVATE, pathToFile);`
`169`	`169`	`return false;`
`170`	`170`	`}`
`171`	`171`
`@@ -242,7 +242,7 @@ Boolean GetMetadataForFile(void *thisInterface, CFMutableDictionaryRef attribute`
`242`	`242`	`} else if (!strcasecmp(tag->key, "wm/mediaoriginalbroadcastdatetime")) {`
`243`	`243`	`attrs[(__bridge NSString *)kMDItemRecordingDate] = dateString(@(tag->value));`
`244`	`244`	`} else {`
`245`		`- os_log_info(logger, "Skipping unknown tag %{public}s=%{public}s in %{public}@", tag->key, tag->value, pathToFile);`
	`245`	`+ os_log_info(logger, "Skipping unknown tag %{public}s=%{public}s in " LOGPRIVATE, tag->key, tag->value, pathToFile);`
`246`	`246`	`}`
`247`	`247`	`}`
`248`	`248`
`@@ -326,7 +326,7 @@ Boolean GetMetadataForFile(void *thisInterface, CFMutableDictionaryRef attribute`
`326`	`326`	`break;`
`327`	`327`
`328`	`328`	`default:`
`329`		`- os_log_info(logger, "Skipping unknown stream #%d:%{public}s in %{public}@", stream_idx, title ? title->value : "", pathToFile);`
	`329`	`+ os_log_info(logger, "Skipping unknown stream #%d:%{public}s in " LOGPRIVATE, stream_idx, title ? title->value : "", pathToFile);`
`330`	`330`	`}`
`331`	`331`
`332`	`332`	`// All recognised types`
`@@ -389,7 +389,7 @@ Boolean GetMetadataForFile(void *thisInterface, CFMutableDictionaryRef attribute`
`389`	`389`	`const char *profile = av_get_profile_name(codec, params->profile);`
`390`	`390`	`addArrayAttributeNoDupes(attrs, (__bridge NSString *)kMDItemCodecs, profile ? [NSString stringWithFormat:@"%s [%s]", name, profile] : @(name));`
`391`	`391`	`} else {`
`392`		`- os_log_info(logger, "Unsupported codec with id %d for stream #%d:%{public}s in %{public}@", params->codec_id, stream_idx, title ? title->value : "", pathToFile);`
	`392`	`+ os_log_info(logger, "Unsupported codec with id %d for stream #%d:%{public}s in " LOGPRIVATE, params->codec_id, stream_idx, title ? title->value : "", pathToFile);`
`393`	`393`	`}`
`394`	`394`	`} // From each stream`
`395`	`395`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,10 +112,10 @@ - (instancetype) initWithURL:(CFURLRef)url`
`112`	`112`	`if (!(self = [super init]))`
`113`	`113`	`return nil;`
`114`	`114`
`115`		`-`
`116`		`- if (avformat_open_input(&fmt_ctx, [[(__bridge NSURL*) url path] UTF8String], NULL, NULL))`
	`115`	`+ int ret;`
	`116`	`+ if ((ret = avformat_open_input(&fmt_ctx, [[(__bridge NSURL*) url path] UTF8String], NULL, NULL)))`
`117`	`117`	`{`
`118`		`- os_log_error(logger, "Can't open %@", [(__bridge NSURL*) url path]);`
	`118`	`+ os_log_error(logger, "Can't open " LOGPRIVATE " - %{public}s", [(__bridge NSURL*) url path], av_err2str(ret));`
`119`	`119`	`return nil;`
`120`	`120`	`}`
`121`	`121`
Original file line number	Diff line number	Diff line change
`@@ -59,18 +59,18 @@ - (void)provideThumbnailForFileRequest:(QLFileThumbnailRequest *)request complet`
`59`	`59`	`if (!logger)`
`60`	`60`	`logger = os_log_create("uk.org.marginal.qlvideo", "thumbnailer");`
`61`	`61`
`62`		`- os_log_info(logger, "Thumbnailer with attributes=%{public}@ scale=%.2lf minimumSize=%dx%d maximumSize=%dx%d for %{public}@",`
	`62`	`+ os_log_info(logger, "Thumbnailer " LOGPRIVATE " with attributes=%{public}@ scale=%.2lf minimumSize=%dx%d maximumSize=%dx%d",`
	`63`	`+ request.fileURL,`
`63`	`64`	`request.attributeKeys, request.scale,`
`64`	`65`	`(int) request.minimumSize.width, (int) request.minimumSize.height,`
`65`		`- (int) request.maximumSize.width, (int) request.maximumSize.height,`
`66`		`- request.fileURL);`
	`66`	`+ (int) request.maximumSize.width, (int) request.maximumSize.height);`
`67`	`67`
`68`	`68`	`// @autoreleasepool`
`69`	`69`	`{`
`70`	`70`	`Snapshotter *snapshotter = [[Snapshotter alloc] initWithURL:(__bridge CFURLRef) request.fileURL];`
`71`	`71`	`if (!snapshotter)`
`72`	`72`	`{`
`73`		`- os_log_error(logger, "Can't supply anything for %@", request.fileURL);`
	`73`	`+ os_log_error(logger, "Can't supply anything for " LOGPRIVATE, request.fileURL);`
`74`	`74`	`return;`
`75`	`75`	`}`
`76`	`76`
`@@ -122,7 +122,7 @@ - (void)provideThumbnailForFileRequest:(QLFileThumbnailRequest *)request complet`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`if (snapshot) {`
`125`		`- os_log_info(logger, "Supplying %dx%d %s for %{public}@", (int) snapshotsize.width, (int) snapshotsize.height,`
	`125`	`+ os_log_info(logger, "Supplying %dx%d %s for " LOGPRIVATE, (int) snapshotsize.width, (int) snapshotsize.height,`
`126`	`126`	`isCoverArt ? "cover art" : ([snapshotter pictures] ? "picture" : "snapshot"), request.fileURL);`
`127`	`127`
`128`	`128`	`// explicitly request letterbox mattes for UTIs that don't derive from public.media such as com.microsoft.advanced-systems-format, and explicitly suppress them for cover art`
`@@ -138,7 +138,7 @@ - (void)provideThumbnailForFileRequest:(QLFileThumbnailRequest *)request complet`
`138`	`138`	`return;`
`139`	`139`	`}`
`140`	`140`
`141`		`- os_log_error(logger, "Couldn't get thumbnail for %@", request.fileURL);`
	`141`	`+ os_log_error(logger, "Couldn't get thumbnail for " LOGPRIVATE, request.fileURL);`
`142`	`142`	`}`
`143`	`143`	`}`
`144`	`144`