// Package ncdu implements a text based user interface for exploring a remote //go:build !plan9 && !solaris && !js // +build !plan9,!solaris,!js package ncdu import ( "context" "fmt" "path" "reflect" "sort" "strings" "github.com/atotto/clipboard" runewidth "github.com/mattn/go-runewidth" termbox "github.com/nsf/termbox-go" "github.com/rclone/rclone/cmd" "github.com/rclone/rclone/cmd/ncdu/scan" "github.com/rclone/rclone/fs" "github.com/rclone/rclone/fs/fspath" "github.com/rclone/rclone/fs/operations" "github.com/spf13/cobra" ) func init() { cmd.Root.AddCommand(commandDefinition) } var commandDefinition = &cobra.Command{ Use: "ncdu remote:path", Short: `Explore a remote with a text based user interface.`, Long: ` This displays a text based user interface allowing the navigation of a remote. It is most useful for answering the question - "What is using all my disk space?". {{< asciinema 157793 >}} To make the user interface it first scans the entire remote given and builds an in memory representation. rclone ncdu can be used during this scanning phase and you will see it building up the directory structure as it goes along. You can interact with the user interface using key presses, press '?' to toggle the help on and off. The supported keys are: ` + strings.Join(helpText()[1:], "\n ") + ` Listed files/directories may be prefixed by a one-character flag, some of them combined with a description in brackes at end of line. These flags have the following meaning: e means this is an empty directory, i.e. contains no files (but may contain empty subdirectories) ~ means this is a directory where some of the files (possibly in subdirectories) have unknown size, and therefore the directory size may be underestimated (and average size inaccurate, as it is average of the files with known sizes). . means an error occurred while reading a subdirectory, and therefore the directory size may be underestimated (and average size inaccurate) ! means an error occurred while reading this directory This an homage to the [ncdu tool](https://dev.yorhel.nl/ncdu) but for rclone remotes. It is missing lots of features at the moment but is useful as it stands. Note that it might take some time to delete big files/directories. The UI won't respond in the meantime since the deletion is done synchronously. `, Run: func(command *cobra.Command, args []string) { cmd.CheckArgs(1, 1, command, args) fsrc := cmd.NewFsSrc(args) cmd.Run(false, false, command, func() error { return NewUI(fsrc).Show() }) }, } // helpText returns help text for ncdu func helpText() (tr []string) { tr = []string{ "rclone ncdu", " ↑,↓ or k,j to Move", " →,l to enter", " ←,h to return", " c toggle counts", " g toggle graph", " a toggle average size in directory", " u toggle human-readable format", " n,s,C,A sort by name,size,count,average size", " d delete file/directory", " v select file/directory", " V enter visual select mode", " D delete selected files/directories", } if !clipboard.Unsupported { tr = append(tr, " y copy current path to clipboard") } tr = append(tr, []string{ " Y display current path", " ^L refresh screen", " ? to toggle help on and off", " q/ESC/c-C to quit", }...) return } // UI contains the state of the user interface type UI struct { f fs.Fs // fs being displayed fsName string // human name of Fs root *scan.Dir // root directory d *scan.Dir // current directory being displayed path string // path of current directory showBox bool // whether to show a box boxText []string // text to show in box boxMenu []string // box menu options boxMenuButton int boxMenuHandler func(fs fs.Fs, path string, option int) (string, error) entries fs.DirEntries // entries of current directory sortPerm []int // order to display entries in after sorting invSortPerm []int // inverse order dirListHeight int // height of listing listing bool // whether listing is in progress showGraph bool // toggle showing graph showCounts bool // toggle showing counts showDirAverageSize bool // toggle average size humanReadable bool // toggle human-readable format visualSelectMode bool // toggle visual selection mode sortByName int8 // +1 for normal, 0 for off, -1 for reverse sortBySize int8 sortByCount int8 sortByAverageSize int8 dirPosMap map[string]dirPos // store for directory positions selectedEntries map[string]dirPos // selected entries of current directory } // Where we have got to in the directory listing type dirPos struct { entry int offset int } // Print a string func Print(x, y int, fg, bg termbox.Attribute, msg string) { for _, c := range msg { termbox.SetCell(x, y, c, fg, bg) x++ } } // Printf a string func Printf(x, y int, fg, bg termbox.Attribute, format string, args ...interface{}) { s := fmt.Sprintf(format, args...) Print(x, y, fg, bg, s) } // Line prints a string to given xmax, with given space func Line(x, y, xmax int, fg, bg termbox.Attribute, spacer rune, msg string) { for _, c := range msg { termbox.SetCell(x, y, c, fg, bg) x += runewidth.RuneWidth(c) if x >= xmax { return } } for ; x < xmax; x++ { termbox.SetCell(x, y, spacer, fg, bg) } } // Linef a string func Linef(x, y, xmax int, fg, bg termbox.Attribute, spacer rune, format string, args ...interface{}) { s := fmt.Sprintf(format, args...) Line(x, y, xmax, fg, bg, spacer, s) } // LineOptions Print line of selectable options func LineOptions(x, y, xmax int, fg, bg termbox.Attribute, options []string, selected int) { defaultBg := bg defaultFg := fg // Print left+right whitespace to center the options xoffset := ((xmax - x) - lineOptionLength(options)) / 2 for j := x; j < x+xoffset; j++ { termbox.SetCell(j, y, ' ', fg, bg) } for j := xmax - xoffset; j < xmax; j++ { termbox.SetCell(j, y, ' ', fg, bg) } x += xoffset for i, o := range options { termbox.SetCell(x, y, ' ', fg, bg) if i == selected { bg = termbox.ColorBlack fg = termbox.ColorWhite } termbox.SetCell(x+1, y, '<', fg, bg) x += 2 // print option text for _, c := range o { termbox.SetCell(x, y, c, fg, bg) x++ } termbox.SetCell(x, y, '>', fg, bg) bg = defaultBg fg = defaultFg termbox.SetCell(x+1, y, ' ', fg, bg) x += 2 } } func lineOptionLength(o []string) int { count := 0 for _, i := range o { count += len(i) } return count + 4*len(o) // spacer and arrows } // Box the u.boxText onto the screen func (u *UI) Box() { w, h := termbox.Size() // Find dimensions of text boxWidth := 10 for _, s := range u.boxText { if len(s) > boxWidth && len(s) < w-4 { boxWidth = len(s) } } boxHeight := len(u.boxText) // position x := (w - boxWidth) / 2 y := (h - boxHeight) / 2 xmax := x + boxWidth if len(u.boxMenu) != 0 { count := lineOptionLength(u.boxMenu) if x+boxWidth > x+count { xmax = x + boxWidth } else { xmax = x + count } } ymax := y + len(u.boxText) // draw text fg, bg := termbox.ColorRed, termbox.ColorWhite for i, s := range u.boxText { Line(x, y+i, xmax, fg, bg, ' ', s) fg = termbox.ColorBlack } if len(u.boxMenu) != 0 { ymax++ LineOptions(x, ymax-1, xmax, fg, bg, u.boxMenu, u.boxMenuButton) } // draw top border for i := y; i < ymax; i++ { termbox.SetCell(x-1, i, '│', fg, bg) termbox.SetCell(xmax, i, '│', fg, bg) } for j := x; j < xmax; j++ { termbox.SetCell(j, y-1, '─', fg, bg) termbox.SetCell(j, ymax, '─', fg, bg) } termbox.SetCell(x-1, y-1, '┌', fg, bg) termbox.SetCell(xmax, y-1, '┐', fg, bg) termbox.SetCell(x-1, ymax, '└', fg, bg) termbox.SetCell(xmax, ymax, '┘', fg, bg) } func (u *UI) moveBox(to int) { if len(u.boxMenu) == 0 { return } if to > 0 { // move right u.boxMenuButton++ } else { // move left u.boxMenuButton-- } if u.boxMenuButton >= len(u.boxMenu) { u.boxMenuButton = len(u.boxMenu) - 1 } else if u.boxMenuButton < 0 { u.boxMenuButton = 0 } } // find the biggest entry in the current listing func (u *UI) biggestEntry() (biggest int64) { if u.d == nil { return } for i := range u.entries { attrs, _ := u.d.AttrI(u.sortPerm[i]) if attrs.Size > biggest { biggest = attrs.Size } } return } // hasEmptyDir returns true if there is empty folder in current listing func (u *UI) hasEmptyDir() bool { if u.d == nil { return false } for i := range u.entries { attrs, _ := u.d.AttrI(u.sortPerm[i]) if attrs.IsDir && attrs.Count == 0 { return true } } return false } // Draw the current screen func (u *UI) Draw() error { w, h := termbox.Size() u.dirListHeight = h - 3 // Plot err := termbox.Clear(termbox.ColorDefault, termbox.ColorDefault) if err != nil { return fmt.Errorf("failed to clear screen: %w", err) } // Header line Linef(0, 0, w, termbox.ColorBlack, termbox.ColorWhite, ' ', "rclone ncdu %s - use the arrow keys to navigate, press ? for help", fs.Version) // Directory line Linef(0, 1, w, termbox.ColorWhite, termbox.ColorBlack, '-', "-- %s ", u.path) // graphs const ( graphBars = 10 graph = "########## " ) // Directory listing if u.d != nil { y := 2 perBar := u.biggestEntry() / graphBars if perBar == 0 { perBar = 1 } showEmptyDir := u.hasEmptyDir() dirPos := u.dirPosMap[u.path] for i, j := range u.sortPerm[dirPos.offset:] { entry := u.entries[j] n := i + dirPos.offset if y >= h-1 { break } attrs, err := u.d.AttrI(u.sortPerm[n]) _, isSelected := u.selectedEntries[entry.String()] fg := termbox.ColorWhite if attrs.EntriesHaveErrors { fg = termbox.ColorYellow } if err != nil { fg = termbox.ColorRed } if isSelected { fg = termbox.ColorLightYellow } bg := termbox.ColorBlack if n == dirPos.entry { fg, bg = bg, fg } mark := ' ' if attrs.IsDir { mark = '/' } fileFlag := ' ' message := "" if !attrs.Readable { message = " [not read yet]" } if attrs.CountUnknownSize > 0 { message = fmt.Sprintf(" [%d of %d files have unknown size, size may be underestimated]", attrs.CountUnknownSize, attrs.Count) fileFlag = '~' } if attrs.EntriesHaveErrors { message = " [some subdirectories could not be read, size may be underestimated]" fileFlag = '.' } if err != nil { message = fmt.Sprintf(" [%s]", err) fileFlag = '!' } extras := "" if u.showCounts { ss := operations.CountStringField(attrs.Count, u.humanReadable, 9) + " " if attrs.Count > 0 { extras += ss } else { extras += strings.Repeat(" ", len(ss)) } } if u.showDirAverageSize { avg := attrs.AverageSize() ss := operations.SizeStringField(int64(avg), u.humanReadable, 9) + " " if avg > 0 { extras += ss } else { extras += strings.Repeat(" ", len(ss)) } } if showEmptyDir { if attrs.IsDir && attrs.Count == 0 && fileFlag == ' ' { fileFlag = 'e' } } if u.showGraph { bars := (attrs.Size + perBar/2 - 1) / perBar // clip if necessary - only happens during startup if bars > 10 { bars = 10 } else if bars < 0 { bars = 0 } extras += "[" + graph[graphBars-bars:2*graphBars-bars] + "] " } Linef(0, y, w, fg, bg, ' ', "%c %s %s%c%s%s", fileFlag, operations.SizeStringField(attrs.Size, u.humanReadable, 12), extras, mark, path.Base(entry.Remote()), message) y++ } } // Footer if u.d == nil { Line(0, h-1, w, termbox.ColorBlack, termbox.ColorWhite, ' ', "Waiting for root directory...") } else { message := "" if u.listing { message = " [listing in progress]" } size, count := u.d.Attr() Linef(0, h-1, w, termbox.ColorBlack, termbox.ColorWhite, ' ', "Total usage: %s, Objects: %s%s", operations.SizeString(size, u.humanReadable), operations.CountString(count, u.humanReadable), message) } // Show the box on top if required if u.showBox { u.Box() } err = termbox.Flush() if err != nil { return fmt.Errorf("failed to flush screen: %w", err) } return nil } // Move the cursor this many spaces adjusting the viewport as necessary func (u *UI) move(d int) { if u.d == nil { return } absD := d if d < 0 { absD = -d } entries := len(u.entries) // Fetch current dirPos dirPos := u.dirPosMap[u.path] dirPos.entry += d // check entry in range if dirPos.entry < 0 { dirPos.entry = 0 } else if dirPos.entry >= entries { dirPos.entry = entries - 1 } // check cursor still on screen p := dirPos.entry - dirPos.offset // where dirPos.entry appears on the screen if p < 0 { dirPos.offset -= absD } else if p >= u.dirListHeight { dirPos.offset += absD } // check dirPos.offset in bounds if entries == 0 || dirPos.offset < 0 { dirPos.offset = 0 } else if dirPos.offset >= entries { dirPos.offset = entries - 1 } // toggle the current file for selection in selection mode if u.visualSelectMode { u.toggleSelectForCursor() } // write dirPos back for later u.dirPosMap[u.path] = dirPos } func (u *UI) removeEntry(pos int) { u.d.Remove(pos) u.setCurrentDir(u.d) } func (u *UI) delete() { if u.d == nil || len(u.entries) == 0 { return } if len(u.selectedEntries) > 0 { u.deleteSelected() } else { u.deleteSingle() } } // delete the entry at the current position func (u *UI) deleteSingle() { ctx := context.Background() cursorPos := u.dirPosMap[u.path] dirPos := u.sortPerm[cursorPos.entry] dirEntry := u.entries[dirPos] u.boxMenu = []string{"cancel", "confirm"} if obj, isFile := dirEntry.(fs.Object); isFile { u.boxMenuHandler = func(f fs.Fs, p string, o int) (string, error) { if o != 1 { return "Aborted!", nil } err := operations.DeleteFile(ctx, obj) if err != nil { return "", err } u.removeEntry(dirPos) if cursorPos.entry >= len(u.entries) { u.move(-1) // move back onto a valid entry } return "Successfully deleted file!", nil } u.popupBox([]string{ "Delete this file?", fspath.JoinRootPath(u.fsName, dirEntry.String())}) } else { u.boxMenuHandler = func(f fs.Fs, p string, o int) (string, error) { if o != 1 { return "Aborted!", nil } err := operations.Purge(ctx, f, dirEntry.String()) if err != nil { return "", err } u.removeEntry(dirPos) if cursorPos.entry >= len(u.entries) { u.move(-1) // move back onto a valid entry } return "Successfully purged folder!", nil } u.popupBox([]string{ "Purge this directory?", "ALL files in it will be deleted", fspath.JoinRootPath(u.fsName, dirEntry.String())}) } } func (u *UI) deleteSelected() { ctx := context.Background() u.boxMenu = []string{"cancel", "confirm"} u.boxMenuHandler = func(f fs.Fs, p string, o int) (string, error) { if o != 1 { return "Aborted!", nil } positionsToDelete := make([]int, len(u.selectedEntries)) i := 0 for key, cursorPos := range u.selectedEntries { dirPos := u.sortPerm[cursorPos.entry] dirEntry := u.entries[dirPos] var err error if obj, isFile := dirEntry.(fs.Object); isFile { err = operations.DeleteFile(ctx, obj) } else { err = operations.Purge(ctx, f, dirEntry.String()) } if err != nil { return "", err } delete(u.selectedEntries, key) positionsToDelete[i] = dirPos i++ } // deleting all entries at once, as doing it during the deletions // could cause issues. sort.Slice(positionsToDelete, func(i, j int) bool { return positionsToDelete[i] > positionsToDelete[j] }) for _, dirPos := range positionsToDelete { u.removeEntry(dirPos) } // move cursor at end if needed cursorPos := u.dirPosMap[u.path] if cursorPos.entry >= len(u.entries) { u.move(-1) } return "Successfully deleted all items!", nil } u.popupBox([]string{ "Delete selected items?", fmt.Sprintf("ALL %d items will be deleted", len(u.selectedEntries))}) } func (u *UI) displayPath() { u.togglePopupBox([]string{ "Current Path", u.path, }) } func (u *UI) copyPath() { if !clipboard.Unsupported { _ = clipboard.WriteAll(u.path) } } // Sort by the configured sort method type ncduSort struct { sortPerm []int entries fs.DirEntries d *scan.Dir u *UI } // Less is part of sort.Interface. func (ds *ncduSort) Less(i, j int) bool { var iAvgSize, jAvgSize float64 iattrs, _ := ds.d.AttrI(ds.sortPerm[i]) jattrs, _ := ds.d.AttrI(ds.sortPerm[j]) iname, jname := ds.entries[ds.sortPerm[i]].Remote(), ds.entries[ds.sortPerm[j]].Remote() if iattrs.Count > 0 { iAvgSize = iattrs.AverageSize() } if jattrs.Count > 0 { jAvgSize = jattrs.AverageSize() } switch { case ds.u.sortByName < 0: return iname > jname case ds.u.sortByName > 0: break case ds.u.sortBySize < 0: if iattrs.Size != jattrs.Size { return iattrs.Size < jattrs.Size } case ds.u.sortBySize > 0: if iattrs.Size != jattrs.Size { return iattrs.Size > jattrs.Size } case ds.u.sortByCount < 0: if iattrs.Count != jattrs.Count { return iattrs.Count < jattrs.Count } case ds.u.sortByCount > 0: if iattrs.Count != jattrs.Count { return iattrs.Count > jattrs.Count } case ds.u.sortByAverageSize < 0: if iAvgSize != jAvgSize { return iAvgSize < jAvgSize } // if avgSize is equal, sort by size return iattrs.Size < jattrs.Size case ds.u.sortByAverageSize > 0: if iAvgSize != jAvgSize { return iAvgSize > jAvgSize } // if avgSize is equal, sort by size return iattrs.Size > jattrs.Size } // if everything equal, sort by name return iname < jname } // Swap is part of sort.Interface. func (ds *ncduSort) Swap(i, j int) { ds.sortPerm[i], ds.sortPerm[j] = ds.sortPerm[j], ds.sortPerm[i] } // Len is part of sort.Interface. func (ds *ncduSort) Len() int { return len(ds.sortPerm) } // sort the permutation map of the current directory func (u *UI) sortCurrentDir() { u.sortPerm = u.sortPerm[:0] for i := range u.entries { u.sortPerm = append(u.sortPerm, i) } data := ncduSort{ sortPerm: u.sortPerm, entries: u.entries, d: u.d, u: u, } sort.Sort(&data) if len(u.invSortPerm) < len(u.sortPerm) { u.invSortPerm = make([]int, len(u.sortPerm)) } for i, j := range u.sortPerm { u.invSortPerm[j] = i } } // setCurrentDir sets the current directory func (u *UI) setCurrentDir(d *scan.Dir) { u.d = d u.entries = d.Entries() u.path = fspath.JoinRootPath(u.fsName, d.Path()) u.selectedEntries = make(map[string]dirPos) u.visualSelectMode = false u.sortCurrentDir() } // enters the current entry func (u *UI) enter() { if u.d == nil || len(u.entries) == 0 { return } dirPos := u.dirPosMap[u.path] d, _ := u.d.GetDir(u.sortPerm[dirPos.entry]) if d == nil { return } u.setCurrentDir(d) } // handles a box option that was selected func (u *UI) handleBoxOption() { msg, err := u.boxMenuHandler(u.f, u.path, u.boxMenuButton) // reset u.boxMenuButton = 0 u.boxMenu = []string{} u.boxMenuHandler = nil if err != nil { u.popupBox([]string{ "error:", err.Error(), }) return } u.popupBox([]string{"Finished:", msg}) } // up goes up to the parent directory func (u *UI) up() { if u.d == nil { return } parent := u.d.Parent() if parent != nil { u.setCurrentDir(parent) } } // popupBox shows a box with the text in func (u *UI) popupBox(text []string) { u.boxText = text u.showBox = true } // togglePopupBox shows a box with the text in func (u *UI) togglePopupBox(text []string) { if u.showBox && reflect.DeepEqual(u.boxText, text) { u.showBox = false } else { u.popupBox(text) } } // toggle the sorting for the flag passed in func (u *UI) toggleSort(sortType *int8) { old := *sortType u.sortBySize = 0 u.sortByCount = 0 u.sortByName = 0 u.sortByAverageSize = 0 if old == 0 { *sortType = 1 } else { *sortType = -old } u.sortCurrentDir() } func (u *UI) toggleSelectForCursor() { cursorPos := u.dirPosMap[u.path] dirPos := u.sortPerm[cursorPos.entry] dirEntry := u.entries[dirPos] _, present := u.selectedEntries[dirEntry.String()] if present { delete(u.selectedEntries, dirEntry.String()) } else { u.selectedEntries[dirEntry.String()] = cursorPos } } // NewUI creates a new user interface for ncdu on f func NewUI(f fs.Fs) *UI { return &UI{ f: f, path: "Waiting for root...", dirListHeight: 20, // updated in Draw fsName: fs.ConfigString(f), showGraph: true, showCounts: false, showDirAverageSize: false, humanReadable: true, sortByName: 0, // +1 for normal, 0 for off, -1 for reverse sortBySize: 1, sortByCount: 0, dirPosMap: make(map[string]dirPos), selectedEntries: make(map[string]dirPos), } } // Show shows the user interface func (u *UI) Show() error { err := termbox.Init() if err != nil { return fmt.Errorf("termbox init: %w", err) } defer termbox.Close() // scan the disk in the background u.listing = true rootChan, errChan, updated := scan.Scan(context.Background(), u.f) // Poll the events into a channel events := make(chan termbox.Event) doneWithEvent := make(chan bool) go func() { for { events <- termbox.PollEvent() <-doneWithEvent } }() // Main loop, waiting for events and channels outer: for { //Reset() err := u.Draw() if err != nil { return fmt.Errorf("draw failed: %w", err) } var root *scan.Dir select { case root = <-rootChan: u.root = root u.setCurrentDir(root) case err := <-errChan: if err != nil { return fmt.Errorf("ncdu directory listing: %w", err) } u.listing = false case <-updated: // redraw // might want to limit updates per second u.sortCurrentDir() case ev := <-events: doneWithEvent <- true if ev.Type == termbox.EventKey { switch ev.Key + termbox.Key(ev.Ch) { case termbox.KeyEsc, termbox.KeyCtrlC, 'q': if u.showBox { u.showBox = false } else { break outer } case termbox.KeyArrowDown, 'j': u.move(1) case termbox.KeyArrowUp, 'k': u.move(-1) case termbox.KeyPgdn, '-', '_': u.move(u.dirListHeight) case termbox.KeyPgup, '=', '+': u.move(-u.dirListHeight) case termbox.KeyArrowLeft, 'h': if u.showBox { u.moveBox(-1) break } u.up() case termbox.KeyEnter: if len(u.boxMenu) > 0 { u.handleBoxOption() break } u.enter() case termbox.KeyArrowRight, 'l': if u.showBox { u.moveBox(1) break } u.enter() case 'c': u.showCounts = !u.showCounts case 'g': u.showGraph = !u.showGraph case 'a': u.showDirAverageSize = !u.showDirAverageSize case 'n': u.toggleSort(&u.sortByName) case 's': u.toggleSort(&u.sortBySize) case 'v': u.toggleSelectForCursor() case 'V': u.visualSelectMode = !u.visualSelectMode case 'C': u.toggleSort(&u.sortByCount) case 'A': u.toggleSort(&u.sortByAverageSize) case 'y': u.copyPath() case 'Y': u.displayPath() case 'd': u.delete() case 'u': u.humanReadable = !u.humanReadable case 'D': u.deleteSelected() case '?': u.togglePopupBox(helpText()) // Refresh the screen. Not obvious what key to map // this onto, but ^L is a common choice. case termbox.KeyCtrlL: err := termbox.Sync() if err != nil { fs.Errorf(nil, "termbox sync returned error: %v", err) } } } } // listen to key presses, etc. } return nil }