LocationStack.psm1

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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537

function Add-LocationToStack {
<#
.SYNOPSIS
Adds path to the location stack
.DESCRIPTION
Adds a directory path specified by <-location> parameter to $LocationStack hashtable, with key defined by <-id> parameter.
If path is not specified, current directory path is used.
If path or id is already present in $LocationStack, use <-force> to overwrite
.LINK
https://github.com/PavelStsefanovich/LocationStack
#>


    param (
        [string]$id = $(throw 'Mandatory parameter not provided: <id>.'),
        [string]$location = $PWD.Path,
        [switch]$force
    )

    $ErrorActionPreference = 'Stop'
    $location = (Resolve-Path $location).Path.TrimEnd('\/')

    if (!$Global:LocationStack) {
        $Global:LocationStack = @{ }
    }

    if ($id -match '\W') {
        throw "Invalid ID: '$id' (allowed characters: [a-zA-Z0-9_])"
    }

    if ($id -in $Global:LocationStack.Keys) {

        if (!$force) {
            Write-Warning "Found LocationStack ID '$id' with following path: '$($Global:LocationStack.$id)'."
            Write-Warning "Use <-force> to overwrite."
            break
        }
    }

    if ($location -in $Global:LocationStack.Values) {

        $existing_location_id = ($Global:LocationStack.GetEnumerator() | ? { $_.value -eq $location }).key

        if (!$force) {
            Write-Warning "Found '$location' with following ID: '$existing_location_id'."
            Write-Warning "Use <-force> to overwrite."
            break              
        }
    }

    if ($existing_location_id) {
        $Global:LocationStack.Remove($existing_location_id)
    }

    $Global:LocationStack.$id = $location
}

function Remove-LocationFromStack {
<#
.SYNOPSIS
Removes path from the location stack
.DESCRIPTION
Removes an entry from $LocationStack hashtable, with key defined by <-id> parameter.
Use <-force> to confirm your intent to delete.
.LINK
https://github.com/PavelStsefanovich/LocationStack
#>


    param (
        [string]$id = $(throw 'Mandatory parameter not provided: <id>.'),
        [switch]$force
    )

    $ErrorActionPreference = 'Stop'

    if (!$Global:LocationStack -or ($Global:LocationStack.Count -eq 0)) {
        Write-Warning "Location Stack is currently empty."
        break
    }

    if ($id -match '\W') {
        throw "Invalid ID: '$id' (allowed characters: [a-zA-Z0-9_])"
    }

    if ($id -notin $Global:LocationStack.Keys) {
        Write-Warning "Location ID '$id' not found in the Location Stack."
        break
    }

    if (!$force) {
        Write-Warning "Found '$id' : '$($Global:LocationStack.$id)'."
        Write-Warning "To delete, re-run with <-force>."
        break
    }

    $location = $Global:LocationStack.$id
    $Global:LocationStack.Remove($id)
    Write-Host "Removed '$id' : '$location'"
}

function Show-LocationStack {
<#
.SYNOPSIS
Lists paths in the location stack.
.DESCRIPTION
Returns $LocationStack hashtable.
Use <-ids>(array) and <-locations>(array) to filter returned results (both accept wildcard '*').
.LINK
https://github.com/PavelStsefanovich/LocationStack
#>


    param (
        [string[]]$ids,
        [string[]]$locations
    )

    $ErrorActionPreference = 'Stop'

    if (!$Global:LocationStack -or ($Global:LocationStack.Count -eq 0)) {
        Write-Warning "Location Stack is currently empty."
        break
    }

    $show_hash = @{}

    if ($ids) {

        foreach ($id in $ids) {
            
            if ($id -match '[^a-zA-Z0-9_\*]') {
                Write-Warning "Invalid ID: '$id' (allowed characters: [a-zA-Z0-9_] + wildcard '*')"
            }

            $keys = @($Global:LocationStack.Keys.GetEnumerator() | ?{$_ -like $id})
            $keys | %{$show_hash.$_ = $Global:LocationStack.$_}
        }
    }

    if ($locations) {

        $values = @()

        foreach ($location in $locations) {

            $Global:LocationStack.Values.GetEnumerator() |
            ? {$_ -like $location} |
            % {$values += $_}
        }

        $Global:LocationStack.Keys.GetEnumerator() | %{

            if ($Global:LocationStack.$_ -in $values) {
                $show_hash.$_ = $Global:LocationStack.$_
            }
        }
    }

    if (!$id -and !$location) {
        $show_hash = $Global:LocationStack.Clone()
    }
    
    return $show_hash
}

