Initial groundwork for native sync support

main.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"github.com/rwinkhart/MUTN/src/backend"
 	"github.com/rwinkhart/MUTN/src/cli"
+	"github.com/rwinkhart/MUTN/src/sync"
 	"os"
 	"strings"
 )
@@ -162,6 +163,8 @@ func main() {
 					fmt.Println(backend.AnsiError + "\"sync\" is not yet implemented" + backend.AnsiReset)
 				}
 				os.Exit(0)
+			case "synctest": // TODO Remove after native sync is implemented
+				sync.RunJob(true)
 			case "init":
 				cli.TempInitCli()
 			case "tweak":

src/backend/configParser.go

@@ -6,10 +6,11 @@ import (
 	"os"
 )
 
-// ReadConfig reads the libmutton.ini file and returns a map of the requested values
-// requires readMap: a map of section names to key names (indicates requested values)
-// returns configMap: a map of key names to values (sections are irrelevant)
-func ReadConfig(readKeys []string) []string {
+// ReadConfig reads the libmutton.ini file and returns a slice of values for the specified keys
+// requires readKeys: a slice of key names (indicates requested values)
+// requires missingValueError: an error message to display if a key is missing a value, set to "" for auto-generated or "0" to exit silently with status 0
+// returns config: a slice of values for the specified keys
+func ReadConfig(readKeys []string, missingValueError string) []string {
 	cfg, err := ini.Load(ConfigPath)
 	if err != nil {
 		fmt.Println(AnsiError + "Failed to load libmutton.ini" + AnsiReset)
@@ -23,7 +24,14 @@ func ReadConfig(readKeys []string) []string {
 
 		// ensure specified key has a value
 		if keyConfig == "" {
+			switch missingValueError {
+			case "":
 				fmt.Println(AnsiError + "Failed to find value for key \"" + key + "\" in section \"[LIBMUTTON]\" in libmutton.ini" + AnsiReset)
+			case "0":
+				os.Exit(0)
+			default:
+				fmt.Println(AnsiError + missingValueError + AnsiReset)
+			}
 			os.Exit(1)
 		}
 
@@ -37,10 +45,9 @@ func ReadConfig(readKeys []string) []string {
 // [LIBMUTTON]
 // gpgID = <gpg key id>
 // textEditor = <editor command>
-// onlineMode = <true/false>
-// sshError = <true/false>
+// sshUser = <remote user>
+// sshIP = <remote ip>
+// sshPort = <remote ssh port>
+// sshIdentity = <ssh private key identity file path>
 // netPinEnabled = <true/false>
-// remoteUser = <ssh user>
-// remoteIP = <ssh ip>
-// remotePort = <ssh port>
-// identityFile = <path to private key>
+// deviceID = <device id> TODO remove from config file

src/backend/gpg.go

@@ -24,7 +24,7 @@ func DecryptGPG(targetLocation string) []string {
 
 // EncryptGPG encrypts a slice of strings using GPG and returns the encrypted data as a byte slice
 func EncryptGPG(input []string) []byte {
-	cmd := exec.Command("gpg", "-q", "-r", ReadConfig([]string{"gpgID"})[0], "-e")
+	cmd := exec.Command("gpg", "-q", "-r", ReadConfig([]string{"gpgID"}, "")[0], "-e")
 	writeToStdin(cmd, strings.Join(input, "\n"))
 	encryptedBytes, err := cmd.Output()
 	if err != nil {

src/cli/1globals.go

@@ -1,14 +1,12 @@
 package cli
 
 import (
-	"github.com/rwinkhart/MUTN/src/backend"
 	termy "golang.org/x/crypto/ssh/terminal"
 	"os"
 )
 
 // global variables used across multiple files
 var (
-	rootLength  = len(backend.EntryRoot)
 	width, _, _ = termy.GetSize(int(os.Stdout.Fd()))
 )
 

src/cli/edit.go

@@ -70,7 +70,7 @@ func GenUpdate(targetLocation string, hidePassword bool) {
 func editNote(baseNote []string) ([]string, bool) {
 	tempFile := backend.CreateTempFile()
 	defer os.Remove(tempFile.Name())
-	editor := backend.ReadConfig([]string{"textEditor"})[0]
+	editor := backend.ReadConfig([]string{"textEditor"}, "")[0]
 
 	// write baseNote to tempFile (if it is not empty)
 	if len(baseNote) > 0 {

src/cli/entryList.go

@@ -3,9 +3,8 @@ package cli
 import (
 	"fmt"
 	"github.com/rwinkhart/MUTN/src/backend"
-	"io/fs"
+	"github.com/rwinkhart/MUTN/src/sync"
 	"os"
-	"path/filepath"
 	"strings"
 )
 
@@ -79,37 +78,7 @@ func printFileEntry(entry string, lastSlash int, charCounter int, colorAlternato
 
 // EntryListGen generates and displays full libmutton entry list
 func EntryListGen() {
-	// 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(backend.EntryRoot,
-		func(fullPath string, entry fs.DirEntry, err error) error {
-
-			// check for errors encountered while walking directory
-			if err != nil {
-				if os.IsNotExist(err) {
-					fmt.Println(backend.AnsiError + "\nThe entry directory does not exist - run \"mutn init\" to create it" + backend.AnsiReset)
-				} else {
-					// otherwise, print the source of the error
-					fmt.Println(backend.AnsiError + "\nAn unexpected error occurred while generating the entry list: " + err.Error() + backend.AnsiReset)
-				}
-				os.Exit(1)
-			}
-
-			// trim root path from each path before storing
-			trimmedPath := fullPath[rootLength:]
-
-			// create separate slices for entries and directories
-			if !entry.IsDir() {
-				fileList = append(fileList, trimmedPath)
-			} else {
-				dirList = append(dirList, trimmedPath)
-			}
-
-			return nil
-		})
+	fileList, dirList := sync.WalkEntryDir()
 
 	// print header bar w/total entry count
 	fmt.Print("\n"+ansiBlackOnWhite, len(fileList), " libmutton entries:"+backend.AnsiReset)

src/cli/init.go

@@ -3,6 +3,7 @@ package cli
 import (
 	"fmt"
 	"github.com/rwinkhart/MUTN/src/backend"
+	"math/rand"
 	"os"
 )
 
@@ -26,5 +27,25 @@ func TempInitCli() {
 	// textEditor
 	textEditor := input("Text editor (leave blank for $EDITOR, falls back to \"" + backend.FallbackEditor + "\"):")
 
+	// SSH info
+	configSSH := inputBinary("Configure SSH settings (for synchronization)?")
+	if configSSH {
+		// client device ID
+		deviceIDPrefix, _ := os.Hostname()
+		deviceIDSuffix := backend.StringGen(rand.Intn(48)+48, true, 0.2)
+		deviceID := deviceIDPrefix + "-" + deviceIDSuffix // TODO do not save in config file, encrypt in config directory
+
+		// necessary SSH info
+		sshUser := input("Remote SSH username:")
+		sshIP := input("Remote SSH IP address:")
+		sshPort := input("Remote SSH port:")
+		sshIdentity := input("SSH private identity file path:") // TODO implement generator and selector
+
+		// write config file
+		backend.TempInit(map[string]string{"textEditor": textEditor, "gpgID": gpgID, "deviceID": deviceID, "sshUser": sshUser, "sshIP": sshIP, "sshPort": sshPort, "sshIdentity": sshIdentity})
+	} else {
+		// write config file
 		backend.TempInit(map[string]string{"textEditor": textEditor, "gpgID": gpgID})
 	}
+
+}

src/cli/printInfo.go

@@ -142,8 +142,8 @@ ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
 		"    ◎-◎    //   \\\\     " + ansiVersionMeat + "♥♥♥♥♥♥♥♥♥" + backend.AnsiReset + "         //   \\\\     /|\\\n" +
 		ansiVersionOutline + "<><><><><><><><><><><><><><>-<><><><><><><><><><><><><><>\n" +
 		"\\" + ansiBlackOnWhite + "                                                       " + backend.AnsiReset + ansiVersionOutline + "/\n" +
-		"\\" + ansiBlackOnWhite + "                  MUTN Version 0.1.0                   " + backend.AnsiReset + ansiVersionOutline + "/\n" +
-		"\\" + ansiBlackOnWhite + "                 The Butchered Update                  " + backend.AnsiReset + ansiVersionOutline + "/\n" +
+		"\\" + ansiBlackOnWhite + "                  MUTN Version 0.2.X                   " + backend.AnsiReset + ansiVersionOutline + "/\n" +
+		"\\" + ansiBlackOnWhite + "                The Placeholder Update                 " + backend.AnsiReset + ansiVersionOutline + "/\n" +
 		"\\" + ansiBlackOnWhite + "                                                       " + backend.AnsiReset + ansiVersionOutline + "/\n" +
 		"\\" + ansiBlackOnWhite + "          Copyright (c) 2024 Randall Winkhart          " + backend.AnsiReset + ansiVersionOutline + "/\n" +
 		"\\" + ansiBlackOnWhite + "                                                       " + backend.AnsiReset + ansiVersionOutline + "/\n" +

src/sync/1globals.go

@@ -0,0 +1,6 @@
+package sync
+
+import "github.com/rwinkhart/MUTN/src/backend"
+
+// RootLength store length of backend.EntryRoot string
+var rootLength = len(backend.EntryRoot)

src/sync/sync.go

@@ -0,0 +1,42 @@
+package sync
+
+import (
+	"fmt"
+	"github.com/rwinkhart/MUTN/src/backend"
+	"os"
+)
+
+// returns lists of local entries and mod times (two separate lists)
+func getLocalData() {
+	fileList, _ := WalkEntryDir()
+	fmt.Println(fileList) // TODO placeholder
+}
+
+// RunJob runs the SSH sync job
+func RunJob(manualSync bool) {
+	// get SSH config info, exit if not configured (displaying an error if the sync job was called manually)
+	var sshUserIPPortIdentity []string
+	if manualSync {
+		sshUserIPPortIdentity = backend.ReadConfig([]string{"sshUser", "sshIP", "sshPort", "sshIdentity"}, "SSH settings not configured - run \"mutn init\" to configure")
+	} else {
+		sshUserIPPortIdentity = backend.ReadConfig([]string{"sshUser", "sshIP", "sshPort", "sshIdentity"}, "0")
+	}
+
+	var sshUser, sshIP, sshPort, sshIdentity string
+	for i, key := range sshUserIPPortIdentity {
+		switch i {
+		case 0:
+			sshUser = key
+		case 1:
+			sshIP = key
+		case 2:
+			sshPort = key
+		case 3:
+			sshIdentity = key
+		}
+	}
+
+	fmt.Println(sshUser, sshIP, sshPort, sshIdentity) // TODO placeholder
+
+	os.Exit(0)
+}

src/sync/walk.go

@@ -0,0 +1,46 @@
+package sync
+
+import (
+	"fmt"
+	"github.com/rwinkhart/MUTN/src/backend"
+	"io/fs"
+	"os"
+	"path/filepath"
+)
+
+// WalkEntryDir walks the entry directory and returns lists of all files and directories found (two separate lists)
+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(backend.EntryRoot,
+		func(fullPath string, entry fs.DirEntry, err error) error {
+
+			// check for errors encountered while walking directory
+			if err != nil {
+				if os.IsNotExist(err) {
+					fmt.Println(backend.AnsiError + "\nThe entry directory does not exist - run \"mutn init\" to create it" + backend.AnsiReset)
+				} else {
+					// otherwise, print the source of the error
+					fmt.Println(backend.AnsiError + "\nAn unexpected error occurred while generating the entry list: " + err.Error() + backend.AnsiReset)
+				}
+				os.Exit(1)
+			}
+
+			// trim root path from each path before storing
+			trimmedPath := fullPath[rootLength:]
+
+			// create separate slices for entries and directories
+			if !entry.IsDir() {
+				fileList = append(fileList, trimmedPath)
+			} else {
+				dirList = append(dirList, trimmedPath)
+			}
+
+			return nil
+		})
+
+	return fileList, dirList
+}