-
Notifications
You must be signed in to change notification settings - Fork 54
/
launch.go
496 lines (411 loc) · 12.2 KB
/
launch.go
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
package launch
import (
"fmt"
"os"
"path/filepath"
"time"
"github.com/itchio/httpkit/neterr"
"github.com/itchio/httpkit/progress"
"github.com/itchio/ox"
"github.com/itchio/pelican"
goerrors "errors"
"crawshaw.io/sqlite"
"github.com/itchio/butler/butlerd"
"github.com/itchio/butler/butlerd/messages"
"github.com/itchio/butler/cmd/operate"
"github.com/itchio/butler/endpoints/launch/manifest"
"github.com/itchio/butler/installer"
"github.com/itchio/butler/installer/bfs"
"github.com/itchio/butler/manager"
"github.com/itchio/dash"
itchio "github.com/itchio/go-itchio"
"github.com/pkg/errors"
)
var ErrCandidateDisappeared = goerrors.New("candidate disappeared from disk!")
func Register(router *butlerd.Router) {
messages.Launch.Register(router, Launch)
}
func Launch(rc *butlerd.RequestContext, params butlerd.LaunchParams) (*butlerd.LaunchResult, error) {
consumer := rc.Consumer
cave := operate.ValidateCave(rc, params.CaveID)
var installFolder string
rc.WithConn(func(conn *sqlite.Conn) {
installFolder = cave.GetInstallFolder(conn)
})
_, err := os.Stat(installFolder)
if err != nil && os.IsNotExist(err) {
return nil, &butlerd.RpcError{
Code: int64(butlerd.CodeInstallFolderDisappeared),
Message: fmt.Sprintf("Could not find install folder (%s)", installFolder),
}
}
game := cave.Game
upload := cave.Upload
build := cave.Build
verdict := cave.GetVerdict()
// these credentials will be used for prereqs, etc., we don't want
// a game-specific download key here
var access *operate.GameAccess
rc.WithConn(func(conn *sqlite.Conn) {
access = operate.AccessForGameID(conn, game.ID).OnlyAPIKey()
})
runtime := ox.CurrentRuntime()
consumer.Infof("→ Launching %s", operate.GameToString(game))
consumer.Infof(" on runtime %s", runtime)
consumer.Infof(" (%s) is our install folder", installFolder)
consumer.Infof("Passed:")
operate.LogUpload(consumer, upload, build)
receiptIn, err := bfs.ReadReceipt(installFolder)
if err != nil {
return nil, errors.WithStack(err)
}
receiptSaidOtherwise := false
if receiptIn != nil {
if receiptIn.Upload != nil {
if upload == nil || upload.ID != receiptIn.Upload.ID {
receiptSaidOtherwise = true
upload = receiptIn.Upload
}
if receiptIn.Build != nil {
if build == nil || build.ID != receiptIn.Build.ID {
receiptSaidOtherwise = true
build = receiptIn.Build
}
}
}
}
if receiptSaidOtherwise {
consumer.Warnf("Receipt had different data, switching to:")
operate.LogUpload(consumer, upload, build)
}
var fullTargetPath string
var strategy = LaunchStrategyUnknown
var candidate *dash.Candidate
var manifestAction *butlerd.Action
appManifest, err := manifest.Read(installFolder)
if err != nil {
return nil, errors.WithStack(err)
}
pickManifestAction := func() error {
var err error
if appManifest == nil {
consumer.Infof("No manifest found at (%s)", manifest.Path(installFolder))
return nil
}
actions := manifest.ListActions(appManifest, runtime)
if len(actions) == 0 {
consumer.Warnf("Had manifest, but no actions available (for this platform at least)")
return nil
}
if len(actions) == 1 {
manifestAction = actions[0]
} else {
r, err := messages.PickManifestAction.Call(rc, butlerd.PickManifestActionParams{
Actions: actions,
})
if err != nil {
return errors.WithStack(err)
}
if r.Index < 0 {
return errors.WithStack(butlerd.CodeOperationAborted)
}
manifestAction = actions[r.Index]
}
if manifestAction == nil {
consumer.Warnf("No manifest action picked")
return nil
}
// is it a path?
res, err := DetermineStrategy(consumer, runtime, installFolder, manifestAction)
if err != nil {
return errors.WithStack(err)
}
strategy = res.Strategy
fullTargetPath = res.FullTargetPath
candidate = res.Candidate
return nil
}
err = pickManifestAction()
if err != nil {
return nil, errors.WithStack(err)
}
filterSetupExes := func(candidatesIn []*dash.Candidate) []*dash.Candidate {
var candidatesOut []*dash.Candidate
for _, c := range candidatesIn {
exclude := false
switch c.Flavor {
case dash.FlavorNativeWindows:
{
err := func() error {
f, err := os.Open(filepath.Join(installFolder, c.Path))
if err != nil {
return errors.WithStack(err)
}
defer f.Close()
peInfo, err := pelican.Probe(f, &pelican.ProbeParams{
Consumer: consumer,
})
if err != nil {
return errors.WithStack(err)
}
if peInfo.RequiresElevation() {
exclude = true
return nil
}
if peInfo.AssemblyInfo == nil && installer.HasSuspiciouslySetupLikeName(filepath.Base(c.Path)) {
exclude = false
return nil
}
return nil
}()
if err != nil {
consumer.Warnf("Could not filter elevated exes: %+v", err)
return candidatesIn
}
}
}
if !exclude {
candidatesOut = append(candidatesOut, c)
}
}
return candidatesOut
}
filterCandidates := func(candidatesIn []*dash.Candidate) []*dash.Candidate {
if len(candidatesIn) <= 1 {
return candidatesIn
}
var nativeFlavor dash.Flavor
var nativeArch dash.Arch
switch runtime.Platform {
case ox.PlatformWindows:
nativeFlavor = dash.FlavorNativeWindows
case ox.PlatformLinux:
nativeFlavor = dash.FlavorNativeLinux
}
if runtime.Is64 {
nativeArch = dash.ArchAmd64
} else {
nativeArch = dash.Arch386
}
for _, c := range candidatesIn {
if c.Flavor != nativeFlavor {
consumer.Infof("Not filtering candidates, we found non-native (%s) flavor", c.Flavor)
return candidatesIn
}
}
hasNativeArch := false
for _, c := range candidatesIn {
if c.Arch == nativeArch {
hasNativeArch = true
break
}
}
if !hasNativeArch {
consumer.Infof("Not filtering candidates, none of them are native arch (%s)", nativeArch)
return candidatesIn
}
var candidatesOut []*dash.Candidate
consumer.Infof("Filtering %d candidates by preferring native arch (%s)", len(candidatesIn), nativeArch)
for _, c := range candidatesIn {
if c.Arch == nativeArch {
candidatesOut = append(candidatesOut, c)
}
}
return candidatesOut
}
pickFromVerdict := func() error {
consumer.Infof("→ Using verdict: %s", verdict)
candidates := filterCandidates(verdict.Candidates)
numCandidatesEliminated := len(verdict.Candidates) - len(candidates)
if numCandidatesEliminated > 0 {
consumer.Infof("Eliminated %d candidates via filtering", numCandidatesEliminated)
}
if len(candidates) >= 0 {
nonSetupCandidates := filterSetupExes(verdict.Candidates)
numCandidatesEliminated := len(candidates) - len(nonSetupCandidates)
if numCandidatesEliminated > 0 {
consumer.Infof("Eliminated %d candidates via setup filtering", numCandidatesEliminated)
candidates = nonSetupCandidates
}
}
switch len(candidates) {
case 0:
return errors.WithStack(butlerd.CodeNoLaunchCandidates)
case 1:
candidate = candidates[0]
default:
fakeActions := []*butlerd.Action{}
for _, c := range candidates {
name := fmt.Sprintf("%s (%s)", c.Path, progress.FormatBytes(c.Size))
fakeActions = append(fakeActions, &butlerd.Action{
Name: name,
Path: c.Path,
})
}
r, err := messages.PickManifestAction.Call(rc, butlerd.PickManifestActionParams{
Actions: fakeActions,
})
if err != nil {
return errors.WithStack(err)
}
if r.Index < 0 {
return errors.WithStack(butlerd.CodeOperationAborted)
}
candidate = candidates[r.Index]
}
fullPath := filepath.Join(installFolder, candidate.Path)
_, err := os.Stat(fullPath)
if err != nil {
return errors.WithStack(err)
}
fullTargetPath = fullPath
return nil
}
if upload != nil {
switch upload.Type {
case "soundtrack", "book", "video", "documentation", "mod", "audio_assets", "graphical_assets", "sourcecode":
consumer.Infof("Forcing shell strategy because upload is of type (%s)", upload.Type)
fullTargetPath = installFolder
strategy = LaunchStrategyShell
}
}
if fullTargetPath == "" {
consumer.Infof("Switching to verdict!")
if verdict == nil {
consumer.Infof("No verdict, configuring now")
newVerdict, err := manager.Configure(consumer, installFolder, runtime)
if err != nil {
return nil, errors.WithStack(err)
}
verdict = newVerdict
cave.SetVerdict(verdict)
rc.WithConn(cave.Save)
err = pickFromVerdict()
if err != nil {
return nil, errors.WithStack(err)
}
} else {
// pick from cached verdict
err = pickFromVerdict()
if err != nil {
redoReason := ""
if errors.Cause(err) == ErrCandidateDisappeared {
redoReason = "Candidate disappeared!"
} else if errors.Cause(err) == butlerd.CodeNoLaunchCandidates {
redoReason = "No candidates!"
}
if redoReason != "" {
consumer.Warnf("%s Re-configuring...", redoReason)
newVerdict, err := manager.Configure(consumer, installFolder, runtime)
if err != nil {
return nil, errors.WithStack(err)
}
verdict = newVerdict
cave.SetVerdict(verdict)
rc.WithConn(cave.Save)
err = pickFromVerdict()
if err != nil {
return nil, errors.WithStack(err)
}
} else {
return nil, errors.WithStack(err)
}
}
}
}
if fullTargetPath == "" {
consumer.Warnf("No target from manifest or verdict, falling back to shell strategy")
fullTargetPath = "."
strategy = LaunchStrategyShell
}
if strategy == LaunchStrategyUnknown {
if candidate == nil {
err := fmt.Errorf("could not determine launch strategy for %s", fullTargetPath)
return nil, errors.WithStack(err)
}
strategy = flavorToStrategy(candidate.Flavor)
}
consumer.Infof("→ Using strategy (%s)", strategy)
consumer.Infof(" (%s) is our target", fullTargetPath)
launcher := launchers[strategy]
if launcher == nil {
err := fmt.Errorf("no launcher for strategy (%s)", strategy)
return nil, errors.WithStack(err)
}
var args = []string{}
var env = make(map[string]string)
if manifestAction != nil {
args = append(args, manifestAction.Args...)
err = requestAPIKeyIfNecessary(rc, manifestAction, game, access, env)
if err != nil {
return nil, errors.WithMessage(err, "While requesting API key")
}
}
sandbox := params.Sandbox
if manifestAction != nil && manifestAction.Sandbox {
consumer.Infof("Enabling sandbox because of manifest opt-in")
sandbox = true
}
launcherParams := LauncherParams{
RequestContext: rc,
Ctx: rc.Ctx,
FullTargetPath: fullTargetPath,
Candidate: candidate,
AppManifest: appManifest,
Action: manifestAction,
Sandbox: sandbox,
Args: args,
Env: env,
PrereqsDir: params.PrereqsDir,
ForcePrereqs: params.ForcePrereqs,
Access: access,
InstallFolder: installFolder,
Runtime: runtime,
RecordPlayTime: func(playTime time.Duration) error {
defer func() {
if e := recover(); e != nil {
consumer.Warnf("Could not record play time: %s", e)
}
}()
cave.RecordPlayTime(playTime)
rc.WithConn(cave.Save)
return nil
},
}
cave.Touch()
rc.WithConn(cave.Save)
err = launcher.Do(launcherParams)
if err != nil {
return nil, errors.WithStack(err)
}
return &butlerd.LaunchResult{}, nil
}
func requestAPIKeyIfNecessary(rc *butlerd.RequestContext, manifestAction *butlerd.Action, game *itchio.Game, access *operate.GameAccess, env map[string]string) error {
consumer := rc.Consumer
if manifestAction.Scope == "" {
// nothing to do
return nil
}
const onlyPermittedScope = "profile:me"
if manifestAction.Scope != onlyPermittedScope {
err := fmt.Errorf("Game asked for scope (%s), asking for permission is unimplemented for now", manifestAction.Scope)
return errors.WithStack(err)
}
client := rc.Client(access.APIKey)
res, err := client.Subkey(itchio.SubkeyParams{
GameID: game.ID,
Scope: manifestAction.Scope,
})
if err != nil {
if neterr.IsNetworkError(err) {
consumer.Infof("No Internet connection, integration API won't be available")
env["ITCHIO_OFFLINE_MODE"] = "1"
return nil
}
return errors.WithStack(err)
}
consumer.Infof("Got subkey (%d chars, expires %s)", len(res.Key), res.ExpiresAt)
env["ITCHIO_API_KEY"] = res.Key
env["ITCHIO_API_KEY_EXPIRES_AT"] = res.ExpiresAt
return nil
}