github.com/Aodurkeen/go-ubiq@v2.3.0+incompatible/cmd/gubiq/consolecmd.go (about) 1 // Copyright 2016 The go-ethereum Authors 2 // This file is part of go-ethereum. 3 // 4 // go-ethereum is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // go-ethereum is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU General Public License for more details. 13 // 14 // You should have received a copy of the GNU General Public License 15 // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>. 16 17 package main 18 19 import ( 20 "fmt" 21 "os" 22 "os/signal" 23 "path/filepath" 24 "strings" 25 "syscall" 26 27 "github.com/ubiq/go-ubiq/cmd/utils" 28 "github.com/ubiq/go-ubiq/console" 29 "github.com/ubiq/go-ubiq/node" 30 "github.com/ubiq/go-ubiq/rpc" 31 "gopkg.in/urfave/cli.v1" 32 ) 33 34 var ( 35 consoleFlags = []cli.Flag{utils.JSpathFlag, utils.ExecFlag, utils.PreloadJSFlag} 36 37 consoleCommand = cli.Command{ 38 Action: utils.MigrateFlags(localConsole), 39 Name: "console", 40 Usage: "Start an interactive JavaScript environment", 41 Flags: append(append(append(nodeFlags, rpcFlags...), consoleFlags...), whisperFlags...), 42 Category: "CONSOLE COMMANDS", 43 Description: ` 44 The Gubiq console is an interactive shell for the JavaScript runtime environment 45 which exposes a node admin interface as well as the Ðapp JavaScript API. 46 See https://github.com/ubiq/go-ubiq/wiki/JavaScript-Console.`, 47 } 48 49 attachCommand = cli.Command{ 50 Action: utils.MigrateFlags(remoteConsole), 51 Name: "attach", 52 Usage: "Start an interactive JavaScript environment (connect to node)", 53 ArgsUsage: "[endpoint]", 54 Flags: append(consoleFlags, utils.DataDirFlag), 55 Category: "CONSOLE COMMANDS", 56 Description: ` 57 The Gubiq console is an interactive shell for the JavaScript runtime environment 58 which exposes a node admin interface as well as the Ðapp JavaScript API. 59 See https://github.com/ubiq/go-ubiq/wiki/JavaScript-Console. 60 This command allows to open a console on a running gubiq node.`, 61 } 62 63 javascriptCommand = cli.Command{ 64 Action: utils.MigrateFlags(ephemeralConsole), 65 Name: "js", 66 Usage: "Execute the specified JavaScript files", 67 ArgsUsage: "<jsfile> [jsfile...]", 68 Flags: append(nodeFlags, consoleFlags...), 69 Category: "CONSOLE COMMANDS", 70 Description: ` 71 The JavaScript VM exposes a node admin interface as well as the Ðapp 72 JavaScript API. See https://github.com/ubiq/go-ubiq/wiki/JavaScript-Console`, 73 } 74 ) 75 76 // localConsole starts a new gubiq node, attaching a JavaScript console to it at the 77 // same time. 78 func localConsole(ctx *cli.Context) error { 79 // Create and start the node based on the CLI flags 80 node := makeFullNode(ctx) 81 startNode(ctx, node) 82 defer node.Stop() 83 84 // Attach to the newly started node and start the JavaScript console 85 client, err := node.Attach() 86 if err != nil { 87 utils.Fatalf("Failed to attach to the inproc gubiq: %v", err) 88 } 89 config := console.Config{ 90 DataDir: utils.MakeDataDir(ctx), 91 DocRoot: ctx.GlobalString(utils.JSpathFlag.Name), 92 Client: client, 93 Preload: utils.MakeConsolePreloads(ctx), 94 } 95 96 console, err := console.New(config) 97 if err != nil { 98 utils.Fatalf("Failed to start the JavaScript console: %v", err) 99 } 100 defer console.Stop(false) 101 102 // If only a short execution was requested, evaluate and return 103 if script := ctx.GlobalString(utils.ExecFlag.Name); script != "" { 104 console.Evaluate(script) 105 return nil 106 } 107 // Otherwise print the welcome screen and enter interactive mode 108 console.Welcome() 109 console.Interactive() 110 111 return nil 112 } 113 114 // remoteConsole will connect to a remote gubiq instance, attaching a JavaScript 115 // console to it. 116 func remoteConsole(ctx *cli.Context) error { 117 // Attach to a remotely running gubiq instance and start the JavaScript console 118 endpoint := ctx.Args().First() 119 if endpoint == "" { 120 path := node.DefaultDataDir() 121 if ctx.GlobalIsSet(utils.DataDirFlag.Name) { 122 path = ctx.GlobalString(utils.DataDirFlag.Name) 123 } 124 if path != "" { 125 if ctx.GlobalBool(utils.TestnetFlag.Name) { 126 path = filepath.Join(path, "testnet") 127 } 128 } 129 endpoint = fmt.Sprintf("%s/gubiq.ipc", path) 130 } 131 client, err := dialRPC(endpoint) 132 if err != nil { 133 utils.Fatalf("Unable to attach to remote gubiq: %v", err) 134 } 135 config := console.Config{ 136 DataDir: utils.MakeDataDir(ctx), 137 DocRoot: ctx.GlobalString(utils.JSpathFlag.Name), 138 Client: client, 139 Preload: utils.MakeConsolePreloads(ctx), 140 } 141 142 console, err := console.New(config) 143 if err != nil { 144 utils.Fatalf("Failed to start the JavaScript console: %v", err) 145 } 146 defer console.Stop(false) 147 148 if script := ctx.GlobalString(utils.ExecFlag.Name); script != "" { 149 console.Evaluate(script) 150 return nil 151 } 152 153 // Otherwise print the welcome screen and enter interactive mode 154 console.Welcome() 155 console.Interactive() 156 157 return nil 158 } 159 160 // dialRPC returns a RPC client which connects to the given endpoint. 161 // The check for empty endpoint implements the defaulting logic 162 // for "gubiq attach" and "gubiq monitor" with no argument. 163 func dialRPC(endpoint string) (*rpc.Client, error) { 164 if endpoint == "" { 165 endpoint = node.DefaultIPCEndpoint(clientIdentifier) 166 } else if strings.HasPrefix(endpoint, "rpc:") || strings.HasPrefix(endpoint, "ipc:") { 167 // Backwards compatibility with gubiq < 1.5 which required 168 // these prefixes. 169 endpoint = endpoint[4:] 170 } 171 return rpc.Dial(endpoint) 172 } 173 174 // ephemeralConsole starts a new gubiq node, attaches an ephemeral JavaScript 175 // console to it, executes each of the files specified as arguments and tears 176 // everything down. 177 func ephemeralConsole(ctx *cli.Context) error { 178 // Create and start the node based on the CLI flags 179 node := makeFullNode(ctx) 180 startNode(ctx, node) 181 defer node.Stop() 182 183 // Attach to the newly started node and start the JavaScript console 184 client, err := node.Attach() 185 if err != nil { 186 utils.Fatalf("Failed to attach to the inproc gubiq: %v", err) 187 } 188 config := console.Config{ 189 DataDir: utils.MakeDataDir(ctx), 190 DocRoot: ctx.GlobalString(utils.JSpathFlag.Name), 191 Client: client, 192 Preload: utils.MakeConsolePreloads(ctx), 193 } 194 195 console, err := console.New(config) 196 if err != nil { 197 utils.Fatalf("Failed to start the JavaScript console: %v", err) 198 } 199 defer console.Stop(false) 200 201 // Evaluate each of the specified JavaScript files 202 for _, file := range ctx.Args() { 203 if err = console.Execute(file); err != nil { 204 utils.Fatalf("Failed to execute %s: %v", file, err) 205 } 206 } 207 // Wait for pending callbacks, but stop for Ctrl-C. 208 abort := make(chan os.Signal, 1) 209 signal.Notify(abort, syscall.SIGINT, syscall.SIGTERM) 210 211 go func() { 212 <-abort 213 os.Exit(0) 214 }() 215 console.Stop(true) 216 217 return nil 218 }