1package commands
2
3import (
4 "context"
5 "errors"
6 "fmt"
7 "io"
8 "log"
9 "net"
10 "net/http"
11 "net/url"
12 "os"
13 "os/signal"
14 "strconv"
15 "syscall"
16 "time"
17
18 "github.com/99designs/gqlgen/graphql/playground"
19 "github.com/gorilla/mux"
20 "github.com/phayes/freeport"
21 "github.com/skratchdot/open-golang/open"
22 "github.com/spf13/cobra"
23
24 "github.com/git-bug/git-bug/api/auth"
25 "github.com/git-bug/git-bug/api/graphql"
26 httpapi "github.com/git-bug/git-bug/api/http"
27 "github.com/git-bug/git-bug/cache"
28 "github.com/git-bug/git-bug/commands/execenv"
29 "github.com/git-bug/git-bug/entities/identity"
30 "github.com/git-bug/git-bug/repository"
31 "github.com/git-bug/git-bug/webui"
32)
33
34const webUIOpenConfigKey = "git-bug.webui.open"
35
36type webUIOptions struct {
37 host string
38 port int
39 open bool
40 noOpen bool
41 readOnly bool
42 logErrors bool
43 query string
44}
45
46func newWebUICommand(env *execenv.Env) *cobra.Command {
47 options := webUIOptions{}
48
49 cmd := &cobra.Command{
50 Use: "webui",
51 Short: "Launch the web UI",
52 Long: `Launch the web UI.
53
54Available git config:
55 git-bug.webui.open [bool]: control the automatic opening of the web UI in the default browser
56`,
57 PreRunE: execenv.LoadRepo(env),
58 RunE: func(cmd *cobra.Command, args []string) error {
59 return runWebUI(env, options)
60 },
61 }
62
63 flags := cmd.Flags()
64 flags.SortFlags = false
65
66 flags.StringVar(&options.host, "host", "127.0.0.1", "Network address or hostname to listen to (default to 127.0.0.1)")
67 flags.BoolVar(&options.open, "open", false, "Automatically open the web UI in the default browser")
68 flags.BoolVar(&options.noOpen, "no-open", false, "Prevent the automatic opening of the web UI in the default browser")
69 flags.IntVarP(&options.port, "port", "p", 0, "Port to listen to (default to random available port)")
70 flags.BoolVar(&options.readOnly, "read-only", false, "Whether to run the web UI in read-only mode")
71 flags.BoolVar(&options.logErrors, "log-errors", false, "Whether to log errors")
72 flags.StringVarP(&options.query, "query", "q", "", "The query to open in the web UI bug list")
73
74 return cmd
75}
76
77func runWebUI(env *execenv.Env, opts webUIOptions) error {
78 if opts.port == 0 {
79 var err error
80 opts.port, err = freeport.GetFreePort()
81 if err != nil {
82 return err
83 }
84 }
85
86 addr := net.JoinHostPort(opts.host, strconv.Itoa(opts.port))
87 webUiAddr := fmt.Sprintf("http://%s", addr)
88 toOpen := webUiAddr
89
90 if len(opts.query) > 0 {
91 // Explicitly set the query parameter instead of going with a default one.
92 toOpen = fmt.Sprintf("%s/?q=%s", webUiAddr, url.QueryEscape(opts.query))
93 }
94
95 router := mux.NewRouter()
96
97 // If the webUI is not read-only, use an authentication middleware with a
98 // fixed identity: the default user of the repo
99 // TODO: support dynamic authentication with OAuth
100 if !opts.readOnly {
101 author, err := identity.GetUserIdentity(env.Repo)
102 if err != nil {
103 return err
104 }
105 router.Use(auth.Middleware(author.Id()))
106 }
107
108 mrc := cache.NewMultiRepoCache()
109
110 _, events := mrc.RegisterDefaultRepository(env.Repo)
111
112 err := execenv.CacheBuildProgressBar(env, events)
113 if err != nil {
114 return err
115 }
116
117 var errOut io.Writer
118 if opts.logErrors {
119 errOut = env.Err
120 }
121
122 graphqlHandler := graphql.NewHandler(mrc, errOut)
123
124 // Routes
125 router.Path("/playground").Handler(playground.Handler("git-bug", "/graphql"))
126 router.Path("/graphql").Handler(graphqlHandler)
127 router.Path("/gitfile/{repo}/{hash}").Handler(httpapi.NewGitFileHandler(mrc))
128 router.Path("/upload/{repo}").Methods("POST").Handler(httpapi.NewGitUploadFileHandler(mrc))
129 router.PathPrefix("/").Handler(webui.NewHandler())
130
131 srv := &http.Server{
132 Addr: addr,
133 Handler: router,
134 }
135
136 done := make(chan bool)
137 quit := make(chan os.Signal, 1)
138
139 // register as handler of the interrupt signal to trigger the teardown
140 signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM, os.Interrupt)
141
142 go func() {
143 <-quit
144 env.Out.Println("WebUI is shutting down...")
145
146 ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
147 defer cancel()
148
149 srv.SetKeepAlivesEnabled(false)
150 if err := srv.Shutdown(ctx); err != nil {
151 log.Fatalf("Could not gracefully shutdown the WebUI: %v\n", err)
152 }
153
154 // Teardown
155 err := graphqlHandler.Close()
156 if err != nil {
157 env.Out.Println(err)
158 }
159
160 close(done)
161 }()
162
163 env.Out.Printf("Web UI: %s\n", webUiAddr)
164 env.Out.Printf("Graphql API: http://%s/graphql\n", addr)
165 env.Out.Printf("Graphql Playground: http://%s/playground\n", addr)
166 env.Out.Println("Press Ctrl+c to quit")
167
168 configOpen, err := env.Repo.AnyConfig().ReadBool(webUIOpenConfigKey)
169 if errors.Is(err, repository.ErrNoConfigEntry) {
170 // default to true
171 configOpen = true
172 } else if err != nil {
173 return err
174 }
175
176 shouldOpen := (configOpen && !opts.noOpen) || opts.open
177
178 if shouldOpen {
179 err = open.Run(toOpen)
180 if err != nil {
181 env.Out.Println(err)
182 }
183 }
184
185 err = srv.ListenAndServe()
186 if err != nil && err != http.ErrServerClosed {
187 return err
188 }
189
190 <-done
191
192 env.Out.Println("WebUI stopped")
193 return nil
194}