-
-
-
- previous step
- •
- next step
-
- `) - template.HTMLEscape(w, data[0:mark]) - io.WriteString(w, "") - template.HTMLEscape(w, data[mark:lo]) - if lo < hi { - io.WriteString(w, "") -} - -// addrToByte evaluates the given address starting at offset start in data. -// It returns the lo and hi byte offset of the matched region within data. -// See http://9p.io/sys/doc/sam/sam.html Table II for details on the syntax. -func addrToByteRange(addr string, start int, data []byte) (lo, hi int, err error) { - var ( - dir byte - prevc byte - charOffset bool - ) - lo = start - hi = start - for addr != "" && err == nil { - c := addr[0] - switch c { - default: - err = errors.New("invalid address syntax near " + string(c)) - case ',': - if len(addr) == 1 { - hi = len(data) - } else { - _, hi, err = addrToByteRange(addr[1:], hi, data) - } - return - - case '+', '-': - if prevc == '+' || prevc == '-' { - lo, hi, err = addrNumber(data, lo, hi, prevc, 1, charOffset) - } - dir = c - - case '$': - lo = len(data) - hi = len(data) - if len(addr) > 1 { - dir = '+' - } - - case '#': - charOffset = true - - case '0', '1', '2', '3', '4', '5', '6', '7', '8', '9': - var i int - for i = 1; i < len(addr); i++ { - if addr[i] < '0' || addr[i] > '9' { - break - } - } - var n int - n, err = strconv.Atoi(addr[0:i]) - if err != nil { - break - } - lo, hi, err = addrNumber(data, lo, hi, dir, n, charOffset) - dir = 0 - charOffset = false - prevc = c - addr = addr[i:] - continue - - case '/': - var i, j int - Regexp: - for i = 1; i < len(addr); i++ { - switch addr[i] { - case '\\': - i++ - case '/': - j = i + 1 - break Regexp - } - } - if j == 0 { - j = i - } - pattern := addr[1:i] - lo, hi, err = addrRegexp(data, lo, hi, dir, pattern) - prevc = c - addr = addr[j:] - continue - } - prevc = c - addr = addr[1:] - } - - if err == nil && dir != 0 { - lo, hi, err = addrNumber(data, lo, hi, dir, 1, charOffset) - } - if err != nil { - return 0, 0, err - } - return lo, hi, nil -} - -// addrNumber applies the given dir, n, and charOffset to the address lo, hi. -// dir is '+' or '-', n is the count, and charOffset is true if the syntax -// used was #n. Applying +n (or +#n) means to advance n lines -// (or characters) after hi. Applying -n (or -#n) means to back up n lines -// (or characters) before lo. -// The return value is the new lo, hi. -func addrNumber(data []byte, lo, hi int, dir byte, n int, charOffset bool) (int, int, error) { - switch dir { - case 0: - lo = 0 - hi = 0 - fallthrough - - case '+': - if charOffset { - pos := hi - for ; n > 0 && pos < len(data); n-- { - _, size := utf8.DecodeRune(data[pos:]) - pos += size - } - if n == 0 { - return pos, pos, nil - } - break - } - // find next beginning of line - if hi > 0 { - for hi < len(data) && data[hi-1] != '\n' { - hi++ - } - } - lo = hi - if n == 0 { - return lo, hi, nil - } - for ; hi < len(data); hi++ { - if data[hi] != '\n' { - continue - } - switch n--; n { - case 1: - lo = hi + 1 - case 0: - return lo, hi + 1, nil - } - } - - case '-': - if charOffset { - // Scan backward for bytes that are not UTF-8 continuation bytes. - pos := lo - for ; pos > 0 && n > 0; pos-- { - if data[pos]&0xc0 != 0x80 { - n-- - } - } - if n == 0 { - return pos, pos, nil - } - break - } - // find earlier beginning of line - for lo > 0 && data[lo-1] != '\n' { - lo-- - } - hi = lo - if n == 0 { - return lo, hi, nil - } - for ; lo >= 0; lo-- { - if lo > 0 && data[lo-1] != '\n' { - continue - } - switch n--; n { - case 1: - hi = lo - case 0: - return lo, hi, nil - } - } - } - - return 0, 0, errors.New("address out of range") -} - -// addrRegexp searches for pattern in the given direction starting at lo, hi. -// The direction dir is '+' (search forward from hi) or '-' (search backward from lo). -// Backward searches are unimplemented. -func addrRegexp(data []byte, lo, hi int, dir byte, pattern string) (int, int, error) { - re, err := regexp.Compile(pattern) - if err != nil { - return 0, 0, err - } - if dir == '-' { - // Could implement reverse search using binary search - // through file, but that seems like overkill. - return 0, 0, errors.New("reverse search not implemented") - } - m := re.FindIndex(data[hi:]) - if len(m) > 0 { - m[0] += hi - m[1] += hi - } else if hi > 0 { - // No match. Wrap to beginning of data. - m = re.FindIndex(data) - } - if len(m) == 0 { - return 0, 0, errors.New("no match for " + pattern) - } - return m[0], m[1], nil -} - -// lineToByte returns the byte index of the first byte of line n. -// Line numbers begin at 1. -func lineToByte(data []byte, n int) int { - if n <= 1 { - return 0 - } - n-- - for i, c := range data { - if c == '\n' { - if n--; n == 0 { - return i + 1 - } - } - } - return len(data) -} - -// byteToLine returns the number of the line containing the byte at index i. -func byteToLine(data []byte, i int) int { - l := 1 - for j, c := range data { - if j == i { - return l - } - if c == '\n' { - l++ - } - } - return l -} diff --git a/cmd/godoc/dl.go b/cmd/godoc/dl.go deleted file mode 100644 index 962a0f0172..0000000000 --- a/cmd/godoc/dl.go +++ /dev/null @@ -1,14 +0,0 @@ -// Copyright 2014 The Go Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package main - -import "net/http" - -// Register a redirect handler for /dl/ to the golang.org download page. -// This file will not be included when deploying godoc to golang.org. - -func init() { - http.Handle("/dl/", http.RedirectHandler("https://golang.org/dl/", http.StatusFound)) -} diff --git a/cmd/godoc/godoc_test.go b/cmd/godoc/godoc_test.go index 3748388fd8..7e44348919 100644 --- a/cmd/godoc/godoc_test.go +++ b/cmd/godoc/godoc_test.go @@ -81,7 +81,7 @@ func waitForServerReady(t *testing.T, cmd *exec.Cmd, addr string) { go func() { ch <- fmt.Errorf("server exited early: %v", cmd.Wait()) }() go waitForServer(t, ch, fmt.Sprintf("http://%v/", addr), - "The Go Programming Language", + "Go Documentation Server", 15*time.Second, false) if err := <-ch; err != nil { @@ -201,7 +201,7 @@ func TestURL(t *testing.T) { } } - t.Run("index", testcase("/", "Go is an open source programming language")) + t.Run("index", testcase("/", "These packages are part of the Go Project but outside the main Go tree.")) t.Run("fmt", testcase("/pkg/fmt", "Package fmt implements formatted I/O")) } @@ -286,8 +286,12 @@ package a; import _ "godoc.test/repo2/a"; const Name = "repo1a"`, releaseTag string // optional release tag that must be in go/build.ReleaseTags }{ { - path: "/", - contains: []string{"Go is an open source programming language"}, + path: "/", + contains: []string{ + "Go Documentation Server", + "Standard library", + "These packages are part of the Go Project but outside the main Go tree.", + }, }, { path: "/pkg/fmt/", diff --git a/cmd/godoc/handlers.go b/cmd/godoc/handlers.go index 2e98501898..a59301be51 100644 --- a/cmd/godoc/handlers.go +++ b/cmd/godoc/handlers.go @@ -2,14 +2,6 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. -// The /doc/codewalk/ tree is synthesized from codewalk descriptions, -// files named $GOROOT/doc/codewalk/*.xml. -// For an example and a description of the format, see -// http://golang.org/doc/codewalk/codewalk or run godoc -http=:6060 -// and see http://localhost:6060/doc/codewalk/codewalk . -// That page is itself a codewalk; the source code for it is -// $GOROOT/doc/codewalk/codewalk.xml. - package main import ( @@ -17,79 +9,39 @@ import ( "go/format" "log" "net/http" - "strings" "text/template" "golang.org/x/tools/godoc" - "golang.org/x/tools/godoc/golangorgenv" "golang.org/x/tools/godoc/redirect" "golang.org/x/tools/godoc/vfs" ) +// This package registers "/compile" and "/share" handlers +// that redirect to the golang.org playground. +import _ "golang.org/x/tools/playground" + var ( pres *godoc.Presentation fs = vfs.NameSpace{} ) -// hostEnforcerHandler redirects requests to "http://foo.golang.org/bar" -// to "https://golang.org/bar". -// It permits requests to the host "godoc-test.golang.org" for testing and -// golang.google.cn for Chinese users. -type hostEnforcerHandler struct { - h http.Handler -} - -func (h hostEnforcerHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { - if !golangorgenv.EnforceHosts() { - h.h.ServeHTTP(w, r) - return - } - if !h.isHTTPS(r) || !h.validHost(r.Host) { - r.URL.Scheme = "https" - if h.validHost(r.Host) { - r.URL.Host = r.Host - } else { - r.URL.Host = "golang.org" - } - http.Redirect(w, r, r.URL.String(), http.StatusFound) - return - } - w.Header().Set("Strict-Transport-Security", "max-age=31536000; includeSubDomains; preload") - h.h.ServeHTTP(w, r) -} - -func (h hostEnforcerHandler) isHTTPS(r *http.Request) bool { - return r.TLS != nil || r.Header.Get("X-Forwarded-Proto") == "https" -} - -func (h hostEnforcerHandler) validHost(host string) bool { - switch strings.ToLower(host) { - case "golang.org", "golang.google.cn": - return true - } - if strings.HasSuffix(host, "-dot-golang-org.appspot.com") { - // staging/test - return true - } - return false -} - -func registerHandlers(pres *godoc.Presentation) *http.ServeMux { +func registerHandlers(pres *godoc.Presentation) { if pres == nil { panic("nil Presentation") } mux := http.NewServeMux() - mux.HandleFunc("/doc/codewalk/", codewalk) - mux.Handle("/doc/play/", pres.FileServer()) - mux.Handle("/robots.txt", pres.FileServer()) - mux.Handle("/", pres) + mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) { + if req.URL.Path == "/" { + http.Redirect(w, req, "/pkg/", http.StatusFound) + return + } + pres.ServeHTTP(w, req) + }) mux.Handle("/pkg/C/", redirect.Handler("/cmd/cgo/")) mux.HandleFunc("/fmt", fmtHandler) redirect.Register(mux) - http.Handle("/", hostEnforcerHandler{mux}) - - return mux + http.Handle("/", mux) } func readTemplate(name string) *template.Template { @@ -113,8 +65,6 @@ func readTemplate(name string) *template.Template { } func readTemplates(p *godoc.Presentation) { - codewalkHTML = readTemplate("codewalk.html") - codewalkdirHTML = readTemplate("codewalkdir.html") p.CallGraphHTML = readTemplate("callgraph.html") p.DirlistHTML = readTemplate("dirlist.html") p.ErrorHTML = readTemplate("error.html") @@ -128,7 +78,6 @@ func readTemplates(p *godoc.Presentation) { p.SearchDocHTML = readTemplate("searchdoc.html") p.SearchCodeHTML = readTemplate("searchcode.html") p.SearchTxtHTML = readTemplate("searchtxt.html") - p.SearchDescXML = readTemplate("opensearch.xml") } type fmtResponse struct { diff --git a/cmd/godoc/index.go b/cmd/godoc/index.go deleted file mode 100644 index f84b29a29d..0000000000 --- a/cmd/godoc/index.go +++ /dev/null @@ -1,11 +0,0 @@ -// Copyright 2015 The Go Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package main - -import "strings" - -func indexDirectoryDefault(dir string) bool { - return dir != "/pkg" && !strings.HasPrefix(dir, "/pkg/") -} diff --git a/cmd/godoc/main.go b/cmd/godoc/main.go index 1d402ba0bd..dc8a08159f 100644 --- a/cmd/godoc/main.go +++ b/cmd/godoc/main.go @@ -6,8 +6,7 @@ // Web server tree: // -// http://godoc/ main landing page -// http://godoc/doc/ serve from $GOROOT/doc - spec, mem, etc. +// http://godoc/ redirect to /pkg/ // http://godoc/src/ serve files from $GOROOT/src; .go gets pretty-printed // http://godoc/cmd/ serve documentation about commands // http://godoc/pkg/ serve documentation about packages @@ -164,8 +163,6 @@ func main() { certInit() } - playEnabled = *showPlayground - // Check usage. if flag.NArg() > 0 { fmt.Fprintln(os.Stderr, `Unexpected arguments. Use "go doc" for command-line help output instead. For example, "go doc fmt.Printf".`) @@ -276,7 +273,9 @@ func main() { corpus.IndexFullText = false } corpus.IndexFiles = *indexFiles - corpus.IndexDirectory = indexDirectoryDefault + corpus.IndexDirectory = func(dir string) bool { + return dir != "/pkg" && !strings.HasPrefix(dir, "/pkg/") + } corpus.IndexThrottle = *indexThrottle corpus.IndexInterval = *indexInterval if *writeIndex || *urlFlag != "" { diff --git a/cmd/godoc/play.go b/cmd/godoc/play.go deleted file mode 100644 index a899353e68..0000000000 --- a/cmd/godoc/play.go +++ /dev/null @@ -1,9 +0,0 @@ -// Copyright 2012 The Go Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package main - -// This package registers "/compile" and "/share" handlers -// that redirect to the golang.org playground. -import _ "golang.org/x/tools/playground" diff --git a/godoc/pres.go b/godoc/pres.go index 7cedcb54e1..1daa5a125b 100644 --- a/godoc/pres.go +++ b/godoc/pres.go @@ -38,7 +38,7 @@ type Presentation struct { SearchDocHTML, SearchCodeHTML, SearchTxtHTML, - SearchDescXML *template.Template + SearchDescXML *template.Template // If not nil, register a /opensearch.xml handler with this template. // TabWidth optionally specifies the tab width. TabWidth int @@ -129,7 +129,9 @@ func NewPresentation(c *Corpus) *Presentation { p.pkgHandler.registerWithMux(p.mux) p.mux.HandleFunc("/", p.ServeFile) p.mux.HandleFunc("/search", p.HandleSearch) - p.mux.HandleFunc("/opensearch.xml", p.serveSearchDesc) + if p.SearchDescXML != nil { + p.mux.HandleFunc("/opensearch.xml", p.serveSearchDesc) + } return p } diff --git a/godoc/static/codewalk.html b/godoc/static/codewalk.html deleted file mode 100644 index 0f3d22a20c..0000000000 --- a/godoc/static/codewalk.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - -") - template.HTMLEscape(w, data[lo:hi]) - io.WriteString(w, "") - } - template.HTMLEscape(w, data[hi:]) - io.WriteString(w, "
| {{$name_html}} | -- | {{html .Title}} | -
- {{end}} - {{.XML}} -