services/workbench2/src/components/multiselect-toolbar/MultiselectToolbar.tsx

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import React from "react";
   6 import { connect } from "react-redux";
   7 import { CustomStyleRulesCallback } from 'common/custom-theme';
   8 import { Toolbar, Tooltip, IconButton } from "@mui/material";
   9 import { WithStyles } from '@mui/styles';
  10 import withStyles from '@mui/styles/withStyles';
  11 import { ArvadosTheme } from "common/custom-theme";
  12 import { RootState } from "store/store";
  13 import { Dispatch } from "redux";
  14 import { TCheckedList } from "components/data-table/data-table";
  15 import { ContextMenuResource } from "store/context-menu/context-menu-actions";
  16 import { Resource, ResourceKind, extractUuidKind } from "models/resource";
  17 import { getResource } from "store/resources/resources";
  18 import { ResourcesState } from "store/resources/resources";
  19 import { MultiSelectMenuAction, MultiSelectMenuActionSet } from "views-components/multiselect-toolbar/ms-menu-actions";
  20 import { ContextMenuAction, ContextMenuActionNames } from "views-components/context-menu/context-menu-action-set";
  21 import { multiselectActionsFilters, TMultiselectActionsFilters } from "./ms-toolbar-action-filters";
  22 import { kindToActionSet, findActionByName } from "./ms-kind-action-differentiator";
  23 import { msToggleTrashAction } from "views-components/multiselect-toolbar/ms-project-action-set";
  24 import { copyToClipboardAction } from "store/open-in-new-tab/open-in-new-tab.actions";
  25 import { ContainerRequestResource } from "models/container-request";
  26 import { FavoritesState } from "store/favorites/favorites-reducer";
  27 import { resourceIsFrozen } from "common/frozen-resources";
  28 import { getResourceWithEditableStatus } from "store/resources/resources";
  29 import { GroupResource } from "models/group";
  30 import { EditableResource } from "models/resource";
  31 import { User } from "models/user";
  32 import { GroupClass } from "models/group";
  33 import { isProcessCancelable } from "store/processes/process";
  34 import { CollectionResource } from "models/collection";
  35 import { getProcess } from "store/processes/process";
  36 import { Process } from "store/processes/process";
  37 import { PublicFavoritesState } from "store/public-favorites/public-favorites-reducer";
  38 import { AuthState } from "store/auth/auth-reducer";
  39 import { IntersectionObserverWrapper } from "./ms-toolbar-overflow-wrapper";
  40 import classNames from "classnames";
  41 import { ContextMenuKind, sortMenuItems, menuDirection } from 'views-components/context-menu/menu-item-sort';
  42
  43 type CssRules = "root" | "toolbarContainer" | "button" | "iconContainer" | "icon" | "divider";
  44
  45 const styles: CustomStyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  46     root: {
  47         display: "flex",
  48         flexDirection: "row",
  49         width: 0,
  50         padding: 0,
  51         margin: 0,
  52         overflow: 'hidden',
  53     },
  54     toolbarContainer: {
  55         height: '3rem',
  56         display: 'flex',
  57         flexDirection: 'column',
  58         justifyContent: 'start',
  59     },
  60     button: {
  61         width: "2.5rem",
  62         height: "2.5rem ",
  63         paddingLeft: 0,
  64         border: "1px solid transparent",
  65         zIndex: 10,
  66     },
  67     iconContainer: {
  68         height: '100%',
  69     },
  70     icon: {
  71         marginLeft: '-0.5rem',
  72     },
  73     divider: {
  74         display: "flex",
  75         alignItems: "center",
  76     },
  77 });
  78
  79 export type MultiselectToolbarProps = {
  80     checkedList: TCheckedList;
  81     selectedResourceUuid: string | null;
  82     iconProps: IconProps
  83     user: User | null
  84     disabledButtons: Set<string>
  85     auth: AuthState;
  86     location: string;
  87     forceMultiSelectMode?: boolean;
  88     injectedStyles?: string;
  89     executeMulti: (action: ContextMenuAction | MultiSelectMenuAction, checkedList: TCheckedList, resources: ResourcesState) => void;
  90 };
  91
  92 type IconProps = {
  93     resources: ResourcesState;
  94     favorites: FavoritesState;
  95     publicFavorites: PublicFavoritesState;
  96 }
  97
  98 const detailsCardPaths = [
  99     '/projects',
 100 ]
 101
 102 export const usesDetailsCard = (location: string): boolean => {
 103     return detailsCardPaths.some(path => location.includes(path))
 104 }
 105
 106 export const MultiselectToolbar = connect(
 107     mapStateToProps,
 108     mapDispatchToProps
 109 )(
 110     withStyles(styles)((props: MultiselectToolbarProps & WithStyles<CssRules>) => {
 111         const { classes, checkedList, iconProps, user, disabledButtons, location, forceMultiSelectMode, injectedStyles } = props;
 112         const selectedResourceArray = selectedToArray(checkedList);
 113         const selectedResourceUuid = usesDetailsCard(location) ? props.selectedResourceUuid : selectedResourceArray.length === 1 ? selectedResourceArray[0] : null;
 114         const singleResourceKind = selectedResourceUuid && !forceMultiSelectMode ? [resourceToMsResourceKind(selectedResourceUuid, iconProps.resources, user)] : null
 115         const currentResourceKinds = singleResourceKind ? singleResourceKind : Array.from(selectedToKindSet(checkedList, iconProps.resources));
 116         const currentPathIsTrash = window.location.pathname === "/trash";
 117
 118         const rawActions =
 119             currentPathIsTrash && selectedToKindSet(checkedList).size
 120                 ? [msToggleTrashAction]
 121                 : selectActionsByKind(currentResourceKinds as string[], multiselectActionsFilters).filter((action) =>
 122                         selectedResourceUuid === null ? action.isForMulti : true
 123                     );
 124
 125         const actions: ContextMenuAction[] | MultiSelectMenuAction[] = sortMenuItems(
 126             singleResourceKind && singleResourceKind.length ? (singleResourceKind[0] as ContextMenuKind) : ContextMenuKind.MULTI,
 127             rawActions,
 128             menuDirection.HORIZONTAL
 129         );
 130
 131         const targetResources = selectedResourceUuid ? {[selectedResourceUuid]: true} as TCheckedList : checkedList
 132
 133         return (
 134             <div className={classes.toolbarContainer}>
 135                 <Toolbar
 136                     className={classNames(classes.root, injectedStyles)}
 137                     style={{ width: `${(actions.length * 2.5) + 2}rem`}}
 138                     data-cy='multiselect-toolbar'
 139                     >
 140                     {actions.length ? (
 141                         <IntersectionObserverWrapper menuLength={actions.length}>
 142                             {actions.map((action, i) =>{
 143                                 const { hasAlts, useAlts, name, altName, icon, altIcon } = action;
 144                             return action.name === ContextMenuActionNames.DIVIDER ? (
 145                                 action.component && (
 146                                     <div
 147                                         className={classes.divider}
 148                                         data-targetid={`${name}${i}`}
 149                                         key={i}
 150                                     >
 151                                         <action.component />
 152                                     </div>
 153                                 )
 154                             ) : hasAlts ? (
 155                                 <Tooltip
 156                                     className={classes.button}
 157                                     data-targetid={name}
 158                                     title={currentPathIsTrash || (useAlts && useAlts(selectedResourceUuid, iconProps)) ? altName : name}
 159                                     key={i}
 160                                     disableFocusListener
 161                                 >
 162                                     <span className={classes.iconContainer}>
 163                                         <IconButton
 164                                             data-cy='multiselect-button'
 165                                             disabled={disabledButtons.has(name)}
 166                                             onClick={() => props.executeMulti(action, targetResources, iconProps.resources)}
 167                                             className={classes.icon}
 168                                             size="large">
 169                                             {currentPathIsTrash || (useAlts && useAlts(selectedResourceUuid, iconProps)) ? altIcon && altIcon({}) : icon({})}
 170                                         </IconButton>
 171                                     </span>
 172                                 </Tooltip>
 173                             ) : (
 174                                 <Tooltip
 175                                     className={classes.button}
 176                                     data-targetid={name}
 177                                     title={action.name}
 178                                     key={i}
 179                                     disableFocusListener
 180                                 >
 181                                     <span className={classes.iconContainer}>
 182                                         <IconButton
 183                                             data-cy='multiselect-button'
 184                                             onClick={() => {
 185                                                 props.executeMulti(action, targetResources, iconProps.resources)}}
 186                                             className={classes.icon}
 187                                             size="large">
 188                                             {action.icon({})}
 189                                         </IconButton>
 190                                     </span>
 191                                 </Tooltip>
 192                             );
 193                             })}
 194                         </IntersectionObserverWrapper>
 195                     ) : (
 196                         <></>
 197                     )}
 198                 </Toolbar>
 199             </div>
 200         );
 201     })
 202 );
 203
 204 export function selectedToArray(checkedList: TCheckedList): Array<string> {
 205     const arrayifiedSelectedList: Array<string> = [];
 206     for (const [key, value] of Object.entries(checkedList)) {
 207         if (value === true) {
 208             arrayifiedSelectedList.push(key);
 209         }
 210     }
 211     return arrayifiedSelectedList;
 212 }
 213
 214 export function selectedToKindSet(checkedList: TCheckedList, resources: ResourcesState = {}): Set<string> {
 215     const setifiedList = new Set<string>();
 216     for (const [key, value] of Object.entries(checkedList)) {
 217         if (value === true) {
 218             isGroupResource(key, resources) ? setifiedList.add(ContextMenuKind.GROUPS) : setifiedList.add(extractUuidKind(key) as string);
 219         }
 220     }
 221     return setifiedList;
 222 }
 223
 224 export const isGroupResource = (uuid: string, resources: ResourcesState): boolean => {
 225     const resource = getResource(uuid)(resources);
 226     if(!resource) return false;
 227     return resource.kind === ResourceKind.PROJECT && (resource as GroupResource).groupClass === GroupClass.ROLE;
 228 };
 229
 230 function groupByKind(checkedList: TCheckedList, resources: ResourcesState): Record<string, ContextMenuResource[]> {
 231     const result = {};
 232     selectedToArray(checkedList).forEach(uuid => {
 233         const resource = getResource(uuid)(resources) as ContainerRequestResource | Resource;
 234         const kind = isGroupResource(uuid, resources) ? ContextMenuKind.GROUPS : resource.kind;
 235         if (!result[kind]) result[kind] = [];
 236         result[kind].push(resource);
 237     });
 238     return result;
 239 }
 240
 241 function filterActions(actionArray: MultiSelectMenuActionSet, filters: Set<string>): Array<MultiSelectMenuAction> {
 242     return actionArray[0].filter(action => filters.has(action.name as string));
 243 }
 244
 245 const resourceToMsResourceKind = (uuid: string, resources: ResourcesState, user: User | null, readonly = false): (ContextMenuKind | ResourceKind) | undefined => {
 246     if (!user) return;
 247     const resource = getResourceWithEditableStatus<GroupResource & EditableResource>(uuid, user.uuid)(resources);
 248     const { isAdmin } = user;
 249     const kind = extractUuidKind(uuid);
 250
 251     const isFrozen = resource?.kind && resource.kind === ResourceKind.PROJECT ? resourceIsFrozen(resource, resources) : false;
 252     const isEditable = (user.isAdmin || (resource || ({} as EditableResource)).isEditable) && !readonly && !isFrozen;
 253
 254     switch (kind) {
 255         case ResourceKind.PROJECT:
 256             if (isFrozen) {
 257                 return isAdmin ? ContextMenuKind.FROZEN_PROJECT_ADMIN : ContextMenuKind.FROZEN_PROJECT;
 258             }
 259
 260             if (isAdmin && !readonly) {
 261                 if (resource?.groupClass === GroupClass.FILTER) {
 262                     return ContextMenuKind.FILTER_GROUP_ADMIN;
 263                 }
 264                 if (resource?.groupClass === GroupClass.ROLE) {
 265                     return ContextMenuKind.GROUPS;
 266                 }
 267                 return ContextMenuKind.PROJECT_ADMIN;
 268             }
 269
 270             return isEditable
 271                 ? resource && resource.groupClass !== GroupClass.FILTER
 272                     ? ContextMenuKind.PROJECT
 273                     : ContextMenuKind.FILTER_GROUP
 274                 : ContextMenuKind.READONLY_PROJECT;
 275         case ResourceKind.COLLECTION:
 276             const c = getResource<CollectionResource>(uuid)(resources);
 277             if (c === undefined) {
 278                 return;
 279             }
 280             const isOldVersion = c.uuid !== c.currentVersionUuid;
 281             const isTrashed = c.isTrashed;
 282             return isOldVersion
 283                 ? ContextMenuKind.OLD_VERSION_COLLECTION
 284                 : isTrashed && isEditable
 285                 ? ContextMenuKind.TRASHED_COLLECTION
 286                 : isAdmin && isEditable
 287                 ? ContextMenuKind.COLLECTION_ADMIN
 288                 : isEditable
 289                 ? ContextMenuKind.COLLECTION
 290                 : ContextMenuKind.READONLY_COLLECTION;
 291         case ResourceKind.PROCESS:
 292             return isAdmin && isEditable
 293                 ? resource && isProcessCancelable(getProcess(resource.uuid)(resources) as Process)
 294                     ? ContextMenuKind.RUNNING_PROCESS_ADMIN
 295                     : ContextMenuKind.PROCESS_ADMIN
 296                 : readonly
 297                 ? ContextMenuKind.READONLY_PROCESS_RESOURCE
 298                 : resource && isProcessCancelable(getProcess(resource.uuid)(resources) as Process)
 299                 ? ContextMenuKind.RUNNING_PROCESS_RESOURCE
 300                 : ContextMenuKind.PROCESS_RESOURCE;
 301         case ResourceKind.USER:
 302             return isAdmin ? ContextMenuKind.ROOT_PROJECT_ADMIN : ContextMenuKind.ROOT_PROJECT;
 303         case ResourceKind.LINK:
 304             return ContextMenuKind.LINK;
 305         case ResourceKind.WORKFLOW:
 306             return isEditable ? ContextMenuKind.WORKFLOW : ContextMenuKind.READONLY_WORKFLOW;
 307         default:
 308             return;
 309     }
 310 };
 311
 312 function selectActionsByKind(currentResourceKinds: Array<string>, filterSet: TMultiselectActionsFilters): MultiSelectMenuAction[] {
 313     const rawResult: Set<MultiSelectMenuAction> = new Set();
 314     const resultNames = new Set();
 315     const allFiltersArray: MultiSelectMenuAction[][] = []
 316     currentResourceKinds.forEach(kind => {
 317         if (filterSet[kind]) {
 318             const actions = filterActions(...filterSet[kind]);
 319             allFiltersArray.push(actions);
 320             actions.forEach(action => {
 321                 if (!resultNames.has(action.name)) {
 322                     rawResult.add(action);
 323                     resultNames.add(action.name);
 324                 }
 325             });
 326         }
 327     });
 328
 329     const filteredNameSet = allFiltersArray.map(filterArray => {
 330         const resultSet = new Set<string>();
 331         filterArray.forEach(action => resultSet.add(action.name as string || ""));
 332         return resultSet;
 333     });
 334
 335     const filteredResult = Array.from(rawResult).filter(action => {
 336         for (let i = 0; i < filteredNameSet.length; i++) {
 337             if (!filteredNameSet[i].has(action.name as string)) return false;
 338         }
 339         return true;
 340     });
 341
 342     return filteredResult;
 343 }
 344
 345
 346 //--------------------------------------------------//
 347
 348 function mapStateToProps({auth, multiselect, resources, favorites, publicFavorites, selectedResourceUuid}: RootState) {
 349     return {
 350         checkedList: multiselect.checkedList as TCheckedList,
 351         user: auth && auth.user ? auth.user : null,
 352         disabledButtons: new Set<string>(multiselect.disabledButtons),
 353         auth,
 354         selectedResourceUuid,
 355         location: window.location.pathname,
 356         iconProps: {
 357             resources,
 358             favorites,
 359             publicFavorites
 360         }
 361     }
 362 }
 363
 364 function mapDispatchToProps(dispatch: Dispatch) {
 365     return {
 366         executeMulti: (selectedAction: ContextMenuAction, checkedList: TCheckedList, resources: ResourcesState): void => {
 367             const kindGroups = groupByKind(checkedList, resources);
 368             const currentList = selectedToArray(checkedList)
 369             switch (selectedAction.name) {
 370                 case ContextMenuActionNames.MOVE_TO:
 371                 case ContextMenuActionNames.REMOVE:
 372                     const firstResourceKind = isGroupResource(currentList[0], resources)
 373                         ? ContextMenuKind.GROUPS
 374                         : (getResource(currentList[0])(resources) as ContainerRequestResource | Resource).kind;
 375                     const action = findActionByName(selectedAction.name as string, kindToActionSet[firstResourceKind]);
 376                     if (action) action.execute(dispatch, kindGroups[firstResourceKind]);
 377                     break;
 378                 case ContextMenuActionNames.COPY_LINK_TO_CLIPBOARD:
 379                     const selectedResources = currentList.map(uuid => getResource(uuid)(resources));
 380                     dispatch<any>(copyToClipboardAction(selectedResources));
 381                     break;
 382                 default:
 383                     for (const kind in kindGroups) {
 384                         const action = findActionByName(selectedAction.name as string, kindToActionSet[kind]);
 385                         if (action) action.execute(dispatch, kindGroups[kind]);
 386                     }
 387                     break;
 388             }
 389         },
 390     };
 391 }