mirror of
https://github.com/golang/go
synced 2024-09-30 22:38:33 -06:00
e83bc56334
These were built inside Google but have been in production for years. Move them into the public tools repository so that they can be more easily maintained. This is step one to moving the entire golang.org deployment process out of Google's internal source repository. Change-Id: I72f875c5020b3f58f1c0cea1d19268e0f991833f Reviewed-on: https://go-review.googlesource.com/14842 Reviewed-by: Chris Broadfoot <cbro@golang.org>
122 lines
3.4 KiB
Go
122 lines
3.4 KiB
Go
// Copyright 2010 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.
|
|
|
|
// 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 (
|
|
"log"
|
|
"net/http"
|
|
"strings"
|
|
"text/template"
|
|
|
|
"golang.org/x/tools/godoc"
|
|
"golang.org/x/tools/godoc/redirect"
|
|
"golang.org/x/tools/godoc/vfs"
|
|
)
|
|
|
|
var (
|
|
pres *godoc.Presentation
|
|
fs = vfs.NameSpace{}
|
|
)
|
|
|
|
var enforceHosts = false // set true in production on app engine
|
|
|
|
// 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.
|
|
type hostEnforcerHandler struct {
|
|
h http.Handler
|
|
}
|
|
|
|
func (h hostEnforcerHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|
if !enforceHosts {
|
|
h.h.ServeHTTP(w, r)
|
|
return
|
|
}
|
|
if r.TLS == nil || !h.validHost(r.Host) {
|
|
r.URL.Scheme = "https"
|
|
if !h.validHost(r.Host) {
|
|
r.URL.Host = "golang.org"
|
|
}
|
|
http.Redirect(w, r, r.URL.String(), http.StatusFound)
|
|
return
|
|
}
|
|
h.h.ServeHTTP(w, r)
|
|
}
|
|
|
|
func (h hostEnforcerHandler) validHost(host string) bool {
|
|
switch strings.ToLower(host) {
|
|
case "golang.org", "godoc-test.golang.org":
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
func registerHandlers(pres *godoc.Presentation) *http.ServeMux {
|
|
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.Handle("/pkg/C/", redirect.Handler("/cmd/cgo/"))
|
|
redirect.Register(mux)
|
|
http.Handle("/", hostEnforcerHandler{mux})
|
|
|
|
return mux
|
|
}
|
|
|
|
func readTemplate(name string) *template.Template {
|
|
if pres == nil {
|
|
panic("no global Presentation set yet")
|
|
}
|
|
path := "lib/godoc/" + name
|
|
|
|
// use underlying file system fs to read the template file
|
|
// (cannot use template ParseFile functions directly)
|
|
data, err := vfs.ReadFile(fs, path)
|
|
if err != nil {
|
|
log.Fatal("readTemplate: ", err)
|
|
}
|
|
// be explicit with errors (for app engine use)
|
|
t, err := template.New(name).Funcs(pres.FuncMap()).Parse(string(data))
|
|
if err != nil {
|
|
log.Fatal("readTemplate: ", err)
|
|
}
|
|
return t
|
|
}
|
|
|
|
func readTemplates(p *godoc.Presentation, html bool) {
|
|
p.PackageText = readTemplate("package.txt")
|
|
p.SearchText = readTemplate("search.txt")
|
|
|
|
if html || p.HTMLMode {
|
|
codewalkHTML = readTemplate("codewalk.html")
|
|
codewalkdirHTML = readTemplate("codewalkdir.html")
|
|
p.CallGraphHTML = readTemplate("callgraph.html")
|
|
p.DirlistHTML = readTemplate("dirlist.html")
|
|
p.ErrorHTML = readTemplate("error.html")
|
|
p.ExampleHTML = readTemplate("example.html")
|
|
p.GodocHTML = readTemplate("godoc.html")
|
|
p.ImplementsHTML = readTemplate("implements.html")
|
|
p.MethodSetHTML = readTemplate("methodset.html")
|
|
p.PackageHTML = readTemplate("package.html")
|
|
p.SearchHTML = readTemplate("search.html")
|
|
p.SearchDocHTML = readTemplate("searchdoc.html")
|
|
p.SearchCodeHTML = readTemplate("searchcode.html")
|
|
p.SearchTxtHTML = readTemplate("searchtxt.html")
|
|
p.SearchDescXML = readTemplate("opensearch.xml")
|
|
}
|
|
}
|