GODT-1158: Store full messages bodies on disk

- GODT-1158: simple on-disk cache in store
- GODT-1158: better member naming in event loop
- GODT-1158: create on-disk cache during bridge setup
- GODT-1158: better job options
- GODT-1158: rename GetLiteral to GetRFC822
- GODT-1158: rename events -> currentEvents
- GODT-1158: unlock cache per-user
- GODT-1158: clean up cache after logout
- GODT-1158: randomized encrypted cache passphrase
- GODT-1158: Opt out of on-disk cache in settings
- GODT-1158: free space in cache
- GODT-1158: make tests compile
- GODT-1158: optional compression
- GODT-1158: cache custom location
- GODT-1158: basic capacity checker
- GODT-1158: cache free space config
- GODT-1158: only unlock cache if pmapi client is unlocked as well
- GODT-1158: simple background sync worker
- GODT-1158: set size/bodystructure when caching message
- GODT-1158: limit store db update blocking with semaphore
- GODT-1158: dumb 10-semaphore
- GODT-1158: properly handle delete; remove bad bodystructure handling
- GODT-1158: hacky fix for caching after logout... baaaaad
- GODT-1158: cache worker
- GODT-1158: compute body structure lazily
- GODT-1158: cache size in store
- GODT-1158: notify cacher when adding to store
- GODT-1158: 15 second store cache watcher
- GODT-1158: enable cacher
- GODT-1158: better cache worker starting/stopping
- GODT-1158: limit cacher to less concurrency than disk cache
- GODT-1158: message builder prio + pchan pkg
- GODT-1158: fix pchan, use in message builder
- GODT-1158: no sem in cacher (rely on message builder prio)
- GODT-1158: raise priority of existing jobs when requested
- GODT-1158: pending messages in on-disk cache
- GODT-1158: WIP just a note about deleting messages from disk cache
- GODT-1158: pending wait when trying to write
- GODT-1158: pending.add to return bool
- GODT-1225: Headers in bodystructure are stored as bytes.
- GODT-1158: fixing header caching
- GODT-1158: don't cache in background
- GODT-1158: all concurrency set in settings
- GODT-1158: worker pools inside message builder
- GODT-1158: fix linter issues
- GODT-1158: remove completed builds from builder
- GODT-1158: remove builder pool
- GODT-1158: cacher defer job done properly
- GODT-1158: fix linter
- GODT-1299: Continue with bodystructure build if deserialization failed
- GODT-1324: Delete messages from the cache when they are deleted on the server
- GODT-1158: refactor cache tests
- GODT-1158: move builder to app/bridge
- GODT-1306: Migrate cache on disk when location is changed (and delete when disabled)

internal/frontend/cli/frontend.go

@@ -128,6 +128,24 @@ func New( //nolint[funlen]
 	})
 	fe.AddCmd(dohCmd)
 
+	// Cache-On-Disk commands.
+	codCmd := &ishell.Cmd{Name: "local-cache",
+		Help: "manage the local encrypted message cache",
+	}
+	codCmd.AddCmd(&ishell.Cmd{Name: "enable",
+		Help: "enable the local cache",
+		Func: fe.enableCacheOnDisk,
+	})
+	codCmd.AddCmd(&ishell.Cmd{Name: "disable",
+		Help: "disable the local cache",
+		Func: fe.disableCacheOnDisk,
+	})
+	codCmd.AddCmd(&ishell.Cmd{Name: "change-location",
+		Help: "change the location of the local cache",
+		Func: fe.setCacheOnDiskLocation,
+	})
+	fe.AddCmd(codCmd)
+
 	// Updates commands.
 	updatesCmd := &ishell.Cmd{Name: "updates",
 		Help: "manage bridge updates",

internal/frontend/cli/system.go

@@ -19,6 +19,7 @@ package cli
 
 import (
 	"fmt"
+	"os"
 	"strconv"
 	"strings"
 
@@ -155,6 +156,67 @@ func (f *frontendCLI) disallowProxy(c *ishell.Context) {
 	}
 }
 
+func (f *frontendCLI) enableCacheOnDisk(c *ishell.Context) {
+	if f.settings.GetBool(settings.CacheEnabledKey) {
+		f.Println("The local cache is already enabled.")
+		return
+	}
+
+	if f.yesNoQuestion("Are you sure you want to enable the local cache") {
+		// Set this back to the default location before enabling.
+		f.settings.Set(settings.CacheLocationKey, "")
+
+		if err := f.bridge.EnableCache(); err != nil {
+			f.Println("The local cache could not be enabled.")
+			return
+		}
+
+		f.settings.SetBool(settings.CacheEnabledKey, true)
+		f.restarter.SetToRestart()
+		f.Stop()
+	}
+}
+
+func (f *frontendCLI) disableCacheOnDisk(c *ishell.Context) {
+	if !f.settings.GetBool(settings.CacheEnabledKey) {
+		f.Println("The local cache is already disabled.")
+		return
+	}
+
+	if f.yesNoQuestion("Are you sure you want to disable the local cache") {
+		if err := f.bridge.DisableCache(); err != nil {
+			f.Println("The local cache could not be disabled.")
+			return
+		}
+
+		f.settings.SetBool(settings.CacheEnabledKey, false)
+		f.restarter.SetToRestart()
+		f.Stop()
+	}
+}
+
+func (f *frontendCLI) setCacheOnDiskLocation(c *ishell.Context) {
+	if !f.settings.GetBool(settings.CacheEnabledKey) {
+		f.Println("The local cache must be enabled.")
+		return
+	}
+
+	if location := f.settings.Get(settings.CacheLocationKey); location != "" {
+		f.Println("The current local cache location is:", location)
+	}
+
+	if location := f.readStringInAttempts("Enter a new location for the cache", c.ReadLine, f.isCacheLocationUsable); location != "" {
+		if err := f.bridge.MigrateCache(f.settings.Get(settings.CacheLocationKey), location); err != nil {
+			f.Println("The local cache location could not be changed.")
+			return
+		}
+
+		f.settings.Set(settings.CacheLocationKey, location)
+		f.restarter.SetToRestart()
+		f.Stop()
+	}
+}
+
 func (f *frontendCLI) isPortFree(port string) bool {
 	port = strings.ReplaceAll(port, ":", "")
 	if port == "" || port == currentPort {
@@ -171,3 +233,13 @@ func (f *frontendCLI) isPortFree(port string) bool {
 	}
 	return true
 }
+
+// NOTE(GODT-1158): Check free space in location.
+func (f *frontendCLI) isCacheLocationUsable(location string) bool {
+	stat, err := os.Stat(location)
+	if err != nil {
+		return false
+	}
+
+	return stat.IsDir()
+}

internal/frontend/types/types.go

@@ -77,6 +77,9 @@ type Bridger interface {
 	ReportBug(osType, osVersion, description, accountName, address, emailClient string) error
 	AllowProxy()
 	DisallowProxy()
+	EnableCache() error
+	DisableCache() error
+	MigrateCache(from, to string) error
 	GetUpdateChannel() updater.UpdateChannel
 	SetUpdateChannel(updater.UpdateChannel) (needRestart bool, err error)
 	GetKeychainApp() string