Modules/PSUtils/Functions/Config.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 |
# =========================================================================== # PowerShell-Config.ps1 --------------------------------------------------- # =========================================================================== # function ---------------------------------------------------------------- # --------------------------------------------------------------------------- function Get-ConfigHome { <# .DESCRIPTION Get the base directory relative to which user specific configuration files should be stored. It is XDG compatible, which means that if the environment variable 'XDG_CONFIG_HOME' is defined it will use the configuration folder 'XDG_CONFIG_HOME/<project-name>' instead. .OUTPUTS System.String. Configuration base directory. #> [CmdletBinding(PositionalBinding=$True)] [OutputType([System.String])] Param() Process { $config_home = Join-Path -Path $([System.Environment]::GetEnvironmentVariable("USERPROFILE", "process")) -ChildPath ".config" $xdg_home = [System.Environment]::GetEnvironmentVariable("XDG_CONFIG_HOME", "process") if ($xdg_home) { $config_home = $xdg_home } return $config_home } } # function ---------------------------------------------------------------- # --------------------------------------------------------------------------- function New-ConfigHome { <# .DESCRIPTION Create the base directory relative to which user specific configuration files should be stored. It is XDG compatible, which means that if the environment variable 'XDG_CONFIG_HOME' is defined it will use the configuration folder 'XDG_CONFIG_HOME/<project-name>' instead. .OUTPUTS None. #> [CmdletBinding(PositionalBinding=$True)] [OutputType([Void])] Param() Process { $config_home = Get-ConfigHome if(-not $(Test-Path -Path $config_home)){ New-Item -Path $config_home -ItemType Directory } } } # function ---------------------------------------------------------------- # --------------------------------------------------------------------------- function Get-ConfigProjectDirList { <# .DESCRIPTION Get specific '<project-name'> configuration directories where configuration files might be stored .OUTPUTS System.String. Folder where configuration files might be stored. #> [CmdletBinding(PositionalBinding=$True)] [OutputType([System.String])] Param( [Parameter(Position=1, Mandatory=$True, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Name of project.")] [System.String] $Name ) Process { $dir_list = New-Object -TypeName System.Collections.Generic.List[System.Object] $xdg_dir_list = [System.Environment]::GetEnvironmentVariable("XDG_CONFIG_DIRS", "process") if ($xdg_dir_list) { # config_home should also be included on top of 'XDG_CONFIG_DIRS' foreach($xdg_dir in $($xdg_dir_list -split ";")) { if (-not $xdg_dir){ continue } [Void] $dir_list.Add($(Join-Path -Path $xdg_dir -ChildPath $Name)) } } # Take 'XDG_CONFIG_HOME' and '%USERPROFILE%/.<project-name>' for backwards compatibility [Void] $dir_list.Add($(Join-Path -Path $(Get-ConfigHome) -ChildPath $Name)) return $dir_list } } # function ---------------------------------------------------------------- # --------------------------------------------------------------------------- function Get-ConfigProjectDir { <# .DESCRIPTION Get folder where the configuration files are stored, e.g. '%USERPROFILE%/.<project-name>'. It is XDG compatible, which means that if the environment variable 'XDG_CONFIG_HOME' is defined it will use the configuration folder 'XDG_CONFIG_HOME/<project-name>' instead. .PARAMETER Name .OUTPUTS System.String. Folder where the configuration files are stored #> [CmdletBinding(PositionalBinding=$True)] [OutputType([System.String])] Param( [Parameter(Position=1, Mandatory=$True, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Name of project.")] [System.String] $Name ) Process { foreach ($dir in (Get-ConfigProjectDirList -Name $Name) ) { if ($(Test-Path -Path $dir)) { return $dir } } # If no folder is found, then return config home $config_home = Join-Path -Path (Get-ConfigHome) -ChildPath $Name return $config_home } } # function ---------------------------------------------------------------- # --------------------------------------------------------------------------- function Get-ConfigProjectFile { <# .DESCRIPTION Get configuration base file locate in project configuration folder, e.g. '%USERPROFILE%/.<project-name>/config.ini'. .PARAMETER Name .OUTPUTS System.String. Path of configuration base file #> [CmdletBinding(PositionalBinding=$True)] [OutputType([System.String])] Param( [Parameter(Position=1, Mandatory=$True, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Name of project.")] [System.String] $Name ) Process { return Join-Path -Path $(Get-ConfigProjectDir -Name $Name) -ChildPath "config.ini" } } # function ---------------------------------------------------------------- # --------------------------------------------------------------------------- function New-ConfigProjectDir { <# .DESCRIPTION Create folder where the configuration files are stored, e.g. '%USERPROFILE%/.<project-name>'. It is XDG compatible, which means that if the environment variable 'XDG_CONFIG_HOME' is defined it will use the configuration folder 'XDG_CONFIG_HOME/<project-name>' instead. .PARAMETER Name .OUTPUTS None. #> [CmdletBinding(PositionalBinding=$True)] [OutputType([Void])] Param( [Parameter(Position=1, Mandatory=$True, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Name of project.")] [System.String] $Name ) Process { $config_home = Get-ConfigProjectDir -Name $Name if(-not $(Test-Path -Path $config_home)){ New-Item -Path $config_home -ItemType Directory } } } # function ---------------------------------------------------------------- # --------------------------------------------------------------------------- function Get-ScriptProjectDir { <# .DESCRIPTION Get folder where the scripts are stored, e.g. '%USERPROFILE%/.<project-name>/scripts'. It is XDG compatible, which means that if the environment variable 'XDG_CONFIG_HOME' is defined it will use the configuration folder 'XDG_CONFIG_HOME/<project-name>/scripts' instead. .PARAMETER Name .OUTPUTS System.String. Folder where the scripts are stored #> [CmdletBinding(PositionalBinding=$True)] [OutputType([System.String])] Param( [Parameter(Position=1, Mandatory=$True, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Name of project.")] [System.String] $Name ) Process { $config_home = $Null foreach ($dir in (Get-ConfigProjectDirList -Name $Name) ) { if ($(Test-Path -Path $dir)) { $config_home = $dir break } } # If no folder is found, then return config home if (-not $config_home){ Join-Path -Path $(Get-ConfigProjectDir -Name $Name) -ChildPath $Name } $scripts_home = Join-Path -Path $config_home -ChildPath "scripts" return $scripts_home } } # function ---------------------------------------------------------------- # --------------------------------------------------------------------------- function New-ScriptProjectDir { <# .DESCRIPTION Create folder where the scripts are stored, e.g. '%USERPROFILE%/.<project-name>/scripts'. It is XDG compatible, which means that if the environment variable 'XDG_CONFIG_HOME' is defined it will use the configuration folder 'XDG_CONFIG_HOME/<project-name>/scripts' instead. .PARAMETER Name .OUTPUTS None. #> [CmdletBinding(PositionalBinding=$True)] [OutputType([Void])] Param( [Parameter(Position=1, Mandatory=$True, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Name of project.")] [System.String] $Name ) Process { $scripts_home = Get-ScriptProjectDir -Name $Name if(-not $(Test-Path -Path $scripts_home)){ New-Item -Path $scripts_home -ItemType Directory } } } # function ---------------------------------------------------------------- # --------------------------------------------------------------------------- function Get-ProjectDir { <# .DESCRIPTION Get folder where the project files are stored, e.g. '%USERPROFILE%/<project-name>'. .PARAMETER Name .OUTPUTS System.String. Folder where the project files are stored #> [CmdletBinding(PositionalBinding=$True)] [OutputType([System.String])] Param( [Parameter(Position=1, Mandatory=$True, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Name of project.")] [System.String] $Name, [Parameter(HelpMessage="If folder does not exist, it will be created.")] [Switch] $Force ) Process { $project_home = Join-Path -Path $([System.Environment]::GetEnvironmentVariable("USERPROFILE", "process")) -ChildPath $Name return $project_home } } # function ---------------------------------------------------------------- # --------------------------------------------------------------------------- function New-ProjectDir { <# .DESCRIPTION Create folder where the project files are stored, e.g. '%USERPROFILE%/<project-name>'. .PARAMETER Name .OUTPUTS None. #> [CmdletBinding(PositionalBinding=$True)] [OutputType([Void])] Param( [Parameter(Position=1, Mandatory=$True, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Name of project.")] [System.String] $Name ) Process { $project_home = Get-ProjectDir -Name $Name if(-not $(Test-Path -Path $project_home)){ New-Item -Path $project_home -ItemType Directory } } } # function ---------------------------------------------------------------- # --------------------------------------------------------------------------- function New-ProjectConfigDirs { <# .DESCRIPTION Create folder where configuration and scripts are stored, e.g. '%USERPROFILE%/.<project-name>'. It is XDG compatible, which means that if the environment variable 'XDG_CONFIG_HOME' is defined it will use the configuration folder 'XDG_CONFIG_HOME/<project-name>/scripts' instead. .PARAMETER Name .OUTPUTS None. #> [CmdletBinding(PositionalBinding=$True)] [OutputType([Void])] Param( [Parameter(Position=1, Mandatory=$True, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Name of project.")] [System.String] $Name ) Process { New-ConfigHome New-ConfigProjectDir -Name $Name New-ScriptProjectDir -Name $Name # New-ProjectDir -Name $Name } } |