diff --git a/.gitignore b/.gitignore index bbc986c..091bd22 100644 --- a/.gitignore +++ b/.gitignore @@ -16,4 +16,7 @@ .DS_Store frontend/frontend -proxy/proxy \ No newline at end of file +proxy/proxy + +# don't include generated bindata file +frontend/bindata.go diff --git a/frontend/Dockerfile.amd64 b/frontend/Dockerfile.amd64 index bccf851..f0e62ad 100644 --- a/frontend/Dockerfile.amd64 +++ b/frontend/Dockerfile.amd64 @@ -2,6 +2,7 @@ FROM golang:buster AS step_0 ENV CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on WORKDIR /root COPY . . +RUN go generate RUN go build -o /frontend FROM scratch AS step_1 diff --git a/frontend/Dockerfile.arm32v7 b/frontend/Dockerfile.arm32v7 index 1ccd2ed..4c63217 100644 --- a/frontend/Dockerfile.arm32v7 +++ b/frontend/Dockerfile.arm32v7 @@ -2,6 +2,7 @@ FROM golang:buster AS step_0 ENV CGO_ENABLED=0 GOOS=linux GOARCH=arm GO111MODULE=on WORKDIR /root COPY . . +RUN go generate RUN go build -o /frontend FROM scratch AS step_1 diff --git a/frontend/Dockerfile.arm64v8 b/frontend/Dockerfile.arm64v8 index 129d810..982f66c 100644 --- a/frontend/Dockerfile.arm64v8 +++ b/frontend/Dockerfile.arm64v8 @@ -2,6 +2,7 @@ FROM golang:buster AS step_0 ENV CGO_ENABLED=0 GOOS=linux GOARCH=arm64 GO111MODULE=on WORKDIR /root COPY . . +RUN go generate RUN go build -o /frontend FROM scratch AS step_1 diff --git a/frontend/Dockerfile.i386 b/frontend/Dockerfile.i386 index 7db318f..72a2cdb 100644 --- a/frontend/Dockerfile.i386 +++ b/frontend/Dockerfile.i386 @@ -2,6 +2,7 @@ FROM golang:buster AS step_0 ENV CGO_ENABLED=0 GOOS=linux GOARCH=386 GO111MODULE=on WORKDIR /root COPY . . +RUN go generate RUN go build -o /frontend FROM scratch AS step_1 diff --git a/frontend/Dockerfile.ppc64le b/frontend/Dockerfile.ppc64le index 402733e..8422b19 100644 --- a/frontend/Dockerfile.ppc64le +++ b/frontend/Dockerfile.ppc64le @@ -2,6 +2,7 @@ FROM golang:buster AS step_0 ENV CGO_ENABLED=0 GOOS=linux GOARCH=ppc64le GO111MODULE=on WORKDIR /root COPY . . +RUN go generate RUN go build -o /frontend FROM scratch AS step_1 diff --git a/frontend/Dockerfile.s390x b/frontend/Dockerfile.s390x index b92a4e8..3f8c8dc 100644 --- a/frontend/Dockerfile.s390x +++ b/frontend/Dockerfile.s390x @@ -2,6 +2,7 @@ FROM golang:buster AS step_0 ENV CGO_ENABLED=0 GOOS=linux GOARCH=s390x GO111MODULE=on WORKDIR /root COPY . . +RUN go generate RUN go build -o /frontend FROM scratch AS step_1 diff --git a/frontend/bindata/robots.txt b/frontend/bindata/robots.txt new file mode 100644 index 0000000..1f53798 --- /dev/null +++ b/frontend/bindata/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Disallow: / diff --git a/frontend/bindata/templates/bgpmap b/frontend/bindata/templates/bgpmap new file mode 100644 index 0000000..89b6aa6 --- /dev/null +++ b/frontend/bindata/templates/bgpmap @@ -0,0 +1,14 @@ +

BGPmap: {{ html .Target }}

+ + + + diff --git a/frontend/bindata/templates/bird b/frontend/bindata/templates/bird new file mode 100644 index 0000000..546d3c5 --- /dev/null +++ b/frontend/bindata/templates/bird @@ -0,0 +1,2 @@ +

