Files
SCM-Manager/scm-ui/ui-webapp/src/repos/containers/RepositoryRoot.tsx
Thomas Zerr 9bcb9f2512 Add un-escaped url prop in repository nav extension point
The url needs to be escaped for the route component, so that
react-router can perform his matching logic.
But additionally, the components rendered within the
extension point also need the unescaped url to create further
links based on this url.
2025-05-27 09:42:49 +02:00

422 lines
15 KiB
TypeScript

/*
* Copyright (c) 2020 - present Cloudogu GmbH
*
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License as published by the Free
* Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
import React, { useEffect, useMemo, useState } from "react";
import { match as Match } from "react-router";
import { Link as RouteLink, Redirect, Route, RouteProps, Switch, useHistory, useRouteMatch } from "react-router-dom";
import { useTranslation } from "react-i18next";
import { binder, ExtensionPoint, extensionPoints } from "@scm-manager/ui-extensions";
import { Changeset, Link } from "@scm-manager/ui-types";
import {
CustomQueryFlexWrappedColumns,
devices,
ErrorPage,
FileControlFactory,
HealthCheckFailureDetail,
JumpToFileButton,
NavLink,
Page,
PrimaryContentColumn,
RepositoryFlags,
SecondaryNavigation,
SecondaryNavigationColumn,
SubNavigation,
urls,
} from "@scm-manager/ui-components";
import { Loading } from "@scm-manager/ui-core";
import RepositoryDetails from "../components/RepositoryDetails";
import EditRepo from "./EditRepo";
import BranchesOverview from "../branches/containers/BranchesOverview";
import CreateBranch from "../branches/containers/CreateBranch";
import Permissions from "../permissions/containers/Permissions";
import EditRepoNavLink from "../components/EditRepoNavLink";
import BranchRoot from "../branches/containers/BranchRoot";
import PermissionsNavLink from "../components/PermissionsNavLink";
import RepositoryNavLink from "../components/RepositoryNavLink";
import CodeOverview from "../codeSection/containers/CodeOverview";
import ChangesetView from "./ChangesetView";
import SourceExtensions from "../sources/containers/SourceExtensions";
import TagsOverview from "../tags/container/TagsOverview";
import CompareRoot from "../compare/CompareRoot";
import TagRoot from "../tags/container/TagRoot";
import {
RepositoryContextProvider,
useIndexLinks,
useNamespaceAndNameContext,
useRepository,
} from "@scm-manager/ui-api";
import styled from "styled-components";
import { useShortcut } from "@scm-manager/ui-shortcuts";
const TagGroup = styled.span`
& > * {
margin-right: 0.25rem;
}
`;
const MobileWrapped = styled.div`
@media screen and (max-width: ${devices.mobile.width}px) {
margin-left: auto;
}
`;
type UrlParams = {
namespace: string;
name: string;
};
const useRepositoryFromUrl = (match: Match<UrlParams>) => {
const { namespace, name } = match.params;
const { data: repository, ...rest } = useRepository(namespace, name);
return {
repository,
...rest,
};
};
const RepositoryRoot = () => {
const match = useRouteMatch<UrlParams>();
const { isLoading, error, repository } = useRepositoryFromUrl(match);
const indexLinks = useIndexLinks();
const [showHealthCheck, setShowHealthCheck] = useState(false);
const [t] = useTranslation("repos");
const context = useNamespaceAndNameContext();
const history = useHistory();
const url = urls.matchedUrlFromMatch(match);
const codeLinkname = useMemo(() => {
if (repository?._links?.sources) {
return "sources";
}
if (repository?._links?.changesets) {
return "changesets";
}
return "";
}, [repository]);
useShortcut("g i", () => history.push(`${url}/info`), {
description: t("shortcuts.info"),
});
useShortcut("g b", () => history.push(`${url}/branches/`), {
active: !!repository?._links["branches"],
description: t("shortcuts.branches"),
});
useShortcut("g t", () => history.push(`${url}/tags/`), {
active: !!repository?._links["tags"],
description: t("shortcuts.tags"),
});
useShortcut("g c", () => history.push(evaluateDestinationForCodeLink()), {
active: !!repository?._links[codeLinkname],
description: t("shortcuts.code"),
});
useShortcut("g s", () => history.push(`${url}/settings/general`), {
description: t("shortcuts.settings"),
});
useEffect(() => {
if (repository) {
context.setNamespace(repository.namespace);
context.setName(repository.name);
}
return () => {
context.setNamespace("");
context.setName("");
};
}, [repository, context]);
if (error) {
return (
<ErrorPage title={t("repositoryRoot.errorTitle")} subtitle={t("repositoryRoot.errorSubtitle")} error={error} />
);
}
if (!repository || isLoading) {
return <Loading />;
}
// props used for extensions
// most of the props required for compatibility
const props = {
namespace: repository.namespace,
name: repository.name,
repository: repository,
loading: isLoading,
error,
repoLink: (indexLinks.repositories as Link)?.href,
indexLinks,
match,
};
const redirectUrlFactory = binder.getExtension<extensionPoints.RepositoryRedirect>("repository.redirect", props);
let redirectedUrl;
if (redirectUrlFactory) {
redirectedUrl = url + redirectUrlFactory(props);
} else {
redirectedUrl = url + "/code/sources/";
}
const fileControlFactoryFactory: (changeset: Changeset) => FileControlFactory = (changeset) => (file) => {
const baseUrl = `${url}/code/sources`;
const sourceLink = file.newPath && {
url: `${baseUrl}/${changeset.id}/${file.newPath}/`,
label: t("diff.jumpToSource"),
};
const targetLink = file.oldPath &&
changeset._embedded?.parents?.length === 1 && {
url: `${baseUrl}/${changeset._embedded.parents[0].id}/${file.oldPath}`,
label: t("diff.jumpToTarget"),
};
const links = [];
switch (file.type) {
case "add":
if (sourceLink) {
links.push(sourceLink);
}
break;
case "delete":
if (targetLink) {
links.push(targetLink);
}
break;
default:
if (targetLink && sourceLink) {
links.push(targetLink, sourceLink); // Target link first because its the previous file
} else if (sourceLink) {
links.push(sourceLink);
}
}
return links ? links.map(({ url, label }) => <JumpToFileButton key={url} tooltip={label} link={url} />) : null;
};
const titleComponent = (
<>
<RouteLink to={`/repos/${repository.namespace}/`} className="has-text-inherit mr-1">
{repository.namespace}
</RouteLink>
/
<RouteLink to={`/repo/${repository.namespace}/${repository.name}`} className="has-text-inherit ml-1">
{repository.name}
</RouteLink>
</>
);
const extensionProps = {
repository,
url,
indexLinks,
};
const matchesBranches = (route: RouteProps) => {
const regex = new RegExp(`${url}/branch/.+/info`);
if (!route.location) {
return false;
}
return !!route.location.pathname.match(regex);
};
const matchesTags = (route: RouteProps) => {
const regex = new RegExp(`${url}/tag/.+/info`);
if (!route.location) {
return false;
}
return !!route.location.pathname.match(regex);
};
const matchesCode = (route: RouteProps) => {
const regex = new RegExp(`${url}(/code)/.*`);
if (!route.location) {
return false;
}
return !!route.location.pathname.match(regex);
};
const evaluateDestinationForCodeLink = () => {
if (repository?._links?.sources) {
return `${url}/code/sources/`;
}
return `${url}/code/changesets`;
};
const modal = (
<HealthCheckFailureDetail
closeFunction={() => setShowHealthCheck(false)}
active={showHealthCheck}
failures={repository.healthCheckFailures}
/>
);
const escapedUrl = urls.escapeUrlForRoute(url);
return (
<RepositoryContextProvider repository={repository}>
<Page
title={titleComponent}
documentTitle={`${repository.namespace}/${repository.name}`}
afterTitle={
<MobileWrapped className="is-flex is-align-items-center">
<ExtensionPoint name="repository.afterTitle" props={{ repository }} />
<TagGroup className="has-text-weight-bold">
<RepositoryFlags repository={repository} tooltipLocation="bottom" />
</TagGroup>
</MobileWrapped>
}
>
{modal}
<ExtensionPoint<extensionPoints.RepositoryBanner>
name="repository.banner"
props={{ repository, url: history.location.pathname }}
renderAll={true}
/>
<CustomQueryFlexWrappedColumns>
<PrimaryContentColumn>
<Switch>
<Redirect exact from={urls.escapeUrlForRoute(match.url)} to={urls.escapeUrlForRoute(redirectedUrl)} />
{/* redirect pre 2.0.0-rc2 links */}
<Redirect from={`${escapedUrl}/changeset/:id`} to={`${url}/code/changeset/:id`} />
<Redirect exact from={`${escapedUrl}/sources`} to={`${url}/code/sources`} />
<Redirect from={`${escapedUrl}/sources/:revision/:path*`} to={`${url}/code/sources/:revision/:path*`} />
<Redirect exact from={`${escapedUrl}/changesets`} to={`${url}/code/changesets`} />
<Redirect
from={`${escapedUrl}/branch/:branch/changesets`}
to={`${url}/code/branch/:branch/changesets/`}
/>
<Route path={`${escapedUrl}/info`} exact>
<RepositoryDetails repository={repository} />
</Route>
<Route path={`${escapedUrl}/settings/general`}>
<EditRepo repository={repository} />
</Route>
<Route path={`${escapedUrl}/settings/permissions`}>
<Permissions namespaceOrRepository={repository} />
</Route>
<Route exact path={`${escapedUrl}/code/changeset/:id`}>
<ChangesetView repository={repository} fileControlFactoryFactory={fileControlFactoryFactory} />
</Route>
<Route path={`${escapedUrl}/code/sourceext/:extension`} exact={true}>
<SourceExtensions repository={repository} />
</Route>
<Route path={`${escapedUrl}/code/sourceext/:extension/:revision/:path*`}>
<SourceExtensions repository={repository} baseUrl={`${url}/code/sources`} />
</Route>
<Route path={`${escapedUrl}/code`}>
<CodeOverview baseUrl={`${url}/code`} repository={repository} />
</Route>
<Route path={`${escapedUrl}/branch/:branch`}>
<BranchRoot repository={repository} />
</Route>
<Route path={`${escapedUrl}/branches`} exact={true}>
<BranchesOverview repository={repository} baseUrl={`${url}/branch`} />
</Route>
<Route path={`${escapedUrl}/branches/create`}>
<CreateBranch repository={repository} />
</Route>
<Route path={`${escapedUrl}/tag/:tag`}>
<TagRoot repository={repository} baseUrl={`${url}/tag`} />
</Route>
<Route path={`${escapedUrl}/tags`} exact={true}>
<TagsOverview repository={repository} baseUrl={`${url}/tag`} />
</Route>
<Route path={`${escapedUrl}/compare/:sourceType/:sourceName`}>
<CompareRoot repository={repository} baseUrl={`${url}/compare`} />
</Route>
<ExtensionPoint<extensionPoints.RepositoryRoute>
name="repository.route"
props={{
repository,
url: urls.escapeUrlForRoute(url),
indexLinks,
urlForLinks: url,
}}
renderAll={true}
/>
</Switch>
</PrimaryContentColumn>
<SecondaryNavigationColumn>
<SecondaryNavigation label={t("repositoryRoot.menu.navigationLabel")}>
<RepositoryNavLink
repository={repository}
linkName={codeLinkname}
to={evaluateDestinationForCodeLink()}
icon="fas fa-code"
label={t("repositoryRoot.menu.sourcesNavLink")}
activeWhenMatch={matchesCode}
activeOnlyWhenExact={false}
title={t("repositoryRoot.menu.sourcesNavLink")}
/>
<ExtensionPoint<extensionPoints.RepositoryNavigationTopLevel>
name="repository.navigation.topLevel"
props={extensionProps}
renderAll={true}
/>
<NavLink
to={`${url}/info`}
icon="fas fa-info-circle"
label={t("repositoryRoot.menu.informationNavLink")}
title={t("repositoryRoot.menu.informationNavLink")}
/>
<RepositoryNavLink
repository={repository}
linkName="branches"
to={`${url}/branches/`}
icon="fas fa-code-branch"
label={t("repositoryRoot.menu.branchesNavLink")}
activeWhenMatch={matchesBranches}
activeOnlyWhenExact={false}
title={t("repositoryRoot.menu.branchesNavLink")}
/>
<RepositoryNavLink
repository={repository}
linkName="tags"
to={`${url}/tags/`}
icon="fas fa-tags"
label={t("repositoryRoot.menu.tagsNavLink")}
activeWhenMatch={matchesTags}
activeOnlyWhenExact={false}
title={t("repositoryRoot.menu.tagsNavLink")}
/>
<ExtensionPoint<extensionPoints.RepositoryNavigation>
name="repository.navigation"
props={extensionProps}
renderAll={true}
/>
<SubNavigation
to={`${url}/settings/general`}
label={t("repositoryRoot.menu.settingsNavLink")}
title={t("repositoryRoot.menu.settingsNavLink")}
>
<EditRepoNavLink repository={repository} editUrl={`${url}/settings/general`} />
<PermissionsNavLink permissionUrl={`${url}/settings/permissions`} repository={repository} />
<ExtensionPoint<extensionPoints.RepositorySetting>
name="repository.setting"
props={extensionProps}
renderAll={true}
/>
</SubNavigation>
</SecondaryNavigation>
</SecondaryNavigationColumn>
</CustomQueryFlexWrappedColumns>
</Page>
</RepositoryContextProvider>
);
};
export default RepositoryRoot;