Refactor: Split into more packages to reduce server binary size

2026-08-27 20:36:29 -04:00 · 2025-05-12 16:26:03 +00:00
parent 84d227b803
commit 36bbf88690
28 changed files with 242 additions and 212 deletions
@@ -0,0 +1,121 @@
+package synccommon
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/rwinkhart/go-boilerplate/back"
+	"github.com/rwinkhart/libmutton/global"
+)
+
+// ANSI color constants used only in this file
+const (
+	AnsiDelete   = "\033[38;5;1m"
+	AnsiDownload = "\033[38;5;2m"
+	AnsiUpload   = "\033[38;5;4m"
+)
+
+var RootLength = len(global.EntryRoot) // length of global.EntryRoot string
+
+// GetModTimes returns a list of all entry modification times.
+func GetModTimes(entryList []string) []int64 {
+	var modList []int64
+	for _, file := range entryList {
+		modTime, _ := os.Stat(global.TargetLocationFormat(file))
+		modList = append(modList, modTime.ModTime().Unix())
+	}
+
+	return modList
+}
+
+// ShearLocal removes the target file or directory from the local system.
+// Returns: deviceID (only on client; for use in ShearRemoteFromClient),
+// isDir (only on client; for use in ShearRemoteFromClient).
+// If the local system is a server, it will also add the target to the deletions list for all clients (except the requesting client).
+// This function should only be used directly by the server binary.
+func ShearLocal(targetLocationIncomplete, clientDeviceID string) (string, bool) {
+	// determine if running on a server
+	var onServer bool
+	if clientDeviceID != "" {
+		onServer = true
+	}
+
+	deviceIDList := global.GenDeviceIDList(true)
+
+	// add the sheared target (incomplete, vanity) to the deletions list (if running on a server)
+	if onServer {
+		for _, device := range deviceIDList {
+			if device.Name() != clientDeviceID {
+				fileToClose, err := os.OpenFile(global.ConfigDir+global.PathSeparator+"deletions"+global.PathSeparator+device.Name()+global.FSSpace+strings.ReplaceAll(targetLocationIncomplete, "/", global.FSPath), os.O_CREATE|os.O_WRONLY, 0600)
+				if err != nil {
+					// do not print error as there is currently no way of seeing server-side errors
+					// failure to add the target to the deletions list will exit the program and result in a client re-uploading the target (non-critical)
+					os.Exit(back.ErrorWrite)
+				}
+				_ = fileToClose.Close() // error ignored; if the file could be created, it can probably be closed
+			}
+		}
+	}
+
+	// get the full targetLocation path and remove the target
+	targetLocationComplete := global.TargetLocationFormat(targetLocationIncomplete)
+	var isFile bool
+	if !onServer { // error if target does not exist on client, needed because os.RemoveAll does not return an error if target does not exist
+		isFile, _ = back.TargetIsFile(targetLocationComplete, true, 0)
+	}
+	err := os.RemoveAll(targetLocationComplete)
+	if err != nil {
+		back.PrintError("Failed to remove local target: "+err.Error(), back.ErrorWrite, true)
+	}
+
+	if !onServer && len(deviceIDList) > 0 { // return the device ID if running on the client and a device ID exists (online mode)
+		return (deviceIDList)[0].Name(), !isFile
+	}
+	return "", true
+
+	// do not exit program, as this function is used as part of ShearRemoteFromClient
+}
+
+// RenameLocal renames oldLocationIncomplete to newLocationIncomplete on the local system.
+// This function should only be used directly by the server binary.
+func RenameLocal(oldLocationIncomplete, newLocationIncomplete string, verifyOldLocationExists bool) {
+	// get full paths for both locations
+	oldLocation := global.TargetLocationFormat(oldLocationIncomplete)
+	newLocation := global.TargetLocationFormat(newLocationIncomplete)
+
+	if verifyOldLocationExists {
+		back.TargetIsFile(oldLocation, true, 0)
+	}
+
+	// ensure newLocation does not exist
+	_, isAccessible := back.TargetIsFile(newLocation, false, 0)
+	if isAccessible {
+		back.PrintError("\""+newLocation+"\" already exists", global.ErrorTargetExists, true)
+	}
+
+	// rename oldLocation to newLocation
+	err := os.Rename(oldLocation, newLocation)
+	if err != nil {
+		back.PrintError("Failed to rename - Does the target containing directory exist?", back.ErrorTargetNotFound, true)
+	}
+
+	// do not exit program, as this function is used as part of RenameRemoteFromClient
+}
+
+// AddFolderLocal creates a new entry-containing directory on the local system.
+// This function should only be used directly by the server binary.
+func AddFolderLocal(targetLocationIncomplete string) {
+	// get the full targetLocation path and create the target
+	targetLocationComplete := global.TargetLocationFormat(targetLocationIncomplete)
+	err := os.Mkdir(targetLocationComplete, 0700)
+	if err != nil {
+		if os.IsExist(err) {
+			fmt.Println(AnsiUpload + "Directory already exists - libmutton will still ensure it exists on the server")
+		} else {
+			back.PrintError("Failed to create directory: "+err.Error(), back.ErrorWrite, true)
+		}
+	}
+
+	// do not exit program, as this function is used as part of AddFolderRemoteFromClient
+}
@@ -0,0 +1,48 @@
+//go:build !windows
+
+package synccommon
+
+import (
+	"io/fs"
+	"os"
+	"path/filepath"
+
+	"github.com/rwinkhart/go-boilerplate/back"
+	"github.com/rwinkhart/libmutton/global"
+)
+
+// WalkEntryDir walks the entry directory and returns lists of all files and directories found (two separate lists).
+// Regardless of platform, all paths are stored with forward slashes (UNIX-style).
+func WalkEntryDir() ([]string, []string) {
+	// define file/directory containing slices so that they may be accessed by the anonymous WalkDir function
+	var fileList []string
+	var dirList []string
+
+	// walk entry directory
+	_ = filepath.WalkDir(global.EntryRoot,
+		func(fullPath string, entry fs.DirEntry, err error) error {
+
+			// check for errors encountered while walking directory
+			if err != nil {
+				if os.IsNotExist(err) {
+					back.PrintError("The entry directory does not exist - Initialize libmutton to create it", back.ErrorOther, true)
+				} else {
+					back.PrintError("An unexpected error occurred while generating the entry list: "+err.Error(), back.ErrorOther, true)
+				}
+			}
+
+			// trim root path from each path before storing
+			trimmedPath := fullPath[RootLength:]
+
+			// append the path to the appropriate slice
+			if !entry.IsDir() {
+				fileList = append(fileList, trimmedPath)
+			} else {
+				dirList = append(dirList, trimmedPath)
+			}
+
+			return nil
+		})
+
+	return fileList, dirList
+}
@@ -0,0 +1,49 @@
+//go:build windows
+
+package synccommon
+
+import (
+	"io/fs"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/rwinkhart/go-boilerplate/back"
+	"github.com/rwinkhart/libmutton/global"
+)
+
+// WalkEntryDir walks the entry directory and returns lists of all files and directories found (two separate lists).
+// Regardless of platform, all paths are stored with forward slashes (UNIX-style).
+func WalkEntryDir() ([]string, []string) {
+	// define file/directory containing slices so that they may be accessed by the anonymous WalkDir function
+	var fileList []string
+	var dirList []string
+
+	// walk entry directory
+	_ = filepath.WalkDir(global.EntryRoot,
+		func(fullPath string, entry fs.DirEntry, err error) error {
+
+			// check for errors encountered while walking directory
+			if err != nil {
+				if os.IsNotExist(err) {
+					back.PrintError("The entry directory does not exist - Initialize libmutton to create it", back.ErrorOther, true)
+				} else {
+					back.PrintError("An unexpected error occurred while generating the entry list: "+err.Error(), back.ErrorOther, true)
+				}
+			}
+
+			// trim root path from each path before storing and replace backslashes with forward slashes
+			trimmedPath := strings.ReplaceAll(fullPath[RootLength:], "\\", "/")
+
+			// append the path to the appropriate slice
+			if !entry.IsDir() {
+				fileList = append(fileList, trimmedPath)
+			} else {
+				dirList = append(dirList, trimmedPath)
+			}
+
+			return nil
+		})
+
+	return fileList, dirList
+}