{{ html .ServerName }}: {{ html .Target }}

+{{ .Result }} diff --git a/frontend/bindata/templates/page b/frontend/bindata/templates/page new file mode 100644 index 0000000..5c50a02 --- /dev/null +++ b/frontend/bindata/templates/page @@ -0,0 +1,68 @@ + + + + + + + +{{ .Title }} + + + + + + + +
+ {{ .Content }} +
+ + + + + diff --git a/frontend/bindata/templates/summary b/frontend/bindata/templates/summary new file mode 100644 index 0000000..eb72128 --- /dev/null +++ b/frontend/bindata/templates/summary @@ -0,0 +1,26 @@ +{{ $ServerName := urlquery .ServerName }} + + + +{{ range .Header }} + +{{ end }} + + +{{ range .Rows }} + + + + + + + + +{{ end }} + +
{{ html . }}
{{ html .Name }}{{ .Proto }}{{ .Table }}{{ .State }}{{ .Since }}{{ .Info }}
+ + + diff --git a/frontend/bindata/templates/whois b/frontend/bindata/templates/whois new file mode 100644 index 0000000..4c7b086 --- /dev/null +++ b/frontend/bindata/templates/whois @@ -0,0 +1,2 @@ +

whois {{ html .Target }}

+{{ .Result }} diff --git a/frontend/go.mod b/frontend/go.mod index 5be1cab..277344d 100644 --- a/frontend/go.mod +++ b/frontend/go.mod @@ -2,4 +2,7 @@ module github.com/xddxdd/bird-lg-go/frontend go 1.15 -require github.com/gorilla/handlers v1.5.1 +require ( + github.com/elazarl/go-bindata-assetfs v1.0.1 + github.com/gorilla/handlers v1.5.1 +) diff --git a/frontend/go.sum b/frontend/go.sum index f27a04f..b1f7671 100644 --- a/frontend/go.sum +++ b/frontend/go.sum @@ -1,3 +1,5 @@ +github.com/elazarl/go-bindata-assetfs v1.0.1 h1:m0kkaHRKEu7tUIUFVwhGGGYClXvyl4RE03qmvRTNfbw= +github.com/elazarl/go-bindata-assetfs v1.0.1/go.mod h1:v+YaWX3bdea5J/mo8dSETolEo7R71Vk1u8bnjau5yw4= github.com/felixge/httpsnoop v1.0.1 h1:lvB5Jl89CsZtGIWuTcDM1E/vkVs49/Ml7JJe07l8SPQ= github.com/felixge/httpsnoop v1.0.1/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U= github.com/gorilla/handlers v1.5.1 h1:9lRY6j8DEeeBT10CvO9hGW0gmky0BprnvDI5vfhUHH4= diff --git a/frontend/main.go b/frontend/main.go index 4072e08..9304ba4 100644 --- a/frontend/main.go +++ b/frontend/main.go @@ -7,6 +7,9 @@ import ( "strings" ) +// binary data +//go:generate go-bindata -prefix bindata -o bindata.go bindata/... + type settingType struct { servers []string domain string @@ -93,5 +96,6 @@ func main() { *navBarBrandPtr, } + ImportTemplates() webServerStart() } diff --git a/frontend/render.go b/frontend/render.go index 26e123b..2b9da29 100644 --- a/frontend/render.go +++ b/frontend/render.go @@ -1,13 +1,41 @@ package main import ( + "bytes" + "fmt" "net/http" "regexp" "sort" "strings" ) -func renderTemplate(w http.ResponseWriter, r *http.Request, title string, content string) { +// static options map +var optionsMap = map[string]string{ + "summary": "show protocols", + "detail": "show protocols all", + "route": "show route for ...", + "route_all": "show route for ... all", + "route_bgpmap": "show route for ... (bgpmap)", + "route_where": "show route where net ~ [ ... ]", + "route_where_all": "show route where net ~ [ ... ] all", + "route_where_bgpmap": "show route where net ~ [ ... ] (bgpmap)", + "route_generic": "show route ...", + "generic": "show ...", + "whois": "whois ...", + "traceroute": "traceroute ...", +} + +// pre-compiled regexp and constant statemap for summary rendering +var splitSummaryLine = regexp.MustCompile(`(\w+)(\s+)(\w+)(\s+)([\w-]+)(\s+)(\w+)(\s+)([0-9\-\. :]+)(.*)`) +var summaryStateMap = map[string]string{ + "up": "success", + "down": "secondary", + "start": "danger", + "passive": "info", +} + +// render the page template +func renderPageTemplate(w http.ResponseWriter, r *http.Request, title string, content string) { path := r.URL.Path[1:] split := strings.SplitN(path, "/", 3) @@ -24,36 +52,28 @@ func renderTemplate(w http.ResponseWriter, r *http.Request, title string, conten split = strings.SplitN(path, "/", 3) - var args tmplArguments - args.Options = map[string]string{ - "summary": "show protocols", - "detail": "show protocols all", - "route": "show route for ...", - "route_all": "show route for ... all", - "route_bgpmap": "show route for ... (bgpmap)", - "route_where": "show route where net ~ [ ... ]", - "route_where_all": "show route where net ~ [ ... ] all", - "route_where_bgpmap": "show route where net ~ [ ... ] (bgpmap)", - "route_generic": "show route ...", - "generic": "show ...", - "whois": "whois ...", - "traceroute": "traceroute ...", + args := TemplatePage{ + Options: optionsMap, + Servers: setting.servers, + AllServersLinkActive: strings.ToLower(split[1]) == strings.ToLower(strings.Join(setting.servers, "+")), + AllServersURL: strings.Join(setting.servers, "+"), + IsWhois: isWhois, + WhoisTarget: whoisTarget, + + URLOption: strings.ToLower(split[0]), + URLServer: strings.ToLower(split[1]), + URLCommand: split[2], + Title: setting.titleBrand + title, + Brand: setting.navBarBrand, + Content: content, } - args.Servers = setting.servers - args.AllServersLinkActive = strings.ToLower(split[1]) == strings.ToLower(strings.Join(setting.servers, "+")) - args.AllServersURL = strings.Join(setting.servers, "+") - args.IsWhois = isWhois - args.WhoisTarget = whoisTarget - args.URLOption = strings.ToLower(split[0]) - args.URLServer = strings.ToLower(split[1]) - args.URLCommand = split[2] + tmpl := TemplateLibrary["page"] + err := tmpl.Execute(w, args) + if err != nil { + fmt.Println("Error rendering page:", err.Error()) + } - args.Title = setting.titleBrand + title - args.Brand = setting.navBarBrand - args.Content = content - - tmpl.Execute(w, args) } // Write the given text to http response, and add whois links for @@ -77,87 +97,81 @@ func smartFormatter(s string) string { return result } -type summaryTableArguments struct { - Headers []string - Lines [][]string -} - // Output a table for the summary page func summaryTable(data string, serverName string) string { - var result string - // Sort the table, excluding title row - stringsSplitted := strings.Split(strings.TrimSpace(data), "\n") - if len(stringsSplitted) <= 1 { + lines := strings.Split(strings.TrimSpace(data), "\n") + if len(lines) <= 1 { // Likely backend returned an error message - result = "
" + strings.TrimSpace(data) + "
" - } else { - // Draw the table head - result += `` - result += `` - for _, col := range strings.Split(stringsSplitted[0], " ") { - colTrimmed := strings.TrimSpace(col) - if len(colTrimmed) == 0 { - continue - } - result += `` - } - result += `` - - stringsWithoutTitle := stringsSplitted[1:] - sort.Strings(stringsWithoutTitle) - - for _, line := range stringsWithoutTitle { - // Ignore empty lines - line = strings.TrimSpace(line) - if len(line) == 0 { - continue - } - - // Parse a total of 6 columns from bird summary - lineSplitted := regexp.MustCompile(`(\w+)(\s+)(\w+)(\s+)([\w-]+)(\s+)(\w+)(\s+)([0-9\-\. :]+)(.*)`).FindStringSubmatch(line) - if lineSplitted == nil { - continue - } - - var row [6]string - if len(lineSplitted) >= 2 { - row[0] = strings.TrimSpace(lineSplitted[1]) - } - if len(lineSplitted) >= 4 { - row[1] = strings.TrimSpace(lineSplitted[3]) - } - if len(lineSplitted) >= 6 { - row[2] = strings.TrimSpace(lineSplitted[5]) - } - if len(lineSplitted) >= 8 { - row[3] = strings.TrimSpace(lineSplitted[7]) - } - if len(lineSplitted) >= 10 { - row[4] = strings.TrimSpace(lineSplitted[9]) - } - if len(lineSplitted) >= 11 { - row[5] = strings.TrimSpace(lineSplitted[10]) - } - - // Draw the row in red if the link isn't up - result += `` - // Add link to detail for first column - result += `` - // Draw the other cells - for i := 1; i < 6; i++ { - result += "" - } - result += "" - } - result += "
` + colTrimmed + `
` + row[0] + `" + row[i] + "
" - result += "" + return "
" + strings.TrimSpace(data) + "
" } - return result + args := TemplateSummary{ + ServerName: serverName, + Raw: data, + } + + // extract the table header + for _, col := range strings.Split(lines[0], " ") { + colTrimmed := strings.TrimSpace(col) + if len(colTrimmed) == 0 { + continue + } + args.Header = append(args.Header, col) + } + + // sort the remaining rows + rows := lines[1:] + sort.Strings(rows) + + // parse each line + for _, line := range rows { + + // Ignore empty lines + line = strings.TrimSpace(line) + if len(line) == 0 { + continue + } + + // Parse a total of 6 columns from bird summary + lineSplitted := splitSummaryLine.FindStringSubmatch(line) + if lineSplitted == nil { + continue + } + + var row SummaryRowData + + if len(lineSplitted) >= 2 { + row.Name = strings.TrimSpace(lineSplitted[1]) + } + if len(lineSplitted) >= 4 { + row.Proto = strings.TrimSpace(lineSplitted[3]) + } + if len(lineSplitted) >= 6 { + row.Table = strings.TrimSpace(lineSplitted[5]) + } + if len(lineSplitted) >= 8 { + row.State = strings.TrimSpace(lineSplitted[7]) + row.MappedState = summaryStateMap[row.State] + } + if len(lineSplitted) >= 10 { + row.Since = strings.TrimSpace(lineSplitted[9]) + } + if len(lineSplitted) >= 11 { + row.Info = strings.TrimSpace(lineSplitted[10]) + } + + // add to the result + args.Rows = append(args.Rows, row) + } + + // finally, render the summary template + tmpl := TemplateLibrary["summary"] + var buffer bytes.Buffer + err := tmpl.Execute(&buffer, args) + if err != nil { + fmt.Println("Error rendering summary:", err.Error()) + } + + return buffer.String() } diff --git a/frontend/template.go b/frontend/template.go index 2dcfac4..0c041dc 100644 --- a/frontend/template.go +++ b/frontend/template.go @@ -4,7 +4,10 @@ import ( "text/template" ) -type tmplArguments struct { +// template argument structures + +// page +type TemplatePage struct { // Global options Options map[string]string Servers []string @@ -27,73 +30,80 @@ type tmplArguments struct { Content string } -var tmpl = template.Must(template.New("tmpl").Parse(` - - - - - - - -{{ .Title }} - - - - +// summary - +type TemplateSummary struct { + ServerName string + Raw string + Header []string + Rows []SummaryRowData +} -
- {{ .Content }} -
+// whois +type TemplateWhois struct { + Target string + Result string +} - - - - -`)) +// bgpmap +type TemplateBGPmap struct { + Servers []string + Target string + Result string +} + +// bird +type TemplateBird struct { + ServerName string + Target string + Result string +} + +// global variable to hold the templates + +var TemplateLibrary map[string]*template.Template + +// list of required templates + +var requiredTemplates = [...]string{ + "page", + "summary", + "whois", + "bgpmap", + "bird", +} + +// import templates from bindata + +func ImportTemplates() { + + // create a new (blank) initial template + TemplateLibrary = make(map[string]*template.Template) + + // for each template that is needed + for _, tmpl := range requiredTemplates { + + // extract the template definition from the bindata + def := MustAssetString("templates/" + tmpl) + + // and add it to the template library + template, err := template.New(tmpl).Parse(def) + if err != nil { + panic("Unable to parse template (templates/" + tmpl + ": " + err.Error()) + } + + // store in the library + TemplateLibrary[tmpl] = template + } + +} diff --git a/frontend/webserver.go b/frontend/webserver.go index cb585b1..71ac742 100644 --- a/frontend/webserver.go +++ b/frontend/webserver.go @@ -1,47 +1,82 @@ package main import ( + "bytes" "fmt" "html" "net/http" + "net/url" "os" "strings" + "github.com/elazarl/go-bindata-assetfs" "github.com/gorilla/handlers" ) -func webHandlerWhois(w http.ResponseWriter, r *http.Request) { - var target string = r.URL.Path[len("/whois/"):] +var primitiveMap = map[string]string{ + "summary": "show protocols", + "detail": "show protocols all %s", + "route": "show route for %s", + "route_all": "show route for %s all", + "route_where": "show route where net ~ [ %s ]", + "route_where_all": "show route where net ~ [ %s ] all", + "route_generic": "show route %s", + "generic": "show %s", + "traceroute": "%s", +} - renderTemplate( +// serve up a generic error +func serverError(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusInternalServerError) + w.Write([]byte("500 Internal Server Error")) +} + +// WHOIS pages +func webHandlerWhois(w http.ResponseWriter, r *http.Request) { + target, err := url.PathUnescape(r.URL.Path[len("/whois/"):]) + if err != nil { + serverError(w, r) + return + } + + // render the whois template + args := TemplateWhois{ + Target: target, + Result: smartFormatter(whois(target)), + } + + tmpl := TemplateLibrary["whois"] + var buffer bytes.Buffer + err = tmpl.Execute(&buffer, args) + if err != nil { + fmt.Println("Error rendering whois template:", err.Error()) + } + + renderPageTemplate( w, r, " - whois "+html.EscapeString(target), - "

