DSCResources/MSFT_xArchive/MSFT_xArchive.psm1

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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
data LocalizedData
{
    # culture="en-US"
    ConvertFrom-StringData @'
    InvalidChecksumArgsMessage=Specifying a Checksum without requesting content validation (the Validate parameter) is not meaningful
    InvalidDestinationDirectory=The specified destination directory {0} does not exist or is not a directory
    InvalidSourcePath=The specified source file {0} does not exist or is not a file
    ErrorOpeningExistingFile=An error occurred while opening the file {0} on disk. Please examine the inner exception for details
    ErrorOpeningArchiveFile=An error occurred while opening the archive file {0}. Please examine the inner exception for details
    ItemExistsButIsWrongType=The named item ({0}) exists but is not the expected type, and Force was not specified
    ItemExistsButIsIncorrect=The destination file {0} has been determined not to match the source, but Force has not been specified. Cannot continue
    ErrorCopyingToOutstream=An error was encountered while copying the archived file to {0}
    PackageUninstalled=The archive at {0} was removed from destination {1}
    PackageInstalled=The archive at {0} was unpacked to destination {1}
    ConfigurationStarted=The configuration of MSFT_ArchiveResource is starting
    ConfigurationFinished=The configuration of MSFT_ArchiveResource has completed
    MakeDirectory=Make directory {0}
    RemoveFileAndRecreateAsDirectory=Remove existing file {0} and replace it with a directory of the same name
    RemoveFile=Remove file {0}
    RemoveDirectory=Remove directory {0}
    UnzipFile=Unzip archived file to {0}
    DestMissingOrIncorrectTypeReason=The destination file {0} was missing or was not a file
    DestHasIncorrectHashvalue=The destination file {0} exists but its checksum did not match the origin file
    DestShouldNotBeThereReason=The destination file {0} exists but should not
    PathNotFoundError=The path {0} either does not exist or is not a valid file system path.
    InvalidZipFileExtensionError={0} is not a supported archive file format. {1} is the only supported archive file format.
    ZipFileExistError=The archive file {0} already exists. If you want to update the existing archive file, run the same command with -Update switch parameter.
    InvalidPathForExpandError=The input to Path parameter {0} contains multiple file system paths. When DestinationType is set to Directory, the Path parameter can accept only one path to the archive file which would be expanded to the path specified by Destination parameter.
    InvalidDirZipFileExtensionError={0} is a directory path. The destination path needs to be a path to an archive file. {1} is the only supported archive file format.
    DuplicatePathFoundError=The input to {0} parameter contains a duplicate path '{1}'. Provide a unique set of paths as input to {2} parameter.
'@

}

Import-LocalizedData  LocalizedData -filename ArchiveResources

$compressCacheLocation = "$env:ProgramData\Microsoft\PSDesiredStateConfiguration\DSCResources\xArchive\Cache"
$CompressionLevelString = "CompressionLevel"
$FileCountString = "FileCount"
$DirectoryCountString = "DirectoryCount"
$LastWriteTimeUtcString = "LastWriteTimeUtc"

# Begin Expand CodeBase

$Debug = $false
Function Trace-Message
{
    param([string] $Message)
    if($Debug)
    {
        Write-Verbose $Message
    }
}

$CacheLocation = "$env:systemroot\system32\Configuration\BuiltinProvCache\MSFT_ArchiveResource"


Function Get-CacheEntry
{
    $key = [string]::Join($args).GetHashCode().ToString()
    Trace-Message "Using ($key) to retrieve hash value"
    $path = Join-Path $CacheLocation $key
    if(-not (Test-Path $path))
    {
        Trace-Message "No cache value found"
        return @{}
    }
    else
    {
        $tmp = Import-CliXml $path
        Trace-Message "Cache value found, returning $tmp"
        return $tmp
    }
}

Function Set-CacheEntry
{
    param([object] $InputObject)
    $key = [string]::Join($args).GetHashCode().ToString()
    Trace-Message "Using $tmp ($key) to save hash value"
    $path = Join-Path $CacheLocation $key
    Trace-Message "About to cache value $InputObject"
    if(-not (Test-Path $CacheLocation))
    {
        mkdir $CacheLocation | Out-Null
    }
    
    Export-CliXml -Path $path -InputObject $InputObject
}

Function Throw-InvalidArgumentException
{
    param(
        [string] $Message,
        [string] $ParamName
    )
    
    $exception = new-object System.ArgumentException $Message,$ParamName
    $errorRecord = New-Object System.Management.Automation.ErrorRecord $exception,$ParamName,"InvalidArgument",$null
    throw $errorRecord
}

Function Throw-TerminatingError
{
    param(
        [string] $Message,
        [System.Management.Automation.ErrorRecord] $ErrorRecord,
        [string] $ExceptionType
    )
    
    $exception = new-object "System.InvalidOperationException" $Message,$ErrorRecord.Exception
    $errorRecord = New-Object System.Management.Automation.ErrorRecord $exception,"MachineStateIncorrect","InvalidOperation",$null
    throw $errorRecord
}

Function Assert-ValidStandardArgs
{
    param(
        [string] $Path,
        [string] $Destination,
        [boolean] $Validate,
        [string] $Checksum
    )
    
    #mkdir and Test-Path can each fail with a useful error message
    #We want to stop our execution if that happens
    $ErrorActionPreference = "Stop"
    
    if(-not (Test-Path -PathType Leaf $Path))
    {
        Throw-InvalidArgumentException ($LocalizedData.InvalidSourcePath -f $Path) "Path"
    }
    
    $item = Get-Item -ErrorAction Ignore -LiteralPath $Destination
    if($item -and $item.GetType() -eq [System.IO.FileInfo])
    {
        Throw-InvalidArgumentException ($LocalizedData.InvalidDestinationDirectory -f $Destination) "Destination"
    }
    
    if($Checksum -and -not $Validate)
    {
        Throw-InvalidArgumentException ($LocalizedData.InvalidChecksumArgsMessage -f $Checksum) "Checksum"
    }
}

Function Get-Hash
{
    param(
        [System.IO.Stream] $Stream,
        [string] $Algorithm
    )
    
    $hashGenerator = $null
    $hashNameToType = @{
        #This is the sort of thing that normally is declared as a global constant, but referencing the type incurs cost
        #that we're trying to avoid in some cold-start cases
        "sha-1" = [System.Security.Cryptography.SHA1]
        "sha-256" = [System.Security.Cryptography.SHA256];
        "sha-512" = [System.Security.Cryptography.SHA512]
    }
    $algorithmType = $hashNameToType[$Algorithm]
    try
    {
        $hashGenerator = $algorithmType::Create() #All types in the dictionary will have this method
        [byte[]]$hashGenerator.ComputeHash($Stream)
    }
    finally
    {
        if($hashGenerator)
        {
            $hashGenerator.Dispose()
        }
    }
}

Function Compare-FileToEntry
{
    param(
        [string] $FileName,
        [object] $Entry,
        [string] $Algorithm
    )
    
    $existingStream = $null
    $hash1 = $null
    try
    {
        $existingStream = New-Object System.IO.FileStream $FileName, "Open"
        $hash1 = Get-Hash $existingStream $Algorithm
    }
    catch
    {
        Throw-TerminatingError ($LocalizedData.ErrorOpeningExistingFile -f $FileName) $_
    }
    finally
    {
        if($existingStream -ne $null)
        {
            $existingStream.Dispose()
        }
    }
    
    $hash2 = $Entry.Checksum
    for($i = 0; $i -lt $hash1.Length; $i++)
    {
        if($hash1[$i] -ne $hash2[$i])
        {
            return $false
        }
    }
    
    return $true
}

