More work on transfer kitten porting

This commit is contained in:
Kovid Goyal
2023-05-31 20:18:53 +05:30
parent 5c786c96e1
commit ff3232547d
4 changed files with 268 additions and 13 deletions

View File

@@ -163,9 +163,9 @@ func safe_string(x string) string {
return safe_string_pat().ReplaceAllLiteralString(x, ``) return safe_string_pat().ReplaceAllLiteralString(x, ``)
} }
func (self *FileTransmissionCommand) Serialize(prefix_with_osc_code ...bool) string { func (self FileTransmissionCommand) Serialize(prefix_with_osc_code ...bool) string {
ans := strings.Builder{} ans := strings.Builder{}
v := reflect.ValueOf(*self) v := reflect.ValueOf(self)
found := false found := false
if len(prefix_with_osc_code) > 0 && prefix_with_osc_code[0] { if len(prefix_with_osc_code) > 0 && prefix_with_osc_code[0] {
ans.WriteString(strconv.Itoa(kitty.FileTransferCode)) ans.WriteString(strconv.Itoa(kitty.FileTransferCode))

View File

@@ -3,18 +3,26 @@
package transfer package transfer
import ( import (
"bytes"
"compress/zlib"
"fmt" "fmt"
"io/fs" "io/fs"
"kitty" "kitty"
"kitty/tools/cli/markup"
"kitty/tools/tui"
"kitty/tools/tui/loop" "kitty/tools/tui/loop"
"kitty/tools/utils" "kitty/tools/utils"
"kitty/tools/utils/humanize"
"kitty/tools/utils/style"
"kitty/tools/wcswidth" "kitty/tools/wcswidth"
"os" "os"
"path/filepath" "path/filepath"
"strconv"
"strings" "strings"
"syscall" "syscall"
"time" "time"
"golang.org/x/exp/constraints"
"golang.org/x/exp/slices" "golang.org/x/exp/slices"
) )
@@ -32,8 +40,46 @@ const (
type FileHash struct{ dev, inode uint64 } type FileHash struct{ dev, inode uint64 }
type Compressor interface {
Compress(data []byte) []byte
Flush() []byte
}
type IdentityCompressor struct{}
func (self *IdentityCompressor) Compress(data []byte) []byte { return data }
func (self *IdentityCompressor) Flush() []byte { return nil }
type ZlibCompressor struct {
b bytes.Buffer
w zlib.Writer
}
func NewZlibCompressor() *ZlibCompressor {
ans := ZlibCompressor{}
ans.b.Grow(4096)
ans.w = *zlib.NewWriter(&ans.b)
return &ans
}
func (self *ZlibCompressor) Compress(data []byte) []byte {
_, err := self.w.Write(data)
if err != nil {
panic(err)
}
return utils.UnsafeStringToBytes(self.b.String())
}
func (self *ZlibCompressor) Flush() []byte {
self.w.Close()
return self.b.Bytes()
}
type File struct { type File struct {
file_hash FileHash file_hash FileHash
ttype TransmissionType
compression Compression
compressor Compressor
file_type FileType file_type FileType
file_id, hard_link_target string file_id, hard_link_target string
local_path, symbolic_link_target, expanded_local_path string local_path, symbolic_link_target, expanded_local_path string
@@ -306,7 +352,7 @@ type SendManager struct {
} }
func (self *SendManager) start_transfer() string { func (self *SendManager) start_transfer() string {
panic("TODO: Implement this") return FileTransmissionCommand{Action: Action_send, Bypass: self.bypass}.Serialize()
} }
func (self *SendManager) initialize() { func (self *SendManager) initialize() {
@@ -334,8 +380,9 @@ type SendHandler struct {
opts *Options opts *Options
files []*File files []*File
lp *loop.Loop lp *loop.Loop
ctx *markup.Context
transmit_started, file_metadata_sent bool transmit_started, file_metadata_sent bool
quite_after_write_code int quit_after_write_code int
check_paths_printed bool check_paths_printed bool
max_name_length int max_name_length int
progress_drawn bool progress_drawn bool
@@ -343,11 +390,154 @@ type SendHandler struct {
done_file_ids *utils.Set[string] done_file_ids *utils.Set[string]
transmit_ok_checked bool transmit_ok_checked bool
progress_update_timer loop.IdType progress_update_timer loop.IdType
spinner *tui.Spinner
}
func safe_divide[A constraints.Integer | constraints.Float, B constraints.Integer | constraints.Float](a A, b B) float64 {
if b == 0 {
return 0
}
return float64(a) / float64(b)
}
type Progress struct {
spinner_char string
bytes_so_far int64
total_bytes int64
secs_so_far float64
bytes_per_sec float64
is_complete bool
max_path_length int
}
func render_seconds(val time.Duration) (ans string) {
if val >= time.Second {
if val.Hours() > 24 {
days := val.Hours() / 24
if days > 99 {
ans = ``
} else {
ans = fmt.Sprintf(">%d days", int(days))
}
}
ans = val.String()
hr, rest, _ := strings.Cut(ans, `h`)
min, rest, _ := strings.Cut(rest, `m`)
secs, _, _ := strings.Cut(rest, ".")
return hr + `:` + min + `:` + secs
} else {
ans = "<1s"
}
if len(ans) < 8 {
ans = strings.Repeat(" ", 8-len(ans)) + ans
}
return
}
func render_progress_in_width(p Progress, ctx *markup.Context) string {
unit_style := ctx.Dim(`|`)
sep, trail, _ := strings.Cut(unit_style, "|")
var ratio, rate, eta string
if p.is_complete || p.bytes_so_far >= p.total_bytes {
ratio = humanize.Size(uint64(p.total_bytes), humanize.SizeOptions{Separator: sep})
rate = humanize.Size(uint64(safe_divide(float64(p.total_bytes), p.secs_so_far)), humanize.SizeOptions{Separator: sep}) + `/s`
eta = ctx.Green(render_seconds(time.Duration(float64(time.Second) * p.secs_so_far)))
} else {
tb := humanize.Size(p.total_bytes)
sval, _, _ := strings.Cut(tb, " ")
val, _ := strconv.ParseFloat(sval, 64)
ratio = format_number(val*safe_divide(p.bytes_so_far, p.total_bytes)) + `/` + strings.ReplaceAll(tb, ` `, sep)
}
}
func (self *SendHandler) render_progress(name string, p Progress) {
if p.spinner_char == "" {
p.spinner_char = " "
}
if p.is_complete {
p.bytes_so_far = p.total_bytes
}
p.max_path_length = self.max_name_length
self.lp.QueueWriteString(render_progress_in_width(p, self.ctx))
}
func (self *SendHandler) draw_progress() {
self.lp.StartAtomicUpdate()
defer self.lp.EndAtomicUpdate()
self.lp.AllowLineWrapping(false)
defer self.lp.AllowLineWrapping(true)
var sc string
for _, df := range self.done_files {
sc = self.ctx.Green(``)
if df.err_msg != "" {
sc = self.ctx.Err(``)
}
if df.file_type == FileType_regular {
self.draw_progress_for_current_file(df, sc, true)
} else {
self.lp.QueueWriteString(sc + ` ` + df.display_name + ` ` + self.ctx.Dim(self.ctx.Italic(df.file_type.String())))
}
self.lp.Println()
self.done_file_ids.Add(df.file_id)
}
self.done_files = nil
is_complete := self.quit_after_write_code > -1
if is_complete {
sc = self.ctx.Green(``)
if self.quit_after_write_code != 0 {
sc = self.ctx.Err(``)
}
} else {
sc = self.spinner.Tick()
}
now := time.Time()
if is_complete {
sz, _ := self.lp.ScreenSize()
self.lp.QueueWriteString(tui.RepeatChar(``, int(sz.WidthCells)))
} else {
af := self.manager.last_progress_file
if af == nil || self.done_file_ids.Has(af.file_id) {
if self.manager.has_rsync && !self.manager.has_transmitting {
self.lp.QueueWriteString(sc + ` Transferring rsync signatures...`)
} else {
self.lp.QueueWriteString(sc + ` Transferring metadata...`)
}
} else {
self.draw_progress_for_current_file(af, sc, false)
}
}
self.lp.Println()
if p := self.manager.progress_tracker; p.total_reported_progress > 0 {
self.render_progress(`Total`, Progress{
spinner_char: sc, bytes_so_far: p.total_reported_progress, total_bytes: p.total_bytes_to_transfer,
secs_so_far: now.Sub(p.started_at).Seconds(), is_complete: is_complete,
bytes_per_sec: safe_divide(p.transfered_stats_amt, p.transfered_stats_interval.Abs().Seconds()),
})
} else {
self.lp.QueueWriteString(`File data transfer has not yet started`)
}
self.lp.Println()
self.schedule_progress_update(self.spinner.Interval())
self.progress_drawn = true
}
func (self *SendHandler) erase_progress(timer_id loop.IdType) {
if self.progress_drawn {
self.progress_drawn = false
self.lp.MoveCursorVertically(-2)
self.lp.QueueWriteString("\r")
self.lp.ClearToEndOfScreen()
}
} }
func (self *SendHandler) refresh_progress(timer_id loop.IdType) (err error) { func (self *SendHandler) refresh_progress(timer_id loop.IdType) (err error) {
if !self.transmit_started {
return nil
}
self.progress_update_timer = 0 self.progress_update_timer = 0
panic("TODO: Implement this") self.erase_progress()
self.draw_progress()
return nil
} }
func (self *SendHandler) schedule_progress_update(delay time.Duration) { func (self *SendHandler) schedule_progress_update(delay time.Duration) {
@@ -379,16 +569,45 @@ func (self *SendHandler) send_payload(payload string) {
self.lp.QueueWriteString(self.manager.suffix) self.lp.QueueWriteString(self.manager.suffix)
} }
func (self *SendHandler) send_file_metadata() error { func (self *File) metadata_command(use_rsync bool) *FileTransmissionCommand {
panic("TODO: Implement this") if use_rsync && self.rsync_capable {
self.ttype = TransmissionType_rsync
}
if self.compression_capable {
self.compression = Compression_zlib
self.compressor = NewZlibCompressor()
} else {
self.compressor = &IdentityCompressor{}
}
return &FileTransmissionCommand{
Action: Action_file, Compression: self.compression, Ftype: self.file_type,
Name: self.remote_path, Permissions: self.permissions, Mtime: time.Duration(self.mtime.UnixNano()),
File_id: self.file_id, Ttype: self.ttype,
}
}
func (self *SendManager) send_file_metadata(send func(string)) {
for _, f := range self.files {
ftc := f.metadata_command(self.use_rsync)
send(ftc.Serialize())
}
}
func (self *SendHandler) send_file_metadata() {
if !self.file_metadata_sent {
self.file_metadata_sent = true
self.manager.send_file_metadata(self.send_payload)
}
} }
func (self *SendHandler) initialize() error { func (self *SendHandler) initialize() error {
self.manager.initialize() self.manager.initialize()
self.spinner = tui.NewSpinner("dots")
self.ctx = markup.New(true)
self.send_payload(self.manager.start_transfer()) self.send_payload(self.manager.start_transfer())
if self.opts.PermissionsBypass != "" { if self.opts.PermissionsBypass != "" {
// dont wait for permission, not needed with a bypass and avoids a roundtrip // dont wait for permission, not needed with a bypass and avoids a roundtrip
return self.send_file_metadata() self.send_file_metadata()
} }
return nil return nil
} }
@@ -400,7 +619,7 @@ func send_loop(opts *Options, files []*File) (err error) {
} }
handler := &SendHandler{ handler := &SendHandler{
opts: opts, files: files, lp: lp, quite_after_write_code: -1, opts: opts, files: files, lp: lp, quit_after_write_code: -1,
max_name_length: utils.Max(0, utils.Map(func(f *File) int { return wcswidth.Stringwidth(f.display_name) }, files)...), max_name_length: utils.Max(0, utils.Map(func(f *File) int { return wcswidth.Stringwidth(f.display_name) }, files)...),
progress_drawn: true, done_file_ids: utils.NewSet[string](), progress_drawn: true, done_file_ids: utils.NewSet[string](),
manager: &SendManager{ manager: &SendManager{

View File

@@ -17,6 +17,10 @@ type Spinner struct {
last_change_at time.Time last_change_at time.Time
} }
func (self Spinner) Interval() time.Duration {
return self.interval
}
func (self *Spinner) Tick() string { func (self *Spinner) Tick() string {
now := time.Now() now := time.Now()
if now.Sub(self.last_change_at) >= self.interval { if now.Sub(self.last_change_at) >= self.interval {

View File

@@ -3,6 +3,8 @@ package humanize
import ( import (
"fmt" "fmt"
"math" "math"
"golang.org/x/exp/constraints"
) )
// IEC Sizes. // IEC Sizes.
@@ -49,13 +51,43 @@ func humanize_bytes(s uint64, base float64, sizes []string, sep string) string {
// Bytes produces a human readable representation of an SI size. // Bytes produces a human readable representation of an SI size.
// Bytes(82854982) -> 83 MB // Bytes(82854982) -> 83 MB
func Bytes(s uint64) string { func Bytes(s uint64) string {
sizes := []string{"B", "kB", "MB", "GB", "TB", "PB", "EB"} return Size(s, SizeOptions{})
return humanize_bytes(s, 1000, sizes, " ")
} }
// IBytes produces a human readable representation of an IEC size. // IBytes produces a human readable representation of an IEC size.
// IBytes(82854982) -> 79 MiB // IBytes(82854982) -> 79 MiB
func IBytes(s uint64) string { func IBytes(s uint64) string {
sizes := []string{"B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB"} return Size(s, SizeOptions{Base: 1024})
return humanize_bytes(s, 1024, sizes, " ") }
type SizeOptions struct {
Separator string
Base int
}
func Size[T constraints.Integer | constraints.Float](s T, opts ...SizeOptions) string {
var o SizeOptions
prefix := ""
if len(opts) == 0 {
o = SizeOptions{}
} else {
o = opts[0]
}
if s < 0 {
prefix = "-"
}
if o.Separator == "" {
o.Separator = " "
}
if o.Base == 0 {
o.Base = 1000
}
var sizes []string
switch o.Base {
default:
sizes = []string{"B", "kB", "MB", "GB", "TB", "PB", "EB"}
case 1024:
sizes = []string{"B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB"}
}
return prefix + humanize_bytes(uint64(s), float64(o.Base), sizes, o.Separator)
} }