whois "+html.EscapeString(target)+"

"+smartFormatter(whois(target)), + buffer.String(), ) } +// serve up results from bird func webBackendCommunicator(endpoint string, command string) func(w http.ResponseWriter, r *http.Request) { - backendCommandPrimitive, commandPresent := (map[string]string{ - "summary": "show protocols", - "detail": "show protocols all %s", - "route": "show route for %s", - "route_all": "show route for %s all", - "route_where": "show route where net ~ [ %s ]", - "route_where_all": "show route where net ~ [ %s ] all", - "route_generic": "show route %s", - "generic": "show %s", - "traceroute": "%s", - })[command] + backendCommandPrimitive, commandPresent := primitiveMap[command] if !commandPresent { panic("invalid command: " + command) } return func(w http.ResponseWriter, r *http.Request) { - split := strings.SplitN(r.URL.Path[1:], "/", 4) + split := strings.SplitN(r.URL.Path[1:], "/", 3) var urlCommands string if len(split) >= 3 { - urlCommands = split[2] + tmp, err := url.PathUnescape(split[2]) + if err != nil { + serverError(w, r) + return + } + urlCommands = tmp } var backendCommand string @@ -52,26 +87,50 @@ func webBackendCommunicator(endpoint string, command string) func(w http.Respons } backendCommand = strings.TrimSpace(backendCommand) - var servers []string = strings.Split(split[1], "+") + escapedServers, err := url.PathUnescape(split[1]) + if err != nil { + serverError(w, r) + return + } + servers := strings.Split(escapedServers, "+") + var responses []string = batchRequest(servers, endpoint, backendCommand) - var result string + var content string for i, response := range responses { - result += "

