2 SGBlog -- Git-backed CGI/UCSPI blogging/phlogging/gemlogging engine
3 Copyright (C) 2020-2022 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 for _, gitURL := range cfg.GitURLs {
216 etagHashForWeb = append(etagHashForWeb, gitURL)
219 headHash, err := initRepo(cfg)
221 makeErr(err, http.StatusInternalServerError)
224 if notes, err := repo.Notes(); err == nil {
225 var notesRef *plumbing.Reference
226 var commentsRef *plumbing.Reference
227 notes.ForEach(func(ref *plumbing.Reference) error {
228 switch string(ref.Name()) {
229 case "refs/notes/commits":
231 case cfg.CommentsNotesRef:
237 if commentsCommit, err := repo.CommitObject(notesRef.Hash()); err == nil {
238 notesTree, _ = commentsCommit.Tree()
241 if commentsRef != nil {
242 if commentsCommit, err := repo.CommitObject(commentsRef.Hash()); err == nil {
243 commentsTree, _ = commentsCommit.Tree()
248 var outBuf bytes.Buffer
251 var gzipWriter *gzip.Writer
252 acceptEncoding := os.Getenv("HTTP_ACCEPT_ENCODING")
253 for _, encoding := range strings.Split(acceptEncoding, ", ") {
254 if encoding == "gzip" {
255 gzipWriter = gzip.NewWriter(&outBuf)
262 if offsetRaw, exists := queryValues["offset"]; exists {
263 offset, err = strconv.Atoi(offsetRaw[0])
265 makeErr(err, http.StatusBadRequest)
268 repoLog, err := repo.Log(&git.LogOptions{From: *headHash})
270 makeErr(err, http.StatusInternalServerError)
272 topicsCache, err := getTopicsCache(cfg, repoLog)
274 makeErr(err, http.StatusInternalServerError)
276 repoLog, err = repo.Log(&git.LogOptions{From: *headHash})
278 makeErr(err, http.StatusInternalServerError)
282 var commits CommitIterNext
284 if t, exists := queryValues["topic"]; exists {
286 hashes := topicsCache[topic]
288 makeErr(errors.New("no posts with that topic"), http.StatusBadRequest)
290 if len(hashes) > offset {
291 hashes = hashes[offset:]
294 commits = &HashesIter{hashes}
296 for i := 0; i < offset; i++ {
297 if _, err = repoLog.Next(); err != nil {
305 entries := make([]TableEntry, 0, PageEntries)
307 for _, data := range etagHashForWeb {
308 etagHash.Write([]byte(data))
310 etagHash.Write([]byte("INDEX"))
311 etagHash.Write([]byte(topic))
312 for i := 0; i < PageEntries; i++ {
313 commit, err := commits.Next()
318 etagHash.Write(commit.Hash[:])
319 commentsRaw := sgblog.GetNote(repo, commentsTree, commit.Hash)
320 etagHash.Write(commentsRaw)
321 topicsRaw := sgblog.GetNote(repo, topicsTree, commit.Hash)
322 etagHash.Write(topicsRaw)
323 entries = append(entries, TableEntry{
325 CommentsRaw: commentsRaw,
326 TopicsRaw: topicsRaw,
331 for i, entry := range entries {
334 lines := msgSplit(entry.Commit.Message)
335 entry.Title = lines[0]
336 entry.LinesNum = len(lines) - 2
337 for _, line := range lines[2:] {
342 entry.DomainURLs = append(entry.DomainURLs, makeA(line, u.Host))
344 entry.CommentsNum = len(sgblog.ParseComments(entry.CommentsRaw))
345 entry.Topics = sgblog.ParseTopics(entry.TopicsRaw)
348 offsetPrev := offset - PageEntries
352 os.Stdout.Write([]byte(startHeader(etagHash, gzipWriter != nil)))
353 err = TmplHTMLIndex.Execute(out, struct {
362 AtomCommentsFeed string
370 Version: sgblog.Version,
373 TopicsEnabled: topicsTree != nil,
374 Topics: topicsCache.Topics(),
375 CommentsEnabled: commentsTree != nil,
376 AtomPostsFeed: AtomPostsFeed,
377 AtomCommentsFeed: AtomCommentsFeed,
379 OffsetPrev: offsetPrev,
380 OffsetNext: offset + PageEntries,
385 makeErr(err, http.StatusInternalServerError)
387 } else if pathInfo == "/twtxt.txt" {
388 commit, err := repo.CommitObject(*headHash)
390 makeErr(err, http.StatusInternalServerError)
392 etagHash.Write([]byte("TWTXT POSTS"))
393 etagHash.Write(commit.Hash[:])
395 repoLog, err := repo.Log(&git.LogOptions{From: *headHash})
397 makeErr(err, http.StatusInternalServerError)
399 for i := 0; i < PageEntries; i++ {
400 commit, err = repoLog.Next()
406 commit.Author.When.Format(time.RFC3339),
407 msgSplit(commit.Message)[0],
410 os.Stdout.WriteString("Content-Type: text/plain; charset=utf-8\n")
411 os.Stdout.WriteString("ETag: " + etagString(etagHash) + "\n")
412 if gzipWriter != nil {
413 os.Stdout.WriteString("Content-Encoding: gzip\n")
416 os.Stdout.WriteString("\n")
417 os.Stdout.Write(outBuf.Bytes())
419 } else if pathInfo == "/"+AtomPostsFeed {
420 commit, err := repo.CommitObject(*headHash)
422 makeErr(err, http.StatusInternalServerError)
426 if t, exists := queryValues["topic"]; exists {
430 etagHash.Write([]byte("ATOM POSTS"))
431 etagHash.Write([]byte(topic))
432 etagHash.Write(commit.Hash[:])
438 title = fmt.Sprintf("%s (topic: %s)", cfg.Title, topic)
440 idHasher, err := blake2b.New256(nil)
444 idHasher.Write([]byte("ATOM POSTS"))
445 idHasher.Write([]byte(cfg.AtomId))
446 idHasher.Write([]byte(topic))
449 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
450 Updated: atom.Time(commit.Author.When),
453 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + AtomPostsFeed,
455 Author: &atom.Person{Name: cfg.AtomAuthor},
458 repoLog, err := repo.Log(&git.LogOptions{From: *headHash})
460 makeErr(err, http.StatusInternalServerError)
462 var commits CommitIterNext
466 topicsCache, err := getTopicsCache(cfg, repoLog)
468 makeErr(err, http.StatusInternalServerError)
470 hashes := topicsCache[topic]
472 makeErr(errors.New("no posts with that topic"), http.StatusBadRequest)
474 commits = &HashesIter{hashes}
477 for i := 0; i < PageEntries; i++ {
478 commit, err = commits.Next()
482 lines := msgSplit(commit.Message)
483 var categories []atom.Category
484 for _, topic := range sgblog.ParseTopics(sgblog.GetNote(
485 repo, topicsTree, commit.Hash,
487 categories = append(categories, atom.Category{Term: topic})
489 htmlized := make([]string, 0, len(lines))
490 htmlized = append(htmlized, "<pre>")
491 for _, l := range lines[2:] {
492 htmlized = append(htmlized, lineURLize(cfg.AtomBaseURL+cfg.URLPrefix, l))
494 htmlized = append(htmlized, "</pre>")
495 feed.Entry = append(feed.Entry, &atom.Entry{
497 ID: "urn:uuid:" + bytes2uuid(commit.Hash[:]),
500 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + commit.Hash.String(),
502 Published: atom.Time(commit.Author.When),
503 Updated: atom.Time(commit.Author.When),
504 Summary: &atom.Text{Type: "text", Body: lines[0]},
507 Body: strings.Join(htmlized, "\n"),
509 Category: categories,
512 data, err := xml.MarshalIndent(&feed, "", " ")
514 makeErr(err, http.StatusInternalServerError)
516 out.Write([]byte(xml.Header))
519 } else if pathInfo == "/"+AtomCommentsFeed {
520 commit, err := repo.CommitObject(commentsRef.Hash())
522 makeErr(err, http.StatusInternalServerError)
524 etagHash.Write([]byte("ATOM COMMENTS"))
525 etagHash.Write(commit.Hash[:])
527 idHasher, err := blake2b.New256(nil)
531 idHasher.Write([]byte("ATOM COMMENTS"))
532 idHasher.Write([]byte(cfg.AtomId))
534 Title: cfg.Title + " comments",
535 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
536 Updated: atom.Time(commit.Author.When),
539 Href: cfg.AtomBaseURL + cfg.URLPrefix + "/" + AtomCommentsFeed,
541 Author: &atom.Person{Name: cfg.AtomAuthor},
543 repoLog, err := repo.Log(&git.LogOptions{From: commentsRef.Hash()})
545 makeErr(err, http.StatusInternalServerError)
547 for i := 0; i < PageEntries; i++ {
548 commit, err = repoLog.Next()
552 fileStats, err := commit.Stats()
554 makeErr(err, http.StatusInternalServerError)
556 t, err := commit.Tree()
558 makeErr(err, http.StatusInternalServerError)
560 commentedHash := plumbing.NewHash(strings.ReplaceAll(
561 fileStats[0].Name, "/", "",
563 commit, err = repo.CommitObject(commentedHash)
567 comments := sgblog.ParseComments(sgblog.GetNote(repo, t, commentedHash))
568 if len(comments) == 0 {
571 commentN := strconv.Itoa(len(comments) - 1)
572 lines := strings.Split(comments[len(comments)-1], "\n")
573 from := strings.TrimPrefix(lines[0], "From: ")
574 date := strings.TrimPrefix(lines[1], "Date: ")
575 htmlized := make([]string, 0, len(lines))
576 htmlized = append(htmlized, "<pre>")
577 for _, l := range lines[2:] {
578 htmlized = append(htmlized, lineURLize(cfg.AtomBaseURL+cfg.URLPrefix, l))
580 htmlized = append(htmlized, "</pre>")
582 idHasher.Write([]byte("COMMENT"))
583 idHasher.Write(commit.Hash[:])
584 idHasher.Write([]byte(commentN))
585 feed.Entry = append(feed.Entry, &atom.Entry{
587 "Comment %s for \"%s\" by %s",
588 commentN, msgSplit(commit.Message)[0], from,
590 Author: &atom.Person{Name: from},
591 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
594 Href: strings.Join([]string{
595 cfg.AtomBaseURL, cfg.URLPrefix, "/",
596 commit.Hash.String(), "#comment", commentN,
599 Published: atom.TimeStr(strings.Replace(date, " ", "T", -1)),
600 Updated: atom.TimeStr(strings.Replace(date, " ", "T", -1)),
603 Body: strings.Join(htmlized, "\n"),
607 data, err := xml.MarshalIndent(&feed, "", " ")
609 makeErr(err, http.StatusInternalServerError)
611 out.Write([]byte(xml.Header))
614 } else if sha1DigestRe.MatchString(pathInfo[1:]) {
615 commit, err := repo.CommitObject(plumbing.NewHash(pathInfo[1 : 1+sha1.Size*2]))
617 makeErr(err, http.StatusBadRequest)
619 for _, data := range etagHashForWeb {
620 etagHash.Write([]byte(data))
622 etagHash.Write([]byte("ENTRY"))
623 etagHash.Write(commit.Hash[:])
624 atomCommentsURL := strings.Join([]string{
625 cfg.AtomBaseURL, cfg.URLPrefix, "/",
626 commit.Hash.String(), "/", AtomCommentsFeed,
628 commentsRaw := sgblog.GetNote(repo, commentsTree, commit.Hash)
629 etagHash.Write(commentsRaw)
630 topicsRaw := sgblog.GetNote(repo, topicsTree, commit.Hash)
631 etagHash.Write(topicsRaw)
632 if strings.HasSuffix(pathInfo, AtomCommentsFeed) {
633 etagHash.Write([]byte("ATOM COMMENTS"))
635 type Comment struct {
641 commentsRaw := sgblog.ParseComments(commentsRaw)
643 if len(commentsRaw) > PageEntries {
644 toSkip = len(commentsRaw) - PageEntries
646 comments := make([]Comment, 0, len(commentsRaw)-toSkip)
647 for i := len(commentsRaw) - 1; i >= toSkip; i-- {
648 lines := strings.Split(commentsRaw[i], "\n")
649 from := strings.TrimPrefix(lines[0], "From: ")
650 date := strings.TrimPrefix(lines[1], "Date: ")
651 comments = append(comments, Comment{
654 date: strings.Replace(date, " ", "T", 1),
658 idHasher, err := blake2b.New256(nil)
662 idHasher.Write([]byte("ATOM COMMENTS"))
663 idHasher.Write(commit.Hash[:])
665 Title: fmt.Sprintf("\"%s\" comments", msgSplit(commit.Message)[0]),
666 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
667 Link: []atom.Link{{Rel: "self", Href: atomCommentsURL}},
668 Author: &atom.Person{Name: cfg.AtomAuthor},
670 if len(comments) > 0 {
671 feed.Updated = atom.TimeStr(comments[0].date)
673 feed.Updated = atom.Time(commit.Author.When)
675 for _, comment := range comments {
677 idHasher.Write([]byte("COMMENT"))
678 idHasher.Write(commit.Hash[:])
679 idHasher.Write([]byte(comment.n))
680 htmlized := make([]string, 0, len(comment.body))
681 htmlized = append(htmlized, "<pre>")
682 for _, l := range comment.body {
685 lineURLize(cfg.AtomBaseURL+cfg.URLPrefix, l),
688 htmlized = append(htmlized, "</pre>")
689 feed.Entry = append(feed.Entry, &atom.Entry{
690 Title: fmt.Sprintf("Comment %s by %s", comment.n, comment.from),
691 Author: &atom.Person{Name: comment.from},
692 ID: "urn:uuid:" + bytes2uuid(idHasher.Sum(nil)),
695 Href: strings.Join([]string{
698 commit.Hash.String(),
699 "#comment", comment.n,
702 Published: atom.TimeStr(
703 strings.Replace(comment.date, " ", "T", -1),
705 Updated: atom.TimeStr(
706 strings.Replace(comment.date, " ", "T", -1),
710 Body: strings.Join(htmlized, "\n"),
714 data, err := xml.MarshalIndent(&feed, "", " ")
716 makeErr(err, http.StatusInternalServerError)
718 out.Write([]byte(xml.Header))
722 notesRaw := sgblog.GetNote(repo, notesTree, commit.Hash)
723 etagHash.Write(notesRaw)
726 lines := msgSplit(commit.Message)
728 when := commit.Author.When.Format(sgblog.WhenFmt)
730 if len(commit.ParentHashes) > 0 {
731 parent = commit.ParentHashes[0].String()
733 commentsParsed := sgblog.ParseComments(commentsRaw)
734 comments := make([]CommentEntry, 0, len(commentsParsed))
735 for _, comment := range commentsParsed {
736 lines := strings.Split(comment, "\n")
737 comments = append(comments, CommentEntry{lines[:3], lines[3:]})
739 var notesLines []string
740 if len(notesRaw) > 0 {
741 notesLines = strings.Split(string(notesRaw), "\n")
744 os.Stdout.Write([]byte(startHeader(etagHash, gzipWriter != nil)))
745 err = TmplHTMLEntry.Execute(out, struct {
752 AtomCommentsURL string
754 Commit *object.Commit
757 Comments []CommentEntry
761 Version: sgblog.Version,
764 TitleEscaped: url.PathEscape(fmt.Sprintf("Re: %s (%s)", title, commit.Hash)),
766 AtomCommentsURL: atomCommentsURL,
770 NoteLines: notesLines,
772 Topics: sgblog.ParseTopics(topicsRaw),
775 makeErr(err, http.StatusInternalServerError)
778 makeErr(errors.New("unknown URL action"), http.StatusNotFound)
780 out.Write([]byte("</body></html>\n"))
781 if gzipWriter != nil {
784 os.Stdout.Write(outBuf.Bytes())
788 os.Stdout.WriteString("Content-Type: application/atom+xml; charset=utf-8\n")
789 os.Stdout.WriteString("ETag: " + etagString(etagHash) + "\n")
790 if gzipWriter != nil {
791 os.Stdout.WriteString("Content-Encoding: gzip\n")
794 os.Stdout.WriteString("\n")
795 os.Stdout.Write(outBuf.Bytes())