Function Get-RelevantChecksumTimestamp
{
    param(
        [System.IO.FileSystemInfo] $FileSystemObject,
        [String] $Checksum
    )
    
    if($Checksum.Equals("createddate"))
    {
        return $FileSystemObject.CreationTime
    }
    else #$Checksum.Equals("modifieddate")
    {
        return $FileSystemObject.LastWriteTime
    }
}

Function Update-Cache
{
    param(
        [Hashtable] $CacheObject,
        [System.IO.Compression.ZipArchiveEntry[]] $Entries,
        [string] $Checksum,
        [string] $SourceLastWriteTime
    )
    
    Trace-Message "In Update-Cache"
    $cacheEntries = new-object System.Collections.ArrayList
    foreach($entry in $Entries)
    {
        $hash = $null
        if($Checksum.StartsWith("sha"))
        {
            $stream = $null
            try
            {
                $stream = $entry.Open()
                $hash = Get-Hash $stream $Checksum
            }
            finally
            {
                if($stream)
                {
                    $stream.Dispose()
                }
            }
        }
        
        Trace-Message "Adding $entry.FullName as a cache entry"
        $cacheEntries.Add(@{
            FullName = $entry.FullName
            LastWriteTime = $entry.LastWriteTime
            Checksum = $hash
        }) | Out-Null
    }
    
    Trace-Message "Updating CacheObject"
    $CacheObject["SourceLastWriteTime"] = $SourceLastWriteTime
    $CacheObject["Entries"] = (@() + $cacheEntries)
    Set-CacheEntry -InputObject $CacheObject $Path $Destination
    Trace-Message "Placed new cache entry"
}

Function Normalize-Checksum
{
    param(
        [boolean] $Validate,
        [string] $Checksum
    )
    
    if($Validate)
    {
        if(-not $Checksum)
        {
            $Checksum = "SHA-256"
        }
        
        $Checksum = $Checksum.ToLower()
    }
    
    Trace-Message "Normalize-Checksum returning $Checksum"
    return $Checksum
}

