1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 import { Dispatch } from 'redux';
6 import { reset, startSubmit, stopSubmit, FormErrors, initialize } from 'redux-form';
7 import { bindDataExplorerActions } from "store/data-explorer/data-explorer-action";
8 import { dialogActions } from 'store/dialog/dialog-actions';
9 import { Participant } from 'views-components/sharing-dialog/participant-select';
10 import { RootState } from 'store/store';
11 import { ServiceRepository } from 'services/services';
12 import { getResource } from 'store/resources/resources';
13 import { GroupResource, GroupClass } from 'models/group';
14 import { getCommonResourceServiceError, CommonResourceServiceError } from 'services/common-service/common-resource-service';
15 import { snackbarActions, SnackbarKind } from 'store/snackbar/snackbar-actions';
16 import { PermissionLevel } from 'models/permission';
17 import { PermissionService } from 'services/permission-service/permission-service';
18 import { FilterBuilder } from 'services/api/filter-builder';
19 import { ProjectUpdateFormDialogData, PROJECT_UPDATE_FORM_NAME } from 'store/projects/project-update-actions';
21 export const GROUPS_PANEL_ID = "groupsPanel";
23 // Create group dialog
24 export const CREATE_GROUP_DIALOG = "createGroupDialog";
25 export const CREATE_GROUP_FORM = "createGroupForm";
26 export const CREATE_GROUP_NAME_FIELD_NAME = 'name';
27 export const CREATE_GROUP_USERS_FIELD_NAME = 'users';
29 export const GROUP_ATTRIBUTES_DIALOG = 'groupAttributesDialog';
30 export const GROUP_REMOVE_DIALOG = 'groupRemoveDialog';
32 export const GroupsPanelActions = bindDataExplorerActions(GROUPS_PANEL_ID);
34 export const loadGroupsPanel = () => GroupsPanelActions.REQUEST_ITEMS();
36 export const openCreateGroupDialog = () =>
37 (dispatch: Dispatch) => {
38 dispatch(dialogActions.OPEN_DIALOG({ id: CREATE_GROUP_DIALOG, data: {} }));
39 dispatch(reset(CREATE_GROUP_FORM));
42 export const openGroupAttributes = (uuid: string) =>
43 (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
44 const { resources } = getState();
45 const data = getResource<GroupResource>(uuid)(resources);
46 dispatch(dialogActions.OPEN_DIALOG({ id: GROUP_ATTRIBUTES_DIALOG, data }));
49 export const removeGroup = (uuid: string) =>
50 async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
51 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Removing ...', kind: SnackbarKind.INFO }));
52 await services.groupsService.delete(uuid);
53 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Removed.', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
54 dispatch<any>(loadGroupsPanel());
57 export const openRemoveGroupDialog = (uuid: string) =>
58 (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
59 dispatch(dialogActions.OPEN_DIALOG({
60 id: GROUP_REMOVE_DIALOG,
62 title: 'Remove group',
63 text: 'Are you sure you want to remove this group?',
64 confirmButtonLabel: 'Remove',
70 // Group edit dialog uses project update dialog with sourcePanel set to reload the appropriate parts
71 export const openGroupUpdateDialog = (resource: ProjectUpdateFormDialogData) =>
72 (dispatch: Dispatch, getState: () => RootState) => {
73 dispatch(initialize(PROJECT_UPDATE_FORM_NAME, resource));
74 dispatch(dialogActions.OPEN_DIALOG({ id: PROJECT_UPDATE_FORM_NAME, data: {sourcePanel: GroupClass.ROLE} }));
77 export const updateGroup = (project: ProjectUpdateFormDialogData) =>
78 async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
79 const uuid = project.uuid || '';
80 dispatch(startSubmit(PROJECT_UPDATE_FORM_NAME));
82 const updatedGroup = await services.groupsService.update(uuid, { name: project.name, description: project.description });
83 dispatch(GroupsPanelActions.REQUEST_ITEMS());
84 dispatch(reset(PROJECT_UPDATE_FORM_NAME));
85 dispatch(dialogActions.CLOSE_DIALOG({ id: PROJECT_UPDATE_FORM_NAME }));
88 dispatch(stopSubmit(PROJECT_UPDATE_FORM_NAME));
89 const error = getCommonResourceServiceError(e);
90 if (error === CommonResourceServiceError.UNIQUE_NAME_VIOLATION) {
91 dispatch(stopSubmit(PROJECT_UPDATE_FORM_NAME, { name: 'Group with the same name already exists.' } as FormErrors));
97 export interface CreateGroupFormData {
98 [CREATE_GROUP_NAME_FIELD_NAME]: string;
99 [CREATE_GROUP_USERS_FIELD_NAME]?: Participant[];
102 export const createGroup = ({ name, users = [] }: CreateGroupFormData) =>
103 async (dispatch: Dispatch, _: {}, { groupsService, permissionService }: ServiceRepository) => {
104 dispatch(startSubmit(CREATE_GROUP_FORM));
106 const newGroup = await groupsService.create({ name, groupClass: GroupClass.ROLE });
107 for (const user of users) {
108 await addGroupMember({
115 dispatch(dialogActions.CLOSE_DIALOG({ id: CREATE_GROUP_DIALOG }));
116 dispatch(reset(CREATE_GROUP_FORM));
117 dispatch(loadGroupsPanel());
118 dispatch(snackbarActions.OPEN_SNACKBAR({
119 message: `${newGroup.name} group has been created`,
120 kind: SnackbarKind.SUCCESS
124 const error = getCommonResourceServiceError(e);
125 if (error === CommonResourceServiceError.UNIQUE_NAME_VIOLATION) {
126 dispatch(stopSubmit(CREATE_GROUP_FORM, { name: 'Group with the same name already exists.' } as FormErrors));
132 interface AddGroupMemberArgs {
133 user: { uuid: string, name: string };
134 group: { uuid: string, name: string };
136 permissionService: PermissionService;
140 * Group membership is determined by whether the group has can_read permission on an object.
141 * If a group G can_read an object A, then we say A is a member of G.
143 * [Permission model docs](https://doc.arvados.org/api/permission-model.html)
145 export const addGroupMember = async ({ user, group, ...args }: AddGroupMemberArgs) => {
146 await createPermission({
149 permissionLevel: PermissionLevel.CAN_READ,
154 interface CreatePermissionLinkArgs {
155 head: { uuid: string, name: string };
156 tail: { uuid: string, name: string };
157 permissionLevel: PermissionLevel;
159 permissionService: PermissionService;
162 const createPermission = async ({ head, tail, permissionLevel, dispatch, permissionService }: CreatePermissionLinkArgs) => {
164 await permissionService.create({
167 name: permissionLevel,
170 dispatch(snackbarActions.OPEN_SNACKBAR({
171 message: `Could not add ${tail.name} -> ${head.name} relation`,
172 kind: SnackbarKind.ERROR,
177 interface DeleteGroupMemberArgs {
178 link: { uuid: string };
180 permissionService: PermissionService;
183 export const deleteGroupMember = async ({ link, ...args }: DeleteGroupMemberArgs) => {
184 await deletePermission({
190 interface DeletePermissionLinkArgs {
193 permissionService: PermissionService;
196 export const deletePermission = async ({ uuid, dispatch, permissionService }: DeletePermissionLinkArgs) => {
198 const permissionsResponse = await permissionService.list({
199 filters: new FilterBuilder()
200 .addEqual('uuid', uuid)
203 const [permission] = permissionsResponse.items;
205 await permissionService.delete(permission.uuid);
207 throw new Error('Permission not found');
210 dispatch(snackbarActions.OPEN_SNACKBAR({
211 message: `Could not delete ${uuid} permission`,
212 kind: SnackbarKind.ERROR,