--- type: change message: |- implement basic git-http-server This isn't really part of dehub proper, but it's a useful utility that dehub projects are likely to want to use, so it's worth leaving it in, at least until it grows into its own thing. The utility starts a simple http server which serves files out of the HEAD of a specified branch. If an html file is requested, and there's a markdown version of that file, then the markdown will be compiled to html (optionally using an html template). README.md is used for index.html, if available. change_hash: AAonhlHUltpS+x8w8HHZRQb8e+RHJZpjoDtN2JTVGFBq credentials: - type: pgp_signature pub_key_id: 95C46FA6A41148AC body: iQIzBAABAgAdFiEEJ6tQKp6olvZKJ0lwlcRvpqQRSKwFAl59ZC0ACgkQlcRvpqQRSKxWjQ/+P8CeaBipcM2CWYU2rJgUxNaHiFwpWNcKfJCdp0ZoypnBww4NyHYSM1578NoGukq2l1stSqqK6oWvN1SbYUd+v1YVmIRhCMbMthPPx1f6kPzStDichqYiPkAaIfIw0PUXpY24fkbHhe0tXC+UApEfgLvgEovHVhBjzbgsPhoMACG8Bgfl8mdwqmkXzGuHxxjpZnZLvL3B3q6nCfpGxUYpdQX5hYucV3+vv2obLnYNpPyaYwdLFcQF7a9xgin5eyWNPayyQ1LPDbt3V9ez0mAtCdqHm3KY3fhqz0YR0bU1rVY9eEMSeNaK8fPPmzDO3vlsE76G+tYuwTLaiZgIDCLy4Qm+VRsw1l35tOwybipWciLvKhCkeq1ohgKEcFZbl5Al4ZhUhj4TKN23gsKQzkt9TJlxAxSaNjkKsb4ZNxMhiKnq/THV2JfLAxCRJ+IK2hyu3wi3te8Q1baTYa9ZXxFN9m5V8r1JNJPUM7BASvCUEzWegNFfrvidCrMHzb7o5GhOETSGWkKejR7/KMn6n1/tvvrt9F2wbPYUJrPKjB8Y33b9PjLgvrQ/2nNOoj6UAeXWMv8N1oaAdjOJB4A8+/vhFTPpXlw3FPRn953LKspkHXck1ooUu1ea1rcOV+872ZVh2HsUn8qD42/IZZQ1K2+NhPaKuAtQnIQzOcZLb94lwA0= account: mediocregophermain
mediocregopher
4 years ago
parent
a8c7f92328
commit
2390197ae3
@ -0,0 +1,22 @@ |
||||
# git-http-server |
||||
|
||||
A simple http server which uses a git repo (bare or otherwise) as the underlying |
||||
filesystem. |
||||
|
||||
* Automatically renders markdown files as html. |
||||
* Will use README.md as the index, if available. |
||||
* Can be set to use a specific branch. |
||||
|
||||
All configuration is done on the command-line. |
||||
|
||||
# Installation |
||||
|
||||
TODO |
||||
|
||||
# Markdown |
||||
|
||||
TODO |
||||
|
||||
# Templates |
||||
|
||||
TODO |
||||
@ -0,0 +1,11 @@ |
||||
module dehub/cmd/git-http-server |
||||
|
||||
go 1.14 |
||||
|
||||
require ( |
||||
dehub v0.0.0 |
||||
gitlab.com/golang-commonmark/markdown v0.0.0-20191127184510-91b5b3c99c19 |
||||
gopkg.in/src-d/go-git.v4 v4.13.1 |
||||
) |
||||
|
||||
replace dehub => ../../ |
||||
@ -0,0 +1,78 @@ |
||||
github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/ghQa61ZWa/C2Aw3RkjiTBOix7dkqa1VLIs= |
||||
github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c= |
||||
github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= |
||||
github.com/bmatcuk/doublestar v1.2.2/go.mod h1:wiQtGV+rzVYxB7WIlirSN++5HPtPlXEo9MEoZQC/PmE= |
||||
github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY= |
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= |
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= |
||||
github.com/emirpasic/gods v1.12.0 h1:QAUIPSaCu4G+POclxeqb3F+WPpdKqFGlw36+yOzGlrg= |
||||
github.com/emirpasic/gods v1.12.0/go.mod h1:YfzfFFoVP/catgzJb4IKIqXjX78Ha8FMSDh3ymbK86o= |
||||
github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc= |
||||
github.com/gliderlabs/ssh v0.2.2/go.mod h1:U7qILu1NlMHj9FlMhZLlkCdDnU1DBEAqr0aevW3Awn0= |
||||
github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= |
||||
github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= |
||||
github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= |
||||
github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= |
||||
github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd h1:Coekwdh0v2wtGp9Gmz1Ze3eVRAWJMLokvN3QjdzCHLY= |
||||
github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM= |
||||
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= |
||||
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= |
||||
github.com/kr/pty v1.1.8/go.mod h1:O1sed60cT9XZ5uDucP5qwvh+TE3NnUj51EiZO/lmSfw= |
||||
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= |
||||
github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y= |
||||
github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= |
||||
github.com/pelletier/go-buffruneio v0.2.0/go.mod h1:JkE26KsDizTr40EUHkXVtNPvgGtbSNq5BcowyYOWdKo= |
||||
github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= |
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= |
||||
github.com/russross/blackfriday v2.0.0+incompatible/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g= |
||||
github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ= |
||||
github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo= |
||||
github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= |
||||
github.com/src-d/gcfg v1.4.0 h1:xXbNR5AlLSA315x2UO+fTSSAXCDf+Ar38/6oyGbDKQ4= |
||||
github.com/src-d/gcfg v1.4.0/go.mod h1:p/UMsR43ujA89BJY9duynAwIpvqEujIH/jFlfL7jWoI= |
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= |
||||
github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE= |
||||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= |
||||
github.com/xanzy/ssh-agent v0.2.1 h1:TCbipTQL2JiiCprBWx9frJ2eJlCYT00NmctrHxVAr70= |
||||
github.com/xanzy/ssh-agent v0.2.1/go.mod h1:mLlQY/MoOhWBj+gOGMQkOeiEvkx+8pJSI+0Bx9h2kr4= |
||||
gitlab.com/golang-commonmark/html v0.0.0-20191124015941-a22733972181 h1:K+bMSIx9A7mLES1rtG+qKduLIXq40DAzYHtb0XuCukA= |
||||
gitlab.com/golang-commonmark/html v0.0.0-20191124015941-a22733972181/go.mod h1:dzYhVIwWCtzPAa4QP98wfB9+mzt33MSmM8wsKiMi2ow= |
||||
gitlab.com/golang-commonmark/linkify v0.0.0-20191026162114-a0c2df6c8f82 h1:oYrL81N608MLZhma3ruL8qTM4xcpYECGut8KSxRY59g= |
||||
gitlab.com/golang-commonmark/linkify v0.0.0-20191026162114-a0c2df6c8f82/go.mod h1:Gn+LZmCrhPECMD3SOKlE+BOHwhOYD9j7WT9NUtkCrC8= |
||||
gitlab.com/golang-commonmark/markdown v0.0.0-20191127184510-91b5b3c99c19 h1:HsZm6XaTpEgZiZqcXZkUbG6BNtSZE3XyCTfo52YBoDY= |
||||
gitlab.com/golang-commonmark/markdown v0.0.0-20191127184510-91b5b3c99c19/go.mod h1:CRIzp0wh6PvKEAeEOtp9wEpNKJJ1VFTNfHO4+ToRgVA= |
||||
gitlab.com/golang-commonmark/mdurl v0.0.0-20191124015652-932350d1cb84 h1:qqjvoVXdWIcZCLPMlzgA7P9FZWdPGPvP/l3ef8GzV6o= |
||||
gitlab.com/golang-commonmark/mdurl v0.0.0-20191124015652-932350d1cb84/go.mod h1:IJZ+fdMvbW2qW6htJx7sLJ04FEs4Ldl/MDsJtMKywfw= |
||||
gitlab.com/golang-commonmark/puny v0.0.0-20191124015043-9f83538fa04f h1:Wku8eEdeJqIOFHtrfkYUByc4bCaTeA6fL0UJgfEiFMI= |
||||
gitlab.com/golang-commonmark/puny v0.0.0-20191124015043-9f83538fa04f/go.mod h1:Tiuhl+njh/JIg0uS/sOJVYi0x2HEa5rc1OAaVsb5tAs= |
||||
gitlab.com/opennota/wd v0.0.0-20180912061657-c5d65f63c638/go.mod h1:EGRJaqe2eO9XGmFtQCvV3Lm9NLico3UhFwUpCG/+mVU= |
||||
golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= |
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= |
||||
golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= |
||||
golang.org/x/crypto v0.0.0-20200109152110-61a87790db17 h1:nVJ3guKA9qdkEQ3TUdXI9QSINo2CUPM/cySEvw2w8I0= |
||||
golang.org/x/crypto v0.0.0-20200109152110-61a87790db17/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= |
||||
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= |
||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= |
||||
golang.org/x/net v0.0.0-20190724013045-ca1201d0de80 h1:Ao/3l156eZf2AW5wK8a7/smtodRU+gha3+BeqJ69lRk= |
||||
golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= |
||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= |
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= |
||||
golang.org/x/sys v0.0.0-20190221075227-b4e8571b14e0/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= |
||||
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= |
||||
golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e h1:D5TXcfTk7xF7hvieo4QErS3qqCB4teTffacDWr7CI+0= |
||||
golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= |
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= |
||||
golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs= |
||||
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= |
||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= |
||||
golang.org/x/tools v0.0.0-20190729092621-ff9f1409240a/go.mod h1:jcCCGcm9btYwXyDqrUWc6MKQKKGJCWEQ3AfLSRIbEuI= |
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= |
||||
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= |
||||
gopkg.in/src-d/go-billy.v4 v4.3.2 h1:0SQA1pRztfTFx2miS8sA97XvooFeNOmvUenF4o0EcVg= |
||||
gopkg.in/src-d/go-billy.v4 v4.3.2/go.mod h1:nDjArDMp+XMs1aFAESLRjfGSgfvoYN0hDfzEk0GjC98= |
||||
gopkg.in/src-d/go-git-fixtures.v3 v3.5.0/go.mod h1:dLBcvytrw/TYZsNTWCnkNF2DSIlzWYqTe3rJR56Ac7g= |
||||
gopkg.in/src-d/go-git.v4 v4.13.1 h1:SRtFyV8Kxc0UP7aCHcijOMQGPxHSmMOPrzulQWolkYE= |
||||
gopkg.in/src-d/go-git.v4 v4.13.1/go.mod h1:nx5NYcxdKxq5fpltdHnPa2Exj4Sx0EclMWZQbYDu2z8= |
||||
gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= |
||||
gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= |
||||
gopkg.in/yaml.v2 v2.2.7/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= |
||||
@ -0,0 +1,152 @@ |
||||
package main |
||||
|
||||
import ( |
||||
"bytes" |
||||
"errors" |
||||
"flag" |
||||
"fmt" |
||||
"io/ioutil" |
||||
"log" |
||||
"net/http" |
||||
"path/filepath" |
||||
"strings" |
||||
"text/template" |
||||
"time" |
||||
|
||||
"gitlab.com/golang-commonmark/markdown" |
||||
"gopkg.in/src-d/go-git.v4" |
||||
"gopkg.in/src-d/go-git.v4/plumbing" |
||||
"gopkg.in/src-d/go-git.v4/plumbing/object" |
||||
) |
||||
|
||||
type handler struct { |
||||
repo *git.Repository |
||||
branch plumbing.ReferenceName |
||||
tpl *template.Template |
||||
} |
||||
|
||||
func (h handler) ServeHTTP(rw http.ResponseWriter, r *http.Request) { |
||||
path := r.URL.Path |
||||
var mdPath string |
||||
if strings.HasSuffix(path, "/") { |
||||
mdPath = filepath.Join(path, "README.md") // do before modifying path
|
||||
path = filepath.Join(path, "index.html") |
||||
|
||||
} else if strings.HasSuffix(path, "/index.html") { |
||||
mdPath = filepath.Join(filepath.Dir(path), "README.md") |
||||
|
||||
} else if filepath.Ext(path) == ".html" { |
||||
mdPath = strings.TrimSuffix(path, ".html") + ".md" |
||||
} |
||||
|
||||
path = strings.TrimPrefix(path, "/") |
||||
mdPath = strings.TrimPrefix(mdPath, "/") |
||||
|
||||
ref, err := h.repo.Reference(h.branch, true) |
||||
if errors.Is(err, plumbing.ErrReferenceNotFound) { |
||||
http.Error(rw, "branch does not exist", 404) |
||||
return |
||||
} else if err != nil { |
||||
log.Printf("resolving reference %q: %v", h.branch, err) |
||||
http.Error(rw, "internal error", 500) |
||||
return |
||||
} |
||||
|
||||
hash := ref.Hash() |
||||
commit, err := h.repo.CommitObject(hash) |
||||
if err != nil { |
||||
log.Printf("fetching commit %q: %v", hash, err) |
||||
http.Error(rw, "internal error", 500) |
||||
return |
||||
} |
||||
|
||||
tree, err := h.repo.TreeObject(commit.TreeHash) |
||||
if err != nil { |
||||
log.Printf("fetching tree %q of commit %q: %v", commit.TreeHash, hash, err) |
||||
http.Error(rw, "internal error", 500) |
||||
return |
||||
} |
||||
|
||||
var usingMD bool |
||||
f, err := tree.File(path) |
||||
if errors.Is(err, object.ErrFileNotFound) { |
||||
usingMD = true |
||||
f, err = tree.File(mdPath) |
||||
} |
||||
|
||||
if errors.Is(err, object.ErrFileNotFound) { |
||||
http.Error(rw, fmt.Sprintf("%q not found", path), 404) |
||||
return |
||||
} else if err != nil { |
||||
log.Printf("fetching file %q / %q: %v", path, mdPath, err) |
||||
http.Error(rw, "internal error", 500) |
||||
return |
||||
} |
||||
|
||||
fr, err := f.Blob.Reader() |
||||
if err != nil { |
||||
log.Printf("getting reader of file %q: %v", f.Name, err) |
||||
http.Error(rw, "internal error", 500) |
||||
return |
||||
} |
||||
defer fr.Close() |
||||
|
||||
b, err := ioutil.ReadAll(fr) |
||||
if err != nil { |
||||
log.Printf("reading in contents of file %q: %v", f.Name, err) |
||||
http.Error(rw, "internal error", 500) |
||||
return |
||||
} |
||||
|
||||
if !usingMD { |
||||
http.ServeContent(rw, r, filepath.Base(path), time.Now(), bytes.NewReader(b)) |
||||
return |
||||
} |
||||
|
||||
mdBuf := new(bytes.Buffer) |
||||
if err := markdown.New().Render(mdBuf, b); err != nil { |
||||
log.Printf("rendering file %q to markdown: %v", f.Name, err) |
||||
http.Error(rw, "internal error", 500) |
||||
return |
||||
} |
||||
|
||||
if h.tpl == nil { |
||||
http.ServeContent(rw, r, filepath.Base(path), time.Now(), bytes.NewReader(mdBuf.Bytes())) |
||||
return |
||||
} |
||||
|
||||
h.tpl.Execute(rw, struct { |
||||
Body string |
||||
}{mdBuf.String()}) |
||||
} |
||||
|
||||
func main() { |
||||
addr := flag.String("addr", ":8000", "Address to listen for http requests on") |
||||
branchName := flag.String("branch", "master", "git branch to serve the HEAD of") |
||||
repoPath := flag.String("repo-path", ".", "Path to the git repository to server") |
||||
tplPath := flag.String("tpl-path", "", "Path to an optional template file which can be used when rendering markdown") |
||||
flag.Parse() |
||||
|
||||
repo, err := git.PlainOpen(*repoPath) |
||||
if err != nil { |
||||
log.Fatalf("opening git repo at path %q: %v", *repoPath, err) |
||||
} |
||||
branch := plumbing.NewBranchReferenceName(*branchName) |
||||
|
||||
// do an initial check for the branch, for funsies
|
||||
if _, err := repo.Reference(branch, true); err != nil { |
||||
log.Fatalf("resolving reference %q: %v", branch, err) |
||||
} |
||||
|
||||
h := &handler{ |
||||
repo: repo, |
||||
branch: branch, |
||||
} |
||||
|
||||
if *tplPath != "" { |
||||
h.tpl = template.Must(template.ParseFiles(*tplPath)) |
||||
} |
||||
|
||||
log.Printf("listening on %q", *addr) |
||||
http.ListenAndServe(*addr, h) |
||||
} |
||||
Loading…
Reference in new issue