aboutsummaryrefslogtreecommitdiff
path: root/projects/readme.go
blob: 2fda69bf169f18c4ebad742ebb80dc3a22cbb613 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
package projects

import (
	"bytes"
	"github.com/libgit2/git2go"
	"html"
	"html/template"
	"io"
	"log"
	"os"
	"os/exec"
	"path"
	"strings"
)

type ReadmeFormat string

const (
	ReadmeMarkdown ReadmeFormat = "markdown"
	ReadmePlain    ReadmeFormat = "plain"
)

func (f ReadmeFormat) Format(raw []byte) template.HTML {
	switch f {
	case ReadmeMarkdown:
		return formatMarkdown(raw)
	default:
		return template.HTML("<pre><code>" + html.EscapeString(string(raw)) + "</code></pre>")
	}
}

func formatMarkdown(raw []byte) template.HTML {
	p := exec.Command("markdown")

	buf := new(bytes.Buffer)

	p.Stdin = bytes.NewReader(raw)
	p.Stdout = buf

	if err := p.Run(); err != nil {
		log.Printf("Failed formatting markdown readme: %s", err)
		return "<strong>Failed formatting markdown :(</strong>"
	}

	return template.HTML(buf.Bytes())
}

func gitReadme(gitpath string) (raw []byte, name string, err error) {
	repo, err := git.OpenRepository(gitpath)
	if err != nil {
		return raw, name, err
	}

	master_tree_obj, err := repo.RevparseSingle("master:") // Root tree of commit at top of master
	if err != nil {
		return raw, name, err
	}

	master_tree, err := master_tree_obj.AsTree()
	if err != nil {
		return raw, name, err
	}

	var inner_err error = nil
	err = master_tree.Walk(func(_ string, entry *git.TreeEntry) int {
		if !(strings.HasPrefix(strings.ToLower(entry.Name), "readme") && entry.Type == git.ObjectBlob) {
			return 1
		}

		name = entry.Name
		blob, err := repo.LookupBlob(entry.Id)
		if err == nil {
			raw = blob.Contents()
		} else {
			inner_err = err
		}
		return -1
	})

	if err == nil && inner_err != nil {
		err = inner_err
	}

	return
}

func (p *Project) formatReadme() {
	readme_name := ""
	var readme_raw []byte
	if p.ReadmePath != "" {
		fullpath := p.ReadmePath
		if !path.IsAbs(fullpath) {
			fullpath = path.Join(p.dir, fullpath)
		}
		fullpath = path.Clean(fullpath)

		f, err := os.Open(fullpath)
		if err != nil {
			log.Printf("Could not get readme for %s: failed opening %s: %s", p.Name, fullpath, err)
			return
		}
		defer f.Close()

		buf := new(bytes.Buffer)
		if _, err := io.Copy(buf, f); err != nil {
			log.Printf("Could not get readme for %s: failed reading %s: %s", p.Name, fullpath, err)
			return
		}

		readme_raw = buf.Bytes()
		readme_name = fullpath
	} else if len(p.Git) > 0 {
		var err error
		readme_raw, readme_name, err = gitReadme(p.Git)
		if err != nil {
			log.Printf("Could not get readme for %s from git: %s", p.Name, err)
			return
		}
		if readme_name == "" {
			return
		}
	} else {
		return
	}

	format := ReadmePlain
	switch strings.ToLower(path.Ext(readme_name)) {
	case ".md", ".mkd", ".markdown":
		format = ReadmeMarkdown
	}

	p.FormattedReadme = format.Format(readme_raw)
}