package ipfshttp import ( "encoding/json" "errors" "fmt" "time" "github.com/ipfs/ipfs-cluster/config" ma "github.com/multiformats/go-multiaddr" ) const configKey = "ipfshttp" // Default values for Config. const ( DefaultNodeAddr = "/ip4/127.0.0.1/tcp/5001" DefaultConnectSwarmsDelay = 30 * time.Second DefaultPinMethod = "refs" DefaultIPFSRequestTimeout = 5 * time.Minute DefaultPinTimeout = 24 * time.Hour DefaultUnpinTimeout = 3 * time.Hour ) // Config is used to initialize a Connector and allows to customize // its behaviour. It implements the config.ComponentConfig interface. type Config struct { config.Saver // Host/Port for the IPFS daemon. NodeAddr ma.Multiaddr // ConnectSwarmsDelay specifies how long to wait after startup before // attempting to open connections from this peer's IPFS daemon to the // IPFS daemons of other peers. ConnectSwarmsDelay time.Duration // "pin" or "refs". "pin" uses a "pin/add" call. "refs" uses a // "refs -r" call followed by "pin/add". "refs" allows fetching in // parallel but should be used with GC disabled. PinMethod string // IPFS Daemon HTTP Client POST timeout IPFSRequestTimeout time.Duration // Pin Operation timeout PinTimeout time.Duration // Unpin Operation timeout UnpinTimeout time.Duration } type jsonConfig struct { NodeMultiaddress string `json:"node_multiaddress"` ConnectSwarmsDelay string `json:"connect_swarms_delay"` PinMethod string `json:"pin_method"` IPFSRequestTimeout string `json:"ipfs_request_timeout"` PinTimeout string `json:"pin_timeout"` UnpinTimeout string `json:"unpin_timeout"` } // ConfigKey provides a human-friendly identifier for this type of Config. func (cfg *Config) ConfigKey() string { return configKey } // Default sets the fields of this Config to sensible default values. func (cfg *Config) Default() error { node, _ := ma.NewMultiaddr(DefaultNodeAddr) cfg.NodeAddr = node cfg.ConnectSwarmsDelay = DefaultConnectSwarmsDelay cfg.PinMethod = DefaultPinMethod cfg.IPFSRequestTimeout = DefaultIPFSRequestTimeout cfg.PinTimeout = DefaultPinTimeout cfg.UnpinTimeout = DefaultUnpinTimeout return nil } // Validate checks that the fields of this Config have sensible values, // at least in appearance. func (cfg *Config) Validate() error { var err error if cfg.NodeAddr == nil { err = errors.New("ipfshttp.node_multiaddress not set") } if cfg.ConnectSwarmsDelay < 0 { err = errors.New("ipfshttp.connect_swarms_delay is invalid") } switch cfg.PinMethod { case "refs", "pin": default: err = errors.New("ipfshttp.pin_method invalid value") } if cfg.IPFSRequestTimeout < 0 { err = errors.New("ipfshttp.ipfs_request_timeout invalid") } if cfg.PinTimeout < 0 { err = errors.New("ipfshttp.pin_timeout invalid") } if cfg.UnpinTimeout < 0 { err = errors.New("ipfshttp.unpin_timeout invalid") } return err } // LoadJSON parses a JSON representation of this Config as generated by ToJSON. func (cfg *Config) LoadJSON(raw []byte) error { jcfg := &jsonConfig{} err := json.Unmarshal(raw, jcfg) if err != nil { logger.Error("Error unmarshaling ipfshttp config") return err } cfg.Default() nodeAddr, err := ma.NewMultiaddr(jcfg.NodeMultiaddress) if err != nil { return fmt.Errorf("error parsing ipfs_node_multiaddress: %s", err) } cfg.NodeAddr = nodeAddr err = config.ParseDurations( "ipfshttp", &config.DurationOpt{Duration: jcfg.ConnectSwarmsDelay, Dst: &cfg.ConnectSwarmsDelay, Name: "connect_swarms_delay"}, &config.DurationOpt{Duration: jcfg.IPFSRequestTimeout, Dst: &cfg.IPFSRequestTimeout, Name: "ipfs_request_timeout"}, &config.DurationOpt{Duration: jcfg.PinTimeout, Dst: &cfg.PinTimeout, Name: "pin_timeout"}, &config.DurationOpt{Duration: jcfg.UnpinTimeout, Dst: &cfg.UnpinTimeout, Name: "unpin_timeout"}, ) if err != nil { return err } config.SetIfNotDefault(jcfg.PinMethod, &cfg.PinMethod) return cfg.Validate() } // ToJSON generates a human-friendly JSON representation of this Config. func (cfg *Config) ToJSON() (raw []byte, err error) { // Multiaddress String() may panic defer func() { if r := recover(); r != nil { err = fmt.Errorf("%s", r) } }() jcfg := &jsonConfig{} // Set all configuration fields jcfg.NodeMultiaddress = cfg.NodeAddr.String() jcfg.ConnectSwarmsDelay = cfg.ConnectSwarmsDelay.String() jcfg.PinMethod = cfg.PinMethod jcfg.IPFSRequestTimeout = cfg.IPFSRequestTimeout.String() jcfg.PinTimeout = cfg.PinTimeout.String() jcfg.UnpinTimeout = cfg.UnpinTimeout.String() raw, err = config.DefaultJSONMarshal(jcfg) return }