feature(update): Add hold/unhold command (ScoopInstaller#3444)

Allows un/locking a program to the current version and enable/disable updates. Close ScoopInstaller#3232 Close ScoopInstaller#1941
r15ch13 · May 8, 2019 · 44975dc · 44975dc
1 parent 8beffc4
commit 44975dc
Show file tree

Hide file tree

Showing 6 changed files with 91 additions and 7 deletions.
diff --git a/lib/core.ps1 b/lib/core.ps1
@@ -233,6 +233,7 @@ function app_status($app, $global) {
     $install_info = install_info $app $status.version $global
 
     $status.failed = (!$install_info -or !$status.version)
+    $status.hold = ($install_info.hold -eq $true)
 
     $manifest = manifest $app $install_info.bucket $install_info.url
     $status.removed = (!$manifest)

diff --git a/libexec/scoop-hold.ps1 b/libexec/scoop-hold.ps1
@@ -0,0 +1,33 @@
+# Usage: scoop hold <apps>
+# Summary: Hold an app to disable updates
+
+. "$psscriptroot\..\lib\help.ps1"
+. "$psscriptroot\..\lib\manifest.ps1"
+
+reset_aliases
+$apps = $args
+
+if(!$apps) {
+    my_usage
+    exit 1
+}
+
+$apps | ForEach-Object {
+    $app = $_
+    $global = installed $app $true
+
+    if (!(installed $app)) {
+        error "'$app' is not installed."
+        return
+    }
+
+    $dir = versiondir $app 'current' $global
+    $json = install_info $app 'current' $global
+    $install = @{}
+    $json | Get-Member -MemberType Properties | ForEach-Object { $install.Add($_.Name, $json.($_.Name))}
+    $install.hold = $true
+    save_install_info $install $dir
+    success "$app is now locked and can not be updated anymore."
+}
+
+exit $exitcode
diff --git a/libexec/scoop-list.ps1 b/libexec/scoop-list.ps1
@@ -30,6 +30,7 @@ if($apps) {
         if($global) { write-host -f DarkGreen ' *global*' -NoNewline }
 
         if (!$install_info) { Write-Host ' *failed*' -ForegroundColor DarkRed -NoNewline }
+        if ($install_info.hold) { Write-Host ' *hold*' -ForegroundColor DarkMagenta -NoNewline }
 
         if ($install_info.bucket -and ($install_info.bucket -ne 'main')) {
             write-host -f Yellow " [$($install_info.bucket)]" -NoNewline

diff --git a/libexec/scoop-status.ps1 b/libexec/scoop-status.ps1
@@ -35,6 +35,7 @@ $failed = @()
 $outdated = @()
 $removed = @()
 $missing_deps = @()
+$onhold = @()
 
 $true, $false | ForEach-Object { # local and global apps
     $global = $_
@@ -52,6 +53,9 @@ $true, $false | ForEach-Object { # local and global apps
         }
         if($status.outdated) {
             $outdated += @{ $app = @($status.version, $status.latest_version) }
+            if($status.hold) {
+                $onhold += @{ $app = @($status.version, $status.latest_version) }
+            }
         }
         if($status.missing_deps) {
             $missing_deps += ,(@($app) + @($status.missing_deps))
@@ -67,6 +71,14 @@ if($outdated) {
     }
 }
 
+if($onhold) {
+    write-host -f DarkCyan 'These apps are outdated and on hold:'
+    $onhold.keys | ForEach-Object {
+        $versions = $onhold.$_
+        "    $_`: $($versions[0]) -> $($versions[1])"
+    }
+}
+
 if($removed) {
     write-host -f DarkCyan 'These app manifests have been removed:'
     $removed.keys | ForEach-Object {

diff --git a/libexec/scoop-unhold.ps1 b/libexec/scoop-unhold.ps1
@@ -0,0 +1,33 @@
+# Usage: scoop unhold <app>
+# Summary: Unhold an app to enable updates
+
+. "$psscriptroot\..\lib\help.ps1"
+. "$psscriptroot\..\lib\manifest.ps1"
+
+reset_aliases
+$apps = $args
+
+if(!$apps) {
+    my_usage
+    exit 1
+}
+
+$apps | ForEach-Object {
+    $app = $_
+    $global = installed $app $true
+
+    if (!(installed $app)) {
+        error "'$app' is not installed."
+        return
+    }
+
+    $dir = versiondir $app 'current' $global
+    $json = install_info $app 'current' $global
+    $install = @{}
+    $json | Get-Member -MemberType Properties | ForEach-Object { $install.Add($_.Name, $json.($_.Name))}
+    $install.hold = $null
+    save_install_info $install $dir
+    success "$app is now unlocked and can be updated again."
+}
+
+exit $exitcode
diff --git a/libexec/scoop-update.ps1 b/libexec/scoop-update.ps1
@@ -289,13 +289,21 @@ if (!$apps) {
             ($app, $global) = $_
             $status = app_status $app $global
             if ($force -or $status.outdated) {
-                $outdated += applist $app $global
-                write-host -f yellow ("$app`: $($status.version) -> $($status.latest_version){0}" -f ('',' (global)')[$global])
+                if(!$status.hold) {
+                    $outdated += applist $app $global
+                    write-host -f yellow ("$app`: $($status.version) -> $($status.latest_version){0}" -f ('',' (global)')[$global])
+                } else {
+                    warn "'$app' is locked to version $($status.version)"
+                }
             } elseif ($apps_param -ne '*') {
                 write-host -f green "$app`: $($status.version) (latest version)"
             }
         }
 
+        if ($outdated -and (Test-Aria2Enabled)) {
+            warn "Scoop uses 'aria2c' for multi-connection downloads."
+            warn "Should it cause issues, run 'scoop config aria2-enabled false' to disable it."
+        }
         if ($outdated.Length -gt 1) {
             write-host -f DarkCyan "Updating $($outdated.Length) outdated apps:"
         } elseif ($outdated.Length -eq 0) {
@@ -306,11 +314,7 @@ if (!$apps) {
     }
 
     $suggested = @{};
-    # # $outdated is a list of ($app, $global) tuples
-    if (Test-Aria2Enabled) {
-        warn "Scoop uses 'aria2c' for multi-connection downloads."
-        warn "Should it cause issues, run 'scoop config aria2-enabled false' to disable it."
-    }
+    # $outdated is a list of ($app, $global) tuples
     $outdated | ForEach-Object { update @_ $quiet $independent $suggested $use_cache $check_hash }
 }