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
|
package preflight
import (
"bytes"
"encoding/xml"
"errors"
"fmt"
"os"
"os/user"
"strings"
"github.com/crc-org/crc/v2/pkg/crc/cache"
"github.com/crc-org/crc/v2/pkg/crc/constants"
"github.com/crc-org/crc/v2/pkg/crc/logging"
"github.com/crc-org/crc/v2/pkg/crc/version"
crcos "github.com/crc-org/crc/v2/pkg/os"
"github.com/crc-org/crc/v2/pkg/os/windows/powershell"
)
var (
// https://docs.microsoft.com/en-us/windows/win32/taskschd/daily-trigger-example--xml-
daemonTaskTemplate = `<?xml version="1.0" encoding="UTF-16"?>
<Task version="1.3" xmlns="http://schemas.microsoft.com/windows/2004/02/mit/task">
<RegistrationInfo>
<Description>Run crc daemon as a task</Description>
<Version>%s</Version>
</RegistrationInfo>
<Settings>
<DisallowStartIfOnBatteries>false</DisallowStartIfOnBatteries>
<StopIfGoingOnBatteries>false</StopIfGoingOnBatteries>
<Hidden>true</Hidden>
<MultipleInstancesPolicy>IgnoreNew</MultipleInstancesPolicy>
<IdleSettings>
<Duration>PT10M</Duration>
<WaitTimeout>PT1H</WaitTimeout>
<StopOnIdleEnd>true</StopOnIdleEnd>
<RestartOnIdle>false</RestartOnIdle>
</IdleSettings>
<UseUnifiedSchedulingEngine>true</UseUnifiedSchedulingEngine>
<ExecutionTimeLimit>PT0S</ExecutionTimeLimit>
</Settings>
<Triggers>
<LogonTrigger>
<UserId>%s</UserId>
</LogonTrigger>
</Triggers>
<Actions Context="Author">
<Exec>
<Command>%s</Command>
<Arguments>%s</Arguments>
</Exec>
</Actions>
</Task>
`
errOlderVersion = fmt.Errorf("expected %s task to be on version '%s'", constants.DaemonTaskName, version.GetCRCVersion())
)
func genDaemonTaskInstallTemplate(crcVersion, userName, backgroundLauncherPath, daemonCommand string) (string, error) {
var escapedDaemonCommand, escapedBackgroundLauncherPath bytes.Buffer
if err := xml.EscapeText(&escapedDaemonCommand, []byte(daemonCommand)); err != nil {
return "", err
}
if err := xml.EscapeText(&escapedBackgroundLauncherPath, []byte(backgroundLauncherPath)); err != nil {
return "", err
}
return fmt.Sprintf(daemonTaskTemplate,
crcVersion,
userName,
escapedBackgroundLauncherPath.String(),
escapedDaemonCommand.String(),
), nil
}
func checkIfDaemonTaskInstalled() error {
_, stderr, err := powershell.Execute("Get-ScheduledTask", "-TaskName", constants.DaemonTaskName)
if err != nil {
logging.Debugf("%s task is not installed: %v : %s", constants.DaemonTaskName, err, stderr)
return err
}
return checkIfOlderTask()
}
func fixDaemonTaskInstalled() error {
// Remove older task if exist
if err := removeDaemonTask(); err != nil {
return err
}
crcBinPath, err := os.Executable()
if err != nil {
return err
}
if !crcos.FileExists(constants.Win32BackgroundLauncherPath()) {
return fmt.Errorf("Missing background launcher binary at: %s", constants.Win32BackgroundLauncherPath())
}
binPathWithArgs := fmt.Sprintf(`"%s" daemon`, crcBinPath)
// Get current user along with domain
u, err := user.Current()
if err != nil {
return fmt.Errorf("failed to get current user: %w", err)
}
taskContent, err := genDaemonTaskInstallTemplate(
version.GetCRCVersion(),
u.Username,
constants.Win32BackgroundLauncherPath(),
binPathWithArgs,
)
if err != nil {
return err
}
if _, stderr, err := powershell.Execute("Register-ScheduledTask", "-Xml", fmt.Sprintf(`'%s'`, taskContent), "-TaskName", constants.DaemonTaskName); err != nil {
return fmt.Errorf("failed to register %s task, %v: %s", constants.DaemonTaskName, err, stderr)
}
return nil
}
func removeDaemonTask() error {
// Return nil if the task does not exist
_, stderr, err := powershell.Execute("Get-ScheduledTask", "-TaskName", constants.DaemonTaskName)
if err != nil {
logging.Debugf("%s task is not installed: %v : %s", constants.DaemonTaskName, err, stderr)
return nil
}
if err := checkIfDaemonTaskRunning(); err == nil {
_, stderr, err := powershell.Execute("Stop-ScheduledTask", "-TaskName", constants.DaemonTaskName)
if err != nil {
logging.Debugf("unable to stop the %s task: %v : %s", constants.DaemonTaskName, err, stderr)
return err
}
}
if err := checkIfDaemonTaskInstalled(); err == nil || errors.Is(err, errOlderVersion) {
_, stderr, err := powershell.Execute("Unregister-ScheduledTask", "-TaskName", constants.DaemonTaskName, "-Confirm:$false")
if err != nil {
logging.Debugf("unable to unregister the %s task: %v : %s", constants.DaemonTaskName, err, stderr)
return err
}
}
return nil
}
func checkIfDaemonTaskRunning() error {
stdout, stderr, err := powershell.Execute(fmt.Sprintf(`(Get-ScheduledTask -TaskName "%s").State`, constants.DaemonTaskName))
if err != nil {
logging.Debugf("%s task is not running: %v : %s", constants.DaemonTaskName, err, stderr)
return err
}
if strings.TrimSpace(stdout) != "Running" {
return fmt.Errorf("expected %s task to be in 'Running' but got '%s'", constants.DaemonTaskName, stdout)
}
return nil
}
func fixDaemonTaskRunning() error {
if daemonRunning() {
if err := killDaemonProcess(); err != nil {
return err
}
}
_, stderr, err := powershell.Execute("Start-ScheduledTask", "-TaskName", constants.DaemonTaskName)
if err != nil {
logging.Debugf("unable to run the %s task: %v : %s", constants.DaemonTaskName, err, stderr)
return err
}
return waitForDaemonRunning()
}
func checkIfOlderTask() error {
stdout, stderr, err := powershell.Execute(fmt.Sprintf(`(Get-ScheduledTask -TaskName "%s").Version`, constants.DaemonTaskName))
if err != nil {
return fmt.Errorf("%s task is not running: %v : %s", constants.DaemonTaskName, err, stderr)
}
if strings.TrimSpace(stdout) != version.GetCRCVersion() {
return fmt.Errorf("%w but got '%s'", errOlderVersion, stdout)
}
return nil
}
func killDaemonProcessIfRunning() error {
if daemonRunning() {
if err := killDaemonProcess(); err != nil {
return err
}
}
return nil
}
func checkWin32BackgroundLauncherInstalled() error {
c := cache.NewWin32BackgroundLauncherCache()
return c.CheckVersion()
}
func fixWin32BackgroundLauncherInstalled() error {
c := cache.NewWin32BackgroundLauncherCache()
return c.EnsureIsCached()
}
func removeWin32BackgroundLauncher() error {
if version.IsInstaller() {
return nil
}
if crcos.FileExists(constants.Win32BackgroundLauncherPath()) {
return os.Remove(constants.Win32BackgroundLauncherPath())
}
return nil
}
|