7 Commits

9 changed files with 93 additions and 151 deletions

View File

@@ -31,6 +31,12 @@ dokku storage:mount teafolio /srv/teafolio-dokku/config.toml:/app/config.toml
## CHANGELOG
2025-06-01 v1.4.2
- Proxy images from Gitea, for servers using `REQUIRE_SIGNIN_VIEW=expensive`
- Always use fallback markdown renderer
- Fix missing support for markdown tables in fallback renderer
- Fix very wide code blocks overflowing page width
2024-03-19 v1.4.1
- Add cooldown for failed markdown API calls
- Fix missing extra html elements when using fallback markdown renderer

View File

@@ -1,10 +1,8 @@
package gitea
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io/ioutil"
"net/http"
@@ -12,17 +10,14 @@ import (
"strings"
"sync/atomic"
"time"
"golang.org/x/sync/semaphore"
)
const MarkdownFailureCooldownSeconds = 3600 // 1 hour
type APIClient struct {
urlBase string
orgName string
token string
apiSem *semaphore.Weighted
apiSem chan struct{}
lastMarkdownFailure atomic.Int64
}
@@ -42,14 +37,27 @@ func NewAPIClient(urlBase string, orgName string, token string, maxConnections i
}
if maxConnections == 0 { // unlimited
ret.apiSem = semaphore.NewWeighted(99999)
// no-op
} else {
ret.apiSem = semaphore.NewWeighted(maxConnections)
ret.apiSem = make(chan struct{}, maxConnections)
}
return ret
}
func (ac *APIClient) Sem() func() {
if ac.apiSem == nil {
// No connection limit
return func() {}
}
// Connection limit
ac.apiSem <- struct{}{}
return func() {
<-ac.apiSem
}
}
func (ac *APIClient) PopulateCommitInfo(ctx context.Context, rr *Repo) error {
// The most recent commit will be the head of one of the branches (easy to find)
@@ -95,11 +103,8 @@ func (ac *APIClient) PopulateImages(ctx context.Context, rr *Repo) error {
}
func (ac *APIClient) apiRequest(ctx context.Context, endpoint string, target interface{}) error {
err := ac.apiSem.Acquire(ctx, 1)
if err != nil {
return err // e.g. ctx closed
}
defer ac.apiSem.Release(1)
release := ac.Sem()
defer release()
req, err := http.NewRequestWithContext(ctx, http.MethodGet, ac.urlBase+endpoint, nil)
if err != nil {
@@ -227,11 +232,8 @@ func (ac *APIClient) RepoFile(ctx context.Context, repo, filename string) ([]byt
}
func (ac *APIClient) filesInDirectory(ctx context.Context, repo, dir string) ([]ReaddirEntry, error) {
err := ac.apiSem.Acquire(ctx, 1)
if err != nil {
return nil, err // e.g. ctx closed
}
defer ac.apiSem.Release(1)
release := ac.Sem()
defer release()
req, err := http.NewRequestWithContext(ctx, http.MethodGet, ac.urlBase+`api/v1/repos/`+url.PathEscape(ac.orgName)+`/`+url.PathEscape(repo)+`/contents/`+dir, nil) // n.b. $dir param not escaped
if err != nil {
@@ -302,88 +304,3 @@ func (ac *APIClient) topicsForRepo(ctx context.Context, repo string) ([]string,
return tr.Topics, nil
}
var ErrMarkdownCooldown = errors.New("Markdown API was recently not functional")
func (ac *APIClient) checkMarkdownCooldown() error {
if ac.lastMarkdownFailure.Load()+MarkdownFailureCooldownSeconds > time.Now().Unix() {
return ErrMarkdownCooldown
}
return nil
}
// renderMarkdown calls the remote Gitea server's own markdown renderer.
func (ac *APIClient) RenderMarkdown(ctx context.Context, repoName string, body string) ([]byte, error) {
if err := ac.checkMarkdownCooldown(); err != nil {
return nil, err
}
err := ac.apiSem.Acquire(ctx, 1)
if err != nil {
return nil, err // e.g. ctx closed
}
defer ac.apiSem.Release(1)
jb, err := json.Marshal(MarkdownRequest{
Context: ac.urlBase + url.PathEscape(ac.orgName) + `/` + url.PathEscape(repoName) + `/src/branch/master`,
Mode: "gfm", // magic constant - Github Flavoured Markdown
Text: body,
})
if err != nil {
return nil, err
}
req, err := http.NewRequestWithContext(ctx, http.MethodPost, ac.urlBase+`api/v1/markdown/`, bytes.NewReader(jb))
if err != nil {
return nil, err
}
req.Header.Set(`Content-Type`, `application/json`)
req.Header.Set(`Content-Length`, fmt.Sprintf("%d", len(jb)))
resp, err := http.DefaultClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
ac.lastMarkdownFailure.Store(time.Now().Unix())
return nil, fmt.Errorf("HTTP %d", resp.StatusCode)
}
return ioutil.ReadAll(resp.Body)
}
// renderMarkdownRaw calls the remote Gitea server's own markdown renderer.
func (ac *APIClient) renderMarkdownRaw(ctx context.Context, body []byte) ([]byte, error) {
if err := ac.checkMarkdownCooldown(); err != nil {
return nil, err
}
err := ac.apiSem.Acquire(ctx, 1)
if err != nil {
return nil, err // e.g. ctx closed
}
defer ac.apiSem.Release(1)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, ac.urlBase+`api/v1/markdown/raw`, bytes.NewReader(body))
if err != nil {
return nil, err
}
req.Header.Set(`Content-Type`, `text/plain`)
req.Header.Set(`Content-Length`, fmt.Sprintf("%d", len(body)))
resp, err := http.DefaultClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
ac.lastMarkdownFailure.Store(time.Now().Unix())
return nil, fmt.Errorf("HTTP %d", resp.StatusCode)
}
return ioutil.ReadAll(resp.Body)
}

3
go.mod
View File

@@ -4,7 +4,6 @@ go 1.19
require (
github.com/BurntSushi/toml v0.3.1
golang.org/x/sync v0.0.0-20200317015054-43a5402ce75a
)
require github.com/yuin/goldmark v1.7.0 // indirect
require github.com/yuin/goldmark v1.7.8 // indirect

2
go.sum
View File

@@ -2,5 +2,7 @@ github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
github.com/yuin/goldmark v1.7.0 h1:EfOIvIMZIzHdB/R/zVrikYLPPwJlfMcNczJFMs1m6sA=
github.com/yuin/goldmark v1.7.0/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E=
github.com/yuin/goldmark v1.7.8 h1:iERMLn0/QJeHFhxSt3p6PeN9mGnvIKSpG9YYorDMnic=
github.com/yuin/goldmark v1.7.8/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E=
golang.org/x/sync v0.0.0-20200317015054-43a5402ce75a h1:WXEvlFVvvGxCJLG6REjsT03iWnKLEWinaScsxF2Vm2o=
golang.org/x/sync v0.0.0-20200317015054-43a5402ce75a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=

16
main.go
View File

@@ -10,6 +10,8 @@ import (
"teafolio/gitea"
"github.com/BurntSushi/toml"
"github.com/yuin/goldmark"
"github.com/yuin/goldmark/extension"
)
type Config struct {
@@ -30,9 +32,12 @@ type Config struct {
type Application struct {
cfg Config
rxRepoPage, rxRepoImage *regexp.Regexp
rxRepoPage *regexp.Regexp
rxRepoImage *regexp.Regexp
rxRepoImage2 *regexp.Regexp
gitea *gitea.APIClient
md goldmark.Markdown
reposMut sync.RWMutex
reposCache []gitea.Repo // Sorted by recently-created-first
@@ -42,8 +47,13 @@ type Application struct {
func main() {
app := Application{
rxRepoPage: regexp.MustCompile(`^/([^/]+)/?$`),
rxRepoImage: regexp.MustCompile(`^/:banner/([^/]+)/?$`),
rxRepoPage: regexp.MustCompile(`^/([^/]+)/?$`),
rxRepoImage: regexp.MustCompile(`^/:banner/([^/]+)/?$`),
rxRepoImage2: regexp.MustCompile(`^/:repo-img/([0-9]+)/([^/]+)/?$`),
md: goldmark.New(
goldmark.WithExtensions(extension.GFM), // required for table rendering support
),
}
configFile := flag.String(`ConfigFile`, `config.toml`, `Configuration file in TOML format`)

View File

@@ -4,7 +4,7 @@ import (
"net/http"
)
func (this *Application) Bannerpage(w http.ResponseWriter, r *http.Request, repoName string) {
func (this *Application) Bannerpage(w http.ResponseWriter, r *http.Request, repoName string, imageIdx int) {
this.reposMut.RLock()
defer this.reposMut.RUnlock()
@@ -17,12 +17,20 @@ func (this *Application) Bannerpage(w http.ResponseWriter, r *http.Request, repo
}
images := this.reposCache[ridx].Images
if len(images) == 0 {
if imageIdx >= len(images) {
w.Header().Set(`Location`, `/static/no_image.png`)
w.WriteHeader(301)
return
}
w.Header().Set(`Location`, images[0].RawURL)
w.WriteHeader(301)
// Mirror serving
// (Direct 301 redirects are no longer available)
imgData, err := this.gitea.RepoFile(r.Context(), repoName, images[imageIdx].Path)
if err != nil {
http.Error(w, err.Error(), 500)
return
}
w.Write(imgData)
}

View File

@@ -2,17 +2,14 @@ package main
import (
"bytes"
"errors"
"fmt"
"html"
"log"
"net/http"
"net/url"
"strconv"
"strings"
"teafolio/gitea"
"github.com/yuin/goldmark"
)
func (this *Application) Repopage(w http.ResponseWriter, r *http.Request, repoName string) {
@@ -60,41 +57,28 @@ func (this *Application) Repopage(w http.ResponseWriter, r *http.Request, repoNa
lines = append([]string{lines[0], lines[1], extraBadgesMd, ""}, lines[2:]...)
}
readmeHtml, err := this.gitea.RenderMarkdown(ctx, repoName, strings.Join(lines, "\n"))
buff := bytes.Buffer{}
err = this.md.Convert([]byte(strings.Join(lines, "\n")), &buff)
if err != nil {
if !errors.Is(err, gitea.ErrMarkdownCooldown) {
log.Printf("%s %s: %s", r.Method, r.URL.Path, fmt.Errorf("rendering markdown: %w", err))
}
// Failed to use Gitea's markdown renderer
// HTTP 401 (Unauthorized) started happening with this API sometime
// between Gitea 1.18 -> 1.21, and no authorization token seems
// sufficient to make it work again
// Use our own one instead as a fallback
buff := bytes.Buffer{}
err = goldmark.Convert([]byte(strings.Join(lines, "\n")), &buff)
if err != nil {
// Built-in markdown renderer didn't work either
log.Printf("%s %s: %s", r.Method, r.URL.Path, fmt.Errorf("rendering markdown: %w", err))
http.Redirect(w, r, repoURL, http.StatusTemporaryRedirect)
return
}
// OK
readmeHtml = buff.Bytes()
err = nil
}
readmeHtml = []byte(strings.Replace(string(readmeHtml), `%%REPLACEME__BADGE%%`, `<img src="/static/build_success_brightgreen.svg" style="width:90px;height:20px;">`, 1))
images, err := this.gitea.ImageFilesForRepo(ctx, repoName)
if err != nil {
log.Printf("%s %s: %s", r.Method, r.URL.Path, fmt.Errorf("listing images: %w", err))
// Built-in markdown renderer didn't work either
log.Printf("%s %s: %s", r.Method, r.URL.Path, fmt.Errorf("rendering markdown: %w", err))
http.Redirect(w, r, repoURL, http.StatusTemporaryRedirect)
return
}
readmeHtml := buff.Bytes()
readmeHtml = []byte(strings.Replace(string(readmeHtml), `%%REPLACEME__BADGE%%`, `<img src="/static/build_success_brightgreen.svg" style="width:90px;height:20px;">`, 1))
// Use cached image list, since the idx numbers need to match the :repo-img/##
// which only uses a cached lookup
var images []gitea.ReaddirEntry
this.reposMut.RLock()
if cacheIdx, ok := this.reposCacheByName[repoName]; ok {
images = this.reposCache[cacheIdx].Images
}
this.reposMut.RUnlock()
// If the Git repository contains a top-level go.mod file, allow vanity imports
if goMod, err := this.gitea.RepoFile(ctx, repoName, `go.mod`); err == nil {
@@ -125,8 +109,12 @@ func (this *Application) Repopage(w http.ResponseWriter, r *http.Request, repoNa
if len(images) > 0 {
fmt.Fprint(w, `<div class="projimg">`)
for _, img := range images {
fmt.Fprint(w, `<a href="`+html.EscapeString(img.RawURL)+`"><img alt="" class="thumbimage" src="`+html.EscapeString(img.RawURL)+`" /></a>`)
for imgIdx, img := range images {
// Direct link
// fmt.Fprint(w, `<a href="`+html.EscapeString(img.RawURL)+`"><img alt="" class="thumbimage" src="`+html.EscapeString(img.RawURL)+`" /></a>`)
// Proxied image
fmt.Fprint(w, `<a href="`+html.EscapeString(img.RawURL)+`"><img alt="" class="thumbimage" src="/:repo-img/`+strconv.Itoa(imgIdx)+`/`+html.EscapeString(repoName)+`" /></a>`)
}
fmt.Fprint(w, `</div>`)
}

View File

@@ -6,6 +6,7 @@ import (
"fmt"
"net/http"
"net/url"
"strconv"
"strings"
)
@@ -14,7 +15,6 @@ var StaticFiles embed.FS
func (this *Application) ServeStatic(w http.ResponseWriter, r *http.Request) {
http.FileServer(http.FS(StaticFiles)).ServeHTTP(w, r)
// http.StripPrefix(`/static/`, http.FileServer(http.FS(StaticFiles))).ServeHTTP(w, r)
}
func (this *Application) ServeHTTP(w http.ResponseWriter, r *http.Request) {
@@ -30,7 +30,15 @@ func (this *Application) ServeHTTP(w http.ResponseWriter, r *http.Request) {
http.Error(w, "not found", 404)
} else if parts := this.rxRepoImage.FindStringSubmatch(r.URL.Path); parts != nil {
this.Bannerpage(w, r, parts[1])
this.Bannerpage(w, r, parts[1], 0) // 0th image
} else if parts := this.rxRepoImage2.FindStringSubmatch(r.URL.Path); parts != nil {
imageIdx, err := strconv.Atoi(parts[1])
if err != nil {
http.Error(w, "Invalid request", 400)
return
}
this.Bannerpage(w, r, parts[2], imageIdx) // 0th image
} else if parts := this.rxRepoPage.FindStringSubmatch(r.URL.Path); parts != nil {

View File

@@ -28,6 +28,10 @@ h1 a:hover {
h1 {
margin-top:0;
}
pre {
/* wide codeblocks should scroll */
overflow-y: auto;
}
.code {
background: #F8F8F8;
font-family:Consolas,monospace;