function Switch-Location {
<#
.SYNOPSIS
Changes current directory to the path in the location stack
.DESCRIPTION
If <-id> is specified, uses path with that ID in $LocationStack hashtable.
If <-location> is specified, changes to that location if it can be resolved.
Before changing location, current directory path is recorded in $LocationStack hashtable under 'last' key.
If no parameters specified, changes location to the path defined by 'last' key in $LocationStack hashtable.
.LINK
https://github.com/PavelStsefanovich/LocationStack
#>


    param (
        [string]$id,
        [string]$location
    )

    $ErrorActionPreference = 'Stop'

    if ($id -and $location) {
        throw "Both <-id> and <-location> cannot be used simultaneously."
    }

    if (!$Global:LocationStack -or ($Global:LocationStack.Count -eq 0)) {
        Write-Warning "Location Stack is currently empty."
        break
    }

    if ($id) {

        if ($id -match '\W') {
            throw "Invalid ID: '$id' (allowed characters: [a-zA-Z0-9_])"
        }

        if ($id -in $Global:LocationStack.Keys) {
            $location = $Global:LocationStack.$id
        }
        else {
            Write-Warning "Location ID '$id' not found in the Location Stack."
            break
        }
    }

    if (!$location) {
        $location = $Global:LocationStack.last
    }

    if ($location) {

        $location = (Resolve-Path $location).Path
        $Global:LocationStack.last = $PWD.Path
        cd $location
    }
}

function Open-LocationInExplorer {
<#
.SYNOPSIS
Opens path(s) from the location stack in Windows Explorer.
.DESCRIPTION
Use <-ids>(array) and <-locations>(array) to filter paths to open (both accept wildcard '*').
.LINK
https://github.com/PavelStsefanovich/LocationStack
#>


    param (
        [string[]]$ids,
        [string[]]$locations
    )

    $ErrorActionPreference = 'Stop'

    if (!$Global:LocationStack -or ($Global:LocationStack.Count -eq 0)) {
        Write-Warning "Location Stack is currently empty."
        break
    }

    $locations_to_open = @()

    if ($ids) {

        foreach ($id in $ids) {

            if ($id -match '[^a-zA-Z0-9_\*]') {
                Write-Warning "Invalid ID: '$id' (allowed characters: [a-zA-Z0-9_] + wildcard '*')"
            }

            $keys = @($Global:LocationStack.Keys.GetEnumerator() | ?{$_ -like $id})
            $keys | %{$locations_to_open += $Global:LocationStack.$_}                
        }
    }

    if (!$ids -and !$locations) {
        $locations_to_open += $PWD.Path
    }

    foreach ($location in $locations) {

        if (Test-Path $location) {
            $locations_to_open += $location
        }
        else {
            Write-Warning "Location not found on disk: '$location'."
        }
    }

    $opened_locations = @()

    foreach ($path in $locations_to_open) {

        if ($path -notin $opened_locations) {

            explorer "$path"
            $opened_locations += $path
        }
    }
}