" + html.EscapeString(servers[i]) + ": " + html.EscapeString(backendCommand) + "

" + + var result string if (endpoint == "bird") && backendCommand == "show protocols" && len(response) > 4 && strings.ToLower(response[0:4]) == "name" { - result += summaryTable(response, servers[i]) + result = summaryTable(response, servers[i]) } else { - result += smartFormatter(response) + result = smartFormatter(response) } + + // render the bird result template + args := TemplateBird{ + ServerName: servers[i], + Target: backendCommand, + Result: result, + } + + tmpl := TemplateLibrary["bird"] + var buffer bytes.Buffer + err := tmpl.Execute(&buffer, args) + if err != nil { + fmt.Println("Error rendering bird template:", err.Error()) + } + + content += buffer.String() } - renderTemplate( + renderPageTemplate( w, r, " - "+html.EscapeString(endpoint+" "+backendCommand), - result, + content, ) } } +// bgpmap result func webHandlerBGPMap(endpoint string, command string) func(w http.ResponseWriter, r *http.Request) { backendCommandPrimitive, commandPresent := (map[string]string{ "route_bgpmap": "show route for %s all", @@ -95,51 +154,70 @@ func webHandlerBGPMap(endpoint string, command string) func(w http.ResponseWrite var servers []string = strings.Split(split[1], "+") var responses []string = batchRequest(servers, endpoint, backendCommand) - renderTemplate( + + // render the bgpmap result template + args := TemplateBGPmap{ + Servers: servers, + Target: backendCommand, + Result: birdRouteToGraphviz(servers, responses, urlCommands), + } + + tmpl := TemplateLibrary["bgpmap"] + var buffer bytes.Buffer + err := tmpl.Execute(&buffer, args) + if err != nil { + fmt.Println("Error rendering bgpmap template:", err.Error()) + } + + renderPageTemplate( w, r, " - "+html.EscapeString(endpoint+" "+backendCommand), - ` - - - `, + buffer.String(), ) } } +// redirect from the form input to a path style query func webHandlerNavbarFormRedirect(w http.ResponseWriter, r *http.Request) { query := r.URL.Query() - if query.Get("action") == "whois" { - http.Redirect(w, r, "/"+query.Get("action")+"/"+query.Get("target"), 302) - } else if query.Get("action") == "summary" { - http.Redirect(w, r, "/"+query.Get("action")+"/"+query.Get("server")+"/", 302) - } else { - http.Redirect(w, r, "/"+query.Get("action")+"/"+query.Get("server")+"/"+query.Get("target"), 302) + + action := query.Get("action") + + switch action { + case "whois": + target := url.PathEscape(query.Get("target")) + http.Redirect(w, r, "/"+action+"/"+target, 302) + case "summary": + server := url.PathEscape(query.Get("server")) + http.Redirect(w, r, "/"+action+"/"+server+"/", 302) + default: + server := url.PathEscape(query.Get("server")) + target := url.PathEscape(query.Get("target")) + http.Redirect(w, r, "/"+action+"/"+server+"/"+target, 302) } } -func webHandlerRobotsTxt(w http.ResponseWriter, r *http.Request) { - w.Write([]byte("User-agent: *\nDisallow: /\n")) -} - -func webHandler404(w http.ResponseWriter, r *http.Request) { - w.WriteHeader(http.StatusNotFound) - w.Write([]byte("404 not found\n")) -} - +// set up routing paths and start webserver func webServerStart() { - // Start HTTP server + + // redirect main page to all server summary http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { http.Redirect(w, r, "/summary/"+strings.Join(setting.servers, "+"), 302) }) + + // serve static pages using the AssetFS and bindata + fs := http.FileServer(&assetfs.AssetFS{ + Asset: Asset, + AssetDir: AssetDir, + AssetInfo: AssetInfo, + Prefix: "", + }) + + http.Handle("/static/", fs) + http.Handle("/robots.txt", fs) + http.Handle("/favicon.ico", fs) + + // backend routes http.HandleFunc("/summary/", webBackendCommunicator("bird", "summary")) http.HandleFunc("/detail/", webBackendCommunicator("bird", "detail")) http.HandleFunc("/route/", webBackendCommunicator("bird", "route")) @@ -154,7 +232,7 @@ func webServerStart() { http.HandleFunc("/whois/", webHandlerWhois) http.HandleFunc("/redir", webHandlerNavbarFormRedirect) http.HandleFunc("/telegram/", webHandlerTelegramBot) - http.HandleFunc("/robots.txt", webHandlerRobotsTxt) - http.HandleFunc("/favicon.ico", webHandler404) + + // Start HTTP server http.ListenAndServe(setting.listen, handlers.LoggingHandler(os.Stdout, http.DefaultServeMux)) }