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
|
// Copyright (c) 2018-2023, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package progress
import (
"context"
"io"
"github.com/sylabs/singularity/v4/pkg/sylog"
"github.com/vbauerster/mpb/v8"
"github.com/vbauerster/mpb/v8/decor"
)
func initProgressBar(totalSize int64) (*mpb.Progress, *mpb.Bar) {
p := mpb.New()
if totalSize > 0 {
return p, p.AddBar(totalSize,
mpb.PrependDecorators(
decor.Counters(decor.SizeB1024(0), "%.1f / %.1f"),
),
mpb.AppendDecorators(
decor.Percentage(),
decor.AverageSpeed(decor.SizeB1024(0), " % .1f "),
decor.AverageETA(decor.ET_STYLE_GO),
),
)
}
return p, p.AddBar(totalSize,
mpb.PrependDecorators(
decor.Current(decor.SizeB1024(0), "%.1f / ???"),
),
mpb.AppendDecorators(
decor.AverageSpeed(decor.SizeB1024(0), " % .1f "),
),
)
}
// See: https://ixday.github.io/post/golang-cancel-copy/
type readerFunc func(p []byte) (n int, err error)
func (rf readerFunc) Read(p []byte) (n int, err error) { return rf(p) }
// Callback is a function that provides progress information copying from a Reader to a Writer
type Callback func(int64, io.Reader, io.Writer) error
// BarCallback returns a progress bar callback unless e.g. --quiet or lower loglevel is set
func BarCallback(ctx context.Context) Callback {
if sylog.GetLevel() <= -1 {
// If we don't need a bar visible, we just copy data through the callback func
return func(totalSize int64, r io.Reader, w io.Writer) error {
_, err := CopyWithContext(ctx, w, r)
return err
}
}
return func(totalSize int64, r io.Reader, w io.Writer) error {
p, bar := initProgressBar(totalSize)
// create proxy reader
bodyProgress := bar.ProxyReader(r)
defer bodyProgress.Close()
written, err := CopyWithContext(ctx, w, bodyProgress)
if err != nil {
bar.Abort(true)
return err
}
// Must ensure bar is complete for a download with unknown size, or it will hang.
if totalSize <= 0 {
bar.SetTotal(written, true)
}
p.Wait()
return nil
}
}
func CopyWithContext(ctx context.Context, dst io.Writer, src io.Reader) (written int64, err error) {
// Copy will call the Reader and Writer interface multiple time, in order
// to copy by chunk (avoiding loading the whole file in memory).
// I insert the ability to cancel before read time as it is the earliest
// possible in the call process.
written, err = io.Copy(dst, readerFunc(func(p []byte) (int, error) {
// golang non-blocking channel: https://gobyexample.com/non-blocking-channel-operations
select {
// if context has been canceled
case <-ctx.Done():
// stop process and propagate "context canceled" error
return 0, ctx.Err()
default:
// otherwise just run default io.Reader implementation
return src.Read(p)
}
}))
return written, err
}
// DownloadBar is a progress bar that implements the scs-library-client ProgressBar interface.
type DownloadBar struct {
bar *mpb.Bar
p *mpb.Progress
}
func (dpb *DownloadBar) Init(contentLength int64) {
if sylog.GetLevel() <= -1 {
// we don't need a bar visible
return
}
dpb.p, dpb.bar = initProgressBar(contentLength)
}
func (dpb *DownloadBar) ProxyReader(r io.Reader) io.ReadCloser {
return dpb.bar.ProxyReader(r)
}
func (dpb *DownloadBar) IncrBy(n int) {
if dpb.bar == nil {
return
}
dpb.bar.IncrBy(n)
}
func (dpb *DownloadBar) Abort(drop bool) {
if dpb.bar == nil {
return
}
dpb.bar.Abort(drop)
}
func (dpb *DownloadBar) Wait() {
if dpb.bar == nil {
return
}
dpb.p.Wait()
}
// UploadBar is a progress bar that implements the scs-library-client UploadCallback interface.
type UploadBar struct {
progress *mpb.Progress
bar *mpb.Bar
r io.Reader
}
func (upb *UploadBar) InitUpload(totalSize int64, r io.Reader) {
if sylog.GetLevel() <= -1 {
// we don't need a bar visible
upb.r = r
return
}
upb.progress, upb.bar = initProgressBar(totalSize)
upb.r = upb.bar.ProxyReader(r)
}
func (upb *UploadBar) GetReader() io.Reader {
return upb.r
}
func (upb *UploadBar) Init(totalSize int64) {
if sylog.GetLevel() <= -1 {
// we don't need a bar visible
return
}
upb.progress, upb.bar = initProgressBar(totalSize)
}
func (upb *UploadBar) IncrBy(n int) {
if upb.bar == nil {
return
}
upb.bar.IncrBy(n)
}
func (upb *UploadBar) Terminate() {
if upb.bar == nil {
return
}
upb.bar.Abort(true)
}
func (upb *UploadBar) Finish() {
if upb.progress == nil {
return
}
// wait for our bar to complete and flush
upb.progress.Wait()
}
|
