src/components/collection-panel-files/collection-panel-files.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 classNames from 'classnames';
   7 import { connect } from 'react-redux';
   8 import { FixedSizeList } from "react-window";
   9 import AutoSizer from "react-virtualized-auto-sizer";
  10 import servicesProvider from 'common/service-provider';
  11 import { CustomizeTableIcon, DownloadIcon, MoreOptionsIcon } from 'components/icon/icon';
  12 import { SearchInput } from 'components/search-input/search-input';
  13 import {
  14     ListItemIcon,
  15     StyleRulesCallback,
  16     Theme,
  17     WithStyles,
  18     withStyles,
  19     Tooltip,
  20     IconButton,
  21     Checkbox,
  22     CircularProgress,
  23     Button,
  24 } from '@material-ui/core';
  25 import { FileTreeData } from '../file-tree/file-tree-data';
  26 import { TreeItem, TreeItemStatus } from '../tree/tree';
  27 import { RootState } from 'store/store';
  28 import { WebDAV, WebDAVRequestConfig } from 'common/webdav';
  29 import { AuthState } from 'store/auth/auth-reducer';
  30 import { extractFilesData } from 'services/collection-service/collection-service-files-response';
  31 import {
  32     DefaultIcon,
  33     DirectoryIcon,
  34     FileIcon,
  35     BackIcon,
  36     SidePanelRightArrowIcon
  37 } from 'components/icon/icon';
  38 import { setCollectionFiles } from 'store/collection-panel/collection-panel-files/collection-panel-files-actions';
  39 import { sortBy } from 'lodash';
  40 import { formatFileSize } from 'common/formatters';
  41 import { getInlineFileUrl, sanitizeToken } from 'views-components/context-menu/actions/helpers';
  42
  43 export interface CollectionPanelFilesProps {
  44     isWritable: boolean;
  45     onUploadDataClick: (targetLocation?: string) => void;
  46     onSearchChange: (searchValue: string) => void;
  47     onItemMenuOpen: (event: React.MouseEvent<HTMLElement>, item: TreeItem<FileTreeData>, isWritable: boolean) => void;
  48     onOptionsMenuOpen: (event: React.MouseEvent<HTMLElement>, isWritable: boolean) => void;
  49     onSelectionToggle: (event: React.MouseEvent<HTMLElement>, item: TreeItem<FileTreeData>) => void;
  50     onCollapseToggle: (id: string, status: TreeItemStatus) => void;
  51     onFileClick: (id: string) => void;
  52     currentItemUuid: any;
  53     dispatch: Function;
  54     collectionPanelFiles: any;
  55     collectionPanel: any;
  56 }
  57
  58 type CssRules = "backButton"
  59     | "backButtonHidden"
  60     | "pathPanelPathWrapper"
  61     | "uploadButton"
  62     | "uploadIcon"
  63     | "moreOptionsButton"
  64     | "moreOptions"
  65     | "loader"
  66     | "wrapper"
  67     | "dataWrapper"
  68     | "row"
  69     | "rowEmpty"
  70     | "leftPanel"
  71     | "rightPanel"
  72     | "pathPanel"
  73     | "pathPanelItem"
  74     | "rowName"
  75     | "listItemIcon"
  76     | "rowActive"
  77     | "pathPanelMenu"
  78     | "rowSelection"
  79     | "leftPanelHidden"
  80     | "leftPanelVisible"
  81     | "searchWrapper"
  82     | "searchWrapperHidden";
  83
  84 const styles: StyleRulesCallback<CssRules> = (theme: Theme) => ({
  85     wrapper: {
  86         display: 'flex',
  87         minHeight: '600px',
  88         color: 'rgba(0,0,0,0.87)',
  89         fontSize: '0.875rem',
  90         fontFamily: '"Roboto", "Helvetica", "Arial", sans-serif',
  91         fontWeight: 400,
  92         lineHeight: '1.5',
  93         letterSpacing: '0.01071em'
  94     },
  95     backButton: {
  96         color: '#00bfa5',
  97         cursor: 'pointer',
  98         float: 'left',
  99     },
 100     backButtonHidden: {
 101         display: 'none',
 102     },
 103     dataWrapper: {
 104         minHeight: '500px'
 105     },
 106     row: {
 107         display: 'flex',
 108         marginTop: '0.5rem',
 109         marginBottom: '0.5rem',
 110         cursor: 'pointer',
 111         "&:hover": {
 112             backgroundColor: 'rgba(0, 0, 0, 0.08)',
 113         }
 114     },
 115     rowEmpty: {
 116         top: '40%',
 117         width: '100%',
 118         textAlign: 'center',
 119         position: 'absolute'
 120     },
 121     loader: {
 122         top: '50%',
 123         left: '50%',
 124         marginTop: '-15px',
 125         marginLeft: '-15px',
 126         position: 'absolute'
 127     },
 128     rowName: {
 129         display: 'inline-flex',
 130         flexDirection: 'column',
 131         justifyContent: 'center'
 132     },
 133     searchWrapper: {
 134         display: 'inline-block',
 135         marginBottom: '1rem',
 136         marginLeft: '1rem',
 137     },
 138     searchWrapperHidden: {
 139         width: '0px'
 140     },
 141     rowSelection: {
 142         padding: '0px',
 143     },
 144     rowActive: {
 145         color: `${theme.palette.primary.main} !important`,
 146     },
 147     listItemIcon: {
 148         display: 'inline-flex',
 149         flexDirection: 'column',
 150         justifyContent: 'center'
 151     },
 152     pathPanelMenu: {
 153         float: 'right',
 154         marginTop: '-15px',
 155     },
 156     pathPanel: {
 157         padding: '0.5rem',
 158         marginBottom: '0.5rem',
 159         backgroundColor: '#fff',
 160         boxShadow: '0px 1px 3px 0px rgb(0 0 0 / 20%), 0px 1px 1px 0px rgb(0 0 0 / 14%), 0px 2px 1px -1px rgb(0 0 0 / 12%)',
 161     },
 162     pathPanelPathWrapper: {
 163         display: 'inline-block',
 164     },
 165     leftPanel: {
 166         flex: 0,
 167         padding: '0 1rem 1rem',
 168         marginRight: '1rem',
 169         whiteSpace: 'nowrap',
 170         position: 'relative',
 171         backgroundColor: '#fff',
 172         boxShadow: '0px 3px 3px 0px rgb(0 0 0 / 20%), 0px 3px 1px 0px rgb(0 0 0 / 14%), 0px 3px 1px -1px rgb(0 0 0 / 12%)',
 173     },
 174     leftPanelVisible: {
 175         opacity: 1,
 176         flex: '50%',
 177         animation: `animateVisible 1000ms ${theme.transitions.easing.easeOut}`
 178     },
 179     leftPanelHidden: {
 180         opacity: 0,
 181         flex: 'initial',
 182         padding: '0',
 183         marginRight: '0',
 184     },
 185     "@keyframes animateVisible": {
 186         "0%": {
 187             opacity: 0,
 188             flex: 'initial',
 189         },
 190         "100%": {
 191             opacity: 1,
 192             flex: '50%',
 193         }
 194     },
 195     rightPanel: {
 196         flex: '50%',
 197         padding: '1rem',
 198         paddingTop: '0.5rem',
 199         marginTop: '-0.5rem',
 200         position: 'relative',
 201         backgroundColor: '#fff',
 202         boxShadow: '0px 3px 3px 0px rgb(0 0 0 / 20%), 0px 3px 1px 0px rgb(0 0 0 / 14%), 0px 3px 1px -1px rgb(0 0 0 / 12%)',
 203     },
 204     pathPanelItem: {
 205         cursor: 'pointer',
 206     },
 207     uploadIcon: {
 208         transform: 'rotate(180deg)'
 209     },
 210     uploadButton: {
 211         float: 'right',
 212     },
 213     moreOptionsButton: {
 214         width: theme.spacing.unit * 3,
 215         height: theme.spacing.unit * 3,
 216         marginRight: theme.spacing.unit,
 217         marginTop: 'auto',
 218         marginBottom: 'auto',
 219         justifyContent: 'center',
 220     },
 221     moreOptions: {
 222         position: 'absolute'
 223     },
 224 });
 225
 226 const pathPromise = {};
 227
 228 export const CollectionPanelFiles = withStyles(styles)(connect((state: RootState) => ({
 229     auth: state.auth,
 230     collectionPanel: state.collectionPanel,
 231     collectionPanelFiles: state.collectionPanelFiles,
 232 }))((props: CollectionPanelFilesProps & WithStyles<CssRules> & { auth: AuthState }) => {
 233     const { classes, onItemMenuOpen, onUploadDataClick, isWritable, dispatch, collectionPanelFiles, collectionPanel } = props;
 234     const { apiToken, config } = props.auth;
 235
 236     const webdavClient = new WebDAV({
 237         baseURL: config.keepWebServiceUrl,
 238         headers: {
 239             Authorization: `Bearer ${apiToken}`
 240         },
 241     });
 242
 243     const webDAVRequestConfig: WebDAVRequestConfig = {
 244         headers: {
 245             Depth: '1',
 246         },
 247     };
 248
 249     const parentRef = React.useRef(null);
 250     const [path, setPath] = React.useState<string[]>([]);
 251     const [pathData, setPathData] = React.useState({});
 252     const [isLoading, setIsLoading] = React.useState(false);
 253     const [leftSearch, setLeftSearch] = React.useState('');
 254     const [rightSearch, setRightSearch] = React.useState('');
 255
 256     const leftKey = (path.length > 1 ? path.slice(0, path.length - 1) : path).join('/');
 257     const rightKey = path.join('/');
 258
 259     const leftData = pathData[leftKey] || [];
 260     const rightData = pathData[rightKey];
 261
 262     React.useEffect(() => {
 263         if (props.currentItemUuid) {
 264             setPathData({});
 265             setPath([props.currentItemUuid]);
 266         }
 267     }, [props.currentItemUuid]);
 268
 269     const fetchData = (keys, ignoreCache = false) => {
 270         const keyArray = Array.isArray(keys) ? keys : [keys];
 271
 272         Promise.all(keyArray.filter(key => !!key)
 273             .map((key) => {
 274                 const dataExists = !!pathData[key];
 275                 const runningRequest = pathPromise[key];
 276
 277                 if (ignoreCache || (!dataExists && !runningRequest)) {
 278                     if (!isLoading) {
 279                         setIsLoading(true);
 280                     }
 281
 282                     pathPromise[key] = true;
 283
 284                     return webdavClient.propfind(`c=${key}`, webDAVRequestConfig);
 285                 }
 286
 287                 return Promise.resolve(null);
 288             })
 289             .filter((promise) => !!promise)
 290         )
 291         .then((requests) => {
 292             const newState = requests.map((request, index) => {
 293                 if (request && request.responseXML != null) {
 294                     const key = keyArray[index];
 295                     const result: any = extractFilesData(request.responseXML);
 296                     const sortedResult = sortBy(result, (n) => n.name).sort((n1, n2) => {
 297                         if (n1.type === 'directory' && n2.type !== 'directory') {
 298                             return -1;
 299                         }
 300                         if (n1.type !== 'directory' && n2.type === 'directory') {
 301                             return 1;
 302                         }
 303                         return 0;
 304                     });
 305
 306                     return { [key]: sortedResult };
 307                 }
 308                 return {};
 309             }).reduce((prev, next) => {
 310                 return { ...next, ...prev };
 311             }, {});
 312
 313             setPathData({ ...pathData, ...newState });
 314         })
 315         .finally(() => {
 316             setIsLoading(false);
 317             keyArray.forEach(key => delete pathPromise[key]);
 318         });
 319     };
 320
 321     React.useEffect(() => {
 322         if (rightKey) {
 323             fetchData(rightKey);
 324             setLeftSearch('');
 325             setRightSearch('');
 326         }
 327     }, [rightKey]); // eslint-disable-line react-hooks/exhaustive-deps
 328
 329     const currentPDH = (collectionPanel.item || {}).portableDataHash;
 330     React.useEffect(() => {
 331         if (currentPDH) {
 332             fetchData([leftKey, rightKey], true);
 333         }
 334     }, [currentPDH]); // eslint-disable-line react-hooks/exhaustive-deps
 335
 336     React.useEffect(() => {
 337         if (rightData) {
 338             const filtered = rightData.filter(({ name }) => name.indexOf(rightSearch) > -1);
 339             setCollectionFiles(filtered, false)(dispatch);
 340         }
 341     }, [rightData, dispatch, rightSearch]);
 342
 343     const handleRightClick = React.useCallback(
 344         (event) => {
 345             event.preventDefault();
 346             let elem = event.target;
 347
 348             while (elem && elem.dataset && !elem.dataset.item) {
 349                 elem = elem.parentNode;
 350             }
 351
 352             if (!elem || !elem.dataset) {
 353                 return;
 354             }
 355
 356             const { id } = elem.dataset;
 357
 358             const item: any = {
 359                 id,
 360                 data: rightData.find((elem) => elem.id === id),
 361             };
 362
 363             if (id) {
 364                 onItemMenuOpen(event, item, isWritable);
 365             }
 366         },
 367         [onItemMenuOpen, isWritable, rightData]);
 368
 369     React.useEffect(() => {
 370         let node = null;
 371
 372         if (parentRef?.current) {
 373             node = parentRef.current;
 374             (node as any).addEventListener('contextmenu', handleRightClick);
 375         }
 376
 377         return () => {
 378             if (node) {
 379                 (node as any).removeEventListener('contextmenu', handleRightClick);
 380             }
 381         };
 382     }, [parentRef, handleRightClick]);
 383
 384     const handleClick = React.useCallback(
 385         (event: any) => {
 386             let isCheckbox = false;
 387             let isMoreButton = false;
 388             let elem = event.target;
 389
 390             if (elem.type === 'checkbox') {
 391                 isCheckbox = true;
 392             }
 393             // The "More options" button click event could be triggered on its
 394             // internal graphic element.
 395             else if ((elem.dataset && elem.dataset.id === 'moreOptions') || (elem.parentNode && elem.parentNode.dataset && elem.parentNode.dataset.id === 'moreOptions')) {
 396                 isMoreButton = true;
 397             }
 398
 399             while (elem && elem.dataset && !elem.dataset.item) {
 400                 elem = elem.parentNode;
 401             }
 402
 403             if (elem && elem.dataset && !isCheckbox && !isMoreButton) {
 404                 const { parentPath, subfolderPath, breadcrumbPath, type } = elem.dataset;
 405
 406                 if (breadcrumbPath) {
 407                     const index = path.indexOf(breadcrumbPath);
 408                     setPath([...path.slice(0, index + 1)]);
 409                 }
 410
 411                 if (parentPath && type === 'directory') {
 412                     if (path.length > 1) {
 413                         path.pop()
 414                     }
 415
 416                     setPath([...path, parentPath]);
 417                 }
 418
 419                 if (subfolderPath && type === 'directory') {
 420                     setPath([...path, subfolderPath]);
 421                 }
 422
 423                 if (elem.dataset.id && type === 'file') {
 424                     const item = rightData.find(({id}) => id === elem.dataset.id) || leftData.find(({ id }) => id === elem.dataset.id);
 425                     const enhancedItem = servicesProvider.getServices().collectionService.extendFileURL(item);
 426                     const fileUrl = sanitizeToken(getInlineFileUrl(enhancedItem.url, config.keepWebServiceUrl, config.keepWebInlineServiceUrl), true);
 427                     window.open(fileUrl, '_blank');
 428                 }
 429             }
 430
 431             if (isCheckbox) {
 432                 const { id } = elem.dataset;
 433                 const item = collectionPanelFiles[id];
 434                 props.onSelectionToggle(event, item);
 435             }
 436             if (isMoreButton) {
 437                 const { id } = elem.dataset;
 438                 const item: any = {
 439                     id,
 440                     data: rightData.find((elem) => elem.id === id),
 441                 };
 442                 onItemMenuOpen(event, item, isWritable);
 443             }
 444         },
 445         [path, setPath, collectionPanelFiles] // eslint-disable-line react-hooks/exhaustive-deps
 446     );
 447
 448     const getItemIcon = React.useCallback(
 449         (type: string, activeClass: string | null) => {
 450             let Icon = DefaultIcon;
 451
 452             switch (type) {
 453                 case 'directory':
 454                     Icon = DirectoryIcon;
 455                     break;
 456                 case 'file':
 457                     Icon = FileIcon;
 458                     break;
 459             }
 460
 461             return (
 462                 <ListItemIcon className={classNames(classes.listItemIcon, activeClass)}>
 463                     <Icon />
 464                 </ListItemIcon>
 465             )
 466         },
 467         [classes]
 468     );
 469
 470     const getActiveClass = React.useCallback(
 471         (name) => {
 472             return path[path.length - 1] === name ? classes.rowActive : null;
 473         },
 474         [path, classes]
 475     );
 476
 477     const onOptionsMenuOpen = React.useCallback(
 478         (ev, isWritable) => {
 479             props.onOptionsMenuOpen(ev, isWritable);
 480         },
 481         [props.onOptionsMenuOpen] // eslint-disable-line react-hooks/exhaustive-deps
 482     );
 483
 484     return <div data-cy="collection-files-panel" onClick={handleClick} ref={parentRef}>
 485         <div className={classes.pathPanel}>
 486             <div className={classes.pathPanelPathWrapper}>
 487             { path.map( (p: string, index: number) =>
 488                 <span key={`${index}-${p}`} data-item="true"
 489                 className={classes.pathPanelItem} data-breadcrumb-path={p}>
 490                     <span className={classes.rowActive}>{index === 0 ? 'Home' : p}</span> <b>/</b>&nbsp;
 491                 </span>)
 492             }
 493             </div>
 494             <Tooltip className={classes.pathPanelMenu} title="More options" disableFocusListener>
 495                 <IconButton data-cy='collection-files-panel-options-btn'
 496                     onClick={(ev) => {
 497                         onOptionsMenuOpen(ev, isWritable);
 498                     }}>
 499                     <CustomizeTableIcon />
 500                 </IconButton>
 501             </Tooltip>
 502         </div>
 503         <div className={classes.wrapper}>
 504             <div className={classNames(classes.leftPanel, path.length > 1 ? classes.leftPanelVisible : classes.leftPanelHidden)} data-cy="collection-files-left-panel">
 505                 <Tooltip title="Go back" className={path.length > 1 ? classes.backButton : classes.backButtonHidden}>
 506                     <IconButton onClick={() => setPath([...path.slice(0, path.length -1)])}>
 507                         <BackIcon />
 508                     </IconButton>
 509                 </Tooltip>
 510                 <div className={path.length > 1 ? classes.searchWrapper : classes.searchWrapperHidden}>
 511                     <SearchInput selfClearProp={leftKey} label="Search" value={leftSearch} onSearch={setLeftSearch} />
 512                 </div>
 513                 <div className={classes.dataWrapper}>{ leftData
 514                 ? <AutoSizer defaultWidth={0}>{({ height, width }) => {
 515                     const filtered = leftData.filter(({ name }) => name.indexOf(leftSearch) > -1);
 516                     return !!filtered.length
 517                     ? <FixedSizeList height={height} itemCount={filtered.length}
 518                         itemSize={35} width={width}>{ ({ index, style }) => {
 519                         const { id, type, name } = filtered[index];
 520                         return <div data-id={id} style={style} data-item="true"
 521                             data-type={type} data-parent-path={name}
 522                             className={classNames(classes.row, getActiveClass(name))}
 523                             key={id}>
 524                                 { getItemIcon(type, getActiveClass(name)) }
 525                                 <div className={classes.rowName}>
 526                                     {name}
 527                                 </div>
 528                                 { getActiveClass(name)
 529                                 ? <SidePanelRightArrowIcon
 530                                     style={{ display: 'inline', marginTop: '5px', marginLeft: '5px' }} />
 531                                 : null
 532                                 }
 533                         </div>;
 534                     }}</FixedSizeList>
 535                     : <div className={classes.rowEmpty}>No directories available</div>
 536                     }}
 537                 </AutoSizer>
 538                 : <div data-cy="collection-loader" className={classes.row}><CircularProgress className={classes.loader} size={30} /></div> }
 539                 </div>
 540             </div>
 541             <div className={classes.rightPanel} data-cy="collection-files-right-panel">
 542                 <div className={classes.searchWrapper}>
 543                     <SearchInput selfClearProp={rightKey} label="Search" value={rightSearch} onSearch={setRightSearch} />
 544                 </div>
 545                 { isWritable &&
 546                 <Button className={classes.uploadButton} data-cy='upload-button'
 547                     onClick={() => {
 548                         onUploadDataClick(rightKey === leftKey ? undefined : rightKey);
 549                     }}
 550                     variant='contained' color='primary' size='small'>
 551                     <DownloadIcon className={classes.uploadIcon} />
 552                     Upload data
 553                 </Button> }
 554                 <div className={classes.dataWrapper}>{ rightData && !isLoading
 555                     ? <AutoSizer defaultHeight={500}>{({ height, width }) => {
 556                         const filtered = rightData.filter(({ name }) => name.indexOf(rightSearch) > -1);
 557                         return !!filtered.length
 558                         ? <FixedSizeList height={height} itemCount={filtered.length}
 559                             itemSize={35} width={width}>{ ({ index, style }) => {
 560                                 const { id, type, name, size } = filtered[index];
 561
 562                                 return <div style={style} data-id={id} data-item="true"
 563                                     data-type={type} data-subfolder-path={name}
 564                                     className={classes.row} key={id}>
 565                                     <Checkbox color="primary"
 566                                         className={classes.rowSelection}
 567                                         checked={collectionPanelFiles[id] ? collectionPanelFiles[id].value.selected : false}
 568                                     />&nbsp;
 569                                     {getItemIcon(type, null)}
 570                                     <div className={classes.rowName}>
 571                                         {name}
 572                                     </div>
 573                                     <span className={classes.rowName} style={{
 574                                         marginLeft: 'auto', marginRight: '1rem' }}>
 575                                         { formatFileSize(size) }
 576                                     </span>
 577                                     <Tooltip title="More options" disableFocusListener>
 578                                         <IconButton data-id='moreOptions'
 579                                             data-cy='file-item-options-btn'
 580                                             className={classes.moreOptionsButton}>
 581                                             <MoreOptionsIcon
 582                                                 data-id='moreOptions'
 583                                                 className={classes.moreOptions} />
 584                                         </IconButton>
 585                                     </Tooltip>
 586                                 </div>
 587                             } }</FixedSizeList>
 588                         : <div className={classes.rowEmpty}>This collection is empty</div>
 589                     }}</AutoSizer>
 590                     : <div className={classes.row}>
 591                         <CircularProgress className={classes.loader} size={30} />
 592                     </div> }
 593                 </div>
 594             </div>
 595         </div>
 596     </div>}));