Bugfix: No Subdirectory

In case the password must provided interactively, it is now invisible. Added also exit codes in case of errors for a better usage and automation e.g. with Docker containers. Finally, improved the console output for e.g. Docker containers.

.gitignore

@@ -22,3 +22,4 @@ _testmain.go
 *.exe
 *.test
 *.prof
+*.DS_Store

CorrectPath.go

@@ -1,9 +1,12 @@
 package main
 
 func correctPath(path string) string {
+
 	if path[len(path)-1:] == `/` || path[len(path)-1:] == `\` {
+		// Case: E.g. remote dir = /myfiles/
 		return path[:len(path)-1]
 	} else {
+		// Case: E.g. remote dir = /myfiles
 		return path
 	}
 }

Main.go

@@ -2,17 +2,21 @@ package main
 
 import (
 	"fmt"
-	"github.com/SommerEngineering/Sync/Sync"
-	"golang.org/x/crypto/ssh"
 	"log"
+	"net"
 	"os"
 	"runtime"
+	"time"
+
+	"github.com/SommerEngineering/Sync/Sync"
+	"github.com/howeyc/gopass"
+	"golang.org/x/crypto/ssh"
 )
 
 func main() {
 
 	// Show the current version:
-	log.Println(`Sync v1.1.0`)
+	log.Println(`Sync v1.3.2`)
 
 	// Allow Go to use all CPUs:
 	runtime.GOMAXPROCS(runtime.NumCPU())
@@ -23,6 +27,7 @@ func main() {
 	// Check if the directories are provided:
 	if localDir == `` || remoteDir == `` {
 		log.Println(`Please provide the local and remote directory.`)
+		os.Exit(1)
 		return
 	}
 
@@ -30,6 +35,7 @@ func main() {
 	if localDir == `.` {
 		if currentWD, currentWDError := os.Getwd(); currentWDError != nil {
 			log.Println("Cannot use the current working directory as local directory: " + currentWDError.Error())
+			os.Exit(2)
 			return
 		} else {
 			log.Println("I use the current working directory as local directory: " + currentWD)
@@ -44,10 +50,12 @@ func main() {
 	// Check if local dir exist
 	if dirInfo, dirError := os.Stat(localDir); dirError != nil {
 		log.Println("There is an error with the local directory: " + dirError.Error())
+		os.Exit(3)
 		return
 	} else {
 		if !dirInfo.IsDir() {
 			log.Println("There is an error with the local directory: You provided a file instead!")
+			os.Exit(4)
 			return
 		}
 	}
@@ -57,7 +65,13 @@ func main() {
 		if password == `` {
 			// Promt for the password:
 			fmt.Print(`Please provide the password for the connection: `)
-			fmt.Scanln(&password)
+			if pass, errPass := gopass.GetPasswd(); errPass != nil {
+				log.Println(`There was an error reading the password securely: ` + errPass.Error())
+				os.Exit(5)
+				return
+			} else {
+				password = string(pass)
+			}
 		} else {
 			break
 		}
@@ -85,12 +99,14 @@ func main() {
 			ssh.PasswordCallback(Sync.PasswordCallback),
 			ssh.KeyboardInteractive(Sync.KeyboardInteractiveChallenge),
 		},
+		HostKeyCallback: showHostKey(),
 	}
 
 	// Connect to the SSH server:
 	ssh := Sync.ConnectSSH(config, serverAddrString)
 	if ssh == nil {
 		log.Println(`It was not possible to connect to the SSH server.`)
+		os.Exit(6)
 		return
 	}
 
@@ -98,3 +114,11 @@ func main() {
 	Sync.Synchronise(ssh, supervised, pushOnly, localDir, remoteDir)
 	log.Println("Synchronising done.")
 }
+
+func showHostKey() ssh.HostKeyCallback {
+	return func(hostname string, remote net.Addr, key ssh.PublicKey) error {
+		log.Printf("Your server's hostname is %s (%s) and its public key is %s. If this is wrong, please abort the program now! Wait 16 seconds for your check.", hostname, remote.String(), ssh.FingerprintSHA256(key))
+		time.Sleep(16 * time.Second)
+		return nil
+	}
+}

README.md

@@ -2,24 +2,24 @@
 This is a simple SFTP synchronisation tool **without** any external dependencies e.g. PuTTY, WinSCP, OpenSSH. Just download the executable which matches your OS and architecture (32 vs. 64 bits) and run it.
 
 ## Syntax
-Sync provids a few arguments:
-- ``localDir`` defines the local directory e.g. ``c:\Users\A\My Documents`` or ``/users/A/My Documents``. If you omit or set it to ``.``, the current working directory gets used.
-- ``remoteDir`` is the remote directory e.g. ``/users/A/Sync``.
-- ``server`` is the SSH server e.g. ``my-server.com:22``.
-- Use ``user`` to set the user's name and ``pwd`` to set the user's password. You can omit the ``pwd``, thus, the program ask for the password on demand.
-- With the argument ``supervised`` you can control if the program should ask you for every type of change. The default is the supervised operating mode. In order to disable it, use ``supervised=false``.
-- Finnaly, the ``pushOnly`` argument can be used to set the **backup mode**, where all remote changes are ignored. The default is the enabled backup mode. In order to sync changes in both directions, set ``pushOnly=false``.
+Sync uses several parameters:
+- The `localDir` parameter defines the local directory e.g. `c:\Users\A\My Documents` or `/users/A/My Documents`. If you omit or set it to `.`, the current working directory gets used.
+- The `remoteDir` parameter sets the remote directory e.g. `/users/A/Sync`.
+- The `server` parameter is the SSH server e.g. `my-server.com:22`.
+- Use the `user` parameter to set the user's name and `pwd` to set the user's password. You can omit the `pwd` and the program ask for the password on demand.
+- The parameter `supervised` controls if the program should ask you for every type of change. The default is the supervised operating mode. In order to disable it, use `supervised=false`.
+- Finnaly, the `pushOnly` argument can be used to set the **backup mode**, where all remote changes are ignored, which is the default. In order to sync changes in both directions, use `pushOnly=false`.
 
 ## Features
 - The whole code is open source and can be used for any purpose (also commercial)
 - If you want, you can compile the code by your own by using the [Go](http://www.golang.org)
-- The program just needs very low resources e.g. around 14 MB memory for Microsoft Windows 10 to sync roughly 6000 files. More files need more memory, because the meta information must keep in memory.
-- If a connection cannot setup, the program re-tries it
-- At the moment, SSHTunnel uses only the password authentication methods. Therefore, it is currently not possible to use e.g. a certificate, etc. Nevertheless, the implementation of this feature is possible.
+- The program needs very low resources e.g. around 14 MB of memory on Microsoft Windows 10 to sync roughly 6,000 files. More files need more memory, because the meta information must keep in memory.
+- If a connection cannot set up, the program re-tries it.
+- At the moment, Sync uses only the password authentication methods. Therefore, it is currently not possible to use e.g. a certificate, etc. Nevertheless, the implementation of this feature is possible.
 - The configuration must be provided by using the command-line arguments. It is currently not possible to use e.g. a configuration file.
 - You can avoid the password argument if you prefer to provide the password on demand.
-- Sync can be used in **backup mode** where all remote changes are ignored or in the **full mode**, where both directions gets synchronised.
-- Use the **supervised mode** in order to get the full control
+- Sync can be used in **backup mode** where all remote changes are ignored or in the **full mode**, where both directions gets synchronized.
+- Use the **supervised mode** in order to get the full control about any change.
 
 ## Download
-Go and get the latest release from the [release page](https://github.com/SommerEngineering/Sync/releases). Sync use the [SFTP library](https://github.com/pkg/sftp) from Dave Cheney. Thanks very much for the good work!
+Go and get the latest release from the [release page](https://github.com/SommerEngineering/Sync/releases). Sync use the [SFTP library](https://github.com/pkg/sftp) from Dave Cheney. Thanks very much for the great work!

Sync/ByLength.go

@@ -0,0 +1,16 @@
+package Sync
+
+type ByLength []string
+
+func (s ByLength) Len() int {
+	return len(s)
+}
+
+func (s ByLength) Swap(i, j int) {
+	s[i], s[j] = s[j], s[i]
+}
+
+// Longer strings will appear first.
+func (s ByLength) Less(i, j int) bool {
+	return len(s[i]) > len(s[j])
+}

Sync/NormalisePath.go

@@ -7,6 +7,12 @@ import (
 
 func normalisePath(base, path string) string {
 	result := strings.Replace(path, base, ``, 1)
+
+	// Ensure that the path starts with a slash:
+	if len(result) > 1 && result[0:1] != `/` {
+		result = filepath.Join(`/`, result)
+	}
+
 	result = filepath.ToSlash(result)
 	return strings.ToLower(result)
 }

Sync/Synchronise.go

@@ -2,8 +2,6 @@ package Sync
 
 import (
 	"fmt"
-	"github.com/pkg/sftp"
-	"golang.org/x/crypto/ssh"
 	"io"
 	"log"
 	"os"
@@ -11,6 +9,9 @@ import (
 	"sort"
 	"strings"
 	"time"
+
+	"github.com/pkg/sftp"
+	"golang.org/x/crypto/ssh"
 )
 
 func Synchronise(ssh *ssh.Client, supervised, pushOnly bool, localDir, remoteDir string) {
@@ -66,6 +67,7 @@ func Synchronise(ssh *ssh.Client, supervised, pushOnly bool, localDir, remoteDir
 	sftp, sftpError := sftp.NewClient(ssh)
 	if sftpError != nil {
 		log.Println("Was not able to connect to the server: " + sftpError.Error())
+		os.Exit(7)
 		return
 	}
 
@@ -155,7 +157,7 @@ func Synchronise(ssh *ssh.Client, supervised, pushOnly bool, localDir, remoteDir
 	log.Printf("Found %d remote files to delete.\n", len(deleteRemoteFiles))
 
 	if len(deleteRemoteFiles) > 0 {
-		sort.Strings(deleteRemoteFiles)
+		sort.Sort(ByLength(deleteRemoteFiles))
 		shouldDeleteRemoteFiles := true
 		if supervised {
 			fmt.Println(`=================================================================`)
@@ -192,7 +194,6 @@ func Synchronise(ssh *ssh.Client, supervised, pushOnly bool, localDir, remoteDir
 					continue
 				}
 
-				// TODO: Does not work: File an issue!
 				removeError := sftp.Remove(normalised2remoteFiles[remoteFileNormalised] + `/`)
 				if removeError != nil {
 					log.Printf("Was not able to delete the remote directory %s: %s\n", normalised2remoteFiles[remoteFileNormalised], removeError.Error())