functions/Add-YoutubeDLJob.ps1
|
function Add-YoutubeDLJob { <# .SYNOPSIS Create a new job definition .DESCRIPTION Add a new youtube-dl job definition to the database, which can be used with the Invoke-YoutubeDL command. .PARAMETER Name The name to call the job. .PARAMETER ConfigPath The filepath pointing to the configuration file. .PARAMETER Scriptblock A scriptblock which will be executed as part of the job once youtube-dl finishes running. .EXAMPLE PS C:\> Add-YoutubeDLJob -Name "test" -ConfigPath ~/conf.txt -Number "123" Adds a new job under the name "test", pointing to the configuration file specified, which contains a variable "Number" and initialises it with the value "123". .INPUTS None .OUTPUTS None .NOTES Once you supply a valid configuration filepath, the function will create parameters at runtime for each variable found in the file, so if for example the configuration file has the variables: "number", "url", the parameters -Number and -Url will be exposed. To see all the parameters, pressing Ctrl+Tab will show the variable parameters at the top of the list. #> [CmdletBinding()] param ( [Parameter(Position = 0, Mandatory = $true)] [string] $Name, [Parameter(Position = 1, Mandatory = $true)] [Alias("Path")] [string] $ConfigPath, [Parameter(Position = 2, Mandatory = $false)] [scriptblock] $Scriptblock ) dynamicparam { # Only run the logic if the file exists if ((Test-Path -Path $ConfigPath) -eq $true) { # Retrieve all instances of variable definitions in the config file $definitionList = Read-ConfigDefinitions -Path $ConfigPath -VariableDefinitions #Define the dynamic parameter dictionary to add all new parameters to $parameterDictionary = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary # Now that a list of all variable definitions is found, create a dynamic parameter for each foreach ($definition in $definitionList) { $paramAttribute = New-Object System.Management.Automation.ParameterAttribute $paramAttribute.Mandatory = $true $attributeCollection = New-Object System.Collections.ObjectModel.Collection[System.Attribute] $attributeCollection.Add($paramAttribute) $param = New-Object System.Management.Automation.RuntimeDefinedParameter($definition, [String], $attributeCollection) $parameterDictionary.Add($definition, $param) } return $parameterDictionary } } process { # Read in the list of job objects $jobList = Get-Jobs -Path "$script:DataPath\database.xml" # Check that the job name isn't already taken $job = $jobList | Where-Object { $_.Name -eq $Name } if ($null -ne $job) { Write-Message -Message "There already exists a job called: $Name" -DisplayWarning return } # Ensure the config file actually exists if ((Test-Path -Path $ConfigPath) -eq $false) { Write-Message -Message "There is no file located at: $ConfigPath" -DisplayWarning return } # Retrieve all instances of variable definitions in the config file $definitionList = Read-ConfigDefinitions -Path $ConfigPath -VariableDefinitions # Set up the job object $job = New-Object -TypeName psobject $job.PSObject.TypeNames.Insert(0, "youtube-dl.Job") $job | Add-Member -NotePropertyName "Name" -NotePropertyValue $Name $job | Add-Member -NotePropertyName "ConfigPath" -NotePropertyValue $ConfigPath # Add the user-provided variable initial-values to the job object [hashtable]$variableList = [ordered]@{} foreach ($definition in $definitionList) { $variableList.Add($definition, $PSBoundParameters[$definition]) } # If a scriptblock has been given in, add it to the job object if ($null -ne $Scriptblock) { $job | Add-Member -NotePropertyName "Scriptblock" -NotePropertyValue $Scriptblock.ToString() } $job | Add-Member -NotePropertyName "Variables" -NotePropertyValue $variableList $jobList.Add($job) # Save the newly created job to the database file Export-Clixml -Path "$script:DataPath\database.xml" -InputObject $jobList | Out-Null } } |