2 SGBlog -- Git-backed CGI/UCSPI blogging/phlogging/gemlogging engine
3 Copyright (C) 2020-2023 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/>.
41 "github.com/go-git/go-git/v5"
42 "github.com/go-git/go-git/v5/plumbing"
43 "github.com/go-git/go-git/v5/plumbing/object"
44 "github.com/vorlif/spreak"
45 "go.stargrave.org/sgblog"
46 "go.stargrave.org/sgblog/cmd/sgblog/atom"
47 "golang.org/x/crypto/blake2b"
51 AtomPostsFeed = "feed.atom"
52 AtomCommentsFeed = "comments.atom"
56 renderableSchemes = map[string]struct{}{
69 //go:embed http-index.tmpl
70 TmplHTMLIndexRaw string
71 TmplHTMLIndex = template.Must(template.New("http-index").Parse(TmplHTMLIndexRaw))
73 //go:embed http-entry.tmpl
74 TmplHTMLEntryRaw string
75 TmplHTMLEntry = template.Must(template.New("http-entry").Funcs(
76 template.FuncMap{"lineURLize": lineURLizeInTemplate},
77 ).Parse(TmplHTMLEntryRaw))
80 type TableEntry struct {
92 type CommentEntry struct {
97 func makeA(href, text string) string {
98 return `<a href="` + href + `">` + text + `</a>`
101 func etagString(etag hash.Hash) string {
102 return `"` + hex.EncodeToString(etag.Sum(nil)) + `"`
105 func urlParse(what string) *url.URL {
106 if u, err := url.ParseRequestURI(what); err == nil {
107 if _, exists := renderableSchemes[u.Scheme]; exists {
114 func lineURLize(urlPrefix, line string) string {
115 cols := strings.Split(html.EscapeString(line), " ")
116 for i, col := range cols {
117 if u := urlParse(col); u != nil {
118 cols[i] = makeA(col, col)
121 cols[i] = sha1DigestRe.ReplaceAllString(col, makeA(urlPrefix+"/$1", "$1"))
123 return strings.Join(cols, " ")
126 func lineURLizeInTemplate(urlPrefix, line interface{}) string {
127 return lineURLize(urlPrefix.(string), line.(string))
130 func startHeader(etag hash.Hash, gziped bool) string {
132 "Content-Type: text/html; charset=utf-8",
133 "ETag: " + etagString(etag),
136 lines = append(lines, "Content-Encoding: gzip")
138 lines = append(lines, "")
139 lines = append(lines, "")
140 return strings.Join(lines, "\n")
143 func makeErr(err error, status int) {
144 fmt.Println("Status:", status)
145 fmt.Print("Content-Type: text/plain; charset=utf-8\n\n")
150 func checkETag(etag hash.Hash) {
151 ifNoneMatch := os.Getenv("HTTP_IF_NONE_MATCH")
152 if ifNoneMatch != "" && ifNoneMatch == etagString(etag) {
153 fmt.Printf("Status: 304\nETag: %s\n\n", ifNoneMatch)
158 func bytes2uuid(b []byte) string {
161 raw[6] = (raw[6] & 0x0F) | uint8(4<<4) // version 4
162 return fmt.Sprintf("%x-%x-%x-%x-%x", raw[0:4], raw[4:6], raw[6:8], raw[8:10], raw[10:])
165 type CommitIterNext interface {
166 Next() (*object.Commit, error)
170 cfgPath := os.Getenv("SGBLOG_CFG")
172 log.Fatalln("SGBLOG_CFG is not set")
174 cfg, err := readCfg(cfgPath)
178 initLocalizer(cfg.Lang)
180 pathInfo := os.Getenv("PATH_INFO")
181 if len(pathInfo) == 0 {
184 queryValues, err := url.ParseQuery(os.Getenv("QUERY_STRING"))
186 makeErr(err, http.StatusBadRequest)
189 etagHash, err := blake2b.New256(nil)
193 for _, s := range []string{
204 if _, err = etagHash.Write([]byte(s)); err != nil {
208 etagHashForWeb := []string{
212 cfg.CommentsNotesRef,
215 etagHashForWeb = append(etagHashForWeb, cfg.GitURLs...)
217 headHash, err := initRepo(cfg)
219 makeErr(err, http.StatusInternalServerError)
222 if notes, err := repo.Notes(); err == nil {
223 var notesRef *plumbing.Reference
224 var commentsRef *plumbing.Reference
225 notes.ForEach(func(ref *plumbing.Reference) error {
226 switch string(ref.Name()) {
227 case "refs/notes/commits":
229 case cfg.CommentsNotesRef:
235 if commentsCommit, err := repo.CommitObject(notesRef.Hash()); err == nil {
236 notesTree, _ = commentsCommit.Tree()
239 if commentsRef != nil {
240 if commentsCommit, err := repo.CommitObject(commentsRef.Hash()); err == nil {
241 commentsTree, _ = commentsCommit.Tree()
246 var outBuf bytes.Buffer
249 var gzipWriter *gzip.Writer
250 acceptEncoding := os.Getenv("HTTP_ACCEPT_ENCODING")
251 for _, encoding := range strings.Split(acceptEncoding, ", ") {
252 if encoding == "gzip" {
253 gzipWriter = gzip.NewWriter(&outBuf)
260 if offsetRaw, exists := queryValues["offset"]; exists {
261 offset, err = strconv.Atoi(offsetRaw[0])
263 makeErr(err, http.StatusBadRequest)
266 repoLog, err := repo.Log(&git.LogOptions{From: *headHash})
268 makeErr(err, http.StatusInternalServerError)
270 topicsCache, err := getTopicsCache(cfg, repoLog)
272 makeErr(err, http.StatusInternalServerError)
274 repoLog, err = repo.Log(&git.LogOptions{From: *headHash})
276 makeErr(err, http.StatusInternalServerError)
280 var commits CommitIterNext
282 if t, exists := queryValues["topic"]; exists {
284 hashes := topicsCache[topic]
286 makeErr(errors.New("no posts with that topic"), http.StatusBadRequest)
288 if len(hashes) > offset {
289 hashes = hashes[offset:]
292 commits = &HashesIter{hashes}
294 for i := 0; i < offset; i++ {
295 if _, err = repoLog.Next(); err != nil {
303 entries := make([]TableEntry, 0, PageEntries)
305 for _, data := range etagHashForWeb {
306 etagHash.Write([]byte(data))
308 etagHash.Write([]byte("INDEX"))
309 etagHash.Write([]byte(topic))
310 for i := 0; i < PageEntries; i++ {
311 commit, err := commits.Next()
316 etagHash.Write(commit.Hash[:])
317 commentsRaw := sgblog.GetNote(repo, commentsTree, commit.Hash)
318 etagHash.Write(commentsRaw)
319 topicsRaw := sgblog.GetNote(repo, topicsTree, commit.Hash)
320 etagHash.Write(topicsRaw)
321 entries = append(entries, TableEntry{
323 CommentsRaw: commentsRaw,
324 TopicsRaw: topicsRaw,
329 for i, entry := range entries {
332 lines := msgSplit(entry.Commit.Message)
333 entry.Title = lines[0]
334 entry.LinesNum = len(lines) - 2
335 for _, line := range lines[2:] {
340 entry.DomainURLs = append(entry.DomainURLs, makeA(line, u.Host))
342 entry.CommentsNum = len(sgblog.ParseComments(entry.CommentsRaw))
343 entry.Topics = sgblog.ParseTopics(entry.TopicsRaw)
346 offsetPrev := offset - PageEntries
350 os.Stdout.Write([]byte(startHeader(etagHash, gzipWriter != nil)))
351 err = TmplHTMLIndex.Execute(out, struct {
360 AtomCommentsFeed string
368 Version: sgblog.Version,
371 TopicsEnabled: topicsTree != nil,
372 Topics: topicsCache.Topics(),
373 CommentsEnabled: commentsTree != nil,
374 AtomPostsFeed: AtomPostsFeed,
375 AtomCommentsFeed: AtomCommentsFeed,
377 OffsetPrev: offsetPrev,
378 OffsetNext: offset + PageEntries,
383 makeErr(err, http.StatusInternalServerError)
385 } else if pathInfo == "/twtxt.txt" {
386 commit, err := repo.CommitObject(*headHash)
388 makeErr(err, http.StatusInternalServerError)
390 etagHash.Write([]byte("TWTXT POSTS"))
391 etagHash.Write(commit.Hash[:])
393 repoLog, err := repo.Log(&git.LogOptions{From: *headHash})
395 makeErr(err, http.StatusInternalServerError)
397 for i := 0; i < PageEntries; i++ {
398 commit, err = repoLog.Next()
404 commit.Author.When.Format(time.RFC3339),
405 msgSplit(commit.Message)[0],
408 os.Stdout.WriteString("Content-Type: text/plain; charset=utf-8\n")
409 os.Stdout.WriteString("ETag: " + etagString(etagHash) + "\n")
410 if gzipWriter != nil {
411 os.Stdout.WriteString("Content-Encoding: gzip\n")
414 os.Stdout.WriteString("\n")
415 os.Stdout.Write(outBuf.Bytes())
417 } else if pathInfo == "/"+AtomPostsFeed {
418 commit, err := repo.CommitObject(*headHash)
420 makeErr(err, http.StatusInternalServerError)
424 if t, exists := queryValues["topic"]; exists {
428 etagHash.Write([]byte("ATOM POSTS"))
429 etagHash.Write([]byte(topic))
430 etagHash.Write(commit.Hash[:])
436 title = fmt.Sprintf("%s (topic: %s)", cfg.Title, topic)
438 idHasher, err := blake2b.New256(nil)
442 idHasher.Write([]byte("ATOM POSTS"))
443 idHasher.Write([]byte(cfg.AtomId))
444 idHasher.Write([]byte(topic))
447 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
448 Updated: atom.Time(commit.Author.When),
451 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + AtomPostsFeed,
453 Author: &atom.Person{Name: cfg.AtomAuthor},
456 repoLog, err := repo.Log(&git.LogOptions{From: *headHash})
458 makeErr(err, http.StatusInternalServerError)
460 var commits CommitIterNext
464 topicsCache, err := getTopicsCache(cfg, repoLog)
466 makeErr(err, http.StatusInternalServerError)
468 hashes := topicsCache[topic]
470 makeErr(errors.New("no posts with that topic"), http.StatusBadRequest)
472 commits = &HashesIter{hashes}
475 for i := 0; i < PageEntries; i++ {
476 commit, err = commits.Next()
480 lines := msgSplit(commit.Message)
481 var categories []atom.Category
482 for _, topic := range sgblog.ParseTopics(sgblog.GetNote(
483 repo, topicsTree, commit.Hash,
485 categories = append(categories, atom.Category{Term: topic})
487 htmlized := make([]string, 0, len(lines))
488 htmlized = append(htmlized, "<pre>")
489 for _, l := range lines[2:] {
490 htmlized = append(htmlized, lineURLize(cfg.AtomBaseURL+cfg.URLPrefix, l))
492 htmlized = append(htmlized, "</pre>")
493 feed.Entry = append(feed.Entry, &atom.Entry{
495 ID: "urn:uuid:" + bytes2uuid(commit.Hash[:]),
498 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + commit.Hash.String(),
500 Published: atom.Time(commit.Author.When),
501 Updated: atom.Time(commit.Author.When),
502 Summary: &atom.Text{Type: "text", Body: lines[0]},
505 Body: strings.Join(htmlized, "\n"),
507 Category: categories,
510 data, err := xml.MarshalIndent(&feed, "", " ")
512 makeErr(err, http.StatusInternalServerError)
514 out.Write([]byte(xml.Header))
517 } else if pathInfo == "/"+AtomCommentsFeed {
518 commit, err := repo.CommitObject(commentsRef.Hash())
520 makeErr(err, http.StatusInternalServerError)
522 etagHash.Write([]byte("ATOM COMMENTS"))
523 etagHash.Write(commit.Hash[:])
525 idHasher, err := blake2b.New256(nil)
529 idHasher.Write([]byte("ATOM COMMENTS"))
530 idHasher.Write([]byte(cfg.AtomId))
532 Title: cfg.Title + " comments",
533 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
534 Updated: atom.Time(commit.Author.When),
537 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + AtomCommentsFeed,
539 Author: &atom.Person{Name: cfg.AtomAuthor},
541 repoLog, err := repo.Log(&git.LogOptions{From: commentsRef.Hash()})
543 makeErr(err, http.StatusInternalServerError)
545 for i := 0; i < PageEntries; i++ {
546 commit, err = repoLog.Next()
550 fileStats, err := commit.Stats()
552 makeErr(err, http.StatusInternalServerError)
554 t, err := commit.Tree()
556 makeErr(err, http.StatusInternalServerError)
558 commentedHash := plumbing.NewHash(strings.ReplaceAll(
559 fileStats[0].Name, "/", "",
561 commit, err = repo.CommitObject(commentedHash)
565 comments := sgblog.ParseComments(sgblog.GetNote(repo, t, commentedHash))
566 if len(comments) == 0 {
569 commentN := strconv.Itoa(len(comments) - 1)
570 lines := strings.Split(comments[len(comments)-1], "\n")
571 from := strings.TrimPrefix(lines[0], "From: ")
572 date := strings.TrimPrefix(lines[1], "Date: ")
573 htmlized := make([]string, 0, len(lines))
574 htmlized = append(htmlized, "<pre>")
575 for _, l := range lines[2:] {
576 htmlized = append(htmlized, lineURLize(cfg.AtomBaseURL+cfg.URLPrefix, l))
578 htmlized = append(htmlized, "</pre>")
580 idHasher.Write([]byte("COMMENT"))
581 idHasher.Write(commit.Hash[:])
582 idHasher.Write([]byte(commentN))
583 feed.Entry = append(feed.Entry, &atom.Entry{
585 "Comment %s for \"%s\" by %s",
586 commentN, msgSplit(commit.Message)[0], from,
588 Author: &atom.Person{Name: from},
589 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
592 Href: strings.Join([]string{
593 cfg.AtomBaseURL, cfg.URLPrefix, "/",
594 commit.Hash.String(), "#comment", commentN,
597 Published: atom.TimeStr(strings.Replace(date, " ", "T", -1)),
598 Updated: atom.TimeStr(strings.Replace(date, " ", "T", -1)),
601 Body: strings.Join(htmlized, "\n"),
605 data, err := xml.MarshalIndent(&feed, "", " ")
607 makeErr(err, http.StatusInternalServerError)
609 out.Write([]byte(xml.Header))
612 } else if sha1DigestRe.MatchString(pathInfo[1:]) {
613 commit, err := repo.CommitObject(plumbing.NewHash(pathInfo[1 : 1+sha1.Size*2]))
615 makeErr(err, http.StatusBadRequest)
617 for _, data := range etagHashForWeb {
618 etagHash.Write([]byte(data))
620 etagHash.Write([]byte("ENTRY"))
621 etagHash.Write(commit.Hash[:])
622 atomCommentsURL := strings.Join([]string{
623 cfg.AtomBaseURL, cfg.URLPrefix, "/",
624 commit.Hash.String(), "/", AtomCommentsFeed,
626 commentsRaw := sgblog.GetNote(repo, commentsTree, commit.Hash)
627 etagHash.Write(commentsRaw)
628 topicsRaw := sgblog.GetNote(repo, topicsTree, commit.Hash)
629 etagHash.Write(topicsRaw)
630 if strings.HasSuffix(pathInfo, AtomCommentsFeed) {
631 etagHash.Write([]byte("ATOM COMMENTS"))
633 type Comment struct {
639 commentsRaw := sgblog.ParseComments(commentsRaw)
641 if len(commentsRaw) > PageEntries {
642 toSkip = len(commentsRaw) - PageEntries
644 comments := make([]Comment, 0, len(commentsRaw)-toSkip)
645 for i := len(commentsRaw) - 1; i >= toSkip; i-- {
646 lines := strings.Split(commentsRaw[i], "\n")
647 from := strings.TrimPrefix(lines[0], "From: ")
648 date := strings.TrimPrefix(lines[1], "Date: ")
649 comments = append(comments, Comment{
652 date: strings.Replace(date, " ", "T", 1),
656 idHasher, err := blake2b.New256(nil)
660 idHasher.Write([]byte("ATOM COMMENTS"))
661 idHasher.Write(commit.Hash[:])
663 Title: fmt.Sprintf("\"%s\" comments", msgSplit(commit.Message)[0]),
664 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
665 Link: []atom.Link{{Rel: "self", Href: atomCommentsURL}},
666 Author: &atom.Person{Name: cfg.AtomAuthor},
668 if len(comments) > 0 {
669 feed.Updated = atom.TimeStr(comments[0].date)
671 feed.Updated = atom.Time(commit.Author.When)
673 for _, comment := range comments {
675 idHasher.Write([]byte("COMMENT"))
676 idHasher.Write(commit.Hash[:])
677 idHasher.Write([]byte(comment.n))
678 htmlized := make([]string, 0, len(comment.body))
679 htmlized = append(htmlized, "<pre>")
680 for _, l := range comment.body {
683 lineURLize(cfg.AtomBaseURL+cfg.URLPrefix, l),
686 htmlized = append(htmlized, "</pre>")
687 feed.Entry = append(feed.Entry, &atom.Entry{
688 Title: fmt.Sprintf("Comment %s by %s", comment.n, comment.from),
689 Author: &atom.Person{Name: comment.from},
690 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
693 Href: strings.Join([]string{
696 commit.Hash.String(),
697 "#comment", comment.n,
700 Published: atom.TimeStr(
701 strings.Replace(comment.date, " ", "T", -1),
703 Updated: atom.TimeStr(
704 strings.Replace(comment.date, " ", "T", -1),
708 Body: strings.Join(htmlized, "\n"),
712 data, err := xml.MarshalIndent(&feed, "", " ")
714 makeErr(err, http.StatusInternalServerError)
716 out.Write([]byte(xml.Header))
720 notesRaw := sgblog.GetNote(repo, notesTree, commit.Hash)
721 etagHash.Write(notesRaw)
724 lines := msgSplit(commit.Message)
726 when := commit.Author.When.Format(sgblog.WhenFmt)
728 if len(commit.ParentHashes) > 0 {
729 parent = commit.ParentHashes[0].String()
731 commentsParsed := sgblog.ParseComments(commentsRaw)
732 comments := make([]CommentEntry, 0, len(commentsParsed))
733 for _, comment := range commentsParsed {
734 lines := strings.Split(comment, "\n")
735 comments = append(comments, CommentEntry{lines[:3], lines[3:]})
737 var notesLines []string
738 if len(notesRaw) > 0 {
739 notesLines = strings.Split(string(notesRaw), "\n")
742 os.Stdout.Write([]byte(startHeader(etagHash, gzipWriter != nil)))
743 err = TmplHTMLEntry.Execute(out, struct {
750 AtomCommentsURL string
752 Commit *object.Commit
755 Comments []CommentEntry
759 Version: sgblog.Version,
762 TitleEscaped: url.PathEscape(fmt.Sprintf("Re: %s (%s)", title, commit.Hash)),
764 AtomCommentsURL: atomCommentsURL,
768 NoteLines: notesLines,
770 Topics: sgblog.ParseTopics(topicsRaw),
773 makeErr(err, http.StatusInternalServerError)
776 makeErr(errors.New("unknown URL action"), http.StatusNotFound)
778 out.Write([]byte("</body></html>\n"))
779 if gzipWriter != nil {
782 os.Stdout.Write(outBuf.Bytes())
786 os.Stdout.WriteString("Content-Type: application/atom+xml; charset=utf-8\n")
787 os.Stdout.WriteString("ETag: " + etagString(etagHash) + "\n")
788 if gzipWriter != nil {
789 os.Stdout.WriteString("Content-Encoding: gzip\n")
792 os.Stdout.WriteString("\n")
793 os.Stdout.Write(outBuf.Bytes())