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, { useEffect, useState } from "react";
   6 import { connect } from "react-redux";
   7 import { StyleRulesCallback, withStyles, WithStyles, Toolbar, Tooltip, IconButton } from "@material-ui/core";
   8 import { ArvadosTheme } from "common/custom-theme";
   9 import { RootState } from "store/store";
  10 import { Dispatch } from "redux";
  11 import { TCheckedList } from "components/data-table/data-table";
  12 import { ContextMenuResource } from "store/context-menu/context-menu-actions";
  13 import { Resource, ResourceKind, extractUuidKind } from "models/resource";
  14 import { getResource } from "store/resources/resources";
  15 import { ResourcesState } from "store/resources/resources";
  16 import { MultiSelectMenuAction, MultiSelectMenuActionSet } from "views-components/multiselect-toolbar/ms-menu-actions";
  17 import { MultiSelectMenuActionNames } from "views-components/multiselect-toolbar/ms-menu-actions";
  18 import { ContextMenuAction } from "views-components/context-menu/context-menu-action-set";
  19 import { multiselectActionsFilters, TMultiselectActionsFilters, msMenuResourceKind } from "./ms-toolbar-action-filters";
  20 import { kindToActionSet, findActionByName } from "./ms-kind-action-differentiator";
  21 import { msToggleTrashAction } from "views-components/multiselect-toolbar/ms-project-action-set";
  22 import { copyToClipboardAction } from "store/open-in-new-tab/open-in-new-tab.actions";
  23 import { ContainerRequestResource } from "models/container-request";
  24 import { FavoritesState } from "store/favorites/favorites-reducer";
  25 import { resourceIsFrozen } from "common/frozen-resources";
  26 import { getResourceWithEditableStatus } from "store/resources/resources";
  27 import { GroupResource } from "models/group";
  28 import { EditableResource } from "models/resource";
  29 import { User } from "models/user";
  30 import { GroupClass } from "models/group";
  31 import { isProcessCancelable } from "store/processes/process";
  32 import { CollectionResource } from "models/collection";
  33 import { getProcess } from "store/processes/process";
  34 import { Process } from "store/processes/process";
  35 import { PublicFavoritesState } from "store/public-favorites/public-favorites-reducer";
  36 import { AuthState } from "store/auth/auth-reducer";
  37 import { IntersectionObserverWrapper } from "./ms-toolbar-overflow-wrapper";
  38
  39 const WIDTH_TRANSITION = 150
  40
  41 type CssRules = "root" | "transition" | "button" | "iconContainer" | "icon";
  42
  43 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  44     root: {
  45         display: "flex",
  46         flexDirection: "row",
  47         width: 0,
  48         height: '2.7rem',
  49         padding: 0,
  50         marginBottom: '-0.5rem',
  51         transition: `width ${WIDTH_TRANSITION}ms`,
  52         overflow: 'hidden',
  53     },
  54     transition: {
  55         display: "flex",
  56         flexDirection: "row",
  57         height: '2.7rem',
  58         padding: 0,
  59         marginBottom: '-0.5rem',
  60         overflow: 'hidden',
  61         transition: `width ${WIDTH_TRANSITION}ms`,
  62     },
  63     button: {
  64         width: "2.5rem",
  65         height: "2.5rem ",
  66         paddingLeft: 0,
  67         border: "1px solid transparent",
  68     },
  69     iconContainer: {
  70         height: '100%',
  71     },
  72     icon: {
  73         marginLeft: '-0.5rem',
  74     }
  75 });
  76
  77 export type MultiselectToolbarProps = {
  78     checkedList: TCheckedList;
  79     selectedResourceUuid: string | null;
  80     iconProps: IconProps
  81     user: User | null
  82     disabledButtons: Set<string>
  83     auth: AuthState;
  84     location: string;
  85     isSubPanel?: boolean;
  86     executeMulti: (action: ContextMenuAction | MultiSelectMenuAction, checkedList: TCheckedList, resources: ResourcesState) => void;
  87 };
  88
  89 type IconProps = {
  90     resources: ResourcesState;
  91     favorites: FavoritesState;
  92     publicFavorites: PublicFavoritesState;
  93 }
  94
  95 const disallowedPaths = [
  96     "/favorites",
  97     "/public-favorites",
  98     "/trash",
  99     "/group",
 100 ]
 101
 102 const isPathDisallowed = (location: string): boolean => {
 103     return disallowedPaths.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, isSubPanel } = props;
 112         const selectedResourceUuid = isPathDisallowed(location) ? null : props.selectedResourceUuid;
 113         const singleResourceKind = selectedResourceUuid && !isSubPanel ? [resourceToMsResourceKind(selectedResourceUuid, iconProps.resources, user)] : null
 114         const currentResourceKinds = singleResourceKind ? singleResourceKind : Array.from(selectedToKindSet(checkedList));
 115         const currentPathIsTrash = location.includes("/trash");
 116         const [isTransitioning, setIsTransitioning] = useState(false);
 117         let transitionTimeout;
 118
 119         const handleTransition = () => {
 120             setIsTransitioning(true)
 121             transitionTimeout = setTimeout(() => {
 122                 setIsTransitioning(false)
 123             }, WIDTH_TRANSITION);
 124         }
 125
 126         useEffect(()=>{
 127                 handleTransition()
 128                 return () => {
 129                     if(transitionTimeout) clearTimeout(transitionTimeout)
 130                 };
 131             // eslint-disable-next-line
 132         }, [checkedList])
 133
 134         const actions =
 135             currentPathIsTrash && selectedToKindSet(checkedList).size
 136                 ? [msToggleTrashAction]
 137                 : selectActionsByKind(currentResourceKinds as string[], multiselectActionsFilters).filter((action) =>
 138                         selectedResourceUuid === null ? action.isForMulti : true
 139                     );
 140
 141         const targetResources = selectedResourceUuid ? {[selectedResourceUuid]: true} as TCheckedList : checkedList
 142
 143         return (
 144             <React.Fragment>
 145                 <Toolbar
 146                     className={isTransitioning ? classes.transition: classes.root}
 147                     style={{ width: `${(actions.length * 2.5) + 3}rem`}}
 148                     data-cy='multiselect-toolbar'
 149                     >
 150                     {actions.length ? (
 151                         <IntersectionObserverWrapper menuLength={actions.length}>
 152                             {actions.map((action, i) =>{
 153                                 const { hasAlts, useAlts, name, altName, icon, altIcon } = action;
 154                             return 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                                         >
 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                                         >
 188                                             {action.icon({})}
 189                                         </IconButton>
 190                                     </span>
 191                                 </Tooltip>
 192                             );
 193                             })}
 194                         </IntersectionObserverWrapper>
 195                     ) : (
 196                         <></>
 197                     )}
 198                 </Toolbar>
 199             </React.Fragment>
 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): Set<string> {
 215     const setifiedList = new Set<string>();
 216     for (const [key, value] of Object.entries(checkedList)) {
 217         if (value === true) {
 218             setifiedList.add(extractUuidKind(key) as string);
 219         }
 220     }
 221     return setifiedList;
 222 }
 223
 224 function groupByKind(checkedList: TCheckedList, resources: ResourcesState): Record<string, ContextMenuResource[]> {
 225     const result = {};
 226     selectedToArray(checkedList).forEach(uuid => {
 227         const resource = getResource(uuid)(resources) as ContainerRequestResource | Resource;
 228         if (!result[resource.kind]) result[resource.kind] = [];
 229         result[resource.kind].push(resource);
 230     });
 231     return result;
 232 }
 233
 234 function filterActions(actionArray: MultiSelectMenuActionSet, filters: Set<string>): Array<MultiSelectMenuAction> {
 235     return actionArray[0].filter(action => filters.has(action.name as string));
 236 }
 237
 238 const resourceToMsResourceKind = (uuid: string, resources: ResourcesState, user: User | null, readonly = false): (msMenuResourceKind | ResourceKind) | undefined => {
 239     if (!user) return;
 240     const resource = getResourceWithEditableStatus<GroupResource & EditableResource>(uuid, user.uuid)(resources);
 241     const { isAdmin } = user;
 242     const kind = extractUuidKind(uuid);
 243
 244     const isFrozen = resource?.kind && resource.kind === ResourceKind.PROJECT ? resourceIsFrozen(resource, resources) : false;
 245     const isEditable = (user.isAdmin || (resource || ({} as EditableResource)).isEditable) && !readonly && !isFrozen;
 246
 247     switch (kind) {
 248         case ResourceKind.PROJECT:
 249             if (isFrozen) {
 250                 return isAdmin ? msMenuResourceKind.FROZEN_PROJECT_ADMIN : msMenuResourceKind.FROZEN_PROJECT;
 251             }
 252
 253             return isAdmin && !readonly
 254                 ? resource && resource.groupClass !== GroupClass.FILTER
 255                     ? msMenuResourceKind.PROJECT_ADMIN
 256                     : msMenuResourceKind.FILTER_GROUP_ADMIN
 257                 : isEditable
 258                 ? resource && resource.groupClass !== GroupClass.FILTER
 259                     ? msMenuResourceKind.PROJECT
 260                     : msMenuResourceKind.FILTER_GROUP
 261                 : msMenuResourceKind.READONLY_PROJECT;
 262         case ResourceKind.COLLECTION:
 263             const c = getResource<CollectionResource>(uuid)(resources);
 264             if (c === undefined) {
 265                 return;
 266             }
 267             const isOldVersion = c.uuid !== c.currentVersionUuid;
 268             const isTrashed = c.isTrashed;
 269             return isOldVersion
 270                 ? msMenuResourceKind.OLD_VERSION_COLLECTION
 271                 : isTrashed && isEditable
 272                 ? msMenuResourceKind.TRASHED_COLLECTION
 273                 : isAdmin && isEditable
 274                 ? msMenuResourceKind.COLLECTION_ADMIN
 275                 : isEditable
 276                 ? msMenuResourceKind.COLLECTION
 277                 : msMenuResourceKind.READONLY_COLLECTION;
 278         case ResourceKind.PROCESS:
 279             return isAdmin && isEditable
 280                 ? resource && isProcessCancelable(getProcess(resource.uuid)(resources) as Process)
 281                     ? msMenuResourceKind.RUNNING_PROCESS_ADMIN
 282                     : msMenuResourceKind.PROCESS_ADMIN
 283                 : readonly
 284                 ? msMenuResourceKind.READONLY_PROCESS_RESOURCE
 285                 : resource && isProcessCancelable(getProcess(resource.uuid)(resources) as Process)
 286                 ? msMenuResourceKind.RUNNING_PROCESS_RESOURCE
 287                 : msMenuResourceKind.PROCESS_RESOURCE;
 288         case ResourceKind.USER:
 289             return isAdmin ? msMenuResourceKind.ROOT_PROJECT_ADMIN : msMenuResourceKind.ROOT_PROJECT;
 290         case ResourceKind.LINK:
 291             return msMenuResourceKind.LINK;
 292         case ResourceKind.WORKFLOW:
 293             return isEditable ? msMenuResourceKind.WORKFLOW : msMenuResourceKind.READONLY_WORKFLOW;
 294         default:
 295             return;
 296     }
 297 };
 298
 299 function selectActionsByKind(currentResourceKinds: Array<string>, filterSet: TMultiselectActionsFilters) {
 300     const rawResult: Set<MultiSelectMenuAction> = new Set();
 301     const resultNames = new Set();
 302     const allFiltersArray: MultiSelectMenuAction[][] = []
 303     currentResourceKinds.forEach(kind => {
 304         if (filterSet[kind]) {
 305             const actions = filterActions(...filterSet[kind]);
 306             allFiltersArray.push(actions);
 307             actions.forEach(action => {
 308                 if (!resultNames.has(action.name)) {
 309                     rawResult.add(action);
 310                     resultNames.add(action.name);
 311                 }
 312             });
 313         }
 314     });
 315
 316     const filteredNameSet = allFiltersArray.map(filterArray => {
 317         const resultSet = new Set<string>();
 318         filterArray.forEach(action => resultSet.add(action.name as string || ""));
 319         return resultSet;
 320     });
 321
 322     const filteredResult = Array.from(rawResult).filter(action => {
 323         for (let i = 0; i < filteredNameSet.length; i++) {
 324             if (!filteredNameSet[i].has(action.name as string)) return false;
 325         }
 326         return true;
 327     });
 328
 329     return filteredResult.sort((a, b) => {
 330         const nameA = a.name || "";
 331         const nameB = b.name || "";
 332         if (nameA < nameB) {
 333             return -1;
 334         }
 335         if (nameA > nameB) {
 336             return 1;
 337         }
 338         return 0;
 339     });
 340 }
 341
 342
 343 //--------------------------------------------------//
 344
 345 function mapStateToProps({auth, multiselect, resources, favorites, publicFavorites, selectedResourceUuid}: RootState) {
 346     return {
 347         checkedList: multiselect.checkedList as TCheckedList,
 348         user: auth && auth.user ? auth.user : null,
 349         disabledButtons: new Set<string>(multiselect.disabledButtons),
 350         auth,
 351         selectedResourceUuid,
 352         location: window.location.pathname,
 353         iconProps: {
 354             resources,
 355             favorites,
 356             publicFavorites
 357         }
 358     }
 359 }
 360
 361 function mapDispatchToProps(dispatch: Dispatch) {
 362     return {
 363         executeMulti: (selectedAction: ContextMenuAction, checkedList: TCheckedList, resources: ResourcesState): void => {
 364             const kindGroups = groupByKind(checkedList, resources);
 365             const currentList = selectedToArray(checkedList)
 366             switch (selectedAction.name) {
 367                 case MultiSelectMenuActionNames.MOVE_TO:
 368                 case MultiSelectMenuActionNames.REMOVE:
 369                     const firstResource = getResource(currentList[0])(resources) as ContainerRequestResource | Resource;
 370                     const action = findActionByName(selectedAction.name as string, kindToActionSet[firstResource.kind]);
 371                     if (action) action.execute(dispatch, kindGroups[firstResource.kind]);
 372                     break;
 373                 case MultiSelectMenuActionNames.COPY_TO_CLIPBOARD:
 374                     const selectedResources = currentList.map(uuid => getResource(uuid)(resources));
 375                     dispatch<any>(copyToClipboardAction(selectedResources));
 376                     break;
 377                 default:
 378                     for (const kind in kindGroups) {
 379                         const action = findActionByName(selectedAction.name as string, kindToActionSet[kind]);
 380                         if (action) action.execute(dispatch, kindGroups[kind]);
 381                     }
 382                     break;
 383             }
 384         },
 385     };
 386 }