function Clear-LocationStack {
<#
.SYNOPSIS
Clears location stack.
.DESCRIPTION
Removes all entries from $LocationStack hashtable except the one with 'last' key.
Use <-force> to delete $LocationStack hashtable completely.
.LINK
https://github.com/PavelStsefanovich/LocationStack
#>


    param (
        [switch]$force
    )

    $ErrorActionPreference = 'Stop'

    if ($force) {
        Get-Variable LocationStack -Scope Global -ErrorAction SilentlyContinue | rm
    }
    else {

        if (!$Global:LocationStack) {
            break
        }

        $keys_to_delete = @()

        foreach ($key in $Global:LocationStack.Keys.GetEnumerator()) {
            
            if ($key -ne 'last') {
                $keys_to_delete += $key
            }
        }

        $keys_to_delete | % {$Global:LocationStack.Remove($_)}
    }
}

function Export-LocationStack {
<#
.SYNOPSIS
Saves location stack to a file.
.DESCRIPTION
If <-name> is not specified, location stack is saved as 'default'.
If location stack with provided name already exists, use <-force> to overwrite.
.LINK
https://github.com/PavelStsefanovich/LocationStack
#>


    param (
        [string]$name,
        [switch]$force
    )

    $ErrorActionPreference = 'Stop'

    if (!$Global:LocationStack -or ($Global:LocationStack.Count -eq 0)) {
        Write-Warning "Location Stack is currently empty."
        break
    }

    if ($name -match '[^a-zA-Z0-9]') {
        throw "Invalid name: '$name' (allowed characters: [a-zA-Z0-9])"
    }

    $save_directory = Join-Path (Split-Path $PROFILE) 'data'
    mkdir $save_directory -ErrorAction SilentlyContinue | Out-Null
    if (!$name) {$name = 'default'}
    $filepath = Join-Path $save_directory "locstack_$name`.json"

    if (Test-Path $filepath) {
        
        if (!$force) {

            Write-Warning "Found location stack '$name' on disk."
            Write-Warning "Use <-force> to overwrite."
            break
        }
    }

    $Global:LocationStack | ConvertTo-Json | Out-File $filepath -Force -ErrorAction Stop
}

function Import-LocationStack {
<#
.SYNOPSIS
Loads location stack from a file.
.DESCRIPTION
If <-name> is not specified, 'default' stack is loaded.
Parameter <-force> is required to avoid accidental replacement of current stack.
.LINK
https://github.com/PavelStsefanovich/LocationStack
#>


    param (
        [string]$name,
        [switch]$force
    )

    $ErrorActionPreference = 'Stop'

    if ($name -match '[^a-zA-Z0-9]') {
        throw "Invalid name: '$name' (allowed characters: [a-zA-Z0-9])"
    }
    
    if (!$force) {

        Write-Warning "(!) Re-run with '-Force' parameter to import location stack from file."
        break
    }

    $save_directory = Join-Path (Split-Path $PROFILE) 'data'
    if (!$name) {$name = 'default'}
    $filepath = Join-Path $save_directory "locstack_$name`.json"

    if (!(Test-Path $filepath)) {
        Write-Warning "LocationStack '$name' not found on disk"
        Write-Warning "Use Get-LocationStack to list available stacks."
        break
    }

    $load_hash = @{}

    (cat $filepath -ErrorAction Stop | ConvertFrom-Json).psobject.properties |
    %{ $load_hash[$_.Name] = $_.Value }

    $Global:LocationStack = $load_hash.Clone()
    Remove-Variable load_hash -force
}

function Get-LocationStack {
<#
.SYNOPSIS
Lists exported location stacks.
.DESCRIPTION
Use <-name>(array) to filter listed stacks (accepts wildcard '*')
.LINK
https://github.com/PavelStsefanovich/LocationStack
#>


    param (
        [string[]]$names = @('*')
    )

    $save_directory = Join-Path (Split-Path $PROFILE) 'data'
    $stacks_list = @()

    foreach ($name in $names) {

        $filter = "locstack_$name`.json"

        if ($name -match '[^a-zA-Z0-9*]') {
            Write-Warning "Invalid name: '$name' (allowed characters: [a-zA-Z0-9*])"
        } 

        $stacks_on_disk = (ls $save_directory -Filter $filter -ErrorAction SilentlyContinue).BaseName

        $stacks_on_disk | %{

            if ($_ -notin $stacks_list) {
                $stacks_list += $_
            }
        }
    }

    if ($stacks_list) {

        $stacks_list | % {
            
            if ($_) {               
                Write-Host $_.replace('locstack_','')
            }
        }
    }
}

