// Copyright 2017 The go-ethereum Authors // This file is part of go-ethereum. // // go-ethereum is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // go-ethereum is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with go-ethereum. If not, see . package main import ( "errors" "fmt" "io" "os" "reflect" "strconv" "strings" "time" "unicode" cli "gopkg.in/urfave/cli.v1" "github.com/ethereum/go-ethereum/cmd/utils" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/log" "github.com/ethereum/go-ethereum/node" "github.com/naoina/toml" bzzapi "github.com/ethereum/go-ethereum/swarm/api" ) var ( //flag definition for the dumpconfig command DumpConfigCommand = cli.Command{ Action: utils.MigrateFlags(dumpConfig), Name: "dumpconfig", Usage: "Show configuration values", ArgsUsage: "", Flags: app.Flags, Category: "MISCELLANEOUS COMMANDS", Description: `The dumpconfig command shows configuration values.`, } //flag definition for the config file command SwarmTomlConfigPathFlag = cli.StringFlag{ Name: "config", Usage: "TOML configuration file", } ) //constants for environment variables const ( SwarmEnvChequebookAddr = "SWARM_CHEQUEBOOK_ADDR" SwarmEnvAccount = "SWARM_ACCOUNT" SwarmEnvListenAddr = "SWARM_LISTEN_ADDR" SwarmEnvPort = "SWARM_PORT" SwarmEnvNetworkID = "SWARM_NETWORK_ID" SwarmEnvSwapEnable = "SWARM_SWAP_ENABLE" SwarmEnvSwapAPI = "SWARM_SWAP_API" SwarmEnvSyncDisable = "SWARM_SYNC_DISABLE" SwarmEnvSyncUpdateDelay = "SWARM_ENV_SYNC_UPDATE_DELAY" SwarmEnvMaxStreamPeerServers = "SWARM_ENV_MAX_STREAM_PEER_SERVERS" SwarmEnvLightNodeEnable = "SWARM_LIGHT_NODE_ENABLE" SwarmEnvDeliverySkipCheck = "SWARM_DELIVERY_SKIP_CHECK" SwarmEnvENSAPI = "SWARM_ENS_API" SwarmEnvENSAddr = "SWARM_ENS_ADDR" SwarmEnvCORS = "SWARM_CORS" SwarmEnvBootnodes = "SWARM_BOOTNODES" SwarmEnvPSSEnable = "SWARM_PSS_ENABLE" SwarmEnvStorePath = "SWARM_STORE_PATH" SwarmEnvStoreCapacity = "SWARM_STORE_CAPACITY" SwarmEnvStoreCacheCapacity = "SWARM_STORE_CACHE_CAPACITY" SwarmEnvBootnodeMode = "SWARM_BOOTNODE_MODE" SwarmAccessPassword = "SWARM_ACCESS_PASSWORD" SwarmAutoDefaultPath = "SWARM_AUTO_DEFAULTPATH" SwarmGlobalstoreAPI = "SWARM_GLOBALSTORE_API" GethEnvDataDir = "GETH_DATADIR" ) // These settings ensure that TOML keys use the same names as Go struct fields. var tomlSettings = toml.Config{ NormFieldName: func(rt reflect.Type, key string) string { return key }, FieldToKey: func(rt reflect.Type, field string) string { return field }, MissingField: func(rt reflect.Type, field string) error { link := "" if unicode.IsUpper(rune(rt.Name()[0])) && rt.PkgPath() != "main" { link = fmt.Sprintf(", check github.com/ethereum/go-ethereum/swarm/api/config.go for available fields") } return fmt.Errorf("field '%s' is not defined in %s%s", field, rt.String(), link) }, } //before booting the swarm node, build the configuration func buildConfig(ctx *cli.Context) (config *bzzapi.Config, err error) { //start by creating a default config config = bzzapi.NewConfig() //first load settings from config file (if provided) config, err = configFileOverride(config, ctx) if err != nil { return nil, err } //override settings provided by environment variables config = envVarsOverride(config) //override settings provided by command line config = cmdLineOverride(config, ctx) //validate configuration parameters err = validateConfig(config) return } //finally, after the configuration build phase is finished, initialize func initSwarmNode(config *bzzapi.Config, stack *node.Node, ctx *cli.Context) { //at this point, all vars should be set in the Config //get the account for the provided swarm account prvkey := getAccount(config.BzzAccount, ctx, stack) //set the resolved config path (geth --datadir) config.Path = expandPath(stack.InstanceDir()) //finally, initialize the configuration config.Init(prvkey) //configuration phase completed here log.Debug("Starting Swarm with the following parameters:") //after having created the config, print it to screen log.Debug(printConfig(config)) } //configFileOverride overrides the current config with the config file, if a config file has been provided func configFileOverride(config *bzzapi.Config, ctx *cli.Context) (*bzzapi.Config, error) { var err error //only do something if the -config flag has been set if ctx.GlobalIsSet(SwarmTomlConfigPathFlag.Name) { var filepath string if filepath = ctx.GlobalString(SwarmTomlConfigPathFlag.Name); filepath == "" { utils.Fatalf("Config file flag provided with invalid file path") } var f *os.File f, err = os.Open(filepath) if err != nil { return nil, err } defer f.Close() //decode the TOML file into a Config struct //note that we are decoding into the existing defaultConfig; //if an entry is not present in the file, the default entry is kept err = tomlSettings.NewDecoder(f).Decode(&config) // Add file name to errors that have a line number. if _, ok := err.(*toml.LineError); ok { err = errors.New(filepath + ", " + err.Error()) } } return config, err } // cmdLineOverride overrides the current config with whatever is provided through the command line // most values are not allowed a zero value (empty string), if not otherwise noted func cmdLineOverride(currentConfig *bzzapi.Config, ctx *cli.Context) *bzzapi.Config { if keyid := ctx.GlobalString(SwarmAccountFlag.Name); keyid != "" { currentConfig.BzzAccount = keyid } if chbookaddr := ctx.GlobalString(ChequebookAddrFlag.Name); chbookaddr != "" { currentConfig.Contract = common.HexToAddress(chbookaddr) } if networkid := ctx.GlobalString(SwarmNetworkIdFlag.Name); networkid != "" { id, err := strconv.ParseUint(networkid, 10, 64) if err != nil { utils.Fatalf("invalid cli flag %s: %v", SwarmNetworkIdFlag.Name, err) } if id != 0 { currentConfig.NetworkID = id } } if ctx.GlobalIsSet(utils.DataDirFlag.Name) { if datadir := ctx.GlobalString(utils.DataDirFlag.Name); datadir != "" { currentConfig.Path = expandPath(datadir) } } bzzport := ctx.GlobalString(SwarmPortFlag.Name) if len(bzzport) > 0 { currentConfig.Port = bzzport } if bzzaddr := ctx.GlobalString(SwarmListenAddrFlag.Name); bzzaddr != "" { currentConfig.ListenAddr = bzzaddr } if ctx.GlobalIsSet(SwarmSwapEnabledFlag.Name) { currentConfig.SwapEnabled = true } if ctx.GlobalIsSet(SwarmSyncDisabledFlag.Name) { currentConfig.SyncEnabled = false } if d := ctx.GlobalDuration(SwarmSyncUpdateDelay.Name); d > 0 { currentConfig.SyncUpdateDelay = d } // any value including 0 is acceptable currentConfig.MaxStreamPeerServers = ctx.GlobalInt(SwarmMaxStreamPeerServersFlag.Name) if ctx.GlobalIsSet(SwarmLightNodeEnabled.Name) { currentConfig.LightNodeEnabled = true } if ctx.GlobalIsSet(SwarmDeliverySkipCheckFlag.Name) { currentConfig.DeliverySkipCheck = true } currentConfig.SwapAPI = ctx.GlobalString(SwarmSwapAPIFlag.Name) if currentConfig.SwapEnabled && currentConfig.SwapAPI == "" { utils.Fatalf(SwarmErrSwapSetNoAPI) } if ctx.GlobalIsSet(EnsAPIFlag.Name) { ensAPIs := ctx.GlobalStringSlice(EnsAPIFlag.Name) // preserve backward compatibility to disable ENS with --ens-api="" if len(ensAPIs) == 1 && ensAPIs[0] == "" { ensAPIs = nil } for i := range ensAPIs { ensAPIs[i] = expandPath(ensAPIs[i]) } currentConfig.EnsAPIs = ensAPIs } if cors := ctx.GlobalString(CorsStringFlag.Name); cors != "" { currentConfig.Cors = cors } if storePath := ctx.GlobalString(SwarmStorePath.Name); storePath != "" { currentConfig.LocalStoreParams.ChunkDbPath = storePath } if storeCapacity := ctx.GlobalUint64(SwarmStoreCapacity.Name); storeCapacity != 0 { currentConfig.LocalStoreParams.DbCapacity = storeCapacity } if ctx.GlobalIsSet(SwarmStoreCacheCapacity.Name) { currentConfig.LocalStoreParams.CacheCapacity = ctx.GlobalUint(SwarmStoreCacheCapacity.Name) } if ctx.GlobalIsSet(SwarmBootnodeModeFlag.Name) { currentConfig.BootnodeMode = ctx.GlobalBool(SwarmBootnodeModeFlag.Name) } if ctx.GlobalIsSet(SwarmGlobalStoreAPIFlag.Name) { currentConfig.GlobalStoreAPI = ctx.GlobalString(SwarmGlobalStoreAPIFlag.Name) } return currentConfig } // envVarsOverride overrides the current config with whatver is provided in environment variables // most values are not allowed a zero value (empty string), if not otherwise noted func envVarsOverride(currentConfig *bzzapi.Config) (config *bzzapi.Config) { if keyid := os.Getenv(SwarmEnvAccount); keyid != "" { currentConfig.BzzAccount = keyid } if chbookaddr := os.Getenv(SwarmEnvChequebookAddr); chbookaddr != "" { currentConfig.Contract = common.HexToAddress(chbookaddr) } if networkid := os.Getenv(SwarmEnvNetworkID); networkid != "" { id, err := strconv.ParseUint(networkid, 10, 64) if err != nil { utils.Fatalf("invalid environment variable %s: %v", SwarmEnvNetworkID, err) } if id != 0 { currentConfig.NetworkID = id } } if datadir := os.Getenv(GethEnvDataDir); datadir != "" { currentConfig.Path = expandPath(datadir) } bzzport := os.Getenv(SwarmEnvPort) if len(bzzport) > 0 { currentConfig.Port = bzzport } if bzzaddr := os.Getenv(SwarmEnvListenAddr); bzzaddr != "" { currentConfig.ListenAddr = bzzaddr } if swapenable := os.Getenv(SwarmEnvSwapEnable); swapenable != "" { swap, err := strconv.ParseBool(swapenable) if err != nil { utils.Fatalf("invalid environment variable %s: %v", SwarmEnvSwapEnable, err) } currentConfig.SwapEnabled = swap } if syncdisable := os.Getenv(SwarmEnvSyncDisable); syncdisable != "" { sync, err := strconv.ParseBool(syncdisable) if err != nil { utils.Fatalf("invalid environment variable %s: %v", SwarmEnvSyncDisable, err) } currentConfig.SyncEnabled = !sync } if v := os.Getenv(SwarmEnvDeliverySkipCheck); v != "" { skipCheck, err := strconv.ParseBool(v) if err != nil { currentConfig.DeliverySkipCheck = skipCheck } } if v := os.Getenv(SwarmEnvSyncUpdateDelay); v != "" { d, err := time.ParseDuration(v) if err != nil { utils.Fatalf("invalid environment variable %s: %v", SwarmEnvSyncUpdateDelay, err) } currentConfig.SyncUpdateDelay = d } if max := os.Getenv(SwarmEnvMaxStreamPeerServers); max != "" { m, err := strconv.Atoi(max) if err != nil { utils.Fatalf("invalid environment variable %s: %v", SwarmEnvMaxStreamPeerServers, err) } currentConfig.MaxStreamPeerServers = m } if lne := os.Getenv(SwarmEnvLightNodeEnable); lne != "" { lightnode, err := strconv.ParseBool(lne) if err != nil { utils.Fatalf("invalid environment variable %s: %v", SwarmEnvLightNodeEnable, err) } currentConfig.LightNodeEnabled = lightnode } if swapapi := os.Getenv(SwarmEnvSwapAPI); swapapi != "" { currentConfig.SwapAPI = swapapi } if currentConfig.SwapEnabled && currentConfig.SwapAPI == "" { utils.Fatalf(SwarmErrSwapSetNoAPI) } if ensapi := os.Getenv(SwarmEnvENSAPI); ensapi != "" { currentConfig.EnsAPIs = strings.Split(ensapi, ",") } if ensaddr := os.Getenv(SwarmEnvENSAddr); ensaddr != "" { currentConfig.EnsRoot = common.HexToAddress(ensaddr) } if cors := os.Getenv(SwarmEnvCORS); cors != "" { currentConfig.Cors = cors } if bm := os.Getenv(SwarmEnvBootnodeMode); bm != "" { bootnodeMode, err := strconv.ParseBool(bm) if err != nil { utils.Fatalf("invalid environment variable %s: %v", SwarmEnvBootnodeMode, err) } currentConfig.BootnodeMode = bootnodeMode } if api := os.Getenv(SwarmGlobalstoreAPI); api != "" { currentConfig.GlobalStoreAPI = api } return currentConfig } // dumpConfig is the dumpconfig command. // writes a default config to STDOUT func dumpConfig(ctx *cli.Context) error { cfg, err := buildConfig(ctx) if err != nil { utils.Fatalf(fmt.Sprintf("Uh oh - dumpconfig triggered an error %v", err)) } comment := "" out, err := tomlSettings.Marshal(&cfg) if err != nil { return err } io.WriteString(os.Stdout, comment) os.Stdout.Write(out) return nil } //validate configuration parameters func validateConfig(cfg *bzzapi.Config) (err error) { for _, ensAPI := range cfg.EnsAPIs { if ensAPI != "" { if err := validateEnsAPIs(ensAPI); err != nil { return fmt.Errorf("invalid format [tld:][contract-addr@]url for ENS API endpoint configuration %q: %v", ensAPI, err) } } } return nil } //validate EnsAPIs configuration parameter func validateEnsAPIs(s string) (err error) { // missing contract address if strings.HasPrefix(s, "@") { return errors.New("missing contract address") } // missing url if strings.HasSuffix(s, "@") { return errors.New("missing url") } // missing tld if strings.HasPrefix(s, ":") { return errors.New("missing tld") } // missing url if strings.HasSuffix(s, ":") { return errors.New("missing url") } return nil } //print a Config as string func printConfig(config *bzzapi.Config) string { out, err := tomlSettings.Marshal(&config) if err != nil { return fmt.Sprintf("Something is not right with the configuration: %v", err) } return string(out) }