-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRemove-ImageMetadata.ps1
More file actions
1412 lines (1166 loc) · 51.9 KB
/
Copy pathRemove-ImageMetadata.ps1
File metadata and controls
1412 lines (1166 loc) · 51.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
function Remove-ImageMetadata
{
<#
.SYNOPSIS
Removes embedded metadata from image files.
.DESCRIPTION
Removes writable metadata from image files using ExifTool. This includes
EXIF, GPS location data, XMP, IPTC, comments, descriptions, PNG textual
chunks, maker notes, thumbnails, and other embedded tag groups supported
by ExifTool.
The function processes image files in place by default and passes
-overwrite_original to ExifTool so no metadata-bearing *_original backup
files are left behind. Use -KeepBackup if you intentionally want ExifTool
to preserve original backup files.
Use -OutputPath to write sanitized copies instead of modifying the source
files. Use -Paranoid to re-encode images through ImageMagick, stripping
metadata from a newly rendered image file before replacing or writing the
final target.
Dependencies:
- `exiftool` must be available in PATH or specified via -ExifToolPath.
Note that the image pixel data is not recompressed by ExifTool when
metadata is removed unless -Paranoid is specified.
- `magick` -Paranoid mode also requires ImageMagick to be installed and
available in PATH or specified via -ImageMagickPath.
.PARAMETER Path
One or more image file or directory paths to process. Accepts pipeline
input and wildcard patterns. Defaults to the current working directory.
.PARAMETER Filters
File name filters to use when searching directories. Defaults to common
image extensions including JPEG, PNG, TIFF, WebP, HEIC, AVIF, GIF, and BMP.
.PARAMETER Exclude
Directory names to exclude when -Recurse is specified. Defaults to
@('.git', 'node_modules', '.vscode').
.PARAMETER Recurse
Searches directories recursively. By default, only files directly inside
each directory are processed.
.PARAMETER ExifToolPath
Path to the ExifTool executable. If omitted, the function searches PATH
and common platform-specific install locations.
.PARAMETER ImageMagickPath
Path to the ImageMagick executable (magick) used by -Paranoid.
If omitted, the function searches PATH and common platform-specific install locations.
.PARAMETER OutputPath
Writes sanitized image files to this file or directory path instead of
modifying the source images in place. When processing multiple images,
OutputPath is treated as a directory.
.PARAMETER Force
Overwrites existing files when -OutputPath targets already exist.
.PARAMETER KeepBackup
Allows ExifTool to create *_original backup files. By default, backups are
suppressed with -overwrite_original so original metadata is not retained.
.PARAMETER PreserveFileTimestamp
Preserves the filesystem modified timestamp by passing -P to ExifTool.
.PARAMETER ResetFileTimestamp
Resets creation, last write, and last access timestamps on sanitized
output files to the value of -ResetTimestamp.
.PARAMETER ResetTimestamp
The UTC timestamp to apply when -ResetFileTimestamp is specified. Defaults
to 2000-01-01T00:00:00Z.
.PARAMETER Paranoid
Re-encodes each image through ImageMagick using -strip, then runs ExifTool
metadata removal on the newly rendered output. This helps remove hidden
payloads, embedded previews, and format-specific metadata that simple tag
deletion may not fully normalize.
.PARAMETER Verify
Runs post-cleanup verification and reports remaining watched metadata as
tag/value entries (for example, [EXIF] Make = Canon) using Get-ImageMetadata.
Watched tags include EXIF, GPS, XMP, IPTC, ICC profile, Photoshop,
comments, titles, authors, software, device details, and thumbnail/preview tags.
.PARAMETER PassThru
Returns a result object for each image file considered for processing.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg'
Removes embedded metadata from photo.jpg in place.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\Images'
Removes metadata from supported image files directly inside the Images folder.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\Images' -Recurse
Recursively removes metadata from supported image files under the Images folder.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\Images' -Recurse -Exclude @('.git', 'raw')
Recursively removes image metadata while skipping .git and raw directories.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\Images' -Filters '*.jpg', '*.png'
Removes metadata only from JPEG and PNG files in the Images folder.
.EXAMPLE
PS > Get-ChildItem -Path '.\Uploads' -Filter '*.jpg' | Remove-ImageMetadata
Removes metadata from JPEG files provided through the pipeline.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -PassThru
Removes metadata and returns a result object describing the operation.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -WhatIf
Shows what metadata removal would do without changing the file.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -KeepBackup
Removes metadata and lets ExifTool create a photo.jpg_original backup file.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -PreserveFileTimestamp
Removes metadata while preserving the file modified timestamp.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -ResetFileTimestamp
Removes metadata and resets filesystem timestamps to 2000-01-01T00:00:00Z.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -OutputPath '.\clean\photo.jpg'
Writes a sanitized copy to the clean folder without modifying photo.jpg.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\Images' -OutputPath '.\CleanImages' -Recurse
Recursively writes sanitized copies to the CleanImages folder.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -Paranoid
Re-encodes photo.jpg through ImageMagick, strips metadata, and replaces the source file.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -OutputPath '.\clean\photo.jpg' -Paranoid -Verify
Writes a re-encoded sanitized copy and reports any watched metadata tags that remain.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -Verify -PassThru
Removes metadata, verifies watched metadata groups, and returns a result object.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -ExifToolPath '/opt/homebrew/bin/exiftool'
Uses a specific ExifTool executable to remove metadata.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\*.jpeg' -PassThru
Removes metadata from all JPEG files matching the wildcard pattern and returns result objects.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\Photos' -OutputPath '.\CleanPhotos' -Recurse -Paranoid -Verify -ResetFileTimestamp
Runs a strong privacy cleanup by re-encoding images, writing clean copies, verifying watched metadata, and resetting timestamps.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\Screenshots' -OutputPath '.\CleanScreenshots' -Filters '*.png' -Verify
Removes textual PNG metadata from screenshots and verifies watched metadata tags in the clean copies.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\DCIM' -Filters '*.heic', '*.heif' -OutputPath '.\CleanDCIM' -Recurse -Paranoid
Re-encodes HEIC/HEIF images into sanitized copies under CleanDCIM using paranoid mode.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -OutputPath '.\clean\photo.jpg' -Force
Overwrites an existing sanitized copy at the specified output path.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -OutputPath '.\clean\photo.jpg' -ResetFileTimestamp -ResetTimestamp ([DateTime]'2024-01-01T00:00:00Z')
Writes a sanitized copy and resets its filesystem timestamps to a specific UTC value.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\Shared' -OutputPath '.\Shared-Clean' -Recurse -Exclude @('.git', 'node_modules', 'private', 'raw')
Recursively sanitizes shareable images while skipping source-control, dependency, private, and raw folders.
.EXAMPLE
PS > Get-ChildItem '.\Uploads' -Include *.jpg, *.png, *.webp -Recurse | Remove-ImageMetadata -OutputPath '.\Uploads-Clean' -Verify
Sanitizes recursively discovered upload images through the pipeline and verifies the clean output files.
.EXAMPLE
PS > Get-ChildItem '.\Photos' -File | Where-Object LastWriteTime -gt (Get-Date).AddDays(-7) | Remove-ImageMetadata -OutputPath '.\Recent-Clean'
Removes metadata only from images modified in the last seven days.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\BeforeUpload' -OutputPath '.\ReadyToUpload' -Recurse -WhatIf
Previews the files that would be sanitized before uploading or publishing images.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\BeforeUpload' -OutputPath '.\ReadyToUpload' -Recurse -PassThru | Format-Table Path, MetadataRemoved, ExitCode
Sanitizes images and displays a concise processing summary table.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -Verify
Removes metadata in place and reports verification status for watched privacy-related tags.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -Paranoid -ImageMagickPath '/opt/homebrew/bin/magick'
Uses a specific ImageMagick executable for paranoid re-encoding.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -ExifToolPath 'C:\Tools\ExifTool\exiftool.exe' -Verify
Uses a specific Windows ExifTool path and verifies the result.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\Album' -Filters '*.jpg', '*.jpeg', '*.png', '*.webp' -Recurse -PassThru
Removes metadata from common web image formats in an album and returns one result object per image.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\PublicGallery' -OutputPath '.\PublicGalleryClean' -Recurse -Paranoid -Force
Rebuilds an existing clean public gallery by overwriting previous sanitized copies.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -OutputPath '.\clean\photo.jpg' -KeepBackup
Writes a sanitized copy and allows ExifTool to keep an *_original backup of that clean-copy target.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\Scans' -OutputPath '.\Scans-Clean' -Filters '*.tif', '*.tiff' -PreserveFileTimestamp
Removes metadata from scanned TIFF files while preserving their modified timestamps.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\Export' -OutputPath '.\Export-Clean' -Filters '*.avif', '*.webp' -Recurse -Verify -PassThru
Sanitizes modern web image exports and returns verification details for each clean file.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\one.jpg', '.\two.png', '.\three.webp' -OutputPath '.\CleanBatch' -PassThru
Sanitizes a small explicit batch of files into one clean output directory.
.EXAMPLE
PS > Remove-ImageMetadata -Path '.\photo.jpg' -OutputPath '.\clean\photo.jpg' -Paranoid -Verify -ResetFileTimestamp -PassThru
Creates a clean copy using the strictest workflow and returns processing, timestamp, and verification details.
.OUTPUTS
System.Management.Automation.PSCustomObject
When PassThru is specified, returns one object per file with Path,
MetadataRemoved, ExitCode, Message, and related processing details.
.NOTES
Author: Jon LaBelle
License: MIT
Source: https://github.com/jonlabelle/pwsh-profile/blob/main/Functions/MediaProcessing/Remove-ImageMetadata.ps1
.LINK
https://exiftool.org/
.LINK
https://github.com/jonlabelle/pwsh-profile/blob/main/Functions/MediaProcessing/Remove-ImageMetadata.ps1
#>
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Justification = 'Metadata is a mass noun in this command name.')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Several parameters are consumed by nested helper functions; the analyzer reports false positives for this pattern.')]
[CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = 'InPlace')]
[OutputType([PSCustomObject])]
param(
[Parameter(Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)]
[Alias('Directory', 'Folder', 'Location', 'FilePath', 'FullName')]
[ValidateNotNullOrEmpty()]
[String[]]
$Path = @($PWD.Path),
[Parameter()]
[ValidateNotNullOrEmpty()]
[String[]]
$Filters = @('*.jpg', '*.jpeg', '*.png', '*.tif', '*.tiff', '*.webp', '*.heic', '*.heif', '*.avif', '*.gif', '*.bmp'),
[Parameter()]
[ValidateNotNullOrEmpty()]
[String[]]
$Exclude = @('.git', 'node_modules', '.vscode'),
[Parameter()]
[Switch]
$Recurse,
[Parameter()]
[ValidateNotNullOrEmpty()]
[String]
$ExifToolPath,
[Parameter(ParameterSetName = 'InPlaceParanoid')]
[Parameter(ParameterSetName = 'InPlaceParanoidPreserveTimestamp')]
[Parameter(ParameterSetName = 'InPlaceParanoidResetTimestamp')]
[Parameter(ParameterSetName = 'OutputParanoid')]
[Parameter(ParameterSetName = 'OutputParanoidPreserveTimestamp')]
[Parameter(ParameterSetName = 'OutputParanoidResetTimestamp')]
[ValidateNotNullOrEmpty()]
[String]
$ImageMagickPath,
[Parameter(Mandatory, ParameterSetName = 'Output')]
[Parameter(Mandatory, ParameterSetName = 'OutputPreserveTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'OutputResetTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'OutputParanoid')]
[Parameter(Mandatory, ParameterSetName = 'OutputParanoidPreserveTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'OutputParanoidResetTimestamp')]
[ValidateNotNullOrEmpty()]
[String]
$OutputPath,
[Parameter(ParameterSetName = 'Output')]
[Parameter(ParameterSetName = 'OutputPreserveTimestamp')]
[Parameter(ParameterSetName = 'OutputResetTimestamp')]
[Parameter(ParameterSetName = 'OutputParanoid')]
[Parameter(ParameterSetName = 'OutputParanoidPreserveTimestamp')]
[Parameter(ParameterSetName = 'OutputParanoidResetTimestamp')]
[Switch]
$Force,
[Parameter()]
[Switch]
$KeepBackup,
[Parameter(Mandatory, ParameterSetName = 'InPlacePreserveTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'InPlaceParanoidPreserveTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'OutputPreserveTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'OutputParanoidPreserveTimestamp')]
[Switch]
$PreserveFileTimestamp,
[Parameter(Mandatory, ParameterSetName = 'InPlaceResetTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'InPlaceParanoidResetTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'OutputResetTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'OutputParanoidResetTimestamp')]
[Switch]
$ResetFileTimestamp,
[Parameter(ParameterSetName = 'InPlaceResetTimestamp')]
[Parameter(ParameterSetName = 'InPlaceParanoidResetTimestamp')]
[Parameter(ParameterSetName = 'OutputResetTimestamp')]
[Parameter(ParameterSetName = 'OutputParanoidResetTimestamp')]
[DateTime]
$ResetTimestamp = ([DateTime]::SpecifyKind([DateTime]'2000-01-01T00:00:00', [DateTimeKind]::Utc)),
[Parameter(Mandatory, ParameterSetName = 'InPlaceParanoid')]
[Parameter(Mandatory, ParameterSetName = 'InPlaceParanoidPreserveTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'InPlaceParanoidResetTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'OutputParanoid')]
[Parameter(Mandatory, ParameterSetName = 'OutputParanoidPreserveTimestamp')]
[Parameter(Mandatory, ParameterSetName = 'OutputParanoidResetTimestamp')]
[Switch]
$Paranoid,
[Parameter()]
[Switch]
$Verify,
[Parameter()]
[Switch]
$PassThru
)
begin
{
Write-Verbose 'Starting image metadata removal'
if ($PSVersionTable.PSVersion.Major -lt 6)
{
$script:IsWindowsPlatform = $true
$script:IsMacOSPlatform = $false
$script:IsLinuxPlatform = $false
}
else
{
$script:IsWindowsPlatform = $IsWindows
$script:IsMacOSPlatform = $IsMacOS
$script:IsLinuxPlatform = $IsLinux
}
if ($PreserveFileTimestamp -and $ResetFileTimestamp)
{
throw 'PreserveFileTimestamp and ResetFileTimestamp cannot be used together.'
}
function Get-ImageMetadataLinuxPackageManagerHint
{
$aptCommand = Get-Command -Name 'apt' -CommandType Application -ErrorAction SilentlyContinue |
Select-Object -First 1
if ($aptCommand)
{
return 'apt'
}
$apkCommand = Get-Command -Name 'apk' -CommandType Application -ErrorAction SilentlyContinue |
Select-Object -First 1
if ($apkCommand)
{
return 'apk'
}
$brewCommand = Get-Command -Name 'brew' -CommandType Application -ErrorAction SilentlyContinue |
Select-Object -First 1
if ($brewCommand)
{
return 'brew'
}
if (-not (Test-Path -Path '/etc/os-release' -PathType Leaf))
{
return ''
}
try
{
$linuxIds = @()
foreach ($line in (Get-Content -Path '/etc/os-release' -ErrorAction Stop))
{
if ($line -match '^(?<Name>ID|ID_LIKE)=(?<Value>.+)$')
{
$linuxIds += $Matches.Value.Trim().Trim('"')
}
}
$linuxFamily = ($linuxIds -join ' ').ToLowerInvariant()
if ($linuxFamily -match '\balpine\b')
{
return 'apk'
}
if ($linuxFamily -match '\b(debian|ubuntu)\b')
{
return 'apt'
}
}
catch
{
Write-Verbose "Unable to detect Linux package manager for install hint: $($_.Exception.Message)"
}
return ''
}
function Get-ImageMetadataInstallPackageHint
{
param(
[Parameter(Mandatory)]
[ValidateSet('ExifTool', 'ImageMagick')]
[String]$RequirementName
)
$installerCommand = 'Install-PlatformPackage'
if ($script:IsWindowsPlatform)
{
switch ($RequirementName)
{
'ExifTool' { return "$installerCommand -Name OliverBetz.ExifTool" }
'ImageMagick' { return "$installerCommand -Name ImageMagick.ImageMagick" }
}
}
if ($script:IsMacOSPlatform)
{
switch ($RequirementName)
{
'ExifTool' { return "$installerCommand -Name exiftool" }
'ImageMagick' { return "$installerCommand -Name imagemagick" }
}
}
if ($script:IsLinuxPlatform)
{
$linuxPackageManager = Get-ImageMetadataLinuxPackageManagerHint
switch ($linuxPackageManager)
{
'apt'
{
switch ($RequirementName)
{
'ExifTool' { return "$installerCommand -Name libimage-exiftool-perl" }
'ImageMagick' { return "$installerCommand -Name imagemagick" }
}
}
'apk'
{
switch ($RequirementName)
{
'ExifTool' { return "$installerCommand -Name exiftool" }
'ImageMagick' { return "$installerCommand -Name imagemagick" }
}
}
'brew'
{
switch ($RequirementName)
{
'ExifTool' { return "$installerCommand -Name exiftool" }
'ImageMagick' { return "$installerCommand -Name imagemagick" }
}
}
}
}
return ''
}
function Get-ImageMetadataMissingRequirementMessage
{
param(
[Parameter(Mandatory)]
[ValidateSet('ExifTool', 'ImageMagick')]
[String]$RequirementName,
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[String]$PathParameterName
)
$message = "$RequirementName executable not found. Install $RequirementName or specify the path using -$PathParameterName."
$installPackageHint = Get-ImageMetadataInstallPackageHint -RequirementName $RequirementName
if (-not [String]::IsNullOrWhiteSpace($installPackageHint))
{
$message = "$message Hint: run: $installPackageHint (function path: ./Functions/SystemAdministration/Install-PlatformPackage.ps1)."
}
return $message
}
function Get-ValidExifToolPath
{
param([String]$ProvidedPath)
$resolvedPath = $ProvidedPath
if ($resolvedPath)
{
$resolvedPath = $PSCmdlet.SessionState.Path.GetUnresolvedProviderPathFromPSPath($resolvedPath)
}
if (-not $resolvedPath)
{
$exifToolCommand = Get-Command -Name 'exiftool' -CommandType Application, ExternalScript -ErrorAction SilentlyContinue |
Select-Object -First 1
if ($exifToolCommand)
{
if ($exifToolCommand.Path)
{
$resolvedPath = $exifToolCommand.Path
}
else
{
$resolvedPath = $exifToolCommand.Source
}
Write-Verbose "Using ExifTool from PATH: $resolvedPath"
}
else
{
if ($script:IsWindowsPlatform)
{
$commonPaths = @(
'C:\Windows\exiftool.exe',
'C:\Program Files\ExifTool\exiftool.exe',
'C:\Program Files (x86)\ExifTool\exiftool.exe',
"$env:USERPROFILE\scoop\apps\exiftool\current\exiftool.exe",
"$env:ProgramData\chocolatey\bin\exiftool.exe"
)
}
elseif ($script:IsMacOSPlatform)
{
$commonPaths = @(
'/opt/homebrew/bin/exiftool',
'/usr/local/bin/exiftool',
'/opt/local/bin/exiftool',
"$env:HOME/.local/bin/exiftool",
"$env:HOME/bin/exiftool"
)
}
else
{
$commonPaths = @(
'/usr/bin/exiftool',
'/usr/local/bin/exiftool',
'/snap/bin/exiftool',
"$env:HOME/.local/bin/exiftool",
"$env:HOME/bin/exiftool"
)
}
foreach ($pathCandidate in $commonPaths)
{
if (Test-Path -LiteralPath $pathCandidate -PathType Leaf)
{
$resolvedPath = $pathCandidate
Write-Verbose "Found ExifTool at: $resolvedPath"
break
}
}
}
}
if (-not $resolvedPath -or -not (Test-Path -LiteralPath $resolvedPath -PathType Leaf))
{
throw (Get-ImageMetadataMissingRequirementMessage -RequirementName 'ExifTool' -PathParameterName 'ExifToolPath')
}
return $resolvedPath
}
function Get-ValidImageMagickPath
{
param([String]$ProvidedPath)
$resolvedPath = $ProvidedPath
if ($resolvedPath)
{
$resolvedPath = $PSCmdlet.SessionState.Path.GetUnresolvedProviderPathFromPSPath($resolvedPath)
}
if (-not $resolvedPath)
{
$imageMagickCommand = Get-Command -Name 'magick' -CommandType Application, ExternalScript -ErrorAction SilentlyContinue |
Select-Object -First 1
if (-not $imageMagickCommand -and -not $script:IsWindowsPlatform)
{
$imageMagickCommand = Get-Command -Name 'convert' -CommandType Application, ExternalScript -ErrorAction SilentlyContinue |
Select-Object -First 1
}
if ($imageMagickCommand)
{
if ($imageMagickCommand.Path)
{
$resolvedPath = $imageMagickCommand.Path
}
else
{
$resolvedPath = $imageMagickCommand.Source
}
Write-Verbose "Using ImageMagick from PATH: $resolvedPath"
}
else
{
if ($script:IsWindowsPlatform)
{
$commonPaths = @(
'C:\Program Files\ImageMagick-7.1.1-Q16-HDRI\magick.exe',
'C:\Program Files\ImageMagick-7.1.0-Q16-HDRI\magick.exe',
"$env:ProgramData\chocolatey\bin\magick.exe",
"$env:USERPROFILE\scoop\apps\imagemagick\current\magick.exe"
)
}
elseif ($script:IsMacOSPlatform)
{
$commonPaths = @(
'/opt/homebrew/bin/magick',
'/usr/local/bin/magick',
'/opt/local/bin/magick',
"$env:HOME/.local/bin/magick",
"$env:HOME/bin/magick",
'/opt/homebrew/bin/convert',
'/usr/local/bin/convert'
)
}
else
{
$commonPaths = @(
'/usr/bin/magick',
'/usr/local/bin/magick',
'/snap/bin/magick',
"$env:HOME/.local/bin/magick",
"$env:HOME/bin/magick",
'/usr/bin/convert',
'/usr/local/bin/convert'
)
}
foreach ($pathCandidate in $commonPaths)
{
if (Test-Path -LiteralPath $pathCandidate -PathType Leaf)
{
$resolvedPath = $pathCandidate
Write-Verbose "Found ImageMagick at: $resolvedPath"
break
}
}
}
}
if (-not $resolvedPath -or -not (Test-Path -LiteralPath $resolvedPath -PathType Leaf))
{
throw (Get-ImageMetadataMissingRequirementMessage -RequirementName 'ImageMagick' -PathParameterName 'ImageMagickPath')
}
return $resolvedPath
}
function Test-ImageFileName
{
param([System.IO.FileInfo]$FileInfo)
foreach ($filter in $Filters)
{
if ($FileInfo.Name -like $filter)
{
return $true
}
}
return $false
}
function Test-ExcludedDirectory
{
param([System.IO.FileInfo]$FileInfo)
if (-not $Recurse -or -not $FileInfo.DirectoryName -or $Exclude.Count -eq 0)
{
return $false
}
$directoryParts = $FileInfo.DirectoryName -split '[\\/]'
foreach ($excludeDirectory in $Exclude)
{
if ($directoryParts -contains $excludeDirectory)
{
return $true
}
}
return $false
}
function Resolve-ImageMetadataPath
{
param([String]$InputPath)
if ([String]::IsNullOrWhiteSpace($InputPath))
{
Write-Warning 'Path parameter is null or empty, skipping.'
return @()
}
try
{
if ([System.Management.Automation.WildcardPattern]::ContainsWildcardCharacters($InputPath))
{
$resolvedItems = @(Resolve-Path -Path $InputPath -ErrorAction Stop)
}
else
{
$resolvedProviderPath = $PSCmdlet.SessionState.Path.GetUnresolvedProviderPathFromPSPath($InputPath)
$resolvedItems = @([PSCustomObject]@{ Path = $resolvedProviderPath })
}
}
catch
{
Write-Error $_.Exception.Message
return @()
}
$imageFiles = [System.Collections.Generic.List[System.IO.FileInfo]]::new()
foreach ($resolvedItem in $resolvedItems)
{
$resolvedPath = $resolvedItem.Path
if (-not (Test-Path -LiteralPath $resolvedPath))
{
Write-Error "Path not found: '$resolvedPath'"
continue
}
$pathItem = Get-Item -LiteralPath $resolvedPath -ErrorAction Stop
if ($pathItem.PSIsContainer)
{
foreach ($filter in $Filters)
{
$childItemParams = @{
LiteralPath = $pathItem.FullName
Filter = $filter
File = $true
ErrorAction = 'Stop'
}
if ($Recurse)
{
$childItemParams.Recurse = $true
}
try
{
$filesForFilter = @(Get-ChildItem @childItemParams)
}
catch
{
Write-Error $_.Exception.Message
continue
}
foreach ($fileForFilter in $filesForFilter)
{
if (-not (Test-ExcludedDirectory -FileInfo $fileForFilter))
{
$imageFiles.Add($fileForFilter)
}
}
}
}
elseif ($pathItem -is [System.IO.FileInfo])
{
if (Test-ImageFileName -FileInfo $pathItem)
{
$imageFiles.Add($pathItem)
}
else
{
Write-Warning "Skipping unsupported image file extension: '$($pathItem.FullName)'"
}
}
}
return @($imageFiles)
}
function Get-ImageOutputPath
{
param(
[System.IO.FileInfo]$FileInfo,
[Int32]$TotalFileCount
)
if (-not $OutputPath)
{
return $FileInfo.FullName
}
$resolvedOutputPath = $PSCmdlet.SessionState.Path.GetUnresolvedProviderPathFromPSPath($OutputPath)
$treatAsDirectory = $true
if ($TotalFileCount -eq 1 -and [System.IO.Path]::GetExtension($resolvedOutputPath))
{
if (-not (Test-Path -LiteralPath $resolvedOutputPath -PathType Container))
{
$treatAsDirectory = $false
}
}
if ($treatAsDirectory)
{
return (Join-Path -Path $resolvedOutputPath -ChildPath $FileInfo.Name)
}
return $resolvedOutputPath
}
function Get-TemporaryImagePath
{
param([String]$DestinationPath)
$destinationDirectory = Split-Path -Path $DestinationPath -Parent
$extension = [System.IO.Path]::GetExtension($DestinationPath)
if ([String]::IsNullOrWhiteSpace($extension))
{
$extension = '.img'
}
do
{
$fileName = '.remove-image-metadata-{0}{1}' -f ([Guid]::NewGuid().ToString('N')), $extension
$temporaryPath = Join-Path -Path $destinationDirectory -ChildPath $fileName
}
while (Test-Path -LiteralPath $temporaryPath)
return $temporaryPath
}
function Move-ImageMetadataOutput
{
param(
[String]$SourcePath,
[String]$DestinationPath,
[Boolean]$AllowOverwrite,
[Boolean]$UseForce
)
if ((Test-Path -LiteralPath $DestinationPath) -and -not $AllowOverwrite)
{
throw "Output file already exists: '$DestinationPath'. Use -Force to overwrite it."
}
if ($UseForce)
{
Move-Item -LiteralPath $SourcePath -Destination $DestinationPath -Force -ErrorAction Stop
return
}
if (Test-Path -LiteralPath $DestinationPath)
{
[System.IO.File]::Copy($SourcePath, $DestinationPath, $true)
[System.IO.File]::Delete($SourcePath)
return
}
[System.IO.File]::Move($SourcePath, $DestinationPath)
}
function Invoke-ExifToolMetadataRemoval
{
param([String]$FilePath)
$exifToolArgs = @()
if (-not $KeepBackup)
{
$exifToolArgs += '-overwrite_original'
}
if ($PreserveFileTimestamp)
{
$exifToolArgs += '-P'
}
$exifToolArgs += '-all='
$exifToolArgs += $FilePath
Write-Verbose "ExifTool command: $exifToolExecutable $($exifToolArgs -join ' ')"
$global:LASTEXITCODE = 0
$commandOutput = @(& $exifToolExecutable @exifToolArgs 2>&1)
$exitCode = $LASTEXITCODE
$message = ($commandOutput | ForEach-Object { "$_" }) -join [Environment]::NewLine
return [PSCustomObject]@{
ExitCode = $exitCode
Message = $message
}
}
function Invoke-ImageMagickStrip
{
param(
[String]$SourcePath,
[String]$DestinationPath
)
$imageMagickArgs = @(
$SourcePath
'-auto-orient'
'-strip'
$DestinationPath
)
Write-Verbose "ImageMagick command: $imageMagickExecutable $($imageMagickArgs -join ' ')"