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