This repository was archived by the owner on Jan 9, 2024. It is now read-only.
forked from genXdev/GenXdev.FileSystem
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGenXdev.FileSystem.psm1
More file actions
1947 lines (1436 loc) · 75.6 KB
/
GenXdev.FileSystem.psm1
File metadata and controls
1947 lines (1436 loc) · 75.6 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
###############################################################################
<#
Copyright 2021 René Vaessen - genXdev
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#>
###############################################################################
<#
.SYNOPSIS
Finds files by searchmask
.DESCRIPTION
Finds files by searchmask on every disk available in the current session
.PARAMETER SearchMask
Partial or full filename to look for
.PARAMETER File
Only find files
.PARAMETER Directory
Only find directories
.EXAMPLE
Find-Item settings.json -File
Find-Item node_modules -Directory
#>
function Find-Item {
[Alias("fi")]
param (
[parameter(
Mandatory = $true,
Position = 0,
HelpMessage = "Search phrase to look for",
ValueFromPipeline = $false
)]
[string] $SearchMask,
[Parameter(
HelpMessage = "Files only",
Mandatory = $false,
ValueFromPipeline = $false
)]
[switch] $File,
[Parameter(
HelpMessage = "Directory only",
Mandatory = $false,
ValueFromPipeline = $false
)]
[switch] $Directory
)
Get-PSDrive -ErrorAction SilentlyContinue | ForEach-Object -ThrottleLimit 8 -Parallel {
try {
if ($_.Provider.Name -eq "FileSystem") {
Get-ChildItem -Path "$($_.Root)*$SearchMask*" -File:$File -Directory:$Directory -ErrorAction SilentlyContinue
Get-ChildItem -Path "$($_.Root)" -Directory -ErrorAction SilentlyContinue |
ForEach-Object -ThrottleLimit 16 -Parallel {
try {
Get-ChildItem -Path "$($_.FullName)\*$SearchMask*" -File:$File -Directory:$Directory -Recurse -ErrorAction SilentlyContinue
}
catch {
}
}
}
}
catch {
}
}
}
###############################################################################
<#
.SYNOPSIS
Expands any given file reference to a full pathname
.DESCRIPTION
Expands any given file reference to a full pathname, with respect to the users current directory
.PARAMETER FilePath
Path to expand
.PARAMETER CreateDirectory
Will create directory if it does not exist
.EXAMPLE
GetFullPath .\
#>
function Expand-Path {
[CmdletBinding()]
[Alias("ep")]
param(
[parameter(Mandatory, Position = 0)]
[string] $FilePath,
[parameter(Mandatory = $false, Position = 1)]
[switch] $CreateDirectory = $false
)
# root folder included?
if ($FilePath.Contains(":") -or $FilePath.StartsWith("\\")) {
try {
# just normalize
$FilePath = [System.IO.Path]::GetFullPath($FilePath);
}
catch {
# keep original
}
}
else {
try {
# combine with users current directory
$FilePath = [System.IO.Path]::GetFullPath([System.IO.Path]::Combine($pwd, $FilePath));
}
catch {
# allow powershell to try to convert it
$FilePath = Convert-Path $FilePath;
}
}
# create directory?
if ($CreateDirectory -eq $true) {
# get directory name
$directory = [System.IO.Path]::GetDirectoryName($FilePath);
# does not exist?
if (![IO.Directory]::Exists($directory)) {
# create it
New-Item -ItemType Directory -Path $directory -Force
}
}
# remove trailing path delimiter
while ($FilePath.EndsWith("\") -and $FilePath.Length -gt 4) {
$FilePath = $FilePath.SubString(0, $FilePath.Length - 1)
}
return $FilePath;
}
###############################################################################
<#
.SYNOPSIS
Wrapper for Microsoft's Robust Copy Utility
Copies file data from one location to another.
.DESCRIPTION
Wrapper for Microsoft's Robust Copy Utility
Copies file data from one location to another.
Robocopy, for "Robust File Copy", is a command-line directory and/or file replication command for Microsoft Windows.
Robocopy functionally replaces Xcopy, with more options. Created by Kevin Allen and first released as part of the
Windows NT 4.0 Resource Kit, it has been a standard feature of Windows since Windows Vista and Windows Server 2008.
Key features
- Folder synchronization
- Support for extra long pathnames > 256 characters
- Restartable mode backups
- Support for copying and fixing security settings
- Advanced file attribute features
- Advanced symbolic link and junction support
- Monitor mode (restart copying after change threshold)
- Optimization features for LargeFiles, multithreaded copying and network compression
- Recovery mode (copy from failing disks)
.PARAMETER Source
The directory, filepath, or directory+searchmask
.PARAMETER DestinationDirectory
The destination directory to place the copied files and directories into.
If this directory does not exist yet, all missing directories will be created.
Default value = `.\`
.PARAMETER FileMask
Optional searchmask for selecting the files that need to be copied.
.PARAMETER Mirror
Synchronizes the content of specified directories, will also delete any files and directories in the destination that do not exist in the source
.PARAMETER Move
Will move instead of copy all files from source to destination
.PARAMETER IncludeSecurity
Will also copy ownership, security descriptors and auditing information of files and directories
.PARAMETER SkipDirectories
Copies only files from source and skips sub-directories (no recurse)
.PARAMETER SkipEmptyDirectories
Does not copy directories if they would be empty
.PARAMETER CopyOnlyDirectoryTreeStructure
Create directory tree only
.PARAMETER CopyOnlyDirectoryTreeStructureAndEmptyFiles
Create directory tree and zero-length files only
.PARAMETER SkipAllSymbolicLinks
Don't copy symbolic links, junctions or the content they point to
.PARAMETER CopySymbolicLinksAsLinks
Instead of copying the content where symbolic links point to, copy the links themselves
.PARAMETER SkipJunctions
Don't copy directory junctions (symbolic link for a folder) or the content they point to
.PARAMETER SkipSymbolicFileLinks
Don't copy file symbolic links but do follow directory junctions
.PARAMETER CopyJunctionsAsJunctons
Instead of copying the content where junctions point to, copy the junctions themselves
.PARAMETER Force
Will copy all files even if they are older then the ones in the destination
.PARAMETER SkipFilesWithoutArchiveAttribute
Copies only files that have the archive attribute set
.PARAMETER ResetArchiveAttributeAfterSelection
In addition of copying only files that have the archive attribute set, will then reset this attribute on the source
.PARAMETER FileExcludeFilter
Exclude any files that matches any of these names/paths/wildcards
.PARAMETER DirectoryExcludeFilter
Exclude any directories that matches any of these names/paths/wildcards
.PARAMETER AttributeIncludeFilter
Copy only files that have all these attributes set [RASHCNETO]
.PARAMETER AttributeExcludeFilter
Exclude files that have any of these attributes set [RASHCNETO]
.PARAMETER SetAttributesAfterCopy
Will set the given attributes to copied files [RASHCNETO]
.PARAMETER RemoveAttributesAfterCopy
Will remove the given attributes from copied files [RASHCNETO]
.PARAMETER MaxSubDirTreeLevelDepth
Only copy the top n levels of the source directory tree
.PARAMETER MinFileSize
Skip files that are not at least n bytes in size
.PARAMETER MaxFileSize
Skip files that are larger then n bytes
.PARAMETER MinFileAge
Skip files that are not at least: n days old OR created before n date (if n < 1900 then n = n days, else n = YYYYMMDD date)
.PARAMETER MaxFileAge
Skip files that are older then: n days OR created after n date (if n < 1900 then n = n days, else n = YYYYMMDD date)
.PARAMETER MinLastAccessAge
Skip files that are accessed within the last: n days OR before n date (if n < 1900 then n = n days, else n = YYYYMMDD date)
.PARAMETER MaxLastAccessAge
Skip files that have not been accessed in: n days OR after n date (if n < 1900 then n = n days, else n = YYYYMMDD date)
.PARAMETER RecoveryMode
Will shortly pause and retry when I/O errors occur during copying
.PARAMETER MonitorMode
Will stay active after copying, and copy additional changes after a a default threshold of 10 minutes
.PARAMETER MonitorModeThresholdMinutes
Run again in n minutes Time, if changed
.PARAMETER MonitorModeThresholdNrOfChanges
Run again when more then n changes seen
.PARAMETER MonitorModeRunHoursFrom
Run hours - times when new copies may be started, start-time, range 0000:2359
.PARAMETER MonitorModeRunHoursUntil
Run hours - times when new copies may be started, end-time, range 0000:2359
.PARAMETER LogFilePath
If specified, logging will also be done to specified file
.PARAMETER LogfileOverwrite
Don't append to the specified logfile, but overwrite instead
.PARAMETER LogDirectoryNames
Include all scanned directory names in output
.PARAMETER LogAllFileNames
Include all scanned file names in output, even skipped onces
.PARAMETER Unicode
Output status as UNICODE
.PARAMETER LargeFiles
Enables optimization for copying large files
.PARAMETER Multithreaded
Optimize performance by doing multithreaded copying
.PARAMETER CompressibleContent
If applicable use compression when copying files between servers to safe bandwidth and time
.PARAMETER Override
Overrides, Removes, or Adds any specified robocopy parameter.
Usage:
Add or replace parameter:
-Override /SwitchWithValue:'SomeValue'
-Override /Switch
Remove parameter:
-Override -/Switch
Multiple overrides:
-Override "/ReplaceThisSwitchWithValue:'SomeValue' -/RemoveThisSwitch /AddThisSwitch"
.PARAMETER WhatIf
Displays a message that describes the effect of the command, instead of executing the command.
.EXAMPLE
Start-RoboCopy c:\videos e:\backups\videos
Start-RoboCopy c:\users\user\onedrive\photos\screenshots e:\backups\screenshots -Move
Start-RoboCopy c:\users\user\onedrive e:\backups\onedrive -Mirror
.LINK
https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/robocopy
.LINK
https://en.wikipedia.org/wiki/Robocopy
#>
function Start-RoboCopy {
[CmdLetBinding(
DefaultParameterSetName = "Default",
ConfirmImpact = "Medium"
)]
[Alias("xc", "rc")]
Param
(
###############################################################################
[Parameter(
Mandatory = $true,
Position = 0,
ValueFromPipeline = $false,
HelpMessage = "The directory, filepath, or directory+searchmask"
)]
[string]$Source,
###############################################################################
[Parameter(
Mandatory = $false,
Position = 1,
ValueFromPipeline = $false,
HelpMessage = "The destination directory to place the copied files and directories into.
If this directory does not exist yet, all missing directories will be created.
Default value = `".\`""
)]
[string]$DestinationDirectory = ".\",
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
Position = 2,
HelpMessage = "Optional searchmask for selecting the files that need to be copied.
Default value = '*'"
)] [string[]] $Files = @(),
###############################################################################
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Synchronizes the content of specified directories, will also delete any files and directories in the destination that do not exist in the source"
)]
[switch] $Mirror,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Will move instead of copy all files from source to destination"
)]
[switch] $Move,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Will also copy ownership, security descriptors and auditing information of files and directories"
)]
[switch] $IncludeSecurity,
###############################################################################
###############################################################################
[Parameter(
ParameterSetName = "Default",
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Copies only files from source and skips sub-directories (no recurse)"
)]
[switch] $SkipDirectories,
###############################################################################
[Parameter(
ParameterSetName = "SkipDirectories",
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Does not copy directories if they would be empty"
)]
[switch] $SkipEmptyDirectories,
###############################################################################
[Parameter(
ParameterSetName = "SkipDirectories",
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Create directory tree only"
)]
[switch] $CopyOnlyDirectoryTreeStructure,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Create directory tree and zero-length files only"
)]
[switch] $CopyOnlyDirectoryTreeStructureAndEmptyFiles,
###############################################################################
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Don't copy symbolic links, junctions or the content they point to"
)]
[switch] $SkipAllSymbolicLinks,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Don't copy file symbolic links but do follow directory junctions"
)]
[switch] $SkipSymbolicFileLinks,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Instead of copying the content where symbolic links point to, copy the links themselves"
)]
[switch] $CopySymbolicLinksAsLinks,
###############################################################################
[Parameter(
ParameterSetName = "SkipDirectories",
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Don't copy directory junctions (symbolic link for a folder) or the content they point to"
)]
[switch] $SkipJunctions,
###############################################################################
[Parameter(
ParameterSetName = "SkipDirectories",
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Instead of copying the content where junctions point to, copy the junctions themselves"
)]
[switch] $CopyJunctionsAsJunctons,
###############################################################################
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Will copy all files even if they are older then the ones in the destination"
)]
[switch] $Force,
###############################################################################
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Copies only files that have the archive attribute set"
)]
[switch] $SkipFilesWithoutArchiveAttribute,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "In addition of copying only files that have the archive attribute set, will then reset this attribute on the source"
)]
[switch] $ResetArchiveAttributeAfterSelection,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Exclude any files that matches any of these names/paths/wildcards"
)]
[string[]] $FileExcludeFilter = @(),
###############################################################################
[Parameter(
ParameterSetName = "SkipDirectories",
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Exclude any directories that matches any of these names/paths/wildcards"
)]
[string[]] $DirectoryExcludeFilter = @(),
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Copy only files that have all these attributes set [RASHCNETO]"
)]
[string] $AttributeIncludeFilter,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Exclude files that have any of these attributes set [RASHCNETO]"
)]
[string] $AttributeExcludeFilter,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Will set the given attributes to copied files [RASHCNETO]"
)]
[string] $SetAttributesAfterCopy,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Will remove the given attributes from copied files [RASHCNETO]"
)]
[string] $RemoveAttributesAfterCopy,
###############################################################################
###############################################################################
[ValidateRange(1, 1000000)]
[Parameter(
ParameterSetName = "SkipDirectories",
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Only copy the top n levels of the source directory tree"
)]
[int] $MaxSubDirTreeLevelDepth = -1,
###############################################################################
[ValidateRange(0, 9999999999999999)]
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Skip files that are not at least n bytes in size"
)]
[int] $MinFileSize = -1,
###############################################################################
[ValidateRange(0, 9999999999999999)]
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Skip files that are larger then n bytes"
)]
[int] $MaxFileSize = -1,
###############################################################################
[ValidateRange(0, 99999999)]
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Skip files that are not at least: n days old OR created before n date (if n < 1900 then n = n days, else n = YYYYMMDD date)"
)]
[int] $MinFileAge = -1,
###############################################################################
[ValidateRange(0, 99999999)]
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Skip files that are older then: n days OR created after n date (if n < 1900 then n = n days, else n = YYYYMMDD date)"
)]
[int] $MaxFileAge = -1,
###############################################################################
[ValidateRange(0, 99999999)]
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Skip files that are accessed within the last: n days OR before n date (if n < 1900 then n = n days, else n = YYYYMMDD date)"
)]
[int] $MinLastAccessAge = -1,
###############################################################################
[ValidateRange(0, 99999999)]
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Skip files that have not been accessed in: n days OR after n date (if n < 1900 then n = n days, else n = YYYYMMDD date)"
)]
[int] $MaxLastAccessAge = -1,
###############################################################################
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Will shortly pause and retry when I/O errors occur during copying"
)]
[switch] $RecoveryMode,
###############################################################################
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Will stay active after copying, and copy additional changes after a a default threshold of 10 minutes"
)]
[switch] $MonitorMode,
###############################################################################
[ValidateRange(1, 144000)]
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Run again in n minutes Time, if changed"
)]
[int] $MonitorModeThresholdMinutes = -1,
###############################################################################
[ValidateRange(1, 1000000000)]
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Run again when more then n changes seen"
)]
[int] $MonitorModeThresholdNrOfChanges = -1,
###############################################################################
[ValidateRange(0, 2359)]
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Run hours - times when new copies may be started, start-time, range 0000:2359"
)]
[int] $MonitorModeRunHoursFrom = -1,
###############################################################################
[ValidateRange(0, 2359)]
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Run hours - times when new copies may be started, end-time, range 0000:2359"
)]
[int] $MonitorModeRunHoursUntil = -1,
###############################################################################
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "If specified, logging will also be done to specified file"
)]
[string] $LogFilePath,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Don't append to the specified logfile, but overwrite instead"
)]
[switch] $LogfileOverwrite,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Include all scanned directory names in output"
)]
[switch] $LogDirectoryNames,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Include all scanned file names in output, even skipped onces"
)]
[switch] $LogAllFileNames,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Output status as UNICODE"
)]
[switch] $Unicode,
###############################################################################
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Enables optimization for copying large files"
)]
[switch] $LargeFiles,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Optimize performance by doing multithreaded copying"
)]
[switch] $MultiThreaded,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "If applicable use compression when copying files between servers to safe bandwidth and time"
)]
[switch] $CompressibleContent,
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
ValueFromRemainingArguments = $true,
Position = 3,
HelpMessage = "Overrides, Removes, or Adds any specified robocopy parameter.
Usage:
Add or replace parameter:
-Override /SwitchWithValue:'SomeValue'
-Override /Switch
Remove parameter:
-Override -/Switch
Multiple overrides:
-Override `"/ReplaceThisSwitchWithValue:'SomeValue' -/RemoveThisSwitch /AddThisSwitch`"
"
)]
[string] $Override,
###############################################################################
###############################################################################
[Parameter(
Mandatory = $false,
ValueFromPipeline = $false,
HelpMessage = "Displays a message that describes the effect of the command, instead of executing the command."
)]
[switch] $WhatIf
)
Begin {
###############################################################################
# initialize settings
$RobocopyPath = "$env:SystemRoot\system32\robocopy.exe";
# normalize to current directory
$Source = Expand-Path $Source
$DestinationDirectory = Expand-Path $DestinationDirectory
# source is not an existing directory?
if ([IO.Directory]::Exists($Source) -eq $false) {
# split directory and filename
$SourceSearchMask = [IO.Path]::GetFileName($Source);
$SourceDirOnly = [IO.Path]::GetDirectoryName($Source);
# does parent directory exist?
if ([IO.Directory]::Exists($SourceDirOnly)) {
# ..but the supplied source parameter is not an existing file?
if ([IO.File]::Exists($Source) -eq $false) {
# ..and the supplied filename is not searchMask?
if (!$SourceSearchMask.Contains("*") -and !$SourceSearchMask.Contains("?")) {
throw "Could not find source: $Source"
}
}
$Mirror = $false;
}
# reconfigure
$Source = $SourceDirOnly;
if ($Files -notcontains $SourceSearchMask) {
$Files = $Files + @($SourceSearchMask);
}
}
# default value
if ($Files.Length -eq 0) {
$Files = @("*");
}
# destination directory does not exist yet?
if ([IO.Directory]::Exists($DestinationDirectory) -eq $false) {
# create it
[IO.Directory]::CreateDirectory($DestinationDirectory) | Out-Null
}
# Turn on verbose
$VerbosePreference = "Continue"
###############################################################################
function CurrentUserHasElivatedRights() {
$id = [System.Security.Principal.WindowsIdentity]::GetCurrent()
$p = New-Object System.Security.Principal.WindowsPrincipal($id)
if ($p.IsInRole([System.Security.Principal.WindowsBuiltInRole]::Administrator) -or
$p.IsInRole([System.Security.Principal.WindowsBuiltInRole]::BackupOperator)) {
return $true;
}
return $false;
}
function ConstructFileFilterSet([string[]] $FileFilterSet, [string] $CommandName) {
$result = "";
$FileFilterSet | ForEach-Object {
$result = "$result '$PSItem'".Trim()
}
return $result;
}
function SanitizeAttributeSet([string] $AttributeSet, [string] $CommandName) {
$AttributeSetNew = "";
$AttributeSet.Replace("[", "").Replace("]", "").ToUpperInvariant().ToCharArray() | ForEach-Object {
if (("RASHCNETO".IndexOf($PSItem) -ge 0) -and ($AttributeSetNew.IndexOf($PSItem) -lt 0)) {
$AttributeSetNew = "$AttributeSet$PSItem";
}
else {
throw "Could not parse parameter -$CommandName $AttributeSet - '$PSIem' is not valid
possible attributes to combine: [RASHCNETO]
R - Read only
A - Archive
S - System
H - Hidden
C - Compressed
N - Not content indexed
E - Encrypted
T - Temporary
O - Offline
"
}
}
return $AttributeSetNew
}
function CheckAgeInteger([int] $AgeValue, [string] $CommandName) {
if ($AgeValue -ge 1900) {
[DateTime] $date;
if ([DateTime]::TryParse("$MaxFileAge", [ref] $date) -eq $false) {
throw "Could not parse parameter '-$CommandName $AgeValue as a valid date (if n < 1900 then n = n days, else n = YYYYMMDD date)"
}
}
}
function getSwitchesDictionary([string] $Switches) {
# initialize
$switchesDictionary = New-Object "System.Collections.Generic.Dictionary[String, String]";
if ([String]::IsNullOrWhiteSpace($Switches)) {
return $switchesDictionary
}
$switchesCleaned = " $Switches ";
# remove spaces
while ($switchesCleaned.IndexOf(" /") -ge 0) {
$switchesCleaned = $switchesCleaned.Replace(" /", " /");
}
while ($switchesCleaned.IndexOf(" -/") -ge 0) {
$switchesCleaned = $switchesCleaned.Replace(" -/", " -/");
}
# split up
$allSwitches = $switchesCleaned.Replace(" -/", " /-").Split(" /", [System.StringSplitOptions]::RemoveEmptyEntries);
# enumerate switches
$allSwitches | ForEach-Object -ErrorAction SilentlyContinue {
# add to Dictionary
$switchesDictionary["$($PSItem.Trim().Split(" ")[0].Split(":" )[0].Trim().ToUpperInvariant())"] = $PSItem.Trim()
}
return $switchesDictionary;
}
function overrideAndCleanSwitches([string] $Switches) {
$autoGeneratedSwitches = (getSwitchesDictionary $Switches)
$overridenSwitches = (getSwitchesDictionary $Override)
$newSwitches = "";
$autoGeneratedSwitches.GetEnumerator() | ForEach-Object -ErrorAction SilentlyContinue {
# should NOT remove it?
if (!$overridenSwitches.ContainsKey("-$($PSItem.Key)")) {
# should replace it?
if ($overridenSwitches.ContainsKey($PSItem.Key)) {
$newSwitches += " /$($overridenSwitches[$PSItem.Key])"
}
else {