|
| 1 | +// Copyright 2025 The Go Authors. All rights reserved. |
| 2 | +// Use of this source code is governed by a BSD-style |
| 3 | +// license that can be found in the LICENSE file. |
| 4 | + |
| 5 | +// doc is an internal command started by go doc -http |
| 6 | +// to serve documentation. It should not be invoked |
| 7 | +// directly. |
| 8 | +package main |
| 9 | + |
| 10 | +import ( |
| 11 | + "context" |
| 12 | + "flag" |
| 13 | + "log" |
| 14 | + "net" |
| 15 | + "net/http" |
| 16 | + "time" |
| 17 | + |
| 18 | + "golang.org/x/pkgsite/cmd/internal/pkgsite" |
| 19 | + "golang.org/x/pkgsite/internal/browser" |
| 20 | + ilog "golang.org/x/pkgsite/internal/log" |
| 21 | + "golang.org/x/pkgsite/internal/middleware/timeout" |
| 22 | + "golang.org/x/pkgsite/internal/stdlib" |
| 23 | +) |
| 24 | + |
| 25 | +var ( |
| 26 | + goRepoPath = flag.String("gorepo", "", "") |
| 27 | + addr = flag.String("http", "", "") |
| 28 | + pathToOpen = flag.String("open", "", "") |
| 29 | +) |
| 30 | + |
| 31 | +func main() { |
| 32 | + log.SetFlags(0) |
| 33 | + log.SetPrefix("doc: ") |
| 34 | + |
| 35 | + // Print simple log entries without the severity, and |
| 36 | + // print error-level and above log messages to the user |
| 37 | + ilog.Use(docLogger{}) |
| 38 | + ilog.SetLevel("error") |
| 39 | + |
| 40 | + flag.Parse() |
| 41 | + if *goRepoPath == "" || *addr == "" || *pathToOpen == "" { |
| 42 | + log.Fatal("-gorepo, -http, or -open not provided to doc command") |
| 43 | + } |
| 44 | + |
| 45 | + stdlib.SetGoRepoPath(*goRepoPath) |
| 46 | + |
| 47 | + ctx := context.Background() |
| 48 | + server, err := pkgsite.BuildServer(ctx, pkgsite.ServerConfig{ |
| 49 | + AllowNoModules: true, |
| 50 | + UseListedMods: true, |
| 51 | + UseLocalStdlib: true, |
| 52 | + GoRepoPath: *goRepoPath, |
| 53 | + }) |
| 54 | + if err != nil { |
| 55 | + log.Fatal(err) |
| 56 | + } |
| 57 | + |
| 58 | + ln, err := net.Listen("tcp", *addr) |
| 59 | + if err != nil { |
| 60 | + log.Fatal(err) |
| 61 | + } |
| 62 | + |
| 63 | + url := "http://" + *addr |
| 64 | + log.Printf("Documentation server listening on addr %s", url) |
| 65 | + |
| 66 | + go func() { |
| 67 | + if !browser.Open(*pathToOpen) { |
| 68 | + log.Printf("Failed to open browser window. Please visit %s in your browser.", *pathToOpen) |
| 69 | + } |
| 70 | + }() |
| 71 | + |
| 72 | + router := http.NewServeMux() |
| 73 | + server.Install(router.Handle, nil, nil) |
| 74 | + mw := timeout.Timeout(54 * time.Second) |
| 75 | + srv := &http.Server{Addr: *addr, Handler: mw(router)} |
| 76 | + log.Fatal(srv.Serve(ln)) |
| 77 | +} |
| 78 | + |
| 79 | +// docLogger is a simple logger that prints the payload |
| 80 | +// using the standard library log package. |
| 81 | +type docLogger struct{} |
| 82 | + |
| 83 | +func (docLogger) Log(ctx context.Context, s ilog.Severity, payload any) { log.Printf("%+v", payload) } |
| 84 | +func (docLogger) Flush() {} |
0 commit comments