# The Test-ExpandArchive cmdlet is used to test the status of item on the destination
function Test-ExpandArchive
{
    param
    (
        [ValidateSet("Present", "Absent")]
        [string] $Ensure = "Present",
        
        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string] $Path,
        
        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string] $Destination,
        
        [boolean] $Validate = $false,
        
        [ValidateSet("", "SHA-1", "SHA-256", "SHA-512", "CreatedDate", "ModifiedDate")]
        [string] $Checksum,

        [boolean] $Force = $false
    )

    $ErrorActionPreference = "Stop"
    
    Trace-Message "About to validate standard arguments"
    Assert-ValidStandardArgs $Path $Destination $Validate $Checksum
    $Checksum = Normalize-Checksum $Validate $Checksum
    Trace-Message "Going for cache entries"
    $result = $true
    $cacheObj = Get-CacheEntry $Path $Destination
    $sourceLastWriteTime = (Get-Item -LiteralPath $Path).LastWriteTime
    $cacheUpToDate = $cacheObj -and $cacheObj.SourceLastWriteTime -and $cacheObj.SourceLastWriteTime -eq $sourceLastWriteTime
    $file = $null
    try
    {
        $entries = $null
        if($cacheUpToDate)
        {
            Trace-Message "The cache was up to date, using cache to satisfy requests"
            $entries = $cacheObj.Entries
        }
        else
        {
            Trace-Message "About to open the zip file"
            $entries, $null, $file = Open-ZipFile $Path
            
            Trace-Message "Updating cache"
            Update-Cache $cacheObj $entries $Checksum $sourceLastWriteTime
            $entries = $cacheObj.Entries
            Trace-Message ("Cache updated with {0} entries" -f $cacheObj.Entries.Length)
        }
        
        foreach($entry in $entries)
        {
            $individualResult = $true
            Trace-Message ("Processing {0}" -f $entry.FullName)
            $dest = join-path $Destination $entry.FullName
            if($dest.EndsWith('\')) #Directory
            {
                $dest = $dest.TrimEnd('\')
                if(-not (Test-Path -PathType Container $dest))
                {
                    Write-Verbose ($LocalizedData.DestMissingOrIncorrectTypeReason -f $dest)
                    $individualResult = $result = $false
                }
            }
            else
            {
                $item = Get-Item -LiteralPath $dest -ErrorAction Ignore
                if(-not $item)
                {
                    $individualResult = $result = $false
                }
                elseif($item.GetType() -ne [System.IO.FileInfo])
                {
                    $individualResult = $result = $false
                }
                
                if(-not $Checksum)
                {
                    Trace-Message "In Test-TargetResource: $dest exists, not using checksums, continuing"
                    if(-not $individualResult -and $Ensure -eq "Present")
                    {
                        Write-Verbose ($LocalizedData.DestMissingOrIncorrectTypeReason -f $dest)
                    }
                    elseif($individualResult -and $Ensure -eq "Absent")
                    {
                        Write-Verbose ($LocalizedData.DestShouldNotBeThereReason -f $dest)
                    }
                }
                else
                {
                    #If the file is there we need to check if it could possibly fail in a different way
                    #Otherwise we skip all these checks - there's nothing to work with
                    if($individualResult)
                    {
                        $Checksum = $Checksum.ToLower()
                        if($Checksum.StartsWith("sha"))
                        {
                            if($item.LastWriteTime.Equals($entry.ExistingItemTimestamp))
                            {
                                Trace-Message "Not performing checksum, the file on disk has the same write time as the last time we verified its contents"
                            }
                            else
                            {
                                if(-not (Compare-FileToEntry $dest $entry $Checksum))
                                {
                                    $individualResult = $result = $false
                                }
                                else
                                {
                                    $entry.ExistingItemTimestamp = $item.LastWriteTime
                                    Trace-Message "$dest exists and the hash matches even though the LastModifiedTime didn't (for some reason) updating cache"
                                }
                            }
                        }
                        else
                        {
                            $date = Get-RelevantChecksumTimestamp $item $Checksum
                            if(-not $date.Equals($entry.LastWriteTime.DateTime))
                            {
                                $individualResult = $result = $false
                            }
                            else
                            {
                                Trace-Message "In Test-TargetResource: $dest exists and the selected timestamp ($Checksum) matched"
                            }
                        }
                    }
                    
                    if(-not $individualResult -and $Ensure -eq "Present")
                    {
                        Write-Verbose ($LocalizedData.DestHasIncorrectHashvalue -f $dest)
                    }
                    elseif($individualResult -and $Ensure -eq "Absent")
                    {
                        Write-Verbose ($LocalizedData.DestShouldNotBeThereReason -f $dest)
                    }
                }
            }
        }
    }
    finally
    {
        if($file)
        {
            $file.Dispose()
        }
    }
    
    Set-CacheEntry -InputObject $cacheObj $Path $Destination
    $result = $result -eq ("Present" -eq $Ensure)
    return $result
}
        
Function Ensure-Directory
{
    param([string] $Dir)
    $item = Get-Item -LiteralPath $Dir -ErrorAction SilentlyContinue
    if(-not $item)
    {
        Trace-Message "Folder $Dir does not exist"
        if($PSCmdlet.ShouldProcess(($LocalizedData.MakeDirectory -f $Dir), $null, $null))
        {
            mkdir $Dir | Out-Null
        }
    }
    else
    {
        if($item.GetType() -ne [System.IO.DirectoryInfo])
        {
            if($Force -and $PSCmdlet.ShouldProcess(($LocalizedData.RemoveFileAndRecreateAsDirectory -f $Dir), $null, $null))
            {
                Trace-Message "Removing $Dir"
                rm $Dir | Out-Null
                mkdir $Dir | Out-Null #Note that we don't do access time translations onto directories since we are emulating the shell's behavior
            }
            else
            {
                Throw-TerminatingError ($LocalizedData.ItemExistsButIsWrongType -f $Path)
            }
        }
    }
}

Function Open-ZipFile
{
    param($Path)
    add-type -assemblyname System.IO.Compression.FileSystem
    $nameHash = @{}
    try
    {
        $fileHandle = ([System.IO.Compression.ZipFile]::OpenRead($Path))
        $entries = $fileHandle.Entries
    }    
    catch
    {
        Throw-TerminatingError ($LocalizedData.ErrorOpeningArchiveFile -f $Path) $_
    }
    
    $entries | %{$nameHash[$_.FullName] = $_}
    return $entries, $nameHash, $fileHandle
}

# The Set-ExpandArchive cmdlet is used to unpack or remove a zip file to a particular directory
function Set-ExpandArchive
{
    [CmdletBinding(SupportsShouldProcess=$true)]
    param
    (
        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string] $Path,
        
        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string] $Destination,
        
        [ValidateSet("Present", "Absent")]
        [string] $Ensure = "Present",
        
        [boolean] $Validate = $false,
        
        [ValidateSet("", "SHA-1", "SHA-256", "SHA-512", "CreatedDate", "ModifiedDate")]
        [string] $Checksum,
        
        [boolean] $Force = $false
    )
    
    $ErrorActionPreference = "Stop"
    Assert-ValidStandardArgs $Path $Destination $Validate $Checksum
    $Checksum = Normalize-Checksum $Validate $Checksum
    Write-Verbose $LocalizedData.ConfigurationStarted
    
    if(-not (Test-Path $Destination))
    {
        mkdir $Destination | Out-Null
    }
    
    $cacheObj = Get-CacheEntry $Path $Destination
    $sourceLastWriteTime = (Get-Item -LiteralPath $Path).LastWriteTime
    $cacheUpToDate = $cacheObj -and $cacheObj.SourceLastWriteTime -and $cacheObj.SourceLastWriteTime -eq $sourceLastWriteTime
    $file = $null
    $nameToEntry = @{}
    try
    {
        if(-not $cacheUpToDate)
        {
            $entries, $nameToEntry, $file = Open-ZipFile $Path
            Update-Cache $cacheObj $entries $Checksum $sourceLastWriteTime
        }
        
        $entries = $cacheObj.Entries
        if($Ensure -eq "Absent")
        {
            $directories = new-object system.collections.generic.hashset[string]
            foreach($entry in $entries)
            {
                $isDir = $false
                if($entry.FullName.EndsWith("\"))
                {
                    $isDir = $true
                    $directories.Add((Split-Path -Leaf $entry)) | Out-Null
                }
                
                $parent = $entry.FullName
                while(($parent = (Split-Path $parent))) { $directories.Add($parent) | Out-Null }
                
                if($isDir)
                {
                    #Directory removal is handled as its own pass, see note and code after this loop
                    continue
                }
                
                $existing = Join-Path $Destination $entry.FullName
                $item = Get-Item -LiteralPath $existing -ErrorAction SilentlyContinue
                if(-not $item)
                {
                    continue
                }
                
                 #Possible for a folder to have been replaced by a directory of the same name, in which case we must leave it alone
                $type = $item.GetType()
                if($type -ne [System.IO.FileInfo])
                {
                    continue
                }
                
                if(-not $Checksum -and $PSCmdlet.ShouldProcess(($LocalizedData.RemoveFile -f $existing), $null, $null))
                {
                    Trace-Message "Removing $existing"
                    rm $existing
                    continue
                }
                
                $Checksum = $Checksum.ToLower()
                if($Checksum.StartsWith("sha"))
                {
                    if((Compare-FileToEntry $existing $entry $Checksum) -and $PSCmdlet.ShouldProcess(($LocalizedData.RemoveFile -f $existing), $null, $null))
                    {
                        Trace-Message "Hashes of existing and zip files match, removing"
                        rm $existing
                    }
                    else
                    {
                        Trace-Message "Hash did not match, file has been modified since it was extracted. Leaving"
                    }
                }
                else
                {
                    $date = Get-RelevantChecksumTimestamp $item $Checksum
                    if($date.Equals($entry.LastWriteTime.DateTime) -and $PSCmdlet.ShouldProcess(($LocalizedData.RemoveFile -f $existing), $null, $null))
                    {
                        Trace-Message "In Set-TargetResource: $existing exists and the selected timestamp ($Checksum) matched, removing"
                        rm $existing
                    }
                    else
                    {
                        Trace-Message "In Set-TargetResource: $existing exists and the selected timestamp ($Checksum) did not match, leaving"
                    }
                }
            }
            
            #Hashset was useful for dropping dupes in an efficient manner, but it can mess with ordering
            #Sort according to current culture (directory names can be localized, obviously)
            #Reverse so we hit children before parents
            $directories = [system.linq.enumerable]::ToList($directories)
            $directories.Sort([System.StringComparer]::InvariantCultureIgnoreCase)
            $directories.Reverse()
            foreach($directory in $directories)
            {
                Trace-Message "Examining $directory to see if it should be removed"
                $existing = Join-Path $Destination $directory
                $item = Get-Item -LiteralPath $existing -ErrorAction SilentlyContinue
                if($item -and $item.GetType() -eq [System.IO.DirectoryInfo] -and $item.GetFiles().Count -eq 0 -and $item.GetDirectories().Count -eq 0 `
                     -and $PSCmdlet.ShouldProcess(($LocalizedData.RemoveDirectory -f $existing), $null, $null))
                {
                    Trace-Message "$existing appears to be an empty directory. Removing it"
                    rmdir $existing
                }
            }
            
            Write-Verbose ($LocalizedData.PackageUninstalled -f $Path,$Destination)
            Write-Verbose $LocalizedData.ConfigurationFinished
            return
        }
        
        Ensure-Directory $Destination
        foreach($entry in $entries)
        {
            $dest = join-path $Destination $entry.FullName
            if($dest.EndsWith('\')) #Directory
            {
                Ensure-Directory $dest.TrimEnd("\") #Some cmdlets have problems with trailing char
                continue
            }
            
            $item = Get-Item -LiteralPath $dest -ErrorAction SilentlyContinue
            if($item)
            {
                if($item.GetType() -eq [System.IO.FileInfo])
                {
                    if(-not $Checksum)
                    {
                        #It exists. The user didn't specify -Validate, so that's good enough for us
                        continue
                    }
                    
                    if($Checksum.StartsWith("sha"))
                    {
                        if($item.LastWriteTime.Equals($entry.ExistingTimestamp))
                        {
                            Trace-Message "LastWriteTime of $dest matches what we have on record, not re-examining $checksum"
                        }
                        else
                        {
                            $identical = Compare-FileToEntry $dest $entry $Checksum
                            
                            if($identical)
                            {
                                Trace-Message "Found a file at $dest where we were going to place one and hash matched. Continuing"
                                $entry.ExistingItemTimestamp = $item.LastWriteTime
                                continue
                            }
                            else
                            {
                                if($Force)
                                {
                                    Trace-Message "Found a file at $dest where we were going to place one and hash didn't match. It will be overwritten"
                                }
                                else
                                {
                                    Trace-Message "Found a file at $dest where we were going to place one and does not match the source, but Force was not specified. Erroring"
                                    Throw-TerminatingError ($LocalizedData.ItemExistsButIsIncorrect -f $dest)
                                }
                            }
                        }
                    }
                    else
                    {
                        $date = Get-RelevantChecksumTimestamp $item $Checksum
                        if($date.Equals($entry.LastWriteTime.DateTime))
                        {
                            Trace-Message "In Set-TargetResource: $dest exists and the selected timestamp ($Checksum) matched, will leave it"
                            continue
                        }
                        else
                        {
                            if($Force)
                            {
                                Trace-Message "In Set-TargetResource: $dest exists and the selected timestamp ($Checksum) did not match. Force was specified, we will overwrite"
                            }
                            else
                            {
                                Trace-Message "Found a file at $dest and timestamp ($Checksum) does not match the source, but Force was not specified. Erroring"
                                Throw-TerminatingError ($LocalizedData.ItemExistsButIsIncorrect -f $dest)
                            }
                        }
                    }
                }
                else
                {
                    if($Force)
                    {
                        Trace-Message "Found a directory at $dest where a file should be. Removing"
                        if($PSCmdlet.ShouldProcess(($LocalizedData.RemoveDirectory -f $dest), $null, $null))
                        {
                            rmdir -Recurse -Force $dest
                        }
                    }
                    else
                    {
                        Trace-Message "Found a directory at $dest where a file should be and Force was not specified. Erroring."
                        Throw-TerminatingError ($LocalizedData.ItemExistsButIsWrongType -f $dest)
                    }
                }
            }
            
            $parent = Split-Path $dest
            if(-not (Test-Path $parent) -and $PSCmdlet.ShouldProcess(($LocalizedData.MakeDirectory -f $parent), $null, $null))
            {
                #TODO: This is an edge case we need to revisit. We should be correctly handling wrong file types along
                #the directory path if they occur within the archive, but they don't have to. Simple tests demonstrate that
                #the Zip format allows you to have the file within a folder without explicitly having an entry for the folder
                #This solution will fail in such a case IF anything along the path is of the wrong type (e.g. file in a place
                #we expect a directory to be)
                mkdir $parent | Out-Null
            }
            
            if($PSCmdlet.ShouldProcess(($LocalizedData.UnzipFile -f $dest), $null, $null))
            {
                #If we get here we can safely blow away anything we find.
                $null, $nameToEntry, $file = Open-ZipFile $Path
                $stream = $null
                $outStream = $null
                try
                {
                    Trace-Message "Writing to file $dest"
                    $stream = $nameToEntry[$entry.FullName].Open()
                    $outStream = New-Object System.IO.FileStream $dest, "Create"
                    $stream.CopyTo($outStream)
                }
                catch
                {
                    Throw-TerminatingError ($LocalizedData.ErrorCopyingToOutstream -f $dest) $_
                }
                finally
                {
                    if($stream -ne $null)
                    {
                        $stream.Dispose()
                    }
                    
                    if($outStream -ne $null)
                    {
                        $outStream.Dispose()
                    }
                }
                
                $fileInfo = New-Object System.IO.FileInfo $dest
                $entry.ExistingItemTimestamp = $fileInfo.LastWriteTime = $fileInfo.LastAccessTime = $fileInfo.CreationTime = $entry.LastWriteTime.DateTime
            }
        }
    }
    finally
    {
        if($file)
        {
            $file.Dispose()
        }
    }
    
    Set-CacheEntry -InputObject $cacheObj $Path $Destination
    Write-Verbose ($LocalizedData.PackageInstalled -f $Path,$Destination)
    Write-Verbose $LocalizedData.ConfigurationFinished
}

# The Get-ExpandArchive cmdlet is used to fetch the object
function Get-ExpandArchive
{
    param
    (
        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string] $Path,
        
        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string] $Destination,
        
        [boolean] $Validate = $false,
        
        [ValidateSet("", "SHA-1", "SHA-256", "SHA-512", "CreatedDate", "ModifiedDate")]
        [string] $Checksum
    )
    
    $exists = Test-ExpandArchive -Path $Path -Destination $Destination -Validate $Validate -Checksum $Checksum
    
    $stringResult = "Absent"
    if($exists)
    {
        $stringResult = "Present"
    }
    
    @{
        Ensure = $stringResult;
        Path = $Path;
        Destination = $Destination;
    }
}

# End Expand CodeBase

function Test-TargetResource
{
    [OutputType([System.Boolean])]
    param
    (
        [parameter(mandatory=$true)]
        [ValidateNotNullOrEmpty()]
        [string[]] $Path,

        [parameter (mandatory=$true)]
        [ValidateNotNullOrEmpty()]
        [string] $Destination,

        [parameter (mandatory=$false)]
        [ValidateSet("Optimal","NoCompression","Fastest")]
        [string]
        $CompressionLevel = "Optimal",

        [parameter (mandatory=$false)]
        [ValidateSet("File","Directory")]
        [string]
        $DestinationType = "Directory",

        [parameter (mandatory=$false)]
        [boolean]
        $MatchSource = $false
    )

   ValidateDuplicateFileSystemPath "Path" $Path
   $result = $false

   if($DestinationType -eq "File")
   {
        ValidateCompressParameters $Path $Destination $DestinationType
        $result = IsArchiveCacheUpdated $Destination $Path $MatchSource $CompressionLevel

        Write-Verbose "Test Result $result"
   }
   else
   {
        ValidateExpandParameters $Path $Destination $DestinationType
        $result = Test-ExpandArchive -Ensure "Present" -Path $Path[0] -Destination $Destination
   }

   return $result
}

function Set-TargetResource 
{
    [CmdletBinding(SupportsShouldProcess=$true)]
    param
    (
        [parameter(mandatory=$true)]
        [ValidateNotNullOrEmpty()]
        [string[]] $Path,

        [parameter (mandatory=$true)]
        [ValidateNotNullOrEmpty()]
        [string] $Destination,

        [parameter (mandatory=$false)]
        [ValidateSet("Optimal","NoCompression","Fastest")]
        [string]
        $CompressionLevel = "Optimal",

        [parameter (mandatory=$false)]
        [ValidateSet("File","Directory")]
        [string]
        $DestinationType = "Directory",

        [parameter (mandatory=$false)]
        [boolean]
        $MatchSource = $false
    )
   
   ValidateDuplicateFileSystemPath "Path" $Path
 
   if($DestinationType -eq "File")
   {
        ValidateCompressParameters $Path $Destination $DestinationType

        # Delete stale archive file and its cache.
        DeleteArchiveFileAndItsCache $Destination

        # Create the archive file.
        Compress-xArchive -Path $Path -DestinationPath $Destination -CompressionLevel $CompressionLevel
        
        # Create the archive file specific cache.
        CreateArchiveCache $Destination $Path $CompressionLevel
   }
   else
   {
        ValidateExpandParameters $Path $Destination $DestinationType
        Set-ExpandArchive -Ensure "Present" -Path $Path[0] -Destination $Destination
   }
}

function Get-TargetResource
{
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [parameter(mandatory=$true)]
        [ValidateNotNullOrEmpty()]
        [string[]] $Path,

        [parameter (mandatory=$true)]
        [ValidateNotNullOrEmpty()]
        [string] $Destination,

        [parameter (mandatory=$false)]
        [ValidateSet("Optimal","NoCompression","Fastest")]
        [string]
        $CompressionLevel = "Optimal",

        [parameter (mandatory=$false)]
        [ValidateSet("File","Directory")]
        [string]
        $DestinationType = "Directory",

        [parameter (mandatory=$false)]
        [boolean]
        $MatchSource = $false
    )

   ValidateDuplicateFileSystemPath "Path" $Path

   if($DestinationType -eq "File")
   {
        ValidateCompressParameters $Path $Destination $DestinationType

        $currentFileInfo = New-Object -TypeName System.IO.FileInfo -ArgumentList $Destination

        if($currentFileInfo.Exists -eq $true)
        {
            $creationTime = $currentFileInfo.CreationTime
            $attributes = $currentFileInfo.Attributes.ToString()
            $size = $currentFileInfo.Length
            $mode = $currentFileInfo.Mode
        }

        $getTargetResourceResult = @{
                                        Path = $Path; 
                                        Destination = $Destination;
                                        CompressionLevel = $CompressionLevel;
                                        DestinationType = $DestinationType;
                                        MatchSource = $MatchSource;
                                        CreationTime = $creationTime;
                                        Attributes = $attributes;
                                        Size = $size;
                                        Mode = $mode;
                                    }
   }
   else
   {
        ValidateExpandParameters $Path $Destination $DestinationType
        $expandArchiveResult = Get-ExpandArchive -Path $Path[0] -Destination $Destination

        $archiveFilePath = $expandArchiveResult["Path"]
        $archivePath = @("$archiveFilePath")

        $currentDirectoryInfo = New-Object -TypeName System.IO.DirectoryInfo -ArgumentList $expandArchiveResult["Destination"]

        if($currentDirectoryInfo.Exists -eq $true)
        {
            $creationTime = $currentDirectoryInfo.CreationTime
            $attributes = $currentDirectoryInfo.Attributes.ToString()
            $mode = $currentDirectoryInfo.Mode

            $filePaths = dir $expandArchiveResult["Destination"] -Recurse
            foreach($currenFilePath in $filePaths)
            {
                if([System.IO.File]::Exists($currenFilePath.FullName)  -eq $true)
                {
                        $currentFileInfo = New-Object -TypeName System.IO.FileInfo -ArgumentList $currenFilePath
                        $size += $currenFilePath.Length
                }
            }
        }

        $getTargetResourceResult = @{
                                Path = $archivePath; 
                                Destination = $expandArchiveResult["Destination"];
                                CompressionLevel = $CompressionLevel;
                                DestinationType = $DestinationType;
                                MatchSource = $MatchSource;
                                CreationTime = $creationTime;
                                Attributes = $attributes;
                                Size = $size;
                                Mode = $mode;
                            }
   }

   return $getTargetResourceResult
}

<#
.SYNOPSIS
The Compress-xArchive cmdlet can be used to zip/compress one or more files/directories.
#>

function Compress-xArchive
{
    [CmdletBinding(
    DefaultParameterSetName="Path", 
    SupportsShouldProcess=$true)]
    param 
    (
        [parameter (
        mandatory=$true, 
        Position=0,
        ParameterSetName="Path",
        ValueFromPipelineByPropertyName=$true)]
        [ValidateNotNullOrEmpty()]
        [string[]] $Path,

        [parameter (
        mandatory=$true, 
        ParameterSetName="LiteralPath",         
        ValueFromPipeline=$false, 
        ValueFromPipelineByPropertyName=$true)]
        [ValidateNotNullOrEmpty()]
        [string[]] $LiteralPath,

        [parameter (mandatory=$true,
        Position=1, 
        ValueFromPipeline=$false, 
        ValueFromPipelineByPropertyName=$false)]
        [ValidateNotNullOrEmpty()]
        [string] $DestinationPath,

        [parameter (
        mandatory=$false, 
        ValueFromPipeline=$false, 
        ValueFromPipelineByPropertyName=$false)]
        [ValidateSet("Optimal","NoCompression","Fastest")]
        [string]
        $CompressionLevel = "Optimal",

        [parameter (
        mandatory=$false,
        ValueFromPipeline=$false, 
        ValueFromPipelineByPropertyName=$false)]
        [switch]
        $Update = $false 
    )

    # Validate Source Path depeding on Path or LiteralPath parameter set is used.
    # The specied source path conatins one or more files or directories that needs
    # to be compressed.
    switch($PsCmdlet.ParameterSetName)
    {
        "Path"
        {
            IsValidFileSystemPath $Path | Out-Null
            ValidateDuplicateFileSystemPath $PsCmdlet.ParameterSetName $Path
            $sourcePath = $Path;
        }
        "LiteralPath" 
        { 
            IsValidFileSystemPath $LiteralPath | Out-Null
            ValidateDuplicateFileSystemPath $PsCmdlet.ParameterSetName $LiteralPath
            $sourcePath = $LiteralPath;
        }
    }

    $zipFileExtension = ".zip"
    $extension = [system.IO.Path]::GetExtension($DestinationPath)

    # If user does not specify .Zip extension, we append it.
    If($extension -eq [string]::Empty)
    {
        $DestinationPath = $DestinationPath + $zipFileExtension
    }
    else
    {
        $comparisonResult = [string]::Compare($extension, $zipFileExtension, [System.StringComparison]::OrdinalIgnoreCase)

        # Invalid file extension is specifed for the zip file to be created.
        if($comparisonResult -ne 0)
        {
            $errorId = "NotSupportedArchiveFileExtension"; 
            $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument;
            $errorMessage = $($LocalizedData.InvalidZipFileExtensionError) -f @($extension, $zipFileExtension)
            $exception = New-Object System.IO.IOException $errorMessage ;
            $errorRecord = New-Object System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $null
            $PSCmdlet.ThrowTerminatingError($errorRecord);
        }
    }

    $destinationParentDir = [system.IO.Path]::GetDirectoryName($DestinationPath)

    IsValidFileSystemPath $destinationParentDir | Out-Null


    if([System.IO.File]::Exists($DestinationPath) -and $Update -eq $false)
    {
        $errorId = "ArchiveFileExists"; 
        $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument;
        $errorMessage = $($LocalizedData.ZipFileExistError) -f @($extension, $zipFileExtension)
        $exception = New-Object System.IO.IOException $errorMessage ;
        $errorRecord = New-Object System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $null
        $PSCmdlet.ThrowTerminatingError($errorRecord);
    }

    CompressArchiveHelper $sourcePath $DestinationPath $CompressionLevel $Update
}

function IsValidFileSystemPath 
{
    param 
    (
        [string[]] $path
    )
    
    $result = $false;

    # null and empty check are are already done on Path parameter at the cmdlet layer.
    foreach($currentPath in $path)
    {
        try
        {
            if([System.IO.File]::Exists($currentPath) -or [System.IO.Directory]::Exists($currentPath))
            {
                $result = $true
            }
            else
            {
                $errorId = "PathNotFound"; 
                $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument;
                $errorMessage = $($LocalizedData.PathNotFoundError) -f @($currentPath)
                $exception = New-Object System.IO.IOException $errorMessage ;
                $errorRecord = New-Object System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $null
                $PSCmdlet.ThrowTerminatingError($errorRecord);
            }
        }
        catch
        {
            throw $_
        }
    }

    return $result;
}

function ValidateDuplicateFileSystemPath 
{
    param 
    (
        [string] $inputParameter,
        [string[]] $path
    )
    
    $uniqueInputPaths = @()

    # null and empty check are are already done on Path parameter at the cmdlet layer.
    foreach($currentPath in $path)
    {
        $currentInputPath = $currentPath.ToUpper()
        if($uniqueInputPaths.Contains($currentInputPath))
        {
            $errorId = "DuplicatePathFound"; 
            $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument;
            $errorMessage = $($LocalizedData.DuplicatePathFoundError) -f @($inputParameter, $currentPath, $inputParameter)
            $exception = New-Object System.IO.IOException $errorMessage ;
            $errorRecord = New-Object System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $null
            $PSCmdlet.ThrowTerminatingError($errorRecord);
        }
        else
        {
            $uniqueInputPaths += $currentInputPath
        }
    }
}

function CompressionLevelMapper
{
    param 
    (
        [string] $compressionLevel
    )

    Add-Type -AssemblyName System.IO.Compression.FileSystem
    Add-Type -AssemblyName System.IO.Compression

    $compressionLevelFormat = [System.IO.Compression.CompressionLevel]::Optimal

    # CompressionLevel format is already validated at the cmdlet layer.
    switch($compressionLevel.ToString())
    {
        "Fastest"
        {
            $compressionLevelFormat = [System.IO.Compression.CompressionLevel]::Fastest
        }
        "NoCompression" 
        { 
            $compressionLevelFormat = [System.IO.Compression.CompressionLevel]::NoCompression
        }
    }

    return $compressionLevelFormat
}

function CompressArchiveHelper 
{
    param 
    (
        [string[]] $sourcePath,
        [string]   $destinationPath,
        [string]   $compressionLevel,
        [bool]     $isUpdateMode
    )

    $sourceFilePaths = @()
    $sourceDirPaths = @()

    foreach($currentPath in $sourcePath)
    {
        if([System.IO.File]::Exists($currentPath))
        {
            $sourceFilePaths += $currentPath
        }
        else
        {
            $sourceDirPaths += $currentPath
        }
    }

    # The Soure Path contains one or more directory (this directory can have files under it) and no files to be compressed.
    if($sourceFilePaths.Count -eq 0 -and $sourceDirPaths.Count -gt 0)
    {
        foreach($currentSourceDirPath in $sourceDirPaths)
        {
            CompressSingleDirHelper $currentSourceDirPath $destinationPath $compressionLevel $true $isUpdateMode
        }
    }

    # The Soure Path contains only files to be compressed.
    elseIf($sourceFilePaths.Count -gt 0 -and $sourceDirPaths.Count -eq 0)
    {
        CompressFilesHelper $sourceFilePaths $destinationPath $compressionLevel $isUpdateMode
    }
    # The Soure Path contains one or more files and one or more directories (this directory can have files under it) to be compressed.
    elseif($sourceFilePaths.Count -gt 0 -and $sourceDirPaths.Count -gt 0)
    {
        foreach($currentSourceDirPath in $sourceDirPaths)
        {
            CompressSingleDirHelper $currentSourceDirPath $destinationPath $compressionLevel $true $isUpdateMode
        }

        CompressFilesHelper $sourceFilePaths $destinationPath $compressionLevel $isUpdateMode
    }
}

function CompressFilesHelper 
{
    param 
    (
        [string[]] $sourceFilePaths,
        [string]   $destinationPath,
        [string]   $compressionLevel,
        [bool]     $isUpdateMode
    )

    ZipArchiveHelper $sourceFilePaths $destinationPath $compressionLevel $isUpdateMode $null
}

function CompressSingleDirHelper 
{
    param 
    (
        [string] $sourceDirPath,
        [string] $destinationPath,
        [string] $compressionLevel,
        [bool]   $useParentDirAsRoot,
        [bool]   $isUpdateMode
    )

    $subDirFiles = @()

    if($useParentDirAsRoot)
    {
        $sourceDirInfo = New-Object -TypeName System.IO.DirectoryInfo -ArgumentList $sourceDirPath
        $sourceDirFullName = $sourceDirInfo.Parent.FullName

        # If the directory is present at the drive level the DirectoryInfo.Parent include '\' example: C:\
        # On the other hand if the directory exists at a deper level then DirectoryInfo.Parent
        # has just the path (without an ending '\'). example C:\source
        if($sourceDirFullName.Length -eq 3)
        {
            $modifiedSourceDirFullName = $sourceDirFullName
        }
        else
        {
            $modifiedSourceDirFullName = $sourceDirFullName + "\"
        }
    }
    else
    {
        $sourceDirFullName = $sourceDirPath
        $modifiedSourceDirFullName = $sourceDirFullName + "\"
    }

    $dirContents = dir $sourceDirPath -Recurse
    foreach($currentContent in $dirContents)
    {
        if([System.IO.File]::Exists($currentContent.FullName))
        {
            $subDirFiles += $currentContent.FullName
        }
        else
        {
            # The currentContent points to a directory.
            # We need to check if the directory is an empty directory, if so such a
            # directory has to be explictly added to the archive file.
            # if there are no files in the directory the GetFiles() API returns an empty array.
            $files = $currentContent.GetFiles()
            if($files.Count -eq 0)
            {
                $subDirFiles += $currentContent.FullName + "\"
            }
        }
    }

    $sourcePaths = $subDirFiles

    ZipArchiveHelper $sourcePaths $destinationPath $compressionLevel $isUpdateMode $modifiedSourceDirFullName
}

function ZipArchiveHelper 
{
    param 
    (
        [string[]] $sourcePaths,
        [string]   $destinationPath,
        [string]   $compressionLevel,
        [bool]     $isUpdateMode,
        [string]   $modifiedSourceDirFullName
    )

    $fileMode = [System.IO.FileMode]::Create
    if([System.IO.File]::Exists($DestinationPath))
    {
        $fileMode = [System.IO.FileMode]::Open
    }

    Add-Type -AssemblyName System.IO.Compression.FileSystem
    Add-Type -AssemblyName System.IO.Compression

    try
    {
        $archiveFileStreamArgs = @($destinationPath, $fileMode)
        $archiveFileStream = New-Object -TypeName System.IO.FileStream -ArgumentList $archiveFileStreamArgs

        $zipArchiveArgs = @($archiveFileStream, [System.IO.Compression.ZipArchiveMode]::Update, $false)
        $zipArchive = New-Object -TypeName System.IO.Compression.ZipArchive -ArgumentList $zipArchiveArgs

        foreach($currentFilePath in $sourcePaths)
        {
            if($modifiedSourceDirFullName -ne $null -and $modifiedSourceDirFullName.Length -gt 0)
            {
                $index = $currentFilePath.IndexOf($modifiedSourceDirFullName, [System.StringComparison]::OrdinalIgnoreCase)
                $currentFilePathSubString = $currentFilePath.Substring($index, $modifiedSourceDirFullName.Length)
                $relativeFilePath = $currentFilePath.Replace($currentFilePathSubString, "").Trim()
            }
            else
            {
                $relativeFilePath = [System.IO.Path]::GetFileName($currentFilePath)
            }

            # Update mode is selected.
            # Check to see if archive file already contains one or more zip files in it.
            if($isUpdateMode -eq $true -and $zipArchive.Entries.Count -gt 0)
            {                    
                $entryToBeUpdated = $null

                # Check if the file already exists in the archive file.
                # If so replace it with new file from the input source.
                # If the file does not exist in the archive file then default to
                # create mode and create the entry in the archive file.

                foreach($currentArchiveEntry in $zipArchive.Entries)
                {
                    $comparisonResult = [string]::Compare($currentArchiveEntry.FullName, $relativeFilePath, [System.StringComparison]::OrdinalIgnoreCase)

                    if($comparisonResult -eq 0)
                    {
                        $entryToBeUpdated = $currentArchiveEntry
                            
                        break
                    }
                }

                if($entryToBeUpdated -ne $null)
                {
                    $entryToBeUpdated.Delete()
                }
            }

            $compression = CompressionLevelMapper $compressionLevel
            if($relativeFilePath[$relativeFilePath.Length -1] -ne '\')
            {
                [System.IO.Compression.ZipFileExtensions]::CreateEntryFromFile($zipArchive, $currentFilePath, $relativeFilePath, $compression)
            }
            else
            {
                $currentArchiveEntry = $zipArchive.CreateEntry("$relativeFilePath", $compression)
            }
        }
    }
    finally
    {
        If($null -ne $zipArchive)
        {
            $zipArchive.Dispose()
        }

        If($null -ne $archiveFileStream)
        {
            $archiveFileStream.Dispose()
        }
    }
}

function ValidateExpandParameters 
{
    param 
    (
        [string[]] $path,
        [string]   $destination,
        [string]   $destinationType
    )

   if($destinationType -eq "Directory")
   {
        # Source - [-Path]: Specifies the path to archive file
        # Destination - [-Destination]: Specifies the path to directory where archive file contents would be expanded.
        if($path.Count -gt 1)
        {
            $errorId = "InvalidArguement"; 
            $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument;
            $errorMessage = $($LocalizedData.InvalidPathForExpandError) -f @($path)
            $exception = New-Object System.IO.IOException $errorMessage ;
            $errorRecord = New-Object System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $null
            $PSCmdlet.ThrowTerminatingError($errorRecord);
        }
        
        # When DestinationType is Directory, The source needs to be a zip file & Destination needs to be a directory
        $zipFileExtension = ".zip"
        $extension = [system.IO.Path]::GetExtension($path[0])

        if($extension -ne $zipFileExtension)
        {
            $errorId = "NotSupportedArchiveFileExtension"; 
            $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument;
            $errorMessage = $($LocalizedData.InvalidZipFileExtensionError) -f @($extension, $zipFileExtension)
            $exception = New-Object System.IO.IOException $errorMessage ;
            $errorRecord = New-Object System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $null
            $PSCmdlet.ThrowTerminatingError($errorRecord);
        }
   }
}

function ValidateCompressParameters 
{
    param 
    (
        [string[]] $path,
        [string]   $destination,
        [string]   $destinationType
    )

   if($destinationType -eq "File")
   {
        $zipFileExtension = ".zip"
        # When DestinationType is File, The Destination needs to be a file with .zip extension.
        $result = Test-Path $destination -Type Container
        if($result -eq $true)
        {
            $errorId = "InvalidArguement"; 
            $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument;
            $errorMessage = $($LocalizedData.InvalidDirZipFileExtensionError) -f @($destination, $zipFileExtension)
            $exception = New-Object System.IO.IOException $errorMessage ;
            $errorRecord = New-Object System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $null
            $PSCmdlet.ThrowTerminatingError($errorRecord);
        }

        $extension = [system.IO.Path]::GetExtension($destination)
        if($extension -ne $zipFileExtension)
        {
            $errorId = "NotSupportedArchiveFileExtension"; 
            $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument;
            $errorMessage = $($LocalizedData.InvalidZipFileExtensionError) -f @($extension, $zipFileExtension)
            $exception = New-Object System.IO.IOException $errorMessage ;
            $errorRecord = New-Object System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $null
            $PSCmdlet.ThrowTerminatingError($errorRecord);
        }
   }
}

function CreateArchiveCache
{
    param 
    (
        [string]   $archiveFile,
        [string[]] $path,
        [string]   $compressionLevel
    )

    $zipFileInfo = New-Object -TypeName System.IO.FileInfo -ArgumentList $archiveFile

    $archiveCacheFileName = $zipFileInfo.FullName.GetHashCode().ToString()
    $archiveCacheFileFullName = [System.IO.Path]::Combine($compressCacheLocation, $archiveCacheFileName + ".xml")

    if(-not (Test-Path $compressCacheLocation))
    {
        New-Item $compressCacheLocation -Type Directory | Out-Null
    }

    $archiveTimeStampCache = @{}
    $archiveTimeStampCache.Add($zipFileInfo.FullName, $zipFileInfo.LastWriteTimeUtc.ToString())

    # Adding CompressionLevel to the archive file specific Cache.
    $archiveTimeStampCache.Add($CompressionLevelString, $compressionLevel)

    # Get the list of all files (including the ones present in the subdirectories).
    $sourceFilePaths = @()
    foreach($currentPath in $path)
    {
        if([System.IO.File]::Exists($currentPath))
        {
            $sourceFilePaths += $currentPath
        }
        else
        {
            $currentDirPaths = dir $currentPath -Recurse
            foreach($itemPath in $currentDirPaths)
            {
                if([System.IO.File]::Exists($itemPath.FullName))
                {
                    $sourceFilePaths += $itemPath.FullName
                }
                else
                {
                    # The currentContent points to a directory.
                    # We need to check if the directory is an empty directory, if so such a
                    # directory has to be explictly added to the archive file.
                    # if there are no files in the directory the GetFiles() API returns an empty array.
                    $files = $itemPath.GetFiles()
                    if($files.Count -eq 0)
                    {
                        $sourceFilePaths += $itemPath.FullName
                    }
                }
            }
        }
    }

    foreach($currentPath in $sourceFilePaths)
    {
        if([System.IO.File]::Exists($currentPath))
        {
            $currentItemInfo = New-Object -TypeName System.IO.FileInfo -ArgumentList $currentPath
            $itemCountString = $FileCountString
        }
        else
        {
            $currentItemInfo = New-Object -TypeName System.IO.DirectoryInfo -ArgumentList $currentPath
            $itemCountString = $DirectoryCountString
        }

        if($archiveTimeStampCache.ContainsKey($currentItemInfo.FullName))
        {
            $currentCacheItem = $archiveTimeStampCache[$currentItemInfo.FullName]
            $currentCacheItem[$itemCountString] += 1
        }
        else
        {
            $itemCache = @{}
            $itemCache.Add($LastWriteTimeUtcString, $currentItemInfo.LastWriteTimeUtc.ToString())
            $itemCache.Add($itemCountString, 1)
            $archiveTimeStampCache.Add($currentItemInfo.FullName, $itemCache)
        }
    }

    Export-CliXml -Path $archiveCacheFileFullName -InputObject $archiveTimeStampCache
}

function DeleteArchiveFileAndItsCache
{
    param 
    (
        [string] $archiveFile
    )

    $zipFileInfo = New-Object -TypeName System.IO.FileInfo -ArgumentList $archiveFile

    $archiveCacheFileName = $zipFileInfo.FullName.GetHashCode().ToString()
    $archiveCacheFileFullName = [System.IO.Path]::Combine($compressCacheLocation, $archiveCacheFileName + ".xml")

    if([System.IO.File]::Exists($archiveCacheFileFullName))
    {
        del "$archiveCacheFileFullName" -Force -Recurse -ErrorAction SilentlyContinue
    }

    if([System.IO.File]::Exists($archiveFile))
    {
        del "$archiveFile" -Force -Recurse -ErrorAction SilentlyContinue
    }
}

function IsArchiveCacheUpdated
{
    param 
    (
        [string]   $archiveFile,
        [string[]] $path,
        [boolean]  $matchSource,
        [string]   $compressionLevel
    )

    Write-Debug "MatchSource is set to $matchSource"

    $result = $false

    $zipFileInfo = New-Object -TypeName System.IO.FileInfo -ArgumentList $archiveFile

    $archiveCacheFileName = $zipFileInfo.FullName.GetHashCode().ToString()

    $archiveCacheFileFullName = [System.IO.Path]::Combine($compressCacheLocation, $archiveCacheFileName + ".xml")

    if([System.IO.File]::Exists($archiveCacheFileFullName))
    {
        $archiveTimeStampCache = Import-Clixml -Path $archiveCacheFileFullName
        if($archiveTimeStampCache -ne $null)
        {
            if($archiveTimeStampCache.ContainsKey($zipFileInfo.FullName))
            {
                # Validate to make sure that the LastWriteTimeUtc in cache matchs that of the archive file.
                $archiveFileInCacheLastWriteTimeUtc = $archiveTimeStampCache[$zipFileInfo.FullName]
                $archiveFileLastWriteTimeUtc = $zipFileInfo.LastWriteTimeUtc.ToString()
                $comparisonResult = [string]::Compare($archiveFileInCacheLastWriteTimeUtc, $archiveFileLastWriteTimeUtc, [System.StringComparison]::OrdinalIgnoreCase)
                if($comparisonResult -ne 0)
                {
                    return $result
                }

                # Validate to make sure that the CompressionLevel in cache matchs with the specifed on in method signature.
                $CompressionLevelInCache = $archiveTimeStampCache[$CompressionLevelString]
                $comparisonResult = [string]::Compare($CompressionLevelInCache, $compressionLevel, [System.StringComparison]::OrdinalIgnoreCase)
                if($comparisonResult -ne 0)
                {
                    return $result
                }
            
                if($matchSource -eq $true)
                {
                    if([System.IO.File]::Exists($archiveFile))
                    {
                        Add-Type -AssemblyName System.IO.Compression.FileSystem
                        Add-Type -AssemblyName System.IO.Compression

                        try
                        {
                            $archiveFileStreamArgs = @($archiveFile, [System.IO.FileMode]::Open)
                            $archiveFileStream = New-Object -TypeName System.IO.FileStream -ArgumentList $archiveFileStreamArgs
                            $zipArchiveArgs = @($archiveFileStream, [System.IO.Compression.ZipArchiveMode]::Read, $false)
                            $zipArchive = New-Object -TypeName System.IO.Compression.ZipArchive -ArgumentList $zipArchiveArgs
                            $fileCountFromInspectiveArchive = $zipArchive.Entries.Count
                        }
                        finally
                        {
                            If($null -ne $zipArchive)
                            {
                                $zipArchive.Dispose()
                            }

                            If($null -ne $archiveFileStream)
                            {
                                $archiveFileStream.Dispose()
                            }
                        }
                    }
                    else
                    {
                        return $result
                    }


                    # Validate all the paths specified in the configuration to ensure that they are valida file system paths.
                    IsValidFileSystemPath $path | Out-Null

                    # Get the list of all files with out duplicates (including the ones present in the subdirectories).
                    # We need to filter out the duplicate paths to the same file (i.e., duplicate path to the same file supplied through user input).
                    $sourceFilePaths = @()
                    foreach($currentPath in $path)
                    {
                        if([System.IO.File]::Exists($currentPath))
                        {
                            if($sourceFilePaths.Contains($currentPath) -eq $false)
                            {
                                $sourceFilePaths += $currentPath
                            }
                        }
                        else
                        {
                            $currentDirPaths = dir $currentPath -Recurse
                            foreach($itemPath in $currentDirPaths)
                            {
                                if([System.IO.File]::Exists($itemPath.FullName))
                                {
                                    if($sourceFilePaths.Contains($itemPath.FullName) -eq $false)
                                    {
                                        $sourceFilePaths += $itemPath.FullName
                                    }
                                }
                                else
                                {
                                    # The currentContent points to a directory.
                                    # We need to check if the directory is an empty directory, if so such a
                                    # directory has to be explictly added to the archive file.
                                    # if there are no files in the directory the GetFiles() API returns an empty array.
                                    $files = $itemPath.GetFiles()
                                    if($files.Count -eq 0)
                                    {
                                        if($sourceFilePaths.Contains($itemPath.FullName) -eq $false)
                                        {
                                            $sourceFilePaths += $itemPath.FullName
                                        }
                                    }
                                }
                            }
                        }
                    }

                    $fileCount = 0
                    foreach($currentFilePath in $sourceFilePaths)
                    {
                        if([System.IO.File]::Exists($currentFilePath))
                        {
                            $currentInfo = New-Object -TypeName System.IO.FileInfo -ArgumentList $currentFilePath
                            $itemCountString = $FileCountString
                        }
                        else
                        {
                            $currentInfo = New-Object -TypeName System.IO.DirectoryInfo -ArgumentList $currentFilePath
                            $itemCountString = $DirectoryCountString
                        }

                        if($archiveTimeStampCache.ContainsKey($currentInfo.FullName))
                        {
                            $currentFileFullName = $currentInfo.FullName
                            Write-Debug "Cache has an entry for $currentFileFullName"

                            $currentCacheItem = $archiveTimeStampCache[$currentInfo.FullName]
                            $fileCount += $currentCacheItem[$itemCountString]
                            $currentItemInCacheLastWriteTimeUtc = $currentCacheItem[$LastWriteTimeUtcString]

                            $currentItemLastWriteTimeUtc =  $currentInfo.LastWriteTimeUtc.ToString()
                            $comparisonResult = [string]::Compare($currentItemInCacheLastWriteTimeUtc, $currentItemLastWriteTimeUtc, [System.StringComparison]::OrdinalIgnoreCase)
                            if($comparisonResult -ne 0)
                            { 
                                Write-Debug "The last updated timestamp of the $currentInfo in Cache is $currentItemInCacheLastWriteTimeUtc where as the actual last updated timestamp is $currentItemLastWriteTimeUtc"
                                return $result
                            }
                        }
                        else
                        {
                            Write-Debug "The Cache does not have an entry for the $currentFilePath"

                            # The Cache does not contain the new Path specified. Hence new files have been added to the source.
                            return $result
                        }
                        
                    }

                    if($fileCountFromInspectiveArchive -ne $fileCount)
                    {
                        return $result
                    }

                    $result = $true
                }
                else
                {
                    $result = $true
                }
            }
        }
     }

    return $result
}

Export-ModuleMember -function Get-TargetResource, Set-TargetResource, Test-TargetResource