Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve parsing of config paths #8

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve parsing of config paths #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dca1c20
Allow configuration/command-line paths other than root to be absolute
oblivioncth Jul 6, 2024
f00430d
Simplify ServerSettings parsing and processing
oblivioncth Jul 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 38 additions & 59 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import (
"net/http/httptest"
"net/url"
"os"
"path"
"path/filepath"
"strings"
"time"
Expand Down Expand Up @@ -69,77 +68,57 @@ func initServer() {
panic(err)
}

// Unmarshal the JSON data into a Config struct
// Unmarshal the JSON data (default values) into a Config struct
err = json.Unmarshal(data, &serverSettings)
if err != nil {
panic(err)
}

// Get all of the parameters passed in
// TODO: Figure out a way to (partially?) automate everything that's going on below
// Match command-line flags to their respective values
// TODO: Figure out a way to automate everything that's going on below
// TODO: Improve descriptions
rootPath := flag.String("rootPath", serverSettings.RootPath, "The path that other relative paths use as a base")
gameDataPath := flag.String("gameRootPath", serverSettings.GameDataPath, "This is the path where to find the zips")
legacyPHPPath := flag.String("legacyPHPPath", serverSettings.LegacyPHPPath, "This is the path for PHP")
legacyCGIBINPath := flag.String("legacyCGIBINPath", serverSettings.LegacyCGIBINPath, "This is the path for CGI-BIN")
legacyHTDOCSPath := flag.String("legacyHTDOCSPath", serverSettings.LegacyHTDOCSPath, "This is the path for HTDOCS")
phpCgiPath := flag.String("phpCgiPath", serverSettings.PhpCgiPath, "Path to PHP CGI executable")
useInfinityServer := flag.Bool("useInfinityServer", serverSettings.UseInfinityServer, "Whether to use the infinity server or not")
infinityServerURL := flag.String("infinityServerURL", serverSettings.InfinityServerURL, "The URL of the infinity server")
handleLegacyRequests := flag.Bool("handleLegacyRequests", serverSettings.HandleLegacyRequests, "Whether to handle legacy requests internally (true) or externally (false)")
externalLegacyPort := flag.String("externalLegacyPort", serverSettings.ExternalLegacyPort, "The port that the external legacy server is running on (if handling legacy is disabled).")
proxyPort := flag.String("proxyPort", serverSettings.ProxyPort, "proxy listen port")
serverHttpPort := flag.String("serverHttpPort", serverSettings.ServerHTTPPort, "zip server http listen port")
useMad4FP := flag.Bool("UseMad4FP", serverSettings.UseMad4FP, "flag to turn on/off Mad4FP.")
enableHttpsProxy := flag.Bool("enableHttpsProxy", serverSettings.EnableHttpsProxy, "Whether to enable HTTPS proxying or not")
allowCrossDomain := flag.Bool("allowCrossDomain", serverSettings.AllowCrossDomain, "Whether to allow cross-domain requests")
verboseLogging := flag.Bool("verboseLogging", serverSettings.VerboseLogging, "should every proxy request be logged to stdout")
apiPrefix := flag.String("apiPrefix", serverSettings.ApiPrefix, "apiPrefix is used to prefix any API call.")

// NOTE: If Go's basic types ever implement the Value interface flag.Var() can be used to avoid passing struct members twice
flag.StringVar(&serverSettings.RootPath, "rootPath", serverSettings.RootPath, "The path that other relative paths use as a base")
flag.StringVar(&serverSettings.GameDataPath, "gameRootPath", serverSettings.GameDataPath, "This is the path where to find the zips")
flag.StringVar(&serverSettings.LegacyPHPPath, "legacyPHPPath", serverSettings.LegacyPHPPath, "This is the path for PHP")
flag.StringVar(&serverSettings.LegacyCGIBINPath, "legacyCGIBINPath", serverSettings.LegacyCGIBINPath, "This is the path for CGI-BIN")
flag.StringVar(&serverSettings.LegacyHTDOCSPath, "legacyHTDOCSPath", serverSettings.LegacyHTDOCSPath, "This is the path for HTDOCS")
flag.StringVar(&serverSettings.PhpCgiPath, "phpCgiPath", serverSettings.PhpCgiPath, "Path to PHP CGI executable")
flag.BoolVar(&serverSettings.UseInfinityServer, "useInfinityServer", serverSettings.UseInfinityServer, "Whether to use the infinity server or not")
flag.StringVar(&serverSettings.InfinityServerURL, "infinityServerURL", serverSettings.InfinityServerURL, "The URL of the infinity server")
flag.BoolVar(&serverSettings.HandleLegacyRequests, "handleLegacyRequests", serverSettings.HandleLegacyRequests, "Whether to handle legacy requests internally (true) or externally (false)")
flag.StringVar(&serverSettings.ExternalLegacyPort, "externalLegacyPort", serverSettings.ExternalLegacyPort, "The port that the external legacy server is running on (if handling legacy is disabled).")
flag.StringVar(&serverSettings.ProxyPort, "proxyPort", serverSettings.ProxyPort, "proxy listen port")
flag.StringVar(&serverSettings.ServerHTTPPort, "serverHttpPort", serverSettings.ServerHTTPPort, "zip server http listen port")
flag.BoolVar(&serverSettings.UseMad4FP, "UseMad4FP", serverSettings.UseMad4FP, "flag to turn on/off Mad4FP.")
flag.BoolVar(&serverSettings.EnableHttpsProxy, "enableHttpsProxy", serverSettings.EnableHttpsProxy, "Whether to enable HTTPS proxying or not")
flag.BoolVar(&serverSettings.AllowCrossDomain, "allowCrossDomain", serverSettings.AllowCrossDomain, "Whether to allow cross-domain requests")
flag.BoolVar(&serverSettings.VerboseLogging, "verboseLogging", serverSettings.VerboseLogging, "should every proxy request be logged to stdout")
flag.StringVar(&serverSettings.ApiPrefix, "apiPrefix", serverSettings.ApiPrefix, "apiPrefix is used to prefix any API call.")

// Override default values with those for which a flag is set
flag.Parse()

// Apply all of the flags to the settings
serverSettings.RootPath, err = filepath.Abs(strings.Trim(*rootPath, "\""))
// Ensure paths are absolute
serverSettings.RootPath, err = filepath.Abs(strings.Trim(serverSettings.RootPath, "\""))
if err != nil {
fmt.Println("Failed to get absolute root path")
panic(err)
}
serverSettings.GameDataPath, err = filepath.Abs(path.Join(serverSettings.RootPath, strings.Trim(*gameDataPath, "\"")))
if err != nil {
fmt.Println("Failed to get absolute game data path")
panic(err)
}
serverSettings.LegacyPHPPath, err = filepath.Abs(path.Join(serverSettings.RootPath, strings.Trim(*legacyPHPPath, "\"")))
if err != nil {
fmt.Println("Failed to get absolute PHP path")
panic(err)
}
serverSettings.LegacyCGIBINPath, err = filepath.Abs(path.Join(serverSettings.RootPath, strings.Trim(*legacyCGIBINPath, "\"")))
if err != nil {
fmt.Println("Failed to get absolute cgi-bin path")
panic(err)
}
serverSettings.LegacyHTDOCSPath, err = filepath.Abs(path.Join(serverSettings.RootPath, strings.Trim(*legacyHTDOCSPath, "\"")))
if err != nil {
fmt.Println("Failed to get absolute htdocs path")
panic(err)
}
serverSettings.PhpCgiPath, err = filepath.Abs(path.Join(serverSettings.RootPath, strings.Trim(*phpCgiPath, "\"")))
if err != nil {
fmt.Println("Failed to get absolute PHP-CGI path")
panic(err)

makeConfigPathAbs := func(p *string) {
if filepath.IsAbs(*p) {
*p = filepath.Clean(*p)
} else {
*p = filepath.Join(serverSettings.RootPath, strings.Trim(*p, "\"")) // Join also calls Clean
}
}
serverSettings.UseInfinityServer = *useInfinityServer
serverSettings.InfinityServerURL = *infinityServerURL
serverSettings.HandleLegacyRequests = *handleLegacyRequests
serverSettings.ExternalLegacyPort = *externalLegacyPort
serverSettings.ProxyPort = *proxyPort
serverSettings.ServerHTTPPort = *serverHttpPort
serverSettings.UseMad4FP = *useMad4FP
serverSettings.EnableHttpsProxy = *enableHttpsProxy
serverSettings.AllowCrossDomain = *allowCrossDomain
serverSettings.VerboseLogging = *verboseLogging
serverSettings.ApiPrefix = *apiPrefix

makeConfigPathAbs(&serverSettings.GameDataPath)
makeConfigPathAbs(&serverSettings.LegacyPHPPath)
makeConfigPathAbs(&serverSettings.LegacyCGIBINPath)
makeConfigPathAbs(&serverSettings.LegacyHTDOCSPath)
makeConfigPathAbs(&serverSettings.PhpCgiPath)

// Print out all path settings
fmt.Println("Root Path:", serverSettings.RootPath)
Expand Down