internal/control/milestone.go
254 lines · 8399 bytes
1package control
2
3import (
4 "errors"
5 "fmt"
6 "io"
7 "path"
8 "regexp"
9 "strings"
10
11 "gitbay.org/gitbay/internal/gitutil"
12 "gitbay.org/gitbay/internal/policy"
13 "gitbay.org/gitbay/internal/protocol"
14 "gitbay.org/gitbay/internal/store"
15)
16
17func init() {
18 register(Command{Path: []string{"milestone", "create"},
19 Summary: "create a milestone",
20 Usage: "milestone create <owner/name> <title> [--description <d>] [--due YYYY-MM-DD]", Run: runMilestoneCreate})
21 register(Command{Path: []string{"milestone", "list"},
22 Summary: "list milestones with progress",
23 Usage: "milestone list <owner/name> [--state open|closed|all]", ReadOnly: true, Run: runMilestoneList})
24 register(Command{Path: []string{"milestone", "close"},
25 Summary: "close a milestone",
26 Usage: "milestone close <owner/name> <title>", Run: runMilestoneClose})
27 register(Command{Path: []string{"milestone", "reopen"},
28 Summary: "reopen a milestone",
29 Usage: "milestone reopen <owner/name> <title>", Run: runMilestoneReopen})
30 register(Command{Path: []string{"issue", "milestone"},
31 Summary: "set or clear an issue's milestone",
32 Usage: "issue milestone <owner/name> <n> <title|none>", Run: runIssueMilestone})
33 register(Command{Path: []string{"mr", "milestone"},
34 Summary: "set or clear an MR's milestone",
35 Usage: "mr milestone <owner/name> <n> <title|none>", Run: runMRMilestone})
36 register(Command{Path: []string{"issue", "templates"},
37 Summary: "list issue templates (.gitbay/issue-template*.md)",
38 Usage: "issue templates <owner/name>", ReadOnly: true, Run: runIssueTemplates})
39}
40
41var duePat = regexp.MustCompile(`^\d{4}-\d{2}-\d{2}$`)
42
43func runMilestoneCreate(c *Ctx, args []string) int {
44 f, err := parseFlags(args, flagSpec{Values: []string{"--description", "--due"}, MaxPos: 2,
45 Usage: "milestone create <owner/name> <title> [--description <d>] [--due YYYY-MM-DD]"})
46 if err != nil {
47 return c.fail(protocol.ExitUsage, "%v", err)
48 }
49 path, title, description, due := f.pos(0), f.pos(1), f.Value("--description"), f.Value("--due")
50 if path == "" || title == "" {
51 return c.fail(protocol.ExitUsage, "usage: milestone create <owner/name> <title> [--description <d>] [--due YYYY-MM-DD]")
52 }
53 if due != "" && !duePat.MatchString(due) {
54 return c.fail(protocol.ExitUsage, "--due must be YYYY-MM-DD")
55 }
56 repo, code := resolveRepo(c, path, policy.CanWrite)
57 if code >= 0 {
58 return code
59 }
60 if code := refuseArchived(c, repo); code >= 0 {
61 return code
62 }
63 if _, err := c.Store.CreateMilestone(repo.ID, title, description, due); err != nil {
64 return c.failErr(err)
65 }
66 return c.emit(map[string]string{"milestone": title}, func(w io.Writer) {
67 fmt.Fprintf(w, "created milestone %q on %s\n", title, repo.Path())
68 })
69}
70
71func runMilestoneList(c *Ctx, args []string) int {
72 f, err := parseFlags(args, flagSpec{Values: []string{"--state"}, MaxPos: 1, Usage: "milestone list <owner/name> [--state open|closed|all]"})
73 if err != nil {
74 return c.fail(protocol.ExitUsage, "%v", err)
75 }
76 state, path := "open", f.pos(0)
77 if f.Has("--state") {
78 state = f.Value("--state")
79 }
80 if path == "" || (state != "open" && state != "closed" && state != "all") {
81 return c.fail(protocol.ExitUsage, "usage: milestone list <owner/name> [--state open|closed|all]")
82 }
83 repo, code := resolveRepo(c, path, policy.CanRead)
84 if code >= 0 {
85 return code
86 }
87 ms, err := c.Store.ListMilestones(repo.ID, state)
88 if err != nil {
89 return c.fail(protocol.ExitFailure, "%v", err)
90 }
91 type out struct {
92 Title string `json:"title"`
93 Description string `json:"description,omitempty"`
94 Due string `json:"due,omitempty"`
95 State string `json:"state"`
96 Open int `json:"open"`
97 Closed int `json:"closed"`
98 }
99 var ds []out
100 for _, m := range ms {
101 ds = append(ds, out{m.Title, m.Description, m.DueDate, m.State, m.OpenItems, m.ClosedItems})
102 }
103 return c.emit(ds, func(w io.Writer) {
104 for _, d := range ds {
105 due := d.Due
106 if due == "" {
107 due = "-"
108 }
109 fmt.Fprintf(w, "%s\t%s\tdue %s\t%d open, %d closed\n", d.Title, d.State, due, d.Open, d.Closed)
110 }
111 })
112}
113
114func runMilestoneClose(c *Ctx, args []string) int { return setMilestoneState(c, args, "closed") }
115func runMilestoneReopen(c *Ctx, args []string) int { return setMilestoneState(c, args, "open") }
116
117func setMilestoneState(c *Ctx, args []string, state string) int {
118 verb := "close"
119 if state == "open" {
120 verb = "reopen"
121 }
122 if len(args) != 2 {
123 return c.fail(protocol.ExitUsage, "usage: milestone %s <owner/name> <title>", verb)
124 }
125 repo, code := resolveRepo(c, args[0], policy.CanWrite)
126 if code >= 0 {
127 return code
128 }
129 if code := refuseArchived(c, repo); code >= 0 {
130 return code
131 }
132 m, err := c.Store.MilestoneByTitle(repo.ID, args[1])
133 if err != nil {
134 return milestoneErr(c, repo, args[1], err)
135 }
136 if err := c.Store.SetMilestoneState(m.ID, state); err != nil {
137 return c.fail(protocol.ExitFailure, "%v", err)
138 }
139 return c.emit(map[string]string{"milestone": m.Title, "state": state}, func(w io.Writer) {
140 fmt.Fprintf(w, "%sd milestone %q on %s\n", verb, m.Title, repo.Path())
141 })
142}
143
144func milestoneErr(c *Ctx, repo store.Repo, title string, err error) int {
145 if errors.Is(err, store.ErrNotFound) {
146 return c.fail(protocol.ExitNotFound, "no milestone %q in %s", title, repo.Path())
147 }
148 return c.fail(protocol.ExitFailure, "%v", err)
149}
150
151func runIssueMilestone(c *Ctx, args []string) int {
152 repo, issue, code := issueRef(c, args, policy.CanWrite)
153 if code >= 0 {
154 return code
155 }
156 if code := refuseArchived(c, repo); code >= 0 {
157 return code
158 }
159 if len(args) != 3 {
160 return c.fail(protocol.ExitUsage, "usage: issue milestone <owner/name> <n> <title|none>")
161 }
162 return setItemMilestone(c, repo, "issue", issue.Number, args[2], func(id int64) error {
163 return c.Store.SetIssueMilestone(issue.ID, id)
164 })
165}
166
167func runMRMilestone(c *Ctx, args []string) int {
168 repo, mr, code := mrRef(c, args, policy.CanWrite)
169 if code >= 0 {
170 return code
171 }
172 if code := refuseArchived(c, repo); code >= 0 {
173 return code
174 }
175 if len(args) != 3 {
176 return c.fail(protocol.ExitUsage, "usage: mr milestone <owner/name> <n> <title|none>")
177 }
178 return setItemMilestone(c, repo, "mr", mr.Number, args[2], func(id int64) error {
179 return c.Store.SetMRMilestone(mr.ID, id)
180 })
181}
182
183// noun and number name what the milestone was set on, for the event.
184func setItemMilestone(c *Ctx, repo store.Repo, noun string, number int64, title string, set func(int64) error) int {
185 var id int64
186 if title != "none" {
187 m, err := c.Store.MilestoneByTitle(repo.ID, title)
188 if err != nil {
189 return milestoneErr(c, repo, title, err)
190 }
191 id = m.ID
192 }
193 if err := set(id); err != nil {
194 return c.fail(protocol.ExitFailure, "%v", err)
195 }
196 cleared := title
197 if cleared == "none" {
198 cleared = ""
199 }
200 c.Store.RecordEvent(repo.ID, c.User.ID, noun+".milestoned",
201 fmt.Sprintf(`{"number":%d,"milestone":%q}`, number, cleared))
202 if title == "none" {
203 return c.emit(map[string]string{"milestone": ""}, func(w io.Writer) {
204 fmt.Fprintln(w, "milestone cleared")
205 })
206 }
207 return c.emit(map[string]string{"milestone": title}, func(w io.Writer) {
208 fmt.Fprintf(w, "milestone set to %q\n", title)
209 })
210}
211
212// runIssueTemplates lists .gitbay/issue-template*.md at the default branch.
213func runIssueTemplates(c *Ctx, args []string) int {
214 if len(args) != 1 {
215 return c.fail(protocol.ExitUsage, "usage: issue templates <owner/name>")
216 }
217 repo, code := resolveRepo(c, args[0], policy.CanRead)
218 if code >= 0 {
219 return code
220 }
221 dir := RepoDir(c.Cfg.Server.Root, repo.OwnerName, repo.Name)
222 ts := IssueTemplates(dir, repo.DefaultBranch)
223 return c.emit(ts, func(w io.Writer) {
224 for _, t := range ts {
225 fmt.Fprintln(w, t.Name)
226 }
227 })
228}
229
230type IssueTemplate struct {
231 Name string `json:"name"`
232 Body string `json:"body"`
233}
234
235// IssueTemplates reads .gitbay/issue-template*.md from ref. Missing
236// directory or unreadable files yield an empty list, never an error.
237func IssueTemplates(dir, ref string) []IssueTemplate {
238 entries, err := gitutil.ListTree(dir, ref, ".gitbay")
239 if err != nil {
240 return nil
241 }
242 var out []IssueTemplate
243 for _, e := range entries {
244 if e.Type != "blob" || !strings.HasPrefix(e.Name, "issue-template") || !strings.HasSuffix(e.Name, ".md") {
245 continue
246 }
247 raw, err := gitutil.ReadBlob(dir, ref, path.Join(".gitbay", e.Name), maxBodyBytes)
248 if err != nil {
249 continue
250 }
251 out = append(out, IssueTemplate{Name: e.Name, Body: string(raw)})
252 }
253 return out
254}