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, 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 export const GROUP_ATTRIBUTES_DIALOG = 'groupAttributesDialog';
  29 export const GROUP_REMOVE_DIALOG = 'groupRemoveDialog';
  30
  31 export const GroupsPanelActions = bindDataExplorerActions(GROUPS_PANEL_ID);
  32
  33 export const loadGroupsPanel = () => GroupsPanelActions.REQUEST_ITEMS();
  34
  35 export const openCreateGroupDialog = () =>
  36     (dispatch: Dispatch) => {
  37         dispatch(dialogActions.OPEN_DIALOG({ id: CREATE_GROUP_DIALOG, data: {} }));
  38         dispatch(reset(CREATE_GROUP_FORM));
  39     };
  40
  41 export const openGroupAttributes = (uuid: string) =>
  42     (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
  43         const { resources } = getState();
  44         const data = getResource<GroupResource>(uuid)(resources);
  45         dispatch(dialogActions.OPEN_DIALOG({ id: GROUP_ATTRIBUTES_DIALOG, data }));
  46     };
  47
  48 export const removeGroup = (uuid: string) =>
  49     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
  50         dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Removing ...', kind: SnackbarKind.INFO }));
  51         await services.groupsService.delete(uuid);
  52         dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Removed.', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
  53         dispatch<any>(loadGroupsPanel());
  54     };
  55
  56 export const openRemoveGroupDialog = (uuid: string) =>
  57     (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
  58         dispatch(dialogActions.OPEN_DIALOG({
  59             id: GROUP_REMOVE_DIALOG,
  60             data: {
  61                 title: 'Remove group',
  62                 text: 'Are you sure you want to remove this group?',
  63                 confirmButtonLabel: 'Remove',
  64                 uuid
  65             }
  66         }));
  67     };
  68
  69 export interface CreateGroupFormData {
  70     [CREATE_GROUP_NAME_FIELD_NAME]: string;
  71     [CREATE_GROUP_USERS_FIELD_NAME]?: Participant[];
  72 }
  73
  74 export const createGroup = ({ name, users = [] }: CreateGroupFormData) =>
  75     async (dispatch: Dispatch, _: {}, { groupsService, permissionService }: ServiceRepository) => {
  76         dispatch(startSubmit(CREATE_GROUP_FORM));
  77         try {
  78             const newGroup = await groupsService.create({ name, groupClass: GroupClass.ROLE });
  79             for (const user of users) {
  80                 await addGroupMember({
  81                     user,
  82                     group: newGroup,
  83                     dispatch,
  84                     permissionService,
  85                 });
  86             }
  87             dispatch(dialogActions.CLOSE_DIALOG({ id: CREATE_GROUP_DIALOG }));
  88             dispatch(reset(CREATE_GROUP_FORM));
  89             dispatch(loadGroupsPanel());
  90             dispatch(snackbarActions.OPEN_SNACKBAR({
  91                 message: `${newGroup.name} group has been created`,
  92                 kind: SnackbarKind.SUCCESS
  93             }));
  94             return newGroup;
  95         } catch (e) {
  96             const error = getCommonResourceServiceError(e);
  97             if (error === CommonResourceServiceError.UNIQUE_NAME_VIOLATION) {
  98                 dispatch(stopSubmit(CREATE_GROUP_FORM, { name: 'Group with the same name already exists.' } as FormErrors));
  99             }
 100             return;
 101         }
 102     };
 103
 104 interface AddGroupMemberArgs {
 105     user: { uuid: string, name: string };
 106     group: { uuid: string, name: string };
 107     dispatch: Dispatch;
 108     permissionService: PermissionService;
 109 }
 110
 111 /**
 112  * Group membership is determined by whether the group has can_read permission on an object.
 113  * If a group G can_read an object A, then we say A is a member of G.
 114  *
 115  * [Permission model docs](https://doc.arvados.org/api/permission-model.html)
 116  */
 117 export const addGroupMember = async ({ user, group, ...args }: AddGroupMemberArgs) => {
 118     await createPermission({
 119         head: { ...group },
 120         tail: { ...user },
 121         permissionLevel: PermissionLevel.CAN_READ,
 122         ...args,
 123     });
 124 };
 125
 126 interface CreatePermissionLinkArgs {
 127     head: { uuid: string, name: string };
 128     tail: { uuid: string, name: string };
 129     permissionLevel: PermissionLevel;
 130     dispatch: Dispatch;
 131     permissionService: PermissionService;
 132 }
 133
 134 const createPermission = async ({ head, tail, permissionLevel, dispatch, permissionService }: CreatePermissionLinkArgs) => {
 135     try {
 136         await permissionService.create({
 137             tailUuid: tail.uuid,
 138             headUuid: head.uuid,
 139             name: permissionLevel,
 140         });
 141     } catch (e) {
 142         dispatch(snackbarActions.OPEN_SNACKBAR({
 143             message: `Could not add ${tail.name} -> ${head.name} relation`,
 144             kind: SnackbarKind.ERROR,
 145         }));
 146     }
 147 };
 148
 149 interface DeleteGroupMemberArgs {
 150     link: { uuid: string };
 151     dispatch: Dispatch;
 152     permissionService: PermissionService;
 153 }
 154
 155 export const deleteGroupMember = async ({ link, ...args }: DeleteGroupMemberArgs) => {
 156     await deletePermission({
 157         uuid: link.uuid,
 158         ...args,
 159     });
 160 };
 161
 162 interface DeletePermissionLinkArgs {
 163     uuid: string;
 164     dispatch: Dispatch;
 165     permissionService: PermissionService;
 166 }
 167
 168 export const deletePermission = async ({ uuid, dispatch, permissionService }: DeletePermissionLinkArgs) => {
 169     try {
 170         const permissionsResponse = await permissionService.list({
 171             filters: new FilterBuilder()
 172                 .addEqual('uuid', uuid)
 173                 .getFilters()
 174         });
 175         const [permission] = permissionsResponse.items;
 176         if (permission) {
 177             await permissionService.delete(permission.uuid);
 178         } else {
 179             throw new Error('Permission not found');
 180         }
 181     } catch (e) {
 182         dispatch(snackbarActions.OPEN_SNACKBAR({
 183             message: `Could not delete ${uuid} permission`,
 184             kind: SnackbarKind.ERROR,
 185         }));
 186     }
 187 };