Allow changing of configuration file for docker #292, refactoring, comments

Author: Forceu

cmd/cli-uploader/Main.go

@@ -6,14 +6,14 @@ import (
 	"fmt"
 	"github.com/forceu/gokapi/cmd/cli-uploader/cliapi"
 	"github.com/forceu/gokapi/cmd/cli-uploader/cliconfig"
+	"github.com/forceu/gokapi/cmd/cli-uploader/cliconstants"
 	"github.com/forceu/gokapi/cmd/cli-uploader/cliflags"
 	"github.com/forceu/gokapi/internal/environment"
 	"github.com/forceu/gokapi/internal/helper"
 	"os"
 )
 
 func main() {
-	cliflags.Init(cliconfig.DockerFolderConfigFile, cliconfig.DockerFolderUpload)
 	mode := cliflags.Parse()
 	switch mode {
 	case cliflags.ModeLogin:
@@ -72,11 +72,15 @@ func checkDockerFolders() {
 	if !environment.IsDockerInstance() {
 		return
 	}
-	if !helper.FolderExists(cliconfig.DockerFolderConfig) {
+	_, isDefault := cliflags.GetConfigLocation()
+	if !isDefault {
+		return
+	}
+	if !helper.FolderExists(cliconstants.DockerFolderConfig) {
 		fmt.Println("Warning: Docker folder does not exist, configuration will be lost when creating a new container")
-		helper.CreateDir(cliconfig.DockerFolderConfig)
+		helper.CreateDir(cliconstants.DockerFolderConfig)
 	}
-	if !helper.FolderExists(cliconfig.DockerFolderUpload) {
-		helper.CreateDir(cliconfig.DockerFolderUpload)
+	if !helper.FolderExists(cliconstants.DockerFolderUpload) {
+		helper.CreateDir(cliconstants.DockerFolderUpload)
 	}
 }

cmd/cli-uploader/cliapi/cliapi.go

@@ -33,19 +33,32 @@ type header struct {
 	Value string
 }
 
+// EInvalidRequest is returned when the API returns a 400
+var EInvalidRequest = errors.New("400 Bad Request")
+
+// EUnauthorised is returned when the API returns a 401
 var EUnauthorised = errors.New("unauthorised")
+
+// ENotFound is returned when the API returns a 404
 var ENotFound = errors.New("404 Not Found")
-var EInvalidRequest = errors.New("400 Bad Request")
+
+// EFileTooBig is returned when the file size exceeds the allowed limit
 var EFileTooBig = errors.New("file too big")
+
+// EE2eKeyIncorrect is returned when the e2e key is incorrect
 var EE2eKeyIncorrect = errors.New("e2e key incorrect")
 
+// Init initialises the API client with the given url and key.
+// The key is used for authentication.
+// The end2endKey is used for end-to-end encryption.
 func Init(url, key string, end2endKey []byte) {
 	gokapiUrl = strings.TrimSuffix(url, "/") + "/api"
 	apiKey = key
 	e2eKey = end2endKey
 
 }
 
+// GetVersion returns the version of the Gokapi server
 func GetVersion() (string, int, error) {
 	result, err := getUrl(gokapiUrl+"/info/version", []header{}, false)
 	if err != nil {
@@ -66,6 +79,7 @@ func GetVersion() (string, int, error) {
 	return parsedResult.Version, parsedResult.VersionInt, nil
 }
 
+// GetConfig returns the upload configuration of the Gokapi server
 func GetConfig() (int, int, bool, error) {
 	result, err := getUrl(gokapiUrl+"/info/config", []header{}, false)
 	if err != nil {
@@ -123,6 +137,7 @@ func getUrl(url string, headers []header, longTimeout bool) (string, error) {
 	return string(body), nil
 }
 
+// UploadFile uploads a file to the Gokapi server
 func UploadFile(uploadParams cliflags.UploadConfig) (models.FileApiOutput, error) {
 	var progressBar *progressbar.ProgressBar
 	file, err := os.OpenFile(uploadParams.File, os.O_RDONLY, 0664)
@@ -313,6 +328,7 @@ func completeChunk(uid, filename string, filesize, realsize int64, useE2e bool,
 	return parsedResult.FileInfo, nil
 }
 
+// GetE2eInfo returns the end-to-end encryption information of the Gokapi server for this user
 func GetE2eInfo() (models.E2EInfoPlainText, error) {
 	var result models.E2EInfoEncrypted
 	var fileInfo models.E2EInfoPlainText

cmd/cli-uploader/cliconfig/cliconfig.go

@@ -6,25 +6,23 @@ import (
 	"errors"
 	"fmt"
 	"github.com/forceu/gokapi/cmd/cli-uploader/cliapi"
+	"github.com/forceu/gokapi/cmd/cli-uploader/cliconstants"
 	"github.com/forceu/gokapi/cmd/cli-uploader/cliflags"
 	"github.com/forceu/gokapi/internal/helper"
 	"os"
 	"strings"
 )
 
-const minGokapiVersionInt = 20100
-const minGokapiVersionStr = "2.1.0"
-
-const DockerFolderConfig = "/app/config/"
-const DockerFolderConfigFile = DockerFolderConfig + "config.json"
-const DockerFolderUpload = "/upload/"
-
 type configFile struct {
 	Url    string `json:"Url"`
 	Apikey string `json:"Apikey"`
 	E2ekey []byte `json:"E2Ekey"`
 }
 
+// CreateLogin creates a login for the CLI.
+// It will ask the user for the URL and API key.
+// It will then test the connection and download the configuration.
+// If the configuration is valid, the login information will be saved.
 func CreateLogin() {
 	fmt.Print("Gokapi URL: ")
 	url := helper.ReadLine()
@@ -67,8 +65,8 @@ func CreateLogin() {
 		os.Exit(1)
 	}
 
-	if vint < minGokapiVersionInt {
-		fmt.Println("\nERROR: Gokapi version must be at least " + minGokapiVersionStr)
+	if vint < cliconstants.MinGokapiVersionInt {
+		fmt.Println("\nERROR: Gokapi version must be at least " + cliconstants.MinGokapiVersionStr)
 		fmt.Println("Your version is " + vstr)
 		os.Exit(1)
 	}
@@ -129,16 +127,20 @@ func save(url, apikey string, e2ekey []byte) error {
 		return err
 	}
 
-	return os.WriteFile(cliflags.GetConfigLocation(), jsonData, 0600)
+	configPath, _ := cliflags.GetConfigLocation()
+	return os.WriteFile(configPath, jsonData, 0600)
 }
 
+// Load initialises the configuration by reading login information from a file and setting up CLI API parameters.
+// Verifies the existence of the configuration file and validates its integrity, terminating on errors.
 func Load() {
-	if !helper.FileExists(cliflags.GetConfigLocation()) {
+	configPath, _ := cliflags.GetConfigLocation()
+	if !helper.FileExists(configPath) {
 		fmt.Println("ERROR: No login information found")
 		fmt.Println("Please run 'gokapi-cli login' to create a login")
 		os.Exit(1)
 	}
-	data, err := os.ReadFile(cliflags.GetConfigLocation())
+	data, err := os.ReadFile(configPath)
 	if err != nil {
 		fmt.Println("ERROR: Could not read login information")
 		os.Exit(1)
@@ -154,9 +156,12 @@ func Load() {
 	cliapi.Init(config.Url, config.Apikey, config.E2ekey)
 }
 
+// Delete deletes the login information file.
+// It will return an error if the file exists but could not be deleted.
 func Delete() error {
-	if !helper.FileExists(cliflags.GetConfigLocation()) {
+	configPath, _ := cliflags.GetConfigLocation()
+	if !helper.FileExists(configPath) {
 		return nil
 	}
-	return os.Remove(cliflags.GetConfigLocation())
+	return os.Remove(configPath)
 }

cmd/cli-uploader/cliconstants/cliconstants.go

@@ -0,0 +1,19 @@
+package cliconstants
+
+// MinGokapiVersionInt is the minimum version of the gokapi server that is supported by the cli
+const MinGokapiVersionInt = 20100
+
+// MinGokapiVersionStr is the minimum version of the gokapi server that is supported by the cli
+const MinGokapiVersionStr = "2.1.0"
+
+// DefaultConfigFileName is the default config file name
+const DefaultConfigFileName = "gokapi-cli.json"
+
+// DockerFolderConfig is the default config folder for an docker instance
+const DockerFolderConfig = "/app/config/"
+
+// DockerFolderConfigFile is the default config path for a docker instance
+const DockerFolderConfigFile = DockerFolderConfig + "config.json"
+
+// DockerFolderUpload is the default upload folder for a docker instance
+const DockerFolderUpload = "/upload/"

cmd/cli-uploader/cliflags/cliflags.go

@@ -2,22 +2,25 @@ package cliflags
 
 import (
 	"fmt"
+	"github.com/forceu/gokapi/cmd/cli-uploader/cliconstants"
 	"github.com/forceu/gokapi/internal/environment"
 	"os"
 	"path/filepath"
 	"strconv"
 )
 
 const (
+	// ModeLogin is the mode for the login command
 	ModeLogin = iota
+	// ModeLogout is the mode for the logout command
 	ModeLogout
+	// ModeUpload is the mode for the upload command
 	ModeUpload
+	// ModeInvalid is the mode for an invalid command
 	ModeInvalid
 )
 
-var dockerConfigFile string
-var dockerUploadFolder string
-
+// UploadConfig contains the parameters for the upload command.
 type UploadConfig struct {
 	File            string
 	JsonOutput      bool
@@ -27,11 +30,7 @@ type UploadConfig struct {
 	Password        string
 }
 
-func Init(dockerConfigPath, dockerUploadPath string) {
-	dockerConfigFile = dockerConfigPath
-	dockerUploadFolder = dockerUploadPath
-}
-
+// Parse parses the command line arguments and returns the mode.
 func Parse() int {
 	if len(os.Args) < 2 {
 		printUsage(3)
@@ -52,6 +51,7 @@ func Parse() int {
 	return ModeInvalid
 }
 
+// GetUploadParameters parses the command line arguments and returns the parameters for the upload command.
 func GetUploadParameters() UploadConfig {
 	result := UploadConfig{}
 	for i := 2; i < len(os.Args); i++ {
@@ -90,7 +90,7 @@ func GetUploadParameters() UploadConfig {
 		if environment.IsDockerInstance() {
 			ok, dockerFile := getDockerUpload()
 			if !ok {
-				fmt.Println("ERROR: Missing parameter --file and no file or more than one file found in " + dockerUploadFolder)
+				fmt.Println("ERROR: Missing parameter --file and no file or more than one file found in " + cliconstants.DockerFolderUpload)
 				os.Exit(2)
 			}
 			result.File = dockerFile
@@ -112,7 +112,7 @@ func getDockerUpload() (bool, string) {
 	if !environment.IsDockerInstance() {
 		return false, ""
 	}
-	entries, err := os.ReadDir(dockerUploadFolder)
+	entries, err := os.ReadDir(cliconstants.DockerFolderUpload)
 	if err != nil {
 		return false, ""
 	}
@@ -132,22 +132,23 @@ func getDockerUpload() (bool, string) {
 	if !fileFound {
 		return false, ""
 	}
-	return true, filepath.Join(dockerUploadFolder, fileName)
+	return true, filepath.Join(cliconstants.DockerFolderUpload, fileName)
 }
 
-func GetConfigLocation() string {
-	if environment.IsDockerInstance() {
-		return dockerConfigFile
-	}
+// GetConfigLocation returns the path to the configuration file. Returns true if the default file is used
+func GetConfigLocation() (string, bool) {
 	for i := 2; i < len(os.Args); i++ {
 		switch os.Args[i] {
 		case "-c":
 			fallthrough
 		case "--configuration":
-			return getParameter(&i)
+			return getParameter(&i), false
 		}
 	}
-	return "gokapi-cli.json"
+	if environment.IsDockerInstance() {
+		return cliconstants.DockerFolderConfigFile, true
+	}
+	return cliconstants.DefaultConfigFileName, true
 }
 
 func getParameter(position *int) string {
@@ -183,9 +184,7 @@ func printUsage(exitCode int) {
 
 	fmt.Println("Options:")
 	fmt.Println("  -f, --file <path>               File to upload")
-	if !environment.IsDockerInstance() {
-		fmt.Println("  -c, --configuration <path>      Path to configuration file (default: gokapi-cli.json)")
-	}
+	fmt.Println("  -c, --configuration <path>      Path to configuration file (default: gokapi-cli.json)")
 	fmt.Println("  -j, --json                      Output the result in JSON only")
 	fmt.Println("  -n, --disable-e2e               Disable end-to-end encryption")
 	fmt.Println("  -e, --expiry-days <int>         Set file expiry in days (default: unlimited)")