function Remove-LocationStack {
<#
.SYNOPSIS
Removes exported location stack from disk.
.DESCRIPTION
Use mandatory <-name> parameter to specify which stack file to delete (use 'default' to remove default stack).
Parameter <-force> is required to avoid accidental removal of stack file.
.LINK
https://github.com/PavelStsefanovich/LocationStack
#>


    param (
        [string]$name = $(throw 'Mandatory parameter not provided: <name>.'),
        [switch]$force
    )

    $ErrorActionPreference = 'Stop'

    if ($name -match '[^a-zA-Z0-9]') {
        throw "Invalid name: '$name' (allowed characters: [a-zA-Z0-9])"
    }

    $save_directory = Join-Path (Split-Path $PROFILE) 'data'
    $filepath = Join-Path $save_directory "locstack_$name`.json"

    if (!(Test-Path $filepath)) {
        Write-Warning "LocationStack '$name' not found on disk"
        Write-Warning "Use Get-LocationStack to list available stacks."
        break
    }

    if (!$force) {

        Write-Warning "Found location stack '$name' on disk."
        Write-Warning "To delete, re-run with <-force>."
        break
    }

    Remove-Item $filepath -Force
    Write-Host "Removed location stack '$name'"
}

try {
    Set-Alias -Name als -Value Add-LocationToStack -Force -ErrorAction Stop
    Set-Alias -Name rls -Value Remove-LocationFromStack -Force -ErrorAction Stop
    Set-Alias -Name shls -Value Show-LocationStack -Force -ErrorAction Stop
    Set-Alias -Name swl -Value Switch-Location -Force -ErrorAction Stop
    Set-Alias -Name ole -Value Open-LocationInExplorer -Force -ErrorAction Stop
    Set-Alias -Name clrs -Value Clear-LocationStack -Force -ErrorAction Stop
    Set-Alias -Name els -Value Export-LocationStack -Force -ErrorAction Stop
    Set-Alias -Name ils -Value Import-LocationStack -Force -ErrorAction Stop
    Set-Alias -Name gls -Value Get-LocationStack -Force -ErrorAction Stop
    Set-Alias -Name rmls -Value Remove-LocationStack -Force -ErrorAction Stop
    Export-ModuleMember -Function * -Alias *
}
catch {
    Write-Warning "<Import-module LocationStack> : Failed to update aliases for imported functions. Please run the following block to set aliases manually:"
    Write-Host ''
    Write-Host 'Set-Alias -Name als -Value Remove-LocationFromStack -Force'
    Write-Host 'Set-Alias -Name rls -Value Add-LocationToStack -Force'
    Write-Host 'Set-Alias -Name shls -Value Show-LocationStack -Force'
    Write-Host 'Set-Alias -Name swl -Value Switch-Location -Force'
    Write-Host 'Set-Alias -Name ole -Value Open-LocationInExplorer -Force'
    Write-Host 'Set-Alias -Name clrs -Value Clear-LocationStack -Force'
    Write-Host 'Set-Alias -Name els -Value Export-LocationStack -Force'
    Write-Host 'Set-Alias -Name ils -Value Import-LocationStack -Force'
    Write-Host 'Set-Alias -Name gls -Value Get-LocationStack -Force'
    Write-Host 'Set-Alias -Name rmls -Value Remove-LocationStack -Force'
    Write-Host ''
    Write-Warning 'Use the following command to delete persistent aliases:'
    Write-Host ''
    Write-Host 'del alias:<alias_name> -Force'
    Write-Host ''
}

Export-ModuleMember -Function *