Create-ZIP.ps1

<#
	{
		"info": {
			"Statement": "Code is poetry",
			"Author": "Joerg Hochwald",
			"Contact": "joerg.hochwald@outlook.com",
			"Link": "http://hochwald.net",
			"Support": "https://github.com/jhochwald/MyPowerShellStuff/issues"
		},
		"Copyright": "(c) 2012-2015 by Joerg Hochwald. All rights reserved."
	}

	Redistribution and use in source and binary forms, with or without modification,
	are permitted provided that the following conditions are met:

	1. Redistributions of source code must retain the above copyright notice, this list of
	   conditions and the following disclaimer.

	2. Redistributions in binary form must reproduce the above copyright notice,
	   this list of conditions and the following disclaimer in the documentation and/or
	   other materials provided with the distribution.

	3. Neither the name of the copyright holder nor the names of its contributors may
	   be used to endorse or promote products derived from this software without
	   specific prior written permission.

	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
	IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
	CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
	SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
	OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	POSSIBILITY OF SUCH DAMAGE.

	By using the Software, you agree to the License, Terms and Conditions above!
#>

function Global:Create-ZIP {
<#
	.SYNOPSIS
		Create a ZIP archive of a given file

	.DESCRIPTION
		Create a ZIP archive of a given file.
		By default within the same directory and the same name as the input file.
		This can be changed via command line parameters

	.PARAMETER InputFile
		Mandatory

		The parameter InputFile is the file that should be compressed.
		You can use it like this: "ClutterReport-20150617171648.csv",
		or with a full path like this: "C:\scripts\PowerShell\export\ClutterReport-20150617171648.csv"

	.PARAMETER OutputFile
		Optional

		You can use it like this: "ClutterReport-20150617171648",
		or with a full path like this: "C:\scripts\PowerShell\export\ClutterReport-20150617171648"
		Do not append the extension!

	.PARAMETER OutputPath
		Optional

		By default the new archive will be created in the same directory as the inpufile,
		if you would like to have it in another directory specify it here like this: "C:\temp\"
		The directory must exist!

	.EXAMPLE
		PS C:\> Create-ZIP -InputFile "C:\scripts\PowerShell\export\ClutterReport-20150617171648.csv"

		# This will create the archive "ClutterReport-20150617171648.zip" from the given inputfile
		# "C:\scripts\PowerShell\export\ClutterReport-20150617171648.csv".
		# The new archive will be located in "C:\scripts\PowerShell\export\"!

	.EXAMPLE
		PS C:\> Create-ZIP -InputFile "C:\scripts\PowerShell\export\ClutterReport-20150617171648.csv" -OutputFile "NewClutterReport"

		# This will create the archive "NewClutterReport.zip" from the given inputfile
		# "C:\scripts\PowerShell\export\ClutterReport-20150617171648.csv".
		# The new archive will be located in "C:\scripts\PowerShell\export\"!

	.EXAMPLE
		PS C:\> Create-ZIP -InputFile "C:\scripts\PowerShell\export\ClutterReport-20150617171648.csv" -OutputPath "C:\temp\"

		# This will create the archive "ClutterReport-20150617171648.zip" from the given inputfile
		# "C:\scripts\PowerShell\export\ClutterReport-20150617171648.csv".
		# The new archive will be located in "C:\temp\"! The directory must exist!

	.EXAMPLE
		PS C:\> Create-ZIP -InputFile "C:\scripts\PowerShell\export\ClutterReport-20150617171648.csv" -OutputFile "NewClutterReport" -OutputPath "C:\temp\"

		# This will create the archive "NewClutterReport.zip" from the given inputfile
		# "C:\scripts\PowerShell\export\ClutterReport-20150617171648.csv".
		# The new archive will be located in "C:\temp\"! The directory must exist!

	.OUTPUTS
		Compress File

	.NOTES
		Notes

	.INPUTS
		Parameters above
#>

	[CmdletBinding(ConfirmImpact = 'None',
				   SupportsShouldProcess = $true)]
	param
	(
		[Parameter(Mandatory = $true,
				   ValueFromPipeline = $true,
				   HelpMessage = 'The parameter InputFile is the file that should be compressed (Mandatory)')]
		[ValidateNotNullOrEmpty()]
		[Alias('Input')]
		[string]
		$InputFile,
		[Parameter(Mandatory = $false,
				   ValueFromPipeline = $false)]
		[Alias('Output')]
		[string]
		$OutputFile,
		[Parameter(Mandatory = $false,
				   ValueFromPipeline = $false)]
		[string]
		$OutputPath
	)

	# Cleanup the variables
	Remove-Variable MyFileName -Scope:Global -Force -Confirm:$false -ErrorAction:SilentlyContinue -WarningAction:SilentlyContinue
	Remove-Variable MyFilePath -Scope:Global -Force -Confirm:$false -ErrorAction:SilentlyContinue -WarningAction:SilentlyContinue
	Remove-Variable OutArchiv -Scope:Global -Force -Confirm:$false -ErrorAction:SilentlyContinue -WarningAction:SilentlyContinue
	Remove-Variable zip -Scope:Global -Force -Confirm:$false -ErrorAction:SilentlyContinue -WarningAction:SilentlyContinue

	# Extract the Filename, without PATH and EXTENSION
	$MyFileName = ((Get-Item $InputFile).Name)

	# Check if the parameter "OutputFile" is given
	if (-not ($OutputFile)) {
		# Extract the Filename, without PATH
		$OutputFile = ((Get-Item $InputFile).BaseName)
	}

	# Append the ZIP extension
	$OutputFile = ($OutputFile + ".zip")

	# Is the OutputPath Parameter given?
	if (-not ($OutputPath)) {
		# Build the new Path Variable
		$MyFilePath = ((Split-Path -Path $InputFile -Parent) + "\")
	} else {
		# Strip the trailing backslash if it exists
		$OutputPath = ($OutputPath.TrimEnd("\"))

		# Build the new Path Variable based on the given OutputPath Parameter
		$MyFilePath = (($OutputPath) + "\")
	}

	# Build a new Filename with Path
	$OutArchiv = (($MyFilePath) + ($OutputFile))

	# Check if the Archive exists and delete it if so
	If (Test-Path $OutArchiv) {
		# If the File is locked, Unblock it!
		Unblock-File -Path:$OutArchiv -Confirm:$false -ErrorAction:Ignore -WarningAction:Ignore

		# Remove the Archive
		Remove-Item -Path:$OutArchiv -Force -Confirm:$false -ErrorAction:Ignore -WarningAction:Ignore
	}

	# The ZipFile class is not available by default in Windows PowerShell because the
	# System.IO.Compression.FileSystem assembly is not loaded by default.
	Add-Type -AssemblyName "System.IO.Compression.FileSystem"

	# Create a new Archive
	$zip = [System.IO.Compression.ZipFile]::Open($OutArchiv, "Create")

	# Add input to the Archive
	$null = [System.IO.Compression.ZipFileExtensions]::CreateEntryFromFile($zip, $InputFile, $MyFileName, "optimal")

	# Close the archive file
	$zip.Dispose()

	# Waiting for compression to complete...
	do {
		# Wait 1 second and try again if working entries are not null
		Start-sleep -Seconds:"1"
	} while (($zip.Entries.count) -ne 0)

	# Extended Support for unattended mode
	if (($RunUnattended) -eq $true) {
		# Inform the Robot (Just pass the Archive Filename)
		Write-Output "$OutArchiv"
	} else {
		# Inform the operator
		Write-Output "Compressed: $InputFile"
		Write-Output "Archive: $OutArchiv"
	}

	# If the File is locked, Unblock it!
	Unblock-File -Path:$OutArchiv -Confirm:$false -ErrorAction:Ignore -WarningAction:Ignore

	# Cleanup the variables
	Remove-Variable MyFileName -Scope:Global -Force -Confirm:$false -ErrorAction:SilentlyContinue -WarningAction:SilentlyContinue
	Remove-Variable MyFilePath -Scope:Global -Force -Confirm:$false -ErrorAction:SilentlyContinue -WarningAction:SilentlyContinue
	Remove-Variable OutArchiv -Scope:Global -Force -Confirm:$false -ErrorAction:SilentlyContinue -WarningAction:SilentlyContinue
	Remove-Variable zip -Scope:Global -Force -Confirm:$false -ErrorAction:SilentlyContinue -WarningAction:SilentlyContinue

	# Do a garbage collection
	if ((Get-Command run-gc -errorAction SilentlyContinue)) {
		run-gc
	}
}
# Set a compatibility Alias
(set-alias Create-Archive Create-ZIP -option:AllScope -scope:Global -force -Confirm:$false -ErrorAction:SilentlyContinue -WarningAction:SilentlyContinue) > $null 2>&1 3>&1
(set-alias Write-ZIP Create-ZIP -option:AllScope -scope:Global -force -Confirm:$false -ErrorAction:SilentlyContinue -WarningAction:SilentlyContinue) > $null 2>&1 3>&1