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