2 SGBlog -- Git-backed CGI/inetd blogging/phlogging engine
3 Copyright (C) 2020 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/>.
40 "github.com/hjson/hjson-go"
41 "go.stargrave.org/sgblog"
42 "golang.org/x/crypto/blake2b"
43 "golang.org/x/tools/blog/atom"
44 "gopkg.in/src-d/go-git.v4"
45 "gopkg.in/src-d/go-git.v4/plumbing"
46 "gopkg.in/src-d/go-git.v4/plumbing/object"
50 AtomPostsFeed = "feed.atom"
51 AtomCommentsFeed = "comments.atom"
52 TmplHTMLIndex = `<html>
54 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
55 <meta name="generator" content="SGBlog {{.Version}}">
56 <title>{{.Cfg.Title}} ({{.Offset}}-{{.OffsetNext}})</title>
57 {{with .Cfg.CSS}}<link rel="stylesheet" type="text/css" href="{{.}}">{{end}}
58 {{with .Cfg.Webmaster}}<link rev="made" href="mailto:{{.}}">{{end}}
59 {{range .Cfg.GitURLs}}<link rel="vcs-git" href="{{.}}" title="Git repository">{{end}}
60 <link rel="top" href="{{.Cfg.URLPrefix}}/" title="top">
61 <link rel="alternate" title="Posts feed" href="{{.Cfg.AtomBaseURL}}{{.Cfg.URLPrefix}}/{{.AtomPostsFeed}}" type="application/atom+xml">
62 {{if .CommentsEnabled}}<link rel="alternate" title="Comments feed" href="{{.Cfg.AtomBaseURL}}{{.Cfg.URLPrefix}}/{{.AtomCommentsFeed}}" type="application/atom+xml">{{end}}
63 {{if .Offset}}<link rel="prev" href="{{.Cfg.URLPrefix}}/{{if .OffsetPrev}}?offset={{.OffsetPrev}}{{end}}" title="prev">{{end}}
64 {{if not .LogEnded}}<link rel="next" href="{{.Cfg.URLPrefix}}/?offset={{.OffsetNext}}" title="next">{{end}}
67 {{with .Cfg.AboutURL}}[<a href="{{.}}">about</a>]{{end}}
69 {{if .Offset}}[<a href="{{.Cfg.URLPrefix}}/{{if .OffsetPrev}}?offset={{.OffsetPrev}}{{end}}">prev</a>]{{end}}
70 {{if not .LogEnded}}[<a href="{{.Cfg.URLPrefix}}/?offset={{.OffsetNext}}">next</a>]{{end}}
73 {{- $datePrev := "0001-01-01" -}}
76 <th>N</th><th>When</th><th>Title</th>
77 <th size="5%"><a title="Lines">L</a></th>
78 <th size="5%"><a title="Comments">C</a></th>
82 {{- $dateCur := .Commit.Author.When.Format "2006-01-02" -}}
83 {{- if ne $dateCur $datePrev -}}
84 <tr><td colspan=6><center><tt>{{$dateCur}}</tt></center></td></tr>
85 {{- $datePrev = $dateCur -}}
89 <td><tt>{{.Commit.Author.When.Format "15:04"}}</tt></td>
90 <td><a href="{{$Cfg.URLPrefix}}/{{.Commit.Hash.String}}">{{.Title}}</a></td>
91 <td>{{.LinesNum}}</td>
92 <td>{{if .CommentsNum}}{{.CommentsNum}}{{else}} {{end}}</td>
93 <td>{{if .DomainURLs}}{{range .DomainURLs}} {{.}} {{end}}{{else}} {{end}}</td>
96 {{template "links" .}}
100 TmplHTMLEntry = `{{$Cfg := .Cfg}}<html>
102 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
103 <meta name="generator" content="SGBlog {{.Version}}">
104 <title>{{.Title}} ({{.When}})</title>
105 {{with .Cfg.CSS}}<link rel="stylesheet" type="text/css" href="{{.}}">{{end}}
106 {{with .Cfg.Webmaster}}<link rev="made" href="mailto:{{.}}">{{end -}}
107 {{- range .Cfg.GitURLs}}
108 <link rel="vcs-git" href="{{.}}" title="Git repository">{{end}}
109 <link rel="top" href="{{.Cfg.URLPrefix}}/" title="top">
110 <link rel="alternate" title="Comments feed" href="{{.AtomCommentsURL}}" type="application/atom+xml">
111 {{if .Parent}}<link rel="prev" href="{{.Cfg.URLPrefix}}/{{.Parent}}" title="prev">{{end}}
114 {{with .Cfg.AboutURL}}[<a href="{{.}}">about</a>]{{end}}
115 [<a href="{{.Cfg.URLPrefix}}/">index</a>]
116 {{if .Parent}}[<a href="{{.Cfg.URLPrefix}}/{{.Parent}}">prev</a>]{{end}}
117 [<tt><a title="When">{{.When}}</a></tt>]
118 [<tt><a title="What">{{.Commit.Hash.String}}</a></tt>]
123 {{range .Lines}}{{. | lineURLize $Cfg.URLPrefix}}
127 {{if .NoteLines}}Note:<pre>
128 {{range .NoteLines}}{{. | lineURLize $Cfg.URLPrefix}}
132 {{if .Cfg.CommentsEmail}}[<a href="mailto:{{.Cfg.CommentsEmail}}?subject={{.Commit.Hash.String}}">leave comment</a>]{{end}}
134 <dl>{{range $idx, $comment := .Comments}}
135 <dt><a name="comment{{$idx}}"><a href="#comment{{$idx}}">comment {{$idx}}</a>:</dt>
137 {{range $comment.HeaderLines}}{{.}}
138 {{end}}{{range $comment.BodyLines}}{{. | lineURLize $Cfg.URLPrefix}}
148 renderableSchemes = map[string]struct{}{
150 "gopher": struct{}{},
153 "telnet": struct{}{},
157 type TableEntry struct {
158 Commit *object.Commit
167 type CommentEntry struct {
172 func makeA(href, text string) string {
173 return `<a href="` + href + `">` + text + `</a>`
176 func etagString(etag hash.Hash) string {
177 return `"` + hex.EncodeToString(etag.Sum(nil)) + `"`
180 func urlParse(what string) *url.URL {
181 if u, err := url.ParseRequestURI(what); err == nil {
182 if _, exists := renderableSchemes[u.Scheme]; exists {
189 func lineURLize(urlPrefix, line string) string {
190 cols := strings.Split(html.EscapeString(line), " ")
191 for i, col := range cols {
192 if u := urlParse(col); u != nil {
193 cols[i] = makeA(col, col)
196 cols[i] = sha1DigestRe.ReplaceAllString(col, makeA(urlPrefix+"/$1", "$1"))
198 return strings.Join(cols, " ")
201 func lineURLizeInTemplate(urlPrefix, line interface{}) string {
202 return lineURLize(urlPrefix.(string), line.(string))
205 func startHeader(etag hash.Hash, gziped bool) string {
207 "Content-Type: text/html; charset=UTF-8",
208 "ETag: " + etagString(etag),
211 lines = append(lines, "Content-Encoding: gzip")
213 lines = append(lines, "")
214 lines = append(lines, "")
215 return strings.Join(lines, "\n")
218 func makeErr(err error) {
219 fmt.Print("Content-Type: text/plain; charset=UTF-8\n\n")
224 func checkETag(etag hash.Hash) {
225 ifNoneMatch := os.Getenv("HTTP_IF_NONE_MATCH")
226 if ifNoneMatch != "" && ifNoneMatch == etagString(etag) {
227 fmt.Printf("Status: 304\nETag: %s\n\n", ifNoneMatch)
232 func bytes2uuid(b []byte) string {
235 raw[6] = (raw[6] & 0x0F) | uint8(4<<4) // version 4
236 return fmt.Sprintf("%x-%x-%x-%x-%x", raw[0:4], raw[4:6], raw[6:8], raw[8:10], raw[10:])
240 cfgPath := os.Getenv("SGBLOG_CFG")
242 log.Fatalln("SGBLOG_CFG is not set")
244 cfgRaw, err := ioutil.ReadFile(cfgPath)
248 var cfgGeneral map[string]interface{}
249 if err = hjson.Unmarshal(cfgRaw, &cfgGeneral); err != nil {
252 cfgRaw, err = json.Marshal(cfgGeneral)
257 if err = json.Unmarshal(cfgRaw, &cfg); err != nil {
260 pathInfo, exists := os.LookupEnv("PATH_INFO")
264 queryValues, err := url.ParseQuery(os.Getenv("QUERY_STRING"))
269 etagHash, err := blake2b.New256(nil)
273 for _, s := range []string{
284 if _, err = etagHash.Write([]byte(s)); err != nil {
288 etagHashForWeb := []string{
292 cfg.CommentsNotesRef,
295 for _, gitURL := range cfg.GitURLs {
296 etagHashForWeb = append(etagHashForWeb, gitURL)
299 headHash, err := initRepo(cfg)
304 if notes, err := repo.Notes(); err == nil {
305 var notesRef *plumbing.Reference
306 var commentsRef *plumbing.Reference
307 notes.ForEach(func(ref *plumbing.Reference) error {
308 switch string(ref.Name()) {
309 case "refs/notes/commits":
311 case cfg.CommentsNotesRef:
317 if commentsCommit, err := repo.CommitObject(notesRef.Hash()); err == nil {
318 notesTree, _ = commentsCommit.Tree()
321 if commentsRef != nil {
322 if commentsCommit, err := repo.CommitObject(commentsRef.Hash()); err == nil {
323 commentsTree, _ = commentsCommit.Tree()
328 var outBuf bytes.Buffer
331 var gzipWriter *gzip.Writer
332 acceptEncoding := os.Getenv("HTTP_ACCEPT_ENCODING")
333 for _, encoding := range strings.Split(acceptEncoding, ", ") {
334 if encoding == "gzip" {
335 gzipWriter = gzip.NewWriter(&outBuf)
342 if offsetRaw, exists := queryValues["offset"]; exists {
343 offset, err = strconv.Atoi(offsetRaw[0])
348 repoLog, err := repo.Log(&git.LogOptions{From: *headHash})
353 for i := 0; i < offset; i++ {
354 if _, err = repoLog.Next(); err != nil {
360 entries := make([]TableEntry, 0, PageEntries)
362 for _, data := range etagHashForWeb {
363 etagHash.Write([]byte(data))
365 etagHash.Write([]byte("INDEX"))
366 for i := 0; i < PageEntries; i++ {
367 commit, err := repoLog.Next()
372 etagHash.Write(commit.Hash[:])
373 commentsRaw := getNote(commentsTree, commit.Hash)
374 etagHash.Write(commentsRaw)
375 entries = append(entries, TableEntry{
377 CommentsRaw: commentsRaw,
382 for i, entry := range entries {
385 lines := msgSplit(entry.Commit.Message)
386 entry.Title = lines[0]
387 entry.LinesNum = len(lines) - 2
388 for _, line := range lines[2:] {
393 entry.DomainURLs = append(entry.DomainURLs, makeA(line, u.Host))
395 entry.CommentsNum = len(parseComments(entry.CommentsRaw))
398 tmpl := template.Must(template.New("index").Parse(TmplHTMLIndex))
399 os.Stdout.Write([]byte(startHeader(etagHash, gzipWriter != nil)))
400 err = tmpl.Execute(out, struct {
405 AtomCommentsFeed string
412 Version: sgblog.Version,
414 CommentsEnabled: commentsTree != nil,
415 AtomPostsFeed: AtomPostsFeed,
416 AtomCommentsFeed: AtomCommentsFeed,
418 OffsetPrev: offset - PageEntries,
419 OffsetNext: offset + PageEntries,
426 } else if pathInfo == "/"+AtomPostsFeed {
427 commit, err := repo.CommitObject(*headHash)
431 etagHash.Write([]byte("ATOM POSTS"))
432 etagHash.Write(commit.Hash[:])
437 Updated: atom.Time(commit.Author.When),
440 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + AtomPostsFeed,
442 Author: &atom.Person{Name: cfg.AtomAuthor},
444 repoLog, err := repo.Log(&git.LogOptions{From: *headHash})
448 for i := 0; i < PageEntries; i++ {
449 commit, err = repoLog.Next()
453 lines := msgSplit(commit.Message)
454 feed.Entry = append(feed.Entry, &atom.Entry{
456 ID: "urn:uuid:" + bytes2uuid(commit.Hash[:]),
459 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + commit.Hash.String(),
461 Published: atom.Time(commit.Author.When),
462 Updated: atom.Time(commit.Author.When),
463 Summary: &atom.Text{Type: "text", Body: lines[0]},
466 Body: strings.Join(lines[2:], "\n"),
470 data, err := xml.MarshalIndent(&feed, "", " ")
476 } else if pathInfo == "/"+AtomCommentsFeed {
477 commit, err := repo.CommitObject(commentsRef.Hash())
481 etagHash.Write([]byte("ATOM COMMENTS"))
482 etagHash.Write(commit.Hash[:])
484 idHasher, err := blake2b.New256(nil)
488 idHasher.Write([]byte("ATOM COMMENTS"))
489 idHasher.Write([]byte(cfg.AtomId))
491 Title: cfg.Title + " comments",
492 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
493 Updated: atom.Time(commit.Author.When),
496 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + AtomCommentsFeed,
498 Author: &atom.Person{Name: cfg.AtomAuthor},
500 repoLog, err := repo.Log(&git.LogOptions{From: commentsRef.Hash()})
504 for i := 0; i < PageEntries; i++ {
505 commit, err = repoLog.Next()
509 fileStats, err := commit.Stats()
513 t, err := commit.Tree()
517 commentedHash := plumbing.NewHash(strings.ReplaceAll(
518 fileStats[0].Name, "/", "",
520 commit, err = repo.CommitObject(commentedHash)
524 comments := parseComments(getNote(t, commentedHash))
525 if len(comments) == 0 {
528 commentN := strconv.Itoa(len(comments) - 1)
529 lines := strings.Split(comments[len(comments)-1], "\n")
530 from := strings.TrimPrefix(lines[0], "From: ")
531 date := strings.TrimPrefix(lines[1], "Date: ")
533 idHasher.Write([]byte("COMMENT"))
534 idHasher.Write(commit.Hash[:])
535 idHasher.Write([]byte(commentN))
536 feed.Entry = append(feed.Entry, &atom.Entry{
538 "Comment %s for \"%s\" by %s",
539 commentN, msgSplit(commit.Message)[0], from,
541 Author: &atom.Person{Name: from},
542 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
545 Href: strings.Join([]string{
546 cfg.AtomBaseURL, cfg.URLPrefix, "/",
547 commit.Hash.String(), "#comment", commentN,
550 Published: atom.TimeStr(date),
551 Updated: atom.TimeStr(date),
554 Body: strings.Join(lines[2:], "\n"),
558 data, err := xml.MarshalIndent(&feed, "", " ")
564 } else if sha1DigestRe.MatchString(pathInfo[1:]) {
565 commit, err := repo.CommitObject(plumbing.NewHash(pathInfo[1 : 1+sha1.Size*2]))
569 for _, data := range etagHashForWeb {
570 etagHash.Write([]byte(data))
572 etagHash.Write([]byte("ENTRY"))
573 etagHash.Write(commit.Hash[:])
574 atomCommentsURL := strings.Join([]string{
575 cfg.AtomBaseURL, cfg.URLPrefix, "/",
576 commit.Hash.String(), "/", AtomCommentsFeed,
578 commentsRaw := getNote(commentsTree, commit.Hash)
579 etagHash.Write(commentsRaw)
580 if strings.HasSuffix(pathInfo, AtomCommentsFeed) {
581 etagHash.Write([]byte("ATOM COMMENTS"))
583 type Comment struct {
589 commentsRaw := parseComments(commentsRaw)
591 if len(commentsRaw) > PageEntries {
592 toSkip = len(commentsRaw) - PageEntries
594 comments := make([]Comment, 0, len(commentsRaw)-toSkip)
595 for i := len(commentsRaw) - 1; i >= toSkip; i-- {
596 lines := strings.Split(commentsRaw[i], "\n")
597 from := strings.TrimPrefix(lines[0], "From: ")
598 date := strings.TrimPrefix(lines[1], "Date: ")
599 comments = append(comments, Comment{
602 date: strings.Replace(date, " ", "T", 1),
606 idHasher, err := blake2b.New256(nil)
610 idHasher.Write([]byte("ATOM COMMENTS"))
611 idHasher.Write(commit.Hash[:])
613 Title: fmt.Sprintf("\"%s\" comments", msgSplit(commit.Message)[0]),
614 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
615 Link: []atom.Link{{Rel: "self", Href: atomCommentsURL}},
616 Author: &atom.Person{Name: cfg.AtomAuthor},
618 if len(comments) > 0 {
619 feed.Updated = atom.TimeStr(comments[0].date)
621 feed.Updated = atom.Time(commit.Author.When)
623 for _, comment := range comments {
625 idHasher.Write([]byte("COMMENT"))
626 idHasher.Write(commit.Hash[:])
627 idHasher.Write([]byte(comment.n))
628 feed.Entry = append(feed.Entry, &atom.Entry{
629 Title: fmt.Sprintf("Comment %s by %s", comment.n, comment.from),
630 Author: &atom.Person{Name: comment.from},
631 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
634 Href: strings.Join([]string{
637 commit.Hash.String(),
638 "#comment", comment.n,
641 Published: atom.TimeStr(comment.date),
642 Updated: atom.TimeStr(comment.date),
645 Body: strings.Join(comment.body, "\n"),
649 data, err := xml.MarshalIndent(&feed, "", " ")
656 notesRaw := getNote(notesTree, commit.Hash)
657 etagHash.Write(notesRaw)
660 lines := msgSplit(commit.Message)
662 when := commit.Author.When.Format(sgblog.WhenFmt)
664 if len(commit.ParentHashes) > 0 {
665 parent = commit.ParentHashes[0].String()
667 commentsParsed := parseComments(commentsRaw)
668 comments := make([]CommentEntry, 0, len(commentsParsed))
669 for _, comment := range commentsParsed {
670 lines := strings.Split(comment, "\n")
671 comments = append(comments, CommentEntry{lines[:3], lines[3:]})
673 var notesLines []string
674 if len(notesRaw) > 0 {
675 notesLines = strings.Split(string(notesRaw), "\n")
678 tmpl := template.New("entry")
679 tmpl = tmpl.Funcs(template.FuncMap{"lineURLize": lineURLizeInTemplate})
680 tmpl = template.Must(tmpl.Parse(TmplHTMLEntry))
681 os.Stdout.Write([]byte(startHeader(etagHash, gzipWriter != nil)))
682 err = tmpl.Execute(out, struct {
687 AtomCommentsURL string
689 Commit *object.Commit
692 Comments []CommentEntry
694 Version: sgblog.Version,
698 AtomCommentsURL: atomCommentsURL,
702 NoteLines: notesLines,
709 makeErr(errors.New("unknown URL action"))
711 out.Write([]byte("</body></html>\n"))
712 if gzipWriter != nil {
715 os.Stdout.Write(outBuf.Bytes())
719 os.Stdout.WriteString("Content-Type: text/xml; charset=UTF-8\n")
720 os.Stdout.WriteString("ETag: " + etagString(etagHash) + "\n")
721 if gzipWriter != nil {
722 os.Stdout.WriteString("Content-Encoding: gzip\n")
725 os.Stdout.WriteString("\n")
726 os.Stdout.Write(outBuf.Bytes())