internal/control/org.go
309 lines · 9350 bytes
1package control
2
3import (
4 "errors"
5 "fmt"
6 "io"
7 "os"
8 "path/filepath"
9
10 "gitbay.org/gitbay/internal/policy"
11 "gitbay.org/gitbay/internal/protocol"
12 "gitbay.org/gitbay/internal/store"
13)
14
15func init() {
16 register(Command{Path: []string{"org", "create"},
17 Summary: "create an organization (you become its first admin)",
18 Usage: "org create <name>",
19 Examples: []string{"org create krz"}, Run: runOrgCreate})
20 register(Command{Path: []string{"org", "list"},
21 Summary: "list organizations you belong to",
22 Usage: "org list",
23 Examples: []string{"org list"}, ReadOnly: true, Run: runOrgList})
24 register(Command{Path: []string{"org", "show"},
25 Summary: "show an organization and its members",
26 Usage: "org show <name>",
27 Examples: []string{"org show krz"}, ReadOnly: true, Run: runOrgShow})
28 register(Command{Path: []string{"org", "rename"},
29 Summary: "rename an organization",
30 Usage: "org rename <old> <new> (clone URLs change)",
31 Examples: []string{"org rename krz krazywarez"}, Run: runOrgRename})
32 register(Command{Path: []string{"org", "delete"},
33 Summary: "delete an empty organization",
34 Usage: "org delete <name> --yes",
35 Flags: []Flag{
36 {"--yes", "", "confirm the permanent delete", ""},
37 },
38 Examples: []string{"org delete krz --yes"}, Run: runOrgDelete})
39 register(Command{Path: []string{"org", "members", "add"},
40 NeedsRecentSignIn: true,
41 Summary: "add or update a member",
42 Usage: "org members add <org> <user> [--role member|admin]",
43 Flags: []Flag{
44 {"--role", "member|admin", "the member's role", "member"},
45 },
46 Examples: []string{"org members add krz cmc --role admin"}, Run: runOrgMembersAdd})
47 register(Command{Path: []string{"org", "members", "remove"},
48 Summary: "remove a member",
49 Usage: "org members remove <org> <user>",
50 Examples: []string{"org members remove krz cmc"}, Run: runOrgMembersRemove})
51 register(Command{Path: []string{"org", "members", "list"},
52 Summary: "list members",
53 Usage: "org members list <org>",
54 Examples: []string{"org members list krz"}, ReadOnly: true, Run: runOrgMembersList})
55}
56
57// orgAdmin loads an org and requires the caller to be one of its admins.
58func orgAdmin(c *Ctx, name string) (store.Org, int) {
59 org, err := c.Store.OrgByName(name)
60 if errors.Is(err, store.ErrNotFound) {
61 return org, c.fail(protocol.ExitNotFound, "no organization %q", name)
62 }
63 if err != nil {
64 return org, c.fail(protocol.ExitFailure, "%v", err)
65 }
66 role, err := c.Store.OrgRole(org.ID, c.User.ID)
67 if err != nil {
68 return org, c.fail(protocol.ExitFailure, "%v", err)
69 }
70 if role != "admin" {
71 return org, c.fail(protocol.ExitDenied, "only admins of %s can do that; ask one", name)
72 }
73 return org, -1
74}
75
76func runOrgCreate(c *Ctx, args []string) int {
77 if len(args) != 1 {
78 return c.usage()
79 }
80 if err := policy.ValidateOwnerName(args[0]); err != nil {
81 return c.failInput(err)
82 }
83 if _, err := c.Store.CreateOrg(args[0], c.User.ID); err != nil {
84 return c.fail(protocol.ExitFailure, "%v", err)
85 }
86 return c.emit(map[string]string{"org": args[0], "role": "admin"}, func(w io.Writer) {
87 fmt.Fprintf(w, "created organization %s; you are its admin\n", args[0])
88 })
89}
90
91func runOrgList(c *Ctx, args []string) int {
92 orgs, err := c.Store.ListOrgsForUser(c.User.ID)
93 if err != nil {
94 return c.fail(protocol.ExitFailure, "%v", err)
95 }
96 type out struct {
97 Org string `json:"org"`
98 Role string `json:"role"`
99 }
100 var ds []out
101 for _, o := range orgs {
102 ds = append(ds, out{o.Username, o.Role})
103 }
104 return c.emitView(ds, func(w io.Writer) {
105 tb := c.table(w, "ORG", "ROLE")
106 for _, d := range ds {
107 tb.row(cRef(d.Org), cState(d.Role))
108 }
109 tb.flush()
110 }, func() screen {
111 rows := make([]row, len(ds))
112 for i, d := range ds {
113 rows[i] = rowOf(cLink(d.Org, c.siteURL(d.Org)), cState(d.Role))
114 }
115 s := listScreen("Organizations", rows)
116 if len(ds) > 0 {
117 s.actions = []action{{"Read", []string{"org", "show", ds[0].Org}}}
118 }
119 return s
120 })
121}
122
123func runOrgShow(c *Ctx, args []string) int {
124 if len(args) != 1 {
125 return c.usage()
126 }
127 org, err := c.Store.OrgByName(args[0])
128 if errors.Is(err, store.ErrNotFound) {
129 return c.fail(protocol.ExitNotFound, "no organization %q", args[0])
130 }
131 if err != nil {
132 return c.fail(protocol.ExitFailure, "%v", err)
133 }
134 members, err := c.Store.OrgMembers(org.ID)
135 if err != nil {
136 return c.fail(protocol.ExitFailure, "%v", err)
137 }
138 type memberOut struct {
139 User string `json:"user"`
140 Role string `json:"role"`
141 }
142 var ms []memberOut
143 for _, m := range members {
144 ms = append(ms, memberOut{m.Username, m.Role})
145 }
146 d := struct {
147 Org string `json:"org"`
148 Members []memberOut `json:"members"`
149 }{org.Name, ms}
150 return c.emitView(d, func(w io.Writer) {
151 v := c.view(w)
152 v.title(d.Org, "", "")
153 if len(ms) > 0 {
154 v.section("members")
155 tb := c.table(w, "USER", "ROLE")
156 for _, m := range ms {
157 tb.row(cRef(m.User), cState(m.Role))
158 }
159 tb.flush()
160 }
161 }, func() screen {
162 members := section{title: "Members", n: len(ms)}
163 for _, m := range ms {
164 members.rows = append(members.rows, rowOf(cRef(m.User), cState(m.Role)))
165 }
166 return screen{
167 fields: []field{{"Org", []cell{cLink(d.Org, c.siteURL(d.Org))}}},
168 sections: []section{members},
169 actions: []action{
170 {"Members", []string{"org", "members", "add", d.Org, "<user>"}},
171 {"Org", []string{"org", "team", "list", d.Org}},
172 {"Org", []string{"org", "label", "list", d.Org}},
173 {"Org", []string{"org", "milestone", "list", d.Org}},
174 },
175 }
176 })
177}
178
179func runOrgRename(c *Ctx, args []string) int {
180 if len(args) != 2 {
181 return c.usage()
182 }
183 org, code := orgAdmin(c, args[0])
184 if code >= 0 {
185 return code
186 }
187 newName := args[1]
188 if err := policy.ValidateOwnerName(newName); err != nil {
189 return c.failInput(err)
190 }
191 oldDir := filepath.Join(c.Cfg.Server.Root, "repos", org.Name)
192 newDir := filepath.Join(c.Cfg.Server.Root, "repos", newName)
193 if _, err := os.Stat(newDir); err == nil {
194 return c.fail(protocol.ExitFailure, "repository directory %s already exists", newName)
195 }
196 release, lockCode := holdOffBackup(c)
197 if lockCode >= 0 {
198 return lockCode
199 }
200 defer release()
201 if err := c.Store.RenameOrg(org.ID, newName); err != nil {
202 return c.failErr(err)
203 }
204 // Repo paths on disk derive from the owner name; move the tree. If the
205 // move fails, revert the database so name and disk stay consistent.
206 if _, err := os.Stat(oldDir); err == nil {
207 if err := os.Rename(oldDir, newDir); err != nil {
208 c.Store.RenameOrg(org.ID, org.Name)
209 return c.fail(protocol.ExitFailure, "moving repositories: %v", err)
210 }
211 }
212 return c.emit(map[string]string{"org": newName, "was": org.Name}, func(w io.Writer) {
213 fmt.Fprintf(w, "renamed %s to %s — clone URLs now use %s/<repo>\n", org.Name, newName, newName)
214 })
215}
216
217func runOrgDelete(c *Ctx, args []string) int {
218 var name string
219 yes := false
220 for _, a := range args {
221 if a == "--yes" {
222 yes = true
223 } else if name == "" {
224 name = a
225 } else {
226 return c.usage()
227 }
228 }
229 if name == "" {
230 return c.usage()
231 }
232 org, code := orgAdmin(c, name)
233 if code >= 0 {
234 return code
235 }
236 if !yes {
237 return c.fail(protocol.ExitUsage, "org delete is permanent; re-run with --yes")
238 }
239 if err := c.Store.DeleteOrg(org.ID); err != nil {
240 return c.fail(protocol.ExitFailure, "%v", err)
241 }
242 return c.emit(map[string]string{"deleted": name}, func(w io.Writer) {
243 fmt.Fprintf(w, "deleted organization %s\n", name)
244 })
245}
246
247func runOrgMembersAdd(c *Ctx, args []string) int {
248 f, err := c.parseArgs(args, flagSpec{Values: []string{"--role"}, MaxPos: -1, Usage: "org members add <org> <user> [--role member|admin]"})
249 if err != nil {
250 return c.fail(protocol.ExitUsage, "%v", err)
251 }
252 role, rest := "member", f.Pos
253 if f.Has("--role") {
254 role = f.Value("--role")
255 }
256 if len(rest) != 2 || (role != "member" && role != "admin") {
257 return c.usage()
258 }
259 org, code := orgAdmin(c, rest[0])
260 if code >= 0 {
261 return code
262 }
263 target, err := c.Store.UserByUsername(rest[1])
264 if errors.Is(err, store.ErrNotFound) {
265 return c.fail(protocol.ExitNotFound, "no such user %q", rest[1])
266 }
267 if err != nil {
268 return c.fail(protocol.ExitFailure, "%v", err)
269 }
270 if err := c.Store.SetOrgMember(org.ID, target.ID, role); err != nil {
271 return c.failErr(err)
272 }
273 return c.emit(map[string]string{"org": org.Name, "user": target.Username, "role": role}, func(w io.Writer) {
274 fmt.Fprintf(w, "%s is now a %s of %s\n", target.Username, role, org.Name)
275 })
276}
277
278func runOrgMembersRemove(c *Ctx, args []string) int {
279 if len(args) != 2 {
280 return c.usage()
281 }
282 org, code := orgAdmin(c, args[0])
283 if code >= 0 {
284 return code
285 }
286 target, err := c.Store.UserByUsername(args[1])
287 if errors.Is(err, store.ErrNotFound) {
288 return c.fail(protocol.ExitNotFound, "no such user %q", args[1])
289 }
290 if err != nil {
291 return c.fail(protocol.ExitFailure, "%v", err)
292 }
293 if err := c.Store.RemoveOrgMember(org.ID, target.ID); err != nil {
294 if errors.Is(err, store.ErrNotFound) {
295 return c.fail(protocol.ExitNotFound, "%s is not a member of %s", target.Username, org.Name)
296 }
297 return c.failErr(err)
298 }
299 return c.emit(map[string]string{"org": org.Name, "removed": target.Username}, func(w io.Writer) {
300 fmt.Fprintf(w, "removed %s from %s\n", target.Username, org.Name)
301 })
302}
303
304func runOrgMembersList(c *Ctx, args []string) int {
305 if len(args) != 1 {
306 return c.usage()
307 }
308 return runOrgShow(c, args)
309}