src/routes/routes.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { matchPath } from 'react-router';
   6 import { ResourceKind, RESOURCE_UUID_PATTERN, extractUuidKind, COLLECTION_PDH_REGEX } from '~/models/resource';
   7 import { getProjectUrl } from '~/models/project';
   8 import { getCollectionUrl } from '~/models/collection';
   9 import { Config } from '~/common/config';
  10 import { Session } from "~/models/session";
  11
  12 export interface FederationConfig {
  13     localCluster: string;
  14     remoteHostsConfig: { [key: string]: Config };
  15     sessions: Session[];
  16 }
  17
  18 export const Routes = {
  19     ROOT: '/',
  20     TOKEN: '/token',
  21     FED_LOGIN: '/fedtoken',
  22     PROJECTS: `/projects/:id(${RESOURCE_UUID_PATTERN})`,
  23     COLLECTIONS: `/collections/:id(${RESOURCE_UUID_PATTERN})`,
  24     PROCESSES: `/processes/:id(${RESOURCE_UUID_PATTERN})`,
  25     FAVORITES: '/favorites',
  26     TRASH: '/trash',
  27     PROCESS_LOGS: `/process-logs/:id(${RESOURCE_UUID_PATTERN})`,
  28     REPOSITORIES: '/repositories',
  29     SHARED_WITH_ME: '/shared-with-me',
  30     RUN_PROCESS: '/run-process',
  31     VIRTUAL_MACHINES_ADMIN: '/virtual-machines-admin',
  32     VIRTUAL_MACHINES_USER: '/virtual-machines-user',
  33     WORKFLOWS: '/workflows',
  34     SEARCH_RESULTS: '/search-results',
  35     SSH_KEYS_ADMIN: `/ssh-keys-admin`,
  36     SSH_KEYS_USER: `/ssh-keys-user`,
  37     SITE_MANAGER: `/site-manager`,
  38     MY_ACCOUNT: '/my-account',
  39     KEEP_SERVICES: `/keep-services`,
  40     COMPUTE_NODES: `/nodes`,
  41     USERS: '/users',
  42     API_CLIENT_AUTHORIZATIONS: `/api_client_authorizations`,
  43     GROUPS: '/groups',
  44     GROUP_DETAILS: `/group/:id(${RESOURCE_UUID_PATTERN})`,
  45     LINKS: '/links',
  46     PUBLIC_FAVORITES: '/public-favorites',
  47     COLLECTIONS_CONTENT_ADDRESS: '/collections/:id',
  48 };
  49
  50 export const getResourceUrl = (uuid: string) => {
  51     const kind = extractUuidKind(uuid);
  52     switch (kind) {
  53         case ResourceKind.PROJECT:
  54             return getProjectUrl(uuid);
  55         case ResourceKind.USER:
  56             return getProjectUrl(uuid);
  57         case ResourceKind.COLLECTION:
  58             return getCollectionUrl(uuid);
  59         case ResourceKind.PROCESS:
  60             return getProcessUrl(uuid);
  61         default:
  62             return undefined;
  63     }
  64 };
  65
  66 export const getNavUrl = (uuid: string, config: FederationConfig) => {
  67     const path = getResourceUrl(uuid) || "";
  68     const cls = uuid.substr(0, 5);
  69     if (cls === config.localCluster || extractUuidKind(uuid) === ResourceKind.USER || COLLECTION_PDH_REGEX.exec(uuid)) {
  70         return path;
  71     } else if (config.remoteHostsConfig[cls]) {
  72         let u: URL;
  73         if (config.remoteHostsConfig[cls].workbench2Url) {
  74             u = new URL(config.remoteHostsConfig[cls].workbench2Url || "");
  75         } else {
  76             u = new URL(config.remoteHostsConfig[cls].workbenchUrl);
  77             u.search = "api_token=" + config.sessions.filter((s) => s.clusterId === cls)[0].token;
  78         }
  79         u.pathname = path;
  80         return u.toString();
  81     } else {
  82         return "";
  83     }
  84 };
  85
  86
  87 export const getProcessUrl = (uuid: string) => `/processes/${uuid}`;
  88
  89 export const getProcessLogUrl = (uuid: string) => `/process-logs/${uuid}`;
  90
  91 export const getGroupUrl = (uuid: string) => `/group/${uuid}`;
  92
  93 export interface ResourceRouteParams {
  94     id: string;
  95 }
  96
  97 export const matchRootRoute = (route: string) =>
  98     matchPath(route, { path: Routes.ROOT, exact: true });
  99
 100 export const matchFavoritesRoute = (route: string) =>
 101     matchPath(route, { path: Routes.FAVORITES });
 102
 103 export const matchTrashRoute = (route: string) =>
 104     matchPath(route, { path: Routes.TRASH });
 105
 106 export const matchProjectRoute = (route: string) =>
 107     matchPath<ResourceRouteParams>(route, { path: Routes.PROJECTS });
 108
 109 export const matchCollectionRoute = (route: string) =>
 110     matchPath<ResourceRouteParams>(route, { path: Routes.COLLECTIONS });
 111
 112 export const matchProcessRoute = (route: string) =>
 113     matchPath<ResourceRouteParams>(route, { path: Routes.PROCESSES });
 114
 115 export const matchProcessLogRoute = (route: string) =>
 116     matchPath<ResourceRouteParams>(route, { path: Routes.PROCESS_LOGS });
 117
 118 export const matchSharedWithMeRoute = (route: string) =>
 119     matchPath(route, { path: Routes.SHARED_WITH_ME });
 120
 121 export const matchRunProcessRoute = (route: string) =>
 122     matchPath(route, { path: Routes.RUN_PROCESS });
 123
 124 export const matchWorkflowRoute = (route: string) =>
 125     matchPath<ResourceRouteParams>(route, { path: Routes.WORKFLOWS });
 126
 127 export const matchSearchResultsRoute = (route: string) =>
 128     matchPath<ResourceRouteParams>(route, { path: Routes.SEARCH_RESULTS });
 129
 130 export const matchUserVirtualMachineRoute = (route: string) =>
 131     matchPath<ResourceRouteParams>(route, { path: Routes.VIRTUAL_MACHINES_USER });
 132
 133 export const matchAdminVirtualMachineRoute = (route: string) =>
 134     matchPath<ResourceRouteParams>(route, { path: Routes.VIRTUAL_MACHINES_ADMIN });
 135
 136 export const matchRepositoriesRoute = (route: string) =>
 137     matchPath<ResourceRouteParams>(route, { path: Routes.REPOSITORIES });
 138
 139 export const matchSshKeysUserRoute = (route: string) =>
 140     matchPath(route, { path: Routes.SSH_KEYS_USER });
 141
 142 export const matchSshKeysAdminRoute = (route: string) =>
 143     matchPath(route, { path: Routes.SSH_KEYS_ADMIN });
 144
 145 export const matchSiteManagerRoute = (route: string) =>
 146     matchPath(route, { path: Routes.SITE_MANAGER });
 147
 148 export const matchMyAccountRoute = (route: string) =>
 149     matchPath(route, { path: Routes.MY_ACCOUNT });
 150
 151 export const matchKeepServicesRoute = (route: string) =>
 152     matchPath(route, { path: Routes.KEEP_SERVICES });
 153
 154 export const matchUsersRoute = (route: string) =>
 155     matchPath(route, { path: Routes.USERS });
 156
 157 export const matchComputeNodesRoute = (route: string) =>
 158     matchPath(route, { path: Routes.COMPUTE_NODES });
 159
 160 export const matchApiClientAuthorizationsRoute = (route: string) =>
 161     matchPath(route, { path: Routes.API_CLIENT_AUTHORIZATIONS });
 162
 163 export const matchGroupsRoute = (route: string) =>
 164     matchPath(route, { path: Routes.GROUPS });
 165
 166 export const matchGroupDetailsRoute = (route: string) =>
 167     matchPath<ResourceRouteParams>(route, { path: Routes.GROUP_DETAILS });
 168
 169 export const matchLinksRoute = (route: string) =>
 170     matchPath(route, { path: Routes.LINKS });
 171
 172 export const matchPublicFavoritesRoute = (route: string) =>
 173     matchPath(route, { path: Routes.PUBLIC_FAVORITES });
 174
 175 export const matchCollectionsContentAddressRoute = (route: string) =>
 176     matchPath(route, { path: Routes.COLLECTIONS_CONTENT_ADDRESS });