include/databaseV2.ps1
|
# DATABASE V2 # # Database driver to store the cache # # Include design description # This is the function ps1. This file is the same for all modules. # Create a public psq with variables, Set-MyInvokeCommandAlias call and Invoke public function. # Invoke function will call back `GetDatabaseRootPath` to use production root path # Mock this Invoke function with Set-MyInvokeCommandAlias to set the Store elsewhere # This ps1 has function `GetDatabaseFile` that will call `Invoke-MyCommand -Command $DB_INVOKE_GET_ROOT_PATH_ALIAS` # to use the store path, mocked or not, to create the final store file name. # All functions of this ps1 will depend on `GetDatabaseFile` for functionality. # # TODO : Create a related public ps1 # 1. define $DB_INVOKE_GET_ROOT_PATH_ALIAS. Make it unique. # 2. define $DB_INVOKE_GET_ROOT_PATH_CMD. Point to the invoke function that calls GetConfigRootPath to get the store path # # Sample code (replace "MyModule" with a unique module prefix): # $DB_INVOKE_GET_ROOT_PATH_ALIAS = "SfGetDbRootPath" # $DB_INVOKE_GET_ROOT_PATH_CMD = "Invoke-SfGetDbRootPath" # # Set-MyInvokeCommandAlias -Alias $DB_INVOKE_GET_ROOT_PATH_ALIAS -Command $DB_INVOKE_GET_ROOT_PATH_CMD # # function Invoke-SfGetDbRootPath{ # [CmdletBinding()] # param() # # $databaseRoot = GetDatabaseRootPath # return $databaseRoot # # } Export-ModuleMember -Function Invoke-SfGetDbRootPath $moduleRootPath = $PSScriptRoot | Split-Path -Parent $moduleName = (Get-ChildItem -Path $moduleRootPath -Filter *.psd1 | Select-Object -First 1).BaseName $DATABASE_ROOT = [System.Environment]::GetFolderPath('UserProfile') | Join-Path -ChildPath ".helpers" -AdditionalChildPath $moduleName, "databaseCache" # Create the database root if it does not exist if(-Not (Test-Path $DATABASE_ROOT)){ New-Item -Path $DATABASE_ROOT -ItemType Directory } Set-MyInvokeCommandAlias -Alias $DB_INVOKE_GET_ROOT_PATH_ALIAS -Command "Invoke-$DB_INVOKE_GET_ROOT_PATH_ALIAS" if(-not (Test-Path -Path function:"Invoke-$DB_INVOKE_GET_ROOT_PATH_ALIAS")){ # PUBLIC FUNCTION function Invoke-MyModuleGetDbRootPath{ [CmdletBinding()] param() $databaseRoot = GetDatabaseRootPath return $databaseRoot } Rename-Item -path Function:Invoke-MyModuleGetDbRootPath -NewName "Invoke-$DB_INVOKE_GET_ROOT_PATH_ALIAS" Export-ModuleMember -Function "Invoke-$DB_INVOKE_GET_ROOT_PATH_ALIAS" } # Extra functions not needed by INCLUDE DATABASE V2 if(-not (Test-Path -Path function:"Reset-$DB_INVOKE_GET_ROOT_PATH_ALIAS")){ function Reset-MyModuleDatabaseStore{ [CmdletBinding()] param() $databaseRoot = Invoke-MyCommand -Command $DB_INVOKE_GET_ROOT_PATH_ALIAS Remove-Item -Path $databaseRoot -Recurse -Force -ErrorAction SilentlyContinue New-Item -Path $databaseRoot -ItemType Directory } Rename-Item -path Function:Reset-MyModuleDatabaseStore -NewName "Reset-$($moduleName)DatabaseStore" Export-ModuleMember -Function "Reset-$($moduleName)DatabaseStore" } # PRIVATE FUNCTIONS function GetDatabaseRootPath { [CmdletBinding()] param() $databaseRoot = $DATABASE_ROOT return $databaseRoot } function GetDatabaseFile{ [CmdletBinding()] param( [Parameter(Position = 0)][string]$Key ) # throw if DB_INVOKE_GET_ROOT_PATH_ALIAS is not set if (-not $DB_INVOKE_GET_ROOT_PATH_ALIAS) { throw "DB_INVOKE_GET_ROOT_PATH_ALIAS is not set. Please set it before calling GetDatabaseFile." } $databaseRoot = Invoke-MyCommand -Command $DB_INVOKE_GET_ROOT_PATH_ALIAS $path = $databaseRoot | Join-Path -ChildPath "$Key.json" return $path } function Get-DatabaseKey{ [CmdletBinding()] param( [Parameter(Position = 0)][string]$Key ) if(-Not (Test-DatabaseKey $Key)){ return $null } $path = GetDatabaseFile $Key $ret = Get-Content $path | ConvertFrom-Json -Depth 10 -AsHashtable return $ret } function Reset-DatabaseKey{ [CmdletBinding()] param( [Parameter(Position = 0)][string]$Key ) $path = GetDatabaseFile -Key $Key Remove-Item -Path $path -Force -ErrorAction SilentlyContinue return } function Save-DatabaseKey{ [CmdletBinding()] param( [Parameter(Position = 0)][string]$Key, [Parameter(Position = 2)][Object]$Value ) $path = GetDatabaseFile -Key $Key $Value | ConvertTo-Json -Depth 10 | Set-Content $path } function Test-DatabaseKey{ [CmdletBinding()] param( [Parameter(Position = 0)][string]$Key ) $path = GetDatabaseFile -Key $Key # Key file not exists if(-Not (Test-Path $path)){ return $false } # TODO: Return $false if cache has expired return $true } |