resolve.go 2.25 KB
Newer Older
1 2 3 4
package commands

import (
	"errors"
5 6
	"io"
	"strings"
7

8
	cmds "github.com/ipfs/go-ipfs/commands"
9
	path "github.com/ipfs/go-ipfs/path"
10
	u "github.com/ipfs/go-ipfs/util"
11 12
)

13 14
type ResolvedPath struct {
	Path path.Path
15 16
}

17
var resolveCmd = &cmds.Command{
18 19 20 21 22 23 24 25 26
	Helptext: cmds.HelpText{
		Tagline: "Gets the value currently published at an IPNS name",
		ShortDescription: `
IPNS is a PKI namespace, where names are the hashes of public keys, and
the private key enables publishing new (signed) values. In resolve, the
default value of <name> is your own identity public key.
`,
		LongDescription: `
IPNS is a PKI namespace, where names are the hashes of public keys, and
27 28
the private key enables publishing new (signed) values. In resolve, the
default value of <name> is your own identity public key.
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43


Examples:

Resolve the value of your identity:

  > ipfs name resolve
  QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy

Resolve te value of another name:

  > ipfs name resolve QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n
  QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy

`,
44
	},
45 46

	Arguments: []cmds.Argument{
47
		cmds.StringArg("name", false, false, "The IPNS name to resolve. Defaults to your node's peerID.").EnableStdin(),
48
	},
49
	Run: func(req cmds.Request, res cmds.Response) {
50

51 52
		n, err := req.Context().GetNode()
		if err != nil {
53 54
			res.SetError(err, cmds.ErrNormal)
			return
55 56
		}

57 58 59 60 61 62
		if !n.OnlineMode() {
			err := n.SetupOfflineRouting()
			if err != nil {
				res.SetError(err, cmds.ErrNormal)
				return
			}
63 64
		}

65 66
		var name string

67
		if len(req.Arguments()) == 0 {
68
			if n.Identity == "" {
69 70
				res.SetError(errors.New("Identity not loaded!"), cmds.ErrNormal)
				return
71
			}
72
			name = n.Identity.Pretty()
73

74
		} else {
75
			name = req.Arguments()[0]
76 77
		}

78
		output, err := n.Namesys.Resolve(n.Context(), "/ipns/"+name)
79
		if err != nil {
80 81
			res.SetError(err, cmds.ErrNormal)
			return
82 83
		}

Matt Bell's avatar
Matt Bell committed
84 85
		// TODO: better errors (in the case of not finding the name, we get "failed to find any peer in table")

86
		res.SetOutput(&ResolvedPath{output})
87
	},
88
	Marshalers: cmds.MarshalerMap{
89
		cmds.Text: func(res cmds.Response) (io.Reader, error) {
90
			output, ok := res.Output().(*ResolvedPath)
91 92 93
			if !ok {
				return nil, u.ErrCast()
			}
94
			return strings.NewReader(output.Path.String()), nil
95
		},
96
	},
97
	Type: ResolvedPath{},
98
}