src/store/groups-panel/groups-panel-actions.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { Dispatch } from 'redux';
   6 import { reset, initialize, startSubmit, stopSubmit, FormErrors } 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
  20 export const GROUPS_PANEL_ID = "groupsPanel";
  21
  22 // Create group dialog
  23 export const CREATE_GROUP_DIALOG = "createGroupDialog";
  24 export const CREATE_GROUP_FORM = "createGroupForm";
  25 export const CREATE_GROUP_NAME_FIELD_NAME = 'name';
  26 export const CREATE_GROUP_USERS_FIELD_NAME = 'users';
  27
  28 // Rename group dialog
  29 export const RENAME_GROUP_DIALOG = "renameGroupDialog";
  30 export const RENAME_GROUP_FORM = "renameGroupForm";
  31 export const RENAME_GROUP_UUID_FIELD_NAME = 'uuid';
  32 export const RENAME_GROUP_NAME_FIELD_NAME = 'name';
  33
  34 export const GROUP_ATTRIBUTES_DIALOG = 'groupAttributesDialog';
  35 export const GROUP_REMOVE_DIALOG = 'groupRemoveDialog';
  36
  37 export const GroupsPanelActions = bindDataExplorerActions(GROUPS_PANEL_ID);
  38
  39 export const loadGroupsPanel = () => GroupsPanelActions.REQUEST_ITEMS();
  40
  41 export const openCreateGroupDialog = () =>
  42     (dispatch: Dispatch) => {
  43         dispatch(dialogActions.OPEN_DIALOG({ id: CREATE_GROUP_DIALOG, data: {} }));
  44         dispatch(reset(CREATE_GROUP_FORM));
  45     };
  46
  47 export const openGroupAttributes = (uuid: string) =>
  48     (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
  49         const { resources } = getState();
  50         const data = getResource<GroupResource>(uuid)(resources);
  51         dispatch(dialogActions.OPEN_DIALOG({ id: GROUP_ATTRIBUTES_DIALOG, data }));
  52     };
  53
  54 export const removeGroup = (uuid: string) =>
  55     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
  56         dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Removing ...', kind: SnackbarKind.INFO }));
  57         await services.groupsService.delete(uuid);
  58         dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Removed.', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
  59         dispatch<any>(loadGroupsPanel());
  60     };
  61
  62 export const openRemoveGroupDialog = (uuid: string) =>
  63     (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
  64         dispatch(dialogActions.OPEN_DIALOG({
  65             id: GROUP_REMOVE_DIALOG,
  66             data: {
  67                 title: 'Remove group',
  68                 text: 'Are you sure you want to remove this group?',
  69                 confirmButtonLabel: 'Remove',
  70                 uuid
  71             }
  72         }));
  73     };
  74
  75 export interface RenameGroupFormData {
  76     [RENAME_GROUP_UUID_FIELD_NAME]: string;
  77     [RENAME_GROUP_NAME_FIELD_NAME]: string;
  78 }
  79
  80 export const openRenameGroupDialog = (uuid: string) =>
  81     (dispatch: Dispatch, getState: () => RootState) => {
  82         const group = getResource<GroupResource>(uuid)(getState().resources);
  83
  84         if (group) {
  85             const formData: RenameGroupFormData = {[RENAME_GROUP_UUID_FIELD_NAME]: group.uuid, [RENAME_GROUP_NAME_FIELD_NAME]: group.name};
  86             console.log("Initialize form: ", formData);
  87             dispatch(reset(RENAME_GROUP_FORM));
  88             dispatch<any>(initialize(RENAME_GROUP_FORM, formData));
  89             dispatch(dialogActions.OPEN_DIALOG({ id: RENAME_GROUP_DIALOG, data: group }));
  90         }
  91     };
  92
  93
  94 export const renameGroup = (data: RenameGroupFormData) =>
  95     async (dispatch: Dispatch, getState: () => RootState, { groupsService }: ServiceRepository) => {
  96         console.log("RenameGroupFormData", data);
  97         await groupsService.update(data[RENAME_GROUP_UUID_FIELD_NAME], { name: data[RENAME_GROUP_NAME_FIELD_NAME] });
  98         dispatch(dialogActions.CLOSE_DIALOG({ id: RENAME_GROUP_DIALOG }));
  99         dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Renamed.', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
 100     };
 101
 102 export interface CreateGroupFormData {
 103     [CREATE_GROUP_NAME_FIELD_NAME]: string;
 104     [CREATE_GROUP_USERS_FIELD_NAME]?: Participant[];
 105 }
 106
 107 export const createGroup = ({ name, users = [] }: CreateGroupFormData) =>
 108     async (dispatch: Dispatch, _: {}, { groupsService, permissionService }: ServiceRepository) => {
 109         dispatch(startSubmit(CREATE_GROUP_FORM));
 110         try {
 111             const newGroup = await groupsService.create({ name, groupClass: GroupClass.ROLE });
 112             for (const user of users) {
 113                 await addGroupMember({
 114                     user,
 115                     group: newGroup,
 116                     dispatch,
 117                     permissionService,
 118                 });
 119             }
 120             dispatch(dialogActions.CLOSE_DIALOG({ id: CREATE_GROUP_DIALOG }));
 121             dispatch(reset(CREATE_GROUP_FORM));
 122             dispatch(loadGroupsPanel());
 123             dispatch(snackbarActions.OPEN_SNACKBAR({
 124                 message: `${newGroup.name} group has been created`,
 125                 kind: SnackbarKind.SUCCESS
 126             }));
 127             return newGroup;
 128         } catch (e) {
 129             const error = getCommonResourceServiceError(e);
 130             if (error === CommonResourceServiceError.UNIQUE_NAME_VIOLATION) {
 131                 dispatch(stopSubmit(CREATE_GROUP_FORM, { name: 'Group with the same name already exists.' } as FormErrors));
 132             }
 133             return;
 134         }
 135     };
 136
 137 interface AddGroupMemberArgs {
 138     user: { uuid: string, name: string };
 139     group: { uuid: string, name: string };
 140     dispatch: Dispatch;
 141     permissionService: PermissionService;
 142 }
 143
 144 /**
 145  * Group membership is determined by whether the group has can_read permission on an object.
 146  * If a group G can_read an object A, then we say A is a member of G.
 147  *
 148  * [Permission model docs](https://doc.arvados.org/api/permission-model.html)
 149  */
 150 export const addGroupMember = async ({ user, group, ...args }: AddGroupMemberArgs) => {
 151     await createPermission({
 152         head: { ...group },
 153         tail: { ...user },
 154         permissionLevel: PermissionLevel.CAN_READ,
 155         ...args,
 156     });
 157 };
 158
 159 interface CreatePermissionLinkArgs {
 160     head: { uuid: string, name: string };
 161     tail: { uuid: string, name: string };
 162     permissionLevel: PermissionLevel;
 163     dispatch: Dispatch;
 164     permissionService: PermissionService;
 165 }
 166
 167 const createPermission = async ({ head, tail, permissionLevel, dispatch, permissionService }: CreatePermissionLinkArgs) => {
 168     try {
 169         await permissionService.create({
 170             tailUuid: tail.uuid,
 171             headUuid: head.uuid,
 172             name: permissionLevel,
 173         });
 174     } catch (e) {
 175         dispatch(snackbarActions.OPEN_SNACKBAR({
 176             message: `Could not add ${tail.name} -> ${head.name} relation`,
 177             kind: SnackbarKind.ERROR,
 178         }));
 179     }
 180 };
 181
 182 interface DeleteGroupMemberArgs {
 183     link: { uuid: string };
 184     dispatch: Dispatch;
 185     permissionService: PermissionService;
 186 }
 187
 188 export const deleteGroupMember = async ({ link, ...args }: DeleteGroupMemberArgs) => {
 189     await deletePermission({
 190         uuid: link.uuid,
 191         ...args,
 192     });
 193 };
 194
 195 interface DeletePermissionLinkArgs {
 196     uuid: string;
 197     dispatch: Dispatch;
 198     permissionService: PermissionService;
 199 }
 200
 201 export const deletePermission = async ({ uuid, dispatch, permissionService }: DeletePermissionLinkArgs) => {
 202     try {
 203         const permissionsResponse = await permissionService.list({
 204             filters: new FilterBuilder()
 205                 .addEqual('uuid', uuid)
 206                 .getFilters()
 207         });
 208         const [permission] = permissionsResponse.items;
 209         if (permission) {
 210             await permissionService.delete(permission.uuid);
 211         } else {
 212             throw new Error('Permission not found');
 213         }
 214     } catch (e) {
 215         dispatch(snackbarActions.OPEN_SNACKBAR({
 216             message: `Could not delete ${uuid} permission`,
 217             kind: SnackbarKind.ERROR,
 218         }));
 219     }
 220 };