Skip to content

Commit

Permalink
Code refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
fvanroie committed Jun 16, 2018
1 parent 1037214 commit 4f0b2e4
Show file tree
Hide file tree
Showing 4 changed files with 119 additions and 80 deletions.
2 changes: 0 additions & 2 deletions PS_OPNsense.psm1
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,6 @@ $f = @(########## PLUGINS ##########
########## CORE ##########
# RestApi
'Invoke-OPNsenseCommand', #'Invoke-OPNsenseOpenApiPath',
# Firmware
'Get-OPNsense', 'Set-OPNsense',

# Cron
#'Get-OPNsenseCronJob', 'Enable-OPNsenseCronJob', 'Disable-OPNsenseCronJob', 'Remove-OPNsenseCronJob',
Expand Down
80 changes: 2 additions & 78 deletions Core/Firmware.ps1 → Public/Core/Firmware/Get-OPNsense.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -22,41 +22,8 @@
#>






Function Get-OPNsenseUpdate {
# .EXTERNALHELP ../PS_OPNsense.psd1-Help.xml
param (
[SupportsWildcards()]
[Parameter(Mandatory = $false, position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
[String[]]$Name,
[String]$Reason
)
BEGIN {
# Get all packages
$opn = Get-OPNsense
$updpkgnames = Get-Member -InputObject $opn.all_packages -MemberType NoteProperty | Select-Object -ExpandProperty name

# No Name was passed
if (-Not $PSBoundParameters.ContainsKey('Name')) { $Name = '*' }

$allupdates = @()
}
PROCESS {
# Multiple Names can be passed
foreach ($updname in $updpkgnames) {
$allupdates += $opn.all_packages.$updname
}
}
END {
return $allupdates | Add-ObjectDetail -TypeName 'OPNsense.Firmware.Update' | Sort-Object Reason, Name
}
}

Function Get-OPNsense {
# .EXTERNALHELP ../PS_OPNsense.psd1-Help.xml
# .EXTERNALHELP ../../../PS_OPNsense.psd1-Help.xml
[CmdletBinding(DefaultParameterSetName = 'Mirror')]
Param(
[Alias("Mirrors")]
Expand Down Expand Up @@ -98,47 +65,4 @@ Function Get-OPNsense {

# No Switches
return Invoke-OPNsenseCommand core firmware status
}


Function Set-OPNsense {
# .EXTERNALHELP ../PS_OPNsense.psd1-Help.xml
[CmdletBinding()]
Param(
[parameter(Mandatory = $false, ParameterSetName = "FirmwareOptions")]
[String]$Mirror,
[parameter(Mandatory = $false, ParameterSetName = "FirmwareOptions")]
[String]$Flavour,
[parameter(Mandatory = $false, ParameterSetName = "FirmwareOptions")]
[String]$Subscription
)

$changed = 0
$FirmwareOptions = Invoke-OPNsenseCommand core firmware getFirmwareConfig -AddProperty @{ Subscription = '' }
if ($PSBoundParameters.ContainsKey('Mirror')) {
$changed++
$FirmwareOptions.Mirror = $Mirror
}
if ($PSBoundParameters.ContainsKey('Flavour')) {
$changed++
$FirmwareOptions.Flavour = $Flavour
}
if ($PSBoundParameters.ContainsKey('Subscription')) {
$changed++
$FirmwareOptions.Subscription = $Subscription
}

if ($changed -gt 0) {
Write-Verbose "$changed setting(s) have changed"
$result = Invoke-OPNsenseCommand core firmware setFirmwareConfig `
-Json @{ mirror = $FirmwareOptions.Mirror; flavour = $FirmwareOptions.Flavour; subscription = $FirmwareOptions.Subscription }
if ($Result.status -eq 'ok') {
return $FirmwareOptions | Add-ObjectDetail -TypeName 'OPNsense.Firmware.Options'
} else {
Throw 'Failed to set the firmware options.'
}
} else {
Write-Warning 'No settings have changed, skipping.'
return $FirmwareOptions | Add-ObjectDetail -TypeName 'OPNsense.Firmware.Options'
}
}
}
52 changes: 52 additions & 0 deletions Public/Core/Firmware/Get-OPNsenseUpdate.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<# MIT License
Copyright (c) 2018 fvanroie, NetwiZe.be
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.
#>


Function Get-OPNsenseUpdate {
# .EXTERNALHELP ../../../PS_OPNsense.psd1-Help.xml
param (
[SupportsWildcards()]
[Parameter(Mandatory = $false, position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
[String[]]$Name,
[String]$Reason
)
BEGIN {
# Get all packages
$opn = Get-OPNsense
$updpkgnames = Get-Member -InputObject $opn.all_packages -MemberType NoteProperty | Select-Object -ExpandProperty name

# No Name was passed
if (-Not $PSBoundParameters.ContainsKey('Name')) { $Name = '*' }

$allupdates = @()
}
PROCESS {
# Multiple Names can be passed
foreach ($updname in $updpkgnames) {
$allupdates += $opn.all_packages.$updname
}
}
END {
return $allupdates | Add-ObjectDetail -TypeName 'OPNsense.Firmware.Update' | Sort-Object Reason, Name
}
}
65 changes: 65 additions & 0 deletions Public/Core/Firmware/Set-OPNsense.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<# MIT License
Copyright (c) 2018 fvanroie, NetwiZe.be
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.
#>


Function Set-OPNsense {
# .EXTERNALHELP ../PS_OPNsense.psd1-Help.xml
[CmdletBinding()]
Param(
[parameter(Mandatory = $false, ParameterSetName = "FirmwareOptions")]
[String]$Mirror,
[parameter(Mandatory = $false, ParameterSetName = "FirmwareOptions")]
[String]$Flavour,
[parameter(Mandatory = $false, ParameterSetName = "FirmwareOptions")]
[String]$Subscription
)

$changed = 0
$FirmwareOptions = Invoke-OPNsenseCommand core firmware getFirmwareConfig -AddProperty @{ Subscription = '' }
if ($PSBoundParameters.ContainsKey('Mirror')) {
$changed++
$FirmwareOptions.Mirror = $Mirror
}
if ($PSBoundParameters.ContainsKey('Flavour')) {
$changed++
$FirmwareOptions.Flavour = $Flavour
}
if ($PSBoundParameters.ContainsKey('Subscription')) {
$changed++
$FirmwareOptions.Subscription = $Subscription
}

if ($changed -gt 0) {
Write-Verbose "$changed setting(s) have changed"
$result = Invoke-OPNsenseCommand core firmware setFirmwareConfig `
-Json @{ mirror = $FirmwareOptions.Mirror; flavour = $FirmwareOptions.Flavour; subscription = $FirmwareOptions.Subscription }
if ($Result.status -eq 'ok') {
return $FirmwareOptions | Add-ObjectDetail -TypeName 'OPNsense.Firmware.Options'
} else {
Throw 'Failed to set the firmware options.'
}
} else {
Write-Warning 'No settings have changed, skipping.'
return $FirmwareOptions | Add-ObjectDetail -TypeName 'OPNsense.Firmware.Options'
}
}

0 comments on commit 4f0b2e4

Please sign in to comment.