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