Add 'offline' argument to Gateway constructor

If offline=true, don't fetch blocks which are not already present in storage. Add --offline-gateway option to `ipfs daemon` License: MIT Signed-off-by: Iaroslav Gridin <voker57@gmail.com>
ipfs · Aug 28, 2017 · 30ac2b7 · 30ac2b7
1 parent a781213
commit 30ac2b7
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 8 deletions.
diff --git a/cmd/ipfs/daemon.go b/cmd/ipfs/daemon.go
@@ -48,6 +48,7 @@ const (
 	writableKwd               = "writable"
 	enableFloodSubKwd         = "enable-pubsub-experiment"
 	enableMultiplexKwd        = "enable-mplex-experiment"
+	offlineGatewayKwd         = "offline-gateway"
 	// apiAddrKwd    = "address-api"
 	// swarmAddrKwd  = "address-swarm"
 )
@@ -148,6 +149,7 @@ Headers.
 		cmds.BoolOption(initOptionKwd, "Initialize ipfs with default settings if not already initialized").Default(false),
 		cmds.StringOption(routingOptionKwd, "Overrides the routing option").Default("dht"),
 		cmds.BoolOption(mountKwd, "Mounts IPFS to the filesystem").Default(false),
+		cmds.BoolOption(offlineGatewayKwd, "Do not fetch blocks for gateway requests").Default(false),
 		cmds.BoolOption(writableKwd, "Enable writing objects (with POST, PUT and DELETE)").Default(false),
 		cmds.StringOption(ipfsMountKwd, "Path to the mountpoint for IPFS (if using --mount). Defaults to config setting."),
 		cmds.StringOption(ipnsMountKwd, "Path to the mountpoint for IPNS (if using --mount). Defaults to config setting."),
@@ -453,9 +455,12 @@ func serveHTTPApi(req cmds.Request) (error, <-chan error) {
 	if err != nil {
 		return fmt.Errorf("serveHTTPApi: Option(%s) failed: %s", unrestrictedApiAccessKwd, err), nil
 	}
-	gatewayOpt := corehttp.GatewayOption(false, corehttp.WebUIPaths...)
+
+	offline, _, err := req.Option(offlineGatewayKwd).Bool()
+
+	gatewayOpt := corehttp.GatewayOption(false, offline, corehttp.WebUIPaths...)
 	if unrestricted {
-		gatewayOpt = corehttp.GatewayOption(true, "/ipfs", "/ipns")
+		gatewayOpt = corehttp.GatewayOption(true, offline, "/ipfs", "/ipns")
 	}
 
 	var opts = []corehttp.ServeOption{
@@ -542,6 +547,8 @@ func serveHTTPGateway(req cmds.Request) (error, <-chan error) {
 		writable = cfg.Gateway.Writable
 	}
 
+	offline, _, err := req.Option(offlineGatewayKwd).Bool()
+
 	gwLis, err := manet.Listen(gatewayMaddr)
 	if err != nil {
 		return fmt.Errorf("serveHTTPGateway: manet.Listen(%s) failed: %s", gatewayMaddr, err), nil
@@ -560,7 +567,7 @@ func serveHTTPGateway(req cmds.Request) (error, <-chan error) {
 		corehttp.CommandsROOption(*req.InvocContext()),
 		corehttp.VersionOption(),
 		corehttp.IPNSHostnameOption(),
-		corehttp.GatewayOption(writable, "/ipfs", "/ipns"),
+		corehttp.GatewayOption(writable, offline, "/ipfs", "/ipns"),
 	}
 
 	if len(cfg.Gateway.RootRedirect) > 0 {

diff --git a/cmd/ipfswatch/main.go b/cmd/ipfswatch/main.go
@@ -88,7 +88,7 @@ func run(ipfsPath, watchPath string) error {
 	if *http {
 		addr := "/ip4/127.0.0.1/tcp/5001"
 		var opts = []corehttp.ServeOption{
-			corehttp.GatewayOption(true, "/ipfs", "/ipns"),
+			corehttp.GatewayOption(true, false, "/ipfs", "/ipns"),
 			corehttp.WebUIOption,
 			corehttp.CommandsOption(cmdCtx(node, ipfsPath)),
 		}

diff --git a/core/corehttp/gateway.go b/core/corehttp/gateway.go
@@ -17,7 +17,7 @@ type GatewayConfig struct {
 	PathPrefixes []string
 }
 
-func GatewayOption(writable bool, paths ...string) ServeOption {
+func GatewayOption(writable bool, offline bool, paths ...string) ServeOption {
 	return func(n *core.IpfsNode, _ net.Listener, mux *http.ServeMux) (*http.ServeMux, error) {
 		cfg, err := n.Repo.Config()
 		if err != nil {
@@ -28,7 +28,7 @@ func GatewayOption(writable bool, paths ...string) ServeOption {
 			Headers:      cfg.Gateway.HTTPHeaders,
 			Writable:     writable,
 			PathPrefixes: cfg.Gateway.PathPrefixes,
-		}, coreapi.NewCoreAPI(n))
+		}, coreapi.NewCoreAPI(n, offline))
 
 		for _, p := range paths {
 			mux.Handle(p+"/", gateway)

diff --git a/core/corehttp/gateway_test.go b/core/corehttp/gateway_test.go
@@ -109,7 +109,7 @@ func newTestServerAndNode(t *testing.T, ns mockNamesys) (*httptest.Server, *core
 		ts.Listener,
 		VersionOption(),
 		IPNSHostnameOption(),
-		GatewayOption(false, "/ipfs", "/ipns"),
+		GatewayOption(false, false, "/ipfs", "/ipns"),
 	)
 	if err != nil {
 		t.Fatal(err)

diff --git a/test/sharness/t0110-gateway.sh b/test/sharness/t0110-gateway.sh
@@ -157,4 +157,22 @@ test_expect_success "try fetching it from gateway" '
 
 test_kill_ipfs_daemon
 
+test_launch_ipfs_daemon --offline-gateway
+
+port=$GWAY_PORT
+apiport=$API_PORT
+
+test_expect_success "try fetching not present key from offline gateway" '
+  echo "hi" | ipfs add --hash-only -Q > hi.hash
+  test_expect_code 22 curl -f "http://127.0.0.1:$port/ipfs/$(cat hi.hash)"
+'
+
+test_expect_success "try fetching present key from offline gateway" '
+  echo "hi" | ipfs add -Q > hi.hash &&
+  echo "http://127.0.0.1:$port/ipfs/$(cat hi.hash)" &&
+  curl -f "http://127.0.0.1:$port/ipfs/$(cat hi.hash)"
+'
+
+test_kill_ipfs_daemon
+
 test_done
diff --git a/test/supernode_client/main.go b/test/supernode_client/main.go
@@ -107,7 +107,7 @@ func run() error {
 
 	opts := []corehttp.ServeOption{
 		corehttp.CommandsOption(cmdCtx(node, repoPath)),
-		corehttp.GatewayOption(false),
+		corehttp.GatewayOption(false, false),
 	}
 
 	if *cat {