2 SGBlog -- Git-backed CGI/inetd blogging/phlogging engine
3 Copyright (C) 2020-2021 Sergey Matveev <stargrave@stargrave.org>
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU Affero General Public License as
7 published by the Free Software Foundation, version 3 of the License.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU Affero General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
38 "github.com/go-git/go-git/v5"
39 "github.com/go-git/go-git/v5/plumbing"
40 "github.com/go-git/go-git/v5/plumbing/object"
41 "go.stargrave.org/sgblog"
42 "go.stargrave.org/sgblog/cmd/sgblog/atom"
43 "golang.org/x/crypto/blake2b"
47 AtomPostsFeed = "feed.atom"
48 AtomCommentsFeed = "comments.atom"
49 TmplHTMLIndex = `<html>
51 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
52 <meta name="generator" content="SGBlog {{.Version}}">
53 <title>{{.Cfg.Title}} {{if .Topic}}(topic: {{.Topic}}) {{end}}({{.Offset}}-{{.OffsetNext}})</title>
54 {{with .Cfg.CSS}}<link rel="stylesheet" type="text/css" href="{{.}}">{{end}}
55 {{with .Cfg.Webmaster}}<link rev="made" href="mailto:{{.}}">{{end}}
56 {{range .Cfg.GitURLs}}<link rel="vcs-git" href="{{.}}" title="Git repository">{{end}}
57 <link rel="top" href="{{.Cfg.URLPrefix}}/" title="top">
58 <link rel="alternate" title="Posts feed" href="{{.Cfg.AtomBaseURL}}{{.Cfg.URLPrefix}}/{{.AtomPostsFeed}}{{if .Topic}}?topic={{.Topic}}{{end}}" type="application/atom+xml">
59 {{if .CommentsEnabled}}<link rel="alternate" title="Comments feed" href="{{.Cfg.AtomBaseURL}}{{.Cfg.URLPrefix}}/{{.AtomCommentsFeed}}" type="application/atom+xml">{{end}}
60 {{if .Offset}}<link rel="prev" href="{{.Cfg.URLPrefix}}/?offset={{.OffsetPrev}}{{if .Topic}}&topic={{.Topic}}{{end}}" title="prev">{{end}}
61 {{if not .LogEnded}}<link rel="next" href="{{.Cfg.URLPrefix}}/?offset={{.OffsetNext}}{{if .Topic}}&topic={{.Topic}}{{end}}" title="next">{{end}}
64 {{with .Cfg.AboutURL}}[<a href="{{.}}">about</a>]{{end}}
66 {{if .Offset}}[<a href="{{.Cfg.URLPrefix}}/?offset={{.OffsetPrev}}{{if .Topic}}&topic={{.Topic}}{{end}}">prev</a>]{{end}}
67 {{if not .LogEnded}}[<a href="{{.Cfg.URLPrefix}}/?offset={{.OffsetNext}}{{if .Topic}}&topic={{.Topic}}{{end}}">next</a>]{{end}}
71 Topics: [<tt><a href="{{$Cfg.URLPrefix}}/">ALL</a></tt>]
72 {{range .Topics}}[<tt><a href="{{$Cfg.URLPrefix}}?topic={{.}}">{{.}}</a></tt>]
75 {{- $TopicsEnabled := .TopicsEnabled -}}
76 {{- $datePrev := "0001-01-01" -}}
79 <th>N</th><th>When</th><th>Title</th>
80 <th size="5%"><a title="Lines">L</a></th>
81 <th size="5%"><a title="Comments">C</a></th>
83 {{if .TopicsEnabled}}<th>Topics</th>{{end}}
86 {{- $dateCur := .Commit.Author.When.Format "2006-01-02" -}}
87 {{- if ne $dateCur $datePrev -}}
88 <tr><td colspan={{if $TopicsEnabled}}7{{else}}7{{end}}><center><tt>{{$dateCur}}</tt></center></td></tr>
89 {{- $datePrev = $dateCur -}}
93 <td><tt>{{.Commit.Author.When.Format "15:04"}}</tt></td>
94 <td><a href="{{$Cfg.URLPrefix}}/{{.Commit.Hash.String}}">{{.Title}}</a></td>
95 <td>{{.LinesNum}}</td>
96 <td>{{if .CommentsNum}}{{.CommentsNum}}{{else}} {{end}}</td>
97 <td>{{if .DomainURLs}}{{range .DomainURLs}} {{.}} {{end}}{{else}} {{end}}</td>
98 {{if $TopicsEnabled}}<td>{{if .Topics}}{{range .Topics}} <a href="{{$Cfg.URLPrefix}}/?topic={{.}}">{{.}}</a> {{end}}{{else}} {{end}}</td>{{end}}
101 {{template "links" .}}
105 TmplHTMLEntry = `{{$Cfg := .Cfg}}<html>
107 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
108 <meta name="generator" content="SGBlog {{.Version}}">
109 <title>{{.Title}} ({{.When}})</title>
110 {{with .Cfg.CSS}}<link rel="stylesheet" type="text/css" href="{{.}}">{{end}}
111 {{with .Cfg.Webmaster}}<link rev="made" href="mailto:{{.}}">{{end -}}
112 {{- range .Cfg.GitURLs}}
113 <link rel="vcs-git" href="{{.}}" title="Git repository">{{end}}
114 <link rel="top" href="{{.Cfg.URLPrefix}}/" title="top">
115 <link rel="alternate" title="Comments feed" href="{{.AtomCommentsURL}}" type="application/atom+xml">
116 {{if .Parent}}<link rel="prev" href="{{.Cfg.URLPrefix}}/{{.Parent}}" title="prev">{{end}}
119 {{with .Cfg.AboutURL}}[<a href="{{.}}">about</a>]{{end}}
120 [<a href="{{.Cfg.URLPrefix}}/">index</a>]
121 {{if .Parent}}[<a href="{{.Cfg.URLPrefix}}/{{.Parent}}">prev</a>]{{end}}
122 [<tt><a title="When">{{.When}}</a></tt>]
123 [<tt><a title="What">{{.Commit.Hash.String}}</a></tt>]
127 Topics: {{range .Topics}}[<tt><a href="{{$Cfg.URLPrefix}}?topic={{.}}">{{.}}</a></tt>]{{end}}
133 {{range .Lines}}{{. | lineURLize $Cfg.URLPrefix}}
137 {{if .NoteLines}}Note:<pre>
138 {{range .NoteLines}}{{. | lineURLize $Cfg.URLPrefix}}
142 {{if .Cfg.CommentsEmail}}[<a href="mailto:{{.Cfg.CommentsEmail}}?subject={{.TitleEscaped}}">leave comment</a>]{{end}}
144 <dl>{{range $idx, $comment := .Comments}}
145 <dt><a name="comment{{$idx}}"><a href="#comment{{$idx}}">comment {{$idx}}</a>:</dt>
147 {{range $comment.HeaderLines}}{{.}}
148 {{end}}{{range $comment.BodyLines}}{{. | lineURLize $Cfg.URLPrefix}}
158 renderableSchemes = map[string]struct{}{
169 type TableEntry struct {
170 Commit *object.Commit
181 type CommentEntry struct {
186 func makeA(href, text string) string {
187 return `<a href="` + href + `">` + text + `</a>`
190 func etagString(etag hash.Hash) string {
191 return `"` + hex.EncodeToString(etag.Sum(nil)) + `"`
194 func urlParse(what string) *url.URL {
195 if u, err := url.ParseRequestURI(what); err == nil {
196 if _, exists := renderableSchemes[u.Scheme]; exists {
203 func lineURLize(urlPrefix, line string) string {
204 cols := strings.Split(html.EscapeString(line), " ")
205 for i, col := range cols {
206 if u := urlParse(col); u != nil {
207 cols[i] = makeA(col, col)
210 cols[i] = sha1DigestRe.ReplaceAllString(col, makeA(urlPrefix+"/$1", "$1"))
212 return strings.Join(cols, " ")
215 func lineURLizeInTemplate(urlPrefix, line interface{}) string {
216 return lineURLize(urlPrefix.(string), line.(string))
219 func startHeader(etag hash.Hash, gziped bool) string {
221 "Content-Type: text/html; charset=UTF-8",
222 "ETag: " + etagString(etag),
225 lines = append(lines, "Content-Encoding: gzip")
227 lines = append(lines, "")
228 lines = append(lines, "")
229 return strings.Join(lines, "\n")
232 func makeErr(err error) {
233 fmt.Print("Content-Type: text/plain; charset=UTF-8\n\n")
238 func checkETag(etag hash.Hash) {
239 ifNoneMatch := os.Getenv("HTTP_IF_NONE_MATCH")
240 if ifNoneMatch != "" && ifNoneMatch == etagString(etag) {
241 fmt.Printf("Status: 304\nETag: %s\n\n", ifNoneMatch)
246 func bytes2uuid(b []byte) string {
249 raw[6] = (raw[6] & 0x0F) | uint8(4<<4) // version 4
250 return fmt.Sprintf("%x-%x-%x-%x-%x", raw[0:4], raw[4:6], raw[6:8], raw[8:10], raw[10:])
253 type CommitIterNext interface {
254 Next() (*object.Commit, error)
258 cfgPath := os.Getenv("SGBLOG_CFG")
260 log.Fatalln("SGBLOG_CFG is not set")
262 cfg, err := readCfg(cfgPath)
267 pathInfo, exists := os.LookupEnv("PATH_INFO")
271 queryValues, err := url.ParseQuery(os.Getenv("QUERY_STRING"))
276 etagHash, err := blake2b.New256(nil)
280 for _, s := range []string{
291 if _, err = etagHash.Write([]byte(s)); err != nil {
295 etagHashForWeb := []string{
299 cfg.CommentsNotesRef,
302 for _, gitURL := range cfg.GitURLs {
303 etagHashForWeb = append(etagHashForWeb, gitURL)
306 headHash, err := initRepo(cfg)
311 if notes, err := repo.Notes(); err == nil {
312 var notesRef *plumbing.Reference
313 var commentsRef *plumbing.Reference
314 notes.ForEach(func(ref *plumbing.Reference) error {
315 switch string(ref.Name()) {
316 case "refs/notes/commits":
318 case cfg.CommentsNotesRef:
324 if commentsCommit, err := repo.CommitObject(notesRef.Hash()); err == nil {
325 notesTree, _ = commentsCommit.Tree()
328 if commentsRef != nil {
329 if commentsCommit, err := repo.CommitObject(commentsRef.Hash()); err == nil {
330 commentsTree, _ = commentsCommit.Tree()
335 var outBuf bytes.Buffer
338 var gzipWriter *gzip.Writer
339 acceptEncoding := os.Getenv("HTTP_ACCEPT_ENCODING")
340 for _, encoding := range strings.Split(acceptEncoding, ", ") {
341 if encoding == "gzip" {
342 gzipWriter = gzip.NewWriter(&outBuf)
349 if offsetRaw, exists := queryValues["offset"]; exists {
350 offset, err = strconv.Atoi(offsetRaw[0])
355 repoLog, err := repo.Log(&git.LogOptions{From: *headHash})
359 topicsCache, err := getTopicsCache(cfg, repoLog)
363 repoLog, err = repo.Log(&git.LogOptions{From: *headHash})
369 var commits CommitIterNext
371 if t, exists := queryValues["topic"]; exists {
373 hashes := topicsCache[topic]
375 makeErr(errors.New("no posts with that topic"))
377 if len(hashes) > offset {
378 hashes = hashes[offset:]
381 commits = &HashesIter{hashes}
383 for i := 0; i < offset; i++ {
384 if _, err = repoLog.Next(); err != nil {
392 entries := make([]TableEntry, 0, PageEntries)
394 for _, data := range etagHashForWeb {
395 etagHash.Write([]byte(data))
397 etagHash.Write([]byte("INDEX"))
398 etagHash.Write([]byte(topic))
399 for i := 0; i < PageEntries; i++ {
400 commit, err := commits.Next()
405 etagHash.Write(commit.Hash[:])
406 commentsRaw := sgblog.GetNote(repo, commentsTree, commit.Hash)
407 etagHash.Write(commentsRaw)
408 topicsRaw := sgblog.GetNote(repo, topicsTree, commit.Hash)
409 etagHash.Write(topicsRaw)
410 entries = append(entries, TableEntry{
412 CommentsRaw: commentsRaw,
413 TopicsRaw: topicsRaw,
418 for i, entry := range entries {
421 lines := msgSplit(entry.Commit.Message)
422 entry.Title = lines[0]
423 entry.LinesNum = len(lines) - 2
424 for _, line := range lines[2:] {
429 entry.DomainURLs = append(entry.DomainURLs, makeA(line, u.Host))
431 entry.CommentsNum = len(sgblog.ParseComments(entry.CommentsRaw))
432 entry.Topics = sgblog.ParseTopics(entry.TopicsRaw)
435 offsetPrev := offset - PageEntries
439 tmpl := template.Must(template.New("index").Parse(TmplHTMLIndex))
440 os.Stdout.Write([]byte(startHeader(etagHash, gzipWriter != nil)))
441 err = tmpl.Execute(out, struct {
449 AtomCommentsFeed string
456 Version: sgblog.Version,
459 TopicsEnabled: topicsTree != nil,
460 Topics: topicsCache.Topics(),
461 CommentsEnabled: commentsTree != nil,
462 AtomPostsFeed: AtomPostsFeed,
463 AtomCommentsFeed: AtomCommentsFeed,
465 OffsetPrev: offsetPrev,
466 OffsetNext: offset + PageEntries,
473 } else if pathInfo == "/"+AtomPostsFeed {
474 commit, err := repo.CommitObject(*headHash)
480 if t, exists := queryValues["topic"]; exists {
484 etagHash.Write([]byte("ATOM POSTS"))
485 etagHash.Write([]byte(topic))
486 etagHash.Write(commit.Hash[:])
492 title = fmt.Sprintf("%s (topic: %s)", cfg.Title, topic)
494 idHasher, err := blake2b.New256(nil)
498 idHasher.Write([]byte("ATOM POSTS"))
499 idHasher.Write([]byte(cfg.AtomId))
500 idHasher.Write([]byte(topic))
503 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
504 Updated: atom.Time(commit.Author.When),
507 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + AtomPostsFeed,
509 Author: &atom.Person{Name: cfg.AtomAuthor},
512 repoLog, err := repo.Log(&git.LogOptions{From: *headHash})
516 var commits CommitIterNext
520 topicsCache, err := getTopicsCache(cfg, repoLog)
524 hashes := topicsCache[topic]
526 makeErr(errors.New("no posts with that topic"))
528 commits = &HashesIter{hashes}
531 for i := 0; i < PageEntries; i++ {
532 commit, err = commits.Next()
536 lines := msgSplit(commit.Message)
537 var categories []atom.Category
538 for _, topic := range sgblog.ParseTopics(sgblog.GetNote(repo, topicsTree, commit.Hash)) {
539 categories = append(categories, atom.Category{Term: topic})
541 htmlized := make([]string, 0, len(lines))
542 htmlized = append(htmlized, "<pre>")
543 for _, l := range lines[2:] {
544 htmlized = append(htmlized, lineURLize(cfg.AtomBaseURL+cfg.URLPrefix, l))
546 htmlized = append(htmlized, "</pre>")
547 feed.Entry = append(feed.Entry, &atom.Entry{
549 ID: "urn:uuid:" + bytes2uuid(commit.Hash[:]),
552 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + commit.Hash.String(),
554 Published: atom.Time(commit.Author.When),
555 Updated: atom.Time(commit.Author.When),
556 Summary: &atom.Text{Type: "text", Body: lines[0]},
559 Body: strings.Join(htmlized, "\n"),
561 Category: categories,
564 data, err := xml.MarshalIndent(&feed, "", " ")
570 } else if pathInfo == "/"+AtomCommentsFeed {
571 commit, err := repo.CommitObject(commentsRef.Hash())
575 etagHash.Write([]byte("ATOM COMMENTS"))
576 etagHash.Write(commit.Hash[:])
578 idHasher, err := blake2b.New256(nil)
582 idHasher.Write([]byte("ATOM COMMENTS"))
583 idHasher.Write([]byte(cfg.AtomId))
585 Title: cfg.Title + " comments",
586 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
587 Updated: atom.Time(commit.Author.When),
590 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + AtomCommentsFeed,
592 Author: &atom.Person{Name: cfg.AtomAuthor},
594 repoLog, err := repo.Log(&git.LogOptions{From: commentsRef.Hash()})
598 for i := 0; i < PageEntries; i++ {
599 commit, err = repoLog.Next()
603 fileStats, err := commit.Stats()
607 t, err := commit.Tree()
611 commentedHash := plumbing.NewHash(strings.ReplaceAll(
612 fileStats[0].Name, "/", "",
614 commit, err = repo.CommitObject(commentedHash)
618 comments := sgblog.ParseComments(sgblog.GetNote(repo, t, commentedHash))
619 if len(comments) == 0 {
622 commentN := strconv.Itoa(len(comments) - 1)
623 lines := strings.Split(comments[len(comments)-1], "\n")
624 from := strings.TrimPrefix(lines[0], "From: ")
625 date := strings.TrimPrefix(lines[1], "Date: ")
626 htmlized := make([]string, 0, len(lines))
627 htmlized = append(htmlized, "<pre>")
628 for _, l := range lines[2:] {
629 htmlized = append(htmlized, lineURLize(cfg.AtomBaseURL+cfg.URLPrefix, l))
631 htmlized = append(htmlized, "</pre>")
633 idHasher.Write([]byte("COMMENT"))
634 idHasher.Write(commit.Hash[:])
635 idHasher.Write([]byte(commentN))
636 feed.Entry = append(feed.Entry, &atom.Entry{
638 "Comment %s for \"%s\" by %s",
639 commentN, msgSplit(commit.Message)[0], from,
641 Author: &atom.Person{Name: from},
642 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
645 Href: strings.Join([]string{
646 cfg.AtomBaseURL, cfg.URLPrefix, "/",
647 commit.Hash.String(), "#comment", commentN,
650 Published: atom.TimeStr(strings.Replace(date, " ", "T", -1)),
651 Updated: atom.TimeStr(strings.Replace(date, " ", "T", -1)),
654 Body: strings.Join(htmlized, "\n"),
658 data, err := xml.MarshalIndent(&feed, "", " ")
664 } else if sha1DigestRe.MatchString(pathInfo[1:]) {
665 commit, err := repo.CommitObject(plumbing.NewHash(pathInfo[1 : 1+sha1.Size*2]))
669 for _, data := range etagHashForWeb {
670 etagHash.Write([]byte(data))
672 etagHash.Write([]byte("ENTRY"))
673 etagHash.Write(commit.Hash[:])
674 atomCommentsURL := strings.Join([]string{
675 cfg.AtomBaseURL, cfg.URLPrefix, "/",
676 commit.Hash.String(), "/", AtomCommentsFeed,
678 commentsRaw := sgblog.GetNote(repo, commentsTree, commit.Hash)
679 etagHash.Write(commentsRaw)
680 topicsRaw := sgblog.GetNote(repo, topicsTree, commit.Hash)
681 etagHash.Write(topicsRaw)
682 if strings.HasSuffix(pathInfo, AtomCommentsFeed) {
683 etagHash.Write([]byte("ATOM COMMENTS"))
685 type Comment struct {
691 commentsRaw := sgblog.ParseComments(commentsRaw)
693 if len(commentsRaw) > PageEntries {
694 toSkip = len(commentsRaw) - PageEntries
696 comments := make([]Comment, 0, len(commentsRaw)-toSkip)
697 for i := len(commentsRaw) - 1; i >= toSkip; i-- {
698 lines := strings.Split(commentsRaw[i], "\n")
699 from := strings.TrimPrefix(lines[0], "From: ")
700 date := strings.TrimPrefix(lines[1], "Date: ")
701 comments = append(comments, Comment{
704 date: strings.Replace(date, " ", "T", 1),
708 idHasher, err := blake2b.New256(nil)
712 idHasher.Write([]byte("ATOM COMMENTS"))
713 idHasher.Write(commit.Hash[:])
715 Title: fmt.Sprintf("\"%s\" comments", msgSplit(commit.Message)[0]),
716 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
717 Link: []atom.Link{{Rel: "self", Href: atomCommentsURL}},
718 Author: &atom.Person{Name: cfg.AtomAuthor},
720 if len(comments) > 0 {
721 feed.Updated = atom.TimeStr(comments[0].date)
723 feed.Updated = atom.Time(commit.Author.When)
725 for _, comment := range comments {
727 idHasher.Write([]byte("COMMENT"))
728 idHasher.Write(commit.Hash[:])
729 idHasher.Write([]byte(comment.n))
730 htmlized := make([]string, 0, len(comment.body))
731 htmlized = append(htmlized, "<pre>")
732 for _, l := range comment.body {
735 lineURLize(cfg.AtomBaseURL+cfg.URLPrefix, l),
738 htmlized = append(htmlized, "</pre>")
739 feed.Entry = append(feed.Entry, &atom.Entry{
740 Title: fmt.Sprintf("Comment %s by %s", comment.n, comment.from),
741 Author: &atom.Person{Name: comment.from},
742 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
745 Href: strings.Join([]string{
748 commit.Hash.String(),
749 "#comment", comment.n,
752 Published: atom.TimeStr(
753 strings.Replace(comment.date, " ", "T", -1),
755 Updated: atom.TimeStr(
756 strings.Replace(comment.date, " ", "T", -1),
760 Body: strings.Join(htmlized, "\n"),
764 data, err := xml.MarshalIndent(&feed, "", " ")
771 notesRaw := sgblog.GetNote(repo, notesTree, commit.Hash)
772 etagHash.Write(notesRaw)
775 lines := msgSplit(commit.Message)
777 when := commit.Author.When.Format(sgblog.WhenFmt)
779 if len(commit.ParentHashes) > 0 {
780 parent = commit.ParentHashes[0].String()
782 commentsParsed := sgblog.ParseComments(commentsRaw)
783 comments := make([]CommentEntry, 0, len(commentsParsed))
784 for _, comment := range commentsParsed {
785 lines := strings.Split(comment, "\n")
786 comments = append(comments, CommentEntry{lines[:3], lines[3:]})
788 var notesLines []string
789 if len(notesRaw) > 0 {
790 notesLines = strings.Split(string(notesRaw), "\n")
793 tmpl := template.New("entry")
794 tmpl = tmpl.Funcs(template.FuncMap{"lineURLize": lineURLizeInTemplate})
795 tmpl = template.Must(tmpl.Parse(TmplHTMLEntry))
796 os.Stdout.Write([]byte(startHeader(etagHash, gzipWriter != nil)))
797 err = tmpl.Execute(out, struct {
803 AtomCommentsURL string
805 Commit *object.Commit
808 Comments []CommentEntry
811 Version: sgblog.Version,
814 TitleEscaped: url.PathEscape(fmt.Sprintf("Re: %s (%s)", title, commit.Hash)),
816 AtomCommentsURL: atomCommentsURL,
820 NoteLines: notesLines,
822 Topics: sgblog.ParseTopics(topicsRaw),
828 makeErr(errors.New("unknown URL action"))
830 out.Write([]byte("</body></html>\n"))
831 if gzipWriter != nil {
834 os.Stdout.Write(outBuf.Bytes())
838 os.Stdout.WriteString("Content-Type: application/atom+xml; charset=UTF-8\n")
839 os.Stdout.WriteString("ETag: " + etagString(etagHash) + "\n")
840 if gzipWriter != nil {
841 os.Stdout.WriteString("Content-Encoding: gzip\n")
844 os.Stdout.WriteString("\n")
845 os.Stdout.Write(outBuf.Bytes())