internal/control/org.go

284 lines · 8487 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.emit(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	})
111}
112
113func runOrgShow(c *Ctx, args []string) int {
114	if len(args) != 1 {
115		return c.usage()
116	}
117	org, err := c.Store.OrgByName(args[0])
118	if errors.Is(err, store.ErrNotFound) {
119		return c.fail(protocol.ExitNotFound, "no organization %q", args[0])
120	}
121	if err != nil {
122		return c.fail(protocol.ExitFailure, "%v", err)
123	}
124	members, err := c.Store.OrgMembers(org.ID)
125	if err != nil {
126		return c.fail(protocol.ExitFailure, "%v", err)
127	}
128	type memberOut struct {
129		User string `json:"user"`
130		Role string `json:"role"`
131	}
132	var ms []memberOut
133	for _, m := range members {
134		ms = append(ms, memberOut{m.Username, m.Role})
135	}
136	d := struct {
137		Org     string      `json:"org"`
138		Members []memberOut `json:"members"`
139	}{org.Name, ms}
140	return c.emit(d, func(w io.Writer) {
141		v := c.view(w)
142		v.title(d.Org, "", "")
143		if len(ms) > 0 {
144			v.section("members")
145			tb := c.table(w, "USER", "ROLE")
146			for _, m := range ms {
147				tb.row(cRef(m.User), cState(m.Role))
148			}
149			tb.flush()
150		}
151	})
152}
153
154func runOrgRename(c *Ctx, args []string) int {
155	if len(args) != 2 {
156		return c.usage()
157	}
158	org, code := orgAdmin(c, args[0])
159	if code >= 0 {
160		return code
161	}
162	newName := args[1]
163	if err := policy.ValidateOwnerName(newName); err != nil {
164		return c.failInput(err)
165	}
166	oldDir := filepath.Join(c.Cfg.Server.Root, "repos", org.Name)
167	newDir := filepath.Join(c.Cfg.Server.Root, "repos", newName)
168	if _, err := os.Stat(newDir); err == nil {
169		return c.fail(protocol.ExitFailure, "repository directory %s already exists", newName)
170	}
171	release, lockCode := holdOffBackup(c)
172	if lockCode >= 0 {
173		return lockCode
174	}
175	defer release()
176	if err := c.Store.RenameOrg(org.ID, newName); err != nil {
177		return c.failErr(err)
178	}
179	// Repo paths on disk derive from the owner name; move the tree. If the
180	// move fails, revert the database so name and disk stay consistent.
181	if _, err := os.Stat(oldDir); err == nil {
182		if err := os.Rename(oldDir, newDir); err != nil {
183			c.Store.RenameOrg(org.ID, org.Name)
184			return c.fail(protocol.ExitFailure, "moving repositories: %v", err)
185		}
186	}
187	return c.emit(map[string]string{"org": newName, "was": org.Name}, func(w io.Writer) {
188		fmt.Fprintf(w, "renamed %s to %s — clone URLs now use %s/<repo>\n", org.Name, newName, newName)
189	})
190}
191
192func runOrgDelete(c *Ctx, args []string) int {
193	var name string
194	yes := false
195	for _, a := range args {
196		if a == "--yes" {
197			yes = true
198		} else if name == "" {
199			name = a
200		} else {
201			return c.usage()
202		}
203	}
204	if name == "" {
205		return c.usage()
206	}
207	org, code := orgAdmin(c, name)
208	if code >= 0 {
209		return code
210	}
211	if !yes {
212		return c.fail(protocol.ExitUsage, "org delete is permanent; re-run with --yes")
213	}
214	if err := c.Store.DeleteOrg(org.ID); err != nil {
215		return c.fail(protocol.ExitFailure, "%v", err)
216	}
217	return c.emit(map[string]string{"deleted": name}, func(w io.Writer) {
218		fmt.Fprintf(w, "deleted organization %s\n", name)
219	})
220}
221
222func runOrgMembersAdd(c *Ctx, args []string) int {
223	f, err := c.parseArgs(args, flagSpec{Values: []string{"--role"}, MaxPos: -1, Usage: "org members add <org> <user> [--role member|admin]"})
224	if err != nil {
225		return c.fail(protocol.ExitUsage, "%v", err)
226	}
227	role, rest := "member", f.Pos
228	if f.Has("--role") {
229		role = f.Value("--role")
230	}
231	if len(rest) != 2 || (role != "member" && role != "admin") {
232		return c.usage()
233	}
234	org, code := orgAdmin(c, rest[0])
235	if code >= 0 {
236		return code
237	}
238	target, err := c.Store.UserByUsername(rest[1])
239	if errors.Is(err, store.ErrNotFound) {
240		return c.fail(protocol.ExitNotFound, "no such user %q", rest[1])
241	}
242	if err != nil {
243		return c.fail(protocol.ExitFailure, "%v", err)
244	}
245	if err := c.Store.SetOrgMember(org.ID, target.ID, role); err != nil {
246		return c.failErr(err)
247	}
248	return c.emit(map[string]string{"org": org.Name, "user": target.Username, "role": role}, func(w io.Writer) {
249		fmt.Fprintf(w, "%s is now a %s of %s\n", target.Username, role, org.Name)
250	})
251}
252
253func runOrgMembersRemove(c *Ctx, args []string) int {
254	if len(args) != 2 {
255		return c.usage()
256	}
257	org, code := orgAdmin(c, args[0])
258	if code >= 0 {
259		return code
260	}
261	target, err := c.Store.UserByUsername(args[1])
262	if errors.Is(err, store.ErrNotFound) {
263		return c.fail(protocol.ExitNotFound, "no such user %q", args[1])
264	}
265	if err != nil {
266		return c.fail(protocol.ExitFailure, "%v", err)
267	}
268	if err := c.Store.RemoveOrgMember(org.ID, target.ID); err != nil {
269		if errors.Is(err, store.ErrNotFound) {
270			return c.fail(protocol.ExitNotFound, "%s is not a member of %s", target.Username, org.Name)
271		}
272		return c.failErr(err)
273	}
274	return c.emit(map[string]string{"org": org.Name, "removed": target.Username}, func(w io.Writer) {
275		fmt.Fprintf(w, "removed %s from %s\n", target.Username, org.Name)
276	})
277}
278
279func runOrgMembersList(c *Ctx, args []string) int {
280	if len(args) != 1 {
281		return c.usage()
282	}
283	return runOrgShow(c, args)
284}