forked from deanishe/awgo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
workflow.go
760 lines (658 loc) · 23.1 KB
/
workflow.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
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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
//
// Copyright (c) 2016 Dean Jackson <[email protected]>
//
// MIT Licence. See http://opensource.org/licenses/MIT
//
package aw
import (
"errors"
"fmt"
"io"
"log"
"os"
"path/filepath"
"runtime/debug"
"time"
"git.deanishe.net/deanishe/awgo/fuzzy"
"git.deanishe.net/deanishe/awgo/util"
"os/exec"
)
// AwGoVersion is the semantic version number of this library.
const AwGoVersion = "0.7.1"
var (
startTime time.Time // Time execution started
// The workflow object operated on by top-level functions.
// It can be retrieved/replaced with DefaultWorkflow() and
// SetDefaultWorkflow() respectively.
wf *Workflow
// Flag, as we only want to set up logging once
// TODO: Better, more pluggable logging
logInitialized bool
)
// init creates the default Workflow.
func init() {
startTime = time.Now()
wf = New()
}
// Updater can check for and download & install newer versions of the workflow.
// There is a concrete implementation and documentation in subpackage "update".
type Updater interface {
UpdateInterval(time.Duration) // Set interval between checks
UpdateAvailable() bool // Return true if a newer version is available
CheckDue() bool // Return true if a check for a newer version is due
CheckForUpdate() error // Retrieve available releases, e.g. from a URL
Install() error // Install the latest version
}
// Option is a configuration option for Workflow. Pass one or more Options to
// New(). An Option returns its inverse (i.e. an Option that restores the
// previous value).
type Option func(wf *Workflow) Option
// options wraps multiple Options, allowing the application of their inverse
// via a single call to options.apply().
type options []Option
// apply configures Workflow with all options and returns a single Option
// to reverse all changes.
func (o options) apply(wf *Workflow) Option {
previous := make(options, len(o))
for i, opt := range o {
previous[i] = wf.Configure(opt)
}
return previous.apply
}
// HelpURL sets the link to your issues/page forum thread where users can
// ask for help. It is shown in the debugger/log if an error occurs. If no
// HelpURL is specified, the website specified in the main workflow setup
// dialog is shown instead (if one is set).
func HelpURL(URL string) Option {
return func(wf *Workflow) Option {
prev := wf.HelpURL
wf.HelpURL = URL
return HelpURL(prev)
}
}
// LogPrefix is the character printed to the debugger at the start of each run.
// Its purpose is to ensure that the first real log message is shown on its own
// line. It is only sent to Alfred's debugger, not the log file.
//
// Default: Purple Heart (\U0001F49C)
func LogPrefix(prefix string) Option {
return func(wf *Workflow) Option {
prev := wf.LogPrefix
wf.LogPrefix = prefix
return LogPrefix(prev)
}
}
// MagicPrefix sets the prefix for "magic" commands.
// If a user enters this prefix, AwGo takes control of the workflow and
// shows a list of matching magic commands to the user.
//
// Default: workflow:
func MagicPrefix(prefix string) Option {
return func(wf *Workflow) Option {
prev := wf.magicPrefix
wf.magicPrefix = prefix
return MagicPrefix(prev)
}
}
// MaxLogSize sets the size (in bytes) at which the workflow log is rotated.
// Default: 1 MiB
func MaxLogSize(bytes int) Option {
return func(wf *Workflow) Option {
prev := wf.MaxLogSize
wf.MaxLogSize = bytes
return MaxLogSize(prev)
}
}
// MaxResults is the maximum number of results to send to Alfred.
// 0 means send all results.
// Default: 0
func MaxResults(num int) Option {
return func(wf *Workflow) Option {
prev := wf.MaxResults
wf.MaxResults = num
return MaxResults(prev)
}
}
// TextErrors tells Workflow to print errors as text, not JSON.
// Set to true if output goes to a Notification.
func TextErrors(on bool) Option {
return func(wf *Workflow) Option {
prev := wf.TextErrors
wf.TextErrors = on
return TextErrors(prev)
}
}
// SortOptions sets the fuzzy sorting options for Workflow.Filter().
func SortOptions(opts ...fuzzy.Option) Option {
return func(wf *Workflow) Option {
prev := wf.SortOptions
wf.SortOptions = opts
return SortOptions(prev...)
}
}
// Update sets the updater for the Workflow.
func Update(updater Updater) Option {
return func(wf *Workflow) Option {
if updater != nil && wf.Version() == "" {
panic("can't set Updater as workflow has no version number")
}
prev := wf.Updater
wf.SetUpdater(updater)
return Update(prev)
}
}
// AddMagic registers magic actions with the Workflow.
func AddMagic(actions ...MagicAction) Option {
return func(wf *Workflow) Option {
for _, action := range actions {
wf.MagicActions.Register(action)
}
return RemoveMagic(actions...)
}
}
// RemoveMagic unregisters magic actions with Workflow.
func RemoveMagic(actions ...MagicAction) Option {
return func(wf *Workflow) Option {
for _, action := range actions {
delete(wf.MagicActions, action.Keyword())
}
return AddMagic(actions...)
}
}
// Workflow provides a simple, consolidated API for building Script
// Filters and talking to Alfred.
//
// As a rule, you should create a Workflow in main() and call your main
// entry-point via Workflow.Run(). Use Workflow.NewItem() to create new
// feedback Items and Workflow.SendFeedback() to send the results to
// Alfred.
//
// If you don't need to customise Workflow's behaviour in any way, you
// can use the package-level functions, which call the corresponding
// methods on the default Workflow object.
//
// See the examples/ subdirectory for some full examples of workflows.
type Workflow struct {
// The response that will be sent to Alfred. Workflow provides
// convenience wrapper methods, so you don't normally have to
// interact with this directly.
Feedback *Feedback
// Workflow execution environment. Contains Alfred and workflow parameters
// extracted from the environment variables exported by Alfred.
// See Context for documentation.
Ctx *Context
// HelpURL is a link to your issues page/forum thread where users can
// report bugs. It is shown in the debugger if the workflow crashes.
// If no HelpURL is specified, the Website specified in the main
// workflow setup dialog will be shown (if one is set).
HelpURL string
// LogPrefix is the character printed to the log at the start of each run.
// Its purpose is to ensure the first real log message starts on its own line,
// instead of sharing a line with Alfred's blurb in the debugger. This is only
// printed to STDERR (i.e. Alfred's debugger), not written to the log file.
// Default: Purple Heart (\U0001F49C)
LogPrefix string
// MaxLogSize is the size (in bytes) at which the workflow log is rotated.
// Default: 1 MiB
MaxLogSize int
// MaxResults is the maximum number of results to send to Alfred.
// 0 means send all results.
// Default: 0
MaxResults int
// SortOptions are options for fuzzy sorting.
SortOptions []fuzzy.Option
// TextErrors tells Workflow to print errors as text, not JSON
// Set to true if output goes to a Notification.
TextErrors bool
// Cache is a Cache pointing to the workflow's cache directory.
Cache *Cache
// Data is a Cache pointing to the workflow's data directory.
Data *Cache
// Session is a cache that stores session-scoped data. These data
// persist until the user closes Alfred or runs a different workflow.
Session *Session
// debug is set from Alfred's `alfred_debug` environment variable.
debug bool
// version holds value set by user or read from environment variable or info.plist.
version string
// Updater fetches updates for the workflow.
Updater Updater
magicPrefix string // Overrides DefaultMagicPrefix for magic actions.
// MagicActions contains the magic actions registered for this workflow.
// It is set to DefaultMagicActions by default.
MagicActions MagicActions
// Set from environment
bundleID string
name string
cacheDir string
dataDir string
workflowDir string
sessionID string
}
// New creates and initialises a new Workflow, passing any Options to Workflow.Configure().
//
// For available options, see the documentation for the Option type and the
// following functions.
func New(opts ...Option) *Workflow {
wf := &Workflow{
Ctx: NewContext(),
Feedback: &Feedback{},
LogPrefix: "\U0001F49C", // Purple heart
MaxLogSize: 1048576, // 1 MiB
MaxResults: 0, // Send all results to Alfred
MagicActions: MagicActions{},
SortOptions: []fuzzy.Option{},
}
wf.MagicActions.Register(DefaultMagicActions...)
wf.Configure(opts...)
wf.Cache = NewCache(wf.CacheDir())
wf.Data = NewCache(wf.DataDir())
wf.Session = NewSession(wf.CacheDir(), wf.SessionID())
wf.initializeLogging()
return wf
}
// --------------------------------------------------------------------
// Initialisation methods
// Configure applies one or more Options to Workflow. The returned Option reverts
// all Options passed to Configure.
func Configure(opts ...Option) (previous Option) { return wf.Configure(opts...) }
func (wf *Workflow) Configure(opts ...Option) (previous Option) {
prev := options{}
for _, opt := range opts {
prev = append(prev, opt(wf))
}
return prev.apply
}
// initializeLogging ensures future log messages are written to
// workflow's log file.
func (wf *Workflow) initializeLogging() {
if logInitialized { // All Workflows use the same global logger
return
}
// Rotate log file if larger than MaxLogSize
fi, err := os.Stat(wf.LogFile())
if err == nil {
if fi.Size() >= int64(wf.MaxLogSize) {
new := wf.LogFile() + ".1"
if err := os.Rename(wf.LogFile(), new); err != nil {
fmt.Fprintf(os.Stderr, "Error rotating log: %v", err)
}
fmt.Fprintln(os.Stderr, "Rotated log")
}
}
// Open log file
file, err := os.OpenFile(wf.LogFile(),
os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0600)
if err != nil {
wf.Fatal(fmt.Sprintf("Couldn't open log file %s : %v",
wf.LogFile(), err))
}
// Attach logger to file
multi := io.MultiWriter(file, os.Stderr)
log.SetOutput(multi)
// log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile)
if wf.Ctx.Debug {
log.SetFlags(log.Ltime | log.Lshortfile)
} else {
log.SetFlags(log.Ltime)
}
logInitialized = true
}
// --------------------------------------------------------------------
// API methods
// Debug returns true if Alfred's debugger is open.
func Debug() bool { return wf.debug }
func (wf *Workflow) Debug() bool { return wf.debug }
// BundleID returns the workflow's bundle ID. This library will not
// work without a bundle ID, which is set in info.plist.
func BundleID() string { return wf.BundleID() }
func (wf *Workflow) BundleID() string {
if wf.Ctx.BundleID == "" {
wf.Fatal("No bundle ID set. You *must* set a bundle ID to use AwGo.")
}
return wf.Ctx.BundleID
}
// Name returns the workflow's name as specified in info.plist.
func Name() string { return wf.Name() }
func (wf *Workflow) Name() string { return wf.Ctx.Name }
// Version returns the workflow's version from info.plist.
func Version() string { return wf.Version() }
func (wf *Workflow) Version() string { return wf.Ctx.WorkflowVersion }
// SetVersion sets the workflow's version string.
func SetVersion(v string) { wf.SetVersion(v) }
func (wf *Workflow) SetVersion(v string) { wf.version = v }
// Dir returns the path to the workflow's root directory.
func Dir() string { return wf.Dir() }
func (wf *Workflow) Dir() string {
if wf.workflowDir == "" {
dir, err := util.FindWorkflowRoot()
if err != nil {
panic(err)
// wf.FatalError(err)
}
wf.workflowDir = dir
}
return wf.workflowDir
}
// Args returns command-line arguments passed to the program.
// It intercepts "magic args" and runs the corresponding actions, terminating
// the workflow.
// See MagicAction for full documentation.
func (wf *Workflow) Args() []string {
prefix := DefaultMagicPrefix
if wf.magicPrefix != "" {
prefix = wf.magicPrefix
}
return wf.MagicActions.Args(os.Args[1:], prefix)
}
// --------------------------------------------------------------------
// Cache & Data
// CacheDir returns the path to the workflow's cache directory.
// The directory will be created if it does not already exist.
func CacheDir() string { return wf.CacheDir() }
func (wf *Workflow) CacheDir() string {
if wf.cacheDir == "" { // Really old version of Alfred with no envvars?
wf.cacheDir = os.ExpandEnv(fmt.Sprintf(
"$HOME/Library/Caches/com.runningwithcrayons.Alfred-3/Workflow Data/%s",
wf.BundleID()))
}
return util.EnsureExists(wf.cacheDir)
}
// OpenCache opens the workflow's cache directory in the default application (usually Finder).
func OpenCache() error { return wf.OpenCache() }
func (wf *Workflow) OpenCache() error {
util.EnsureExists(wf.DataDir())
cmd := exec.Command("open", wf.CacheDir())
return cmd.Run()
}
// ClearCache deletes all files from the workflow's cache directory.
func ClearCache() error { return wf.ClearCache() }
func (wf *Workflow) ClearCache() error {
return util.ClearDirectory(wf.CacheDir())
}
// DataDir returns the path to the workflow's data directory.
// The directory will be created if it does not already exist.
func DataDir() string { return wf.DataDir() }
func (wf *Workflow) DataDir() string {
if wf.dataDir == "" { // Really old version of Alfred with no envvars?
wf.dataDir = os.ExpandEnv(fmt.Sprintf(
"$HOME/Library/Application Support/Alfred 3/Workflow Data/%s",
wf.BundleID()))
}
return util.EnsureExists(wf.dataDir)
}
// OpenData opens the workflow's data directory in the default application (usually Finder).
func OpenData() error { return wf.OpenData() }
func (wf *Workflow) OpenData() error {
cmd := exec.Command("open", wf.DataDir())
return cmd.Run()
}
// ClearData deletes all files from the workflow's cache directory.
func ClearData() error { return wf.ClearData() }
func (wf *Workflow) ClearData() error {
return util.ClearDirectory(wf.DataDir())
}
// SessionID returns the session ID for this run of the workflow. This is used
// internally for session-scoped caching.
func SessionID() string { return wf.SessionID() }
func (wf *Workflow) SessionID() string {
if wf.sessionID == "" {
ev := os.Getenv("AW_SESSION_ID")
if ev != "" {
wf.sessionID = ev
} else {
wf.sessionID = NewSessionID()
wf.Var("AW_SESSION_ID", wf.sessionID)
}
}
return wf.sessionID
}
// Reset deletes all workflow data (cache and data directories).
func Reset() error { return wf.Reset() }
func (wf *Workflow) Reset() error {
errs := []error{}
if err := wf.ClearCache(); err != nil {
errs = append(errs, err)
}
if err := wf.ClearData(); err != nil {
errs = append(errs, err)
}
if len(errs) > 0 {
return errs[0]
}
return nil
}
// LogFile returns the path to the workflow's log file.
func LogFile() string { return wf.LogFile() }
func (wf *Workflow) LogFile() string {
return filepath.Join(wf.CacheDir(), fmt.Sprintf("%s.log", wf.BundleID()))
}
// OpenLog opens the workflow's logfile in the default application (usually Console.app).
func OpenLog() error { return wf.OpenLog() }
func (wf *Workflow) OpenLog() error {
if !util.PathExists(wf.LogFile()) {
log.Println("Creating log file...")
}
cmd := exec.Command("open", wf.LogFile())
return cmd.Run()
}
// --------------------------------------------------------------------
// Feedback
// Rerun tells Alfred to re-run the Script Filter after `secs` seconds.
func Rerun(secs float64) *Workflow { return wf.Rerun(secs) }
func (wf *Workflow) Rerun(secs float64) *Workflow {
wf.Feedback.Rerun(secs)
return wf
}
// Vars returns the workflow variables set on Workflow.Feedback.
// See Feedback.Vars() for more information.
func Vars() map[string]string { return wf.Vars() }
func (wf *Workflow) Vars() map[string]string {
return wf.Feedback.Vars()
}
// Var sets the value of workflow variable k on Workflow.Feedback to v.
// See Feedback.Var() for more information.
func Var(k, v string) *Workflow { return wf.Var(k, v) }
func (wf *Workflow) Var(k, v string) *Workflow {
wf.Feedback.Var(k, v)
return wf
}
// NewItem adds and returns a new feedback Item.
// See Feedback.NewItem() for more information.
func NewItem(title string) *Item { return wf.NewItem(title) }
func (wf *Workflow) NewItem(title string) *Item {
return wf.Feedback.NewItem(title)
}
// NewFileItem adds and returns a new feedback Item pre-populated from path.
// See Feedback.NewFileItem() for more information.
func NewFileItem(path string) *Item { return wf.NewFileItem(path) }
func (wf *Workflow) NewFileItem(path string) *Item {
return wf.Feedback.NewFileItem(path)
}
// NewWarningItem adds and returns a new Feedback Item with the system
// warning icon (exclamation mark on yellow triangle).
func NewWarningItem(title, subtitle string) *Item { return wf.NewWarningItem(title, subtitle) }
func (wf *Workflow) NewWarningItem(title, subtitle string) *Item {
return wf.Feedback.NewItem(title).
Subtitle(subtitle).
Icon(IconWarning)
}
// IsEmpty returns true if Workflow contains no items.
func IsEmpty() bool { return wf.IsEmpty() }
func (wf *Workflow) IsEmpty() bool { return len(wf.Feedback.Items) == 0 }
// Filter fuzzy-sorts feedback Items against query and deletes Items that don't match.
func Filter(query string) []*fuzzy.Result { return wf.Filter(query) }
func (wf *Workflow) Filter(query string) []*fuzzy.Result {
return wf.Feedback.Filter(query, wf.SortOptions...)
}
// Run runs your workflow function, catching any errors.
// If the workflow panics, Run rescues and displays an error
// message in Alfred.
func Run(fn func()) { wf.Run(fn) }
func (wf *Workflow) Run(fn func()) {
var vstr string
if wf.Version() != "" {
vstr = fmt.Sprintf("%s/%v", wf.Name(), wf.Version())
} else {
vstr = wf.Name()
}
vstr = fmt.Sprintf(" %s (AwGo/%v) ", vstr, AwGoVersion)
// Print right after Alfred's introductory blurb in the debugger.
// Alfred strips whitespace.
if wf.LogPrefix != "" {
fmt.Fprintln(os.Stderr, wf.LogPrefix)
}
log.Println(util.Pad(vstr, "-", 50))
// Catch any `panic` and display an error in Alfred.
// Fatal(msg) will terminate the process (via log.Fatal).
defer func() {
if r := recover(); r != nil {
log.Println(util.Pad(" FATAL ERROR ", "-", 50))
log.Printf("%s : %s", r, debug.Stack())
log.Println(util.Pad(" END STACK TRACE ", "-", 50))
// log.Printf("Recovered : %x", r)
err, ok := r.(error)
if ok {
wf.outputErrorMsg(err.Error())
}
wf.outputErrorMsg(fmt.Sprintf("%v", r))
}
}()
// Call the workflow's main function.
fn()
finishLog(false)
}
// FatalError displays an error message in Alfred, then calls log.Fatal(),
// terminating the workflow.
func FatalError(err error) { wf.FatalError(err) }
func (wf *Workflow) FatalError(err error) { wf.Fatal(err.Error()) }
// Fatal displays an error message in Alfred, then calls log.Fatal(),
// terminating the workflow.
func Fatal(msg string) { wf.Fatal(msg) }
func (wf *Workflow) Fatal(msg string) { wf.outputErrorMsg(msg) }
// Fatalf displays an error message in Alfred, then calls log.Fatal(),
// terminating the workflow.
func Fatalf(format string, args ...interface{}) { wf.Fatalf(format, args...) }
func (wf *Workflow) Fatalf(format string, args ...interface{}) {
wf.Fatal(fmt.Sprintf(format, args...))
}
// Warn displays a warning message in Alfred immediately. Unlike
// FatalError()/Fatal(), this does not terminate the workflow,
// but you can't send any more results to Alfred.
func Warn(title, subtitle string) *Workflow { return wf.Warn(title, subtitle) }
func (wf *Workflow) Warn(title, subtitle string) *Workflow {
wf.Feedback.Clear()
wf.NewItem(title).
Subtitle(subtitle).
Icon(IconWarning)
return wf.SendFeedback()
}
// WarnEmpty adds a warning item to feedback if there are no other items.
func WarnEmpty(title, subtitle string) { wf.WarnEmpty(title, subtitle) }
func (wf *Workflow) WarnEmpty(title, subtitle string) {
if wf.IsEmpty() {
wf.Warn(title, subtitle)
}
}
// SendFeedback generates and sends the JSON response to Alfred.
// The JSON is output to STDOUT. At this point, Alfred considers your
// workflow complete; sending further responses will have no effect.
func SendFeedback() { wf.SendFeedback() }
func (wf *Workflow) SendFeedback() *Workflow {
// Truncate Items if MaxResults is set
if wf.MaxResults > 0 && len(wf.Feedback.Items) > wf.MaxResults {
wf.Feedback.Items = wf.Feedback.Items[0:wf.MaxResults]
}
if err := wf.Feedback.Send(); err != nil {
log.Fatalf("Error generating JSON : %v", err)
}
return wf
}
// --------------------------------------------------------------------
// Updating
// SetUpdater sets an updater for the workflow.
func SetUpdater(u Updater) { wf.SetUpdater(u) }
func (wf *Workflow) SetUpdater(u Updater) {
wf.Updater = u
wf.MagicActions.Register(&updateMagic{wf.Updater})
}
// UpdateCheckDue returns true if an update is available.
func UpdateCheckDue() bool { return wf.UpdateCheckDue() }
func (wf *Workflow) UpdateCheckDue() bool {
if wf.Updater == nil {
log.Println("No updater configured")
return false
}
return wf.Updater.CheckDue()
}
// CheckForUpdate retrieves and caches the list of available releases.
func CheckForUpdate() error { return wf.CheckForUpdate() }
func (wf *Workflow) CheckForUpdate() error {
if wf.Updater == nil {
return errors.New("No updater configured")
}
return wf.Updater.CheckForUpdate()
}
// UpdateAvailable returns true if a newer version is available to install.
func UpdateAvailable() bool { return wf.UpdateAvailable() }
func (wf *Workflow) UpdateAvailable() bool {
if wf.Updater == nil {
log.Println("No updater configured")
return false
}
return wf.Updater.UpdateAvailable()
}
// InstallUpdate downloads and installs the latest version of the workflow.
func InstallUpdate() error { return wf.InstallUpdate() }
func (wf *Workflow) InstallUpdate() error {
if wf.Updater == nil {
return errors.New("No updater configured")
}
return wf.Updater.Install()
}
// --------------------------------------------------------------------
// Helper methods
// outputErrorMsg prints and logs error, then exits process.
func (wf *Workflow) outputErrorMsg(msg string) {
if wf.TextErrors {
fmt.Print(msg)
} else {
wf.Feedback.Clear()
wf.NewItem(msg).Icon(IconError)
wf.SendFeedback()
}
log.Printf("[ERROR] %s", msg)
// Show help URL or website URL
if wf.HelpURL != "" {
log.Printf("Get help at %s", wf.HelpURL)
}
finishLog(true)
}
// awDataDir is the directory for AwGo's own data.
func awDataDir() string { return wf.awDataDir() }
func (wf *Workflow) awDataDir() string {
return util.EnsureExists(filepath.Join(wf.DataDir(), "_aw"))
}
// awCacheDir is the directory for AwGo's own cache.
func awCacheDir() string { return wf.awCacheDir() }
func (wf *Workflow) awCacheDir() string {
return util.EnsureExists(filepath.Join(wf.CacheDir(), "_aw"))
}
// --------------------------------------------------------------------
// Package-level only
// finishLog outputs the workflow duration
func finishLog(fatal bool) {
elapsed := time.Now().Sub(startTime)
s := util.Pad(fmt.Sprintf(" %s ", util.ReadableDuration(elapsed)), "-", 50)
if fatal {
log.Fatalln(s)
} else {
log.Println(s)
}
}
// DefaultWorkflow returns the Workflow object used by the
// package-level functions.
func DefaultWorkflow() *Workflow { return wf }
// SetDefaultWorkflow changes the Workflow object used by the
// package-level functions.
func SetDefaultWorkflow(w *Workflow) { wf = w }