Utils/ConfigTools.ps1
|
# ============================================================================= # Created On: 2018/06/20 @ 12:22 # Created By: Alcha # Organization: HassleFree Solutions, LLC # Filename: ConfigTools.ps1 # Description: Contains the various functions responsible for maintaining # configuration info. # ============================================================================= <# .SYNOPSIS Gets a user enviornment variable and returns it. .PARAMETER Name The name of the variable you want to retrieve. .EXAMPLE PS C:\> Get-UserVariable -Name DISCORD_WEBHOOK 'https://bit.ly/ThisIsAShortedURLWebhook' .NOTES Uses the GetEnvironmentVariable function from the Environment namespace. #> function Get-UserVariable { [CmdletBinding()] [Alias('guv')] param ( [Parameter(Mandatory = $true, Position = 0)] [Alias('Var')] [System.String] $Name ) return [System.Environment]::GetEnvironmentVariable($Name, [System.EnvironmentVariableTarget]::User) } <# .SYNOPSIS Set a user level environment variable. .DESCRIPTION Sets a user level environment variable with the provided name and values. .PARAMETER Name The name of the variable you wish to set. .PARAMETER Value The value of the variable you wish to set. .EXAMPLE PS C:\> Set-UserVariable -Name DISCORD_WEBHOOK -Value 'https://bit.ly/discurl' The variable "DISCORD_WEBHOOK" has been set with the following value: https://bit.ly/discurl .NOTES Has a sister function, Set-MachineVariable that will let you set a machine level environment variable if you need it available for more than one user. #> function Set-UserVariable { [CmdletBinding()] [Alias('suv')] param ( [Parameter(Mandatory = $true, Position = 0)] [Alias('VariableName', 'VarName', 'Var')] [System.String] $Name, [Parameter(Mandatory = $true, Position = 1)] [System.String] [Alias('Data', 'Datum', 'Val')] $Value ) if ($Name -match ' ') { Write-Error -Message 'The provided variable name contains a space. Try replacing the space with an underscore (_).' -RecommendedAction 'Replace the space with an underscore.'} else { try { [System.Environment]::SetEnvironmentVariable($Name, $Value, [System.EnvironmentVariableTarget]::User) Write-Host "The variable `"$Name`" has been set with the following value:`n" Write-Host $Value } catch { Write-Error $_ } } } <# .SYNOPSIS Remove a User level environment variable. .DESCRIPTION Remove a User level environment variable with provided name. .PARAMETER Name The name of the variable you wish to remove. .EXAMPLE PS C:\> Remove-UserVariable -Name TestVarA The variable "TestVarA" has been removed. #> function Remove-UserVariable { [CmdletBinding()] [Alias('ruv', 'Delete-UserVariable')] param ( [Parameter(Mandatory = $true, Position = 0, HelpMessage = 'Which User variable would you like to remove from the environment path?')] [Alias('Variable', 'Var')] [System.String] $Name ) if ($Name -match ' ') { Write-Error -Message 'The provided variable name contains a space. Try replacing the space with an underscore (_).'` -RecommendedAction 'Replace the space with an underscore.' } else { try { [System.Environment]::SetEnvironmentVariable($Name, $null, [System.EnvironmentVariableTarget]::User) Write-Host "The variable `"$Name`" has been removed." } catch { Write-Error $_ } } } <# .SYNOPSIS Gets a Machine enviornment variable and returns it. .PARAMETER Name The name of the variable you want to retrieve. .EXAMPLE PS C:\> Get-MachineVariable -Name DISCORD_WEBHOOK 'https://bit.ly/ThisIsAShortedURLWebhook' #> function Get-MachineVariable { [CmdletBinding()] [Alias('gmv')] param ( [Parameter(Mandatory = $true, Position = 0)] [Alias('Var')] [System.String] $Name ) return [System.Environment]::GetEnvironmentVariable($Name, [System.EnvironmentVariableTarget]::Machine) } <# .SYNOPSIS Set a machine level environment variable. .DESCRIPTION Sets a machine level environment variable with the provided name and values. .PARAMETER Name The name of the variable you wish to set. .PARAMETER Value The value of the variable you wish to set. .EXAMPLE PS C:\> Set-UserVariable -Name DISCORD_WEBHOOK -Value 'https://bit.ly/discurl' .NOTES Has a sister function, Set-UserVariable that will let you set a user level environment variable if you only need it for a specific user or don't have admin rights. #> function Set-MachineVariable { [CmdletBinding()] [Alias('smv')] param ( [Parameter(Mandatory = $true, Position = 0)] [Alias('VariableName', 'VarName', 'Var')] [System.String] $Name, [Parameter(Mandatory = $true, Position = 1)] [System.String] [Alias('Data', 'Datum', 'Val')] $Value ) if ($Name -match ' ') { Write-Error -Message 'The provided variable name contains a space. Try replacing the space with an underscore (_).' ` -RecommendedAction 'Replace the space with an underscore.' } else { if (Get-IsUserAdmin) { try { [System.Environment]::SetEnvironmentVariable($Name, $Value, [System.EnvironmentVariableTarget]::Machine) Write-Host "The variable `"$Name`" has been set with the following value:`n" Write-Host $Value } catch { Write-Error $_ } } else { Write-Warning 'You must execute this function as an administrator as admin rights are required to add Machine level variables.' Write-Warning 'Launching PowerShell as an Administrator now...' Start-Process powershell -Verb runAs -ArgumentList "Set-MachineVariable $Name $Value" } } } <# .SYNOPSIS Remove a Machine level environment variable. .DESCRIPTION Remove a Machine level environment variable with provided name. .PARAMETER Name The name of the variable you wish to remove. .EXAMPLE PS C:\> Remove-MachineVariable -Name TestVarA The variable "TestVarA" has been removed. #> function Remove-MachineVariable { [CmdletBinding()] [Alias('rmv', 'Delete-MachineVariable')] param ( [Parameter(Mandatory = $true, Position = 0, HelpMessage = 'Which Machine variable would you like to remove from the environment path?')] [Alias('Variable', 'Var')] [System.String] $Name ) if ($Name -match ' ') { Write-Error -Message 'The provided variable name contains a space. Try replacing the space with an underscore (_).'` -RecommendedAction 'Replace the space with an underscore.' } else { if (Get-IsUserAdmin) { try { [System.Environment]::SetEnvironmentVariable($Name, $null, [System.EnvironmentVariableTarget]::Machine) Write-Host "The variable `"$Name`" has been removed." } catch { Write-Error $_ } } else { Write-Warning 'You must execute this function as an administrator as admin rights are required to add Machine level variables.' Write-Warning 'Launching PowerShell as an Administrator now...' Start-Process powershell -Verb runAs -ArgumentList "Remove-MachineVariable $Name" } } } <# .SYNOPSIS Determines if the current process has administrator rights. .DESCRIPTION Determines if the current process has administrator rights and returns true or false. .EXAMPLE PS C:\> Get-IsUserAdmin False .EXAMPLE PS C:\> AmIAdmin True .NOTES Whether or not the process is an admin is done by checking if the current identity is part of the built in Windows Administrator role. #> function Get-IsUserAdmin { [CmdletBinding()] [Alias('IsUserAdmin', 'Get-AdminStatus', 'AmIAdmin', 'IsAdmin')] param() return ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole(` [Security.Principal.WindowsBuiltInRole] "Administrator") } |